flow_ct_tcp_entry_finalize_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 <unistd.h>
 
#include <rte_ethdev.h>
 
#include <doca_log.h>
#include <doca_flow.h>
#include <doca_flow_ct.h>
 
#include "flow_ct_common.h"
#include "flow_common.h"
 
#define PACKET_BURST 128
#define DEFAULT_CNT_DELAY_S 2
#define DEFAULT_CNT_QUERY_INTERVAL 1
 
DOCA_LOG_REGISTER(FLOW_CT_TCP_ENTRY_FINALIZE);
 
static int nb_entry_finalize_triggers;
static int nb_entries = 0;
 
/*
 * Create RSS pipe
 *
 * @port [in]: Pipe port
 * @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_rss_pipe(struct doca_flow_port *port,
                    struct entries_status *status,
                    struct doca_flow_pipe **pipe)
{
    struct doca_flow_match match;
    struct doca_flow_pipe_cfg *cfg;
    struct doca_flow_fwd fwd;
    uint16_t rss_queues[1];
    doca_error_t result;
 
    memset(&match, 0, sizeof(match));
    memset(&fwd, 0, sizeof(fwd));
 
    result = doca_flow_pipe_cfg_create(&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(cfg, "RSS_PIPE", 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(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;
    }
 
    /* RSS queue - send matched traffic to queue 0  */
    rss_queues[0] = 0;
    fwd.type = DOCA_FLOW_FWD_RSS;
    fwd.rss_type = DOCA_FLOW_RESOURCE_TYPE_NON_SHARED;
    fwd.rss.queues_array = rss_queues;
    fwd.rss.outer_flags = DOCA_FLOW_RSS_IPV4 | DOCA_FLOW_RSS_TCP;
    fwd.rss.nr_queues = 1;
 
    result = doca_flow_pipe_create(cfg, &fwd, NULL, pipe);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create RSS pipe: %s", doca_error_get_descr(result));
        goto destroy_pipe_cfg;
    }
    doca_flow_pipe_cfg_destroy(cfg);
 
    /* Match on any packet */
    result = doca_flow_pipe_add_entry(0, *pipe, &match, NULL, NULL, &fwd, 0, status, NULL);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to add RSS pipe entry: %s", doca_error_get_descr(result));
        return result;
    }
 
    result = doca_flow_entries_process(port, 0, DEFAULT_TIMEOUT_US, 0);
    if (result != DOCA_SUCCESS)
        DOCA_LOG_ERR("Failed to process RSS entry: %s", doca_error_get_descr(result));
 
    return result;
 
destroy_pipe_cfg:
    doca_flow_pipe_cfg_destroy(cfg);
    return result;
}
 
/*
 * Create egress pipe
 *
 * @port [in]: Pipe port
 * @port_id [in]: Next pipe port id
 * @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_egress_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_pipe_cfg *cfg;
    struct doca_flow_fwd fwd;
    doca_error_t result;
 
    memset(&match, 0, sizeof(match));
    memset(&fwd, 0, sizeof(fwd));
 
    result = doca_flow_pipe_cfg_create(&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(cfg, "EGRESS_PIPE", 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(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_PORT;
    fwd.port_id = port_id;
 
    result = doca_flow_pipe_create(cfg, &fwd, NULL, pipe);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create EGRESS pipe: %s", doca_error_get_descr(result));
        goto destroy_pipe_cfg;
    }
    doca_flow_pipe_cfg_destroy(cfg);
 
    /* Match on any packet */
    result = doca_flow_pipe_add_entry(0, *pipe, &match, NULL, NULL, &fwd, 0, status, NULL);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to add EGRESS pipe entry: %s", doca_error_get_descr(result));
        return result;
    }
 
    result = doca_flow_entries_process(port, 0, DEFAULT_TIMEOUT_US, 0);
    if (result != DOCA_SUCCESS)
        DOCA_LOG_ERR("Failed to process EGRESS entry: %s", doca_error_get_descr(result));
 
    return result;
 
