solana/programs/bpf_loader/src/syscalls.rs

5107 lines
168 KiB
Rust
Raw Normal View History

2021-07-29 10:48:14 -07:00
#[allow(deprecated)]
use {
2022-04-11 16:05:09 -07:00
crate::{allocator_bump::BpfAllocator, BpfError},
solana_program_runtime::{
ic_logger_msg, ic_msg,
invoke_context::{visit_each_account_once, ComputeMeter, InvokeContext},
stable_log,
2021-12-20 20:03:20 -08:00
timings::ExecuteTimings,
},
solana_rbpf::{
aligned_memory::AlignedMemory,
ebpf,
error::EbpfError,
memory_region::{AccessType, MemoryMapping},
question_mark,
vm::{EbpfVm, SyscallObject, SyscallRegistry},
},
solana_sdk::{
account::{ReadableAccount, WritableAccount},
account_info::AccountInfo,
blake3, bpf_loader, bpf_loader_deprecated, bpf_loader_upgradeable,
entrypoint::{BPF_ALIGN_OF_U128, MAX_PERMITTED_DATA_INCREASE, SUCCESS},
feature_set::{
2022-04-11 16:05:09 -07:00
add_get_processed_sibling_instruction_syscall, blake3_syscall_enabled,
check_physical_overlapping, check_slice_translation_size, curve25519_syscall_enabled,
disable_fees_sysvar, do_support_realloc, executables_incur_cpi_data_cost,
fixed_memcpy_nonoverlapping_check, libsecp256k1_0_5_upgrade_enabled,
limit_secp256k1_recovery_id, prevent_calling_precompiles_as_programs,
return_data_syscall_enabled, secp256k1_recover_syscall_enabled,
sol_log_data_syscall_enabled, syscall_saturated_math, update_syscall_base_costs,
zk_token_sdk_enabled,
},
hash::{Hasher, HASH_BYTES},
instruction::{
AccountMeta, Instruction, InstructionError, ProcessedSiblingInstruction,
TRANSACTION_LEVEL_STACK_HEIGHT,
},
keccak, native_loader,
precompiles::is_precompile,
program::MAX_RETURN_DATA,
program_stubs::is_nonoverlapping,
pubkey::{Pubkey, PubkeyError, MAX_SEEDS, MAX_SEED_LEN},
secp256k1_recover::{
Secp256k1RecoverError, SECP256K1_PUBLIC_KEY_LENGTH, SECP256K1_SIGNATURE_LENGTH,
},
sysvar::{Sysvar, SysvarId},
transaction_context::InstructionAccount,
},
std::{
alloc::Layout,
2021-12-15 14:19:47 -08:00
cell::{Ref, RefCell, RefMut},
mem::{align_of, size_of},
rc::Rc,
slice::from_raw_parts_mut,
str::{from_utf8, Utf8Error},
sync::Arc,
},
thiserror::Error as ThisError,
2020-01-09 23:58:13 -08:00
};
2020-12-09 02:14:53 -08:00
/// Maximum signers
pub const MAX_SIGNERS: usize = 16;
/// Error definitions
#[derive(Debug, ThisError, PartialEq)]
pub enum SyscallError {
#[error("{0}: {1:?}")]
InvalidString(Utf8Error, Vec<u8>),
#[error("BPF program panicked")]
Abort,
#[error("BPF program Panicked in {0} at {1}:{2}")]
Panic(String, u64, u64),
#[error("Cannot borrow invoke context")]
2020-04-28 14:33:56 -07:00
InvokeContextBorrowFailed,
#[error("Malformed signer seed: {0}: {1:?}")]
2020-04-28 14:33:56 -07:00
MalformedSignerSeed(Utf8Error, Vec<u8>),
#[error("Could not create program address with signer seeds: {0}")]
BadSeeds(PubkeyError),
2021-02-01 11:40:49 -08:00
#[error("Program {0} not supported by inner instructions")]
ProgramNotSupported(Pubkey),
#[error("{0}")]
InstructionError(InstructionError),
#[error("Unaligned pointer")]
UnalignedPointer,
2020-12-09 02:14:53 -08:00
#[error("Too many signers")]
TooManySigners,
2021-02-01 11:40:49 -08:00
#[error("Instruction passed to inner instruction is too large ({0} > {1})")]
InstructionTooLarge(usize, usize),
#[error("Too many accounts passed to inner instruction")]
TooManyAccounts,
2021-06-01 15:33:17 -07:00
#[error("Overlapping copy")]
CopyOverlapping,
#[error("Return data too large ({0} > {1})")]
ReturnDataTooLarge(u64, u64),
#[error("Hashing too many sequences")]
TooManySlices,
2022-03-10 11:48:33 -08:00
#[error("InvalidLength")]
InvalidLength,
}
2021-02-18 23:42:09 -08:00
impl From<SyscallError> for EbpfError<BpfError> {
fn from(error: SyscallError) -> Self {
EbpfError::UserError(error.into())
}
}
trait SyscallConsume {
2021-02-18 23:42:09 -08:00
fn consume(&mut self, amount: u64) -> Result<(), EbpfError<BpfError>>;
}
impl SyscallConsume for Rc<RefCell<ComputeMeter>> {
2021-02-18 23:42:09 -08:00
fn consume(&mut self, amount: u64) -> Result<(), EbpfError<BpfError>> {
self.try_borrow_mut()
.map_err(|_| SyscallError::InvokeContextBorrowFailed)?
.consume(amount)
.map_err(SyscallError::InstructionError)?;
Ok(())
}
}
macro_rules! register_feature_gated_syscall {
($syscall_registry:expr, $is_feature_active:expr, $name:expr, $init:expr, $call:expr $(,)?) => {
if $is_feature_active {
$syscall_registry.register_syscall_by_name($name, $init, $call)
} else {
Ok(())
}
};
}
pub fn register_syscalls(
invoke_context: &mut InvokeContext,
2021-02-18 23:42:09 -08:00
) -> Result<SyscallRegistry, EbpfError<BpfError>> {
let secp256k1_recover_syscall_enabled = invoke_context
.feature_set
.is_active(&secp256k1_recover_syscall_enabled::id());
let blake3_syscall_enabled = invoke_context
.feature_set
.is_active(&blake3_syscall_enabled::id());
let zk_token_sdk_enabled = invoke_context
.feature_set
.is_active(&zk_token_sdk_enabled::id());
let curve25519_syscall_enabled = invoke_context
.feature_set
.is_active(&curve25519_syscall_enabled::id());
let disable_fees_sysvar = invoke_context
.feature_set
.is_active(&disable_fees_sysvar::id());
let return_data_syscall_enabled = invoke_context
.feature_set
.is_active(&return_data_syscall_enabled::id());
let sol_log_data_syscall_enabled = invoke_context
.feature_set
.is_active(&sol_log_data_syscall_enabled::id());
let add_get_processed_sibling_instruction_syscall = invoke_context
.feature_set
.is_active(&add_get_processed_sibling_instruction_syscall::id());
let mut syscall_registry = SyscallRegistry::default();
// Abort
syscall_registry.register_syscall_by_name(b"abort", SyscallAbort::init, SyscallAbort::call)?;
// Panic
syscall_registry.register_syscall_by_name(
b"sol_panic_",
SyscallPanic::init,
SyscallPanic::call,
)?;
// Logging
syscall_registry.register_syscall_by_name(b"sol_log_", SyscallLog::init, SyscallLog::call)?;
syscall_registry.register_syscall_by_name(
b"sol_log_64_",
SyscallLogU64::init,
SyscallLogU64::call,
)?;
syscall_registry.register_syscall_by_name(
b"sol_log_compute_units_",
SyscallLogBpfComputeUnits::init,
SyscallLogBpfComputeUnits::call,
)?;
syscall_registry.register_syscall_by_name(
b"sol_log_pubkey",
SyscallLogPubkey::init,
SyscallLogPubkey::call,
)?;
// Program defined addresses (PDA)
syscall_registry.register_syscall_by_name(
b"sol_create_program_address",
SyscallCreateProgramAddress::init,
SyscallCreateProgramAddress::call,
)?;
2021-02-18 09:56:11 -08:00
syscall_registry.register_syscall_by_name(
b"sol_try_find_program_address",
SyscallTryFindProgramAddress::init,
2021-02-18 09:56:11 -08:00
SyscallTryFindProgramAddress::call,
)?;
2021-03-30 12:16:21 -07:00
// Sha256
syscall_registry.register_syscall_by_name(
b"sol_sha256",
SyscallSha256::init,
SyscallSha256::call,
)?;
// Keccak256
syscall_registry.register_syscall_by_name(
b"sol_keccak256",
SyscallKeccak256::init,
SyscallKeccak256::call,
)?;
2021-06-08 11:04:10 -07:00
// Secp256k1 Recover
register_feature_gated_syscall!(
syscall_registry,
secp256k1_recover_syscall_enabled,
b"sol_secp256k1_recover",
SyscallSecp256k1Recover::init,
SyscallSecp256k1Recover::call,
)?;
// Blake3
register_feature_gated_syscall!(
syscall_registry,
blake3_syscall_enabled,
b"sol_blake3",
SyscallBlake3::init,
SyscallBlake3::call,
)?;
// ZK Token
register_feature_gated_syscall!(
syscall_registry,
zk_token_sdk_enabled,
b"sol_zk_token_elgamal_op",
SyscallZkTokenElgamalOp::init,
SyscallZkTokenElgamalOp::call,
)?;
register_feature_gated_syscall!(
syscall_registry,
zk_token_sdk_enabled,
b"sol_zk_token_elgamal_op_with_lo_hi",
SyscallZkTokenElgamalOpWithLoHi::init,
SyscallZkTokenElgamalOpWithLoHi::call,
)?;
register_feature_gated_syscall!(
syscall_registry,
zk_token_sdk_enabled,
b"sol_zk_token_elgamal_op_with_scalar",
SyscallZkTokenElgamalOpWithScalar::init,
SyscallZkTokenElgamalOpWithScalar::call,
)?;
// Elliptic Curve Point Validation
//
// TODO: add group operations and multiscalar multiplications
register_feature_gated_syscall!(
syscall_registry,
curve25519_syscall_enabled,
b"sol_curve25519_point_validation",
SyscallCurvePointValidation::init,
SyscallCurvePointValidation::call,
)?;
register_feature_gated_syscall!(
syscall_registry,
curve25519_syscall_enabled,
b"sol_curve25519_point_validation",
SyscallCurveGroupOps::init,
SyscallCurveGroupOps::call,
)?;
// Sysvars
syscall_registry.register_syscall_by_name(
b"sol_get_clock_sysvar",
SyscallGetClockSysvar::init,
SyscallGetClockSysvar::call,
)?;
2021-07-29 15:03:00 -07:00
syscall_registry.register_syscall_by_name(
b"sol_get_epoch_schedule_sysvar",
SyscallGetEpochScheduleSysvar::init,
2021-07-29 15:03:00 -07:00
SyscallGetEpochScheduleSysvar::call,
)?;
register_feature_gated_syscall!(
syscall_registry,
!disable_fees_sysvar,
b"sol_get_fees_sysvar",
SyscallGetFeesSysvar::init,
SyscallGetFeesSysvar::call,
)?;
syscall_registry.register_syscall_by_name(
b"sol_get_rent_sysvar",
SyscallGetRentSysvar::init,
SyscallGetRentSysvar::call,
)?;
2021-04-12 16:04:57 -07:00
// Memory ops
syscall_registry.register_syscall_by_name(
b"sol_memcpy_",
SyscallMemcpy::init,
SyscallMemcpy::call,
)?;
syscall_registry.register_syscall_by_name(
b"sol_memmove_",
SyscallMemmove::init,
SyscallMemmove::call,
)?;
syscall_registry.register_syscall_by_name(
b"sol_memcmp_",
SyscallMemcmp::init,
SyscallMemcmp::call,
)?;
syscall_registry.register_syscall_by_name(
b"sol_memset_",
SyscallMemset::init,
SyscallMemset::call,
)?;
2021-06-01 15:33:17 -07:00
// Cross-program invocation
syscall_registry.register_syscall_by_name(
b"sol_invoke_signed_c",
SyscallInvokeSignedC::init,
SyscallInvokeSignedC::call,
)?;
syscall_registry.register_syscall_by_name(
b"sol_invoke_signed_rust",
SyscallInvokeSignedRust::init,
SyscallInvokeSignedRust::call,
)?;
2021-06-01 15:33:17 -07:00
// Memory allocator
syscall_registry.register_syscall_by_name(
b"sol_alloc_free_",
SyscallAllocFree::init,
SyscallAllocFree::call,
)?;
// Return data
register_feature_gated_syscall!(
syscall_registry,
return_data_syscall_enabled,
b"sol_set_return_data",
SyscallSetReturnData::init,
SyscallSetReturnData::call,
)?;
register_feature_gated_syscall!(
syscall_registry,
return_data_syscall_enabled,
b"sol_get_return_data",
SyscallGetReturnData::init,
SyscallGetReturnData::call,
)?;
// Log data
register_feature_gated_syscall!(
syscall_registry,
sol_log_data_syscall_enabled,
b"sol_log_data",
SyscallLogData::init,
SyscallLogData::call,
)?;
// Processed sibling instructions
register_feature_gated_syscall!(
syscall_registry,
add_get_processed_sibling_instruction_syscall,
b"sol_get_processed_sibling_instruction",
SyscallGetProcessedSiblingInstruction::init,
SyscallGetProcessedSiblingInstruction::call,
)?;
// Stack height
register_feature_gated_syscall!(
syscall_registry,
add_get_processed_sibling_instruction_syscall,
b"sol_get_stack_height",
SyscallGetStackHeight::init,
SyscallGetStackHeight::call,
)?;
Ok(syscall_registry)
}
pub fn bind_syscall_context_objects<'a, 'b>(
2021-02-18 23:42:09 -08:00
vm: &mut EbpfVm<'a, BpfError, crate::ThisInstructionMeter>,
invoke_context: &'a mut InvokeContext<'b>,
heap: AlignedMemory,
2021-02-18 23:42:09 -08:00
) -> Result<(), EbpfError<BpfError>> {
2022-04-11 16:05:09 -07:00
invoke_context.set_check_aligned(
bpf_loader_deprecated::id()
!= invoke_context
.transaction_context
.get_current_instruction_context()
.and_then(|instruction_context| {
instruction_context
.try_borrow_program_account(invoke_context.transaction_context)
})
.map(|program_account| *program_account.get_owner())
.map_err(SyscallError::InstructionError)?,
);
invoke_context.set_check_size(
invoke_context
.feature_set
.is_active(&check_slice_translation_size::id()),
);
invoke_context
.set_allocator(Rc::new(RefCell::new(BpfAllocator::new(
heap,
ebpf::MM_HEAP_START,
))))
.map_err(SyscallError::InstructionError)?;
let invoke_context = Rc::new(RefCell::new(invoke_context));
2022-04-30 01:58:12 -07:00
vm.bind_syscall_context_objects(invoke_context)?;
Ok(())
}
fn translate(
memory_mapping: &MemoryMapping,
access_type: AccessType,
vm_addr: u64,
len: u64,
2021-02-18 23:42:09 -08:00
) -> Result<u64, EbpfError<BpfError>> {
memory_mapping.map::<BpfError>(access_type, vm_addr, len)
}
fn translate_type_inner<'a, T>(
memory_mapping: &MemoryMapping,
access_type: AccessType,
vm_addr: u64,
check_aligned: bool,
2021-02-18 23:42:09 -08:00
) -> Result<&'a mut T, EbpfError<BpfError>> {
let host_addr = translate(memory_mapping, access_type, vm_addr, size_of::<T>() as u64)?;
if check_aligned && (host_addr as *mut T as usize).wrapping_rem(align_of::<T>()) != 0 {
return Err(SyscallError::UnalignedPointer.into());
}
Ok(unsafe { &mut *(host_addr as *mut T) })
}
fn translate_type_mut<'a, T>(
memory_mapping: &MemoryMapping,
vm_addr: u64,
check_aligned: bool,
2021-02-18 23:42:09 -08:00
) -> Result<&'a mut T, EbpfError<BpfError>> {
translate_type_inner::<T>(memory_mapping, AccessType::Store, vm_addr, check_aligned)
}
fn translate_type<'a, T>(
memory_mapping: &MemoryMapping,
vm_addr: u64,
check_aligned: bool,
2021-02-18 23:42:09 -08:00
) -> Result<&'a T, EbpfError<BpfError>> {
translate_type_inner::<T>(memory_mapping, AccessType::Load, vm_addr, check_aligned)
2021-09-17 09:46:49 -07:00
.map(|value| &*value)
}
fn translate_slice_inner<'a, T>(
memory_mapping: &MemoryMapping,
access_type: AccessType,
vm_addr: u64,
len: u64,
check_aligned: bool,
check_size: bool,
2021-02-18 23:42:09 -08:00
) -> Result<&'a mut [T], EbpfError<BpfError>> {
if len == 0 {
return Ok(&mut []);
}
let total_size = len.saturating_mul(size_of::<T>() as u64);
if check_size & isize::try_from(total_size).is_err() {
return Err(SyscallError::InvalidLength.into());
}
let host_addr = translate(memory_mapping, access_type, vm_addr, total_size)?;
if check_aligned && (host_addr as *mut T as usize).wrapping_rem(align_of::<T>()) != 0 {
return Err(SyscallError::UnalignedPointer.into());
}
Ok(unsafe { from_raw_parts_mut(host_addr as *mut T, len as usize) })
}
fn translate_slice_mut<'a, T>(
memory_mapping: &MemoryMapping,
vm_addr: u64,
len: u64,
check_aligned: bool,
check_size: bool,
2021-02-18 23:42:09 -08:00
) -> Result<&'a mut [T], EbpfError<BpfError>> {
translate_slice_inner::<T>(
memory_mapping,
AccessType::Store,
vm_addr,
len,
check_aligned,
check_size,
)
}
fn translate_slice<'a, T>(
memory_mapping: &MemoryMapping,
vm_addr: u64,
len: u64,
check_aligned: bool,
check_size: bool,
2021-02-18 23:42:09 -08:00
) -> Result<&'a [T], EbpfError<BpfError>> {
translate_slice_inner::<T>(
memory_mapping,
AccessType::Load,
vm_addr,
len,
check_aligned,
check_size,
)
.map(|value| &*value)
}
/// Take a virtual pointer to a string (points to BPF VM memory space), translate it
/// pass it to a user-defined work function
fn translate_string_and_do(
memory_mapping: &MemoryMapping,
addr: u64,
len: u64,
check_aligned: bool,
check_size: bool,
2021-02-18 23:42:09 -08:00
work: &mut dyn FnMut(&str) -> Result<u64, EbpfError<BpfError>>,
) -> Result<u64, EbpfError<BpfError>> {
let buf = translate_slice::<u8>(memory_mapping, addr, len, check_aligned, check_size)?;
let i = match buf.iter().position(|byte| *byte == 0) {
Some(i) => i,
None => len as usize,
};
2022-03-10 11:48:33 -08:00
let msg = buf.get(..i).ok_or(SyscallError::InvalidLength)?;
match from_utf8(msg) {
Ok(message) => work(message),
2022-03-10 11:48:33 -08:00
Err(err) => Err(SyscallError::InvalidString(err, msg.to_vec()).into()),
}
}
type SyscallContext<'a, 'b> = Rc<RefCell<&'a mut InvokeContext<'b>>>;
macro_rules! declare_syscall {
($(#[$attr:meta])* $name:ident, $call:item) => {
$(#[$attr])*
pub struct $name<'a, 'b> {
invoke_context: SyscallContext<'a, 'b>,
}
impl<'a, 'b> $name<'a, 'b> {
pub fn init(
invoke_context: SyscallContext<'a, 'b>,
) -> Box<(dyn SyscallObject<BpfError> + 'a)> {
Box::new(Self { invoke_context })
}
}
impl<'a, 'b> SyscallObject<BpfError> for $name<'a, 'b> {
$call
}
};
2022-04-11 16:05:09 -07:00
}
declare_syscall!(
/// Abort syscall functions, called when the BPF program calls `abort()`
/// LLVM will insert calls to `abort()` if it detects an untenable situation,
/// `abort()` is not intended to be called explicitly by the program.
/// Causes the BPF program to be halted immediately
SyscallAbort,
fn call(
&mut self,
_arg1: u64,
_arg2: u64,
_arg3: u64,
_arg4: u64,
_arg5: u64,
_memory_mapping: &MemoryMapping,
2021-02-18 23:42:09 -08:00
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let _ = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
*result = Err(SyscallError::Abort.into());
}
);
declare_syscall!(
/// Panic syscall function, called when the BPF program calls 'sol_panic_()`
/// Causes the BPF program to be halted immediately
SyscallPanic,
fn call(
&mut self,
file: u64,
len: u64,
line: u64,
column: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
2021-02-18 23:42:09 -08:00
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
2021-12-15 14:19:47 -08:00
if !invoke_context
.feature_set
.is_active(&update_syscall_base_costs::id())
{
question_mark!(invoke_context.get_compute_meter().consume(len), result);
}
*result = translate_string_and_do(
memory_mapping,
file,
len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
&mut |string: &str| Err(SyscallError::Panic(string.to_string(), line, column).into()),
);
}
);
declare_syscall!(
/// Log a user's info message
SyscallLog,
fn call(
&mut self,
addr: u64,
len: u64,
_arg3: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
2021-02-18 23:42:09 -08:00
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
2021-12-15 14:19:47 -08:00
let cost = if invoke_context
.feature_set
.is_active(&update_syscall_base_costs::id())
{
invoke_context
.get_compute_budget()
.syscall_base_cost
.max(len)
} else {
len
};
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
question_mark!(
translate_string_and_do(
memory_mapping,
addr,
len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
&mut |string: &str| {
stable_log::program_log(&invoke_context.get_log_collector(), string);
Ok(0)
}
),
result
);
*result = Ok(0);
}
);
2019-08-23 11:03:53 -07:00
declare_syscall!(
/// Log 5 64-bit values
SyscallLogU64,
fn call(
&mut self,
arg1: u64,
arg2: u64,
arg3: u64,
arg4: u64,
arg5: u64,
_memory_mapping: &MemoryMapping,
2021-02-18 23:42:09 -08:00
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let cost = invoke_context.get_compute_budget().log_64_units;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
stable_log::program_log(
&invoke_context.get_log_collector(),
&format!(
"{:#x}, {:#x}, {:#x}, {:#x}, {:#x}",
arg1, arg2, arg3, arg4, arg5
),
);
*result = Ok(0);
2019-09-30 14:21:29 -07:00
}
);
declare_syscall!(
/// Log current compute consumption
SyscallLogBpfComputeUnits,
2020-10-28 12:39:48 -07:00
fn call(
&mut self,
_arg1: u64,
_arg2: u64,
_arg3: u64,
_arg4: u64,
_arg5: u64,
_memory_mapping: &MemoryMapping,
2021-02-18 23:42:09 -08:00
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
2021-12-15 14:19:47 -08:00
let cost = if invoke_context
.feature_set
.is_active(&update_syscall_base_costs::id())
{
invoke_context.get_compute_budget().syscall_base_cost
} else {
0
};
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
ic_logger_msg!(
invoke_context.get_log_collector(),
"Program consumption: {} units remaining",
invoke_context.get_compute_meter().borrow().get_remaining()
);
*result = Ok(0);
2020-10-28 12:39:48 -07:00
}
);
2020-10-28 12:39:48 -07:00
declare_syscall!(
/// Log 5 64-bit values
SyscallLogPubkey,
2020-10-15 09:11:54 -07:00
fn call(
&mut self,
pubkey_addr: u64,
_arg2: u64,
_arg3: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
2021-02-18 23:42:09 -08:00
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let cost = invoke_context.get_compute_budget().log_pubkey_units;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let pubkey = question_mark!(
2022-04-11 16:05:09 -07:00
translate_type::<Pubkey>(
memory_mapping,
pubkey_addr,
invoke_context.get_check_aligned()
),
result
);
stable_log::program_log(&invoke_context.get_log_collector(), &pubkey.to_string());
*result = Ok(0);
2020-10-15 09:11:54 -07:00
}
);
declare_syscall!(
/// Dynamic memory allocation syscall called when the BPF program calls
/// `sol_alloc_free_()`. The allocator is expected to allocate/free
/// from/to a given chunk of memory and enforce size restrictions. The
/// memory chunk is given to the allocator during allocator creation and
/// information about that memory (start address and size) is passed
/// to the VM to use for enforcement.
SyscallAllocFree,
fn call(
&mut self,
size: u64,
free_addr: u64,
_arg3: u64,
_arg4: u64,
_arg5: u64,
_memory_mapping: &MemoryMapping,
2021-02-18 23:42:09 -08:00
result: &mut Result<u64, EbpfError<BpfError>>,
) {
2022-04-11 16:05:09 -07:00
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let allocator = question_mark!(
invoke_context
.get_allocator()
.map_err(SyscallError::InstructionError),
result
);
let mut allocator = question_mark!(
allocator
.try_borrow_mut()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let align = if invoke_context.get_check_aligned() {
2021-11-30 10:41:15 -08:00
BPF_ALIGN_OF_U128
2020-08-24 13:21:34 -07:00
} else {
align_of::<u8>()
};
let layout = match Layout::from_size_align(size as usize, align) {
2020-08-17 09:49:21 -07:00
Ok(layout) => layout,
Err(_) => {
*result = Ok(0);
return;
}
2020-08-17 09:49:21 -07:00
};
*result = if free_addr == 0 {
2022-04-11 16:05:09 -07:00
match allocator.alloc(layout) {
Ok(addr) => Ok(addr as u64),
Err(_) => Ok(0),
}
} else {
2022-04-11 16:05:09 -07:00
allocator.dealloc(free_addr, layout);
Ok(0)
};
}
);
2020-04-18 17:04:13 -07:00
fn translate_and_check_program_address_inputs<'a>(
seeds_addr: u64,
seeds_len: u64,
program_id_addr: u64,
memory_mapping: &MemoryMapping,
check_aligned: bool,
check_size: bool,
2021-02-18 23:42:09 -08:00
) -> Result<(Vec<&'a [u8]>, &'a Pubkey), EbpfError<BpfError>> {
let untranslated_seeds = translate_slice::<&[&u8]>(
memory_mapping,
seeds_addr,
seeds_len,
check_aligned,
check_size,
)?;
if untranslated_seeds.len() > MAX_SEEDS {
return Err(SyscallError::BadSeeds(PubkeyError::MaxSeedLengthExceeded).into());
}
let seeds = untranslated_seeds
.iter()
.map(|untranslated_seed| {
2021-10-28 09:04:03 -07:00
if untranslated_seed.len() > MAX_SEED_LEN {
return Err(SyscallError::BadSeeds(PubkeyError::MaxSeedLengthExceeded).into());
}
translate_slice::<u8>(
memory_mapping,
untranslated_seed.as_ptr() as *const _ as u64,
untranslated_seed.len() as u64,
check_aligned,
check_size,
)
})
2021-02-18 23:42:09 -08:00
.collect::<Result<Vec<_>, EbpfError<BpfError>>>()?;
let program_id = translate_type::<Pubkey>(memory_mapping, program_id_addr, check_aligned)?;
Ok((seeds, program_id))
}
declare_syscall!(
/// Create a program address
SyscallCreateProgramAddress,
fn call(
&mut self,
seeds_addr: u64,
seeds_len: u64,
program_id_addr: u64,
address_addr: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
2021-02-18 23:42:09 -08:00
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let cost = invoke_context
.get_compute_budget()
.create_program_address_units;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let (seeds, program_id) = question_mark!(
translate_and_check_program_address_inputs(
seeds_addr,
seeds_len,
program_id_addr,
memory_mapping,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size()
),
result
);
let new_address = match Pubkey::create_program_address(&seeds, program_id) {
Ok(address) => address,
Err(_) => {
*result = Ok(1);
return;
}
};
let address = question_mark!(
translate_slice_mut::<u8>(
memory_mapping,
address_addr,
32,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
address.copy_from_slice(new_address.as_ref());
*result = Ok(0);
}
);
declare_syscall!(
/// Create a program address
SyscallTryFindProgramAddress,
fn call(
&mut self,
seeds_addr: u64,
seeds_len: u64,
program_id_addr: u64,
address_addr: u64,
bump_seed_addr: u64,
memory_mapping: &MemoryMapping,
2021-02-18 23:42:09 -08:00
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let cost = invoke_context
.get_compute_budget()
.create_program_address_units;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let (seeds, program_id) = question_mark!(
translate_and_check_program_address_inputs(
seeds_addr,
seeds_len,
program_id_addr,
memory_mapping,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size()
),
result
);
let mut bump_seed = [std::u8::MAX];
for _ in 0..std::u8::MAX {
{
let mut seeds_with_bump = seeds.to_vec();
seeds_with_bump.push(&bump_seed);
2021-10-28 09:04:03 -07:00
if let Ok(new_address) =
Pubkey::create_program_address(&seeds_with_bump, program_id)
{
let bump_seed_ref = question_mark!(
translate_type_mut::<u8>(
memory_mapping,
bump_seed_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned()
),
2021-10-28 09:04:03 -07:00
result
);
let address = question_mark!(
translate_slice_mut::<u8>(
memory_mapping,
address_addr,
32,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
2021-10-28 09:04:03 -07:00
result
);
*bump_seed_ref = bump_seed[0];
address.copy_from_slice(new_address.as_ref());
*result = Ok(0);
return;
}
}
2022-03-02 14:50:16 -08:00
bump_seed[0] = bump_seed[0].saturating_sub(1);
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
}
*result = Ok(1);
}
);
declare_syscall!(
/// SHA256
SyscallSha256,
2020-09-29 23:29:20 -07:00
fn call(
&mut self,
vals_addr: u64,
vals_len: u64,
result_addr: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
2021-02-18 23:42:09 -08:00
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
2021-12-15 14:19:47 -08:00
let compute_budget = invoke_context.get_compute_budget();
if invoke_context
.feature_set
.is_active(&update_syscall_base_costs::id())
&& compute_budget.sha256_max_slices < vals_len
{
ic_msg!(
invoke_context,
"Sha256 hashing {} sequences in one syscall is over the limit {}",
vals_len,
compute_budget.sha256_max_slices,
);
*result = Err(SyscallError::TooManySlices.into());
return;
}
question_mark!(
2021-12-15 14:19:47 -08:00
invoke_context
.get_compute_meter()
.consume(compute_budget.sha256_base_cost),
result
);
let hash_result = question_mark!(
translate_slice_mut::<u8>(
memory_mapping,
result_addr,
HASH_BYTES as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
let mut hasher = Hasher::default();
if vals_len > 0 {
let vals = question_mark!(
translate_slice::<&[u8]>(
memory_mapping,
vals_addr,
vals_len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
for val in vals.iter() {
let bytes = question_mark!(
translate_slice::<u8>(
memory_mapping,
val.as_ptr() as u64,
val.len() as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
let cost = if invoke_context
.feature_set
.is_active(&update_syscall_base_costs::id())
{
compute_budget.mem_op_base_cost.max(
compute_budget
.sha256_byte_cost
2022-03-02 14:50:16 -08:00
.saturating_mul((val.len() as u64).saturating_div(2)),
)
} else {
2022-03-02 14:50:16 -08:00
compute_budget
.sha256_byte_cost
.saturating_mul((val.len() as u64).saturating_div(2))
};
2021-12-15 14:19:47 -08:00
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
2020-09-29 23:29:20 -07:00
hasher.hash(bytes);
}
}
hash_result.copy_from_slice(&hasher.result().to_bytes());
*result = Ok(0);
2020-09-29 23:29:20 -07:00
}
);
2020-09-29 23:29:20 -07:00
fn get_sysvar<T: std::fmt::Debug + Sysvar + SysvarId + Clone>(
sysvar: Result<Arc<T>, InstructionError>,
2021-04-12 16:04:57 -07:00
var_addr: u64,
check_aligned: bool,
2021-04-12 16:04:57 -07:00
memory_mapping: &MemoryMapping,
invoke_context: &mut InvokeContext,
2021-04-12 16:04:57 -07:00
) -> Result<u64, EbpfError<BpfError>> {
2022-03-02 14:50:16 -08:00
invoke_context.get_compute_meter().consume(
invoke_context
.get_compute_budget()
.sysvar_base_cost
.saturating_add(size_of::<T>() as u64),
)?;
let var = translate_type_mut::<T>(memory_mapping, var_addr, check_aligned)?;
2021-04-12 16:04:57 -07:00
let sysvar: Arc<T> = sysvar.map_err(SyscallError::InstructionError)?;
*var = T::clone(sysvar.as_ref());
2021-04-12 16:04:57 -07:00
Ok(SUCCESS)
}
declare_syscall!(
/// Get a Clock sysvar
SyscallGetClockSysvar,
2021-04-12 16:04:57 -07:00
fn call(
&mut self,
var_addr: u64,
_arg2: u64,
_arg3: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let mut invoke_context = question_mark!(
self.invoke_context
.try_borrow_mut()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
*result = get_sysvar(
invoke_context.get_sysvar_cache().get_clock(),
2021-04-12 16:04:57 -07:00
var_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
2021-04-12 16:04:57 -07:00
memory_mapping,
&mut invoke_context,
2021-04-12 16:04:57 -07:00
);
}
);
declare_syscall!(
/// Get a EpochSchedule sysvar
SyscallGetEpochScheduleSysvar,
2021-04-12 16:04:57 -07:00
fn call(
&mut self,
var_addr: u64,
_arg2: u64,
_arg3: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let mut invoke_context = question_mark!(
self.invoke_context
.try_borrow_mut()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
*result = get_sysvar(
invoke_context.get_sysvar_cache().get_epoch_schedule(),
2021-04-12 16:04:57 -07:00
var_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
2021-04-12 16:04:57 -07:00
memory_mapping,
&mut invoke_context,
2021-04-12 16:04:57 -07:00
);
}
);
declare_syscall!(
/// Get a Fees sysvar
SyscallGetFeesSysvar,
2021-04-12 16:04:57 -07:00
fn call(
&mut self,
var_addr: u64,
_arg2: u64,
_arg3: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let mut invoke_context = question_mark!(
self.invoke_context
.try_borrow_mut()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
#[allow(deprecated)]
{
*result = get_sysvar(
invoke_context.get_sysvar_cache().get_fees(),
var_addr,
invoke_context.get_check_aligned(),
memory_mapping,
&mut invoke_context,
);
}
}
);
declare_syscall!(
/// Get a Rent sysvar
SyscallGetRentSysvar,
2021-04-12 16:04:57 -07:00
fn call(
&mut self,
var_addr: u64,
_arg2: u64,
_arg3: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let mut invoke_context = question_mark!(
self.invoke_context
.try_borrow_mut()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
*result = get_sysvar(
invoke_context.get_sysvar_cache().get_rent(),
2021-04-12 16:04:57 -07:00
var_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
2021-04-12 16:04:57 -07:00
memory_mapping,
&mut invoke_context,
2021-04-12 16:04:57 -07:00
);
}
);
2021-04-12 16:04:57 -07:00
declare_syscall!(
// Keccak256
SyscallKeccak256,
fn call(
&mut self,
vals_addr: u64,
vals_len: u64,
result_addr: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
2021-12-15 14:19:47 -08:00
let compute_budget = invoke_context.get_compute_budget();
if invoke_context
.feature_set
.is_active(&update_syscall_base_costs::id())
&& compute_budget.sha256_max_slices < vals_len
{
ic_msg!(
invoke_context,
"Keccak256 hashing {} sequences in one syscall is over the limit {}",
vals_len,
compute_budget.sha256_max_slices,
);
*result = Err(SyscallError::TooManySlices.into());
return;
}
question_mark!(
2021-12-15 14:19:47 -08:00
invoke_context
.get_compute_meter()
.consume(compute_budget.sha256_base_cost),
result
);
let hash_result = question_mark!(
translate_slice_mut::<u8>(
memory_mapping,
result_addr,
keccak::HASH_BYTES as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
let mut hasher = keccak::Hasher::default();
if vals_len > 0 {
let vals = question_mark!(
translate_slice::<&[u8]>(
memory_mapping,
vals_addr,
vals_len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
for val in vals.iter() {
let bytes = question_mark!(
translate_slice::<u8>(
memory_mapping,
val.as_ptr() as u64,
val.len() as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
let cost = if invoke_context
.feature_set
.is_active(&update_syscall_base_costs::id())
{
compute_budget.mem_op_base_cost.max(
compute_budget
.sha256_byte_cost
2022-03-02 14:50:16 -08:00
.saturating_mul((val.len() as u64).saturating_div(2)),
)
} else {
2022-03-02 14:50:16 -08:00
compute_budget
.sha256_byte_cost
.saturating_mul((val.len() as u64).saturating_div(2))
};
2021-12-15 14:19:47 -08:00
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
hasher.hash(bytes);
}
}
hash_result.copy_from_slice(&hasher.result().to_bytes());
*result = Ok(0);
}
);
/// This function is incorrect due to arithmetic overflow and only exists for
/// backwards compatibility. Instead use program_stubs::is_nonoverlapping.
#[allow(clippy::integer_arithmetic)]
fn check_overlapping_do_not_use(src_addr: u64, dst_addr: u64, n: u64) -> bool {
(src_addr <= dst_addr && src_addr + n > dst_addr)
|| (dst_addr <= src_addr && dst_addr + n > src_addr)
2021-08-16 16:16:52 -07:00
}
2021-12-15 14:19:47 -08:00
fn mem_op_consume<'a, 'b>(
invoke_context: &Ref<&'a mut InvokeContext<'b>>,
n: u64,
) -> Result<(), EbpfError<BpfError>> {
let compute_budget = invoke_context.get_compute_budget();
let cost = if invoke_context
.feature_set
.is_active(&update_syscall_base_costs::id())
{
compute_budget
.mem_op_base_cost
2022-03-02 14:50:16 -08:00
.max(n.saturating_div(compute_budget.cpi_bytes_per_unit))
2021-12-15 14:19:47 -08:00
} else {
2022-03-02 14:50:16 -08:00
n.saturating_div(compute_budget.cpi_bytes_per_unit)
2021-12-15 14:19:47 -08:00
};
invoke_context.get_compute_meter().consume(cost)
}
declare_syscall!(
/// memcpy
SyscallMemcpy,
2021-06-01 15:33:17 -07:00
fn call(
&mut self,
dst_addr: u64,
src_addr: u64,
n: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
2021-12-15 14:19:47 -08:00
// When deprecating `update_syscall_base_costs` switch to `mem_op_consume`
let compute_budget = invoke_context.get_compute_budget();
let update_syscall_base_costs = invoke_context
.feature_set
.is_active(&update_syscall_base_costs::id());
if update_syscall_base_costs {
let cost = compute_budget
.mem_op_base_cost
2022-03-02 14:50:16 -08:00
.max(n.saturating_div(compute_budget.cpi_bytes_per_unit));
2021-12-15 14:19:47 -08:00
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
}
let use_fixed_nonoverlapping_check = invoke_context
.feature_set
.is_active(&fixed_memcpy_nonoverlapping_check::id());
let do_check_physical_overlapping = invoke_context
.feature_set
.is_active(&check_physical_overlapping::id());
#[allow(clippy::collapsible_else_if)]
if use_fixed_nonoverlapping_check {
if !is_nonoverlapping(src_addr, dst_addr, n) {
*result = Err(SyscallError::CopyOverlapping.into());
return;
}
} else {
if check_overlapping_do_not_use(src_addr, dst_addr, n) {
*result = Err(SyscallError::CopyOverlapping.into());
return;
}
2021-06-01 15:33:17 -07:00
}
2021-12-15 14:19:47 -08:00
if !update_syscall_base_costs {
2022-03-02 14:50:16 -08:00
let cost = n.saturating_div(compute_budget.cpi_bytes_per_unit);
2021-12-15 14:19:47 -08:00
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
};
let dst_ptr = question_mark!(
translate_slice_mut::<u8>(
memory_mapping,
dst_addr,
n,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size()
),
2021-06-01 15:33:17 -07:00
result
)
.as_mut_ptr();
let src_ptr = question_mark!(
translate_slice::<u8>(
memory_mapping,
src_addr,
n,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size()
),
2021-06-01 15:33:17 -07:00
result
)
.as_ptr();
if do_check_physical_overlapping
&& !is_nonoverlapping(src_ptr as usize, dst_ptr as usize, n as usize)
{
unsafe {
std::ptr::copy(src_ptr, dst_ptr, n as usize);
}
} else {
unsafe {
std::ptr::copy_nonoverlapping(src_ptr, dst_ptr, n as usize);
}
2021-06-01 15:33:17 -07:00
}
*result = Ok(0);
}
);
declare_syscall!(
/// memmove
SyscallMemmove,
2021-06-01 15:33:17 -07:00
fn call(
&mut self,
dst_addr: u64,
src_addr: u64,
n: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
2021-12-15 14:19:47 -08:00
question_mark!(mem_op_consume(&invoke_context, n), result);
2021-06-01 15:33:17 -07:00
let dst = question_mark!(
translate_slice_mut::<u8>(
memory_mapping,
dst_addr,
n,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size()
),
2021-06-01 15:33:17 -07:00
result
);
let src = question_mark!(
translate_slice::<u8>(
memory_mapping,
src_addr,
n,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size()
),
2021-06-01 15:33:17 -07:00
result
);
unsafe {
std::ptr::copy(src.as_ptr(), dst.as_mut_ptr(), n as usize);
}
*result = Ok(0);
}
);
declare_syscall!(
/// memcmp
SyscallMemcmp,
2021-06-01 15:33:17 -07:00
fn call(
&mut self,
s1_addr: u64,
s2_addr: u64,
n: u64,
cmp_result_addr: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
2021-12-15 14:19:47 -08:00
question_mark!(mem_op_consume(&invoke_context, n), result);
2021-06-01 15:33:17 -07:00
let s1 = question_mark!(
translate_slice::<u8>(
memory_mapping,
s1_addr,
n,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
2021-06-01 15:33:17 -07:00
result
);
let s2 = question_mark!(
translate_slice::<u8>(
memory_mapping,
s2_addr,
n,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
2021-06-01 15:33:17 -07:00
result
);
let cmp_result = question_mark!(
2022-04-11 16:05:09 -07:00
translate_type_mut::<i32>(
memory_mapping,
cmp_result_addr,
invoke_context.get_check_aligned()
),
2021-06-01 15:33:17 -07:00
result
);
let mut i = 0;
while i < n as usize {
2022-03-10 11:48:33 -08:00
let a = *question_mark!(s1.get(i).ok_or(SyscallError::InvalidLength,), result);
let b = *question_mark!(s2.get(i).ok_or(SyscallError::InvalidLength,), result);
2021-06-01 15:33:17 -07:00
if a != b {
2022-03-08 11:48:22 -08:00
*cmp_result = if invoke_context
.feature_set
.is_active(&syscall_saturated_math::id())
{
(a as i32).saturating_sub(b as i32)
} else {
#[allow(clippy::integer_arithmetic)]
{
a as i32 - b as i32
}
};
2021-06-01 15:33:17 -07:00
*result = Ok(0);
return;
2022-03-08 11:48:22 -08:00
};
2022-03-02 14:50:16 -08:00
i = i.saturating_add(1);
2021-06-01 15:33:17 -07:00
}
*cmp_result = 0;
*result = Ok(0);
}
);
declare_syscall!(
/// memset
SyscallMemset,
2021-06-01 15:33:17 -07:00
fn call(
&mut self,
s_addr: u64,
c: u64,
n: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
2021-12-15 14:19:47 -08:00
question_mark!(mem_op_consume(&invoke_context, n), result);
2021-06-01 15:33:17 -07:00
let s = question_mark!(
translate_slice_mut::<u8>(
memory_mapping,
s_addr,
n,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
2021-06-01 15:33:17 -07:00
result
);
for val in s.iter_mut().take(n as usize) {
*val = c as u8;
}
*result = Ok(0);
}
);
2021-06-01 15:33:17 -07:00
declare_syscall!(
/// secp256k1_recover
SyscallSecp256k1Recover,
fn call(
&mut self,
hash_addr: u64,
recovery_id_val: u64,
signature_addr: u64,
result_addr: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let cost = invoke_context.get_compute_budget().secp256k1_recover_cost;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let hash = question_mark!(
translate_slice::<u8>(
memory_mapping,
hash_addr,
keccak::HASH_BYTES as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
let signature = question_mark!(
translate_slice::<u8>(
memory_mapping,
signature_addr,
SECP256K1_SIGNATURE_LENGTH as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
let secp256k1_recover_result = question_mark!(
translate_slice_mut::<u8>(
memory_mapping,
result_addr,
SECP256K1_PUBLIC_KEY_LENGTH as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
let message = match libsecp256k1::Message::parse_slice(hash) {
Ok(msg) => msg,
Err(_) => {
*result = Ok(Secp256k1RecoverError::InvalidHash.into());
return;
}
};
2022-03-14 09:34:43 -07:00
let adjusted_recover_id_val = if invoke_context
.feature_set
.is_active(&limit_secp256k1_recovery_id::id())
{
match recovery_id_val.try_into() {
Ok(adjusted_recover_id_val) => adjusted_recover_id_val,
Err(_) => {
*result = Ok(Secp256k1RecoverError::InvalidRecoveryId.into());
return;
}
}
} else {
recovery_id_val as u8
};
let recovery_id = match libsecp256k1::RecoveryId::parse(adjusted_recover_id_val) {
Ok(id) => id,
Err(_) => {
*result = Ok(Secp256k1RecoverError::InvalidRecoveryId.into());
return;
}
};
let sig_parse_result = if invoke_context
.feature_set
.is_active(&libsecp256k1_0_5_upgrade_enabled::id())
{
libsecp256k1::Signature::parse_standard_slice(signature)
} else {
libsecp256k1::Signature::parse_overflowing_slice(signature)
};
2021-07-13 21:22:35 -07:00
let signature = match sig_parse_result {
Ok(sig) => sig,
Err(_) => {
*result = Ok(Secp256k1RecoverError::InvalidSignature.into());
return;
}
};
let public_key = match libsecp256k1::recover(&message, &signature, &recovery_id) {
Ok(key) => key.serialize(),
Err(_) => {
*result = Ok(Secp256k1RecoverError::InvalidSignature.into());
return;
}
};
secp256k1_recover_result.copy_from_slice(&public_key[1..65]);
*result = Ok(SUCCESS);
}
);
declare_syscall!(
SyscallZkTokenElgamalOp,
fn call(
&mut self,
op: u64,
ct_0_addr: u64,
ct_1_addr: u64,
ct_result_addr: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
use solana_zk_token_sdk::zk_token_elgamal::{ops, pod};
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let cost = invoke_context.get_compute_budget().zk_token_elgamal_op_cost;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let ct_0 = question_mark!(
2022-04-11 16:05:09 -07:00
translate_type::<pod::ElGamalCiphertext>(
memory_mapping,
ct_0_addr,
invoke_context.get_check_aligned()
),
result
);
let ct_1 = question_mark!(
2022-04-11 16:05:09 -07:00
translate_type::<pod::ElGamalCiphertext>(
memory_mapping,
ct_1_addr,
invoke_context.get_check_aligned()
),
result
);
if let Some(ct_result) = match op {
ops::OP_ADD => ops::add(ct_0, ct_1),
ops::OP_SUB => ops::subtract(ct_0, ct_1),
_ => None,
} {
*question_mark!(
translate_type_mut::<pod::ElGamalCiphertext>(
memory_mapping,
ct_result_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
),
result
) = ct_result;
*result = Ok(0);
} else {
*result = Ok(1);
}
}
);
declare_syscall!(
SyscallZkTokenElgamalOpWithLoHi,
fn call(
&mut self,
op: u64,
ct_0_addr: u64,
ct_1_lo_addr: u64,
ct_1_hi_addr: u64,
ct_result_addr: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
use solana_zk_token_sdk::zk_token_elgamal::{ops, pod};
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let cost = invoke_context.get_compute_budget().zk_token_elgamal_op_cost;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let ct_0 = question_mark!(
2022-04-11 16:05:09 -07:00
translate_type::<pod::ElGamalCiphertext>(
memory_mapping,
ct_0_addr,
invoke_context.get_check_aligned()
),
result
);
let ct_1_lo = question_mark!(
translate_type::<pod::ElGamalCiphertext>(
memory_mapping,
ct_1_lo_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned()
),
result
);
let ct_1_hi = question_mark!(
translate_type::<pod::ElGamalCiphertext>(
memory_mapping,
ct_1_hi_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned()
),
result
);
if let Some(ct_result) = match op {
ops::OP_ADD => ops::add_with_lo_hi(ct_0, ct_1_lo, ct_1_hi),
ops::OP_SUB => ops::subtract_with_lo_hi(ct_0, ct_1_lo, ct_1_hi),
_ => None,
} {
*question_mark!(
translate_type_mut::<pod::ElGamalCiphertext>(
memory_mapping,
ct_result_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
),
result
) = ct_result;
*result = Ok(0);
} else {
*result = Ok(1);
}
}
);
declare_syscall!(
SyscallZkTokenElgamalOpWithScalar,
fn call(
&mut self,
op: u64,
ct_addr: u64,
scalar: u64,
ct_result_addr: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
use solana_zk_token_sdk::zk_token_elgamal::{ops, pod};
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let cost = invoke_context.get_compute_budget().zk_token_elgamal_op_cost;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let ct = question_mark!(
2022-04-11 16:05:09 -07:00
translate_type::<pod::ElGamalCiphertext>(
memory_mapping,
ct_addr,
invoke_context.get_check_aligned()
),
result
);
if let Some(ct_result) = match op {
ops::OP_ADD => ops::add_to(ct, scalar),
ops::OP_SUB => ops::subtract_from(ct, scalar),
_ => None,
} {
*question_mark!(
translate_type_mut::<pod::ElGamalCiphertext>(
memory_mapping,
ct_result_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
),
result
) = ct_result;
*result = Ok(0);
} else {
*result = Ok(1);
}
}
);
declare_syscall!(
// Elliptic Curve Point Validation
//
// Currently, only curve25519 Edwards and Ristretto representations are supported
SyscallCurvePointValidation,
fn call(
&mut self,
curve_id: u64,
point_addr: u64,
_arg3: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
use solana_zk_token_sdk::curve25519::{curve_syscall_traits::*, edwards, ristretto};
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
match curve_id {
CURVE25519_EDWARDS => {
let cost = invoke_context
.get_compute_budget()
.curve25519_edwards_validate_point_cost;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let point = question_mark!(
translate_type::<edwards::PodEdwardsPoint>(
memory_mapping,
point_addr,
invoke_context.get_check_aligned()
),
result
);
if edwards::validate_edwards(point) {
*result = Ok(0);
} else {
*result = Ok(1);
}
}
CURVE25519_RISTRETTO => {
let cost = invoke_context
.get_compute_budget()
.curve25519_ristretto_validate_point_cost;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let point = question_mark!(
translate_type::<ristretto::PodRistrettoPoint>(
memory_mapping,
point_addr,
invoke_context.get_check_aligned()
),
result
);
if ristretto::validate_ristretto(point) {
*result = Ok(0);
} else {
*result = Ok(1);
}
}
_ => {
*result = Ok(1);
}
};
}
);
declare_syscall!(
// Elliptic Curve Group Operations
//
// Currently, only curve25519 Edwards and Ristretto representations are supported
SyscallCurveGroupOps,
fn call(
&mut self,
curve_id: u64,
group_op: u64,
left_input_addr: u64,
right_input_addr: u64,
result_point_addr: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
use solana_zk_token_sdk::curve25519::{
curve_syscall_traits::*, edwards, ristretto, scalar,
};
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
match curve_id {
CURVE25519_EDWARDS => match group_op {
ADD => {
let cost = invoke_context
.get_compute_budget()
.curve25519_edwards_add_cost;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let left_point = question_mark!(
translate_type::<edwards::PodEdwardsPoint>(
memory_mapping,
left_input_addr,
invoke_context.get_check_aligned(),
),
result
);
let right_point = question_mark!(
translate_type::<edwards::PodEdwardsPoint>(
memory_mapping,
right_input_addr,
invoke_context.get_check_aligned(),
),
result
);
if let Some(result_point) = edwards::add_edwards(left_point, right_point) {
*question_mark!(
translate_type_mut::<edwards::PodEdwardsPoint>(
memory_mapping,
result_point_addr,
invoke_context.get_check_aligned(),
),
result
) = result_point;
*result = Ok(0);
}
}
SUB => {
let cost = invoke_context
.get_compute_budget()
.curve25519_edwards_subtract_cost;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let left_point = question_mark!(
translate_type::<edwards::PodEdwardsPoint>(
memory_mapping,
left_input_addr,
invoke_context.get_check_aligned(),
),
result
);
let right_point = question_mark!(
translate_type::<edwards::PodEdwardsPoint>(
memory_mapping,
right_input_addr,
invoke_context.get_check_aligned(),
),
result
);
if let Some(result_point) = edwards::subtract_edwards(left_point, right_point) {
*question_mark!(
translate_type_mut::<edwards::PodEdwardsPoint>(
memory_mapping,
result_point_addr,
invoke_context.get_check_aligned(),
),
result
) = result_point;
*result = Ok(0);
}
}
MUL => {
let cost = invoke_context
.get_compute_budget()
.curve25519_edwards_multiply_cost;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let scalar = question_mark!(
translate_type::<scalar::PodScalar>(
memory_mapping,
left_input_addr,
invoke_context.get_check_aligned(),
),
result
);
let input_point = question_mark!(
translate_type::<edwards::PodEdwardsPoint>(
memory_mapping,
right_input_addr,
invoke_context.get_check_aligned(),
),
result
);
if let Some(result_point) = edwards::multiply_edwards(scalar, input_point) {
*question_mark!(
translate_type_mut::<edwards::PodEdwardsPoint>(
memory_mapping,
result_point_addr,
invoke_context.get_check_aligned(),
),
result
) = result_point;
*result = Ok(0);
}
}
_ => {
*result = Ok(1);
}
},
CURVE25519_RISTRETTO => match group_op {
ADD => {
let cost = invoke_context
.get_compute_budget()
.curve25519_ristretto_add_cost;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let left_point = question_mark!(
translate_type::<ristretto::PodRistrettoPoint>(
memory_mapping,
left_input_addr,
invoke_context.get_check_aligned(),
),
result
);
let right_point = question_mark!(
translate_type::<ristretto::PodRistrettoPoint>(
memory_mapping,
right_input_addr,
invoke_context.get_check_aligned(),
),
result
);
if let Some(result_point) = ristretto::add_ristretto(left_point, right_point) {
*question_mark!(
translate_type_mut::<ristretto::PodRistrettoPoint>(
memory_mapping,
result_point_addr,
invoke_context.get_check_aligned(),
),
result
) = result_point;
*result = Ok(0);
}
}
SUB => {
let cost = invoke_context
.get_compute_budget()
.curve25519_ristretto_subtract_cost;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let left_point = question_mark!(
translate_type::<ristretto::PodRistrettoPoint>(
memory_mapping,
left_input_addr,
invoke_context.get_check_aligned(),
),
result
);
let right_point = question_mark!(
translate_type::<ristretto::PodRistrettoPoint>(
memory_mapping,
right_input_addr,
invoke_context.get_check_aligned(),
),
result
);
if let Some(result_point) =
ristretto::subtract_ristretto(left_point, right_point)
{
*question_mark!(
translate_type_mut::<ristretto::PodRistrettoPoint>(
memory_mapping,
result_point_addr,
invoke_context.get_check_aligned(),
),
result
) = result_point;
*result = Ok(0);
}
}
MUL => {
let cost = invoke_context
.get_compute_budget()
.curve25519_ristretto_multiply_cost;
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let scalar = question_mark!(
translate_type::<scalar::PodScalar>(
memory_mapping,
left_input_addr,
invoke_context.get_check_aligned(),
),
result
);
let input_point = question_mark!(
translate_type::<ristretto::PodRistrettoPoint>(
memory_mapping,
right_input_addr,
invoke_context.get_check_aligned(),
),
result
);
if let Some(result_point) = ristretto::multiply_ristretto(scalar, input_point) {
*question_mark!(
translate_type_mut::<ristretto::PodRistrettoPoint>(
memory_mapping,
result_point_addr,
invoke_context.get_check_aligned(),
),
result
) = result_point;
*result = Ok(0);
}
}
_ => {
*result = Ok(1);
}
},
_ => {
*result = Ok(1);
}
}
}
);
declare_syscall!(
// Blake3
SyscallBlake3,
2021-06-08 11:04:10 -07:00
fn call(
&mut self,
vals_addr: u64,
vals_len: u64,
result_addr: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
2021-12-15 14:19:47 -08:00
let compute_budget = invoke_context.get_compute_budget();
if invoke_context
.feature_set
.is_active(&update_syscall_base_costs::id())
&& compute_budget.sha256_max_slices < vals_len
{
ic_msg!(
invoke_context,
"Blake3 hashing {} sequences in one syscall is over the limit {}",
vals_len,
compute_budget.sha256_max_slices,
);
*result = Err(SyscallError::TooManySlices.into());
return;
}
question_mark!(
2021-12-15 14:19:47 -08:00
invoke_context
.get_compute_meter()
.consume(compute_budget.sha256_base_cost),
result
);
2021-06-08 11:04:10 -07:00
let hash_result = question_mark!(
translate_slice_mut::<u8>(
memory_mapping,
result_addr,
blake3::HASH_BYTES as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
2021-06-08 11:04:10 -07:00
),
result
);
let mut hasher = blake3::Hasher::default();
if vals_len > 0 {
let vals = question_mark!(
translate_slice::<&[u8]>(
memory_mapping,
vals_addr,
vals_len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
2021-06-08 11:04:10 -07:00
result
);
for val in vals.iter() {
let bytes = question_mark!(
translate_slice::<u8>(
memory_mapping,
val.as_ptr() as u64,
val.len() as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
2021-06-08 11:04:10 -07:00
),
result
);
let cost = if invoke_context
.feature_set
.is_active(&update_syscall_base_costs::id())
{
compute_budget.mem_op_base_cost.max(
compute_budget
.sha256_byte_cost
2022-03-02 14:50:16 -08:00
.saturating_mul((val.len() as u64).saturating_div(2)),
)
2022-03-08 11:48:22 -08:00
} else if invoke_context
.feature_set
.is_active(&syscall_saturated_math::id())
{
2022-03-02 14:50:16 -08:00
compute_budget
.sha256_byte_cost
.saturating_mul((val.len() as u64).saturating_div(2))
2022-03-08 11:48:22 -08:00
} else {
#[allow(clippy::integer_arithmetic)]
{
compute_budget.sha256_byte_cost * (val.len() as u64 / 2)
}
};
2021-12-15 14:19:47 -08:00
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
2021-06-08 11:04:10 -07:00
hasher.hash(bytes);
}
}
hash_result.copy_from_slice(&hasher.result().to_bytes());
*result = Ok(0);
}
);
2021-06-08 11:04:10 -07:00
// Cross-program invocation syscalls
2020-04-28 14:33:56 -07:00
struct CallerAccount<'a> {
lamports: &'a mut u64,
owner: &'a mut Pubkey,
original_data_len: usize,
data: &'a mut [u8],
vm_data_addr: u64,
ref_to_len_in_vm: &'a mut u64,
serialized_len_ptr: &'a mut u64,
executable: bool,
rent_epoch: u64,
}
type TranslatedAccounts<'a> = Vec<(usize, Option<CallerAccount<'a>>)>;
2020-04-28 14:33:56 -07:00
/// Implemented by language specific data structure translators
trait SyscallInvokeSigned<'a, 'b> {
fn get_context_mut(&self) -> Result<RefMut<&'a mut InvokeContext<'b>>, EbpfError<BpfError>>;
2020-04-28 14:33:56 -07:00
fn translate_instruction(
&self,
addr: u64,
memory_mapping: &MemoryMapping,
invoke_context: &mut InvokeContext,
2021-02-18 23:42:09 -08:00
) -> Result<Instruction, EbpfError<BpfError>>;
fn translate_accounts<'c>(
&'c self,
instruction_accounts: &[InstructionAccount],
program_indices: &[usize],
2020-04-28 14:33:56 -07:00
account_infos_addr: u64,
account_infos_len: u64,
memory_mapping: &MemoryMapping,
invoke_context: &mut InvokeContext,
) -> Result<TranslatedAccounts<'c>, EbpfError<BpfError>>;
2020-04-28 14:33:56 -07:00
fn translate_signers(
&self,
program_id: &Pubkey,
signers_seeds_addr: u64,
signers_seeds_len: u64,
memory_mapping: &MemoryMapping,
2022-04-11 16:05:09 -07:00
invoke_context: &InvokeContext,
2021-02-18 23:42:09 -08:00
) -> Result<Vec<Pubkey>, EbpfError<BpfError>>;
2020-04-28 14:33:56 -07:00
}
declare_syscall!(
/// Cross-program invocation called from Rust
SyscallInvokeSignedRust,
2022-04-11 16:05:09 -07:00
fn call(
&mut self,
instruction_addr: u64,
account_infos_addr: u64,
account_infos_len: u64,
signers_seeds_addr: u64,
signers_seeds_len: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
*result = call(
self,
instruction_addr,
account_infos_addr,
account_infos_len,
signers_seeds_addr,
signers_seeds_len,
memory_mapping,
);
}
);
2022-04-11 16:05:09 -07:00
impl<'a, 'b> SyscallInvokeSigned<'a, 'b> for SyscallInvokeSignedRust<'a, 'b> {
fn get_context_mut(&self) -> Result<RefMut<&'a mut InvokeContext<'b>>, EbpfError<BpfError>> {
2020-04-28 14:33:56 -07:00
self.invoke_context
.try_borrow_mut()
.map_err(|_| SyscallError::InvokeContextBorrowFailed.into())
2020-04-28 14:33:56 -07:00
}
2020-04-28 14:33:56 -07:00
fn translate_instruction(
&self,
addr: u64,
memory_mapping: &MemoryMapping,
invoke_context: &mut InvokeContext,
2021-02-18 23:42:09 -08:00
) -> Result<Instruction, EbpfError<BpfError>> {
2022-04-11 16:05:09 -07:00
let ix = translate_type::<Instruction>(
memory_mapping,
addr,
invoke_context.get_check_aligned(),
)?;
check_instruction_size(ix.accounts.len(), ix.data.len(), invoke_context)?;
2020-12-28 17:14:17 -08:00
let accounts = translate_slice::<AccountMeta>(
memory_mapping,
ix.accounts.as_ptr() as u64,
ix.accounts.len() as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
)?
.to_vec();
let data = translate_slice::<u8>(
memory_mapping,
ix.data.as_ptr() as u64,
ix.data.len() as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
2020-04-28 14:33:56 -07:00
)?
.to_vec();
Ok(Instruction {
program_id: ix.program_id,
accounts,
data,
})
}
fn translate_accounts<'c>(
&'c self,
instruction_accounts: &[InstructionAccount],
program_indices: &[usize],
2020-04-28 14:33:56 -07:00
account_infos_addr: u64,
account_infos_len: u64,
memory_mapping: &MemoryMapping,
invoke_context: &mut InvokeContext,
) -> Result<TranslatedAccounts<'c>, EbpfError<BpfError>> {
let account_infos = translate_slice::<AccountInfo>(
memory_mapping,
account_infos_addr,
account_infos_len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
)?;
check_account_infos(account_infos.len(), invoke_context)?;
let account_info_keys = account_infos
.iter()
.map(|account_info| {
translate_type::<Pubkey>(
memory_mapping,
account_info.key as *const _ as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
)
})
2021-02-18 23:42:09 -08:00
.collect::<Result<Vec<_>, EbpfError<BpfError>>>()?;
let translate = |account_info: &AccountInfo, invoke_context: &InvokeContext| {
// Translate the account from user space
let lamports = {
// Double translate lamports out of RefCell
let ptr = translate_type::<u64>(
memory_mapping,
account_info.lamports.as_ptr() as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
)?;
2022-04-11 16:05:09 -07:00
translate_type_mut::<u64>(memory_mapping, *ptr, invoke_context.get_check_aligned())?
};
let owner = translate_type_mut::<Pubkey>(
memory_mapping,
account_info.owner as *const _ as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
)?;
let (data, vm_data_addr, ref_to_len_in_vm, serialized_len_ptr) = {
// Double translate data out of RefCell
let data = *translate_type::<&[u8]>(
memory_mapping,
account_info.data.as_ptr() as *const _ as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
)?;
2021-07-29 15:03:00 -07:00
invoke_context.get_compute_meter().consume(
2022-03-02 14:50:16 -08:00
(data.len() as u64)
.saturating_div(invoke_context.get_compute_budget().cpi_bytes_per_unit),
2021-07-29 15:03:00 -07:00
)?;
let translated = translate(
memory_mapping,
AccessType::Store,
2022-03-23 09:16:03 -07:00
(account_info.data.as_ptr() as *const u64 as u64)
.saturating_add(size_of::<u64>() as u64),
8,
)? as *mut u64;
let ref_to_len_in_vm = unsafe { &mut *translated };
2022-03-23 09:16:03 -07:00
let ref_of_len_in_input_buffer =
(data.as_ptr() as *const _ as u64).saturating_sub(8);
let serialized_len_ptr = translate_type_mut::<u64>(
memory_mapping,
2022-03-23 09:16:03 -07:00
ref_of_len_in_input_buffer,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
)?;
let vm_data_addr = data.as_ptr() as u64;
(
translate_slice_mut::<u8>(
memory_mapping,
vm_data_addr,
data.len() as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
)?,
vm_data_addr,
ref_to_len_in_vm,
serialized_len_ptr,
)
};
Ok(CallerAccount {
lamports,
owner,
original_data_len: 0, // set later
data,
vm_data_addr,
ref_to_len_in_vm,
serialized_len_ptr,
executable: account_info.executable,
rent_epoch: account_info.rent_epoch,
})
};
2020-04-28 14:33:56 -07:00
get_translated_accounts(
instruction_accounts,
program_indices,
&account_info_keys,
account_infos,
invoke_context,
translate,
)
2020-04-28 14:33:56 -07:00
}
fn translate_signers(
&self,
program_id: &Pubkey,
signers_seeds_addr: u64,
signers_seeds_len: u64,
memory_mapping: &MemoryMapping,
2022-04-11 16:05:09 -07:00
invoke_context: &InvokeContext,
2021-02-18 23:42:09 -08:00
) -> Result<Vec<Pubkey>, EbpfError<BpfError>> {
2020-04-28 14:33:56 -07:00
let mut signers = Vec::new();
if signers_seeds_len > 0 {
let signers_seeds = translate_slice::<&[&[u8]]>(
memory_mapping,
signers_seeds_addr,
signers_seeds_len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
)?;
2020-12-09 02:14:53 -08:00
if signers_seeds.len() > MAX_SIGNERS {
return Err(SyscallError::TooManySigners.into());
}
2020-04-28 14:33:56 -07:00
for signer_seeds in signers_seeds.iter() {
let untranslated_seeds = translate_slice::<&[u8]>(
memory_mapping,
signer_seeds.as_ptr() as *const _ as u64,
signer_seeds.len() as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
)?;
2020-12-03 09:58:25 -08:00
if untranslated_seeds.len() > MAX_SEEDS {
return Err(SyscallError::InstructionError(
InstructionError::MaxSeedLengthExceeded,
)
.into());
}
2020-04-28 14:33:56 -07:00
let seeds = untranslated_seeds
.iter()
.map(|untranslated_seed| {
translate_slice::<u8>(
memory_mapping,
untranslated_seed.as_ptr() as *const _ as u64,
untranslated_seed.len() as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
)
2020-04-28 14:33:56 -07:00
})
2021-02-18 23:42:09 -08:00
.collect::<Result<Vec<_>, EbpfError<BpfError>>>()?;
2020-04-28 14:33:56 -07:00
let signer = Pubkey::create_program_address(&seeds, program_id)
.map_err(SyscallError::BadSeeds)?;
2020-04-28 14:33:56 -07:00
signers.push(signer);
}
Ok(signers)
} else {
Ok(vec![])
}
}
}
/// Rust representation of C's SolInstruction
#[derive(Debug)]
#[repr(C)]
2020-04-28 14:33:56 -07:00
struct SolInstruction {
program_id_addr: u64,
accounts_addr: u64,
accounts_len: u64,
2020-04-28 14:33:56 -07:00
data_addr: u64,
data_len: u64,
2020-04-28 14:33:56 -07:00
}
/// Rust representation of C's SolAccountMeta
#[derive(Debug)]
#[repr(C)]
2020-04-28 14:33:56 -07:00
struct SolAccountMeta {
pubkey_addr: u64,
is_writable: bool,
is_signer: bool,
}
/// Rust representation of C's SolAccountInfo
#[derive(Debug)]
#[repr(C)]
2020-04-28 14:33:56 -07:00
struct SolAccountInfo {
key_addr: u64,
lamports_addr: u64,
data_len: u64,
2020-04-28 14:33:56 -07:00
data_addr: u64,
owner_addr: u64,
rent_epoch: u64,
#[allow(dead_code)]
2020-04-28 14:33:56 -07:00
is_signer: bool,
#[allow(dead_code)]
2020-04-28 14:33:56 -07:00
is_writable: bool,
executable: bool,
}
/// Rust representation of C's SolSignerSeed
#[derive(Debug)]
#[repr(C)]
2020-04-28 14:33:56 -07:00
struct SolSignerSeedC {
addr: u64,
len: u64,
}
/// Rust representation of C's SolSignerSeeds
#[derive(Debug)]
#[repr(C)]
2020-04-28 14:33:56 -07:00
struct SolSignerSeedsC {
addr: u64,
len: u64,
}
declare_syscall!(
/// Cross-program invocation called from C
SyscallInvokeSignedC,
2022-04-11 16:05:09 -07:00
fn call(
&mut self,
instruction_addr: u64,
account_infos_addr: u64,
account_infos_len: u64,
signers_seeds_addr: u64,
signers_seeds_len: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
*result = call(
self,
instruction_addr,
account_infos_addr,
account_infos_len,
signers_seeds_addr,
signers_seeds_len,
memory_mapping,
);
}
);
2022-04-11 16:05:09 -07:00
impl<'a, 'b> SyscallInvokeSigned<'a, 'b> for SyscallInvokeSignedC<'a, 'b> {
fn get_context_mut(&self) -> Result<RefMut<&'a mut InvokeContext<'b>>, EbpfError<BpfError>> {
2020-04-28 14:33:56 -07:00
self.invoke_context
.try_borrow_mut()
.map_err(|_| SyscallError::InvokeContextBorrowFailed.into())
2020-04-28 14:33:56 -07:00
}
2020-12-28 17:14:17 -08:00
2020-04-28 14:33:56 -07:00
fn translate_instruction(
&self,
addr: u64,
memory_mapping: &MemoryMapping,
invoke_context: &mut InvokeContext,
2021-02-18 23:42:09 -08:00
) -> Result<Instruction, EbpfError<BpfError>> {
2022-04-11 16:05:09 -07:00
let ix_c = translate_type::<SolInstruction>(
memory_mapping,
addr,
invoke_context.get_check_aligned(),
)?;
check_instruction_size(
ix_c.accounts_len as usize,
ix_c.data_len as usize,
invoke_context,
)?;
2022-04-11 16:05:09 -07:00
let program_id = translate_type::<Pubkey>(
memory_mapping,
ix_c.program_id_addr,
invoke_context.get_check_aligned(),
)?;
let meta_cs = translate_slice::<SolAccountMeta>(
memory_mapping,
ix_c.accounts_addr,
ix_c.accounts_len as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
2020-04-28 14:33:56 -07:00
)?;
let data = translate_slice::<u8>(
memory_mapping,
ix_c.data_addr,
ix_c.data_len as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
)?
.to_vec();
2020-04-28 14:33:56 -07:00
let accounts = meta_cs
.iter()
.map(|meta_c| {
let pubkey = translate_type::<Pubkey>(
memory_mapping,
meta_c.pubkey_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
)?;
2020-04-28 14:33:56 -07:00
Ok(AccountMeta {
pubkey: *pubkey,
is_signer: meta_c.is_signer,
is_writable: meta_c.is_writable,
})
})
2021-02-18 23:42:09 -08:00
.collect::<Result<Vec<AccountMeta>, EbpfError<BpfError>>>()?;
2020-04-28 14:33:56 -07:00
Ok(Instruction {
program_id: *program_id,
accounts,
data,
})
}
fn translate_accounts<'c>(
&'c self,
instruction_accounts: &[InstructionAccount],
program_indices: &[usize],
2020-04-28 14:33:56 -07:00
account_infos_addr: u64,
account_infos_len: u64,
memory_mapping: &MemoryMapping,
invoke_context: &mut InvokeContext,
) -> Result<TranslatedAccounts<'c>, EbpfError<BpfError>> {
let account_infos = translate_slice::<SolAccountInfo>(
memory_mapping,
account_infos_addr,
2020-04-28 14:33:56 -07:00
account_infos_len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
2020-04-28 14:33:56 -07:00
)?;
check_account_infos(account_infos.len(), invoke_context)?;
let account_info_keys = account_infos
.iter()
.map(|account_info| {
2022-04-11 16:05:09 -07:00
translate_type::<Pubkey>(
memory_mapping,
account_info.key_addr,
invoke_context.get_check_aligned(),
)
})
2021-02-18 23:42:09 -08:00
.collect::<Result<Vec<_>, EbpfError<BpfError>>>()?;
let translate = |account_info: &SolAccountInfo, invoke_context: &InvokeContext| {
// Translate the account from user space
let lamports = translate_type_mut::<u64>(
memory_mapping,
account_info.lamports_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
)?;
let owner = translate_type_mut::<Pubkey>(
memory_mapping,
account_info.owner_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
)?;
let vm_data_addr = account_info.data_addr;
2021-07-29 15:03:00 -07:00
invoke_context.get_compute_meter().consume(
2022-03-02 14:50:16 -08:00
account_info
.data_len
.saturating_div(invoke_context.get_compute_budget().cpi_bytes_per_unit),
2021-07-29 15:03:00 -07:00
)?;
let data = translate_slice_mut::<u8>(
memory_mapping,
vm_data_addr,
account_info.data_len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
)?;
2020-04-28 14:33:56 -07:00
2022-03-10 11:48:33 -08:00
let first_info_addr = account_infos.first().ok_or(SyscallError::InstructionError(
InstructionError::InvalidArgument,
))? as *const _ as u64;
let addr = &account_info.data_len as *const u64 as u64;
2022-03-08 11:48:22 -08:00
let vm_addr = if invoke_context
.feature_set
.is_active(&syscall_saturated_math::id())
{
account_infos_addr.saturating_add(addr.saturating_sub(first_info_addr))
} else {
#[allow(clippy::integer_arithmetic)]
{
account_infos_addr + (addr - first_info_addr)
}
};
let _ = translate(
memory_mapping,
AccessType::Store,
vm_addr,
size_of::<u64>() as u64,
)?;
let ref_to_len_in_vm = unsafe { &mut *(addr as *mut u64) };
let ref_of_len_in_input_buffer =
2022-03-23 09:16:03 -07:00
(account_info.data_addr as *mut u8 as u64).saturating_sub(8);
let serialized_len_ptr = translate_type_mut::<u64>(
memory_mapping,
2022-03-23 09:16:03 -07:00
ref_of_len_in_input_buffer,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
)?;
Ok(CallerAccount {
lamports,
owner,
original_data_len: 0, // set later
data,
vm_data_addr,
ref_to_len_in_vm,
serialized_len_ptr,
executable: account_info.executable,
rent_epoch: account_info.rent_epoch,
})
};
2020-04-28 14:33:56 -07:00
get_translated_accounts(
instruction_accounts,
program_indices,
&account_info_keys,
account_infos,
invoke_context,
translate,
)
2020-04-28 14:33:56 -07:00
}
fn translate_signers(
&self,
program_id: &Pubkey,
signers_seeds_addr: u64,
signers_seeds_len: u64,
memory_mapping: &MemoryMapping,
2022-04-11 16:05:09 -07:00
invoke_context: &InvokeContext,
2021-02-18 23:42:09 -08:00
) -> Result<Vec<Pubkey>, EbpfError<BpfError>> {
2020-04-28 14:33:56 -07:00
if signers_seeds_len > 0 {
let signers_seeds = translate_slice::<SolSignerSeedsC>(
memory_mapping,
signers_seeds_addr,
2020-04-28 14:33:56 -07:00
signers_seeds_len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
2020-04-28 14:33:56 -07:00
)?;
2020-12-09 02:14:53 -08:00
if signers_seeds.len() > MAX_SIGNERS {
return Err(SyscallError::TooManySigners.into());
}
2020-04-28 14:33:56 -07:00
Ok(signers_seeds
.iter()
.map(|signer_seeds| {
let seeds = translate_slice::<SolSignerSeedC>(
memory_mapping,
signer_seeds.addr,
2020-04-28 14:33:56 -07:00
signer_seeds.len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
2020-04-28 14:33:56 -07:00
)?;
2020-12-03 09:58:25 -08:00
if seeds.len() > MAX_SEEDS {
return Err(SyscallError::InstructionError(
InstructionError::MaxSeedLengthExceeded,
)
.into());
}
let seeds_bytes = seeds
2020-04-28 14:33:56 -07:00
.iter()
.map(|seed| {
translate_slice::<u8>(
memory_mapping,
seed.addr,
seed.len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
)
})
2021-02-18 23:42:09 -08:00
.collect::<Result<Vec<_>, EbpfError<BpfError>>>()?;
Pubkey::create_program_address(&seeds_bytes, program_id)
.map_err(|err| SyscallError::BadSeeds(err).into())
2020-04-28 14:33:56 -07:00
})
2021-02-18 23:42:09 -08:00
.collect::<Result<Vec<_>, EbpfError<BpfError>>>()?)
2020-04-28 14:33:56 -07:00
} else {
Ok(vec![])
}
}
}
fn get_translated_accounts<'a, T, F>(
instruction_accounts: &[InstructionAccount],
program_indices: &[usize],
account_info_keys: &[&Pubkey],
account_infos: &[T],
invoke_context: &mut InvokeContext,
do_translate: F,
2021-02-18 23:42:09 -08:00
) -> Result<TranslatedAccounts<'a>, EbpfError<BpfError>>
where
F: Fn(&T, &InvokeContext) -> Result<CallerAccount<'a>, EbpfError<BpfError>>,
{
let instruction_context = invoke_context
.transaction_context
.get_current_instruction_context()
2021-10-28 09:03:47 -07:00
.map_err(SyscallError::InstructionError)?;
let mut accounts = Vec::with_capacity(instruction_accounts.len().saturating_add(1));
let program_account_index = program_indices
.last()
.ok_or(SyscallError::InstructionError(
InstructionError::MissingAccount,
))?;
accounts.push((*program_account_index, None));
visit_each_account_once::<EbpfError<BpfError>>(
instruction_accounts,
&mut |_index: usize, instruction_account: &InstructionAccount| {
let account = invoke_context
.transaction_context
.get_account_at_index(instruction_account.index_in_transaction)
.map_err(SyscallError::InstructionError)?;
let account_key = invoke_context
.transaction_context
.get_key_of_account_at_index(instruction_account.index_in_transaction)
.map_err(SyscallError::InstructionError)?;
if account.borrow().executable() {
// Use the known account
2022-04-19 19:31:11 -07:00
if invoke_context
.feature_set
.is_active(&executables_incur_cpi_data_cost::id())
{
invoke_context
.get_compute_meter()
.consume((account.borrow().data().len() as u64).saturating_div(
invoke_context.get_compute_budget().cpi_bytes_per_unit,
))?;
}
accounts.push((instruction_account.index_in_transaction, None));
} else if let Some(caller_account_index) =
account_info_keys.iter().position(|key| *key == account_key)
{
let mut caller_account = do_translate(
account_infos
.get(caller_account_index)
.ok_or(SyscallError::InvalidLength)?,
invoke_context,
)?;
{
let mut account = account.borrow_mut();
account.copy_into_owner_from_slice(caller_account.owner.as_ref());
account.set_data_from_slice(caller_account.data);
account.set_lamports(*caller_account.lamports);
account.set_executable(caller_account.executable);
account.set_rent_epoch(caller_account.rent_epoch);
}
let caller_account = if instruction_account.is_writable {
let orig_data_len_index = instruction_account
.index_in_caller
.saturating_sub(instruction_context.get_number_of_program_accounts());
2022-04-11 16:05:09 -07:00
let orig_data_lens = invoke_context
.get_orig_account_lengths()
.map_err(SyscallError::InstructionError)?;
if orig_data_len_index < orig_data_lens.len() {
caller_account.original_data_len = *orig_data_lens
.get(orig_data_len_index)
.ok_or(SyscallError::InvalidLength)?;
} else {
ic_msg!(
invoke_context,
"Internal error: index mismatch for account {}",
account_key
);
return Err(SyscallError::InstructionError(
InstructionError::MissingAccount,
)
.into());
}
2021-10-28 17:13:42 -07:00
Some(caller_account)
} else {
None
};
accounts.push((instruction_account.index_in_transaction, caller_account));
} else {
ic_msg!(
invoke_context,
"Instruction references an unknown account {}",
account_key
);
return Err(
SyscallError::InstructionError(InstructionError::MissingAccount).into(),
);
}
Ok(())
},
SyscallError::InstructionError(InstructionError::NotEnoughAccountKeys).into(),
)?;
Ok(accounts)
}
2020-12-28 17:14:17 -08:00
fn check_instruction_size(
num_accounts: usize,
data_len: usize,
invoke_context: &mut InvokeContext,
2021-02-18 23:42:09 -08:00
) -> Result<(), EbpfError<BpfError>> {
let size = num_accounts
.saturating_mul(size_of::<AccountMeta>())
.saturating_add(data_len);
2021-07-22 10:18:51 -07:00
let max_size = invoke_context.get_compute_budget().max_cpi_instruction_size;
2021-02-01 11:40:49 -08:00
if size > max_size {
return Err(SyscallError::InstructionTooLarge(size, max_size).into());
2020-12-28 17:14:17 -08:00
}
Ok(())
}
fn check_account_infos(
len: usize,
invoke_context: &mut InvokeContext,
2021-02-18 23:42:09 -08:00
) -> Result<(), EbpfError<BpfError>> {
2022-03-08 11:48:22 -08:00
let adjusted_len = if invoke_context
.feature_set
.is_active(&syscall_saturated_math::id())
2022-03-02 14:50:16 -08:00
{
2022-03-08 11:48:22 -08:00
len.saturating_mul(size_of::<Pubkey>())
} else {
#[allow(clippy::integer_arithmetic)]
{
len * size_of::<Pubkey>()
}
};
if adjusted_len > invoke_context.get_compute_budget().max_cpi_instruction_size {
// Cap the number of account_infos a caller can pass to approximate
// maximum that accounts that could be passed in an instruction
return Err(SyscallError::TooManyAccounts.into());
};
Ok(())
}
fn check_authorized_program(
program_id: &Pubkey,
instruction_data: &[u8],
invoke_context: &InvokeContext,
2021-02-18 23:42:09 -08:00
) -> Result<(), EbpfError<BpfError>> {
#[allow(clippy::blocks_in_if_conditions)]
if native_loader::check_id(program_id)
|| bpf_loader::check_id(program_id)
|| bpf_loader_deprecated::check_id(program_id)
|| (bpf_loader_upgradeable::check_id(program_id)
&& !(bpf_loader_upgradeable::is_upgrade_instruction(instruction_data)
|| bpf_loader_upgradeable::is_set_authority_instruction(instruction_data)
2021-10-28 09:04:03 -07:00
|| bpf_loader_upgradeable::is_close_instruction(instruction_data)))
|| (invoke_context
.feature_set
.is_active(&prevent_calling_precompiles_as_programs::id())
&& is_precompile(program_id, |feature_id: &Pubkey| {
invoke_context.feature_set.is_active(feature_id)
}))
{
return Err(SyscallError::ProgramNotSupported(*program_id).into());
}
Ok(())
}
2020-04-28 14:33:56 -07:00
/// Call process instruction, common to both Rust and C
fn call<'a, 'b: 'a>(
syscall: &mut dyn SyscallInvokeSigned<'a, 'b>,
2020-04-28 14:33:56 -07:00
instruction_addr: u64,
account_infos_addr: u64,
account_infos_len: u64,
signers_seeds_addr: u64,
signers_seeds_len: u64,
memory_mapping: &MemoryMapping,
2021-02-18 23:42:09 -08:00
) -> Result<u64, EbpfError<BpfError>> {
let mut invoke_context = syscall.get_context_mut()?;
invoke_context
.get_compute_meter()
.consume(invoke_context.get_compute_budget().invoke_units)?;
let do_support_realloc = invoke_context
.feature_set
.is_active(&do_support_realloc::id());
// Translate and verify caller's data
let instruction =
syscall.translate_instruction(instruction_addr, memory_mapping, *invoke_context)?;
let transaction_context = &invoke_context.transaction_context;
let instruction_context = transaction_context
.get_current_instruction_context()
.map_err(SyscallError::InstructionError)?;
let caller_program_id = instruction_context
.get_program_key(transaction_context)
.map_err(SyscallError::InstructionError)?;
let signers = syscall.translate_signers(
caller_program_id,
signers_seeds_addr,
signers_seeds_len,
memory_mapping,
2022-04-11 16:05:09 -07:00
*invoke_context,
)?;
let (instruction_accounts, program_indices) = invoke_context
.prepare_instruction(&instruction, &signers)
.map_err(SyscallError::InstructionError)?;
check_authorized_program(&instruction.program_id, &instruction.data, *invoke_context)?;
let mut accounts = syscall.translate_accounts(
&instruction_accounts,
&program_indices,
account_infos_addr,
account_infos_len,
memory_mapping,
*invoke_context,
)?;
// Process instruction
let mut compute_units_consumed = 0;
invoke_context
.process_instruction(
&instruction.data,
&instruction_accounts,
&program_indices,
&mut compute_units_consumed,
2021-12-20 20:03:20 -08:00
&mut ExecuteTimings::default(),
)
.map_err(SyscallError::InstructionError)?;
2020-04-28 14:33:56 -07:00
// Copy results back to caller
for (callee_account_index, caller_account) in accounts.iter_mut() {
if let Some(caller_account) = caller_account {
let callee_account = invoke_context
.transaction_context
.get_account_at_index(*callee_account_index)
.map_err(SyscallError::InstructionError)?
.borrow();
*caller_account.lamports = callee_account.lamports();
*caller_account.owner = *callee_account.owner();
let new_len = callee_account.data().len();
if caller_account.data.len() != new_len {
if !do_support_realloc && !caller_account.data.is_empty() {
// Only support for `CreateAccount` at this time.
// Need a way to limit total realloc size across multiple CPI calls
ic_msg!(
invoke_context,
"Inner instructions do not support realloc, only SystemProgram::CreateAccount",
);
return Err(
SyscallError::InstructionError(InstructionError::InvalidRealloc).into(),
);
}
let data_overflow = if do_support_realloc {
2022-03-08 11:48:22 -08:00
if invoke_context
.feature_set
.is_active(&syscall_saturated_math::id())
{
new_len
> caller_account
.original_data_len
.saturating_add(MAX_PERMITTED_DATA_INCREASE)
} else {
#[allow(clippy::integer_arithmetic)]
{
new_len > caller_account.original_data_len + MAX_PERMITTED_DATA_INCREASE
}
}
} else if invoke_context
.feature_set
.is_active(&syscall_saturated_math::id())
{
2022-03-02 14:50:16 -08:00
new_len
> caller_account
.data
.len()
.saturating_add(MAX_PERMITTED_DATA_INCREASE)
2022-03-08 11:48:22 -08:00
} else {
#[allow(clippy::integer_arithmetic)]
{
new_len > caller_account.data.len() + MAX_PERMITTED_DATA_INCREASE
}
};
if data_overflow {
ic_msg!(
invoke_context,
"Account data size realloc limited to {} in inner instructions",
MAX_PERMITTED_DATA_INCREASE
);
return Err(
SyscallError::InstructionError(InstructionError::InvalidRealloc).into(),
);
}
if new_len < caller_account.data.len() {
2022-03-10 11:48:33 -08:00
caller_account
.data
.get_mut(new_len..)
.ok_or(SyscallError::InstructionError(
InstructionError::AccountDataTooSmall,
))?
.fill(0);
}
caller_account.data = translate_slice_mut::<u8>(
memory_mapping,
caller_account.vm_data_addr,
new_len as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
)?;
*caller_account.ref_to_len_in_vm = new_len as u64;
*caller_account.serialized_len_ptr = new_len as u64;
2020-08-06 12:14:12 -07:00
}
2022-03-10 11:48:33 -08:00
let to_slice = &mut caller_account.data;
let from_slice = callee_account
.data()
.get(0..new_len)
.ok_or(SyscallError::InvalidLength)?;
if to_slice.len() != from_slice.len() {
return Err(
SyscallError::InstructionError(InstructionError::AccountDataTooSmall).into(),
);
}
to_slice.copy_from_slice(from_slice);
2020-04-28 14:33:56 -07:00
}
}
Ok(SUCCESS)
}
declare_syscall!(
/// Set return data
SyscallSetReturnData,
fn call(
&mut self,
addr: u64,
len: u64,
_arg3: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let mut invoke_context = question_mark!(
self.invoke_context
.try_borrow_mut()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let budget = invoke_context.get_compute_budget();
2022-03-08 11:48:22 -08:00
let cost = if invoke_context
.feature_set
.is_active(&syscall_saturated_math::id())
{
len.saturating_div(budget.cpi_bytes_per_unit)
.saturating_add(budget.syscall_base_cost)
} else {
#[allow(clippy::integer_arithmetic)]
{
len / budget.cpi_bytes_per_unit + budget.syscall_base_cost
}
};
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
if len > MAX_RETURN_DATA as u64 {
*result = Err(SyscallError::ReturnDataTooLarge(len, MAX_RETURN_DATA as u64).into());
return;
}
let return_data = if len == 0 {
Vec::new()
} else {
question_mark!(
translate_slice::<u8>(
memory_mapping,
addr,
len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
)
.to_vec()
};
let transaction_context = &mut invoke_context.transaction_context;
let program_id = *question_mark!(
transaction_context
.get_current_instruction_context()
.and_then(
|instruction_context| instruction_context.get_program_key(transaction_context)
)
.map_err(SyscallError::InstructionError),
result
);
question_mark!(
transaction_context
.set_return_data(program_id, return_data)
.map_err(SyscallError::InstructionError),
result
);
*result = Ok(0);
}
);
declare_syscall!(
/// Get return data
SyscallGetReturnData,
fn call(
&mut self,
return_data_addr: u64,
mut length: u64,
program_id_addr: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let budget = invoke_context.get_compute_budget();
question_mark!(
invoke_context
.get_compute_meter()
.consume(budget.syscall_base_cost),
result
);
let (program_id, return_data) = invoke_context.transaction_context.get_return_data();
length = length.min(return_data.len() as u64);
if length != 0 {
2022-03-08 11:48:22 -08:00
let cost = if invoke_context
.feature_set
.is_active(&syscall_saturated_math::id())
{
length
.saturating_add(size_of::<Pubkey>() as u64)
.saturating_div(budget.cpi_bytes_per_unit)
} else {
#[allow(clippy::integer_arithmetic)]
{
(length + size_of::<Pubkey>() as u64) / budget.cpi_bytes_per_unit
}
};
question_mark!(invoke_context.get_compute_meter().consume(cost), result);
let return_data_result = question_mark!(
translate_slice_mut::<u8>(
memory_mapping,
return_data_addr,
length,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
2022-03-10 11:48:33 -08:00
let to_slice = return_data_result;
let from_slice = question_mark!(
return_data
.get(..length as usize)
.ok_or(SyscallError::InvokeContextBorrowFailed),
result
);
if to_slice.len() != from_slice.len() {
*result = Err(SyscallError::InvalidLength.into());
return;
}
to_slice.copy_from_slice(from_slice);
let program_id_result = question_mark!(
2022-04-11 16:05:09 -07:00
translate_type_mut::<Pubkey>(
memory_mapping,
program_id_addr,
invoke_context.get_check_aligned()
),
result
);
2022-03-10 11:48:33 -08:00
*program_id_result = *program_id;
}
// Return the actual length, rather the length returned
*result = Ok(return_data.len() as u64);
}
);
declare_syscall!(
/// Log data handling
SyscallLogData,
fn call(
&mut self,
addr: u64,
len: u64,
_arg3: u64,
_arg4: u64,
_arg5: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let budget = invoke_context.get_compute_budget();
question_mark!(
invoke_context
.get_compute_meter()
.consume(budget.syscall_base_cost),
result
);
let untranslated_fields = question_mark!(
translate_slice::<&[u8]>(
memory_mapping,
addr,
len,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
question_mark!(
invoke_context.get_compute_meter().consume(
budget
.syscall_base_cost
.saturating_mul(untranslated_fields.len() as u64)
2021-11-18 14:02:47 -08:00
),
result
);
question_mark!(
invoke_context.get_compute_meter().consume(
untranslated_fields
.iter()
.fold(0, |total, e| total.saturating_add(e.len() as u64))
),
result
);
let mut fields = Vec::with_capacity(untranslated_fields.len());
for untranslated_field in untranslated_fields {
fields.push(question_mark!(
translate_slice::<u8>(
memory_mapping,
untranslated_field.as_ptr() as *const _ as u64,
untranslated_field.len() as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
));
}
let log_collector = invoke_context.get_log_collector();
stable_log::program_data(&log_collector, &fields);
*result = Ok(0);
}
);
declare_syscall!(
/// Get a processed sigling instruction
SyscallGetProcessedSiblingInstruction,
fn call(
&mut self,
index: u64,
meta_addr: u64,
program_id_addr: u64,
data_addr: u64,
accounts_addr: u64,
memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let budget = invoke_context.get_compute_budget();
question_mark!(
invoke_context
.get_compute_meter()
.consume(budget.syscall_base_cost),
result
);
let stack_height = invoke_context.get_stack_height();
let instruction_trace = invoke_context.transaction_context.get_instruction_trace();
let instruction_context = if stack_height == TRANSACTION_LEVEL_STACK_HEIGHT {
// pick one of the top-level instructions
instruction_trace
.len()
.checked_sub(2)
.and_then(|result| result.checked_sub(index as usize))
.and_then(|index| instruction_trace.get(index))
2022-03-10 11:48:33 -08:00
.and_then(|instruction_list| instruction_list.first())
} else {
// Walk the last list of inner instructions
instruction_trace.last().and_then(|inners| {
let mut current_index = 0;
inners.iter().rev().skip(1).find(|instruction_context| {
if stack_height == instruction_context.get_stack_height() {
if index == current_index {
return true;
} else {
2022-03-02 14:50:16 -08:00
current_index = current_index.saturating_add(1);
}
}
false
})
})
};
if let Some(instruction_context) = instruction_context {
let ProcessedSiblingInstruction {
data_len,
accounts_len,
} = question_mark!(
translate_type_mut::<ProcessedSiblingInstruction>(
memory_mapping,
meta_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
),
result
);
2022-02-07 13:54:20 -08:00
if *data_len == instruction_context.get_instruction_data().len()
&& *accounts_len == instruction_context.get_number_of_instruction_accounts()
{
let program_id = question_mark!(
translate_type_mut::<Pubkey>(
memory_mapping,
program_id_addr,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned()
),
result
);
let data = question_mark!(
translate_slice_mut::<u8>(
memory_mapping,
data_addr,
*data_len as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
let accounts = question_mark!(
translate_slice_mut::<AccountMeta>(
memory_mapping,
accounts_addr,
*accounts_len as u64,
2022-04-11 16:05:09 -07:00
invoke_context.get_check_aligned(),
invoke_context.get_check_size(),
),
result
);
*program_id =
instruction_context.get_program_id(invoke_context.transaction_context);
data.clone_from_slice(instruction_context.get_instruction_data());
let account_metas = question_mark!(
(instruction_context.get_number_of_program_accounts()
..instruction_context.get_number_of_accounts())
.map(|index_in_instruction| Ok(AccountMeta {
pubkey: *invoke_context.get_key_of_account_at_index(
instruction_context
.get_index_in_transaction(index_in_instruction)?
)?,
is_signer: instruction_context.is_signer(index_in_instruction)?,
is_writable: instruction_context.is_writable(index_in_instruction)?,
}))
.collect::<Result<Vec<_>, InstructionError>>()
.map_err(SyscallError::InstructionError),
result
);
accounts.clone_from_slice(account_metas.as_slice());
}
*data_len = instruction_context.get_instruction_data().len();
*accounts_len = instruction_context.get_number_of_instruction_accounts();
*result = Ok(true as u64);
return;
}
*result = Ok(false as u64);
}
);
declare_syscall!(
/// Get current call stack height
SyscallGetStackHeight,
fn call(
&mut self,
_arg1: u64,
_arg2: u64,
_arg3: u64,
_arg4: u64,
_arg5: u64,
_memory_mapping: &MemoryMapping,
result: &mut Result<u64, EbpfError<BpfError>>,
) {
let invoke_context = question_mark!(
self.invoke_context
.try_borrow()
.map_err(|_| SyscallError::InvokeContextBorrowFailed),
result
);
let budget = invoke_context.get_compute_budget();
question_mark!(
invoke_context
.get_compute_meter()
.consume(budget.syscall_base_cost),
result
);
*result = Ok(invoke_context.get_stack_height() as u64);
}
);
2020-04-18 17:04:13 -07:00
#[cfg(test)]
mod tests {
#[allow(deprecated)]
use solana_sdk::sysvar::fees::Fees;
use {
super::*,
solana_program_runtime::{invoke_context::InvokeContext, sysvar_cache::SysvarCache},
solana_rbpf::{
ebpf::HOST_ALIGN, memory_region::MemoryRegion, user_error::UserError, vm::Config,
},
solana_sdk::{
account::AccountSharedData,
bpf_loader,
fee_calculator::FeeCalculator,
hash::hashv,
2022-03-30 08:28:49 -07:00
program::check_type_assumptions,
sysvar::{clock::Clock, epoch_schedule::EpochSchedule, rent::Rent},
transaction_context::TransactionContext,
},
std::{borrow::Cow, str::FromStr},
};
2020-04-18 17:04:13 -07:00
macro_rules! assert_access_violation {
($result:expr, $va:expr, $len:expr) => {
match $result {
Err(EbpfError::AccessViolation(_, _, va, len, _)) if $va == va && $len == len => (),
Err(EbpfError::StackAccessViolation(_, _, va, len, _))
if $va == va && $len == len => {}
_ => panic!(),
}
};
}
macro_rules! prepare_mockup {
($invoke_context:ident,
$transaction_context:ident,
$program_key:ident,
$loader_key:expr $(,)?) => {
let $program_key = Pubkey::new_unique();
let mut $transaction_context = TransactionContext::new(
vec![
(
$loader_key,
AccountSharedData::new(0, 0, &native_loader::id()),
),
($program_key, AccountSharedData::new(0, 0, &$loader_key)),
],
1,
1,
);
let mut $invoke_context = InvokeContext::new_mock(&mut $transaction_context, &[]);
$invoke_context.push(&[], &[0, 1], &[]).unwrap();
};
}
#[allow(dead_code)]
struct MockSlice {
pub vm_addr: u64,
pub len: usize,
}
2020-04-18 17:04:13 -07:00
#[test]
fn test_translate() {
const START: u64 = 0x100000000;
2020-04-18 17:04:13 -07:00
const LENGTH: u64 = 1000;
let data = vec![0u8; LENGTH as usize];
let addr = data.as_ptr() as u64;
let config = Config::default();
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
2022-04-30 01:58:12 -07:00
MemoryRegion::new_readonly(&data, START),
],
&config,
)
.unwrap();
2020-04-18 17:04:13 -07:00
let cases = vec![
(true, START, 0, addr),
(true, START, 1, addr),
(true, START, LENGTH, addr),
(true, START + 1, LENGTH - 1, addr + 1),
(false, START + 1, LENGTH, 0),
(true, START + LENGTH - 1, 1, addr + LENGTH - 1),
(true, START + LENGTH, 0, addr + LENGTH),
(false, START + LENGTH, 1, 0),
(false, START, LENGTH + 1, 0),
(false, 0, 0, 0),
(false, 0, 1, 0),
(false, START - 1, 0, 0),
(false, START - 1, 1, 0),
(true, START + LENGTH / 2, LENGTH / 2, addr + LENGTH / 2),
];
for (ok, start, length, value) in cases {
if ok {
assert_eq!(
2021-03-10 09:48:41 -08:00
translate(&memory_mapping, AccessType::Load, start, length).unwrap(),
value
)
} else {
2021-03-10 09:48:41 -08:00
assert!(translate(&memory_mapping, AccessType::Load, start, length).is_err())
2020-04-18 17:04:13 -07:00
}
}
}
#[test]
fn test_translate_type() {
// Pubkey
let pubkey = solana_sdk::pubkey::new_rand();
2020-04-18 17:04:13 -07:00
let addr = &pubkey as *const _ as u64;
let config = Config::default();
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: addr,
vm_addr: 0x100000000,
len: std::mem::size_of::<Pubkey>() as u64,
vm_gap_shift: 63,
is_writable: false,
},
],
&config,
)
.unwrap();
let translated_pubkey =
translate_type::<Pubkey>(&memory_mapping, 0x100000000, true).unwrap();
2020-04-18 17:04:13 -07:00
assert_eq!(pubkey, *translated_pubkey);
// Instruction
2021-03-03 21:46:48 -08:00
let instruction = Instruction::new_with_bincode(
solana_sdk::pubkey::new_rand(),
2020-04-18 17:04:13 -07:00
&"foobar",
vec![AccountMeta::new(solana_sdk::pubkey::new_rand(), false)],
2020-04-18 17:04:13 -07:00
);
let addr = &instruction as *const _ as u64;
let mut memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: addr,
vm_addr: 0x100000000,
len: std::mem::size_of::<Instruction>() as u64,
vm_gap_shift: 63,
is_writable: false,
},
],
&config,
)
.unwrap();
let translated_instruction =
translate_type::<Instruction>(&memory_mapping, 0x100000000, true).unwrap();
2020-04-18 17:04:13 -07:00
assert_eq!(instruction, *translated_instruction);
memory_mapping.resize_region::<BpfError>(1, 1).unwrap();
assert!(translate_type::<Instruction>(&memory_mapping, 0x100000000, true).is_err());
2020-04-18 17:04:13 -07:00
}
#[test]
fn test_translate_slice() {
// zero len
let good_data = vec![1u8, 2, 3, 4, 5];
let data: Vec<u8> = vec![];
assert_eq!(0x1 as *const u8, data.as_ptr());
let addr = good_data.as_ptr() as *const _ as u64;
let config = Config::default();
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: addr,
vm_addr: 0x100000000,
len: good_data.len() as u64,
vm_gap_shift: 63,
is_writable: false,
},
],
&config,
)
.unwrap();
2021-09-17 09:46:49 -07:00
let translated_data =
translate_slice::<u8>(&memory_mapping, data.as_ptr() as u64, 0, true, true).unwrap();
assert_eq!(data, translated_data);
assert_eq!(0, translated_data.len());
2020-04-18 17:04:13 -07:00
// u8
let mut data = vec![1u8, 2, 3, 4, 5];
let addr = data.as_ptr() as *const _ as u64;
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: addr,
vm_addr: 0x100000000,
len: data.len() as u64,
vm_gap_shift: 63,
is_writable: false,
},
],
&config,
)
.unwrap();
let translated_data =
translate_slice::<u8>(&memory_mapping, 0x100000000, data.len() as u64, true, true)
.unwrap();
2020-04-18 17:04:13 -07:00
assert_eq!(data, translated_data);
2022-03-10 11:48:33 -08:00
*data.first_mut().unwrap() = 10;
2020-04-18 17:04:13 -07:00
assert_eq!(data, translated_data);
assert!(
translate_slice::<u8>(&memory_mapping, data.as_ptr() as u64, u64::MAX, true, true)
.is_err()
);
assert!(translate_slice::<u8>(
&memory_mapping,
0x100000000 - 1,
data.len() as u64,
true,
true
)
.is_err());
2020-04-18 17:04:13 -07:00
// u64
let mut data = vec![1u64, 2, 3, 4, 5];
let addr = data.as_ptr() as *const _ as u64;
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: addr,
vm_addr: 0x100000000,
len: (data.len() * size_of::<u64>()) as u64,
vm_gap_shift: 63,
is_writable: false,
},
],
&config,
)
.unwrap();
let translated_data =
translate_slice::<u64>(&memory_mapping, 0x100000000, data.len() as u64, true, true)
.unwrap();
assert_eq!(data, translated_data);
2022-03-10 11:48:33 -08:00
*data.first_mut().unwrap() = 10;
assert_eq!(data, translated_data);
2021-09-17 09:46:49 -07:00
assert!(
translate_slice::<u64>(&memory_mapping, 0x100000000, u64::MAX, true, true).is_err()
2021-09-17 09:46:49 -07:00
);
2020-04-18 17:04:13 -07:00
// Pubkeys
let mut data = vec![solana_sdk::pubkey::new_rand(); 5];
2020-04-18 17:04:13 -07:00
let addr = data.as_ptr() as *const _ as u64;
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: addr,
vm_addr: 0x100000000,
len: (data.len() * std::mem::size_of::<Pubkey>()) as u64,
vm_gap_shift: 63,
is_writable: false,
},
],
&config,
)
.unwrap();
let translated_data =
translate_slice::<Pubkey>(&memory_mapping, 0x100000000, data.len() as u64, true, true)
.unwrap();
2020-04-18 17:04:13 -07:00
assert_eq!(data, translated_data);
2022-03-10 11:48:33 -08:00
*data.first_mut().unwrap() = solana_sdk::pubkey::new_rand(); // Both should point to same place
2020-04-18 17:04:13 -07:00
assert_eq!(data, translated_data);
}
#[test]
fn test_translate_string_and_do() {
let string = "Gaggablaghblagh!";
let addr = string.as_ptr() as *const _ as u64;
let config = Config::default();
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: addr,
vm_addr: 0x100000000,
len: string.len() as u64,
vm_gap_shift: 63,
is_writable: false,
},
],
&config,
)
.unwrap();
2020-04-18 17:04:13 -07:00
assert_eq!(
42,
translate_string_and_do(
&memory_mapping,
0x100000000,
string.len() as u64,
true,
true,
&mut |string: &str| {
assert_eq!(string, "Gaggablaghblagh!");
Ok(42)
}
)
2020-04-18 17:04:13 -07:00
.unwrap()
);
}
#[test]
#[should_panic(expected = "UserError(SyscallError(Abort))")]
fn test_syscall_abort() {
2022-04-11 16:05:09 -07:00
prepare_mockup!(
invoke_context,
transaction_context,
program_id,
bpf_loader::id(),
);
let config = Config::default();
let memory_mapping =
MemoryMapping::new::<UserError>(vec![MemoryRegion::default()], &config).unwrap();
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
SyscallAbort::call(
2022-04-11 16:05:09 -07:00
&mut SyscallAbort {
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
2022-04-11 16:05:09 -07:00
},
0,
0,
0,
0,
0,
&memory_mapping,
&mut result,
);
result.unwrap();
2020-04-18 17:04:13 -07:00
}
#[test]
#[should_panic(expected = "UserError(SyscallError(Panic(\"Gaggablaghblagh!\", 42, 84)))")]
fn test_syscall_sol_panic() {
prepare_mockup!(
invoke_context,
transaction_context,
program_id,
bpf_loader::id(),
);
let mut syscall_panic = SyscallPanic {
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
};
2020-04-18 17:04:13 -07:00
let string = "Gaggablaghblagh!";
let addr = string.as_ptr() as *const _ as u64;
let config = Config::default();
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: addr,
vm_addr: 0x100000000,
len: string.len() as u64,
vm_gap_shift: 63,
is_writable: false,
},
],
&config,
)
.unwrap();
2021-02-11 16:55:17 -08:00
syscall_panic
.invoke_context
.borrow_mut()
.get_compute_meter()
.borrow_mut()
.mock_set_remaining(string.len() as u64 - 1);
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
2021-02-11 16:55:17 -08:00
syscall_panic.call(
0x100000000,
2021-02-11 16:55:17 -08:00
string.len() as u64,
42,
84,
0,
&memory_mapping,
&mut result,
);
assert_eq!(
2021-02-18 23:42:09 -08:00
Err(EbpfError::UserError(BpfError::SyscallError(
2021-02-11 16:55:17 -08:00
SyscallError::InstructionError(InstructionError::ComputationalBudgetExceeded)
))),
result
);
syscall_panic
.invoke_context
.borrow_mut()
.get_compute_meter()
.borrow_mut()
.mock_set_remaining(string.len() as u64);
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall_panic.call(
0x100000000,
string.len() as u64,
42,
84,
0,
&memory_mapping,
&mut result,
);
result.unwrap();
2020-04-18 17:04:13 -07:00
}
#[test]
fn test_syscall_sol_log() {
prepare_mockup!(
invoke_context,
transaction_context,
program_id,
bpf_loader::id(),
);
let mut syscall_sol_log = SyscallLog {
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
};
2020-04-18 17:04:13 -07:00
let string = "Gaggablaghblagh!";
let addr = string.as_ptr() as *const _ as u64;
let config = Config::default();
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: addr,
vm_addr: 0x100000000,
len: string.len() as u64,
vm_gap_shift: 63,
is_writable: false,
},
],
&config,
)
.unwrap();
syscall_sol_log
.invoke_context
.borrow_mut()
.get_compute_meter()
.borrow_mut()
2021-12-15 14:19:47 -08:00
.mock_set_remaining(400 - 1);
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall_sol_log.call(
0x100000001, // AccessViolation
string.len() as u64,
0,
0,
0,
&memory_mapping,
&mut result,
);
assert_access_violation!(result, 0x100000001, string.len() as u64);
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall_sol_log.call(
0x100000000,
string.len() as u64 * 2, // AccessViolation
0,
0,
0,
&memory_mapping,
&mut result,
);
assert_access_violation!(result, 0x100000000, string.len() as u64 * 2);
2021-02-11 16:55:17 -08:00
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
2021-02-11 16:55:17 -08:00
syscall_sol_log.call(
0x100000000,
2021-02-11 16:55:17 -08:00
string.len() as u64,
0,
0,
0,
&memory_mapping,
&mut result,
);
result.unwrap();
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
2021-02-11 16:55:17 -08:00
syscall_sol_log.call(
0x100000000,
2021-02-11 16:55:17 -08:00
string.len() as u64,
0,
0,
0,
&memory_mapping,
&mut result,
);
assert_eq!(
2021-02-18 23:42:09 -08:00
Err(EbpfError::UserError(BpfError::SyscallError(
2021-02-11 16:55:17 -08:00
SyscallError::InstructionError(InstructionError::ComputationalBudgetExceeded)
))),
result
);
assert_eq!(
syscall_sol_log
.invoke_context
.borrow()
.get_log_collector()
.unwrap()
.borrow()
.get_recorded_content(),
&["Program log: Gaggablaghblagh!".to_string()]
);
2020-04-18 17:04:13 -07:00
}
#[test]
fn test_syscall_sol_log_u64() {
prepare_mockup!(
invoke_context,
transaction_context,
program_id,
bpf_loader::id(),
);
let cost = invoke_context.get_compute_budget().log_64_units;
let mut syscall_sol_log_u64 = SyscallLogU64 {
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
};
2020-04-18 17:04:13 -07:00
syscall_sol_log_u64
.invoke_context
.borrow_mut()
.get_compute_meter()
.borrow_mut()
.mock_set_remaining(cost);
let config = Config::default();
let memory_mapping = MemoryMapping::new::<UserError>(vec![], &config).unwrap();
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall_sol_log_u64.call(1, 2, 3, 4, 5, &memory_mapping, &mut result);
result.unwrap();
assert_eq!(
syscall_sol_log_u64
.invoke_context
.borrow()
.get_log_collector()
.unwrap()
.borrow()
.get_recorded_content(),
&["Program log: 0x1, 0x2, 0x3, 0x4, 0x5".to_string()]
);
2020-04-18 17:04:13 -07:00
}
2020-10-15 09:11:54 -07:00
#[test]
fn test_syscall_sol_pubkey() {
prepare_mockup!(
invoke_context,
transaction_context,
program_id,
bpf_loader::id(),
);
let cost = invoke_context.get_compute_budget().log_pubkey_units;
let mut syscall_sol_pubkey = SyscallLogPubkey {
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
};
2020-10-15 09:11:54 -07:00
let pubkey = Pubkey::from_str("MoqiU1vryuCGQSxFKA1SZ316JdLEFFhoAu6cKUNk7dN").unwrap();
2022-03-10 11:48:33 -08:00
let addr = pubkey.as_ref().first().unwrap() as *const _ as u64;
let config = Config::default();
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: addr,
vm_addr: 0x100000000,
len: 32,
vm_gap_shift: 63,
is_writable: false,
},
],
&config,
)
.unwrap();
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall_sol_pubkey.call(
0x100000001, // AccessViolation
32,
0,
0,
0,
&memory_mapping,
&mut result,
2020-10-15 09:11:54 -07:00
);
assert_access_violation!(result, 0x100000001, 32);
syscall_sol_pubkey
.invoke_context
.borrow_mut()
.get_compute_meter()
.borrow_mut()
.mock_set_remaining(1);
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall_sol_pubkey.call(100, 32, 0, 0, 0, &memory_mapping, &mut result);
2020-10-15 09:11:54 -07:00
assert_eq!(
2021-02-18 23:42:09 -08:00
Err(EbpfError::UserError(BpfError::SyscallError(
2020-10-15 09:11:54 -07:00
SyscallError::InstructionError(InstructionError::ComputationalBudgetExceeded)
))),
result
2020-10-15 09:11:54 -07:00
);
syscall_sol_pubkey
.invoke_context
.borrow_mut()
.get_compute_meter()
.borrow_mut()
.mock_set_remaining(cost);
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall_sol_pubkey.call(0x100000000, 0, 0, 0, 0, &memory_mapping, &mut result);
result.unwrap();
assert_eq!(
syscall_sol_pubkey
.invoke_context
.borrow()
.get_log_collector()
.unwrap()
.borrow()
.get_recorded_content(),
&["Program log: MoqiU1vryuCGQSxFKA1SZ316JdLEFFhoAu6cKUNk7dN".to_string()]
);
2020-10-15 09:11:54 -07:00
}
2020-04-18 17:04:13 -07:00
#[test]
fn test_syscall_sol_alloc_free() {
let config = Config::default();
2022-04-11 16:05:09 -07:00
2020-04-18 17:04:13 -07:00
// large alloc
{
2022-04-11 16:05:09 -07:00
prepare_mockup!(
invoke_context,
transaction_context,
program_id,
bpf_loader::id(),
);
2022-04-30 01:58:12 -07:00
let mut heap = AlignedMemory::new_with_size(100, HOST_ALIGN);
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
2022-04-30 01:58:12 -07:00
MemoryRegion::new_readonly(&[], ebpf::MM_PROGRAM_START),
MemoryRegion::new_writable_gapped(&mut [], ebpf::MM_STACK_START, 4096),
MemoryRegion::new_writable(heap.as_slice_mut(), ebpf::MM_HEAP_START),
MemoryRegion::new_writable(&mut [], ebpf::MM_INPUT_START),
],
&config,
)
.unwrap();
2022-04-11 16:05:09 -07:00
invoke_context
.set_allocator(Rc::new(RefCell::new(BpfAllocator::new(
heap,
ebpf::MM_HEAP_START,
))))
.unwrap();
let mut syscall = SyscallAllocFree {
2022-04-11 16:05:09 -07:00
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
2020-04-18 17:04:13 -07:00
};
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall.call(100, 0, 0, 0, 0, &memory_mapping, &mut result);
assert_ne!(result.unwrap(), 0);
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall.call(100, 0, 0, 0, 0, &memory_mapping, &mut result);
assert_eq!(result.unwrap(), 0);
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall.call(u64::MAX, 0, 0, 0, 0, &memory_mapping, &mut result);
assert_eq!(result.unwrap(), 0);
2020-04-18 17:04:13 -07:00
}
2022-04-11 16:05:09 -07:00
2020-08-24 13:21:34 -07:00
// many small unaligned allocs
{
2022-04-11 16:05:09 -07:00
prepare_mockup!(
invoke_context,
transaction_context,
program_id,
bpf_loader::id(),
);
2022-04-30 01:58:12 -07:00
let mut heap = AlignedMemory::new_with_size(100, HOST_ALIGN);
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
2022-04-30 01:58:12 -07:00
MemoryRegion::new_readonly(&[], ebpf::MM_PROGRAM_START),
MemoryRegion::new_writable_gapped(&mut [], ebpf::MM_STACK_START, 4096),
MemoryRegion::new_writable(heap.as_slice_mut(), ebpf::MM_HEAP_START),
MemoryRegion::new_writable(&mut [], ebpf::MM_INPUT_START),
],
&config,
)
.unwrap();
2022-04-11 16:05:09 -07:00
invoke_context
.set_allocator(Rc::new(RefCell::new(BpfAllocator::new(
heap,
ebpf::MM_HEAP_START,
))))
.unwrap();
invoke_context.set_check_aligned(false);
let mut syscall = SyscallAllocFree {
2022-04-11 16:05:09 -07:00
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
2020-08-24 13:21:34 -07:00
};
for _ in 0..100 {
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall.call(1, 0, 0, 0, 0, &memory_mapping, &mut result);
assert_ne!(result.unwrap(), 0);
2020-08-24 13:21:34 -07:00
}
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall.call(100, 0, 0, 0, 0, &memory_mapping, &mut result);
assert_eq!(result.unwrap(), 0);
2020-08-24 13:21:34 -07:00
}
2022-04-11 16:05:09 -07:00
2020-08-24 13:21:34 -07:00
// many small aligned allocs
2020-04-18 17:04:13 -07:00
{
2022-04-11 16:05:09 -07:00
prepare_mockup!(
invoke_context,
transaction_context,
program_id,
bpf_loader::id(),
);
2022-04-30 01:58:12 -07:00
let mut heap = AlignedMemory::new_with_size(100, HOST_ALIGN);
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
2022-04-30 01:58:12 -07:00
MemoryRegion::new_readonly(&[], ebpf::MM_PROGRAM_START),
MemoryRegion::new_writable_gapped(&mut [], ebpf::MM_STACK_START, 4096),
MemoryRegion::new_writable(heap.as_slice_mut(), ebpf::MM_HEAP_START),
MemoryRegion::new_writable(&mut [], ebpf::MM_INPUT_START),
],
&config,
)
.unwrap();
2022-04-11 16:05:09 -07:00
invoke_context
.set_allocator(Rc::new(RefCell::new(BpfAllocator::new(
heap,
ebpf::MM_HEAP_START,
))))
.unwrap();
let mut syscall = SyscallAllocFree {
2022-04-11 16:05:09 -07:00
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
2020-04-18 17:04:13 -07:00
};
2020-08-17 09:49:21 -07:00
for _ in 0..12 {
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall.call(1, 0, 0, 0, 0, &memory_mapping, &mut result);
assert_ne!(result.unwrap(), 0);
2020-04-18 17:04:13 -07:00
}
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall.call(100, 0, 0, 0, 0, &memory_mapping, &mut result);
assert_eq!(result.unwrap(), 0);
2020-04-18 17:04:13 -07:00
}
2022-04-11 16:05:09 -07:00
2020-08-17 09:49:21 -07:00
// aligned allocs
fn aligned<T>() {
2022-04-11 16:05:09 -07:00
prepare_mockup!(
invoke_context,
transaction_context,
program_id,
bpf_loader::id(),
);
2022-04-30 01:58:12 -07:00
let mut heap = AlignedMemory::new_with_size(100, HOST_ALIGN);
let config = Config::default();
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
2022-04-30 01:58:12 -07:00
MemoryRegion::new_readonly(&[], ebpf::MM_PROGRAM_START),
MemoryRegion::new_writable_gapped(&mut [], ebpf::MM_STACK_START, 4096),
MemoryRegion::new_writable(heap.as_slice_mut(), ebpf::MM_HEAP_START),
MemoryRegion::new_writable(&mut [], ebpf::MM_INPUT_START),
],
&config,
)
.unwrap();
2022-04-11 16:05:09 -07:00
invoke_context
.set_allocator(Rc::new(RefCell::new(BpfAllocator::new(
heap,
ebpf::MM_HEAP_START,
))))
.unwrap();
let mut syscall = SyscallAllocFree {
2022-04-11 16:05:09 -07:00
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
2020-08-17 09:49:21 -07:00
};
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall.call(
size_of::<u8>() as u64,
0,
0,
0,
0,
&memory_mapping,
&mut result,
);
let address = result.unwrap();
2020-08-17 09:49:21 -07:00
assert_ne!(address, 0);
assert_eq!(
(address as *const u8 as usize).wrapping_rem(align_of::<u8>()),
0
);
2020-08-17 09:49:21 -07:00
}
aligned::<u8>();
aligned::<u16>();
aligned::<u32>();
aligned::<u64>();
aligned::<u128>();
2020-04-18 17:04:13 -07:00
}
2020-09-29 23:29:20 -07:00
#[test]
fn test_syscall_sha256() {
let config = Config::default();
prepare_mockup!(
invoke_context,
transaction_context,
program_id,
bpf_loader_deprecated::id(),
);
2020-09-29 23:29:20 -07:00
let bytes1 = "Gaggablaghblagh!";
let bytes2 = "flurbos";
let mock_slice1 = MockSlice {
vm_addr: 0x300000000,
2020-09-29 23:29:20 -07:00
len: bytes1.len(),
};
let mock_slice2 = MockSlice {
vm_addr: 0x400000000,
2020-09-29 23:29:20 -07:00
len: bytes2.len(),
};
let bytes_to_hash = [mock_slice1, mock_slice2];
let hash_result = [0; HASH_BYTES];
2020-09-29 23:29:20 -07:00
let ro_len = bytes_to_hash.len() as u64;
let ro_va = 0x100000000;
let rw_va = 0x200000000;
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: bytes_to_hash.as_ptr() as *const _ as u64,
vm_addr: ro_va,
len: 32,
vm_gap_shift: 63,
is_writable: false,
},
MemoryRegion {
host_addr: hash_result.as_ptr() as *const _ as u64,
vm_addr: rw_va,
len: HASH_BYTES as u64,
vm_gap_shift: 63,
is_writable: true,
},
MemoryRegion {
host_addr: bytes1.as_ptr() as *const _ as u64,
vm_addr: bytes_to_hash[0].vm_addr,
len: bytes1.len() as u64,
vm_gap_shift: 63,
is_writable: false,
},
MemoryRegion {
host_addr: bytes2.as_ptr() as *const _ as u64,
vm_addr: bytes_to_hash[1].vm_addr,
len: bytes2.len() as u64,
vm_gap_shift: 63,
is_writable: false,
},
],
&config,
)
.unwrap();
invoke_context
.get_compute_meter()
.borrow_mut()
.mock_set_remaining(
(invoke_context.get_compute_budget().sha256_base_cost
+ invoke_context.get_compute_budget().mem_op_base_cost.max(
invoke_context
.get_compute_budget()
.sha256_byte_cost
.saturating_mul((bytes1.len() + bytes2.len()) as u64 / 2),
))
* 4,
);
2020-09-29 23:29:20 -07:00
let mut syscall = SyscallSha256 {
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
2020-09-29 23:29:20 -07:00
};
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall.call(ro_va, ro_len, rw_va, 0, 0, &memory_mapping, &mut result);
result.unwrap();
2020-09-29 23:29:20 -07:00
let hash_local = hashv(&[bytes1.as_ref(), bytes2.as_ref()]).to_bytes();
assert_eq!(hash_result, hash_local);
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall.call(
ro_va - 1, // AccessViolation
ro_len,
rw_va,
0,
0,
&memory_mapping,
&mut result,
2020-09-29 23:29:20 -07:00
);
assert_access_violation!(result, ro_va - 1, 32);
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall.call(
2020-09-29 23:29:20 -07:00
ro_va,
ro_len + 1, // AccessViolation
rw_va,
0,
0,
&memory_mapping,
&mut result,
2020-09-29 23:29:20 -07:00
);
assert_access_violation!(result, ro_va, 48);
2021-02-18 23:42:09 -08:00
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
syscall.call(
ro_va,
ro_len,
rw_va - 1, // AccessViolation
0,
0,
&memory_mapping,
&mut result,
2020-09-29 23:29:20 -07:00
);
assert_access_violation!(result, rw_va - 1, HASH_BYTES as u64);
2020-09-29 23:29:20 -07:00
syscall.call(ro_va, ro_len, rw_va, 0, 0, &memory_mapping, &mut result);
2020-09-29 23:29:20 -07:00
assert_eq!(
2021-02-18 23:42:09 -08:00
Err(EbpfError::UserError(BpfError::SyscallError(
2020-09-29 23:29:20 -07:00
SyscallError::InstructionError(InstructionError::ComputationalBudgetExceeded)
))),
result
2020-09-29 23:29:20 -07:00
);
}
2021-04-12 16:04:57 -07:00
#[test]
#[allow(deprecated)]
2021-04-12 16:04:57 -07:00
fn test_syscall_get_sysvar() {
let config = Config::default();
let src_clock = Clock {
slot: 1,
epoch_start_timestamp: 2,
epoch: 3,
leader_schedule_epoch: 4,
unix_timestamp: 5,
};
let src_epochschedule = EpochSchedule {
slots_per_epoch: 1,
leader_schedule_slot_offset: 2,
warmup: false,
first_normal_epoch: 3,
first_normal_slot: 4,
};
let src_fees = Fees {
fee_calculator: FeeCalculator {
lamports_per_signature: 1,
},
};
let src_rent = Rent {
lamports_per_byte_year: 1,
exemption_threshold: 2.0,
burn_percent: 3,
};
let mut sysvar_cache = SysvarCache::default();
sysvar_cache.set_clock(src_clock.clone());
sysvar_cache.set_epoch_schedule(src_epochschedule);
sysvar_cache.set_fees(src_fees.clone());
sysvar_cache.set_rent(src_rent);
prepare_mockup!(
invoke_context,
transaction_context,
program_id,
bpf_loader::id(),
);
invoke_context.sysvar_cache = Cow::Owned(sysvar_cache);
2021-04-12 16:04:57 -07:00
// Test clock sysvar
{
let got_clock = Clock::default();
let got_clock_va = 0x100000000;
2021-04-12 16:04:57 -07:00
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: &got_clock as *const _ as u64,
vm_addr: got_clock_va,
len: size_of::<Clock>() as u64,
vm_gap_shift: 63,
is_writable: true,
},
],
&config,
)
.unwrap();
2021-04-12 16:04:57 -07:00
let mut syscall = SyscallGetClockSysvar {
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
};
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
2021-04-12 16:04:57 -07:00
syscall.call(got_clock_va, 0, 0, 0, 0, &memory_mapping, &mut result);
result.unwrap();
assert_eq!(got_clock, src_clock);
}
// Test epoch_schedule sysvar
{
let got_epochschedule = EpochSchedule::default();
let got_epochschedule_va = 0x100000000;
2021-04-12 16:04:57 -07:00
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: &got_epochschedule as *const _ as u64,
vm_addr: got_epochschedule_va,
len: size_of::<EpochSchedule>() as u64,
vm_gap_shift: 63,
is_writable: true,
},
],
&config,
)
.unwrap();
2021-04-12 16:04:57 -07:00
let mut syscall = SyscallGetEpochScheduleSysvar {
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
};
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
2021-04-12 16:04:57 -07:00
syscall.call(
got_epochschedule_va,
0,
0,
0,
0,
&memory_mapping,
&mut result,
);
result.unwrap();
assert_eq!(got_epochschedule, src_epochschedule);
}
// Test fees sysvar
{
let got_fees = Fees::default();
let got_fees_va = 0x100000000;
2021-04-12 16:04:57 -07:00
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: &got_fees as *const _ as u64,
vm_addr: got_fees_va,
len: size_of::<Fees>() as u64,
vm_gap_shift: 63,
is_writable: true,
},
],
&config,
)
.unwrap();
2021-04-12 16:04:57 -07:00
let mut syscall = SyscallGetFeesSysvar {
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
};
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
2021-04-12 16:04:57 -07:00
syscall.call(got_fees_va, 0, 0, 0, 0, &memory_mapping, &mut result);
result.unwrap();
assert_eq!(got_fees, src_fees);
}
// Test rent sysvar
{
let got_rent = Rent::default();
let got_rent_va = 0x100000000;
2021-04-12 16:04:57 -07:00
let memory_mapping = MemoryMapping::new::<UserError>(
vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: &got_rent as *const _ as u64,
vm_addr: got_rent_va,
len: size_of::<Rent>() as u64,
vm_gap_shift: 63,
is_writable: true,
},
],
&config,
)
.unwrap();
2021-04-12 16:04:57 -07:00
let mut syscall = SyscallGetRentSysvar {
invoke_context: Rc::new(RefCell::new(&mut invoke_context)),
};
let mut result: Result<u64, EbpfError<BpfError>> = Ok(0);
2021-04-12 16:04:57 -07:00
syscall.call(got_rent_va, 0, 0, 0, 0, &memory_mapping, &mut result);
result.unwrap();
assert_eq!(got_rent, src_rent);
}
}
2021-08-16 16:16:52 -07:00
#[test]
fn test_overlapping() {
assert!(!check_overlapping_do_not_use(10, 7, 3));
assert!(check_overlapping_do_not_use(10, 8, 3));
assert!(check_overlapping_do_not_use(10, 9, 3));
assert!(check_overlapping_do_not_use(10, 10, 3));
assert!(check_overlapping_do_not_use(10, 11, 3));
assert!(check_overlapping_do_not_use(10, 12, 3));
assert!(!check_overlapping_do_not_use(10, 13, 3));
2021-08-16 16:16:52 -07:00
}
fn call_program_address_common(
seeds: &[&[u8]],
program_id: &Pubkey,
syscall: &mut dyn SyscallObject<BpfError>,
) -> Result<(Pubkey, u8), EbpfError<BpfError>> {
const SEEDS_VA: u64 = 0x100000000;
const PROGRAM_ID_VA: u64 = 0x200000000;
const ADDRESS_VA: u64 = 0x300000000;
const BUMP_SEED_VA: u64 = 0x400000000;
const SEED_VA: u64 = 0x500000000;
let config = Config::default();
let address = Pubkey::default();
let bump_seed = 0;
let mut mock_slices = Vec::with_capacity(seeds.len());
let mut regions = vec![
MemoryRegion::default(),
MemoryRegion {
host_addr: mock_slices.as_ptr() as u64,
vm_addr: SEEDS_VA,
2022-03-02 14:50:16 -08:00
len: (seeds.len().saturating_mul(size_of::<MockSlice>()) as u64),
vm_gap_shift: 63,
is_writable: false,
},
MemoryRegion {
host_addr: program_id.as_ref().as_ptr() as u64,
vm_addr: PROGRAM_ID_VA,
len: 32,
vm_gap_shift: 63,
is_writable: false,
},
MemoryRegion {
host_addr: address.as_ref().as_ptr() as u64,
vm_addr: ADDRESS_VA,
len: 32,
vm_gap_shift: 63,
is_writable: true,
},
MemoryRegion {
host_addr: &bump_seed as *const u8 as u64,
vm_addr: BUMP_SEED_VA,
len: 32,
vm_gap_shift: 63,
is_writable: true,
},
];
for (i, seed) in seeds.iter().enumerate() {
2022-03-02 14:50:16 -08:00
let vm_addr = SEED_VA.saturating_add((i as u64).saturating_mul(0x100000000));
let mock_slice = MockSlice {
vm_addr,
len: seed.len(),
};
mock_slices.push(mock_slice);
regions.push(MemoryRegion {
host_addr: seed.as_ptr() as u64,
vm_addr,
len: seed.len() as u64,
vm_gap_shift: 63,
is_writable: false,
});
}
let memory_mapping = MemoryMapping::new::<UserError>(regions, &config).unwrap();
let mut result = Ok(0);
syscall.call(
SEEDS_VA,
seeds.len() as u64,
PROGRAM_ID_VA,
ADDRESS_VA,
BUMP_SEED_VA,
&memory_mapping,
&mut result,
);
let _ = result?;
Ok((address, bump_seed))
}
fn create_program_address(
invoke_context: &mut InvokeContext,
seeds: &[&[u8]],
address: &Pubkey,
) -> Result<Pubkey, EbpfError<BpfError>> {
let mut syscall = SyscallCreateProgramAddress {
invoke_context: Rc::new(RefCell::new(invoke_context)),
};
let (address, _) = call_program_address_common(seeds, address, &mut syscall)?;
Ok(address)
}
fn try_find_program_address(
invoke_context: &mut InvokeContext,
seeds: &[&[u8]],
address: &Pubkey,
) -> Result<(Pubkey, u8), EbpfError<BpfError>> {
let mut syscall = SyscallTryFindProgramAddress {
invoke_context: Rc::new(RefCell::new(invoke_context)),
};
call_program_address_common(seeds, address, &mut syscall)
}
#[test]
fn test_create_program_address() {
// These tests duplicate the direct tests in solana_program::pubkey
prepare_mockup!(
invoke_context,
transaction_context,
program_id,
bpf_loader::id(),
);
let address = bpf_loader_upgradeable::id();
let exceeded_seed = &[127; MAX_SEED_LEN + 1];
let result = create_program_address(&mut invoke_context, &[exceeded_seed], &address);
assert_eq!(
result,
Err(SyscallError::BadSeeds(PubkeyError::MaxSeedLengthExceeded).into())
);
assert_eq!(
create_program_address(
&mut invoke_context,
&[b"short_seed", exceeded_seed],
&address,
),
Err(SyscallError::BadSeeds(PubkeyError::MaxSeedLengthExceeded).into())
);
let max_seed = &[0; MAX_SEED_LEN];
assert!(create_program_address(&mut invoke_context, &[max_seed], &address).is_ok());
let exceeded_seeds: &[&[u8]] = &[
&[1],
&[2],
&[3],
&[4],
&[5],
&[6],
&[7],
&[8],
&[9],
&[10],
&[11],
&[12],
&[13],
&[14],
&[15],
&[16],
];
assert!(create_program_address(&mut invoke_context, exceeded_seeds, &address).is_ok());
let max_seeds: &[&[u8]] = &[
&[1],
&[2],
&[3],
&[4],
&[5],
&[6],
&[7],
&[8],
&[9],
&[10],
&[11],
&[12],
&[13],
&[14],
&[15],
&[16],
&[17],
];
assert_eq!(
create_program_address(&mut invoke_context, max_seeds, &address),
Err(SyscallError::BadSeeds(PubkeyError::MaxSeedLengthExceeded).into())
);
assert_eq!(
create_program_address(&mut invoke_context, &[b"", &[1]], &address),
Ok("BwqrghZA2htAcqq8dzP1WDAhTXYTYWj7CHxF5j7TDBAe"
.parse()
.unwrap())
);
assert_eq!(
create_program_address(&mut invoke_context, &["".as_ref(), &[0]], &address),
Ok("13yWmRpaTR4r5nAktwLqMpRNr28tnVUZw26rTvPSSB19"
.parse()
.unwrap())
);
assert_eq!(
create_program_address(&mut invoke_context, &[b"Talking", b"Squirrels"], &address),
Ok("2fnQrngrQT4SeLcdToJAD96phoEjNL2man2kfRLCASVk"
.parse()
.unwrap())
);
let public_key = Pubkey::from_str("SeedPubey1111111111111111111111111111111111").unwrap();
assert_eq!(
create_program_address(&mut invoke_context, &[public_key.as_ref(), &[1]], &address),
Ok("976ymqVnfE32QFe6NfGDctSvVa36LWnvYxhU6G2232YL"
.parse()
.unwrap())
);
assert_ne!(
create_program_address(&mut invoke_context, &[b"Talking", b"Squirrels"], &address)
.unwrap(),
create_program_address(&mut invoke_context, &[b"Talking"], &address).unwrap(),
);
invoke_context
.get_compute_meter()
.borrow_mut()
.mock_set_remaining(0);
assert_eq!(
create_program_address(&mut invoke_context, &[b"", &[1]], &address),
Err(
SyscallError::InstructionError(InstructionError::ComputationalBudgetExceeded)
.into()
)
);
}
#[test]
fn test_find_program_address() {
prepare_mockup!(
invoke_context,
transaction_context,
program_id,
bpf_loader::id(),
);
let cost = invoke_context
.get_compute_budget()
.create_program_address_units;
let address = bpf_loader_upgradeable::id();
let max_tries = 256; // one per seed
for _ in 0..1_000 {
let address = Pubkey::new_unique();
invoke_context
.get_compute_meter()
.borrow_mut()
.mock_set_remaining(cost * max_tries);
let (found_address, bump_seed) =
try_find_program_address(&mut invoke_context, &[b"Lil'", b"Bits"], &address)
.unwrap();
assert_eq!(
found_address,
create_program_address(
&mut invoke_context,
&[b"Lil'", b"Bits", &[bump_seed]],
&address,
)
.unwrap()
);
}
let seeds: &[&[u8]] = &[b""];
invoke_context
.get_compute_meter()
.borrow_mut()
.mock_set_remaining(cost * max_tries);
let (_, bump_seed) =
try_find_program_address(&mut invoke_context, seeds, &address).unwrap();
invoke_context
.get_compute_meter()
.borrow_mut()
.mock_set_remaining(cost * (max_tries - bump_seed as u64));
try_find_program_address(&mut invoke_context, seeds, &address).unwrap();
invoke_context
.get_compute_meter()
.borrow_mut()
.mock_set_remaining(cost * (max_tries - bump_seed as u64 - 1));
assert_eq!(
try_find_program_address(&mut invoke_context, seeds, &address),
Err(
SyscallError::InstructionError(InstructionError::ComputationalBudgetExceeded)
.into()
)
);
let exceeded_seed = &[127; MAX_SEED_LEN + 1];
invoke_context
.get_compute_meter()
.borrow_mut()
.mock_set_remaining(cost * (max_tries - 1));
assert_eq!(
try_find_program_address(&mut invoke_context, &[exceeded_seed], &address),
Err(SyscallError::BadSeeds(PubkeyError::MaxSeedLengthExceeded).into())
);
let exceeded_seeds: &[&[u8]] = &[
&[1],
&[2],
&[3],
&[4],
&[5],
&[6],
&[7],
&[8],
&[9],
&[10],
&[11],
&[12],
&[13],
&[14],
&[15],
&[16],
&[17],
];
invoke_context
.get_compute_meter()
.borrow_mut()
.mock_set_remaining(cost * (max_tries - 1));
assert_eq!(
try_find_program_address(&mut invoke_context, exceeded_seeds, &address),
Err(SyscallError::BadSeeds(PubkeyError::MaxSeedLengthExceeded).into())
);
}
#[test]
fn test_check_type_assumptions() {
2022-03-30 08:28:49 -07:00
check_type_assumptions();
}
2020-04-18 17:04:13 -07:00
}