get:
Show a patch.

patch:
Update a patch.

put:
Update a patch.

GET /api/patches/133771/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 133771,
    "url": "http://patchwork.dpdk.org/api/patches/133771/?format=api",
    "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20231102082020.2588392-2-haijie1@huawei.com/",
    "project": {
        "id": 1,
        "url": "http://patchwork.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": "<20231102082020.2588392-2-haijie1@huawei.com>",
    "list_archive_url": "https://inbox.dpdk.org/dev/20231102082020.2588392-2-haijie1@huawei.com",
    "date": "2023-11-02T08:20:12",
    "name": "[v9,1/9] ethdev: overwrite some comment related to RSS",
    "commit_ref": null,
    "pull_url": null,
    "state": "accepted",
    "archived": true,
    "hash": "d29e9f9f7948a49a40a7b36ec9950c503d2ef7c9",
    "submitter": {
        "id": 2935,
        "url": "http://patchwork.dpdk.org/api/people/2935/?format=api",
        "name": "Jie Hai",
        "email": "haijie1@huawei.com"
    },
    "delegate": {
        "id": 319,
        "url": "http://patchwork.dpdk.org/api/users/319/?format=api",
        "username": "fyigit",
        "first_name": "Ferruh",
        "last_name": "Yigit",
        "email": "ferruh.yigit@amd.com"
    },
    "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/20231102082020.2588392-2-haijie1@huawei.com/mbox/",
    "series": [
        {
            "id": 30113,
            "url": "http://patchwork.dpdk.org/api/series/30113/?format=api",
            "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=30113",
            "date": "2023-11-02T08:20:14",
            "name": "support setting and querying RSS algorithms",
            "version": 9,
            "mbox": "http://patchwork.dpdk.org/series/30113/mbox/"
        }
    ],
    "comments": "http://patchwork.dpdk.org/api/patches/133771/comments/",
    "check": "warning",
    "checks": "http://patchwork.dpdk.org/api/patches/133771/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 6ABF84326B;\n\tThu,  2 Nov 2023 09:24:03 +0100 (CET)",
            "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 9FC19406B4;\n\tThu,  2 Nov 2023 09:23:58 +0100 (CET)",
            "from szxga01-in.huawei.com (szxga01-in.huawei.com [45.249.212.187])\n by mails.dpdk.org (Postfix) with ESMTP id 8F62C40284\n for <dev@dpdk.org>; Thu,  2 Nov 2023 09:23:56 +0100 (CET)",
            "from kwepemi500020.china.huawei.com (unknown [172.30.72.55])\n by szxga01-in.huawei.com (SkyGuard) with ESMTP id 4SLcN672RKzvQP3;\n Thu,  2 Nov 2023 16:23:50 +0800 (CST)",
            "from localhost.localdomain (10.67.165.2) by\n kwepemi500020.china.huawei.com (7.221.188.8) with Microsoft SMTP Server\n (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id\n 15.1.2507.31; Thu, 2 Nov 2023 16:23:52 +0800"
        ],
        "From": "Jie Hai <haijie1@huawei.com>",
        "To": "<dev@dpdk.org>, Thomas Monjalon <thomas@monjalon.net>, Ferruh Yigit\n <ferruh.yigit@amd.com>, Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>, Ori\n Kam <orika@nvidia.com>",
        "CC": "<lihuisong@huawei.com>, <fengchengwen@huawei.com>,\n <liudongdong3@huawei.com>",
        "Subject": "[PATCH v9 1/9] ethdev: overwrite some comment related to RSS",
        "Date": "Thu, 2 Nov 2023 16:20:12 +0800",
        "Message-ID": "<20231102082020.2588392-2-haijie1@huawei.com>",
        "X-Mailer": "git-send-email 2.30.0",
        "In-Reply-To": "<20231102082020.2588392-1-haijie1@huawei.com>",
        "References": "<20230315110033.30143-1-liudongdong3@huawei.com>\n <20231102082020.2588392-1-haijie1@huawei.com>",
        "MIME-Version": "1.0",
        "Content-Transfer-Encoding": "8bit",
        "Content-Type": "text/plain",
        "X-Originating-IP": "[10.67.165.2]",
        "X-ClientProxiedBy": "dggems704-chm.china.huawei.com (10.3.19.181) To\n kwepemi500020.china.huawei.com (7.221.188.8)",
        "X-CFilter-Loop": "Reflected",
        "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"
    },
    "content": "In rte_eth_dev_rss_hash_conf_get(), the \"rss_key_len\" should be\ngreater than or equal to the \"hash_key_size\" which get from\nrte_eth_dev_info_get() API. And the \"rss_key\" should contain at\nleast \"hash_key_size\" bytes. If these requirements are not met,\nthe query unreliable.\n\nIn rte_eth_dev_rss_hash_update() or rte_eth_dev_configure(), the\n\"rss_key_len\" indicates the length of the \"rss_key\" in bytes of\nthe array pointed by \"rss_key\", it should be equal to the\n\"hash_key_size\" if \"rss_key\" is not NULL.\n\nThis patch overwrites the comments of fields of \"rte_eth_rss_conf\"\nand \"RTE_ETH_HASH_FUNCTION_DEFAULT\", checks \"rss_key_len\" in\nethdev level, and documents these changes.\n\nSigned-off-by: Jie Hai <haijie1@huawei.com>\nAcked-by: Huisong Li <lihuisong@huawei.com>\nAcked-by: Chengwen Feng <fengchengwen@huawei.com>\n---\n doc/guides/rel_notes/release_23_11.rst |  4 ++++\n lib/ethdev/rte_ethdev.c                | 31 ++++++++++++++++++++++++\n lib/ethdev/rte_ethdev.h                | 33 ++++++++++++++------------\n lib/ethdev/rte_flow.h                  |  1 +\n 4 files changed, 54 insertions(+), 15 deletions(-)",
    "diff": "diff --git a/doc/guides/rel_notes/release_23_11.rst b/doc/guides/rel_notes/release_23_11.rst\nindex 95db98d098d8..0b67f31dc385 100644\n--- a/doc/guides/rel_notes/release_23_11.rst\n+++ b/doc/guides/rel_notes/release_23_11.rst\n@@ -345,6 +345,10 @@ API Changes\n   Updated ``rte_ml_op``, ``rte_ml_io_quantize`` and ``rte_ml_io_dequantize``\n   to support an array of ``rte_ml_buff_seg``.\n \n+* ethdev: When ``rte_eth_dev_configure`` or ``rte_eth_dev_rss_hash_update`` are\n+  called, the ``rss_key_len`` of structure ``rte_eth_rss_conf`` should be provided\n+  by user for the case ``rss_key != NULL``, it won't be taken as default 40\n+  bytes anymore.\n \n ABI Changes\n -----------\ndiff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c\nindex af23ac0ad00f..6727aca12dce 100644\n--- a/lib/ethdev/rte_ethdev.c\n+++ b/lib/ethdev/rte_ethdev.c\n@@ -1500,6 +1500,16 @@ rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_q, uint16_t nb_tx_q,\n \t\tgoto rollback;\n \t}\n \n+\tif (dev_conf->rx_adv_conf.rss_conf.rss_key != NULL &&\n+\t    dev_conf->rx_adv_conf.rss_conf.rss_key_len != dev_info.hash_key_size) {\n+\t\tRTE_ETHDEV_LOG(ERR,\n+\t\t\t\"Ethdev port_id=%u invalid RSS key len: %u, valid value: %u\\n\",\n+\t\t\tport_id, dev_conf->rx_adv_conf.rss_conf.rss_key_len,\n+\t\t\tdev_info.hash_key_size);\n+\t\tret = -EINVAL;\n+\t\tgoto rollback;\n+\t}\n+\n \t/*\n \t * Setup new number of Rx/Tx queues and reconfigure device.\n \t */\n@@ -4698,6 +4708,14 @@ rte_eth_dev_rss_hash_update(uint16_t port_id,\n \t\treturn -ENOTSUP;\n \t}\n \n+\tif (rss_conf->rss_key != NULL &&\n+\t    rss_conf->rss_key_len != dev_info.hash_key_size) {\n+\t\tRTE_ETHDEV_LOG(ERR,\n+\t\t\t\"Ethdev port_id=%u invalid RSS key len: %u, valid value: %u\\n\",\n+\t\t\tport_id, rss_conf->rss_key_len, dev_info.hash_key_size);\n+\t\treturn -EINVAL;\n+\t}\n+\n \tif (*dev->dev_ops->rss_hash_update == NULL)\n \t\treturn -ENOTSUP;\n \tret = eth_err(port_id, (*dev->dev_ops->rss_hash_update)(dev,\n@@ -4712,6 +4730,7 @@ int\n rte_eth_dev_rss_hash_conf_get(uint16_t port_id,\n \t\t\t      struct rte_eth_rss_conf *rss_conf)\n {\n+\tstruct rte_eth_dev_info dev_info = { 0 };\n \tstruct rte_eth_dev *dev;\n \tint ret;\n \n@@ -4725,6 +4744,18 @@ rte_eth_dev_rss_hash_conf_get(uint16_t port_id,\n \t\treturn -EINVAL;\n \t}\n \n+\tret = rte_eth_dev_info_get(port_id, &dev_info);\n+\tif (ret != 0)\n+\t\treturn ret;\n+\n+\tif (rss_conf->rss_key != NULL &&\n+\t    rss_conf->rss_key_len < dev_info.hash_key_size) {\n+\t\tRTE_ETHDEV_LOG(ERR,\n+\t\t\t\"Ethdev port_id=%u invalid RSS key len: %u, should not be less than: %u\\n\",\n+\t\t\tport_id, rss_conf->rss_key_len, dev_info.hash_key_size);\n+\t\treturn -EINVAL;\n+\t}\n+\n \tif (*dev->dev_ops->rss_hash_conf_get == NULL)\n \t\treturn -ENOTSUP;\n \tret = eth_err(port_id, (*dev->dev_ops->rss_hash_conf_get)(dev,\ndiff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h\nindex a53dd5a1efec..fb1a1f89c67f 100644\n--- a/lib/ethdev/rte_ethdev.h\n+++ b/lib/ethdev/rte_ethdev.h\n@@ -448,24 +448,27 @@ struct rte_vlan_filter_conf {\n /**\n  * A structure used to configure the Receive Side Scaling (RSS) feature\n  * of an Ethernet port.\n- * If not NULL, the *rss_key* pointer of the *rss_conf* structure points\n- * to an array holding the RSS key to use for hashing specific header\n- * fields of received packets. The length of this array should be indicated\n- * by *rss_key_len* below. Otherwise, a default random hash key is used by\n- * the device driver.\n- *\n- * The *rss_key_len* field of the *rss_conf* structure indicates the length\n- * in bytes of the array pointed by *rss_key*. To be compatible, this length\n- * will be checked in i40e only. Others assume 40 bytes to be used as before.\n- *\n- * The *rss_hf* field of the *rss_conf* structure indicates the different\n- * types of IPv4/IPv6 packets to which the RSS hashing must be applied.\n- * Supplying an *rss_hf* equal to zero disables the RSS feature.\n  */\n struct rte_eth_rss_conf {\n-\tuint8_t *rss_key;    /**< If not NULL, 40-byte hash key. */\n+\t/**\n+\t * In rte_eth_dev_rss_hash_conf_get(), the *rss_key_len* should be\n+\t * greater than or equal to the *hash_key_size* which get from\n+\t * rte_eth_dev_info_get() API. And the *rss_key* should contain at least\n+\t * *hash_key_size* bytes. If not meet these requirements, the query\n+\t * result is unreliable even if the operation returns success.\n+\t *\n+\t * In rte_eth_dev_rss_hash_update() or rte_eth_dev_configure(), if\n+\t * *rss_key* is not NULL, the *rss_key_len* indicates the length of the\n+\t * *rss_key* in bytes and it should be equal to *hash_key_size*.\n+\t * If *rss_key* is NULL, drivers are free to use a random or a default key.\n+\t */\n+\tuint8_t *rss_key;\n \tuint8_t rss_key_len; /**< hash key length in bytes. */\n-\tuint64_t rss_hf;     /**< Hash functions to apply - see below. */\n+\t/**\n+\t * Indicates the type of packets or the specific part of packets to\n+\t * which RSS hashing is to be applied.\n+\t */\n+\tuint64_t rss_hf;\n };\n \n /*\ndiff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h\nindex c16fe8c21f2f..751c29a0f3f3 100644\n--- a/lib/ethdev/rte_flow.h\n+++ b/lib/ethdev/rte_flow.h\n@@ -3226,6 +3226,7 @@ struct rte_flow_query_count {\n  * Hash function types.\n  */\n enum rte_eth_hash_function {\n+\t/** DEFAULT means driver decides which hash algorithm to pick. */\n \tRTE_ETH_HASH_FUNCTION_DEFAULT = 0,\n \tRTE_ETH_HASH_FUNCTION_TOEPLITZ, /**< Toeplitz */\n \tRTE_ETH_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */\n",
    "prefixes": [
        "v9",
        "1/9"
    ]
}