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