solana_program_runtime/
deploy.rs

1//! Program deployment functionality.
2
3#[cfg(feature = "metrics")]
4use {crate::program_metrics::LoadProgramMetrics, solana_svm_measure::measure::Measure};
5use {
6    crate::{
7        invoke_context::InvokeContext,
8        loaded_programs::{ProgramCacheForTxBatch, ProgramRuntimeEnvironment},
9        program_cache_entry::{ProgramCacheEntry, ProgramCacheEntryOwner},
10    },
11    solana_clock::Slot,
12    solana_instruction::error::InstructionError,
13    solana_pubkey::Pubkey,
14    solana_sbpf::{
15        elf::{ElfError, Executable},
16        program::{BuiltinProgram, SBPFVersion},
17        verifier::RequisiteVerifier,
18    },
19    solana_svm_log_collector::{LogCollector, ic_logger_msg},
20    solana_svm_type_overrides::sync::Arc,
21    std::{cell::RefCell, rc::Rc},
22};
23
24fn morph_into_deployment_environment(
25    from: ProgramRuntimeEnvironment,
26    disable_sbpf_v0_v1_v2_deployment: bool,
27) -> Result<BuiltinProgram<InvokeContext<'static, 'static>>, ElfError> {
28    let mut config = (*from).get_config().clone();
29    config.reject_broken_elfs = true;
30    if disable_sbpf_v0_v1_v2_deployment {
31        config.enabled_sbpf_versions = SBPFVersion::V3..=*config.enabled_sbpf_versions.end();
32    }
33
34    let mut result = BuiltinProgram::new_loader(config);
35
36    for (_key, (name, value)) in (*from).get_function_registry().iter() {
37        // Deployment of programs with sol_alloc_free is disabled. So do not register the syscall.
38        if name != *b"sol_alloc_free_" {
39            result.register_function(unsafe { std::str::from_utf8_unchecked(name) }, value)?;
40        }
41    }
42
43    Ok(result)
44}
45
46/// Directly deploy a program using a provided invoke context.
47/// This function should only be invoked from the runtime, since it does not
48/// provide any account loads or checks.
49#[allow(clippy::too_many_arguments)]
50pub fn deploy_program(
51    log_collector: Option<Rc<RefCell<LogCollector>>>,
52    #[cfg(feature = "metrics")] load_program_metrics: &mut LoadProgramMetrics,
53    program_cache_for_tx_batch: &mut ProgramCacheForTxBatch,
54    program_runtime_environment: ProgramRuntimeEnvironment,
55    disable_sbpf_v0_v1_v2_deployment: bool,
56    program_id: &Pubkey,
57    loader_key: &Pubkey,
58    programdata: &[u8],
59    deployment_slot: Slot,
60) -> Result<(), InstructionError> {
61    #[cfg(feature = "metrics")]
62    let mut register_syscalls_time = Measure::start("register_syscalls_time");
63    let deployment_program_runtime_environment = morph_into_deployment_environment(
64        ProgramRuntimeEnvironment::clone(&program_runtime_environment),
65        disable_sbpf_v0_v1_v2_deployment,
66    )
67    .map_err(|e| {
68        ic_logger_msg!(log_collector, "Failed to register syscalls: {}", e);
69        InstructionError::ProgramEnvironmentSetupFailure
70    })?;
71    #[cfg(feature = "metrics")]
72    {
73        register_syscalls_time.stop();
74        load_program_metrics.register_syscalls_us = register_syscalls_time.as_us();
75    }
76    // Verify using stricter deployment_program_runtime_environment
77    #[cfg(feature = "metrics")]
78    let mut load_elf_time = Measure::start("load_elf_time");
79    let executable = Executable::<InvokeContext>::load(
80        programdata,
81        Arc::new(deployment_program_runtime_environment),
82    )
83    .map_err(|err| {
84        ic_logger_msg!(log_collector, "{}", err);
85        InstructionError::InvalidAccountData
86    })?;
87    #[cfg(feature = "metrics")]
88    {
89        load_elf_time.stop();
90        load_program_metrics.load_elf_us = load_elf_time.as_us();
91    }
92    #[cfg(feature = "metrics")]
93    let mut verify_code_time = Measure::start("verify_code_time");
94    executable.verify::<RequisiteVerifier>().map_err(|err| {
95        ic_logger_msg!(log_collector, "{}", err);
96        InstructionError::InvalidAccountData
97    })?;
98    #[cfg(feature = "metrics")]
99    {
100        verify_code_time.stop();
101        load_program_metrics.verify_code_us = verify_code_time.as_us();
102    }
103    // Insert but with program_runtime_environment
104    let program_cache_entry = ProgramCacheEntry::new_unloaded(
105        deployment_slot,
106        ProgramCacheEntryOwner::try_from(loader_key)
107            .map_err(|_| InstructionError::InvalidAccountData)?,
108        program_runtime_environment,
109    );
110    if let Some(old_entry) = program_cache_for_tx_batch.find(program_id) {
111        program_cache_entry.stats.merge_from(&old_entry.stats);
112    }
113    #[cfg(feature = "metrics")]
114    {
115        load_program_metrics.program_id = program_id.to_string();
116    }
117    program_cache_for_tx_batch.store_modified_entry(*program_id, Arc::new(program_cache_entry));
118    Ok(())
119}
120
121#[macro_export]
122macro_rules! deploy_program {
123    ($invoke_context:expr,
124     $program_id:expr,
125     $loader_key:expr,
126     $programdata:expr,
127     $deployment_slot:expr,
128     $disable_sbpf_v0_v1_v2_deployment:expr $(,)?) => {
129        assert_eq!(
130            $deployment_slot,
131            $invoke_context.program_cache_for_tx_batch.slot()
132        );
133        #[cfg(feature = "metrics")]
134        let mut load_program_metrics = $crate::program_metrics::LoadProgramMetrics::default();
135        $crate::deploy::deploy_program(
136            $invoke_context.get_log_collector(),
137            #[cfg(feature = "metrics")]
138            &mut load_program_metrics,
139            $invoke_context.program_cache_for_tx_batch,
140            $invoke_context
141                .get_program_runtime_environment_for_deployment()
142                .clone(),
143            $disable_sbpf_v0_v1_v2_deployment,
144            $program_id,
145            $loader_key,
146            $programdata,
147            $deployment_slot,
148        )?;
149        #[cfg(feature = "metrics")]
150        load_program_metrics.submit_datapoint(&mut $invoke_context.timings);
151    };
152}
solana_program_runtime/deploy.rs

solana_program_runtime/
deploy.rs
