|
1 | 1 | ## Configuration for a CI Fuzz project
|
2 |
| -## Generated on 2024-09-12 |
| 2 | +## Generated on 2025-04-15 |
3 | 3 |
|
4 |
| -## The build system used to build this project. If not set, cifuzz tries |
5 |
| -## to detect the build system automatically. |
6 |
| -## Valid values: "bazel", "cmake", "other". |
| 4 | +## The build system used to build this project. If not set, cifuzz tries to |
| 5 | +## detect the build system automatically. |
| 6 | +## Valid values: "bazel", "cmake", "other" |
7 | 7 | build-system: cmake
|
8 | 8 |
|
9 |
| -## If the build system type is "other", this command is used by |
10 |
| -## `cifuzz run` to build the fuzz test. |
11 |
| -#build-command: "make my_fuzz_test" |
| 9 | +## Engine used for fuzzing, default is "libfuzzer-clang". |
| 10 | +## Valid values: "libfuzzer-clang", "honggfuzz-clang", "honggfuzz-gcc" |
| 11 | +#engine: honggfuzz-gcc |
12 | 12 |
|
13 |
| -## Directories containing sample inputs used as seeds for the |
14 |
| -## code under test. This is used only for fuzzing runs. |
15 |
| -## See https://llvm.org/docs/LibFuzzer.html#corpus |
| 13 | +## If the build system type is "other", this command is used to build the fuzz |
| 14 | +## tests. |
| 15 | +#build-command: make my_fuzz_test |
| 16 | + |
| 17 | +## If the build system type is "other", this command is used to list the names |
| 18 | +## of already existing fuzz tests in your project. This allows running all fuzz |
| 19 | +## tests in the project without listing them explicitly, supports fuzz test |
| 20 | +## generation and enables fuzz test completion for commands. |
| 21 | +## The listed names should be separated by whitespace and can't include |
| 22 | +## whitespaces themselves, i.e. 'fuzz_test1 fuzz_test_2 ...' |
| 23 | +#list-fuzz-tests-command: echo my_fuzz_test |
| 24 | + |
| 25 | +## Command-line arguments to pass directly to the build system to use when |
| 26 | +## building fuzz tests. |
| 27 | +#build-system-args: |
| 28 | +# - -DBUILD_TESTS=ON |
| 29 | + |
| 30 | +## Directories containing sample inputs used as seeds for running fuzz tests. |
| 31 | +## For general information on seed corpora, see: |
| 32 | +## https://docs.code-intelligence.com/glossary#seed-corpus |
16 | 33 | #seed-corpus-dirs:
|
17 | 34 | # - path/to/seed-corpus
|
18 | 35 |
|
19 |
| -## Directories containing inputs used for calculating coverage. |
| 36 | +## Directories containing inputs for calculating coverage. These are used in |
| 37 | +## addition to inputs found in the directory of the fuzz test. |
20 | 38 | #corpus-dirs:
|
21 | 39 | # - path/to/corpus
|
22 | 40 |
|
23 |
| -## A file containing input language keywords or other interesting byte |
24 |
| -## sequences. |
25 |
| -## See https://llvm.org/docs/LibFuzzer.html#dictionaries |
| 41 | +## File containing input language keywords or other interesting byte sequences |
| 42 | +## used for running fuzz tests. |
| 43 | +## For libFuzzer see: https://llvm.org/docs/LibFuzzer.html#dictionaries |
26 | 44 | #dict: path/to/dictionary.dct
|
27 | 45 |
|
28 |
| -## Command-line arguments to pass to libFuzzer. |
29 |
| -## See https://llvm.org/docs/LibFuzzer.html#options |
| 46 | +## Command-line arguments to pass to the fuzzing engine when running fuzz tests. |
| 47 | +## For libFuzzer see: https://llvm.org/docs/LibFuzzer.html#options |
30 | 48 | engine-args:
|
31 |
| - - -use_value_profile=1 |
| 49 | + - -use_value_profile=1 # Only use value profile with libFuzzer! Never use it with Honggfuzz! |
32 | 50 | # - -rss_limit_mb=4096
|
33 | 51 |
|
34 |
| -## Maximum time to run all fuzz tests. The default is to run for 10 minutes. |
| 52 | +## Maximum time to run all fuzz tests. Default is 10 minutes. The time will be |
| 53 | +## split up evenly between multiple fuzz tests. To keep running indefinitely, |
| 54 | +## set value to 0. |
35 | 55 | max-fuzzing-duration: 0
|
36 | 56 | max-idle-time: 0
|
| 57 | + |
37 | 58 | ## Set to true to print output of the `cifuzz run` command as JSON.
|
38 | 59 | #print-json: true
|
39 | 60 |
|
40 | 61 | ## Set to true to disable desktop notifications.
|
41 | 62 | #no-notifications: true
|
42 | 63 |
|
43 |
| -## Style for CI Fuzz. |
| 64 | +## Set style for command output. |
| 65 | +## Valid values: "pretty", "plain" |
44 | 66 | #style: plain
|
0 commit comments