Page History

Wiki MarkupParenthesize all variable parameter names in macro definitions. See also \[[PRE02|PRE02-A. Macro expansion must always be parenthesized]\].

...

also PRE00-C. Prefer inline or static functions to function-like macros and PRE02-C. Macro replacement lists should be parenthesized.

Noncompliant Code Example

This CUBE() macro definition is non-compliant noncompliant because it fails to parenthesize the variable parameter names.:

#define CUBE(I) (I * I * I)
int a = 81 / CUBE(2 + 1);

As a result, the invocation

int a = 81 / CUBE(2 + 1);

expands to

int a = 81 / (2 + 1 * 2 + 1 * 2 + 1);  /* evaluatesEvaluates to 11 */

while which is clearly not the desired behavior is

int a = 81 / ( (2 + 1) * (2 + 1) * (2 + 1)); /* evaluates to 3 */

result.

Compliant Solution

Parenthesizing all variable parameter names in the CUBE() macro allows it to expand correctly (when invoked in this manner).:

#define CUBE(I) ( (I) * (I) * (I) )
int a = 81 / CUBE(2 + 1);

However, if a parameter appears several times in the expansion, the macro may not work properly if the actual argument is an expression with side effects. Given the CUBE() macro above, the invocation

int a = 81 / CUBE(i++);
{code:bgColor=#ccccff}
expands to

int a = 81 / (i++ * i++ * i++);

...

Exceptions

PRE01-C-EX1: When the parameter names are surrounded by commas in the replacement text, regardless of how complicated the actual arguments are, there is no need for parenthesizing the macro parameters. Because commas have lower precedence than any other operator, there is no chance of the actual arguments being parsed in a surprising way. Comma separators, which separate arguments in a function call, also have lower precedence than other operators, although they are technically different from comma operators.

#define FOO(a, b, c) bar(a, b, c)
/* ... */
FOO(arg1, arg2, arg3);

PRE01-C-EX2: Macro parameters cannot be individually parenthesized when concatenating tokens using the ## operator, converting macro parameters to strings using the # operator, or concatenating adjacent string literals. The following JOIN() macro concatenates both arguments to form a new token. The SHOW() macro converts the single argument into a string literal, which is then passed as a parameter to printf() and as a string and as a parameter to the %d specifier. For example, if SHOW() is invoked as SHOW(66);, the macro would be expanded to printf("66" " = %d\n", 66);.

#define JOIN(a, b) (a ## b)
#define SHOW(a) printf(#a " = %d\n", a)

See PRE05-C. Understand macro replacement when concatenating tokens or performing stringification for more information on using the ## operator to concatenate tokens.

Risk Assessment

Failing to parenthesize the parameter names in a macro can result in unintended program behavior.

which is undefined (see \[[EXP30|EXP30-C. Do not depend on order of evaluation between sequence points]\]).

Risk Assessment

References

Automated Detection

Related Vulnerabilities

Search for vulnerabilities resulting from the violation of this rule on the CERT website.

Related Guidelines

Bibliography

...

Image Added Image Added Image Added Wiki Markup\[[Summit 05|AA. C References#Summit 05]] Question 10.1 \[[ISO/IEC 9899-1999|AA. C References#ISO/IEC 9899-1999]] Section 6.10 Preprocessing directives, Section 5.1.1 Translation environment