flow_tcp_seq_sample.c

Go to the documentation of this file.

/*
 * Copyright (c) 2025 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 <string.h>
#include <unistd.h>
 
#include <doca_bitfield.h>
#include <doca_log.h>
#include <doca_flow.h>
 
#include "flow_common.h"
 
/* Number of action descriptors */
#define NB_ACTION_DESC (1)
/* The number of seconds app waits for traffic to come */
#define WAITING_TIME (5)
 
DOCA_LOG_REGISTER(FLOW_TCP_SEQ);
 
static doca_error_t create_root_pipe(struct doca_flow_port *port,
                     struct doca_flow_pipe *next_pipe,
                     struct doca_flow_pipe **pipe)
{
    struct doca_flow_match match = {0};
    struct doca_flow_fwd fwd = {0};
    struct doca_flow_pipe_cfg *pipe_cfg;
    doca_error_t result;
 
    match.parser_meta.outer_l3_type = DOCA_FLOW_L3_META_IPV4;
    match.parser_meta.outer_l4_type = DOCA_FLOW_L4_META_TCP;
 
    result = doca_flow_pipe_cfg_create(&pipe_cfg, port);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create doca_flow_pipe_cfg: %s", doca_error_get_descr(result));
        return result;
    }
 
    result = set_flow_pipe_cfg(pipe_cfg, "TCP_SEQ_ROOT", DOCA_FLOW_PIPE_BASIC, true);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to set doca_flow_pipe_cfg: %s", doca_error_get_descr(result));
        goto destroy_pipe_cfg;
    }
    result = doca_flow_pipe_cfg_set_match(pipe_cfg, &match, NULL);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to set doca_flow_pipe_cfg match: %s", doca_error_get_descr(result));
        goto destroy_pipe_cfg;
    }
 
    fwd.type = DOCA_FLOW_FWD_PIPE;
    fwd.next_pipe = next_pipe;
 
    result = doca_flow_pipe_create(pipe_cfg, &fwd, NULL, pipe);
 
destroy_pipe_cfg:
    doca_flow_pipe_cfg_destroy(pipe_cfg);
    return result;
}
 
static doca_error_t create_comparison_pipe(struct doca_flow_port *port, struct doca_flow_pipe **pipe)
{
    struct doca_flow_pipe_cfg *pipe_cfg;
    doca_error_t result;
 
    result = doca_flow_pipe_cfg_create(&pipe_cfg, port);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create doca_flow_pipe_cfg: %s", doca_error_get_descr(result));
        return result;
    }
 
    result = set_flow_pipe_cfg(pipe_cfg, "TCP_SEQ_COMPARE", DOCA_FLOW_PIPE_CONTROL, false);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to set doca_flow_pipe_cfg: %s", doca_error_get_descr(result));
        goto destroy_pipe_cfg;
    }
 
    result = doca_flow_pipe_create(pipe_cfg, NULL, NULL, pipe);
 
destroy_pipe_cfg:
    doca_flow_pipe_cfg_destroy(pipe_cfg);
    return result;
}
 
static doca_error_t add_comparison_pipe_entry(struct doca_flow_pipe *pipe,
                          struct doca_flow_pipe *next_pipe,
                          struct entries_status *status)
{
    struct doca_flow_match match;
    struct doca_flow_match_condition condition;
    struct doca_flow_fwd fwd;
 
    condition.operation = DOCA_FLOW_COMPARE_LT;
    condition.field_op.a.field_string = "outer.tcp.seq_num";
    condition.field_op.a.bit_offset = 0;
    condition.field_op.b.field_string = NULL;
    condition.field_op.b.bit_offset = 0;
    condition.field_op.width = 32;
 
    match.outer.tcp.seq_num = DOCA_HTOBE32(10);
 
    fwd.type = DOCA_FLOW_FWD_PIPE;
    fwd.next_pipe = next_pipe;
 
    return doca_flow_pipe_control_add_entry(0 /* queue */,
                        0 /* priority */,
                        pipe,
                        &match,
                        NULL /* match_mask */,
                        &condition,
                        NULL,
                        NULL,
                        NULL,
                        NULL,
                        &fwd,
                        status,
                        NULL);
}
 
static doca_error_t create_action_pipe(struct doca_flow_port *port, int port_id, struct doca_flow_pipe **pipe)
{
    struct doca_flow_match match = {0};
    struct doca_flow_actions actions = {0}, *actions_arr[NB_ACTIONS_ARR];
    struct doca_flow_fwd fwd = {0};
    struct doca_flow_pipe_cfg *pipe_cfg;
    struct doca_flow_action_descs descs = {0}, *descs_arr[NB_ACTIONS_ARR];
    struct doca_flow_action_desc desc_array[NB_ACTION_DESC] = {0};
    doca_error_t result;
 
    match.parser_meta.outer_l3_type = DOCA_FLOW_L3_META_IPV4;
    match.parser_meta.outer_l4_type = DOCA_FLOW_L4_META_TCP;
 
    actions_arr[0] = &actions;
    descs_arr[0] = &descs;
    descs.nb_action_desc = NB_ACTION_DESC;
    descs.desc_array = desc_array;
 
    desc_array[0].type = DOCA_FLOW_ACTION_ADD;
    desc_array[0].field_op.dst.field_string = "outer.tcp.ack_num";
    desc_array[0].field_op.dst.bit_offset = 0;
    desc_array[0].field_op.width = 32;
 
    actions.outer.tcp.ack_num = DOCA_HTOBE32(314);
 
    result = doca_flow_pipe_cfg_create(&pipe_cfg, port);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create doca_flow_pipe_cfg: %s", doca_error_get_descr(result));
        return result;
    }
 
    result = set_flow_pipe_cfg(pipe_cfg, "TCP_SEQ_ACTION", DOCA_FLOW_PIPE_BASIC, false);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to set doca_flow_pipe_cfg: %s", doca_error_get_descr(result));
        goto destroy_pipe_cfg;
    }
    result = doca_flow_pipe_cfg_set_match(pipe_cfg, &match, NULL);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to set doca_flow_pipe_cfg match: %s", doca_error_get_descr(result));
        goto destroy_pipe_cfg;
    }
    result = doca_flow_pipe_cfg_set_actions(pipe_cfg, actions_arr, NULL, descs_arr, NB_ACTIONS_ARR);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to set doca_flow_pipe_cfg actions: %s", doca_error_get_descr(result));
        goto destroy_pipe_cfg;
    }
 
    /* forwarding traffic to other port */
    fwd.type = DOCA_FLOW_FWD_PORT;
    fwd.port_id = port_id ^ 1;
 
    result = doca_flow_pipe_create(pipe_cfg, &fwd, NULL, pipe);
 
