Versions Compared

Key

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

In C++, modifying an object, calling a library I/O function, accessing a volatile-qualified value, or calling a function which performs one of these actions, are ways to modify the state of the execution environment. These actions are called side effects. All relationships between value computations and side effects can be described in terms of sequencing of their evaluations. The C++ Standard, [intro.execution], paragraph 13 [ISO/IEC 14882-2014], establishes three sequencing terms:

Sequenced before is an asymmetric, transitive, pair-wise relation between evaluations executed by a single thread, which induces a partial order among those evaluations. Given any two evaluations A and B, if A is sequenced before B, then the execution of A shall precede the execution of B. If A is not sequenced before B and B is not sequenced before A, then A and B are unsequenced. [Note: The execution of unsequenced evaluations can overlap. — end note] Evaluations A and B are indeterminately sequenced when either A is sequenced before B or B is sequenced before A, but it is unspecified which. [Note: Indeterminately sequenced evaluations cannot overlap, but either could be executed first. — end note]

Paragraph 15 then goes on to state (nonnormative text removed for brevity):

Except where noted, evaluations of operands of individual operators and of subexpressions of individual expressions are unsequenced. ... The value computations of the operands of an operator are sequenced before the value computation of the result of the operator. If a side effect on a scalar object is unsequenced relative to either another side effect on the same scalar object or a value computation using the value of the same scalar object, and they are not potentially concurrent, the behavior is undefined. ... When calling a function (whether or not the function is inline), every value computation and side effect associated with any argument expression, or with the postfix expression designating the called function, is sequenced before execution of every expression or statement in the body of the called function. ... Every evaluation in the calling function (including other function calls) that is not otherwise specifically sequenced before or after the execution of the body of the called function is indeterminately sequenced with respect to the execution of the called function. Several contexts in C++ cause evaluation of a function call, even though no corresponding function call syntax appears in the translation unit. ... The sequencing constraints on the execution of the called function (as described above) are features of the function calls as evaluated, whatever the syntax of the expression that calls the function might be.

Do not allow the same scalar object to appear in side effects or value computations in both halves of an unsequenced or indeterminately sequenced operation.

The following expressions have sequencing restrictions that deviate from the usual unsequenced ordering [ISO/IEC 14882-2014]:

  • In postfix ++ and -- expressions, the value computation is sequenced before the modification of the operand. ([expr.post.incr], paragraph 1)
  • In logical && expressions, if the second expression is evaluated, every value computation and side effect associated with the first expression is sequenced before every value computation and side effect associated with the second expression. ([expr.log.and], paragraph 2)
  • In logical || expressions, if the second expression is evaluated, every value computation and side effect associated with the first expression is sequenced before every value computation and side effect associated with the second expression. ([expr.log.or], paragraph 2)
  • In conditional ?: expressions, every value computation and side effect associated with the first expression is sequenced before every value computation and side effect associated with the second or third expression (whichever is evaluated). ([expr.cond], paragraph 1)
  • In assignment expressions (including compound assignments), the assignment is sequenced after the value computations of left and right operands, and before the value computation of the assignment expression. ([expr.ass], paragraph 1)
  • In comma , expressions, every value computation and side effect associated with the left expression is sequenced before every value computation and side effect associated with the right expression. ([expr.comma], paragraph 1)
  • When evaluating initializer lists, the value computation and side effect associated with each initializer-clause is sequenced before every value computation and side effect associated with a subsequent initializer-clause. ([dcl.init.list], paragraph 4)
  • When a signal handler is executed as a result of a call to std::raise(), the execution of the handler is sequenced after the invocation of std::raise() and before its return. ([intro.execution], paragraph 6)
  • The completions of the destructors for all initialized objects with thread storage duration within a thread are sequenced before the initiation of the destructors of any object with static storage duration. ([basic.start.term], paragraph 1)
  • In a new-expression, initialization of an allocated object is sequenced before the value computation of the new-expression. ([expr.new], paragraph 18)
  • When a default constructor is called to initialize an element of an array and the constructor has at least one default argument, the destruction of every temporary created in a default argument is sequenced before the construction of the next array element, if any. ([class.temporary], paragraph 4)
  • The destruction of a temporary whose lifetime is not extended by being bound to a reference is sequenced before the destruction of every temporary which is constructed earlier in the same full-expression. ([class.temporary], paragraph 5)
  • Atomic memory ordering functions can explicitly determine the sequencing order for expressions. ([atomics.order] and [atomics.fences])

Evaluation of an expression may produce side effects. At specific points during execution, known as sequence points, all side effects of previous evaluations are complete, and no side effects of subsequent evaluations have yet taken place. Do not depend on the order of evaluation for side effects unless there is an intervening sequence point.

The order in which operands in an expression are evaluated is unspecified in C++. The only guarantee is that they will all be completely evaluated at the next sequence point. According to ISO/IEC 14882-2003:

The following are the sequence points defined by ISO/IEC 14882-2003:

  • at the completion of evaluation of each full-expression;
  • after the evaluation of all function arguments (if any) and before execution of any expressions or statements in the function body;
  • after the copying of a returned value and before the execution of any expressions outside the function;
  • after the evaluation of the first operand of the following operators: && (logical AND); || (logical OR); ? (conditional); , (comma, but see the note immediately following);
  • after the initialization of each base and member in a class.

According to ISO/IEC 14882-2003:

...

This rule means that statements such as

Code Block
bgColor#ccccff
langcpp
i = i + 1;
a[i] = i;

