linux-net.c File Reference

net component This file contains the source code for a component that enables PAPI-C to access network statistics through the /proc file system. This component will dynamically create a native events table for all the interfaces listed in /proc/net/dev (16 entries for each interface). More...

Include dependency graph for linux-net.c:

Go to the source code of this file.

Data Structures
struct	temp_event
struct	net_counters

Macros
#define	NET_REFRESH_LATENCY   1000000
#define	NET_PROC_FILE   "/proc/net/dev"
#define	NET_PROC_MAX_LINE   (IFNAMSIZ + 16 * (20 + 1) + 16)
#define	NET_INVALID_RESULT   -1
#define	HANDLE_STRING_ERROR   {fprintf(stderr,"%s:%i unexpected string function error.\n",__FILE__,__LINE__); exit(-1);}
#define	NET_INTERFACE_COUNTERS   16

Functions
static int	generateNetEventList (void)
static int	getInterfaceBaseIndex (const char *ifname)
static int	read_net_counters (long long *values)
static int	_net_init_thread (hwd_context_t *ctx)
static int	_net_init_component (int cidx)
static int	_net_init_control_state (hwd_control_state_t *ctl)
static int	_net_start (hwd_context_t *ctx, hwd_control_state_t *ctl)
static int	_net_read (hwd_context_t *ctx, hwd_control_state_t *ctl, long long **events, int flags)
static int	_net_stop (hwd_context_t *ctx, hwd_control_state_t *ctl)
static int	_net_shutdown_thread (hwd_context_t *ctx)
static int	_net_shutdown_component (void)
static int	_net_ctl (hwd_context_t *ctx, int code, _papi_int_option_t *option)
static int	_net_update_control_state (hwd_control_state_t *ctl, NativeInfo_t *native, int count, hwd_context_t *ctx)
static int	_net_set_domain (hwd_control_state_t *ctl, int domain)
int	_net_reset (hwd_context_t *ctx, hwd_control_state_t *ctl)
static int	_net_ntv_enum_events (unsigned int *EventCode, int modifier)
static int	_net_ntv_name_to_code (const char *name, unsigned int *EventCode)
static int	_net_ntv_code_to_name (unsigned int EventCode, char *name, int len)
static int	_net_ntv_code_to_descr (unsigned int EventCode, char *name, int len)
static int	_net_ntv_code_to_bits (unsigned int EventCode, hwd_register_t *bits)

Variables
papi_vector_t	_net_vector
static NET_native_event_entry_t *	_net_native_events =NULL
static int	num_events = 0
static int	is_initialized = 0
static long long	_net_register_start [NET_MAX_COUNTERS]
static long long	_net_register_current [NET_MAX_COUNTERS]
static struct temp_event *	root = NULL
static const struct net_counters	_net_counter_info [NET_INTERFACE_COUNTERS]

Detailed Description

Author

Haihang You you@c.nosp@m.s.ut.nosp@m.k.edu

Jose Pedro Oliveira jpo@d.nosp@m.i.um.nosp@m.inho..nosp@m.pt

Definition in file linux-net.c.

Macro Definition Documentation

HANDLE_STRING_ERROR

#define HANDLE_STRING_ERROR   {fprintf(stderr,"%s:%i unexpected string function error.\n",__FILE__,__LINE__); exit(-1);}

Definition at line 57 of file linux-net.c.

NET_INTERFACE_COUNTERS

#define NET_INTERFACE_COUNTERS   16

Definition at line 76 of file linux-net.c.

NET_INVALID_RESULT

#define NET_INVALID_RESULT   -1

Definition at line 51 of file linux-net.c.

NET_PROC_FILE

#define NET_PROC_FILE   "/proc/net/dev"

Definition at line 44 of file linux-net.c.

NET_PROC_MAX_LINE

#define NET_PROC_MAX_LINE   (IFNAMSIZ + 16 * (20 + 1) + 16)

Definition at line 49 of file linux-net.c.

NET_REFRESH_LATENCY

#define NET_REFRESH_LATENCY   1000000

Definition at line 42 of file linux-net.c.

Function Documentation

_net_ctl()

static int _net_ctl ( hwd_context_t *  ctx, int  code, _papi_int_option_t *  option  )

static

Definition at line 498 of file linux-net.c.

{
    ( void ) ctx;
    ( void ) code;
    ( void ) option;
 
    return PAPI_OK;
}

_net_init_component()

static int _net_init_component ( int  cidx )

static

Definition at line 320 of file linux-net.c.

