root/sys/dev/virtual/amazon/ena/ena_sysctl.c
/*-
 * BSD LICENSE
 *
 * Copyright (c) 2015-2017 Amazon.com, Inc. or its affiliates.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * $FreeBSD: head/sys/dev/ena/ena_sysctl.c 325592 2017-11-09 13:36:42Z mw $
 */

#include "ena_sysctl.h"

static void     ena_sysctl_add_wd(struct ena_adapter *);
#if 0 /* XXX swildner counters */
static void     ena_sysctl_add_stats(struct ena_adapter *);
#endif

void
ena_sysctl_add_nodes(struct ena_adapter *adapter)
{
        ena_sysctl_add_wd(adapter);
#if 0 /* XXX swildner counters */
        ena_sysctl_add_stats(adapter);
#endif
}

static void
ena_sysctl_add_wd(struct ena_adapter *adapter)
{
        device_t dev;

        struct sysctl_ctx_list *ctx;
        struct sysctl_oid *tree;
        struct sysctl_oid_list *child;

        dev = adapter->pdev;

        ctx = device_get_sysctl_ctx(dev);
        tree = device_get_sysctl_tree(dev);
        child = SYSCTL_CHILDREN(tree);

        /* Sysctl calls for Watchdog service */
        SYSCTL_ADD_INT(ctx, child, OID_AUTO, "wd_active",
            CTLFLAG_RW, &adapter->wd_active, 0,
            "Watchdog is active");

        SYSCTL_ADD_QUAD(ctx, child, OID_AUTO, "keep_alive_timeout",
            CTLFLAG_RW, &adapter->keep_alive_timeout, 0,
            "Timeout for Keep Alive messages");

        SYSCTL_ADD_QUAD(ctx, child, OID_AUTO, "missing_tx_timeout",
            CTLFLAG_RW, &adapter->missing_tx_timeout, 0,
            "Timeout for TX completion");

        SYSCTL_ADD_U32(ctx, child, OID_AUTO, "missing_tx_max_queues",
            CTLFLAG_RW, &adapter->missing_tx_max_queues,
            "Number of TX queues to check per run");

        SYSCTL_ADD_U32(ctx, child, OID_AUTO, "missing_tx_threshold",
            CTLFLAG_RW, &adapter->missing_tx_threshold,
            "Max number of timeouted packets");
}

