feat: replace the --release flag with a generic --profile flag (#163)

camshaft · Sep 5, 2023 · d2cb031 · d2cb031
1 parent b1f2d9f
commit d2cb031
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 36 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -5,6 +5,12 @@ members = [
     "cargo-bolero",
 ]
 
+[profile.fuzz]
+inherits = "dev"
+opt-level = 3
+incremental = false
+codegen-units = 1
+
 [profile.release]
 lto = true
 codegen-units = 1

diff --git a/Makefile b/Makefile
@@ -61,15 +61,13 @@ libfuzzer honggfuzz:
 	    --manifest-path examples/basic/Cargo.toml \
 	    --runs 100000 \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER)
 	@cargo run \
 	    --features $@ \
 	    reduce \
 	    fuzz_bytes \
 	    --manifest-path examples/basic/Cargo.toml \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER)
 	@cargo run \
 	    --features $@ \
@@ -78,15 +76,13 @@ libfuzzer honggfuzz:
 	    --manifest-path examples/basic/Cargo.toml \
 	    --runs 100000 \
 	    --engine $@ \
-	    --release true \
 	    --sanitizer $(SANITIZER)
 	@cargo run \
 	    --features $@ \
 	    reduce \
 	    fuzz_generator \
 	    --manifest-path examples/basic/Cargo.toml \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER)
 	@cargo run \
 	    --features $@ \
@@ -95,15 +91,13 @@ libfuzzer honggfuzz:
 	    --manifest-path examples/basic/Cargo.toml \
 	    --runs 1000 \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER)
 	@cargo run \
 	    --features $@ \
 	    reduce \
 	    fuzz_operations \
 	    --manifest-path examples/basic/Cargo.toml \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER)
 	@SHOULD_PANIC=1 cargo run \
 	    --features $@ \
@@ -112,7 +106,6 @@ libfuzzer honggfuzz:
 	    --manifest-path examples/basic/Cargo.toml \
 	    --runs 100000 \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER) \
 	    || true # TODO make this consistent
 	@SHOULD_PANIC=1 cargo run \
@@ -121,7 +114,6 @@ libfuzzer honggfuzz:
 	    tests::add_test \
 	    --manifest-path examples/basic/Cargo.toml \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER) \
 	    || true # TODO make this consistent
 	@SHOULD_PANIC=1 cargo run \
@@ -131,7 +123,6 @@ libfuzzer honggfuzz:
 	    --manifest-path examples/basic/Cargo.toml \
 	    --runs 100000 \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER) \
 	    || true # TODO make this consistent
 	@SHOULD_PANIC=1 cargo run \
@@ -140,7 +131,6 @@ libfuzzer honggfuzz:
 	    tests::other_test \
 	    --manifest-path examples/basic/Cargo.toml \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER) \
 	    || true # TODO make this consistent
 	@SHOULD_PANIC=1 cargo run \
@@ -150,7 +140,6 @@ libfuzzer honggfuzz:
 	    --manifest-path examples/basic/Cargo.toml \
 	    --runs 1000 \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER) \
 	    || true # TODO make this consistent
 
@@ -162,7 +151,6 @@ afl:
 	    --manifest-path examples/basic/Cargo.toml \
 	    --runs 100000 \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER)
 	@cargo run \
 	    --features $@ \
@@ -171,7 +159,6 @@ afl:
 	    --manifest-path examples/basic/Cargo.toml \
 	    --runs 100000 \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER)
 	@rm -rf examples/basic/src/__fuzz__
 	@SHOULD_PANIC=1 cargo run \
@@ -181,7 +168,6 @@ afl:
 	    --manifest-path examples/basic/Cargo.toml \
 	    --runs 100000 \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER) \
 	    && exit 1 || true
 	@rm -rf examples/basic/src/__fuzz__
@@ -192,7 +178,6 @@ afl:
 	    --manifest-path examples/basic/Cargo.toml \
 	    --runs 100000 \
 	    --engine $@ \
-	    --release \
 	    --sanitizer $(SANITIZER) \
 	    && exit 1 || true
 

diff --git a/book/src/library-installation.md b/book/src/library-installation.md
@@ -13,6 +13,20 @@ bolero = "0.9"
 ```
 to `Cargo.toml`.
 
+Then, create the `fuzz` profile: (Note that LTO is not well-supported for the fuzzing profile)
+```toml
+[profile.fuzz]
+inherits = "dev"
+opt-level = 3
+incremental = false
+codegen-units = 1
+```
+
+If you forget adding the profile, then you will get the following error:
+```
+error: profile `fuzz` is not defined
+```
+
 ## Structured Test Generation
 
 If your crate wishes to implement structured test generation on public data structures, `bolero-generator` can be added to the main dependencies:

diff --git a/cargo-bolero/src/project.rs b/cargo-bolero/src/project.rs
@@ -23,9 +23,11 @@ pub struct Project {
     #[structopt(long)]
     all_features: bool,
 
-    /// Build artifacts in release mode, with optimizations [default: true]
-    #[structopt(long)]
-    release: Option<Option<bool>>,
+    /// Build artifacts in release mode, with optimizations [default: "fuzz"]
+    ///
+    /// Note that if you do not have `codegen-units = 1` in the profile, there are known compilation bugs
+    #[structopt(long, default_value = "fuzz")]
+    profile: String,
 
     /// Do not activate the `default` feature
     #[structopt(long)]
@@ -88,10 +90,7 @@ impl Project {
         let mut cmd = self.cargo();
 
         cmd.arg(call).arg("--target").arg(&self.target);
-
-        if self.release() {
-            cmd.arg("--release");
-        }
+        cmd.arg("--profile").arg(&self.profile);
 
         if self.no_default_features {
             cmd.arg("--no-default-features");
@@ -187,12 +186,6 @@ impl Project {
         } else {
             None
         })
-        // https://github.com/rust-lang/rust/issues/47071
-        .chain(if self.release() {
-            Some("-Ccodegen-units=1")
-        } else {
-            None
-        })
         .map(String::from)
         .chain(self.sanitizer_flags())
         .chain(std::env::var(inherits).ok())
@@ -212,12 +205,4 @@ impl Project {
         self.sanitizers()
             .map(|sanitizer| format!("-Zsanitizer={}", sanitizer))
     }
-
-    fn release(&self) -> bool {
-        match self.release {
-            None => true,
-            Some(None) => true,
-            Some(Some(v)) => v,
-        }
-    }
 }
diff --git a/examples/basic/Cargo.toml b/examples/basic/Cargo.toml
@@ -30,3 +30,9 @@ harness = false
 
 [profile.bench]
 debug = true
+
+[profile.fuzz]
+inherits = "dev"
+opt-level = 3
+incremental = false
+codegen-units = 1
diff --git a/examples/workspace/Cargo.toml b/examples/workspace/Cargo.toml
@@ -3,3 +3,9 @@ members = ["crate_a", "crate_b"]
 
 [profile.bench]
 debug = true
+
+[profile.fuzz]
+inherits = "dev"
+opt-level = 3
+incremental = false
+codegen-units = 1