Merge pull request #51 from fitzgen/no-dwarf

No dwarf

CHANGELOG.md

@@ -32,6 +32,23 @@ Released YYYY-MM-DD.
 
 --------------------------------------------------------------------------------
 
+## 0.2.0
+
+Released 2019-02-14.
+
+### Added
+
+* Added configuration options for controlling emission of the DWARF and name
+  custom sections.
+
+### Changed
+
+* Changed the synthetic naming option from "generate_names" to
+  "generate_synthetic_names_for_anonymous_items" to more accurately reflect what
+  it does.
+
+--------------------------------------------------------------------------------
+
 ## 0.1.0
 
 Released 2019-02-12.

Cargo.toml

@@ -2,7 +2,7 @@
 authors = ["Nick Fitzgerald <[email protected]>"]
 edition = "2018"
 name = "walrus"
-version = "0.1.0"
+version = "0.2.0"
 license = "MIT/Apache-2.0"
 readme = "README.md"
 categories = ["wasm"]
@@ -19,7 +19,7 @@ id-arena = { version = "2.2.0", features = ['rayon'] }
 leb128 = "0.2.3"
 log = "0.4"
 rayon = "1.0.3"
-walrus-macro = { path = './crates/macro', version = '=0.1.0' }
+walrus-macro = { path = './crates/macro', version = '=0.2.0' }
 wasmparser = "0.28"
 
 [dev-dependencies]

crates/macro/Cargo.toml

@@ -2,7 +2,7 @@
 authors = ["Nick Fitzgerald <[email protected]>"]
 edition = "2018"
 name = "walrus-macro"
-version = "0.1.0"
+version = "0.2.0"
 license = "MIT/Apache-2.0"
 categories = ["wasm"]
 repository = "https://github.com/rustwasm/walrus/tree/crates/macro"

src/module/config.rs

@@ -4,23 +4,58 @@ use crate::module::Module;
 /// Configuration for a `Module` which currently affects parsing.
 #[derive(Clone, Debug, Default)]
 pub struct ModuleConfig {
-    pub(crate) generate_names: bool,
+    pub(crate) generate_dwarf: bool,
+    pub(crate) generate_name_section: bool,
+    pub(crate) generate_synthetic_names_for_anonymous_items: bool,
     pub(crate) skip_strict_validate: bool,
 }
 
 impl ModuleConfig {
     /// Creates a fresh new configuration with default settings.
     pub fn new() -> ModuleConfig {
-        ModuleConfig::default()
+        ModuleConfig {
+            generate_dwarf: false,
+            generate_name_section: true,
+            generate_synthetic_names_for_anonymous_items: false,
+            skip_strict_validate: false,
+        }
     }
 
-    /// Sets a flag to whether debugging names are generated for
-    /// locals/functions/etc when parsing and running passes for this module.
+    /// Sets a flag to whether DWARF debug sections are generated for this
+    /// module.
+    ///
+    /// By default this flag is `false`. Note that any emitted DWARF is
+    /// currently wildly incorrect and buggy, and is also larger than the wasm
+    /// itself!
+    pub fn generate_dwarf(&mut self, generate: bool) -> &mut ModuleConfig {
+        self.generate_dwarf = generate;
+        self
+    }
+
+    /// Sets a flag to whether the custom "name" section is generated for this
+    /// module.
+    ///
+    /// The "name" section contains symbol names for the module, functions, and
+    /// locals. When enabled, stack traces will use these names, instead of
+    /// `wasm-function[123]`.
+    ///
+    /// By default this flag is `true`.
+    pub fn generate_name_section(&mut self, generate: bool) -> &mut ModuleConfig {
+        self.generate_name_section = generate;
+        self
+    }
+
+    /// Sets a flag to whether synthetic debugging names are generated for
+    /// anonymous locals/functions/etc when parsing and running passes for this
+    /// module.
     ///
     /// By default this flag is `false`, and it will generate quite a few names
     /// if enabled!
-    pub fn generate_names(&mut self, generate: bool) -> &mut ModuleConfig {
-        self.generate_names = generate;
+    pub fn generate_synthetic_names_for_anonymous_items(
+        &mut self,
+        generate: bool,
+    ) -> &mut ModuleConfig {
+        self.generate_synthetic_names_for_anonymous_items = generate;
         self
     }
 

src/module/functions/mod.rs

@@ -281,7 +281,7 @@ impl Module {
             let id = self.funcs.arena.next_id();
             self.funcs.arena.alloc(Function::new_uninitialized(id, ty));
             let idx = ids.push_func(id);
-            if self.config.generate_names {
+            if self.config.generate_synthetic_names_for_anonymous_items {
                 self.funcs.get_mut(id).name = Some(format!("f{}", idx));
             }
         }
@@ -324,7 +324,7 @@ impl Module {
                 let local_id = self.locals.add(*ty);
                 let idx = indices.push_local(id, local_id);
                 args.push(local_id);
-                if self.config.generate_names {
+                if self.config.generate_synthetic_names_for_anonymous_items {
                     let name = format!("arg{}", idx);
                     self.locals.get_mut(local_id).name = Some(name);
                 }
@@ -349,7 +349,7 @@ impl Module {
                 for _ in 0..count {
                     let local_id = self.locals.add(ty);
                     let idx = indices.push_local(id, local_id);
-                    if self.config.generate_names {
+                    if self.config.generate_synthetic_names_for_anonymous_items {
                         let name = format!("l{}", idx);
                         self.locals.get_mut(local_id).name = Some(name);
                     }

src/module/mod.rs

@@ -256,9 +256,17 @@ impl Module {
         self.funcs.emit(&mut cx);
         self.data.emit(&mut cx);
 
-        emit_name_section(&mut cx);
+        if self.config.generate_name_section {
+            emit_name_section(&mut cx);
+        }
+
         self.producers.emit(&mut cx);
         for section in self.custom.iter() {
+            if !self.config.generate_dwarf && section.name.starts_with(".debug") {
+                log::debug!("skipping DWARF custom section {}", section.name);
+                continue;
+            }
+
             log::debug!("emitting custom section {}", section.name);
             cx.custom_section(&section.name).encoder.raw(&section.value);
         }
@@ -303,7 +311,9 @@ impl Module {
                             // names for locals if they aren't specified, so
                             // just ignore empty names which would in theory
                             // make debugging a bit harder.
-                            if self.config.generate_names && naming.name.is_empty() {
+                            if self.config.generate_synthetic_names_for_anonymous_items
+                                && naming.name.is_empty()
+                            {
                                 continue;
                             }
                             let id = indices.get_local(func_id, naming.index)?;