1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
/* Copyright 2018 Mozilla Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use crate::{BinaryReader, Result, SectionIteratorLimited, SectionReader, SectionWithLimitedItems};
use std::fmt::Debug;
use std::ops::Range;
/// Represents the types of values in a WebAssembly module.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum ValType {
/// The value type is i32.
I32,
/// The value type is i64.
I64,
/// The value type is f32.
F32,
/// The value type is f64.
F64,
/// The value type is v128.
V128,
/// The value type is a function reference.
FuncRef,
/// The value type is an extern reference.
ExternRef,
}
impl ValType {
/// Returns whether this value type is a "reference type".
///
/// Only reference types are allowed in tables, for example, and with some
/// instructions. Current reference types include `funcref` and `externref`.
pub fn is_reference_type(&self) -> bool {
matches!(self, ValType::FuncRef | ValType::ExternRef)
}
}
/// Represents a type in a WebAssembly module.
#[derive(Debug, Clone)]
pub enum Type {
/// The type is for a function.
Func(FuncType),
}
/// Represents a type of a function in a WebAssembly module.
#[derive(Clone, Eq, PartialEq, Hash)]
pub struct FuncType {
/// The combined parameters and result types.
params_results: Box<[ValType]>,
/// The number of paramter types.
len_params: usize,
}
impl Debug for FuncType {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("FuncType")
.field("params", &self.params())
.field("returns", &self.results())
.finish()
}
}
impl FuncType {
/// Creates a new [`FuncType`] from the given `params` and `results`.
pub fn new<P, R>(params: P, results: R) -> Self
where
P: IntoIterator<Item = ValType>,
R: IntoIterator<Item = ValType>,
{
let mut buffer = params.into_iter().collect::<Vec<_>>();
let len_params = buffer.len();
buffer.extend(results);
Self {
params_results: buffer.into(),
len_params,
}
}
/// Creates a new [`FuncType`] fom its raw parts.
///
/// # Panics
///
/// If `len_params` is greater than the length of `params_results` combined.
pub(crate) fn from_raw_parts(params_results: Box<[ValType]>, len_params: usize) -> Self {
assert!(len_params <= params_results.len());
Self {
params_results,
len_params,
}
}
/// Returns a shared slice to the parameter types of the [`FuncType`].
#[inline]
pub fn params(&self) -> &[ValType] {
&self.params_results[..self.len_params]
}
/// Returns a shared slice to the result types of the [`FuncType`].
#[inline]
pub fn results(&self) -> &[ValType] {
&self.params_results[self.len_params..]
}
}
/// Represents a table's type.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct TableType {
/// The table's element type.
pub element_type: ValType,
/// Initial size of this table, in elements.
pub initial: u32,
/// Optional maximum size of the table, in elements.
pub maximum: Option<u32>,
}
/// Represents a memory's type.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct MemoryType {
/// Whether or not this is a 64-bit memory, using i64 as an index. If this
/// is false it's a 32-bit memory using i32 as an index.
///
/// This is part of the memory64 proposal in WebAssembly.
pub memory64: bool,
/// Whether or not this is a "shared" memory, indicating that it should be
/// send-able across threads and the `maximum` field is always present for
/// valid types.
///
/// This is part of the threads proposal in WebAssembly.
pub shared: bool,
/// Initial size of this memory, in wasm pages.
///
/// For 32-bit memories (when `memory64` is `false`) this is guaranteed to
/// be at most `u32::MAX` for valid types.
pub initial: u64,
/// Optional maximum size of this memory, in wasm pages.
///
/// For 32-bit memories (when `memory64` is `false`) this is guaranteed to
/// be at most `u32::MAX` for valid types. This field is always present for
/// valid wasm memories when `shared` is `true`.
pub maximum: Option<u64>,
}
impl MemoryType {
/// Gets the index type for the memory.
pub fn index_type(&self) -> ValType {
if self.memory64 {
ValType::I64
} else {
ValType::I32
}
}
}
/// Represents a global's type.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct GlobalType {
/// The global's type.
pub content_type: ValType,
/// Whether or not the global is mutable.
pub mutable: bool,
}
/// Represents a tag kind.
#[derive(Clone, Copy, Debug)]
pub enum TagKind {
/// The tag is an exception type.
Exception,
}
/// A tag's type.
#[derive(Clone, Copy, Debug)]
pub struct TagType {
/// The kind of tag
pub kind: TagKind,
/// The function type this tag uses.
pub func_type_idx: u32,
}
/// A reader for the type section of a WebAssembly module.
#[derive(Clone)]
pub struct TypeSectionReader<'a> {
reader: BinaryReader<'a>,
count: u32,
}
impl<'a> TypeSectionReader<'a> {
/// Constructs a new `TypeSectionReader` for the given data and offset.
pub fn new(data: &'a [u8], offset: usize) -> Result<Self> {
let mut reader = BinaryReader::new_with_offset(data, offset);
let count = reader.read_var_u32()?;
Ok(Self { reader, count })
}
/// Gets the original position of the reader.
pub fn original_position(&self) -> usize {
self.reader.original_position()
}
/// Gets a count of items in the section.
pub fn get_count(&self) -> u32 {
self.count
}
/// Reads content of the type section.
///
/// # Examples
/// ```
/// use wasmparser::TypeSectionReader;
/// let data: &[u8] = &[0x01, 0x60, 0x00, 0x00];
/// let mut reader = TypeSectionReader::new(data, 0).unwrap();
/// for _ in 0..reader.get_count() {
/// let ty = reader.read().expect("type");
/// println!("Type {:?}", ty);
/// }
/// ```
pub fn read(&mut self) -> Result<Type> {
self.reader.read_type()
}
}
impl<'a> SectionReader for TypeSectionReader<'a> {
type Item = Type;
fn read(&mut self) -> Result<Self::Item> {
Self::read(self)
}
fn eof(&self) -> bool {
self.reader.eof()
}
fn original_position(&self) -> usize {
Self::original_position(self)
}
fn range(&self) -> Range<usize> {
self.reader.range()
}
}
impl<'a> SectionWithLimitedItems for TypeSectionReader<'a> {
fn get_count(&self) -> u32 {
Self::get_count(self)
}
}
impl<'a> IntoIterator for TypeSectionReader<'a> {
type Item = Result<Type>;
type IntoIter = SectionIteratorLimited<Self>;
/// Implements iterator over the type section.
///
/// # Examples
/// ```
/// use wasmparser::TypeSectionReader;
/// # let data: &[u8] = &[0x01, 0x60, 0x00, 0x00];
/// let mut reader = TypeSectionReader::new(data, 0).unwrap();
/// for ty in reader {
/// println!("Type {:?}", ty.expect("type"));
/// }
/// ```
fn into_iter(self) -> Self::IntoIter {
SectionIteratorLimited::new(self)
}
}