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(cross_over, 1, "If 1, cross over inputs.") 27FUZZER_FLAG_INT(mutate_depth, 5, 28 "Apply this number of consecutive mutations to each input.") 29FUZZER_FLAG_INT(reduce_depth, 0, "Experimental/internal. " 30 "Reduce depth if mutations lose unique features") 31FUZZER_FLAG_INT(shuffle, 1, "Shuffle inputs at startup") 32FUZZER_FLAG_INT(prefer_small, 1, 33 "If 1, always prefer smaller inputs during the corpus shuffle.") 34FUZZER_FLAG_INT( 35 timeout, 1200, 36 "Timeout in seconds (if positive). " 37 "If one unit runs more than this number of seconds the process will abort.") 38FUZZER_FLAG_INT(error_exitcode, 77, "When libFuzzer itself reports a bug " 39 "this exit code will be used.") 40FUZZER_FLAG_INT(timeout_exitcode, 70, "When libFuzzer reports a timeout " 41 "this exit code will be used.") 42FUZZER_FLAG_INT(max_total_time, 0, "If positive, indicates the maximal total " 43 "time in seconds to run the fuzzer.") 44FUZZER_FLAG_INT(help, 0, "Print help.") 45FUZZER_FLAG_INT(fork, 0, "Experimental mode where fuzzing happens " 46 "in a subprocess") 47FUZZER_FLAG_INT(ignore_timeouts, 1, "Ignore timeouts in fork mode") 48FUZZER_FLAG_INT(ignore_ooms, 1, "Ignore OOMs in fork mode") 49FUZZER_FLAG_INT(ignore_crashes, 0, "Ignore crashes in fork mode") 50FUZZER_FLAG_INT(merge, 0, "If 1, the 2-nd, 3-rd, etc corpora will be " 51 "merged into the 1-st corpus. Only interesting units will be taken. " 52 "This flag can be used to minimize a corpus.") 53FUZZER_FLAG_STRING(stop_file, "Stop fuzzing ASAP if this file exists") 54FUZZER_FLAG_STRING(merge_inner, "internal flag") 55FUZZER_FLAG_STRING(merge_control_file, 56 "Specify a control file used for the merge process. " 57 "If a merge process gets killed it tries to leave this file " 58 "in a state suitable for resuming the merge. " 59 "By default a temporary file will be used." 60 "The same file can be used for multistep merge process.") 61FUZZER_FLAG_INT(minimize_crash, 0, "If 1, minimizes the provided" 62 " crash input. Use with -runs=N or -max_total_time=N to limit " 63 "the number attempts." 64 " Use with -exact_artifact_path to specify the output." 65 " Combine with ASAN_OPTIONS=dedup_token_length=3 (or similar) to ensure that" 66 " the minimized input triggers the same crash." 67 ) 68FUZZER_FLAG_INT(cleanse_crash, 0, "If 1, tries to cleanse the provided" 69 " crash input to make it contain fewer original bytes." 70 " Use with -exact_artifact_path to specify the output." 71 ) 72FUZZER_FLAG_INT(minimize_crash_internal_step, 0, "internal flag") 73FUZZER_FLAG_STRING(features_dir, "internal flag. Used to dump feature sets on disk." 74 "Every time a new input is added to the corpus, a corresponding file in the features_dir" 75 " is created containing the unique features of that input." 76 " Features are stored in binary format.") 77FUZZER_FLAG_INT(use_counters, 1, "Use coverage counters") 78FUZZER_FLAG_INT(use_memmem, 1, 79 "Use hints from intercepting memmem, strstr, etc") 80FUZZER_FLAG_INT(use_value_profile, 0, 81 "Experimental. Use value profile to guide fuzzing.") 82FUZZER_FLAG_INT(use_cmp, 1, "Use CMP traces to guide mutations") 83FUZZER_FLAG_INT(shrink, 0, "Experimental. Try to shrink corpus inputs.") 84FUZZER_FLAG_INT(reduce_inputs, 1, 85 "Try to reduce the size of inputs while preserving their full feature sets") 86FUZZER_FLAG_UNSIGNED(jobs, 0, "Number of jobs to run. If jobs >= 1 we spawn" 87 " this number of jobs in separate worker processes" 88 " with stdout/stderr redirected to fuzz-JOB.log.") 89FUZZER_FLAG_UNSIGNED(workers, 0, 90 "Number of simultaneous worker processes to run the jobs." 91 " If zero, \"min(jobs,NumberOfCpuCores()/2)\" is used.") 92FUZZER_FLAG_INT(reload, 1, 93 "Reload the main corpus every <N> seconds to get new units" 94 " discovered by other processes. If 0, disabled") 95FUZZER_FLAG_INT(report_slow_units, 10, 96 "Report slowest units if they run for more than this number of seconds.") 97FUZZER_FLAG_INT(only_ascii, 0, 98 "If 1, generate only ASCII (isprint+isspace) inputs.") 99FUZZER_FLAG_STRING(dict, "Experimental. Use the dictionary file.") 100FUZZER_FLAG_STRING(artifact_prefix, "Write fuzzing artifacts (crash, " 101 "timeout, or slow inputs) as " 102 "$(artifact_prefix)file") 103FUZZER_FLAG_STRING(exact_artifact_path, 104 "Write the single artifact on failure (crash, timeout) " 105 "as $(exact_artifact_path). This overrides -artifact_prefix " 106 "and will not use checksum in the file name. Do not " 107 "use the same path for several parallel processes.") 108FUZZER_FLAG_INT(print_pcs, 0, "If 1, print out newly covered PCs.") 109FUZZER_FLAG_INT(print_funcs, 2, "If >=1, print out at most this number of " 110 "newly covered functions.") 111FUZZER_FLAG_INT(print_final_stats, 0, "If 1, print statistics at exit.") 112FUZZER_FLAG_INT(print_corpus_stats, 0, 113 "If 1, print statistics on corpus elements at exit.") 114FUZZER_FLAG_INT(print_coverage, 0, "If 1, print coverage information as text" 115 " at exit.") 116FUZZER_FLAG_INT(dump_coverage, 0, "Deprecated.") 117FUZZER_FLAG_INT(handle_segv, 1, "If 1, try to intercept SIGSEGV.") 118FUZZER_FLAG_INT(handle_bus, 1, "If 1, try to intercept SIGBUS.") 119FUZZER_FLAG_INT(handle_abrt, 1, "If 1, try to intercept SIGABRT.") 120FUZZER_FLAG_INT(handle_ill, 1, "If 1, try to intercept SIGILL.") 121FUZZER_FLAG_INT(handle_fpe, 1, "If 1, try to intercept SIGFPE.") 122FUZZER_FLAG_INT(handle_int, 1, "If 1, try to intercept SIGINT.") 123FUZZER_FLAG_INT(handle_term, 1, "If 1, try to intercept SIGTERM.") 124FUZZER_FLAG_INT(handle_xfsz, 1, "If 1, try to intercept SIGXFSZ.") 125FUZZER_FLAG_INT(handle_usr1, 1, "If 1, try to intercept SIGUSR1.") 126FUZZER_FLAG_INT(handle_usr2, 1, "If 1, try to intercept SIGUSR2.") 127FUZZER_FLAG_INT(close_fd_mask, 0, "If 1, close stdout at startup; " 128 "if 2, close stderr; if 3, close both. " 129 "Be careful, this will also close e.g. stderr of asan.") 130FUZZER_FLAG_INT(detect_leaks, 1, "If 1, and if LeakSanitizer is enabled " 131 "try to detect memory leaks during fuzzing (i.e. not only at shut down).") 132FUZZER_FLAG_INT(purge_allocator_interval, 1, "Purge allocator caches and " 133 "quarantines every <N> seconds. When rss_limit_mb is specified (>0), " 134 "purging starts when RSS exceeds 50% of rss_limit_mb. Pass " 135 "purge_allocator_interval=-1 to disable this functionality.") 136FUZZER_FLAG_INT(trace_malloc, 0, "If >= 1 will print all mallocs/frees. " 137 "If >= 2 will also print stack traces.") 138FUZZER_FLAG_INT(rss_limit_mb, 2048, "If non-zero, the fuzzer will exit upon" 139 "reaching this limit of RSS memory usage.") 140FUZZER_FLAG_INT(malloc_limit_mb, 0, "If non-zero, the fuzzer will exit " 141 "if the target tries to allocate this number of Mb with one malloc call. " 142 "If zero (default) same limit as rss_limit_mb is applied.") 143FUZZER_FLAG_STRING(exit_on_src_pos, "Exit if a newly found PC originates" 144 " from the given source location. Example: -exit_on_src_pos=foo.cc:123. " 145 "Used primarily for testing libFuzzer itself.") 146FUZZER_FLAG_STRING(exit_on_item, "Exit if an item with a given sha1 sum" 147 " was added to the corpus. " 148 "Used primarily for testing libFuzzer itself.") 149FUZZER_FLAG_INT(ignore_remaining_args, 0, "If 1, ignore all arguments passed " 150 "after this one. Useful for fuzzers that need to do their own " 151 "argument parsing.") 152FUZZER_FLAG_STRING(focus_function, "Experimental. " 153 "Fuzzing will focus on inputs that trigger calls to this function. " 154 "If -focus_function=auto and -data_flow_trace is used, libFuzzer " 155 "will choose the focus functions automatically.") 156FUZZER_FLAG_INT(entropic, 0, "Experimental. Enables entropic power schedule.") 157FUZZER_FLAG_INT(entropic_feature_frequency_threshold, 0xFF, "Experimental. If " 158 "entropic is enabled, all features which are observed less often than " 159 "the specified value are considered as rare.") 160FUZZER_FLAG_INT(entropic_number_of_rarest_features, 100, "Experimental. If " 161 "entropic is enabled, we keep track of the frequencies only for the " 162 "Top-X least abundant features (union features that are considered as " 163 "rare).") 164 165FUZZER_FLAG_INT(analyze_dict, 0, "Experimental") 166FUZZER_DEPRECATED_FLAG(use_clang_coverage) 167FUZZER_FLAG_STRING(data_flow_trace, "Experimental: use the data flow trace") 168FUZZER_FLAG_STRING(collect_data_flow, 169 "Experimental: collect the data flow trace") 170