feature(frontend): parse AccountComponentMetadata in the frontend

and pass it through the pipeline.

Author: greenhat

frontend/wasm/src/code_translator/tests.rs

@@ -24,7 +24,7 @@ fn check_op(wat_op: &str, expected_ir: expect_test::ExpectFile) {
         )"#,
     );
     let wasm = wat::parse_str(wat).unwrap();
-    let world_ref = translate(&wasm, &WasmTranslationConfig::default(), context.clone())
+    let output = translate(&wasm, &WasmTranslationConfig::default(), context.clone())
         .map_err(|e| {
             if let Some(labels) = e.labels() {
                 for label in labels {
@@ -36,9 +36,9 @@ fn check_op(wat_op: &str, expected_ir: expect_test::ExpectFile) {
         })
         .unwrap();
 
-    let world = world_ref.borrow();
+    let component = output.component.borrow();
     let mut w = String::new();
-    world
+    component
         .as_operation()
         .prewalk(|op: &Operation| {
             if let Some(_function) = op.downcast_ref::<builtin::Function>() {

frontend/wasm/src/component/build_ir.rs

@@ -6,7 +6,7 @@ use midenc_session::{diagnostics::Report, Session};
 use super::{translator::ComponentTranslator, ComponentTypesBuilder, ParsedRootComponent};
 use crate::{
     component::ComponentParser, error::WasmResult, supported_component_model_features,
-    WasmTranslationConfig,
+    FrontendOutput, WasmTranslationConfig,
 };
 
 fn parse<'data>(
@@ -28,7 +28,7 @@ pub fn translate_component(
     wasm: &[u8],
     config: &WasmTranslationConfig,
     context: Rc<Context>,
-) -> WasmResult<midenc_hir::dialects::builtin::ComponentRef> {
+) -> WasmResult<FrontendOutput> {
     let (mut component_types_builder, mut parsed_root_component) =
         parse(config, wasm, context.session())?;
     let dialect = context.get_or_register_dialect::<BuiltinDialect>();

frontend/wasm/src/component/parser.rs

@@ -434,7 +434,10 @@ impl<'a, 'data> ComponentParser<'a, 'data> {
             // debug.
             other => {
                 self.validator.payload(&other).into_diagnostic()?;
-                unsupported_diag!(&self.session.diagnostics, "unsupported section {other:?}");
+                unsupported_diag!(
+                    &self.session.diagnostics,
+                    "unsupported component section {other:?}"
+                );
             }
         }
 
@@ -606,12 +609,16 @@ impl<'a, 'data> ComponentParser<'a, 'data> {
         // module and actual function translation is deferred until this
         // entire process has completed.
         self.validator.module_section(&range).into_diagnostic()?;
-        let parsed_module = ModuleEnvironment::new(
+        let module_environment = ModuleEnvironment::new(
             self.config,
             self.validator,
             self.types.module_types_builder_mut(),
-        )
-        .parse(parser, &component[range.start..range.end], &self.session.diagnostics)?;
+        );
+        let parsed_module = module_environment.parse(
+            parser,
+            &component[range.start..range.end],
+            &self.session.diagnostics,
+        )?;
         let static_idx = self.static_modules.push(parsed_module);
         self.result.initializers.push(LocalInitializer::ModuleStatic(static_idx));
         // Set a fallback name for the newly added parsed module to be used if

frontend/wasm/src/component/translator.rs

@@ -4,7 +4,7 @@ use cranelift_entity::PrimaryMap;
 use midenc_hir::{
     self as hir2,
     diagnostics::Report,
-    dialects::builtin::{self, ComponentBuilder, ComponentRef, ModuleBuilder, World, WorldBuilder},
+    dialects::builtin::{self, ComponentBuilder, ModuleBuilder, World, WorldBuilder},
     interner::Symbol,
     Abi, BuilderExt, Context, FunctionIdent, FunctionType, FxHashMap, Ident, SourceSpan,
 };
@@ -32,7 +32,7 @@ use crate::{
         module_translation_state::ModuleTranslationState,
         types::{EntityIndex, FuncIndex},
     },
-    unsupported_diag, WasmTranslationConfig,
+    unsupported_diag, FrontendOutput, WasmTranslationConfig,
 };
 
 /// A translator from the linearized Wasm component model to the Miden IR component
@@ -100,14 +100,30 @@ impl<'a> ComponentTranslator<'a> {
         mut self,
         root_component: &'a ParsedComponent,
         types: &mut ComponentTypesBuilder,
-    ) -> WasmResult<ComponentRef> {
+    ) -> WasmResult<FrontendOutput> {
         let mut frame = ComponentFrame::new(root_component.types_ref(), FxHashMap::default());
 
         for init in &root_component.initializers {
             self.initializer(&mut frame, types, init)?;
         }
 
-        Ok(self.result.component)
+        let mut account_component_metadata_bytes_vec: Vec<Vec<u8>> = self
+            .nested_modules
+            .into_iter()
+            .flat_map(|t| t.1.account_component_metadata_bytes.map(|slice| slice.to_vec()))
+            .collect();
+        assert_eq!(
+            account_component_metadata_bytes_vec.len(),
+            1,
+            "expected only one core Wasm module to have account component metadata section",
+        );
+        let account_component_metadata_bytes = account_component_metadata_bytes_vec.remove(0);
+
+        let output = FrontendOutput {
+            component: self.result.component,
+            account_component_metadata_bytes: Some(account_component_metadata_bytes),
+        };
+        Ok(output)
     }
 
     fn initializer(

frontend/wasm/src/lib.rs

@@ -29,17 +29,29 @@ use wasmparser::WasmFeatures;
 
 pub use self::{config::*, error::WasmError};
 
+/// The output of the frontend Wasm translation stage
+pub struct FrontendOutput {
+    /// The IR component translated from the Wasm
+    pub component: builtin::ComponentRef,
+    /// The serialized AccountComponentMetadata (name, description, storage layout, etc.)
+    pub account_component_metadata_bytes: Option<Vec<u8>>,
+}
+
 /// Translate a valid Wasm core module or Wasm Component Model binary into Miden
 /// IR Component
 pub fn translate(
     wasm: &[u8],
     config: &WasmTranslationConfig,
     context: Rc<Context>,
-) -> WasmResult<builtin::ComponentRef> {
+) -> WasmResult<FrontendOutput> {
     if wasm[4..8] == [0x01, 0x00, 0x00, 0x00] {
         // Wasm core module
         // see https://github.com/WebAssembly/component-model/blob/main/design/mvp/Binary.md#component-definitions
-        translate_module_as_component(wasm, config, context)
+        let component = translate_module_as_component(wasm, config, context)?;
+        Ok(FrontendOutput {
+            component,
+            account_component_metadata_bytes: None,
+        })
     } else {
         translate_component(wasm, config, context)
     }

frontend/wasm/src/module/module_env.rs

@@ -74,6 +74,9 @@ pub struct ParsedModule<'data> {
     /// When we're parsing the code section this will be incremented so we know
     /// which function is currently being defined.
     code_index: u32,
+
+    /// The serialized AccountComponentMetadata (name, description, storage layout, etc.)
+    pub account_component_metadata_bytes: Option<&'data [u8]>,
 }
 
 /// Contains function data: byte code and its offset in the module.
@@ -208,13 +211,24 @@ impl<'a, 'data> ModuleEnvironment<'a, 'data> {
                     log::warn!("failed to parse name section {:?}", e);
                 }
             }
-            Payload::CustomSection(s) => self.dwarf_section(&s),
+            Payload::CustomSection(s) if s.name().starts_with(".debug_") => self.dwarf_section(&s),
+            Payload::CustomSection(s) if s.name() == "miden_account_component_metadata" => {
+                self.result.account_component_metadata_bytes = Some(s.data());
+            }
+            Payload::CustomSection { .. } => {
+                // ignore any other custom sections
+            }
+
             // It's expected that validation will probably reject other
             // payloads such as `UnknownSection` or those related to the
             // component model.
             other => {
                 self.validator.payload(&other).into_diagnostic()?;
-                unsupported_diag!(diagnostics, "wasm error: unsupported section {:?}", other);
+                unsupported_diag!(
+                    diagnostics,
+                    "wasm error: unsupported module section {:?}",
+                    other
+                );
             }
         }
         Ok(())
@@ -716,9 +730,6 @@ impl<'a, 'data> ModuleEnvironment<'a, 'data> {
 
     fn dwarf_section(&mut self, section: &CustomSectionReader<'data>) {
         let name = section.name();
-        if !name.starts_with(".debug_") {
-            return;
-        }
         if !self.config.generate_native_debuginfo && !self.config.parse_wasm_debuginfo {
             self.result.has_unparsed_debuginfo = true;
             return;

midenc-compile/src/stages/assemble.rs

@@ -86,6 +86,8 @@ fn build_package(mast: MastArtifact, outputs: &CodegenOutput, session: &Session)
         }
     }
 
+    todo!("store outputs.account_component_metadata to the Package");
+
     miden_mast_package::Package {
         name,
         mast,

midenc-compile/src/stages/codegen.rs

@@ -18,6 +18,8 @@ pub struct CodegenOutput {
     pub component: Arc<MasmComponent>,
     pub link_libraries: Vec<Arc<Library>>,
     pub link_packages: BTreeMap<Symbol, Arc<Package>>,
+    /// The serialized AccountComponentMetadata (name, description, storage layout, etc.)
+    pub account_component_metadata_bytes: Option<Vec<u8>>,
 }
 
 /// Perform code generation on the possibly-linked output of previous stages
@@ -76,6 +78,7 @@ impl Stage for CodegenStage {
             component: Arc::from(masm_component),
             link_libraries,
             link_packages,
+            account_component_metadata_bytes: linker_output.account_component_metadata_bytes,
         })
     }
 }

midenc-compile/src/stages/link.rs

@@ -1,5 +1,6 @@
 use alloc::{borrow::ToOwned, collections::BTreeMap, sync::Arc, vec::Vec};
 
+use midenc_frontend_wasm::FrontendOutput;
 use midenc_hir::{interner::Symbol, BuilderExt, OpBuilder, SourceSpan};
 #[cfg(feature = "std")]
 use midenc_session::Path;
@@ -16,6 +17,8 @@ pub struct LinkOutput {
     pub world: builtin::WorldRef,
     /// The IR component which is the primary input being compiled
     pub component: builtin::ComponentRef,
+    /// The serialized AccountComponentMetadata (name, description, storage layout, etc.)
+    pub account_component_metadata_bytes: Option<Vec<u8>>,
     /// The set of Miden Assembly sources to be provided to the assembler to satisfy link-time
     /// dependencies
     pub masm: Vec<Arc<miden_assembly::ast::Module>>,
@@ -109,7 +112,10 @@ impl Stage for LinkStage {
         // Parse and translate the component WebAssembly using the constructed World
         let component_wasm =
             component_wasm.ok_or_else(|| Report::msg("expected at least one wasm input"))?;
-        let component = match component_wasm {
+        let FrontendOutput {
+            component,
+            account_component_metadata_bytes,
+        } = match component_wasm {
             #[cfg(feature = "std")]
             InputType::Real(path) => parse_hir_from_wasm_file(&path, world, context.clone())?,
             #[cfg(not(feature = "std"))]
@@ -138,6 +144,7 @@ impl Stage for LinkStage {
         Ok(LinkOutput {
             world,
             component,
+            account_component_metadata_bytes,
             masm,
             mast,
             packages,
@@ -150,7 +157,7 @@ fn parse_hir_from_wasm_file(
     path: &Path,
     world: builtin::WorldRef,
     context: Rc<Context>,
-) -> CompilerResult<builtin::ComponentRef> {
+) -> CompilerResult<FrontendOutput> {
     use std::io::Read;
 
     log::debug!("parsing hir from wasm at {}", path.display());
@@ -172,12 +179,12 @@ fn parse_hir_from_wasm_bytes(
     bytes: &[u8],
     context: Rc<Context>,
     config: &wasm::WasmTranslationConfig,
-) -> CompilerResult<builtin::ComponentRef> {
-    let component = wasm::translate(bytes, config, context.clone())?;
+) -> CompilerResult<FrontendOutput> {
+    let outpub = wasm::translate(bytes, config, context.clone())?;
     log::debug!(
         "parsed hir component from wasm bytes with first module name: {}",
-        component.borrow().id()
+        outpub.component.borrow().id()
     );
 
-    Ok(component)
+    Ok(outpub)
 }

sdk/base-macros/src/account_component_metadata.rs

@@ -35,10 +35,6 @@ impl AccountComponentMetadataBuilder {
         }
     }
 
-    pub fn name(&self) -> String {
-        self.name.clone()
-    }
-
     pub fn build(self) -> AccountComponentMetadata {
         AccountComponentMetadata::new(
             self.name,