2021-09-02 21:29:11 -07:00
|
|
|
#[cfg(RUSTC_WITH_SPECIALIZATION)]
|
|
|
|
use solana_frozen_abi::abi_example::AbiExample;
|
2021-12-03 09:00:31 -08:00
|
|
|
use {
|
|
|
|
crate::system_instruction_processor,
|
|
|
|
solana_program_runtime::{
|
|
|
|
invoke_context::{InvokeContext, ProcessInstructionWithContext},
|
|
|
|
stable_log,
|
|
|
|
},
|
|
|
|
solana_sdk::{
|
|
|
|
feature_set, instruction::InstructionError, pubkey::Pubkey, stake, system_program,
|
|
|
|
},
|
|
|
|
std::fmt,
|
|
|
|
};
|
2020-11-12 12:44:37 -08:00
|
|
|
|
|
|
|
fn process_instruction_with_program_logging(
|
|
|
|
process_instruction: ProcessInstructionWithContext,
|
2021-10-08 02:41:07 -07:00
|
|
|
first_instruction_account: usize,
|
2020-11-12 12:44:37 -08:00
|
|
|
instruction_data: &[u8],
|
2021-12-02 09:47:16 -08:00
|
|
|
invoke_context: &mut InvokeContext,
|
2020-11-12 12:44:37 -08:00
|
|
|
) -> Result<(), InstructionError> {
|
2021-11-23 04:23:40 -08:00
|
|
|
let logger = invoke_context.get_log_collector();
|
2022-01-03 14:30:56 -08:00
|
|
|
let program_id = invoke_context.transaction_context.get_program_key()?;
|
2020-11-12 12:44:37 -08:00
|
|
|
stable_log::program_invoke(&logger, program_id, invoke_context.invoke_depth());
|
|
|
|
|
2021-10-10 13:29:18 -07:00
|
|
|
let result = process_instruction(first_instruction_account, instruction_data, invoke_context);
|
2020-11-12 12:44:37 -08:00
|
|
|
|
2022-01-03 14:30:56 -08:00
|
|
|
let program_id = invoke_context.transaction_context.get_program_key()?;
|
2020-11-12 12:44:37 -08:00
|
|
|
match &result {
|
|
|
|
Ok(()) => stable_log::program_success(&logger, program_id),
|
|
|
|
Err(err) => stable_log::program_failure(&logger, program_id, err),
|
|
|
|
}
|
|
|
|
result
|
|
|
|
}
|
|
|
|
|
|
|
|
macro_rules! with_program_logging {
|
|
|
|
($process_instruction:expr) => {
|
2021-10-10 13:29:18 -07:00
|
|
|
|first_instruction_account: usize,
|
2021-10-08 02:41:07 -07:00
|
|
|
instruction_data: &[u8],
|
2021-12-02 09:47:16 -08:00
|
|
|
invoke_context: &mut InvokeContext| {
|
2020-11-12 12:44:37 -08:00
|
|
|
process_instruction_with_program_logging(
|
|
|
|
$process_instruction,
|
2021-10-08 02:41:07 -07:00
|
|
|
first_instruction_account,
|
2020-11-12 12:44:37 -08:00
|
|
|
instruction_data,
|
|
|
|
invoke_context,
|
|
|
|
)
|
|
|
|
}
|
|
|
|
};
|
|
|
|
}
|
2020-08-25 09:49:15 -07:00
|
|
|
|
2021-09-02 21:29:11 -07:00
|
|
|
#[derive(AbiExample, Debug, Clone)]
|
|
|
|
pub enum ActivationType {
|
|
|
|
NewProgram,
|
|
|
|
NewVersion,
|
2021-09-28 23:25:08 -07:00
|
|
|
RemoveProgram,
|
2021-09-02 21:29:11 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Clone)]
|
|
|
|
pub struct Builtin {
|
|
|
|
pub name: String,
|
|
|
|
pub id: Pubkey,
|
|
|
|
pub process_instruction_with_context: ProcessInstructionWithContext,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Builtin {
|
|
|
|
pub fn new(
|
|
|
|
name: &str,
|
|
|
|
id: Pubkey,
|
|
|
|
process_instruction_with_context: ProcessInstructionWithContext,
|
|
|
|
) -> Self {
|
|
|
|
Self {
|
|
|
|
name: name.to_string(),
|
|
|
|
id,
|
|
|
|
process_instruction_with_context,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl fmt::Debug for Builtin {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
write!(f, "Builtin [name={}, id={}]", self.name, self.id)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[cfg(RUSTC_WITH_SPECIALIZATION)]
|
|
|
|
impl AbiExample for Builtin {
|
|
|
|
fn example() -> Self {
|
|
|
|
Self {
|
|
|
|
name: String::default(),
|
|
|
|
id: Pubkey::default(),
|
2021-10-10 13:29:18 -07:00
|
|
|
process_instruction_with_context: |_, _, _| Ok(()),
|
2021-09-02 21:29:11 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Clone, Debug)]
|
|
|
|
pub struct Builtins {
|
|
|
|
/// Builtin programs that are always available
|
|
|
|
pub genesis_builtins: Vec<Builtin>,
|
|
|
|
|
2021-09-28 23:25:08 -07:00
|
|
|
/// Builtin programs activated or deactivated dynamically by feature
|
2021-09-02 21:29:11 -07:00
|
|
|
pub feature_builtins: Vec<(Builtin, Pubkey, ActivationType)>,
|
|
|
|
}
|
|
|
|
|
2020-09-24 12:23:09 -07:00
|
|
|
/// Builtin programs that are always available
|
|
|
|
fn genesis_builtins() -> Vec<Builtin> {
|
|
|
|
vec![
|
|
|
|
Builtin::new(
|
|
|
|
"system_program",
|
|
|
|
system_program::id(),
|
2020-11-12 12:44:37 -08:00
|
|
|
with_program_logging!(system_instruction_processor::process_instruction),
|
2020-09-24 12:23:09 -07:00
|
|
|
),
|
|
|
|
Builtin::new(
|
|
|
|
"vote_program",
|
|
|
|
solana_vote_program::id(),
|
2020-11-12 12:44:37 -08:00
|
|
|
with_program_logging!(solana_vote_program::vote_instruction::process_instruction),
|
2020-09-24 12:23:09 -07:00
|
|
|
),
|
|
|
|
Builtin::new(
|
|
|
|
"stake_program",
|
2021-06-15 09:04:00 -07:00
|
|
|
stake::program::id(),
|
2021-01-25 12:32:33 -08:00
|
|
|
with_program_logging!(solana_stake_program::stake_instruction::process_instruction),
|
2020-09-24 12:23:09 -07:00
|
|
|
),
|
|
|
|
Builtin::new(
|
|
|
|
"config_program",
|
|
|
|
solana_config_program::id(),
|
2020-11-12 12:44:37 -08:00
|
|
|
with_program_logging!(solana_config_program::config_processor::process_instruction),
|
2020-09-24 12:23:09 -07:00
|
|
|
),
|
2021-07-13 16:10:30 -07:00
|
|
|
Builtin::new(
|
|
|
|
"secp256k1_program",
|
|
|
|
solana_sdk::secp256k1_program::id(),
|
2021-09-28 23:25:08 -07:00
|
|
|
dummy_process_instruction,
|
2021-07-13 16:10:30 -07:00
|
|
|
),
|
2020-09-24 12:23:09 -07:00
|
|
|
]
|
2020-08-14 12:32:45 -07:00
|
|
|
}
|
|
|
|
|
2021-09-28 23:25:08 -07:00
|
|
|
/// place holder for secp256k1, remove when the precompile program is deactivated via feature activation
|
|
|
|
fn dummy_process_instruction(
|
2021-10-08 02:41:07 -07:00
|
|
|
_first_instruction_account: usize,
|
2021-09-28 23:25:08 -07:00
|
|
|
_data: &[u8],
|
2021-12-02 09:47:16 -08:00
|
|
|
_invoke_context: &mut InvokeContext,
|
2021-09-28 23:25:08 -07:00
|
|
|
) -> Result<(), InstructionError> {
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
2020-09-24 12:23:09 -07:00
|
|
|
/// Builtin programs activated dynamically by feature
|
2020-11-06 00:08:11 -08:00
|
|
|
///
|
|
|
|
/// Note: If the feature_builtin is intended to replace another builtin program, it must have a new
|
|
|
|
/// name.
|
|
|
|
/// This is to enable the runtime to determine categorically whether the builtin update has
|
|
|
|
/// occurred, and preserve idempotency in Bank::add_native_program across genesis, snapshot, and
|
|
|
|
/// normal child Bank creation.
|
|
|
|
/// https://github.com/solana-labs/solana/blob/84b139cc94b5be7c9e0c18c2ad91743231b85a0d/runtime/src/bank.rs#L1723
|
2020-11-05 07:37:07 -08:00
|
|
|
fn feature_builtins() -> Vec<(Builtin, Pubkey, ActivationType)> {
|
2021-09-03 14:35:38 -07:00
|
|
|
vec![
|
|
|
|
(
|
|
|
|
Builtin::new(
|
|
|
|
"compute_budget_program",
|
|
|
|
solana_sdk::compute_budget::id(),
|
|
|
|
solana_compute_budget_program::process_instruction,
|
|
|
|
),
|
2021-10-26 20:08:59 -07:00
|
|
|
feature_set::add_compute_budget_program::id(),
|
2021-09-03 14:35:38 -07:00
|
|
|
ActivationType::NewProgram,
|
2021-07-16 00:31:22 -07:00
|
|
|
),
|
2021-09-28 23:25:08 -07:00
|
|
|
// TODO when feature `prevent_calling_precompiles_as_programs` is
|
|
|
|
// cleaned up also remove "secp256k1_program" from the main builtins
|
|
|
|
// list
|
2021-09-03 14:35:38 -07:00
|
|
|
(
|
|
|
|
Builtin::new(
|
2021-09-28 23:25:08 -07:00
|
|
|
"secp256k1_program",
|
|
|
|
solana_sdk::secp256k1_program::id(),
|
|
|
|
dummy_process_instruction,
|
2021-09-03 14:35:38 -07:00
|
|
|
),
|
2021-09-28 23:25:08 -07:00
|
|
|
feature_set::prevent_calling_precompiles_as_programs::id(),
|
|
|
|
ActivationType::RemoveProgram,
|
2021-09-03 14:35:38 -07:00
|
|
|
),
|
2021-12-10 13:02:16 -08:00
|
|
|
(
|
|
|
|
Builtin::new(
|
|
|
|
"address_lookup_table_program",
|
|
|
|
solana_address_lookup_table_program::id(),
|
|
|
|
solana_address_lookup_table_program::processor::process_instruction,
|
|
|
|
),
|
|
|
|
feature_set::versioned_tx_message_enabled::id(),
|
|
|
|
ActivationType::NewProgram,
|
|
|
|
),
|
2022-01-04 22:55:26 -08:00
|
|
|
(
|
|
|
|
Builtin::new(
|
|
|
|
"zk_token_proof_program",
|
|
|
|
solana_zk_token_sdk::zk_token_proof_program::id(),
|
|
|
|
with_program_logging!(solana_zk_token_proof_program::process_instruction),
|
|
|
|
),
|
|
|
|
feature_set::zk_token_sdk_enabled::id(),
|
|
|
|
ActivationType::NewProgram,
|
|
|
|
),
|
2021-09-03 14:35:38 -07:00
|
|
|
]
|
2020-09-21 22:36:23 -07:00
|
|
|
}
|
|
|
|
|
2020-09-24 12:23:09 -07:00
|
|
|
pub(crate) fn get() -> Builtins {
|
|
|
|
Builtins {
|
|
|
|
genesis_builtins: genesis_builtins(),
|
|
|
|
feature_builtins: feature_builtins(),
|
2020-08-25 09:49:15 -07:00
|
|
|
}
|
2020-08-14 12:32:45 -07:00
|
|
|
}
|