ethdev: add protocol based meter input color selection

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>

diff --git a/doc/guides/prog_guide/traffic_metering_and_policing.rst b/doc/guides/prog_guide/traffic_metering_and_policing.rst
index ceb5a96488ae7c564f6c199c51c67df11297fb3f..d1958a023d37c47048bb1f4fe599e92bae99f37e 100644 (file)
--- a/doc/guides/prog_guide/traffic_metering_and_policing.rst
+++ b/doc/guides/prog_guide/traffic_metering_and_policing.rst
@@ -21,6 +21,7 @@ The main features are:
 * Policer actions (per meter output color): recolor, drop
 * Statistics (per policer output color)
 * Chaining multiple meter objects
+* Protocol based input color selection
 
 Configuration steps
 -------------------
@@ -105,3 +106,37 @@ traffic meter and policing library.
    * Adding one (or multiple) actions of the type ``RTE_FLOW_ACTION_TYPE_METER``
      to the list of meter actions (``struct rte_mtr_meter_policy_params::actions``)
      specified per color as show in :numref:`figure_rte_mtr_chaining`.
+
+Protocol based input color selection
+------------------------------------
+
+The API supports selecting the input color based on the packet content.
+Following is the API usage model for the same.
+
+#. Probe the protocol based input color selection device capabilities using
+   the following parameters with ``rte_mtr_capabilities_get()`` API.
+
+   * ``struct rte_mtr_capabilities::input_color_proto_mask;``
+   * ``struct rte_mtr_capabilities::separate_input_color_table_per_port``
+
+#. When creating the meter object using ``rte_mtr_create()``, configure
+   relevant input color selection parameters such as
+
+   * Fill the tables ``struct rte_mtr_params::dscp_table``,
+     ``struct rte_mtr_params::vlan_table`` based on input color selected.
+
+   * Update the ``struct rte_mtr_params::default_input_color`` to determine
+     the default input color in case the input packet does not match
+     the input color method.
+
+#. Use the following APIs to configure the meter object
+
+   * Select the input protocol color with ``rte_mtr_color_in_protocol_set()`` API.
+
+   * If needed, update the input color table at runtime using
+     ``rte_mtr_meter_vlan_table_update()`` and ``rte_mtr_meter_dscp_table_update()``
+     APIs.
+
+   * Application can query the configured input color protocol and its associated
+     priority using ``rte_mtr_color_in_protocol_get()`` and
+     ``rte_mtr_color_in_protocol_priority_get()`` APIs.

diff --git a/doc/guides/rel_notes/release_22_07.rst b/doc/guides/rel_notes/release_22_07.rst
index ce43b262b25ec6099392817c72aba6e44677a82e..d8bcd1336c5ad2b23b76f466c009d09e56311157 100644 (file)
--- a/doc/guides/rel_notes/release_22_07.rst
+++ b/doc/guides/rel_notes/release_22_07.rst
@@ -55,6 +55,15 @@ New Features
      Also, make sure to start the actual text at the margin.
      =======================================================
 
+* **Added protocol based input color selection for meter.**
+
+  Added new functions ``rte_mtr_color_in_protocol_set()``,
+  ``rte_mtr_color_in_protocol_get()``,
+  ``rte_mtr_color_in_protocol_priority_get()``,
+  ``rte_mtr_meter_vlan_table_update()``
+  and updated ``struct rte_mtr_params`` and ``struct rte_mtr_capabilities`` to
+  support protocol based input color selection for meter.
+
 * **Added vhost API to get the number of in-flight packets.**
 
   Added an API which can get the number of in-flight packets in
@@ -153,6 +162,10 @@ API Changes
   undefines the AltiVec keyword ``vector``.
   The alternative keyword ``__vector`` should be used instead.
 
+* Experimental structures ``struct rte_mtr_params``
+  and ``struct rte_mtr_capabilities`` updated to support
+  protocol based input color for meter.
+
 
 ABI Changes
 -----------

diff --git a/lib/ethdev/rte_mtr.c b/lib/ethdev/rte_mtr.c
index e49fcf271c2f547b17c0238f3a2a1eaa44df42f3..441ea1dca9e5bab569325c406c7befcf74bb408f 100644 (file)
--- a/lib/ethdev/rte_mtr.c
+++ b/lib/ethdev/rte_mtr.c
@@ -207,6 +207,56 @@ rte_mtr_meter_dscp_table_update(uint16_t port_id,
                mtr_id, dscp_table, error);
 }
 
