procps/proc/diskstats.h
Jim Warner 82d5661603 library: standardize all the 'context' structure names
This patch attempts to standardize the naming of those
most important (declared not defined) context structs.

The present practice represents a hodge podge of names
only some of which reflect the source /proc file name.
And 2 of those file names embed a literal 'info' which
is likely the origin of that required parm identifier.

Now we'll append a universal '_info' to such structure
names, while including the names of those /proc pseudo
files where possible. In any case, that context struct
will *always* begin with the actual module/header file
name. And only the following two sound a little weird!

---------> 'meminfo_info' + 'slabinfo_info' <---------

Signed-off-by: Jim Warner <james.warner@comcast.net>
2016-07-26 20:47:34 +10:00

130 lines
4.1 KiB
C

/*
* diskstats - Disk statistics - part of procps
*
* Copyright (c) 2003 Fabian Frederick
* Copyright (C) 2003 Albert Cahalan
* Copyright (C) 2015 Craig Small <csmall@enc.com.au>
* Copyright (C) 2016 Jim Warner <james.warner@comcast.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef PROC_DISKSTATS_H
#define PROC_DISKSTATS_H
#include <sys/cdefs.h>
__BEGIN_DECLS
enum diskstats_item {
PROCPS_DISKSTATS_noop, // ( never altered )
PROCPS_DISKSTATS_extra, // ( reset to zero )
PROCPS_DISKSTATS_NAME, // str
PROCPS_DISKSTATS_TYPE, // s_int
PROCPS_DISKSTATS_MAJOR, // s_int
PROCPS_DISKSTATS_MINOR, // s_int
PROCPS_DISKSTATS_READS, // ul_int
PROCPS_DISKSTATS_READS_MERGED, // ul_int
PROCPS_DISKSTATS_READ_SECTORS, // ul_int
PROCPS_DISKSTATS_READ_TIME, // ul_int
PROCPS_DISKSTATS_WRITES, // ul_int
PROCPS_DISKSTATS_WRITES_MERGED, // ul_int
PROCPS_DISKSTATS_WRITE_SECTORS, // ul_int
PROCPS_DISKSTATS_WRITE_TIME, // ul_int
PROCPS_DISKSTATS_IO_TIME, // ul_int
PROCPS_DISKSTATS_IO_WTIME, // ul_int
PROCPS_DISKSTATS_IO_INPROGRESS, // s_int
PROCPS_DISKSTATS_DELTA_READS, // s_int
PROCPS_DISKSTATS_DELTA_READS_MERGED, // s_int
PROCPS_DISKSTATS_DELTA_READ_SECTORS, // s_int
PROCPS_DISKSTATS_DELTA_READ_TIME, // s_int
PROCPS_DISKSTATS_DELTA_WRITES, // s_int
PROCPS_DISKSTATS_DELTA_WRITES_MERGED, // s_int
PROCPS_DISKSTATS_DELTA_WRITE_SECTORS, // s_int
PROCPS_DISKSTATS_DELTA_WRITE_TIME, // s_int
PROCPS_DISKSTATS_DELTA_IO_TIME, // s_int
PROCPS_DISKSTATS_DELTA_IO_WTIME // s_int
};
enum diskstats_sort_order {
PROCPS_DISKSTATS_SORT_ASCEND = +1,
PROCPS_DISKSTATS_SORT_DESCEND = -1
};
struct diskstats_result {
enum diskstats_item item;
union {
signed int s_int;
unsigned long ul_int;
char *str;
} result;
};
struct diskstats_stack {
struct diskstats_result *head;
};
struct diskstats_reap {
int total;
struct diskstats_stack **stacks;
};
#define PROCPS_DISKSTATS_TYPE_DISK -11111
#define PROCPS_DISKSTATS_TYPE_PARTITION -22222
#define PROCPS_DISKSTATS_GET( info, actual_enum, type ) \
procps_diskstats_get( info, actual_enum ) -> result . type
#define PROCPS_DISKSTATS_VAL( relative_enum, type, stack) \
stack -> head [ relative_enum ] . result . type
struct diskstats_info;
int procps_diskstats_new (struct diskstats_info **info);
int procps_diskstats_ref (struct diskstats_info *info);
int procps_diskstats_unref (struct diskstats_info **info);
struct diskstats_result *procps_diskstats_get (
struct diskstats_info *info,
const char *name,
enum diskstats_item item);
struct diskstats_reap *procps_diskstats_reap (
struct diskstats_info *info,
enum diskstats_item *items,
int numitems);
struct diskstats_stack *procps_diskstats_select (
struct diskstats_info *info,
const char *name,
enum diskstats_item *items,
int numitems);
struct diskstats_stack **procps_diskstats_sort (
struct diskstats_info *info,
struct diskstats_stack *stacks[],
int numstacked,
enum diskstats_item sortitem,
enum diskstats_sort_order order);
__END_DECLS
#endif