`A4-7-1`: false positives in for loops
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 28/100
Research direction
Start by locating the CodeQL query for affected rule A4-7-1 and compare its behavior with the C++ examples in this issue. The work is done when the shown loop-counter, bounded-iteration, container-size, and auxiliary-span cases no longer produce false positives while genuine overflow risks remain reported.
Written by the indexing model from the issue text.
Description
Affected rules
A4-7-1
Description
Typical increment by one in for loops cannot lead to overflow or wrap-around because the number of iterations isn't large enough. The example illustrates true negatives together with false positives:
- in
fthe variable used as "loop counter" is defined inside or outside the scope of the loop, - and in
gthe number of iterations changes by a factor 100, although still not close to int limit - in general I think a query should take into account, if possible, the value used to initialize the counter and the (potential maximum) number of iterations. - iterating through a container through an auxiliary span of its values (rather than through the container directly).
Example
#include <array>
void f() {
const int num_iter = 100000;
for (int i = 0; i < num_iter; i++) { // OK.
;
}
int j = 0;
for (; j < num_iter; j++) { // False Positive.
;
}
}
void g() {
constexpr int N1000 = 1000;
std::array<int, N1000> arr1000;
std::size_t idx = 0;
for (; idx < arr1000.size(); ++idx) { // OK.
;
}
constexpr int N100000 = 100000;
std::array<int, N100000> arr100000;
idx = 0;
for (; idx < arr100000.size(); ++idx) { // False Positive.
;
}
}
namespace {
// AUTOSAR is C++14, so a quick C++20's span:
template<typename T>
class span
{
public:
span(T* data, std::size_t s) : data_member(data), size_(s) {}
std::size_t size() { return size_; }
private:
T* data_member;
std::size_t size_;
};
// This could be a member (non-template) function in a custom (template) container.
template<typename Container>
constexpr span<typename Container::value_type> values(Container& c) {
return {c.data(), c.size()};
}
}
int main() {
constexpr int N = 1;
std::array<int, N> arr;
auto values = ::values(arr);
std::size_t idx = 0;
for (; idx < values.size(); ++idx) { // False Positive.
; // Avoid assuming N is declared in the same scope, but OK that it is a
// std::size_t NTTP and/or data member of the container argument to values().
}
}
- Dominant language
- CodeQL
- Stars
- 227
- Forks
- 82
- Avg merge
- 6d 7h
- Merged PRs (30d)
- 9
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/codeql-coding-standards
-
false positive/false negative Stardard-MISRA-C++
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
github/codeql-coding-standards#1172 ·
-
Difficulty-Low false positive/false negative false-negative Impact-Low Standard-MISRA-C
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty-Medium false positive/false negative false-positive Impact-Medium Standard-CERT-C
Difficulty 4/5 3-5 days Newbie friendliness 48/100
github/codeql-coding-standards#1200 ·
-
`RULE-0-0-1`: "unreachable statement" false positives due to over-pruning of the control-flow graph Openfalse positive/false negative
Difficulty 4/5 3-5 days Newbie friendliness 48/100
github/codeql-coding-standards#1190 ·
-
false positive/false negative
Difficulty 3/5 1-2 days Newbie friendliness 65/100
github/codeql-coding-standards#1175 ·
All issues in github/codeql-coding-standards
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ScoopInstaller/Nonportable#639 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
ScoopInstaller/Extras#18800 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
uqbar-project/website-wollok-ts#84 · 2 comments ·
-
on hold T: core-bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100