DCL32-CPP. Do not declare or define a reserved identifier

The C++ Standard [ISO/IEC 14882-2003], Section 17.4.3.1.2 specifies the following sets of reserved names:

• Each name that contains a double underscore __ or begins with an underscore followed by an uppercase letter is reserved to the implementation for any use.
• Each name that begins with an underscore is reserved to the implementation for use as a name in the global namespace.
• Each name declared as an object with external linkage in a header is reserved to the implementation to designate that library object with external linkage, both in namespace std and in the global namespace.
• Each global function signature declared with external linkage in a header is reserved to the implementation to designate that function signature with external linkage.
• Each name from the Standard C library declared with external linkage is reserved to the implementation for use as a name with extern "C" linkage, both in namespace std and in the global namespace.
• Each function signature from the Standard C library declared with external linkage is reserved to the implementation for use as a function signature with both extern "C" and extern "C++" linkage, or as a name of namespace scope in the global namespace.
• For each type T from the Standard C library, the types ::T and std::T are reserved to the implementation and, when defined, ::T shall be identical to std::T.
• A translation unit that includes a standard library header shall not #define or #undef names declared in any standard library header.

In addition, the C99 Standard [ISO/IEC 9899:1999], largely subsumed by C++, specifies in section 7.1.3 the following sets of reserved names:

• All identifiers that begin with an underscore and either an uppercase letter or another underscore are always reserved for any use.
• 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.
• Each macro name in any of the subclauses (including the future library directions) is reserved for use as specified if any of its associated headers is included, unless explicitly stated otherwise.
• All identifiers with external linkage(including future library directions) are always reserved for use as identifiers with external linkage.
• Each identifier with file scope listed in any of the above 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.

No other identifiers are reserved ^#1. The behavior of a program that declares or defines an identifier in a context in which it is reserved or defines a reserved identifier as a macro name, is undefined . Trying to define a reserved identifier can result in its name conflicting with that used in implementation, which may or may not be detected at compile time.

[1] Note that the POSIX ^® standard extends the set of identifiers reserved by C99 to include an open-ended set of its own. See section 2.2 Compilation Environment in [IEEE Std 1003.1-2008].

Noncompliant Code Example (Header Guard)

A common but noncompliant practice is to choose a reserved name for a macro used in a preprocessor conditional guarding against multiple inclusion of a header file. See also PRE06-CPP. Enclose header files in an inclusion 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. A typical manifestation of such a clash is a compilation error.

#ifndef _MY_HEADER_H_
#define _MY_HEADER_H_

// contents of <my_header.h>

#endif // _MY_HEADER_H_

Compliant Solution (Header Guard)

This compliant solution avoids using leading or trailing underscores in the name of the header guard.

#ifndef MY_HEADER_H
#define MY_HEADER_H

// contents of <my_header.h>

#endif // MY_HEADER_H

Noncompliant Code Example (File Scope Objects)

In this noncompliant code example, the names of the file scope objects _max_limit and _limit both begin with an underscore. Since it is static, the declaration of _max_limit might seem to be impervious to clashes with names defined by the implementation. However, because the header <stddef.h> is included to define size_t a potential for a name clash exists (note, however, that a conforming compiler may implicitly declare reserved names regardless of whether or not any C standard library header has been explicitly included). In addition, because _limit has external linkage, it may clash with a symbol with the same name defined in the language runtime library even if such a symbol is not declared in any header. Consequently, it is unsafe to start the name of any file scope identifier with an underscore, even if its linkage limits its visibility to a single translation unit. Common effects of such clashes range from compiler errors, to linker errors, to abnormal program behavior at runtime.

#include <cstddef>   // for size_t

static const std::size_t _max_limit = 1024;
std::size_t _limit = 100;

unsigned int getValue(unsigned int count) {
  return count < _limit ? count : _limit;
}

Compliant Solution (File Scope Objects)

In this compliant solution, names of no file scope objects begin with an underscore and, hence, do not encroach on the reserved name space.

#include <cstddef>   // for size_t

