Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated references from C11->C23

Some functions return a pointer to an object that cannot be modified without causing undefined behavior. These functions include getenv(), setlocale(), localeconv()asctime(), and strerror(). In such cases, the function call results must be treated as being const-qualified.

The C Standard, 7.2224.4.6, paragraph 4 [ISO/IEC 9899:20112024], defines getenv() as follows:

...

Similarly, subclause 7.11.1.1, paragraph 8 [ISO/IEC 9899:20112024], defines setlocale() as follows:

...

 And subclause 7.11.2.1, paragraph 8 [ISO/IEC 9899:20112024], defines localeconv() as follows:

...

Altering the string returned by setlocale() or the structure returned by localeconv() are undefined behaviors. (See undefined behaviors 120 and 121.) Furthermore, the C Standard imposes no requirements on the contents of the string by setlocale(). Consequently, no assumptions can be made as to the string's internal contents or structure.

Finally, subclause 7.2426.6.23, paragraph 4 [ISO/IEC 9899:20112024], states

The The strerror function returns a pointer to the string, the contents of which are locale-specific. The array pointed to shall not be modified by the program, but may be overwritten by . The behavior is undefined if the returned value is used after a subsequent call to the strerror functionthe strerror function, or after the thread which called the function to obtain the returned value has exited.

Altering the string returned by strerror() is undefined behavior. (See undefined behavior 184.)

...

C4751, C4752, C4753C++4751, C++4752, C++4753

Tool

Version

Checker

Description

Astrée
Include Page
Astrée_V
Astrée_V
stdlib-const-pointer-assignPartially checked
Axivion Bauhaus Suite

Include Page
Axivion Bauhaus Suite_V
Axivion Bauhaus Suite_V

CertC-ENV30
CodeSonar
Include Page
CodeSonar_V
CodeSonar_V

BADFUNC.GETENV
LANG.STRUCT.RPNTC

Use of getenv
Returned Pointer Not Treated as const

Compass/ROSE

Can detect violations of this rule. In particular, it ensures that the result of getenv() is stored in a const variable

Cppcheck Premium

Include Page
Cppcheck Premium_V
Cppcheck Premium_V

premium-cert-env30-cFully implemented
Helix QAC

Include Page
Helix QAC_V
Helix QAC_V

C1492, C1493, C1494

DF4751,

DF4752, DF4753


Klocwork
Include Page
Klocwork_V
Klocwork_V

MISRA.STDLIB.CTYPE.RANGE.2012_AMD1
MISRA.STDLIB.ILLEGAL_REUSE.2012_AMD1
MISRA.STDLIB.ILLEGAL_WRITE.2012_AMD1


LDRA tool suite
Include Page
LDRA_V
LDRA_V
107 DPartially Implemented
Parasoft C/C++test

Include Page
Parasoft_V
Parasoft_V

CERT_C-ENV30-a

The pointers returned by the Standard Library functions 'localeconv', 'getenv', 'setlocale' or, 'strerror' shall only be used as if they have pointer to const-qualified type

Polyspace Bug Finder

Include Page
Polyspace Bug Finder_V
Polyspace Bug Finder_V

CERT C: Rule ENV30-C


Checks for modification of internal buffer returned from nonreentrant standard function (rule fully covered)

 PRQA QA-C

Include Page
PRQA QA-C_vPRQA QA-C_v1492, 1493, 1494 
PVS-Studio

Include Page
PVS-Studio_V
PVS-Studio_V

V675
RuleChecker

Include Page
RuleChecker_V
RuleChecker_V

stdlib-const-pointer-assignPartially checked

...

[IEEE Std 1003.1:2013]XSH, System Interfaces, getenv
XSH, System Interfaces, setlocale
XSH, System Interfaces, localeconv
[ISO/IEC 9899:20112024]7.11.1.1, "The setlocale Function"
7.11.2.1, "The localeconv Function"
7.2224.4.6, "The getenv Function"
7.2426.6.23, "The strerror Function"


...