apsh_netscan_get_sample.c

Go to the documentation of this file.

/*
 * Copyright (c) 2024 NVIDIA CORPORATION AND 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:
 *     * Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of the NVIDIA CORPORATION nor the names of its contributors may be used
 *       to endorse or promote products derived from this software without specific prior written
 *       permission.
 *
 * 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 NVIDIA CORPORATION 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 TOR (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
 
#include <inttypes.h>
 
#include <doca_apsh.h>
#include <doca_log.h>
 
#include "apsh_common.h"
 
DOCA_LOG_REGISTER(NETSCAN_GET);
#define BUFFER_SIZE 2048
 
void collect_interface_data(struct doca_apsh_netscan *connection, char *buffer)
{
    int offset = 0;
    char *interface_name = doca_apsh_netscan_info_get(connection, DOCA_APSH_NETSCAN_LINUX_INTERFACE_NAME);
    if (interface_name == NULL) {
        buffer[0] = '-';
        buffer[1] = '\0';
        return;
    }
    offset += snprintf(buffer + offset,
               BUFFER_SIZE - offset,
               "Interface name: %s",
               doca_apsh_netscan_info_get(connection, DOCA_APSH_NETSCAN_LINUX_INTERFACE_NAME));
 
    uint32_t ipv4_arr_size =
        doca_apsh_netscan_info_get(connection, DOCA_APSH_NETSCAN_LINUX_INTERFACE_IPV4_ARR_SIZE);
    if (ipv4_arr_size > 0) {
        offset += snprintf(buffer + offset, BUFFER_SIZE - offset, ", IPV4: ");
        char **ipv4_addr_arr =
            doca_apsh_netscan_info_get(connection, DOCA_APSH_NETSCAN_LINUX_INTERFACE_IPV4_ARR);
        // prints only first 5 IPV4 addresses
        for (uint32_t j = 0; j < ipv4_arr_size && j < 5; j++) {
            offset += snprintf(buffer + offset, BUFFER_SIZE - offset, "%s ", ipv4_addr_arr[j]);
        }
    }
    uint32_t ipv6_arr_size =
        doca_apsh_netscan_info_get(connection, DOCA_APSH_NETSCAN_LINUX_INTERFACE_IPV6_ARR_SIZE);
    if (ipv6_arr_size > 0) {
        offset += snprintf(buffer + offset, BUFFER_SIZE - offset, ", IPV6: ");
        char **ipv6_addr_arr =
            doca_apsh_netscan_info_get(connection, DOCA_APSH_NETSCAN_LINUX_INTERFACE_IPV6_ARR);
        // prints only first 5 IPV6 addresses
        for (uint32_t j = 0; j < ipv6_arr_size && j < 5; j++) {
            offset += snprintf(buffer + offset, BUFFER_SIZE - offset, "%s  ", ipv6_addr_arr[j]);
        }
    }
    uint32_t mac_arr_size = doca_apsh_netscan_info_get(connection, DOCA_APSH_NETSCAN_LINUX_INTERFACE_MAC_ARR_SIZE);
    if (mac_arr_size > 0) {
        offset += snprintf(buffer + offset, BUFFER_SIZE - offset, ", MAC address: ");
        char **mac_addr_arr = doca_apsh_netscan_info_get(connection, DOCA_APSH_NETSCAN_LINUX_INTERFACE_MAC_ARR);
        // prints only first 5 MAC addresses
        for (uint32_t j = 0; j < mac_arr_size && j < 5; j++) {
            offset += snprintf(buffer + offset, BUFFER_SIZE - offset, "%s  ", mac_addr_arr[j]);
        }
    }
}
/*
 * Calls the DOCA APSH API function that matches this sample name and prints the result
 *
 * @dma_device_name [in]: IBDEV Name of the device to use for DMA
 * @pci_vuid [in]: VUID of the device exposed to the target system
 * @os_type [in]: Indicates the OS type of the target system
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise
 */
doca_error_t netscan_get(const char *dma_device_name,
             const char *pci_vuid,
             enum doca_apsh_system_os os_type,
             const char *mem_region,
             const char *os_symbols)
{
    doca_error_t result;
    int num_connections, i;
    struct doca_apsh_ctx *apsh_ctx;
    struct doca_apsh_system *sys;
    struct doca_apsh_netscan **connections;
 
    /* Init */
    result = init_doca_apsh(dma_device_name, &apsh_ctx);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to init the DOCA APSH lib");
        return result;
    }
    DOCA_LOG_INFO("DOCA APSH lib context init successful");
 
    result = init_doca_apsh_system(apsh_ctx, os_type, os_symbols, mem_region, pci_vuid, &sys);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to init the system context");
        return result;
    }
    DOCA_LOG_INFO("DOCA APSH system context created");
 
    result = doca_apsh_netscan_get(sys, &connections, &num_connections);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create the connection list");
        cleanup_doca_apsh(apsh_ctx, sys);
        return result;
    }
    DOCA_LOG_INFO("Successfully performed %s. Host system contains %d connections", __func__, num_connections);
 
    /* Print some attributes of the connections */
    DOCA_LOG_INFO("Connections of system:");
    for (i = 0; i < num_connections; ++i) {
        DOCA_LOG_INFO(
            "\tConnection %d  - PID: %u, COMM: %s, Protocol: %s, local address: %s:%lu, local address: %s:%lu, state %s",
            i,
            doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_PID),
            doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_COMM),
            doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_PROTOCOL),
            doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_LOCAL_ADDR),
            doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_LOCAL_PORT),
            doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_REMOTE_ADDR),
            doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_REMOTE_PORT),
            doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_STATE));
        if (os_type == DOCA_APSH_SYSTEM_LINUX) {
            char interfaces_data_buffer[BUFFER_SIZE];
            collect_interface_data(connections[i], interfaces_data_buffer);
            DOCA_LOG_INFO("\tConnection %d  -  FD: %u, family: %s, type: %s, filter %s, Interface data: %s",
                      i,
                      doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_LINUX_FD),
                      doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_LINUX_FAMILY),
                      doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_LINUX_TYPE),
                      doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_LINUX_FILTER),
                      interfaces_data_buffer);
        }
        if (os_type == DOCA_APSH_SYSTEM_LINUX &&
            !strcmp(doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_PROTOCOL), "TCP")) {
            DOCA_LOG_INFO(
                "\tConnection %d - TCP connection - Bytes sent: %lu, Bytes acked: %lu, Bytes received: %lu, Segs in: %u, Segs out: %u, Data segs in: %u, Data segs out: %u",
                i,
                doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_LINUX_TCP_BYTES_SENT),
                doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_LINUX_TCP_BYTES_ACKED),
                doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_LINUX_TCP_BYTES_RECEIVED),
                doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_LINUX_TCP_SEGS_IN),
                doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_LINUX_TCP_SEGS_OUT),
                doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_LINUX_TCP_DATA_SEGS_IN),
                doca_apsh_netscan_info_get(connections[i], DOCA_APSH_NETSCAN_LINUX_TCP_DATA_SEGS_OUT));
        }
    }
 
    /* Cleanup */
    doca_apsh_netscan_free(connections);
    cleanup_doca_apsh(apsh_ctx, sys);
    return DOCA_SUCCESS;
}