#if 0 /* XXX swildner counters */
static void
ena_sysctl_add_stats(struct ena_adapter *adapter)
{
        device_t dev;

        struct ena_ring *tx_ring;
        struct ena_ring *rx_ring;

        struct ena_hw_stats *hw_stats;
        struct ena_stats_dev *dev_stats;
        struct ena_stats_tx *tx_stats;
        struct ena_stats_rx *rx_stats;
        struct ena_com_stats_admin *admin_stats;

        struct sysctl_ctx_list *ctx;
        struct sysctl_oid *tree;
        struct sysctl_oid_list *child;

        struct sysctl_oid *queue_node, *tx_node, *rx_node, *hw_node;
        struct sysctl_oid *admin_node;
        struct sysctl_oid_list *queue_list, *tx_list, *rx_list, *hw_list;
        struct sysctl_oid_list *admin_list;

#define QUEUE_NAME_LEN 32
        char namebuf[QUEUE_NAME_LEN];
        int i;

        dev = adapter->pdev;

        ctx = device_get_sysctl_ctx(dev);
        tree = device_get_sysctl_tree(dev);
        child = SYSCTL_CHILDREN(tree);

        tx_ring = adapter->tx_ring;
        rx_ring = adapter->rx_ring;

        hw_stats = &adapter->hw_stats;
        dev_stats = &adapter->dev_stats;
        admin_stats = &adapter->ena_dev->admin_queue.stats;

        SYSCTL_ADD_COUNTER_U64(ctx, child, OID_AUTO, "wd_expired",
            CTLFLAG_RD, &dev_stats->wd_expired,
            "Watchdog expiry count");
        SYSCTL_ADD_COUNTER_U64(ctx, child, OID_AUTO, "interface_up",
            CTLFLAG_RD, &dev_stats->interface_up,
            "Network interface up count");
        SYSCTL_ADD_COUNTER_U64(ctx, child, OID_AUTO, "interface_down",
            CTLFLAG_RD, &dev_stats->interface_down,
            "Network interface down count");
        SYSCTL_ADD_COUNTER_U64(ctx, child, OID_AUTO, "admin_q_pause",
            CTLFLAG_RD, &dev_stats->admin_q_pause,
            "Admin queue pauses");

        for (i = 0; i < adapter->num_queues; ++i, ++tx_ring, ++rx_ring) {
                ksnprintf(namebuf, QUEUE_NAME_LEN, "queue%d", i);

                queue_node = SYSCTL_ADD_NODE(ctx, child, OID_AUTO,
                    namebuf, CTLFLAG_RD, NULL, "Queue Name");
                queue_list = SYSCTL_CHILDREN(queue_node);

                /* TX specific stats */
                tx_node = SYSCTL_ADD_NODE(ctx, queue_list, OID_AUTO,
                    "tx_ring", CTLFLAG_RD, NULL, "TX ring");
                tx_list = SYSCTL_CHILDREN(tx_node);

                tx_stats = &tx_ring->tx_stats;

                SYSCTL_ADD_COUNTER_U64(ctx, tx_list, OID_AUTO,
                    "count", CTLFLAG_RD,
                    &tx_stats->cnt, "Packets sent");
                SYSCTL_ADD_COUNTER_U64(ctx, tx_list, OID_AUTO,
                    "bytes", CTLFLAG_RD,
                    &tx_stats->bytes, "Bytes sent");
                SYSCTL_ADD_COUNTER_U64(ctx, tx_list, OID_AUTO,
                    "prepare_ctx_err", CTLFLAG_RD,
                    &tx_stats->prepare_ctx_err,
                    "TX buffer preparation failures");
                SYSCTL_ADD_COUNTER_U64(ctx, tx_list, OID_AUTO,
                    "dma_mapping_err", CTLFLAG_RD,
                    &tx_stats->dma_mapping_err, "DMA mapping failures");
                SYSCTL_ADD_COUNTER_U64(ctx, tx_list, OID_AUTO,
                    "doorbells", CTLFLAG_RD,
                    &tx_stats->doorbells, "Queue doorbells");
                SYSCTL_ADD_COUNTER_U64(ctx, tx_list, OID_AUTO,
                    "missing_tx_comp", CTLFLAG_RD,
                    &tx_stats->missing_tx_comp, "TX completions missed");
                SYSCTL_ADD_COUNTER_U64(ctx, tx_list, OID_AUTO,
                    "bad_req_id", CTLFLAG_RD,
                    &tx_stats->bad_req_id, "Bad request id count");
                SYSCTL_ADD_COUNTER_U64(ctx, tx_list, OID_AUTO,
                        "mbuf_collapses", CTLFLAG_RD,
                        &tx_stats->collapse,
                        "Mbuf collapse count");
                SYSCTL_ADD_COUNTER_U64(ctx, tx_list, OID_AUTO,
                        "mbuf_collapse_err", CTLFLAG_RD,
                        &tx_stats->collapse_err,
                        "Mbuf collapse failures");

                /* RX specific stats */
                rx_node = SYSCTL_ADD_NODE(ctx, queue_list, OID_AUTO,
                    "rx_ring", CTLFLAG_RD, NULL, "RX ring");
                rx_list = SYSCTL_CHILDREN(rx_node);

                rx_stats = &rx_ring->rx_stats;

                SYSCTL_ADD_COUNTER_U64(ctx, rx_list, OID_AUTO,
                    "count", CTLFLAG_RD,
                    &rx_stats->cnt, "Packets received");
                SYSCTL_ADD_COUNTER_U64(ctx, rx_list, OID_AUTO,
                    "bytes", CTLFLAG_RD,
                    &rx_stats->bytes, "Bytes received");
                SYSCTL_ADD_COUNTER_U64(ctx, rx_list, OID_AUTO,
                    "refil_partial", CTLFLAG_RD,
                    &rx_stats->refil_partial, "Partial refilled mbufs");
                SYSCTL_ADD_COUNTER_U64(ctx, rx_list, OID_AUTO,
                    "bad_csum", CTLFLAG_RD,
                    &rx_stats->bad_csum, "Bad RX checksum");
                SYSCTL_ADD_COUNTER_U64(ctx, rx_list, OID_AUTO,
                    "mbuf_alloc_fail", CTLFLAG_RD,
                    &rx_stats->mbuf_alloc_fail, "Failed mbuf allocs");
                SYSCTL_ADD_COUNTER_U64(ctx, rx_list, OID_AUTO,
                    "mjum_alloc_fail", CTLFLAG_RD,
                    &rx_stats->mjum_alloc_fail, "Failed jumbo mbuf allocs");
                SYSCTL_ADD_COUNTER_U64(ctx, rx_list, OID_AUTO,
                    "dma_mapping_err", CTLFLAG_RD,
                    &rx_stats->dma_mapping_err, "DMA mapping errors");
                SYSCTL_ADD_COUNTER_U64(ctx, rx_list, OID_AUTO,
                    "bad_desc_num", CTLFLAG_RD,
                    &rx_stats->bad_desc_num, "Bad descriptor count");
                SYSCTL_ADD_COUNTER_U64(ctx, rx_list, OID_AUTO,
                    "bad_req_id", CTLFLAG_RD,
                    &rx_stats->bad_req_id, "Bad request id count");
                SYSCTL_ADD_COUNTER_U64(ctx, rx_list, OID_AUTO,
                    "empty_rx_ring", CTLFLAG_RD,
                    &rx_stats->empty_rx_ring, "RX descriptors depletion count");
        }

        /* Stats read from device */
        hw_node = SYSCTL_ADD_NODE(ctx, child, OID_AUTO, "hw_stats",
            CTLFLAG_RD, NULL, "Statistics from hardware");
        hw_list = SYSCTL_CHILDREN(hw_node);

        SYSCTL_ADD_COUNTER_U64(ctx, hw_list, OID_AUTO, "rx_packets", CTLFLAG_RD,
            &hw_stats->rx_packets, "Packets received");
        SYSCTL_ADD_COUNTER_U64(ctx, hw_list, OID_AUTO, "tx_packets", CTLFLAG_RD,
            &hw_stats->tx_packets, "Packets transmitted");
        SYSCTL_ADD_COUNTER_U64(ctx, hw_list, OID_AUTO, "rx_bytes", CTLFLAG_RD,
            &hw_stats->rx_bytes, "Bytes received");
        SYSCTL_ADD_COUNTER_U64(ctx, hw_list, OID_AUTO, "tx_bytes", CTLFLAG_RD,
            &hw_stats->tx_bytes, "Bytes transmitted");
        SYSCTL_ADD_COUNTER_U64(ctx, hw_list, OID_AUTO, "rx_drops", CTLFLAG_RD,
            &hw_stats->rx_drops, "Receive packet drops");

        /* ENA Admin queue stats */
        admin_node = SYSCTL_ADD_NODE(ctx, child, OID_AUTO, "admin_stats",
            CTLFLAG_RD, NULL, "ENA Admin Queue statistics");
        admin_list = SYSCTL_CHILDREN(admin_node);

        SYSCTL_ADD_U32(ctx, admin_list, OID_AUTO, "aborted_cmd", CTLFLAG_RD,
            &admin_stats->aborted_cmd, "Aborted commands");
        SYSCTL_ADD_U32(ctx, admin_list, OID_AUTO, "sumbitted_cmd", CTLFLAG_RD,
            &admin_stats->submitted_cmd, "Submitted commands");
        SYSCTL_ADD_U32(ctx, admin_list, OID_AUTO, "completed_cmd", CTLFLAG_RD,
            &admin_stats->completed_cmd, "Completed commands");
        SYSCTL_ADD_U32(ctx, admin_list, OID_AUTO, "out_of_space", CTLFLAG_RD,
            &admin_stats->out_of_space, "Queue out of space");
        SYSCTL_ADD_U32(ctx, admin_list, OID_AUTO, "no_completion", CTLFLAG_RD,
            &admin_stats->no_completion, "Commands not completed");
}
#endif