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.

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

feat: Add wasm_memory_threshold #626

Merged
merged 3 commits into from
Dec 30, 2024
Merged

feat: Add wasm_memory_threshold #626

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
09deeaf
Add `wasm_memory_threshold`
adamspofford-dfinity Dec 30, 2024
14ffa05
the rest
adamspofford-dfinity Dec 30, 2024
5936fd6
missed those
adamspofford-dfinity Dec 30, 2024
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

* Added `wasm_memory_threshold` field to `CanisterSettings`.

## [0.39.2] - 2024-12-20

* Bumped `ic-certification` to `3.0.0`.
Expand Down
2 changes: 2 additions & 0 deletions ic-utils/src/interfaces/management_canister.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,8 @@ pub struct DefiniteCanisterSettings {
pub reserved_cycles_limit: Option<Nat>,
/// A soft limit on the Wasm memory usage of the canister in bytes (up to 256TiB).
pub wasm_memory_limit: Option<Nat>,
/// A threshold limit on the Wasm memory usage of the canister in bytes, at which the canister's `on_low_wasm_memory` hook will be called (up to 256TiB)
pub wasm_memory_threshold: Option<Nat>,
/// The canister log visibility. Defines which principals are allowed to fetch logs.
pub log_visibility: LogVisibility,
}
Expand Down
105 changes: 91 additions & 14 deletions ic-utils/src/interfaces/management_canister/builders.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,14 @@ pub struct CanisterSettings {
/// Must be a number between 0 and 2^48^ (i.e 256TB), inclusively.
pub wasm_memory_limit: Option<Nat>,

/// A threshold on the remaining Wasm memory of the canister.
///
/// When the remaining memory drops below this threshold, its
/// `on_low_wasm_memory` hook will be invoked. This enables it
/// to self-optimize or raise an alert or otherwise attempt to
/// prevent itself from reaching `wasm_memory_limit`.
pub wasm_memory_threshold: Option<Nat>,

/// The canister log visibility of the canister.
///
/// If unspecified and a canister is being created with these settings, defaults to `Controllers`, i.e. private by default.
Expand All @@ -93,6 +101,7 @@ pub struct CreateCanisterBuilder<'agent, 'canister: 'agent> {
freezing_threshold: Option<Result<FreezingThreshold, AgentError>>,
reserved_cycles_limit: Option<Result<ReservedCyclesLimit, AgentError>>,
wasm_memory_limit: Option<Result<WasmMemoryLimit, AgentError>>,
wasm_memory_threshold: Option<Result<WasmMemoryLimit, AgentError>>,
log_visibility: Option<Result<LogVisibility, AgentError>>,
is_provisional_create: bool,
amount: Option<u128>,
Expand All @@ -111,6 +120,7 @@ impl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister> {
freezing_threshold: None,
reserved_cycles_limit: None,
wasm_memory_limit: None,
wasm_memory_threshold: None,
log_visibility: None,
is_provisional_create: false,
amount: None,
Expand Down Expand Up @@ -161,7 +171,7 @@ impl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister> {
}
}

/// Pass in an optional controller for the canister. If this is [None],
/// Pass in an optional controller for the canister. If this is [`None`],
/// it will revert the controller to default.
pub fn with_optional_controller<C, E>(self, controller: Option<C>) -> Self
where
Expand Down Expand Up @@ -199,7 +209,7 @@ impl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister> {
self.with_optional_controller(Some(controller))
}

/// Pass in a compute allocation optional value for the canister. If this is [None],
/// Pass in a compute allocation optional value for the canister. If this is [`None`],
/// it will revert the compute allocation to default.
pub fn with_optional_compute_allocation<C, E>(self, compute_allocation: Option<C>) -> Self
where
Expand All @@ -224,7 +234,7 @@ impl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister> {
self.with_optional_compute_allocation(Some(compute_allocation))
}

/// Pass in a memory allocation optional value for the canister. If this is [None],
/// Pass in a memory allocation optional value for the canister. If this is [`None`],
/// it will revert the memory allocation to default.
pub fn with_optional_memory_allocation<E, C>(self, memory_allocation: Option<C>) -> Self
where
Expand All @@ -249,7 +259,7 @@ impl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister> {
self.with_optional_memory_allocation(Some(memory_allocation))
}

/// Pass in a freezing threshold optional value for the canister. If this is [None],
/// Pass in a freezing threshold optional value for the canister. If this is [`None`],
/// it will revert the freezing threshold to default.
pub fn with_optional_freezing_threshold<E, C>(self, freezing_threshold: Option<C>) -> Self
where
Expand Down Expand Up @@ -283,7 +293,7 @@ impl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister> {
self.with_optional_reserved_cycles_limit(Some(limit))
}

/// Pass in a reserved cycles limit optional value for the canister. If this is [None],
/// Pass in a reserved cycles limit optional value for the canister. If this is [`None`],
/// it will create the canister with the default limit.
pub fn with_optional_reserved_cycles_limit<E, C>(self, limit: Option<C>) -> Self
where
Expand All @@ -309,7 +319,7 @@ impl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister> {
self.with_optional_wasm_memory_limit(Some(wasm_memory_limit))
}

/// Pass in a Wasm memory limit optional value for the canister. If this is [None],
/// Pass in a Wasm memory limit optional value for the canister. If this is [`None`],
/// it will revert the Wasm memory limit to default.
pub fn with_optional_wasm_memory_limit<E, C>(self, wasm_memory_limit: Option<C>) -> Self
where
Expand All @@ -326,6 +336,32 @@ impl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister> {
}
}

