2021-10-15 16:49:47

by Rasmus Villemoes

[permalink] [raw]
Subject: [PATCH] linux/container_of.h: switch to static_assert

_Static_assert() is evaluated already in the compiler's frontend, and
gives a somehat more to-the-point error, compared to the BUILD_BUG_ON
macro, which only fires after the optimizer has had a chance to
eliminate calls to functions marked with
__attribute__((error)). In theory, this might make builds a tiny bit
faster.

There's also a little less gunk in the error message emitted:

lib/sort.c: In function ‘foo’:
./include/linux/build_bug.h:78:41: error: static assertion failed: "pointer type mismatch in container_of()"
78 | #define __static_assert(expr, msg, ...) _Static_assert(expr, msg)

compared to

lib/sort.c: In function ‘foo’:
././include/linux/compiler_types.h:322:38: error: call to ‘__compiletime_assert_2’ declared with attribute error: pointer type mismatch in container_of()
322 | _compiletime_assert(condition, msg, __compiletime_assert_, __COUNTER__)

While at it, fix the copy-pasto in container_of_safe().

Signed-off-by: Rasmus Villemoes <[email protected]>
---
akpm: This is obviously on top of Andy's kernel.h splitup series, so
should go along with those if acked.

include/linux/container_of.h | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/include/linux/container_of.h b/include/linux/container_of.h
index dd56019838c6..2f4944b791b8 100644
--- a/include/linux/container_of.h
+++ b/include/linux/container_of.h
@@ -16,9 +16,9 @@
*/
#define container_of(ptr, type, member) ({ \
void *__mptr = (void *)(ptr); \
- BUILD_BUG_ON_MSG(!__same_type(*(ptr), ((type *)0)->member) && \
- !__same_type(*(ptr), void), \
- "pointer type mismatch in container_of()"); \
+ static_assert(__same_type(*(ptr), ((type *)0)->member) || \
+ __same_type(*(ptr), void), \
+ "pointer type mismatch in container_of()"); \
((type *)(__mptr - offsetof(type, member))); })

/**
@@ -31,9 +31,9 @@
*/
#define container_of_safe(ptr, type, member) ({ \
void *__mptr = (void *)(ptr); \
- BUILD_BUG_ON_MSG(!__same_type(*(ptr), ((type *)0)->member) && \
- !__same_type(*(ptr), void), \
- "pointer type mismatch in container_of()"); \
+ static_assert(__same_type(*(ptr), ((type *)0)->member) || \
+ __same_type(*(ptr), void), \
+ "pointer type mismatch in container_of_safe()"); \
IS_ERR_OR_NULL(__mptr) ? ERR_CAST(__mptr) : \
((type *)(__mptr - offsetof(type, member))); })

--
2.31.1


2021-10-15 18:29:04

by Andy Shevchenko

[permalink] [raw]
Subject: Re: [PATCH] linux/container_of.h: switch to static_assert

On Fri, Oct 15, 2021 at 11:05:30AM +0200, Rasmus Villemoes wrote:
> _Static_assert() is evaluated already in the compiler's frontend, and
> gives a somehat more to-the-point error, compared to the BUILD_BUG_ON
> macro, which only fires after the optimizer has had a chance to
> eliminate calls to functions marked with
> __attribute__((error)). In theory, this might make builds a tiny bit
> faster.
>
> There's also a little less gunk in the error message emitted:
>
> lib/sort.c: In function ‘foo’:
> ./include/linux/build_bug.h:78:41: error: static assertion failed: "pointer type mismatch in container_of()"
> 78 | #define __static_assert(expr, msg, ...) _Static_assert(expr, msg)
>
> compared to
>
> lib/sort.c: In function ‘foo’:
> ././include/linux/compiler_types.h:322:38: error: call to ‘__compiletime_assert_2’ declared with attribute error: pointer type mismatch in container_of()
> 322 | _compiletime_assert(condition, msg, __compiletime_assert_, __COUNTER__)
>
> While at it, fix the copy-pasto in container_of_safe().

Thanks, Rasmus!
Make sense to me.
Acked-by: Andy Shevchenko <[email protected]>

> Signed-off-by: Rasmus Villemoes <[email protected]>
> ---
> akpm: This is obviously on top of Andy's kernel.h splitup series, so
> should go along with those if acked.

Nevertheless, kbuild bot is not happy about bottom_half.h (_RET_IP_, _THIS_IP_
definitions). Do you have any idea what to do the best? (I think those macros
deserve a separate header as well).

--
With Best Regards,
Andy Shevchenko


2021-10-15 18:29:05

by Andy Shevchenko

[permalink] [raw]
Subject: Re: [PATCH] linux/container_of.h: switch to static_assert

On Fri, Oct 15, 2021 at 04:11:01PM +0300, Andy Shevchenko wrote:
> On Fri, Oct 15, 2021 at 11:05:30AM +0200, Rasmus Villemoes wrote:
> > _Static_assert() is evaluated already in the compiler's frontend, and
> > gives a somehat more to-the-point error, compared to the BUILD_BUG_ON
> > macro, which only fires after the optimizer has had a chance to
> > eliminate calls to functions marked with
> > __attribute__((error)). In theory, this might make builds a tiny bit
> > faster.
> >
> > There's also a little less gunk in the error message emitted:
> >
> > lib/sort.c: In function ‘foo’:
> > ./include/linux/build_bug.h:78:41: error: static assertion failed: "pointer type mismatch in container_of()"
> > 78 | #define __static_assert(expr, msg, ...) _Static_assert(expr, msg)
> >
> > compared to
> >
> > lib/sort.c: In function ‘foo’:
> > ././include/linux/compiler_types.h:322:38: error: call to ‘__compiletime_assert_2’ declared with attribute error: pointer type mismatch in container_of()
> > 322 | _compiletime_assert(condition, msg, __compiletime_assert_, __COUNTER__)
> >
> > While at it, fix the copy-pasto in container_of_safe().
>
> Thanks, Rasmus!
> Make sense to me.

