xref: /freebsd/contrib/llvm-project/compiler-rt/lib/fuzzer/FuzzerFlags.def (revision b59017c5cad90d0f09a59e68c00457b7faf93e7c) 
1//===- FuzzerFlags.def - Run-time flags -------------------------*- C++ -* ===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8// Flags. FUZZER_FLAG_INT/FUZZER_FLAG_STRING macros should be defined at the
9// point of inclusion. We are not using any flag parsing library for better
10// portability and independence.
11//===----------------------------------------------------------------------===//
12FUZZER_FLAG_INT(verbosity, 1, "Verbosity level.")
13FUZZER_FLAG_UNSIGNED(seed, 0, "Random seed. If 0, seed is generated.")
14FUZZER_FLAG_INT(runs, -1,
15            "Number of individual test runs (-1 for infinite runs).")
16FUZZER_FLAG_INT(max_len, 0, "Maximum length of the test input. "
17    "If 0, libFuzzer tries to guess a good value based on the corpus "
18    "and reports it. ")
19FUZZER_FLAG_INT(len_control, 100, "Try generating small inputs first, "
20  "then try larger inputs over time.  Specifies the rate at which the length "
21  "limit is increased (smaller == faster).  If 0, immediately try inputs with "
22  "size up to max_len. Default value is 0, if LLVMFuzzerCustomMutator is used.")
23FUZZER_FLAG_STRING(seed_inputs, "A comma-separated list of input files "
24  "to use as an additional seed corpus. Alternatively, an \"@\" followed by "
25  "the name of a file containing the comma-separated list.")
26FUZZER_FLAG_INT(keep_seed, 0, "If 1, keep seed inputs in the corpus even if "
27  "they do not produce new coverage. When used with |reduce_inputs==1|, the "
28  "seed inputs will never be reduced. This option can be useful when seeds are"
29  "not properly formed for the fuzz target but still have useful snippets.")
30FUZZER_FLAG_INT(cross_over, 1, "If 1, cross over inputs.")
31FUZZER_FLAG_INT(cross_over_uniform_dist, 0, "Experimental. If 1, use a "
32  "uniform probability distribution when choosing inputs to cross over with. "
33  "Some of the inputs in the corpus may never get chosen for mutation "
34  "depending on the input mutation scheduling policy. With this flag, all "
35  "inputs, regardless of the input mutation scheduling policy, can be chosen "
36  "as an input to cross over with. This can be particularly useful with "
37  "|keep_seed==1|; all the initial seed inputs, even though they do not "
38  "increase coverage because they are not properly formed, will still be "
39  "chosen as an input to cross over with.")
40
41FUZZER_FLAG_INT(mutate_depth, 5,
42            "Apply this number of consecutive mutations to each input.")
43FUZZER_FLAG_INT(reduce_depth, 0, "Experimental/internal. "
44                "Reduce depth if mutations lose unique features")
45FUZZER_FLAG_INT(shuffle, 1, "Shuffle inputs at startup")
46FUZZER_FLAG_INT(prefer_small, 1,
47    "If 1, always prefer smaller inputs during the corpus shuffle.")
48FUZZER_FLAG_INT(
49    timeout, 1200,
50    "Timeout in seconds (if positive). "
51    "If one unit runs more than this number of seconds the process will abort.")
52FUZZER_FLAG_INT(error_exitcode, 77, "When libFuzzer itself reports a bug "
53  "this exit code will be used.")
54FUZZER_FLAG_INT(timeout_exitcode, 70, "When libFuzzer reports a timeout "
55  "this exit code will be used.")
56FUZZER_FLAG_INT(max_total_time, 0, "If positive, indicates the maximal total "
57                                   "time in seconds to run the fuzzer.")
58FUZZER_FLAG_INT(help, 0, "Print help.")
59FUZZER_FLAG_INT(fork, 0, "Experimental mode where fuzzing happens "
60                "in a subprocess")
61FUZZER_FLAG_INT(fork_corpus_groups, 0, "For fork mode, enable the corpus-group "
62		"strategy, The main corpus will be grouped according to size, "
63		"and each sub-process will randomly select seeds from different "
64		"groups as the sub-corpus.")
65FUZZER_FLAG_INT(ignore_timeouts, 1, "Ignore timeouts in fork mode")
66FUZZER_FLAG_INT(ignore_ooms, 1, "Ignore OOMs in fork mode")
67FUZZER_FLAG_INT(ignore_crashes, 0, "Ignore crashes in fork mode")
68FUZZER_FLAG_INT(merge, 0, "If 1, the 2-nd, 3-rd, etc corpora will be "
69  "merged into the 1-st corpus. Only interesting units will be taken. "
70  "This flag can be used to minimize a corpus.")
71FUZZER_FLAG_INT(set_cover_merge, 0, "If 1, the 2-nd, 3-rd, etc corpora will be "
72  "merged into the 1-st corpus. Same as the 'merge' flag, but uses the "
73  "standard greedy algorithm for the set cover problem to "
74  "compute an approximation of the minimum set of testcases that "
75  "provide the same coverage as the initial corpora")
76FUZZER_FLAG_STRING(stop_file, "Stop fuzzing ASAP if this file exists")
77FUZZER_FLAG_STRING(merge_inner, "internal flag")
78FUZZER_FLAG_STRING(merge_control_file,
79                   "Specify a control file used for the merge process. "
80                   "If a merge process gets killed it tries to leave this file "
81                   "in a state suitable for resuming the merge. "
82                   "By default a temporary file will be used."
83                   "The same file can be used for multistep merge process.")
84FUZZER_FLAG_INT(minimize_crash, 0, "If 1, minimizes the provided"
85  " crash input. Use with -runs=N or -max_total_time=N to limit "
86  "the number attempts."
87  " Use with -exact_artifact_path to specify the output."
88  " Combine with ASAN_OPTIONS=dedup_token_length=3 (or similar) to ensure that"
89  " the minimized input triggers the same crash."
90  )
91FUZZER_FLAG_INT(cleanse_crash, 0, "If 1, tries to cleanse the provided"
92  " crash input to make it contain fewer original bytes."
93  " Use with -exact_artifact_path to specify the output."
94  )
95FUZZER_FLAG_INT(minimize_crash_internal_step, 0, "internal flag")
96FUZZER_FLAG_STRING(features_dir, "internal flag. Used to dump feature sets on disk."
97  "Every time a new input is added to the corpus, a corresponding file in the features_dir"
98  " is created containing the unique features of that input."
99  " Features are stored in binary format.")
100FUZZER_FLAG_STRING(mutation_graph_file, "Saves a graph (in DOT format) to"
101  " mutation_graph_file. The graph contains a vertex for each input that has"
102  " unique coverage; directed edges are provided between parents and children"
103  " where the child has unique coverage, and are recorded with the type of"
104  " mutation that caused the child.")
105FUZZER_FLAG_INT(use_counters, 1, "Use coverage counters")
106FUZZER_FLAG_INT(use_memmem, 1,
107                "Use hints from intercepting memmem, strstr, etc")
108FUZZER_FLAG_INT(use_value_profile, 0,
109                "Experimental. Use value profile to guide fuzzing.")
110FUZZER_FLAG_INT(use_cmp, 1, "Use CMP traces to guide mutations")
111FUZZER_FLAG_INT(shrink, 0, "Experimental. Try to shrink corpus inputs.")
112FUZZER_FLAG_INT(reduce_inputs, 1,
113  "Try to reduce the size of inputs while preserving their full feature sets")
114FUZZER_FLAG_UNSIGNED(jobs, 0, "Number of jobs to run. If jobs >= 1 we spawn"
115                          " this number of jobs in separate worker processes"
116                          " with stdout/stderr redirected to fuzz-JOB.log.")
117FUZZER_FLAG_UNSIGNED(workers, 0,
118            "Number of simultaneous worker processes to run the jobs."
119            " If zero, \"min(jobs,NumberOfCpuCores()/2)\" is used.")
120FUZZER_FLAG_INT(reload, 1,
121                "Reload the main corpus every <N> seconds to get new units"
122                " discovered by other processes. If 0, disabled")
123FUZZER_FLAG_INT(report_slow_units, 10,
124    "Report slowest units if they run for more than this number of seconds.")
125FUZZER_FLAG_INT(only_ascii, 0,
126                "If 1, generate only ASCII (isprint+isspace) inputs.")
127FUZZER_FLAG_STRING(dict, "Experimental. Use the dictionary file.")
128FUZZER_FLAG_STRING(artifact_prefix, "Write fuzzing artifacts (crash, "
129                                    "timeout, or slow inputs) as "
130                                    "$(artifact_prefix)file")
131FUZZER_FLAG_STRING(exact_artifact_path,
132                   "Write the single artifact on failure (crash, timeout) "
133                   "as $(exact_artifact_path). This overrides -artifact_prefix "
134                   "and will not use checksum in the file name. Do not "
135                   "use the same path for several parallel processes.")
136FUZZER_FLAG_INT(print_pcs, 0, "If 1, print out newly covered PCs.")
137FUZZER_FLAG_INT(print_funcs, 2, "If >=1, print out at most this number of "
138                                "newly covered functions.")
139FUZZER_FLAG_INT(print_final_stats, 0, "If 1, print statistics at exit.")
140FUZZER_FLAG_INT(print_corpus_stats, 0,
141  "If 1, print statistics on corpus elements at exit.")
142FUZZER_FLAG_INT(print_coverage, 0, "If 1, print coverage information as text"
143                                   " at exit.")
144FUZZER_FLAG_INT(print_full_coverage, 0, "If 1, print full coverage information "
145                                        "(all branches) as text at exit.")
146FUZZER_FLAG_INT(dump_coverage, 0, "Deprecated.")
147FUZZER_FLAG_INT(handle_segv, 1, "If 1, try to intercept SIGSEGV.")
148FUZZER_FLAG_INT(handle_bus, 1, "If 1, try to intercept SIGBUS.")
149FUZZER_FLAG_INT(handle_abrt, 1, "If 1, try to intercept SIGABRT.")
150FUZZER_FLAG_INT(handle_ill, 1, "If 1, try to intercept SIGILL.")
151FUZZER_FLAG_INT(handle_fpe, 1, "If 1, try to intercept SIGFPE.")
152FUZZER_FLAG_INT(handle_int, 1, "If 1, try to intercept SIGINT.")
153FUZZER_FLAG_INT(handle_term, 1, "If 1, try to intercept SIGTERM.")
154FUZZER_FLAG_INT(handle_xfsz, 1, "If 1, try to intercept SIGXFSZ.")
155FUZZER_FLAG_INT(handle_usr1, 1, "If 1, try to intercept SIGUSR1.")
156FUZZER_FLAG_INT(handle_usr2, 1, "If 1, try to intercept SIGUSR2.")
157FUZZER_FLAG_INT(handle_winexcept, 1, "If 1, try to intercept uncaught Windows "
158    "Visual C++ Exceptions.")
159FUZZER_FLAG_INT(close_fd_mask, 0, "If 1, close stdout at startup; "
160    "if 2, close stderr; if 3, close both. "
161    "Be careful, this will also close e.g. stderr of asan.")
162FUZZER_FLAG_INT(detect_leaks, 1, "If 1, and if LeakSanitizer is enabled "
163    "try to detect memory leaks during fuzzing (i.e. not only at shut down).")
164FUZZER_FLAG_INT(purge_allocator_interval, 1, "Purge allocator caches and "
165    "quarantines every <N> seconds. When rss_limit_mb is specified (>0), "
166    "purging starts when RSS exceeds 50% of rss_limit_mb. Pass "
167    "purge_allocator_interval=-1 to disable this functionality.")
168FUZZER_FLAG_INT(trace_malloc, 0, "If >= 1 will print all mallocs/frees. "
169    "If >= 2 will also print stack traces.")
170FUZZER_FLAG_INT(rss_limit_mb, 2048, "If non-zero, the fuzzer will exit upon "
171    "reaching this limit of RSS memory usage.")
172FUZZER_FLAG_INT(malloc_limit_mb, 0, "If non-zero, the fuzzer will exit "
173    "if the target tries to allocate this number of Mb with one malloc call. "
174    "If zero (default) same limit as rss_limit_mb is applied.")
175FUZZER_FLAG_STRING(exit_on_src_pos, "Exit if a newly found PC originates"
176    " from the given source location. Example: -exit_on_src_pos=foo.cc:123. "
177    "Used primarily for testing libFuzzer itself.")
178FUZZER_FLAG_STRING(exit_on_item, "Exit if an item with a given sha1 sum"
179    " was added to the corpus. "
180    "Used primarily for testing libFuzzer itself.")
181FUZZER_FLAG_INT(ignore_remaining_args, 0, "If 1, ignore all arguments passed "
182                "after this one. Useful for fuzzers that need to do their own "
183                "argument parsing.")
184FUZZER_FLAG_STRING(focus_function, "Experimental. "
185     "Fuzzing will focus on inputs that trigger calls to this function. "
186     "If -focus_function=auto and -data_flow_trace is used, libFuzzer "
187     "will choose the focus functions automatically. Disables -entropic when "
188     "specified.")
189FUZZER_FLAG_INT(entropic, 1, "Enables entropic power schedule.")
190FUZZER_FLAG_INT(entropic_feature_frequency_threshold, 0xFF, "Experimental. If "
191     "entropic is enabled, all features which are observed less often than "
192     "the specified value are considered as rare.")
193FUZZER_FLAG_INT(entropic_number_of_rarest_features, 100, "Experimental. If "
194     "entropic is enabled, we keep track of the frequencies only for the "
195     "Top-X least abundant features (union features that are considered as "
196     "rare).")
197FUZZER_FLAG_INT(entropic_scale_per_exec_time, 0, "Experimental. If 1, "
198     "the Entropic power schedule gets scaled based on the input execution "
199     "time. Inputs with lower execution time get scheduled more (up to 30x). "
200     "Note that, if 1, fuzzer stops from being deterministic even if a "
201     "non-zero random seed is given.")
202
203FUZZER_FLAG_INT(analyze_dict, 0, "Experimental")
204FUZZER_DEPRECATED_FLAG(use_clang_coverage)
205FUZZER_FLAG_STRING(data_flow_trace, "Experimental: use the data flow trace")
206FUZZER_FLAG_STRING(collect_data_flow,
207                   "Experimental: collect the data flow trace")
208
209FUZZER_FLAG_INT(create_missing_dirs, 0, "Automatically attempt to create "
210     "directories for arguments that would normally expect them to already "
211     "exist (i.e. artifact_prefix, exact_artifact_path, features_dir, corpus)")
212