2019-05-24 16:21:42 -07:00
|
|
|
pub mod alloc;
|
|
|
|
pub mod allocator_bump;
|
2018-10-16 16:33:31 -07:00
|
|
|
pub mod bpf_verifier;
|
2019-06-21 11:08:50 -07:00
|
|
|
pub mod helpers;
|
2018-10-16 16:33:31 -07:00
|
|
|
|
2018-10-16 09:43:49 -07:00
|
|
|
use byteorder::{ByteOrder, LittleEndian, WriteBytesExt};
|
2018-12-14 20:39:10 -08:00
|
|
|
use log::*;
|
2019-08-23 11:03:53 -07:00
|
|
|
use solana_rbpf::{memory_region::MemoryRegion, EbpfVm};
|
2018-12-03 13:32:31 -08:00
|
|
|
use solana_sdk::account::KeyedAccount;
|
2019-11-21 16:34:40 -08:00
|
|
|
use solana_sdk::bpf_loader;
|
2019-03-23 20:12:27 -07:00
|
|
|
use solana_sdk::instruction::InstructionError;
|
2019-11-08 09:19:19 -08:00
|
|
|
use solana_sdk::instruction_processor_utils::{limited_deserialize, next_keyed_account};
|
2018-10-25 11:13:08 -07:00
|
|
|
use solana_sdk::loader_instruction::LoaderInstruction;
|
|
|
|
use solana_sdk::pubkey::Pubkey;
|
2019-10-03 14:22:48 -07:00
|
|
|
use solana_sdk::sysvar::rent;
|
2019-09-06 16:05:01 -07:00
|
|
|
use std::convert::TryFrom;
|
2018-10-16 09:43:49 -07:00
|
|
|
use std::io::prelude::*;
|
2019-06-21 11:08:50 -07:00
|
|
|
use std::io::Error;
|
2018-10-16 09:43:49 -07:00
|
|
|
use std::mem;
|
2019-05-24 16:21:42 -07:00
|
|
|
|
2019-11-20 16:32:19 -08:00
|
|
|
solana_sdk::declare_program!(
|
2019-11-21 16:34:40 -08:00
|
|
|
bpf_loader::BS58_STRING,
|
2019-11-20 16:32:19 -08:00
|
|
|
solana_bpf_loader_program,
|
|
|
|
process_instruction
|
|
|
|
);
|
|
|
|
|
2019-08-23 11:03:53 -07:00
|
|
|
pub fn create_vm(prog: &[u8]) -> Result<(EbpfVm, MemoryRegion), Error> {
|
|
|
|
let mut vm = EbpfVm::new(None)?;
|
2018-10-26 19:38:07 -07:00
|
|
|
vm.set_verifier(bpf_verifier::check)?;
|
2019-10-02 10:07:44 -07:00
|
|
|
vm.set_max_instruction_count(100_000)?;
|
2018-11-06 14:28:46 -08:00
|
|
|
vm.set_elf(&prog)?;
|
2019-05-24 16:21:42 -07:00
|
|
|
|
2019-06-21 11:08:50 -07:00
|
|
|
let heap_region = helpers::register_helpers(&mut vm)?;
|
2019-05-24 16:21:42 -07:00
|
|
|
|
|
|
|
Ok((vm, heap_region))
|
2018-10-26 19:38:07 -07:00
|
|
|
}
|
|
|
|
|
2018-11-13 19:54:41 -08:00
|
|
|
fn serialize_parameters(
|
2018-11-17 17:02:14 -08:00
|
|
|
program_id: &Pubkey,
|
2018-11-13 19:54:41 -08:00
|
|
|
keyed_accounts: &mut [KeyedAccount],
|
|
|
|
data: &[u8],
|
|
|
|
) -> Vec<u8> {
|
2018-10-16 09:43:49 -07:00
|
|
|
assert_eq!(32, mem::size_of::<Pubkey>());
|
|
|
|
|
|
|
|
let mut v: Vec<u8> = Vec::new();
|
|
|
|
v.write_u64::<LittleEndian>(keyed_accounts.len() as u64)
|
|
|
|
.unwrap();
|
|
|
|
for info in keyed_accounts.iter_mut() {
|
2018-11-29 12:32:16 -08:00
|
|
|
v.write_u64::<LittleEndian>(info.signer_key().is_some() as u64)
|
|
|
|
.unwrap();
|
|
|
|
v.write_all(info.unsigned_key().as_ref()).unwrap();
|
2019-03-05 16:28:14 -08:00
|
|
|
v.write_u64::<LittleEndian>(info.account.lamports).unwrap();
|
2019-03-14 09:48:27 -07:00
|
|
|
v.write_u64::<LittleEndian>(info.account.data.len() as u64)
|
2018-10-16 09:43:49 -07:00
|
|
|
.unwrap();
|
2019-03-14 09:48:27 -07:00
|
|
|
v.write_all(&info.account.data).unwrap();
|
2018-11-12 09:29:17 -08:00
|
|
|
v.write_all(info.account.owner.as_ref()).unwrap();
|
2018-10-16 09:43:49 -07:00
|
|
|
}
|
|
|
|
v.write_u64::<LittleEndian>(data.len() as u64).unwrap();
|
|
|
|
v.write_all(data).unwrap();
|
2018-11-17 17:02:14 -08:00
|
|
|
v.write_all(program_id.as_ref()).unwrap();
|
2018-10-16 09:43:49 -07:00
|
|
|
v
|
|
|
|
}
|
|
|
|
|
2018-10-19 18:28:38 -07:00
|
|
|
fn deserialize_parameters(keyed_accounts: &mut [KeyedAccount], buffer: &[u8]) {
|
2018-10-16 09:43:49 -07:00
|
|
|
assert_eq!(32, mem::size_of::<Pubkey>());
|
|
|
|
|
|
|
|
let mut start = mem::size_of::<u64>();
|
|
|
|
for info in keyed_accounts.iter_mut() {
|
2018-11-29 12:32:16 -08:00
|
|
|
start += mem::size_of::<u64>(); // skip signer_key boolean
|
2018-10-16 09:43:49 -07:00
|
|
|
start += mem::size_of::<Pubkey>(); // skip pubkey
|
2019-03-05 16:28:14 -08:00
|
|
|
info.account.lamports = LittleEndian::read_u64(&buffer[start..]);
|
2018-10-16 09:43:49 -07:00
|
|
|
|
2019-03-05 16:28:14 -08:00
|
|
|
start += mem::size_of::<u64>() // skip lamports
|
2018-10-16 09:43:49 -07:00
|
|
|
+ mem::size_of::<u64>(); // skip length tag
|
2019-03-14 09:48:27 -07:00
|
|
|
let end = start + info.account.data.len();
|
|
|
|
info.account.data.clone_from_slice(&buffer[start..end]);
|
2018-10-16 09:43:49 -07:00
|
|
|
|
2019-03-14 09:48:27 -07:00
|
|
|
start += info.account.data.len() // skip data
|
2018-11-12 09:29:17 -08:00
|
|
|
+ mem::size_of::<Pubkey>(); // skip owner
|
2018-10-16 09:43:49 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-06-12 08:49:59 -07:00
|
|
|
pub fn process_instruction(
|
2018-11-17 17:02:14 -08:00
|
|
|
program_id: &Pubkey,
|
|
|
|
keyed_accounts: &mut [KeyedAccount],
|
2019-07-16 09:45:32 -07:00
|
|
|
ix_data: &[u8],
|
2019-03-18 09:05:03 -07:00
|
|
|
) -> Result<(), InstructionError> {
|
2018-12-14 12:36:50 -08:00
|
|
|
solana_logger::setup();
|
2018-10-16 16:33:31 -07:00
|
|
|
|
2019-10-23 19:56:07 -07:00
|
|
|
if let Ok(instruction) = limited_deserialize(ix_data) {
|
2018-10-16 09:43:49 -07:00
|
|
|
match instruction {
|
|
|
|
LoaderInstruction::Write { offset, bytes } => {
|
2019-11-08 09:19:19 -08:00
|
|
|
let mut keyed_accounts_iter = keyed_accounts.iter_mut();
|
|
|
|
let program = next_keyed_account(&mut keyed_accounts_iter)?;
|
|
|
|
if program.signer_key().is_none() {
|
2019-07-16 09:45:32 -07:00
|
|
|
warn!("key[0] did not sign the transaction");
|
2019-11-08 09:19:19 -08:00
|
|
|
return Err(InstructionError::MissingRequiredSignature);
|
2019-07-16 09:45:32 -07:00
|
|
|
}
|
2018-10-16 09:43:49 -07:00
|
|
|
let offset = offset as usize;
|
2018-10-19 18:28:38 -07:00
|
|
|
let len = bytes.len();
|
2019-09-10 16:13:23 -07:00
|
|
|
trace!("Write: offset={} length={}", offset, len);
|
2019-11-08 09:19:19 -08:00
|
|
|
if program.account.data.len() < offset + len {
|
2018-10-30 08:39:10 -07:00
|
|
|
warn!(
|
|
|
|
"Write overflow: {} < {}",
|
2019-11-08 09:19:19 -08:00
|
|
|
program.account.data.len(),
|
2018-10-19 18:28:38 -07:00
|
|
|
offset + len
|
|
|
|
);
|
2019-11-08 09:19:19 -08:00
|
|
|
return Err(InstructionError::AccountDataTooSmall);
|
2018-10-16 09:43:49 -07:00
|
|
|
}
|
2019-11-08 09:19:19 -08:00
|
|
|
program.account.data[offset..offset + len].copy_from_slice(&bytes);
|
2018-10-16 09:43:49 -07:00
|
|
|
}
|
|
|
|
LoaderInstruction::Finalize => {
|
2019-11-08 09:19:19 -08:00
|
|
|
let mut keyed_accounts_iter = keyed_accounts.iter_mut();
|
|
|
|
let program = next_keyed_account(&mut keyed_accounts_iter)?;
|
|
|
|
let rent = next_keyed_account(&mut keyed_accounts_iter)?;
|
|
|
|
|
|
|
|
if program.signer_key().is_none() {
|
2019-07-16 09:45:32 -07:00
|
|
|
warn!("key[0] did not sign the transaction");
|
2019-11-08 09:19:19 -08:00
|
|
|
return Err(InstructionError::MissingRequiredSignature);
|
2019-07-16 09:45:32 -07:00
|
|
|
}
|
2019-10-03 14:22:48 -07:00
|
|
|
|
2019-11-08 09:19:19 -08:00
|
|
|
rent::verify_rent_exemption(&program, &rent)?;
|
2019-10-03 14:22:48 -07:00
|
|
|
|
2019-11-08 09:19:19 -08:00
|
|
|
program.account.executable = true;
|
|
|
|
info!("Finalize: account {:?}", program.signer_key().unwrap());
|
2018-10-16 09:43:49 -07:00
|
|
|
}
|
2019-07-16 09:45:32 -07:00
|
|
|
LoaderInstruction::InvokeMain { data } => {
|
2019-11-08 09:19:19 -08:00
|
|
|
let mut keyed_accounts_iter = keyed_accounts.iter_mut();
|
|
|
|
let program = next_keyed_account(&mut keyed_accounts_iter)?;
|
|
|
|
|
|
|
|
if !program.account.executable {
|
|
|
|
warn!("BPF program account not executable");
|
|
|
|
return Err(InstructionError::AccountNotExecutable);
|
2019-07-16 09:45:32 -07:00
|
|
|
}
|
2019-11-08 09:19:19 -08:00
|
|
|
let (mut vm, heap_region) = match create_vm(&program.account.data) {
|
2019-07-16 09:45:32 -07:00
|
|
|
Ok(info) => info,
|
|
|
|
Err(e) => {
|
|
|
|
warn!("Failed to create BPF VM: {}", e);
|
|
|
|
return Err(InstructionError::GenericError);
|
|
|
|
}
|
|
|
|
};
|
2019-11-08 09:19:19 -08:00
|
|
|
let parameter_accounts = keyed_accounts_iter.into_slice();
|
|
|
|
let mut parameter_bytes =
|
|
|
|
serialize_parameters(program_id, parameter_accounts, &data);
|
2019-07-16 09:45:32 -07:00
|
|
|
|
2019-09-10 16:13:23 -07:00
|
|
|
info!("Call BPF program");
|
2019-11-08 09:19:19 -08:00
|
|
|
match vm.execute_program(parameter_bytes.as_mut_slice(), &[], &[heap_region]) {
|
2019-09-06 16:05:01 -07:00
|
|
|
Ok(status) => match u32::try_from(status) {
|
|
|
|
Ok(status) => {
|
|
|
|
if status > 0 {
|
|
|
|
warn!("BPF program failed: {}", status);
|
|
|
|
return Err(InstructionError::CustomError(status));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Err(e) => {
|
|
|
|
warn!("BPF VM encountered invalid status: {}", e);
|
2019-07-16 09:45:32 -07:00
|
|
|
return Err(InstructionError::GenericError);
|
|
|
|
}
|
2019-09-06 16:05:01 -07:00
|
|
|
},
|
2019-07-16 09:45:32 -07:00
|
|
|
Err(e) => {
|
|
|
|
warn!("BPF VM failed to run program: {}", e);
|
|
|
|
return Err(InstructionError::GenericError);
|
|
|
|
}
|
|
|
|
}
|
2019-11-08 09:19:19 -08:00
|
|
|
deserialize_parameters(parameter_accounts, ¶meter_bytes);
|
2019-09-10 16:13:23 -07:00
|
|
|
info!("BPF program success");
|
2019-07-16 09:45:32 -07:00
|
|
|
}
|
2018-10-16 09:43:49 -07:00
|
|
|
}
|
|
|
|
} else {
|
2019-10-25 16:22:41 -07:00
|
|
|
warn!("Invalid instruction data: {:?}", ix_data);
|
2019-11-08 09:19:19 -08:00
|
|
|
return Err(InstructionError::InvalidInstructionData);
|
2018-10-16 09:43:49 -07:00
|
|
|
}
|
2018-12-03 13:32:31 -08:00
|
|
|
Ok(())
|
2018-10-16 09:43:49 -07:00
|
|
|
}
|
2018-10-31 10:59:56 -07:00
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
|
|
|
use super::*;
|
2019-11-08 09:19:19 -08:00
|
|
|
use solana_sdk::account::Account;
|
|
|
|
use std::fs::File;
|
|
|
|
use std::io::Read;
|
2018-11-06 14:28:46 -08:00
|
|
|
|
2018-10-31 10:59:56 -07:00
|
|
|
#[test]
|
2019-08-23 11:03:53 -07:00
|
|
|
#[should_panic(expected = "Error: Exceeded maximum number of instructions allowed")]
|
2019-11-08 09:19:19 -08:00
|
|
|
fn test_bpf_loader_non_terminating_program() {
|
2018-10-31 10:59:56 -07:00
|
|
|
#[rustfmt::skip]
|
2019-11-08 09:19:19 -08:00
|
|
|
let program = &[
|
2019-02-22 16:27:19 -08:00
|
|
|
0x07, 0x01, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, // r6 + 1
|
|
|
|
0x05, 0x00, 0xfe, 0xff, 0x00, 0x00, 0x00, 0x00, // goto -2
|
2018-10-31 10:59:56 -07:00
|
|
|
0x95, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // exit
|
|
|
|
];
|
|
|
|
let input = &mut [0x00];
|
2018-11-06 14:28:46 -08:00
|
|
|
|
2019-08-23 11:03:53 -07:00
|
|
|
let mut vm = EbpfVm::new(None).unwrap();
|
2018-11-06 14:28:46 -08:00
|
|
|
vm.set_verifier(bpf_verifier::check).unwrap();
|
2019-02-22 16:27:19 -08:00
|
|
|
vm.set_max_instruction_count(10).unwrap();
|
2019-11-08 09:19:19 -08:00
|
|
|
vm.set_program(program).unwrap();
|
2019-05-24 16:21:42 -07:00
|
|
|
vm.execute_program(input, &[], &[]).unwrap();
|
2018-10-31 10:59:56 -07:00
|
|
|
}
|
2019-11-08 09:19:19 -08:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_bpf_loader_write() {
|
|
|
|
let program_id = Pubkey::new_rand();
|
|
|
|
let program_key = Pubkey::new_rand();
|
|
|
|
let mut program_account = Account::new(1, 0, &program_id);
|
|
|
|
let mut keyed_accounts = vec![KeyedAccount::new(&program_key, false, &mut program_account)];
|
|
|
|
let ix_data = bincode::serialize(&LoaderInstruction::Write {
|
|
|
|
offset: 3,
|
|
|
|
bytes: vec![1, 2, 3],
|
|
|
|
})
|
|
|
|
.unwrap();
|
|
|
|
|
|
|
|
// Case: Empty keyed accounts
|
|
|
|
assert_eq!(
|
|
|
|
Err(InstructionError::NotEnoughAccountKeys),
|
|
|
|
process_instruction(&program_id, &mut vec![], &ix_data)
|
|
|
|
);
|
|
|
|
|
|
|
|
// Case: Not signed
|
|
|
|
assert_eq!(
|
|
|
|
Err(InstructionError::MissingRequiredSignature),
|
|
|
|
process_instruction(&program_id, &mut keyed_accounts, &ix_data)
|
|
|
|
);
|
|
|
|
|
|
|
|
// Case: Write bytes to an offset
|
|
|
|
let mut keyed_accounts = vec![KeyedAccount::new(&program_key, true, &mut program_account)];
|
|
|
|
keyed_accounts[0].account.data = vec![0; 6];
|
|
|
|
assert_eq!(
|
|
|
|
Ok(()),
|
|
|
|
process_instruction(&program_id, &mut keyed_accounts, &ix_data)
|
|
|
|
);
|
|
|
|
assert_eq!(vec![0, 0, 0, 1, 2, 3], keyed_accounts[0].account.data);
|
|
|
|
|
|
|
|
// Case: Overflow
|
|
|
|
let mut keyed_accounts = vec![KeyedAccount::new(&program_key, true, &mut program_account)];
|
|
|
|
keyed_accounts[0].account.data = vec![0; 5];
|
|
|
|
assert_eq!(
|
|
|
|
Err(InstructionError::AccountDataTooSmall),
|
|
|
|
process_instruction(&program_id, &mut keyed_accounts, &ix_data)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_bpf_loader_finalize() {
|
|
|
|
let program_id = Pubkey::new_rand();
|
|
|
|
let program_key = Pubkey::new_rand();
|
|
|
|
let rent_key = rent::id();
|
|
|
|
let mut program_account = Account::new(1, 0, &program_id);
|
|
|
|
let mut keyed_accounts = vec![KeyedAccount::new(&program_key, false, &mut program_account)];
|
|
|
|
let ix_data = bincode::serialize(&LoaderInstruction::Finalize).unwrap();
|
|
|
|
|
|
|
|
// Case: Empty keyed accounts
|
|
|
|
assert_eq!(
|
|
|
|
Err(InstructionError::NotEnoughAccountKeys),
|
|
|
|
process_instruction(&program_id, &mut vec![], &ix_data)
|
|
|
|
);
|
|
|
|
|
|
|
|
let mut rent_account = rent::create_account(1, &rent::Rent::default());
|
|
|
|
keyed_accounts.push(KeyedAccount::new(&rent_key, false, &mut rent_account));
|
|
|
|
|
|
|
|
// Case: Not signed
|
|
|
|
assert_eq!(
|
|
|
|
Err(InstructionError::MissingRequiredSignature),
|
|
|
|
process_instruction(&program_id, &mut keyed_accounts, &ix_data)
|
|
|
|
);
|
|
|
|
|
|
|
|
// Case: Finalize
|
|
|
|
let mut keyed_accounts = vec![
|
|
|
|
KeyedAccount::new(&program_key, true, &mut program_account),
|
|
|
|
KeyedAccount::new(&rent_key, false, &mut rent_account),
|
|
|
|
];
|
|
|
|
assert_eq!(
|
|
|
|
Ok(()),
|
|
|
|
process_instruction(&program_id, &mut keyed_accounts, &ix_data)
|
|
|
|
);
|
|
|
|
assert!(keyed_accounts[0].account.executable);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_bpf_loader_invoke_main() {
|
|
|
|
let program_id = Pubkey::new_rand();
|
|
|
|
let program_key = Pubkey::new_rand();
|
|
|
|
|
|
|
|
// Create program account
|
|
|
|
let mut file = File::open("test_elfs/noop.so").expect("file open failed");
|
|
|
|
let mut elf = Vec::new();
|
|
|
|
file.read_to_end(&mut elf).unwrap();
|
|
|
|
let mut program_account = Account::new(1, 0, &program_id);
|
|
|
|
program_account.data = elf;
|
|
|
|
program_account.executable = true;
|
|
|
|
|
|
|
|
let mut keyed_accounts = vec![KeyedAccount::new(&program_key, false, &mut program_account)];
|
|
|
|
let ix_data = bincode::serialize(&LoaderInstruction::InvokeMain { data: vec![] }).unwrap();
|
|
|
|
|
|
|
|
// Case: Empty keyed accounts
|
|
|
|
assert_eq!(
|
|
|
|
Err(InstructionError::NotEnoughAccountKeys),
|
|
|
|
process_instruction(&program_id, &mut vec![], &ix_data)
|
|
|
|
);
|
|
|
|
|
|
|
|
// Case: Only a program account
|
|
|
|
assert_eq!(
|
|
|
|
Ok(()),
|
|
|
|
process_instruction(&program_id, &mut keyed_accounts, &ix_data)
|
|
|
|
);
|
|
|
|
|
|
|
|
// Case: Account not executable
|
|
|
|
keyed_accounts[0].account.executable = false;
|
|
|
|
assert_eq!(
|
|
|
|
Err(InstructionError::AccountNotExecutable),
|
|
|
|
process_instruction(&program_id, &mut keyed_accounts, &ix_data)
|
|
|
|
);
|
|
|
|
keyed_accounts[0].account.executable = true;
|
|
|
|
|
|
|
|
// Case: With program and parameter account
|
|
|
|
let mut parameter_account = Account::new(1, 0, &program_id);
|
|
|
|
keyed_accounts.push(KeyedAccount::new(
|
|
|
|
&program_key,
|
|
|
|
false,
|
|
|
|
&mut parameter_account,
|
|
|
|
));
|
|
|
|
assert_eq!(
|
|
|
|
Ok(()),
|
|
|
|
process_instruction(&program_id, &mut keyed_accounts, &ix_data)
|
|
|
|
);
|
|
|
|
}
|
2018-10-31 10:59:56 -07:00
|
|
|
}
|