get:
Show a patch.

patch:
Update a patch.

put:
Update a patch.

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

{
    "id": 134873,
    "url": "http://patches.dpdk.org/api/patches/134873/?format=api",
    "web_url": "http://patches.dpdk.org/project/dpdk/patch/20231205094536.2816720-5-david.marchand@redhat.com/",
    "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": "<20231205094536.2816720-5-david.marchand@redhat.com>",
    "list_archive_url": "https://inbox.dpdk.org/dev/20231205094536.2816720-5-david.marchand@redhat.com",
    "date": "2023-12-05T09:45:35",
    "name": "[v2,5/5] vhost: enhance virtqueue access lock asserts",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": true,
    "hash": "6a007c64b1d022a3c011f35e886afcf0e9c95a6e",
    "submitter": {
        "id": 1173,
        "url": "http://patches.dpdk.org/api/people/1173/?format=api",
        "name": "David Marchand",
        "email": "david.marchand@redhat.com"
    },
    "delegate": {
        "id": 2642,
        "url": "http://patches.dpdk.org/api/users/2642/?format=api",
        "username": "mcoquelin",
        "first_name": "Maxime",
        "last_name": "Coquelin",
        "email": "maxime.coquelin@redhat.com"
    },
    "mbox": "http://patches.dpdk.org/project/dpdk/patch/20231205094536.2816720-5-david.marchand@redhat.com/mbox/",
    "series": [
        {
            "id": 30453,
            "url": "http://patches.dpdk.org/api/series/30453/?format=api",
            "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30453",
            "date": "2023-12-05T09:45:31",
            "name": "[v2,1/5] vhost: fix virtqueue access check in datapath",
            "version": 2,
            "mbox": "http://patches.dpdk.org/series/30453/mbox/"
        }
    ],
    "comments": "http://patches.dpdk.org/api/patches/134873/comments/",
    "check": "success",
    "checks": "http://patches.dpdk.org/api/patches/134873/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 32D5543676;\n\tTue,  5 Dec 2023 10:46:27 +0100 (CET)",
            "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 9690F42E2C;\n\tTue,  5 Dec 2023 10:46:01 +0100 (CET)",
            "from us-smtp-delivery-124.mimecast.com\n (us-smtp-delivery-124.mimecast.com [170.10.133.124])\n by mails.dpdk.org (Postfix) with ESMTP id 3343D42E25\n for <dev@dpdk.org>; Tue,  5 Dec 2023 10:46:00 +0100 (CET)",
            "from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com\n [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS\n (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id\n us-mta-448-8lOXDxZOOPenhsGjsLh9hg-1; Tue, 05 Dec 2023 04:45:57 -0500",
            "from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com\n [10.11.54.3])\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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id A2784185A787;\n Tue,  5 Dec 2023 09:45:57 +0000 (UTC)",
            "from dmarchan.redhat.com (unknown [10.45.225.216])\n by smtp.corp.redhat.com (Postfix) with ESMTP id 997851121312;\n Tue,  5 Dec 2023 09:45:56 +0000 (UTC)"
        ],
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n s=mimecast20190719; t=1701769559;\n h=from:from:reply-to:subject:subject:date:date:message-id:message-id:\n to:to:cc:cc:mime-version:mime-version:content-type:content-type:\n content-transfer-encoding:content-transfer-encoding:\n in-reply-to:in-reply-to:references:references;\n bh=LRPkJVsHkICbmaTG8gxyBoBKzXMWEIyTtDyA9v3lA3o=;\n b=hYbXTIJlgAXG65U8f1RRUKnN2+fHyGsoJrB3rd/pJc999xEl/ZNNgEMkHaj5SM3de87x5a\n StVQpa7cJrrlZi1mx+cC09HmM43XNxJ4x30DxgI34dsBKo4Ae3Wf4az2wjVtIv3rddHaPI\n Tp+fAwy1QX07+Nz6Yhjjid59gBkbgMs=",
        "X-MC-Unique": "8lOXDxZOOPenhsGjsLh9hg-1",
        "From": "David Marchand <david.marchand@redhat.com>",
        "To": "dev@dpdk.org",
        "Cc": "Eelco Chaudron <echaudro@redhat.com>,\n Maxime Coquelin <maxime.coquelin@redhat.com>,\n Chenbo Xia <chenbox@nvidia.com>",
        "Subject": "[PATCH v2 5/5] vhost: enhance virtqueue access lock asserts",
        "Date": "Tue,  5 Dec 2023 10:45:35 +0100",
        "Message-ID": "<20231205094536.2816720-5-david.marchand@redhat.com>",
        "In-Reply-To": "<20231205094536.2816720-1-david.marchand@redhat.com>",
        "References": "<20231023095520.2864868-1-david.marchand@redhat.com>\n <20231205094536.2816720-1-david.marchand@redhat.com>",
        "MIME-Version": "1.0",
        "X-Scanned-By": "MIMEDefang 3.4.1 on 10.11.54.3",
        "X-Mimecast-Spam-Score": "0",
        "X-Mimecast-Originator": "redhat.com",
        "Content-Transfer-Encoding": "8bit",
        "Content-Type": "text/plain; charset=\"US-ASCII\"; x-default=true",
        "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": "A simple comment in vhost_user_msg_handler() is not that robust.\n\nAdd a lock_all_qps property to message handlers so that their\nimplementation can add a build check and assert a vq is locked.\n\nSigned-off-by: David Marchand <david.marchand@redhat.com>\nAcked-by: Eelco Chaudron <echaudro@redhat.com>\nReviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>\n---\nChanges since v1:\n- moved this patch as the last of the series,\n\n---\n lib/vhost/vhost_user.c | 114 +++++++++++++++++++----------------------\n 1 file changed, 53 insertions(+), 61 deletions(-)",
    "diff": "diff --git a/lib/vhost/vhost_user.c b/lib/vhost/vhost_user.c\nindex 651ea5854b..e8020ccfd3 100644\n--- a/lib/vhost/vhost_user.c\n+++ b/lib/vhost/vhost_user.c\n@@ -56,14 +56,24 @@\n #define INFLIGHT_ALIGNMENT\t64\n #define INFLIGHT_VERSION\t0x1\n \n-typedef struct vhost_message_handler {\n+typedef const struct vhost_message_handler {\n \tconst char *description;\n \tint (*callback)(struct virtio_net **pdev, struct vhu_msg_context *ctx,\n \t\tint main_fd);\n \tbool accepts_fd;\n+\tbool lock_all_qps;\n } vhost_message_handler_t;\n static vhost_message_handler_t vhost_message_handlers[];\n \n+/* vhost_user_msg_handler() locks all qps based on a handler's lock_all_qps.\n+ * Later, a handler may need to ensure the vq has been locked (for example,\n+ * when calling lock annotated helpers).\n+ */\n+#define VHOST_USER_ASSERT_LOCK(dev, vq, id) do { \\\n+\tRTE_BUILD_BUG_ON(!vhost_message_handlers[id].lock_all_qps); \\\n+\tvq_assert_lock(dev, vq); \\\n+} while (0)\n+\n static int send_vhost_reply(struct virtio_net *dev, int sockfd, struct vhu_msg_context *ctx);\n static int read_vhost_message(struct virtio_net *dev, int sockfd, struct vhu_msg_context *ctx);\n \n@@ -400,7 +410,7 @@ vhost_user_set_features(struct virtio_net **pdev,\n \t\t\tcleanup_vq(vq, 1);\n \t\t\tcleanup_vq_inflight(dev, vq);\n \t\t\t/* vhost_user_lock_all_queue_pairs locked all qps */\n-\t\t\tvq_assert_lock(dev, vq);\n+\t\t\tVHOST_USER_ASSERT_LOCK(dev, vq, VHOST_USER_SET_FEATURES);\n \t\t\trte_rwlock_write_unlock(&vq->access_lock);\n \t\t\tfree_vq(dev, vq);\n \t\t}\n@@ -927,7 +937,7 @@ vhost_user_set_vring_addr(struct virtio_net **pdev,\n \tvq = dev->virtqueue[ctx->msg.payload.addr.index];\n \n \t/* vhost_user_lock_all_queue_pairs locked all qps */\n-\tvq_assert_lock(dev, vq);\n+\tVHOST_USER_ASSERT_LOCK(dev, vq, VHOST_USER_SET_VRING_ADDR);\n \n \taccess_ok = vq->access_ok;\n \n@@ -1442,7 +1452,7 @@ vhost_user_set_mem_table(struct virtio_net **pdev,\n \n \t\tif (vq->desc || vq->avail || vq->used) {\n \t\t\t/* vhost_user_lock_all_queue_pairs locked all qps */\n-\t\t\tvq_assert_lock(dev, vq);\n+\t\t\tVHOST_USER_ASSERT_LOCK(dev, vq, VHOST_USER_SET_MEM_TABLE);\n \n \t\t\t/*\n \t\t\t * If the memory table got updated, the ring addresses\n@@ -2234,7 +2244,7 @@ vhost_user_set_vring_enable(struct virtio_net **pdev,\n \tvq = dev->virtqueue[index];\n \tif (!(dev->flags & VIRTIO_DEV_VDPA_CONFIGURED)) {\n \t\t/* vhost_user_lock_all_queue_pairs locked all qps */\n-\t\tvq_assert_lock(dev, vq);\n+\t\tVHOST_USER_ASSERT_LOCK(dev, vq, VHOST_USER_SET_VRING_ENABLE);\n \t\tif (enable && vq->async && vq->async->pkts_inflight_n) {\n \t\t\tVHOST_LOG_CONFIG(dev->ifname, ERR,\n \t\t\t\t\"failed to enable vring. Inflight packets must be completed first\\n\");\n@@ -2839,41 +2849,43 @@ vhost_user_set_status(struct virtio_net **pdev,\n }\n \n #define VHOST_MESSAGE_HANDLERS \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_NONE, NULL, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_GET_FEATURES, vhost_user_get_features, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_FEATURES, vhost_user_set_features, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_OWNER, vhost_user_set_owner, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_RESET_OWNER, vhost_user_reset_owner, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_MEM_TABLE, vhost_user_set_mem_table, true) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_LOG_BASE, vhost_user_set_log_base, true) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_LOG_FD, vhost_user_set_log_fd, true) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_NUM, vhost_user_set_vring_num, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_ADDR, vhost_user_set_vring_addr, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_BASE, vhost_user_set_vring_base, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_GET_VRING_BASE, vhost_user_get_vring_base, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_KICK, vhost_user_set_vring_kick, true) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_CALL, vhost_user_set_vring_call, true) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_ERR, vhost_user_set_vring_err, true) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_GET_PROTOCOL_FEATURES, vhost_user_get_protocol_features, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_PROTOCOL_FEATURES, vhost_user_set_protocol_features, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_GET_QUEUE_NUM, vhost_user_get_queue_num, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_ENABLE, vhost_user_set_vring_enable, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SEND_RARP, vhost_user_send_rarp, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_NET_SET_MTU, vhost_user_net_set_mtu, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_BACKEND_REQ_FD, vhost_user_set_req_fd, true) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_IOTLB_MSG, vhost_user_iotlb_msg, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_GET_CONFIG, vhost_user_get_config, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_CONFIG, vhost_user_set_config, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_POSTCOPY_ADVISE, vhost_user_set_postcopy_advise, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_POSTCOPY_LISTEN, vhost_user_set_postcopy_listen, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_POSTCOPY_END, vhost_user_postcopy_end, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_GET_INFLIGHT_FD, vhost_user_get_inflight_fd, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_INFLIGHT_FD, vhost_user_set_inflight_fd, true) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_SET_STATUS, vhost_user_set_status, false) \\\n-VHOST_MESSAGE_HANDLER(VHOST_USER_GET_STATUS, vhost_user_get_status, false)\n-\n-#define VHOST_MESSAGE_HANDLER(id, handler, accepts_fd) \\\n-\t[id] = { #id, handler, accepts_fd },\n+VHOST_MESSAGE_HANDLER(VHOST_USER_NONE, NULL, false, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_GET_FEATURES, vhost_user_get_features, false, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_FEATURES, vhost_user_set_features, false, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_OWNER, vhost_user_set_owner, false, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_RESET_OWNER, vhost_user_reset_owner, false, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_MEM_TABLE, vhost_user_set_mem_table, true, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_LOG_BASE, vhost_user_set_log_base, true, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_LOG_FD, vhost_user_set_log_fd, true, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_NUM, vhost_user_set_vring_num, false, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_ADDR, vhost_user_set_vring_addr, false, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_BASE, vhost_user_set_vring_base, false, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_GET_VRING_BASE, vhost_user_get_vring_base, false, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_KICK, vhost_user_set_vring_kick, true, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_CALL, vhost_user_set_vring_call, true, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_ERR, vhost_user_set_vring_err, true, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_GET_PROTOCOL_FEATURES, vhost_user_get_protocol_features, \\\n+\tfalse, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_PROTOCOL_FEATURES, vhost_user_set_protocol_features, \\\n+\tfalse, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_GET_QUEUE_NUM, vhost_user_get_queue_num, false, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_ENABLE, vhost_user_set_vring_enable, false, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SEND_RARP, vhost_user_send_rarp, false, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_NET_SET_MTU, vhost_user_net_set_mtu, false, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_BACKEND_REQ_FD, vhost_user_set_req_fd, true, true) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_IOTLB_MSG, vhost_user_iotlb_msg, false, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_GET_CONFIG, vhost_user_get_config, false, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_CONFIG, vhost_user_set_config, false, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_POSTCOPY_ADVISE, vhost_user_set_postcopy_advise, false, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_POSTCOPY_LISTEN, vhost_user_set_postcopy_listen, false, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_POSTCOPY_END, vhost_user_postcopy_end, false, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_GET_INFLIGHT_FD, vhost_user_get_inflight_fd, false, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_INFLIGHT_FD, vhost_user_set_inflight_fd, true, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_SET_STATUS, vhost_user_set_status, false, false) \\\n+VHOST_MESSAGE_HANDLER(VHOST_USER_GET_STATUS, vhost_user_get_status, false, false)\n+\n+#define VHOST_MESSAGE_HANDLER(id, handler, accepts_fd, lock_all_qps) \\\n+\t[id] = { #id, handler, accepts_fd, lock_all_qps },\n static vhost_message_handler_t vhost_message_handlers[] = {\n \tVHOST_MESSAGE_HANDLERS\n };\n@@ -3141,31 +3153,11 @@ vhost_user_msg_handler(int vid, int fd)\n \t * inactive, so it is safe. Otherwise taking the access_lock\n \t * would cause a dead lock.\n \t */\n-\tswitch (request) {\n-\tcase VHOST_USER_SET_FEATURES:\n-\tcase VHOST_USER_SET_PROTOCOL_FEATURES:\n-\tcase VHOST_USER_SET_OWNER:\n-\tcase VHOST_USER_SET_MEM_TABLE:\n-\tcase VHOST_USER_SET_LOG_BASE:\n-\tcase VHOST_USER_SET_LOG_FD:\n-\tcase VHOST_USER_SET_VRING_NUM:\n-\tcase VHOST_USER_SET_VRING_ADDR:\n-\tcase VHOST_USER_SET_VRING_BASE:\n-\tcase VHOST_USER_SET_VRING_KICK:\n-\tcase VHOST_USER_SET_VRING_CALL:\n-\tcase VHOST_USER_SET_VRING_ERR:\n-\tcase VHOST_USER_SET_VRING_ENABLE:\n-\tcase VHOST_USER_SEND_RARP:\n-\tcase VHOST_USER_NET_SET_MTU:\n-\tcase VHOST_USER_SET_BACKEND_REQ_FD:\n+\tif (msg_handler->lock_all_qps) {\n \t\tif (!(dev->flags & VIRTIO_DEV_VDPA_CONFIGURED)) {\n \t\t\tvhost_user_lock_all_queue_pairs(dev);\n \t\t\tunlock_required = 1;\n \t\t}\n-\t\tbreak;\n-\tdefault:\n-\t\tbreak;\n-\n \t}\n \n \thandled = false;\n",
    "prefixes": [
        "v2",
        "5/5"
    ]
}