destroy_pipe_cfg:
    doca_flow_pipe_cfg_destroy(cfg);
    return result;
}
 
/*
 * Create CT miss pipe
 *
 * @port [in]: Pipe port
 * @fwd_pipe [in]: Forward pipe pointer
 * @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_ct_miss_pipe(struct doca_flow_port *port,
                    struct doca_flow_pipe *fwd_pipe,
                    struct entries_status *status,
                    struct doca_flow_pipe **pipe)
{
    struct doca_flow_match match;
    struct doca_flow_pipe_cfg *cfg;
    struct doca_flow_fwd fwd;
    struct doca_flow_fwd fwd_miss;
    doca_error_t result;
 
    memset(&match, 0, sizeof(match));
    memset(&fwd, 0, sizeof(fwd));
    memset(&fwd_miss, 0, sizeof(fwd));
 
    result = doca_flow_pipe_cfg_create(&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(cfg, "CT_MISS_PIPE", 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(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 = fwd_pipe;
 
    fwd_miss.type = DOCA_FLOW_FWD_PIPE;
    fwd_miss.next_pipe = fwd_pipe;
 
    result = doca_flow_pipe_create(cfg, &fwd, &fwd_miss, pipe);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create CT miss pipe: %s", doca_error_get_descr(result));
        goto destroy_pipe_cfg;
    }
    doca_flow_pipe_cfg_destroy(cfg);
 
    /* Match on any packet */
    result = doca_flow_pipe_add_entry(0, *pipe, &match, NULL, NULL, &fwd, 0, status, NULL);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to add CT miss pipe entry: %s", doca_error_get_descr(result));
        return result;
    }
 
    result = doca_flow_entries_process(port, 0, DEFAULT_TIMEOUT_US, 0);
    if (result != DOCA_SUCCESS)
        DOCA_LOG_ERR("Failed to process CT miss entry: %s", doca_error_get_descr(result));
 
    return result;
 
destroy_pipe_cfg:
    doca_flow_pipe_cfg_destroy(cfg);
    return result;
}
 
/*
 * Create DOCA Flow TCP state pipe to filter state on known TCP session
 *
 * @port [in]: Pipe port
 * @status [in]: User context for adding entry
 * @fwd_pipe [in]: Forward pipe
 * @fwd_miss_pipe [in]: Forward miss pipe
 * @pipe [out]: Created pipe pointer
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise.
 */
static doca_error_t create_tcp_flags_filter_pipe(struct doca_flow_port *port,
                         struct entries_status *status,
                         struct doca_flow_pipe *fwd_pipe,
                         struct doca_flow_pipe *fwd_miss_pipe,
                         struct doca_flow_pipe **pipe)
{
    struct doca_flow_match match;
    struct doca_flow_match mask;
    struct doca_flow_fwd fwd;
    struct doca_flow_fwd fwd_miss;
    struct doca_flow_pipe_cfg *cfg;
    doca_error_t result;
 
    memset(&match, 0, sizeof(match));
    memset(&mask, 0, sizeof(mask));
    memset(&fwd, 0, sizeof(fwd));
    memset(&fwd_miss, 0, sizeof(fwd_miss));
 
    /* Match on non SYN, FIN and RST packets */
    match.outer.tcp.flags = 0xff;
    match.outer.l4_type_ext = DOCA_FLOW_L4_TYPE_EXT_TCP;
 
    mask.outer.l4_type_ext = DOCA_FLOW_L4_TYPE_EXT_TCP;
    mask.outer.tcp.flags = DOCA_FLOW_MATCH_TCP_FLAG_SYN | DOCA_FLOW_MATCH_TCP_FLAG_FIN |
                   DOCA_FLOW_MATCH_TCP_FLAG_RST;
 
