rte_table_action.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2018 Intel Corporation
 */

#ifndef __INCLUDE_RTE_TABLE_ACTION_H__
#define __INCLUDE_RTE_TABLE_ACTION_H__

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

#include <rte_compat.h>
#include <rte_ether.h>
#include <rte_meter.h>
#include <rte_table_hash.h>

#include "rte_pipeline.h"

enum rte_table_action_type {
    RTE_TABLE_ACTION_FWD = 0,

    RTE_TABLE_ACTION_LB,

    RTE_TABLE_ACTION_MTR,

    RTE_TABLE_ACTION_TM,

    RTE_TABLE_ACTION_ENCAP,

    RTE_TABLE_ACTION_NAT,

    RTE_TABLE_ACTION_TTL,

    RTE_TABLE_ACTION_STATS,

    RTE_TABLE_ACTION_TIME,

    RTE_TABLE_ACTION_SYM_CRYPTO,

    RTE_TABLE_ACTION_TAG,

    RTE_TABLE_ACTION_DECAP,
};

struct rte_table_action_common_config {
    int ip_version;

    uint32_t ip_offset;
};

struct rte_table_action_fwd_params {
    enum rte_pipeline_action action;

    uint32_t id;
};

#define RTE_TABLE_ACTION_LB_KEY_SIZE_MIN                    8

#define RTE_TABLE_ACTION_LB_KEY_SIZE_MAX                    64

#define RTE_TABLE_ACTION_LB_TABLE_SIZE                      8

struct rte_table_action_lb_config {
    uint32_t key_size;

    uint32_t key_offset;

    uint8_t key_mask[RTE_TABLE_ACTION_LB_KEY_SIZE_MAX];

    rte_table_hash_op_hash f_hash;

    uint64_t seed;

    uint32_t out_offset;
};

struct rte_table_action_lb_params {
    uint32_t out[RTE_TABLE_ACTION_LB_TABLE_SIZE];
};

#define RTE_TABLE_ACTION_TC_MAX                                  4

#define RTE_TABLE_ACTION_TC_QUEUE_MAX                            4

struct rte_table_action_dscp_table_entry {
    uint32_t tc_id;

    uint32_t tc_queue_id;

    enum rte_meter_color color;
};

struct rte_table_action_dscp_table {
    struct rte_table_action_dscp_table_entry entry[64];
};

enum rte_table_action_meter_algorithm {
    RTE_TABLE_ACTION_METER_SRTCM,

    RTE_TABLE_ACTION_METER_TRTCM,
};

struct rte_table_action_meter_profile {
    enum rte_table_action_meter_algorithm alg;

    RTE_STD_C11
    union {
        struct rte_meter_srtcm_params srtcm;

        struct rte_meter_trtcm_params trtcm;
    };
};

enum rte_table_action_policer {
    RTE_TABLE_ACTION_POLICER_COLOR_GREEN = 0,

    RTE_TABLE_ACTION_POLICER_COLOR_YELLOW,

    RTE_TABLE_ACTION_POLICER_COLOR_RED,

    RTE_TABLE_ACTION_POLICER_DROP,

    RTE_TABLE_ACTION_POLICER_MAX
};

struct rte_table_action_mtr_tc_params {
    uint32_t meter_profile_id;

    enum rte_table_action_policer policer[e_RTE_METER_COLORS];
};

struct rte_table_action_mtr_counters_tc {
    uint64_t n_packets[e_RTE_METER_COLORS];

    uint64_t n_bytes[e_RTE_METER_COLORS];

    int n_packets_valid;

    int n_bytes_valid;
};

struct rte_table_action_mtr_config {
    enum rte_table_action_meter_algorithm alg;

    uint32_t n_tc;

    int n_packets_enabled;

    int n_bytes_enabled;
};

struct rte_table_action_mtr_params {
    struct rte_table_action_mtr_tc_params mtr[RTE_TABLE_ACTION_TC_MAX];

    uint32_t tc_mask;
};

struct rte_table_action_mtr_counters {
    struct rte_table_action_mtr_counters_tc stats[RTE_TABLE_ACTION_TC_MAX];

    uint32_t tc_mask;
};

struct rte_table_action_tm_config {
    uint32_t n_subports_per_port;

    uint32_t n_pipes_per_subport;
};

struct rte_table_action_tm_params {
    uint32_t subport_id;

    uint32_t pipe_id;
};

