flow_gtp_encap_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 <string.h>
#include <unistd.h>
 
#include <doca_log.h>
#include <doca_flow.h>
#include <doca_bitfield.h>
 
#include "flow_common.h"
 
DOCA_LOG_REGISTER(FLOW_GTP_ENCAP);
 
/*
 * Create DOCA Flow pipe with match on header types to filter out non IPV4 packets.
 *
 * @port [in]: port of the pipe
 * @port_id [in]: port ID of the pipe
 * @status [in]: user context for adding entry
 * @pipe [out]: created pipe pointer
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise.
 */
static doca_error_t create_classifier_pipe(struct doca_flow_port *port,
                       int port_id,
                       struct entries_status *status,
                       struct doca_flow_pipe **pipe)
{
    struct doca_flow_match match;
    struct doca_flow_fwd fwd;
    struct doca_flow_pipe_cfg *pipe_cfg;
    struct doca_flow_pipe_entry *entry;
    doca_error_t result;
 
    memset(&match, 0, sizeof(match));
    memset(&fwd, 0, sizeof(fwd));
 
    match.parser_meta.outer_l3_type = DOCA_FLOW_L3_META_IPV4;
 
    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, "CLASSIFIER_PIPE", 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;
    }
 
    /* 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);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create classifier pipe: %s", doca_error_get_descr(result));
        goto destroy_pipe_cfg;
    }
    result = doca_flow_pipe_add_entry(0, *pipe, &match, NULL, NULL, NULL, 0, status, &entry);
 
destroy_pipe_cfg:
    doca_flow_pipe_cfg_destroy(pipe_cfg);
    return result;
}
 
/*
 * Create DOCA Flow pipe on EGRESS domain with encap action with changeable values
 *
 * @port [in]: port of the pipe
 * @port_id [in]: pipe port ID
 * @pipe [out]: created pipe pointer
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise.
 */
static doca_error_t create_gtp_encap_pipe(struct doca_flow_port *port, int port_id, struct doca_flow_pipe **pipe)
{
    struct doca_flow_actions actions, *actions_arr[NB_ACTIONS_ARR];
    struct doca_flow_match match;
    struct doca_flow_fwd fwd;
    struct doca_flow_pipe_cfg *pipe_cfg;
    doca_error_t result;
 
    memset(&match, 0, sizeof(match));
    memset(&actions, 0, sizeof(actions));
    memset(&fwd, 0, sizeof(fwd));
 
    /* build basic outer GTP encap data*/
    actions.encap_type = DOCA_FLOW_RESOURCE_TYPE_NON_SHARED;
    SET_MAC_ADDR(actions.encap_cfg.encap.outer.eth.src_mac, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff);
    SET_MAC_ADDR(actions.encap_cfg.encap.outer.eth.dst_mac, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff);
    actions.encap_cfg.encap.outer.l3_type = DOCA_FLOW_L3_TYPE_IP4;
    actions.encap_cfg.encap.outer.ip4.src_ip = 0xffffffff;
    actions.encap_cfg.encap.outer.ip4.dst_ip = 0xffffffff;
    actions.encap_cfg.encap.outer.ip4.ttl = 0xff;
    actions.encap_cfg.encap.outer.ip4.flags_fragment_offset = 0xffff;
    actions.encap_cfg.encap.outer.l4_type_ext = DOCA_FLOW_L4_TYPE_EXT_UDP;
    actions.encap_cfg.encap.outer.udp.l4_port.dst_port = DOCA_HTOBE16(DOCA_FLOW_GTPU_DEFAULT_PORT);
    actions.encap_cfg.encap.tun.type = DOCA_FLOW_TUN_GTPU;
    actions.encap_cfg.encap.tun.gtp_teid = 0xffffffff;
    actions.encap_cfg.encap.tun.gtp_next_ext_hdr_type = DOCA_FLOW_GTP_EXT_PSC;
    actions.encap_cfg.encap.tun.gtp_ext_psc_qfi = 0xff;
    actions_arr[0] = &actions;
 
    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, "GTP_ENCAP_PIPE", 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_domain(pipe_cfg, DOCA_FLOW_PIPE_DOMAIN_EGRESS);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to set doca_flow_pipe_cfg domain: %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, NULL, 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 the wire */
    fwd.type = DOCA_FLOW_FWD_PORT;
    fwd.port_id = port_id;
 
    result = doca_flow_pipe_create(pipe_cfg, &fwd, NULL, pipe);
destroy_pipe_cfg:
    doca_flow_pipe_cfg_destroy(pipe_cfg);
    return result;
}
 
/*
 * Add DOCA Flow pipe entry with example gtp encap values
 *
 * @pipe [in]: pipe of the entry
 * @status [in]: user context for adding entry
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise.
 */
