starknet_os: os resources test - add keccak

Author: dorimedini-starkware

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

@@ -105,8 +105,8 @@ const SYSCALL_BASE_GAS_COST = 10000;
 
 // Syscall gas costs.
 const CALL_CONTRACT_GAS_COST = 91160;
-const DEPLOY_GAS_COST = 151870;
-const DEPLOY_CALLDATA_FACTOR_GAS_COST = 4650;
+const DEPLOY_GAS_COST = 151670;
+const DEPLOY_CALLDATA_FACTOR_GAS_COST = 4850;
 const GET_BLOCK_HASH_GAS_COST = 10810;
 const GET_CLASS_HASH_AT_GAS_COST = 10000;
 const GET_EXECUTION_INFO_GAS_COST = 11240;
@@ -133,7 +133,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 = 175107;
 const SHA256_PROCESS_BLOCK_GAS_COST = 841295;
 
 // Cairo 1.0 error codes.

crates/apollo_starknet_os_program/src/program_hash.json

@@ -1,5 +1,5 @@
 {
-  "os": "0x769d28e62bb261f8b7a535c9007361344abd5458f559bcbaee8f9b4897864f6",
+  "os": "0x4993a6c01cd33ffab71977f6a6a89835cd3bc4861f81734f45ad749df041cca",
   "virtual_os": "0x4ccaaed5759efad1372b08a0719839fcf22c28f1ae8b0744a4ad95a20a628ff",
   "aggregator": "0x700786d51b3854af43d8e12180380bda3029be6c1767e007858de6ca2edac40",
   "aggregator_with_prefix": "0xe08d300e3f5996e43d6d7cc5a20068e0e58cf1309089f2348317ac580f6c1f"

crates/blockifier/resources/blockifier_versioned_constants_0_14_3.json

@@ -247,15 +247,15 @@
             },
             "Deploy": {
                 "constant": {
-                    "n_steps": 1180,
+                    "n_steps": 1178,
                     "n_memory_holes": 0,
                     "builtin_instance_counter": {
                         "range_check_builtin": 21,
                         "pedersen_builtin": 8
                     }
                 },
                 "calldata_factor": {
-                    "n_steps": 6,
+                    "n_steps": 8,
                     "n_memory_holes": 0,
                     "builtin_instance_counter": {
                         "pedersen_builtin": 1
@@ -337,7 +337,7 @@
                 "builtin_instance_counter": {}
             },
             "KeccakRound": {
-                "n_steps": 281,
+                "n_steps": 315,
                 "n_memory_holes": 0,
                 "builtin_instance_counter": {
                     "range_check_builtin": 56,

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

@@ -8,6 +8,7 @@ mod OsResourcesTestContract {
         deploy_syscall,
         emit_event_syscall,
         get_execution_info_v2_syscall,
+        keccak_syscall,
         library_call_syscall,
     };
     use starknet::{ClassHash, ContractAddress, get_block_hash_syscall, get_class_hash_at_syscall};
@@ -99,6 +100,15 @@ mod OsResourcesTestContract {
 
         // get execution info syscall.
         get_execution_info_v2_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();
     }
 
     // Target for call_contract and library_call — accepts no arguments.

crates/starknet_os_flow_tests/src/os_resources_test.rs

@@ -1,6 +1,7 @@
 use std::collections::HashSet;
 
 use blockifier::blockifier_versioned_constants::{
+    RawStepGasCost,
     RawVersionedConstants,
     ResourcesParams,
     VariableCallDataFactor,
@@ -31,7 +32,7 @@ use crate::tests::NON_TRIVIAL_RESOURCE_BOUNDS;
 use crate::utils::get_class_hash_of_feature_contract;
 
 // TODO(Dori): Delete this, or at least reduce it to a minimal set of unmeasurable syscalls.
-const UNMEASURABLE_SYSCALLS: [Selector; 27] = [
+const UNMEASURABLE_SYSCALLS: [Selector; 25] = [
     Selector::DelegateCall,
     Selector::DelegateL1Handler,
     Selector::GetBlockNumber,
@@ -41,8 +42,6 @@ const UNMEASURABLE_SYSCALLS: [Selector; 27] = [
     Selector::GetSequencerAddress,
     Selector::GetTxInfo,
     Selector::GetTxSignature,
-    Selector::Keccak,
-    Selector::KeccakRound,
     Selector::Sha256ProcessBlock,
     Selector::LibraryCallL1Handler,
     Selector::ReplaceClass,
@@ -61,7 +60,10 @@ const UNMEASURABLE_SYSCALLS: [Selector; 27] = [
     Selector::StorageWrite,
 ];
 
-const SYSCALLS_WITH_LINEAR_FACTOR: [Selector; 2] = [Selector::Deploy, Selector::MetaTxV0];
+/// 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].
+const SYSCALLS_WITH_LINEAR_FACTOR: [Selector; 3] =
+    [Selector::Deploy, Selector::Keccak, Selector::MetaTxV0];
 
 /// 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.
@@ -122,6 +124,9 @@ async fn test_fee_transfer_syscalls() {
 async fn test_os_resources_regression() {
     let os_resources_contract = FeatureContract::OsResourcesTest(RunnableCairo1::Casm);
     let os_resources_class_hash = get_class_hash_of_feature_contract(os_resources_contract);
+    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
@@ -253,7 +258,7 @@ async fn test_os_resources_regression() {
 
         // If this if a syscall with a linear factor, the next syscall should be the linear cost.
         // Otherwise, this syscall has a constant cost.
-        let syscall_cost = if SYSCALLS_WITH_LINEAR_FACTOR.contains(&selector) {
+        if SYSCALLS_WITH_LINEAR_FACTOR.contains(&selector) {
             let next_syscall_trace = syscalls_iter.next().unwrap();
             assert_eq!(
                 selector,
@@ -267,16 +272,38 @@ async fn test_os_resources_regression() {
                 - &next_inner_overhead)
                 .filter_unused_builtins();
             let linear_factor_resources = (&next_resources - &resources).filter_unused_builtins();
-            VariableResourceParams::WithFactor(ResourcesParams {
-                constant: resources,
-                // Syscalls with a linear factor have an unscaled linear factor cost.
-                calldata_factor: VariableCallDataFactor::Unscaled(linear_factor_resources),
-            })
+            // Keccak is a special case - we store the linear cost as a separate syscall.
+            if selector == Selector::Keccak {
+                // TODO(Dori): Currently, the Keccak base cost is enforced in the OS to equal the
+                //   syscall base cost. If and when this 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.
+                let RawStepGasCost { step_gas_cost: n_steps } =
+                    raw_vc.os_constants.syscall_base_gas_cost.clone();
+                let resources = ExecutionResources {
+                    n_steps: n_steps.0.try_into().unwrap(),
+                    ..Default::default()
+                };
+                let linear_factor_resources =
+                    (&next_resources - &resources).filter_unused_builtins();
+                measurements.insert(Selector::Keccak, VariableResourceParams::Constant(resources));
+                measurements.insert(
+                    Selector::KeccakRound,
+                    VariableResourceParams::Constant(linear_factor_resources),
+                );
+            } else {
+                measurements.insert(
+                    selector,
+                    VariableResourceParams::WithFactor(ResourcesParams {
+                        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.
@@ -297,9 +324,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);
     }