sui_adapter_v0/
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                // Don't augment errors with execution state on-chain
58                error_execution_state: false,
59
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    ) -> NativeContextExtensions<'r> {
79        let mut extensions = NativeContextExtensions::default();
80        extensions.add(ObjectRuntime::new(
81            child_resolver,
82            input_objects,
83            is_metered,
84            protocol_config,
85            metrics,
86        ));
87        extensions.add(NativesCostTable::from_protocol_config(protocol_config));
88        extensions
89    }
90
91    /// Given a list of `modules` and an `object_id`, mutate each module's self ID (which must be
92    /// 0x0) to be `object_id`.
93    pub fn substitute_package_id(
94        modules: &mut [CompiledModule],
95        object_id: ObjectID,
96    ) -> Result<(), ExecutionError> {
97        let new_address = AccountAddress::from(object_id);
98
99        for module in modules.iter_mut() {
100            let self_handle = module.self_handle().clone();
101            let self_address_idx = self_handle.address;
102
103            let addrs = &mut module.address_identifiers;
104            let Some(address_mut) = addrs.get_mut(self_address_idx.0 as usize) else {
105                let name = module.identifier_at(self_handle.name);
106                return Err(ExecutionError::new_with_source(
107                    ExecutionErrorKind::PublishErrorNonZeroAddress,
108                    format!("Publishing module {name} with invalid address index"),
109                ));
110            };
111
112            if *address_mut != AccountAddress::ZERO {
113                let name = module.identifier_at(self_handle.name);
114                return Err(ExecutionError::new_with_source(
115                    ExecutionErrorKind::PublishErrorNonZeroAddress,
116                    format!("Publishing module {name} with non-zero address is not allowed"),
117                ));
118            };
119
120            *address_mut = new_address;
121        }
122
123        Ok(())
124    }
125
126    pub fn missing_unwrapped_msg(id: &ObjectID) -> String {
127        format!(
128        "Unable to unwrap object {}. Was unable to retrieve last known version in the parent sync",
129        id
130    )
131    }
132
133    /// Run the bytecode verifier with a meter limit
134    ///
135    /// This function only fails if the verification does not complete within the limit.  If the
136    /// modules fail to verify but verification completes within the meter limit, the function
137    /// succeeds.
138    #[instrument(level = "trace", skip_all)]
139    pub fn run_metered_move_bytecode_verifier(
140        modules: &[CompiledModule],
141        protocol_config: &ProtocolConfig,
142        verifier_config: &VerifierConfig,
143        meter: &mut (impl Meter + ?Sized),
144        metrics: &Arc<BytecodeVerifierMetrics>,
145    ) -> Result<(), SuiError> {
146        // run the Move verifier
147        for module in modules.iter() {
148            let per_module_meter_verifier_timer = metrics
149                .verifier_runtime_per_module_success_latency
150                .start_timer();
151
152            if let Err(e) = verify_module_with_config_metered(verifier_config, module, meter) {
153                // Check that the status indicates mtering timeout
154                if check_for_verifier_timeout(&e.major_status()) {
155                    // Discard success timer, but record timeout/failure timer
156                    metrics
157                        .verifier_runtime_per_module_timeout_latency
158                        .observe(per_module_meter_verifier_timer.stop_and_discard());
159                    metrics
160                        .verifier_timeout_metrics
161                        .with_label_values(&[
162                            BytecodeVerifierMetrics::MOVE_VERIFIER_TAG,
163                            BytecodeVerifierMetrics::TIMEOUT_TAG,
164                        ])
165                        .inc();
166                    return Err(SuiErrorKind::ModuleVerificationFailure {
167                        error: format!("Verification timedout: {}", e),
168                    }
169                    .into());
170                };
171            } else if let Err(err) = sui_verify_module_metered_check_timeout_only(
172                protocol_config,
173                module,
174                &BTreeMap::new(),
175                meter,
176            ) {
177                // We only checked that the failure was due to timeout
178                // Discard success timer, but record timeout/failure timer
179                metrics
180                    .verifier_runtime_per_module_timeout_latency
181                    .observe(per_module_meter_verifier_timer.stop_and_discard());
182                metrics
183                    .verifier_timeout_metrics
184                    .with_label_values(&[
185                        BytecodeVerifierMetrics::SUI_VERIFIER_TAG,
186                        BytecodeVerifierMetrics::TIMEOUT_TAG,
187                    ])
188                    .inc();
189                return Err(err.into());
190            }
191            // Save the success timer
192            per_module_meter_verifier_timer.stop_and_record();
193            metrics
194                .verifier_timeout_metrics
195                .with_label_values(&[
196                    BytecodeVerifierMetrics::OVERALL_TAG,
197                    BytecodeVerifierMetrics::SUCCESS_TAG,
198                ])
199                .inc();
200        }
201        Ok(())
202    }
203}
sui_adapter_v0/adapter.rs

sui_adapter_v0/
adapter.rs
