Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

seal_reentrant_count returns contract reentrant count #11539

Closed
wants to merge 32 commits into from
Closed
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
a8214fd
Add logic, test, broken benchmark
yarikbratashchuk May 18, 2022
143c158
Merge branch 'master' into seal_reentrant_count
yarikbratashchuk May 20, 2022
219eb84
Merge branch 'master' into seal_reentrant_count
yarikbratashchuk May 22, 2022
fccd751
account_entrance_count
yarikbratashchuk May 23, 2022
0a70239
Addressing comments
yarikbratashchuk May 29, 2022
6f3655a
Address @agryaznov's comments
yarikbratashchuk Jun 1, 2022
f29884b
Add test for account_entrance_count, fix ci
yarikbratashchuk Jun 2, 2022
72c8f83
Cargo fmt
yarikbratashchuk Jun 2, 2022
0f6f894
Fix tests
yarikbratashchuk Jun 2, 2022
949c438
Fix tests
yarikbratashchuk Jun 5, 2022
f34b6da
Remove delegated call from test, address comments
yarikbratashchuk Jun 16, 2022
a036585
Minor fixes and indentation in wat files
yarikbratashchuk Jun 21, 2022
3be772e
Update test for account_entrance_count
yarikbratashchuk Jun 21, 2022
5fdc100
Update reentrant_count_call test
yarikbratashchuk Jun 21, 2022
b656c88
Delegate call test
yarikbratashchuk Jun 23, 2022
17bb81f
Cargo +nightly fmt
yarikbratashchuk Jun 24, 2022
2f7f405
Address comments
yarikbratashchuk Jun 24, 2022
5f01797
Update reentrant_count_works test
yarikbratashchuk Jun 24, 2022
013e3bf
Merge branch 'master' into master
yarikbratashchuk Jun 24, 2022
3948142
Apply weights diff
yarikbratashchuk Jul 3, 2022
9c0c06f
Add fixture descriptions
yarikbratashchuk Jul 3, 2022
9c5bb47
Update comments as suggested
yarikbratashchuk Jul 3, 2022
35c0349
Update reentrant_count_call test to use seal_address
yarikbratashchuk Jul 3, 2022
3400632
Merge branch 'paritytech:master' into master
RustNinja Aug 2, 2022
ebde8e1
Merge branch 'paritytech:master' into master
Artemka374 Aug 10, 2022
321a828
change account_entrance_count_call fixture to use seal_caller
Artemka374 Sep 11, 2022
ee63f37
Merge remote-tracking branch 'paritytech/master'
Artemka374 Nov 2, 2022
3463795
fix compilation errors and apply some suggestions
Artemka374 Nov 4, 2022
1649d37
apply suggestions
Artemka374 Nov 5, 2022
8d94425
cargo fmt
Artemka374 Nov 7, 2022
0e48a2d
apply suggestions
Artemka374 Nov 10, 2022
7db2660
Merge remote-tracking branch 'paritytech/master'
Artemka374 Nov 10, 2022
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
37 changes: 37 additions & 0 deletions frame/contracts/fixtures/account_entrance_count_call.wat
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
(module
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
(import "seal0" "seal_input" (func $seal_input (param i32 i32)))
(import "__unstable__" "seal_account_entrance_count" (func $seal_account_entrance_count (param i32) (result i32)))
agryaznov marked this conversation as resolved.
Show resolved Hide resolved
(import "env" "memory" (memory 1 1))

;; [0, 32) buffer where input is copied

;; [32, 36) size of the input buffer
(data (i32.const 32) "\20")

(func $assert (param i32)
(block $ok
(br_if $ok
(get_local 0)
)
(unreachable)
)
)
(func (export "call")
(local $account_entrance_count i32)

;; Reading "callee" contract address (which is the address of the caller)
(call $seal_input (i32.const 0) (i32.const 32))

(set_local $account_entrance_count
(call $seal_account_entrance_count (i32.const 0))
)

;; assert account_entrance_count == 1
(call $assert
(i32.eq (get_local $account_entrance_count) (i32.const 1))
)
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
)

(func (export "deploy"))

)
65 changes: 65 additions & 0 deletions frame/contracts/fixtures/reentrant_count_call.wat
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
(module
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
(import "seal0" "seal_input" (func $seal_input (param i32 i32)))
(import "seal0" "seal_call" (func $seal_call (param i32 i32 i64 i32 i32 i32 i32 i32 i32) (result i32)))
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
(import "__unstable__" "seal_reentrant_count" (func $seal_reentrant_count (result i32)))
agryaznov marked this conversation as resolved.
Show resolved Hide resolved
(import "env" "memory" (memory 1 1))

;; [0, 32) buffer where input is copied

;; [32, 36) size of the input buffer
(data (i32.const 32) "\20")

(func $assert (param i32)
(block $ok
(br_if $ok
(get_local 0)
)
(unreachable)
)
)
(func (export "call")
(local $exit_code i32)
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
(local $reentrant_count i32)

(set_local $reentrant_count
(call $seal_reentrant_count)
)

yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
(get_local $reentrant_count)
(if
(then
;; assert reentrant_count == 1
(call $assert
(i32.eq (get_local $reentrant_count) (i32.const 1))
)
athei marked this conversation as resolved.
Show resolved Hide resolved
)
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
(else
;; Reading "callee" contract address (which is the address of the caller)
(call $seal_input (i32.const 0) (i32.const 32))

;; Call to itself
(set_local $exit_code
(call $seal_call
(i32.const 0) ;; Pointer to "callee" address.
(i32.const 32) ;; Length of "callee" address.
(i64.const 0) ;; How much gas to devote for the execution. 0 = all.
(i32.const 0) ;; Pointer to the buffer with value to transfer
(i32.const 0) ;; Length of the buffer with value to transfer.
(i32.const 0) ;; Pointer to input data buffer address
(i32.const 32) ;; Length of input data buffer
(i32.const 0xffffffff) ;; u32 max sentinel value: do not copy output
(i32.const 0) ;; Ptr to output buffer len
)
)

;; assert reentrant_count == 0
(call $assert
(i32.eq (get_local $reentrant_count) (i32.const 0))
)
)
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
)
)

(func (export "deploy"))

)
53 changes: 53 additions & 0 deletions frame/contracts/src/benchmarking/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2055,6 +2055,59 @@ benchmarks! {
let origin = RawOrigin::Signed(instance.caller.clone());
}: call(origin, instance.addr, 0u32.into(), Weight::MAX, None, vec![])

