Add bindgen version information to Producers in resulting components (#502)

* gen-guest-c: component type object uses the LinkingSection encoder

rather than open coding the exact same thing

* fixup

* add producer metadata to gen-guest-c component-type section

* add producer section to wit-component type in gen-guest-teavm-java

* gen-guest-rust: add producers metadata to component type section

* test-helpers: fix codegen test generator

* cargo.lock fix

* latest wasm-tools deps

Author: pchickey

Cargo.lock

@@ -29,10 +29,11 @@ clap = { version = "4.0.9", features = ["derive"] }
 env_logger = "0.9.1"
 indexmap = "1.9.1"
 
-wasm-encoder = "0.23.0"
-wat = "1.0.57"
+wasm-encoder = "0.24.0"
+wasm-metadata = "0.2.0"
+wat = "1.0.59"
 wit-parser = "0.6.0"
-wit-component = "0.6.0"
+wit-component = "0.7.0"
 
 wit-bindgen-core = { path = 'crates/bindgen-core', version = '0.3.0' }
 wit-bindgen-gen-guest-c = { path = 'crates/gen-guest-c', version = '0.3.0' }

Cargo.toml

@@ -19,6 +19,7 @@ test = false
 wit-bindgen-core = { workspace = true }
 wit-component = { workspace = true }
 wasm-encoder = { workspace = true }
+wasm-metadata = { workspace = true }
 anyhow = { workspace = true }
 heck = { workspace = true }
 clap = { workspace = true, optional = true }

crates/gen-guest-c/Cargo.toml

@@ -1,7 +1,8 @@
 use anyhow::Result;
 use heck::ToSnakeCase;
 use wasm_encoder::{
-    CodeSection, CustomSection, Encode, Function, FunctionSection, Module, TypeSection,
+    CodeSection, CustomSection, Function, FunctionSection, LinkingSection, Module, SymbolTable,
+    TypeSection,
 };
 use wit_bindgen_core::wit_parser::{Resolve, WorldId};
 use wit_component::StringEncoding;
@@ -25,7 +26,13 @@ pub fn object(resolve: &Resolve, world: WorldId, encoding: StringEncoding) -> Re
     code.function(&Function::new([]));
     module.section(&code);
 
-    let data = wit_component::metadata::encode(resolve, world, encoding).unwrap();
+    let mut producers = wasm_metadata::Producers::empty();
+    producers.add(
+        "processed-by",
+        env!("CARGO_PKG_NAME"),
+        env!("CARGO_PKG_VERSION"),
+    );
+    let data = wit_component::metadata::encode(resolve, world, encoding, Some(&producers)).unwrap();
 
     // The custom section name here must start with "component-type" but
     // otherwise is attempted to be unique here to ensure that this doesn't get
@@ -40,24 +47,12 @@ pub fn object(resolve: &Resolve, world: WorldId, encoding: StringEncoding) -> Re
         data: data.as_slice(),
     });
 
-    // Append the `.linking` section
-    let mut data = Vec::new();
-    data.push(0x02); // version 2
-    {
-        let mut subsection = Vec::<u8>::new();
-        subsection.push(0x01); // syminfo count
-        subsection.push(0x00); // SYMTAB_FUNCTION
-        0u32.encode(&mut subsection); // flags
-        0u32.encode(&mut subsection); // index
-        linking_symbol(&world_name).encode(&mut subsection); // name
-
-        data.push(0x08); // `WASM_SYMBOL_TABLE`
-        subsection.encode(&mut data);
-    }
-    module.section(&CustomSection {
-        name: "linking",
-        data: &data,
-    });
+    // Append the linking section, so that lld knows the custom section's symbol name
+    let mut linking = LinkingSection::new();
+    let mut symbols = SymbolTable::new();
+    symbols.function(0, 0, Some(&linking_symbol(&world_name)));
+    linking.symbol_table(&symbols);
+    module.section(&linking);
 
     Ok(module.finish())
 }

crates/gen-guest-c/src/component_type_object.rs

@@ -19,6 +19,7 @@ doctest = false
 wit-bindgen-core = { workspace = true }
 wit-bindgen-gen-rust-lib = { workspace = true }
 wit-component = { workspace = true }
+wasm-metadata = { workspace = true }
 heck = { workspace = true }
 clap = { workspace = true, optional = true }
 

crates/gen-guest-rust/Cargo.toml

@@ -252,9 +252,21 @@ impl WorldGenerator for RustWasm {
         self.src
             .push_str(&format!("#[link_section = \"component-type:{}\"]\n", name,));
 
-        let component_type =
-            wit_component::metadata::encode(resolve, world, wit_component::StringEncoding::UTF8)
-                .unwrap();
+        let mut producers = wasm_metadata::Producers::empty();
+        producers.add(
+            "processed-by",
+            env!("CARGO_PKG_NAME"),
+            env!("CARGO_PKG_VERSION"),
+        );
+
+        let component_type = wit_component::metadata::encode(
+            resolve,
+            world,
+            wit_component::StringEncoding::UTF8,
+            Some(&producers),
+        )
+        .unwrap();
+
         self.src.push_str("#[doc(hidden)]");
         self.src.push_str(&format!(
             "pub static __WIT_BINDGEN_COMPONENT_TYPE: [u8; {}] = ",

crates/gen-guest-rust/src/lib.rs

@@ -13,6 +13,7 @@ through the `wit-bindgen-cli` crate.
 [dependencies]
 wit-bindgen-core = { workspace = true }
 wit-component = { workspace = true }
+wasm-metadata = { workspace = true }
 heck = { workspace = true }
 clap = { workspace = true, optional = true }
 

crates/gen-guest-teavm-java/Cargo.toml

@@ -202,13 +202,26 @@ impl WorldGenerator for TeaVmJava {
                 .join("\n"),
         );
 
-        let component_type =
-            wit_component::metadata::encode(resolve, id, wit_component::StringEncoding::UTF8)
-                .unwrap()
-                .into_iter()
-                .map(|byte| format!("{byte:02x}"))
-                .collect::<Vec<_>>()
-                .concat();
+        let mut producers = wasm_metadata::Producers::empty();
+        producers.add(
+            "processed-by",
+            env!("CARGO_PKG_NAME"),
+            env!("CARGO_PKG_VERSION"),
+        );
+
+        let component_type = wit_component::metadata::encode(
+            resolve,
+            id,
+            wit_component::StringEncoding::UTF8,
+            Some(&producers),
+        )
+        .unwrap();
+
+        let component_type = component_type
+            .into_iter()
+            .map(|byte| format!("{byte:02x}"))
+            .collect::<Vec<_>>()
+            .concat();
 
         uwriteln!(
             src,

crates/gen-guest-teavm-java/src/lib.rs

@@ -90,7 +90,8 @@ pub fn run_component_codegen_test(
     let (resolve, world) = parse_wit(wit_path);
     let world_name = &resolve.worlds[world].name;
     let mut wasm = wit_component::dummy_module(&resolve, world);
-    let encoded = wit_component::metadata::encode(&resolve, world, StringEncoding::UTF8).unwrap();
+    let encoded =
+        wit_component::metadata::encode(&resolve, world, StringEncoding::UTF8, None).unwrap();
     let section = wasm_encoder::CustomSection {
         name: "component-type",
         data: &encoded,