{
    int retval = PAPI_OK;
    int i = 0;
    struct temp_event *t, *last;
 
    if ( is_initialized )
        goto fn_exit;
 
    memset(_net_register_start, 0,
            NET_MAX_COUNTERS*sizeof(_net_register_start[0]));
    memset(_net_register_current, 0, 
            NET_MAX_COUNTERS*sizeof(_net_register_current[0]));
 
    is_initialized = 1;
 
    /* The network interfaces are listed in /proc/net/dev */
    num_events = generateNetEventList();
 
    if ( num_events < 0 ) {  /* disabled_reason already set */
        retval = PAPI_ECMP;
        goto fn_fail;
    }
 
    if ( num_events == 0 )  /* No network interfaces found */
        goto fn_exit;
 
    t = root;
    _net_native_events = (NET_native_event_entry_t*)
        papi_malloc(sizeof(NET_native_event_entry_t) * num_events);
    do {
        int retlen;
        retlen = snprintf(_net_native_events[i].name, PAPI_MAX_STR_LEN, "%s", t->name);
        if (retlen <= 0 || retlen >= PAPI_MAX_STR_LEN) HANDLE_STRING_ERROR;
        retlen = snprintf(_net_native_events[i].description, PAPI_MAX_STR_LEN, "%s", t->description);
        if (retlen <= 0 || retlen >= PAPI_MAX_STR_LEN) HANDLE_STRING_ERROR;
        _net_native_events[i].resources.selector = i + 1;
        last    = t;
        t       = t->next;
        papi_free(last);
        i++;
    } while (t != NULL);
    root = NULL;
 
    /* Export the total number of events available */
    _net_vector.cmp_info.num_native_events = num_events;
 
    /* Export the component id */
    _net_vector.cmp_info.CmpIdx = cidx;
 
  fn_exit:
    _papi_hwd[cidx]->cmp_info.disabled = retval;
    return retval;
  fn_fail:
    goto fn_exit;
}

Here is the call graph for this function:

_net_init_control_state()

static int _net_init_control_state ( hwd_control_state_t *  ctl )

static

Definition at line 383 of file linux-net.c.

{
    ( void ) ctl;
 
    return PAPI_OK;
}

_net_init_thread()

static int _net_init_thread ( hwd_context_t *  ctx )

static

Definition at line 307 of file linux-net.c.

{
    ( void ) ctx;
 
    return PAPI_OK;
}

_net_ntv_code_to_bits()

static int _net_ntv_code_to_bits ( unsigned int  EventCode, hwd_register_t *  bits  )

static

Definition at line 650 of file linux-net.c.

{
    int index = EventCode;
 
    if ( index >= 0 && index < num_events ) {
        memcpy( ( NET_register_t * ) bits,
                &( _net_native_events[index].resources ),
                sizeof ( NET_register_t ) );
        return PAPI_OK;
    }
 
    return PAPI_ENOEVNT;
}

_net_ntv_code_to_descr()

static int _net_ntv_code_to_descr ( unsigned int  EventCode, char *  name, int  len  )

static

Definition at line 633 of file linux-net.c.

{
    int index = EventCode;
 
    if ( index >= 0 && index < num_events ) {
        strncpy( name, _net_native_events[index].description, len );
        return PAPI_OK;
    }
 
    return PAPI_ENOEVNT;
}

_net_ntv_code_to_name()

static int _net_ntv_code_to_name ( unsigned int  EventCode, char *  name, int  len  )

static

Definition at line 616 of file linux-net.c.

{
    int index = EventCode;
 
    if ( index >= 0 && index < num_events ) {
        strncpy( name, _net_native_events[index].name, len );
        return PAPI_OK;
    }
 
    return PAPI_ENOEVNT;
}

_net_ntv_enum_events()

static int _net_ntv_enum_events ( unsigned int *  EventCode, int  modifier  )

static

Definition at line 561 of file linux-net.c.

{
    int index;
 
    switch ( modifier ) {
        case PAPI_ENUM_FIRST:
            if (num_events==0) {
                return PAPI_ENOEVNT;
            }
            *EventCode = 0;
            return PAPI_OK;
            break;
 
        case PAPI_ENUM_EVENTS:
            index = *EventCode;
            if ( index < num_events - 1 ) {
                *EventCode = *EventCode + 1;
                return PAPI_OK;
            } else {
                return PAPI_ENOEVNT;
            }
            break;
 
        default:
            return PAPI_EINVAL;
            break;
    }
    return PAPI_EINVAL;
}

