args.c

Go to the documentation of this file.

/*
 * Copyright (c) 2023 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 <doca_argp.h>
#include <utils.h>
 
#include "common.h"
 
DOCA_LOG_REGISTER(GPU_ARGS);
 
/*
 * Get GPU PCIe address input.
 *
 * @param [in]: Command line parameter
 * @config [in]: Application configuration structure
 * @return: DOCA_SUCCESS on success and DOCA_ERROR_INVALID_VALUE otherwise
 */
static doca_error_t gpu_pci_address_callback(void *param, void *config)
{
    struct app_gpu_cfg *app_cfg = (struct app_gpu_cfg *)config;
    char *pci_address = (char *)param;
    int len;
 
    len = strnlen(pci_address, DOCA_DEVINFO_PCI_ADDR_SIZE);
    if (len >= DOCA_DEVINFO_PCI_ADDR_SIZE) {
        DOCA_LOG_ERR("PCI file name too long. Max %d", DOCA_DEVINFO_PCI_ADDR_SIZE - 1);
        return DOCA_ERROR_INVALID_VALUE;
    }
 
    strlcpy(app_cfg->gpu_pcie_addr, pci_address, DOCA_DEVINFO_PCI_ADDR_SIZE);
 
    return DOCA_SUCCESS;
}
 
/*
 * Enable GPU HTTP server mode.
 *
 * @param [in]: Command line parameter
 * @config [in]: Application configuration structure
 * @return: DOCA_SUCCESS on success and DOCA_ERROR_INVALID_VALUE otherwise
 */
static doca_error_t http_server_callback(void *param, void *config)
{
    struct app_gpu_cfg *app_cfg = (struct app_gpu_cfg *)config;
    bool http_server = *((bool *)param);
 
    app_cfg->http_server = http_server;
 
    return DOCA_SUCCESS;
}
 
/*
 * Get NIC PCIe address input.
 *
 * @param [in]: Command line parameter
 * @config [in]: Application configuration structure
 * @return: DOCA_SUCCESS on success and DOCA_ERROR_INVALID_VALUE otherwise
 */
static doca_error_t nic_pci_address_callback(void *param, void *config)
{
    struct app_gpu_cfg *app_cfg = (struct app_gpu_cfg *)config;
    char *pci_address = (char *)param;
    int len;
 
    len = strnlen(pci_address, DOCA_DEVINFO_PCI_ADDR_SIZE);
    if (len >= DOCA_DEVINFO_PCI_ADDR_SIZE) {
        DOCA_LOG_ERR("PCI file name too long. Max %d", DOCA_DEVINFO_PCI_ADDR_SIZE - 1);
        return DOCA_ERROR_INVALID_VALUE;
    }
 
    strlcpy(app_cfg->nic_pcie_addr, pci_address, DOCA_DEVINFO_PCI_ADDR_SIZE);
 
    return DOCA_SUCCESS;
}
 
/*
 * Get GPU receive queue number.
 *
 * @param [in]: Command line parameter
 * @config [in]: Application configuration structure
 * @return: DOCA_SUCCESS on success and DOCA_ERROR_INVALID_VALUE otherwise
 */
static doca_error_t queue_num_callback(void *param, void *config)
{
    struct app_gpu_cfg *app_cfg = (struct app_gpu_cfg *)config;
    int queue_num = *((int *)param);
 
    if (queue_num == 0 || queue_num > MAX_QUEUES) {
        DOCA_LOG_ERR("GPU receive queue number is wrong 0 < %d < %d", queue_num, MAX_QUEUES);
        return DOCA_ERROR_INVALID_VALUE;
    }
 
    app_cfg->queue_num = queue_num;
 
    return DOCA_SUCCESS;
}
 
doca_error_t register_application_params(void)
{
    doca_error_t result;
    struct doca_argp_param *gpu_param, *nic_param, *queue_param, *server_param;
 
    result = doca_argp_param_create(&gpu_param);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create ARGP param: %s", doca_error_get_descr(result));
        return result;
    }
 
    doca_argp_param_set_short_name(gpu_param, "g");
    doca_argp_param_set_long_name(gpu_param, "gpu");
    doca_argp_param_set_arguments(gpu_param, "<GPU PCIe address>");
    doca_argp_param_set_description(gpu_param, "GPU PCIe address to be used by the app");
    doca_argp_param_set_callback(gpu_param, gpu_pci_address_callback);
    doca_argp_param_set_type(gpu_param, DOCA_ARGP_TYPE_STRING);
    doca_argp_param_set_mandatory(gpu_param);
    result = doca_argp_register_param(gpu_param);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to register ARGP param: %s", doca_error_get_descr(result));
        return result;
    }
 
    result = doca_argp_param_create(&nic_param);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create ARGP param: %s", doca_error_get_descr(result));
        return result;
    }
 
    doca_argp_param_set_short_name(nic_param, "n");
    doca_argp_param_set_long_name(nic_param, "nic");
    doca_argp_param_set_arguments(nic_param, "<NIC PCIe address>");
    doca_argp_param_set_description(nic_param, "DOCA device PCIe address used by the app");
    doca_argp_param_set_callback(nic_param, nic_pci_address_callback);
    doca_argp_param_set_type(nic_param, DOCA_ARGP_TYPE_STRING);
    doca_argp_param_set_mandatory(nic_param);
    result = doca_argp_register_param(nic_param);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to register ARGP param: %s", doca_error_get_descr(result));
        return result;
    }
 
    result = doca_argp_param_create(&queue_param);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create ARGP param: %s", doca_error_get_descr(result));
        return result;
    }
 
    doca_argp_param_set_short_name(queue_param, "q");
    doca_argp_param_set_long_name(queue_param, "queue");
    doca_argp_param_set_arguments(queue_param, "<GPU receive queues>");
    doca_argp_param_set_description(queue_param, "DOCA GPUNetIO receive queue per flow");
    doca_argp_param_set_callback(queue_param, queue_num_callback);
    doca_argp_param_set_type(queue_param, DOCA_ARGP_TYPE_INT);
    doca_argp_param_set_mandatory(queue_param);
    result = doca_argp_register_param(queue_param);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to register ARGP param: %s", doca_error_get_descr(result));
        return result;
    }
 
    result = doca_argp_param_create(&server_param);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create ARGP param: %s", doca_error_get_descr(result));
        return result;
    }
 
    doca_argp_param_set_short_name(server_param, "s");
    doca_argp_param_set_long_name(server_param, "httpserver");
    doca_argp_param_set_arguments(server_param, "<Enable GPU HTTP server>");
    doca_argp_param_set_description(server_param, "Enable GPU HTTP server mode");
    doca_argp_param_set_callback(server_param, http_server_callback);
    doca_argp_param_set_type(server_param, DOCA_ARGP_TYPE_BOOLEAN);
    result = doca_argp_register_param(server_param);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to register ARGP param: %s", doca_error_get_descr(result));
        return result;
    }
 
    /* Register version callback for DOCA SDK & RUNTIME */
    result = doca_argp_register_version_callback(sdk_version_callback);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to register ARGP param: %s", doca_error_get_descr(result));
        return result;
    }
 
    return DOCA_SUCCESS;
}