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 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
use crate::{isa::reg::Reg, masm::StackSlot};
use std::collections::VecDeque;
use std::ops::RangeBounds;
use wasmparser::{Ieee32, Ieee64};
use wasmtime_environ::WasmType;
/// A typed register value used to track register values in the value
/// stack.
#[derive(Debug, Eq, PartialEq, Copy, Clone)]
pub struct TypedReg {
/// The physical register.
pub reg: Reg,
/// The type associated to the physical register.
pub ty: WasmType,
}
impl TypedReg {
/// Create a new [`TypedReg`].
pub fn new(ty: WasmType, reg: Reg) -> Self {
Self { ty, reg }
}
/// Create an i64 [`TypedReg`].
pub fn i64(reg: Reg) -> Self {
Self {
ty: WasmType::I64,
reg,
}
}
}
impl From<TypedReg> for Reg {
fn from(tr: TypedReg) -> Self {
tr.reg
}
}
/// A local value.
#[derive(Debug, Eq, PartialEq, Copy, Clone)]
pub struct Local {
/// The index of the local.
pub index: u32,
/// The type of the local.
pub ty: WasmType,
}
/// A memory value.
#[derive(Debug, Eq, PartialEq, Copy, Clone)]
pub struct Memory {
/// The type associated with the memory offset.
pub ty: WasmType,
/// The stack slot corresponding to the memory value.
pub slot: StackSlot,
}
/// Value definition to be used within the shadow stack.
#[derive(Debug, Eq, PartialEq, Copy, Clone)]
pub(crate) enum Val {
/// I32 Constant.
I32(i32),
/// I64 Constant.
I64(i64),
/// F32 Constant.
F32(Ieee32),
/// F64 Constant.
F64(Ieee64),
/// A register value.
Reg(TypedReg),
/// A local slot.
Local(Local),
/// Offset to a memory location.
Memory(Memory),
}
impl From<TypedReg> for Val {
fn from(tr: TypedReg) -> Self {
Val::Reg(tr)
}
}
impl From<Local> for Val {
fn from(local: Local) -> Self {
Val::Local(local)
}
}
impl From<Memory> for Val {
fn from(mem: Memory) -> Self {
Val::Memory(mem)
}
}
impl TryFrom<u32> for Val {
type Error = anyhow::Error;
fn try_from(value: u32) -> Result<Self, Self::Error> {
i32::try_from(value).map(Val::i32).map_err(Into::into)
}
}
impl Val {
/// Create a new I32 constant value.
pub fn i32(v: i32) -> Self {
Self::I32(v)
}
/// Create a new I64 constant value.
pub fn i64(v: i64) -> Self {
Self::I64(v)
}
/// Create a new F32 constant value.
pub fn f32(v: Ieee32) -> Self {
Self::F32(v)
}
pub fn f64(v: Ieee64) -> Self {
Self::F64(v)
}
/// Create a new Reg value.
pub fn reg(reg: Reg, ty: WasmType) -> Self {
Self::Reg(TypedReg { reg, ty })
}
/// Create a new Local value.
pub fn local(index: u32, ty: WasmType) -> Self {
Self::Local(Local { index, ty })
}
/// Create a Memory value.
pub fn mem(ty: WasmType, slot: StackSlot) -> Self {
Self::Memory(Memory { ty, slot })
}
/// Check whether the value is a register.
pub fn is_reg(&self) -> bool {
match *self {
Self::Reg(_) => true,
_ => false,
}
}
/// Check wheter the value is a memory offset.
pub fn is_mem(&self) -> bool {
match *self {
Self::Memory(_) => true,
_ => false,
}
}
/// Get the register representation of the value.
///
/// # Panics
/// This method will panic if the value is not a register.
pub fn get_reg(&self) -> TypedReg {
match self {
Self::Reg(tr) => *tr,
v => panic!("expected value {:?} to be a register", v),
}
}
/// Get the integer representation of the value.
///
/// # Panics
/// This method will panic if the value is not an i32.
pub fn get_i32(&self) -> i32 {
match self {
Self::I32(v) => *v,
v => panic!("expected value {:?} to be i32", v),
}
}
/// Get the integer representation of the value.
///
/// # Panics
/// This method will panic if the value is not an i64.
pub fn get_i64(&self) -> i64 {
match self {
Self::I64(v) => *v,
v => panic!("expected value {:?} to be i64", v),
}
}
/// Check whether the value is an i32 constant.
pub fn is_i32_const(&self) -> bool {
match *self {
Self::I32(_) => true,
_ => false,
}
}
/// Check whether the value is an i64 constant.
pub fn is_i64_const(&self) -> bool {
match *self {
Self::I64(_) => true,
_ => false,
}
}
/// Get the type of the value.
pub fn ty(&self) -> WasmType {
match self {
Val::I32(_) => WasmType::I32,
Val::I64(_) => WasmType::I64,
Val::F32(_) => WasmType::F32,
Val::F64(_) => WasmType::F64,
Val::Reg(r) => r.ty,
Val::Memory(m) => m.ty,
Val::Local(l) => l.ty,
}
}
}
/// The shadow stack used for compilation.
#[derive(Default, Debug)]
pub(crate) struct Stack {
inner: VecDeque<Val>,
}
impl Stack {
/// Allocate a new stack.
pub fn new() -> Self {
Self {
inner: Default::default(),
}
}
/// Insert a new value at the specified index.
pub fn insert(&mut self, at: usize, val: Val) {
self.inner.insert(at, val);
}
/// Get the length of the stack.
pub fn len(&self) -> usize {
self.inner.len()
}
/// Push a value to the stack.
pub fn push(&mut self, val: Val) {
self.inner.push_back(val);
}
/// Peek into the top in the stack.
pub fn peek(&self) -> Option<&Val> {
self.inner.back()
}
/// Returns an iterator referencing the last n items of the stack,
/// in bottom-most to top-most order.
pub fn peekn(&self, n: usize) -> impl Iterator<Item = &Val> + '_ {
let len = self.len();
assert!(n <= len);
let partition = len - n;
self.inner.range(partition..)
}
/// Pops the top element of the stack, if any.
pub fn pop(&mut self) -> Option<Val> {
self.inner.pop_back()
}
/// Pops the element at the top of the stack if it is an i32 const;
/// returns `None` otherwise.
pub fn pop_i32_const(&mut self) -> Option<i32> {
match self.peek() {
Some(v) => v.is_i32_const().then(|| self.pop().unwrap().get_i32()),
_ => None,
}
}
/// Pops the element at the top of the stack if it is an i64 const;
/// returns `None` otherwise.
pub fn pop_i64_const(&mut self) -> Option<i64> {
match self.peek() {
Some(v) => v.is_i64_const().then(|| self.pop().unwrap().get_i64()),
_ => None,
}
}
/// Pops the element at the top of the stack if it is a register;
/// returns `None` otherwise.
pub fn pop_reg(&mut self) -> Option<TypedReg> {
match self.peek() {
Some(v) => v.is_reg().then(|| self.pop().unwrap().get_reg()),
_ => None,
}
}
/// Pops the given register if it is at the top of the stack;
/// returns `None` otherwise.
pub fn pop_named_reg(&mut self, reg: Reg) -> Option<TypedReg> {
match self.peek() {
Some(v) => {
(v.is_reg() && v.get_reg().reg == reg).then(|| self.pop().unwrap().get_reg())
}
_ => None,
}
}
/// Get a mutable reference to the inner stack representation.
pub fn inner_mut(&mut self) -> &mut VecDeque<Val> {
&mut self.inner
}
/// Calculates size in bytes of memory entries within the specified range of
/// the stack.
pub fn sizeof<R>(&self, range: R) -> u32
where
R: RangeBounds<usize>,
{
self.inner.range(range).fold(0, |acc, v| match v {
Val::Memory(m) => acc + m.slot.size,
_ => acc,
})
}
}
#[cfg(test)]
mod tests {
use super::{Stack, Val};
use crate::isa::reg::Reg;
use wasmtime_environ::WasmType;
#[test]
fn test_pop_i32_const() {
let mut stack = Stack::new();
stack.push(Val::i32(33i32));
assert_eq!(33, stack.pop_i32_const().unwrap());
stack.push(Val::local(10, WasmType::I32));
assert!(stack.pop_i32_const().is_none());
}
#[test]
fn test_pop_reg() {
let mut stack = Stack::new();
let reg = Reg::int(2usize);
stack.push(Val::reg(reg, WasmType::I32));
stack.push(Val::i32(4));
assert_eq!(None, stack.pop_reg());
let _ = stack.pop().unwrap();
assert_eq!(reg, stack.pop_reg().unwrap().reg);
}
#[test]
fn test_pop_named_reg() {
let mut stack = Stack::new();
let reg = Reg::int(2usize);
stack.push(Val::reg(reg, WasmType::I32));
stack.push(Val::reg(Reg::int(4), WasmType::I32));
assert_eq!(None, stack.pop_named_reg(reg));
let _ = stack.pop().unwrap();
assert_eq!(reg, stack.pop_named_reg(reg).unwrap().reg);
}
}