Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
rte_mtr_params(3)		      DPDK		       rte_mtr_params(3)

NAME
     rte_mtr_params

SYNOPSIS
     #include <rte_mtr.h>

   Data Fields
     uint32_t meter_profile_id
     int use_prev_mtr_color
     enum rte_color * dscp_table
     enum rte_color * vlan_table
     int meter_enable
     uint64_t stats_mask
     uint32_t meter_policy_id
     enum rte_color default_input_color

Detailed Description
     Parameters for each traffic metering & policing object

     See also
	 enum rte_mtr_stats_type

     Definition at line 264 of file rte_mtr.h.

Field Documentation
   uint32_t meter_profile_id
     Meter profile ID.

     See also
	 rte_mtr_meter_profile_add()

     Definition at line 266 of file rte_mtr.h.

   int use_prev_mtr_color
     Meter  input color in case of MTR object chaining. When non-zero: if a pre-
     vious 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.

     Definition at line 277 of file rte_mtr.h.

   enum rte_color* dscp_table
     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 popu-
     lated  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 config-
     ured.

     See also
	 enum rte_mtr_color_in_protocol::RTE_MTR_COLOR_IN_PROTO_OUTER_IP

	 enum rte_mtr_color_in_protocol::RTE_MTR_COLOR_IN_PROTO_INNER_IP

	 struct rte_mtr_params::input_color_proto_mask

     Definition at line 304 of file rte_mtr.h.

   enum rte_color* vlan_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 popu-
     lated  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 config-
     ured.

     See also
	 enum rte_mtr_color_in_protocol::RTE_MTR_COLOR_IN_PROTO_OUTER_VLAN

	 enum rte_mtr_color_in_protocol::RTE_MTR_COLOR_IN_PROTO_INNER_VLAN

	 struct rte_mtr_params::input_color_proto_mask

     Definition at line 330 of file rte_mtr.h.

   int meter_enable
     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_pro-
     file_id is set to NONE.

     See also
	 rte_mtr_meter_disable()

     Definition at line 336 of file rte_mtr.h.

   uint64_t stats_mask
     Set of stats counters to be enabled.

     See also
	 enum rte_mtr_stats_type

     Definition at line 341 of file rte_mtr.h.

   uint32_t meter_policy_id
     Meter policy ID.

     See also
	 rte_mtr_meter_policy_add()

     Definition at line 344 of file rte_mtr.h.

   enum rte_color default_input_color
     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 in-
     put_color_proto_mask set to zero.

     Definition at line 350 of file rte_mtr.h.

Author
     Generated automatically by Doxygen for DPDK from the source code.

Version 25.11.0 		 Thu Aug 27 2026	       rte_mtr_params(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=dscp_table&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help