Project overview: zstd-safe
High level conclusions
Reachability and coverage overview
Warning:
The number of runtime covered functions are larger than the
number of reachable functions. This means that Fuzz Introspector found
there are more functions covered at runtime than what is considered
reachable based on the static analysis. This is a limitation in the
analysis as anything covered at runtime is by definition reachable by the
fuzzers.
This is likely due to a limitation in the static analysis. In this case, the
count of functions covered at runtime is the true value, which means this
is what should be considered "achieved" by the fuzzer.
Use the project functions table below to query all functions that were not covered at runtime.
Project functions overview
The following table shows data about each function in the project. The functions included in this table correspond to all functions that exist in the executables of the fuzzers. As such, there may be functions that are from third-party libraries.
For further technical details on the meaning of columns in the below table, please see the Glossary .
| Func name | Functions filename | Args | Function call depth | Reached by Fuzzers | Runtime reached by Fuzzers | Combined reached by Fuzzers | Fuzzers runtime hit | Func lines hit % | I Count | BB Count | Cyclomatic complexity | Functions reached | Reached by functions | Accumulated cyclomatic complexity | Undiscovered complexity |
|---|
Fuzzer details
Fuzzer: zstd_fuzzer
Call tree
The calltree shows the control flow of the fuzzer. This is overlaid with coverage information to display how much of the potential code a fuzzer can reach is in fact covered at runtime. In the following there is a link to a detailed calltree visualisation as well as a bitmap showing a high-level view of the calltree. For further information about these topics please see the glossary for full calltree and calltree overview
Call tree overview bitmap:
The distribution of callsites in terms of coloring is
| Color | Runtime hitcount | Callsite count | Percentage |
|---|---|---|---|
| red | 0 | 544 | 93.3% |
| gold | [1:9] | 0 | 0.0% |
| yellow | [10:29] | 0 | 0.0% |
| greenyellow | [30:49] | 0 | 0.0% |
| lawngreen | 50+ | 39 | 6.68% |
| All colors | 583 | 100 |
Fuzz blockers
The following nodes represent call sites where fuzz blockers occur.
| Amount of callsites blocked | Calltree index | Parent function | Callsite | Largest blocked function |
|---|---|---|---|---|
| 245 | 337 | CCtx::set_parameter | call site: 00337 | Reader::read_to_end |
| 106 | 0 | EP | call site: 00000 | Reader::read_to_end |
| 55 | 175 | DCtx::create | call site: 00175 | CCtx::compress_using_dict |
| 35 | 269 | DCtx::finish_one_shot | call site: 00269 | DCtx::reset_after_one_shot |
| 28 | 145 | zstd_safe::CCtx::default | call site: 00145 | std::io::Cursor::as_mut_ptr |
| 28 | 305 | Poison::record | call site: 00305 | CCtx::set_parameter |
| 11 | 254 | CCtx::finish_one_shot | call site: 00254 | DCtx::decompress_using_dict |
| 10 | 123 | fs::File::create | call site: 00123 | CCtx::try_create |
| 10 | 134 | ptr_void | call site: 00134 | |
| 7 | 234 | parse_code | call site: 00234 | CCtx::finish_one_shot |
| 3 | 242 | CCtx::finish_one_shot | call site: 00242 | CCtx::guard_workers |
| 2 | 107 | fs::File::create | call site: 00107 |
Runtime coverage analysis
| Function name | source code lines | source lines hit | percentage hit |
|---|
Files reached
| filename | functions hit |
|---|---|
| zstd-safe/fuzz/fuzz_targets/zstd_fuzzer.rs | 25 |
| zstd-safe/zstd-sys/examples/it_work.rs | 12 |
| zstd-safe/src/lib.rs | 78 |
| src/stream/write/mod.rs | 5 |
| src/lib.rs | 13 |
| tests/issue_251.rs | 12 |
| src/stream/zio/writer.rs | 5 |
| tests/issue_382.rs | 12 |
| src/stream/functions.rs | 14 |
| src/stream/zio/reader.rs | 11 |
| src/stream/raw.rs | 9 |
| src/dict.rs | 5 |
| zstd-safe/src/rust_allocator.rs | 1 |
| src/stream/read/mod.rs | 5 |
| src/bulk/compressor.rs | 2 |
Analyses and suggestions
Optimal target analysis
Remaining optimal interesting functions
The following table shows a list of functions that are optimal targets. Optimal targets are identified by finding the functions that in combination, yield a high code coverage.
| Func name | Functions filename | Arg count | Args | Function depth | hitcount | instr count | bb count | cyclomatic complexity | Reachable functions | Incoming references | total cyclomatic complexity | Unreached complexity |
|---|
Implementing fuzzers that target the above functions will improve reachability such that it becomes:
All functions overview
If you implement fuzzers for these functions, the status of all functions in the project will be:
| Func name | Functions filename | Args | Function call depth | Reached by Fuzzers | Runtime reached by Fuzzers | Combined reached by Fuzzers | Fuzzers runtime hit | Func lines hit % | I Count | BB Count | Cyclomatic complexity | Functions reached | Reached by functions | Accumulated cyclomatic complexity | Undiscovered complexity |
|---|
Fuzz engine guidance
This sections provides heuristics that can be used as input to a fuzz engine when running a given fuzz target. The current focus is on providing input that is usable by libFuzzer.
zstd-safe/fuzz/fuzz_targets/zstd_fuzzer.rs
Dictionary
Use this with the libFuzzer -dict=DICT.file flag
Fuzzer function priority
Use one of these functions as input to libfuzzer with flag: -focus_function name
-focus_function=['CCtx::set_parameter', 'DCtx::create', 'DCtx::finish_one_shot', 'zstd_safe::CCtx::default', 'Poison::record', 'CCtx::finish_one_shot', 'fs::File::create', 'ptr_void', 'parse_code']Runtime coverage analysis
This section shows analysis of runtime coverage data.
For futher technical details on how this section is generated, please see the Glossary .
Complex functions with low coverage
| Func name | Function total lines | Lines covered at runtime | percentage covered | Reached by fuzzers |
|---|---|---|---|---|
| zstd_safe::CCtx::set_parameter | 36 | 11 | 30.55% | |
| ZSTD_CCtxParams_setParameter | 185 | 9 | 4.864% | |
| ZSTD_buildSeqStore | 131 | 46 | 35.11% | |
| ZSTD_loadDictionaryContent | 93 | 33 | 35.48% | |
| ZSTD_opt_getNextMatchAndUpdateSeqStore | 35 | 10 | 28.57% | |
| ZSTD_rescaleFreqs | 97 | 49 | 50.51% | |
| ZSTD_decompressContinue | 143 | 57 | 39.86% |
Files and Directories in report
This section shows which files and directories are considered in this report. The main reason for showing this is fuzz introspector may include more code in the reasoning than is desired. This section helps identify if too many files/directories are included, e.g. third party code, which may be irrelevant for the threat model. In the event too much is included, fuzz introspector supports a configuration file that can exclude data from the report. See the following link for more information on how to create a config file: link
Files in report
| Source file | Reached by | Covered by |
|---|---|---|
| /src/zstd-rs/tests/issue_182.rs | [] | [] |
| /src/zstd-rs/zstd-safe/tests/support/rust_allocator.rs | [] | [] |
| /src/zstd-rs/zstd-safe/tests/with_rust_allocator_dictionaries.rs | [] | [] |
| /src/zstd-rs/tests/issue_381.rs | [] | [] |
| /src/zstd-rs/zstd-safe/zstd-sys/tests/opaque_handle_traits.rs | [] | [] |
| /src/zstd-rs/zstd-safe/tests/with_rust_allocator_one_shot.rs | [] | [] |
| /src/zstd-rs/zstd-safe/zstd-sys/build.rs | [] | [] |
| /src/zstd-rs/src/bulk/compressor.rs | ['zstd_fuzzer'] | ['zstd_fuzzer'] |
| /src/zstd-rs/src/stream/functions.rs | ['zstd_fuzzer'] | [] |
| /src/zstd-rs/bench/benches/zstd.rs | [] | [] |
| /src/zstd-rs/src/stream/tests.rs | [] | [] |
| /src/zstd-rs/src/dict.rs | ['zstd_fuzzer'] | [] |
| /src/zstd-rs/tests/with_rust_allocator.rs | [] | [] |
| /src/zstd-rs/src/stream/zio/reader.rs | ['zstd_fuzzer'] | [] |
| /src/zstd-rs/zstd-safe/zstd-sys/examples/it_work.rs | ['zstd_fuzzer'] | [] |
| /src/zstd-rs/src/bulk/decompressor.rs | [] | [] |
| /src/zstd-rs/src/stream/zio/writer.rs | ['zstd_fuzzer'] | [] |
| /src/zstd-rs/src/stream/write/tests.rs | [] | [] |
| /src/zstd-rs/zstd-safe/src/lib.rs | ['zstd_fuzzer'] | ['zstd_fuzzer'] |
| /src/zstd-rs/src/stream/raw.rs | ['zstd_fuzzer'] | ['zstd_fuzzer'] |
| /src/zstd-rs/src/stream/write/mod.rs | ['zstd_fuzzer'] | ['zstd_fuzzer'] |
| /src/zstd-rs/src/stream/mod.rs | [] | [] |
| /src/zstd-rs/zstd-safe/zstd-sys/src/wasm_shim.rs | [] | [] |
| /src/zstd-rs/src/bulk/mod.rs | [] | [] |
| /src/zstd-rs/tests/invalid_dictionary.rs | [] | [] |
| /src/zstd-rs/examples/throughput.rs | [] | [] |
| /src/zstd-rs/src/stream/read/tests.rs | [] | [] |
| /src/zstd-rs/zstd-safe/fuzz/fuzz_targets/zstd_fuzzer.rs | ['zstd_fuzzer'] | [] |
| /src/zstd-rs/src/stream/read/mod.rs | ['zstd_fuzzer'] | [] |
| /src/zstd-rs/examples/zstdcat.rs | [] | [] |
| /src/zstd-rs/zstd-safe/src/rust_allocator.rs | ['zstd_fuzzer'] | [] |
| /src/zstd-rs/src/lib.rs | ['zstd_fuzzer'] | [] |
| /src/zstd-rs/zstd-safe/tests/with_rust_allocator.rs | [] | [] |
| /src/zstd-rs/examples/zstd.rs | [] | [] |
| /src/zstd-rs/zstd-safe/src/tests.rs | [] | [] |
| /src/zstd-rs/src/bulk/tests.rs | [] | [] |
| /src/zstd-rs/examples/basic.rs | [] | [] |
| /src/zstd-rs/zstd-safe/src/seekable.rs | [] | [] |
| /src/zstd-rs/tests/issue_382.rs | ['zstd_fuzzer'] | ['zstd_fuzzer'] |
| /src/zstd-rs/tests/with_rust_allocator_stream.rs | [] | [] |
| /src/zstd-rs/tests/issue_251.rs | ['zstd_fuzzer'] | ['zstd_fuzzer'] |
Directories in report
| Directory |
|---|
| /src/zstd-rs/zstd-safe/zstd-sys/tests/ |
| /src/zstd-rs/zstd-safe/tests/support/ |
| /src/zstd-rs/zstd-safe/zstd-sys/ |
| /src/zstd-rs/zstd-safe/src/ |
| /src/zstd-rs/zstd-safe/fuzz/fuzz_targets/ |
| /src/zstd-rs/src/stream/read/ |
| /src/zstd-rs/src/stream/zio/ |
| /src/zstd-rs/src/ |
| /src/zstd-rs/src/stream/ |
| /src/zstd-rs/zstd-safe/zstd-sys/src/ |
| /src/zstd-rs/src/bulk/ |
| /src/zstd-rs/zstd-safe/tests/ |
| /src/zstd-rs/bench/benches/ |
| /src/zstd-rs/tests/ |
| /src/zstd-rs/src/stream/write/ |
| /src/zstd-rs/zstd-safe/zstd-sys/examples/ |
| /src/zstd-rs/examples/ |
Function call coverage
This section shows a list of 3rd party function calls and their relative coverage information. By static analysis of the target project code, all of the 3rd party function call and their caller information, including the source file and line number that initiate the call are captured. The caller source code file and line number are shown in column 2 while column 1 is the function name of the 3rd party function call. Each occurrent of the 3rd party function call will occuply a separate row. Column 3 of each row indicate if the 3rd party call in the source file line is unreachable. Column 4 lists all fuzzers that have covered that particular system call in that specific location (source file and line)during their dynamic fuzzing.
Function in each files in report
| Target sink | Callsite location | Reached by fuzzer | Covered by Fuzzers |
|---|
Metadata section
This sections shows the raw data that is used to produce this report. This is mainly used for further processing and developer debugging.
| Fuzzer | Calltree file | Program data file | Coverage file |
|---|---|---|---|
| zstd_fuzzer | fuzzerLogFile-zstd_fuzzer.data | fuzzerLogFile-zstd_fuzzer.data.yaml | zstd_fuzzer.covreport |