Skip to content

Make Instruction::update_branch_offset usable by both FuncTranlator backends #1560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Robbepop merged 3 commits into from
Jul 10, 2025
Merged

Make Instruction::update_branch_offset usable by both FuncTranlator backends #1560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3dc8c23
put UpdateBranchOffset trait + impl into comparator.rs
Robbepop Jul 10, 2025
3320e08
refactor Instruction::update_branch_offset trait method impl
Robbepop Jul 10, 2025
5c19cff
change formatting
Robbepop Jul 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 116 additions & 0 deletions crates/wasmi/src/engine/translator/comparator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -784,3 +784,119 @@
};
Some(comparator)
}

/// Extension trait to update the branch offset of an [`Instruction`].
pub trait UpdateBranchOffset {
/// Updates the [`BranchOffset`] for the branch [`Instruction].
///
/// # Panics
///
/// If `self` is not a branch [`Instruction`].
fn update_branch_offset(
&mut self,
stack: &mut impl AllocConst,
new_offset: BranchOffset,
) -> Result<(), Error>;
}

impl UpdateBranchOffset for Instruction {
#[rustfmt::skip]
fn update_branch_offset(
&mut self,
stack: &mut impl AllocConst,
new_offset: BranchOffset,
) -> Result<(), Error> {
use Instruction as I;
match self {
| I::Branch { offset }
| I::BranchTableTarget { offset, .. }
| I::BranchTableTargetNonOverlapping { offset, .. } => {
offset.init(new_offset);
return Ok(());
}
_ => {}
};
let offset = match self {
| I::BranchI32And { offset, .. }
| I::BranchI32Or { offset, .. }
| I::BranchI32Xor { offset, .. }
| I::BranchI32Nand { offset, .. }
| I::BranchI32Nor { offset, .. }
| I::BranchI32Xnor { offset, .. }
| I::BranchI32Eq { offset, .. }
| I::BranchI32Ne { offset, .. }
| I::BranchI32LtS { offset, .. }
| I::BranchI32LtU { offset, .. }
| I::BranchI32LeS { offset, .. }
| I::BranchI32LeU { offset, .. }
| I::BranchI64And { offset, .. }
| I::BranchI64Or { offset, .. }
| I::BranchI64Xor { offset, .. }
| I::BranchI64Nand { offset, .. }
| I::BranchI64Nor { offset, .. }
| I::BranchI64Xnor { offset, .. }
| I::BranchI64Eq { offset, .. }
| I::BranchI64Ne { offset, .. }
| I::BranchI64LtS { offset, .. }
| I::BranchI64LtU { offset, .. }
| I::BranchI64LeS { offset, .. }
| I::BranchI64LeU { offset, .. }
| I::BranchF32Eq { offset, .. }
| I::BranchF32Ne { offset, .. }
| I::BranchF32Lt { offset, .. }
| I::BranchF32Le { offset, .. }
| I::BranchF32NotLt { offset, .. }
| I::BranchF32NotLe { offset, .. }
| I::BranchF64Eq { offset, .. }
| I::BranchF64Ne { offset, .. }
| I::BranchF64Lt { offset, .. }
| I::BranchF64Le { offset, .. }
| I::BranchF64NotLt { offset, .. }
| I::BranchF64NotLe { offset, .. }
| I::BranchI32AndImm16 { offset, .. }
| I::BranchI32OrImm16 { offset, .. }
| I::BranchI32XorImm16 { offset, .. }
| I::BranchI32NandImm16 { offset, .. }
| I::BranchI32NorImm16 { offset, .. }
| I::BranchI32XnorImm16 { offset, .. }
| I::BranchI32EqImm16 { offset, .. }
| I::BranchI32NeImm16 { offset, .. }
| I::BranchI32LtSImm16Lhs { offset, .. }
| I::BranchI32LtSImm16Rhs { offset, .. }
| I::BranchI32LeSImm16Lhs { offset, .. }
| I::BranchI32LeSImm16Rhs { offset, .. }
| I::BranchI32LtUImm16Lhs { offset, .. }
| I::BranchI32LtUImm16Rhs { offset, .. }
| I::BranchI32LeUImm16Lhs { offset, .. }
| I::BranchI32LeUImm16Rhs { offset, .. }
| I::BranchI64AndImm16 { offset, .. }
| I::BranchI64OrImm16 { offset, .. }
| I::BranchI64XorImm16 { offset, .. }
| I::BranchI64NandImm16 { offset, .. }
| I::BranchI64NorImm16 { offset, .. }
| I::BranchI64XnorImm16 { offset, .. }
| I::BranchI64EqImm16 { offset, .. }
| I::BranchI64NeImm16 { offset, .. }
| I::BranchI64LtSImm16Lhs { offset, .. }
| I::BranchI64LtSImm16Rhs { offset, .. }
| I::BranchI64LeSImm16Lhs { offset, .. }
| I::BranchI64LeSImm16Rhs { offset, .. }
| I::BranchI64LtUImm16Lhs { offset, .. }
| I::BranchI64LtUImm16Rhs { offset, .. }
| I::BranchI64LeUImm16Lhs { offset, .. }
| I::BranchI64LeUImm16Rhs { offset, .. } => offset,
unexpected => {
panic!("expected a Wasmi `cmp`+`branch` instruction but found: {unexpected:?}")

Check warning on line 889 in crates/wasmi/src/engine/translator/comparator.rs

View check run for this annotation

Codecov / codecov/patch

crates/wasmi/src/engine/translator/comparator.rs#L888-L889 

Added lines #L888 - L889 were not covered by tests
}
};
if offset.init(new_offset).is_err() {
// Case: we need to covert `self` into its cmp+branch fallback instruction variant
// since adjusting the 16-bit offset failed.
let Some(fallback) = self.try_into_cmp_branch_fallback_instr(new_offset, stack)? else {
unreachable!("failed to create cmp+branch fallback instruction for: {self:?}");
};
*self = fallback;
}
Ok(())
}
}
113 changes: 1 addition & 112 deletions crates/wasmi/src/engine/translator/func/instr_encoder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ use crate::{
CompareResult,
LogicalizeCmpInstr,
NegateCmpInstr,
TryIntoCmpBranchFallbackInstr,
TryIntoCmpBranchInstr,
TryIntoCmpSelectInstr,
UpdateBranchOffset as _,
},
func::{
stack::RegisterSpace,
Expand Down Expand Up @@ -1103,117 +1103,6 @@ impl InstrEncoder {
}
}

/// Extension trait to update the branch offset of an [`Instruction`].
trait UpdateBranchOffset {
/// Updates the [`BranchOffset`] for the branch [`Instruction].
///
/// # Panics
///
/// If `self` is not a branch [`Instruction`].
fn update_branch_offset(
&mut self,
stack: &mut ValueStack,
new_offset: BranchOffset,
) -> Result<(), Error>;
}

impl UpdateBranchOffset for Instruction {
#[rustfmt::skip]
fn update_branch_offset(&mut self, stack: &mut ValueStack, new_offset: BranchOffset) -> Result<(), Error> {
use Instruction as I;
match self {
Instruction::Branch { offset } |
Instruction::BranchTableTarget { offset, .. } |
Instruction::BranchTableTargetNonOverlapping { offset, .. } => {
offset.init(new_offset);
return Ok(())
}
_ => {}
};
let update_status = match self {
I::BranchI32And { offset, .. } |
I::BranchI32Or { offset, .. } |
I::BranchI32Xor { offset, .. } |
I::BranchI32Nand { offset, .. } |
I::BranchI32Nor { offset, .. } |
I::BranchI32Xnor { offset, .. } |
I::BranchI32Eq { offset, .. } |
I::BranchI32Ne { offset, .. } |
I::BranchI32LtS { offset, .. } |
I::BranchI32LtU { offset, .. } |
I::BranchI32LeS { offset, .. } |
I::BranchI32LeU { offset, .. } |
I::BranchI64And { offset, .. } |
I::BranchI64Or { offset, .. } |
I::BranchI64Xor { offset, .. } |
I::BranchI64Nand { offset, .. } |
I::BranchI64Nor { offset, .. } |
I::BranchI64Xnor { offset, .. } |
I::BranchI64Eq { offset, .. } |
I::BranchI64Ne { offset, .. } |
I::BranchI64LtS { offset, .. } |
I::BranchI64LtU { offset, .. } |
I::BranchI64LeS { offset, .. } |
I::BranchI64LeU { offset, .. } |
I::BranchF32Eq { offset, .. } |
I::BranchF32Ne { offset, .. } |
I::BranchF32Lt { offset, .. } |
I::BranchF32Le { offset, .. } |
I::BranchF32NotLt { offset, .. } |
I::BranchF32NotLe { offset, .. } |
I::BranchF64Eq { offset, .. } |
I::BranchF64Ne { offset, .. } |
I::BranchF64Lt { offset, .. } |
I::BranchF64Le { offset, .. } |
I::BranchF64NotLt { offset, .. } |
I::BranchF64NotLe { offset, .. } |
I::BranchI32AndImm16 { offset, .. } |
I::BranchI32OrImm16 { offset, .. } |
I::BranchI32XorImm16 { offset, .. } |
I::BranchI32NandImm16 { offset, .. } |
I::BranchI32NorImm16 { offset, .. } |
I::BranchI32XnorImm16 { offset, .. } |
I::BranchI32EqImm16 { offset, .. } |
I::BranchI32NeImm16 { offset, .. } |
I::BranchI32LtSImm16Lhs { offset, .. } |
I::BranchI32LtSImm16Rhs { offset, .. } |
I::BranchI32LeSImm16Lhs { offset, .. } |
I::BranchI32LeSImm16Rhs { offset, .. } |
I::BranchI32LtUImm16Lhs { offset, .. } |
I::BranchI32LtUImm16Rhs { offset, .. } |
I::BranchI32LeUImm16Lhs { offset, .. } |
I::BranchI32LeUImm16Rhs { offset, .. } |
I::BranchI64AndImm16 { offset, .. } |
I::BranchI64OrImm16 { offset, .. } |
I::BranchI64XorImm16 { offset, .. } |
I::BranchI64NandImm16 { offset, .. } |
I::BranchI64NorImm16 { offset, .. } |
I::BranchI64XnorImm16 { offset, .. } |
I::BranchI64EqImm16 { offset, .. } |
I::BranchI64NeImm16 { offset, .. } |
I::BranchI64LtSImm16Lhs { offset, .. } |
I::BranchI64LtSImm16Rhs { offset, .. } |
I::BranchI64LeSImm16Lhs { offset, .. } |
I::BranchI64LeSImm16Rhs { offset, .. } |
I::BranchI64LtUImm16Lhs { offset, .. } |
I::BranchI64LtUImm16Rhs { offset, .. } |
I::BranchI64LeUImm16Lhs { offset, .. } |
I::BranchI64LeUImm16Rhs { offset, .. } => {
offset.init(new_offset)
}
unexpected => {
panic!("expected a Wasmi branch+cmp instruction but found: {unexpected:?}")
}
};
if update_status.is_err() {
if let Some(fallback) = self.try_into_cmp_branch_fallback_instr(new_offset, stack)? {
*self = fallback;
}
}
Ok(())
}
}

#[cfg(test)]
mod tests {
use super::*;
Expand Down