flow_mark_set_main.c

Go to the documentation of this file.

/*
 * Copyright (c) 2022-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 <stdlib.h>
 
#include <doca_argp.h>
#include <doca_flow.h>
#include <doca_log.h>
 
#include <dpdk_utils.h>
#include "flow_mark_set.h"
 
DOCA_LOG_REGISTER(FLOW_MARK_SET::MAIN);
 
/* Sample's Logic */
doca_error_t flow_mark_set(int nb_queues, struct mark_set_config *app_cfg);
 
/*
 * Callback for arg action flavour
 *
 * @param [in]: parameter
 * @config [in]: app dpdk config
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise
 */
static doca_error_t action_type_param_callback(void *param, void *config)
{
    struct mark_set_config *app_config = config;
    const char *str = param;
 
    if (strcmp(str, "changeable") == 0)
        app_config->action_changeable = true;
    else if (strcmp(str, "specific") == 0)
        app_config->action_changeable = false;
    else {
        DOCA_LOG_ERR("Unknown action-type '%s' was specified", str);
        return DOCA_ERROR_NOT_SUPPORTED;
    }
 
    return DOCA_SUCCESS;
}
 
/*
 * Callback for arg action flavour
 *
 * @param [in]: parameter
 * @config [in]: app dpdk config
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise
 */
static doca_error_t mark_value_param_callback(void *param, void *config)
{
    struct mark_set_config *app_config = config;
    const char *str = param;
    char *endptr;
 
    app_config->mark_value = strtol(str, &endptr, 0);
    if (*endptr) {
        DOCA_LOG_ERR("Invalid value for mark val: %s", str);
        return -EINVAL;
    }
 
    return DOCA_SUCCESS;
}
 
/*
 * Register for mark_set params
 *
 * @return: EXIT_SUCCESS on success and EXIT_FAILURE otherwise
 */
static int register_app_params(void)
{
    doca_error_t result;
    struct doca_argp_param *action_type_param;
    struct doca_argp_param *mark_value_param;
 
    /* Create and register mark-type paras */
    result = doca_argp_param_create(&action_type_param);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create mark-type ARGP param: %s", doca_error_get_descr(result));
        return result;
    }
 
    doca_argp_param_set_short_name(action_type_param, "type");
    doca_argp_param_set_long_name(action_type_param, "action-type");
    doca_argp_param_set_arguments(action_type_param, "<action-type>");
    doca_argp_param_set_description(action_type_param, "Set action-type (\"changeable\", \"specific\")");
    doca_argp_param_set_callback(action_type_param, action_type_param_callback);
    doca_argp_param_set_type(action_type_param, DOCA_ARGP_TYPE_STRING);
    result = doca_argp_register_param(action_type_param);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to register program param: %s", doca_error_get_descr(result));
        return result;
    }
 
    /* Create and register markt value param */
    result = doca_argp_param_create(&mark_value_param);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create mark value ARGP param: %s", doca_error_get_descr(result));
        return result;
    }
    doca_argp_param_set_short_name(mark_value_param, "markval");
    doca_argp_param_set_long_name(mark_value_param, "mark-value");
    doca_argp_param_set_arguments(mark_value_param, "<mark-value>");
    doca_argp_param_set_description(mark_value_param, "Set the mark value");
    doca_argp_param_set_callback(mark_value_param, mark_value_param_callback);
    doca_argp_param_set_type(mark_value_param, DOCA_ARGP_TYPE_STRING);
    result = doca_argp_register_param(mark_value_param);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to register program param: %s", doca_error_get_descr(result));
        return result;
    }
 
    return 0;
}
 
/*
 * Sample main function
 *
 * @argc [in]: command line arguments size
 * @argv [in]: array of command line arguments
 * @return: EXIT_SUCCESS on success and EXIT_FAILURE otherwise
 */
int main(int argc, char **argv)
{
    doca_error_t result;
    struct doca_log_backend *sdk_log;
    int exit_status = EXIT_FAILURE;
    struct application_dpdk_config dpdk_config = {
        .port_config.nb_ports = 2,
        .port_config.nb_queues = 4,
        .port_config.nb_hairpin_q = 1,
        .reserve_main_thread = true,
    };
    struct mark_set_config app_cfg = {.action_changeable = false, .mark_value = 0x123456};
 
    /* Register a logger backend */
    result = doca_log_backend_create_standard();
    if (result != DOCA_SUCCESS)
        goto sample_exit;
 
    /* Register a logger backend for internal SDK errors and warnings */
    result = doca_log_backend_create_with_file_sdk(stderr, &sdk_log);
    if (result != DOCA_SUCCESS)
        goto sample_exit;
    result = doca_log_backend_set_sdk_level(sdk_log, DOCA_LOG_LEVEL_WARNING);
    if (result != DOCA_SUCCESS)
        goto sample_exit;
 
    DOCA_LOG_INFO("Starting the sample");
 
    result = doca_argp_init(NULL, &app_cfg);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to init ARGP resources: %s", doca_error_get_descr(result));
        goto sample_exit;
    }
    result = register_app_params();
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to register Flow parameters: %s", doca_error_get_descr(result));
        goto argp_cleanup;
    }
    doca_argp_set_dpdk_program(dpdk_init);
    result = doca_argp_start(argc, argv);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to parse sample input: %s", doca_error_get_descr(result));
        goto argp_cleanup;
    }
 
    /* update queues and ports */
    result = dpdk_queues_and_ports_init(&dpdk_config);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to update ports and queues");
        goto dpdk_cleanup;
    }
 
    /* run sample */
    result = flow_mark_set(dpdk_config.port_config.nb_queues, &app_cfg);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("flow_mark_set() encountered an error: %s", doca_error_get_descr(result));
        goto dpdk_ports_queues_cleanup;
    }
 
    exit_status = EXIT_SUCCESS;
 
dpdk_ports_queues_cleanup:
    dpdk_queues_and_ports_fini(&dpdk_config);
dpdk_cleanup:
    dpdk_fini();
argp_cleanup:
    doca_argp_destroy();
sample_exit:
    if (exit_status == EXIT_SUCCESS)
        DOCA_LOG_INFO("Sample finished successfully");
    else
        DOCA_LOG_INFO("Sample finished with errors");
    return exit_status;
}