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