Page History

If a constant value is given for an identifier, do not diminish the modifiability maintainability of the code in which it is used by assuming its value in expressions. Just Simply giving the constant a name is not enough to ensure modifiability; you must be careful to always use the name, and remember that the value could can change. This recommendation is related to DCL06-AC. Use meaningful symbolic constants to represent literal values in program logic.

...

Noncompliant Code Example

The header <stdiostdio.h>h defines the BUFSIZ macro, which expands to an integer constant expression that is the size of the buffer used by the setbuf() function. This non-compliant noncompliant code example defeats the purpose of defining BUFSIZ as a constant by assuming its value in the following expression:

#include <stdio.h>
/* ... */
nblocks = 1 + ((nbytes - 1) >> 9);  /* hardBUFSIZ to= modify,512 uses "magic number"= 2^9 */

The programmer's assumption underlying this code is that "everyone knows that BUFSIZ equals 512," and right-shifting nine 9 bits is the same (for positive numbers) as dividing by 512. However, if BUFSIZ changes to 1024 on some systems, modifications are difficult and error - prone.

Compliant Solution

This compliant solution uses the identifier assigned to the constant value in the expression.:

#include <stdio.h>
/* ... */
nblocks = 1 + (nbytes - 1) / BUFSIZ;

Most modern C compilers will optimize this code appropriately.

Risk Assessment

Improper use of macros may result in unexpected arithmetic resultsAssuming the value of an expression diminishes the maintainability of code and can produce unexpected behavior under any circumstances in which the constant changes.

Automated Detection

Related Vulnerabilities

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

References

\[[Plum 85|AA. C References#Plum 85]\] Rule 1-5
\[[ISO/IEC 9899-1999|AA. C References#ISO/IEC 9899-1999]\] Section 6.10, "Preprocessing directives," and Section 5.1.1, "Translation environment"

Related Guidelines

Bibliography

...

Image Added Image Added Image AddedEXP06-A. Operands to the sizeof operator should not contain side effects      03. Expressions (EXP)       EXP08-A. Ensure pointer arithmetic is used correctly