Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The arguments to a macro should not include preprocessor directives, such as #define, #ifdef, and #include. Doing so is undefined behavior, according to Section 6.10.3, Paragraph  para. 11, of the C99 C Standard [ISO/IEC 9899:19992011].

The sequence of preprocessing tokens bounded by the outside-most matching parentheses forms the list of arguments for the function-like macro. The individual arguments within the list are separated by comma preprocessing tokens, but comma preprocessing tokens between matching inner parentheses do not separate arguments. If there are sequences of preprocessing tokens within the list of arguments that would otherwise act as preprocessing directives, the behavior is undefined.

(See also undefined behavior 87behavior 93 of Annex J.)

The scope of this rule includes using preprocessor directives in arguments to a function where it is unknown whether or not the function is implemented using a macro. For example, standard library functions, such as memcpy(), printf(), and assert(), may be implemented as macros.

...

Code Block
bgColor#FFCCCC
langc

memcpy(dest, src,
#ifdef PLATFORM1
  12
#else
  24
#endif
);

...

Code Block
bgColor#ccccff
langc

#ifdef PLATFORM1
  memcpy(dest, src, 12);
#else
  memcpy(dest, src, 24);
#endif

...

Recommendation

Severity

Likelihood

Remediation Cost

Priority

Level

PRE32-C

low

unlikely

medium

P2

L3

Related Guidelines

ISO/IEC 9899:19992011 Section 6.10.3.1, "Argument substitution," paragraph 11

Bibliography

[GCC Bugs] "Non-bugs"

...