Versions Compared

Key

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

Two or more incompatible declarations of the same function or object must not appear in the same program  program because they result in undefined behavior. Subclause The C Standard, 6.2.7 of the C standard , mentions that two types may be distinct yet compatible , and addresses precisely when two distinct types are compatible.

The C Standard identifies four situations in which undefined behavior (UB) may arise as a result of incompatible declarations of the same function or object:

UB

Description

Code

15

Two declarations of the same object or function specify types that are not compatible (6.2.7).

All noncompliant code in this guideline

31
—Two
Two identifiers differ only in nonsignificant characters (6.4.2.1).Excessively Long Identifiers

37

An object has its stored value accessed other than by an lvalue of an allowable type (6.5).

Incompatible Object Declarations

,


Incompatible Array Declarations

41

A function is defined with a type that is not compatible with the type (of the expression) pointed to by the expression that denotes the called function (6.5.2.2).

Incompatible Function Declarations

,

 
Excessively Long Identifiers

Although the effect of two incompatible declarations simply appearing in the same program may be benign on most implementations, the effects of invoking a function through an expression whose type is incompatible with the function definition are typically catastrophic. Similarly, the effects of accessing an object using an lvalue of a type that is incompatible with the object definition may range from unintended information exposure to memory overwrite to a hardware trap.

Anchor
Incompatible Object Declarations
Incompatible Object Declarations
Noncompliant Code Example (Incompatible Object Declarations)

In this noncompliant code example, the variable i is declared to have type int in file a.c but defined to be of type short in file b.c. The declarations are incompatible, resulting in undefined behavior undefined behavior 15. Furthermore, accessing the object using an lvalue of an incompatible type, as done shown in function f() results in , is undefined behavior 37 with possible observable results ranging from unintended information exposure to memory overwrite to a hardware trap.

...

Code Block
bgColor#ccccff
langc
/* In a.c */
extern int i;   

int f(void) {
  return ++i;   
}

/* In b.c */
int i;   

Anchor
Incompatible Array Declarations
Incompatible Array Declarations
Noncompliant Code Example (Incompatible Array Declarations)

In this noncompliant code example, the variable a is declared to have a pointer type in file a.c but defined to have an array type in file b.c. The two declarations are incompatible, resulting in undefined behavior 15. As before, accessing the object in function f() results in is undefined behavior 37 with the typical effect of triggering a hardware trap.

Code Block
bgColor#FFcccc
languagec
/* In a.c */
extern int *a;   /* UB 15 */

int f(unsigned int i, int x) {
  int tmp = a[i];   /* UB 37: read access */
  a[i] = x;         /* UB 37: write access */
  return tmp;
}

/* In b.c */
int a[] = { 1, 2, 3, 4 };   /* UB 15 */

...

Code Block
bgColor#ccccff
langc
/* In a.c */
extern int a[];   

int f(unsigned int i, int x) {
  int tmp = a[i];   
  a[i] = x;         
  return tmp;
}

/* In b.c */
int a[] = { 1, 2, 3, 4 };  

Anchor
Incompatible Function Declarations
Incompatible Function Declarations
Noncompliant Code Example (Incompatible Function Declarations)

In this noncompliant code example, the function f() is declared in file a.c with one prototype but defined in file b.c with another. The two prototypes are incompatible, resulting in undefined behavior 15. Furthermore, invoking the function results in is undefined behavior 41 with and typically has catastrophic effectsconsequences.

Code Block
bgColor#FFcccc
languagec
/* In a.c */
extern int f(int a);   /* UB 15 */

int g(int a) {
  return f(a);   /* UB 41 */
}

/* In b.c */
long f(long a) {   /* UB 15 */
  return a * 2;
}

...

This compliant solution has compatible declarations of prototypes for the function f():

Code Block
bgColor#ccccff
langc
/* In a.c */
extern int f(int a);   

int g(int a) {
  return f(a);   
}

/* In b.c */
int f(int a) {   
  return a * 2;
}

Noncompliant Code Example (Incompatible Variadic Function Declarations)

In this noncompliant code example, the function buginf() is defined to take a variable number of arguments and expects them all to be signed integers with a sentinel value of -1:

Code Block
bgColor#FFCCCC
langc
/* In a.c */
void buginf(const char *fmt, ...) {
   /* ... */
}
 
/* In b.c */
void buginf();

Although this code appears to be well defined because of the prototype-less declaration of buginf(), it exhibits undefined behavior in accordance with the C Standard, 6.7.6.3, paragraph 15 [ISO/IEC 9899:2011],

For two function types to be compatible, both shall specify compatible return types. Moreover, the parameter type lists, if both are present, shall agree in the number of parameters and in use of the ellipsis terminator; corresponding parameters shall have compatible types. If one type has a parameter type list and the other type is specified by a function declarator that is not part of a function definition and that contains an empty identifier list, the parameter list shall not have an ellipsis terminator and the type of each parameter shall be compatible with the type that results from the application of the default argument promotions.

