| Message ID | 20220606061209.335709-1-ammarfaizi2@gnuweeb.org (mailing list archive) |
|---|---|
| Headers | show |
| Series | Ensure io_uring data structure consistentcy in liburing | expand |
On 6/6/22 14:12, Ammar Faizi wrote: > > Hi, > > This is an RFC for liburing-2.3. > > ## Introduction: > This series adds compile time assertions for liburing. They are taken > from the io_uring source in the kernel tree. The point of this series > is to make sure the shared struct is consistent between the kernel > space and user space. > > > ## Implementation detail: > We use `static_assert()` macro from <assert.h> that can yield compile > error if the expression given to it evaluates to false. This way we > can create a `BUILD_BUG_ON()` macro that we usually use inside the > kernel. The assertions are placed inside a header file named > build_assert.h, this header is included via compile flag `-include` > when compiling the core liburing sources. > > > ## How to maintain this? > This is pretty much easy to maintain, we just need to sync the > `BUILD_BUG_ON()` macro calls that check the shared struct from > io_uring. See patch #5 for detail. > > Looks good to me, Acked-by: Hao Xu <howeyxu@tencent.com>
Hi, This is an RFC for liburing-2.3. ## Introduction: This series adds compile time assertions for liburing. They are taken from the io_uring source in the kernel tree. The point of this series is to make sure the shared struct is consistent between the kernel space and user space. ## Implementation detail: We use `static_assert()` macro from <assert.h> that can yield compile error if the expression given to it evaluates to false. This way we can create a `BUILD_BUG_ON()` macro that we usually use inside the kernel. The assertions are placed inside a header file named build_assert.h, this header is included via compile flag `-include` when compiling the core liburing sources. ## How to maintain this? This is pretty much easy to maintain, we just need to sync the `BUILD_BUG_ON()` macro calls that check the shared struct from io_uring. See patch #5 for detail. ## Patches summary: - Patch 1 is just a small code style cleanup. - Patch 2 is to add BUILD_BUG_ON() macro. - Patch 3 is to add sizeof_field() macro. - Patch 4 is to avoid macro redefinition warnings. - Patch 5 is the main part, it adds io_uring data structure assertions. Signed-off-by: Ammar Faizi <ammarfaizi2@gnuweeb.org> --- Ammar Faizi (5): lib: Don't indent in `#ifdef -> #define -> #endif` block lib: Add `BUILD_BUG_ON()` macro lib: Add `sizeof_field()` macro Avoid macro redefinition warnings Add io_uring data structure build assertion src/Makefile | 3 ++- src/build_assert.h | 57 ++++++++++++++++++++++++++++++++++++++++++++++ src/lib.h | 18 +++++++++++---- src/queue.c | 2 ++ src/register.c | 2 ++ src/setup.c | 2 ++ src/syscall.c | 2 ++ 7 files changed, 80 insertions(+), 6 deletions(-) create mode 100644 src/build_assert.h base-commit: 4633a2d0fe9bd1f3dbb5b6d2788a08a264803146