seal_reentrant_count {
agryaznov marked this conversation as resolved.
Show resolved Hide resolved
let r in 0 .. API_BENCHMARK_BATCHES;
let code = WasmModule::<T>::from(ModuleDefinition {
memory: Some(ImportedMemory::max::<T>()),
imported_functions: vec![ImportedFunction {
module: "__unstable__",
name: "seal_reentrant_count",
agryaznov marked this conversation as resolved.
Show resolved Hide resolved
params: vec![],
return_type: Some(ValueType::I32),
}],
call_body: Some(body::repeated(r * API_BENCHMARK_BATCH_SIZE, &[
Instruction::Call(0),
Instruction::Drop,
])),
.. Default::default()
});
let instance = Contract::<T>::new(code, vec![])?;
let origin = RawOrigin::Signed(instance.caller.clone());
}: call(origin, instance.addr, 0u32.into(), Weight::MAX, None, vec![])

seal_account_entrance_count {
agryaznov marked this conversation as resolved.
Show resolved Hide resolved
let r in 0 .. API_BENCHMARK_BATCHES;
let dummy_code = WasmModule::<T>::dummy_with_bytes(0);
let accounts = (0..r * API_BENCHMARK_BATCH_SIZE)
.map(|i| Contract::with_index(i + 1, dummy_code.clone(), vec![]))
.collect::<Result<Vec<_>, _>>()?;
let account_id_len = accounts.get(0).map(|i| i.account_id.encode().len()).unwrap_or(0);
let account_id_bytes = accounts.iter().flat_map(|x| x.account_id.encode()).collect();
let code = WasmModule::<T>::from(ModuleDefinition {
memory: Some(ImportedMemory::max::<T>()),
imported_functions: vec![ImportedFunction {
module: "__unstable__",
name: "seal_account_entrance_count",
agryaznov marked this conversation as resolved.
Show resolved Hide resolved
params: vec![ValueType::I32],
return_type: Some(ValueType::I32),
}],
data_segments: vec![
DataSegment {
offset: 0,
value: account_id_bytes,
},
],
call_body: Some(body::repeated_dyn(r * API_BENCHMARK_BATCH_SIZE, vec![
Counter(0 as u32, account_id_len as u32), // account_ptr
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
Regular(Instruction::Call(0)),
Regular(Instruction::Drop),
])),
.. Default::default()
});
let instance = Contract::<T>::new(code, vec![])?;
let origin = RawOrigin::Signed(instance.caller.clone());
}: call(origin, instance.addr, 0u32.into(), Weight::MAX, None, vec![])