static const std::size_t max_limit = 1024;
std::size_t limit = 100;

unsigned int getValue(unsigned int count) {
  return count < limit ? count : limit;
}

Noncompliant Code Example (Reserved Macros)

In the noncompliant code example below, because the C standard library header <inttypes.h> is specified to include <stdint.h>, the name MAX_SIZE conflicts with the name of the <stdint.h> header macro used to denote the upper limit of size_t. In addition, while the name INTFAST16_LIMIT_MAX isn't defined by the C standard library, because it begins with the INT prefix and ends with the _MAX suffix it encroaches on the reserved name space (see section 8.26.8 of C99). A typical manifestation of such a clash is a compilation error.

#include <inttypes.h>   // for int_fast16_t and PRIdFAST16

static const int_fast16_t INTFAST16_LIMIT_MAX = 12000;

void print_fast16(int_fast16_t val) {
    enum { MAX_SIZE = 80 };
    char buf [MAX_SIZE];
    if (INTFAST16_LIMIT_MAX < val)
      std::sprintf(buf, "The value is too large");
    else
      std::snprintf(buf, MAX_SIZE, "The value is %" PRIdFAST16, val);
    // ...
}

Compliant Solution (Reserved Macros)

The compliant solution below avoids redefining reserved names or using reserved prefixes and suffixes.

#include <inttypes.h>   // for int_fast16_t and PRIdFAST16

static const int_fast16_t MY_INTFAST16_UPPER_LIMIT = 12000;

void print_fast16(int_fast16_t val) {
    enum { BUFSIZE = 80 };
    char buf [BUFSIZE];
    if (MY_INTFAST16_UPPER_LIMIT < val)
      std::sprintf(buf, "The value is too large");
    else
      std::snprintf(buf, BUFSIZE, "The value is %" PRIdFAST16, val);
    // ...
}

Noncompliant Code Example (Identifiers With External Linkage)

In addition to symbols defined as functions in each C standard library header, identifiers with external linkage include, among many others, errno, math_errhandling, setjmp(), and va_end(), regardless of whether any of them is masked by a macro of the same name or not.

The noncompliant example below provides definitions for the C standard library functions std::malloc() and std::free(). While this practice is permitted by many traditional implementations of UNIX (see, for example, the Dmalloc library), doing so is disallowed by the C++ standard as it need not generally portable and may lead to undefined behavior. Common effects range from compiler errors, to linker errors, to abnormal program behavior at runtime. In addition, even on systems where replacing malloc() is allowed, doing so without also replacing std::calloc() and std::realloc() is likely to cause problems as well.

#include <cstddef>

void* malloc(std::size_t nbytes) {
  void *ptr;
  // allocate storage from own pool and set ptr
  return ptr;
}

void free(void *ptr) {
  // return storage to own pool
}

Compliant Solution (Identifiers With External Linkage)

The compliant, portable solution avoids redefining any C standard library identifiers with external linkage. In addition, it provides definitions for all memory allocation functions.

#include <cstddef>

void* my_malloc(std::size_t nbytes) {
  void *ptr;
  // allocate storage from own pool and set ptr
  return ptr;
}

void* my_calloc(std::size_t nelems, std::size_t elsize) {
  void *ptr;
  /// allocate storage from own pool and set ptr
  return ptr;
}

void* my_realloc(void *ptr, std::size_t nbytes) {
  // reallocate storage from own pool and set ptr
  return ptr;
}

void my_free(void *ptr) {
  // return storage to own pool
}

Risk Assessment

Using reserved identifiers can lead to incorrect program operation.

Automated Detection

A module written in Compass/ROSE can detect violations of this rule.

Other Languages

This rule appears in the C Secure Coding Standard as DCL37-C. Do not declare or define a reserved identifier.

Bibliography

[ISO/IEC 14882-2003] Section 17.4.3.1.2, "Global names"
[ISO/IEC 9899:1999] Section 7.1.3, "Reserved Identifiers"
[IEEE Std 1003.1-2008] Section 2.2 "The Compilation Environment"