Division and modulo remainder operations performed on integers are susceptible to divide-by-zero errors. Consequently, the divisor in a division or modulo remainder operation on integer types must be checked for zero prior to the operation. Division and remainder operations performed on floating-point numbers are not subject to this rule.
Noncompliant Code Example (Division)
The result of the / operator is the quotient from the division of the first arithmetic operand by the second arithmetic operand. Division operations are susceptible to divide-by-zero errors. Overflow can also occur during two's-complement signed integer division when the dividend is equal to the minimum (negative) value for the signed integer type and the divisor is equal to —1. (See rule "−1 (see NUM00-J. Detect or prevent integer overflow".)This code for more information). This noncompliant code example can result in a divide-by-zero error during the division of the signed operands num1 and num2.:
| Code Block | ||
|---|---|---|
| ||
long num1, num2, result;
/* Initialize num1 and num2 */
result = num1 / num2;
|
Compliant Solution (Division)
This compliant solution tests the suspect division operation divisor to guarantee there is no possibility of divide-by-zero errors.:
| Code Block | ||
|---|---|---|
| ||
long num1, num2, result; /* Initialize num1 and num2 */ if ((num2 == 0)) { // handleHandle error } else { result = num1 / num2; } |
Noncompliant Code Example (
...
Remainder)
The % operator provides the remainder when two operands of integer type are divided. This noncompliant code example can result in a divide-by-zero error during the remainder operation on the signed operands num1 and num2.:
| Code Block | ||
|---|---|---|
| ||
long num1, num2, result;
/* Initialize num1 and num2 */
result = num1 % num2;
|
Compliant Solution (Remainder)
This compliant solution tests the suspect remainder operation divisor to guarantee there is no possibility of a divide-by-zero error.:
| Code Block | ||
|---|---|---|
| ||
long num1, num2, result; /* Initialize num1 and num2 */ if ((num2 == 0)) { // handleHandle error } else { result = num1 % num2; } |
Risk Assessment
A divide-division or remainder by - zero can result in abnormal program termination and denial-of-service (DoS).
Rule | Severity | Likelihood | Detectable |
|---|
Repairable | Priority | Level |
|---|---|---|
NUM02-J | Low |
Likely |
No |
Yes | P6 | L2 |
Automated Detection
Automated detection exists for C and C++, but not for Java yet.
Related Guidelines
Tool | Version | Checker | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Coverity | 7.5 | DIVIDE_BY_ZERO | Implemented | ||||||
| Parasoft Jtest |
| CERT.NUM02.ZERO | Avoid division by zero | ||||||
| PVS-Studio |
| V6020 | |||||||
| SonarQube |
| S3518 | Zero should not be a possible denominator |
Related Guidelines
INT33-C. Ensure that division and modulo operations do not result in divide-by-zero errors
Divide |
by Zero |
Bibliography
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="22c53991-dc93-4059-ad55-54988691dee8"><ac:plain-text-body><![CDATA[
1999] |
Subclause 6.5.5, "Multiplicative |
]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="36d09f37-bf55-4907-a910-8cce4031ecec"><ac:plain-text-body><![CDATA[
[[Seacord 05
Operators" | |
Chapter 5, "Integers" |
]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3c635232-bd88-420e-8814-97896d12dada"><ac:plain-text-body><![CDATA[
[[Warren 02
| [Seacord 2015] | |
Chapter 2, "Basics" |
]]></ac:plain-text-body></ac:structured-macro>
...
NUM01-J. Avoid performing bitwise and arithmetic operations on the same data 03. Numeric Types and Operations (NUM)