_net_ntv_name_to_code()

static int _net_ntv_name_to_code ( const char *  name, unsigned int *  EventCode  )

static

Definition at line 596 of file linux-net.c.

{
    int i;
 
    for ( i=0; i<num_events; i++) {
        if (strcmp(name, _net_native_events[i].name) == 0) {
       *EventCode = i;
 
            return PAPI_OK;
        }
    }
 
    return PAPI_ENOEVNT;
}

_net_read()

static int _net_read ( hwd_context_t *  ctx, hwd_control_state_t *  ctl, long long **  events, int  flags  )

static

Definition at line 414 of file linux-net.c.

{
    (void) flags;
    (void) ctx;
 
    NET_control_state_t *net_ctl = (NET_control_state_t *) ctl;
    long long now = PAPI_get_real_usec();
    int i;
 
    /* Caching
     * Only read new values from /proc if enough time has passed
     * since the last read.
     */
    if ( now - net_ctl->lastupdate > NET_REFRESH_LATENCY ) {
        read_net_counters(_net_register_current);
        for ( i=0; i<NET_MAX_COUNTERS; i++ ) {
            net_ctl->values[i] = _net_register_current[i] - _net_register_start[i];
        }
        net_ctl->lastupdate = now;
    }
    *events = net_ctl->values;
 
    return PAPI_OK;
}

Here is the call graph for this function:

_net_reset()

int _net_reset	(	hwd_context_t *	ctx,
		hwd_control_state_t *	ctl
	)

Definition at line 548 of file linux-net.c.

{
    ( void ) ctx;
    ( void ) ctl;
 
    return PAPI_OK;
}

_net_set_domain()

static int _net_set_domain ( hwd_control_state_t *  ctl, int  domain  )

static

Definition at line 537 of file linux-net.c.

{
    ( void ) ctl;
    if ( PAPI_DOM_ALL != domain )
        return PAPI_EINVAL;
 
    return PAPI_OK;
}

_net_shutdown_component()

static int _net_shutdown_component ( void  )

static

Definition at line 476 of file linux-net.c.

{
    if ( is_initialized )
    {
      is_initialized = 0;
      if (_net_native_events != NULL)
      {
         papi_free(_net_native_events);
         _net_native_events = NULL;
      }
    }
 
    return PAPI_OK;
}

_net_shutdown_thread()

static int _net_shutdown_thread ( hwd_context_t *  ctx )

static

Definition at line 464 of file linux-net.c.

{
    ( void ) ctx;
 
    return PAPI_OK;
}

_net_start()

static int _net_start ( hwd_context_t *  ctx, hwd_control_state_t *  ctl  )

static

Definition at line 392 of file linux-net.c.

{
    ( void ) ctx;
 
    NET_control_state_t *net_ctl = (NET_control_state_t *) ctl;
    long long now = PAPI_get_real_usec();
 
    read_net_counters(_net_register_start);
    memcpy(_net_register_current, _net_register_start,
            NET_MAX_COUNTERS * sizeof(_net_register_start[0]));
 
    /* set initial values to 0 */
    memset(net_ctl->values, 0, NET_MAX_COUNTERS*sizeof(net_ctl->values[0]));
    
    /* Set last access time for caching purposes */
    net_ctl->lastupdate = now;
 
    return PAPI_OK;
}

Here is the call graph for this function:

_net_stop()

static int _net_stop ( hwd_context_t *  ctx, hwd_control_state_t *  ctl  )

static

Definition at line 442 of file linux-net.c.

{
    (void) ctx;
 
    NET_control_state_t *net_ctl = (NET_control_state_t *) ctl;
    long long now = PAPI_get_real_usec();
    int i;
 
    read_net_counters(_net_register_current);
    for ( i=0; i<NET_MAX_COUNTERS; i++ ) {
        net_ctl->values[i] = _net_register_current[i] - _net_register_start[i];
    }
    net_ctl->lastupdate = now;
 
    return PAPI_OK;
}

Here is the call graph for this function:

_net_update_control_state()

static int _net_update_control_state ( hwd_control_state_t *  ctl, NativeInfo_t *  native, int  count, hwd_context_t *  ctx  )

static

Definition at line 509 of file linux-net.c.

{
    ( void ) ctx;
    ( void ) ctl;
 
    int i, index;
 
    for ( i = 0; i < count; i++ ) {
        index = native[i].ni_event;
        native[i].ni_position = _net_native_events[index].resources.selector - 1;
    }
 
    return PAPI_OK;
}

