CertC-DCL40¶
Do not create incompatible declarations of the same function or object
Required inputs: IR
Two or more incompatible declarations of the same function or object must not appear in the same program because they result in undefined behavior . The C Standard, 6.2.7, 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 |
|---|---|---|
| 14 | Two declarations of the same object or function specify types that are not compatible (6.2.7). | All noncompliant code in this guideline |
| 30 | Two identifiers differ only in nonsignificant characters (6.4.2.1). | Excessively Long Identifiers |
| 36 | An object has its stored value accessed other than by an lvalue of an allowable type (6.5). |
Incompatible Object Declarations Incompatible Array Declarations |
| 37 | 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.
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 14 . Furthermore, accessing the object using an lvalue of an incompatible type, as shown in function f() , is undefined behavior 36 with possible observable results ranging from unintended information exposure to memory overwrite to a hardware trap.
/* In a.c */
extern int i; /* UB 14 */
int f(void) {
return ++i; /* UB 36 */
}
/* In b.c */
short i; /* UB 14 */
|
Compliant Solution (Incompatible Object Declarations)
This compliant solution has compatible declarations of the variable i :
/* In a.c */
extern int i;
int f(void) {
return ++i;
}
/* In b.c */
int i;
|
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 14 . As before, accessing the object in function f() is undefined behavior 36 with the typical effect of triggering a hardware trap.
/* In a.c */
extern int *a; /* UB 14 */
int f(unsigned int i, int x) {
int tmp = a[i]; /* UB 36: read access */
a[i] = x; /* UB 36: write access */
return tmp;
}
/* In b.c */
int a[] = { 1, 2, 3, 4 }; /* UB 14 */
|
Compliant Solution (Incompatible Array Declarations)
This compliant solution declares a as an array in a.c and b.c :
/* 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 };
|
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 14 . Furthermore, invoking the function is undefined behavior 37 and typically has catastrophic consequences.
/* In a.c */
extern int f(int a); /* UB 14 */
int g(int a) {
return f(a); /* UB 37 */
}
/* In b.c */
long f(long a) { /* UB 14 */
return a * 2;
}
|
Compliant Solution (Incompatible Function Declarations)
This compliant solution has compatible prototypes for the function f() :
/* 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 :
/* 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 76 in accordance with the C Standard, 6.7.7.4, paragraph 14 [ ISO/IEC 9899:2024 ],
For two function types to be compatible, both shall specify compatible return types. Moreover, the parameter type lists shall agree in the number of parameters and in use of the final ellipsis; corresponding parameters shall have compatible types. In the determination of type compatibility and of a composite type, each parameter declared with function or array type is taken as having the adjusted type and each parameter declared with qualified type is taken as having the unqualified version of its declared type.
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:
/* In a.c */
void buginf(const char *fmt, ...) {
/* ... */
}
/* In b.c */
void buginf(const char *fmt, ...);
|
Noncompliant Code Example (Excessively Long Identifiers)
In this noncompliant code example, the length of the identifier declaring the function pointer bash_groupname_completion_function() in the file bashline.h exceeds by 3 the minimum implementation limit of 31 significant initial characters in an external identifier. This introduces the possibility of colliding with the bash_groupname_completion_funct integer variable defined in file b.c , which is exactly 31 characters long. On an implementation that exactly meets this limit, this is undefined behavior 30 . It results in two incompatible declarations of the same function. (See undefined behavior 14 .) In addition, invoking the function leads to undefined behavior 37 with typically catastrophic effects.
/* In bashline.h */
/* UB 14, UB 30 */
extern char * bash_groupname_completion_function(const char *, int);
/* In a.c */
#include "bashline.h"
void f(const char *s, int i) {
bash_groupname_completion_function(s, i); /* UB 37 */
}
/* In b.c */
int bash_groupname_completion_funct; /* UB 14, UB 30 */
|
NOTE: 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.
/* In bashline.h */
extern char * bash_groupname_completion(const char *, int);
/* In a.c */
#include "bashline.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 | Detectable | Repairable | Priority | Level |
|---|---|---|---|---|---|---|
| DCL40-C | Low | Unlikely | Yes | No | P2 | L3 |
Related Guidelines
| Taxonomy | Taxonomy item | Relationship |
| ISO/IEC TS 17961 | Declaring the same function or object in incompatible ways [funcdecl] | Prior to 2018-01-12: CERT: Unspecified Relationship |
| MISRA C:2012 | Rule 8.4 (required) | Prior to 2018-01-12: CERT: Unspecified Relationship |
Bibliography
| [ Hatton 1995 ] | Section 2.8.3 |
| [ ISO/IEC 9899:2011 ] | J.2, "Undefined Behavior" |
| [ ISO/IEC 9899:2024 ] | 6.7.7.4 "Function Declarators" |
Possible Messages
Key |
Text |
Severity |
Disabled |
|---|---|---|---|
cafe_not_compatible_with_previous_decl |
{} |
None |
False |
ellipsis_mismatch |
Parameter {kind1} does not match {kind2} at {pos} |
None |
False |
except_spec_mismatch |
{kind1} does not match {kind2} at {pos} |
None |
False |
external_identifiers_not_distinct |
External identifiers not distinct. |
None |
False |
external_identifiers_sharing |
External identifiers sharing first {} characters. |
None |
False |
implicit_ellipsis_mismatch |
Missing parameters should not match an ellipsis parameter at {pos} |
None |
False |
implicit_ellipsis_mismatch_rev |
An ellipsis parameter should not match missing parameters at {pos} |
None |
False |
implicit_length_match |
No parameters implicitly match {num} parameter{p} in {decl} at {pos} |
None |
False |
implicit_length_match_rev |
{num} parameter{p} implicitly match{es} no parameters in {decl} at {pos} |
None |
False |
implicit_promotion_mismatch |
Missing parameters do not match an unpromoted parameter type {type} at {pos} |
None |
False |
implicit_promotion_mismatch_rev |
An unpromoted parameter type {type} does not match missing parameters at {pos} |
None |
False |
internal_identifiers_not_distinct |
Internal identifiers not distinct. |
None |
False |
internal_identifiers_sharing |
Internal identifiers sharing first {} characters. |
None |
False |
length_mismatch |
{num1} parameter{p1} {versus} {num2} parameter{p2} at {pos} |
None |
False |
linkage_mismatch |
{kind1} does not match {kind2} at {pos} |
None |
False |
parameter_type_mismatch |
{kind} type {type1} {versus} {type2} at {pos}{implicit2}{remark} |
None |
False |
return_type_mismatch |
{kind} type {type1} {versus} {type2} at {pos}{implicit2}{remark} |
None |
False |
variable_type_mismatch |
{kind} type {type1} {versus} {type2} at {pos}{implicit2}{remark} |
None |
False |
Options¶
This rule shares the following common options: confidence, exclude_in_macros, exclude_messages_in_system_headers, excludes, extend_exclude_to_macro_invocations, includes, justification_checker, languages, post_processing, provider, report_at, severity
The following places define options that affect this rule: Stylechecks, Analysis-GlobalOptions
check_exception_specification¶
check_exception_specification : bool = False
check_linkage_declaration¶
check_linkage_declaration : bool = False
maxlen¶
maxlen : int | None = None
report_external_identifiers¶
report_external_identifiers : bool = True
report_internal_identifiers¶
report_internal_identifiers : bool = False
report_short_identifiers¶
report_short_identifiers : bool = False