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

feat: [EXC-1669] Propagate hook execution status to SystemState #667

Conversation

dragoljub-duric
Copy link
Contributor

@dragoljub-duric dragoljub-duric commented Jul 29, 2024

This PR is part of the OnLowWasmMemoryHook effort. Here we implement checking for hook condition and propagating hook status to SystemState.
Condition for executing hook, as agreed in interface spec discussion is:

  1. In the case with memory_allocation min(memory_allocation - used_stable_memory, wasm_memory_limit) - used_wasm_memory
  2. Without memory allocation wasm_memory_limit - used_wasm_memory

Hook status can be one of:

  1. Condition is not satisfied
  2. Ready for execution
  3. Executed

The hook condition is checked whenever additional execution (stable or Wasm) memory allocation is requested.

After this change, we will have all the required information of SystemState and it will be necessary only to schedule hook execution in the following round.

This PR will be followed with:

  1. EXC-1724 In which we will refactor SystemState::task_queue to be new struct with additional field on_low_wasm_memory_hook_status, to ensure that whenever available first task that will be poped form task queue is OnLowWasmMemoryHook (excluding paused executions). For that reason SystemState::on_low_wasm_memory_hook status is private, and we use set and get, so it can be easier encapsulated in the future TaskQueue struct.
  2. EXC-1725 Schedule and execute OnLowWasmMemoryHook

@github-actions github-actions bot added the feat label Jul 29, 2024
rs/replicated_state/src/canister_state/system_state.rs Outdated Show resolved Hide resolved
rs/replicated_state/src/canister_state/system_state.rs Outdated Show resolved Hide resolved
rs/replicated_state/src/canister_state/system_state.rs Outdated Show resolved Hide resolved
rs/replicated_state/src/canister_state/tests.rs Outdated Show resolved Hide resolved
rs/state_manager/src/tip.rs Outdated Show resolved Hide resolved
rs/system_api/src/lib.rs Show resolved Hide resolved
rs/system_api/src/lib.rs Outdated Show resolved Hide resolved
Copy link
Contributor

@alin-at-dfinity alin-at-dfinity left a comment

Choose a reason for hiding this comment

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

LGTM, thank you.

rs/system_api/src/lib.rs Show resolved Hide resolved
@dragoljub-duric dragoljub-duric added this pull request to the merge queue Sep 24, 2024
Merged via the queue into master with commit 9b24201 Sep 24, 2024
25 checks passed
@dragoljub-duric dragoljub-duric deleted the EXC-1669-implement-checking-for-hook-condition-and-execute-hook branch September 24, 2024 20:50
frankdavid pushed a commit that referenced this pull request Sep 25, 2024
This PR is part of the OnLowWasmMemoryHook effort. Here we implement
checking for hook condition and propagating hook status to SystemState.
Condition for executing hook, as agreed in interface spec
[discussion](dfinity/interface-spec#286 (comment))
is:

1. In the case with memory_allocation `min(memory_allocation -
used_stable_memory, wasm_memory_limit) - used_wasm_memory`
2. Without memory allocation `wasm_memory_limit - used_wasm_memory` 

Hook status can be one of:

1. Condition is not satisfied
3. Ready for execution
4. Executed

The hook condition is checked whenever additional execution (stable or
Wasm) memory allocation is requested.

After this change, we will have all the required information of
SystemState and it will be necessary only to schedule hook execution in
the following round.

This PR will be followed with:

1. [EXC-1724](https://dfinity.atlassian.net/browse/EXC-1724) In which we
will refactor `SystemState::task_queue` to be new struct with additional
field `on_low_wasm_memory_hook_status`, to ensure that whenever
available first task that will be poped form task queue is
`OnLowWasmMemoryHook` (excluding paused executions). For that reason
`SystemState::on_low_wasm_memory_hook status` is private, and we use
`set` and `get`, so it can be easier encapsulated in the future
`TaskQueue` struct.
2. [EXC-1725](https://dfinity.atlassian.net/browse/EXC-1725) Schedule
and execute `OnLowWasmMemoryHook`


[EXC-1724]:
https://dfinity.atlassian.net/browse/EXC-1724?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[EXC-1725]:
https://dfinity.atlassian.net/browse/EXC-1725?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

---------

Co-authored-by: Alin Sinpalean <[email protected]>
levifeldman pushed a commit to levifeldman/ic that referenced this pull request Oct 1, 2024
…ity#667)

This PR is part of the OnLowWasmMemoryHook effort. Here we implement
checking for hook condition and propagating hook status to SystemState.
Condition for executing hook, as agreed in interface spec
[discussion](dfinity/interface-spec#286 (comment))
is:

1. In the case with memory_allocation `min(memory_allocation -
used_stable_memory, wasm_memory_limit) - used_wasm_memory`
2. Without memory allocation `wasm_memory_limit - used_wasm_memory` 

Hook status can be one of:

1. Condition is not satisfied
3. Ready for execution
4. Executed

The hook condition is checked whenever additional execution (stable or
Wasm) memory allocation is requested.

After this change, we will have all the required information of
SystemState and it will be necessary only to schedule hook execution in
the following round.

This PR will be followed with:

1. [EXC-1724](https://dfinity.atlassian.net/browse/EXC-1724) In which we
will refactor `SystemState::task_queue` to be new struct with additional
field `on_low_wasm_memory_hook_status`, to ensure that whenever
available first task that will be poped form task queue is
`OnLowWasmMemoryHook` (excluding paused executions). For that reason
`SystemState::on_low_wasm_memory_hook status` is private, and we use
`set` and `get`, so it can be easier encapsulated in the future
`TaskQueue` struct.
2. [EXC-1725](https://dfinity.atlassian.net/browse/EXC-1725) Schedule
and execute `OnLowWasmMemoryHook`


[EXC-1724]:
https://dfinity.atlassian.net/browse/EXC-1724?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[EXC-1725]:
https://dfinity.atlassian.net/browse/EXC-1725?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

---------

Co-authored-by: Alin Sinpalean <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants