common/sfc: replace out of bounds condition with static_assert
PATCH 1/1 common/sfc: replace out of bounds condition with static_assert
The sfc base code had its own definition of static assertions using the out of bound array access hack. Replace it with a static_assert like rte_common.h.
--- drivers/common/sfc_efx/base/efx.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/common/sfc_efx/base/efx.h +2 -2
@@ -17,8 +17,8 @@extern "C" {#endif -#define EFX_STATIC_ASSERT (_cond) \ - ((void)sizeof (char[(_cond) ? 1 : -1])) +#define EFX_STATIC_ASSERT (_cond) \ + do { static_assert((_cond), "assert failed" #_cond); } while (0)#define EFX_ARRAY_SIZE (_array) \ (sizeof (_array) / sizeof ((_array)[0]))
Signature · 1 line
2.43.0
Quoted 19 lines
From: Stephen Hemminger [mailto:[email protected]]
Sent: Thursday, 18 January 2024 21.18The sfc base code had its own definition of static assertions using the out of bound array access hack. Replace it with a
static_assertlikerte_common.h.Fixes f67e4719147d ("net/sfc/base: fix coding style")Signed-off-by Stephen Hemminger <[email protected]>--- drivers/common/sfc_efx/base/efx.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)drivers/common/sfc_efx/base/efx.h +0
-0
drivers/common/sfc_efx/base/efx.h line 21
Quoted 7 lines
drivers/common/sfc_efx/base/efx.h +2
-2@@ -17,8 +17,8 @@extern "C" {#endif -#define EFX_STATIC_ASSERT (_cond) \ - ((void)sizeof (char[(_cond) ? 1 : -1])) +#define EFX_STATIC_ASSERT (_cond) \ + do { static_assert((_cond), "assert failed" #_cond); } while (0)
This probably works for the DPDK project.
For other projects using the same file, it might also need "#include <assert.h>" (containing the static_assert convenience macro for C), and possibly your workaround for toolchain issues with missing C11 macro in FreeBSD. Maybe not in this file, but somewhere.
Andrew Rybchenko
Acked-byQuoted 29 lines · Morten Brørup
Quoted 19 lines
From: Stephen Hemminger [mailto:[email protected]]
Sent: Thursday, 18 January 2024 21.18The sfc base code had its own definition of static assertions using the out of bound array access hack. Replace it with a
static_assertlikerte_common.h.Fixes f67e4719147d ("net/sfc/base: fix coding style")Signed-off-by Stephen Hemminger <[email protected]>--- drivers/common/sfc_efx/base/efx.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)drivers/common/sfc_efx/base/efx.h +0
-0drivers/common/sfc_efx/base/efx.h line 21
Quoted 7 lines
drivers/common/sfc_efx/base/efx.h +2
-2@@ -17,8 +17,8 @@extern "C" {#endif -#define EFX_STATIC_ASSERT (_cond) \ - ((void)sizeof (char[(_cond) ? 1 : -1])) +#define EFX_STATIC_ASSERT (_cond) \ + do { static_assert((_cond), "assert failed" #_cond); } while (0)This probably works for the DPDK project.
Quoted 4 lines
For other projects using the same file, it might also need "#include <
assert.h>" (containing thestatic_assertconvenience macro for C), and possibly your workaround for toolchain issues with missing C11 macro in FreeBSD. Maybe not in this file, but somewhere.Acked-by Morten Brørup <[email protected]>
PATCH v2 1/1 common/sfc: replace out of bounds condition with static_assert
In reply to Stephen HemmingerThe sfc base code had its own definition of static assertions using the out of bound array access hack. Replace it with a static_assert like rte_common.h.
---
v2 - add assert.h to make sure it works in other environments
drivers/common/sfc_efx/base/efx.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
drivers/common/sfc_efx/base/efx.h +4 -2
@@ -7,6 +7,8 @@#ifndef _SYS_EFX_H#define _SYS_EFX_H +#include <assert.h> +#include "efx_annote.h" #include "efsys.h" #include "efx_types.h"
@@ -17,8 +19,8 @@extern "C" {#endif -#define EFX_STATIC_ASSERT (_cond) \ - ((void)sizeof (char[(_cond) ? 1 : -1])) +#define EFX_STATIC_ASSERT (_cond) \ + do { static_assert((_cond), "assert failed" #_cond); } while (0)#define EFX_ARRAY_SIZE (_array) \ (sizeof (_array) / sizeof ((_array)[0]))
Signature · 1 line
2.43.0
Quoted 11 lines
From: Stephen Hemminger [mailto:[email protected]]
Sent: Friday, 19 January 2024 23.14The sfc base code had its own definition of static assertions using the out of bound array access hack. Replace it with a
static_assertlikerte_common.h.Fixes f67e4719147d ("net/sfc/base: fix coding style")Signed-off-by Stephen Hemminger <[email protected]>Acked-by Morten Brørup <[email protected]>---
Quoted 27 lines · Stephen Hemminger
The sfc base code had its own definition of static assertions using the out of bound array access hack. Replace it with a
static_assertlikerte_common.h.Fixes f67e4719147d ("net/sfc/base: fix coding style")Signed-off-by Stephen Hemminger <[email protected]>Acked-by Morten Brørup <[email protected]>---
v2 - addassert.hto make sure it works in other environmentsdrivers/common/sfc_efx/base/efx.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)drivers/common/sfc_efx/base/efx.h +2
-0@@ -7,6 +7,8 @@#ifndef _SYS_EFX_H#define _SYS_EFX_H +#include <assert.h> +#include "efx_annote.h" #include "efsys.h" #include "efx_types.h"
drivers/common/sfc_efx/base/efx.h line 26
Quoted 10 lines
drivers/common/sfc_efx/base/efx.h +2
-2@@ -17,8 +19,8 @@extern "C" {#endif -#define EFX_STATIC_ASSERT (_cond) \ - ((void)sizeof (char[(_cond) ? 1 : -1])) +#define EFX_STATIC_ASSERT (_cond) \ + do { static_assert((_cond), "assert failed" #_cond); } while (0)#define EFX_ARRAY_SIZE (_array) \ (sizeof (_array) / sizeof ((_array)[0]))
Getting following build error with clang:
FAILED: drivers/common/sfc_efx/base/libsfc_base.a.p/ef10_filter.c.o
./drivers/common/sfc_efx/base/ef10_filter.c ../drivers/common/sfc_efx/base/ef10_filter.c:503:2: error: static_assert expression is not an integral constant expression
EFX_STATIC_ASSERT((EFX_FIELD_OFFSET(efx_filter_spec_t,efs_outer_vid) %
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ../drivers/common/sfc_efx/base/efx.h:23:21: note: expanded from macro 'EFX_STATIC_ASSERT'
do { static_assert((_cond), "assert failed" #_cond); } while (0)
^~~~~~~../drivers/common/sfc_efx/base/ef10_filter.c:503:21: note: cast that performs the conversions of a reinterpret_cast is not allowed in a constant expression
EFX_STATIC_ASSERT((EFX_FIELD_OFFSET(efx_filter_spec_t,efs_outer_vid) %
^
../drivers/common/sfc_efx/base/efx.h:29:3: note: expanded from macro
'EFX_FIELD_OFFSET'
((size_t)&(((_type *)0)->_field))
^../drivers/common/sfc_efx/base/ef10_filter.c:1246:18: error: shift count
Quoted 1 line
= width of type [-Werror,-Wshift-count-overflow]
matches_count = MCDI_OUT_DWORD(req,
^~~~~~~~~~~~~~~~~~~../drivers/common/sfc_efx/base/efx_mcdi.h:493:2: note: expanded from macro 'MCDI_OUT_DWORD'
EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst), \
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
../drivers/common/sfc_efx/base/efx_types.h:533:30: note: expanded from
macro 'EFX_DWORD_FIELD'
EFX_HIGH_BIT(_field)) & EFX_MASK32(_field))
^~~~~~~~~~~~~~~~~~
../drivers/common/sfc_efx/base/efx_types.h:145:23: note: expanded from
macro 'EFX_MASK32'
(((((uint32_t)1) << EFX_WIDTH(_field))) - 1))
^ ~~~~~~~~~~~~~~~~~2 errors generated.
Quoted 36 lines · On Wed, 7 Feb 2024 19:10:37 +0000 Ferruh Yigit <[email protected]> wrote:
Quoted 35 lines · Stephen Hemminger
The sfc base code had its own definition of static assertions using the out of bound array access hack. Replace it with a
static_assertlikerte_common.h.Fixes f67e4719147d ("net/sfc/base: fix coding style")Signed-off-by Stephen Hemminger <[email protected]>Acked-by Morten Brørup <[email protected]>---
v2 - addassert.hto make sure it works in other environmentsdrivers/common/sfc_efx/base/efx.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)drivers/common/sfc_efx/base/efx.h +4
-2@@ -7,6 +7,8 @@#ifndef _SYS_EFX_H#define _SYS_EFX_H +#include <assert.h> +#include "efx_annote.h" #include "efsys.h" #include "efx_types.h" @@ -17,8 +19,8 @@extern "C" {#endif -#define EFX_STATIC_ASSERT (_cond) \ - ((void)sizeof (char[(_cond) ? 1 : -1])) +#define EFX_STATIC_ASSERT (_cond) \ + do { static_assert((_cond), "assert failed" #_cond); } while (0)
Quoted 4 lines
drivers/common/sfc_efx/base/efx.h line 26
Quoted 2 lines
drivers/common/sfc_efx/base/efx.h +0
-0#define EFX_ARRAY_SIZE (_array) \ (sizeof (_array) / sizeof ((_array)[0]))Getting following build error with clang:
What version of clang?
It works for me with clang 16.0.6
Quoted 6 lines · On Wed, 7 Feb 2024 19:10:37 +0000 Ferruh Yigit <[email protected]> wrote:
../drivers/common/sfc_efx/base/ef10_filter.c:1246:18: error: shift countQuoted 1 line
= width of type [-Werror,-Wshift-count-overflow]
matches_count= MCDI_OUT_DWORD(req,
^~~~~~~~~~~~~~~~~~~../drivers/common/sfc_efx/base/efx_mcdi.h:493:2: note: expanded from macro 'MCDI_OUT_DWORD'
Quoted 9 lines
EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst), \
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
../drivers/common/sfc_efx/base/efx_types.h:533:30: note: expanded from
macro 'EFX_DWORD_FIELD'
EFX_HIGH_BIT(_field)) & EFX_MASK32(_field))
^~~~~~~~~~~~~~~~~~
../drivers/common/sfc_efx/base/efx_types.h:145:23: note: expanded from
macro 'EFX_MASK32'
(((((uint32_t)1) << EFX_WIDTH(_field))) - 1))None of this got changed by the patch. Looks like it would not compile even without the patch on your version of clang.
Quoted 19 lines · Stephen Hemminger
Quoted 6 lines · On Wed, 7 Feb 2024 19:10:37 +0000 Ferruh Yigit <[email protected]> wrote:
../drivers/common/sfc_efx/base/ef10_filter.c:1246:18: error: shift countQuoted 1 line
= width of type [-Werror,-Wshift-count-overflow]
matches_count= MCDI_OUT_DWORD(req,
^~~~~~~~~~~~~~~~~~~../drivers/common/sfc_efx/base/efx_mcdi.h:493:2: note: expanded from macro 'MCDI_OUT_DWORD'Quoted 9 lines
EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst), \ ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ../drivers/common/sfc_efx/base/efx_types.h:533:30: note: expanded from macro 'EFX_DWORD_FIELD' EFX_HIGH_BIT(_field)) & EFX_MASK32(_field)) ^~~~~~~~~~~~~~~~~~ ../drivers/common/sfc_efx/base/efx_types.h:145:23: note: expanded from macro 'EFX_MASK32' (((((uint32_t)1) << EFX_WIDTH(_field))) - 1))
Quoted 3 lines
None of this got changed by the patch. Looks like it would not compile even without the patch on your version of clang.
Nope, error only happens with the patch.
And CI seems reporting the errors:
https://mails.dpdk.org/archives/test-report/2024-January/558546.html
Quoted 20 lines · On Wed, 7 Feb 2024 23:30:07 +0000 Ferruh Yigit <[email protected]> wrote:
Quoted 19 lines · Stephen Hemminger
Quoted 15 lines · On Wed, 7 Feb 2024 19:10:37 +0000 Ferruh Yigit <[email protected]> wrote:
../drivers/common/sfc_efx/base/ef10_filter.c:1246:18: error: shift countQuoted 1 line
= width of type [-Werror,-Wshift-count-overflow]
matches_count= MCDI_OUT_DWORD(req,
^~~~~~~~~~~~~~~~~~~../drivers/common/sfc_efx/base/efx_mcdi.h:493:2: note: expanded from macro 'MCDI_OUT_DWORD'EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst), \ ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ../drivers/common/sfc_efx/base/efx_types.h:533:30: note: expanded from macro 'EFX_DWORD_FIELD' EFX_HIGH_BIT(_field)) & EFX_MASK32(_field)) ^~~~~~~~~~~~~~~~~~ ../drivers/common/sfc_efx/base/efx_types.h:145:23: note: expanded from macro 'EFX_MASK32' (((((uint32_t)1) << EFX_WIDTH(_field))) - 1))
Quoted 8 lines
Quoted 3 lines
None of this got changed by the patch. Looks like it would not compile even without the patch on your version of clang.
Nope, error only happens with the patch.
And CI seems reporting the errors:
https://mails.dpdk.org/archives/test-report/2024-January/558546.html
This patch is allowing compiler to see some things as constant which were hidden before. The driver is buggy, for example, look at this:
/*
* Stop lint complaining about some shifts.
*/
#ifdef __lint
extern int fix_lint;
#define FIX_LINT(_x) (_x + fix_lint)
#else
#define FIX_LINT(_x) (_x)
#endif
Looks like it is wallpapering over some errors.
PATCH 1/1 common/sfc: replace out of bounds condition with static_assert
In reply to Stephen HemmingerThe sfc base code had its own definition of static assertions using the out of bound array access hack. This method does not force the condition to be const and can have false negatives. Better to use static_assert() like other places in DPDK.
---
v3 - change the macro to workaround issues with older clang.
Compiles on Debian testing with Gcc and Clang.
drivers/common/sfc_efx/base/efx.h | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-)
drivers/common/sfc_efx/base/efx.h +10 -2
@@ -7,6 +7,8 @@#ifndef _SYS_EFX_H#define _SYS_EFX_H +#include <assert.h> +#include "efx_annote.h" #include "efsys.h" #include "efx_types.h"
@@ -17,8 +19,14 @@extern "C" {#endif -#define EFX_STATIC_ASSERT (_cond) \ - ((void)sizeof (char[(_cond) ? 1 : -1])) +/* +* Triggers an error at compilation time if the condition is false. +* +* The { } exists to workaround a bug in clang (#55821) +* where it would not handle _Static_assert in a switch case. +*/ +#define EFX_STATIC_ASSERT (_cond) \ + { static_assert((_cond), #_cond); }#define EFX_ARRAY_SIZE (_array) \ (sizeof (_array) / sizeof ((_array)[0]))
Signature · 1 line
2.43.0
PATCH v4 1/1 common/sfc: replace out of bounds condition with static_assert
In reply to Stephen HemmingerThe sfc base code had its own definition of static assertions using the out of bound array access hack. Replace it with a static_assert like rte_common.h.
The use of null pointer to compute offset is not always a constant in older versions of clang. Use standard offsetof() instead.
--- drivers/common/sfc_efx/base/efx.h | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-)
drivers/common/sfc_efx/base/efx.h +11 -3
@@ -7,6 +7,8 @@#ifndef _SYS_EFX_H#define _SYS_EFX_H +#include <assert.h> +#include "efx_annote.h" #include "efsys.h" #include "efx_types.h"
@@ -17,14 +19,20 @@extern "C" {#endif -#define EFX_STATIC_ASSERT (_cond) \ - ((void)sizeof (char[(_cond) ? 1 : -1])) +/* +* Triggers an error at compilation time if the condition is false. +* +* The { } exists to workaround a bug in clang (#55821) +* where it would not handle _Static_assert in a switch case. +*/ +#define EFX_STATIC_ASSERT (_cond) \ + { static_assert((_cond), #_cond); }#define EFX_ARRAY_SIZE (_array) \ (sizeof (_array) / sizeof ((_array)[0]))#define EFX_FIELD_OFFSET (_type, _field) \ - ((size_t)&(((_type *)0)->_field)) + offsetof(_type, _field)/* The macro expands divider twice */ #define EFX_DIV_ROUND_UP (_n, _d) (((_n) + (_d) - 1) / (_d))
Signature · 1 line
2.43.0
Quoted 4 lines · Stephen Hemminger
The sfc base code had its own definition of static assertions using the out of bound array access hack. Replace it with a
static_assertlikerte_common.h.
Quoted 9 lines
The use of null pointer to compute offset is not always a constant in older versions of clang. Use standard
offsetof()instead.Fixes f67e4719147d ("net/sfc/base: fix coding style")> Cc: [email protected]Signed-off-by Stephen Hemminger <[email protected]>Acked-by Morten Brørup <[email protected]>Reviewed-by Morten Brørup <[email protected]>
Looks good to me,
unless there is no objection from driver maintainers I will merge it.
Quoted 4 lines · Stephen Hemminger
The sfc base code had its own definition of static assertions using the out of bound array access hack. Replace it with a
static_assertlikerte_common.h.
Quoted 8 lines
The use of null pointer to compute offset is not always a constant in older versions of clang. Use standard
offsetof()instead.Fixes f67e4719147d ("net/sfc/base: fix coding style")Signed-off-by Stephen Hemminger <[email protected]>Acked-by Morten Brørup <[email protected]>Reviewed-by Morten Brørup <[email protected]>
Moving ack from previous version:
Applied to dpdk-next-net/main, thanks.