src/libstatgrab/statgrab.h

/*
 * i-scream libstatgrab
 * http://www.i-scream.org
 * Copyright (C) 2000-2004 i-scream
 * 
 * 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., 59 Temple Place, Suite 330, Boston, MA
 * 02111-1307 USA
 *
 * $Id: statgrab.h,v 1.48 2004/04/08 13:16:05 ats Exp $
 */

#include <sys/types.h>

/* FIXME typedefs for 32/64-bit types */
/* FIXME maybe tidy up field names? */
/* FIXME comments for less obvious fields */

int sg_init(void);
int sg_drop_privileges(void);

typedef enum {
        SG_ERROR_NONE = 0,
        SG_ERROR_ASPRINTF,
        SG_ERROR_DEVSTAT_GETDEVS,
        SG_ERROR_DEVSTAT_SELECTDEVS,
        SG_ERROR_ENOENT,
        SG_ERROR_GETIFADDRS,
        SG_ERROR_GETMNTINFO,
        SG_ERROR_GETPAGESIZE,
        SG_ERROR_KSTAT_DATA_LOOKUP,
        SG_ERROR_KSTAT_LOOKUP,
        SG_ERROR_KSTAT_OPEN,
        SG_ERROR_KSTAT_READ,
        SG_ERROR_KVM_GETSWAPINFO,
        SG_ERROR_KVM_OPENFILES,
        SG_ERROR_MALLOC,
        SG_ERROR_OPEN,
        SG_ERROR_OPENDIR,
        SG_ERROR_PARSE,
        SG_ERROR_SETEGID,
        SG_ERROR_SETEUID,
        SG_ERROR_SETMNTENT,
        SG_ERROR_SOCKET,
        SG_ERROR_SWAPCTL,
        SG_ERROR_SYSCONF,
        SG_ERROR_SYSCTL,
        SG_ERROR_SYSCTLBYNAME,
        SG_ERROR_SYSCTLNAMETOMIB,
        SG_ERROR_UNAME,
        SG_ERROR_UNSUPPORTED,
        SG_ERROR_XSW_VER_MISMATCH
} sg_error;

void sg_set_error(sg_error code, const char *arg);
sg_error sg_get_error();
const char *sg_get_error_arg();
const char *sg_str_error(sg_error code);

typedef struct {
        char *os_name;
        char *os_release;
        char *os_version;
        char *platform;
        char *hostname;
        time_t uptime;
} sg_host_info;

sg_host_info *sg_get_host_info();

typedef struct {
        long long user;
        long long kernel;
        long long idle;
        long long iowait;
        long long swap;
        long long nice;
        long long total;
        time_t systime;
} sg_cpu_stats;

sg_cpu_stats *sg_get_cpu_stats();
sg_cpu_stats *sg_get_cpu_stats_diff();

typedef struct {
        float user;
        float kernel;
        float idle;
        float iowait;
        float swap;
        float nice;
        time_t time_taken;
} sg_cpu_percents;

sg_cpu_percents *sg_get_cpu_percents();

typedef struct {
        long long total;
        long long free;
        long long used;
        long long cache;
} sg_mem_stats;

sg_mem_stats *sg_get_mem_stats();

typedef struct {
        double min1;
        double min5;
        double min15;
} sg_load_stats;

sg_load_stats *sg_get_load_stats();

typedef struct {
        char *name_list;
        int num_entries;
} sg_user_stats;

sg_user_stats *sg_get_user_stats();

typedef struct {
        long long total;
        long long used;
        long long free;
} sg_swap_stats;

sg_swap_stats *sg_get_swap_stats();

typedef struct {
        char *device_name;
        char *fs_type;
        char *mnt_point;
        long long size;
        long long used;
        long long avail;
        long long total_inodes;
        long long used_inodes;
        long long free_inodes;
} sg_fs_stats;

sg_fs_stats *sg_get_fs_stats(int *entries);

int sg_fs_compare_device_name(const void *va, const void *vb);
int sg_fs_compare_mnt_point(const void *va, const void *vb);

typedef struct {
        char *disk_name;
        long long read_bytes;
        long long write_bytes;
        time_t systime;
} sg_disk_io_stats;

sg_disk_io_stats *sg_get_disk_io_stats(int *entries);
sg_disk_io_stats *sg_get_disk_io_stats_diff(int *entries);

int sg_disk_io_compare_name(const void *va, const void *vb);

typedef struct {
        char *interface_name;
        long long tx;
        long long rx;
        long long ipackets;
        long long opackets;
        long long ierrors;
        long long oerrors;
        long long collisions;
        time_t systime;
} sg_network_io_stats;

