c4d097c709
Many of our item enumerator identifiers are very long, especially in that <VMSTAT> module. Additionally, they all contain the exact same universal 'PROCPS_' prefix. The origins for this are likely found in the desire to avoid name clashes with other potential include files. But with procps-ng newlib, we've probably gone way too far. Did 'PROCPS_PIDS_TICS_SYSTEM' actually offer more protection against clash than 'PIDS_TICS_SYSTEM' does? I don't think so. Besides, no matter how big that name becomes, one can never guarantee they'll never be some clash. And, conversely, extremely short names will not always create conflict. Of course, in either case when some clash occurs, one can always #undef that problem. Thus, this commit will eliminate that 'PROCPS_' prefix making all of those enum identifiers a little shorter. And, we'll still be well above some ridiculously short (criminally short) names found in some common headers: - - - - - - - - - - <term.h> - 'tab', 'TTY', etc - - - - - - - - - - - - - - - - <search.h> - 'ENTER', ENTRY', 'FIND', etc ------------------------------------------------------ Finally, with this as a last of the wholesale changes, we will have established the naming conventions below: . only functions will begin with that 'procps_' prefix . exposed structures begin with the module/header name . item enumerators begin like structs, but capitalized . other enumerators work exactly like item enumerators . macros and constants begin just like the enumerators ------------------------------------------------------ Signed-off-by: Jim Warner <james.warner@comcast.net>
165 lines
5.9 KiB
C
165 lines
5.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_MEMINFO_H
|
|
#define PROC_MEMINFO_H
|
|
|
|
#include <sys/cdefs.h>
|
|
|
|
__BEGIN_DECLS
|
|
|
|
enum meminfo_item {
|
|
MEMINFO_noop, // ( never altered )
|
|
MEMINFO_extra, // ( reset to zero )
|
|
/*
|
|
note: all of the following values are exressed as KiB
|
|
*/
|
|
MEMINFO_MEM_ACTIVE, // ul_int
|
|
MEMINFO_MEM_ACTIVE_ANON, // ul_int
|
|
MEMINFO_MEM_ACTIVE_FILE, // ul_int
|
|
MEMINFO_MEM_ANON, // ul_int
|
|
MEMINFO_MEM_AVAILABLE, // ul_int
|
|
MEMINFO_MEM_BOUNCE, // ul_int
|
|
MEMINFO_MEM_BUFFERS, // ul_int
|
|
MEMINFO_MEM_CACHED, // ul_int
|
|
MEMINFO_MEM_COMMIT_LIMIT, // ul_int
|
|
MEMINFO_MEM_COMMITTED_AS, // ul_int
|
|
MEMINFO_MEM_HARD_CORRUPTED, // ul_int
|
|
MEMINFO_MEM_DIRTY, // ul_int
|
|
MEMINFO_MEM_FREE, // ul_int
|
|
MEMINFO_MEM_HUGE_ANON, // ul_int
|
|
MEMINFO_MEM_HUGE_FREE, // ul_int
|
|
MEMINFO_MEM_HUGE_RSVD, // ul_int
|
|
MEMINFO_MEM_HUGE_SIZE, // ul_int
|
|
MEMINFO_MEM_HUGE_SURPLUS, // ul_int
|
|
MEMINFO_MEM_HUGE_TOTAL, // ul_int
|
|
MEMINFO_MEM_INACTIVE, // ul_int
|
|
MEMINFO_MEM_INACTIVE_ANON, // ul_int
|
|
MEMINFO_MEM_INACTIVE_FILE, // ul_int
|
|
MEMINFO_MEM_KERNEL_STACK, // ul_int
|
|
MEMINFO_MEM_LOCKED, // ul_int
|
|
MEMINFO_MEM_MAPPED, // ul_int
|
|
MEMINFO_MEM_NFS_UNSTABLE, // ul_int
|
|
MEMINFO_MEM_PAGE_TABLES, // ul_int
|
|
MEMINFO_MEM_SHARED, // ul_int
|
|
MEMINFO_MEM_SLAB, // ul_int
|
|
MEMINFO_MEM_SLAB_RECLAIM, // ul_int
|
|
MEMINFO_MEM_SLAB_UNRECLAIM, // ul_int
|
|
MEMINFO_MEM_TOTAL, // ul_int
|
|
MEMINFO_MEM_UNEVICTABLE, // ul_int
|
|
MEMINFO_MEM_USED, // ul_int
|
|
MEMINFO_MEM_VM_ALLOC_CHUNK, // ul_int
|
|
MEMINFO_MEM_VM_ALLOC_TOTAL, // ul_int
|
|
MEMINFO_MEM_VM_ALLOC_USED, // ul_int
|
|
MEMINFO_MEM_WRITEBACK, // ul_int
|
|
MEMINFO_MEM_WRITEBACK_TMP, // ul_int
|
|
|
|
MEMINFO_DELTA_ACTIVE, // s_int
|
|
MEMINFO_DELTA_ACTIVE_ANON, // s_int
|
|
MEMINFO_DELTA_ACTIVE_FILE, // s_int
|
|
MEMINFO_DELTA_ANON, // s_int
|
|
MEMINFO_DELTA_AVAILABLE, // s_int
|
|
MEMINFO_DELTA_BOUNCE, // s_int
|
|
MEMINFO_DELTA_BUFFERS, // s_int
|
|
MEMINFO_DELTA_CACHED, // s_int
|
|
MEMINFO_DELTA_COMMIT_LIMIT, // s_int
|
|
MEMINFO_DELTA_COMMITTED_AS, // s_int
|
|
MEMINFO_DELTA_HARD_CORRUPTED, // s_int
|
|
MEMINFO_DELTA_DIRTY, // s_int
|
|
MEMINFO_DELTA_FREE, // s_int
|
|
MEMINFO_DELTA_HUGE_ANON, // s_int
|
|
MEMINFO_DELTA_HUGE_FREE, // s_int
|
|
MEMINFO_DELTA_HUGE_RSVD, // s_int
|
|
MEMINFO_DELTA_HUGE_SIZE, // s_int
|
|
MEMINFO_DELTA_HUGE_SURPLUS, // s_int
|
|
MEMINFO_DELTA_HUGE_TOTAL, // s_int
|
|
MEMINFO_DELTA_INACTIVE, // s_int
|
|
MEMINFO_DELTA_INACTIVE_ANON, // s_int
|
|
MEMINFO_DELTA_INACTIVE_FILE, // s_int
|
|
MEMINFO_DELTA_KERNEL_STACK, // s_int
|
|
MEMINFO_DELTA_LOCKED, // s_int
|
|
MEMINFO_DELTA_MAPPED, // s_int
|
|
MEMINFO_DELTA_NFS_UNSTABLE, // s_int
|
|
MEMINFO_DELTA_PAGE_TABLES, // s_int
|
|
MEMINFO_DELTA_SHARED, // s_int
|
|
MEMINFO_DELTA_SLAB, // s_int
|
|
MEMINFO_DELTA_SLAB_RECLAIM, // s_int
|
|
MEMINFO_DELTA_SLAB_UNRECLAIM, // s_int
|
|
MEMINFO_DELTA_TOTAL, // s_int
|
|
MEMINFO_DELTA_UNEVICTABLE, // s_int
|
|
MEMINFO_DELTA_USED, // s_int
|
|
MEMINFO_DELTA_VM_ALLOC_CHUNK, // s_int
|
|
MEMINFO_DELTA_VM_ALLOC_TOTAL, // s_int
|
|
MEMINFO_DELTA_VM_ALLOC_USED, // s_int
|
|
MEMINFO_DELTA_WRITEBACK, // s_int
|
|
MEMINFO_DELTA_WRITEBACK_TMP, // s_int
|
|
|
|
MEMINFO_MEMHI_FREE, // ul_int
|
|
MEMINFO_MEMHI_TOTAL, // ul_int
|
|
MEMINFO_MEMHI_USED, // ul_int
|
|
|
|
MEMINFO_MEMLO_FREE, // ul_int
|
|
MEMINFO_MEMLO_TOTAL, // ul_int
|
|
MEMINFO_MEMLO_USED, // ul_int
|
|
|
|
MEMINFO_SWAP_CACHED, // ul_int
|
|
MEMINFO_SWAP_FREE, // ul_int
|
|
MEMINFO_SWAP_TOTAL, // ul_int
|
|
MEMINFO_SWAP_USED // ul_int
|
|
};
|
|
|
|
|
|
struct meminfo_result {
|
|
enum meminfo_item item;
|
|
union {
|
|
signed int s_int;
|
|
unsigned long ul_int;
|
|
} result;
|
|
};
|
|
|
|
struct meminfo_stack {
|
|
struct meminfo_result *head;
|
|
};
|
|
|
|
|
|
#define MEMINFO_GET( info, actual_enum, type ) \
|
|
procps_meminfo_get( info, actual_enum ) -> result . type
|
|
|
|
#define MEMINFO_VAL( relative_enum, type, stack) \
|
|
stack -> head [ relative_enum ] . result . type
|
|
|
|
|
|
struct meminfo_info;
|
|
|
|
int procps_meminfo_new (struct meminfo_info **info);
|
|
int procps_meminfo_ref (struct meminfo_info *info);
|
|
int procps_meminfo_unref (struct meminfo_info **info);
|
|
|
|
struct meminfo_result *procps_meminfo_get (
|
|
struct meminfo_info *info,
|
|
enum meminfo_item item);
|
|
|
|
struct meminfo_stack *procps_meminfo_select (
|
|
struct meminfo_info *info,
|
|
enum meminfo_item *items,
|
|
int numitems);
|
|
|
|
__END_DECLS
|
|
|
|
#endif
|