--- name: "sg_get_network_io_stats_diff" section: "3" platform: "linux" package: "libstatgrab" version: "0.92.1-2" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/sg_get_network_io_stats_diff" --- # sg\_get\_network\_io\_stats\_diff(3) get network statistics ## NAME sg\_get\_network\_io\_stats, sg\_get\_network\_io\_stats\_r, sg\_get\_network\_io\_stats\_diff, sg\_get\_network\_io\_stats\_diff\_between, sg\_free\_network\_io\_stats, sg\_network\_io\_compare\_name - get network statistics ## SYNOPSIS ``` FC#include F[0] ``` FCsg\_network\_io\_stats \***sg\_get\_network\_io\_stats**F\[0\] FC(size\_t \**entries*);F\[0\] FCsg\_network\_io\_stats \***sg\_get\_network\_io\_stats\_r**F\[0\] FC(size\_t \**entries*);F\[0\] FCsg\_network\_io\_stats \***sg\_get\_network\_io\_stats\_diff**F\[0\] FC(size\_t \**entries*);F\[0\] FCsg\_network\_io\_stats \***sg\_get\_network\_io\_stats\_diff\_between**F\[0\] FC(const sg\_network\_io\_stats \**cur*, const sg\_network\_io\_stats \**last*, size\_t \**entries*);F\[0\] FCsg\_error **sg\_free\_network\_io\_stats**F\[0\] FC(sg\_network\_iface\_stats \**data*);F\[0\] FCint **sg\_network\_io\_compare\_name**F\[0\] FC(const void \**va*, const void \**vb*);F\[0\] ## DESCRIPTION The FC**sg\_get\_network\_io\_stats**F\[0\] functions provide network interface I/O statistics on a per interface basis. All get- and diff-functions take an optional FCentriesF\[0\] parameter, which points (when given) to a size\_t to take the number of returned vector entries. The FC**sg\_get\_network\_io\_stats**F\[0\]() and FC**sg\_get\_network\_io\_stats\_r**F\[0\]() functions deliver the I/O-statistics since the interface has been attached to the system. The FC**sg\_get\_network\_io\_stats\_diff**F\[0\]() and FC**sg\_get\_network\_io\_stats\_diff\_between**F\[0\]() deliver the difference between two calls of FC**sg\_get\_network\_io\_stats**F\[0\]() or FC**sg\_get\_network\_io\_stats\_r**F\[0\](), respectively. **API Shortcut** | | | | | --- | --- | --- | | function | returns | data owner | | sg\_get\_network\_io\_stats | sg\_network\_io\_stats \* | libstatgrab (thread local) | | sg\_get\_network\_io\_stats\_r | sg\_network\_io\_stats \* | caller | | sg\_get\_network\_io\_stats\_diff | sg\_network\_io\_stats \* | libstatgrab (thread local) | | sg\_get\_network\_io\_stats\_diff\_between | sg\_network\_io\_stats \* | caller | FCsg\_network\_io\_statsF\[0\] vectors received from FC**sg\_get\_network\_io\_stats\_r**F\[0\]() or FC**sg\_get\_network\_io\_stats\_diff\_between**F\[0\]() must be freed using FC**sg\_free\_network\_io\_stats**F\[0\]() when not needed any more. The caller is responsible for doing it. Additionally a support function for FC**qsort**F\[0\](3) are available: FC**sg\_network\_io\_compare\_name**F\[0\](). **Example** ``` FC size_t entries; sg_network_io_stats *network_stats = NULL; while( NULL != ( network_stats = sg_get_network_io_stats_diff(&entries) ) ) { /* sort interface by name */ qsort( network_stats, entries, sizeof(network_stats[0]), &sg_network_io_compare_name ); show_network_io_stats( network_stats ); } F[0] ``` FC**sg\_get\_network\_io\_stats**F\[0\] returns the network traffic stored in the kernel which holds the amount of data transferred since device was attached. 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. The FC**sg\_get\_network\_io\_stats\_diff**F\[0\]() function and the FC**sg\_get\_network\_io\_stats\_diff\_between**F\[0\]() function care about these overflows and try to detect overflows when the diff is calculated. ## RETURN VALUES All network statistics return a pointer to a structure of type FCsg\_network\_io\_statsF\[0\]. ``` FC typedef struct { char *interface_name; unsigned long long tx; unsigned long long rx; unsigned long long ipackets; unsigned long long opackets; unsigned long long ierrors; unsigned long long oerrors; unsigned long long collisions; time_t systime; } sg_network_io_stats; F[0] ``` - FCinterface\_nameF\[0\] The name known to the operating system. (eg. on linux it might be eth0, on AIX en0 and on FreeBSD fxp0) - FCtxF\[0\] The number of bytes transmitted. - FCrxF\[0\] The number of bytes received. - FCipacketsF\[0\] The number of packets received. - FCopacketsF\[0\] The number of packets transmitted. - FCierrorsF\[0\] The number of receive errors. - FCoerrorsF\[0\] The number of transmit errors. - FCcollisionsF\[0\] The number of collisions. - FCsystimeF\[0\] The timestamp when the above stats where collected in seconds since epoch or the time period over which FCtxF\[0\] and FCrxF\[0\] were transferred. ## BUGS FC**sg\_get\_network\_io\_stats\_diff**F\[0\] and FC**sg\_get\_network\_io\_stats\_diff\_between**F\[0\] compare two lists of network interface 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 FC**sg\_get\_network\_io\_stats\_diff**F\[0\] will return the same as FC**sg\_get\_network\_io\_stats**F\[0\]. 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 FC**sg\_get\_network\_io\_stats\_diff**F\[0\] function will return 5GB. ## SEE ALSO [**statgrab**(3)](/statgrab/3.md) ## WEBSITE ⟨https://libstatgrab.org/⟩