Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/100942/?format=api
{ "id": 100942, "url": "http://patches.dpdk.org/api/patches/100942/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20211010143930.4985-6-ivan.malov@oktetlabs.ru/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20211010143930.4985-6-ivan.malov@oktetlabs.ru>", "list_archive_url": "https://inbox.dpdk.org/dev/20211010143930.4985-6-ivan.malov@oktetlabs.ru", "date": "2021-10-10T14:39:23", "name": "[v3,05/12] ethdev: deprecate hard-to-use or ambiguous items and actions", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "f30492ef9af64247dc9d62ae1cd5de0afb94ee9b", "submitter": { "id": 869, "url": "http://patches.dpdk.org/api/people/869/?format=api", "name": "Ivan Malov", "email": "Ivan.Malov@oktetlabs.ru" }, "delegate": { "id": 319, "url": "http://patches.dpdk.org/api/users/319/?format=api", "username": "fyigit", "first_name": "Ferruh", "last_name": "Yigit", "email": "ferruh.yigit@amd.com" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20211010143930.4985-6-ivan.malov@oktetlabs.ru/mbox/", "series": [ { "id": 19490, "url": "http://patches.dpdk.org/api/series/19490/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=19490", "date": "2021-10-10T14:39:18", "name": "ethdev: rework transfer flow API", "version": 3, "mbox": "http://patches.dpdk.org/series/19490/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/100942/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/100942/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 239CFA0C43;\n\tSun, 10 Oct 2021 16:40:35 +0200 (CEST)", "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 4C10841123;\n\tSun, 10 Oct 2021 16:40:07 +0200 (CEST)", "from shelob.oktetlabs.ru (shelob.oktetlabs.ru [91.220.146.113])\n by mails.dpdk.org (Postfix) with ESMTP id 7F3D84003C\n for <dev@dpdk.org>; Sun, 10 Oct 2021 16:40:00 +0200 (CEST)", "from localhost.localdomain (unknown [5.144.123.197])\n (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest\n SHA256)\n (No client certificate requested)\n by shelob.oktetlabs.ru (Postfix) with ESMTPSA id 2DC597F6D7;\n Sun, 10 Oct 2021 17:40:00 +0300 (MSK)" ], "DKIM-Filter": "OpenDKIM Filter v2.11.0 shelob.oktetlabs.ru 2DC597F6D7", "DKIM-Signature": "v=1; a=rsa-sha256; c=simple/simple; d=oktetlabs.ru;\n s=default; t=1633876800;\n bh=6n9+fon2tp8nQD1WT6llae4RQxjJsPC4od7C41rMcS0=;\n h=From:To:Cc:Subject:Date:In-Reply-To:References;\n b=eVROE0N2Bz2G9nLvSU3XTTVdqEwzhZ78wC6PTth4oDRq0OssMRmT6f5caHsmOWX16\n M+cTI+HrHV47n++NS3Z7benKHOlz2S0Q4S7hty7WDnOPDUY6smwX0TisrzO0DQ5Ww+\n LD0+n9hweRrZdvUfZhyniO7wZTNplZKcBw/NsS3M=", "From": "Ivan Malov <ivan.malov@oktetlabs.ru>", "To": "dev@dpdk.org", "Cc": "Thomas Monjalon <thomas@monjalon.net>, Ori Kam <orika@nvidia.com>,\n Ray Kinsella <mdr@ashroe.eu>, Ferruh Yigit <ferruh.yigit@intel.com>,\n Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>", "Date": "Sun, 10 Oct 2021 17:39:23 +0300", "Message-Id": "<20211010143930.4985-6-ivan.malov@oktetlabs.ru>", "X-Mailer": "git-send-email 2.20.1", "In-Reply-To": "<20211010143930.4985-1-ivan.malov@oktetlabs.ru>", "References": "<20211001134716.1608857-1-andrew.rybchenko@oktetlabs.ru>\n <20211010143930.4985-1-ivan.malov@oktetlabs.ru>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[dpdk-dev] [PATCH v3 05/12] ethdev: deprecate hard-to-use or\n ambiguous items and actions", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "PF, VF and PHY_PORT require that applications have extra\nknowledge of the underlying NIC and thus are hard to use.\nAlso, the corresponding items depend on the direction\nattribute (ingress / egress), which complicates their\nuse in applications and interpretation in PMDs.\n\nThe concept of PORT_ID is ambiguous as it doesn't say whether\nthe port in question is an ethdev or the represented entity.\n\nItems and actions PORT_REPRESENTOR, REPRESENTED_PORT\nshould be used instead.\n\nSigned-off-by: Ivan Malov <ivan.malov@oktetlabs.ru>\n---\n doc/guides/prog_guide/rte_flow.rst | 32 +++++++++++++++\n doc/guides/rel_notes/deprecation.rst | 9 ++---\n doc/guides/rel_notes/release_21_11.rst | 3 ++\n lib/ethdev/rte_flow.h | 56 ++++++++++++++++++++++++++\n 4 files changed, 94 insertions(+), 6 deletions(-)", "diff": "diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst\nindex 2bc437e5cd..1aa24e0633 100644\n--- a/doc/guides/prog_guide/rte_flow.rst\n+++ b/doc/guides/prog_guide/rte_flow.rst\n@@ -504,6 +504,10 @@ Usage example, matching non-TCPv4 packets only:\n Item: ``PF``\n ^^^^^^^^^^^^\n \n+This item is deprecated. Consider:\n+ - `Item: PORT_REPRESENTOR`_\n+ - `Item: REPRESENTED_PORT`_\n+\n Matches traffic originating from (ingress) or going to (egress) the physical\n function of the current device.\n \n@@ -531,6 +535,10 @@ the application and thus not associated with a DPDK port ID.\n Item: ``VF``\n ^^^^^^^^^^^^\n \n+This item is deprecated. Consider:\n+ - `Item: PORT_REPRESENTOR`_\n+ - `Item: REPRESENTED_PORT`_\n+\n Matches traffic originating from (ingress) or going to (egress) a given\n virtual function of the current device.\n \n@@ -562,6 +570,10 @@ separate entities, should be addressed through their own DPDK port IDs.\n Item: ``PHY_PORT``\n ^^^^^^^^^^^^^^^^^^\n \n+This item is deprecated. Consider:\n+ - `Item: PORT_REPRESENTOR`_\n+ - `Item: REPRESENTED_PORT`_\n+\n Matches traffic originating from (ingress) or going to (egress) a physical\n port of the underlying device.\n \n@@ -596,6 +608,10 @@ associated with a port_id should be retrieved by other means.\n Item: ``PORT_ID``\n ^^^^^^^^^^^^^^^^^\n \n+This item is deprecated. Consider:\n+ - `Item: PORT_REPRESENTOR`_\n+ - `Item: REPRESENTED_PORT`_\n+\n Matches traffic originating from (ingress) or going to (egress) a given DPDK\n port ID.\n \n@@ -1965,6 +1981,10 @@ only matching traffic goes through.\n Action: ``PF``\n ^^^^^^^^^^^^^^\n \n+This action is deprecated. Consider:\n+ - `Action: PORT_REPRESENTOR`_\n+ - `Action: REPRESENTED_PORT`_\n+\n Directs matching traffic to the physical function (PF) of the current\n device.\n \n@@ -1985,6 +2005,10 @@ See `Item: PF`_.\n Action: ``VF``\n ^^^^^^^^^^^^^^\n \n+This action is deprecated. Consider:\n+ - `Action: PORT_REPRESENTOR`_\n+ - `Action: REPRESENTED_PORT`_\n+\n Directs matching traffic to a given virtual function of the current device.\n \n Packets matched by a VF pattern item can be redirected to their original VF\n@@ -2009,6 +2033,10 @@ See `Item: VF`_.\n Action: ``PHY_PORT``\n ^^^^^^^^^^^^^^^^^^^^\n \n+This action is deprecated. Consider:\n+ - `Action: PORT_REPRESENTOR`_\n+ - `Action: REPRESENTED_PORT`_\n+\n Directs matching traffic to a given physical port index of the underlying\n device.\n \n@@ -2028,6 +2056,10 @@ See `Item: PHY_PORT`_.\n \n Action: ``PORT_ID``\n ^^^^^^^^^^^^^^^^^^^\n+This action is deprecated. Consider:\n+ - `Action: PORT_REPRESENTOR`_\n+ - `Action: REPRESENTED_PORT`_\n+\n Directs matching traffic to a given DPDK port ID.\n \n See `Item: PORT_ID`_.\ndiff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst\nindex b86147dda1..c91d570099 100644\n--- a/doc/guides/rel_notes/deprecation.rst\n+++ b/doc/guides/rel_notes/deprecation.rst\n@@ -122,12 +122,6 @@ Deprecation Notices\n is deprecated and will be removed in DPDK 21.11. Shared counters should\n be managed using shared actions API (``rte_flow_shared_action_create`` etc).\n \n-* ethdev: Definition of the flow API action ``RTE_FLOW_ACTION_TYPE_PORT_ID``\n- is ambiguous and needs clarification.\n- Structure ``rte_flow_action_port_id`` will be extended to specify\n- traffic direction to the represented entity or ethdev port itself\n- in DPDK 21.11.\n-\n * ethdev: Flow API documentation is unclear if ethdev port used to create\n a flow rule adds any implicit match criteria in the case of transfer rules.\n The semantics will be clarified in DPDK 21.11 and it will require fixes in\n@@ -256,3 +250,6 @@ Deprecation Notices\n * cmdline: ``cmdline`` structure will be made opaque to hide platform-specific\n content. On Linux and FreeBSD, supported prior to DPDK 20.11,\n original structure will be kept until DPDK 21.11.\n+\n+* ethdev: Items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID`` are\n+ deprecated as hard-to-use / ambiguous and will be removed in DPDK 22.11.\ndiff --git a/doc/guides/rel_notes/release_21_11.rst b/doc/guides/rel_notes/release_21_11.rst\nindex f689a10e63..63f946ad88 100644\n--- a/doc/guides/rel_notes/release_21_11.rst\n+++ b/doc/guides/rel_notes/release_21_11.rst\n@@ -190,6 +190,9 @@ API Changes\n \n * ethdev: Added items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` to flow API.\n \n+* ethdev: Deprecated items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID``.\n+ Suggested items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` instead.\n+\n * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been\n removed. Its usages have been replaced by a new function\n ``rte_kvargs_get_with_value()``.\ndiff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h\nindex afd1f4c193..afd50d6d51 100644\n--- a/lib/ethdev/rte_flow.h\n+++ b/lib/ethdev/rte_flow.h\n@@ -160,6 +160,10 @@ enum rte_flow_item_type {\n \tRTE_FLOW_ITEM_TYPE_ANY,\n \n \t/**\n+\t * @deprecated\n+\t * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR\n+\t * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT\n+\t *\n \t * [META]\n \t *\n \t * Matches traffic originating from (ingress) or going to (egress)\n@@ -170,6 +174,10 @@ enum rte_flow_item_type {\n \tRTE_FLOW_ITEM_TYPE_PF,\n \n \t/**\n+\t * @deprecated\n+\t * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR\n+\t * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT\n+\t *\n \t * [META]\n \t *\n \t * Matches traffic originating from (ingress) or going to (egress) a\n@@ -180,6 +188,10 @@ enum rte_flow_item_type {\n \tRTE_FLOW_ITEM_TYPE_VF,\n \n \t/**\n+\t * @deprecated\n+\t * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR\n+\t * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT\n+\t *\n \t * [META]\n \t *\n \t * Matches traffic originating from (ingress) or going to (egress) a\n@@ -190,6 +202,10 @@ enum rte_flow_item_type {\n \tRTE_FLOW_ITEM_TYPE_PHY_PORT,\n \n \t/**\n+\t * @deprecated\n+\t * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR\n+\t * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT\n+\t *\n \t * [META]\n \t *\n \t * Matches traffic originating from (ingress) or going to (egress) a\n@@ -640,6 +656,10 @@ static const struct rte_flow_item_any rte_flow_item_any_mask = {\n #endif\n \n /**\n+ * @deprecated\n+ * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR\n+ * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT\n+ *\n * RTE_FLOW_ITEM_TYPE_VF\n *\n * Matches traffic originating from (ingress) or going to (egress) a given\n@@ -669,6 +689,10 @@ static const struct rte_flow_item_vf rte_flow_item_vf_mask = {\n #endif\n \n /**\n+ * @deprecated\n+ * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR\n+ * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT\n+ *\n * RTE_FLOW_ITEM_TYPE_PHY_PORT\n *\n * Matches traffic originating from (ingress) or going to (egress) a\n@@ -700,6 +724,10 @@ static const struct rte_flow_item_phy_port rte_flow_item_phy_port_mask = {\n #endif\n \n /**\n+ * @deprecated\n+ * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR\n+ * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT\n+ *\n * RTE_FLOW_ITEM_TYPE_PORT_ID\n *\n * Matches traffic originating from (ingress) or going to (egress) a given\n@@ -1990,6 +2018,10 @@ enum rte_flow_action_type {\n \tRTE_FLOW_ACTION_TYPE_RSS,\n \n \t/**\n+\t * @deprecated\n+\t * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR\n+\t * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT\n+\t *\n \t * Directs matching traffic to the physical function (PF) of the\n \t * current device.\n \t *\n@@ -1998,6 +2030,10 @@ enum rte_flow_action_type {\n \tRTE_FLOW_ACTION_TYPE_PF,\n \n \t/**\n+\t * @deprecated\n+\t * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR\n+\t * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT\n+\t *\n \t * Directs matching traffic to a given virtual function of the\n \t * current device.\n \t *\n@@ -2006,6 +2042,10 @@ enum rte_flow_action_type {\n \tRTE_FLOW_ACTION_TYPE_VF,\n \n \t/**\n+\t * @deprecated\n+\t * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR\n+\t * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT\n+\t *\n \t * Directs packets to a given physical port index of the underlying\n \t * device.\n \t *\n@@ -2014,6 +2054,10 @@ enum rte_flow_action_type {\n \tRTE_FLOW_ACTION_TYPE_PHY_PORT,\n \n \t/**\n+\t * @deprecated\n+\t * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR\n+\t * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT\n+\t *\n \t * Directs matching traffic to a given DPDK port ID.\n \t *\n \t * See struct rte_flow_action_port_id.\n@@ -2654,6 +2698,10 @@ struct rte_flow_action_rss {\n };\n \n /**\n+ * @deprecated\n+ * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR\n+ * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT\n+ *\n * RTE_FLOW_ACTION_TYPE_VF\n *\n * Directs matching traffic to a given virtual function of the current\n@@ -2672,6 +2720,10 @@ struct rte_flow_action_vf {\n };\n \n /**\n+ * @deprecated\n+ * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR\n+ * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT\n+ *\n * RTE_FLOW_ACTION_TYPE_PHY_PORT\n *\n * Directs packets to a given physical port index of the underlying\n@@ -2686,6 +2738,10 @@ struct rte_flow_action_phy_port {\n };\n \n /**\n+ * @deprecated\n+ * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR\n+ * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT\n+ *\n * RTE_FLOW_ACTION_TYPE_PORT_ID\n *\n * Directs matching traffic to a given DPDK port ID.\n", "prefixes": [ "v3", "05/12" ] }