generateNetEventList()

static int generateNetEventList ( void  )

static

Definition at line 111 of file linux-net.c.

{
    FILE *fin;
    char line[NET_PROC_MAX_LINE];
    char *retval, *ifname;
    int count = 0;
    struct temp_event *temp;
    struct temp_event *last = NULL;
    int i, j;
 
    fin = fopen(NET_PROC_FILE, "r");
    if (fin == NULL) {
        SUBDBG("Can't find %s, are you sure the /proc file-system is mounted?\n",
           NET_PROC_FILE);
        snprintf(_net_vector.cmp_info.disabled_reason, PAPI_MAX_STR_LEN-2,
        "Failed to find /proc file-system.");
        _net_vector.cmp_info.disabled_reason[PAPI_MAX_STR_LEN-1]=0;    // force null termination.
        return 0;
    }
 
    /* skip the 2 header lines */
    for (i=0; i<2; i++) {
        retval = fgets (line, NET_PROC_MAX_LINE, fin);
        if (retval == NULL) {
            fclose(fin);
            SUBDBG("Not enough lines in %s\n", NET_PROC_FILE);
            snprintf(_net_vector.cmp_info.disabled_reason, PAPI_MAX_STR_LEN-2,
            "Not enough lines in '%s'.", NET_PROC_FILE);
            _net_vector.cmp_info.disabled_reason[PAPI_MAX_STR_LEN-1]=0;    // force null termination.
            return 0;
        }
    }
 
    while ((fgets (line, NET_PROC_MAX_LINE, fin)) == line) {
 
        /* split the interface name from the 16 counters */
        retval = strstr(line, ":");
        if (retval == NULL) {
            SUBDBG("Wrong line format <%s>\n", line);
            continue;
        }
 
        *retval = '\0';
        ifname = line;
        while (isspace(*ifname)) { ifname++; }
 
        for (j=0; j<NET_INTERFACE_COUNTERS; j++) {
 
            /* keep the interface name around */
            temp = (struct temp_event *)papi_malloc(sizeof(struct temp_event));
            if (!temp) {
                PAPIERROR("out of memory!");
                fclose(fin);
                snprintf(_net_vector.cmp_info.disabled_reason, PAPI_MAX_STR_LEN-2,
                "%s failed to allocate %lu bytes for temp_event.", __func__, sizeof(struct temp_event));
                _net_vector.cmp_info.disabled_reason[PAPI_MAX_STR_LEN-1]=0;    // force null termination.
                return PAPI_ENOMEM;
            }
            temp->next = NULL;
 
            if (root == NULL) {
                root = temp;
            } else if (last) {
                last->next = temp;
            } else {
                free(temp);
                fclose(fin);
                PAPIERROR("This shouldn't be possible\n");
                snprintf(_net_vector.cmp_info.disabled_reason, PAPI_MAX_STR_LEN-2,
                "%s Error navigating linked list.", __func__);
                _net_vector.cmp_info.disabled_reason[PAPI_MAX_STR_LEN-1]=0;    // force null termination.
                return PAPI_ECMP;
            }
            last = temp;
 
            size_t str_len = strlen(ifname) + strlen(_net_counter_info[j].name) + 1;
            str_len = (str_len > PAPI_MAX_STR_LEN - 1) ? PAPI_MAX_STR_LEN - 1 : str_len;
            snprintf(temp->name, str_len, "%s:%s",
                    ifname, _net_counter_info[j].name);
            str_len = strlen(ifname) + strlen(_net_counter_info[j].description) + 1;
            str_len = (str_len > PAPI_MAX_STR_LEN - 1) ? PAPI_MAX_STR_LEN - 1 : str_len;
            snprintf(temp->description, str_len, "%s %s",
                    ifname, _net_counter_info[j].description);
 
            count++;
        }
    }
 
    fclose(fin);
 
    return count;
}

Here is the call graph for this function:

Here is the caller graph for this function:

getInterfaceBaseIndex()

static int getInterfaceBaseIndex ( const char *  ifname )

static

Definition at line 206 of file linux-net.c.

{
    int i;
 
    for ( i=0; i<num_events; i+=NET_INTERFACE_COUNTERS ) {
        if (strncmp(_net_native_events[i].name, ifname, strlen(ifname)) == 0) {
            return i;
        }
    }
 
    return -1;  /* Not found */
}

Here is the caller graph for this function:

read_net_counters()

