vhost: fix external message handlers
PATCH 1/1 vhost: fix external message handlers
Following a rework, external message handlers were receiving a pointer to a vhost_user message (as stated in the API), but lost the ability to interact with fds attached to the message.
Restore the original layout and put a build check and reminders.
Bugzilla ID: 953
---
This patch is untested, but sending quickly to get feedback from the reporter and comments from author and maintainers.
--- lib/vhost/vhost_user.c | 8 ++++---- lib/vhost/vhost_user.h | 7 +++++-- 2 files changed, 9 insertions(+), 6 deletions(-)
lib/vhost/vhost_user.c +4 -4
@@ -3023,8 +3023,8 @@ vhost_user_msg_handler(int vid, int fd) handled = false;if (dev->extern_ops.pre_msg_handle) { - ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);
@@ -3069,8 +3069,8 @@ vhost_user_msg_handler(int vid, int fd) skip_to_post_handle:if (ret !=RTE_VHOST_MSG_RESULT_ERR && dev->extern_ops.post_msg_handle) { - ret = (*dev->extern_ops.post_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.post_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);
lib/vhost/vhost_user.h +5 -2
@@ -152,10 +152,13 @@ typedef struct VhostUserMsg {/* Nothing should be added after the payload */ }__rte_packed VhostUserMsg; -struct vhu_msg_context { +/* Note: this structure and VhostUserMsg can't be changed carelessly as +* external message handlers rely on them. +*/ +__rte_packed struct vhu_msg_context { +VhostUserMsg msg;int fds[VHOST_MEMORY_MAX_NREGIONS ];int fd_num; -VhostUserMsg msg; };#define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
Signature · 1 line
2.23.0
Hi,
Quoted 55 lines · David Marchand
Following a rework, external message handlers were receiving a pointer to a
vhost_usermessage (as stated in the API), but lost the ability to interact with fds attached to the message.
Restore the original layout and put a build check and reminders.Bugzilla ID: 953
Fixes 5e0099dc709e ("vhost: remove payload size limitation")Signed-off-by David Marchand <[email protected]>---
This patch is untested, but sending quickly to get feedback from the reporter and comments from author and maintainers.--- lib/vhost/vhost_user.c | 8 ++++---- lib/vhost/vhost_user.h | 7 +++++-- 2 files changed, 9 insertions(+), 6 deletions(-)lib/vhost/vhost_user.c +4
-4@@ -3023,8 +3023,8 @@ vhost_user_msg_handler(int vid, int fd) handled = false;if (dev->extern_ops.pre_msg_handle) { - ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);@@ -3069,8 +3069,8 @@ vhost_user_msg_handler(int vid, int fd) skip_to_post_handle:if (ret !=RTE_VHOST_MSG_RESULT_ERR && dev->extern_ops.post_msg_handle) { - ret = (*dev->extern_ops.post_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.post_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);lib/vhost/vhost_user.h +1
-1@@ -152,10 +152,13 @@ typedef struct VhostUserMsg {/* Nothing should be added after the payload */ }__rte_packed VhostUserMsg; -struct vhu_msg_context { +/* Note: this structure and VhostUserMsg can't be changed carelessly as
lib/vhost/vhost_user.h typedef struct VhostUserMsg { · line 164
Quoted 10 lines
lib/vhost/vhost_user.h +4
-1+* external message handlers rely on them. +*/ +__rte_packed struct vhu_msg_context { +VhostUserMsg msg;int fds[VHOST_MEMORY_MAX_NREGIONS ];int fd_num; -VhostUserMsg msg; };#define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
We should revisit the callbacks prototype when we'll be allowed to break API, passing the message pointer as void * is definitely not a good idea.
In the mean time, I agree with your fix:
We may also add Reported-by tag when applying.
Thanks!
Maxime
Quoted 65 lines · Maxime Coquelin
Quoted 64 lines · David Marchand
Following a rework, external message handlers were receiving a pointer to a
vhost_usermessage (as stated in the API), but lost the ability to interact with fds attached to the message.
Restore the original layout and put a build check and reminders.Bugzilla ID: 953
Fixes 5e0099dc709e ("vhost: remove payload size limitation")Signed-off-by David Marchand <[email protected]>---
This patch is untested, but sending quickly to get feedback from the reporter and comments from author and maintainers.--- lib/vhost/vhost_user.c | 8 ++++---- lib/vhost/vhost_user.h | 7 +++++-- 2 files changed, 9 insertions(+), 6 deletions(-)lib/vhost/vhost_user.c +4
-4@@ -3023,8 +3023,8 @@ vhost_user_msg_handler(int vid, int fd) handled = false;if (dev->extern_ops.pre_msg_handle) { - ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);@@ -3069,8 +3069,8 @@ vhost_user_msg_handler(int vid, int fd) skip_to_post_handle:if (ret !=RTE_VHOST_MSG_RESULT_ERR && dev->extern_ops.post_msg_handle) { - ret = (*dev->extern_ops.post_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.post_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);lib/vhost/vhost_user.h +5
-2@@ -152,10 +152,13 @@ typedef struct VhostUserMsg {/* Nothing should be added after the payload */ }__rte_packed VhostUserMsg; -struct vhu_msg_context { +/* Note: this structure and VhostUserMsg can't be changed carelessly as +* external message handlers rely on them. +*/ +__rte_packed struct vhu_msg_context { +VhostUserMsg msg;int fds[VHOST_MEMORY_MAX_NREGIONS ];int fd_num; -VhostUserMsg msg; };
Quoted 5 lines
lib/vhost/vhost_user.h typedef struct VhostUserMsg { · line 164
Quoted 1 line
lib/vhost/vhost_user.h +0
-0#define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)We should revisit the callbacks prototype when we'll be allowed to break API, passing the message pointer as void * is definitely not a good idea.
Indeed.
Quoted 6 lines
In the mean time, I agree with your fix:
Reviewed-by Maxime Coquelin <[email protected]>We may also add Reported-by tag when applying.
There is an issue with clang, I'll send a v2.
Signature · 1 line
David Marchand
Quoted 76 lines · David Marchand
Quoted 65 lines · Maxime Coquelin
Quoted 64 lines · David Marchand
Following a rework, external message handlers were receiving a pointer to a
vhost_usermessage (as stated in the API), but lost the ability to interact with fds attached to the message.
Restore the original layout and put a build check and reminders.Bugzilla ID: 953
Fixes 5e0099dc709e ("vhost: remove payload size limitation")Signed-off-by David Marchand <[email protected]>---
This patch is untested, but sending quickly to get feedback from the reporter and comments from author and maintainers.--- lib/vhost/vhost_user.c | 8 ++++---- lib/vhost/vhost_user.h | 7 +++++-- 2 files changed, 9 insertions(+), 6 deletions(-)lib/vhost/vhost_user.c +4
-4@@ -3023,8 +3023,8 @@ vhost_user_msg_handler(int vid, int fd) handled = false;if (dev->extern_ops.pre_msg_handle) { - ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);@@ -3069,8 +3069,8 @@ vhost_user_msg_handler(int vid, int fd) skip_to_post_handle:if (ret !=RTE_VHOST_MSG_RESULT_ERR && dev->extern_ops.post_msg_handle) { - ret = (*dev->extern_ops.post_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.post_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);lib/vhost/vhost_user.h +5
-2@@ -152,10 +152,13 @@ typedef struct VhostUserMsg {/* Nothing should be added after the payload */ }__rte_packed VhostUserMsg; -struct vhu_msg_context { +/* Note: this structure and VhostUserMsg can't be changed carelessly as +* external message handlers rely on them. +*/ +__rte_packed struct vhu_msg_context { +VhostUserMsg msg;int fds[VHOST_MEMORY_MAX_NREGIONS ];int fd_num; -VhostUserMsg msg; };Quoted 5 lines
lib/vhost/vhost_user.h typedef struct VhostUserMsg { · line 164
Quoted 1 line
lib/vhost/vhost_user.h +0
-0#define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)We should revisit the callbacks prototype when we'll be allowed to break API, passing the message pointer as void * is definitely not a good idea.
Indeed.
Quoted 1 line
Quoted 8 lines
Quoted 5 lines
In the mean time, I agree with your fix:
Reviewed-by Maxime Coquelin <[email protected]>We may also add Reported-by tag when applying.
There is an issue with clang, I'll send a v2.
Ok.
Fan, can you have a try and confirm it fixes the issue on your side?
Thanks,
Maxime
PATCH v2 1/1 vhost: fix external message handlers
In reply to David MarchandFollowing a rework, external message handlers were receiving a pointer to a vhost_user message (as stated in the API), but lost the ability to interact with fds attached to the message.
Restore the original layout and put a build check and reminders.
Bugzilla ID: 953
---
Changes since v1:
- fixed build with clang,
--- lib/vhost/vhost_user.c | 8 ++++---- lib/vhost/vhost_user.h | 7 +++++-- 2 files changed, 9 insertions(+), 6 deletions(-)
lib/vhost/vhost_user.c +4 -4
@@ -3023,8 +3023,8 @@ vhost_user_msg_handler(int vid, int fd) handled = false;if (dev->extern_ops.pre_msg_handle) { - ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);
@@ -3069,8 +3069,8 @@ vhost_user_msg_handler(int vid, int fd) skip_to_post_handle:if (ret !=RTE_VHOST_MSG_RESULT_ERR && dev->extern_ops.post_msg_handle) { - ret = (*dev->extern_ops.post_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.post_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);
lib/vhost/vhost_user.h +5 -2
@@ -152,10 +152,13 @@ typedef struct VhostUserMsg {/* Nothing should be added after the payload */ }__rte_packed VhostUserMsg; -struct vhu_msg_context { +/* Note: this structure and VhostUserMsg can't be changed carelessly as +* external message handlers rely on them. +*/ +struct __rte_packed vhu_msg_context { +VhostUserMsg msg;int fds[VHOST_MEMORY_MAX_NREGIONS ];int fd_num; -VhostUserMsg msg; };#define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
Signature · 1 line
2.23.0
Quoted 55 lines · David Marchand
Following a rework, external message handlers were receiving a pointer to a
vhost_usermessage (as stated in the API), but lost the ability to interact with fds attached to the message.
Restore the original layout and put a build check and reminders.Bugzilla ID: 953
Fixes 5e0099dc709e ("vhost: remove payload size limitation")Reported-by Fan Zhang <[email protected]>Signed-off-by David Marchand <[email protected]>---
Changes since v1:
- fixed build with clang,--- lib/vhost/vhost_user.c | 8 ++++---- lib/vhost/vhost_user.h | 7 +++++-- 2 files changed, 9 insertions(+), 6 deletions(-)lib/vhost/vhost_user.c +4
-4@@ -3023,8 +3023,8 @@ vhost_user_msg_handler(int vid, int fd) handled = false;if (dev->extern_ops.pre_msg_handle) { - ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);@@ -3069,8 +3069,8 @@ vhost_user_msg_handler(int vid, int fd) skip_to_post_handle:if (ret !=RTE_VHOST_MSG_RESULT_ERR && dev->extern_ops.post_msg_handle) { - ret = (*dev->extern_ops.post_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.post_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);lib/vhost/vhost_user.h +1
-1@@ -152,10 +152,13 @@ typedef struct VhostUserMsg {/* Nothing should be added after the payload */ }__rte_packed VhostUserMsg; -struct vhu_msg_context { +/* Note: this structure and VhostUserMsg can't be changed carelessly as
lib/vhost/vhost_user.h typedef struct VhostUserMsg { · line 164
Quoted 10 lines
lib/vhost/vhost_user.h +4
-1+* external message handlers rely on them. +*/ +struct __rte_packed vhu_msg_context { +VhostUserMsg msg;int fds[VHOST_MEMORY_MAX_NREGIONS ];int fd_num; -VhostUserMsg msg; };#define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
Thanks,
Maxime
Hi everyone,
Quoted 8 lines
Following a rework, external message handlers were receiving a pointer to a
vhost_usermessage (as stated in the API), but lost the ability to interact with fds attached to the message.
Restore the original layout and put a build check and reminders.Bugzilla ID: 953
Fixes 5e0099dc709e ("vhost: remove payload size limitation")
Quoted 7 lines
Reported-by Fan Zhang <[email protected]>Signed-off-by David Marchand <[email protected]>---
Changes since v1:
- fixed build with clang,---
Quoted 67 lines · David Marchand
Following a rework, external message handlers were receiving a pointer to a
vhost_usermessage (as stated in the API), but lost the ability to interact with fds attached to the message.
Restore the original layout and put a build check and reminders.Bugzilla ID: 953
Fixes 5e0099dc709e ("vhost: remove payload size limitation")Reported-by Fan Zhang <[email protected]>Signed-off-by David Marchand <[email protected]>---
Changes since v1:
- fixed build with clang,--- lib/vhost/vhost_user.c | 8 ++++---- lib/vhost/vhost_user.h | 7 +++++-- 2 files changed, 9 insertions(+), 6 deletions(-)lib/vhost/vhost_user.c +4
-4@@ -3023,8 +3023,8 @@ vhost_user_msg_handler(int vid, int fd) handled = false;if (dev->extern_ops.pre_msg_handle) { - ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.pre_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);@@ -3069,8 +3069,8 @@ vhost_user_msg_handler(int vid, int fd) skip_to_post_handle:if (ret !=RTE_VHOST_MSG_RESULT_ERR && dev->extern_ops.post_msg_handle) { - ret = (*dev->extern_ops.post_msg_handle)(dev->vid, - (void *)&ctx.msg); +RTE_BUILD_BUG_ON (offsetof(struct vhu_msg_context , msg) !=0 ); + ret = (*dev->extern_ops.post_msg_handle)(dev->vid, &ctx);switch (ret) {case RTE_VHOST_MSG_RESULT_REPLY :send_vhost_reply (dev, fd, &ctx);lib/vhost/vhost_user.h +5
-3@@ -152,10 +152,13 @@ typedef struct VhostUserMsg {/* Nothing should be added after the payload */ }__rte_packed VhostUserMsg; -struct vhu_msg_context { +/* Note: this structure and VhostUserMsg can't be changed carelessly as +* external message handlers rely on them. +*/ +struct __rte_packed vhu_msg_context { +VhostUserMsg msg;int fds[VHOST_MEMORY_MAX_NREGIONS ];int fd_num; -VhostUserMsg msg; };#define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64) --
Quoted 2 lines
2.23.0
Sorry to have missed that test with virtio-crypto ; I'll create another thread to talk about the VhostUserMsg extension.
Thanks,
Christophe
David Marchand
Reviewed-by Maxime Coquelin Tested-by Jakub Poczatek Acked-by Jakub Poczatek Reviewed-by Christophe Fontaine on v2 1/1 AppliedQuoted 11 lines · David Marchand
Following a rework, external message handlers were receiving a pointer to a
vhost_usermessage (as stated in the API), but lost the ability to interact with fds attached to the message.
Restore the original layout and put a build check and reminders.Bugzilla ID: 953
Fixes 5e0099dc709e ("vhost: remove payload size limitation")Reported-by Fan Zhang <[email protected]>Signed-off-by David Marchand <[email protected]>
Applied, thanks.
Signature · 1 line
David Marchand