enum rte_table_action_encap_type {
    RTE_TABLE_ACTION_ENCAP_ETHER = 0,

    RTE_TABLE_ACTION_ENCAP_VLAN,

    RTE_TABLE_ACTION_ENCAP_QINQ,

    RTE_TABLE_ACTION_ENCAP_MPLS,

    RTE_TABLE_ACTION_ENCAP_PPPOE,

    RTE_TABLE_ACTION_ENCAP_VXLAN,
};

struct rte_table_action_ether_hdr {
    struct ether_addr da; 
    struct ether_addr sa; 
};

struct rte_table_action_vlan_hdr {
    uint8_t pcp; 
    uint8_t dei; 
    uint16_t vid; 
};

struct rte_table_action_mpls_hdr {
    uint32_t label; 
    uint8_t tc; 
    uint8_t ttl; 
};

struct rte_table_action_pppoe_hdr {
    uint16_t session_id; 
};

struct rte_table_action_ipv4_header {
    uint32_t sa; 
    uint32_t da; 
    uint8_t dscp; 
    uint8_t ttl; 
};

struct rte_table_action_ipv6_header {
    uint8_t sa[16]; 
    uint8_t da[16]; 
    uint32_t flow_label; 
    uint8_t dscp; 
    uint8_t hop_limit; 
};

struct rte_table_action_udp_header {
    uint16_t sp; 
    uint16_t dp; 
};

struct rte_table_action_vxlan_hdr {
    uint32_t vni; 
};

struct rte_table_action_encap_ether_params {
    struct rte_table_action_ether_hdr ether; 
};

struct rte_table_action_encap_vlan_params {
    struct rte_table_action_ether_hdr ether; 
    struct rte_table_action_vlan_hdr vlan; 
};

struct rte_table_action_encap_qinq_params {
    struct rte_table_action_ether_hdr ether; 
    struct rte_table_action_vlan_hdr svlan; 
    struct rte_table_action_vlan_hdr cvlan; 
};

#ifndef RTE_TABLE_ACTION_MPLS_LABELS_MAX
#define RTE_TABLE_ACTION_MPLS_LABELS_MAX                   4
#endif

struct rte_table_action_encap_mpls_params {
    struct rte_table_action_ether_hdr ether;

    struct rte_table_action_mpls_hdr mpls[RTE_TABLE_ACTION_MPLS_LABELS_MAX];

    uint32_t mpls_count;

    int unicast;
};

struct rte_table_action_encap_pppoe_params {
    struct rte_table_action_ether_hdr ether; 
    struct rte_table_action_pppoe_hdr pppoe; 
};

struct rte_table_action_encap_vxlan_params {
    struct rte_table_action_ether_hdr ether; 
    struct rte_table_action_vlan_hdr vlan; 
    RTE_STD_C11
    union {
        struct rte_table_action_ipv4_header ipv4; 
        struct rte_table_action_ipv6_header ipv6; 
    };

    struct rte_table_action_udp_header udp; 
    struct rte_table_action_vxlan_hdr vxlan; 
};

struct rte_table_action_encap_config {
    uint64_t encap_mask;

    RTE_STD_C11
    union {
        struct {
            uint32_t data_offset;

            int vlan;

            int ip_version;
        } vxlan; 
    };
};

struct rte_table_action_encap_params {
    enum rte_table_action_encap_type type;

    RTE_STD_C11
    union {
        struct rte_table_action_encap_ether_params ether;

        struct rte_table_action_encap_vlan_params vlan;

        struct rte_table_action_encap_qinq_params qinq;

        struct rte_table_action_encap_mpls_params mpls;

        struct rte_table_action_encap_pppoe_params pppoe;

        struct rte_table_action_encap_vxlan_params vxlan;
    };
};

struct rte_table_action_nat_config {
    int source_nat;

    uint8_t proto;
};

struct rte_table_action_nat_params {
    int ip_version;

    union {
        uint32_t ipv4;

        uint8_t ipv6[16];
    } addr;

    uint16_t port;
};

struct rte_table_action_ttl_config {
    int drop;

    int n_packets_enabled;
};

struct rte_table_action_ttl_params {
    int decrement;
};

struct rte_table_action_ttl_counters {
    uint64_t n_packets;
};

struct rte_table_action_stats_config {
    int n_packets_enabled;

    int n_bytes_enabled;
};

struct rte_table_action_stats_params {
    uint64_t n_packets;

    uint64_t n_bytes;
};

struct rte_table_action_stats_counters {
    uint64_t n_packets;

