starknet_os: os resources test - add keccak

Author: dorimedini-starkware

crates/apollo_starknet_os_program/src/cairo/starkware/starknet/core/os/constants.cairo

@@ -72,7 +72,7 @@ const ALLOWED_VIRTUAL_OS_PROGRAM_HASHES_1 = (
     0x06ecb73d21c7d98ddd4148f5bcd91cc2747c65364245fbf32a63b05cca1685c2
 );
 const ALLOWED_VIRTUAL_OS_PROGRAM_HASHES_2 = (
-    0x06e0e4653c9bf533daba4c89a969a78f082fd2b7ebd38912ca8138441a897bea
+    0x050a1cd46f1a35628c7569f85218b7b8b01510cb33834c3bd00885183c5770a5
 );
 const ALLOWED_VIRTUAL_OS_PROGRAM_HASHES_LEN = 3;
 
@@ -136,7 +136,7 @@ const SECP256R1_MUL_GAS_COST = 13511870;
 const SECP256R1_NEW_GAS_COST = 61630;
 
 const KECCAK_GAS_COST = 10000;
-const KECCAK_ROUND_COST_GAS_COST = 171707;
+const KECCAK_ROUND_COST_GAS_COST = 175207;
 const SHA256_PROCESS_BLOCK_GAS_COST = 841295;
 const SHA512_PROCESS_BLOCK_GAS_COST = 2413810;
 

crates/apollo_starknet_os_program/src/program_hash.json

@@ -1,6 +1,6 @@
 {
-  "os": "0x6953c7279f84f553ce738d580de5df707feef830c3ca1840829b6bbdf79db4e",
-  "virtual_os": "0x6e0e4653c9bf533daba4c89a969a78f082fd2b7ebd38912ca8138441a897bea",
+  "os": "0x195ad0b42c896cb80d029d349cc1b7fe182acb20c540c3dcb68256ab87ea41",
+  "virtual_os": "0x50a1cd46f1a35628c7569f85218b7b8b01510cb33834c3bd00885183c5770a5",
   "aggregator": "0x700786d51b3854af43d8e12180380bda3029be6c1767e007858de6ca2edac40",
   "aggregator_with_prefix": "0xe08d300e3f5996e43d6d7cc5a20068e0e58cf1309089f2348317ac580f6c1f"
 }

crates/blockifier/resources/blockifier_versioned_constants_0_14_4.json

@@ -128,7 +128,7 @@
         "allowed_virtual_os_program_hashes": [
             "0x3e98c2d7703b03a7edb73ed7f075f97f1dcbaa8f717cdf6e1a57bf058265473",
             "0x6ecb73d21c7d98ddd4148f5bcd91cc2747c65364245fbf32a63b05cca1685c2",
-            "0x6e0e4653c9bf533daba4c89a969a78f082fd2b7ebd38912ca8138441a897bea"
+            "0x50a1cd46f1a35628c7569f85218b7b8b01510cb33834c3bd00885183c5770a5"
         ],
         "constructor_entry_point_selector": "0x28ffe4ff0f226a9107253e17a904099aa4f63a02a5621de0576e5aa71bc5194",
         "default_entry_point_selector": "0x0",
