Versions Compared

Key

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

Make sure that included header file names are unique. According to the C standard Standard, subclause 6.10.2, paragraph 5 [ISO/IEC 9899:2011],

The implementation shall provide unique mappings for sequences consisting of one or more nondigits or digits (6.4.2.1) followed by a period (.) and a single nondigit. The first character shall not be a digit. The implementation may ignore distinctions of alphabetical case and restrict the mapping to eight significant characters before the period.

...

Note that compliance with this recommendation does not require that short file names are used, only that the file names are unique.

Noncompliant Code Example

The following This noncompliant code example contains references to headers that may exist independently in various environments but can be ambiguously interpreted by a C-compliant compiler.:

Code Block
bgColor#FFcccc
langc
#include "Library.h"
#include <stdio.h>
#include <stdlib.h>
#include "library.h"

#include "utilities_math.h"
#include "utilities_physics.h"

#include "my_library.h"

/* Rest of program ... */

Library.h and library.h may refer to the same file. Also, because only the first eight characters are guaranteed to be significant, it is unclear whether utilities_math.h and utilities_physics.h are parsed. Finally, if a file such as my_libraryOLD.h exists, it may inadvertently be included instead of my_library.h.

Compliant Solution

This compliant solution avoids the ambiguity by renaming the associated files to be unique under the preceding constraints.:

Code Block
bgColor#ccccFF
langc
#include "Lib_main.h"
#include <stdio.h>
#include <stdlib.h>
#include "lib_2.h"

#include "util_math.h"
#include "util_physics.h"

#include "my_library.h"

/* Rest of program ... */

The only solution for mitigating ambiguity of a file, such as my_libraryOLD.h, is to rename old files with either a prefix (that would fall within the first eight characters) or add an extension (such as my_library.h.old).

Exceptions

PRE08-C-EX1: While the Although the C standard requires Standard requires only the first eight characters in the file name to be significant, most modern systems have long file names, and compilers on such systems can typically differentiate them. Consequently, long file names in headers may be used, provided that all the implementations to which the code is ported can distinguish between these file names.

...

Failing to guarantee uniqueness of header files may result in the inclusion of an older version of a header file, which may include incorrect macro definitions or obsolete function prototypes or result in other errors that may or may not be detected by the compiler. Portability issues may also stem from the use of header names that are not guaranteed to be unique.

Recommendation

Severity

Likelihood

Remediation Cost

Priority

Level

PRE08-C

low

Low

unlikely

Unlikely

medium

Medium

P2

L3

Automated Detection

ToolVersionCheckerDescription
Klocwork
Axivion Bauhaus Suite

Include Page

Klocwork

Axivion Bauhaus Suite_V

Klocwork

Axivion Bauhaus Suite_V

IF_DUPL_HEADER

 
CertC-PRE08

ECLAIR

Include Page
ECLAIR_V
ECLAIR_V

CC2.PRE08

Fully implemented

PRQA QA-C
Include Page
PRQA QA-C_v
PRQA QA-C_v
5002Fully implemented

Related Vulnerabilities

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

Related Guidelines

...

...

Bibliography

...

]Subclause 6.10.2, "Source

...

File Inclusion"

MISRA Rule 19.5

Bibliography


...

Image Modified Image Modified Image Modified