/// Pass in a Wasm memory threshold value for the canister.
pub fn with_wasm_memory_threshold<C, E>(self, wasm_memory_threshold: C) -> Self
where
E: std::fmt::Display,
C: TryInto<WasmMemoryLimit, Error = E>,
{
self.with_optional_wasm_memory_threshold(Some(wasm_memory_threshold))
}

/// Pass in a Wasm memory threshold optional value for the canister. If this is [`None`],
/// it will revert the Wasm memory threshold to default.
pub fn with_optional_wasm_memory_threshold<E, C>(self, wasm_memory_threshold: Option<C>) -> Self
where
E: std::fmt::Display,
C: TryInto<WasmMemoryLimit, Error = E>,
{
Self {
wasm_memory_threshold: wasm_memory_threshold.map(|limit| {
limit
.try_into()
.map_err(|e| AgentError::MessageError(format!("{e}")))
}),
..self
}
}

/// Pass in a log visibility setting for the canister.
pub fn with_log_visibility<C, E>(self, log_visibility: C) -> Self
where
Expand All @@ -335,7 +371,7 @@ impl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister> {
self.with_optional_log_visibility(Some(log_visibility))
}

/// Pass in a log visibility optional setting for the canister. If this is [None],
/// Pass in a log visibility optional setting for the canister. If this is [`None`],
/// it will revert the log visibility to default.
pub fn with_optional_log_visibility<E, C>(self, log_visibility: Option<C>) -> Self
where
Expand Down Expand Up @@ -385,6 +421,11 @@ impl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister> {
Some(Ok(x)) => Some(Nat::from(u64::from(x))),
None => None,
};
let wasm_memory_threshold = match self.wasm_memory_threshold {
Some(Err(x)) => return Err(AgentError::MessageError(format!("{x}"))),
Some(Ok(x)) => Some(Nat::from(u64::from(x))),
None => None,
};
let log_visibility = match self.log_visibility {
Some(Err(x)) => return Err(AgentError::MessageError(format!("{x}"))),
Some(Ok(x)) => Some(x),
Expand Down Expand Up @@ -412,6 +453,7 @@ impl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister> {
freezing_threshold,
reserved_cycles_limit,
wasm_memory_limit,
wasm_memory_threshold,
log_visibility,
},
specified_id: self.specified_id,
Expand All @@ -430,6 +472,7 @@ impl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister> {
freezing_threshold,
reserved_cycles_limit,
wasm_memory_limit,
wasm_memory_threshold,
log_visibility,
})
.with_effective_canister_id(self.effective_canister_id)
Expand Down Expand Up @@ -956,6 +999,7 @@ pub struct UpdateCanisterBuilder<'agent, 'canister: 'agent> {
freezing_threshold: Option<Result<FreezingThreshold, AgentError>>,
reserved_cycles_limit: Option<Result<ReservedCyclesLimit, AgentError>>,
wasm_memory_limit: Option<Result<WasmMemoryLimit, AgentError>>,
wasm_memory_threshold: Option<Result<WasmMemoryLimit, AgentError>>,
log_visibility: Option<Result<LogVisibility, AgentError>>,
}

