FlakyIterators

KO | EN

gitlite — search

#hacktoberfest #react #ai #golang #android #linux #docker #macos #nodejs #windows #awesome #cli #kubernetes #security

(★ 9)

A fast and dirty checker based on libclang which detects non-deterministic iteration

FlakyIterators Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![License](http://img.shields.io/:license-MIT-blue.svg)](https://github.com/yugr/FlakyIterators/blob/master/LICENSE.txt)
[![Build Status](https://github.com/yugr/FlakyIterators/actions/workflows/ci.yml/badge.svg)](https://github.com/yugr/FlakyIterators/actions)
[![codecov](https://codecov.io/gh/yugr/FlakyIterators/branch/master/graph/badge.svg)](https://codecov.io/gh/yugr/FlakyIterators)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/yugr/FlakyIterators.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/yugr/FlakyIterators/alerts/)
[![Coverity Scan](https://scan.coverity.com/projects/yugr-FlakyIterators/badge.svg)](https://scan.coverity.com/projects/yugr-FlakyIterators)

A fast and dirty checker which detects non-deterministic iteration e.g.
```
std::unordered_map<...> map;
for (auto [k, v] : map) {
  ...
}

std::map<Something *, ...> map;
for (auto [k, v] : map) {
  ...
}
```

Warnings are reported only if functions with predefined names (e.g. `printf`)
are encountered in a loop.

# Comparison with Clang Static Analyzer

CSA's [PointerIteration](https://clang.llvm.org/docs/analyzer/checkers.html#alpha-nondeterminism-pointeriteration-c) does not report nondeterministic iteration neither over ordered containers of pointers, nor over unordered containers of non-pointers.

# How to build

To build, install (on Debian/Ubuntu) `llvm`, `libclang-dev` and `libpcre3-dev`:
```
$ sudo apt-get install llvm libclang-dev libpcre3-dev
```
and run
```
$ make clean all
```

To build debug or sanitized versions run `make` with `DEBUG=1`, `ASAN=1` or `UBSAN=1`.

# How to use

Run `bin/find-flaky` on files you are interested in:
```
$ bin/find-flaky tests/3-unordered-map-notok.cc
find-flaky: warning: calling IO function 'printf' inside flaky loop
```

By default tool looks for most common IO functions (like `printf`)
but you provide your own patterns:
```
$ cat patterns.txt
# A useful comment
my_debug_fun
# Another one
other_fun
$ bin/find-flaky --patterns patterns.txt ...
```

Custom compile flags (usually `-D` and `-I`) can be supplied with `--cflags` parameter and
verbosity can be set with `-v` flag.
For additional options run `bin/find-flaky -h`.

# How to test

Build and then run
```
$ make test
Found no errors
```

# TODO

* support other loop types

FlakyIterators

FlakyIterators Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

FlakyIterators

FlakyIterators Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README