sg_network_io_stats *sg_get_network_io_stats(int *entries);
sg_network_io_stats *sg_get_network_io_stats_diff(int *entries);

int sg_network_io_compare_name(const void *va, const void *vb);

typedef enum {
        SG_IFACE_DUPLEX_FULL,
        SG_IFACE_DUPLEX_HALF,
        SG_IFACE_DUPLEX_UNKNOWN
} sg_iface_duplex;

typedef struct {
        char *interface_name;
        int speed;      /* In megabits/sec */
        sg_iface_duplex dup;
        int up;
} sg_network_iface_stats;

sg_network_iface_stats *sg_get_network_iface_stats(int *entries);

int sg_network_iface_compare_name(const void *va, const void *vb);

typedef struct {
        long long pages_pagein;
        long long pages_pageout;
        time_t systime;
} sg_page_stats;

sg_page_stats *sg_get_page_stats();
sg_page_stats *sg_get_page_stats_diff();

typedef enum {
        SG_PROCESS_STATE_RUNNING,
        SG_PROCESS_STATE_SLEEPING,
        SG_PROCESS_STATE_STOPPED,
        SG_PROCESS_STATE_ZOMBIE,
        SG_PROCESS_STATE_UNKNOWN
} sg_process_state;

typedef struct {
        char *process_name;
        char *proctitle;

        pid_t pid;
        pid_t parent; /* Parent pid */
        pid_t pgid;   /* process id of process group leader */

        uid_t uid;
        uid_t euid;
        gid_t gid;
        gid_t egid;

        unsigned long long proc_size; /* in bytes */
        unsigned long long proc_resident; /* in bytes */
        time_t time_spent; /* time running in seconds */
        double cpu_percent;
        int nice;
        sg_process_state state;
} sg_process_stats;

sg_process_stats *sg_get_process_stats(int *entries);

int sg_process_compare_name(const void *va, const void *vb);
int sg_process_compare_pid(const void *va, const void *vb);
int sg_process_compare_uid(const void *va, const void *vb);
int sg_process_compare_gid(const void *va, const void *vb);
int sg_process_compare_size(const void *va, const void *vb);
int sg_process_compare_res(const void *va, const void *vb);
int sg_process_compare_cpu(const void *va, const void *vb);
int sg_process_compare_time(const void *va, const void *vb);

typedef struct {
        int total;
        int running;
        int sleeping;
        int stopped;
        int zombie;
} sg_process_count;

sg_process_count *sg_get_process_count();

#ifdef SG_ENABLE_DEPRECATED
#include <statgrab_deprecated.h>
#endif