    result = doca_flow_pipe_cfg_create(&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(cfg, "TCP_FLAGS_FILTER_PIPE", 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(cfg, &match, &mask);
    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 = fwd_pipe;
 
    fwd_miss.type = DOCA_FLOW_FWD_PIPE;
    fwd_miss.next_pipe = fwd_miss_pipe;
 
    result = doca_flow_pipe_create(cfg, &fwd, &fwd_miss, pipe);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create TCP_FLAGS_FILTER pipe: %s", doca_error_get_descr(result));
        goto destroy_pipe_cfg;
    }
    doca_flow_pipe_cfg_destroy(cfg);
 
    match.outer.tcp.flags = 0;
    result = doca_flow_pipe_add_entry(0, *pipe, &match, NULL, NULL, NULL, 0, status, NULL);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to create TCP flags filter pipe entry: %s", doca_error_get_descr(result));
        return result;
    }
 
    result = doca_flow_entries_process(port, 0, DEFAULT_TIMEOUT_US, 0);
    if (result != DOCA_SUCCESS)
        DOCA_LOG_ERR("Failed to process TCP flags filter entry: %s", doca_error_get_descr(result));
 
    return result;
 
destroy_pipe_cfg:
    doca_flow_pipe_cfg_destroy(cfg);
    return result;
}
 
/*
 * Create CT pipe
 *
 * @port [in]: Pipe port
 * @fwd_pipe [in]: Forward pipe pointer
 * @fwd_miss_pipe [in]: Forward miss pipe pointer
 * @pipe [out]: Created pipe pointer
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise.
 */
static doca_error_t create_ct_pipe(struct doca_flow_port *port,
                   struct doca_flow_pipe *fwd_pipe,
                   struct doca_flow_pipe *fwd_miss_pipe,
                   struct doca_flow_pipe **pipe)
{
    struct doca_flow_match match;
    struct doca_flow_pipe_cfg *cfg;
    struct doca_flow_fwd fwd;
    struct doca_flow_fwd fwd_miss;
    doca_error_t result;
 
    memset(&match, 0, sizeof(match));
    memset(&fwd, 0, sizeof(fwd));
    memset(&fwd_miss, 0, sizeof(fwd));
 