Compliant Solution (Incompatible Variadic Function Declarations)

In this compliant solution, the prototype for the function buginf() is included in the scope in the source file where it will be used:

Code Block
bgColor#ccccff
langc
/* In a.c */
void buginf(const char *fmt, ...) {
   /* ... */
}

/* In b.c */
void buginf(const char *fmt, ...);

Anchor
Excessively Long Identifiers
Excessively Long Identifiers
Noncompliant Code Example (Excessively Long Identifiers)

Code Block
bgColor#FFcccc
languagec
/* In bash/bashline.h */
/* UB 15, UB 31 */
extern char * bash_groupname_completion_function(const char *, int); /* UB 15, UB 31 */

/* In a.c */
#include <bashline"bashline.h>h"

void f(const char *s, int i) {
  bash_groupname_completion_function(s, i);   /* UB 41 */
}

/* In b.c */
int bash_groupname_completion_funct;   /* UB 15, UB 31 */

NoteNOTE: The identifier bash_groupname_completion_function referenced here was taken from GNU Bash, version 3.2.

Compliant Solution (Excessively Long Identifiers)

In this compliant solution, the length of the identifier declaring the function pointer bash_groupname_completion() in bashline.h is less than 32 characters. Consequently, it cannot clash with bash_groupname_completion_funct on any compliant platform.

Code Block
bgColor#ccccff
langc
/* In bash/bashline.h */
extern char * bash_groupname_completion(const char *, int);   

/* In a.c */
#include <bashline"bashline.h>h"

void f(const char *s, int i) {
  bash_groupname_completion(s, i);  
}

/* In b.c */
int bash_groupname_completion_funct; 

...

Risk Assessment

Rule

Severity

Likelihood

Remediation Cost

Priority

Level

DCL40-C

Low

Unlikely

Medium

P2

L3

Automated Detection

Tool

Version

Checker

Description

Astrée
Include Page
Astrée_V
Astrée_V

type-compatibility

type-compatibility-link

distinct-extern

Fully checked
Axivion Bauhaus Suite

Include Page
Axivion Bauhaus Suite_V
Axivion Bauhaus Suite_V

CertC-DCL40Fully implemented
CodeSonar
Include Page
CodeSonar_V
CodeSonar_V
LANG.STRUCT.DECL.IF
LANG.STRUCT.DECL.IO
Inconsistent function declarations
Inconsistent object declarations
Coverity
Include Page
Coverity_V
Coverity_V
MISRA C 2012 Rule 8.4Implemented
Helix QAC

Include Page
Helix QAC_V
Helix QAC_V

C0776, C0778, C0779, C0789, C1510

C++1510

Fully implemented
Klocwork

Include Page
Klocwork_V
Klocwork_V

MISRA.FUNC.NOPROT.DEF.2012
MISRA.FUNC.PARAMS.IDENT

Fully implemented
LDRA tool suite8.5.4

1 X, 17 D

Partially implemented
Fully implementedPRQA QA-C8.11510Fully implemented

Related Guidelines

Parasoft C/C++test

Include Page
Parasoft_V
Parasoft_V

CERT_C-DCL40-a
CERT_C-DCL40-b

All declarations of an object or function shall have compatible types
If objects or functions are declared more than once their types shall be compatible

Parasoft Insure++



Runtime analysis

PC-lint Plus

Include Page
PC-lint Plus_V
PC-lint Plus_V

18, 621, 793, 4376

Fully supported

Polyspace Bug Finder

Include Page
Polyspace Bug Finder_V
Polyspace Bug Finder_V

CERT C: Rule DCL40-C




Checks for declaration mismatch (rule fully covered)

RuleChecker

Include Page
RuleChecker_V
RuleChecker_V

type-compatibility

type-compatibility-link

distinct-extern

 

Fully checked
TrustInSoft Analyzer

Include Page
TrustInSoft Analyzer_V
TrustInSoft Analyzer_V

incompatible declarationExhaustively verified.

Related Guidelines

Key here (explains table format and definitions)

Taxonomy

Taxonomy item

Relationship

ISO/IEC TS 17961Declaring the same function or object in incompatible ways [funcdecl]Prior to 2018-01-12: CERT: Unspecified Relationship
MISRA C:2012Rule 8.4 (required)Prior to 2018-01-12: CERT: Unspecified Relationship

Bibliography

[Hatton 1995]Section 2.8.3
[ISO/IEC 9899:2011]
Subclause
6.7.6.3, "Function Declarators (including Prototypes)"
J.2, "Undefined
behavior
Behavior"

...


...

Image Modified Image Modified Image Modified