Struct cairo_vm::vm::vm_memory::memory_segments::MemorySegmentManager

pub struct MemorySegmentManager {
    pub segment_sizes: HashMap<usize, usize>,
    pub segment_used_sizes: Option<Vec<usize>>,
    pub public_memory_offsets: HashMap<usize, Vec<(usize, usize)>>,
    /* private fields */
}

Fields

segment_sizes: HashMap<usize, usize>

segment_used_sizes: Option<Vec<usize>>

public_memory_offsets: HashMap<usize, Vec<(usize, usize)>>

Implementations

impl MemorySegmentManager

pub fn num_segments(&self) -> usize

Number of segments in the real memory

pub fn num_temp_segments(&self) -> usize

Number of segments in the temporary memory

pub fn add(&mut self) -> Relocatable

Adds a new segment and returns its starting location as a Relocatable value. Its segment index will always be positive.

pub fn add_temporary_segment(&mut self) -> Relocatable

Adds a new temporary segment and returns its starting location as a Relocatable value. Its segment index will always be negative.

pub fn load_data( &mut self, ptr: Relocatable, data: &[MaybeRelocatable], ) -> Result<Relocatable, MemoryError>

Writes data into the memory from address ptr and returns the first address after the data.

pub fn new() -> MemorySegmentManager

pub fn compute_effective_sizes(&mut self) -> &Vec<usize>

Calculates the size of each memory segment.

pub fn get_segment_used_size(&self, index: usize) -> Option<usize>

Returns the number of used segments if they have been computed. Returns None otherwise.

pub fn get_segment_size(&self, index: usize) -> Option<usize>

pub fn relocate_segments(&self) -> Result<Vec<usize>, MemoryError>

Returns a vector containing the first relocated address of each memory segment

pub fn gen_arg( &mut self, arg: &dyn Any, ) -> Result<MaybeRelocatable, MemoryError>

pub fn gen_cairo_arg( &mut self, arg: &CairoArg, ) -> Result<MaybeRelocatable, VirtualMachineError>

pub fn write_arg( &mut self, ptr: Relocatable, arg: &dyn Any, ) -> Result<MaybeRelocatable, MemoryError>

pub fn is_valid_memory_value( &self, value: &MaybeRelocatable, ) -> Result<bool, MemoryError>

pub fn get_memory_holes( &self, builtin_segment_indexes: HashSet<usize>, ) -> Result<usize, MemoryError>

Counts the memory holes (aka unaccessed memory cells) in memory

Parameters

• builtin_segment_indexes: Set representing the segments indexes of the builtins initialized in the VM, except for the output builtin.

pub fn get_public_memory_addresses( &self, segment_offsets: &[usize], ) -> Result<Vec<(usize, usize)>, MemoryError>

Returns a list of addresses of memory cells that constitute the public memory. segment_offsets is the result of self.relocate_segments()

pub fn finalize( &mut self, size: Option<usize>, segment_index: usize, public_memory: Option<&Vec<(usize, usize)>>, )

Trait Implementations

impl Default for MemorySegmentManager

fn default() -> Self

Returns the “default value” for a type.

impl Display for MemorySegmentManager

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

Formats the value using the given formatter.