are allowedhave defined behavior, and statements such as the following are do not:

Code Block
bgColor#FFcccc
langcpp
/*/ i is modified twice in betweenthe sequencesame pointsfull */expression
i = ++i + 1;  

/*/ i is read other than to determine the value to be stored */
a[i++] = i;   

Note that not all instances of a comma in C++ code denote a usage of the comma operator. For example, the comma between arguments in a function call is NOT the comma operator.

Noncompliant Code Example

Programs cannot safely rely on the order of evaluation of operands between sequence points. In this noncompliant code example, i is evaluated twice without an intervening sequence pointmore than one in an unsequenced manner, and so the behavior of the expression is undefined:

Code Block
bgColor#FFcccc
langcpp
#include <stdio.h>

void funcf(int i, const int *b) {
  int a = i + b[++i];
  printf("%d, %d", a, i);// ...
}

Compliant Solution

These examples are independent of the order of evaluation of the operands and can be interpreted in only one way.

Code Block
bgColor#ccccff
langcpp
#include <stdio.h>

void funcf(int i, const int *b) {
  int a;
  ++i;
  int a = i + b[i];
  printf("%d, %d", a, i);// ...
}

Alternatively:

Code Block
bgColor#ccccff
langcpp
#include <stdio.h>

void funcf(int i, const int *b) {
  int a = i + b[i + 1];
  ++i;
  printf("%d, %d", a, i);// ...
}

Noncompliant Code Example

The call to func() in this noncompliant code example has undefined behavior because there is no sequence point between the argument expressions are unsequenced:

Code Block
bgColor#FFcccc
langcpp
extern void func(int i, int j);
 
void f(int i) {
  func(i++, i);
}

The first (left) argument expression reads the value of of i (to determine the value to be stored) and then modifies modifies i. The second (right) argument expression reads the value of i between the same pair of sequence points as the first argument, but of i, but not to determine the value to be stored in in i. This additional attempt to read the value of of i has undefined  has undefined behavior..

Compliant Solution

This compliant solution is appropriate when the programmer intends for both arguments to func() to be equivalent:

...

Code Block
bgColor#ccccff
langcpp
extern void func(int i, int j);
 
void f(int i) {
  int j = i++;
  func(j, i);
}

Noncompliant Code Example

The order of evaluation for function arguments is unspecified. This noncompliant code example exhibits unspecified behavior but not undefined behavior:

Code Block
bgColor#FFcccc
langc
extern void c(int i, int j);
int glob;
 
int a(void) {
  return glob + 10;
}

int b(void) {
  glob = 42;
  return glob;
}
 
void funcf(void) {
  c(a(), b());
}

It is unspecified what order a() and b() are called in; the only guarantee is that both a() and b() will be called before c() is called. If a() or b() rely on shared state when calculating their return value, as they do in this example, the resulting arguments passed to c() may differ between compilers or architectures.

Compliant Solution

In this compliant solution, the order of evaluation for a() and b() is fixed, and so no unspecified behavior occurs:

Code Block
bgColor#ccccff
langc
extern void c(int i, int j);
int glob;
 
int a(void) {
  return glob + 10;
}
 
int b(void) {
  glob = 42;
  return glob;
}
 
void funcf(void) {
  int a_val, b_val;
 
  a_val = a();
  b_val = b();

  c(a_val, b_val);
}

Risk Assessment

Attempting to modify an object multiple times between sequence points in an unsequenced or indeterminately sequenced evaluation may cause that object to take on an unexpected value, which can lead to unexpected program behavior.

Rule

Severity

Likelihood

Remediation Cost

Priority

Level

EXP30-CPP

Medium

Probable

Medium

P8

L2

Automated Detection

Tool

Version

Checker

Description

Compass/ROSE

 

 

Can detect simple violations of this rule. It needs to examine each expression and make sure that no variable is modified twice in the expression. It also must check that no variable is modified once, then read elsewhere, with the single exception that a variable may appear on both the left and right of an assignment operator

Coverity

Include Page
Coverity_V
Coverity_V

EVALUATION_ORDER

Can detect the specific instance where a statement contains multiple side effects on the same value with an undefined evaluation order because, with different compiler flags or different compilers or platforms, the statement may behave differently

ECLAIR

Include Page
ECLAIR_V
ECLAIR_V

CC2.EXP30

Fully implemented

GCC

Include Page
GCC_V
GCC_V

 

Can detect violations of this rule when the -Wsequence-point flag is used

LDRA tool suite

Include Page
LDRA_V
LDRA_V

35 D
1 Q
9 S
134 S

Fully implemented

Splint

Include Page
Splint_V
Splint_V

 

 

PRQA QA-C++
Include Page
PRQA QA-C++_V
PRQA QA-C++_V
3220, 3221, 3222, 3223 SonarQube Plugin
Include Page
seccode:SonarQube_Vseccode:SonarQube_VIncAndDecMixedWithOtherOperators 

Related Vulnerabilities

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

Related Guidelines

Bibliography

Questions 3.1, 3.2, 3.3, 3.3b, 3.7, 3.8, 3.9, 3.10a, 3.10b, and 3.11
[ISO/IEC 14882-20032014]Sections 1.9 Program execution, 5 Expressions, 12.6.2 Initializing bases and members.
[Saks 2007] 
, "Program Execution"
[MISRA 08]Rule 5-0-1, "The value of an expression shall be the same under any order of evaluation that the standard permits."[Summit 2005]

 

...