refactor: Rename SystemStateChanges to SystemStateModifications for consistency (dfinity#3555)

All the other structs that maintain modifications of different parts of
the canister state use `*Modifications` in their name, so change
`SystemStateChanges` to use it as well for consistency.

Author: dsarlis

rs/canister_sandbox/src/protocol/ctlsvc.rs

@@ -67,7 +67,7 @@ mod tests {
         InstanceStats, SystemApiCallCounters, WasmExecutionOutput,
     };
     use ic_replicated_state::{Global, NumWasmPages, PageMap};
-    use ic_system_api::sandbox_safe_system_state::SystemStateChanges;
+    use ic_system_api::sandbox_safe_system_state::SystemStateModifications;
     use ic_types::{ingress::WasmResult, CanisterLog, NumBytes, NumInstructions};
 
     use crate::protocol::{
@@ -125,7 +125,7 @@ mod tests {
                         size: NumWasmPages::new(42),
                     },
                 }),
-                system_state_changes: SystemStateChanges::default(),
+                system_state_modifications: SystemStateModifications::default(),
             },
             execute_total_duration: Duration::from_secs(10),
             execute_run_duration: Duration::from_secs(1),

rs/canister_sandbox/src/protocol/structs.rs

@@ -4,7 +4,7 @@ use ic_replicated_state::{
     page_map::PageDeltaSerialization, Global, Memory, NumWasmPages, PageIndex,
 };
 use ic_system_api::{
-    sandbox_safe_system_state::{SandboxSafeSystemState, SystemStateChanges},
+    sandbox_safe_system_state::{SandboxSafeSystemState, SystemStateModifications},
     ApiType, ExecutionParameters,
 };
 use ic_types::{methods::FuncRef, NumBytes};
@@ -67,7 +67,7 @@ pub struct StateModifications {
     /// The system state changes contain parts that are always applied
     /// and parts that are only applied depending on the method executed
     /// (similarly to `execution_state_modifications`).
-    pub system_state_changes: SystemStateChanges,
+    pub system_state_modifications: SystemStateModifications,
 }
 
 #[derive(Serialize, Debug, Deserialize, Clone, PartialEq)]

rs/canister_sandbox/src/replica_controller/sandboxed_execution_controller.rs

@@ -1587,13 +1587,13 @@ impl SandboxedExecutionController {
 
         let StateModifications {
             execution_state_modifications,
-            system_state_changes,
+            system_state_modifications,
         } = exec_output.take_state_modifications();
 
         match execution_state_modifications {
             None => CanisterStateChanges {
                 execution_state_changes: None,
-                system_state_changes,
+                system_state_modifications,
             },
             Some(execution_state_modifications) => {
                 // TODO: If a canister has broken out of wasm then it might have allocated more
@@ -1647,7 +1647,7 @@ impl SandboxedExecutionController {
                         wasm_memory,
                         stable_memory,
                     }),
-                    system_state_changes,
+                    system_state_modifications,
                 }
             }
         }

rs/canister_sandbox/src/sandbox_manager.rs

