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
|
//! Test that a `tracked` fn on a `salsa::input`
//! compiles and executes successfully.
use std::cell::Cell;
use common::LogDatabase;
use expect_test::expect;
mod common;
use salsa::{Database, Setter};
use test_log::test;
thread_local! {
static COUNTER: Cell<usize> = const { Cell::new(0) };
}
#[salsa::input]
struct MyInput {
field1: u32,
field2: u32,
}
#[salsa::tracked]
struct MyTracked<'db> {
#[tracked]
counter: usize,
}
#[salsa::tracked]
fn function(db: &dyn Database, input: MyInput) -> (usize, usize) {
// Read input 1
let _field1 = input.field1(db);
// **BAD:** Leak in the value of the counter non-deterministically
let counter = COUNTER.with(|c| c.get());
// Create the tracked struct, which (from salsa's POV), only depends on field1;
// but which actually depends on the leaked value.
let tracked = MyTracked::new(db, counter);
// Read the tracked field
let result = counter_field(db, input, tracked);
// Read input 2. This will cause us to re-execute on revision 2.
let _field2 = input.field2(db);
(result, tracked.counter(db))
}
#[salsa::tracked]
fn counter_field<'db>(db: &'db dyn Database, input: MyInput, tracked: MyTracked<'db>) -> usize {
// Read input 2. This will cause us to re-execute on revision 2.
let _field2 = input.field2(db);
tracked.counter(db)
}
#[test]
fn test_leaked_inputs_ignored() {
let mut db = common::EventLoggerDatabase::default();
let input = MyInput::new(&db, 10, 20);
let result_in_rev_1 = function(&db, input);
db.assert_logs(expect![[r#"
[
"WillCheckCancellation",
"WillExecute { database_key: function(Id(0)) }",
"DidInternValue { key: counter_field::interned_arguments(Id(800)), revision: R1 }",
"WillCheckCancellation",
"WillExecute { database_key: counter_field(Id(800)) }",
]"#]]);
assert_eq!(result_in_rev_1, (0, 0));
// Modify field2 so that `function` is seen to have changed --
// but only *after* the tracked struct is created.
input.set_field2(&mut db).to(30);
// Also modify the thread-local counter
COUNTER.with(|c| c.set(100));
let result_in_rev_2 = function(&db, input);
db.assert_logs(expect![[r#"
[
"DidSetCancellationFlag",
"WillCheckCancellation",
"DidValidateInternedValue { key: counter_field::interned_arguments(Id(800)), revision: R2 }",
"WillCheckCancellation",
"WillExecute { database_key: counter_field(Id(800)) }",
"WillExecute { database_key: function(Id(0)) }",
"WillCheckCancellation",
]"#]]);
// Salsa will re-execute `counter_field` before re-executing
// `function` since, from what it can see, no inputs have changed
// before `counter_field` is called. This will read the field of
// the tracked struct which means it will be *fixed* at `0`.
// When we re-execute `counter_field` later, we ignore the new
// value of 100 since the struct has already been read during
// this revision.
//
// Contrast with preverify-struct-with-leaked-data.rs.
assert_eq!(result_in_rev_2, (0, 0));
}
|