spec/packet_io_stats.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2015-2018 Linaro Limited
 * Copyright (c) 2021-2022 Nokia
 */
 
#ifndef ODP_API_SPEC_PACKET_IO_STATS_H_
#define ODP_API_SPEC_PACKET_IO_STATS_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/queue_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct odp_pktio_stats_t {
    uint64_t in_octets;
 
    uint64_t in_packets;
 
    uint64_t in_ucast_pkts;
 
    uint64_t in_mcast_pkts;
 
    uint64_t in_bcast_pkts;
 
    uint64_t in_discards;
 
    uint64_t in_errors;
 
    uint64_t out_octets;
 
    uint64_t out_packets;
 
    uint64_t out_ucast_pkts;
 
    uint64_t out_mcast_pkts;
 
    uint64_t out_bcast_pkts;
 
    uint64_t out_discards;
 
    uint64_t out_errors;
} odp_pktio_stats_t;
 
typedef struct odp_pktin_queue_stats_t {
    uint64_t octets;
 
    uint64_t packets;
 
    uint64_t discards;
 
    uint64_t errors;
 
} odp_pktin_queue_stats_t;
 
typedef struct odp_pktout_queue_stats_t {
    uint64_t octets;
 
    uint64_t packets;
 
    uint64_t discards;
 
    uint64_t errors;
 
} odp_pktout_queue_stats_t;
 
typedef struct odp_pktio_stats_capability_t {
    struct {
        union {
            struct {
                uint64_t in_octets          : 1;
 
                uint64_t in_packets         : 1;
 
                uint64_t in_ucast_pkts      : 1;
 
                uint64_t in_mcast_pkts      : 1;
 
                uint64_t in_bcast_pkts      : 1;
 
                uint64_t in_discards        : 1;
 
                uint64_t in_errors          : 1;
 
                uint64_t out_octets         : 1;
 
                uint64_t out_packets        : 1;
 
                uint64_t out_ucast_pkts     : 1;
 
                uint64_t out_mcast_pkts     : 1;
 
                uint64_t out_bcast_pkts     : 1;
 
                uint64_t out_discards       : 1;
 
                uint64_t out_errors         : 1;
            } counter;
 
            uint64_t all_counters;
        };
    } pktio;
 
    struct {
        union {
            struct {
                uint64_t octets             : 1;
 
                uint64_t packets            : 1;
 
                uint64_t discards           : 1;
 
                uint64_t errors             : 1;
            } counter;
 
            uint64_t all_counters;
        };
    } pktin_queue;
 
    struct {
        union {
            struct {
                uint64_t octets             : 1;
 
                uint64_t packets            : 1;
 
                uint64_t discards           : 1;
 
                uint64_t errors             : 1;
            } counter;
 
            uint64_t all_counters;
        };
    } pktout_queue;
 
} odp_pktio_stats_capability_t;
 
typedef struct odp_pktio_extra_stat_info_t {
    char name[ODP_PKTIO_STATS_EXTRA_NAME_LEN];
 
} odp_pktio_extra_stat_info_t;
 
int odp_pktio_stats(odp_pktio_t pktio, odp_pktio_stats_t *stats);
 
int odp_pktin_queue_stats(odp_pktin_queue_t queue,
              odp_pktin_queue_stats_t *stats);
 
int odp_pktin_event_queue_stats(odp_pktio_t pktio, odp_queue_t queue,
                odp_pktin_queue_stats_t *stats);
 
int odp_pktout_queue_stats(odp_pktout_queue_t queue,
               odp_pktout_queue_stats_t *stats);
 
int odp_pktout_event_queue_stats(odp_pktio_t pktio, odp_queue_t queue,
                 odp_pktout_queue_stats_t *stats);
 
int odp_pktio_stats_reset(odp_pktio_t pktio);
 
int odp_pktio_extra_stat_info(odp_pktio_t pktio,
                  odp_pktio_extra_stat_info_t info[], int num);
 
int odp_pktio_extra_stats(odp_pktio_t pktio, uint64_t stats[], int num);
 
int odp_pktio_extra_stat_counter(odp_pktio_t pktio, uint32_t id,
                 uint64_t *stat);
 
void odp_pktio_extra_stats_print(odp_pktio_t pktio);
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif