net_stats.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2016 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_NET_STATS_H_
#define ZEPHYR_INCLUDE_NET_NET_STATS_H_
 
#include <zephyr/types.h>
#include <net/net_core.h>
#include <net/net_mgmt.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef uint32_t net_stats_t;
 
struct net_stats_bytes {
        net_stats_t sent;
        net_stats_t received;
};
 
struct net_stats_pkts {
        net_stats_t tx;
        net_stats_t rx;
};
 
struct net_stats_ip {
        net_stats_t recv;
 
        net_stats_t sent;
 
        net_stats_t forwarded;
 
        net_stats_t drop;
};
 
struct net_stats_ip_errors {
        net_stats_t vhlerr;
 
        net_stats_t hblenerr;
 
        net_stats_t lblenerr;
 
        net_stats_t fragerr;
 
        net_stats_t chkerr;
 
        net_stats_t protoerr;
};
 
struct net_stats_icmp {
        net_stats_t recv;
 
        net_stats_t sent;
 
        net_stats_t drop;
 
        net_stats_t typeerr;
 
        net_stats_t chkerr;
};
 
struct net_stats_tcp {
        struct net_stats_bytes bytes;
 
        net_stats_t resent;
 
        net_stats_t drop;
 
        net_stats_t recv;
 
        net_stats_t sent;
 
        net_stats_t seg_drop;
 
        net_stats_t chkerr;
 
        net_stats_t ackerr;
 
        net_stats_t rsterr;
 
        net_stats_t rst;
 
        net_stats_t rexmit;
 
        net_stats_t conndrop;
 
        net_stats_t connrst;
};
 
struct net_stats_udp {
        net_stats_t drop;
 
        net_stats_t recv;
 
        net_stats_t sent;
 
        net_stats_t chkerr;
};
 
struct net_stats_ipv6_nd {
        net_stats_t drop;
        net_stats_t recv;
        net_stats_t sent;
};
 
struct net_stats_ipv6_mld {
        net_stats_t recv;
 
        net_stats_t sent;
 
        net_stats_t drop;
};
 
struct net_stats_ipv4_igmp {
        net_stats_t recv;
 
        net_stats_t sent;
 
        net_stats_t drop;
};
 
struct net_stats_tx_time {
        uint64_t sum;
        net_stats_t count;
};
 
struct net_stats_rx_time {
        uint64_t sum;
        net_stats_t count;
};
 
#if NET_TC_TX_COUNT == 0
#define NET_TC_TX_STATS_COUNT 1
#else
#define NET_TC_TX_STATS_COUNT NET_TC_TX_COUNT
#endif
 
#if NET_TC_RX_COUNT == 0
#define NET_TC_RX_STATS_COUNT 1
#else
#define NET_TC_RX_STATS_COUNT NET_TC_RX_COUNT
#endif
 
struct net_stats_tc {
        struct {
                struct net_stats_tx_time tx_time;
#if defined(CONFIG_NET_PKT_TXTIME_STATS_DETAIL)
                struct net_stats_tx_time
                                tx_time_detail[NET_PKT_DETAIL_STATS_COUNT];
#endif
                net_stats_t pkts;
                net_stats_t bytes;
                uint8_t priority;
        } sent[NET_TC_TX_STATS_COUNT];
 
        struct {
                struct net_stats_rx_time rx_time;
#if defined(CONFIG_NET_PKT_RXTIME_STATS_DETAIL)
                struct net_stats_rx_time
                                rx_time_detail[NET_PKT_DETAIL_STATS_COUNT];
#endif
                net_stats_t pkts;
                net_stats_t bytes;
                uint8_t priority;
        } recv[NET_TC_RX_STATS_COUNT];
};
 
 
struct net_stats_pm {
        uint64_t overall_suspend_time;
        net_stats_t suspend_count;
        uint32_t last_suspend_time;
        uint32_t start_time;
};
 
 
struct net_stats {
        net_stats_t processing_error;
 
        struct net_stats_bytes bytes;
 
        struct net_stats_ip_errors ip_errors;
 
#if defined(CONFIG_NET_STATISTICS_IPV6)
        struct net_stats_ip ipv6;
#endif
 
#if defined(CONFIG_NET_STATISTICS_IPV4)
        struct net_stats_ip ipv4;
#endif
 
#if defined(CONFIG_NET_STATISTICS_ICMP)
        struct net_stats_icmp icmp;
#endif
 
#if defined(CONFIG_NET_STATISTICS_TCP)
        struct net_stats_tcp tcp;
#endif
 
#if defined(CONFIG_NET_STATISTICS_UDP)
        struct net_stats_udp udp;
#endif
 
#if defined(CONFIG_NET_STATISTICS_IPV6_ND)
        struct net_stats_ipv6_nd ipv6_nd;
#endif
 
#if defined(CONFIG_NET_STATISTICS_MLD)
        struct net_stats_ipv6_mld ipv6_mld;
#endif
 
#if defined(CONFIG_NET_STATISTICS_IGMP)
        struct net_stats_ipv4_igmp ipv4_igmp;
#endif
 
#if NET_TC_COUNT > 1
        struct net_stats_tc tc;
#endif
 
#if defined(CONFIG_NET_PKT_TXTIME_STATS)
        struct net_stats_tx_time tx_time;
#endif
 
#if defined(CONFIG_NET_PKT_RXTIME_STATS)
        struct net_stats_rx_time rx_time;
#endif
 
#if defined(CONFIG_NET_PKT_TXTIME_STATS_DETAIL)
        struct net_stats_tx_time tx_time_detail[NET_PKT_DETAIL_STATS_COUNT];
#endif
#if defined(CONFIG_NET_PKT_RXTIME_STATS_DETAIL)
        struct net_stats_rx_time rx_time_detail[NET_PKT_DETAIL_STATS_COUNT];
#endif
 
#if defined(CONFIG_NET_STATISTICS_POWER_MANAGEMENT)
        struct net_stats_pm pm;
#endif
};
 
struct net_stats_eth_errors {
        net_stats_t rx_length_errors;
        net_stats_t rx_over_errors;
        net_stats_t rx_crc_errors;
        net_stats_t rx_frame_errors;
        net_stats_t rx_no_buffer_count;
        net_stats_t rx_missed_errors;
        net_stats_t rx_long_length_errors;
        net_stats_t rx_short_length_errors;
        net_stats_t rx_align_errors;
        net_stats_t rx_dma_failed;
        net_stats_t rx_buf_alloc_failed;
 
        net_stats_t tx_aborted_errors;
        net_stats_t tx_carrier_errors;
        net_stats_t tx_fifo_errors;
        net_stats_t tx_heartbeat_errors;
        net_stats_t tx_window_errors;
        net_stats_t tx_dma_failed;
 
        net_stats_t uncorr_ecc_errors;
        net_stats_t corr_ecc_errors;
};
 
struct net_stats_eth_flow {
        net_stats_t rx_flow_control_xon;
        net_stats_t rx_flow_control_xoff;
        net_stats_t tx_flow_control_xon;
        net_stats_t tx_flow_control_xoff;
};
 
struct net_stats_eth_csum {
        net_stats_t rx_csum_offload_good;
        net_stats_t rx_csum_offload_errors;
};
 
struct net_stats_eth_hw_timestamp {
        net_stats_t rx_hwtstamp_cleared;
        net_stats_t tx_hwtstamp_timeouts;
        net_stats_t tx_hwtstamp_skipped;
};
 
#ifdef CONFIG_NET_STATISTICS_ETHERNET_VENDOR
struct net_stats_eth_vendor {
        const char * const key;
        uint32_t value;
};
#endif
 
struct net_stats_eth {
        struct net_stats_bytes bytes;
        struct net_stats_pkts pkts;
        struct net_stats_pkts broadcast;
        struct net_stats_pkts multicast;
        struct net_stats_pkts errors;
        struct net_stats_eth_errors error_details;
        struct net_stats_eth_flow flow_control;
        struct net_stats_eth_csum csum;
        struct net_stats_eth_hw_timestamp hw_timestamp;
        net_stats_t collisions;
        net_stats_t tx_dropped;
        net_stats_t tx_timeout_count;
        net_stats_t tx_restart_queue;
#ifdef CONFIG_NET_STATISTICS_ETHERNET_VENDOR
        struct net_stats_eth_vendor *vendor;
#endif
};
 
struct net_stats_ppp {
        struct net_stats_bytes bytes;
        struct net_stats_pkts pkts;
 
        net_stats_t drop;
 
        net_stats_t chkerr;
};
 
#if defined(CONFIG_NET_STATISTICS_USER_API)
/* Management part definitions */
 
#define _NET_STATS_LAYER        NET_MGMT_LAYER_L3
#define _NET_STATS_CODE         0x101
#define _NET_STATS_BASE         (NET_MGMT_LAYER(_NET_STATS_LAYER) |     \
                                 NET_MGMT_LAYER_CODE(_NET_STATS_CODE))
 
enum net_request_stats_cmd {
        NET_REQUEST_STATS_CMD_GET_ALL = 1,
        NET_REQUEST_STATS_CMD_GET_PROCESSING_ERROR,
        NET_REQUEST_STATS_CMD_GET_BYTES,
        NET_REQUEST_STATS_CMD_GET_IP_ERRORS,
        NET_REQUEST_STATS_CMD_GET_IPV4,
        NET_REQUEST_STATS_CMD_GET_IPV6,
        NET_REQUEST_STATS_CMD_GET_IPV6_ND,
        NET_REQUEST_STATS_CMD_GET_ICMP,
        NET_REQUEST_STATS_CMD_GET_UDP,
        NET_REQUEST_STATS_CMD_GET_TCP,
        NET_REQUEST_STATS_CMD_GET_ETHERNET,
        NET_REQUEST_STATS_CMD_GET_PPP,
        NET_REQUEST_STATS_CMD_GET_PM
};
 
#define NET_REQUEST_STATS_GET_ALL                               \
        (_NET_STATS_BASE | NET_REQUEST_STATS_CMD_GET_ALL)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_STATS_GET_ALL);
 
#define NET_REQUEST_STATS_GET_PROCESSING_ERROR                          \
        (_NET_STATS_BASE | NET_REQUEST_STATS_CMD_GET_PROCESSING_ERROR)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_STATS_GET_PROCESSING_ERROR);
 
#define NET_REQUEST_STATS_GET_BYTES                             \
        (_NET_STATS_BASE | NET_REQUEST_STATS_CMD_GET_BYTES)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_STATS_GET_BYTES);
 
#define NET_REQUEST_STATS_GET_IP_ERRORS                         \
        (_NET_STATS_BASE | NET_REQUEST_STATS_CMD_GET_IP_ERRORS)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_STATS_GET_IP_ERRORS);
 
#if defined(CONFIG_NET_STATISTICS_IPV4)
#define NET_REQUEST_STATS_GET_IPV4                              \
        (_NET_STATS_BASE | NET_REQUEST_STATS_CMD_GET_IPV4)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_STATS_GET_IPV4);
#endif /* CONFIG_NET_STATISTICS_IPV4 */
 
#if defined(CONFIG_NET_STATISTICS_IPV6)
#define NET_REQUEST_STATS_GET_IPV6                              \
        (_NET_STATS_BASE | NET_REQUEST_STATS_CMD_GET_IPV6)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_STATS_GET_IPV6);
#endif /* CONFIG_NET_STATISTICS_IPV6 */
 
#if defined(CONFIG_NET_STATISTICS_IPV6_ND)
#define NET_REQUEST_STATS_GET_IPV6_ND                           \
        (_NET_STATS_BASE | NET_REQUEST_STATS_CMD_GET_IPV6_ND)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_STATS_GET_IPV6_ND);
#endif /* CONFIG_NET_STATISTICS_IPV6_ND */
 
#if defined(CONFIG_NET_STATISTICS_ICMP)
#define NET_REQUEST_STATS_GET_ICMP                              \
        (_NET_STATS_BASE | NET_REQUEST_STATS_CMD_GET_ICMP)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_STATS_GET_ICMP);
#endif /* CONFIG_NET_STATISTICS_ICMP */
 
#if defined(CONFIG_NET_STATISTICS_UDP)
#define NET_REQUEST_STATS_GET_UDP                               \
        (_NET_STATS_BASE | NET_REQUEST_STATS_CMD_GET_UDP)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_STATS_GET_UDP);
#endif /* CONFIG_NET_STATISTICS_UDP */
 
#if defined(CONFIG_NET_STATISTICS_TCP)
#define NET_REQUEST_STATS_GET_TCP                               \
        (_NET_STATS_BASE | NET_REQUEST_STATS_CMD_GET_TCP)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_STATS_GET_TCP);
#endif /* CONFIG_NET_STATISTICS_TCP */
 
#if defined(CONFIG_NET_STATISTICS_ETHERNET)
#define NET_REQUEST_STATS_GET_ETHERNET                          \
        (_NET_STATS_BASE | NET_REQUEST_STATS_CMD_GET_ETHERNET)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_STATS_GET_ETHERNET);
#endif /* CONFIG_NET_STATISTICS_ETHERNET */
 
#if defined(CONFIG_NET_STATISTICS_PPP)
#define NET_REQUEST_STATS_GET_PPP                               \
        (_NET_STATS_BASE | NET_REQUEST_STATS_CMD_GET_PPP)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_STATS_GET_PPP);
#endif /* CONFIG_NET_STATISTICS_PPP */
 
#endif /* CONFIG_NET_STATISTICS_USER_API */
 
#if defined(CONFIG_NET_STATISTICS_POWER_MANAGEMENT)
#define NET_REQUEST_STATS_GET_PM                                \
        (_NET_STATS_BASE | NET_REQUEST_STATS_CMD_GET_PM)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_STATS_GET_PM);
#endif /* CONFIG_NET_STATISTICS_POWER_MANAGEMENT */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_NET_STATS_H_ */