use crate::{encode_section, ConstExpr, Encode, RefType, Section, SectionId}; use std::borrow::Cow; /// An encoder for the element section. /// /// Element sections are only supported for modules. /// /// # Example /// /// ``` /// use std::borrow::Cow; /// use wasm_encoder::{ /// Elements, ElementSection, Module, TableSection, TableType, /// RefType, ConstExpr /// }; /// /// let mut tables = TableSection::new(); /// tables.table(TableType { /// element_type: RefType::FUNCREF, /// minimum: 128, /// maximum: None, /// table64: false, /// shared: false, /// }); /// /// let mut elements = ElementSection::new(); /// let table_index = 0; /// let offset = ConstExpr::i32_const(42); /// let functions = Elements::Functions(Cow::Borrowed(&[ /// // Function indices... /// ])); /// elements.active(Some(table_index), &offset, functions); /// /// let mut module = Module::new(); /// module /// .section(&tables) /// .section(&elements); /// /// let wasm_bytes = module.finish(); /// ``` #[derive(Clone, Default, Debug)] pub struct ElementSection { bytes: Vec, num_added: u32, } /// A sequence of elements in a segment in the element section. #[derive(Clone, Debug)] pub enum Elements<'a> { /// A sequences of references to functions by their indices. Functions(Cow<'a, [u32]>), /// A sequence of reference expressions. Expressions(RefType, Cow<'a, [ConstExpr]>), } /// An element segment's mode. #[derive(Clone, Debug)] pub enum ElementMode<'a> { /// A passive element segment. /// /// Passive segments are part of the bulk memory proposal. Passive, /// A declared element segment. /// /// Declared segments are part of the bulk memory proposal. Declared, /// An active element segment. Active { /// The table index. /// /// `Active` element specifying a `None` table forces the MVP encoding and refers to the /// 0th table holding `funcref`s. Non-`None` tables use the encoding introduced with the /// bulk memory proposal and can refer to tables with any valid reference type. table: Option, /// The offset within the table to place this segment. offset: &'a ConstExpr, }, } /// An element segment in the element section. #[derive(Clone, Debug)] pub struct ElementSegment<'a> { /// The element segment's mode. pub mode: ElementMode<'a>, /// This segment's elements. pub elements: Elements<'a>, } impl ElementSection { /// Create a new element section encoder. pub fn new() -> Self { Self::default() } /// The number of element segments in the section. pub fn len(&self) -> u32 { self.num_added } /// Determines if the section is empty. pub fn is_empty(&self) -> bool { self.num_added == 0 } /// Define an element segment. pub fn segment<'a>(&mut self, segment: ElementSegment<'a>) -> &mut Self { let expr_bit = match segment.elements { Elements::Expressions(..) => 0b100u32, Elements::Functions(_) => 0b000u32, }; let mut encode_type = false; match &segment.mode { ElementMode::Passive => { (0x01 | expr_bit).encode(&mut self.bytes); encode_type = true; } ElementMode::Active { table, offset } => { match (table, &segment.elements) { // If the `table` is not specified then the 0x00 encoding // can be used with either function indices or expressions // that have a `funcref` type. (None, Elements::Functions(_) | Elements::Expressions(RefType::FUNCREF, _)) => { (/* 0x00 | */expr_bit).encode(&mut self.bytes); } // ... otherwise fall through for all other expressions here // with table 0 or an explicitly specified table to the 0x02 // encoding. (None, Elements::Expressions(..)) | (Some(_), _) => { (0x02 | expr_bit).encode(&mut self.bytes); table.unwrap_or(0).encode(&mut self.bytes); encode_type = true; } } offset.encode(&mut self.bytes); } ElementMode::Declared => { (0x03 | expr_bit).encode(&mut self.bytes); encode_type = true; } } match segment.elements { Elements::Functions(fs) => { if encode_type { // elemkind == funcref self.bytes.push(0x00); } fs.encode(&mut self.bytes); } Elements::Expressions(ty, e) => { if encode_type { ty.encode(&mut self.bytes); } e.len().encode(&mut self.bytes); for expr in e.iter() { expr.encode(&mut self.bytes); } } } self.num_added += 1; self } /// Define an active element segment. /// /// `Active` element specifying a `None` table forces the MVP encoding and refers to the 0th /// table holding `funcref`s. Non-`None` tables use the encoding introduced with the bulk /// memory proposal and can refer to tables with any valid reference type. pub fn active( &mut self, table_index: Option, offset: &ConstExpr, elements: Elements<'_>, ) -> &mut Self { self.segment(ElementSegment { mode: ElementMode::Active { table: table_index, offset, }, elements, }) } /// Encode a passive element segment. /// /// Passive segments are part of the bulk memory proposal. pub fn passive<'a>(&mut self, elements: Elements<'a>) -> &mut Self { self.segment(ElementSegment { mode: ElementMode::Passive, elements, }) } /// Encode a declared element segment. /// /// Declared segments are part of the bulk memory proposal. pub fn declared<'a>(&mut self, elements: Elements<'a>) -> &mut Self { self.segment(ElementSegment { mode: ElementMode::Declared, elements, }) } /// Copy a raw, already-encoded element segment into this elements section. pub fn raw(&mut self, raw_bytes: &[u8]) -> &mut Self { self.bytes.extend_from_slice(raw_bytes); self.num_added += 1; self } } impl Encode for ElementSection { fn encode(&self, sink: &mut Vec) { encode_section(sink, self.num_added, &self.bytes); } } impl Section for ElementSection { fn id(&self) -> u8 { SectionId::Element.into() } }