Expand All @@ -971,11 +1015,12 @@ impl<'agent, 'canister: 'agent> UpdateCanisterBuilder<'agent, 'canister> {
freezing_threshold: None,
reserved_cycles_limit: None,
wasm_memory_limit: None,
wasm_memory_threshold: None,
log_visibility: None,
}
}

/// Pass in an optional controller for the canister. If this is [None],
/// Pass in an optional controller for the canister. If this is [`None`],
/// it will revert the controller to default.
pub fn with_optional_controller<C, E>(self, controller: Option<C>) -> Self
where
Expand Down Expand Up @@ -1014,7 +1059,7 @@ impl<'agent, 'canister: 'agent> UpdateCanisterBuilder<'agent, 'canister> {
self.with_optional_controller(Some(controller))
}

/// Pass in a compute allocation optional value for the canister. If this is [None],
/// Pass in a compute allocation optional value for the canister. If this is [`None`],
/// it will revert the compute allocation to default.
pub fn with_optional_compute_allocation<C, E>(self, compute_allocation: Option<C>) -> Self
where
Expand All @@ -1039,7 +1084,7 @@ impl<'agent, 'canister: 'agent> UpdateCanisterBuilder<'agent, 'canister> {
self.with_optional_compute_allocation(Some(compute_allocation))
}

/// Pass in a memory allocation optional value for the canister. If this is [None],
/// Pass in a memory allocation optional value for the canister. If this is [`None`],
/// it will revert the memory allocation to default.
pub fn with_optional_memory_allocation<E, C>(self, memory_allocation: Option<C>) -> Self
where
Expand All @@ -1064,7 +1109,7 @@ impl<'agent, 'canister: 'agent> UpdateCanisterBuilder<'agent, 'canister> {
self.with_optional_memory_allocation(Some(memory_allocation))
}

/// Pass in a freezing threshold optional value for the canister. If this is [None],
/// Pass in a freezing threshold optional value for the canister. If this is [`None`],
/// it will revert the freezing threshold to default.
pub fn with_optional_freezing_threshold<E, C>(self, freezing_threshold: Option<C>) -> Self
where
Expand Down Expand Up @@ -1099,7 +1144,7 @@ impl<'agent, 'canister: 'agent> UpdateCanisterBuilder<'agent, 'canister> {
}

/// Pass in a reserved cycles limit optional value for the canister.
/// If this is [None], leaves the reserved cycles limit unchanged.
/// If this is [`None`], leaves the reserved cycles limit unchanged.
pub fn with_optional_reserved_cycles_limit<E, C>(self, limit: Option<C>) -> Self
where
E: std::fmt::Display,
Expand All @@ -1123,7 +1168,7 @@ impl<'agent, 'canister: 'agent> UpdateCanisterBuilder<'agent, 'canister> {
self.with_optional_wasm_memory_limit(Some(wasm_memory_limit))
}

/// Pass in a Wasm memory limit optional value for the canister. If this is [None],
/// Pass in a Wasm memory limit optional value for the canister. If this is [`None`],
/// leaves the Wasm memory limit unchanged.
pub fn with_optional_wasm_memory_limit<E, C>(self, wasm_memory_limit: Option<C>) -> Self
where
Expand All @@ -1140,6 +1185,32 @@ impl<'agent, 'canister: 'agent> UpdateCanisterBuilder<'agent, 'canister> {
}
}

/// Pass in a Wasm memory limit threshold value for the canister.
pub fn with_wasm_memory_threshold<C, E>(self, wasm_memory_threshold: C) -> Self
where
E: std::fmt::Display,
C: TryInto<WasmMemoryLimit, Error = E>,
{
self.with_optional_wasm_memory_threshold(Some(wasm_memory_threshold))
}