    uint64_t n_bytes;

    int n_packets_valid;

    int n_bytes_valid;
};

struct rte_table_action_time_params {
    uint64_t time;
};

#ifndef RTE_TABLE_ACTION_SYM_CRYPTO_IV_SIZE_MAX
#define RTE_TABLE_ACTION_SYM_CRYPTO_IV_SIZE_MAX     (16)
#endif

#ifndef RTE_TABLE_ACTION_SYM_CRYPTO_AAD_SIZE_MAX
#define RTE_TABLE_ACTION_SYM_CRYPTO_AAD_SIZE_MAX    (16)
#endif

#ifndef RTE_TABLE_ACTION_SYM_CRYPTO_IV_OFFSET
#define RTE_TABLE_ACTION_SYM_CRYPTO_IV_OFFSET               \
    (sizeof(struct rte_crypto_op) + sizeof(struct rte_crypto_sym_op))
#endif

struct rte_table_action_vlo {
    uint8_t *val;
    uint32_t length;
    uint32_t offset;
};

struct rte_table_action_sym_crypto_config {
    uint8_t cryptodev_id;

    uint32_t op_offset;

    struct rte_mempool *mp_create;

    struct rte_mempool *mp_init;
};

struct rte_table_action_sym_crypto_params {

    struct rte_crypto_sym_xform *xform;

    uint32_t data_offset;

    union {
        struct {
            struct rte_table_action_vlo cipher_iv;

            struct rte_table_action_vlo cipher_iv_update;

            struct rte_table_action_vlo auth_iv;

            struct rte_table_action_vlo auth_iv_update;

        } cipher_auth;

        struct {
            struct rte_table_action_vlo aad;

            struct rte_table_action_vlo iv;

            struct rte_table_action_vlo aad_update;

            struct rte_table_action_vlo iv_update;

        } aead;
    };
};

struct rte_table_action_tag_params {
    uint32_t tag;
};

struct rte_table_action_decap_params {
    uint16_t n;
};

struct rte_table_action_profile;

struct rte_table_action_profile * __rte_experimental
rte_table_action_profile_create(struct rte_table_action_common_config *common);

int __rte_experimental
rte_table_action_profile_free(struct rte_table_action_profile *profile);

int __rte_experimental
rte_table_action_profile_action_register(struct rte_table_action_profile *profile,
    enum rte_table_action_type type,
    void *action_config);

int __rte_experimental
rte_table_action_profile_freeze(struct rte_table_action_profile *profile);

struct rte_table_action;

struct rte_table_action * __rte_experimental
rte_table_action_create(struct rte_table_action_profile *profile,
    uint32_t socket_id);

int __rte_experimental
rte_table_action_free(struct rte_table_action *action);

int __rte_experimental
rte_table_action_table_params_get(struct rte_table_action *action,
    struct rte_pipeline_table_params *params);

int __rte_experimental
rte_table_action_apply(struct rte_table_action *action,
    void *data,
    enum rte_table_action_type type,
    void *action_params);

int __rte_experimental
rte_table_action_dscp_table_update(struct rte_table_action *action,
    uint64_t dscp_mask,
    struct rte_table_action_dscp_table *table);

int __rte_experimental
rte_table_action_meter_profile_add(struct rte_table_action *action,
    uint32_t meter_profile_id,
    struct rte_table_action_meter_profile *profile);

int __rte_experimental
rte_table_action_meter_profile_delete(struct rte_table_action *action,
    uint32_t meter_profile_id);

int __rte_experimental
rte_table_action_meter_read(struct rte_table_action *action,
    void *data,
    uint32_t tc_mask,
    struct rte_table_action_mtr_counters *stats,
    int clear);

int __rte_experimental
rte_table_action_ttl_read(struct rte_table_action *action,
    void *data,
    struct rte_table_action_ttl_counters *stats,
    int clear);

int __rte_experimental
rte_table_action_stats_read(struct rte_table_action *action,
    void *data,
    struct rte_table_action_stats_counters *stats,
    int clear);

int __rte_experimental
rte_table_action_time_read(struct rte_table_action *action,
    void *data,
    uint64_t *timestamp);

struct rte_cryptodev_sym_session *__rte_experimental
rte_table_action_crypto_sym_session_get(struct rte_table_action *action,
    void *data);

#ifdef __cplusplus
}
#endif

#endif /* __INCLUDE_RTE_TABLE_ACTION_H__ */