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
/* 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, BinaryReaderError, OperatorsReader, Result, SectionIteratorLimited,
SectionReader, SectionWithLimitedItems, ValType,
};
use std::ops::Range;
/// Represents a WebAssembly function body.
#[derive(Debug, Clone, Copy)]
pub struct FunctionBody<'a> {
offset: usize,
data: &'a [u8],
allow_memarg64: bool,
}
impl<'a> FunctionBody<'a> {
/// Constructs a new `FunctionBody` for the given data and offset.
pub fn new(offset: usize, data: &'a [u8]) -> Self {
Self {
offset,
data,
allow_memarg64: false,
}
}
/// Whether or not to allow 64-bit memory arguments in the
/// function body.
///
/// This is intended to be `true` when support for the memory64
/// WebAssembly proposal is also enabled.
pub fn allow_memarg64(&mut self, allow: bool) {
self.allow_memarg64 = allow;
}
/// Gets a binary reader for this function body.
pub fn get_binary_reader<'b>(&self) -> BinaryReader<'b>
where
'a: 'b,
{
let mut reader = BinaryReader::new_with_offset(self.data, self.offset);
reader.allow_memarg64(self.allow_memarg64);
reader
}
fn skip_locals(reader: &mut BinaryReader) -> Result<()> {
let count = reader.read_var_u32()?;
for _ in 0..count {
reader.read_var_u32()?;
reader.read_var_u32()?;
}
Ok(())
}
/// Gets the locals reader for this function body.
pub fn get_locals_reader<'b>(&self) -> Result<LocalsReader<'b>>
where
'a: 'b,
{
let mut reader = BinaryReader::new_with_offset(self.data, self.offset);
let count = reader.read_var_u32()?;
Ok(LocalsReader { reader, count })
}
/// Gets the operators reader for this function body.
pub fn get_operators_reader<'b>(&self) -> Result<OperatorsReader<'b>>
where
'a: 'b,
{
let mut reader = BinaryReader::new_with_offset(self.data, self.offset);
Self::skip_locals(&mut reader)?;
let pos = reader.position;
let mut reader = OperatorsReader::new(&self.data[pos..], self.offset + pos);
reader.allow_memarg64(self.allow_memarg64);
Ok(reader)
}
/// Gets the range of the function body.
pub fn range(&self) -> Range<usize> {
self.offset..self.offset + self.data.len()
}
}
/// A reader for a function body's locals.
pub struct LocalsReader<'a> {
reader: BinaryReader<'a>,
count: u32,
}
impl<'a> LocalsReader<'a> {
/// Gets the count of locals in the function body.
pub fn get_count(&self) -> u32 {
self.count
}
/// Gets the original position of the reader.
pub fn original_position(&self) -> usize {
self.reader.original_position()
}
/// Reads an item from the reader.
pub fn read(&mut self) -> Result<(u32, ValType)> {
let count = self.reader.read_var_u32()?;
let value_type = self.reader.read_val_type()?;
Ok((count, value_type))
}
}
impl<'a> IntoIterator for LocalsReader<'a> {
type Item = Result<(u32, ValType)>;
type IntoIter = LocalsIterator<'a>;
fn into_iter(self) -> Self::IntoIter {
let count = self.count;
LocalsIterator {
reader: self,
left: count,
err: false,
}
}
}
/// An iterator over locals in a function body.
pub struct LocalsIterator<'a> {
reader: LocalsReader<'a>,
left: u32,
err: bool,
}
impl<'a> Iterator for LocalsIterator<'a> {
type Item = Result<(u32, ValType)>;
fn next(&mut self) -> Option<Self::Item> {
if self.err || self.left == 0 {
return None;
}
let result = self.reader.read();
self.err = result.is_err();
self.left -= 1;
Some(result)
}
fn size_hint(&self) -> (usize, Option<usize>) {
let count = self.reader.get_count() as usize;
(count, Some(count))
}
}
/// A reader for the code section of a WebAssembly module.
pub struct CodeSectionReader<'a> {
reader: BinaryReader<'a>,
count: u32,
}
impl<'a> CodeSectionReader<'a> {
/// Constructs a new `CodeSectionReader` for the given data and offset.
pub fn new(data: &'a [u8], offset: usize) -> Result<CodeSectionReader<'a>> {
let mut reader = BinaryReader::new_with_offset(data, offset);
let count = reader.read_var_u32()?;
Ok(CodeSectionReader { reader, count })
}
/// Gets the original position of the reader.
pub fn original_position(&self) -> usize {
self.reader.original_position()
}
/// Gets the count of items in the section.
pub fn get_count(&self) -> u32 {
self.count
}
fn verify_body_end(&self, end: usize) -> Result<()> {
if self.reader.buffer.len() < end {
return Err(BinaryReaderError::new(
"function body extends past end of the code section",
self.reader.original_offset + self.reader.buffer.len(),
));
}
Ok(())
}
/// Reads content of the code section.
///
/// # Examples
/// ```
/// use wasmparser::CodeSectionReader;
/// # let data: &[u8] = &[
/// # 0x01, 0x03, 0x00, 0x01, 0x0b];
/// let mut code_reader = CodeSectionReader::new(data, 0).unwrap();
/// for _ in 0..code_reader.get_count() {
/// let body = code_reader.read().expect("function body");
/// let mut binary_reader = body.get_binary_reader();
/// assert!(binary_reader.read_var_u32().expect("local count") == 0);
/// let op = binary_reader.read_operator().expect("first operator");
/// println!("First operator: {:?}", op);
/// }
/// ```
pub fn read<'b>(&mut self) -> Result<FunctionBody<'b>>
where
'a: 'b,
{
let size = self.reader.read_var_u32()? as usize;
let body_start = self.reader.position;
let body_end = body_start + size;
self.verify_body_end(body_end)?;
self.reader.skip_to(body_end);
Ok(FunctionBody {
offset: self.reader.original_offset + body_start,
data: &self.reader.buffer[body_start..body_end],
allow_memarg64: false,
})
}
}
impl<'a> SectionReader for CodeSectionReader<'a> {
type Item = FunctionBody<'a>;
fn read(&mut self) -> Result<Self::Item> {
CodeSectionReader::read(self)
}
fn eof(&self) -> bool {
self.reader.eof()
}
fn original_position(&self) -> usize {
CodeSectionReader::original_position(self)
}
fn range(&self) -> Range<usize> {
self.reader.range()
}
}
impl<'a> SectionWithLimitedItems for CodeSectionReader<'a> {
fn get_count(&self) -> u32 {
CodeSectionReader::get_count(self)
}
}
impl<'a> IntoIterator for CodeSectionReader<'a> {
type Item = Result<FunctionBody<'a>>;
type IntoIter = SectionIteratorLimited<CodeSectionReader<'a>>;
/// Implements iterator over the code section.
///
/// # Examples
/// ```
/// use wasmparser::CodeSectionReader;
/// # let data: &[u8] = &[
/// # 0x01, 0x03, 0x00, 0x01, 0x0b];
/// let mut code_reader = CodeSectionReader::new(data, 0).unwrap();
/// for body in code_reader {
/// let mut binary_reader = body.expect("b").get_binary_reader();
/// assert!(binary_reader.read_var_u32().expect("local count") == 0);
/// let op = binary_reader.read_operator().expect("first operator");
/// println!("First operator: {:?}", op);
/// }
/// ```
fn into_iter(self) -> Self::IntoIter {
SectionIteratorLimited::new(self)
}
}