Add whole-archive feature to libafl_targets (#1544)

* maybe fix linkage?

* fix hack CI

* interceptors

* do not call strstr and friends

* format

* whoops

* enforce nightly; fixup linkage by featuring interceptors

* skip libafl_libfuzzer in stable cargo hack check

* oops

* packed_bundled_libs is stablised

Author: addisoncrump

.github/workflows/build_and_test.yml

@@ -145,7 +145,7 @@ jobs:
       # Skipping `python` as it has to be built with the `maturin` tool
       # `agpl`, `nautilus` require nightly
       # `sancov_pcguard_edges` is tested seperately
-      run: LLVM_CONFIG=llvm-config-15 cargo hack check --each-feature --clean-per-run --exclude-features=prelude,agpl,nautilus,python,sancov_pcguard_edges,arm,aarch64,i386,be,systemmode --no-dev-deps
+      run: LLVM_CONFIG=llvm-config-15 cargo hack check --workspace --each-feature --clean-per-run --exclude-features=prelude,agpl,nautilus,python,sancov_pcguard_edges,arm,aarch64,i386,be,systemmode,whole_archive --no-dev-deps --exclude libafl_libfuzzer
     - name: Check nightly features
       run: cargo +nightly check --features=agpl && cargo +nightly check --features=nautilus
 

libafl_libfuzzer/libafl_libfuzzer_runtime/Cargo.toml

@@ -32,7 +32,7 @@ crate-type = ["staticlib", "rlib"]
 [dependencies]
 libafl = { path = "../../libafl", default-features = false, features = ["std", "derive", "llmp_compression", "rand_trait", "regex", "errors_backtrace", "serdeany_autoreg", "tui_monitor"] }
 libafl_bolts = { path = "../../libafl_bolts", default-features = false, features = ["std", "derive", "llmp_compression", "rand_trait", "serdeany_autoreg", "errors_backtrace"] }
-libafl_targets = { path = "../../libafl_targets", features = ["sancov_8bit", "sancov_cmplog", "libfuzzer", "libfuzzer_oom", "libfuzzer_define_run_driver", "sanitizers_flags"] }
+libafl_targets = { path = "../../libafl_targets", features = ["sancov_8bit", "sancov_cmplog", "libfuzzer", "libfuzzer_oom", "libfuzzer_define_run_driver", "libfuzzer_interceptors", "sanitizers_flags", "whole_archive"] }
 
 ahash = { version = "0.8.3", default-features = false }
 libc = "0.2.139"

libafl_targets/Cargo.toml

@@ -21,22 +21,25 @@ std = ["libafl/std"]
 libfuzzer = ["std", "sanitizer_interfaces"]
 libfuzzer_no_link_main = ["libfuzzer"]
 libfuzzer_define_run_driver = ["libfuzzer"]
+libfuzzer_interceptors = ["libfuzzer", "sancov_cmplog"]
 libfuzzer_oom = ["libfuzzer"]
 sanitizers_flags = []
 pointer_maps = []
 sancov_pcguard_edges = []
 sancov_pcguard_hitcounts = []
 sancov_value_profile = []
 sancov_8bit = []
-sancov_cmplog = []
+sancov_cmplog = [] # Defines cmp and __sanitizer_weak_hook functions. Use libfuzzer_interceptors to define interceptors (only compatible with Linux)
 sancov_pcguard = ["sancov_pcguard_hitcounts"]
 sanitizer_interfaces = []
 clippy = [] # Ignore compiler warnings during clippy
 observers = ["meminterval", "ahash"]
+whole_archive = [] # use +whole-archive to ensure the presence of weak symbols
 
 [build-dependencies]
 bindgen = "0.68"
 cc = { version = "1.0", features = ["parallel"] }
+rustversion = "1.0"
 
 [dependencies]
 libafl = { path = "../libafl", version = "0.11.1", default-features = false, features = [] }

libafl_targets/build.rs

@@ -2,6 +2,10 @@
 
 use std::{env, fs::File, io::Write, path::Path};
 
+#[cfg(feature = "whole_archive")]
+#[rustversion::not(nightly)]
+compile_error!("Must use a nightly release with whole_archive!");
+
 #[allow(clippy::too_many_lines)]
 fn main() {
     let out_dir = env::var_os("OUT_DIR").unwrap();
@@ -72,6 +76,10 @@ fn main() {
 
         #[cfg(unix)]
         sancov_cmp.flag("-Wno-sign-compare");
+        #[cfg(feature = "whole_archive")]
+        {
+            sancov_cmp.link_lib_modifier("+whole-archive");
+        }
 
         #[cfg(feature = "sancov_value_profile")]
         {
@@ -125,12 +133,32 @@ fn main() {
         let mut libfuzzer = cc::Build::new();
         libfuzzer.file(src_dir.join("libfuzzer.c"));
 
+        #[cfg(feature = "whole_archive")]
+        {
+            libfuzzer.link_lib_modifier("+whole-archive");
+        }
+
         #[cfg(feature = "libfuzzer_no_link_main")]
         libfuzzer.define("FUZZER_NO_LINK_MAIN", "1");
         #[cfg(feature = "libfuzzer_define_run_driver")]
         libfuzzer.define("FUZZER_DEFINE_RUN_DRIVER", "1");
 
         libfuzzer.compile("libfuzzer");
+
+        #[cfg(feature = "libfuzzer_interceptors")]
+        {
+            println!("cargo:rerun-if-changed=src/libfuzzer/FuzzerInterceptors.cpp");
+
+            let mut interceptors = cc::Build::new();
+            interceptors.file(src_dir.join("libfuzzer/FuzzerInterceptors.cpp"));
+
+            #[cfg(feature = "whole_archive")]
+            {
+                interceptors.link_lib_modifier("+whole-archive");
+            }
+
+            interceptors.cpp(true).compile("interceptors");
+        }
     }
 
     println!("cargo:rerun-if-changed=src/common.h");
@@ -159,6 +187,11 @@ fn main() {
 
     let mut common = cc::Build::new();
 
+    #[cfg(feature = "whole_archive")]
+    {
+        common.link_lib_modifier("+whole-archive");
+    }
+
     #[cfg(feature = "sanitizers_flags")]
     {
         common.define("DEFAULT_SANITIZERS_OPTIONS", "1");
@@ -168,7 +201,14 @@ fn main() {
 
     println!("cargo:rerun-if-changed=src/coverage.c");
 
-    cc::Build::new()
+    let mut coverage = cc::Build::new();
+
+    #[cfg(feature = "whole_archive")]
+    {
+        coverage.link_lib_modifier("+whole-archive");
+    }
+
+    coverage
         .file(src_dir.join("coverage.c"))
         .define("EDGES_MAP_SIZE", Some(&*format!("{edges_map_size}")))
         .define("ACCOUNTING_MAP_SIZE", Some(&*format!("{acc_map_size}")))
@@ -177,49 +217,47 @@ fn main() {
     println!("cargo:rerun-if-changed=src/cmplog.h");
     println!("cargo:rerun-if-changed=src/cmplog.c");
 
-    #[cfg(unix)]
+    let mut cmplog = cc::Build::new();
+
+    #[cfg(feature = "whole_archive")]
     {
-        cc::Build::new()
-            .flag("-Wno-pointer-sign") // UNIX ONLY FLAGS
-            .flag("-Wno-sign-compare")
-            .define("CMP_MAP_SIZE", Some(&*format!("{cmp_map_size}")))
-            .define(
-                "AFLPP_CMPLOG_MAP_W",
-                Some(&*format!("{aflpp_cmplog_map_w}")),
-            )
-            .define(
-                "AFLPP_CMPLOG_MAP_H",
-                Some(&*format!("{aflpp_cmplog_map_h}")),
-            )
-            .define("CMPLOG_MAP_W", Some(&*format!("{cmplog_map_w}")))
-            .define("CMPLOG_MAP_H", Some(&*format!("{cmplog_map_h}")))
-            .file(src_dir.join("cmplog.c"))
-            .compile("cmplog");
+        cmplog.link_lib_modifier("+whole-archive");
     }
 
-    #[cfg(not(unix))]
+    #[cfg(unix)]
     {
-        cc::Build::new()
-            .define("CMP_MAP_SIZE", Some(&*format!("{cmp_map_size}")))
-            .define(
-                "AFLPP_CMPLOG_MAP_W",
-                Some(&*format!("{aflpp_cmplog_map_w}")),
-            )
-            .define(
-                "AFLPP_CMPLOG_MAP_H",
-                Some(&*format!("{aflpp_cmplog_map_h}")),
-            )
-            .define("CMPLOG_MAP_W", Some(&*format!("{cmplog_map_w}")))
-            .define("CMPLOG_MAP_H", Some(&*format!("{cmplog_map_h}")))
-            .file(src_dir.join("cmplog.c"))
-            .compile("cmplog");
+        cmplog
+            .flag("-Wno-pointer-sign") // UNIX ONLY FLAGS
+            .flag("-Wno-sign-compare");
     }
 
+    cmplog
+        .define("CMP_MAP_SIZE", Some(&*format!("{cmp_map_size}")))
+        .define(
+            "AFLPP_CMPLOG_MAP_W",
+            Some(&*format!("{aflpp_cmplog_map_w}")),
+        )
+        .define(
+            "AFLPP_CMPLOG_MAP_H",
+            Some(&*format!("{aflpp_cmplog_map_h}")),
+        )
+        .define("CMPLOG_MAP_W", Some(&*format!("{cmplog_map_w}")))
+        .define("CMPLOG_MAP_H", Some(&*format!("{cmplog_map_h}")))
+        .file(src_dir.join("cmplog.c"))
+        .compile("cmplog");
+
     #[cfg(unix)]
     {
         println!("cargo:rerun-if-changed=src/forkserver.c");
 
-        cc::Build::new()
+        let mut forkserver = cc::Build::new();
+
+        #[cfg(feature = "whole_archive")]
+        {
+            forkserver.link_lib_modifier("+whole-archive");
+        }
+
+        forkserver
             .file(src_dir.join("forkserver.c"))
             .compile("forkserver");
     }
@@ -228,7 +266,14 @@ fn main() {
     {
         println!("cargo:rerun-if-changed=src/windows_asan.c");
 
-        cc::Build::new()
+        let mut winasan = cc::Build::new();
+
+        #[cfg(feature = "whole_archive")]
+        {
+            winasan.link_lib_modifier("+whole-archive");
+        }
+
+        winasan
             .file(src_dir.join("windows_asan.c"))
             .compile("windows_asan");
     }

libafl_targets/src/lib.rs

@@ -1,6 +1,4 @@
 //! `libafl_targets` contains runtime code, injected in the target itself during compilation.
-//!
-//!
 #![no_std]
 #![deny(rustdoc::broken_intra_doc_links)]
 #![deny(clippy::all)]