[libFuzzer] better documentatio for -save_minimized_corpus=1
[oota-llvm.git] / lib / Fuzzer / FuzzerFlags.def
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 //===----------------------------------------------------------------------===//
13 FUZZER_FLAG_INT(verbosity, 1, "Verbosity level.")
14 FUZZER_FLAG_INT(seed, 0, "Random seed. If 0, seed is generated.")
15 FUZZER_FLAG_INT(runs, -1,
16             "Number of individual test runs (-1 for infinite runs).")
17 FUZZER_FLAG_INT(max_len, 64, "Maximum length of the test input.")
18 FUZZER_FLAG_INT(cross_over, 1, "If 1, cross over inputs.")
19 FUZZER_FLAG_INT(mutate_depth, 5,
20             "Apply this number of consecutive mutations to each input.")
21 FUZZER_FLAG_INT(
22     prefer_small_during_initial_shuffle, -1,
23     "If 1, always prefer smaller inputs during the initial corpus shuffle."
24     " If 0, never do that. If -1, do it sometimes.")
25 FUZZER_FLAG_INT(exit_on_first, 0,
26             "If 1, exit after the first new interesting input is found.")
27 FUZZER_FLAG_INT(
28     timeout, 1200,
29     "Timeout in seconds (if positive). "
30     "If one unit runs more than this number of seconds the process will abort.")
31 FUZZER_FLAG_INT(help, 0, "Print help.")
32 FUZZER_FLAG_INT(
33     save_minimized_corpus, 0,
34     "If 1, the minimized corpus is saved into the first input directory. "
35     "Example: ./fuzzer -save_minimized_corpus=1 NEW_EMPTY_DIR OLD_CORPUS")
36 FUZZER_FLAG_INT(use_counters, 1, "Use coverage counters")
37 FUZZER_FLAG_INT(use_traces, 0, "Experimental: use instruction traces")
38 FUZZER_FLAG_INT(use_full_coverage_set, 0,
39             "Experimental: Maximize the number of different full"
40             " coverage sets as opposed to maximizing the total coverage."
41             " This is potentially MUCH slower, but may discover more paths.")
42 FUZZER_FLAG_INT(jobs, 0, "Number of jobs to run. If jobs >= 1 we spawn"
43                           " this number of jobs in separate worker processes"
44                           " with stdout/stderr redirected to fuzz-JOB.log.")
45 FUZZER_FLAG_INT(workers, 0,
46             "Number of simultaneous worker processes to run the jobs."
47             " If zero, \"min(jobs,NumberOfCpuCores()/2)\" is used.")
48 FUZZER_FLAG_INT(reload, 1,
49                 "Reload the main corpus periodically to get new units"
50                 " discovered by other processes.")
51 FUZZER_FLAG_STRING(deprecated_tokens,
52                    "Use the file with tokens (one token per line) to"
53                    " fuzz a token based input language.")
54 FUZZER_FLAG_STRING(apply_tokens, "Read the given input file, substitute bytes "
55                                  " with tokens and write the result to stdout.")
56 FUZZER_FLAG_STRING(sync_command, "Execute an external command "
57                                  "\"<sync_command> <test_corpus>\" "
58                                  "to synchronize the test corpus.")
59 FUZZER_FLAG_INT(sync_timeout, 600, "Minimum timeout between syncs.")
60 FUZZER_FLAG_INT(report_slow_units, 10,
61     "Report slowest units if they run for more than this number of seconds.")
62 FUZZER_FLAG_INT(only_ascii, 0,
63                 "If 1, generate only ASCII (isprint+isspace) inputs.")
64 FUZZER_FLAG_STRING(dict, "Experimental. Use the dictionary file.")
65 FUZZER_FLAG_INT(tbm_depth, 5, "Apply at most this number of consecutive"
66                                "trace-based-mutations (tbm).")
67 FUZZER_FLAG_INT(tbm_width, 5, "Apply at most this number of independent"
68                                "trace-based-mutations (tbm)")