/// Pass in a Wasm memory limit threshold value for the canister. If this is [`None`],
/// leaves the memory threshold unchanged.
pub fn with_optional_wasm_memory_threshold<E, C>(self, wasm_memory_threshold: Option<C>) -> Self
where
E: std::fmt::Display,
C: TryInto<WasmMemoryLimit, Error = E>,
{
Self {
wasm_memory_threshold: wasm_memory_threshold.map(|limit| {
limit
.try_into()
.map_err(|e| AgentError::MessageError(format!("{e}")))
}),
..self
}
}

/// Pass in a log visibility setting for the canister.
pub fn with_log_visibility<C, E>(self, log_visibility: C) -> Self
where
Expand All @@ -1149,7 +1220,7 @@ impl<'agent, 'canister: 'agent> UpdateCanisterBuilder<'agent, 'canister> {
self.with_optional_log_visibility(Some(log_visibility))
}

/// Pass in a log visibility optional setting for the canister. If this is [None],
/// Pass in a log visibility optional setting for the canister. If this is [`None`],
/// leaves the log visibility unchanged.
pub fn with_optional_log_visibility<E, C>(self, log_visibility: Option<C>) -> Self
where
Expand Down Expand Up @@ -1205,6 +1276,11 @@ impl<'agent, 'canister: 'agent> UpdateCanisterBuilder<'agent, 'canister> {
Some(Ok(x)) => Some(Nat::from(u64::from(x))),
None => None,
};
let wasm_memory_threshold = match self.wasm_memory_threshold {
Some(Err(x)) => return Err(AgentError::MessageError(format!("{x}"))),
Some(Ok(x)) => Some(Nat::from(u64::from(x))),
None => None,
};
let log_visibility = match self.log_visibility {
Some(Err(x)) => return Err(AgentError::MessageError(format!("{x}"))),
Some(Ok(x)) => Some(x),
Expand All @@ -1223,6 +1299,7 @@ impl<'agent, 'canister: 'agent> UpdateCanisterBuilder<'agent, 'canister> {
freezing_threshold,
reserved_cycles_limit,
wasm_memory_limit,
wasm_memory_threshold,
log_visibility,
},
})
Expand Down
4 changes: 4 additions & 0 deletions ic-utils/src/interfaces/wallet.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,7 @@ impl<'agent> WalletCanister<'agent> {
freezing_threshold: freezing_threshold.map(u64::from).map(Nat::from),
reserved_cycles_limit: None,
wasm_memory_limit: None,
wasm_memory_threshold: None,
log_visibility: None,
};

Expand Down Expand Up @@ -704,6 +705,7 @@ impl<'agent> WalletCanister<'agent> {
freezing_threshold: freezing_threshold.map(u64::from).map(Nat::from),
reserved_cycles_limit: None,
wasm_memory_limit: None,
wasm_memory_threshold: None,
log_visibility: None,
};

Expand Down Expand Up @@ -833,6 +835,7 @@ impl<'agent> WalletCanister<'agent> {
freezing_threshold: freezing_threshold.map(u64::from).map(Nat::from),
reserved_cycles_limit: None,
wasm_memory_limit: None,
wasm_memory_threshold: None,
log_visibility: None,
};

Expand Down Expand Up @@ -864,6 +867,7 @@ impl<'agent> WalletCanister<'agent> {
freezing_threshold: freezing_threshold.map(u64::from).map(Nat::from),
reserved_cycles_limit: None,
wasm_memory_limit: None,
wasm_memory_threshold: None,
log_visibility: None,
};

Expand Down
1 change: 1 addition & 0 deletions ref-tests/tests/ic-ref.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,6 +734,7 @@ mod management_canister {
freezing_threshold: None,
reserved_cycles_limit: None,
wasm_memory_limit: None,
wasm_memory_threshold: None,
log_visibility: None,
},
};
Expand Down
1 change: 1 addition & 0 deletions ref-tests/tests/integration.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,7 @@ fn wallet_create_wallet() {
freezing_threshold: None,
reserved_cycles_limit: None,
wasm_memory_limit: None,
wasm_memory_threshold: None,
log_visibility: None,
},
};
Expand Down
Loading