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.40 2004/04/07 14:53:40 tdb Exp $
 */

#include <sys/types.h>

/* FIXME typedefs for 32/64-bit types */
/* FIXME maybe tidy up field names? */
/* FIXME tab/space damage */
/* FIXME prefixes for util functions too */
/* FIXME comments for less obvious fields */

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

typedef enum {
        SG_ERROR_NONE = 0,
        SG_ERROR_MALLOC,
        SG_ERROR_KSTAT_OPEN,
        SG_ERROR_OPEN,
        SG_ERROR_SYSCTLBYNAME,
        SG_ERROR_SYSCTL,
        SG_ERROR_PARSE,
        SG_ERROR_GETMNTINFO,
        SG_ERROR_SETMNTENT,
        SG_ERROR_DEVSTAT_GETDEVS,
        SG_ERROR_DEVSTAT_SELECTDEVS,
        SG_ERROR_ASPRINTF,
        SG_ERROR_UNSUPPORTED
} sg_error;

void sg_set_error(sg_error code, const char *arg);
sg_error sg_get_error();
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);

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);

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);

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);

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);

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.41
Committed:	Wed Apr 7 19:26:16 2004 UTC (20 years, 1 month ago) by tdb
Content type:	text/plain
Branch:	MAIN
Changes since 1.40:	+9 -2 lines
Log Message:	Error reporting for disk_stats.
#	Content
1	/*
2	* i-scream libstatgrab
3	* http://www.i-scream.org
4	* Copyright (C) 2000-2004 i-scream
5	*
6	* 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	*
11	* This library is distributed in the hope that it will be useful,
12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14	* Lesser General Public License for more details.
15	*
16	* 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	*
21	* $Id: statgrab.h,v 1.40 2004/04/07 14:53:40 tdb Exp $
22	*/
23
24	#include <sys/types.h>
25
26	/* FIXME typedefs for 32/64-bit types */
27	/* FIXME maybe tidy up field names? */
28	/* FIXME tab/space damage */
29	/* FIXME prefixes for util functions too */
30	/* FIXME comments for less obvious fields */
31
32	int sg_init(void);
33	int sg_drop_privileges(void);
34
35	typedef enum {
36	SG_ERROR_NONE = 0,
37	SG_ERROR_MALLOC,
38	SG_ERROR_KSTAT_OPEN,
39	SG_ERROR_OPEN,
40	SG_ERROR_SYSCTLBYNAME,
41	SG_ERROR_SYSCTL,
42	SG_ERROR_PARSE,
43	SG_ERROR_GETMNTINFO,
44	SG_ERROR_SETMNTENT,
45	SG_ERROR_DEVSTAT_GETDEVS,
46	SG_ERROR_DEVSTAT_SELECTDEVS,
47	SG_ERROR_ASPRINTF,
48	SG_ERROR_UNSUPPORTED
49	} sg_error;
50
51	void sg_set_error(sg_error code, const char *arg);
52	sg_error sg_get_error();
53	const char *sg_str_error(sg_error code);
54
55	typedef struct {
56	char *os_name;
57	char *os_release;
58	char *os_version;
59	char *platform;
60	char *hostname;
61	time_t uptime;
62	} sg_host_info;
63
64	sg_host_info *sg_get_host_info();
65
66	typedef struct {
67	long long user;
68	long long kernel;
69	long long idle;
70	long long iowait;
71	long long swap;
72	long long nice;
73	long long total;
74	time_t systime;
75	} sg_cpu_stats;
76
77	sg_cpu_stats *sg_get_cpu_stats();
78	sg_cpu_stats *sg_get_cpu_stats_diff();
79
80	typedef struct {
81	float user;
82	float kernel;
83	float idle;
84	float iowait;
85	float swap;
86	float nice;
87	time_t time_taken;
88	} sg_cpu_percents;
89
90	sg_cpu_percents *sg_get_cpu_percents();
91
92	typedef struct {
93	long long total;
94	long long free;
95	long long used;
96	long long cache;
97	} sg_mem_stats;
98
99	sg_mem_stats *sg_get_mem_stats();
100
101	typedef struct {
102	double min1;
103	double min5;
104	double min15;
105	} sg_load_stats;
106
107	sg_load_stats *sg_get_load_stats();
108
109	typedef struct {
110	char *name_list;
111	int num_entries;
112	} sg_user_stats;
113
114	sg_user_stats *sg_get_user_stats();
115
116	typedef struct {
117	long long total;
118	long long used;
119	long long free;
120	} sg_swap_stats;
121
122	sg_swap_stats *sg_get_swap_stats();
123
124	typedef struct {
125	char *device_name;
126	char *fs_type;
127	char *mnt_point;
128	long long size;
129	long long used;
130	long long avail;
131	long long total_inodes;
132	long long used_inodes;
133	long long free_inodes;
134	} sg_fs_stats;
135
136	sg_fs_stats sg_get_fs_stats(int entries);
137
138	typedef struct {
139	char *disk_name;
140	long long read_bytes;
141	long long write_bytes;
142	time_t systime;
143	} sg_disk_io_stats;
144
145	sg_disk_io_stats sg_get_disk_io_stats(int entries);
146	sg_disk_io_stats sg_get_disk_io_stats_diff(int entries);
147
148	typedef struct {
149	char *interface_name;
150	long long tx;
151	long long rx;
152	long long ipackets;
153	long long opackets;
154	long long ierrors;
155	long long oerrors;
156	long long collisions;
157	time_t systime;
158	} sg_network_io_stats;
159
160	sg_network_io_stats sg_get_network_io_stats(int entries);
161	sg_network_io_stats sg_get_network_io_stats_diff(int entries);
162
163	typedef enum {
164	SG_IFACE_DUPLEX_FULL,
165	SG_IFACE_DUPLEX_HALF,
166	SG_IFACE_DUPLEX_UNKNOWN
167	} sg_iface_duplex;
168
169	typedef struct {
170	char *interface_name;
171	int speed; /* In megabits/sec */
172	sg_iface_duplex dup;
173	int up;
174	} sg_network_iface_stats;
175
176	sg_network_iface_stats sg_get_network_iface_stats(int entries);
177
178	typedef struct {
179	long long pages_pagein;
180	long long pages_pageout;
181	time_t systime;
182	} sg_page_stats;
183
184	sg_page_stats *sg_get_page_stats();
185	sg_page_stats *sg_get_page_stats_diff();
186
187	typedef enum {
188	SG_PROCESS_STATE_RUNNING,
189	SG_PROCESS_STATE_SLEEPING,
190	SG_PROCESS_STATE_STOPPED,
191	SG_PROCESS_STATE_ZOMBIE,
192	SG_PROCESS_STATE_UNKNOWN
193	} sg_process_state;
194
195	typedef struct {
196	char *process_name;
197	char *proctitle;
198
199	pid_t pid;
200	pid_t parent; /* Parent pid */
201	pid_t pgid; /* process id of process group leader */
202
203	uid_t uid;
204	uid_t euid;
205	gid_t gid;
206	gid_t egid;
207
208	unsigned long long proc_size; /* in bytes */
209	unsigned long long proc_resident; /* in bytes */
210	time_t time_spent; /* time running in seconds */
211	double cpu_percent;
212	int nice;
213	sg_process_state state;
214	} sg_process_stats;
215
216	sg_process_stats sg_get_process_stats(int entries);
217
218	typedef struct {
219	int total;
220	int running;
221	int sleeping;
222	int stopped;
223	int zombie;
224	} sg_process_count;
225
226	sg_process_count *sg_get_process_count();
227
228	#ifdef SG_ENABLE_DEPRECATED
229	#include <statgrab_deprecated.h>
230	#endif
231