| 3 |
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
| 4 |
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
| 5 |
|
|
| 6 |
< |
<refentry id="get_process_stats"> |
| 6 |
> |
<refentry id="sg_get_process_stats"> |
| 7 |
|
|
| 8 |
|
<refentryinfo> |
| 9 |
|
<date>$Date$</date> |
| 10 |
|
<releaseinfo>$Id$</releaseinfo> |
| 11 |
|
</refentryinfo> |
| 12 |
< |
|
| 12 |
> |
|
| 13 |
|
<refmeta> |
| 14 |
< |
<refentrytitle>get_process_stats</refentrytitle> |
| 14 |
> |
<refentrytitle>sg_get_process_stats</refentrytitle> |
| 15 |
|
<manvolnum>3</manvolnum> |
| 16 |
|
<refmiscinfo>i-scream</refmiscinfo> |
| 17 |
|
</refmeta> |
| 18 |
< |
|
| 18 |
> |
|
| 19 |
|
<refnamediv> |
| 20 |
< |
<refname>get_process_stats</refname> |
| 20 |
> |
<refname>sg_get_process_stats</refname> |
| 21 |
> |
<refname>sg_get_process_count</refname> |
| 22 |
|
<refpurpose>get process statistics</refpurpose> |
| 23 |
|
</refnamediv> |
| 24 |
< |
|
| 24 |
> |
|
| 25 |
|
<refsynopsisdiv> |
| 26 |
|
<funcsynopsis> |
| 27 |
|
<funcsynopsisinfo>#include <statgrab.h></funcsynopsisinfo> |
| 28 |
|
<funcprototype> |
| 29 |
< |
<funcdef>process_stat_t *<function>get_process_stats</function></funcdef> |
| 29 |
> |
<funcdef>sg_process_stats *<function>sg_get_process_stats</function></funcdef> |
| 30 |
> |
<paramdef>int *<parameter>entries</parameter></paramdef> |
| 31 |
> |
</funcprototype> |
| 32 |
> |
<funcprototype> |
| 33 |
> |
<funcdef>sg_process_count *<function>sg_get_process_count</function></funcdef> |
| 34 |
|
<void/> |
| 35 |
|
</funcprototype> |
| 36 |
|
</funcsynopsis> |
| 37 |
|
</refsynopsisdiv> |
| 38 |
< |
|
| 38 |
> |
|
| 39 |
|
<refsect1> |
| 40 |
|
<title>Description</title> |
| 41 |
|
<para> |
| 42 |
< |
<function>get_process_stats</function> returns a pointer to a |
| 43 |
< |
static buffer of type <structname>process_stat_t</structname>. |
| 42 |
> |
The <function>sg_get_process_stats</function> takes a pointer to |
| 43 |
> |
an int, <parameter>entries</parameter>, which is filled with the |
| 44 |
> |
number of processes the snapshot contains. The return value is a |
| 45 |
> |
pointer to the first member of an array of |
| 46 |
> |
<structname>sg_process_stats</structname> structures; the number |
| 47 |
> |
of entries in the array is returned in |
| 48 |
> |
<parameter>entries</parameter>. |
| 49 |
|
</para> |
| 50 |
|
<para> |
| 51 |
< |
It provides information on the number of processes and the |
| 52 |
< |
system and the different states they're in. |
| 51 |
> |
<function>sg_get_process_count</function> returns a pointer to a |
| 52 |
> |
static buffer of type <structname>sg_process_count</structname>. |
| 53 |
|
</para> |
| 54 |
+ |
<para> |
| 55 |
+ |
These two functions provide information on the process running |
| 56 |
+ |
on the system. In the first case lots of detail is provided, and |
| 57 |
+ |
in the second case a summary of the states of the current processes. |
| 58 |
+ |
</para> |
| 59 |
|
</refsect1> |
| 60 |
< |
|
| 60 |
> |
|
| 61 |
|
<refsect1> |
| 62 |
|
<title>Return Values</title> |
| 63 |
|
|
| 64 |
|
<para> |
| 65 |
< |
The structure returned is of type |
| 66 |
< |
<structname>process_stat_t</structname>. |
| 65 |
> |
The structure returned by sg_get_process_stats is of type |
| 66 |
> |
<structname>sg_process_stats</structname>. |
| 67 |
|
</para> |
| 68 |
|
|
| 69 |
|
<programlisting> |
| 70 |
+ |
typedef struct { |
| 71 |
+ |
char *process_name; |
| 72 |
+ |
char *proctitle; |
| 73 |
+ |
|
| 74 |
+ |
pid_t pid; |
| 75 |
+ |
pid_t parent; /* Parent pid */ |
| 76 |
+ |
pid_t pgid; /* process id of process group leader */ |
| 77 |
+ |
|
| 78 |
+ |
uid_t uid; |
| 79 |
+ |
uid_t euid; |
| 80 |
+ |
gid_t gid; |
| 81 |
+ |
gid_t egid; |
| 82 |
+ |
|
| 83 |
+ |
unsigned long long proc_size; /* in bytes */ |
| 84 |
+ |
unsigned long long proc_resident; /* in bytes */ |
| 85 |
+ |
time_t time_spent; /* time running in seconds */ |
| 86 |
+ |
double cpu_percent; |
| 87 |
+ |
int nice; |
| 88 |
+ |
sg_process_state state; |
| 89 |
+ |
} sg_process_stats; |
| 90 |
+ |
</programlisting> |
| 91 |
+ |
|
| 92 |
+ |
<programlisting> |
| 93 |
+ |
typedef enum { |
| 94 |
+ |
SG_PROCESS_STATE_RUNNING, |
| 95 |
+ |
SG_PROCESS_STATE_SLEEPING, |
| 96 |
+ |
SG_PROCESS_STATE_STOPPED, |
| 97 |
+ |
SG_PROCESS_STATE_ZOMBIE, |
| 98 |
+ |
SG_PROCESS_STATE_UNKNOWN |
| 99 |
+ |
} sg_process_state; |
| 100 |
+ |
</programlisting> |
| 101 |
+ |
|
| 102 |
+ |
<variablelist> |
| 103 |
+ |
<varlistentry> |
| 104 |
+ |
<term><structfield>process_name</structfield></term> |
| 105 |
+ |
<listitem> |
| 106 |
+ |
<para> |
| 107 |
+ |
The name of the command that was run. |
| 108 |
+ |
</para> |
| 109 |
+ |
</listitem> |
| 110 |
+ |
</varlistentry> |
| 111 |
+ |
<varlistentry> |
| 112 |
+ |
<term><structfield>proctitle</structfield></term> |
| 113 |
+ |
<listitem> |
| 114 |
+ |
<para> |
| 115 |
+ |
The command line (the "title") of the process. Take |
| 116 |
+ |
note - this can be modified by the process, so isn't |
| 117 |
+ |
guaranteed to be the original command line. |
| 118 |
+ |
</para> |
| 119 |
+ |
</listitem> |
| 120 |
+ |
</varlistentry> |
| 121 |
+ |
<varlistentry> |
| 122 |
+ |
<term><structfield>pid</structfield></term> |
| 123 |
+ |
<listitem> |
| 124 |
+ |
<para> |
| 125 |
+ |
The process ID. |
| 126 |
+ |
</para> |
| 127 |
+ |
</listitem> |
| 128 |
+ |
</varlistentry> |
| 129 |
+ |
<varlistentry> |
| 130 |
+ |
<term><structfield>parent</structfield></term> |
| 131 |
+ |
<listitem> |
| 132 |
+ |
<para> |
| 133 |
+ |
The parent process ID. |
| 134 |
+ |
</para> |
| 135 |
+ |
</listitem> |
| 136 |
+ |
</varlistentry> |
| 137 |
+ |
<varlistentry> |
| 138 |
+ |
<term><structfield>pgid</structfield></term> |
| 139 |
+ |
<listitem> |
| 140 |
+ |
<para> |
| 141 |
+ |
The process ID of the process group leader. |
| 142 |
+ |
</para> |
| 143 |
+ |
</listitem> |
| 144 |
+ |
</varlistentry> |
| 145 |
+ |
<varlistentry> |
| 146 |
+ |
<term><structfield>uid</structfield></term> |
| 147 |
+ |
<listitem> |
| 148 |
+ |
<para> |
| 149 |
+ |
The UID the process is running as. |
| 150 |
+ |
</para> |
| 151 |
+ |
</listitem> |
| 152 |
+ |
</varlistentry> |
| 153 |
+ |
<varlistentry> |
| 154 |
+ |
<term><structfield>euid</structfield></term> |
| 155 |
+ |
<listitem> |
| 156 |
+ |
<para> |
| 157 |
+ |
The effective UID the process is running as. |
| 158 |
+ |
</para> |
| 159 |
+ |
</listitem> |
| 160 |
+ |
</varlistentry> |
| 161 |
+ |
<varlistentry> |
| 162 |
+ |
<term><structfield>gid</structfield></term> |
| 163 |
+ |
<listitem> |
| 164 |
+ |
<para> |
| 165 |
+ |
The GID the process is running as. |
| 166 |
+ |
</para> |
| 167 |
+ |
</listitem> |
| 168 |
+ |
</varlistentry> |
| 169 |
+ |
<varlistentry> |
| 170 |
+ |
<term><structfield>egid</structfield></term> |
| 171 |
+ |
<listitem> |
| 172 |
+ |
<para> |
| 173 |
+ |
The effective GID the process is running as. |
| 174 |
+ |
</para> |
| 175 |
+ |
</listitem> |
| 176 |
+ |
</varlistentry> |
| 177 |
+ |
<varlistentry> |
| 178 |
+ |
<term><structfield>proc_size</structfield></term> |
| 179 |
+ |
<listitem> |
| 180 |
+ |
<para> |
| 181 |
+ |
The size of the process in bytes. |
| 182 |
+ |
</para> |
| 183 |
+ |
</listitem> |
| 184 |
+ |
</varlistentry> |
| 185 |
+ |
<varlistentry> |
| 186 |
+ |
<term><structfield>proc_resident</structfield></term> |
| 187 |
+ |
<listitem> |
| 188 |
+ |
<para> |
| 189 |
+ |
The size of the process that's resident in memory. |
| 190 |
+ |
</para> |
| 191 |
+ |
</listitem> |
| 192 |
+ |
</varlistentry> |
| 193 |
+ |
<varlistentry> |
| 194 |
+ |
<term><structfield>time_spent</structfield></term> |
| 195 |
+ |
<listitem> |
| 196 |
+ |
<para> |
| 197 |
+ |
The number of seconds the process has been running. |
| 198 |
+ |
</para> |
| 199 |
+ |
</listitem> |
| 200 |
+ |
</varlistentry> |
| 201 |
+ |
<varlistentry> |
| 202 |
+ |
<term><structfield>cpu_percent</structfield></term> |
| 203 |
+ |
<listitem> |
| 204 |
+ |
<para> |
| 205 |
+ |
The current percentage of CPU the process is using. |
| 206 |
+ |
</para> |
| 207 |
+ |
</listitem> |
| 208 |
+ |
</varlistentry> |
| 209 |
+ |
<varlistentry> |
| 210 |
+ |
<term><structfield>nice</structfield></term> |
| 211 |
+ |
<listitem> |
| 212 |
+ |
<para> |
| 213 |
+ |
The nice value of the process. |
| 214 |
+ |
</para> |
| 215 |
+ |
</listitem> |
| 216 |
+ |
</varlistentry> |
| 217 |
+ |
<varlistentry> |
| 218 |
+ |
<term><structfield>state</structfield></term> |
| 219 |
+ |
<listitem> |
| 220 |
+ |
<para> |
| 221 |
+ |
The current state of the process. See sg_process_state |
| 222 |
+ |
for permitted values. |
| 223 |
+ |
</para> |
| 224 |
+ |
</listitem> |
| 225 |
+ |
</varlistentry> |
| 226 |
+ |
</variablelist> |
| 227 |
+ |
|
| 228 |
+ |
<para> |
| 229 |
+ |
The structure returned by sg_get_process_count is of type |
| 230 |
+ |
<structname>sg_process_count</structname>. |
| 231 |
+ |
</para> |
| 232 |
+ |
|
| 233 |
+ |
<programlisting> |
| 234 |
|
typedef struct{ |
| 235 |
|
int total; |
| 236 |
|
int running; |
| 237 |
|
int sleeping; |
| 238 |
|
int stopped; |
| 239 |
|
int zombie; |
| 240 |
< |
}process_stat_t; |
| 240 |
> |
}sg_process_count; |
| 241 |
|
</programlisting> |
| 242 |
|
|
| 243 |
|
<variablelist> |
| 296 |
|
</member> |
| 297 |
|
</simplelist> |
| 298 |
|
</refsect1> |
| 299 |
< |
|
| 299 |
> |
|
| 300 |
|
<refsect1> |
| 301 |
|
<title>Website</title> |
| 302 |
< |
|
| 302 |
> |
|
| 303 |
|
<simplelist type="vert"> |
| 304 |
|
<member> |
| 305 |
< |
<ulink url="http://www.i-scream.org">http://www.i-scream.org</ulink> |
| 305 |
> |
<ulink url="http://www.i-scream.org/libstatgrab/"> |
| 306 |
> |
http://www.i-scream.org/libstatgrab/ |
| 307 |
> |
</ulink> |
| 308 |
|
</member> |
| 309 |
|
</simplelist> |
| 310 |
|
</refsect1> |
