Home | History | Annotate | Download | only in Fuzzer
      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(cross_over, 1, "If 1, cross over inputs.")
     21 FUZZER_FLAG_INT(mutate_depth, 5,
     22             "Apply this number of consecutive mutations to each input.")
     23 FUZZER_FLAG_INT(shuffle, 1, "Shuffle inputs at startup")
     24 FUZZER_FLAG_INT(prefer_small, 1,
     25     "If 1, always prefer smaller inputs during the corpus shuffle.")
     26 FUZZER_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.")
     30 FUZZER_FLAG_INT(timeout_exitcode, 77,
     31                 "Unless abort_on_timeout is set, use this exitcode on timeout.")
     32 FUZZER_FLAG_INT(error_exit_code, 77, "When libFuzzer's signal handlers are in "
     33   "use exit with this exitcode after catching a deadly signal.")
     34 FUZZER_FLAG_INT(max_total_time, 0, "If positive, indicates the maximal total "
     35                                    "time in seconds to run the fuzzer.")
     36 FUZZER_FLAG_INT(help, 0, "Print help.")
     37 FUZZER_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.")
     40 FUZZER_FLAG_INT(use_counters, 1, "Use coverage counters")
     41 FUZZER_FLAG_INT(use_indir_calls, 1, "Use indirect caller-callee counters")
     42 FUZZER_FLAG_INT(use_traces, 0, "Experimental: use instruction traces")
     43 FUZZER_FLAG_INT(use_memcmp, 1,
     44                 "Use hints from intercepting memcmp, strcmp, etc")
     45 FUZZER_FLAG_INT(jobs, 0, "Number of jobs to run. If jobs >= 1 we spawn"
     46                           " this number of jobs in separate worker processes"
     47                           " with stdout/stderr redirected to fuzz-JOB.log.")
     48 FUZZER_FLAG_INT(workers, 0,
     49             "Number of simultaneous worker processes to run the jobs."
     50             " If zero, \"min(jobs,NumberOfCpuCores()/2)\" is used.")
     51 FUZZER_FLAG_INT(reload, 1,
     52                 "Reload the main corpus periodically to get new units"
     53                 " discovered by other processes.")
     54 FUZZER_FLAG_INT(report_slow_units, 10,
     55     "Report slowest units if they run for more than this number of seconds.")
     56 FUZZER_FLAG_INT(only_ascii, 0,
     57                 "If 1, generate only ASCII (isprint+isspace) inputs.")
     58 FUZZER_FLAG_STRING(dict, "Experimental. Use the dictionary file.")
     59 FUZZER_FLAG_STRING(artifact_prefix, "Write fuzzing artifacts (crash, "
     60                                     "timeout, or slow inputs) as "
     61                                     "$(artifact_prefix)file")
     62 FUZZER_FLAG_STRING(exact_artifact_path,
     63                    "Write the single artifact on failure (crash, timeout) "
     64                    "as $(exact_artifact_path). This overrides -artifact_prefix "
     65                    "and will not use checksum in the file name. Do not "
     66                    "use the same path for several parallel processes.")
     67 FUZZER_FLAG_INT(drill, 0, "Experimental: fuzz using a single unit as the seed "
     68                           "corpus, then merge with the initial corpus")
     69 FUZZER_FLAG_INT(output_csv, 0, "Enable pulse output in CSV format.")
     70 FUZZER_FLAG_INT(print_new_cov_pcs, 0, "If 1, print out new covered pcs.")
     71 FUZZER_FLAG_INT(print_final_stats, 0, "If 1, print statistics at exit.")
     72 
     73 FUZZER_FLAG_INT(handle_segv, 1, "If 1, try to intercept SIGSEGV.")
     74 FUZZER_FLAG_INT(handle_bus, 1, "If 1, try to intercept SIGSEGV.")
     75 FUZZER_FLAG_INT(handle_abrt, 1, "If 1, try to intercept SIGABRT.")
     76 FUZZER_FLAG_INT(handle_ill, 1, "If 1, try to intercept SIGILL.")
     77 FUZZER_FLAG_INT(handle_fpe, 1, "If 1, try to intercept SIGFPE.")
     78 FUZZER_FLAG_INT(handle_int, 1, "If 1, try to intercept SIGINT.")
     79 FUZZER_FLAG_INT(handle_term, 1, "If 1, try to intercept SIGTERM.")
     80 FUZZER_FLAG_INT(close_fd_mask, 0, "If 1, close stdout at startup; "
     81     "if 2, close stderr; if 3, close both. "
     82     "Be careful, this will also close e.g. asan's stderr/stdout.")
     83 FUZZER_FLAG_INT(detect_leaks, 1, "If 1, and if LeakSanitizer is enabled "
     84     "try to detect memory leaks during fuzzing (i.e. not only at shut down).")
     85 FUZZER_FLAG_INT(rss_limit_mb, 2048, "If non-zero, the fuzzer will exit upon"
     86     "reaching this limit of RSS memory usage.")
     87 FUZZER_FLAG_INT(truncate_units, 0, "Try truncated units when loading corpus.")
     88 FUZZER_FLAG_INT(prune_corpus, 1, "Prune corpus items without new coverage when "
     89                                  "loading corpus.")
     90 
     91 FUZZER_DEPRECATED_FLAG(exit_on_first)
     92 FUZZER_DEPRECATED_FLAG(save_minimized_corpus)
     93 FUZZER_DEPRECATED_FLAG(sync_command)
     94 FUZZER_DEPRECATED_FLAG(sync_timeout)
     95 FUZZER_DEPRECATED_FLAG(test_single_input)
     96