7e6a371d8a
This commit is the culmination of efforts to modernize the library api. It should be treated as a first blush attempt, especially since I have absolutely no library design experience. But I did have a very strong desire to lessen the new library's impact on the top program. Under this new api, a 'stack' is the equivalent of the old proc_t. It can be seen as a variable length record whose contents & order is under complete user control. That initial stack/record configuration is established at procps_pids_new() time and will probably serve most program needs. But, a dynamic & demanding program like top will later change a stack via procps_pids_reset(). For programs like top & ps, procps_pids_reap() will be the function that will retrieve all tasks and threads. Any program that needs to filter / select only certain processes or users have available other functions that can be used: procps_pids_stacks_alloc, fill & dealloc. This implementation attempts to maximize that existing proven libprocps code base. As we gain more experience such actual code can be migrated into the pids.c file. Signed-off-by: Jim Warner <james.warner@comcast.net>
233 lines
7.9 KiB
C
233 lines
7.9 KiB
C
/*
|
|
* pids.h - task/thread/process related declarations for libproc
|
|
*
|
|
* Copyright (C) 1998-2005 Albert Cahalan
|
|
* Copyright (C) 2015 Craig Small <csmall@enc.com.au>
|
|
* Copyright (C) 2015 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_PIDS_H
|
|
#define _PROC_PIDS_H
|
|
|
|
__BEGIN_DECLS
|
|
|
|
enum pids_item {
|
|
PROCPS_PIDS_ADDR_END_CODE, // addr
|
|
PROCPS_PIDS_ADDR_KSTK_EIP, // addr
|
|
PROCPS_PIDS_ADDR_KSTK_ESP, // addr
|
|
PROCPS_PIDS_ADDR_START_CODE, // addr
|
|
PROCPS_PIDS_ADDR_START_STACK, // addr
|
|
PROCPS_PIDS_ALARM, // sl_int
|
|
PROCPS_PIDS_CGROUP, // str
|
|
PROCPS_PIDS_CMD, // str
|
|
PROCPS_PIDS_CMDLINE, // str
|
|
PROCPS_PIDS_ENVIRON, // str
|
|
PROCPS_PIDS_EXIT_SIGNAL, // s_int
|
|
PROCPS_PIDS_FLAGS, // ul_int
|
|
PROCPS_PIDS_FLT_MAJ, // ul_int
|
|
PROCPS_PIDS_FLT_MAJ_C, // ul_int
|
|
PROCPS_PIDS_FLT_MAJ_DELTA, // ul_int
|
|
PROCPS_PIDS_FLT_MIN, // ul_int
|
|
PROCPS_PIDS_FLT_MIN_C, // ul_int
|
|
PROCPS_PIDS_FLT_MIN_DELTA, // ul_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, // ul_int
|
|
PROCPS_PIDS_MEM_DATA, // sl_int
|
|
PROCPS_PIDS_MEM_DATA_KIB, // ul_int
|
|
PROCPS_PIDS_MEM_DT, // sl_int
|
|
PROCPS_PIDS_MEM_LRS, // sl_int
|
|
PROCPS_PIDS_MEM_RES, // sl_int
|
|
PROCPS_PIDS_MEM_RES_KIB, // ul_int
|
|
PROCPS_PIDS_MEM_SHR, // sl_int
|
|
PROCPS_PIDS_MEM_SHR_KIB, // ul_int
|
|
PROCPS_PIDS_MEM_VIRT, // sl_int
|
|
PROCPS_PIDS_MEM_VIRT_KIB, // ul_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, // u_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_START, // ull_int
|
|
PROCPS_PIDS_TTY, // s_int
|
|
PROCPS_PIDS_VM_DATA, // ul_int
|
|
PROCPS_PIDS_VM_EXE, // ul_int
|
|
PROCPS_PIDS_VM_LIB, // ul_int
|
|
PROCPS_PIDS_VM_LOCK, // ul_int
|
|
PROCPS_PIDS_VM_RSS, // ul_int
|
|
PROCPS_PIDS_VM_SIZE, // ul_int
|
|
PROCPS_PIDS_VM_STACK, // ul_int
|
|
PROCPS_PIDS_VM_SWAP, // ul_int
|
|
PROCPS_PIDS_VM_USED, // ul_int
|
|
PROCPS_PIDS_VSIZE_PGS, // ul_int
|
|
PROCPS_PIDS_WCHAN_ADDR, // addr
|
|
PROCPS_PIDS_WCHAN_NAME, // str
|
|
PROCPS_PIDS_noop // n/a
|
|
};
|
|
|
|
enum pids_fill_type {
|
|
PROCPS_FILL_PID = 0x1000,
|
|
PROCPS_FILL_UID = 0x4000
|
|
};
|
|
|
|
enum pids_reap_type {
|
|
PROCPS_REAP_TASKS_ONLY = 0,
|
|
PROCPS_REAP_THREADS_TOO = 1
|
|
};
|
|
|
|
enum pids_sort_order {
|
|
PROCPS_SORT_ASCEND = -1,
|
|
PROCPS_SORT_DESCEND = +1
|
|
};
|
|
|
|
|
|
struct procps_pidsinfo;
|
|
|
|
struct pids_result {
|
|
enum pids_item item;
|
|
union {
|
|
char s_ch;
|
|
int s_int;
|
|
unsigned int u_int;
|
|
long sl_int;
|
|
unsigned long ul_int;
|
|
unsigned long long ull_int;
|
|
void * addr;
|
|
const char * str;
|
|
} result;
|
|
};
|
|
|
|
struct pids_stack {
|
|
struct pids_result *head;
|
|
unsigned fill_id;
|
|
};
|
|
|
|
struct pids_stacks {
|
|
struct pids_stack **stacks;
|
|
};
|
|
|
|
struct pids_counts {
|
|
int total;
|
|
int running, sleeping, stopped, zombied;
|
|
};
|
|
|
|
struct pids_reap {
|
|
struct pids_stacks reaped;
|
|
struct pids_counts counts;
|
|
};
|
|
|
|
|
|
int procps_pids_new (
|
|
struct procps_pidsinfo **info,
|
|
int maxitems,
|
|
enum pids_item *items);
|
|
|
|
struct pids_reap *procps_pids_reap (
|
|
struct procps_pidsinfo *info,
|
|
enum pids_reap_type which);
|
|
|
|
int procps_pids_ref (
|
|
struct procps_pidsinfo *info);
|
|
|
|
int procps_pids_reset (
|
|
struct procps_pidsinfo *info,
|
|
int newmaxitems,
|
|
enum pids_item *newitems);
|
|
|
|
struct pids_stacks *procps_pids_stacks_alloc (
|
|
struct procps_pidsinfo *info,
|
|
int maxstacks);
|
|
|
|
int procps_pids_stacks_dealloc (
|
|
struct procps_pidsinfo *info,
|
|
struct pids_stacks **these);
|
|
|
|
struct pids_counts *procps_pids_stacks_fill (
|
|
struct procps_pidsinfo *info,
|
|
struct pids_stacks *these,
|
|
int maxstacks,
|
|
enum pids_fill_type which);
|
|
|
|
struct pids_stack **procps_pids_stacks_sort (
|
|
struct procps_pidsinfo *info,
|
|
struct pids_stack **stacks,
|
|
int numstacked,
|
|
enum pids_item sort,
|
|
enum pids_sort_order order);
|
|
|
|
int procps_pids_unref (
|
|
struct procps_pidsinfo **info);
|
|
|
|
__END_DECLS
|
|
|
|
#endif /* _PROC_PIDS_H */
|