d04fb3b55c
Currently, meter object supports only DSCP based on input color table, The patch enhance that to support VLAN based input color table, color table based on inner field for the tunnel use case, and support for fallback color per meter if packet based on a different field. All of the above features are exposed through capability and added additional capability to specify the implementation supports more than one input color table per ethdev port. Suggested-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Signed-off-by: Jerin Jacob <jerinj@marvell.com> Acked-by: Ray Kinsella <mdr@ashroe.eu> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
1095 lines
34 KiB
C
1095 lines
34 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright 2017 Intel Corporation
|
|
* Copyright 2017 NXP
|
|
* Copyright 2017 Cavium
|
|
*/
|
|
|
|
#ifndef __INCLUDE_RTE_MTR_H__
|
|
#define __INCLUDE_RTE_MTR_H__
|
|
|
|
/**
|
|
* @file
|
|
* RTE Generic Traffic Metering and Policing API
|
|
*
|
|
* This interface provides the ability to configure the traffic metering and
|
|
* policing (MTR) in a generic way.
|
|
*
|
|
* The processing done for each input packet hitting a MTR object is:
|
|
* A) Traffic metering: The packet is assigned a color (the meter output
|
|
* color), based on the previous history of the flow reflected in the
|
|
* current state of the MTR object, according to the specific traffic
|
|
* metering algorithm. The traffic metering algorithm can typically work
|
|
* in color aware mode, in which case the input packet already has an
|
|
* initial color (the input color), or in color blind mode, which is
|
|
* equivalent to considering all input packets initially colored as green.
|
|
* B) Policing: There is a separate policer action configured for each meter
|
|
* output color, which can:
|
|
* a) Drop the packet.
|
|
* b) Keep the same packet color: the policer output color matches the
|
|
* meter output color (essentially a no-op action).
|
|
* c) Recolor the packet: the policer output color is different than
|
|
* the meter output color.
|
|
* The policer output color is the output color of the packet, which is
|
|
* set in the packet meta-data (i.e. struct rte_mbuf::sched::color).
|
|
* C) Statistics: The set of counters maintained for each MTR object is
|
|
* configurable and subject to the implementation support. This set
|
|
* includes the number of packets and bytes dropped or passed for each
|
|
* output color.
|
|
*
|
|
* Once successfully created, an MTR object is linked to one or several flows
|
|
* through the meter action of the flow API.
|
|
* A) Whether an MTR object is private to a flow or potentially shared by
|
|
* several flows has to be specified at creation time.
|
|
* B) Several meter actions can be potentially registered for the same flow.
|
|
*
|
|
* @warning
|
|
* @b EXPERIMENTAL: this API may change without prior notice
|
|
*/
|
|
#include <stdint.h>
|
|
#include <rte_compat.h>
|
|
#include <rte_common.h>
|
|
#include <rte_meter.h>
|
|
#include <rte_flow.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Statistics counter type
|
|
*/
|
|
enum rte_mtr_stats_type {
|
|
/** Number of packets passed as green by the policer. */
|
|
RTE_MTR_STATS_N_PKTS_GREEN = 1 << 0,
|
|
|
|
/** Number of packets passed as yellow by the policer. */
|
|
RTE_MTR_STATS_N_PKTS_YELLOW = 1 << 1,
|
|
|
|
/** Number of packets passed as red by the policer. */
|
|
RTE_MTR_STATS_N_PKTS_RED = 1 << 2,
|
|
|
|
/** Number of packets dropped by the policer. */
|
|
RTE_MTR_STATS_N_PKTS_DROPPED = 1 << 3,
|
|
|
|
/** Number of bytes passed as green by the policer. */
|
|
RTE_MTR_STATS_N_BYTES_GREEN = 1 << 4,
|
|
|
|
/** Number of bytes passed as yellow by the policer. */
|
|
RTE_MTR_STATS_N_BYTES_YELLOW = 1 << 5,
|
|
|
|
/** Number of bytes passed as red by the policer. */
|
|
RTE_MTR_STATS_N_BYTES_RED = 1 << 6,
|
|
|
|
/** Number of bytes dropped by the policer. */
|
|
RTE_MTR_STATS_N_BYTES_DROPPED = 1 << 7,
|
|
};
|
|
|
|
/**
|
|
* Statistics counters
|
|
*/
|
|
struct rte_mtr_stats {
|
|
/** Number of packets passed by the policer (per color). */
|
|
uint64_t n_pkts[RTE_COLORS];
|
|
|
|
/** Number of bytes passed by the policer (per color). */
|
|
uint64_t n_bytes[RTE_COLORS];
|
|
|
|
/** Number of packets dropped by the policer. */
|
|
uint64_t n_pkts_dropped;
|
|
|
|
/** Number of bytes passed by the policer. */
|
|
uint64_t n_bytes_dropped;
|
|
};
|
|
|
|
/**
|
|
* Traffic metering algorithms
|
|
*/
|
|
enum rte_mtr_algorithm {
|
|
/** No traffic metering performed, the output color is the same as the
|
|
* input color for every input packet. The meter of the MTR object is
|
|
* working in pass-through mode, having same effect as meter disable.
|
|
* @see rte_mtr_meter_disable()
|
|
*/
|
|
RTE_MTR_NONE = 0,
|
|
|
|
/** Single Rate Three Color Marker (srTCM) - IETF RFC 2697. */
|
|
RTE_MTR_SRTCM_RFC2697,
|
|
|
|
/** Two Rate Three Color Marker (trTCM) - IETF RFC 2698. */
|
|
RTE_MTR_TRTCM_RFC2698,
|
|
|
|
/** Two Rate Three Color Marker (trTCM) - IETF RFC 4115. */
|
|
RTE_MTR_TRTCM_RFC4115,
|
|
};
|
|
|
|
/**
|
|
* Meter profile
|
|
*/
|
|
struct rte_mtr_meter_profile {
|
|
/** Traffic metering algorithm. */
|
|
enum rte_mtr_algorithm alg;
|
|
|
|
RTE_STD_C11
|
|
union {
|
|
/** Items only valid when *alg* is set to srTCM - RFC 2697. */
|
|
struct {
|
|
/**
|
|
* Committed Information Rate (CIR)
|
|
* (bytes per second or packets per second).
|
|
*/
|
|
uint64_t cir;
|
|
|
|
/** Committed Burst Size (CBS) (bytes or packets). */
|
|
uint64_t cbs;
|
|
|
|
/** Excess Burst Size (EBS) (bytes or packets). */
|
|
uint64_t ebs;
|
|
} srtcm_rfc2697;
|
|
|
|
/** Items only valid when *alg* is set to trTCM - RFC 2698. */
|
|
struct {
|
|
/**
|
|
* Committed Information Rate (CIR)
|
|
* (bytes per second or packets per second).
|
|
*/
|
|
uint64_t cir;
|
|
|
|
/**
|
|
* Peak Information Rate (PIR)
|
|
* (bytes per second or packets per second).
|
|
*/
|
|
uint64_t pir;
|
|
|
|
/** Committed Burst Size (CBS) (bytes or packets). */
|
|
uint64_t cbs;
|
|
|
|
/** Peak Burst Size (PBS) (bytes or packets). */
|
|
uint64_t pbs;
|
|
} trtcm_rfc2698;
|
|
|
|
/** Items only valid when *alg* is set to trTCM - RFC 4115. */
|
|
struct {
|
|
/**
|
|
* Committed Information Rate (CIR)
|
|
* (bytes per second or packets per second).
|
|
*/
|
|
uint64_t cir;
|
|
|
|
/**
|
|
* Excess Information Rate (EIR)
|
|
* (bytes per second or packets per second).
|
|
*/
|
|
uint64_t eir;
|
|
|
|
/** Committed Burst Size (CBS) (bytes or packets). */
|
|
uint64_t cbs;
|
|
|
|
/** Excess Burst Size (EBS) (bytes or packets). */
|
|
uint64_t ebs;
|
|
} trtcm_rfc4115;
|
|
};
|
|
|
|
/**
|
|
* When zero, the byte mode is enabled for the current profile, so the
|
|
* *rate* and *size* fields are specified in bytes per second
|
|
* and bytes, respectively.
|
|
* When non-zero, the packet mode is enabled for the current profile,
|
|
* so the *rate* and *size* fields are specified in packets per second
|
|
* and packets, respectively.
|
|
*/
|
|
int packet_mode;
|
|
};
|
|
|
|
/**
|
|
* Meter policy
|
|
*/
|
|
struct rte_mtr_meter_policy_params {
|
|
/**
|
|
* Policy action list per color.
|
|
* actions[i] potentially represents a chain of rte_flow actions
|
|
* terminated by the END action, exactly as specified by the rte_flow
|
|
* API for the flow definition, and not just a single action.
|
|
*/
|
|
const struct rte_flow_action *actions[RTE_COLORS];
|
|
};
|
|
|
|
/**
|
|
* Input color protocol method
|
|
*
|
|
* More than one of the method can be enabled for a given meter.
|
|
* Even if enabled, a method might not be applicable to each input packet,
|
|
* in case the associated protocol header is not present in the packet.
|
|
* The highest priority method that is both enabled for the meter and also
|
|
* applicable for the current input packet wins;
|
|
* if none is both enabled and applicable, the default input color is used.
|
|
* @see function rte_mtr_color_in_protocol_set()
|
|
*
|
|
*/
|
|
enum rte_mtr_color_in_protocol {
|
|
/**
|
|
* Enable the detection of the packet input color based on the outermost
|
|
* VLAN header fields DEI (1 bit) and PCP (3 bits).
|
|
* These fields are used as index into the VLAN table.
|
|
*
|
|
* @see struct rte_mtr_params::vlan_table
|
|
*/
|
|
RTE_MTR_COLOR_IN_PROTO_OUTER_VLAN = RTE_BIT64(0),
|
|
/**
|
|
* Enable the detection of the packet input color based on the innermost
|
|
* VLAN header fields DEI (1 bit) and PCP (3 bits).
|
|
* These fields are used as index into the VLAN table.
|
|
*
|
|
* @see struct rte_mtr_params::vlan_table
|
|
*/
|
|
RTE_MTR_COLOR_IN_PROTO_INNER_VLAN = RTE_BIT64(1),
|
|
/**
|
|
* Enable the detection of the packet input color based on the outermost
|
|
* IP DSCP field. These fields are used as index into the DSCP table.
|
|
*
|
|
* @see struct rte_mtr_params::dscp_table
|
|
*/
|
|
RTE_MTR_COLOR_IN_PROTO_OUTER_IP = RTE_BIT64(2),
|
|
/**
|
|
* Enable the detection of the packet input color based on the innermost
|
|
* IP DSCP field. These fields are used as index into the DSCP table.
|
|
*
|
|
* @see struct rte_mtr_params::dscp_table
|
|
*/
|
|
RTE_MTR_COLOR_IN_PROTO_INNER_IP = RTE_BIT64(3),
|
|
};
|
|
|
|
/**
|
|
* Parameters for each traffic metering & policing object
|
|
*
|
|
* @see enum rte_mtr_stats_type
|
|
*/
|
|
struct rte_mtr_params {
|
|
/** Meter profile ID. @see rte_mtr_meter_profile_add() */
|
|
uint32_t meter_profile_id;
|
|
|
|
/** Meter input color in case of MTR object chaining. When non-zero: if
|
|
* a previous MTR object is enabled in the same flow, then the color
|
|
* determined by the latest MTR object in the same flow is used as the
|
|
* input color by the current MTR object, otherwise the current MTR
|
|
* object uses the *dscp_table* to determine the input color. When zero:
|
|
* the color determined by any previous MTR object in same flow is
|
|
* ignored by the current MTR object, which uses the *dscp_table* to
|
|
* determine the input color.
|
|
*/
|
|
int use_prev_mtr_color;
|
|
|
|
/** Meter input color based on IP DSCP protocol field.
|
|
*
|
|
* Valid when *input_color_proto_mask* set to any of the following
|
|
* RTE_MTR_COLOR_IN_PROTO_OUTER_IP,
|
|
* RTE_MTR_COLOR_IN_PROTO_INNER_IP
|
|
*
|
|
* When non-NULL: it points to a pre-allocated and
|
|
* pre-populated table with exactly 64 elements providing the input
|
|
* color for each value of the IPv4/IPv6 Differentiated Services Code
|
|
* Point (DSCP) input packet field.
|
|
*
|
|
* When NULL: it is equivalent to setting this parameter to an all-green
|
|
* populated table (i.e. table with all the 64 elements set to green
|
|
* color). The color blind mode is configured by setting
|
|
* *use_prev_mtr_color* to 0 and *dscp_table* to either NULL or to an
|
|
* all-green populated table.
|
|
*
|
|
* When *use_prev_mtr_color* is non-zero value or when *dscp_table*
|
|
* contains at least one yellow or red color element, then the color
|
|
* aware mode is configured.
|
|
*
|
|
* @see enum rte_mtr_color_in_protocol::RTE_MTR_COLOR_IN_PROTO_OUTER_IP
|
|
* @see enum rte_mtr_color_in_protocol::RTE_MTR_COLOR_IN_PROTO_INNER_IP
|
|
* @see struct rte_mtr_params::input_color_proto_mask
|
|
*/
|
|
enum rte_color *dscp_table;
|
|
/** Meter input color based on VLAN DEI(1bit), PCP(3 bits) protocol
|
|
* fields.
|
|
*
|
|
* Valid when *input_color_proto_mask* set to any of the following
|
|
* RTE_MTR_COLOR_IN_PROTO_OUTER_VLAN,
|
|
* RTE_MTR_COLOR_IN_PROTO_INNER_VLAN
|
|
*
|
|
* When non-NULL: it points to a pre-allocated and pre-populated
|
|
* table with exactly 16 elements providing the input color for
|
|
* each value of the DEI(1bit), PCP(3 bits) input packet field.
|
|
*
|
|
* When NULL: it is equivalent to setting this parameter to an
|
|
* all-green populated table (i.e. table with
|
|
* all the 16 elements set to green color). The color blind mode
|
|
* is configured by setting *use_prev_mtr_color* to 0 and
|
|
* *vlan_table* to either NULL or to an all-green populated table.
|
|
*
|
|
* When *use_prev_mtr_color* is non-zero value
|
|
* or when *vlan_table* contains at least one yellow or
|
|
* red color element, then the color aware mode is configured.
|
|
*
|
|
* @see enum rte_mtr_color_in_protocol::RTE_MTR_COLOR_IN_PROTO_OUTER_VLAN
|
|
* @see enum rte_mtr_color_in_protocol::RTE_MTR_COLOR_IN_PROTO_INNER_VLAN
|
|
* @see struct rte_mtr_params::input_color_proto_mask
|
|
*/
|
|
enum rte_color *vlan_table;
|
|
/** Non-zero to enable the meter, zero to disable the meter at the time
|
|
* of MTR object creation. Ignored when the meter profile indicated by
|
|
* *meter_profile_id* is set to NONE.
|
|
* @see rte_mtr_meter_disable()
|
|
*/
|
|
int meter_enable;
|
|
|
|
/** Set of stats counters to be enabled.
|
|
* @see enum rte_mtr_stats_type
|
|
*/
|
|
uint64_t stats_mask;
|
|
|
|
/** Meter policy ID. @see rte_mtr_meter_policy_add() */
|
|
uint32_t meter_policy_id;
|
|
|
|
/** Input color to be set for the input packet when none of the
|
|
* enabled input color methods is applicable to the input packet.
|
|
* Ignored when this when *input_color_proto_mask* set to zero.
|
|
*/
|
|
enum rte_color default_input_color;
|
|
};
|
|
|
|
/**
|
|
* MTR capabilities
|
|
*/
|
|
struct rte_mtr_capabilities {
|
|
/** Maximum number of MTR objects. */
|
|
uint32_t n_max;
|
|
|
|
/** Maximum number of MTR objects that can be shared by multiple flows.
|
|
* The value of zero indicates that shared MTR objects are not
|
|
* supported. The maximum value is *n_max*.
|
|
*/
|
|
uint32_t n_shared_max;
|
|
|
|
/** When non-zero, this flag indicates that all the MTR objects that
|
|
* cannot be shared by multiple flows have identical capability set.
|
|
*/
|
|
int identical;
|
|
|
|
/** When non-zero, this flag indicates that all the MTR objects that
|
|
* can be shared by multiple flows have identical capability set.
|
|
*/
|
|
int shared_identical;
|
|
|
|
/** Maximum number of flows that can share the same MTR object. The
|
|
* value of zero is invalid. The value of 1 means that shared MTR
|
|
* objects not supported.
|
|
*/
|
|
uint32_t shared_n_flows_per_mtr_max;
|
|
|
|
/** Maximum number of MTR objects that can be part of the same flow. The
|
|
* value of zero is invalid. The value of 1 indicates that MTR object
|
|
* chaining is not supported. The maximum value is *n_max*.
|
|
*/
|
|
uint32_t chaining_n_mtrs_per_flow_max;
|
|
|
|
/**
|
|
* When non-zero, it indicates that the packet color identified by one
|
|
* MTR object can be used as the packet input color by any subsequent
|
|
* MTR object from the same flow. When zero, it indicates that the color
|
|
* determined by one MTR object is always ignored by any subsequent MTR
|
|
* object from the same flow. Only valid when MTR chaining is supported,
|
|
* i.e. *chaining_n_mtrs_per_flow_max* is greater than 1. When non-zero,
|
|
* it also means that the color aware mode is supported by at least one
|
|
* metering algorithm.
|
|
*/
|
|
int chaining_use_prev_mtr_color_supported;
|
|
|
|
/**
|
|
* When non-zero, it indicates that the packet color identified by one
|
|
* MTR object is always used as the packet input color by any subsequent
|
|
* MTR object that is part of the same flow. When zero, it indicates
|
|
* that whether the color determined by one MTR object is either ignored
|
|
* or used as the packet input color by any subsequent MTR object from
|
|
* the same flow is individually configurable for each MTR object. Only
|
|
* valid when *chaining_use_prev_mtr_color_supported* is non-zero.
|
|
*/
|
|
int chaining_use_prev_mtr_color_enforced;
|
|
|
|
/** Maximum number of MTR objects that can have their meter configured
|
|
* to run the srTCM RFC 2697 algorithm. The value of 0 indicates this
|
|
* metering algorithm is not supported. The maximum value is *n_max*.
|
|
*/
|
|
uint32_t meter_srtcm_rfc2697_n_max;
|
|
|
|
/** Maximum number of MTR objects that can have their meter configured
|
|
* to run the trTCM RFC 2698 algorithm. The value of 0 indicates this
|
|
* metering algorithm is not supported. The maximum value is *n_max*.
|
|
*/
|
|
uint32_t meter_trtcm_rfc2698_n_max;
|
|
|
|
/** Maximum number of MTR objects that can have their meter configured
|
|
* to run the trTCM RFC 4115 algorithm. The value of 0 indicates this
|
|
* metering algorithm is not supported. The maximum value is *n_max*.
|
|
*/
|
|
uint32_t meter_trtcm_rfc4115_n_max;
|
|
|
|
/** Maximum traffic rate that can be metered by a single MTR object. For
|
|
* srTCM RFC 2697, this is the maximum CIR rate. For trTCM RFC 2698,
|
|
* this is the maximum PIR rate. For trTCM RFC 4115, this is the maximum
|
|
* value for the sum of PIR and EIR rates.
|
|
*/
|
|
uint64_t meter_rate_max;
|
|
|
|
/**
|
|
* Maximum number of policy objects that can have.
|
|
* The value of 0 is invalid. Policy must be supported for meter.
|
|
* The maximum value is *n_max*.
|
|
*/
|
|
uint64_t meter_policy_n_max;
|
|
|
|
/**
|
|
* When non-zero, it indicates that color aware mode is supported for
|
|
* the srTCM RFC 2697 metering algorithm.
|
|
*/
|
|
int color_aware_srtcm_rfc2697_supported;
|
|
|
|
/**
|
|
* When non-zero, it indicates that color aware mode is supported for
|
|
* the trTCM RFC 2698 metering algorithm.
|
|
*/
|
|
int color_aware_trtcm_rfc2698_supported;
|
|
|
|
/**
|
|
* When non-zero, it indicates that color aware mode is supported for
|
|
* the trTCM RFC 4115 metering algorithm.
|
|
*/
|
|
int color_aware_trtcm_rfc4115_supported;
|
|
|
|
/**
|
|
* srTCM rfc2697 byte mode supported.
|
|
* When non-zero, it indicates that byte mode is supported for
|
|
* the srTCM RFC 2697 metering algorithm.
|
|
*/
|
|
int srtcm_rfc2697_byte_mode_supported;
|
|
|
|
/**
|
|
* srTCM rfc2697 packet mode supported.
|
|
* When non-zero, it indicates that packet mode is supported for
|
|
* the srTCM RFC 2697 metering algorithm.
|
|
*/
|
|
int srtcm_rfc2697_packet_mode_supported;
|
|
|
|
/**
|
|
* trTCM rfc2698 byte mode supported.
|
|
* When non-zero, it indicates that byte mode is supported for
|
|
* the trTCM RFC 2698 metering algorithm.
|
|
*/
|
|
int trtcm_rfc2698_byte_mode_supported;
|
|
|
|
/**
|
|
* trTCM rfc2698 packet mode supported.
|
|
* When non-zero, it indicates that packet mode is supported for
|
|
* the trTCM RFC 2698 metering algorithm.
|
|
*/
|
|
int trtcm_rfc2698_packet_mode_supported;
|
|
|
|
/**
|
|
* trTCM rfc4115 byte mode supported.
|
|
* When non-zero, it indicates that byte mode is supported for
|
|
* the trTCM RFC 4115 metering algorithm.
|
|
*/
|
|
int trtcm_rfc4115_byte_mode_supported;
|
|
|
|
/**
|
|
* trTCM rfc4115 packet mode supported.
|
|
* When non-zero, it indicates that packet mode is supported for
|
|
* the trTCM RFC 4115 metering algorithm.
|
|
*/
|
|
int trtcm_rfc4115_packet_mode_supported;
|
|
|
|
/** Set of supported statistics counter types.
|
|
* @see enum rte_mtr_stats_type
|
|
*/
|
|
uint64_t stats_mask;
|
|
|
|
/** Set of supported input color protocol.
|
|
* @see enum rte_mtr_color_in_protocol
|
|
*/
|
|
uint64_t input_color_proto_mask;
|
|
|
|
/** When non-zero, it indicates that driver supports separate
|
|
* input color table for given ethdev port.
|
|
*/
|
|
int separate_input_color_table_per_port;
|
|
};
|
|
|
|
/**
|
|
* Verbose error types.
|
|
*
|
|
* Most of them provide the type of the object referenced by struct
|
|
* rte_mtr_error::cause.
|
|
*/
|
|
enum rte_mtr_error_type {
|
|
RTE_MTR_ERROR_TYPE_NONE, /**< No error. */
|
|
RTE_MTR_ERROR_TYPE_UNSPECIFIED, /**< Cause unspecified. */
|
|
RTE_MTR_ERROR_TYPE_METER_PROFILE_ID,
|
|
RTE_MTR_ERROR_TYPE_METER_PROFILE,
|
|
RTE_MTR_ERROR_TYPE_METER_PROFILE_PACKET_MODE,
|
|
RTE_MTR_ERROR_TYPE_MTR_ID,
|
|
RTE_MTR_ERROR_TYPE_MTR_PARAMS,
|
|
RTE_MTR_ERROR_TYPE_POLICER_ACTION_GREEN,
|
|
RTE_MTR_ERROR_TYPE_POLICER_ACTION_YELLOW,
|
|
RTE_MTR_ERROR_TYPE_POLICER_ACTION_RED,
|
|
RTE_MTR_ERROR_TYPE_STATS_MASK,
|
|
RTE_MTR_ERROR_TYPE_STATS,
|
|
RTE_MTR_ERROR_TYPE_SHARED,
|
|
RTE_MTR_ERROR_TYPE_METER_POLICY_ID,
|
|
RTE_MTR_ERROR_TYPE_METER_POLICY,
|
|
};
|
|
|
|
/**
|
|
* Verbose error structure definition.
|
|
*
|
|
* This object is normally allocated by applications and set by PMDs, the
|
|
* message points to a constant string which does not need to be freed by
|
|
* the application, however its pointer can be considered valid only as long
|
|
* as its associated DPDK port remains configured. Closing the underlying
|
|
* device or unloading the PMD invalidates it.
|
|
*
|
|
* Both cause and message may be NULL regardless of the error type.
|
|
*/
|
|
struct rte_mtr_error {
|
|
enum rte_mtr_error_type type; /**< Cause field and error type. */
|
|
const void *cause; /**< Object responsible for the error. */
|
|
const char *message; /**< Human-readable error message. */
|
|
};
|
|
|
|
/**
|
|
* MTR capabilities get
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[out] cap
|
|
* MTR capabilities. Needs to be pre-allocated and valid.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_capabilities_get(uint16_t port_id,
|
|
struct rte_mtr_capabilities *cap,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* Meter profile add
|
|
*
|
|
* Create a new meter profile with ID set to *meter_profile_id*. The new profile
|
|
* is used to create one or several MTR objects.
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] meter_profile_id
|
|
* ID for the new meter profile. Needs to be unused by any of the existing
|
|
* meter profiles added for the current port.
|
|
* @param[in] profile
|
|
* Meter profile parameters. Needs to be pre-allocated and valid.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_meter_profile_add(uint16_t port_id,
|
|
uint32_t meter_profile_id,
|
|
struct rte_mtr_meter_profile *profile,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* Meter profile delete
|
|
*
|
|
* Delete an existing meter profile. This operation fails when there is
|
|
* currently at least one user (i.e. MTR object) of this profile.
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] meter_profile_id
|
|
* Meter profile ID. Needs to be the valid.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_meter_profile_delete(uint16_t port_id,
|
|
uint32_t meter_profile_id,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* Check whether a meter policy can be created on a given port.
|
|
*
|
|
* The meter policy is validated for correctness and
|
|
* whether it could be accepted by the device given sufficient resources.
|
|
* The policy is checked against the current capability information
|
|
* meter_policy_n_max configuration.
|
|
* The policy may also optionally be validated against existing
|
|
* device policy resources.
|
|
* This function has no effect on the target device.
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] policy
|
|
* Associated action list per color.
|
|
* list NULL is legal and means no special action.
|
|
* (list terminated by the END action).
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_meter_policy_validate(uint16_t port_id,
|
|
struct rte_mtr_meter_policy_params *policy,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* Meter policy add
|
|
*
|
|
* Create a new meter policy. The new policy
|
|
* is used to create single or multiple MTR objects.
|
|
* The same policy can be used to create multiple MTR objects.
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] policy_id
|
|
* Policy identifier for the new meter policy.
|
|
* @param[in] policy
|
|
* Associated actions per color.
|
|
* list NULL is legal and means no special action.
|
|
* Non-NULL list must be terminated.
|
|
* (list terminated by the END action).
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_meter_policy_add(uint16_t port_id,
|
|
uint32_t policy_id,
|
|
struct rte_mtr_meter_policy_params *policy,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* Define meter policy action list:
|
|
* GREEN - GREEN, YELLOW - YELLOW, RED - RED
|
|
*/
|
|
#define rte_mtr_policy_pass_color(policy) \
|
|
struct rte_mtr_meter_policy_params policy = \
|
|
{ \
|
|
.actions[RTE_COLOR_GREEN] = (struct rte_flow_action[]) { \
|
|
{ \
|
|
.type = RTE_FLOW_ACTION_TYPE_METER_COLOR, \
|
|
.conf = &(struct rte_flow_action_meter_color) { \
|
|
.color = RTE_COLOR_GREEN, \
|
|
}, \
|
|
}, \
|
|
{ \
|
|
.type = RTE_FLOW_ACTION_TYPE_END, \
|
|
}, \
|
|
}, \
|
|
.actions[RTE_COLOR_YELLOW] = (struct rte_flow_action[]) { \
|
|
{ \
|
|
.type = RTE_FLOW_ACTION_TYPE_METER_COLOR, \
|
|
.conf = &(struct rte_flow_action_meter_color) { \
|
|
.color = RTE_COLOR_YELLOW, \
|
|
}, \
|
|
}, \
|
|
{ \
|
|
.type = RTE_FLOW_ACTION_TYPE_END, \
|
|
}, \
|
|
}, \
|
|
.actions[RTE_COLOR_RED] = (struct rte_flow_action[]) { \
|
|
{ \
|
|
.type = RTE_FLOW_ACTION_TYPE_METER_COLOR, \
|
|
.conf = &(struct rte_flow_action_meter_color) { \
|
|
.color = RTE_COLOR_RED, \
|
|
}, \
|
|
}, \
|
|
{ \
|
|
.type = RTE_FLOW_ACTION_TYPE_END, \
|
|
}, \
|
|
}, \
|
|
}
|
|
|
|
/**
|
|
* Define meter policy action list:
|
|
* GREEN - Do nothing, YELLOW - Do nothing, RED - DROP
|
|
*/
|
|
#define rte_mtr_policy_drop_red(policy) \
|
|
struct rte_mtr_meter_policy_params policy = \
|
|
{ \
|
|
.actions[RTE_COLOR_GREEN] = NULL, \
|
|
.actions[RTE_COLOR_YELLOW] = NULL, \
|
|
.actions[RTE_COLOR_RED] = (struct rte_flow_action[]) { \
|
|
{ \
|
|
.type = RTE_FLOW_ACTION_TYPE_DROP, \
|
|
}, \
|
|
{ \
|
|
.type = RTE_FLOW_ACTION_TYPE_END, \
|
|
}, \
|
|
}, \
|
|
}
|
|
|
|
/**
|
|
* Meter policy delete
|
|
*
|
|
* Delete an existing meter policy. This operation fails when there is
|
|
* currently at least one user (i.e. MTR object) of this policy.
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] policy_id
|
|
* Policy identifier.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_meter_policy_delete(uint16_t port_id,
|
|
uint32_t policy_id,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* MTR object create
|
|
*
|
|
* Create a new MTR object for the current port. This object is run as part of
|
|
* associated flow action for traffic metering and policing.
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] mtr_id
|
|
* MTR object ID. Needs to be unused by any of the existing MTR objects.
|
|
* created for the current port.
|
|
* @param[in] params
|
|
* MTR object params. Needs to be pre-allocated and valid.
|
|
* @param[in] shared
|
|
* Non-zero when this MTR object can be shared by multiple flows, zero when
|
|
* this MTR object can be used by a single flow.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*
|
|
* @see enum rte_flow_action_type::RTE_FLOW_ACTION_TYPE_METER
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_create(uint16_t port_id,
|
|
uint32_t mtr_id,
|
|
struct rte_mtr_params *params,
|
|
int shared,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* MTR object destroy
|
|
*
|
|
* Delete an existing MTR object. This operation fails when there is currently
|
|
* at least one user (i.e. flow) of this MTR object.
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] mtr_id
|
|
* MTR object ID. Needs to be valid.
|
|
* created for the current port.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_destroy(uint16_t port_id,
|
|
uint32_t mtr_id,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* MTR object meter disable
|
|
*
|
|
* Disable the meter of an existing MTR object. In disabled state, the meter of
|
|
* the current MTR object works in pass-through mode, meaning that for each
|
|
* input packet the meter output color is always the same as the input color. In
|
|
* particular, when the meter of the current MTR object is configured in color
|
|
* blind mode, the input color is always green, so the meter output color is
|
|
* also always green. Note that the policer and the statistics of the current
|
|
* MTR object are working as usual while the meter is disabled. No action is
|
|
* taken and this function returns successfully when the meter of the current
|
|
* MTR object is already disabled.
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] mtr_id
|
|
* MTR object ID.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_meter_disable(uint16_t port_id,
|
|
uint32_t mtr_id,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* MTR object meter enable
|
|
*
|
|
* Enable the meter of an existing MTR object. If the MTR object has its meter
|
|
* already enabled, then no action is taken and this function returns
|
|
* successfully.
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] mtr_id
|
|
* MTR object ID.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_meter_enable(uint16_t port_id,
|
|
uint32_t mtr_id,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* MTR object meter profile update
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] mtr_id
|
|
* MTR object ID. Needs to be valid.
|
|
* @param[in] meter_profile_id
|
|
* Meter profile ID for the current MTR object. Needs to be valid.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_meter_profile_update(uint16_t port_id,
|
|
uint32_t mtr_id,
|
|
uint32_t meter_profile_id,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* MTR object meter policy update
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] mtr_id
|
|
* MTR object ID. Needs to be valid.
|
|
* @param[in] meter_policy_id
|
|
* Meter policy ID for the current MTR object. Needs to be valid.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_meter_policy_update(uint16_t port_id,
|
|
uint32_t mtr_id,
|
|
uint32_t meter_policy_id,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* MTR object DSCP table update
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] mtr_id
|
|
* MTR object ID. Needs to be valid.
|
|
* @param[in] dscp_table
|
|
* When non-NULL: it points to a pre-allocated and pre-populated table with
|
|
* exactly 64 elements providing the input color for each value of the
|
|
* IPv4/IPv6 Differentiated Services Code Point (DSCP) input packet field.
|
|
* When NULL: it is equivalent to setting this parameter to an "all-green"
|
|
* populated table (i.e. table with all the 64 elements set to green color).
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_meter_dscp_table_update(uint16_t port_id,
|
|
uint32_t mtr_id,
|
|
enum rte_color *dscp_table,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* MTR object VLAN table update
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] mtr_id
|
|
* MTR object ID. Needs to be valid.
|
|
* @param[in] vlan_table
|
|
* When non-NULL: it points to a pre-allocated and pre-populated table with
|
|
* exactly 16 elements providing the input color for each value of the
|
|
* each value of the DEI(1bit), PCP(3 bits) input packet field.
|
|
* When NULL: it is equivalent to setting this parameter to an "all-green"
|
|
* populated table (i.e. table with all the 16 elements set to green color).
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_meter_vlan_table_update(uint16_t port_id, uint32_t mtr_id,
|
|
enum rte_color *vlan_table,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* Set the input color protocol for a given MTR object
|
|
*
|
|
* More than one of the method can be enabled for a given meter.
|
|
* Even if enabled, a method might not be applicable to each input packet,
|
|
* in case the associated protocol header is not present in the packet.
|
|
* The highest priority method that is both enabled for the meter and also
|
|
* applicable for the current input packet wins;
|
|
* if none is both enabled and applicable, the default input color is used.
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] mtr_id
|
|
* MTR object ID. Needs to be valid.
|
|
* @param[in] proto
|
|
* Input color protocol.
|
|
* @param[in] priority
|
|
* Input color protocol priority. Value zero indicates
|
|
* the highest priority.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_color_in_protocol_set(uint16_t port_id, uint32_t mtr_id,
|
|
enum rte_mtr_color_in_protocol proto, uint32_t priority,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* Get the input color protocol for a given MTR object
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] mtr_id
|
|
* MTR object ID. Needs to be valid.
|
|
* @param[out] proto_mask
|
|
* Selected input color protocols as bit mask.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_color_in_protocol_get(uint16_t port_id, uint32_t mtr_id,
|
|
uint64_t *proto_mask,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* Get the priority associated with input color protocol for a given MTR object
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] mtr_id
|
|
* MTR object ID. Needs to be valid.
|
|
* @param[in] proto
|
|
* Input color protocol.
|
|
* @param[out] priority
|
|
* Input color protocol priority associated with proto.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_color_in_protocol_priority_get(uint16_t port_id, uint32_t mtr_id,
|
|
enum rte_mtr_color_in_protocol proto, uint32_t *priority,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* MTR object enabled statistics counters update
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] mtr_id
|
|
* MTR object ID. Needs to be valid.
|
|
* @param[in] stats_mask
|
|
* Mask of statistics counter types to be enabled for the current MTR object.
|
|
* Any statistics counter type not included in this set is to be disabled for
|
|
* the current MTR object.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*
|
|
* @see enum rte_mtr_stats_type
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_stats_update(uint16_t port_id,
|
|
uint32_t mtr_id,
|
|
uint64_t stats_mask,
|
|
struct rte_mtr_error *error);
|
|
|
|
/**
|
|
* MTR object statistics counters read
|
|
*
|
|
* @param[in] port_id
|
|
* The port identifier of the Ethernet device.
|
|
* @param[in] mtr_id
|
|
* MTR object ID. Needs to be valid.
|
|
* @param[out] stats
|
|
* When non-NULL, it contains the current value for the statistics counters
|
|
* enabled for the current MTR object.
|
|
* @param[out] stats_mask
|
|
* When non-NULL, it contains the mask of statistics counter types that are
|
|
* currently enabled for this MTR object, indicating which of the counters
|
|
* retrieved with the *stats* structure are valid.
|
|
* @param[in] clear
|
|
* When this parameter has a non-zero value, the statistics counters are
|
|
* cleared (i.e. set to zero) immediately after they have been read,
|
|
* otherwise the statistics counters are left untouched.
|
|
* @param[out] error
|
|
* Error details. Filled in only on error, when not NULL.
|
|
* @return
|
|
* 0 on success, non-zero error code otherwise.
|
|
*
|
|
* @see enum rte_mtr_stats_type
|
|
*/
|
|
__rte_experimental
|
|
int
|
|
rte_mtr_stats_read(uint16_t port_id,
|
|
uint32_t mtr_id,
|
|
struct rte_mtr_stats *stats,
|
|
uint64_t *stats_mask,
|
|
int clear,
|
|
struct rte_mtr_error *error);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __INCLUDE_RTE_MTR_H__ */
|