From patchwork Tue Feb 27 10:39:03 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Marchand X-Patchwork-Id: 137339 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: 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]) by inbox.dpdk.org (Postfix) with ESMTP id 5EF5343C07; Tue, 27 Feb 2024 11:39:16 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E35294027D; Tue, 27 Feb 2024 11:39:15 +0100 (CET) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mails.dpdk.org (Postfix) with ESMTP id 1198840150 for ; Tue, 27 Feb 2024 11:39:13 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1709030353; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=VYhLnBRG0IU/7O2WYtjsd3EO15zlBWESaKbd4lSHvkg=; b=Z6UTDJBAmCJDGSidlr++vu+QLZL97AHoYzh4gMpZi32+kTB4lVL2ZspMrWcR9omstFUQdk 4KZjQ4TUDqVMMp/2TC5MPGhXQe9LbHsTUNA1LONRFkiLuljUDt4YN5UIJqkpLYVLWF9rDu t8TQJdlX5REG2Y1e6leZskkkHujZzA8= Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-606-uWdC9G3-MNqjAanRXvu4oA-1; Tue, 27 Feb 2024 05:39:10 -0500 X-MC-Unique: uWdC9G3-MNqjAanRXvu4oA-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 1262E1C29EA8; Tue, 27 Feb 2024 10:39:10 +0000 (UTC) Received: from dmarchan.redhat.com (unknown [10.45.225.66]) by smtp.corp.redhat.com (Postfix) with ESMTP id BBCBEC01644; Tue, 27 Feb 2024 10:39:08 +0000 (UTC) From: David Marchand To: dev@dpdk.org Cc: echaudro@redhat.com, Maxime Coquelin , Chenbo Xia Subject: [PATCH v4] vhost: enhance virtqueue access lock asserts Date: Tue, 27 Feb 2024 11:39:03 +0100 Message-ID: <20240227103903.1338151-1-david.marchand@redhat.com> In-Reply-To: <20231205094536.2816720-5-david.marchand@redhat.com> References: <20231205094536.2816720-5-david.marchand@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.8 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org A simple comment in vhost_user_msg_handler() is not that robust. Add a lock_all_qps property to message handlers so that their implementation can add a build check and assert a vq is locked. Signed-off-by: David Marchand Reviewed-by: Maxime Coquelin Reviewed-by: Maxime Coquelin --- Changes since v3: - directly called static_assert() with improved message, Changes since v2: - dropped review tags, - following use of static_assert() in RTE_BUILD_BUG_ON, reworked build check by using enums (one enum is now defined per message type), - as the added enums must be defined early, moved the definitions of handlers at the top of the file, Changes since v1: - moved this patch as the last of the series, --- lib/vhost/vhost_user.c | 130 +++++++++++++++++++++-------------------- 1 file changed, 68 insertions(+), 62 deletions(-) diff --git a/lib/vhost/vhost_user.c b/lib/vhost/vhost_user.c index 3e8a87e517..3aba32c95a 100644 --- a/lib/vhost/vhost_user.c +++ b/lib/vhost/vhost_user.c @@ -19,6 +19,7 @@ * Do not assume received VhostUserMsg fields contain sensible values! */ +#include #include #include #include @@ -56,14 +57,73 @@ #define INFLIGHT_ALIGNMENT 64 #define INFLIGHT_VERSION 0x1 -typedef struct vhost_message_handler { +typedef const struct vhost_message_handler { const char *description; int (*callback)(struct virtio_net **pdev, struct vhu_msg_context *ctx, int main_fd); bool accepts_fd; + bool lock_all_qps; } vhost_message_handler_t; static vhost_message_handler_t vhost_message_handlers[]; +#define VHOST_MESSAGE_HANDLERS \ +VHOST_MESSAGE_HANDLER(VHOST_USER_NONE, NULL, false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_GET_FEATURES, vhost_user_get_features, false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_FEATURES, vhost_user_set_features, false, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_OWNER, vhost_user_set_owner, false, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_RESET_OWNER, vhost_user_reset_owner, false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_MEM_TABLE, vhost_user_set_mem_table, true, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_LOG_BASE, vhost_user_set_log_base, true, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_LOG_FD, vhost_user_set_log_fd, true, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_NUM, vhost_user_set_vring_num, false, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_ADDR, vhost_user_set_vring_addr, false, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_BASE, vhost_user_set_vring_base, false, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_GET_VRING_BASE, vhost_user_get_vring_base, false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_KICK, vhost_user_set_vring_kick, true, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_CALL, vhost_user_set_vring_call, true, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_ERR, vhost_user_set_vring_err, true, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_GET_PROTOCOL_FEATURES, vhost_user_get_protocol_features, \ + false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_PROTOCOL_FEATURES, vhost_user_set_protocol_features, \ + false, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_GET_QUEUE_NUM, vhost_user_get_queue_num, false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_ENABLE, vhost_user_set_vring_enable, false, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SEND_RARP, vhost_user_send_rarp, false, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_NET_SET_MTU, vhost_user_net_set_mtu, false, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_BACKEND_REQ_FD, vhost_user_set_req_fd, true, true) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_IOTLB_MSG, vhost_user_iotlb_msg, false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_GET_CONFIG, vhost_user_get_config, false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_CONFIG, vhost_user_set_config, false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_POSTCOPY_ADVISE, vhost_user_set_postcopy_advise, false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_POSTCOPY_LISTEN, vhost_user_set_postcopy_listen, false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_POSTCOPY_END, vhost_user_postcopy_end, false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_GET_INFLIGHT_FD, vhost_user_get_inflight_fd, false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_INFLIGHT_FD, vhost_user_set_inflight_fd, true, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_SET_STATUS, vhost_user_set_status, false, false) \ +VHOST_MESSAGE_HANDLER(VHOST_USER_GET_STATUS, vhost_user_get_status, false, false) + +#define VHOST_MESSAGE_HANDLER(id, handler, accepts_fd, lock_all_qps) \ + id ## _LOCK_ALL_QPS = lock_all_qps, +enum { + VHOST_MESSAGE_HANDLERS +}; +#undef VHOST_MESSAGE_HANDLER + +/* vhost_user_msg_handler() locks all qps based on a handler's lock_all_qps. + * Later, a handler may need to ensure the vq has been locked (for example, + * when calling lock annotated helpers). + * + * Note: unfortunately, static_assert() does not see an array content as a + * constant expression. Because of this, we can't simply check for + * vhost_user_msg_handler[].lock_all_qps. + * Instead, define an enum for each handler. + */ +#define VHOST_USER_ASSERT_LOCK(dev, vq, id) do { \ + static_assert(id ## _LOCK_ALL_QPS == true, \ + #id " handler is not declared as locking all queue pairs"); \ + vq_assert_lock(dev, vq); \ +} while (0) + static int send_vhost_reply(struct virtio_net *dev, int sockfd, struct vhu_msg_context *ctx); static int read_vhost_message(struct virtio_net *dev, int sockfd, struct vhu_msg_context *ctx); @@ -400,7 +460,7 @@ vhost_user_set_features(struct virtio_net **pdev, cleanup_vq(vq, 1); cleanup_vq_inflight(dev, vq); /* vhost_user_lock_all_queue_pairs locked all qps */ - vq_assert_lock(dev, vq); + VHOST_USER_ASSERT_LOCK(dev, vq, VHOST_USER_SET_FEATURES); rte_rwlock_write_unlock(&vq->access_lock); free_vq(dev, vq); } @@ -927,7 +987,7 @@ vhost_user_set_vring_addr(struct virtio_net **pdev, vq = dev->virtqueue[ctx->msg.payload.addr.index]; /* vhost_user_lock_all_queue_pairs locked all qps */ - vq_assert_lock(dev, vq); + VHOST_USER_ASSERT_LOCK(dev, vq, VHOST_USER_SET_VRING_ADDR); access_ok = vq->access_ok; @@ -1442,7 +1502,7 @@ vhost_user_set_mem_table(struct virtio_net **pdev, if (vq->desc || vq->avail || vq->used) { /* vhost_user_lock_all_queue_pairs locked all qps */ - vq_assert_lock(dev, vq); + VHOST_USER_ASSERT_LOCK(dev, vq, VHOST_USER_SET_MEM_TABLE); /* * If the memory table got updated, the ring addresses @@ -2234,7 +2294,7 @@ vhost_user_set_vring_enable(struct virtio_net **pdev, vq = dev->virtqueue[index]; if (!(dev->flags & VIRTIO_DEV_VDPA_CONFIGURED)) { /* vhost_user_lock_all_queue_pairs locked all qps */ - vq_assert_lock(dev, vq); + VHOST_USER_ASSERT_LOCK(dev, vq, VHOST_USER_SET_VRING_ENABLE); if (enable && vq->async && vq->async->pkts_inflight_n) { VHOST_CONFIG_LOG(dev->ifname, ERR, "failed to enable vring. Inflight packets must be completed first"); @@ -2838,42 +2898,8 @@ vhost_user_set_status(struct virtio_net **pdev, return RTE_VHOST_MSG_RESULT_OK; } -#define VHOST_MESSAGE_HANDLERS \ -VHOST_MESSAGE_HANDLER(VHOST_USER_NONE, NULL, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_GET_FEATURES, vhost_user_get_features, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_FEATURES, vhost_user_set_features, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_OWNER, vhost_user_set_owner, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_RESET_OWNER, vhost_user_reset_owner, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_MEM_TABLE, vhost_user_set_mem_table, true) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_LOG_BASE, vhost_user_set_log_base, true) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_LOG_FD, vhost_user_set_log_fd, true) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_NUM, vhost_user_set_vring_num, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_ADDR, vhost_user_set_vring_addr, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_BASE, vhost_user_set_vring_base, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_GET_VRING_BASE, vhost_user_get_vring_base, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_KICK, vhost_user_set_vring_kick, true) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_CALL, vhost_user_set_vring_call, true) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_ERR, vhost_user_set_vring_err, true) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_GET_PROTOCOL_FEATURES, vhost_user_get_protocol_features, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_PROTOCOL_FEATURES, vhost_user_set_protocol_features, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_GET_QUEUE_NUM, vhost_user_get_queue_num, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_VRING_ENABLE, vhost_user_set_vring_enable, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SEND_RARP, vhost_user_send_rarp, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_NET_SET_MTU, vhost_user_net_set_mtu, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_BACKEND_REQ_FD, vhost_user_set_req_fd, true) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_IOTLB_MSG, vhost_user_iotlb_msg, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_GET_CONFIG, vhost_user_get_config, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_CONFIG, vhost_user_set_config, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_POSTCOPY_ADVISE, vhost_user_set_postcopy_advise, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_POSTCOPY_LISTEN, vhost_user_set_postcopy_listen, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_POSTCOPY_END, vhost_user_postcopy_end, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_GET_INFLIGHT_FD, vhost_user_get_inflight_fd, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_INFLIGHT_FD, vhost_user_set_inflight_fd, true) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_SET_STATUS, vhost_user_set_status, false) \ -VHOST_MESSAGE_HANDLER(VHOST_USER_GET_STATUS, vhost_user_get_status, false) - -#define VHOST_MESSAGE_HANDLER(id, handler, accepts_fd) \ - [id] = { #id, handler, accepts_fd }, +#define VHOST_MESSAGE_HANDLER(id, handler, accepts_fd, lock_all_qps) \ + [id] = { #id, handler, accepts_fd, id ## _LOCK_ALL_QPS }, static vhost_message_handler_t vhost_message_handlers[] = { VHOST_MESSAGE_HANDLERS }; @@ -3141,31 +3167,11 @@ vhost_user_msg_handler(int vid, int fd) * inactive, so it is safe. Otherwise taking the access_lock * would cause a dead lock. */ - switch (request) { - case VHOST_USER_SET_FEATURES: - case VHOST_USER_SET_PROTOCOL_FEATURES: - case VHOST_USER_SET_OWNER: - case VHOST_USER_SET_MEM_TABLE: - case VHOST_USER_SET_LOG_BASE: - case VHOST_USER_SET_LOG_FD: - case VHOST_USER_SET_VRING_NUM: - case VHOST_USER_SET_VRING_ADDR: - case VHOST_USER_SET_VRING_BASE: - case VHOST_USER_SET_VRING_KICK: - case VHOST_USER_SET_VRING_CALL: - case VHOST_USER_SET_VRING_ERR: - case VHOST_USER_SET_VRING_ENABLE: - case VHOST_USER_SEND_RARP: - case VHOST_USER_NET_SET_MTU: - case VHOST_USER_SET_BACKEND_REQ_FD: + if (msg_handler->lock_all_qps) { if (!(dev->flags & VIRTIO_DEV_VDPA_CONFIGURED)) { vhost_user_lock_all_queue_pairs(dev); unlock_required = 1; } - break; - default: - break; - } handled = false;