Struct Program

pub struct Program { /* private fields */ }

A Program is a collection of Modules that are being compiled together as a package.

This is primarily used for storing/querying data which must be shared across modules:

• The set of global variables which will be allocated on the global heap
• The set of modules and functions which have been defined

When translating to Miden Assembly, we need something like this to allow us to perform some basic linker tasks prior to emitting the textual MASM which will be fed to the Miden VM.

This structure is intended to be allocated via std::sync::Arc, so that it can be shared across multiple threads which are emitting/compiling modules at the same time. It is designed so that individual fields are locked, rather than the structure as a whole, to minimize contention. The intuition is that, in general, changes at the Program level are relatively infrequent, i.e. only when declaring a new Module, or GlobalVariable, do we actually need to mutate the structure. In all other situations, changes are scoped at the Module level.

Implementations

impl Program

pub fn new() -> Self

Create a new, empty Program.

pub const fn page_size(&self) -> u32

Get the default page size for this program

pub const fn reserved_memory_pages(&self) -> u32

Get the size of the reserved linear memory (in pages) region for this program

pub const fn reserved_memory_bytes(&self) -> u32

Get the size of the reserved linear memory (in bytes) region for this program

pub fn add_library(&mut self, lib: CompiledLibrary)

Add to the set of libraries this Program will be assembled with

pub fn has_entrypoint(&self) -> bool

Returns true if this program has a defined entrypoint

pub fn is_executable(&self) -> bool

Returns true if this program is executable.

An executable program is one which has an entrypoint that will be called after the program is loaded.

pub fn entrypoint(&self) -> Option<FunctionIdent>

Returns the FunctionIdent corresponding to the program entrypoint

pub fn modules(&self) -> &RBTree<ModuleTreeAdapter>

Return a reference to the module table for this program

pub fn modules_mut(&mut self) -> &mut RBTree<ModuleTreeAdapter>

Return a mutable reference to the module table for this program

pub fn libraries(&self) -> &BTreeMap<RpoDigest, CompiledLibrary>

Return the set of libraries this program links against

pub fn libraries_mut(&mut self) -> &mut BTreeMap<RpoDigest, CompiledLibrary>

Return the set of libraries this program links against as a mutable reference

pub fn segments(&self) -> &DataSegmentTable

Return a reference to the data segment table for this program

pub fn globals(&self) -> &GlobalVariableTable

Get a reference to the global variable table for this program

pub fn globals_mut(&mut self) -> &mut GlobalVariableTable

Get a mutable reference to the global variable table for this program

pub fn contains(&self, name: Ident) -> bool

Returns true if name is defined in this program.

pub fn signature(&self, id: &FunctionIdent) -> Option<&Signature>

Look up the signature of a function in this program by id

Trait Implementations

impl AnalysisKey for Program

type Key = ProgramAnalysisKey

The type of the unique identifier associated with Self

fn key(&self) -> Self::Key

Get the key to associate with the current entity

impl Default for Program

fn default() -> Self

Returns the “default value” for a type.