sui_adapter_v1/
adapter.rs

1// Copyright (c) Mysten Labs, Inc.
2// SPDX-License-Identifier: Apache-2.0
3
4pub use checked::*;
5
6#[sui_macros::with_checked_arithmetic]
7mod checked {
8    use std::{collections::BTreeMap, sync::Arc};
9
10    use anyhow::Result;
11    use move_binary_format::file_format::CompiledModule;
12    use move_bytecode_verifier::verify_module_with_config_metered;
13    use move_bytecode_verifier_meter::Meter;
14    use move_core_types::account_address::AccountAddress;
15    use move_vm_config::{
16        runtime::{VMConfig, VMRuntimeLimitsConfig},
17        verifier::VerifierConfig,
18    };
19    use move_vm_runtime::{
20        move_vm::MoveVM, native_extensions::NativeContextExtensions,
21        native_functions::NativeFunctionTable,
22    };
23    use sui_move_natives::object_runtime;
24    use sui_types::{error::SuiErrorKind, metrics::BytecodeVerifierMetrics};
25    use sui_verifier::check_for_verifier_timeout;
26    use tracing::instrument;
27
28    use sui_move_natives::{object_runtime::ObjectRuntime, NativesCostTable};
29    use sui_protocol_config::ProtocolConfig;
30    use sui_types::{
31        base_types::*,
32        error::ExecutionError,
33        error::{ExecutionErrorKind, SuiError},
34        metrics::LimitsMetrics,
35        storage::ChildObjectResolver,
36    };
37    use sui_verifier::verifier::sui_verify_module_metered_check_timeout_only;
38
39    pub fn new_move_vm(
40        natives: NativeFunctionTable,
41        protocol_config: &ProtocolConfig,
42    ) -> Result<MoveVM, SuiError> {
43        MoveVM::new_with_config(
44            natives,
45            VMConfig {
46                verifier: protocol_config.verifier_config(/* signing_limits */ None),
47                max_binary_format_version: protocol_config.move_binary_format_version(),
48                runtime_limits_config: VMRuntimeLimitsConfig {
49                    vector_len_max: protocol_config.max_move_vector_len(),
50                    max_value_nest_depth: protocol_config.max_move_value_depth_as_option(),
51                    hardened_otw_check: protocol_config.hardened_otw_check(),
52                },
53                enable_invariant_violation_check_in_swap_loc: !protocol_config
54                    .disable_invariant_violation_check_in_swap_loc(),
55                check_no_extraneous_bytes_during_deserialization: protocol_config
56                    .no_extraneous_module_bytes(),
57
58                // Don't augment errors with execution state on-chain
59                error_execution_state: false,
60                binary_config: protocol_config.binary_config(None),
61                rethrow_serialization_type_layout_errors: protocol_config
62                    .rethrow_serialization_type_layout_errors(),
63                max_type_to_layout_nodes: protocol_config.max_type_to_layout_nodes_as_option(),
64                variant_nodes: protocol_config.variant_nodes(),
65                deprecate_global_storage_ops_during_deserialization: protocol_config
66                    .deprecate_global_storage_ops_during_deserialization(),
67            },
68        )
69        .map_err(|_| SuiErrorKind::ExecutionInvariantViolation.into())
70    }
71
72    pub fn new_native_extensions<'r>(
73        child_resolver: &'r dyn ChildObjectResolver,
74        input_objects: BTreeMap<ObjectID, object_runtime::InputObject>,
75        is_metered: bool,
76        protocol_config: &ProtocolConfig,
77        metrics: Arc<LimitsMetrics>,
78        current_epoch_id: EpochId,
79    ) -> NativeContextExtensions<'r> {
80        let mut extensions = NativeContextExtensions::default();
81        extensions.add(ObjectRuntime::new(
82            child_resolver,
83            input_objects,
84            is_metered,
85            protocol_config,
86            metrics,
87            current_epoch_id,
88        ));
89        extensions.add(NativesCostTable::from_protocol_config(protocol_config));
90        extensions
91    }
92
93    /// Given a list of `modules` and an `object_id`, mutate each module's self ID (which must be
94    /// 0x0) to be `object_id`.
95    pub fn substitute_package_id(
96        modules: &mut [CompiledModule],
97        object_id: ObjectID,
98    ) -> Result<(), ExecutionError> {
99        let new_address = AccountAddress::from(object_id);
100
101        for module in modules.iter_mut() {
102            let self_handle = module.self_handle().clone();
103            let self_address_idx = self_handle.address;
104
105            let addrs = &mut module.address_identifiers;
106            let Some(address_mut) = addrs.get_mut(self_address_idx.0 as usize) else {
107                let name = module.identifier_at(self_handle.name);
108                return Err(ExecutionError::new_with_source(
109                    ExecutionErrorKind::PublishErrorNonZeroAddress,
110                    format!("Publishing module {name} with invalid address index"),
111                ));
112            };
113
114            if *address_mut != AccountAddress::ZERO {
115                let name = module.identifier_at(self_handle.name);
116                return Err(ExecutionError::new_with_source(
117                    ExecutionErrorKind::PublishErrorNonZeroAddress,
118                    format!("Publishing module {name} with non-zero address is not allowed"),
119                ));
120            };
121
122            *address_mut = new_address;
123        }
124
125        Ok(())
126    }
127
128    pub fn missing_unwrapped_msg(id: &ObjectID) -> String {
129        format!(
130        "Unable to unwrap object {}. Was unable to retrieve last known version in the parent sync",
131        id
132    )
133    }
134
135    /// Run the bytecode verifier with a meter limit
136    ///
137    /// This function only fails if the verification does not complete within the limit.  If the
138    /// modules fail to verify but verification completes within the meter limit, the function
139    /// succeeds.
140    #[instrument(level = "trace", skip_all)]
141    pub fn run_metered_move_bytecode_verifier(
142        modules: &[CompiledModule],
143        verifier_config: &VerifierConfig,
144        meter: &mut (impl Meter + ?Sized),
145        metrics: &Arc<BytecodeVerifierMetrics>,
146    ) -> Result<(), SuiError> {
147        // run the Move verifier
148        for module in modules.iter() {
149            let per_module_meter_verifier_timer = metrics
150                .verifier_runtime_per_module_success_latency
151                .start_timer();
152
153            if let Err(e) = verify_module_with_config_metered(verifier_config, module, meter) {
154                // Check that the status indicates mtering timeout
155                if check_for_verifier_timeout(&e.major_status()) {
156                    // Discard success timer, but record timeout/failure timer
157                    metrics
158                        .verifier_runtime_per_module_timeout_latency
159                        .observe(per_module_meter_verifier_timer.stop_and_discard());
160                    metrics
161                        .verifier_timeout_metrics
162                        .with_label_values(&[
163                            BytecodeVerifierMetrics::MOVE_VERIFIER_TAG,
164                            BytecodeVerifierMetrics::TIMEOUT_TAG,
165                        ])
166                        .inc();
167                    return Err(SuiErrorKind::ModuleVerificationFailure {
168                        error: format!("Verification timedout: {}", e),
169                    }
170                    .into());
171                };
172            } else if let Err(err) =
173                sui_verify_module_metered_check_timeout_only(module, &BTreeMap::new(), meter)
174            {
175                // We only checked that the failure was due to timeout
176                // Discard success timer, but record timeout/failure timer
177                metrics
178                    .verifier_runtime_per_module_timeout_latency
179                    .observe(per_module_meter_verifier_timer.stop_and_discard());
180                metrics
181                    .verifier_timeout_metrics
182                    .with_label_values(&[
183                        BytecodeVerifierMetrics::SUI_VERIFIER_TAG,
184                        BytecodeVerifierMetrics::TIMEOUT_TAG,
185                    ])
186                    .inc();
187                return Err(err.into());
188            }
189            // Save the success timer
190            per_module_meter_verifier_timer.stop_and_record();
191            metrics
192                .verifier_timeout_metrics
193                .with_label_values(&[
194                    BytecodeVerifierMetrics::OVERALL_TAG,
195                    BytecodeVerifierMetrics::SUCCESS_TAG,
196                ])
197                .inc();
198        }
199        Ok(())
200    }
201}
sui_adapter_v1/adapter.rs

sui_adapter_v1/
adapter.rs
