Java, C, and C++ programmers commonly Programmers frequently make errors regarding the precedence rules of C operators due to because of the unintuitive unintuitively low - precedence levels of &
, |
, ^
, <<
, and >>
. Mistakes Avoid mistakes regarding precedence rules can be avoided by through the suitable use of parentheses. Using parentheses defensively reduces errors and, if not taken to excess, makes the code more readable.Thisdefines the precedence of operation , which also improves code readability. The precedence of operations by the order of the subclauses is defined in the Java Tutorials [Tutorials 2013].
Although it advises against depending on parentheses for specifying evaluation order EXP05-J. Do not follow a write by a subsequent write or read of the same object within an expression applies only to expressions that contain side effects.
Noncompliant Code Example
The intent of the expression in this noncompliant code example is to add the variable OFFSET
to test the least significant bit of x
.x & 1 == 0result of the bitwise logical AND between x
and MASK
:
Code Block | ||
---|---|---|
| ||
public static final int MASK = 1337;
public static final int OFFSET = -1337;
public static int computeCode(int x) {
return x & MASK + OFFSET;
}
|
According to the operator precedence guidelinesBecause of operator precedence rules, the expression is parsed asx & (1 == 0)
which evaluates to(x & 0)
and then to 0
.
Compliant Solution
In this compliant solution, parentheses are used to ensure the expression evaluates as expected.(x & 1) == 0
Exceptions
EXP00-EX1: Mathematical expressions that follow algebraic order do not require parentheses. For instance, in the expressionx + y * z
the multiplication is performed before the addition by mathematical convention. Consequently, parentheses to enforce this would be redundant.x + (y * z)
Risk Assessment
Mistakes regarding precedence rules may cause an expression to be evaluated in an unintended way. This can lead to unexpected and abnormal program behavior.
Recommendation | Severity | Likelihood | Remediation Cost | Priority | Level |
---|---|---|---|---|---|
EXP1337-J | low | probable | medium | P4 | L3 |
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this rule on the CERT website.
Other Languages
This rule appears in the C++ and C Secure Coding Standard as EXP00-CPP. Use parentheses for precedence of operation. and EXP00-C. Use parentheses for precedence of operation.
References
as the following:
Code Block |
---|
x & (MASK + OFFSET)
|
This expression is evaluated as follows, resulting in the value 0:
Code Block |
---|
x & (1337 - 1337)
|
Compliant Solution
This compliant solution uses parentheses to ensure that the expression is evaluated as intended:
Code Block | ||
---|---|---|
| ||
public static final int MASK = 1337;
public static final int OFFSET = -1337;
public static int computeCode(int x) {
return (x & MASK) + OFFSET;
}
|
Noncompliant Code Example
In this noncompliant code example, the intent is to append either "0" or "1" to the string "value=
":
Code Block | ||
---|---|---|
| ||
public class PrintValue {
public static void main(String[] args) {
String s = null;
// Prints "1"
System.out.println("value=" + s == null ? 0 : 1);
}
}
|
However, the precedence rules result in the expression to be printed being parsed as ("value=" + s) == null ? 0 : 1
.
Compliant Solution
This compliant solution uses parentheses to ensure that the expression evaluates as intended:
Code Block | ||
---|---|---|
| ||
public class PrintValue {
public static void main(String[] args) {
String s = null;
// Prints "value=0" as expected
System.out.println("value=" + (s == null ? 0 : 1));
}
}
|
Applicability
Mistakes regarding precedence guidelines can cause an expression to be evaluated in an unintended way, which can lead to unexpected and abnormal program behavior.
Parentheses may be omitted from mathematical expressions that follow the algebraic precedence rules. For instance, consider the following expression:
Code Block |
---|
x + y * z
|
By mathematical convention, multiplication is performed before addition; parentheses are redundant in this case:
Code Block | ||
---|---|---|
| ||
x + (y * z)
|
Detection of all expressions using low-precedence operators without parentheses is straightforward. Determining the correctness of such uses is infeasible in the general case, although heuristic warnings could be useful.
Automated Detection
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
Parasoft Jtest |
| CERT.EXP53.APAREN | Use '()' to separate complex expressions | ||||||
SonarQube |
| S864 |
Bibliography
[ESA 2005] | Rule 65, Use parentheses to explicitly indicate the order of execution of numerical operators |
...