Refactor: move instructions sysvar serialization out of Message (#22544)
This commit is contained in:
parent
f8db314134
commit
7ba57e7a7c
|
@ -218,7 +218,7 @@ impl Accounts {
|
||||||
message: &SanitizedMessage,
|
message: &SanitizedMessage,
|
||||||
is_owned_by_sysvar: bool,
|
is_owned_by_sysvar: bool,
|
||||||
) -> AccountSharedData {
|
) -> AccountSharedData {
|
||||||
let data = construct_instructions_data(message);
|
let data = construct_instructions_data(&message.decompile_instructions());
|
||||||
let owner = if is_owned_by_sysvar {
|
let owner = if is_owned_by_sysvar {
|
||||||
sysvar::id()
|
sysvar::id()
|
||||||
} else {
|
} else {
|
||||||
|
|
|
@ -7,7 +7,7 @@ use {
|
||||||
instruction::{AccountMeta, Instruction},
|
instruction::{AccountMeta, Instruction},
|
||||||
message::{Message, SanitizedMessage},
|
message::{Message, SanitizedMessage},
|
||||||
pubkey::{self, Pubkey},
|
pubkey::{self, Pubkey},
|
||||||
sysvar::instructions,
|
sysvar::instructions::{self, construct_instructions_data},
|
||||||
},
|
},
|
||||||
std::convert::TryFrom,
|
std::convert::TryFrom,
|
||||||
test::Bencher,
|
test::Bencher,
|
||||||
|
@ -28,13 +28,14 @@ fn bench_bincode_instruction_serialize(b: &mut Bencher) {
|
||||||
}
|
}
|
||||||
|
|
||||||
#[bench]
|
#[bench]
|
||||||
fn bench_manual_instruction_serialize(b: &mut Bencher) {
|
fn bench_construct_instructions_data(b: &mut Bencher) {
|
||||||
let instructions = make_instructions();
|
let instructions = make_instructions();
|
||||||
let message =
|
let message =
|
||||||
SanitizedMessage::try_from(Message::new(&instructions, Some(&Pubkey::new_unique())))
|
SanitizedMessage::try_from(Message::new(&instructions, Some(&Pubkey::new_unique())))
|
||||||
.unwrap();
|
.unwrap();
|
||||||
b.iter(|| {
|
b.iter(|| {
|
||||||
test::black_box(message.serialize_instructions());
|
let instructions = message.decompile_instructions();
|
||||||
|
test::black_box(construct_instructions_data(&instructions));
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -53,7 +54,7 @@ fn bench_manual_instruction_deserialize(b: &mut Bencher) {
|
||||||
let message =
|
let message =
|
||||||
SanitizedMessage::try_from(Message::new(&instructions, Some(&Pubkey::new_unique())))
|
SanitizedMessage::try_from(Message::new(&instructions, Some(&Pubkey::new_unique())))
|
||||||
.unwrap();
|
.unwrap();
|
||||||
let serialized = message.serialize_instructions();
|
let serialized = construct_instructions_data(&message.decompile_instructions());
|
||||||
b.iter(|| {
|
b.iter(|| {
|
||||||
for i in 0..instructions.len() {
|
for i in 0..instructions.len() {
|
||||||
#[allow(deprecated)]
|
#[allow(deprecated)]
|
||||||
|
@ -68,7 +69,7 @@ fn bench_manual_instruction_deserialize_single(b: &mut Bencher) {
|
||||||
let message =
|
let message =
|
||||||
SanitizedMessage::try_from(Message::new(&instructions, Some(&Pubkey::new_unique())))
|
SanitizedMessage::try_from(Message::new(&instructions, Some(&Pubkey::new_unique())))
|
||||||
.unwrap();
|
.unwrap();
|
||||||
let serialized = message.serialize_instructions();
|
let serialized = construct_instructions_data(&message.decompile_instructions());
|
||||||
b.iter(|| {
|
b.iter(|| {
|
||||||
#[allow(deprecated)]
|
#[allow(deprecated)]
|
||||||
test::black_box(instructions::load_instruction_at(3, &serialized).unwrap());
|
test::black_box(instructions::load_instruction_at(3, &serialized).unwrap());
|
||||||
|
|
|
@ -9,9 +9,6 @@ use {
|
||||||
message::MessageHeader,
|
message::MessageHeader,
|
||||||
pubkey::Pubkey,
|
pubkey::Pubkey,
|
||||||
sanitize::{Sanitize, SanitizeError},
|
sanitize::{Sanitize, SanitizeError},
|
||||||
serialize_utils::{
|
|
||||||
append_slice, append_u16, append_u8, read_pubkey, read_slice, read_u16, read_u8,
|
|
||||||
},
|
|
||||||
short_vec, system_instruction, system_program, sysvar, wasm_bindgen,
|
short_vec, system_instruction, system_program, sysvar, wasm_bindgen,
|
||||||
},
|
},
|
||||||
lazy_static::lazy_static,
|
lazy_static::lazy_static,
|
||||||
|
@ -400,100 +397,13 @@ impl Message {
|
||||||
(writable_keys, readonly_keys)
|
(writable_keys, readonly_keys)
|
||||||
}
|
}
|
||||||
|
|
||||||
// First encode the number of instructions:
|
|
||||||
// [0..2 - num_instructions
|
|
||||||
//
|
|
||||||
// Then a table of offsets of where to find them in the data
|
|
||||||
// 3..2 * num_instructions table of instruction offsets
|
|
||||||
//
|
|
||||||
// Each instruction is then encoded as:
|
|
||||||
// 0..2 - num_accounts
|
|
||||||
// 2 - meta_byte -> (bit 0 signer, bit 1 is_writable)
|
|
||||||
// 3..35 - pubkey - 32 bytes
|
|
||||||
// 35..67 - program_id
|
|
||||||
// 67..69 - data len - u16
|
|
||||||
// 69..data_len - data
|
|
||||||
#[deprecated]
|
#[deprecated]
|
||||||
pub fn serialize_instructions(&self) -> Vec<u8> {
|
|
||||||
// 64 bytes is a reasonable guess, calculating exactly is slower in benchmarks
|
|
||||||
let mut data = Vec::with_capacity(self.instructions.len() * (32 * 2));
|
|
||||||
append_u16(&mut data, self.instructions.len() as u16);
|
|
||||||
for _ in 0..self.instructions.len() {
|
|
||||||
append_u16(&mut data, 0);
|
|
||||||
}
|
|
||||||
for (i, instruction) in self.instructions.iter().enumerate() {
|
|
||||||
let start_instruction_offset = data.len() as u16;
|
|
||||||
let start = 2 + (2 * i);
|
|
||||||
data[start..start + 2].copy_from_slice(&start_instruction_offset.to_le_bytes());
|
|
||||||
append_u16(&mut data, instruction.accounts.len() as u16);
|
|
||||||
for account_index in &instruction.accounts {
|
|
||||||
let account_index = *account_index as usize;
|
|
||||||
let is_signer = self.is_signer(account_index);
|
|
||||||
let is_writable = self.is_writable(account_index);
|
|
||||||
let mut meta_byte = 0;
|
|
||||||
if is_signer {
|
|
||||||
meta_byte |= 1 << Self::IS_SIGNER_BIT;
|
|
||||||
}
|
|
||||||
if is_writable {
|
|
||||||
meta_byte |= 1 << Self::IS_WRITABLE_BIT;
|
|
||||||
}
|
|
||||||
append_u8(&mut data, meta_byte);
|
|
||||||
append_slice(&mut data, self.account_keys[account_index].as_ref());
|
|
||||||
}
|
|
||||||
|
|
||||||
let program_id = &self.account_keys[instruction.program_id_index as usize];
|
|
||||||
append_slice(&mut data, program_id.as_ref());
|
|
||||||
append_u16(&mut data, instruction.data.len() as u16);
|
|
||||||
append_slice(&mut data, &instruction.data);
|
|
||||||
}
|
|
||||||
data
|
|
||||||
}
|
|
||||||
|
|
||||||
const IS_SIGNER_BIT: usize = 0;
|
|
||||||
const IS_WRITABLE_BIT: usize = 1;
|
|
||||||
|
|
||||||
pub fn deserialize_instruction(
|
pub fn deserialize_instruction(
|
||||||
index: usize,
|
index: usize,
|
||||||
data: &[u8],
|
data: &[u8],
|
||||||
) -> Result<Instruction, SanitizeError> {
|
) -> Result<Instruction, SanitizeError> {
|
||||||
let mut current = 0;
|
#[allow(deprecated)]
|
||||||
let num_instructions = read_u16(&mut current, data)?;
|
sysvar::instructions::load_instruction_at(index, data)
|
||||||
if index >= num_instructions as usize {
|
|
||||||
return Err(SanitizeError::IndexOutOfBounds);
|
|
||||||
}
|
|
||||||
|
|
||||||
// index into the instruction byte-offset table.
|
|
||||||
current += index * 2;
|
|
||||||
let start = read_u16(&mut current, data)?;
|
|
||||||
|
|
||||||
current = start as usize;
|
|
||||||
let num_accounts = read_u16(&mut current, data)?;
|
|
||||||
let mut accounts = Vec::with_capacity(num_accounts as usize);
|
|
||||||
for _ in 0..num_accounts {
|
|
||||||
let meta_byte = read_u8(&mut current, data)?;
|
|
||||||
let mut is_signer = false;
|
|
||||||
let mut is_writable = false;
|
|
||||||
if meta_byte & (1 << Self::IS_SIGNER_BIT) != 0 {
|
|
||||||
is_signer = true;
|
|
||||||
}
|
|
||||||
if meta_byte & (1 << Self::IS_WRITABLE_BIT) != 0 {
|
|
||||||
is_writable = true;
|
|
||||||
}
|
|
||||||
let pubkey = read_pubkey(&mut current, data)?;
|
|
||||||
accounts.push(AccountMeta {
|
|
||||||
pubkey,
|
|
||||||
is_signer,
|
|
||||||
is_writable,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
let program_id = read_pubkey(&mut current, data)?;
|
|
||||||
let data_len = read_u16(&mut current, data)?;
|
|
||||||
let data = read_slice(&mut current, data, data_len as usize)?;
|
|
||||||
Ok(Instruction {
|
|
||||||
program_id,
|
|
||||||
accounts,
|
|
||||||
data,
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn signer_keys(&self) -> Vec<&Pubkey> {
|
pub fn signer_keys(&self) -> Vec<&Pubkey> {
|
||||||
|
@ -930,59 +840,6 @@ mod tests {
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_decompile_instructions() {
|
|
||||||
solana_logger::setup();
|
|
||||||
let program_id0 = Pubkey::new_unique();
|
|
||||||
let program_id1 = Pubkey::new_unique();
|
|
||||||
let id0 = Pubkey::new_unique();
|
|
||||||
let id1 = Pubkey::new_unique();
|
|
||||||
let id2 = Pubkey::new_unique();
|
|
||||||
let id3 = Pubkey::new_unique();
|
|
||||||
let instructions = vec![
|
|
||||||
Instruction::new_with_bincode(program_id0, &0, vec![AccountMeta::new(id0, false)]),
|
|
||||||
Instruction::new_with_bincode(program_id0, &0, vec![AccountMeta::new(id1, true)]),
|
|
||||||
Instruction::new_with_bincode(
|
|
||||||
program_id1,
|
|
||||||
&0,
|
|
||||||
vec![AccountMeta::new_readonly(id2, false)],
|
|
||||||
),
|
|
||||||
Instruction::new_with_bincode(
|
|
||||||
program_id1,
|
|
||||||
&0,
|
|
||||||
vec![AccountMeta::new_readonly(id3, true)],
|
|
||||||
),
|
|
||||||
];
|
|
||||||
|
|
||||||
let message = Message::new(&instructions, Some(&id1));
|
|
||||||
let serialized = message.serialize_instructions();
|
|
||||||
for (i, instruction) in instructions.iter().enumerate() {
|
|
||||||
assert_eq!(
|
|
||||||
Message::deserialize_instruction(i, &serialized).unwrap(),
|
|
||||||
*instruction
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_decompile_instructions_out_of_bounds() {
|
|
||||||
solana_logger::setup();
|
|
||||||
let program_id0 = Pubkey::new_unique();
|
|
||||||
let id0 = Pubkey::new_unique();
|
|
||||||
let id1 = Pubkey::new_unique();
|
|
||||||
let instructions = vec![
|
|
||||||
Instruction::new_with_bincode(program_id0, &0, vec![AccountMeta::new(id0, false)]),
|
|
||||||
Instruction::new_with_bincode(program_id0, &0, vec![AccountMeta::new(id1, true)]),
|
|
||||||
];
|
|
||||||
|
|
||||||
let message = Message::new(&instructions, Some(&id1));
|
|
||||||
let serialized = message.serialize_instructions();
|
|
||||||
assert_eq!(
|
|
||||||
Message::deserialize_instruction(instructions.len(), &serialized).unwrap_err(),
|
|
||||||
SanitizeError::IndexOutOfBounds,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_program_ids() {
|
fn test_program_ids() {
|
||||||
let key0 = Pubkey::new_unique();
|
let key0 = Pubkey::new_unique();
|
||||||
|
|
|
@ -11,10 +11,9 @@ use {
|
||||||
program_utils::limited_deserialize,
|
program_utils::limited_deserialize,
|
||||||
pubkey::Pubkey,
|
pubkey::Pubkey,
|
||||||
sanitize::{Sanitize, SanitizeError},
|
sanitize::{Sanitize, SanitizeError},
|
||||||
serialize_utils::{append_slice, append_u16, append_u8},
|
|
||||||
solana_program::{system_instruction::SystemInstruction, system_program},
|
solana_program::{system_instruction::SystemInstruction, system_program},
|
||||||
|
sysvar::instructions::{BorrowedAccountMeta, BorrowedInstruction},
|
||||||
},
|
},
|
||||||
bitflags::bitflags,
|
|
||||||
std::convert::TryFrom,
|
std::convert::TryFrom,
|
||||||
thiserror::Error,
|
thiserror::Error,
|
||||||
};
|
};
|
||||||
|
@ -57,14 +56,6 @@ impl TryFrom<LegacyMessage> for SanitizedMessage {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
bitflags! {
|
|
||||||
struct InstructionsSysvarAccountMeta: u8 {
|
|
||||||
const NONE = 0b00000000;
|
|
||||||
const IS_SIGNER = 0b00000001;
|
|
||||||
const IS_WRITABLE = 0b00000010;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl SanitizedMessage {
|
impl SanitizedMessage {
|
||||||
/// Return true if this message contains duplicate account keys
|
/// Return true if this message contains duplicate account keys
|
||||||
pub fn has_duplicates(&self) -> bool {
|
pub fn has_duplicates(&self) -> bool {
|
||||||
|
@ -199,57 +190,6 @@ impl SanitizedMessage {
|
||||||
index < usize::from(self.header().num_required_signatures)
|
index < usize::from(self.header().num_required_signatures)
|
||||||
}
|
}
|
||||||
|
|
||||||
// First encode the number of instructions:
|
|
||||||
// [0..2 - num_instructions
|
|
||||||
//
|
|
||||||
// Then a table of offsets of where to find them in the data
|
|
||||||
// 3..2 * num_instructions table of instruction offsets
|
|
||||||
//
|
|
||||||
// Each instruction is then encoded as:
|
|
||||||
// 0..2 - num_accounts
|
|
||||||
// 2 - meta_byte -> (bit 0 signer, bit 1 is_writable)
|
|
||||||
// 3..35 - pubkey - 32 bytes
|
|
||||||
// 35..67 - program_id
|
|
||||||
// 67..69 - data len - u16
|
|
||||||
// 69..data_len - data
|
|
||||||
#[allow(clippy::integer_arithmetic)]
|
|
||||||
pub fn serialize_instructions(&self) -> Vec<u8> {
|
|
||||||
// 64 bytes is a reasonable guess, calculating exactly is slower in benchmarks
|
|
||||||
let mut data = Vec::with_capacity(self.instructions().len() * (32 * 2));
|
|
||||||
append_u16(&mut data, self.instructions().len() as u16);
|
|
||||||
for _ in 0..self.instructions().len() {
|
|
||||||
append_u16(&mut data, 0);
|
|
||||||
}
|
|
||||||
for (i, (program_id, instruction)) in self.program_instructions_iter().enumerate() {
|
|
||||||
let start_instruction_offset = data.len() as u16;
|
|
||||||
let start = 2 + (2 * i);
|
|
||||||
data[start..start + 2].copy_from_slice(&start_instruction_offset.to_le_bytes());
|
|
||||||
append_u16(&mut data, instruction.accounts.len() as u16);
|
|
||||||
for account_index in &instruction.accounts {
|
|
||||||
let account_index = *account_index as usize;
|
|
||||||
let is_signer = self.is_signer(account_index);
|
|
||||||
let is_writable = self.is_writable(account_index);
|
|
||||||
let mut account_meta = InstructionsSysvarAccountMeta::NONE;
|
|
||||||
if is_signer {
|
|
||||||
account_meta |= InstructionsSysvarAccountMeta::IS_SIGNER;
|
|
||||||
}
|
|
||||||
if is_writable {
|
|
||||||
account_meta |= InstructionsSysvarAccountMeta::IS_WRITABLE;
|
|
||||||
}
|
|
||||||
append_u8(&mut data, account_meta.bits());
|
|
||||||
append_slice(
|
|
||||||
&mut data,
|
|
||||||
self.get_account_key(account_index).unwrap().as_ref(),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
append_slice(&mut data, program_id.as_ref());
|
|
||||||
append_u16(&mut data, instruction.data.len() as u16);
|
|
||||||
append_slice(&mut data, &instruction.data);
|
|
||||||
}
|
|
||||||
data
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Return the resolved addresses for this message if it has any.
|
/// Return the resolved addresses for this message if it has any.
|
||||||
fn loaded_lookup_table_addresses(&self) -> Option<&LoadedAddresses> {
|
fn loaded_lookup_table_addresses(&self) -> Option<&LoadedAddresses> {
|
||||||
match &self {
|
match &self {
|
||||||
|
@ -288,6 +228,32 @@ impl SanitizedMessage {
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Decompile message instructions without cloning account keys
|
||||||
|
pub fn decompile_instructions(&self) -> Vec<BorrowedInstruction> {
|
||||||
|
self.program_instructions_iter()
|
||||||
|
.map(|(program_id, instruction)| {
|
||||||
|
let accounts = instruction
|
||||||
|
.accounts
|
||||||
|
.iter()
|
||||||
|
.map(|account_index| {
|
||||||
|
let account_index = *account_index as usize;
|
||||||
|
BorrowedAccountMeta {
|
||||||
|
is_signer: self.is_signer(account_index),
|
||||||
|
is_writable: self.is_writable(account_index),
|
||||||
|
pubkey: self.get_account_key(account_index).unwrap(),
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
|
||||||
|
BorrowedInstruction {
|
||||||
|
accounts,
|
||||||
|
data: &instruction.data,
|
||||||
|
program_id,
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.collect()
|
||||||
|
}
|
||||||
|
|
||||||
/// Inspect all message keys for the bpf upgradeable loader
|
/// Inspect all message keys for the bpf upgradeable loader
|
||||||
pub fn is_upgradeable_loader_present(&self) -> bool {
|
pub fn is_upgradeable_loader_present(&self) -> bool {
|
||||||
match self {
|
match self {
|
||||||
|
@ -414,47 +380,6 @@ mod tests {
|
||||||
assert_eq!(v0_message.num_readonly_accounts(), 3);
|
assert_eq!(v0_message.num_readonly_accounts(), 3);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
|
||||||
#[allow(deprecated)]
|
|
||||||
fn test_serialize_instructions() {
|
|
||||||
let program_id0 = Pubkey::new_unique();
|
|
||||||
let program_id1 = Pubkey::new_unique();
|
|
||||||
let id0 = Pubkey::new_unique();
|
|
||||||
let id1 = Pubkey::new_unique();
|
|
||||||
let id2 = Pubkey::new_unique();
|
|
||||||
let id3 = Pubkey::new_unique();
|
|
||||||
let instructions = vec![
|
|
||||||
Instruction::new_with_bincode(program_id0, &0, vec![AccountMeta::new(id0, false)]),
|
|
||||||
Instruction::new_with_bincode(program_id0, &0, vec![AccountMeta::new(id1, true)]),
|
|
||||||
Instruction::new_with_bincode(
|
|
||||||
program_id1,
|
|
||||||
&0,
|
|
||||||
vec![AccountMeta::new_readonly(id2, false)],
|
|
||||||
),
|
|
||||||
Instruction::new_with_bincode(
|
|
||||||
program_id1,
|
|
||||||
&0,
|
|
||||||
vec![AccountMeta::new_readonly(id3, true)],
|
|
||||||
),
|
|
||||||
];
|
|
||||||
|
|
||||||
let message = LegacyMessage::new(&instructions, Some(&id1));
|
|
||||||
let sanitized_message = SanitizedMessage::try_from(message.clone()).unwrap();
|
|
||||||
let serialized = sanitized_message.serialize_instructions();
|
|
||||||
|
|
||||||
// assert that SanitizedMessage::serialize_instructions has the same behavior as the
|
|
||||||
// deprecated Message::serialize_instructions method
|
|
||||||
assert_eq!(serialized, message.serialize_instructions());
|
|
||||||
|
|
||||||
// assert that Message::deserialize_instruction is compatible with SanitizedMessage::serialize_instructions
|
|
||||||
for (i, instruction) in instructions.iter().enumerate() {
|
|
||||||
assert_eq!(
|
|
||||||
LegacyMessage::deserialize_instruction(i, &serialized).unwrap(),
|
|
||||||
*instruction
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_try_compile_instruction() {
|
fn test_try_compile_instruction() {
|
||||||
let key0 = Pubkey::new_unique();
|
let key0 = Pubkey::new_unique();
|
||||||
|
|
|
@ -1,9 +1,17 @@
|
||||||
#![allow(clippy::integer_arithmetic)]
|
#![allow(clippy::integer_arithmetic)]
|
||||||
//! This account contains the serialized transaction instructions
|
//! This account contains the serialized transaction instructions
|
||||||
|
|
||||||
use crate::{
|
use crate::{
|
||||||
account_info::AccountInfo, instruction::Instruction, program_error::ProgramError,
|
account_info::AccountInfo,
|
||||||
|
instruction::{AccountMeta, Instruction},
|
||||||
|
program_error::ProgramError,
|
||||||
|
pubkey::Pubkey,
|
||||||
sanitize::SanitizeError,
|
sanitize::SanitizeError,
|
||||||
|
serialize_utils::{read_pubkey, read_slice, read_u16, read_u8},
|
||||||
|
};
|
||||||
|
#[cfg(not(target_arch = "bpf"))]
|
||||||
|
use {
|
||||||
|
crate::serialize_utils::{append_slice, append_u16, append_u8},
|
||||||
|
bitflags::bitflags,
|
||||||
};
|
};
|
||||||
|
|
||||||
// Instructions Sysvar, dummy type, use the associated helpers instead of the Sysvar trait
|
// Instructions Sysvar, dummy type, use the associated helpers instead of the Sysvar trait
|
||||||
|
@ -11,16 +19,85 @@ pub struct Instructions();
|
||||||
|
|
||||||
crate::declare_sysvar_id!("Sysvar1nstructions1111111111111111111111111", Instructions);
|
crate::declare_sysvar_id!("Sysvar1nstructions1111111111111111111111111", Instructions);
|
||||||
|
|
||||||
// Construct the account data for the Instruction sSysvar
|
// Construct the account data for the Instructions Sysvar
|
||||||
#[cfg(not(target_arch = "bpf"))]
|
#[cfg(not(target_arch = "bpf"))]
|
||||||
pub fn construct_instructions_data(message: &crate::message::SanitizedMessage) -> Vec<u8> {
|
pub fn construct_instructions_data(instructions: &[BorrowedInstruction]) -> Vec<u8> {
|
||||||
let mut data = message.serialize_instructions();
|
let mut data = serialize_instructions(instructions);
|
||||||
// add room for current instruction index.
|
// add room for current instruction index.
|
||||||
data.resize(data.len() + 2, 0);
|
data.resize(data.len() + 2, 0);
|
||||||
|
|
||||||
data
|
data
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Borrowed version of AccountMeta
|
||||||
|
pub struct BorrowedAccountMeta<'a> {
|
||||||
|
pub pubkey: &'a Pubkey,
|
||||||
|
pub is_signer: bool,
|
||||||
|
pub is_writable: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Borrowed version of Instruction
|
||||||
|
pub struct BorrowedInstruction<'a> {
|
||||||
|
pub program_id: &'a Pubkey,
|
||||||
|
pub accounts: Vec<BorrowedAccountMeta<'a>>,
|
||||||
|
pub data: &'a [u8],
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(not(target_arch = "bpf"))]
|
||||||
|
bitflags! {
|
||||||
|
struct InstructionsSysvarAccountMeta: u8 {
|
||||||
|
const NONE = 0b00000000;
|
||||||
|
const IS_SIGNER = 0b00000001;
|
||||||
|
const IS_WRITABLE = 0b00000010;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// First encode the number of instructions:
|
||||||
|
// [0..2 - num_instructions
|
||||||
|
//
|
||||||
|
// Then a table of offsets of where to find them in the data
|
||||||
|
// 3..2 * num_instructions table of instruction offsets
|
||||||
|
//
|
||||||
|
// Each instruction is then encoded as:
|
||||||
|
// 0..2 - num_accounts
|
||||||
|
// 2 - meta_byte -> (bit 0 signer, bit 1 is_writable)
|
||||||
|
// 3..35 - pubkey - 32 bytes
|
||||||
|
// 35..67 - program_id
|
||||||
|
// 67..69 - data len - u16
|
||||||
|
// 69..data_len - data
|
||||||
|
#[cfg(not(target_arch = "bpf"))]
|
||||||
|
fn serialize_instructions(instructions: &[BorrowedInstruction]) -> Vec<u8> {
|
||||||
|
// 64 bytes is a reasonable guess, calculating exactly is slower in benchmarks
|
||||||
|
let mut data = Vec::with_capacity(instructions.len() * (32 * 2));
|
||||||
|
append_u16(&mut data, instructions.len() as u16);
|
||||||
|
for _ in 0..instructions.len() {
|
||||||
|
append_u16(&mut data, 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (i, instruction) in instructions.iter().enumerate() {
|
||||||
|
let start_instruction_offset = data.len() as u16;
|
||||||
|
let start = 2 + (2 * i);
|
||||||
|
data[start..start + 2].copy_from_slice(&start_instruction_offset.to_le_bytes());
|
||||||
|
append_u16(&mut data, instruction.accounts.len() as u16);
|
||||||
|
for account_meta in &instruction.accounts {
|
||||||
|
let mut account_meta_flags = InstructionsSysvarAccountMeta::NONE;
|
||||||
|
if account_meta.is_signer {
|
||||||
|
account_meta_flags |= InstructionsSysvarAccountMeta::IS_SIGNER;
|
||||||
|
}
|
||||||
|
if account_meta.is_writable {
|
||||||
|
account_meta_flags |= InstructionsSysvarAccountMeta::IS_WRITABLE;
|
||||||
|
}
|
||||||
|
append_u8(&mut data, account_meta_flags.bits());
|
||||||
|
append_slice(&mut data, account_meta.pubkey.as_ref());
|
||||||
|
}
|
||||||
|
|
||||||
|
append_slice(&mut data, instruction.program_id.as_ref());
|
||||||
|
append_u16(&mut data, instruction.data.len() as u16);
|
||||||
|
append_slice(&mut data, instruction.data);
|
||||||
|
}
|
||||||
|
data
|
||||||
|
}
|
||||||
|
|
||||||
/// Load the current `Instruction`'s index in the currently executing
|
/// Load the current `Instruction`'s index in the currently executing
|
||||||
/// `Transaction` from the Instructions Sysvar data
|
/// `Transaction` from the Instructions Sysvar data
|
||||||
#[deprecated(
|
#[deprecated(
|
||||||
|
@ -56,6 +133,50 @@ pub fn store_current_index(data: &mut [u8], instruction_index: u16) {
|
||||||
data[last_index..last_index + 2].copy_from_slice(&instruction_index.to_le_bytes());
|
data[last_index..last_index + 2].copy_from_slice(&instruction_index.to_le_bytes());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn deserialize_instruction(index: usize, data: &[u8]) -> Result<Instruction, SanitizeError> {
|
||||||
|
const IS_SIGNER_BIT: usize = 0;
|
||||||
|
const IS_WRITABLE_BIT: usize = 1;
|
||||||
|
|
||||||
|
let mut current = 0;
|
||||||
|
let num_instructions = read_u16(&mut current, data)?;
|
||||||
|
if index >= num_instructions as usize {
|
||||||
|
return Err(SanitizeError::IndexOutOfBounds);
|
||||||
|
}
|
||||||
|
|
||||||
|
// index into the instruction byte-offset table.
|
||||||
|
current += index * 2;
|
||||||
|
let start = read_u16(&mut current, data)?;
|
||||||
|
|
||||||
|
current = start as usize;
|
||||||
|
let num_accounts = read_u16(&mut current, data)?;
|
||||||
|
let mut accounts = Vec::with_capacity(num_accounts as usize);
|
||||||
|
for _ in 0..num_accounts {
|
||||||
|
let meta_byte = read_u8(&mut current, data)?;
|
||||||
|
let mut is_signer = false;
|
||||||
|
let mut is_writable = false;
|
||||||
|
if meta_byte & (1 << IS_SIGNER_BIT) != 0 {
|
||||||
|
is_signer = true;
|
||||||
|
}
|
||||||
|
if meta_byte & (1 << IS_WRITABLE_BIT) != 0 {
|
||||||
|
is_writable = true;
|
||||||
|
}
|
||||||
|
let pubkey = read_pubkey(&mut current, data)?;
|
||||||
|
accounts.push(AccountMeta {
|
||||||
|
pubkey,
|
||||||
|
is_signer,
|
||||||
|
is_writable,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
let program_id = read_pubkey(&mut current, data)?;
|
||||||
|
let data_len = read_u16(&mut current, data)?;
|
||||||
|
let data = read_slice(&mut current, data, data_len as usize)?;
|
||||||
|
Ok(Instruction {
|
||||||
|
program_id,
|
||||||
|
accounts,
|
||||||
|
data,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
/// Load an `Instruction` in the currently executing `Transaction` at the
|
/// Load an `Instruction` in the currently executing `Transaction` at the
|
||||||
/// specified index
|
/// specified index
|
||||||
#[deprecated(
|
#[deprecated(
|
||||||
|
@ -63,7 +184,7 @@ pub fn store_current_index(data: &mut [u8], instruction_index: u16) {
|
||||||
note = "Unsafe because the sysvar accounts address is not checked, please use `load_instruction_at_checked` instead"
|
note = "Unsafe because the sysvar accounts address is not checked, please use `load_instruction_at_checked` instead"
|
||||||
)]
|
)]
|
||||||
pub fn load_instruction_at(index: usize, data: &[u8]) -> Result<Instruction, SanitizeError> {
|
pub fn load_instruction_at(index: usize, data: &[u8]) -> Result<Instruction, SanitizeError> {
|
||||||
crate::message::Message::deserialize_instruction(index, data)
|
deserialize_instruction(index, data)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Load an `Instruction` in the currently executing `Transaction` at the
|
/// Load an `Instruction` in the currently executing `Transaction` at the
|
||||||
|
@ -77,11 +198,9 @@ pub fn load_instruction_at_checked(
|
||||||
}
|
}
|
||||||
|
|
||||||
let instruction_sysvar = instruction_sysvar_account_info.try_borrow_data()?;
|
let instruction_sysvar = instruction_sysvar_account_info.try_borrow_data()?;
|
||||||
crate::message::Message::deserialize_instruction(index, &instruction_sysvar).map_err(|err| {
|
deserialize_instruction(index, &instruction_sysvar).map_err(|err| match err {
|
||||||
match err {
|
SanitizeError::IndexOutOfBounds => ProgramError::InvalidArgument,
|
||||||
SanitizeError::IndexOutOfBounds => ProgramError::InvalidArgument,
|
_ => ProgramError::InvalidInstructionData,
|
||||||
_ => ProgramError::InvalidInstructionData,
|
|
||||||
}
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -117,7 +236,11 @@ pub fn get_instruction_relative(
|
||||||
mod tests {
|
mod tests {
|
||||||
use {
|
use {
|
||||||
super::*,
|
super::*,
|
||||||
crate::{instruction::AccountMeta, message::Message, pubkey::Pubkey},
|
crate::{
|
||||||
|
instruction::AccountMeta,
|
||||||
|
message::{Message as LegacyMessage, SanitizedMessage},
|
||||||
|
pubkey::Pubkey,
|
||||||
|
},
|
||||||
std::convert::TryFrom,
|
std::convert::TryFrom,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -143,7 +266,7 @@ mod tests {
|
||||||
&0,
|
&0,
|
||||||
vec![AccountMeta::new(Pubkey::new_unique(), false)],
|
vec![AccountMeta::new(Pubkey::new_unique(), false)],
|
||||||
);
|
);
|
||||||
let sanitized_message = crate::message::SanitizedMessage::try_from(Message::new(
|
let sanitized_message = SanitizedMessage::try_from(LegacyMessage::new(
|
||||||
&[instruction0.clone(), instruction1.clone()],
|
&[instruction0.clone(), instruction1.clone()],
|
||||||
Some(&Pubkey::new_unique()),
|
Some(&Pubkey::new_unique()),
|
||||||
))
|
))
|
||||||
|
@ -151,7 +274,7 @@ mod tests {
|
||||||
|
|
||||||
let key = id();
|
let key = id();
|
||||||
let mut lamports = 0;
|
let mut lamports = 0;
|
||||||
let mut data = construct_instructions_data(&sanitized_message);
|
let mut data = construct_instructions_data(&sanitized_message.decompile_instructions());
|
||||||
let owner = crate::sysvar::id();
|
let owner = crate::sysvar::id();
|
||||||
let mut account_info = AccountInfo::new(
|
let mut account_info = AccountInfo::new(
|
||||||
&key,
|
&key,
|
||||||
|
@ -197,7 +320,7 @@ mod tests {
|
||||||
&0,
|
&0,
|
||||||
vec![AccountMeta::new(Pubkey::new_unique(), false)],
|
vec![AccountMeta::new(Pubkey::new_unique(), false)],
|
||||||
);
|
);
|
||||||
let sanitized_message = crate::message::SanitizedMessage::try_from(Message::new(
|
let sanitized_message = SanitizedMessage::try_from(LegacyMessage::new(
|
||||||
&[instruction0, instruction1],
|
&[instruction0, instruction1],
|
||||||
Some(&Pubkey::new_unique()),
|
Some(&Pubkey::new_unique()),
|
||||||
))
|
))
|
||||||
|
@ -205,7 +328,7 @@ mod tests {
|
||||||
|
|
||||||
let key = id();
|
let key = id();
|
||||||
let mut lamports = 0;
|
let mut lamports = 0;
|
||||||
let mut data = construct_instructions_data(&sanitized_message);
|
let mut data = construct_instructions_data(&sanitized_message.decompile_instructions());
|
||||||
store_current_index(&mut data, 1);
|
store_current_index(&mut data, 1);
|
||||||
let owner = crate::sysvar::id();
|
let owner = crate::sysvar::id();
|
||||||
let mut account_info = AccountInfo::new(
|
let mut account_info = AccountInfo::new(
|
||||||
|
@ -251,7 +374,7 @@ mod tests {
|
||||||
&0,
|
&0,
|
||||||
vec![AccountMeta::new(Pubkey::new_unique(), false)],
|
vec![AccountMeta::new(Pubkey::new_unique(), false)],
|
||||||
);
|
);
|
||||||
let sanitized_message = crate::message::SanitizedMessage::try_from(Message::new(
|
let sanitized_message = SanitizedMessage::try_from(LegacyMessage::new(
|
||||||
&[
|
&[
|
||||||
instruction0.clone(),
|
instruction0.clone(),
|
||||||
instruction1.clone(),
|
instruction1.clone(),
|
||||||
|
@ -263,7 +386,7 @@ mod tests {
|
||||||
|
|
||||||
let key = id();
|
let key = id();
|
||||||
let mut lamports = 0;
|
let mut lamports = 0;
|
||||||
let mut data = construct_instructions_data(&sanitized_message);
|
let mut data = construct_instructions_data(&sanitized_message.decompile_instructions());
|
||||||
store_current_index(&mut data, 1);
|
store_current_index(&mut data, 1);
|
||||||
let owner = crate::sysvar::id();
|
let owner = crate::sysvar::id();
|
||||||
let mut account_info = AccountInfo::new(
|
let mut account_info = AccountInfo::new(
|
||||||
|
@ -329,4 +452,59 @@ mod tests {
|
||||||
get_instruction_relative(0, &account_info)
|
get_instruction_relative(0, &account_info)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_serialize_instructions() {
|
||||||
|
let program_id0 = Pubkey::new_unique();
|
||||||
|
let program_id1 = Pubkey::new_unique();
|
||||||
|
let id0 = Pubkey::new_unique();
|
||||||
|
let id1 = Pubkey::new_unique();
|
||||||
|
let id2 = Pubkey::new_unique();
|
||||||
|
let id3 = Pubkey::new_unique();
|
||||||
|
let instructions = vec![
|
||||||
|
Instruction::new_with_bincode(program_id0, &0, vec![AccountMeta::new(id0, false)]),
|
||||||
|
Instruction::new_with_bincode(program_id0, &0, vec![AccountMeta::new(id1, true)]),
|
||||||
|
Instruction::new_with_bincode(
|
||||||
|
program_id1,
|
||||||
|
&0,
|
||||||
|
vec![AccountMeta::new_readonly(id2, false)],
|
||||||
|
),
|
||||||
|
Instruction::new_with_bincode(
|
||||||
|
program_id1,
|
||||||
|
&0,
|
||||||
|
vec![AccountMeta::new_readonly(id3, true)],
|
||||||
|
),
|
||||||
|
];
|
||||||
|
|
||||||
|
let message = LegacyMessage::new(&instructions, Some(&id1));
|
||||||
|
let sanitized_message = SanitizedMessage::try_from(message).unwrap();
|
||||||
|
let serialized = serialize_instructions(&sanitized_message.decompile_instructions());
|
||||||
|
|
||||||
|
// assert that deserialize_instruction is compatible with SanitizedMessage::serialize_instructions
|
||||||
|
for (i, instruction) in instructions.iter().enumerate() {
|
||||||
|
assert_eq!(
|
||||||
|
deserialize_instruction(i, &serialized).unwrap(),
|
||||||
|
*instruction
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_decompile_instructions_out_of_bounds() {
|
||||||
|
let program_id0 = Pubkey::new_unique();
|
||||||
|
let id0 = Pubkey::new_unique();
|
||||||
|
let id1 = Pubkey::new_unique();
|
||||||
|
let instructions = vec![
|
||||||
|
Instruction::new_with_bincode(program_id0, &0, vec![AccountMeta::new(id0, false)]),
|
||||||
|
Instruction::new_with_bincode(program_id0, &0, vec![AccountMeta::new(id1, true)]),
|
||||||
|
];
|
||||||
|
|
||||||
|
let message =
|
||||||
|
SanitizedMessage::try_from(LegacyMessage::new(&instructions, Some(&id1))).unwrap();
|
||||||
|
let serialized = serialize_instructions(&message.decompile_instructions());
|
||||||
|
assert_eq!(
|
||||||
|
deserialize_instruction(instructions.len(), &serialized).unwrap_err(),
|
||||||
|
SanitizeError::IndexOutOfBounds,
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue