6671a3a8b7
This commit is intended as a refinement of the patches
mentioned below, where origins/sources of newlib items
were added to the header files for user documentation.
However, if those additions are to be truly effective,
along with kernel documentation (where available), the
following prerequisites must also have been satisfied:
. our identifiers closely align with linux field names
. our derived items are documented or self-documenting
Satisfying those prerequisites prompted this patch and
for these changes, kernel sources were emphasized over
available documentation (shame on me, it should always
have been so). And, while some 'new' fields were found
to be conditional, they were included unconditionally.
These changes appear more extensive than they actually
need be since I have attempted to enforce some spacing
conventions. So, I've summarize the significant things
in the sections that follow. For a proper perspective,
use: 'git diff --ignore-space-change' (good as alias).
___________________________________________ <PIDS> api
This api is unique in that there exists many different
file/directory origins subordinate to /proc/<pid>. And
our item identifiers are sometimes coerced so as to be
able to group related or similar enumerators together.
So, users needed more help relating our identifiers to
an actual documented field. Thus, we will now also add
the field names as with 'stat: delayacct_blkio_ticks'.
Each item ending with a '_C' now consistently includes
both the parent's count/time plus waited for children.
That 'RTPRIO' guy was renamed/relocated as PRIORITY_RT
since its original name is an implementation artifact.
___________________________________________ <STAT> api
The only api change was to correct a typo ('dervied').
_________________________________________ <VMSTAT> api
Even ignoring white space, this interface received the
largest number of changes. Mostly, this was because of
deficiencies in the proc(5) documentation. Recall that
this documentation already sorely lacks any substance.
Usually, just kernel releases are noted, not contents.
When compared to kernel source, that proc(5) contained
many non-existent fields and also omitted many others.
________________________________________ <MEMINFO> api
Sadly, with this api many of the changes were simply a
correction of some earlier 'human error' where several
fields where hashed then tracked but never represented
with an item enumerator in this meminfo.h header file.
_______________________________________ <SLABINFO> api
The 'SLABS' (summary) & 'SLABNODE' items were reversed
since the former are derived from the separate caches.
More significantly, those 'SLABNODE' guys were renamed
to 'SLAB' since they concern individual caches and the
concept of 'nodes' is really an implementation detail.
Also, several enumerators were changed to more closely
agree with official slabinfo(5) documentation referred
to in what we're treating as a base document: proc(5).
Lastly, while those 'SLABS' items are solely a product
of our library and not represented in slabinfo(5), the
names attempt to parallel those found as 'SLAB' items.
______________________________________ <DISKSTATS> api
One enumeration identifier was changed so as to better
reflect its relationship to that actual documentation:
'Documentation/iostats.txt', as referenced in proc(5).
Reference(s):
. 12/2018, item origins added (and commit msg history)
commit 96d59cbf46
. 01/2019, <stat> origins tweaked
commit 201e816b26
Signed-off-by: Jim Warner <james.warner@comcast.net>
138 lines
4.5 KiB
C
138 lines
4.5 KiB
C
/*
|
|
* libprocps - Library to read proc filesystem
|
|
*
|
|
* 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 PROCPS_DISKSTATS_H
|
|
#define PROCPS_DISKSTATS_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
enum diskstats_item {
|
|
DISKSTATS_noop, // ( never altered )
|
|
DISKSTATS_extra, // ( reset to zero )
|
|
// returns origin, see proc(5)
|
|
// ------- -------------------
|
|
DISKSTATS_NAME, // str /proc/diskstats
|
|
DISKSTATS_TYPE, // s_int "
|
|
DISKSTATS_MAJOR, // s_int "
|
|
DISKSTATS_MINOR, // s_int "
|
|
|
|
DISKSTATS_READS, // ul_int "
|
|
DISKSTATS_READS_MERGED, // ul_int "
|
|
DISKSTATS_READ_SECTORS, // ul_int "
|
|
DISKSTATS_READ_TIME, // ul_int "
|
|
DISKSTATS_WRITES, // ul_int "
|
|
DISKSTATS_WRITES_MERGED, // ul_int "
|
|
DISKSTATS_WRITE_SECTORS, // ul_int "
|
|
DISKSTATS_WRITE_TIME, // ul_int "
|
|
DISKSTATS_IO_TIME, // ul_int "
|
|
DISKSTATS_WEIGHTED_TIME, // ul_int "
|
|
|
|
DISKSTATS_IO_INPROGRESS, // s_int "
|
|
|
|
DISKSTATS_DELTA_READS, // s_int derived from above
|
|
DISKSTATS_DELTA_READS_MERGED, // s_int "
|
|
DISKSTATS_DELTA_READ_SECTORS, // s_int "
|
|
DISKSTATS_DELTA_READ_TIME, // s_int "
|
|
DISKSTATS_DELTA_WRITES, // s_int "
|
|
DISKSTATS_DELTA_WRITES_MERGED, // s_int "
|
|
DISKSTATS_DELTA_WRITE_SECTORS, // s_int "
|
|
DISKSTATS_DELTA_WRITE_TIME, // s_int "
|
|
DISKSTATS_DELTA_IO_TIME, // s_int "
|
|
DISKSTATS_DELTA_WEIGHTED_TIME // s_int "
|
|
};
|
|
|
|
enum diskstats_sort_order {
|
|
DISKSTATS_SORT_ASCEND = +1,
|
|
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 DISKSTATS_TYPE_DISK -11111
|
|
#define DISKSTATS_TYPE_PARTITION -22222
|
|
|
|
#define DISKSTATS_GET( info, name, actual_enum, type ) ( { \
|
|
struct diskstats_result *r = procps_diskstats_get( info, name, actual_enum ); \
|
|
r ? r->result . type : 0; } )
|
|
|
|
#define DISKSTATS_VAL( relative_enum, type, stack, info ) \
|
|
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);
|
|
|
|
|
|
#ifdef XTRA_PROCPS_DEBUG
|
|
# include <proc/xtra-procps-debug.h>
|
|
#endif
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif
|