@@ -160,7 +160,7 @@ impl Execution {
         match wasm_result {
             Ok(_) => {
                 let state_modifications = {
-                    let system_state_changes = match instance_or_system_api {
+                    let system_state_modifications = match instance_or_system_api {
                         // Here we use `store_data_mut` instead of
                         // `into_store_data` because the later will drop the
                         // wasmtime Instance which can be an expensive
@@ -172,8 +172,8 @@ impl Execution {
                             .store_data_mut()
                             .system_api_mut()
                             .expect("System api not present in the wasmtime instance")
-                            .take_system_state_changes(),
-                        Err(system_api) => system_api.into_system_state_changes(),
+                            .take_system_state_modifications(),
+                        Err(system_api) => system_api.into_system_state_modifications(),
                     };
 
                     let execution_state_modifications = deltas.map(
@@ -193,7 +193,7 @@ impl Execution {
 
                     StateModifications {
                         execution_state_modifications,
-                        system_state_changes,
+                        system_state_modifications,
                     }
                 };
                 if state_modifications.execution_state_modifications.is_some() {

rs/embedders/src/wasm_executor.rs

@@ -5,7 +5,7 @@ use std::sync::Arc;
 use ic_replicated_state::canister_state::execution_state::WasmBinary;
 use ic_replicated_state::page_map::PageAllocatorFileDescriptor;
 use ic_replicated_state::{ExportedFunctions, Global, Memory, NumWasmPages, PageMap};
-use ic_system_api::sandbox_safe_system_state::{SandboxSafeSystemState, SystemStateChanges};
+use ic_system_api::sandbox_safe_system_state::{SandboxSafeSystemState, SystemStateModifications};
 use ic_system_api::{ApiType, DefaultOutOfInstructionsHandler};
 use ic_types::methods::{FuncRef, WasmMethod};
 use ic_types::NumOsPages;
@@ -146,7 +146,7 @@ pub struct ExecutionStateChanges {
 pub struct CanisterStateChanges {
     pub execution_state_changes: Option<ExecutionStateChanges>,
 
-    pub system_state_changes: SystemStateChanges,
+    pub system_state_modifications: SystemStateModifications,
 }
 
 /// The result of WebAssembly execution with deterministic time slicing.
@@ -260,7 +260,7 @@ impl WasmExecutor for WasmExecutorImpl {
             Ok(instance) => instance.into_store_data().system_api.unwrap(),
             Err(system_api) => system_api,
         };
-        let system_state_changes = system_api.into_system_state_changes();
+        let system_state_modifications = system_api.into_system_state_modifications();
 
         (
             compilation_result,
@@ -269,7 +269,7 @@ impl WasmExecutor for WasmExecutorImpl {
                 wasm_execution_output,
                 CanisterStateChanges {
                     execution_state_changes,
-                    system_state_changes,
+                    system_state_modifications,
                 },
             ),
         )
@@ -497,7 +497,7 @@ pub fn wasm_execution_error(
         },
         CanisterStateChanges {
             execution_state_changes: None,
-            system_state_changes: SystemStateChanges::default(),
+            system_state_modifications: SystemStateModifications::default(),
         },
     )
 }

rs/embedders/tests/wasmtime_embedder.rs

@@ -3118,14 +3118,14 @@ fn wasm64_saturate_fun_index() {
         .build();
     let _res = instance.run(FuncRef::Method(WasmMethod::Update("test".to_string())));
 
-    let system_state_changes = instance
+    let system_state_modifications = instance
         .store_data_mut()
         .system_api_mut()
         .unwrap()
-        .take_system_state_changes();
+        .take_system_state_modifications();
 
     // call_perform should trigger one callback update
-    let callback_update = system_state_changes
+    let callback_update = system_state_modifications
         .callback_updates
         .first()
         .unwrap()

rs/execution_environment/src/execution/common.rs

@@ -18,7 +18,7 @@ use ic_replicated_state::{
     CallContext, CallContextAction, CallOrigin, CanisterState, ExecutionState, NetworkTopology,
     SystemState,
 };
-use ic_system_api::sandbox_safe_system_state::{RequestMetadataStats, SystemStateChanges};
+use ic_system_api::sandbox_safe_system_state::{RequestMetadataStats, SystemStateModifications};
 use ic_types::ingress::{IngressState, IngressStatus, WasmResult};
 use ic_types::messages::{
     CallContextId, CallbackId, CanisterCall, CanisterCallOrTask, MessageId, Payload, RejectContext,
@@ -410,7 +410,7 @@ pub fn update_round_limits(round_limits: &mut RoundLimits, slice: &SliceExecutio
 /// subnet available memory. In case of an error, the partially applied changes
 /// are not undone.
 fn try_apply_canister_state_changes(
-    system_state_changes: SystemStateChanges,
+    system_state_modifications: SystemStateModifications,
     output: &WasmExecutionOutput,
     system_state: &mut SystemState,
     subnet_available_memory: &mut SubnetAvailableMemory,
@@ -427,7 +427,7 @@ fn try_apply_canister_state_changes(
         )
         .map_err(|_| HypervisorError::OutOfMemory)?;
 
-    system_state_changes.apply_changes(time, system_state, network_topology, subnet_id, log)
+    system_state_modifications.apply_changes(time, system_state, network_topology, subnet_id, log)
 }
 
 /// Applies canister state change after Wasm execution if possible.
@@ -457,17 +457,17 @@ pub fn apply_canister_state_changes(
 ) {
     let CanisterStateChanges {
         execution_state_changes,
-        system_state_changes,
+        system_state_modifications,
     } = canister_state_changes;
 
     let clean_system_state = system_state.clone();
     let clean_subnet_available_memory = round_limits.subnet_available_memory;
-    let callbacks_created = system_state_changes.callbacks_created();
+    let callbacks_created = system_state_modifications.callbacks_created();
     if output.wasm_result.is_ok() {
         // Everything that is passed via a mutable reference in this function
         // should be cloned and restored in case of an error.
         match try_apply_canister_state_changes(
-            system_state_changes,
+            system_state_modifications,
             output,
             system_state,
             &mut round_limits.subnet_available_memory,

rs/execution_environment/src/execution/install_code.rs

@@ -743,10 +743,10 @@ impl InstallCodeHelper {
 
         let CanisterStateChanges {
             execution_state_changes,
-            system_state_changes,
+            system_state_modifications,
         } = canister_state_changes;
 
-        if let Err(err) = system_state_changes.apply_changes(
+        if let Err(err) = system_state_modifications.apply_changes(
             original.time,
             &mut self.canister.system_state,
             round.network_topology,

rs/execution_environment/src/execution/response.rs

@@ -374,7 +374,9 @@ impl ResponseHelper {
         // Check that the cycles balance does not go below zero after applying
         // the Wasm execution state changes.
         let old_balance = self.canister.system_state.balance();
-        let requested = canister_state_changes.system_state_changes.removed_cycles();
+        let requested = canister_state_changes
+            .system_state_modifications
+            .removed_cycles();
         // Note that we ignore the freezing threshold as required by the spec.
         if old_balance < requested {
             let reveal_top_up = self
@@ -462,7 +464,9 @@ impl ResponseHelper {
         // like releasing locks or undoing other state changes.
         let ingress_induction_cycles_debit =
             self.canister.system_state.ingress_induction_cycles_debit();
-        let removed_cycles = canister_state_changes.system_state_changes.removed_cycles();
+        let removed_cycles = canister_state_changes
+            .system_state_modifications
+            .removed_cycles();
         if self.canister.system_state.balance() < ingress_induction_cycles_debit + removed_cycles {
             self.canister
                 .system_state

rs/execution_environment/src/execution/update.rs

@@ -448,7 +448,9 @@ impl UpdateHelper {
         // Check that the cycles balance does not go below the freezing
         // threshold after applying the Wasm execution state changes.
         let old_balance = self.canister.system_state.balance();
-        let requested = canister_state_changes.system_state_changes.removed_cycles();
+        let requested = canister_state_changes
+            .system_state_modifications
+            .removed_cycles();
         let reveal_top_up = self
             .canister
             .controllers()