Skip to content

A lightweight WebAssembly runtime that is fast, secure, and standards-compliant

Add a shared maximum-frame-size check across all backends (#13783)

Soumik15630mc911bb4155b3
diff --git a/cranelift/codegen/src/isa/aarch64/mod.rs b/cranelift/codegen/src/isa/aarch64/mod.rs
index b7adf46f86..b613446495 100644
--- a/cranelift/codegen/src/isa/aarch64/mod.rs
+++ b/cranelift/codegen/src/isa/aarch64/mod.rs
@@ -74,7 +74,7 @@ impl TargetIsa for AArch64Backend {
) -> CodegenResult<CompiledCodeStencil> {
let (vcode, regalloc_result) = self.compile_vcode(func, domtree, ctrl_plane)?;
- let emit_result = vcode.emit(&regalloc_result, want_disasm, &self.flags, ctrl_plane);
+ let emit_result = vcode.emit(&regalloc_result, want_disasm, &self.flags, ctrl_plane)?;
let value_labels_ranges = emit_result.value_labels_ranges;
let buffer = emit_result.buffer;
diff --git a/cranelift/codegen/src/isa/pulley_shared/mod.rs b/cranelift/codegen/src/isa/pulley_shared/mod.rs
index 66d0051e9e..69ac4fd5f3 100644
--- a/cranelift/codegen/src/isa/pulley_shared/mod.rs
+++ b/cranelift/codegen/src/isa/pulley_shared/mod.rs
@@ -179,7 +179,7 @@ where
let want_disasm =
want_disasm || (cfg!(feature = "trace-log") && log::log_enabled!(log::Level::Debug));
- let emit_result = vcode.emit(&regalloc_result, want_disasm, &self.flags, ctrl_plane);
+ let emit_result = vcode.emit(&regalloc_result, want_disasm, &self.flags, ctrl_plane)?;
let value_labels_ranges = emit_result.value_labels_ranges;
let buffer = emit_result.buffer;
diff --git a/cranelift/codegen/src/isa/riscv64/mod.rs b/cranelift/codegen/src/isa/riscv64/mod.rs
index 21b899d3b5..e8f8ca4774 100644
--- a/cranelift/codegen/src/isa/riscv64/mod.rs
+++ b/cranelift/codegen/src/isa/riscv64/mod.rs
@@ -76,7 +76,7 @@ impl TargetIsa for Riscv64Backend {
let (vcode, regalloc_result) = self.compile_vcode(func, domtree, ctrl_plane)?;
let want_disasm = want_disasm || log::log_enabled!(log::Level::Debug);
- let emit_result = vcode.emit(&regalloc_result, want_disasm, &self.flags, ctrl_plane);
+ let emit_result = vcode.emit(&regalloc_result, want_disasm, &self.flags, ctrl_plane)?;
let value_labels_ranges = emit_result.value_labels_ranges;
let buffer = emit_result.buffer;
diff --git a/cranelift/codegen/src/isa/s390x/mod.rs b/cranelift/codegen/src/isa/s390x/mod.rs
index 1f2c2461ee..9d92adb7a9 100644
--- a/cranelift/codegen/src/isa/s390x/mod.rs
+++ b/cranelift/codegen/src/isa/s390x/mod.rs
@@ -73,7 +73,7 @@ impl TargetIsa for S390xBackend {
let flags = self.flags();
let (vcode, regalloc_result) = self.compile_vcode(func, domtree, ctrl_plane)?;
- let emit_result = vcode.emit(&regalloc_result, want_disasm, flags, ctrl_plane);
+ let emit_result = vcode.emit(&regalloc_result, want_disasm, flags, ctrl_plane)?;
let value_labels_ranges = emit_result.value_labels_ranges;
let buffer = emit_result.buffer;
diff --git a/cranelift/codegen/src/isa/x64/abi.rs b/cranelift/codegen/src/isa/x64/abi.rs
index e847c23b2a..81e87f8e35 100644
--- a/cranelift/codegen/src/isa/x64/abi.rs
+++ b/cranelift/codegen/src/isa/x64/abi.rs
@@ -1342,3 +1342,51 @@ const fn create_reg_env_systemv(enable_pinned_reg: bool) -> MachineEnv {
env
}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::machinst::abi::Callee;
+ use alloc::vec::Vec;
+
+ fn make_frame_layout(total_relevant_fields_sum: u32) -> FrameLayout {
+ FrameLayout {
+ word_bytes: 8,
+ incoming_args_size: 0,
+ tail_args_size: 0,
+ setup_area_size: 0,
+ clobber_size: 0,
+ fixed_frame_storage_size: total_relevant_fields_sum,
+ stackslots_size: 0,
+ outgoing_args_size: 0,
+ clobbered_callee_saves: Vec::new(),
+ function_calls: crate::machinst::FunctionCalls::None,
+ }
+ }
+
+ const ONE_GIB: u32 = 1 << 30;
+
+ #[test]
+ fn frame_layout_under_limit_is_accepted() {
+ let layout = make_frame_layout(ONE_GIB - 1);
+ assert!(!Callee::<X64ABIMachineSpec>::frame_layout_exceeds_limit(
+ &layout, ONE_GIB
+ ));
+ }
+
+ #[test]
+ fn frame_layout_at_exact_limit_is_accepted() {
+ let layout = make_frame_layout(ONE_GIB);
+ assert!(!Callee::<X64ABIMachineSpec>::frame_layout_exceeds_limit(
+ &layout, ONE_GIB
+ ));
+ }
+
+ #[test]
+ fn frame_layout_over_limit_is_rejected() {
+ let layout = make_frame_layout(ONE_GIB + 1);
+ assert!(Callee::<X64ABIMachineSpec>::frame_layout_exceeds_limit(
+ &layout, ONE_GIB
+ ));
+ }
+}
diff --git a/cranelift/codegen/src/isa/x64/mod.rs b/cranelift/codegen/src/isa/x64/mod.rs
index 15eb736f47..96f6f3b525 100644
--- a/cranelift/codegen/src/isa/x64/mod.rs
+++ b/cranelift/codegen/src/isa/x64/mod.rs
@@ -82,7 +82,7 @@ impl TargetIsa for X64Backend {
) -> CodegenResult<CompiledCodeStencil> {
let (vcode, regalloc_result) = self.compile_vcode(func, domtree, ctrl_plane)?;
- let emit_result = vcode.emit(&regalloc_result, want_disasm, &self.flags, ctrl_plane);
+ let emit_result = vcode.emit(&regalloc_result, want_disasm, &self.flags, ctrl_plane)?;
let value_labels_ranges = emit_result.value_labels_ranges;
let buffer = emit_result.buffer;
diff --git a/cranelift/codegen/src/machinst/abi.rs b/cranelift/codegen/src/machinst/abi.rs
index e467d8ccad..c7b42116b5 100644
--- a/cranelift/codegen/src/machinst/abi.rs
+++ b/cranelift/codegen/src/machinst/abi.rs
@@ -498,6 +498,12 @@ pub trait ABIMachineSpec {
outgoing_args_size: u32,
) -> FrameLayout;
+ /// Defaults to a conservative 1GiB
+ /// across all backends.
+ fn maximum_frame_size() -> u32 {
+ 1 << 30 // 1 GiB
+ }
+
/// Generate the usual frame-setup sequence for this architecture: e.g.,
/// `push rbp / mov rbp, rsp` on x86-64, or `stp fp, lr, [sp, #-16]!` on
/// AArch64.
@@ -2204,12 +2210,12 @@ impl<M: ABIMachineSpec> Callee<M> {
spillslots: usize,
clobbered: Vec<Writable<RealReg>>,
function_calls: FunctionCalls,
- ) {
+ ) -> CodegenResult<()> {
let bytes = M::word_bytes();
let total_stacksize = self.stackslots_size + bytes * spillslots as u32;
let mask = M::stack_align(self.call_conv) - 1;
let total_stacksize = (total_stacksize + mask) & !mask; // 16-align the stack.
- self.frame_layout = Some(M::compute_frame_layout(
+ let frame_layout = M::compute_frame_layout(
self.call_conv,
&self.flags,
self.signature(),
@@ -2220,7 +2226,28 @@ impl<M: ABIMachineSpec> Callee<M> {
self.stackslots_size,
total_stacksize,
self.outgoing_args_size,
- ));
+ );
+
+ if Self::frame_layout_exceeds_limit(&frame_layout, M::maximum_frame_size()) {
+ return Err(CodegenError::ImplLimitExceeded);
+ }
+
+ self.frame_layout = Some(frame_layout);
+ Ok(())
+ }
+
+ /// Pulled out so that it can be used directly in tests without constructing a full `Callee`.
+ pub(crate) fn frame_layout_exceeds_limit(
+ frame_layout: &FrameLayout,
+ max_frame_size: u32,
+ ) -> bool {
+ let total: u64 = frame_layout.incoming_args_size as u64
+ + frame_layout.tail_args_size as u64
+ + frame_layout.setup_area_size as u64
+ + frame_layout.clobber_size as u64
+ + frame_layout.fixed_frame_storage_size as u64
+ + frame_layout.outgoing_args_size as u64;
+ total > max_frame_size as u64
}
/// Generate a prologue, post-regalloc.
diff --git a/cranelift/codegen/src/machinst/vcode.rs b/cranelift/codegen/src/machinst/vcode.rs
index 24e82202a0..2efb29a905 100644
--- a/cranelift/codegen/src/machinst/vcode.rs
+++ b/cranelift/codegen/src/machinst/vcode.rs
@@ -739,7 +739,7 @@ impl<I: VCodeInst> VCode<I> {
want_disasm: bool,
flags: &settings::Flags,
ctrl_plane: &mut ControlPlane,
- ) -> EmitResult
+ ) -> CodegenResult<EmitResult>
where
I: VCodeInst,
{
@@ -783,7 +783,7 @@ impl<I: VCodeInst> VCode<I> {
regalloc.num_spillslots,
clobbers,
function_calls,
- );
+ )?;
// Emit blocks.
let mut cur_srcloc = None;
@@ -1164,13 +1164,13 @@ impl<I: VCodeInst> VCode<I> {
// Store metadata about frame layout in the MachBuffer.
buffer.set_frame_layout(self.abi.frame_slot_metadata());
- EmitResult {
+ Ok(EmitResult {
buffer: buffer.finish(&self.constants, ctrl_plane),
bb_offsets,
bb_edges,
disasm: if want_disasm { Some(disasm) } else { None },
value_labels_ranges,
- }
+ })
}
fn monotonize_inst_offsets(&self, inst_offsets: &mut [CodeOffset], func_body_len: u32) {