Skip to content
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.

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

Fix a case of using the wrong stack map during gcs #2396

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 22 additions & 4 deletions crates/runtime/src/externref.rs
Original file line number Diff line number Diff line change
Expand Up @@ -779,8 +779,9 @@ struct ModuleStackMaps {
range: std::ops::Range<usize>,

/// A map from a PC in this module (that is a GC safepoint) to its
/// associated stack map.
pc_to_stack_map: Vec<(usize, Rc<StackMap>)>,
/// associated stack map. If `None` then it means that the PC is the start
/// of a range which has no stack map.
pc_to_stack_map: Vec<(usize, Option<Rc<StackMap>>)>,
}

impl StackMapRegistry {
Expand All @@ -797,19 +798,36 @@ impl StackMapRegistry {
let mut min = usize::max_value();
let mut max = 0;
let mut pc_to_stack_map = vec![];
let mut last_is_none_marker = true;

for (range, infos) in stack_maps {
let len = range.end - range.start;

min = std::cmp::min(min, range.start);
max = std::cmp::max(max, range.end);

// Add a marker between functions indicating that this function's pc
// starts with no stack map so when our binary search later on finds
// a pc between the start of the function and the function's first
// stack map it doesn't think the previous stack map is our stack
// map.
//
// We skip this if the previous entry pushed was also a `None`
// marker, in which case the starting pc already has no stack map.
// This is also skipped if the first `code_offset` is zero since
// what we'll push applies for the first pc anyway.
if !last_is_none_marker && (infos.is_empty() || infos[0].code_offset > 0) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could make this a tiny bit less wordy (although perhaps some would argue less readable) like this:

Suggested change
if !last_is_none_marker && (infos.is_empty() || infos[0].code_offset > 0) {
if !last_is_none_marker && (infos.get(0).map_or(true, |i| i.code_offset > 0) {

I would probably use map_or personally but it doesn't really matter either way.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I guess this isn't actually even less wordy... nevermind!

pc_to_stack_map.push((range.start, None));
last_is_none_marker = true;
}

for info in infos {
assert!((info.code_offset as usize) < len);
pc_to_stack_map.push((
range.start + (info.code_offset as usize),
Rc::new(info.stack_map.clone()),
Some(Rc::new(info.stack_map.clone())),
));
last_is_none_marker = false;
}
}

Expand Down Expand Up @@ -911,7 +929,7 @@ impl StackMapRegistry {
Err(n) => n - 1,
};

let stack_map = stack_maps.pc_to_stack_map[index].1.clone();
let stack_map = stack_maps.pc_to_stack_map[index].1.as_ref()?.clone();
Some(stack_map)
}
}
Expand Down
49 changes: 49 additions & 0 deletions tests/misc_testsuite/reference-types/no-mixup-stack-maps.wast
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
(module
(global $g (mut externref) (ref.null extern))

;; This function will have a stack map, notably one that's a bit
;; different than the one below.
(func $has_a_stack_map
(local externref)
global.get $g
local.tee 0
global.set $g

local.get 0
global.set $g
ref.null extern
global.set $g
)

;; This function also has a stack map, but it's only applicable after
;; the call to the `$gc` import, so when we gc during that we shouldn't
;; accidentally read the previous function's stack maps and use that
;; for our own.
(func (export "run") (result i32)
call $gc

ref.null extern
global.set $g
i32.const 0
)

(func (export "init") (param externref)
local.get 0
global.set $g
)

;; A small function which when run triggers a gc in wasmtime
(func $gc
(local $i i32)
i32.const 10000
local.set $i
(loop $continue
(global.set $g (global.get $g))
(local.tee $i (i32.sub (local.get $i) (i32.const 1)))
br_if $continue
)
)
)

(invoke "init" (ref.extern 1))
(assert_return (invoke "run") (i32.const 0))