abc71a46ad
This commit represents a complete redesign of the stat interface. Gone are the confusing 8 separate accessors along with their 2 additional read functions. In their place we have just 3 accessors, with no read required. That old interface also suffered an inflexibility with respect to structures. Now we deal with an unchanging standard 'result' struct enabling future changes where the binary interface will no longer need to be broken. And gone is that former unnecessary typedef, used when dealing with jiffies. Now the standard C type is used. Our new API also adds some brand new functionality. If a caller plans to employ successive 'select' or 'reap' invocations, then delta values are available (which is actually only what that top program is interested in). At some future point a 'sort' function could be easily introduced to complement the 'reap' function. However, I saw no need for it at present and so it was omitted. There were several design decisions which everyone may not agree with. In support I'll offer these rationals: . The 'get' function returns a signed long long result which means a potential loss of some significance. But I felt the ability to distinguish actual errors (minus values) from true zero results were worth such a risk. . The DELTA item enumerators were also made signed and smaller than their parents. And they are intentionally grouped as last so as to emphasize those distinctions. . The SYS type items were excluded from the new 'reap' function. It would not make sense to duplicate them in each results stack. They're limited to 'get'/'select'. . By the same token, some items (DELTA, etc.) will not be allowed under that 'get' routine. That function was already open to significant internal overhead (through subsequent calls like in vmstat.c). That is why it has been limited via 1 second between reads of /proc/stat. Lastly, when we finally get around to documenting this interface there's a real potential toe stubber when it comes to the numa node portion. The libnuma.so doesn't really provide any means to retrieve the active nodes. Thus, any total reported by <stat> is just the highest node number plus one, as reported by the numa library. Any unused/inactive nodes are identified through these . PROCPS_STAT_TIC_ID shows as PROCPS_STAT_NODE_INVALID By the same token after the STAT_REAP_CPUS_ONLY 'reap' . PROCPS_STAT_TIC_NUMA_NODE = PROCPS_STAT_NODE_INVALID Reference(s): http://www.freelists.org/post/procps/newlib-stat-interface Signed-off-by: Jim Warner <james.warner@comcast.net>
127 lines
3.9 KiB
C
127 lines
3.9 KiB
C
/*
|
|
* libprocps - Library to read proc filesystem
|
|
*
|
|
* 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_STAT_H
|
|
#define PROC_STAT_H
|
|
|
|
#include <proc/procps.h>
|
|
|
|
__BEGIN_DECLS
|
|
|
|
enum stat_item {
|
|
PROCPS_STAT_noop, // ( never altered )
|
|
PROCPS_STAT_extra, // ( reset to zero )
|
|
|
|
PROCPS_STAT_TIC_ID, // s_int
|
|
PROCPS_STAT_TIC_NUMA_NODE, // s_int
|
|
PROCPS_STAT_TIC_USER, // ull_int
|
|
PROCPS_STAT_TIC_NICE, // ull_int
|
|
PROCPS_STAT_TIC_SYSTEM, // ull_int
|
|
PROCPS_STAT_TIC_IDLE, // ull_int
|
|
PROCPS_STAT_TIC_IOWAIT, // ull_int
|
|
PROCPS_STAT_TIC_IRQ, // ull_int
|
|
PROCPS_STAT_TIC_SOFTIRQ, // ull_int
|
|
PROCPS_STAT_TIC_STOLEN, // ull_int
|
|
PROCPS_STAT_TIC_GUEST, // ull_int
|
|
PROCPS_STAT_TIC_GUEST_NICE, // ull_int
|
|
PROCPS_STAT_TIC_DELTA_USER, // sl_int
|
|
PROCPS_STAT_TIC_DELTA_NICE, // sl_int
|
|
PROCPS_STAT_TIC_DELTA_SYSTEM, // sl_int
|
|
PROCPS_STAT_TIC_DELTA_IDLE, // sl_int
|
|
PROCPS_STAT_TIC_DELTA_IOWAIT, // sl_int
|
|
PROCPS_STAT_TIC_DELTA_IRQ, // sl_int
|
|
PROCPS_STAT_TIC_DELTA_SOFTIRQ, // sl_int
|
|
PROCPS_STAT_TIC_DELTA_STOLEN, // sl_int
|
|
PROCPS_STAT_TIC_DELTA_GUEST, // sl_int
|
|
PROCPS_STAT_TIC_DELTA_GUEST_NICE, // sl_int
|
|
|
|
PROCPS_STAT_SYS_CTX_SWITCHES, // ul_int
|
|
PROCPS_STAT_SYS_INTERRUPTS, // ul_int
|
|
PROCPS_STAT_SYS_PROC_BLOCKED, // ul_int
|
|
PROCPS_STAT_SYS_PROC_CREATED, // ul_int
|
|
PROCPS_STAT_SYS_PROC_RUNNING, // ul_int
|
|
PROCPS_STAT_SYS_TIME_OF_BOOT, // ul_int
|
|
PROCPS_STAT_SYS_DELTA_CTX_SWITCHES, // s_int
|
|
PROCPS_STAT_SYS_DELTA_INTERRUPTS, // s_int
|
|
PROCPS_STAT_SYS_DELTA_PROC_BLOCKED, // s_int
|
|
PROCPS_STAT_SYS_DELTA_PROC_CREATED, // s_int
|
|
PROCPS_STAT_SYS_DELTA_PROC_RUNNING, // s_int
|
|
};
|
|
|
|
enum stat_reap_type {
|
|
STAT_REAP_CPUS_ONLY,
|
|
STAT_REAP_CPUS_AND_NODES
|
|
};
|
|
|
|
struct stat_result {
|
|
enum stat_item item;
|
|
union {
|
|
int s_int;
|
|
long sl_int;
|
|
unsigned long ul_int;
|
|
unsigned long long ull_int;
|
|
} result;
|
|
};
|
|
|
|
struct stat_stack {
|
|
struct stat_result *head;
|
|
};
|
|
|
|
struct stat_reap {
|
|
int total;
|
|
struct stat_stack **stacks;
|
|
};
|
|
|
|
struct stat_reaped {
|
|
struct stat_stack *summary;
|
|
struct stat_reap *cpus;
|
|
struct stat_reap *nodes;
|
|
};
|
|
|
|
|
|
#define PROCPS_STAT_SUMMARY_ID -11111
|
|
#define PROCPS_STAT_NODE_INVALID -22222
|
|
|
|
#define PROCPS_STAT_VAL(rel_enum,type,stack) \
|
|
stack -> head [ rel_enum ] . result . type
|
|
|
|
|
|
struct procps_statinfo;
|
|
|
|
int procps_stat_new (struct procps_statinfo **info);
|
|
int procps_stat_ref (struct procps_statinfo *info);
|
|
int procps_stat_unref (struct procps_statinfo **info);
|
|
|
|
signed long long procps_stat_get (
|
|
struct procps_statinfo *info,
|
|
enum stat_item item);
|
|
|
|
struct stat_stack *procps_stat_select (
|
|
struct procps_statinfo *info,
|
|
enum stat_item *items,
|
|
int numitems);
|
|
|
|
struct stat_reaped *procps_stat_reap (
|
|
struct procps_statinfo *info,
|
|
enum stat_reap_type what,
|
|
enum stat_item *items,
|
|
int numitems);
|
|
|
|
__END_DECLS
|
|
|
|
#endif
|