// We make the assumption that pushing a constant and dropping a value takes roughly
// the same amount of time. We follow that `t.load` and `drop` both have the weight
// of this benchmark / 2. We need to make this assumption because there is no way
Expand Down
22 changes: 22 additions & 0 deletions frame/contracts/src/exec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,15 @@ pub trait Ext: sealing::Sealed {

/// Sets new code hash for existing contract.
fn set_code_hash(&mut self, hash: CodeHash<Self::T>) -> Result<(), DispatchError>;

/// Returns then number of times currently executing contract exists on the call stack in
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
/// addition to the calling instance. A value of 0 means no reentrancy.
fn reentrant_count(&self) -> u32;

/// Returns the number of times specified contract exists on the call stack. Delegated calls are
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
/// not calculated as separate entrance.
/// A value of 0 means it does not exist on the call stack.
fn account_entrance_count(&self, account_id: &AccountIdOf<Self::T>) -> u32;
}

/// Describes the different functions that can be exported by an [`Executable`].
Expand Down Expand Up @@ -1227,6 +1236,19 @@ where
});
Ok(())
}

fn reentrant_count(&self) -> u32 {
let id: &AccountIdOf<Self::T> = &self.top_frame().account_id;
self.account_entrance_count(id).checked_sub(1).unwrap_or(0)
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
}

fn account_entrance_count(&self, account_id: &AccountIdOf<Self::T>) -> u32 {
self.frames()
.filter_map(|f| {
(f.delegate_caller.is_none() && &f.account_id == account_id).then(|| true)
})
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
.count() as u32
}
}

fn deposit_event<T: Config>(topics: Vec<T::Hash>, event: Event<T>) {
Expand Down
8 changes: 8 additions & 0 deletions frame/contracts/src/schedule.rs
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,12 @@ pub struct HostFnWeights<T: Config> {
/// Weight of calling `seal_ecdsa_to_eth_address`.
pub ecdsa_to_eth_address: Weight,

/// Weight of calling `seal_reentrant_count`.
pub reentrant_count: Weight,

/// Weight of calling `seal_account_entrance_count`.
pub account_entrance_count: Weight,

/// The type parameter is used in the default implementation.
#[codec(skip)]
pub _phantom: PhantomData<T>,
Expand Down Expand Up @@ -651,6 +657,8 @@ impl<T: Config> Default for HostFnWeights<T> {
hash_blake2_128_per_byte: cost_byte_batched!(seal_hash_blake2_128_per_kb),
ecdsa_recover: cost_batched!(seal_ecdsa_recover),
ecdsa_to_eth_address: cost_batched!(seal_ecdsa_to_eth_address),
reentrant_count: cost_batched!(seal_reentrant_count),
account_entrance_count: cost_batched!(seal_account_entrance_count),
_phantom: PhantomData,
}
}
Expand Down
65 changes: 65 additions & 0 deletions frame/contracts/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3228,3 +3228,68 @@ fn set_code_hash() {
);
});
}

