V2614. MISRA. External identifiers should be distinct.
This diagnostic rule is based on the MISRA (Motor Industry Software Reliability Association) guidelines for software development.
This rule applies only to C. Identifiers with external linkage should be easily distinguished within the limitations imposed by the standard used.
The limitations are as follows:
- before standard C99 - 6 significant characters, case-insensitive;
- starting with standard C99 - 31 significant characters, case-sensitive.
Example 1:
// 123456789012345678901234567890123
extern int shrtfn(void); // OK
extern int longfuncname(void); // Error in C90,
// but OK in C99
extern int longlonglonglonglongfunctionname1(void); // Error in both
Long identifiers make it difficult to read code - and it's easy to confuse them with automatically generated identifiers. Also, when two identifiers differ only in characters that are not significant, this causes undefined behavior.
Some implementations of compilers and linkers can have their own limitations. To find out what these limitations are, refer to these tools' documentation.
Example 2:
// 123456789012345678901234567890123
extern int longFuncName1(int);
extern int longFuncName2(int);
extern int AAA;
extern int aaa;
void foo(void)
{
longFuncName2(AAA);
}
This code contains several errors at once (we'll examine this code based on the C90 standard):
- Identifiers 'longFuncName1' and 'longFuncName2' will be truncated down to the first 6 characters ('longFu'). So the linker will regard them as identical.
- According to the C90 standard, identifiers are not always case-sensitive - so the linker can interpret identifiers 'AAA' and 'aaa' as identical as well.
- The 'foo' function calls the 'longFuncName2' function and passes the 'AAA' variable value as its parameter. This call leads to undefined behavior because each of these two identifiers cannot be interpreted as distinct.
This diagnostic is classified as:
|