According to the C Standard, 76.4.2.1 .3 paragraph 7 [ISO/IEC 9899:20112024],
Some identifiers are reserved.
— All identifiers that begin with a double underscore (__) or All identifiers that begin with an underscore and either (_) followed by an uppercase letter or another underscore are always reserved for any use, except those identifiers which are lexically identical to keywords.
All — All identifiers that begin with an underscore are always reserved for use as identifiers with file scope in both the ordinary and tag name spaces.
Other identifiers may be reserved, see 7.1.3.
C Standard, 7.1.3 paragraph 1 [ISO/IEC 9899:2024],
Each header declares or defines all identifiers listed in its associated subclause, and optionally declares or defines identifiers listed in its associated future library directions subclause and identifiers which are always reserved either for any use or for use as file scope identifiers.
— All potentially reserved identifiers (including ones listed in the future library directions) that are provided by an implementation with an external definition are reserved for any use. An implementation shall not provide an external definition of a potentially reserved identifier unless that identifier is reserved for a use where it would have external linkage. All other potentially reserved identifiers that are provided by an implementation (including in the form of a macro) are reserved for any use when the associated header is included. No other potentially reserved identifiers are reserved.
— Each macro name in any of the following subclauses (including the future library directions) is reserved for use as specified if any of its associated headers is included, ; unless explicitly stated otherwise (see 7.1.4).
— All identifiers with external linkage in any of the following subclauses (including the future library directions) and
errno
are always reserved for use as identifiers with external linkage.— Each identifier with file scope listed in any of the following subclauses (including the future library directions) is reserved for use as a macro name and as an identifier with file scope in the same name space if any of its associated headers is included.
Additionally, subclause 7.
...
33 defines many other reserved identifiers for future library directions.
No other identifiers are reserved. (The POSIX standard extends the set of identifiers reserved by the C Standard to include an open-ended set of its own. See See Portable Operating System Interface [POSIX®], Base Specifications, Issue 7, Section 2.2, "The Compilation Environment" [IEEE Std 1003.1-2013].) The behavior of a program that declares or defines an identifier in a context in which it is reserved or that defines a reserved identifier as a macro name is undefined. (See undefined behavior 106.)
Noncompliant Code Example (
...
Include Guard)
A common, but noncompliant, practice is to choose a reserved name for a macro used in a preprocessor conditional guarding against multiple inclusions of a header file. (See also PRE06-C. Enclose header files in an inclusion include guard.) The name may clash with reserved names defined by the implementation of the C standard library in its headers or with reserved names implicitly predefined by the compiler even when no C standard library header is included.
Code Block | ||||
---|---|---|---|---|
| ||||
#ifndef _MY_HEADER_H_ #define _MY_HEADER_H_ /* Contents of <my_header.h> */ #endif /* _MY_HEADER_H_ */ |
Compliant Solution (
...
Include Guard)
This compliant solution avoids using leading underscores in the macro name of the header include guard:
Code Block | ||||
---|---|---|---|---|
| ||||
#ifndef MY_HEADER_H #define MY_HEADER_H /* Contents of <my_header.h> */ #endif /* MY_HEADER_H */ |
...
In this noncompliant code example, because the C standard library header <inttypes.h>
is specified to include <stdint.h>
, the name SIZE_MAX
conflicts with a standard macro of the same name, which is used to denote the upper limit of size_t
. In addition, although the name INTFAST16_LIMIT_MAX
is not defined by the C standard library, it is a reserved identifier because it begins with the INT
prefix and ends with the _MAX
suffix. (See the C Standard, 7.3133.1014.)
Code Block | ||||
---|---|---|---|---|
| ||||
#include <inttypes.h> #include <stdio.h> static const int_fast16_t INTFAST16_LIMIT_MAX = 12000; void print_fast16(int_fast16_t val) { enum { SIZE_MAX = 80 }; char buf[SIZE_MAX]; if (INTFAST16_LIMIT_MAX < val) { sprintf(buf, "The value is too large"); } else { snprintf(buf, SIZE_MAX, "The value is %" PRIdFAST16, val); } } |
...
Noncompliant Code Example (Identifiers with External Linkage)
...
(Identifiers with External Linkage)
This noncompliant example provides definitions for the C standard library functions malloc()
and free()
. Although this practice is permitted by many traditional implementations of UNIX (for example, the Dmalloc library), it is undefined behavior according to the C Standard. Even on systems that allow replacing malloc()
, doing so without also replacing aligned_alloc()
, calloc()
, and realloc()
is likely to cause problems.
...
Noncompliant Code Example (errno
)
In addition to symbols defined as functions in each C standard library header, identifiers with external linkage include errno
and math_errhandling
. According to the C Standard, 7.5, paragraph 2 [ISO/IEC 9899:2011], the behavior of a program is undefined when
...
Using reserved identifiers can lead to incorrect program operation.
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|
DCL37-C
Low
Unlikely
Low
P3
L3
Automated Detection
DCL37-C | Low | Unlikely | Low | P3 | L3 |
Automated Detection
Tool
Version
Checker
Description
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
Astrée |
| future-library-use language-override language-override-c99 reserved-declaration reserved-declaration-c99 reserved-identifier | Partially checked | ||||||
Axivion Bauhaus Suite |
| CertC-DCL37 | Fully implemented. Reserved identifiers, as in DCL37-C-EX3, are configurable. |
CodeSonar |
| LANG.STRUCT.DECL.RESERVED | Declaration of reserved name | ||||||
Compass/ROSE |
Coverity |
| MISRA C 2004 Rule 20.1 MISRA C 2004 Rule 20.2 MISRA C 2012 Rule 21. |
MISRA C 2012 Rule 21.2
1 MISRA C 2012 Rule 21.2 | Implemented | ||||||||
Cppcheck Premium |
| premium-cert-dcl37-c | Partially Implemented Can detect use of reserved name for a macro | ||||||
ECLAIR |
| CC2.DCL37 | Fully implemented | ||||||
Helix QAC |
| C0602, C0603, C4600, C4601, C4602, C4603, C4604, C4605, C4606, C4607, C4608, C4620, C4621, C4622, C4623, C4624, C4640, C4641, C4642, C4643, C4644, C4645 |
Fully implemented | ||||||||
Klocwork |
| MISRA.DEFINE.WRONGNAME.UNDERSCORE MISRA.STDLIB.WRONGNAME.UNDERSCORE MISRA.STDLIB.WRONGNAME |
Fully implemented | ||||||||
LDRA tool suite |
| 86 S, 218 S, 219 S, 580 S, 626 |
Fully Implemented
S | Fully Implemented | ||||||||
Parasoft C/C++test |
| CERT_C-DCL37-a | Do not #define or #undef identifiers with names which start with underscore | ||||||
PC-lint Plus |
| 978, 9071, 9093 | Partially supported |
Polyspace Bug Finder |
MISRA2012-RULE-21_2
4603, 4604, 4605, 4606,
4607, 4608
| Checks for:
Rule partially covered | |||||||
PVS-Studio |
| V677 |
SonarQube C/C++ Plugin |
| S978 |
RuleChecker |
|
|
|
future-library-use language-override language-override-c99 reserved-declaration reserved-declaration-c99 reserved-identifier |
Partially checked |
Related Guidelines
Key here (explains table format and definitions)
Taxonomy | Taxonomy item | Relationship |
---|---|---|
CERT C Secure Coding Standard | PRE00-C. Prefer inline or static functions |
to function-like macros | Prior to 2018-01-12: CERT: Unspecified Relationship |
CERT C Secure Coding Standard | PRE06-C. Enclose header files in an |
include guard | Prior to 2018-01-12: CERT: Unspecified Relationship |
CERT C Secure Coding Standard |
PRE31-C. Avoid side effects in arguments to unsafe macros |
Prior to 2018-01-12: CERT: Unspecified Relationship | |
CERT C | DCL51-CPP. Do not declare or |
define a reserved identifier | Prior to 2018-01-12: CERT: Unspecified Relationship | |
ISO/IEC TS 17961 | Using identifiers that are reserved for the implementation [resident] | Prior to 2018-01-12: CERT: Unspecified Relationship |
MISRA C:2012 | Rule 21.1 (required) | Prior to 2018-01-12: CERT: Unspecified Relationship |
MISRA C:2012 | Rule 21.2 (required) | Prior to 2018-01-12: CERT: Unspecified Relationship |
Bibliography
[IEEE Std 1003.1-2013] | Section 2.2, "The Compilation Environment" |
[ISO/IEC 9899: |
2024] | 7.1.3, "Reserved Identifiers" 7. |
33. |
14, "Integer Types |
...
...