Struct solana_rbpf::elf::Executable

source · [−]

pub struct Executable<E: UserDefinedError, I: InstructionMeter> { /* private fields */ }

Expand description

Elf loader/relocator

Implementations

source

impl<E: UserDefinedError, I: InstructionMeter> Executable<E, I>

source

pub fn get_config(&self) -> &Config

Get the configuration settings

source

pub fn get_text_bytes(&self) -> (u64, &[u8 ])

Get the .text section virtual address and bytes

source

pub fn get_ro_section(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Get the concatenated read-only sections (including the text section)

source

pub fn get_entrypoint_instruction_offset(&self) -> Result<usize, EbpfError<E>>

Get the entry point offset into the text section

source

pub fn lookup_bpf_function(&self, hash: u32) -> Option<usize>

Get a symbol’s instruction offset

source

pub fn get_syscall_registry(&self) -> &SyscallRegistry

Get the syscall registry

source

pub fn get_compiled_program(&self) -> Option<&JitProgram<E, I>>

Get the JIT compiled program

source

pub fn jit_compile(executable: &mut Pin<Box<Self>>) -> Result<(), EbpfError<E>>

JIT compile the executable

source

pub fn report_unresolved_symbol(
&self,
insn_offset: usize
) -> Result<u64, EbpfError<E>>

Report information on a symbol that failed to be resolved

source

pub fn get_function_symbols(&self) -> BTreeMap<usize, (u32, String )>

Get syscalls and BPF functions (if debug symbols are not stripped)

source

pub fn get_syscall_symbols(&self) -> &BTreeMap<u32, String>

Get syscalls symbols

source

pub fn new_from_text_bytes(
 config: Config,
 text_bytes: &[u8 ],
 syscall_registry: SyscallRegistry,
 bpf_functions: BTreeMap<u32, (usize, String )>
) -> Self

Create from raw text section bytes (list of instructions)

source

pub fn load(
 config: Config,
 bytes: &[u8 ],
 syscall_registry: SyscallRegistry
) -> Result<Self, ElfError>

Fully loads an ELF, including validation and relocation

source

pub fn mem_size(&self) -> usize

Calculate the total memory size of the executable

source

pub fn fixup_relative_calls(
 enable_symbol_and_section_labels: bool,
 bpf_functions: &mut BTreeMap<u32, (usize, String )>,
 elf_bytes: &mut [u8 ]
) -> Result<(), ElfError>

Fix-ups relative calls

source

pub fn validate(
 _config: &Config,
 elf: &Elf<'_>,
 elf_bytes: &[u8 ]
) -> Result<(), ElfError>

Validates the ELF

source

impl<E: UserDefinedError, I: 'static + InstructionMeter> Executable<E, I>

Static constructors for Executable

source

pub fn from_elf(
 elf_bytes: &[u8 ],
 verifier: Option<Verifier>,
 config: Config,
 syscall_registry: SyscallRegistry
) -> Result<Pin<Box<Self>>, EbpfError<E>>

Creates a verified executable from an ELF file

source

pub fn from_text_bytes(
 text_bytes: &[u8 ],
 verifier: Option<Verifier>,
 config: Config,
 syscall_registry: SyscallRegistry,
 bpf_functions: BTreeMap<u32, (usize, String )>
) -> Result<Pin<Box<Self>>, EbpfError<E>>

Creates a verified executable from machine code

Trait Implementations

source

impl<E: Debug + UserDefinedError, I: Debug + InstructionMeter> Debug for Executable<E, I>

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl<E: PartialEq + UserDefinedError, I: PartialEq + InstructionMeter> PartialEq<Executable<E, I>> for Executable<E, I>

source

fn eq(&self, other: &Executable<E, I>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &Executable<E, I>) -> bool

This method tests for !=.

source

impl<E: UserDefinedError, I: InstructionMeter> StructuralPartialEq for Executable<E, I>

Auto Trait Implementations

impl<E, I> RefUnwindSafe for Executable<E, I>

impl<E, I> Send for Executable<E, I>

impl<E, I> Sync for Executable<E, I>

impl<E, I> Unpin for Executable<E, I>

impl<E, I> !UnwindSafe for Executable<E, I>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct solana_rbpf::elf::Executable

Implementations

impl<E: UserDefinedError, I: InstructionMeter> Executable<E, I>

pub fn get_config(&self) -> &Config

pub fn get_text_bytes(&self) -> (u64, &[u8])

pub fn get_ro_section(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

pub fn get_entrypoint_instruction_offset(&self) -> Result<usize, EbpfError<E>>

pub fn lookup_bpf_function(&self, hash: u32) -> Option<usize>

pub fn get_syscall_registry(&self) -> &SyscallRegistry

pub fn get_compiled_program(&self) -> Option<&JitProgram<E, I>>

pub fn jit_compile(executable: &mut Pin<Box<Self>>) -> Result<(), EbpfError<E>>

pub fn report_unresolved_symbol( &self, insn_offset: usize) -> Result<u64, EbpfError<E>>

pub fn get_function_symbols(&self) -> BTreeMap<usize, (u32, String)>

pub fn get_syscall_symbols(&self) -> &BTreeMap<u32, String>

pub fn new_from_text_bytes( config: Config, text_bytes: &[u8], syscall_registry: SyscallRegistry, bpf_functions: BTreeMap<u32, (usize, String)>) -> Self

pub fn load( config: Config, bytes: &[u8], syscall_registry: SyscallRegistry) -> Result<Self, ElfError>

pub fn mem_size(&self) -> usize

pub fn fixup_relative_calls( enable_symbol_and_section_labels: bool, bpf_functions: &mut BTreeMap<u32, (usize, String)>, elf_bytes: &mut [u8]) -> Result<(), ElfError>

pub fn validate( _config: &Config, elf: &Elf<'_>, elf_bytes: &[u8]) -> Result<(), ElfError>

impl<E: UserDefinedError, I: 'static + InstructionMeter> Executable<E, I>

pub fn from_elf( elf_bytes: &[u8], verifier: Option<Verifier>, config: Config, syscall_registry: SyscallRegistry) -> Result<Pin<Box<Self>>, EbpfError<E>>

pub fn from_text_bytes( text_bytes: &[u8], verifier: Option<Verifier>, config: Config, syscall_registry: SyscallRegistry, bpf_functions: BTreeMap<u32, (usize, String)>) -> Result<Pin<Box<Self>>, EbpfError<E>>

Trait Implementations

impl<E: Debug + UserDefinedError, I: Debug + InstructionMeter> Debug for Executable<E, I>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl<E: PartialEq + UserDefinedError, I: PartialEq + InstructionMeter> PartialEq<Executable<E, I>> for Executable<E, I>

fn eq(&self, other: &Executable<E, I>) -> bool

fn ne(&self, other: &Executable<E, I>) -> bool

impl<E: UserDefinedError, I: InstructionMeter> StructuralPartialEq for Executable<E, I>

Auto Trait Implementations

impl<E, I> RefUnwindSafe for Executable<E, I>

impl<E, I> Send for Executable<E, I>

impl<E, I> Sync for Executable<E, I>

impl<E, I> Unpin for Executable<E, I>

impl<E, I> !UnwindSafe for Executable<E, I>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

pub fn get_text_bytes(&self) -> (u64, &[u8 ])

pub fn get_ro_section(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

pub fn report_unresolved_symbol(
&self,
insn_offset: usize
) -> Result<u64, EbpfError<E>>

pub fn get_function_symbols(&self) -> BTreeMap<usize, (u32, String )>

pub fn new_from_text_bytes(
config: Config,
text_bytes: &[u8 ],
syscall_registry: SyscallRegistry,
bpf_functions: BTreeMap<u32, (usize, String )>
) -> Self

pub fn load(
config: Config,
bytes: &[u8 ],
syscall_registry: SyscallRegistry
) -> Result<Self, ElfError>

pub fn fixup_relative_calls(
enable_symbol_and_section_labels: bool,
bpf_functions: &mut BTreeMap<u32, (usize, String )>,
elf_bytes: &mut [u8 ]
) -> Result<(), ElfError>

pub fn validate(
_config: &Config,
elf: &Elf<'_>,
elf_bytes: &[u8 ]
) -> Result<(), ElfError>

pub fn from_elf(
elf_bytes: &[u8 ],
verifier: Option<Verifier>,
config: Config,
syscall_registry: SyscallRegistry
) -> Result<Pin<Box<Self>>, EbpfError<E>>

pub fn from_text_bytes(
text_bytes: &[u8 ],
verifier: Option<Verifier>,
config: Config,
syscall_registry: SyscallRegistry,
bpf_functions: BTreeMap<u32, (usize, String )>
) -> Result<Pin<Box<Self>>, EbpfError<E>>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,