Btw, shouldn't we also remove build_bug.h in the container_of.h with this?
(Or if this goes first, do we still need bug.h?)

--
With Best Regards,
Andy Shevchenko


2021-10-15 21:32:16

by Rasmus Villemoes

[permalink] [raw]
Subject: Re: [PATCH] linux/container_of.h: switch to static_assert

On 15/10/2021 15.13, Andy Shevchenko wrote:

> Btw, shouldn't we also remove build_bug.h in the container_of.h with this?
> (Or if this goes first, do we still need bug.h?)
>

We absolutely need build_bug.h, as that is where static_assert is defined.

container_of.h doesn't include bug.h AFAICT, nor should it need to.

(We should still find a quiet place for __same_type and have
container_of include that header, but that's unrelated to this patch.)

Rasmus

2021-10-16 03:29:12

by Miguel Ojeda

[permalink] [raw]
Subject: Re: [PATCH] linux/container_of.h: switch to static_assert

On Fri, Oct 15, 2021 at 11:05 AM Rasmus Villemoes
<[email protected]> wrote:
>
> _Static_assert() is evaluated already in the compiler's frontend, and
> gives a somehat more to-the-point error, compared to the BUILD_BUG_ON
> macro, which only fires after the optimizer has had a chance to
> eliminate calls to functions marked with
> __attribute__((error)). In theory, this might make builds a tiny bit
> faster.

Thanks for this! Very much in favor!

Reviewed-by: Miguel Ojeda <[email protected]>

Perhaps Andrew may want to add a link to the related discussion
thread: https://lore.kernel.org/lkml/[email protected]/T/

Cheers,
Miguel

2021-10-17 14:33:52

by Nick Desaulniers

[permalink] [raw]
Subject: Re: [PATCH] linux/container_of.h: switch to static_assert

On Fri, Oct 15, 2021 at 2:05 AM Rasmus Villemoes
<[email protected]> wrote:
>
> _Static_assert() is evaluated already in the compiler's frontend, and
> gives a somehat more to-the-point error, compared to the BUILD_BUG_ON
> macro, which only fires after the optimizer has had a chance to
> eliminate calls to functions marked with
> __attribute__((error)). In theory, this might make builds a tiny bit
> faster.
>
> There's also a little less gunk in the error message emitted:
>
> lib/sort.c: In function ‘foo’:
> ./include/linux/build_bug.h:78:41: error: static assertion failed: "pointer type mismatch in container_of()"
> 78 | #define __static_assert(expr, msg, ...) _Static_assert(expr, msg)
>
> compared to
>
> lib/sort.c: In function ‘foo’:
> ././include/linux/compiler_types.h:322:38: error: call to ‘__compiletime_assert_2’ declared with attribute error: pointer type mismatch in container_of()
> 322 | _compiletime_assert(condition, msg, __compiletime_assert_, __COUNTER__)
>
> While at it, fix the copy-pasto in container_of_safe().
>
> Signed-off-by: Rasmus Villemoes <[email protected]>

Thanks for the patch!
Reviewed-by: Nick Desaulniers <[email protected]>

> ---
> akpm: This is obviously on top of Andy's kernel.h splitup series, so
> should go along with those if acked.
>
> include/linux/container_of.h | 12 ++++++------
> 1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/include/linux/container_of.h b/include/linux/container_of.h
> index dd56019838c6..2f4944b791b8 100644
> --- a/include/linux/container_of.h
> +++ b/include/linux/container_of.h
> @@ -16,9 +16,9 @@
> */
> #define container_of(ptr, type, member) ({ \
> void *__mptr = (void *)(ptr); \
> - BUILD_BUG_ON_MSG(!__same_type(*(ptr), ((type *)0)->member) && \
> - !__same_type(*(ptr), void), \
> - "pointer type mismatch in container_of()"); \
> + static_assert(__same_type(*(ptr), ((type *)0)->member) || \
> + __same_type(*(ptr), void), \
> + "pointer type mismatch in container_of()"); \
> ((type *)(__mptr - offsetof(type, member))); })
>
> /**
> @@ -31,9 +31,9 @@
> */
> #define container_of_safe(ptr, type, member) ({ \
> void *__mptr = (void *)(ptr); \
> - BUILD_BUG_ON_MSG(!__same_type(*(ptr), ((type *)0)->member) && \
> - !__same_type(*(ptr), void), \
> - "pointer type mismatch in container_of()"); \
> + static_assert(__same_type(*(ptr), ((type *)0)->member) || \
> + __same_type(*(ptr), void), \
> + "pointer type mismatch in container_of_safe()"); \
> IS_ERR_OR_NULL(__mptr) ? ERR_CAST(__mptr) : \
> ((type *)(__mptr - offsetof(type, member))); })
>
> --
> 2.31.1
>


--
Thanks,
~Nick Desaulniers