#[test]
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
#[cfg(feature = "unstable-interface")]
fn reentrant_count_works_with_call() {
let (wasm1, code_hash1) = compile_module::<Test>("reentrant_count_call").unwrap();
let contract_addr1 = Contracts::contract_address(&ALICE, &code_hash1, &[]);
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved

ExtBuilder::default().existential_deposit(100).build().execute_with(|| {
let _ = Balances::deposit_creating(&ALICE, 1_000_000);

assert_ok!(Contracts::instantiate_with_code(
Origin::signed(ALICE),
300_000,
GAS_LIMIT,
None,
wasm1,
vec![],
vec![],
));

Contracts::bare_call(
ALICE,
contract_addr1.clone(),
0,
GAS_LIMIT,
None,
AsRef::<[u8]>::as_ref(&contract_addr1).to_vec(),
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
true,
)
.result
.unwrap();
});
}
#[test]
#[cfg(feature = "unstable-interface")]
fn account_entrance_count_works() {
let (wasm1, code_hash1) = compile_module::<Test>("account_entrance_count_call").unwrap();
let contract_addr1 = Contracts::contract_address(&ALICE, &code_hash1, &[]);

ExtBuilder::default().existential_deposit(100).build().execute_with(|| {
let _ = Balances::deposit_creating(&ALICE, 1_000_000);

assert_ok!(Contracts::instantiate_with_code(
Origin::signed(ALICE),
300_000,
GAS_LIMIT,
None,
wasm1,
vec![],
vec![],
));

Contracts::bare_call(
agryaznov marked this conversation as resolved.
Show resolved Hide resolved
ALICE,
contract_addr1.clone(),
0,
GAS_LIMIT,
None,
AsRef::<[u8]>::as_ref(&contract_addr1).to_vec(),
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
true,
)
.result
.unwrap();
});
}
72 changes: 72 additions & 0 deletions frame/contracts/src/wasm/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -523,6 +523,12 @@ mod tests {
fn ecdsa_to_eth_address(&self, _pk: &[u8; 33]) -> Result<[u8; 20], ()> {
Ok([2u8; 20])
}
fn reentrant_count(&self) -> u32 {
12
}
fn account_entrance_count(&self, _account_id: &AccountIdOf<Self::T>) -> u32 {
12
}
}

fn execute<E: BorrowMut<MockExt>>(wat: &str, input_data: Vec<u8>, mut ext: E) -> ExecResult {
Expand Down Expand Up @@ -2594,4 +2600,70 @@ mod tests {

assert_eq!(mock_ext.code_hashes.pop().unwrap(), H256::from_slice(&[17u8; 32]));
}

#[test]
#[cfg(feature = "unstable-interface")]
fn reentrant_count_works() {
yarikbratashchuk marked this conversation as resolved.
Show resolved Hide resolved
const CODE: &str = r#"
(module
(import "__unstable__" "seal_reentrant_count" (func $seal_reentrant_count (result i32)))
(import "env" "memory" (memory 1 1))
(func $assert (param i32)
(block $ok
(br_if $ok
(get_local 0)
)
(unreachable)
)
)
(func (export "call")
(local $return_val i32)
(set_local $return_val
(call $seal_reentrant_count)
)
(call $assert
(i32.eq (get_local $return_val) (i32.const 12))
)
)

(func (export "deploy"))
)
"#;

let mut mock_ext = MockExt::default();
execute(CODE, vec![], &mut mock_ext).unwrap();
}

#[test]
#[cfg(feature = "unstable-interface")]
fn account_entrance_count_works() {
const CODE: &str = r#"
(module
(import "__unstable__" "seal_account_entrance_count" (func $seal_account_entrance_count (param i32) (result i32)))
(import "env" "memory" (memory 1 1))
(func $assert (param i32)
(block $ok
(br_if $ok
(get_local 0)
)
(unreachable)
)
)
(func (export "call")
(local $return_val i32)
(set_local $return_val
(call $seal_account_entrance_count (i32.const 0))
)
(call $assert
(i32.eq (get_local $return_val) (i32.const 12))
)
)

(func (export "deploy"))
)
"#;

let mut mock_ext = MockExt::default();
execute(CODE, vec![], &mut mock_ext).unwrap();
}
}
Loading