• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1//===- FuzzerFlags.def - Run-time flags -------------------------*- C++ -* ===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9// Flags. FUZZER_FLAG_INT/FUZZER_FLAG_STRING macros should be defined at the
10// point of inclusion. We are not using any flag parsing library for better
11// portability and independence.
12//===----------------------------------------------------------------------===//
13FUZZER_FLAG_INT(verbosity, 1, "Verbosity level.")
14FUZZER_FLAG_UNSIGNED(seed, 0, "Random seed. If 0, seed is generated.")
15FUZZER_FLAG_INT(runs, -1,
16            "Number of individual test runs (-1 for infinite runs).")
17FUZZER_FLAG_INT(max_len, 0, "Maximum length of the test input. "
18    "If 0, libFuzzer tries to guess a good value based on the corpus "
19    "and reports it. ")
20FUZZER_FLAG_INT(cross_over, 1, "If 1, cross over inputs.")
21FUZZER_FLAG_INT(mutate_depth, 5,
22            "Apply this number of consecutive mutations to each input.")
23FUZZER_FLAG_INT(shuffle, 1, "Shuffle inputs at startup")
24FUZZER_FLAG_INT(prefer_small, 1,
25    "If 1, always prefer smaller inputs during the corpus shuffle.")
26FUZZER_FLAG_INT(
27    timeout, 1200,
28    "Timeout in seconds (if positive). "
29    "If one unit runs more than this number of seconds the process will abort.")
30FUZZER_FLAG_INT(error_exitcode, 77, "When libFuzzer itself reports a bug "
31  "this exit code will be used.")
32FUZZER_FLAG_INT(timeout_exitcode, 77, "When libFuzzer reports a timeout "
33  "this exit code will be used.")
34FUZZER_FLAG_INT(max_total_time, 0, "If positive, indicates the maximal total "
35                                   "time in seconds to run the fuzzer.")
36FUZZER_FLAG_INT(help, 0, "Print help.")
37FUZZER_FLAG_INT(merge, 0, "If 1, the 2-nd, 3-rd, etc corpora will be "
38  "merged into the 1-st corpus. Only interesting units will be taken. "
39  "This flag can be used to minimize a corpus.")
40FUZZER_FLAG_STRING(merge_control_file, "internal flag")
41FUZZER_FLAG_INT(minimize_crash, 0, "If 1, minimizes the provided"
42  " crash input. Use with -runs=N or -max_total_time=N to limit "
43  "the number attempts")
44FUZZER_FLAG_INT(minimize_crash_internal_step, 0, "internal flag")
45FUZZER_FLAG_INT(use_counters, 1, "Use coverage counters")
46FUZZER_FLAG_INT(use_indir_calls, 1, "Use indirect caller-callee counters")
47FUZZER_FLAG_INT(use_memcmp, 1,
48                "Use hints from intercepting memcmp, strcmp, etc")
49FUZZER_FLAG_INT(use_memmem, 1,
50                "Use hints from intercepting memmem, strstr, etc")
51FUZZER_FLAG_INT(use_value_profile, 0,
52                "Experimental. Use value profile to guide fuzzing.")
53FUZZER_FLAG_INT(use_cmp, 1, "Use CMP traces to guide mutations")
54FUZZER_FLAG_INT(shrink, 0, "Experimental. Try to shrink corpus elements.")
55FUZZER_FLAG_UNSIGNED(jobs, 0, "Number of jobs to run. If jobs >= 1 we spawn"
56                          " this number of jobs in separate worker processes"
57                          " with stdout/stderr redirected to fuzz-JOB.log.")
58FUZZER_FLAG_UNSIGNED(workers, 0,
59            "Number of simultaneous worker processes to run the jobs."
60            " If zero, \"min(jobs,NumberOfCpuCores()/2)\" is used.")
61FUZZER_FLAG_INT(reload, 1,
62                "Reload the main corpus every <N> seconds to get new units"
63                " discovered by other processes. If 0, disabled")
64FUZZER_FLAG_INT(report_slow_units, 10,
65    "Report slowest units if they run for more than this number of seconds.")
66FUZZER_FLAG_INT(only_ascii, 0,
67                "If 1, generate only ASCII (isprint+isspace) inputs.")
68FUZZER_FLAG_STRING(dict, "Experimental. Use the dictionary file.")
69FUZZER_FLAG_STRING(artifact_prefix, "Write fuzzing artifacts (crash, "
70                                    "timeout, or slow inputs) as "
71                                    "$(artifact_prefix)file")
72FUZZER_FLAG_STRING(exact_artifact_path,
73                   "Write the single artifact on failure (crash, timeout) "
74                   "as $(exact_artifact_path). This overrides -artifact_prefix "
75                   "and will not use checksum in the file name. Do not "
76                   "use the same path for several parallel processes.")
77FUZZER_FLAG_INT(output_csv, 0, "Enable pulse output in CSV format.")
78FUZZER_FLAG_INT(print_pcs, 0, "If 1, print out newly covered PCs.")
79FUZZER_FLAG_INT(print_final_stats, 0, "If 1, print statistics at exit.")
80FUZZER_FLAG_INT(print_corpus_stats, 0,
81  "If 1, print statistics on corpus elements at exit.")
82FUZZER_FLAG_INT(print_coverage, 0, "If 1, print coverage information at exit."
83                                   " Experimental, only with trace-pc-guard")
84FUZZER_FLAG_INT(dump_coverage, 0, "If 1, dump coverage information at exit."
85                                  " Experimental, only with trace-pc-guard")
86FUZZER_FLAG_INT(handle_segv, 1, "If 1, try to intercept SIGSEGV.")
87FUZZER_FLAG_INT(handle_bus, 1, "If 1, try to intercept SIGSEGV.")
88FUZZER_FLAG_INT(handle_abrt, 1, "If 1, try to intercept SIGABRT.")
89FUZZER_FLAG_INT(handle_ill, 1, "If 1, try to intercept SIGILL.")
90FUZZER_FLAG_INT(handle_fpe, 1, "If 1, try to intercept SIGFPE.")
91FUZZER_FLAG_INT(handle_int, 1, "If 1, try to intercept SIGINT.")
92FUZZER_FLAG_INT(handle_term, 1, "If 1, try to intercept SIGTERM.")
93FUZZER_FLAG_INT(close_fd_mask, 0, "If 1, close stdout at startup; "
94    "if 2, close stderr; if 3, close both. "
95    "Be careful, this will also close e.g. asan's stderr/stdout.")
96FUZZER_FLAG_INT(detect_leaks, 1, "If 1, and if LeakSanitizer is enabled "
97    "try to detect memory leaks during fuzzing (i.e. not only at shut down).")
98FUZZER_FLAG_INT(trace_malloc, 0, "If >= 1 will print all mallocs/frees. "
99    "If >= 2 will also print stack traces.")
100FUZZER_FLAG_INT(rss_limit_mb, 2048, "If non-zero, the fuzzer will exit upon"
101    "reaching this limit of RSS memory usage.")
102FUZZER_FLAG_STRING(exit_on_src_pos, "Exit if a newly found PC originates"
103    " from the given source location. Example: -exit_on_src_pos=foo.cc:123. "
104    "Used primarily for testing libFuzzer itself.")
105FUZZER_FLAG_STRING(exit_on_item, "Exit if an item with a given sha1 sum"
106    " was added to the corpus. "
107    "Used primarily for testing libFuzzer itself.")
108
109FUZZER_DEPRECATED_FLAG(exit_on_first)
110FUZZER_DEPRECATED_FLAG(save_minimized_corpus)
111FUZZER_DEPRECATED_FLAG(sync_command)
112FUZZER_DEPRECATED_FLAG(sync_timeout)
113FUZZER_DEPRECATED_FLAG(test_single_input)
114FUZZER_DEPRECATED_FLAG(drill)
115FUZZER_DEPRECATED_FLAG(truncate_units)
116