aluvm 0.12.0

Functional registry-based RISC 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
91
92
93
94

// Reference rust implementation of AluVM (arithmetic logic unit virtual machine).
// To find more on AluVM please check <https://aluvm.org>
//
// SPDX-License-Identifier: Apache-2.0
//
// Designed in 2021-2025 by Dr Maxim Orlovsky <orlovsky@ubideco.org>
// Written in 2021-2025 by Dr Maxim Orlovsky <orlovsky@ubideco.org>
//
// Copyright (C) 2021-2024 LNP/BP Standards Association, Switzerland.
// Copyright (C) 2024-2025 Laboratories for Ubiquitous Deterministic Computing (UBIDECO),
//                         Institute for Distributed and Cognitive Systems (InDCS), Switzerland.
// Copyright (C) 2021-2025 Dr Maxim Orlovsky.
// All rights under the above copyrights are reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
// in compliance with the License. You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software distributed under the License
// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
// or implied. See the License for the specific language governing permissions and limitations under
// the License.

use amplify::confinement::{self, TinyOrdSet};

use super::{Lib, LibId, MarshallError, Marshaller};
use crate::isa::{BytecodeRead, CodeEofError, Instruction};

/// Errors while assembling lib-old from the instruction set.
#[derive(Clone, Copy, Eq, PartialEq, Hash, Debug, Display, Error, From)]
#[display(inner)]
pub enum AssemblerError {
    /// Error assembling code and data segments.
    #[from]
    Bytecode(MarshallError),

    /// Error assembling a library segment.
    #[from]
    LibSegOverflow(confinement::Error),
}

impl Lib {
    /// Assembles a library from the provided instructions by encoding them into bytecode.
    pub fn assemble<Isa>(code: &[Isa]) -> Result<Lib, AssemblerError>
    where Isa: Instruction<LibId> {
        let call_sites = code.iter().filter_map(|instr| instr.external_ref());
        let libs_segment = TinyOrdSet::try_from_iter(call_sites)?;

        let mut writer = Marshaller::new(&libs_segment);
        for instr in code.iter() {
            instr.encode_instr(&mut writer)?;
        }
        let (code_segment, data_segment) = writer.finish();

        Ok(Lib {
            isae: Isa::isa_ext(),
            libs: libs_segment,
            code: code_segment,
            data: data_segment,
        })
    }

    /// Disassembles the library into a set of instructions.
    pub fn disassemble<Isa>(&self) -> Result<Vec<Isa>, CodeEofError>
    where Isa: Instruction<LibId> {
        let mut code = Vec::new();
        let mut reader = Marshaller::with(&self.code, &self.data, &self.libs);
        while !reader.is_eof() {
            code.push(Isa::decode_instr(&mut reader)?);
        }
        Ok(code)
    }

    /// Disassembles the library into a set of instructions and offsets and prints it to the writer.
    pub fn print_disassemble<Isa>(
        &self,
        mut writer: impl std::io::Write,
    ) -> Result<(), std::io::Error>
    where
        Isa: Instruction<LibId>,
    {
        let mut reader = Marshaller::with(&self.code, &self.data, &self.libs);
        while !reader.is_eof() {
            let pos = reader.offset().0 as usize;
            write!(writer, "offset {pos:06}: ")?;
            match Isa::decode_instr(&mut reader) {
                Ok(instr) => writeln!(writer, "{instr}")?,
                Err(_) => writeln!(writer, "; <incomplete instruction>")?,
            }
        }
        Ok(())
    }
}