aluvm 0.10.6

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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

// 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
//
// Written in 2021-2023 by
//     Dr Maxim Orlovsky <orlovsky@ubideco.org>
//
// Copyright (C) 2021-2022 LNP/BP Standards Association. All rights reserved.
// Copyright (C) 2023 UBIDECO Institute. All rights 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.

//! AluVM instruction set architecture

mod bytecode;
mod exec;
mod flags;
mod instr;
pub mod opcodes;

pub use bytecode::{Bytecode, BytecodeError};
pub use exec::{ExecStep, InstructionSet};
pub use flags::{
    DeleteFlag, ExtendFlag, Flag, FloatEqFlag, InsertFlag, IntFlags, MergeFlag, NoneEqFlag,
    ParseFlagError, RoundingFlag, SignFlag, SplitFlag,
};
pub use instr::{
    ArithmeticOp, BitwiseOp, BytesOp, CmpOp, ControlFlowOp, Curve25519Op, DigestOp, Instr, MoveOp,
    PutOp, ReservedOp, Secp256k1Op,
};

/// List of standardised ISA extensions.
#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug, Display)]
#[non_exhaustive]
#[derive(Default)]
pub enum Isa {
    /// Core ISA instruction set
    #[display("ALU")]
    #[default]
    Alu,

    /// Floating-point operations
    #[display("FLOAT")]
    Float,

    /// Bitcoin-specific cryptographic hash functions
    #[display("BPDIGEST")]
    BpDigest,

    /// Operations on Secp256k1 curve
    #[display("SECP256")]
    Secp256k1,

    /// Operations on Curve25519
    #[display("ED25519")]
    Curve25519,

    /// ALU runtime extensions
    #[display("ALURE")]
    AluRe,

    /// Bitcoin protocol-specific instructions
    #[display("BP")]
    Bp,

    /// RGB-specific instructions
    #[display("RGB")]
    Rgb,

    /// Lightning network protocol-specific instructions
    #[display("LNP")]
    Lnp,

    /// Instructions for SIMD
    #[display("SIMD")]
    Simd,

    /// Instructions for biologically-inspired cognitive architectures
    #[display("REBICA")]
    Rebica,
}

impl Isa {
    /// Enumerates all ISA extension variants
    pub const fn all() -> [Isa; 11] {
        [
            Isa::Alu,
            Isa::Float,
            Isa::BpDigest,
            Isa::Secp256k1,
            Isa::Curve25519,
            Isa::AluRe,
            Isa::Bp,
            Isa::Rgb,
            Isa::Lnp,
            Isa::Simd,
            Isa::Rebica,
        ]
    }
}