static int read_net_counters ( long long *  values )

static

Definition at line 221 of file linux-net.c.

{
    FILE *fin;
    char line[NET_PROC_MAX_LINE];
    char *retval, *ifname, *data;
    int i, nf, if_bidx;
 
    fin = fopen(NET_PROC_FILE, "r");
    if (fin == NULL) {
        SUBDBG("Can't find %s, are you sure the /proc file-system is mounted?\n",
           NET_PROC_FILE);
        return NET_INVALID_RESULT;
    }
 
    /* skip the 2 header lines */
    for (i=0; i<2; i++) {
        retval = fgets (line, NET_PROC_MAX_LINE, fin);
        if (retval == NULL) {
            SUBDBG("Not enough lines in %s\n", NET_PROC_FILE);
            fclose(fin);
            return 0;
        }
    }
 
    while ((fgets (line, NET_PROC_MAX_LINE, fin)) == line) {
 
        /* split the interface name from its 16 counters */
        retval = strstr(line, ":");
        if (retval == NULL) {
            SUBDBG("Wrong line format <%s>\n", line);
            continue;
        }
 
        *retval = '\0';
        data = retval + 1;
        ifname = line;
        while (isspace(*ifname)) { ifname++; }
 
        if_bidx = getInterfaceBaseIndex(ifname);
        if (if_bidx < 0) {
            SUBDBG("Interface <%s> not found\n", ifname);
        } else {
            nf = sscanf( data,
                "%lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld\n",
                &values[if_bidx + 0],  &values[if_bidx + 1],
                &values[if_bidx + 2],  &values[if_bidx + 3],
                &values[if_bidx + 4],  &values[if_bidx + 5],
                &values[if_bidx + 6],  &values[if_bidx + 7],
                &values[if_bidx + 8],  &values[if_bidx + 9],
                &values[if_bidx + 10], &values[if_bidx + 11],
                &values[if_bidx + 12], &values[if_bidx + 13],
                &values[if_bidx + 14], &values[if_bidx + 15]);
 
            SUBDBG("\nRead "
                "%lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld\n",
                values[if_bidx + 0],  values[if_bidx + 1],
                values[if_bidx + 2],  values[if_bidx + 3],
                values[if_bidx + 4],  values[if_bidx + 5],
                values[if_bidx + 6],  values[if_bidx + 7],
                values[if_bidx + 8],  values[if_bidx + 9],
                values[if_bidx + 10], values[if_bidx + 11],
                values[if_bidx + 12], values[if_bidx + 13],
                values[if_bidx + 14], values[if_bidx + 15]);
 
            if ( nf != NET_INTERFACE_COUNTERS ) {
                /* This shouldn't happen */
                SUBDBG("/proc line with wrong number of fields\n");
            }
        }
 
    }
 
    fclose(fin);
 
    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

_net_counter_info

const struct net_counters _net_counter_info[NET_INTERFACE_COUNTERS]

static

Initial value:

= {
    
    { "rx:bytes",      "receive bytes"},
    { "rx:packets",    "receive packets"},
    { "rx:errors",     "receive errors"},
    { "rx:dropped",    "receive dropped"},
    { "rx:fifo",       "receive fifo"},
    { "rx:frame",      "receive frame"},
    { "rx:compressed", "receive compressed"},
    { "rx:multicast",  "receive multicast"},
    
    { "tx:bytes",      "transmit bytes"},
    { "tx:packets",    "transmit packets"},
    { "tx:errors",     "transmit errors"},
    { "tx:dropped",    "transmit dropped"},
    { "tx:fifo",       "transmit fifo"},
    { "tx:colls",      "transmit colls"},
    { "tx:carrier",    "transmit carrier"},
    { "tx:compressed", "transmit compressed"},
}

_net_native_events

NET_native_event_entry_t* _net_native_events =NULL

static

Definition at line 59 of file linux-net.c.

_net_register_current

long long _net_register_current[NET_MAX_COUNTERS]

static

Definition at line 65 of file linux-net.c.

_net_register_start

long long _net_register_start[NET_MAX_COUNTERS]

static

Definition at line 64 of file linux-net.c.

_net_vector

papi_vector_t _net_vector

Definition at line 35 of file linux-net.c.

is_initialized

int is_initialized = 0

static

Definition at line 62 of file linux-net.c.

num_events

int num_events = 0

static

Definition at line 61 of file linux-net.c.

root

struct temp_event* root = NULL

static

Definition at line 73 of file linux-net.c.