Rename --inspect=history to just --inspect

As "history" is the only available inspection option.

Author: Samuel Groß

Sources/Fuzzilli/Configuration.swift

@@ -46,8 +46,12 @@ public struct Configuration {
     /// Enable the saving of programs that failed or timed-out during execution.
     public let enableDiagnostics: Bool
 
-    /// Set of enabled inspection features.
-    public let inspection: InspectionOptions
+    /// Whether to enable inspection for generated programs. If enabled, a full record
+    /// of the steps that led to a particular program will be kept. In particular, a programs
+    /// ancestor chain (the programs that were mutated to arrive at the current program)
+    /// is recorded as well as the exact list of mutations and code generations, as well
+    /// as the reductions performed by the minimizer.
+    public let enableInspection: Bool
 
     public init(timeout: UInt32 = 250,
                 skipStartupTests: Bool = false,
@@ -58,15 +62,15 @@ public struct Configuration {
                 dropoutRate: Double = 0,
                 collectRuntimeTypes: Bool = false,
                 enableDiagnostics: Bool = false,
-                inspection: InspectionOptions = []) {
+                enableInspection: Bool = false) {
         self.timeout = timeout
         self.logLevel = logLevel
         self.crashTests = crashTests
         self.isFuzzing = isFuzzing
         self.dropoutRate = dropoutRate
         self.minimizationLimit = minimizationLimit
         self.enableDiagnostics = enableDiagnostics
-        self.inspection = inspection
+        self.enableInspection = enableInspection
     }
 }
 

Sources/Fuzzilli/Core/FuzzEngine.swift

@@ -32,7 +32,7 @@ extension FuzzEngine {
             case .succeeded:
                 fuzzer.dispatchEvent(fuzzer.events.ValidProgramFound, data: program)
                 if let aspects = fuzzer.evaluator.evaluate(execution) {
-                    if fuzzer.config.inspection.contains(.history) {
+                    if fuzzer.config.enableInspection {
                         program.comments.add("Program is interesting due to \(aspects)", at: .footer)
                     }
                     fuzzer.processInteresting(program, havingAspects: aspects, origin: .local)

Sources/Fuzzilli/Core/ProgramBuilder.swift

@@ -140,7 +140,7 @@ public class ProgramBuilder {
     /// Add a trace comment to the currently generated program at the current position.
     /// This is only done if history inspection is enabled.
     public func trace(_ commentGenerator: @autoclosure () -> String) {
-        if fuzzer.config.inspection.contains(.history) {
+        if fuzzer.config.enableInspection {
             // Use an autoclosure here so that template strings are only evaluated when they are needed.
             comments.add(commentGenerator(), at: .instruction(code.count))
         }
@@ -149,7 +149,7 @@ public class ProgramBuilder {
     /// Add a trace comment at the start of the currently generated program.
     /// This is only done if history inspection is enabled.
     public func traceHeader(_ commentGenerator: @autoclosure () -> String) {
-        if fuzzer.config.inspection.contains(.history) {
+        if fuzzer.config.enableInspection {
             comments.add(commentGenerator(), at: .header)
         }
     }

Sources/Fuzzilli/Corpus/Corpus.swift

@@ -52,7 +52,7 @@ extension Corpus {
         // And programs in the corpus don't keep their comments
         program.comments.removeAll()
 
-        if fuzzer.config.inspection.contains(.history) {
+        if fuzzer.config.enableInspection {
             // Except for one identifying them as part of the corpus
             program.comments.add("Corpus entry #\(index) on instance \(fuzzer.id) with Corpus type \(name)", at: .header)
         }

Sources/Fuzzilli/Fuzzer.swift

@@ -542,7 +542,7 @@ public class Fuzzer {
     public func makeBuilder(forMutating parent: Program? = nil, mode: ProgramBuilder.Mode = .aggressive) -> ProgramBuilder {
         dispatchPrecondition(condition: .onQueue(queue))
         // Program ancestor chains are only constructed if inspection mode is enabled
-        let parent = config.inspection.contains(.history) ? parent : nil
+        let parent = config.enableInspection ? parent : nil
         return ProgramBuilder(for: self, parent: parent, mode: mode)
     }
 

Sources/Fuzzilli/Minimization/Minimizer.swift

@@ -44,7 +44,7 @@ public class Minimizer: ComponentBase {
             let minimizedCode = self.internalMinimize(program, withAspects: aspects, limit: minimizationLimit, runningSynchronously: false)
             self.fuzzer.async {
                 let minimizedProgram: Program
-                if self.fuzzer.config.inspection.contains(.history) {
+                if self.fuzzer.config.enableInspection {
                     minimizedProgram = Program(code: minimizedCode, parent: program)
                     minimizedProgram.comments.add("Minimizing \(program.id)", at: .header)
                 } else {

Sources/Fuzzilli/Modules/Storage.swift

@@ -139,7 +139,7 @@ public class Storage: Module {
         }
 
         // If inspection is enabled, we also include the programs ancestor chain in a separate .history file
-        if fuzzer.config.inspection.contains(.history) && program.parent != nil {
+        if fuzzer.config.enableInspection && program.parent != nil {
             let lifter = FuzzILLifter()
 
             var ancestors: [Program] = []

Sources/FuzzilliCli/main.swift

@@ -92,10 +92,9 @@ Options:
     --diagnostics                : Enable saving of programs that failed or timed-out during execution. Also tracks
                                    executions on the current REPRL instance.
     --swarmTesting               : Enable Swarm Testing mode. The fuzzer will choose random weights for the code generators per process.
-    --inspect=opt1,opt2,...      : Enable inspection options. The following options are currently available:
-                                       history: Additional .fuzzil.history files are written to disk for every program.
-                                                These describe in detail how the program was generated through mutations,
-                                                code generation, and minimization
+    --inspect                    : Enable inspection for generated programs. When enabled, additional .fuzzil.history files are written
+                                   to disk for every interesting or crashing program. These describe in detail how the program was generated
+                                   through mutations, code generation, and minimization.
     --argumentRandomization      : Enable JS engine argument randomization
 """)
     exit(0)
@@ -145,7 +144,7 @@ let instanceType = args["--instanceType"] ?? "standalone"
 let corpusSyncMode = args["--corpusSyncMode"] ?? "full"
 let dontFuzz = args.has("--dontFuzz")
 let diagnostics = args.has("--diagnostics")
-let inspect = args["--inspect"]
+let inspect = args.has("--inspect")
 let swarmTesting = args.has("--swarmTesting")
 let randomizingArguments = args.has("--argumentRandomization")
 
@@ -259,19 +258,6 @@ guard let corpusSyncMode = corpusSyncModeByName[corpusSyncMode] else {
     configError("Invalid network corpus synchronization mode \(corpusSyncMode)")
 }
 
-var inspectionOptions = InspectionOptions()
-if let optionList = inspect {
-    let options = optionList.components(separatedBy: ",")
-    for option in options {
-        switch option {
-        case "history":
-            inspectionOptions.insert(.history)
-        default:
-            configError("Unknown inspection feature: \(option)")
-        }
-    }
-}
-
 // Make it easy to detect typos etc. in command line arguments
 if args.unusedOptionals.count > 0 {
     configError("Invalid arguments: \(args.unusedOptionals)")
@@ -408,7 +394,7 @@ let config = Configuration(timeout: UInt32(timeout),
                            isFuzzing: !dontFuzz,
                            minimizationLimit: minimizationLimit,
                            enableDiagnostics: diagnostics,
-                           inspection: inspectionOptions)
+                           enableInspection: inspect)
 
 let fuzzer = makeFuzzer(for: profile, with: config)