Versions Compared

Key

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

Immutable (constant) values ) should be declared as enumeration constants, const-qualified objects (unmodifiable lvalues), enumerations values, or as a last resort, a #define.

In general, it is preferable to declare immutable values as const-qualified objects rather than as macro definitions. Using a const declared value means that the compiler is able to check the type of the object, the object has scope, and (certain) debugging tools can show the name of the object.  However, for integer constants, it is preferable to use an enumeration constant instead of a const-qualified object as this eliminates the possibility of taking the address of the integer constant and does not require that storage is allocated for the value.

In addition, const-qualified objects cannot be used where compile-time integer constants are required, namely to define the:

...

If any of these are required, then an integer constant (an rvalue) must be used. For integer constants, it is preferable to use an enum instead of a const-qualified object as this eliminates the possibility of taking the address of the integer constant and does not required that storage is allocated for the value.

This recommendation is related to EXP10-A. Do not diminish the benefits of constants by assuming their values in expressions.

Non-Compliant Code (object-like macro)

A preprocessing directive of the form:

...

An unsuffixed floating constant, as in this example, has type double. If suffixed by the letter f or F, it has type float. If suffixed by the letter l or L, it has type long double.

Compliant Solution

In this compliant solution, pi is declared as a const-qualified object, allowing the constant to have scope and to have its value inspected by a debugger.

Code Block
bgColor#ccccff
const float pi = 3.14159;
float degrees;
float radians;
/* ... */
radians = degrees * pi / 180;

While inadequate in some ways, this is the best that can be done for non-integer constants.

Non-Compliant Code Example (immutable integer values)

In this non-compliant code example, max is declared as a const-qualified object. While declaring non-integer constants as const-qualified object objects is the best that can be done in C, for integer constants we can do better. Declaring immutable integer values as const-qualified objects still allows the programmer to take the address of the object. Also, const-qualified integers cannot be used in locations where an integer constant is required, such as the value of a case constant.

...

Most C compilers allocate memory for const-qualified objects.

Compliant Solution (enum)

This compliant solution declares max as an enum enumeration constant rather than a const-qualified object or a macro definition.

Code Block
bgColor#ccccff
enum { max = 15 };
int a[max]; /* OK */
const int *p;

p = &max; /* error: '&' on constant */

Risk Assessment

Failing to declare immutable values using const or enum Using ordinary variables to hold constants instead of using enumeration constants or const-qualified objects can result in a value intended to be constant being changed at runtime.

...

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

References

Wiki Markup
\[[ISO/IEC 9899-1999|AA. C References#ISO/IEC 9899-1999]\] Section 6.3.2.1, "Lvalues, arrays, and function designators," Section 6.7.2.2, "Enumeration specifiers," and Section 6.10.3, "Macro replacement"