Versions Compared

Key

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

The arguments to a macro must not include preprocessor directives, such as #define, #ifdef, and #include. Doing so results in undefined behavior, according to the C Standard, 6.10.35,  paragraph paragraph 11 [ISO/IEC 9899:20112024]:

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.

...

This rule also applies to the use of preprocessor directives in arguments to a any function where it is unknown whether or not the function is implemented using a macro. For example, This includes all standard library functions, such as memcpy(), printf(), and assert(), because any standard library function may be implemented as macrosa macro. (C24, 7.1.4, paragraph 1).

Noncompliant Code Example

...

Code Block
bgColor#FFCCCC
langc
#include <string.h>
 
void func(const char *src) {
  /* Validate the source string; calculate size */
  char *dest;
  /* malloc() destination string */ 
  memcpy(dest, src,
    #ifdef PLATFORM1
      12
    #else
      24
    #endif
  );
  /* ... */
);}

Compliant Solution

In this compliant solution [GCC Bugs], the appropriate call to memcpy() is determined outside the function call:

...

Including preprocessor directives in macro arguments is undefined behavior.

Rule

Severity

Likelihood

Remediation Cost

Priority

Level

PRE32-C

Low

Unlikely

Medium

P2

L3

Automated Detection

Tool

Version

Checker

Description

Astrée
Include Page
Astrée_V
Astrée_V
macro-argument-hashFully checked
Axivion Bauhaus Suite

Include Page
Axivion Bauhaus Suite_V
Axivion Bauhaus Suite_V

CertC-PRE32Fully implemented
CodeSonar
Include Page
CodeSonar_V
CodeSonar_V
LANG.PREPROC.MACROARGPreprocessing directives in macro argument

ECLAIR

Include Page
ECLAIR_V
ECLAIR_V

CC2.PRE32

Fully implemented

Helix QAC

Include Page
Helix QAC_V
Helix QAC_V

C0853

C++1072

Fully implemented
Klocwork

Include Page
Klocwork_V
Klocwork_V

MISRA.EXPANSION.DIRECTIVEFully implemented
LDRA tool suite
Include Page
LDRA_V
LDRA_V
341 S
Partially implementedPRQA QA-C Include PagePRQA QA-C_vPRQA QA-C_v853 
Fully implemented
Parasoft C/C++test

Include Page
Parasoft_V
Parasoft_V

CERT_C-PRE32-a
Arguments to a function-like macro shall not contain tokens that look like preprocessing directives
PC-lint Plus

Include Page
PC-lint Plus_V
PC-lint Plus_V

436, 9501

Fully supported

Polyspace Bug Finder

Include Page
Polyspace Bug Finder_V
Polyspace Bug Finder_V

CERT C: Rule PRE32-CChecks for preprocessor directive in macro argument (rule fully covered)
RuleChecker
Include Page
RuleChecker_V
RuleChecker_V
macro-argument-hashFully checked

Related Vulnerabilities

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

Bibliography

[GCC Bugs]"Non-bugs"
[ISO/IEC 9899:
2011
2024]6.10.
3
5, "Macro Replacement"

...


...

Image Modified Image Modified Image Modified