DPDK 22.11.5
|
#include <stdint.h>
#include <rte_compat.h>
#include <rte_ether.h>
#include <rte_meter.h>
#include <rte_table_hash.h>
#include "rte_pipeline.h"
Go to the source code of this file.
Macros | |
#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 |
#define | RTE_TABLE_ACTION_TC_MAX 16 |
#define | RTE_TABLE_ACTION_TC_QUEUE_MAX 16 |
#define | RTE_TABLE_ACTION_MPLS_LABELS_MAX 4 |
#define | RTE_TABLE_ACTION_SYM_CRYPTO_IV_SIZE_MAX (16) |
Functions | |
__rte_experimental struct rte_table_action_profile * | rte_table_action_profile_create (struct rte_table_action_common_config *common) |
__rte_experimental int | rte_table_action_profile_free (struct rte_table_action_profile *profile) |
__rte_experimental int | rte_table_action_profile_action_register (struct rte_table_action_profile *profile, enum rte_table_action_type type, void *action_config) |
__rte_experimental int | rte_table_action_profile_freeze (struct rte_table_action_profile *profile) |
__rte_experimental struct rte_table_action * | rte_table_action_create (struct rte_table_action_profile *profile, uint32_t socket_id) |
__rte_experimental int | rte_table_action_free (struct rte_table_action *action) |
__rte_experimental int | rte_table_action_table_params_get (struct rte_table_action *action, struct rte_pipeline_table_params *params) |
__rte_experimental int | rte_table_action_apply (struct rte_table_action *action, void *data, enum rte_table_action_type type, void *action_params) |
__rte_experimental int | rte_table_action_dscp_table_update (struct rte_table_action *action, uint64_t dscp_mask, struct rte_table_action_dscp_table *table) |
__rte_experimental int | rte_table_action_meter_profile_add (struct rte_table_action *action, uint32_t meter_profile_id, struct rte_table_action_meter_profile *profile) |
__rte_experimental int | rte_table_action_meter_profile_delete (struct rte_table_action *action, uint32_t meter_profile_id) |
__rte_experimental int | 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) |
__rte_experimental int | rte_table_action_ttl_read (struct rte_table_action *action, void *data, struct rte_table_action_ttl_counters *stats, int clear) |
__rte_experimental int | rte_table_action_stats_read (struct rte_table_action *action, void *data, struct rte_table_action_stats_counters *stats, int clear) |
__rte_experimental int | rte_table_action_time_read (struct rte_table_action *action, void *data, uint64_t *timestamp) |
__rte_experimental struct rte_cryptodev_sym_session * | rte_table_action_crypto_sym_session_get (struct rte_table_action *action, void *data) |
RTE Pipeline Table Actions
This API provides a common set of actions for pipeline tables to speed up application development.
Each match-action rule added to a pipeline table has associated data that stores the action context. This data is input to the table action handler called for every input packet that hits the rule as part of the table lookup during the pipeline execution. The pipeline library allows the user to define his own table actions by providing customized table action handlers (table lookup) and complete freedom of setting the rules and their data (table rule add/delete). While the user can still follow this process, this API is intended to provide a quicker development alternative for a set of predefined actions.
The typical steps to use this API are:
Definition in file rte_table_action.h.
#define RTE_TABLE_ACTION_LB_KEY_SIZE_MIN 8 |
RTE_TABLE_ACTION_LB Load balance key size min (number of bytes).
Definition at line 136 of file rte_table_action.h.
#define RTE_TABLE_ACTION_LB_KEY_SIZE_MAX 64 |
Load balance key size max (number of bytes).
Definition at line 139 of file rte_table_action.h.
#define RTE_TABLE_ACTION_LB_TABLE_SIZE 8 |
Load balance table size.
Definition at line 142 of file rte_table_action.h.
#define RTE_TABLE_ACTION_TC_MAX 16 |
RTE_TABLE_ACTION_MTR Max number of traffic classes (TCs).
Definition at line 184 of file rte_table_action.h.
#define RTE_TABLE_ACTION_TC_QUEUE_MAX 16 |
Max number of queues per traffic class.
Definition at line 187 of file rte_table_action.h.
#define RTE_TABLE_ACTION_MPLS_LABELS_MAX 4 |
Max number of MPLS labels per output packet for MPLS encapsulation.
Definition at line 461 of file rte_table_action.h.
#define RTE_TABLE_ACTION_SYM_CRYPTO_IV_SIZE_MAX (16) |
RTE_TABLE_ACTION_CRYPTO
Definition at line 712 of file rte_table_action.h.
Table actions.
Definition at line 69 of file rte_table_action.h.
Supported traffic metering algorithms.
Enumerator | |
---|---|
RTE_TABLE_ACTION_METER_SRTCM | Single Rate Three Color Marker (srTCM) - IETF RFC 2697. |
RTE_TABLE_ACTION_METER_TRTCM | Two Rate Three Color Marker (trTCM) - IETF RFC 2698. |
Definition at line 215 of file rte_table_action.h.
Policer actions.
Definition at line 239 of file rte_table_action.h.
RTE_TABLE_ACTION_ENCAP Supported packet encapsulation types.
Definition at line 363 of file rte_table_action.h.
__rte_experimental struct rte_table_action_profile * rte_table_action_profile_create | ( | struct rte_table_action_common_config * | common | ) |
Table action profile create.
[in] | common | Common action configuration. |
__rte_experimental int rte_table_action_profile_free | ( | struct rte_table_action_profile * | profile | ) |
Table action profile free.
[in] | profile | Table profile action handle (needs to be valid). |
__rte_experimental int rte_table_action_profile_action_register | ( | struct rte_table_action_profile * | profile, |
enum rte_table_action_type | type, | ||
void * | action_config | ||
) |
Table action profile action register.
[in] | profile | Table profile action handle (needs to be valid and not in frozen state). |
[in] | type | Specific table action to be registered for profile. |
[in] | action_config | Configuration for the type action. If struct rte_table_action_*type*_config is defined by the Table Action API, it needs to point to a valid instance of this structure, otherwise it needs to be set to NULL. |
__rte_experimental int rte_table_action_profile_freeze | ( | struct rte_table_action_profile * | profile | ) |
Table action profile freeze.
Once this function is called successfully, the given profile enters the frozen state with the following immediate effects: no more actions can be registered for this profile, so the profile can be instantiated to create table action objects.
[in] | profile | Table profile action handle (needs to be valid and not in frozen state). |
__rte_experimental struct rte_table_action * rte_table_action_create | ( | struct rte_table_action_profile * | profile, |
uint32_t | socket_id | ||
) |
Table action create.
Instantiates the given table action profile to create a table action object.
[in] | profile | Table profile action handle (needs to be valid and in frozen state). |
[in] | socket_id | CPU socket ID where the internal data structures required by the new table action object should be allocated. |
__rte_experimental int rte_table_action_free | ( | struct rte_table_action * | action | ) |
Table action free.
[in] | action | Handle to table action object (needs to be valid). |
__rte_experimental int rte_table_action_table_params_get | ( | struct rte_table_action * | action, |
struct rte_pipeline_table_params * | params | ||
) |
Table action table params get.
[in] | action | Handle to table action object (needs to be valid). |
[in,out] | params | Pipeline table parameters (needs to be pre-allocated). |
__rte_experimental int rte_table_action_apply | ( | struct rte_table_action * | action, |
void * | data, | ||
enum rte_table_action_type | type, | ||
void * | action_params | ||
) |
Table action apply.
[in] | action | Handle to table action object (needs to be valid). |
[in] | data | Data byte array (typically table rule data) to apply action type on. |
[in] | type | Specific table action previously registered for the table action profile of the action object. |
[in] | action_params | Parameters for the type action. If struct rte_table_action_*type*_params is defined by the Table Action API, it needs to point to a valid instance of this structure, otherwise it needs to be set to NULL. |
__rte_experimental int rte_table_action_dscp_table_update | ( | struct rte_table_action * | action, |
uint64_t | dscp_mask, | ||
struct rte_table_action_dscp_table * | table | ||
) |
Table action DSCP table update.
[in] | action | Handle to table action object (needs to be valid). |
[in] | dscp_mask | 64-bit mask defining the DSCP table entries to be updated. If bit N is set in this bit mask, then DSCP table entry N is to be updated, otherwise not. |
[in] | table | DSCP table. |
__rte_experimental int rte_table_action_meter_profile_add | ( | struct rte_table_action * | action, |
uint32_t | meter_profile_id, | ||
struct rte_table_action_meter_profile * | profile | ||
) |
Table action meter profile add.
[in] | action | Handle to table action object (needs to be valid). |
[in] | meter_profile_id | Meter profile ID to be used for the profile once it is successfully added to the action object (needs to be unused by the set of meter profiles currently registered for the action object). |
[in] | profile | Meter profile to be added. |
__rte_experimental int rte_table_action_meter_profile_delete | ( | struct rte_table_action * | action, |
uint32_t | meter_profile_id | ||
) |
Table action meter profile delete.
[in] | action | Handle to table action object (needs to be valid). |
[in] | meter_profile_id | Meter profile ID of the meter profile to be deleted from the action object (needs to be valid for the action object). |
__rte_experimental int 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 | ||
) |
Table action meter read.
[in] | action | Handle to table action object (needs to be valid). |
[in] | data | Data byte array (typically table rule data) with meter action previously applied on it. |
[in] | tc_mask | Bit mask defining which traffic classes should have the meter stats counters read from data and stored into stats. If bit N is set in this bit mask, then traffic class N is part of this operation, otherwise it is not. If bit N is set in this bit mask, then traffic class N must be one of the traffic classes that are enabled for the meter action in the table action profile used by the action object. |
[in,out] | stats | When non-NULL, it points to the area where the meter stats counters read from data are saved. Only the meter stats counters for the tc_mask traffic classes are read and stored to stats. |
[in] | clear | When non-zero, the meter stats counters are cleared (i.e. set to zero), otherwise the counters are not modified. When the read operation is enabled (stats is non-NULL), the clear operation is performed after the read operation is completed. |
__rte_experimental int rte_table_action_ttl_read | ( | struct rte_table_action * | action, |
void * | data, | ||
struct rte_table_action_ttl_counters * | stats, | ||
int | clear | ||
) |
Table action TTL read.
[in] | action | Handle to table action object (needs to be valid). |
[in] | data | Data byte array (typically table rule data) with TTL action previously applied on it. |
[in,out] | stats | When non-NULL, it points to the area where the TTL stats counters read from data are saved. |
[in] | clear | When non-zero, the TTL stats counters are cleared (i.e. set to zero), otherwise the counters are not modified. When the read operation is enabled (stats is non-NULL), the clear operation is performed after the read operation is completed. |
__rte_experimental int rte_table_action_stats_read | ( | struct rte_table_action * | action, |
void * | data, | ||
struct rte_table_action_stats_counters * | stats, | ||
int | clear | ||
) |
Table action stats read.
[in] | action | Handle to table action object (needs to be valid). |
[in] | data | Data byte array (typically table rule data) with stats action previously applied on it. |
[in,out] | stats | When non-NULL, it points to the area where the stats counters read from data are saved. |
[in] | clear | When non-zero, the stats counters are cleared (i.e. set to zero), otherwise the counters are not modified. When the read operation is enabled (stats is non-NULL), the clear operation is performed after the read operation is completed. |
__rte_experimental int rte_table_action_time_read | ( | struct rte_table_action * | action, |
void * | data, | ||
uint64_t * | timestamp | ||
) |
Table action timestamp read.
[in] | action | Handle to table action object (needs to be valid). |
[in] | data | Data byte array (typically table rule data) with timestamp action previously applied on it. |
[in,out] | timestamp | Pre-allocated memory where the timestamp read from data is saved (has to be non-NULL). |
__rte_experimental struct rte_cryptodev_sym_session * rte_table_action_crypto_sym_session_get | ( | struct rte_table_action * | action, |
void * | data | ||
) |
Table action cryptodev symmetric session get.
[in] | action | Handle to table action object (needs to be valid). |
[in] | data | Data byte array (typically table rule data) with sym crypto action. |