Revision:	1.49
Committed:	Thu Apr 8 13:44:44 2004 UTC (20 years, 1 month ago) by ats
Content type:	text/plain
Branch:	MAIN
CVS Tags:	LIBSTATGRAB_0_10
Changes since 1.48:	+11 -1 lines
Log Message:	Add comparison functions for names where that's likely to be useful. Make the network_iface_stats example show how to use bsearch to find an interface by name.
#	User	Rev	Content
1	tdb	1.22	/*
2	tdb	1.34	* i-scream libstatgrab
3	tdb	1.13	* http://www.i-scream.org
4	tdb	1.22	* Copyright (C) 2000-2004 i-scream
5	pajs	1.1	*
6	tdb	1.22	* This library is free software; you can redistribute it and/or
7			* modify it under the terms of the GNU Lesser General Public
8			* License as published by the Free Software Foundation; either
9			* version 2.1 of the License, or (at your option) any later version.
10	pajs	1.1	*
11	tdb	1.22	* This library is distributed in the hope that it will be useful,
12	pajs	1.1	* but WITHOUT ANY WARRANTY; without even the implied warranty of
13	tdb	1.22	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14			* Lesser General Public License for more details.
15	pajs	1.1	*
16	tdb	1.22	* You should have received a copy of the GNU Lesser General Public
17			* License along with this library; if not, write to the Free Software
18			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19			* 02111-1307 USA
20	tdb	1.23	*
21	ats	1.49	* $Id: statgrab.h,v 1.48 2004/04/08 13:16:05 ats Exp $
22	pajs	1.1	*/
23
24	pajs	1.21	#include <sys/types.h>
25
26	ats	1.33	/* FIXME typedefs for 32/64-bit types */
27			/* FIXME maybe tidy up field names? */
28			/* FIXME comments for less obvious fields */
29
30			int sg_init(void);
31			int sg_drop_privileges(void);
32	tdb	1.36
33			typedef enum {
34	tdb	1.38	SG_ERROR_NONE = 0,
35	tdb	1.42	SG_ERROR_ASPRINTF,
36			SG_ERROR_DEVSTAT_GETDEVS,
37			SG_ERROR_DEVSTAT_SELECTDEVS,
38			SG_ERROR_ENOENT,
39			SG_ERROR_GETIFADDRS,
40			SG_ERROR_GETMNTINFO,
41			SG_ERROR_GETPAGESIZE,
42			SG_ERROR_KSTAT_DATA_LOOKUP,
43			SG_ERROR_KSTAT_LOOKUP,
44			SG_ERROR_KSTAT_OPEN,
45			SG_ERROR_KSTAT_READ,
46			SG_ERROR_KVM_GETSWAPINFO,
47			SG_ERROR_KVM_OPENFILES,
48	tdb	1.39	SG_ERROR_MALLOC,
49			SG_ERROR_OPEN,
50	tdb	1.42	SG_ERROR_OPENDIR,
51	tdb	1.41	SG_ERROR_PARSE,
52	tdb	1.42	SG_ERROR_SETEGID,
53			SG_ERROR_SETEUID,
54	tdb	1.41	SG_ERROR_SETMNTENT,
55	tdb	1.42	SG_ERROR_SOCKET,
56			SG_ERROR_SWAPCTL,
57			SG_ERROR_SYSCONF,
58			SG_ERROR_SYSCTL,
59			SG_ERROR_SYSCTLBYNAME,
60			SG_ERROR_SYSCTLNAMETOMIB,
61			SG_ERROR_UNAME,
62			SG_ERROR_UNSUPPORTED,
63			SG_ERROR_XSW_VER_MISMATCH
64	tdb	1.36	} sg_error;
65
66			void sg_set_error(sg_error code, const char *arg);
67			sg_error sg_get_error();
68	ats	1.43	const char *sg_get_error_arg();
69	ats	1.37	const char *sg_str_error(sg_error code);
70	ats	1.33
71			typedef struct {
72			char *os_name;
73			char *os_release;
74			char *os_version;
75			char *platform;
76			char *hostname;
77			time_t uptime;
78			} sg_host_info;
79
80			sg_host_info *sg_get_host_info();
81
82			typedef struct {
83	tdb	1.39	long long user;
84			long long kernel;
85			long long idle;
86			long long iowait;
87			long long swap;
88			long long nice;
89			long long total;
90			time_t systime;
91	ats	1.33	} sg_cpu_stats;
92	pajs	1.1
93	ats	1.33	sg_cpu_stats *sg_get_cpu_stats();
94			sg_cpu_stats *sg_get_cpu_stats_diff();
95
96			typedef struct {
97	tdb	1.39	float user;
98			float kernel;
99			float idle;
100			float iowait;
101			float swap;
102			float nice;
103	pajs	1.1	time_t time_taken;
104	ats	1.33	} sg_cpu_percents;
105
106			sg_cpu_percents *sg_get_cpu_percents();
107	pajs	1.1
108	ats	1.33	typedef struct {
109	pajs	1.1	long long total;
110			long long free;
111			long long used;
112			long long cache;
113	ats	1.33	} sg_mem_stats;
114
115			sg_mem_stats *sg_get_mem_stats();
116	pajs	1.1
117	ats	1.33	typedef struct {
118	pajs	1.1	double min1;
119			double min5;
120			double min15;
121	ats	1.33	} sg_load_stats;
122
123			sg_load_stats *sg_get_load_stats();
124	pajs	1.1
125	ats	1.33	typedef struct {
126	pajs	1.8	char *name_list;
127	pajs	1.1	int num_entries;
128	ats	1.33	} sg_user_stats;
129
130			sg_user_stats *sg_get_user_stats();
131	pajs	1.1
132	ats	1.33	typedef struct {
133	pajs	1.1	long long total;
134			long long used;
135			long long free;
136	ats	1.33	} sg_swap_stats;
137	pajs	1.1
138	ats	1.33	sg_swap_stats *sg_get_swap_stats();
139	pajs	1.1
140			typedef struct {
141	tdb	1.39	char *device_name;
142	pajs	1.1	char *fs_type;
143	tdb	1.39	char *mnt_point;
144			long long size;
145			long long used;
146			long long avail;
147			long long total_inodes;
148	pajs	1.1	long long used_inodes;
149	tdb	1.39	long long free_inodes;
150	ats	1.33	} sg_fs_stats;
151
152			sg_fs_stats sg_get_fs_stats(int entries);
153	pajs	1.1
154	ats	1.49	int sg_fs_compare_device_name(const void va, const void vb);
155			int sg_fs_compare_mnt_point(const void va, const void vb);
156
157	ats	1.33	typedef struct {
158	pajs	1.4	char *disk_name;
159			long long read_bytes;
160			long long write_bytes;
161			time_t systime;
162	ats	1.33	} sg_disk_io_stats;
163	pajs	1.4
164	ats	1.33	sg_disk_io_stats sg_get_disk_io_stats(int entries);
165			sg_disk_io_stats sg_get_disk_io_stats_diff(int entries);
166	pajs	1.1
167	ats	1.49	int sg_disk_io_compare_name(const void va, const void vb);
168
169	ats	1.33	typedef struct {
170	pajs	1.1	char *interface_name;
171			long long tx;
172			long long rx;
173	tdb	1.28	long long ipackets;
174			long long opackets;
175			long long ierrors;
176			long long oerrors;
177			long long collisions;
178	pajs	1.1	time_t systime;
179	ats	1.33	} sg_network_io_stats;
180
181			sg_network_io_stats sg_get_network_io_stats(int entries);
182			sg_network_io_stats sg_get_network_io_stats_diff(int entries);
183	pajs	1.24
184	ats	1.49	int sg_network_io_compare_name(const void va, const void vb);
185
186	ats	1.33	typedef enum {
187			SG_IFACE_DUPLEX_FULL,
188			SG_IFACE_DUPLEX_HALF,
189			SG_IFACE_DUPLEX_UNKNOWN
190			} sg_iface_duplex;
191	pajs	1.24
192	ats	1.33	typedef struct {
193	pajs	1.24	char *interface_name;
194			int speed; /* In megabits/sec */
195	ats	1.33	sg_iface_duplex dup;
196	pajs	1.27	int up;
197	ats	1.33	} sg_network_iface_stats;
198
199			sg_network_iface_stats sg_get_network_iface_stats(int entries);
200	pajs	1.1
201	ats	1.49	int sg_network_iface_compare_name(const void va, const void vb);
202
203	ats	1.33	typedef struct {
204	pajs	1.2	long long pages_pagein;
205			long long pages_pageout;
206	pajs	1.1	time_t systime;
207	ats	1.33	} sg_page_stats;
208
209			sg_page_stats *sg_get_page_stats();
210			sg_page_stats *sg_get_page_stats_diff();
211	pajs	1.29
212	ats	1.33	typedef enum {
213			SG_PROCESS_STATE_RUNNING,
214			SG_PROCESS_STATE_SLEEPING,
215			SG_PROCESS_STATE_STOPPED,
216			SG_PROCESS_STATE_ZOMBIE,
217			SG_PROCESS_STATE_UNKNOWN
218			} sg_process_state;
219	pajs	1.30
220	ats	1.33	typedef struct {
221	pajs	1.29	char *process_name;
222			char *proctitle;
223
224			pid_t pid;
225			pid_t parent; /* Parent pid */
226			pid_t pgid; /* process id of process group leader */
227
228			uid_t uid;
229			uid_t euid;
230			gid_t gid;
231			gid_t egid;
232
233			unsigned long long proc_size; /* in bytes */
234			unsigned long long proc_resident; /* in bytes */
235	tdb	1.31	time_t time_spent; /* time running in seconds */
236	pajs	1.29	double cpu_percent;
237			int nice;
238	ats	1.33	sg_process_state state;
239			} sg_process_stats;
240	pajs	1.29
241	ats	1.33	sg_process_stats sg_get_process_stats(int entries);
242	pajs	1.1
243	ats	1.49	int sg_process_compare_name(const void va, const void vb);
244	ats	1.48	int sg_process_compare_pid(const void va, const void vb);
245			int sg_process_compare_uid(const void va, const void vb);
246			int sg_process_compare_gid(const void va, const void vb);
247			int sg_process_compare_size(const void va, const void vb);
248			int sg_process_compare_res(const void va, const void vb);
249			int sg_process_compare_cpu(const void va, const void vb);
250			int sg_process_compare_time(const void va, const void vb);
251
252	ats	1.33	typedef struct {
253			int total;
254			int running;
255			int sleeping;
256			int stopped;
257			int zombie;
258			} sg_process_count;
259	pajs	1.14
260	ats	1.33	sg_process_count *sg_get_process_count();
261	tdb	1.35
262			#ifdef SG_ENABLE_DEPRECATED
263			#include <statgrab_deprecated.h>
264			#endif
265	ats	1.18