Merge pull request #156 from Aimeedeer/dwarf-feature

add feature dwarf

.github/workflows/ci.yml

@@ -117,7 +117,17 @@ jobs:
       - uses: actions/checkout@v3
       - name: Checkout submodule
         run: git submodule update --init --recursive
-      - run: cargo test --manifest-path components/conformance-tests/Cargo.toml 
+      - run: cargo test --manifest-path components/conformance-tests/Cargo.toml
+
+  dwarf:
+    name: Dwarf feature
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Checkout submodule
+        run: git submodule update --init --recursive
+      - run: cargo test --features=dwarf
+      - run: cargo test --features=dwarf --manifest-path components/conformance-tests/Cargo.toml
 
   fmt:
     name: Cargo fmt

components/conformance-tests/Cargo.toml

@@ -13,3 +13,7 @@ anyhow = "1.0.58"
 anyhow = "1.0.58"
 wasm-opt = { path = "../wasm-opt", version = "0.114.1" }
 tempfile = "3.3.0"
+
+[features]
+default = []
+dwarf = ["wasm-opt/dwarf"]

components/conformance-tests/build.rs

@@ -64,10 +64,15 @@ fn build_binaryen_wasm_opt() -> Result<()> {
 fn build_rust_wasm_opt() -> Result<()> {
     let dirs = get_dirs()?;
 
-    let cargo_status = Command::new("cargo")
+    let mut cmd = Command::new("cargo");
+    cmd
         .current_dir(dirs.workspace)
-        .args(["build", "-p", "wasm-opt", "--release"])
-        .status()?;
+        .args(["build", "-p", "wasm-opt", "--release"]);
+
+    #[cfg(feature = "dwarf")]
+    cmd.args(["--features", "dwarf"]);
+
+    let cargo_status = cmd.status()?;
 
     if !cargo_status.success() {
         bail!("cargo failed");

components/conformance-tests/tests/tests.rs

@@ -251,6 +251,7 @@ fn get_test_infile_wasm() -> Result<PathBuf> {
     Ok(infile)
 }
 
+#[cfg(feature = "dwarf")]
 fn get_test_infile_wasm_alt() -> Result<PathBuf> {
     let manifest_dir = std::env::var("CARGO_MANIFEST_DIR")?;
     let manifest_dir = PathBuf::from(manifest_dir);
@@ -889,6 +890,7 @@ fn check_versions() -> Result<()> {
 }
 
 #[test]
+#[cfg(feature = "dwarf")]
 fn dwarf_line_info() -> Result<()> {
     let infile = get_test_infile_wasm_alt()?;
     let outfile = PathBuf::from("outfile.wasm");

components/wasm-opt-sys/Cargo.toml

@@ -16,3 +16,7 @@ cxx-build = "1.0.79"
 
 [dependencies]
 cxx = "1.0.79"
+
+[features]
+default = []
+dwarf = []

components/wasm-opt-sys/build.rs

@@ -15,7 +15,9 @@ fn main() -> anyhow::Result<()> {
     let src_dir = binaryen_dir.join("src");
     let src_files = get_src_files(&src_dir)?;
 
+    #[cfg(feature = "dwarf")]
     let llvm_dir = binaryen_dir.join("third_party/llvm-project");
+    #[cfg(feature = "dwarf")]
     let llvm_files = get_llvm_files(&llvm_dir)?;
 
     let tools_dir = src_dir.join("tools");
@@ -35,8 +37,12 @@ fn main() -> anyhow::Result<()> {
     CFG.exported_header_dirs.push(&src_dir);
     CFG.exported_header_dirs.push(&tools_dir);
     CFG.exported_header_dirs.push(&output_dir);
-    let llvm_include = llvm_dir.join("include");
-    CFG.exported_header_dirs.push(&llvm_include);
+
+    #[cfg(feature = "dwarf")]
+    {
+        let llvm_include = llvm_dir.join("include");
+        CFG.exported_header_dirs.push(&llvm_include);
+    }
 
     let mut builder = cxx_build::bridge("src/lib.rs");
 
@@ -49,6 +55,7 @@ fn main() -> anyhow::Result<()> {
                 "-w",
                 "-Wno-unused-parameter",
                 "-DTHROW_ON_FATAL",
+                #[cfg(feature = "dwarf")]
                 "-DBUILD_LLVM_DWARF",
                 "-DNDEBUG",
             ]
@@ -57,6 +64,7 @@ fn main() -> anyhow::Result<()> {
                 "/std:c++17",
                 "/w",
                 "/DTHROW_ON_FATAL",
+                #[cfg(feature = "dwarf")]
                 "/DBUILD_LLVM_DWARF",
                 "/DNDEBUG",
             ]
@@ -70,10 +78,12 @@ fn main() -> anyhow::Result<()> {
     builder
         .file(wasm_opt_main_shim)
         .files(src_files)
-        .files(&llvm_files)
         .file(wasm_opt_src)
         .file(wasm_intrinsics_src);
 
+    #[cfg(feature = "dwarf")]
+    builder.files(&llvm_files);
+
     builder.compile("wasm-opt-cc");
 
     Ok(())
@@ -356,6 +366,7 @@ fn check_cxx17_support() -> anyhow::Result<()> {
     Ok(())
 }
 
+#[cfg(feature = "dwarf")]
 fn get_llvm_files(llvm_dir: &Path) -> anyhow::Result<[PathBuf; 63]> {
     let llvm_dwarf = disambiguate_file(&llvm_dir.join("Dwarf.cpp"), "LLVMDwarf.cpp")?;
     let llvm_debug = disambiguate_file(&llvm_dir.join("Debug.cpp"), "LLVMDebug.cpp")?;

components/wasm-opt/Cargo.toml

@@ -18,3 +18,7 @@ strum = "0.24"
 strum_macros = "0.24"
 thiserror = "1.0.32"
 tempfile = "3.3.0"
+
+[features]
+default = []
+dwarf = ["wasm-opt-sys/dwarf"]