destroy_pipe_cfg:
    doca_flow_pipe_cfg_destroy(pipe_cfg);
    return result;
}
 
/*
 * Run flow_tcp_seq sample
 *
 * @nb_queues [in]: number of queues the sample will use
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise.
 */
doca_error_t flow_tcp_seq(int nb_queues)
{
    int nb_ports = 2;
    struct flow_resources resource = {0};
    uint32_t nr_shared_resources[SHARED_RESOURCE_NUM_VALUES] = {0};
    struct doca_flow_port *ports[nb_ports];
    struct doca_dev *dev_arr[nb_ports];
    uint32_t actions_mem_size[nb_ports];
    struct doca_flow_pipe *root_pipe, *action_pipe, *comparison_pipe;
    uint32_t num_of_entries = 3;
    doca_error_t result;
    int port_id;
 
    result = init_doca_flow(nb_queues, "vnf,hws", &resource, nr_shared_resources);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to init DOCA Flow: %s", doca_error_get_descr(result));
        return result;
    }
 
    memset(dev_arr, 0, sizeof(struct doca_dev *) * nb_ports);
    ARRAY_INIT(actions_mem_size, ACTIONS_MEM_SIZE(nb_queues, num_of_entries));
    result = init_doca_flow_ports(nb_ports, ports, true, dev_arr, actions_mem_size);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to init DOCA ports: %s", doca_error_get_descr(result));
        doca_flow_destroy();
        return result;
    }
 
    for (port_id = 0; port_id < nb_ports; port_id++) {
        struct entries_status status = {0};
 
        result = create_action_pipe(ports[port_id], port_id, &action_pipe);
        if (result != DOCA_SUCCESS) {
            DOCA_LOG_ERR("Failed to create action pipe: %s", doca_error_get_descr(result));
            stop_doca_flow_ports(nb_ports, ports);
            doca_flow_destroy();
            return result;
        }
 
        result = doca_flow_pipe_add_entry(0, action_pipe, NULL, NULL, NULL, NULL, 0, &status, NULL);
        if (result != DOCA_SUCCESS) {
            DOCA_LOG_ERR("Failed to add action pipe entry: %s", doca_error_get_descr(result));
            stop_doca_flow_ports(nb_ports, ports);
            doca_flow_destroy();
            return result;
        }
 
        result = create_comparison_pipe(ports[port_id], &comparison_pipe);
        if (result != DOCA_SUCCESS) {
            DOCA_LOG_ERR("Failed to create comparison pipe: %s", doca_error_get_descr(result));
            stop_doca_flow_ports(nb_ports, ports);
            doca_flow_destroy();
            return result;
        }
 
        result = add_comparison_pipe_entry(comparison_pipe, action_pipe, &status);
        if (result != DOCA_SUCCESS) {
            DOCA_LOG_ERR("Failed to add comparison pipe entry: %s", doca_error_get_descr(result));
            stop_doca_flow_ports(nb_ports, ports);
            doca_flow_destroy();
            return result;
        }
 
        result = create_root_pipe(ports[port_id], comparison_pipe, &root_pipe);
        if (result != DOCA_SUCCESS) {
            DOCA_LOG_ERR("Failed to create root pipe: %s", doca_error_get_descr(result));
            stop_doca_flow_ports(nb_ports, ports);
            doca_flow_destroy();
            return result;
        }
 
        result = doca_flow_pipe_add_entry(0, root_pipe, NULL, NULL, NULL, NULL, 0, &status, NULL);
        if (result != DOCA_SUCCESS) {
            DOCA_LOG_ERR("Failed to add root pipeentry: %s", doca_error_get_descr(result));
            stop_doca_flow_ports(nb_ports, ports);
            doca_flow_destroy();
            return result;
        }
 
        result = flow_process_entries(ports[port_id], &status, num_of_entries);
        if (result != DOCA_SUCCESS) {
            DOCA_LOG_ERR("Failed to process entries: %s", doca_error_get_descr(result));
            stop_doca_flow_ports(nb_ports, ports);
            doca_flow_destroy();
            return result;
        }
    }
 
    DOCA_LOG_INFO("Wait %u seconds for packets to arrive", WAITING_TIME);
    sleep(WAITING_TIME);
 
    result = stop_doca_flow_ports(nb_ports, ports);
    doca_flow_destroy();
    return result;
}