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.52 2004/07/16 15:28:02 tdb Exp $
 */

#ifndef STATGRAB_H
#define STATGRAB_H

#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);
void sg_set_error_with_errno(sg_error code, const char *arg);
sg_error sg_get_error();
const char *sg_get_error_arg();
int sg_get_error_errno();
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

#endif
Revision:	1.53
Committed:	Sun Jul 18 20:44:01 2004 UTC (19 years, 10 months ago) by ats
Content type:	text/plain
Branch:	MAIN
CVS Tags:	LIBSTATGRAB_0_10_3, LIBSTATGRAB_0_10_2, LIBSTATGRAB_0_10_1
Changes since 1.52:	+2 -2 lines
Log Message:	Remove extraneous consts.
#	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.53	* $Id: statgrab.h,v 1.52 2004/07/16 15:28:02 tdb Exp $
22	pajs	1.1	*/
23
24	tdb	1.50	#ifndef STATGRAB_H
25			#define STATGRAB_H
26
27	pajs	1.21	#include <sys/types.h>
28
29	ats	1.33	/* FIXME typedefs for 32/64-bit types */
30			/* FIXME maybe tidy up field names? */
31			/* FIXME comments for less obvious fields */
32
33			int sg_init(void);
34			int sg_drop_privileges(void);
35	tdb	1.36
36			typedef enum {
37	tdb	1.38	SG_ERROR_NONE = 0,
38	tdb	1.42	SG_ERROR_ASPRINTF,
39			SG_ERROR_DEVSTAT_GETDEVS,
40			SG_ERROR_DEVSTAT_SELECTDEVS,
41			SG_ERROR_ENOENT,
42			SG_ERROR_GETIFADDRS,
43			SG_ERROR_GETMNTINFO,
44			SG_ERROR_GETPAGESIZE,
45			SG_ERROR_KSTAT_DATA_LOOKUP,
46			SG_ERROR_KSTAT_LOOKUP,
47			SG_ERROR_KSTAT_OPEN,
48			SG_ERROR_KSTAT_READ,
49			SG_ERROR_KVM_GETSWAPINFO,
50			SG_ERROR_KVM_OPENFILES,
51	tdb	1.39	SG_ERROR_MALLOC,
52			SG_ERROR_OPEN,
53	tdb	1.42	SG_ERROR_OPENDIR,
54	tdb	1.41	SG_ERROR_PARSE,
55	tdb	1.42	SG_ERROR_SETEGID,
56			SG_ERROR_SETEUID,
57	tdb	1.41	SG_ERROR_SETMNTENT,
58	tdb	1.42	SG_ERROR_SOCKET,
59			SG_ERROR_SWAPCTL,
60			SG_ERROR_SYSCONF,
61			SG_ERROR_SYSCTL,
62			SG_ERROR_SYSCTLBYNAME,
63			SG_ERROR_SYSCTLNAMETOMIB,
64			SG_ERROR_UNAME,
65			SG_ERROR_UNSUPPORTED,
66			SG_ERROR_XSW_VER_MISMATCH
67	tdb	1.36	} sg_error;
68
69			void sg_set_error(sg_error code, const char *arg);
70	tdb	1.52	void sg_set_error_with_errno(sg_error code, const char *arg);
71	tdb	1.36	sg_error sg_get_error();
72	ats	1.43	const char *sg_get_error_arg();
73	ats	1.53	int sg_get_error_errno();
74	ats	1.37	const char *sg_str_error(sg_error code);
75	ats	1.33
76			typedef struct {
77			char *os_name;
78			char *os_release;
79			char *os_version;
80			char *platform;
81			char *hostname;
82			time_t uptime;
83			} sg_host_info;
84
85			sg_host_info *sg_get_host_info();
86
87			typedef struct {
88	tdb	1.39	long long user;
89			long long kernel;
90			long long idle;
91			long long iowait;
92			long long swap;
93			long long nice;
94			long long total;
95			time_t systime;
96	ats	1.33	} sg_cpu_stats;
97	pajs	1.1
98	ats	1.33	sg_cpu_stats *sg_get_cpu_stats();
99			sg_cpu_stats *sg_get_cpu_stats_diff();
100
101			typedef struct {
102	tdb	1.39	float user;
103			float kernel;
104			float idle;
105			float iowait;
106			float swap;
107			float nice;
108	pajs	1.1	time_t time_taken;
109	ats	1.33	} sg_cpu_percents;
110
111			sg_cpu_percents *sg_get_cpu_percents();
112	pajs	1.1
113	ats	1.33	typedef struct {
114	pajs	1.1	long long total;
115			long long free;
116			long long used;
117			long long cache;
118	ats	1.33	} sg_mem_stats;
119
120			sg_mem_stats *sg_get_mem_stats();
121	pajs	1.1
122	ats	1.33	typedef struct {
123	pajs	1.1	double min1;
124			double min5;
125			double min15;
126	ats	1.33	} sg_load_stats;
127
128			sg_load_stats *sg_get_load_stats();
129	pajs	1.1
130	ats	1.33	typedef struct {
131	pajs	1.8	char *name_list;
132	pajs	1.1	int num_entries;
133	ats	1.33	} sg_user_stats;
134
135			sg_user_stats *sg_get_user_stats();
136	pajs	1.1
137	ats	1.33	typedef struct {
138	pajs	1.1	long long total;
139			long long used;
140			long long free;
141	ats	1.33	} sg_swap_stats;
142	pajs	1.1
143	ats	1.33	sg_swap_stats *sg_get_swap_stats();
144	pajs	1.1
145			typedef struct {
146	tdb	1.39	char *device_name;
147	pajs	1.1	char *fs_type;
148	tdb	1.39	char *mnt_point;
149			long long size;
150			long long used;
151			long long avail;
152			long long total_inodes;
153	pajs	1.1	long long used_inodes;
154	tdb	1.39	long long free_inodes;
155	ats	1.33	} sg_fs_stats;
156
157			sg_fs_stats sg_get_fs_stats(int entries);
158	pajs	1.1
159	ats	1.49	int sg_fs_compare_device_name(const void va, const void vb);
160			int sg_fs_compare_mnt_point(const void va, const void vb);
161
162	ats	1.33	typedef struct {
163	pajs	1.4	char *disk_name;
164			long long read_bytes;
165			long long write_bytes;
166			time_t systime;
167	ats	1.33	} sg_disk_io_stats;
168	pajs	1.4
169	ats	1.33	sg_disk_io_stats sg_get_disk_io_stats(int entries);
170			sg_disk_io_stats sg_get_disk_io_stats_diff(int entries);
171	pajs	1.1
172	ats	1.49	int sg_disk_io_compare_name(const void va, const void vb);
173
174	ats	1.33	typedef struct {
175	pajs	1.1	char *interface_name;
176			long long tx;
177			long long rx;
178	tdb	1.28	long long ipackets;
179			long long opackets;
180			long long ierrors;
181			long long oerrors;
182			long long collisions;
183	pajs	1.1	time_t systime;
184	ats	1.33	} sg_network_io_stats;
185
186			sg_network_io_stats sg_get_network_io_stats(int entries);
187			sg_network_io_stats sg_get_network_io_stats_diff(int entries);
188	pajs	1.24
189	ats	1.49	int sg_network_io_compare_name(const void va, const void vb);
190
191	ats	1.33	typedef enum {
192			SG_IFACE_DUPLEX_FULL,
193			SG_IFACE_DUPLEX_HALF,
194			SG_IFACE_DUPLEX_UNKNOWN
195			} sg_iface_duplex;
196	pajs	1.24
197	ats	1.33	typedef struct {
198	pajs	1.24	char *interface_name;
199			int speed; /* In megabits/sec */
200	ats	1.33	sg_iface_duplex dup;
201	pajs	1.27	int up;
202	ats	1.33	} sg_network_iface_stats;
203
204			sg_network_iface_stats sg_get_network_iface_stats(int entries);
205	pajs	1.1
206	ats	1.49	int sg_network_iface_compare_name(const void va, const void vb);
207
208	ats	1.33	typedef struct {
209	pajs	1.2	long long pages_pagein;
210			long long pages_pageout;
211	pajs	1.1	time_t systime;
212	ats	1.33	} sg_page_stats;
213
214			sg_page_stats *sg_get_page_stats();
215			sg_page_stats *sg_get_page_stats_diff();
216	pajs	1.29
217	ats	1.33	typedef enum {
218			SG_PROCESS_STATE_RUNNING,
219			SG_PROCESS_STATE_SLEEPING,
220			SG_PROCESS_STATE_STOPPED,
221			SG_PROCESS_STATE_ZOMBIE,
222			SG_PROCESS_STATE_UNKNOWN
223			} sg_process_state;
224	pajs	1.30
225	ats	1.33	typedef struct {
226	pajs	1.29	char *process_name;
227			char *proctitle;
228
229			pid_t pid;
230			pid_t parent; /* Parent pid */
231			pid_t pgid; /* process id of process group leader */
232
233			uid_t uid;
234			uid_t euid;
235			gid_t gid;
236			gid_t egid;
237
238			unsigned long long proc_size; /* in bytes */
239			unsigned long long proc_resident; /* in bytes */
240	tdb	1.31	time_t time_spent; /* time running in seconds */
241	pajs	1.29	double cpu_percent;
242			int nice;
243	ats	1.33	sg_process_state state;
244			} sg_process_stats;
245	pajs	1.29
246	ats	1.33	sg_process_stats sg_get_process_stats(int entries);
247	pajs	1.1
248	ats	1.49	int sg_process_compare_name(const void va, const void vb);
249	ats	1.48	int sg_process_compare_pid(const void va, const void vb);
250			int sg_process_compare_uid(const void va, const void vb);
251			int sg_process_compare_gid(const void va, const void vb);
252			int sg_process_compare_size(const void va, const void vb);
253			int sg_process_compare_res(const void va, const void vb);
254			int sg_process_compare_cpu(const void va, const void vb);
255			int sg_process_compare_time(const void va, const void vb);
256
257	ats	1.33	typedef struct {
258			int total;
259			int running;
260			int sleeping;
261			int stopped;
262			int zombie;
263			} sg_process_count;
264	pajs	1.14
265	ats	1.33	sg_process_count *sg_get_process_count();
266	tdb	1.35
267			#ifdef SG_ENABLE_DEPRECATED
268			#include <statgrab_deprecated.h>
269			#endif
270	ats	1.18
271	tdb	1.50	#endif