library: removed all the 'PROCPS_' enumerator prefixes
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>
This commit is contained in:
Jim Warner
Craig Small
258
proc/pids.h
258
proc/pids.h
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* pids.h - task/thread/process related declarations for libproc
|
||||
* libprocps - Library to read proc filesystem
|
||||
*
|
||||
* Copyright (C) 1998-2005 Albert Cahalan
|
||||
* Copyright (C) 2015 Craig Small <csmall@enc.com.au>
|
||||
@@ -20,145 +20,147 @@
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
*/
|
||||
|
||||
#ifndef _PROC_PIDS_H
|
||||
#define _PROC_PIDS_H
|
||||
#ifndef PROC_PIDS_H
|
||||
#define PROC_PIDS_H
|
||||
|
||||
#include <sys/cdefs.h>
|
||||
|
||||
__BEGIN_DECLS
|
||||
|
||||
enum pids_item {
|
||||
PROCPS_PIDS_noop, // ( never altered )
|
||||
PROCPS_PIDS_extra, // ( reset to zero )
|
||||
PROCPS_PIDS_ADDR_END_CODE, // ul_int
|
||||
PROCPS_PIDS_ADDR_KSTK_EIP, // ul_int
|
||||
PROCPS_PIDS_ADDR_KSTK_ESP, // ul_int
|
||||
PROCPS_PIDS_ADDR_START_CODE, // ul_int
|
||||
PROCPS_PIDS_ADDR_START_STACK, // ul_int
|
||||
PROCPS_PIDS_ALARM, // sl_int
|
||||
PROCPS_PIDS_CGNAME, // str
|
||||
PROCPS_PIDS_CGROUP, // str
|
||||
PROCPS_PIDS_CGROUP_V, // strv
|
||||
PROCPS_PIDS_CMD, // str
|
||||
PROCPS_PIDS_CMDLINE, // str
|
||||
PROCPS_PIDS_CMDLINE_V, // strv
|
||||
PROCPS_PIDS_ENVIRON, // str
|
||||
PROCPS_PIDS_ENVIRON_V, // strv
|
||||
PROCPS_PIDS_EXIT_SIGNAL, // s_int
|
||||
PROCPS_PIDS_FLAGS, // ul_int
|
||||
PROCPS_PIDS_FLT_MAJ, // sl_int
|
||||
PROCPS_PIDS_FLT_MAJ_C, // sl_int
|
||||
PROCPS_PIDS_FLT_MAJ_DELTA, // sl_int
|
||||
PROCPS_PIDS_FLT_MIN, // sl_int
|
||||
PROCPS_PIDS_FLT_MIN_C, // sl_int
|
||||
PROCPS_PIDS_FLT_MIN_DELTA, // sl_int
|
||||
PROCPS_PIDS_ID_EGID, // u_int
|
||||
PROCPS_PIDS_ID_EGROUP, // str
|
||||
PROCPS_PIDS_ID_EUID, // u_int
|
||||
PROCPS_PIDS_ID_EUSER, // str
|
||||
PROCPS_PIDS_ID_FGID, // u_int
|
||||
PROCPS_PIDS_ID_FGROUP, // str
|
||||
PROCPS_PIDS_ID_FUID, // u_int
|
||||
PROCPS_PIDS_ID_FUSER, // str
|
||||
PROCPS_PIDS_ID_PGRP, // s_int
|
||||
PROCPS_PIDS_ID_PID, // s_int
|
||||
PROCPS_PIDS_ID_PPID, // s_int
|
||||
PROCPS_PIDS_ID_RGID, // u_int
|
||||
PROCPS_PIDS_ID_RGROUP, // str
|
||||
PROCPS_PIDS_ID_RUID, // u_int
|
||||
PROCPS_PIDS_ID_RUSER, // str
|
||||
PROCPS_PIDS_ID_SESSION, // s_int
|
||||
PROCPS_PIDS_ID_SGID, // u_int
|
||||
PROCPS_PIDS_ID_SGROUP, // str
|
||||
PROCPS_PIDS_ID_SUID, // u_int
|
||||
PROCPS_PIDS_ID_SUSER, // str
|
||||
PROCPS_PIDS_ID_TGID, // s_int
|
||||
PROCPS_PIDS_ID_TPGID, // s_int
|
||||
PROCPS_PIDS_LXCNAME, // str
|
||||
PROCPS_PIDS_MEM_CODE, // sl_int
|
||||
PROCPS_PIDS_MEM_CODE_KIB, // sl_int
|
||||
PROCPS_PIDS_MEM_DATA, // sl_int
|
||||
PROCPS_PIDS_MEM_DATA_KIB, // sl_int
|
||||
PROCPS_PIDS_MEM_DT, // sl_int
|
||||
PROCPS_PIDS_MEM_LRS, // sl_int
|
||||
PROCPS_PIDS_MEM_RES, // sl_int
|
||||
PROCPS_PIDS_MEM_RES_KIB, // sl_int
|
||||
PROCPS_PIDS_MEM_SHR, // sl_int
|
||||
PROCPS_PIDS_MEM_SHR_KIB, // sl_int
|
||||
PROCPS_PIDS_MEM_VIRT, // sl_int
|
||||
PROCPS_PIDS_MEM_VIRT_KIB, // sl_int
|
||||
PROCPS_PIDS_NICE, // sl_int
|
||||
PROCPS_PIDS_NLWP, // s_int
|
||||
PROCPS_PIDS_NS_IPC, // ul_int
|
||||
PROCPS_PIDS_NS_MNT, // ul_int
|
||||
PROCPS_PIDS_NS_NET, // ul_int
|
||||
PROCPS_PIDS_NS_PID, // ul_int
|
||||
PROCPS_PIDS_NS_USER, // ul_int
|
||||
PROCPS_PIDS_NS_UTS, // ul_int
|
||||
PROCPS_PIDS_OOM_ADJ, // s_int
|
||||
PROCPS_PIDS_OOM_SCORE, // s_int
|
||||
PROCPS_PIDS_PRIORITY, // s_int
|
||||
PROCPS_PIDS_PROCESSOR, // u_int
|
||||
PROCPS_PIDS_RSS, // sl_int
|
||||
PROCPS_PIDS_RSS_RLIM, // ul_int
|
||||
PROCPS_PIDS_RTPRIO, // ul_int
|
||||
PROCPS_PIDS_SCHED_CLASS, // ul_int
|
||||
PROCPS_PIDS_SD_MACH, // str
|
||||
PROCPS_PIDS_SD_OUID, // str
|
||||
PROCPS_PIDS_SD_SEAT, // str
|
||||
PROCPS_PIDS_SD_SESS, // str
|
||||
PROCPS_PIDS_SD_SLICE, // str
|
||||
PROCPS_PIDS_SD_UNIT, // str
|
||||
PROCPS_PIDS_SD_UUNIT, // str
|
||||
PROCPS_PIDS_SIGBLOCKED, // str
|
||||
PROCPS_PIDS_SIGCATCH, // str
|
||||
PROCPS_PIDS_SIGIGNORE, // str
|
||||
PROCPS_PIDS_SIGNALS, // str
|
||||
PROCPS_PIDS_SIGPENDING, // str
|
||||
PROCPS_PIDS_STATE, // s_ch
|
||||
PROCPS_PIDS_SUPGIDS, // str
|
||||
PROCPS_PIDS_SUPGROUPS, // str
|
||||
PROCPS_PIDS_TICS_ALL, // ull_int
|
||||
PROCPS_PIDS_TICS_ALL_C, // ull_int
|
||||
PROCPS_PIDS_TICS_DELTA, // sl_int
|
||||
PROCPS_PIDS_TICS_SYSTEM, // ull_int
|
||||
PROCPS_PIDS_TICS_SYSTEM_C, // ull_int
|
||||
PROCPS_PIDS_TICS_USER, // ull_int
|
||||
PROCPS_PIDS_TICS_USER_C, // ull_int
|
||||
PROCPS_PIDS_TIME_ALL, // ull_int
|
||||
PROCPS_PIDS_TIME_ELAPSED, // ull_int
|
||||
PROCPS_PIDS_TIME_START, // ull_int
|
||||
PROCPS_PIDS_TTY, // s_int
|
||||
PROCPS_PIDS_TTY_NAME, // str
|
||||
PROCPS_PIDS_TTY_NUMBER, // str
|
||||
PROCPS_PIDS_VM_DATA, // sl_int
|
||||
PROCPS_PIDS_VM_EXE, // sl_int
|
||||
PROCPS_PIDS_VM_LIB, // sl_int
|
||||
PROCPS_PIDS_VM_RSS, // sl_int
|
||||
PROCPS_PIDS_VM_RSS_ANON, // sl_int
|
||||
PROCPS_PIDS_VM_RSS_FILE, // sl_int
|
||||
PROCPS_PIDS_VM_RSS_LOCKED, // sl_int
|
||||
PROCPS_PIDS_VM_RSS_SHARED, // sl_int
|
||||
PROCPS_PIDS_VM_SIZE, // sl_int
|
||||
PROCPS_PIDS_VM_STACK, // sl_int
|
||||
PROCPS_PIDS_VM_SWAP, // sl_int
|
||||
PROCPS_PIDS_VM_USED, // sl_int
|
||||
PROCPS_PIDS_VSIZE_PGS, // ul_int
|
||||
PROCPS_PIDS_WCHAN_ADDR, // ul_int
|
||||
PROCPS_PIDS_WCHAN_NAME // str
|
||||
PIDS_noop, // ( never altered )
|
||||
PIDS_extra, // ( reset to zero )
|
||||
PIDS_ADDR_END_CODE, // ul_int
|
||||
PIDS_ADDR_KSTK_EIP, // ul_int
|
||||
PIDS_ADDR_KSTK_ESP, // ul_int
|
||||
PIDS_ADDR_START_CODE, // ul_int
|
||||
PIDS_ADDR_START_STACK, // ul_int
|
||||
PIDS_ALARM, // sl_int
|
||||
PIDS_CGNAME, // str
|
||||
PIDS_CGROUP, // str
|
||||
PIDS_CGROUP_V, // strv
|
||||
PIDS_CMD, // str
|
||||
PIDS_CMDLINE, // str
|
||||
PIDS_CMDLINE_V, // strv
|
||||
PIDS_ENVIRON, // str
|
||||
PIDS_ENVIRON_V, // strv
|
||||
PIDS_EXIT_SIGNAL, // s_int
|
||||
PIDS_FLAGS, // ul_int
|
||||
PIDS_FLT_MAJ, // sl_int
|
||||
PIDS_FLT_MAJ_C, // sl_int
|
||||
PIDS_FLT_MAJ_DELTA, // sl_int
|
||||
PIDS_FLT_MIN, // sl_int
|
||||
PIDS_FLT_MIN_C, // sl_int
|
||||
PIDS_FLT_MIN_DELTA, // sl_int
|
||||
PIDS_ID_EGID, // u_int
|
||||
PIDS_ID_EGROUP, // str
|
||||
PIDS_ID_EUID, // u_int
|
||||
PIDS_ID_EUSER, // str
|
||||
PIDS_ID_FGID, // u_int
|
||||
PIDS_ID_FGROUP, // str
|
||||
PIDS_ID_FUID, // u_int
|
||||
PIDS_ID_FUSER, // str
|
||||
PIDS_ID_PGRP, // s_int
|
||||
PIDS_ID_PID, // s_int
|
||||
PIDS_ID_PPID, // s_int
|
||||
PIDS_ID_RGID, // u_int
|
||||
PIDS_ID_RGROUP, // str
|
||||
PIDS_ID_RUID, // u_int
|
||||
PIDS_ID_RUSER, // str
|
||||
PIDS_ID_SESSION, // s_int
|
||||
PIDS_ID_SGID, // u_int
|
||||
PIDS_ID_SGROUP, // str
|
||||
PIDS_ID_SUID, // u_int
|
||||
PIDS_ID_SUSER, // str
|
||||
PIDS_ID_TGID, // s_int
|
||||
PIDS_ID_TPGID, // s_int
|
||||
PIDS_LXCNAME, // str
|
||||
PIDS_MEM_CODE, // sl_int
|
||||
PIDS_MEM_CODE_KIB, // sl_int
|
||||
PIDS_MEM_DATA, // sl_int
|
||||
PIDS_MEM_DATA_KIB, // sl_int
|
||||
PIDS_MEM_DT, // sl_int
|
||||
PIDS_MEM_LRS, // sl_int
|
||||
PIDS_MEM_RES, // sl_int
|
||||
PIDS_MEM_RES_KIB, // sl_int
|
||||
PIDS_MEM_SHR, // sl_int
|
||||
PIDS_MEM_SHR_KIB, // sl_int
|
||||
PIDS_MEM_VIRT, // sl_int
|
||||
PIDS_MEM_VIRT_KIB, // sl_int
|
||||
PIDS_NICE, // sl_int
|
||||
PIDS_NLWP, // s_int
|
||||
PIDS_NS_IPC, // ul_int
|
||||
PIDS_NS_MNT, // ul_int
|
||||
PIDS_NS_NET, // ul_int
|
||||
PIDS_NS_PID, // ul_int
|
||||
PIDS_NS_USER, // ul_int
|
||||
PIDS_NS_UTS, // ul_int
|
||||
PIDS_OOM_ADJ, // s_int
|
||||
PIDS_OOM_SCORE, // s_int
|
||||
PIDS_PRIORITY, // s_int
|
||||
PIDS_PROCESSOR, // u_int
|
||||
PIDS_RSS, // sl_int
|
||||
PIDS_RSS_RLIM, // ul_int
|
||||
PIDS_RTPRIO, // ul_int
|
||||
PIDS_SCHED_CLASS, // ul_int
|
||||
PIDS_SD_MACH, // str
|
||||
PIDS_SD_OUID, // str
|
||||
PIDS_SD_SEAT, // str
|
||||
PIDS_SD_SESS, // str
|
||||
PIDS_SD_SLICE, // str
|
||||
PIDS_SD_UNIT, // str
|
||||
PIDS_SD_UUNIT, // str
|
||||
PIDS_SIGBLOCKED, // str
|
||||
PIDS_SIGCATCH, // str
|
||||
PIDS_SIGIGNORE, // str
|
||||
PIDS_SIGNALS, // str
|
||||
PIDS_SIGPENDING, // str
|
||||
PIDS_STATE, // s_ch
|
||||
PIDS_SUPGIDS, // str
|
||||
PIDS_SUPGROUPS, // str
|
||||
PIDS_TICS_ALL, // ull_int
|
||||
PIDS_TICS_ALL_C, // ull_int
|
||||
PIDS_TICS_DELTA, // sl_int
|
||||
PIDS_TICS_SYSTEM, // ull_int
|
||||
PIDS_TICS_SYSTEM_C, // ull_int
|
||||
PIDS_TICS_USER, // ull_int
|
||||
PIDS_TICS_USER_C, // ull_int
|
||||
PIDS_TIME_ALL, // ull_int
|
||||
PIDS_TIME_ELAPSED, // ull_int
|
||||
PIDS_TIME_START, // ull_int
|
||||
PIDS_TTY, // s_int
|
||||
PIDS_TTY_NAME, // str
|
||||
PIDS_TTY_NUMBER, // str
|
||||
PIDS_VM_DATA, // sl_int
|
||||
PIDS_VM_EXE, // sl_int
|
||||
PIDS_VM_LIB, // sl_int
|
||||
PIDS_VM_RSS, // sl_int
|
||||
PIDS_VM_RSS_ANON, // sl_int
|
||||
PIDS_VM_RSS_FILE, // sl_int
|
||||
PIDS_VM_RSS_LOCKED, // sl_int
|
||||
PIDS_VM_RSS_SHARED, // sl_int
|
||||
PIDS_VM_SIZE, // sl_int
|
||||
PIDS_VM_STACK, // sl_int
|
||||
PIDS_VM_SWAP, // sl_int
|
||||
PIDS_VM_USED, // sl_int
|
||||
PIDS_VSIZE_PGS, // ul_int
|
||||
PIDS_WCHAN_ADDR, // ul_int
|
||||
PIDS_WCHAN_NAME // str
|
||||
};
|
||||
|
||||
enum pids_fetch_type {
|
||||
PROCPS_FETCH_TASKS_ONLY,
|
||||
PROCPS_FETCH_THREADS_TOO
|
||||
PIDS_FETCH_TASKS_ONLY,
|
||||
PIDS_FETCH_THREADS_TOO
|
||||
};
|
||||
|
||||
enum pids_select_type {
|
||||
PROCPS_SELECT_PID = 0x1000,
|
||||
PROCPS_SELECT_UID = 0x4000
|
||||
PIDS_SELECT_PID = 0x1000,
|
||||
PIDS_SELECT_UID = 0x4000
|
||||
};
|
||||
|
||||
enum pids_sort_order {
|
||||
PROCPS_PIDS_ASCEND = +1,
|
||||
PROCPS_PIDS_DESCEND = -1
|
||||
PIDS_SORT_ASCEND = +1,
|
||||
PIDS_SORT_DESCEND = -1
|
||||
};
|
||||
|
||||
|
||||
@@ -191,7 +193,7 @@ struct pids_fetch {
|
||||
};
|
||||
|
||||
|
||||
#define PROCPS_PIDS_VAL( relative_enum, type, stack ) \
|
||||
#define PIDS_VAL( relative_enum, type, stack ) \
|
||||
stack -> head [ relative_enum ] . result . type
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user