    result = doca_flow_pipe_cfg_create(&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(cfg, "CT_PIPE", DOCA_FLOW_PIPE_CT, 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(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 = fwd_pipe;
 
    fwd_miss.type = DOCA_FLOW_FWD_PIPE;
    fwd_miss.next_pipe = fwd_miss_pipe;
 
    result = doca_flow_pipe_create(cfg, &fwd, &fwd_miss, pipe);
    if (result != DOCA_SUCCESS)
        DOCA_LOG_ERR("Failed to create CT pipe: %s", doca_error_get_descr(result));
destroy_pipe_cfg:
    doca_flow_pipe_cfg_destroy(cfg);
    return result;
}
 
/*
 * Parse TCP packet to update CT tables
 *
 * @packet [in]: Packet to parse
 * @match_o [out]: Origin match struct to fill
 * @match_r [out]: Reply match struct to fill
 * @tcp_state [out]: Packet TCP state
 */
static void parse_packet(struct rte_mbuf *packet,
             struct doca_flow_ct_match *match_o,
             struct doca_flow_ct_match *match_r,
             uint8_t *tcp_state)
{
    uint8_t *l4_hdr;
    struct rte_ipv4_hdr *ipv4_hdr;
    const struct rte_tcp_hdr *tcp_hdr;
 
    ipv4_hdr = rte_pktmbuf_mtod_offset(packet, struct rte_ipv4_hdr *, sizeof(struct rte_ether_hdr));
 
    match_o->ipv4.src_ip = ipv4_hdr->src_addr;
    match_o->ipv4.dst_ip = ipv4_hdr->dst_addr;
    match_r->ipv4.src_ip = match_o->ipv4.dst_ip;
    match_r->ipv4.dst_ip = match_o->ipv4.src_ip;
 
    l4_hdr = (typeof(l4_hdr))ipv4_hdr + rte_ipv4_hdr_len(ipv4_hdr);
    tcp_hdr = (typeof(tcp_hdr))l4_hdr;
 
    match_o->ipv4.l4_port.src_port = tcp_hdr->src_port;
    match_o->ipv4.l4_port.dst_port = tcp_hdr->dst_port;
    match_r->ipv4.l4_port.src_port = match_o->ipv4.l4_port.dst_port;
    match_r->ipv4.l4_port.dst_port = match_o->ipv4.l4_port.src_port;
 
    match_o->ipv4.next_proto = DOCA_FLOW_PROTO_TCP;
    match_r->ipv4.next_proto = DOCA_FLOW_PROTO_TCP;
 
    *tcp_state = tcp_hdr->tcp_flags;
}
 
/*
 * Dequeue 'SYN' packets from DPDK queues, parse and update CT tables with new connection 5 tuple
 *
 * @port [in]: Port id to which an entry should be inserted
 * @ct_queue [in]: DOCA Flow CT queue number
 * @ct_status [in]: User context for adding CT entry
 * @entry [in/out]: CT entry
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise.
 */
static doca_error_t process_syn_packets(struct doca_flow_port *port,
                    uint16_t ct_queue,
                    struct entries_status *ct_status,
                    struct doca_flow_pipe_entry **entry)
{
    struct rte_mbuf *packets[PACKET_BURST];
    struct doca_flow_ct_match match_o;
    struct doca_flow_ct_match match_r;
    uint32_t flags = DOCA_FLOW_CT_ENTRY_FLAGS_NO_WAIT | DOCA_FLOW_CT_ENTRY_FLAGS_DIR_ORIGIN |
             DOCA_FLOW_CT_ENTRY_FLAGS_ENTRY_FINALIZE | DOCA_FLOW_CT_ENTRY_FLAGS_COUNTER_REPLY |
             DOCA_FLOW_CT_ENTRY_FLAGS_COUNTER_ORIGIN;
    uint8_t tcp_state;
    doca_error_t result;
    int rc, i, nb_packets, nb_process = 0;
 
    memset(&match_o, 0, sizeof(match_o));
    memset(&match_r, 0, sizeof(match_r));
 
    rc = rte_flow_dynf_metadata_register();
    if (unlikely(rc)) {
        DOCA_LOG_ERR("Enable metadata failed");
        return DOCA_ERROR_BAD_STATE;
    }
 
    nb_packets = rte_eth_rx_burst(0, 0, packets, PACKET_BURST);
    if (nb_packets == 0) {
        DOCA_LOG_INFO("Sample didn't receive packets to process");
        return DOCA_ERROR_BAD_STATE;
    }
 
    DOCA_LOG_INFO("%d packets received on rx_burst()", nb_packets);
    for (i = 0; i < PACKET_BURST && i < nb_packets; i++) {
        parse_packet(packets[i], &match_o, &match_r, &tcp_state);
        if (tcp_state & DOCA_FLOW_MATCH_TCP_FLAG_SYN) {
            if (nb_entries > 0) {
                DOCA_LOG_INFO("Already have one entry, skip");
                continue;
            }
            /* Allocate CT entry */
            result = doca_flow_ct_entry_prepare(ct_queue,
                                NULL,
                                DOCA_FLOW_CT_ENTRY_FLAGS_ALLOC_ON_MISS,
                                &match_o,
                                0,
                                &match_r,
                                0,
                                entry,
                                NULL);
            if (result != DOCA_SUCCESS) {
                DOCA_LOG_ERR("Failed to prepare CT entry\n");
                return result;
            }
            result = doca_flow_ct_add_entry(ct_queue,
                            NULL,
                            flags,
                            &match_o,
                            &match_r,
                            0,
                            0,
                            0,
                            0,
                            0,
                            ct_status,
                            *entry);
            if (result != DOCA_SUCCESS) {
                DOCA_LOG_ERR("Failed to add CT pipe an entry: %s", doca_error_get_descr(result));
                return result;
            }
            nb_entries++;
            nb_process++;
            while (ct_status->nb_processed != nb_process) {
                result = doca_flow_ct_entries_process(port, ct_queue, 0, 0, NULL);
                if (result != DOCA_SUCCESS) {
                    DOCA_LOG_ERR("Failed to process Flow CT entries: %s",
                             doca_error_get_descr(result));
                    return result;
                }
 
                if (ct_status->failure) {
                    DOCA_LOG_ERR("Flow CT entries process returned with a failure");
                    return DOCA_ERROR_BAD_STATE;
                }
            }
            rte_flow_dynf_metadata_set(packets[i], 1);
            packets[i]->ol_flags |= RTE_MBUF_DYNFLAG_TX_METADATA;
            rte_eth_tx_burst(0, 0, &packets[i], 1);
        } else {
            DOCA_LOG_WARN("Sample is only able to process 'SYN' packets at first phase");
            continue;
        }
    }
    ct_status->nb_processed = 0;
 
    return DOCA_SUCCESS;
}
 
/*
 * Dequeue 'FIN' and 'RST' packets from DPDK queues to remove entries
 *
 * @port [in]: Port id to which an entry should be inserted
 * @ct_queue [in]: DOCA Flow CT queue number
 * @entry [in/out]: CT entry
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise.
 */
static doca_error_t process_fin_packets(struct doca_flow_port *port,
                    uint16_t ct_queue,
                    struct doca_flow_pipe_entry **entry)
{
    struct rte_mbuf *packets[PACKET_BURST];
    struct doca_flow_ct_match match_o;
    struct doca_flow_ct_match match_r;
    uint32_t flags = DOCA_FLOW_CT_ENTRY_FLAGS_NO_WAIT;
    uint8_t tcp_state;
    doca_error_t result;
    int rc, i, nb_packets, nb_process = 0;
 
    memset(&match_o, 0, sizeof(match_o));
    memset(&match_r, 0, sizeof(match_r));
 
    rc = rte_flow_dynf_metadata_register();
    if (unlikely(rc)) {
        DOCA_LOG_ERR("Enable metadata failed");
        return DOCA_ERROR_BAD_STATE;
    }
 
    nb_packets = rte_eth_rx_burst(0, 0, packets, PACKET_BURST);
    if (nb_packets == 0) {
        DOCA_LOG_INFO("Sample didn't receive packets to process");
        return DOCA_ERROR_BAD_STATE;
    }
 
    DOCA_LOG_INFO("%d packets received on rx_burst()", nb_packets);
    for (i = 0; i < PACKET_BURST && i < nb_packets; i++) {
        parse_packet(packets[i], &match_o, &match_r, &tcp_state);
        if (tcp_state & DOCA_FLOW_MATCH_TCP_FLAG_FIN || tcp_state & DOCA_FLOW_MATCH_TCP_FLAG_RST) {
            if (nb_entries == 0) {
                DOCA_LOG_INFO("No entry to remove, skip");
                continue;
            }
            result = doca_flow_ct_rm_entry(ct_queue, NULL, flags, *entry);
            if (result != DOCA_SUCCESS) {
                DOCA_LOG_ERR("Failed to remove CT pipe entry: %s", doca_error_get_descr(result));
                return result;
            }
            nb_process++;
            while (nb_entry_finalize_triggers != nb_process) {
                result = doca_flow_ct_entries_process(port, ct_queue, 0, 0, NULL);
                if (result != DOCA_SUCCESS) {
                    DOCA_LOG_ERR("Failed to process Flow CT entries: %s",
                             doca_error_get_descr(result));
                    return result;
                }
                (void)doca_flow_aging_handle(port, ct_queue, 0, 0);
            }
            nb_entries--;
            DOCA_LOG_INFO("TCP session was ended");
            rte_flow_dynf_metadata_set(packets[i], 1);
            packets[i]->ol_flags |= RTE_MBUF_DYNFLAG_TX_METADATA;
            rte_eth_tx_burst(0, 0, &packets[i], 1);
        } else {
            DOCA_LOG_WARN("Sample is only able to process 'FIN' and 'RST' packets at second phase");
            continue;
        }
    }
 
    return DOCA_SUCCESS;
}
 
/*
 * CT entry_finalize callback
 *
 * @pipe [in]: Not being used
 * @entry [in]: DOCA Flow CT entry
 * @ct_queue [in]: DOCA Flow CT queue number
 * @usr_ctx [in]: Usr context
 */
static void entry_finalize_cb(struct doca_flow_pipe *pipe, void *entry, uint16_t ct_queue, void *usr_ctx)
{
    (void)usr_ctx;
    uint64_t entry_flags, last_hit_s;
    struct doca_flow_ct_match match_o, match_r;
    struct doca_flow_resource_query query_o, query_r;
    doca_error_t result;
 
    result = doca_flow_ct_get_entry(ct_queue, pipe, 0, entry, &match_o, &match_r, &entry_flags);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to get CT entry information: %s", doca_error_get_descr(result));
        return;
    }
 
    nb_entry_finalize_triggers++;
 
    DOCA_LOG_INFO("Entry finalize callback triggered on entry %d, origin: 0x%08x:0x%x -> 0x%08x:0x%x",
              nb_entry_finalize_triggers,
              be32toh(match_o.ipv4.src_ip),
              match_o.ipv4.l4_port.src_port,
              be32toh(match_o.ipv4.dst_ip),
              match_o.ipv4.l4_port.dst_port);
 
    result = doca_flow_ct_query_entry(ct_queue, pipe, 0, entry, &query_o, &query_r, &last_hit_s);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to query CT entry: %s", doca_error_get_descr(result));
        return;
    }
 
    DOCA_LOG_INFO("Entry %d, origin total bytes: %ld", nb_entry_finalize_triggers, query_o.counter.total_bytes);
    DOCA_LOG_INFO("Entry %d, origin total packets: %ld", nb_entry_finalize_triggers, query_o.counter.total_pkts);
    DOCA_LOG_INFO("Entry %d, last hit since Epoch (sec) : %ld", nb_entry_finalize_triggers, last_hit_s);
}
 
/*
 * Run flow_ct_tcp_entry_finalize sample
 *
 * @nb_queues [in]: number of queues the sample will use
 * @ct_dev [in]: Flow CT device
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise.
 */
doca_error_t flow_ct_tcp_entry_finalize(uint16_t nb_queues, struct doca_dev *ct_dev)
{
    const int nb_ports = 2, nb_entries = 7;
    struct flow_resources resource;
    uint32_t nr_shared_resources[SHARED_RESOURCE_NUM_VALUES] = {0};
    struct doca_flow_pipe_entry *tcp_entry;
    struct doca_flow_pipe *egress_pipe, *ct_miss_pipe, *tcp_flags_filter_pipe, *rss_pipe, *tcp_pipe;
    struct doca_flow_pipe *ct_pipe = NULL;
    struct doca_flow_port *ports[nb_ports];
    struct doca_flow_meta o_zone_mask, o_modify_mask, r_zone_mask, r_modify_mask;
    struct doca_dev *dev_arr[nb_ports];
    uint32_t actions_mem_size[nb_ports];
    struct entries_status ctrl_status, ct_status;
    uint32_t ct_flags = 0, nb_arm_queues = 1, nb_ctrl_queues = 1, nb_user_actions = 0, nb_ipv4_sessions = 1024,
         nb_ipv6_sessions = 0; /* On BF2 should always be 0 */
    uint16_t ct_queue = nb_queues;
    doca_error_t result;
 
    memset(&ctrl_status, 0, sizeof(ctrl_status));
    memset(&ct_status, 0, sizeof(ct_status));
    memset(&resource, 0, sizeof(resource));
 
    resource.nr_counters = 1;
 
    result = init_doca_flow(nb_queues, "switch,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;
    }
 
    /* Dont use zone masking */
    memset(&o_zone_mask, 0, sizeof(o_zone_mask));
    memset(&o_modify_mask, 0, sizeof(o_modify_mask));
    memset(&r_zone_mask, 0, sizeof(r_zone_mask));
    memset(&r_modify_mask, 0, sizeof(r_modify_mask));
 
    result = init_doca_flow_ct(ct_flags,
                   nb_arm_queues,
                   nb_ctrl_queues,
                   nb_user_actions,
                   entry_finalize_cb,
                   nb_ipv4_sessions,
                   nb_ipv6_sessions,
                   0,
                   false,
                   &o_zone_mask,
                   &o_modify_mask,
                   false,
                   &r_zone_mask,
                   &r_modify_mask);
    if (result != DOCA_SUCCESS) {
        doca_flow_destroy();
        return result;
    }
 
    memset(dev_arr, 0, sizeof(struct doca_dev *) * nb_ports);
    dev_arr[0] = ct_dev;
    ARRAY_INIT(actions_mem_size, ACTIONS_MEM_SIZE(nb_queues, nb_entries));
    result = init_doca_flow_ports(nb_ports, ports, false, 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_ct_destroy();
        doca_flow_destroy();
        return result;
    }
 
    result = create_rss_pipe(ports[0], &ctrl_status, &rss_pipe);
    if (result != DOCA_SUCCESS)
        goto cleanup;
 
    result = create_egress_pipe(ports[0], 1, &ctrl_status, &egress_pipe);
    if (result != DOCA_SUCCESS)
        goto cleanup;
 
    result = create_tcp_flags_filter_pipe(ports[0], &ctrl_status, egress_pipe, rss_pipe, &tcp_flags_filter_pipe);
    if (result != DOCA_SUCCESS)
        goto cleanup;
 
    result = create_ct_miss_pipe(ports[0], rss_pipe, &ctrl_status, &ct_miss_pipe);
    if (result != DOCA_SUCCESS)
        goto cleanup;
 
    result = create_ct_pipe(ports[0], tcp_flags_filter_pipe, ct_miss_pipe, &ct_pipe);
    if (result != DOCA_SUCCESS)
        goto cleanup;
 
    result = create_ct_root_pipe(ports[0], true, false, DOCA_FLOW_L4_META_TCP, ct_pipe, &ctrl_status, &tcp_pipe);
    if (result != DOCA_SUCCESS)
        goto cleanup;
 
    result = doca_flow_entries_process(ports[0], 0, DEFAULT_TIMEOUT_US, nb_entries);
    if (result != DOCA_SUCCESS) {
        DOCA_LOG_ERR("Failed to process Flow CT entries: %s", doca_error_get_descr(result));
        goto cleanup;
    }
 
    if (ctrl_status.nb_processed != nb_entries || ctrl_status.failure) {
        DOCA_LOG_ERR("Failed to process entries");
        result = DOCA_ERROR_BAD_STATE;
        goto cleanup;
    }
 
    DOCA_LOG_INFO("Wait few seconds for 'SYN' packet to arrive");
 
    sleep(5);
    result = process_syn_packets(ports[0], ct_queue, &ct_status, &tcp_entry);
    if (result != DOCA_SUCCESS)
        goto cleanup;
 
    sleep(DEFAULT_CNT_DELAY_S + DEFAULT_CNT_QUERY_INTERVAL);
    DOCA_LOG_INFO("TCP session was created, waiting for 'FIN'/'RST' packet before ending the session");
 
    sleep(7);
    result = process_fin_packets(ports[0], ct_queue, &tcp_entry);
    if (result != DOCA_SUCCESS)
        goto cleanup;
 
cleanup:
    cleanup_procedure(ct_pipe, nb_ports, ports);
    return result;
}