sg_get_network_io_stats(3) [debian man page]
sg_get_network_io_stats(3) Library Functions Manual sg_get_network_io_stats(3) NAME
sg_get_network_io_stats, sg_get_network_io_stats_diff - get network statistics SYNOPSIS
#include <statgrab.h> sg_network_io_stats *sg_get_network_io_stats(int *entries); sg_network_io_stats *sg_get_network_io_stats_diff(int *entries); DESCRIPTION
Both calls take a pointer to an int, entries, which is filled with the number of network interfaces the machine has. This is needed to know how many sg_network_io_stats structures have been returned. A pointer is returned to the first sg_network_io_stats. sg_get_network_io_stats returns the network traffic stored in the kernel which holds the amount of data transferred since bootup. On some platforms, such as Solaris 7, this value is stored in a 32bit int, so wraps around when it reaches 4GB. Other platforms, such as Solaris 8, hold the value in a 64bit int, which wraps somewhere near 17 million terabytes. sg_get_network_io_stats also returns the number of packets sent and received, and the number of errors that have occured. It also makes the number of collisions available. sg_get_network_io_stats_diff is the same as sg_get_network_io_stats except it will return the difference since the last call. So, for instance a call to sg_get_network_io_stats_diff is made, and called again 5 seconds later. Over that time, 20 bytes of traffic was trans- mitted and 10 bytes received. Tx will store 20, rx will store 10 and systime will store 5. This function copes with wrap arounds by the O/S so should be seemless to use. RETURN VALUES
All network statistics return a pointer to a structure of type sg_network_io_stats. 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; interface_name The name known to the operating system. (eg. on linux it might be eth0) tx The number of bytes transmitted. rx The number of bytes received. ipackets The number of packets received. opackets The number of packets transmitted. ierrors The number of receive errors. oerrors The number of transmit errors. collisions The number of collisions. systime The time period over which tx and rx were transferred. BUGS
On the very first call sg_get_network_io_stats_diff will return the same as sg_get_network_io_stats. After the first call it will always return the difference. On operating system that hold only 32bits of data there is a problem if the values wrap twice. For example, on Solaris 7 if 9GB is trans- ferred and the operating system wraps at 4GB, the sg_get_network_io_stats_diff function will return 5GB. SEE ALSO
statgrab(3) WEBSITE
http://www.i-scream.org/libstatgrab/ i-scream $Date: 2005/04/25 11:25:45 $ sg_get_network_io_stats(3)
Check Out this Related Man Page
sg_get_process_stats(3) Library Functions Manual sg_get_process_stats(3) NAME
sg_get_process_stats, sg_get_process_count, sg_process_compare_name, sg_process_compare_pid, sg_process_compare_uid, sg_process_com- pare_gid, sg_process_compare_size, sg_process_compare_res, sg_process_compare_cpu, sg_process_compare_time - get process statistics SYNOPSIS
#include <statgrab.h> sg_process_stats *sg_get_process_stats(int *entries); sg_process_count *sg_get_process_count(void); 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); DESCRIPTION
The sg_get_process_stats takes a pointer to an int, entries, which is filled with the number of processes the snapshot contains. The return value is a pointer to the first member of an array of sg_process_stats structures; the number of entries in the array is returned in entries. sg_get_process_count returns a pointer to a static buffer of type sg_process_count. These two functions provide information on the process running on the system. In the first case lots of detail is provided, and in the sec- ond case a summary of the states of the current processes. sg_process_compare_name sg_process_compare_pid sg_process_compare_uid sg_process_compare_gid sg_process_compare_size sg_process_compare_res sg_process_compare_cpu sg_process_compare_time These functions compare two sg_process_stats entries, and return an int to represent which one is greater. The main use of these functions is to be passed to qsort to sort the sg_process_stats by the given type. For example: qsort(sg_process_stats ps, int ps_size, sizeof *ps, sg_process_compare_pid); RETURN VALUES
The structure returned by sg_get_process_stats is of type sg_process_stats. 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; 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; process_name The name of the command that was run. proctitle The command line (the "title") of the process. Take note - this can be modified by the process, so isn't guaranteed to be the origi- nal command line. pid The process ID. parent The parent process ID. pgid The process ID of the process group leader. uid The UID the process is running as. euid The effective UID the process is running as. gid The GID the process is running as. egid The effective GID the process is running as. proc_size The size of the process in bytes. proc_resident The size of the process that's resident in memory. time_spent The number of seconds the process has been running. cpu_percent The current percentage of CPU the process is using. nice The nice value of the process. state The current state of the process. See sg_process_state for permitted values. The structure returned by sg_get_process_count is of type sg_process_count. typedef struct{ int total; int running; int sleeping; int stopped; int zombie; }sg_process_count; total The total number of processes. running The number of running processes. sleeping The number of sleeping processes. stopped The number of stopped processes. zombie The number of zombie processes. SEE ALSO
statgrab(3) WEBSITE
http://www.i-scream.org/libstatgrab/ i-scream $Date: 2005/04/25 11:25:45 $ sg_get_process_stats(3)