miden-vm 0.22.1

Miden virtual machine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

use std::path::PathBuf;

use clap::Parser;
use miden_assembly::{
    Assembler, Library, PathBuf as LibraryPath,
    diagnostics::{IntoDiagnostic, Report},
};
use miden_core_lib::CoreLibrary;

#[derive(Debug, Clone, Parser)]
#[command(
    name = "Compile Library",
    about = "Bundles .masm files into a single .masl library with access to the core library."
)]
pub struct BundleCmd {
    /// Disable debug symbols (release mode)
    #[arg(short = 'r', long = "release")]
    release: bool,
    /// Path to a directory containing the `.masm` files which are part of the library.
    #[arg(value_parser)]
    dir: PathBuf,
    /// Defines the top-level namespace, e.g. `mylib`, otherwise the directory name is used. For a
    /// kernel library the namespace defaults to `kernel`.
    #[arg(short, long)]
    namespace: Option<String>,
    /// Version of the library, defaults to `0.1.0`.
    #[arg(short, long, default_value = "0.1.0")]
    version: String,
    /// Build a kernel library from module `kernel` and using the library `dir` as kernel
    /// namespace. The `kernel` file should not be in the directory `dir`.
    #[arg(short, long)]
    kernel: Option<PathBuf>,
    /// Path of the output `.masl` file.
    #[arg(short, long)]
    output: Option<PathBuf>,
}

impl BundleCmd {
    pub fn execute(&self) -> Result<(), Report> {
        println!("============================================================");
        println!("Build library");
        println!("============================================================");

        let mut assembler = Assembler::default();

        if self.dir.is_file() {
            return Err(Report::msg("`dir` must be a directory."));
        }
        let dir = self.dir.file_name().ok_or("`dir` cannot end with `..`.").map_err(Report::msg)?;

        // write the masl output
        let output_file = match &self.output {
            Some(output) => output,
            None => {
                let parent =
                    &self.dir.parent().ok_or("Invalid output path").map_err(Report::msg)?;
                &parent.join("out").with_extension(Library::LIBRARY_EXTENSION)
            },
        };

        match &self.kernel {
            Some(kernel) => {
                if !kernel.is_file() {
                    return Err(Report::msg("`kernel` must be a file"));
                };
                assembler.link_dynamic_library(CoreLibrary::default())?;
                let library = assembler.assemble_kernel_from_dir(kernel, Some(&self.dir))?;
                library.write_to_file(output_file).into_diagnostic()?;
                println!(
                    "Built kernel module {} with library {}",
                    kernel.display(),
                    &self.dir.display()
                );
            },
            None => {
                let namespace = match &self.namespace {
                    Some(namespace) => namespace.to_string(),
                    None => dir.to_string_lossy().into_owned(),
                };
                let library_namespace = LibraryPath::new(&namespace).into_diagnostic()?;
                assembler.link_dynamic_library(CoreLibrary::default())?;
                let library = assembler.assemble_library_from_dir(&self.dir, library_namespace)?;
                library.write_to_file(output_file).into_diagnostic()?;
                println!("Built library {namespace}");
            },
        }

        Ok(())
    }
}