sg_get_cpu_percents(3) [debian man page]

sg_get_cpu_stats(3)					     Library Functions Manual					       sg_get_cpu_stats(3)

NAME

       sg_get_cpu_stats, sg_get_cpu_stats_diff, sg_get_cpu_percents - get cpu usage

SYNOPSIS

       #include <statgrab.h>

       sg_cpu_percents *sg_get_cpu_percents(void);

       sg_cpu_stats *sg_get_cpu_stats(void);

       sg_cpu_stats *sg_get_cpu_stats_diff(void);

DESCRIPTION

       sg_get_cpu_stats()  and	sg_get_cpu_stats_diff()  both  return  static pointers of type sg_cpu_stats.  sg_get_cpu_stats() returns the total
       amount of "ticks" the operating system has spent in each of the different states. sg_get_cpu_stats_diff() returns the difference in "ticks"
       for  each  of  the  states  since  last time sg_get_cpu_stats_diff() or sg_get_cpu_stats() was called. If it has never been called, it will
       return the result of sg_get_cpu_stats().

       The value stored (the "ticks") will vary between operating systems. For example Solaris has a total of 100 per second, while Linux has sub-
       stantially more. Also, different operating systems store different information - you won't find nice cpu on Solaris for example.

       Because of this, you will ideally always want to work on a scale against the total, or in percentages.

       sg_get_cpu_percents() returns a pointer to a static sg_cpu_percents. The function calls sg_get_cpu_stats_diff() and changes the values into
       percentages. If it has never been called before (and nor has sg_get_cpu_stats() or sg_get_cpu_stats_diff()), the returned percentages  will
       be the systems total ever since its uptime. (Unless the counters have cycled)

RETURN VALUES

       There are two structures returned by the CPU statistics functions.

       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;

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

       user  kernel  idle  iowait  swap  nice
	      The different CPU states.

       systime	time_taken
	      The time taken in seconds since the last call of the function, or the system time.

SEE ALSO

       statgrab(3)

WEBSITE

       http://www.i-scream.org/libstatgrab/

i-scream						   $Date: 2005/04/25 11:25:45 $ 				       sg_get_cpu_stats(3)

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)