Page History

Many functions return useful values whether or not the function has side effects. In most cases, this value is used to signify whether the function successfully completed its task or if some error occurred (see ERR02-AC. Avoid in-band error indicators). Other times, the value is the result of some computation and is a necessary output.an integral part of the function's API.

Subclause Wiki MarkupSection 6.8.3 of C99 \[of the C Standard [ISO/IEC 9899:1999|AA. C References#ISO/IEC 9899-1999]\] states that2011] states:

The expression in an expression statement is evaluated as a void expression for its side effects.

All expression statements, such as function calls with an ignored value, are implicitly cast to void. Since Because a return value often contains important information about possible errors, it should always be checked; otherwise, the cast should be made explicit to signify programmer intent. If a function returns no meaningful value, it should be declared with return type void.

This recommendation encompasses MEM32ERR33-C. Detect and handle memory allocation errors, FIO04-A. Detect and handle input and output errors, and FIO34-C. Use int to capture the return value of character IO functions.

Non-Compliant Code Example

standard library errors. Unlike this recommendation, that rule is restricted to functions from the Standard C library.

Compliance with this recommendation is required in order to comply with ERR00-C. Adopt and implement a consistent and comprehensive error-handling policy

Noncompliant Code Example

The asprintf() function has been provided by the GNU C library. It works like sprintf(), but if given a null pointer as the destination string, it will create a buffer sufficient to hold the resulting string. It relies on malloc() to allocate the buffer. If malloc() fails, then asprintf() returns a negative number.

This noncompliant code example calls asprintf(), but fails to check whether the string was successfully createdThis non-compliant code example calls puts() and fails to check whether a write error occurs.

puts("foo");

...

void func(char* name) {
  char* s = NULL;
  asprintf(&s,"Hello, %s!\n", name);
  (void) puts(s);
  free(s);
}

Compliant Solution

This compliant solution checks to make sure no output error occurred (see FIO04-A. Detect and handle input and output errors).

void func(char* name) {
  char* s = NULL;
  if (putsasprintf("foo") == EOF&s,"Hello, %s!\n", name) < 0) {
    /* Handle Errorerror */
  }
  (void) puts(s);
  free(s);
} 

Exceptions

EXP12-C-EX1: If the return value is inconsequential or if any errors can be safely ignored, such as for functions called because of their side effects, the function should be explicitly cast to void to signify programmer intent. See the compliant solution for removing an existing destination file For an example of this exception, see "Compliant Solution (Remove Existing Destination File)" under the section "Portable Behavior" in FIO10-AC. Take care when using the rename() function for an example of this exception, or Exception ERR33-C-EX1 in ERR33-C. Detect and handle standard library errors.

EXP12-C-EX2: If a function cannot fail or if the return value cannot signify an error condition, the return value may be ignored. Such functions should be added to a white list whitelist when automatic checkers are used.

strcpy(dst, src);

Risk Assessment

Failure to handle error codes or other values returned by functions can lead to incorrect program flow and violations of data integrity.

Automated Detection

Splint Version 3.1.1 can detect violations of this recommendation.

Compass/ROSE can detect violations of this recommendation.

Related Vulnerabilities

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

References

...

Related Guidelines

Bibliography

...

...

...

...

Image Added Image Added Image Added and null statements" \[[ISO/IEC PDTR 24772|AA. C References#ISO/IEC PDTR 24772]\] "CSJ Passing Parameters and Return Values"EXP11-C. Do not apply operators expecting one type to data of an incompatible type      03. Expressions (EXP)       EXP30-C. Do not depend on order of evaluation between sequence points