Versions Compared

Key

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

The logical AND and logical OR operators (&& and ||, respectively) exhibit "short-circuit" operation. That is, the second operand is not evaluated if the result can be deduced solely by evaluating the first operand.

One Programmers should exercise caution if the second operand contains side effects because it may not be apparent whether the side effects actually occur.

In the following code, the value of i is incremented only when i >= 0.:

Code Block

enum { max = 15 };
int i = /* initializeInitialize to user -supplied value */;

if ( (i >= 0) && ( (i++) <= max) ) {
  /* codeCode */
}

Although the behavior is well defined, it is not immediately obvious whether or not i gets incremented or not.

Noncompliant Code Example

In this noncompliant code example, the second operand of the logical OR operator invokes a function that results in side effects.:

Code Block
bgColor#ffcccc
langc

char *p = /* initialize,Initialize; may or may not be NULL */

if (p || (p = (char *) malloc(BUF_SIZE)) ) {
  /* Perform some docomputation stuffbased withon p */
  free(p);
  p = NULL;
}
 else {
  /* handleHandle malloc() error */
  return;
}

Because malloc() is called only called if p is NULL when entering the if clause, free() might be called with a pointer to local data not allocated by malloc(). (see See MEM34-C. Only free memory allocated dynamically.) . This behavior is partially due to the uncertainty of whether or not malloc() is actually called or not.

Compliant Solution

In this compliant solution, a second pointer, q, is used to indicate whether malloc() is called; if not, q remains set to NULL. Passing NULL to free() is guaranteed to safely do nothing.

Code Block
bgColor#ccccff
langc

char *p = /* Initialize; may or may not be NULL */
char *q = NULL;
if (p == NULL) {
  q = (char *) malloc(BUF_SIZE);
  p = q;
}
if (p == NULL) {
  /* handleHandle malloc() error */
  return;
}

/* do stuff withPerform some computation based on p */
free(q);
q = NULL;

Risk Assessment

Failing to understand the short-circuit behavior of the logical OR or AND operator may cause unintended program behavior.

Recommendation

Severity

Likelihood

Remediation Cost

Priority

Level

EXP02-C

low

Low

unlikely

Unlikely

medium

Medium

P2

L3

Automated Detection

...

Tool

Version

Checker

Description

Astrée
Include Page
Astrée_V
Astrée_V
logop-side-effectFully checked
Axivion Bauhaus Suite

Include Page
Axivion Bauhaus Suite_V
Axivion Bauhaus Suite_V

CertC-EXP02Fully implemented
Compass/ROSE

...



Could detect possible violations of this recommendation by reporting expressions with side effects, including function calls, that appear on the right-hand

...

side of an && or || operator

Helix QAC

Include Page
Helix QAC_V
Helix QAC_V

C3415
Klocwork
Include Page
Klocwork_V
Klocwork_V
MISRA.LOGIC.SIDEEFF
LDRA tool suite
Include Page
LDRA_V
LDRA_V

35 D
1 Q
133 S
406 S
408 S

Fully implemented

Parasoft C/C++test
Include Page
Parasoft_V
Parasoft_V
CERT_C-EXP02-a

The right-hand operand of a logical && or || operator shall not contain side effects

PC-lint Plus

Include Page
PC-lint Plus_V
PC-lint Plus_V

9007

Fully supported

RuleChecker
Include Page
RuleChecker_V
RuleChecker_V
logop-side-effectFully checked
SonarQube C/C++ Plugin
Include Page
SonarQube C/C++ Plugin_V
SonarQube C/C++ Plugin_V
SideEffectInRightHandSideOfLogical

Related Vulnerabilities

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

Other Languages

...

Related Guidelines

...

...

...

MITRE CWECWE-768, Incorrect short circuit evaluation


...

Image Added Image Added

References

Wiki Markup
\[[CWE|AA. Bibliography#CWE]\] [CWE-768|http://cwe.mitre.org/data/definitions/768.html]: Incorrect Short Circuit Evaluation
\[[ISO/IEC 9899:1999|AA. Bibliography#ISO/IEC 9899-1999]\] Section 6.5.13, "Logical AND operator," and Section 6.5.14, "Logical OR operator"

EXP01-C. Do not take the size of a pointer to determine the size of the pointed-to type      03. Expressions (EXP)      Image Modified