static doca_error_t add_gtp_encap_pipe_entry(struct doca_flow_pipe *pipe, struct entries_status *status)
{
    struct doca_flow_actions actions;
    struct doca_flow_pipe_entry *entry;
    doca_error_t result;
 
    doca_be32_t encap_dst_ip_addr = BE_IPV4_ADDR(81, 81, 81, 81);
    doca_be32_t encap_src_ip_addr = BE_IPV4_ADDR(11, 21, 31, 41);
    doca_be16_t encap_flags_fragment_offset = DOCA_HTOBE16(DOCA_FLOW_IP4_FLAG_DONT_FRAGMENT);
    uint8_t encap_ttl = 17;
    uint8_t src_mac[] = {0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0xff};
    uint8_t dst_mac[] = {0x11, 0x22, 0x33, 0x44, 0x55, 0x66};
 
    SET_MAC_ADDR(actions.encap_cfg.encap.outer.eth.src_mac,
             src_mac[0],
             src_mac[1],
             src_mac[2],
             src_mac[3],
             src_mac[4],
             src_mac[5]);
    SET_MAC_ADDR(actions.encap_cfg.encap.outer.eth.dst_mac,
             dst_mac[0],
             dst_mac[1],
             dst_mac[2],
             dst_mac[3],
             dst_mac[4],
             dst_mac[5]);
    actions.encap_cfg.encap.outer.l3_type = DOCA_FLOW_L3_TYPE_IP4;
    actions.encap_cfg.encap.outer.ip4.src_ip = encap_src_ip_addr;
    actions.encap_cfg.encap.outer.ip4.dst_ip = encap_dst_ip_addr;
    actions.encap_cfg.encap.outer.ip4.flags_fragment_offset = encap_flags_fragment_offset;
    actions.encap_cfg.encap.outer.ip4.ttl = encap_ttl;
    actions.encap_cfg.encap.tun.type = DOCA_FLOW_TUN_GTPU;
    actions.encap_cfg.encap.tun.gtp_teid = DOCA_HTOBE32(0xdeadbeef);
    actions.encap_cfg.encap.tun.gtp_next_ext_hdr_type = DOCA_FLOW_GTP_EXT_PSC;
    actions.encap_cfg.encap.tun.gtp_ext_psc_qfi = 0x26;
    actions.action_idx = 0;
 
    result = doca_flow_pipe_add_entry(0, pipe, NULL, &actions, NULL, NULL, 0, status, &entry);
    if (result != DOCA_SUCCESS)
        return result;
 
    return DOCA_SUCCESS;
}
 
/*
 * Run flow_gtp_encap sample
 *
 * @nb_queues [in]: number of queues the sample will use
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise.
 */
doca_error_t flow_gtp_encap(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 *pipe;
    struct doca_flow_pipe *classifier_pipe;
    struct entries_status status_ingress;
    int num_of_entries_ingress = 1;
    struct entries_status status_egress;
    int num_of_entries_egress = 1;
    doca_error_t result;
    int port_id;
 
    result = init_doca_flow(nb_queues, "vnf", &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_ingress + num_of_entries_egress));
    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++) {
        memset(&status_ingress, 0, sizeof(status_ingress));
        memset(&status_egress, 0, sizeof(status_egress));
 
        result = create_classifier_pipe(ports[port_id], port_id, &status_ingress, &classifier_pipe);
        if (result != DOCA_SUCCESS) {
            DOCA_LOG_ERR("Failed to create match pipe: %s", doca_error_get_descr(result));
            goto err;
        }
 
        result = create_gtp_encap_pipe(ports[port_id ^ 1], port_id ^ 1, &pipe);
        if (result != DOCA_SUCCESS) {
            DOCA_LOG_ERR("Failed to create gtp encap pipe: %s", doca_error_get_descr(result));
            goto err;
        }
 
        result = add_gtp_encap_pipe_entry(pipe, &status_egress);
        if (result != DOCA_SUCCESS) {
            DOCA_LOG_ERR("Failed to add entry to gtp encap pipe: %s", doca_error_get_descr(result));
            goto err;
        }
 
        result = flow_process_entries(ports[port_id], &status_ingress, num_of_entries_ingress);
        if (result != DOCA_SUCCESS) {
            DOCA_LOG_ERR("Failed to process entries: %s", doca_error_get_descr(result));
            goto err;
        }
 
        result = flow_process_entries(ports[port_id ^ 1], &status_egress, num_of_entries_egress);
        if (result != DOCA_SUCCESS) {
            DOCA_LOG_ERR("Failed to process entries: %s", doca_error_get_descr(result));
            goto err;
        }
    }
 
    DOCA_LOG_INFO("Wait few seconds for packets to arrive");
    sleep(10);
 
    result = stop_doca_flow_ports(nb_ports, ports);
    doca_flow_destroy();
    return result;
 
err:
    stop_doca_flow_ports(nb_ports, ports);
    doca_flow_destroy();
    return result;
}