@@ -337,7 +337,7 @@
                 "builtin_instance_counter": {}
             },
             "KeccakRound": {
-                "n_steps": 281,
+                "n_steps": 316,
                 "n_memory_holes": 0,
                 "builtin_instance_counter": {
                     "range_check_builtin": 56,

crates/blockifier/resources/versioned_constants_diff_regression/0.14.3_0.14.4.txt

@@ -1,4 +1,4 @@
-+ /os_constants/allowed_virtual_os_program_hashes/2: "0x6e0e4653c9bf533daba4c89a969a78f082fd2b7ebd38912ca8138441a897bea"
++ /os_constants/allowed_virtual_os_program_hashes/2: "0x50a1cd46f1a35628c7569f85218b7b8b01510cb33834c3bd00885183c5770a5"
 ~ /os_resources/execute_syscalls/CallContract/n_steps: 901
 ~ /os_resources/execute_syscalls/LibraryCall/n_steps: 874
 ~ /os_resources/execute_syscalls/MetaTxV0/constant/builtin_instance_counter/pedersen_builtin: 13

crates/blockifier_test_utils/resources/feature_contracts/cairo1/os_resources_test_contract.cairo

@@ -4,7 +4,7 @@ mod OsResourcesTestContract {
     use starknet::info::SyscallResultTrait;
     use starknet::syscalls::{
         call_contract_syscall, deploy_syscall, emit_event_syscall, get_execution_info_v3_syscall,
-        library_call_syscall,
+        keccak_syscall, library_call_syscall,
     };
     use starknet::{ClassHash, ContractAddress, get_block_hash_syscall, get_class_hash_at_syscall};
 
@@ -92,5 +92,14 @@ mod OsResourcesTestContract {
 
         // get execution info syscall.
         get_execution_info_v3_syscall().unwrap_syscall();
+
+        // keccak syscall. Second call is to measure the keccak round syscall.
+        keccak_syscall(array![].span()).unwrap_syscall();
+        // Exactly 17 input u64s are required to measure a single round.
+        let mut input = array![];
+        for _ in 0_u8..17 {
+            input.append(1_u64);
+        }
+        keccak_syscall(input.span()).unwrap_syscall();
     }
 }

crates/starknet_os_flow_tests/src/os_resources_test.rs

@@ -2,6 +2,7 @@ use std::collections::{HashMap, HashSet};
 use std::sync::LazyLock;
 
 use blockifier::blockifier_versioned_constants::{
+    RawStepGasCost,
     RawVersionedConstants,
     ResourcesParams,
     VariableCallDataFactor,
@@ -44,7 +45,7 @@ use crate::test_manager::{
 use crate::tests::NON_TRIVIAL_RESOURCE_BOUNDS;
 
 // TODO(Dori): Delete this, or at least reduce it to a minimal set of unmeasurable syscalls.
-const UNMEASURABLE_SYSCALLS: [Selector; 28] = [
+const UNMEASURABLE_SYSCALLS: [Selector; 26] = [
     Selector::DelegateCall,
     Selector::DelegateL1Handler,
     Selector::GetBlockNumber,
@@ -54,8 +55,6 @@ const UNMEASURABLE_SYSCALLS: [Selector; 28] = [
     Selector::GetSequencerAddress,
     Selector::GetTxInfo,
     Selector::GetTxSignature,
-    Selector::Keccak,
-    Selector::KeccakRound,
     Selector::Sha256ProcessBlock,
     Selector::Sha512ProcessBlock,
     Selector::LibraryCallL1Handler,
@@ -90,8 +89,9 @@ const UNMEASURABLE_SYSCALLS: [Selector; 28] = [
 /// The second call will always have one more linear element than the first call.
 /// Note: Keccak does not store the linear factor in the same entry in the versioned constants, but
 /// it does have a measurable linear factor stored under [Selector::KeccakRound].
-static SYSCALLS_WITH_LINEAR_FACTOR: LazyLock<HashMap<Selector, usize>> =
-    LazyLock::new(|| HashMap::from([(Selector::Deploy, 1), (Selector::MetaTxV0, 1)]));
+static SYSCALLS_WITH_LINEAR_FACTOR: LazyLock<HashMap<Selector, usize>> = LazyLock::new(|| {
+    HashMap::from([(Selector::Deploy, 1), (Selector::Keccak, 0), (Selector::MetaTxV0, 1)])
+});
 
 /// Expected syscalls in the fee transfer call. Should be removed from the list of syscalls during
 /// measurement iteration - only the syscalls called during __execute__ should be measured.
@@ -177,6 +177,9 @@ async fn test_fee_transfer_syscalls() {
 #[tokio::test]
 async fn test_os_resources_regression() {
     let os_resources_contract = FeatureContract::OsResourcesTest(RunnableCairo1::Casm);
+    let version = StarknetVersion::LATEST;
+    let mut raw_vc: RawVersionedConstants =
+        serde_json::from_str(VersionedConstants::json_str(&version).unwrap()).unwrap();
 
     // Setup the test initial state and test builder.
     // Need to explicitly set up the state to be able to override the minimal sierra version for gas
@@ -190,6 +193,7 @@ async fn test_os_resources_regression() {
     initial_state_data.initial_state.block_context = {
         let block_context = &initial_state_data.initial_state.block_context;
         let mut vc = block_context.versioned_constants().clone();
+        assert_eq!(vc, raw_vc.clone().into());
         vc.min_sierra_version_for_sierra_gas = SierraVersion::new(99, 99, 99);
         BlockContext::new(
             block_context.block_info().clone(),
@@ -335,9 +339,7 @@ async fn test_os_resources_regression() {
 
         // If this if a syscall with a linear factor, the next syscall should be an invocation of
         // the same syscall with +1 linear element.
-        let syscall_cost = if let Some(linear_count_in_base) =
-            SYSCALLS_WITH_LINEAR_FACTOR.get(&selector)
-        {
+        if let Some(linear_count_in_base) = SYSCALLS_WITH_LINEAR_FACTOR.get(&selector) {
             let next_syscall_trace = syscalls_iter.next().unwrap();
             assert_eq!(
                 selector,
@@ -348,24 +350,50 @@ async fn test_os_resources_regression() {
             );
             let next_resources =
                 maybe_deduct_inner(next_syscall_trace.get_resources().unwrap(), selector);
-            let linear_factor_resources = (&next_resources - &resources).filter_unused_builtins();
 
-            // Linear factor is computed; deduct the linear overhead from the base cost to get the
-            // real base cost.
-            let constant_resources = (&resources
-                - &(&linear_factor_resources * *linear_count_in_base))
-                .filter_unused_builtins();
+            // Keccak is a special case:
+            // 1. We store the linear cost as a separate syscall.
+            // 2. Currently, the Keccak base cost is enforced in the OS to equal the syscall base
+            //    cost (`static_assert KECCAK_GAS_COST == SYSCALL_BASE_GAS_COST`).
+            // TODO(Dori): If and when (2) is no longer the case, no need to replace `resources`
+            //   (measured keccak base cost) with the syscall base cost, and no need to recompute
+            //   the linear factor.
+            if selector == Selector::Keccak {
+                let RawStepGasCost { step_gas_cost: n_steps } =
+                    raw_vc.os_constants.syscall_base_gas_cost.clone();
+                let constant_resources = ExecutionResources {
+                    n_steps: n_steps.0.try_into().unwrap(),
+                    ..Default::default()
+                };
+                let linear_factor_resources =
+                    (&next_resources - &constant_resources).filter_unused_builtins();
+                measurements
+                    .insert(Selector::Keccak, VariableResourceParams::Constant(constant_resources));
+                measurements.insert(
+                    Selector::KeccakRound,
+                    VariableResourceParams::Constant(linear_factor_resources),
+                );
+            } else {
+                let linear_factor_resources =
+                    (&next_resources - &resources).filter_unused_builtins();
+                // Linear factor is computed; deduct the linear overhead from the base cost to get
+                // the real base cost.
+                let constant_resources = (&resources
+                    - &(&linear_factor_resources * *linear_count_in_base))
+                    .filter_unused_builtins();
 
-            VariableResourceParams::WithFactor(ResourcesParams {
-                constant: constant_resources,
-                // Syscalls with a linear factor have an unscaled linear factor cost.
-                calldata_factor: VariableCallDataFactor::Unscaled(linear_factor_resources),
-            })
+                measurements.insert(
+                    selector,
+                    VariableResourceParams::WithFactor(ResourcesParams {
+                        constant: constant_resources,
+                        // Syscalls with a linear factor have an unscaled linear factor cost.
+                        calldata_factor: VariableCallDataFactor::Unscaled(linear_factor_resources),
+                    }),
+                );
+            }
         } else {
-            VariableResourceParams::Constant(resources)
-        };
-
-        measurements.insert(selector, syscall_cost);
+            measurements.insert(selector, VariableResourceParams::Constant(resources));
+        }
     }
 
     // Make sure we covered all syscalls we expect to.
@@ -379,9 +407,6 @@ async fn test_os_resources_regression() {
     );
 
     // Compare the measurements with the expected values on the latest VC.
-    let version = StarknetVersion::LATEST;
-    let mut raw_vc: RawVersionedConstants =
-        serde_json::from_str(VersionedConstants::json_str(&version).unwrap()).unwrap();
     for (syscall, resources) in measurements {
         raw_vc.os_resources.execute_syscalls.insert(syscall, resources);
     }