diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index 77de8da973..c51ed88cfe 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -2238,6 +2238,7 @@ fields in the pattern items. Action: ``OF_SET_MPLS_TTL`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^ +This action is deprecated. Consider `Action: MODIFY_FIELD`_. Implements ``OFPAT_SET_MPLS_TTL`` ("MPLS TTL") as defined by the `OpenFlow Switch Specification`_. @@ -2254,6 +2255,7 @@ Switch Specification`_. Action: ``OF_DEC_MPLS_TTL`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^ +This action is deprecated. Consider `Action: MODIFY_FIELD`_. Implements ``OFPAT_DEC_MPLS_TTL`` ("decrement MPLS TTL") as defined by the `OpenFlow Switch Specification`_. @@ -2270,6 +2272,7 @@ Implements ``OFPAT_DEC_MPLS_TTL`` ("decrement MPLS TTL") as defined by the Action: ``OF_SET_NW_TTL`` ^^^^^^^^^^^^^^^^^^^^^^^^^ +This action is deprecated. Consider `Action: MODIFY_FIELD`_. Implements ``OFPAT_SET_NW_TTL`` ("IP TTL") as defined by the `OpenFlow Switch Specification`_. @@ -2286,6 +2289,7 @@ Switch Specification`_. Action: ``OF_DEC_NW_TTL`` ^^^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Implements ``OFPAT_DEC_NW_TTL`` ("decrement IP TTL") as defined by the `OpenFlow Switch Specification`_. @@ -2302,6 +2306,7 @@ Implements ``OFPAT_DEC_NW_TTL`` ("decrement IP TTL") as defined by the Action: ``OF_COPY_TTL_OUT`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^ +This action is deprecated. Consider `Action: MODIFY_FIELD`_. Implements ``OFPAT_COPY_TTL_OUT`` ("copy TTL "outwards" -- from next-to-outermost to outermost") as defined by the `OpenFlow Switch @@ -2319,6 +2324,7 @@ Specification`_. Action: ``OF_COPY_TTL_IN`` ^^^^^^^^^^^^^^^^^^^^^^^^^^ +This action is deprecated. Consider `Action: MODIFY_FIELD`_. Implements ``OFPAT_COPY_TTL_IN`` ("copy TTL "inwards" -- from outermost to next-to-outermost") as defined by the `OpenFlow Switch Specification`_. @@ -2589,6 +2595,7 @@ valid packet. Action: ``SET_IPV4_SRC`` ^^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Set a new IPv4 source address in the outermost IPv4 header. @@ -2607,6 +2614,7 @@ Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned. Action: ``SET_IPV4_DST`` ^^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Set a new IPv4 destination address in the outermost IPv4 header. @@ -2625,6 +2633,7 @@ Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned. Action: ``SET_IPV6_SRC`` ^^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Set a new IPv6 source address in the outermost IPv6 header. @@ -2643,6 +2652,7 @@ Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned. Action: ``SET_IPV6_DST`` ^^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Set a new IPv6 destination address in the outermost IPv6 header. @@ -2661,6 +2671,7 @@ Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned. Action: ``SET_TP_SRC`` ^^^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Set a new source port number in the outermost TCP/UDP header. @@ -2679,6 +2690,7 @@ flow pattern item. Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned. Action: ``SET_TP_DST`` ^^^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Set a new destination port number in the outermost TCP/UDP header. @@ -2716,6 +2728,7 @@ Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned. Action: ``DEC_TTL`` ^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Decrease TTL value. @@ -2734,6 +2747,7 @@ in pattern, Some PMDs will reject rule because behavior will be undefined. Action: ``SET_TTL`` ^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Assigns a new TTL value. @@ -2752,6 +2766,7 @@ in pattern, Some PMDs will reject rule because behavior will be undefined. Action: ``SET_MAC_SRC`` ^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Set source MAC address. @@ -2770,6 +2785,7 @@ Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned. Action: ``SET_MAC_DST`` ^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Set destination MAC address. @@ -2788,6 +2804,7 @@ Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned. Action: ``INC_TCP_SEQ`` ^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Increase sequence number in the outermost TCP header. Value to increase TCP sequence number by is a big-endian 32 bit integer. @@ -2796,6 +2813,7 @@ Using this action on non-matching traffic will result in undefined behavior. Action: ``DEC_TCP_SEQ`` ^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Decrease sequence number in the outermost TCP header. Value to decrease TCP sequence number by is a big-endian 32 bit integer. @@ -2804,6 +2822,7 @@ Using this action on non-matching traffic will result in undefined behavior. Action: ``INC_TCP_ACK`` ^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Increase acknowledgment number in the outermost TCP header. Value to increase TCP acknowledgment number by is a big-endian 32 bit integer. @@ -2812,6 +2831,7 @@ Using this action on non-matching traffic will result in undefined behavior. Action: ``DEC_TCP_ACK`` ^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Decrease acknowledgment number in the outermost TCP header. Value to decrease TCP acknowledgment number by is a big-endian 32 bit integer. @@ -2820,6 +2840,7 @@ Using this action on non-matching traffic will result in undefined behavior. Action: ``SET_TAG`` ^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Set Tag. @@ -2842,6 +2863,7 @@ application. Multiple tags are supported by specifying index. Action: ``SET_META`` ^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Set metadata. Item ``META`` matches metadata. @@ -2876,6 +2898,7 @@ used to connect the Rx and Tx flows if it can be propagated from Rx to Tx path. Action: ``SET_IPV4_DSCP`` ^^^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Set IPv4 DSCP. @@ -2896,6 +2919,7 @@ Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned. Action: ``SET_IPV6_DSCP`` ^^^^^^^^^^^^^^^^^^^^^^^^^ +This is a legacy action. Consider `Action: MODIFY_FIELD`_ as alternative. Set IPv6 DSCP. diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 0671fb2ba7..5581822d10 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -93,6 +93,20 @@ Deprecation Notices is deprecated as ambiguous with respect to the embedded switch. The use of these attributes will become invalid starting from DPDK 22.11. +* ethdev: Actions ``OF_SET_MPLS_TTL``, ``OF_DEC_MPLS_TTL``, ``OF_SET_NW_TTL``, + ``OF_COPY_TTL_OUT``, ``OF_COPY_TTL_IN`` are deprecated as not supported by + any PMD, so they will be removed in DPDK 22.11. + +* ethdev: Actions ``OF_DEC_NW_TTL``, ``SET_IPV4_SRC``, ``SET_IPV4_DST``, + ``SET_IPV6_SRC``, ``SET_IPV6_DST``, ``SET_TP_SRC``, ``SET_TP_DST``, + ``DEC_TTL``, ``SET_TTL``, ``SET_MAC_SRC``, ``SET_MAC_DST``, ``INC_TCP_SEQ``, + ``DEC_TCP_SEQ``, ``INC_TCP_ACK``, ``DEC_TCP_ACK``, ``SET_IPV4_DSCP``, + ``SET_IPV6_DSCP``, ``SET_TAG``, ``SET_META`` are marked as legacy and + superseded by the generic MODIFY_FIELD action. + The legacy actions should be deprecated in 22.07, once MODIFY_FIELD + alternative is implemented. + The legacy actions should be removed in DPDK 22.11. + * cryptodev: Hide structures ``rte_cryptodev_sym_session`` and ``rte_cryptodev_asym_session`` to remove unnecessary indirection between session and the private data of session. An opaque pointer can be exposed diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h index 650376c16d..1031fb246b 100644 --- a/lib/ethdev/rte_flow.h +++ b/lib/ethdev/rte_flow.h @@ -2363,6 +2363,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_SECURITY, /** + * @deprecated + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Implements OFPAT_SET_MPLS_TTL ("MPLS TTL") as defined by the * OpenFlow Switch Specification. * @@ -2371,6 +2374,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_OF_SET_MPLS_TTL, /** + * @deprecated + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Implements OFPAT_DEC_MPLS_TTL ("decrement MPLS TTL") as defined * by the OpenFlow Switch Specification. * @@ -2379,6 +2385,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_OF_DEC_MPLS_TTL, /** + * @deprecated + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Implements OFPAT_SET_NW_TTL ("IP TTL") as defined by the OpenFlow * Switch Specification. * @@ -2387,6 +2396,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_OF_SET_NW_TTL, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Implements OFPAT_DEC_NW_TTL ("decrement IP TTL") as defined by * the OpenFlow Switch Specification. * @@ -2395,6 +2407,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_OF_DEC_NW_TTL, /** + * @deprecated + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Implements OFPAT_COPY_TTL_OUT ("copy TTL "outwards" -- from * next-to-outermost to outermost") as defined by the OpenFlow * Switch Specification. @@ -2404,6 +2419,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_OF_COPY_TTL_OUT, /** + * @deprecated + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Implements OFPAT_COPY_TTL_IN ("copy TTL "inwards" -- from * outermost to next-to-outermost") as defined by the OpenFlow * Switch Specification. @@ -2509,6 +2527,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_RAW_DECAP, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Modify IPv4 source address in the outermost IPv4 header. * * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4, @@ -2519,6 +2540,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_SET_IPV4_SRC, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Modify IPv4 destination address in the outermost IPv4 header. * * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4, @@ -2529,6 +2553,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_SET_IPV4_DST, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Modify IPv6 source address in the outermost IPv6 header. * * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6, @@ -2539,6 +2566,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_SET_IPV6_SRC, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Modify IPv6 destination address in the outermost IPv6 header. * * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6, @@ -2549,6 +2579,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_SET_IPV6_DST, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Modify source port number in the outermost TCP/UDP header. * * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_TCP @@ -2560,6 +2593,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_SET_TP_SRC, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Modify destination port number in the outermost TCP/UDP header. * * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_TCP @@ -2582,6 +2618,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_MAC_SWAP, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Decrease TTL value directly * * No associated configuration structure. @@ -2589,6 +2628,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_DEC_TTL, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Set TTL value * * See struct rte_flow_action_set_ttl @@ -2596,6 +2638,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_SET_TTL, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Set source MAC address from matched flow. * * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH, @@ -2606,6 +2651,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_SET_MAC_SRC, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Set destination MAC address from matched flow. * * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH, @@ -2616,6 +2664,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_SET_MAC_DST, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Increase sequence number in the outermost TCP header. * * Action configuration specifies the value to increase @@ -2630,6 +2681,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_INC_TCP_SEQ, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Decrease sequence number in the outermost TCP header. * * Action configuration specifies the value to decrease @@ -2644,6 +2698,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_DEC_TCP_SEQ, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Increase acknowledgment number in the outermost TCP header. * * Action configuration specifies the value to increase @@ -2658,6 +2715,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_INC_TCP_ACK, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Decrease acknowledgment number in the outermost TCP header. * * Action configuration specifies the value to decrease @@ -2672,6 +2732,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_DEC_TCP_ACK, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Set Tag. * * Tag is for internal flow usage only and @@ -2682,6 +2745,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_SET_TAG, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Set metadata on ingress or egress path. * * See struct rte_flow_action_set_meta. @@ -2689,6 +2755,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_SET_META, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Modify IPv4 DSCP in the outermost IP header. * * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4, @@ -2699,6 +2768,9 @@ enum rte_flow_action_type { RTE_FLOW_ACTION_TYPE_SET_IPV4_DSCP, /** + * @warning This is a legacy action. + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * Modify IPv6 DSCP in the outermost IP header. * * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6, @@ -3069,6 +3141,9 @@ struct rte_flow_action_security { }; /** + * @deprecated + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * RTE_FLOW_ACTION_TYPE_OF_SET_MPLS_TTL * * Implements OFPAT_SET_MPLS_TTL ("MPLS TTL") as defined by the OpenFlow @@ -3079,6 +3154,9 @@ struct rte_flow_action_of_set_mpls_ttl { }; /** + * @deprecated + * @see RTE_FLOW_ACTION_TYPE_MODIFY_FIELD + * * RTE_FLOW_ACTION_TYPE_OF_SET_NW_TTL * * Implements OFPAT_SET_NW_TTL ("IP TTL") as defined by the OpenFlow Switch