sg_get_disk_io_stats(3)

NAME
sg_get_disk_io_stats, sg_get_disk_io_stats_r, sg_get_disk_io_stats_diff, sg_get_disk_io_stats_diff_between, sg_free_disk_io_stats, sg_disk_io_compare_name, sg_disk_io_compare_traffic - get disk io statistics

SYNOPSIS
\FC#include <statgrab.h>\F[]

\FCsg_disk_io_stats *sg_get_disk_io_stats\F[]
\FC(size_t *entries);\F[]

\FCsg_disk_io_stats *sg_get_disk_io_stats_r\F[]
\FC(size_t *entries);\F[]

\FCsg_disk_io_stats *sg_get_disk_io_stats_diff\F[]
\FC(size_t *entries);\F[]

\FCsg_disk_io_stats *sg_get_disk_io_stats_diff_between\F[]
\FC(const sg_disk_io_stats *cur, const sg_disk_io_stats *last, size_t *entries);\F[]

\FCsg_error sg_free_disk_io_stats\F[]
\FC(sg_disk_io_stats *data);\F[]

\FCint sg_disk_io_compare_name\F[]
\FC(const void *va, const void *vb);\F[]

\FCint sg_disk_io_compare_traffic\F[]
\FC(const void *va, const void *vb);\F[]

DESCRIPTION
The \FCsg_get_disk_io_stats\F[] functions provide disk I/O statistics on a per disk basis. All get- and diff-functions take an optional \FCentries\F[] parameter, which points (when given) to a size_t to take the number of returned vector entries.

The \FCsg_get_disk_io_stats\F[]() and \FCsg_get_disk_io_stats_r\F[]() functions deliver the I/O-statistics since the disk has been attached to the system. The \FCsg_get_disk_io_stats_diff\F[]() and \FCsg_get_disk_io_stats_diff_between\F[]() deliver the difference between two calls of \FCsg_get_disk_io_stats\F[]() or \FCsg_get_disk_io_stats_r\F[](), respectively.

API Shortcut
function | returns | data owner
sg_get_disk_io_stats | sg_disk_io_stats * | libstatgrab (thread local)
sg_get_disk_io_stats_r | sg_disk_io_stats * | caller
sg_get_disk_io_stats_diff | sg_disk_io_stats * | libstatgrab (thread local)
sg_get_disk_io_stats_diff_between | sg_disk_io_stats * | caller

\FCsg_disk_io_stats\F[] vectors got from \FCsg_get_disk_io_stats_r\F[]() or \FCsg_get_disk_io_stats_diff_between\F[]() must be freed using \FCsg_free_disk_io_stats\F[]() when not needed any more. The caller is responsible for doing it.

Additionally two support functions for \FCqsort\F[](3) are available: \FCsg_disk_io_compare_name\F[]() and \FCsg_disk_io_compare_traffic\F[]().

Example

\FC
size_t entries;
sg_disk_io_stats *io_stats = NULL;
while( NULL != ( io_stats = sg_get_disk_io_stats_diff(&entries) ) ) {
    /* show disks with most traffic first */
    qsort( io_stats, entries, sizeof(io_stats[0]), &sg_disk_io_compare_traffic );
    show_disk_io_stats( io_stats );
}
        \F[]

On some platforms, such as Solaris 7, the kernel value is stored in a 32bit int, so wraps around when it reaches 4GB. Other platforms, such as Solaris 8 (and most other modern systems), hold the value in a 64bit int, which wraps somewhere near 17 million terabytes. The \FCsg_get_disk_io_stats_diff\F[]() function and the \FCsg_get_disk_io_stats_diff_between\F[]() function care about these overflows and try to detect overflows when the diff is calculated.

On Solaris libstatgrab will attempt to get the cXtXdXsX representation for the \FCdisk_name\F[] string. If it fails it will use a name like sd0. On some systems programs calling libstatgrab will need elevated privileges to lookup some of the names. The mappings are built up when \FCsg_init\F[]() is called for the first time.

RETURN VALUES
All diskio statistics return a pointer to a structure of type \FCsg_disk_io_stats\F[].

\FC
typedef struct {
        char *disk_name;
        unsigned long long read_bytes;
        unsigned long long write_bytes;
        time_t systime;
} sg_disk_io_stats;
    \F[]

\FCdisk_name\F[]
    The name known to the operating system. (eg. on linux it might be hda)

\FCread_bytes\F[]
    The number of bytes the disk has read.

\FCwrite_bytes\F[]
    The number of bytes the disk has written.

\FCsystime\F[]
    The time period over which \FCread_bytes\F[] and \FCwrite_bytes\F[] were transferred.

BUGS
\FCsg_get_disk_io_stats_diff\F[] and \FCsg_get_disk_io_stats_diff_between\F[] compare two lists of disk (block device) related I/O statistics. Each entry occurring only in the second list is passed through to the resulting list as if it would have been compared to an entry with all statistic values set to 0. This implies, on the very first call \FCsg_get_disk_io_stats_diff\F[] will return the same as \FCsg_get_disk_io_stats\F[].

On operating systems that hold only 32bits of data there is a problem if the values wrap twice. For example, on Solaris 7 if 9GB is transferred and the operating system wraps at 4GB, the \FCsg_get_disk_io_stats_diff\F[]() function will return 5GB.

The compare functions exists rather for backward compatibility than for functionality enhancements. Limited flexibility (e.g. reverse order) and lack of optimising opportunities for the compiler leads to the recommendation to implement the required compare routines locally.

SEE ALSO
statgrab(3)

WEBSITE
⟨https://libstatgrab.org/⟩