Struct midenc_codegen_masm::Program

pub struct Program { /* private fields */ }

A Program represents a complete set of modules which are intended to be shipped and executed together.

Implementations

impl Program

pub fn new<M>( entrypoint: FunctionIdent, segments: DataSegmentTable, modules: M, ) -> Self

where M: IntoIterator<Item = Box<Module>>,

Create a new Program initialized from a DataSegmentTable, a set of Modules, and an optional entrypoint function.

A main.masm module will be generated which invokes the given entrypoint on startup, after initializing the global heap of the root context, based on the provided data segment table.

You should generally prefer to use Program::from_hir, but this constructor allows you to manually produce a MASM program from its constituent parts.

pub fn from_hir( program: &Program, globals: &GlobalVariableAnalysis<Program>, ) -> Result<Self, Report>

Create a new Program initialized from an hir::Program.

The resulting Program will have the following:

• Data segments described by the original hir::Program
• The entrypoint function which will be invoked after the initialization phase of startup
• If an entrypoint is set, an executable Module which performs initialization and then invokes the entrypoint

None of the HIR modules will have been added yet

pub fn link_kernel(&mut self, kernel: KernelLibrary)

Link this Program against the given kernel during assembly

pub fn link_library(&mut self, library: CompiledLibrary)

Link this Program against the given library during assembly

pub fn link_libraries(&self) -> &[CompiledLibrary]

Get the set of CompiledLibrary this program links against

pub fn advice_inputs(&self) -> AdviceInputs

Get the expected miden_processor::AdviceInputs needed to execute this program.

pub fn entrypoint(&self) -> FunctionIdent

pub fn stack_pointer(&self) -> Option<u32>

pub fn freeze(self: Box<Self>) -> Arc<Program>

Freezes this program, preventing further modifications

pub fn modules(&self) -> impl Iterator<Item = &Module> + '_

Get an iterator over the modules in this program

pub fn unwrap_frozen_modules(&self) -> &FrozenModuleTree

Access the frozen module tree of this program, and panic if not frozen

pub fn insert(&mut self, module: Box<Module>)

Insert a module into this program.

The insertion order is not preserved - modules are ordered by name.

NOTE: This function will panic if the program has been frozen

pub fn get<Q>(&self, name: &Q) -> Option<&Module>

where Q: ?Sized + Ord, Ident: Borrow<Q>,

Get a reference to a module in this program by name

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

where Ident: PartialEq<N>,

Returns true if this program contains a Module named name

pub fn write_to_directory<P: AsRef<Path>>( &self, path: P, session: &Session, ) -> Result<()>

Write this Program to the given output directory.

pub fn assemble(&self, session: &Session) -> Result<Arc<Program>, Report>

Trait Implementations

impl Clone for Program

fn clone(&self) -> Program

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Display for Program

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

Formats the value using the given formatter.

impl Emit for Program

fn name(&self) -> Option<Symbol>

The name of this item, if applicable

fn output_type(&self, _mode: OutputMode) -> OutputType

The output type associated with this item and the given mode

fn write_to<W: Write>( &self, writer: W, mode: OutputMode, _session: &Session, ) -> Result<()>

Write this item to the given std::io::Write handle, using mode to determine the output type

fn write_to_stdout(&self, session: &Session) -> Result<(), Error>

Write this item to standard output, inferring the best OutputMode based on whether or not stdout is a tty or not

fn write_to_file( &self, path: &Path, mode: OutputMode, session: &Session, ) -> Result<(), Error>

Write this item to the given file path, using mode to determine the output type