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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

// 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.

#![allow(missing_docs)]
#![allow(clippy::unusual_byte_groupings)]

// Control-flow instructions
pub const INSTR_FAIL: u8 = 0b00_000_000;
pub const INSTR_SUCC: u8 = 0b00_000_001;
pub const INSTR_JMP: u8 = 0b00_000_010;
pub const INSTR_JIF: u8 = 0b00_000_011;
pub const INSTR_ROUTINE: u8 = 0b00_000_100;
pub const INSTR_CALL: u8 = 0b00_000_101;
pub const INSTR_EXEC: u8 = 0b00_000_110;
pub const INSTR_RET: u8 = 0b00_000_111;

// Instructions setting register values
pub const INSTR_CLRA: u8 = 0b00_001_000;
pub const INSTR_CLRF: u8 = 0b00_001_001;
pub const INSTR_CLRR: u8 = 0b00_001_010;
pub const INSTR_PUTA: u8 = 0b00_001_011;
pub const INSTR_PUTF: u8 = 0b00_001_100;
pub const INSTR_PUTR: u8 = 0b00_001_101;
pub const INSTR_PUTIFA: u8 = 0b00_001_110;
pub const INSTR_PUTIFR: u8 = 0b00_001_111;

// Instructions moving and swapping register values
pub const INSTR_MOV: u8 = 0b00_010_000;
pub const INSTR_CPA: u8 = 0b00_010_001;
pub const INSTR_CNA: u8 = 0b00_010_010;
pub const INSTR_CNF: u8 = 0b00_010_011;
pub const INSTR_CPR: u8 = 0b00_010_100;
pub const INSTR_SPY: u8 = 0b00_010_101;
pub const INSTR_CAF: u8 = 0b00_010_110;
pub const INSTR_CFA: u8 = 0b00_010_111;

// Instructions comparing register values
pub const INSTR_LGT: u8 = 0b00_011_000;
pub const INSTR_CMP: u8 = 0b00_011_001;
pub const INSTR_IFZA: u8 = 0b00_011_010;
pub const INSTR_IFZR: u8 = 0b00_011_011;
pub const INSTR_IFNA: u8 = 0b00_011_100;
pub const INSTR_IFNR: u8 = 0b00_011_101;
pub const INSTR_ST: u8 = 0b00_011_110;
pub const INSTR_STINV: u8 = 0b00_011_111;

// Arithmetic instructions
pub const INSTR_ADD: u8 = 0b00_100_000;
pub const INSTR_SUB: u8 = 0b00_100_001;
pub const INSTR_MUL: u8 = 0b00_100_010;
pub const INSTR_DIV: u8 = 0b00_100_011;
pub const INSTR_STP: u8 = 0b00_100_100;
pub const INSTR_NEG: u8 = 0b00_100_101;
pub const INSTR_ABS: u8 = 0b00_100_110;
pub const INSTR_REM: u8 = 0b00_100_111;

// Bit operations & boolean algebra instructions
pub const INSTR_AND: u8 = 0b00_101_000;
pub const INSTR_OR: u8 = 0b00_101_001;
pub const INSTR_XOR: u8 = 0b00_101_010;
pub const INSTR_NOT: u8 = 0b00_101_011;
pub const INSTR_SHF: u8 = 0b00_101_100;
pub const INSTR_SHC: u8 = 0b00_101_101;
pub const INSTR_REVA: u8 = 0b00_101_110;
pub const INSTR_REVR: u8 = 0b00_101_111;

//  Operations on byte strings
pub const INSTR_PUT: u8 = 0b00_110_000;
pub const INSTR_MVS: u8 = 0b00_110_001;
pub const INSTR_SWP: u8 = 0b00_110_010;
pub const INSTR_FILL: u8 = 0b00_110_011;
pub const INSTR_LEN: u8 = 0b00_110_100;
pub const INSTR_CNT: u8 = 0b00_110_101;
pub const INSTR_EQ: u8 = 0b00_110_110;
pub const INSTR_CON: u8 = 0b00_110_111;

pub const INSTR_FIND: u8 = 0b00_111_000;
pub const INSTR_EXTR: u8 = 0b00_111_001;
pub const INSTR_INJ: u8 = 0b00_111_010;
pub const INSTR_JOIN: u8 = 0b00_111_011;
pub const INSTR_SPLT: u8 = 0b00_111_100;
pub const INSTR_INS: u8 = 0b00_111_101;
pub const INSTR_DEL: u8 = 0b00_111_110;
pub const INSTR_REV: u8 = 0b00_111_111;

// No-operation instruction
pub const INSTR_NOP: u8 = 0b11_111_111;

// Reserved operations which can be used by future AluVM versions
pub const INSTR_RESV_FROM: u8 = 0b01_000_000;
pub const INSTR_RESV_TO: u8 = 0b01_111_111;

// ## ISA extensions:

// ### Hashing (BPDIGEST)

pub const INSTR_RIPEMD: u8 = 0b10_000_000;
pub const INSTR_SHA256: u8 = 0b10_000_001;
pub const INSTR_SHA512: u8 = 0b10_000_010;

// ### Secp256k1 operations (SECP256K1)

pub const INSTR_SECP_GEN: u8 = 0b10_001_000;
pub const INSTR_SECP_MUL: u8 = 0b10_001_001;
pub const INSTR_SECP_ADD: u8 = 0b10_001_010;
pub const INSTR_SECP_NEG: u8 = 0b10_001_011;

// ### Curve25519 operations (ED25519)

pub const INSTR_ED_GEN: u8 = 0b10_001_100;
pub const INSTR_ED_MUL: u8 = 0b10_001_101;
pub const INSTR_ED_ADD: u8 = 0b10_001_110;
pub const INSTR_ED_NEG: u8 = 0b10_001_111;

// Opcodes with may be used by ISA extensions
pub const INSTR_ISAE_FROM: u8 = 0b10_000_000;
pub const INSTR_ISAE_TO: u8 = 0b11_111_110;