[PATCH] test: parenthesize assertion macro parameters

[Marat Khalili]

Hi, thanks for doing this! Please see some comments inline below.

> -----Original Message-----
> From: Weijun Pan <wpan3636 at gmail.com>
> Sent: Sunday 19 April 2026 17:48
> Cc: dev at dpdk.org; Weijun Pan <wpan36 at wisc.edu>
> Subject: [PATCH] test: parenthesize assertion macro parameters
> 
> Some test assertion macros use parameters directly in expressions,
> which can lead to unexpected evaluation due to operator precedence
> after macro substitution.
> 
> Fix this by parenthesizing macro parameters and the resulting
> expressions in rte_test.h and app/test/test.h.
> 
> Bugzilla ID: 1925
> 
> Signed-off-by: Weijun Pan <wpan36 at wisc.edu>
> ---
>  app/test/test.h            | 34 +++++++++++++++++-----------------
>  lib/eal/include/rte_test.h | 12 ++++++------
>  2 files changed, 23 insertions(+), 23 deletions(-)
> 
> diff --git a/app/test/test.h b/app/test/test.h
> index 1f12fc5397..b1174e4973 100644
> --- a/app/test/test.h
> +++ b/app/test/test.h
> @@ -34,7 +34,7 @@
> 
>  /* Compare two buffers (length in bytes) */
>  #define TEST_ASSERT_BUFFERS_ARE_EQUAL(a, b, len,  msg, ...) do {	\
> -	if (memcmp(a, b, len)) {                                        \
> +	if (memcmp((a), (b), (len))) {                                        \
>  		printf("TestCase %s() line %d failed: "              \
>  			msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
>  		TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
> @@ -44,21 +44,21 @@
> 
>  /* Compare two buffers with offset (length and offset in bytes) */
>  #define TEST_ASSERT_BUFFERS_ARE_EQUAL_OFFSET(a, b, len, off, msg, ...) do { \
> -	const uint8_t *_a_with_off = (const uint8_t *)a + off;              \
> -	const uint8_t *_b_with_off = (const uint8_t *)b + off;              \
> -	TEST_ASSERT_BUFFERS_ARE_EQUAL(_a_with_off, _b_with_off, len, msg);  \
> +	const uint8_t *_a_with_off = (const uint8_t *)(a) + (off);              \
> +	const uint8_t *_b_with_off = (const uint8_t *)(b) + (off);              \
> +	TEST_ASSERT_BUFFERS_ARE_EQUAL(_a_with_off, _b_with_off, (len), msg);  \

Probably needed a comment somewhere in the commit message or cover letter (part
after --- for a single commit) what the strategy was to help reviewers:
parenthesize all substitutions even in unambiguous places like surrounded by
commas (which is fine to me personally, finding places where parentheses are
not strictly necessary needs effort), but leave msg alone since it has to be a
string literal and parenthesizing it would break literal concatenation.

>  } while (0)
> 
>  /* Compare two buffers (length in bits) */
>  #define TEST_ASSERT_BUFFERS_ARE_EQUAL_BIT(a, b, len, msg, ...) do {	\
>  	uint8_t _last_byte_a, _last_byte_b;                       \
>  	uint8_t _last_byte_mask, _last_byte_bits;                  \
> -	TEST_ASSERT_BUFFERS_ARE_EQUAL(a, b, (len >> 3), msg);     \
> -	if (len % 8) {                                              \
> -		_last_byte_bits = len % 8;                   \
> +	TEST_ASSERT_BUFFERS_ARE_EQUAL((a), (b), ((len) >> 3), msg);     \
> +	if ((len) % 8) {                                              \
> +		_last_byte_bits = (len) % 8;                   \
>  		_last_byte_mask = ~((1 << (8 - _last_byte_bits)) - 1); \
> -		_last_byte_a = ((const uint8_t *)a)[len >> 3];            \
> -		_last_byte_b = ((const uint8_t *)b)[len >> 3];            \
> +		_last_byte_a = ((const uint8_t *)(a))[(len) >> 3];            \
> +		_last_byte_b = ((const uint8_t *)(b))[(len) >> 3];            \
>  		_last_byte_a &= _last_byte_mask;                     \
>  		_last_byte_b &= _last_byte_mask;                    \
>  		if (_last_byte_a != _last_byte_b) {                  \
> @@ -74,16 +74,16 @@
>  #define TEST_ASSERT_BUFFERS_ARE_EQUAL_BIT_OFFSET(a, b, len, off, msg, ...) do {	\
>  	uint8_t _first_byte_a, _first_byte_b;                                 \
>  	uint8_t _first_byte_mask, _first_byte_bits;                           \
> -	uint32_t _len_without_first_byte = (off % 8) ?                       \
> -				len - (8 - (off % 8)) :                       \
> -				len;                                          \
> -	uint32_t _off_in_bytes = (off % 8) ? (off >> 3) + 1 : (off >> 3);     \
> -	const uint8_t *_a_with_off = (const uint8_t *)a + _off_in_bytes;      \
> -	const uint8_t *_b_with_off = (const uint8_t *)b + _off_in_bytes;      \
> +	uint32_t _len_without_first_byte = ((off) % 8) ?                       \
> +				((len) - (8 - ((off) % 8))) :                       \
> +				(len);                                          \
> +	uint32_t _off_in_bytes = ((off) % 8) ? (((off) >> 3) + 1) : ((off) >> 3);     \
> +	const uint8_t *_a_with_off = (const uint8_t *)(a) + _off_in_bytes;      \
> +	const uint8_t *_b_with_off = (const uint8_t *)(b) + _off_in_bytes;      \
>  	TEST_ASSERT_BUFFERS_ARE_EQUAL_BIT(_a_with_off, _b_with_off,           \
>  				_len_without_first_byte, msg);                \
> -	if (off % 8) {                                                        \
> -		_first_byte_bits = 8 - (off % 8);                             \
> +	if ((off) % 8) {                                                        \
> +		_first_byte_bits = 8 - ((off) % 8);                             \
>  		_first_byte_mask = (1 << _first_byte_bits) - 1;               \
>  		_first_byte_a = *(_a_with_off - 1);                           \
>  		_first_byte_b = *(_b_with_off - 1);                           \
> diff --git a/lib/eal/include/rte_test.h b/lib/eal/include/rte_test.h
> index 62c8f165af..b73d4e75c2 100644
> --- a/lib/eal/include/rte_test.h
> +++ b/lib/eal/include/rte_test.h
> @@ -26,21 +26,21 @@
>  } while (0)
> 
>  #define RTE_TEST_ASSERT_EQUAL(a, b, msg, ...) \
> -	RTE_TEST_ASSERT(a == b, msg, ##__VA_ARGS__)
> +	RTE_TEST_ASSERT(((a) == (b)), msg, ##__VA_ARGS__)

Parenthesizing both arguments passed and arguments substituted is not strictly
necessary, although not technically wrong.

> 
>  #define RTE_TEST_ASSERT_NOT_EQUAL(a, b, msg, ...) \
> -	RTE_TEST_ASSERT(a != b, msg, ##__VA_ARGS__)
> +	RTE_TEST_ASSERT(((a) != (b)), msg, ##__VA_ARGS__)
> 
>  #define RTE_TEST_ASSERT_SUCCESS(val, msg, ...) \
> -	RTE_TEST_ASSERT(val == 0, msg, ##__VA_ARGS__)
> +	RTE_TEST_ASSERT(((val) == 0), msg, ##__VA_ARGS__)
> 
>  #define RTE_TEST_ASSERT_FAIL(val, msg, ...) \
> -	RTE_TEST_ASSERT(val != 0, msg, ##__VA_ARGS__)
> +	RTE_TEST_ASSERT(((val) != 0), msg, ##__VA_ARGS__)
> 
>  #define RTE_TEST_ASSERT_NULL(val, msg, ...) \
> -	RTE_TEST_ASSERT(val == NULL, msg, ##__VA_ARGS__)
> +	RTE_TEST_ASSERT(((val) == NULL), msg, ##__VA_ARGS__)
> 
>  #define RTE_TEST_ASSERT_NOT_NULL(val, msg, ...) \
> -	RTE_TEST_ASSERT(val != NULL, msg, ##__VA_ARGS__)
> +	RTE_TEST_ASSERT(((val) != NULL), msg, ##__VA_ARGS__)
> 
>  #endif /* _RTE_TEST_H_ */
> --
> 2.34.1

Patchwork has detected that your From email is different from your
Signed-off-by email. I believe this is a formal requirement that may prevent
your patch from getting merged. If you plan to send patches from your personal
email please add it as an alias to the .mailmap .

The patch is technically correct and would work, neither of my comments is a
blocker (although last one might be a blocker from maintainer), but given that
there are three of them maybe you would want to send a v2 to practice the
process. Don't forget --in-reply-to when sending it.