+/** MTR object meter VLAN table update */
+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)
+{
+       struct rte_eth_dev *dev = &rte_eth_devices[port_id];
+       return RTE_MTR_FUNC(port_id, meter_vlan_table_update)(dev,
+               mtr_id, vlan_table, error);
+}
+
+/** Set the input color protocol on MTR object */
+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)
+{
+       struct rte_eth_dev *dev = &rte_eth_devices[port_id];
+       return RTE_MTR_FUNC(port_id, in_proto_set)(dev,
+               mtr_id, proto, priority, error);
+}
+
+/** Get input color protocols of MTR object */
+int
+rte_mtr_color_in_protocol_get(uint16_t port_id,
+       uint32_t mtr_id,
+       uint64_t *proto_mask,
+       struct rte_mtr_error *error)
+{
+       struct rte_eth_dev *dev = &rte_eth_devices[port_id];
+       return RTE_MTR_FUNC(port_id, in_proto_get)(dev,
+               mtr_id, proto_mask, error);
+}
+
+/** Get input color protocol priority of MTR object */
+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)
+{
+       struct rte_eth_dev *dev = &rte_eth_devices[port_id];
+       return RTE_MTR_FUNC(port_id, in_proto_prio_get)(dev,
+               mtr_id, proto, priority, error);
+}
+
 /** MTR object enabled stats update */
 int
 rte_mtr_stats_update(uint16_t port_id,

diff --git a/lib/ethdev/rte_mtr.h b/lib/ethdev/rte_mtr.h
index 40df0888c82da609b7526baebace689ec6c5c7da..008bc84f0dcf01fa089dd08a1f240c3de13d7910 100644 (file)
--- a/lib/ethdev/rte_mtr.h
+++ b/lib/ethdev/rte_mtr.h
@@ -213,6 +213,51 @@ struct rte_mtr_meter_policy_params {
        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
  *
@@ -233,20 +278,58 @@ struct rte_mtr_params {
         */
        int use_prev_mtr_color;
 
-       /** Meter input color. When non-NULL: it points to a pre-allocated and
+       /** 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.
+        * 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.
@@ -261,6 +344,12 @@ struct rte_mtr_params {
 
        /** 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;
 };
 
 /**
@@ -417,6 +506,16 @@ struct rte_mtr_capabilities {
         * @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;
 };
 
 /**
@@ -832,6 +931,103 @@ rte_mtr_meter_dscp_table_update(uint16_t port_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
  *

diff --git a/lib/ethdev/rte_mtr_driver.h b/lib/ethdev/rte_mtr_driver.h
index ee8c6ef7adb17e71d65ea833965fad9a3f8fd75d..f7dca9a54c697ad2537622c3355868097dc88064 100644 (file)
--- a/lib/ethdev/rte_mtr_driver.h
+++ b/lib/ethdev/rte_mtr_driver.h
@@ -97,6 +97,32 @@ typedef int (*rte_mtr_meter_dscp_table_update_t)(struct rte_eth_dev *dev,
        enum rte_color *dscp_table,
        struct rte_mtr_error *error);
 
+/** @internal mtr object meter vlan table update. */
+typedef int (*rte_mtr_meter_vlan_table_update_t)(struct rte_eth_dev *dev,
+       uint32_t mtr_id,
+       enum rte_color *vlan_table,
+       struct rte_mtr_error *error);
+
+/** @internal Set the input color protocol on MTR object. */
+typedef int (*rte_mtr_meter_color_in_proto_set_t)(struct rte_eth_dev *dev,
+       uint32_t mtr_id,
+       enum rte_mtr_color_in_protocol proto,
+       uint32_t priority,
+       struct rte_mtr_error *error);
+
+/** @internal Get the input color protocols of MTR object. */
+typedef int (*rte_mtr_meter_color_in_proto_get_t)(struct rte_eth_dev *dev,
+       uint32_t mtr_id,
+       uint64_t *proto_mask,
+       struct rte_mtr_error *error);
+
+/** @internal Get the input color protocol priority of MTR object. */
+typedef int (*rte_mtr_meter_color_in_proto_prio_get_t)(struct rte_eth_dev *dev,
+       uint32_t mtr_id,
+       enum rte_mtr_color_in_protocol proto,
+       uint32_t *priority,
+       struct rte_mtr_error *error);
+
 /** @internal MTR object enabled stats update. */
 typedef int (*rte_mtr_stats_update_t)(struct rte_eth_dev *dev,
        uint32_t mtr_id,
@@ -139,6 +165,18 @@ struct rte_mtr_ops {
        /** MTR object meter DSCP table update */
        rte_mtr_meter_dscp_table_update_t meter_dscp_table_update;
 
+       /** MTR object meter VLAN table update */
+       rte_mtr_meter_vlan_table_update_t meter_vlan_table_update;
+
+       /** Set the input color protocol on MTR object. */
+       rte_mtr_meter_color_in_proto_set_t in_proto_set;
+
+       /** Get the input color protocol of MTR object. */
+       rte_mtr_meter_color_in_proto_get_t in_proto_get;
+
+       /** Get the input color protocol priority of MTR object. */
+       rte_mtr_meter_color_in_proto_prio_get_t in_proto_prio_get;
+
        /** MTR object enabled stats update */
        rte_mtr_stats_update_t stats_update;
 

diff --git a/lib/ethdev/version.map b/lib/ethdev/version.map
index 20391ab29edfb7590be42d0122ce5d013ec4ddd6..daca7851f244b0d9b2e2839a095be0f578bb5d49 100644 (file)
--- a/lib/ethdev/version.map
+++ b/lib/ethdev/version.map
@@ -279,6 +279,12 @@ EXPERIMENTAL {
        rte_flow_async_action_handle_create;
        rte_flow_async_action_handle_destroy;
        rte_flow_async_action_handle_update;
+
+       # added in 22.07
+       rte_mtr_color_in_protocol_get;
+       rte_mtr_color_in_protocol_priority_get;
+       rte_mtr_color_in_protocol_set;
+       rte_mtr_meter_vlan_table_update;
 };
 
 INTERNAL {