Introduce and use static_assert_unreachable()
cover Introduce and use static_assert_unreachable()
Introduce macro static_assert_unreachable(), use it to replace __{get,put}_user_bad() and update ECLAIR configuration to allow the use of such macro at the end of switch-caluses.
Federico Serafini (3):
xen: introduce static_assert_unreachable() x86/uaccess: replace __{get,put}_user_bad() with
static_assert_unreachable()
automation/eclair: add deviation for MISRA C:2012 Rule 16.3
automation/eclair_analysis/ECLAIR/deviations.ecl | 4 ++++ docs/misra/deviations.rst | 4 ++++ xen/arch/x86/include/asm/uaccess.h | 7 ++----- xen/include/xen/compiler.h | 8 ++++++++ 4 files changed, 18 insertions(+), 5 deletions(-)
Signature · 1 line
2.34.1
PATCH 2/3 x86/uaccess: replace __{get,put}_user_bad() with static_assert_unreachable()
Use static_assert_unreachable() to improve readability and anticipate the build failure (from a linker error to an assembler error) in case of wrong size.
--- xen/arch/x86/include/asm/uaccess.h | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-)
xen/arch/x86/include/asm/uaccess.h +2 -5
@@ -21,9 +21,6 @@ unsigned int copy_from_guest_ll(void *to, const void __user *from, unsigned intunsigned int copy_to_unsafe_ll (void *to,const void *from,unsigned int n);unsigned int copy_from_unsafe_ll (void *to,const void *from,unsigned int n); -extern long __get_user_bad (void ); -extern void __put_user_bad (void ); - #define UA_KEEP(args...) args #define UA_DROP(args...)
@@ -208,7 +205,7 @@ do { \case 8 : \put_unsafe_asm (x, ptr, grd, retval,"q" ,"" ,"ir" , errret); \break ; \ -default :__put_user_bad (); \ +default :static_assert_unreachable (); \ } \clac (); \ }while ( false )
@@ -227,7 +224,7 @@ do { \case 2 :get_unsafe_asm (x, ptr, grd, retval,"w" ,"=r" , errret);break ; \case 4 :get_unsafe_asm (x, ptr, grd, retval,"k" ,"=r" , errret);break ; \case 8 :get_unsafe_asm (x, ptr, grd, retval,"" ,"=r" , errret);break ; \ -default :__get_user_bad (); \ +default :static_assert_unreachable (); \ } \clac (); \ }while ( false )
Signature · 1 line
2.34.1
PATCH 1/3 xen: introduce static_assert_unreachable()
In reply to Federico SerafiniIntroduce macro static_asser_unreachable() to check that a program point is considered unreachable by the static analysis performed by the compiler, even at optimization level -O0.
The use of such macro will lead to one of the following outcomes:
- the program point identified by the macro is considered unreachable, then the compiler removes the macro;
- the program point identified by the macro is not considered unreachable, then the compiler does not remove the macro, which will lead to a failure in the build process caused by an assembler error.
--- xen/include/xen/compiler.h | 8 ++++++++ 1 file changed, 8 insertions(+)
xen/include/xen/compiler.h +8 -0
@@ -64,6 +64,14 @@# define fallthrough do {} while (0)/* fallthrough */ #endif +/* +* Add the following macro to check that a program point is considered +* unreachable by the static analysis performed by the compiler, +* even at optimization level -O0. +*/ +#define static_assert_unreachable () \ + asm(".error \"unreachable program point reached\""); +#ifdef __clang__/* Clang can replace some vars with new automatic ones that go in .data; * mark all explicit-segment vars 'used' to prevent that. */
Signature · 1 line
2.34.1
PATCH 3/3 automation/eclair: add deviation for MISRA C:2012 Rule 16.3
In reply to Federico SerafiniUpdate ECLAIR configuration to consider safe switch clauses ending with static_assert_unreachable().
Update docs/misra/deviations.rst accordingly.
--- automation/eclair_analysis/ECLAIR/deviations.ecl | 4 ++++ docs/misra/deviations.rst | 4 ++++ 2 files changed, 8 insertions(+)
automation/eclair_analysis/ECLAIR/deviations.ecl +4 -0
@@ -368,6 +368,10 @@ safe." -config=MC3R1.R16.3,reports+={safe, "any_area(end_loc(any_exp(text(/BUG\\(\\);/))))"} -doc_end +-doc_begin="Switch clauses ending with failure method \"static_assert_unreachable()\" are safe." +-config=MC3R1.R16.3,reports+={safe, "any_area(end_loc(any_exp(text(/static_assert_unreachable\\(\\);/))))"} +-doc_end + -doc_begin="Switch clauses not ending with the break statement are safe if an explicit comment indicating the fallthrough intention is present." -config=MC3R1.R16.3,reports+={safe, "any_area(end_loc(any_exp(text(^(?s).*/\\* [fF]all ?through.? \\*/.*$,0..1))))"}
docs/misra/deviations.rst +4 -0
@@ -307,6 +307,10 @@ Deviations related to MISRA C:2012 Rules: - Switch clauses ending with failure method \"BUG()\" are safe. - Tagged as `safe` for ECLAIR. + * - R16.3 + - Switch clauses ending with macro static_assert_unreachable() are safe. + - Tagged as `safe` for ECLAIR. + * - R16.3 - Existing switch clauses not ending with the break statement are safe if an explicit comment indicating the fallthrough intention is present.
Signature · 1 line
2.34.1
Re: [XEN PATCH 1/3] xen: introduce static_assert_unreachable()
In reply to Federico SerafiniQuoted 3 lines · Federico Serafini
Introduce macro
static_asser_unreachable()to check that a program point is considered unreachable by the static analysis performed by the compiler, even at optimization level -O0.
Is it really intended to limit use of this macro to cases where even at -O0 the compiler would eliminate respective code? Note that right now even debug builds are done with some optimization, and some of the DCE we're relying depends on that (iirc).
xen/include/xen/compiler.h line 73
Quoted 13 lines
xen/include/xen/compiler.h +7
-0@@ -64,6 +64,14 @@# define fallthrough do {} while (0)/* fallthrough */ #endif +/* +* Add the following macro to check that a program point is considered +* unreachable by the static analysis performed by the compiler, +* even at optimization level -O0. +*/ +#define static_assert_unreachable () \ + asm(".error \"unreachable program point reached\"");
Did you check the diagnostic that results when this check actually triggers? I expect it will be not really obvious from the message you introduce where the issue actually is. I expect we will want to use some of __FILE__ / __LINE__ / __FUNCTION__ to actually supply such context.
Also: Stray semicolon and (nit) missing blanks.
Finally I wonder about case: We have ASSERT_UNREACHABLE() and it may be indicated to use all uppercase her as well.
Jan
Re: [XEN PATCH 1/3] xen: introduce static_assert_unreachable()
Quoted 9 lines · Jan Beulich
Quoted 3 lines · Federico Serafini
Introduce macro
static_asser_unreachable()to check that a program point is considered unreachable by the static analysis performed by the compiler, even at optimization level -O0.Is it really intended to limit use of this macro to cases where even at -O0 the compiler would eliminate respective code? Note that right now even debug builds are done with some optimization, and some of the DCE we're relying depends on that (iirc).
I'll remove this restriction.
Quoted 7 lines
Quoted 7 lines
xen/include/xen/compiler.h +0
-0@@ -64,6 +64,14 @@# define fallthrough do {} while (0)/* fallthrough */ #endif
Quoted 13 lines
xen/include/xen/compiler.h line 73
Quoted 7 lines
xen/include/xen/compiler.h +7
-0+/* +* Add the following macro to check that a program point is considered +* unreachable by the static analysis performed by the compiler, +* even at optimization level -O0. +*/ +#define static_assert_unreachable () \ + asm(".error \"unreachable program point reached\"");Did you check the diagnostic that results when this check actually triggers? I expect it will be not really obvious from the message you introduce where the issue actually is. I expect we will want to use some of
__FILE__/__LINE__/__FUNCTION__to actually supply such context.
The assembler error comes with file and line information, for example:
./arch/x86/include/asm/uaccess.h: Assembler messages:./arch/x86/include/asm/uaccess.h:377: Error: unreachable program point reached
At line 377 there is an use of get_unsafe_size() where I passed a wrong size as argument. Is that clear enough?
What do you think about modifying the message as follows:
"unreachability static assert failed."
Quoted 2 lines
Also: Stray semicolon and (nit) missing blanks.
It is not clear to me where are the missing blanks.
Quoted 3 lines
Finally I wonder about case: We have
ASSERT_UNREACHABLE()and it may be indicated to use all uppercase her as well.
Ok.
Signature · 3 lines
Federico Serafini, M.Sc. Software Engineer, BUGSENG (http://bugseng.com)
Re: [XEN PATCH 1/3] xen: introduce static_assert_unreachable()
Quoted 22 lines · Federico Serafini
Quoted 7 lines · Jan Beulich
Quoted 6 lines · Federico Serafini
xen/include/xen/compiler.h +0
-0@@ -64,6 +64,14 @@# define fallthrough do {} while (0)/* fallthrough */ #endif Quoted 13 lines
xen/include/xen/compiler.h line 73
Quoted 7 lines
xen/include/xen/compiler.h +7
-0+/* +* Add the following macro to check that a program point is considered +* unreachable by the static analysis performed by the compiler, +* even at optimization level -O0. +*/ +#define static_assert_unreachable () \ + asm(".error \"unreachable program point reached\"");Did you check the diagnostic that results when this check actually triggers? I expect it will be not really obvious from the message you introduce where the issue actually is. I expect we will want to use some of
__FILE__/__LINE__/__FUNCTION__to actually supply such context.
Quoted 8 lines
The assembler error comes with file and line information, for example:
./arch/x86/include/asm/uaccess.h: Assembler messages:./arch/x86/include/asm/uaccess.h:377: Error: unreachable program point reachedAt line 377 there is an use of
get_unsafe_size()where I passed a wrong size as argument. Is that clear enough?
Hmm, yes, looks like it might be sufficient. Mentioning __FUNCTION__ may still add value, though. But I see now that __FILE__ / __LINE__ are already covered for.
Quoted 2 lines
What do you think about modifying the message as follows:
"unreachability static assert failed."
I'm okay-ish with the original text, and I like it slightly better than this new suggestion. If we want "static assert" in the output, then maybe "static assertion failed: unreachable".
Quoted 3 lines
Quoted 1 line
Also: Stray semicolon and (nit) missing blanks.
It is not clear to me where are the missing blanks.
Just like for other keywords:
asm ( ".error \"unreachable program point reached\"" )
Jan