[PATCH v2] test: parenthesize assertion macro parameters

[Weijun Pan]

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.

This is a test macro robustness fix and does not fix a runtime issue
in DPDK, so no Fixes or stable tags are added.

Bugzilla ID: 1925

Signed-off-by: Weijun Pan <wpan3636 at gmail.com>

---
v2:
- Remove unnecessary parentheses surrounded by commas
- Keep parenthesize substitutions even in unambiguous places in rte_test.h
  to maintain coding style: parenthesize a condition
- Keep msg unparenthesized to preserve string literal concatenation
---
 app/test/test.h            | 30 +++++++++++++++---------------
 lib/eal/include/rte_test.h | 12 ++++++------
 2 files changed, 21 insertions(+), 21 deletions(-)

diff --git a/app/test/test.h b/app/test/test.h
index 1f12fc5397..e7539418a8 100644
--- a/app/test/test.h
+++ b/app/test/test.h
@@ -44,8 +44,8 @@
 
 /* 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;              \
+	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);  \
 } while (0)
 
@@ -53,12 +53,12 @@
 #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__)
 
 #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