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 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
// Copyright (C) 2019-2022 Aleo Systems Inc.
// This file is part of the snarkVM library.
// The snarkVM library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// The snarkVM library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with the snarkVM library. If not, see <https://www.gnu.org/licenses/>.
use super::*;
impl<N: Network, A: circuit::Aleo<Network = N>> Registers<N, A> {
/// Loads the literal of a given operand from the registers.
///
/// # Errors
/// This method will halt if the given operand is not a literal.
/// This method will halt if the register locator is not found.
/// In the case of register members, this method will halt if the member is not found.
#[inline]
pub fn load_literal(&self, stack: &Stack<N>, operand: &Operand<N>) -> Result<Literal<N>> {
match self.load(stack, operand)? {
Value::Plaintext(Plaintext::Literal(literal, ..)) => Ok(literal),
Value::Plaintext(Plaintext::Interface(..)) => bail!("Operand must be a literal"),
Value::Record(..) => bail!("Operand must be a literal"),
}
}
/// Loads the value of a given operand from the registers.
///
/// # Errors
/// This method will halt if the register locator is not found.
/// In the case of register members, this method will halt if the member is not found.
#[inline]
pub fn load(&self, stack: &Stack<N>, operand: &Operand<N>) -> Result<Value<N>> {
// Retrieve the register.
let register = match operand {
// If the operand is a literal, return the literal.
Operand::Literal(literal) => return Ok(Value::Plaintext(Plaintext::from(literal))),
// If the operand is a register, load the value from the register.
Operand::Register(register) => register,
// If the operand is the program ID, load the program address.
Operand::ProgramID(program_id) => {
return Ok(Value::Plaintext(Plaintext::from(Literal::Address(program_id.to_address()?))));
}
// If the operand is the caller, load the value of the caller.
Operand::Caller => return Ok(Value::Plaintext(Plaintext::from(Literal::Address(self.caller()?)))),
};
// Retrieve the stack value.
let stack_value =
self.console_registers.get(®ister.locator()).ok_or_else(|| anyhow!("'{register}' does not exist"))?;
// Return the value for the given register or register member.
let stack_value = match register {
// If the register is a locator, then return the stack value.
Register::Locator(..) => stack_value.clone(),
// If the register is a register member, then load the specific stack value.
Register::Member(_, ref path) => {
match stack_value {
// Retrieve the plaintext member from the path.
Value::Plaintext(plaintext) => Value::Plaintext(plaintext.find(path)?),
// Retrieve the record entry from the path.
Value::Record(record) => match record.find(path)? {
Entry::Constant(plaintext) | Entry::Public(plaintext) | Entry::Private(plaintext) => {
Value::Plaintext(plaintext)
}
},
}
}
};
// Retrieve the register type.
match self.register_types.get_type(stack, register) {
// Ensure the stack value matches the register type.
Ok(register_type) => stack.matches_register_type(&stack_value, ®ister_type)?,
// Ensure the register is defined.
Err(error) => bail!("Register '{register}' is not a member of the function: {error}"),
};
Ok(stack_value)
}
}
impl<N: Network, A: circuit::Aleo<Network = N>> Registers<N, A> {
/// Loads the literal circuit of a given operand from the registers.
///
/// # Errors
/// This method will halt if the given operand is not a literal.
/// This method will halt if the register locator is not found.
/// In the case of register members, this method will halt if the member is not found.
#[inline]
pub fn load_literal_circuit(&self, stack: &Stack<N>, operand: &Operand<N>) -> Result<circuit::program::Literal<A>> {
match self.load_circuit(stack, operand)? {
circuit::Value::Plaintext(circuit::Plaintext::Literal(literal, ..)) => Ok(literal),
circuit::Value::Plaintext(circuit::Plaintext::Interface(..)) => bail!("Operand must be a literal"),
circuit::Value::Record(..) => bail!("Operand must be a literal"),
}
}
/// Loads the value of a given operand from the registers.
///
/// # Errors
/// This method will halt if the register locator is not found.
/// In the case of register members, this method will halt if the member is not found.
#[inline]
pub fn load_circuit(&self, stack: &Stack<N>, operand: &Operand<N>) -> Result<circuit::Value<A>> {
use circuit::Inject;
// Retrieve the register.
let register = match operand {
// If the operand is a literal, return the literal.
Operand::Literal(literal) => {
return Ok(circuit::Value::Plaintext(circuit::Plaintext::from(circuit::Literal::constant(
literal.clone(),
))));
}
// If the operand is a register, load the value from the register.
Operand::Register(register) => register,
// If the operand is the program ID, load the program address.
Operand::ProgramID(program_id) => {
return Ok(circuit::Value::Plaintext(circuit::Plaintext::from(circuit::Literal::constant(
Literal::Address(program_id.to_address()?),
))));
}
// If the operand is the caller, load the value of the caller.
Operand::Caller => {
return Ok(circuit::Value::Plaintext(circuit::Plaintext::from(circuit::Literal::Address(
self.caller_circuit()?,
))));
}
};
// Retrieve the circuit value.
let circuit_value =
self.circuit_registers.get(®ister.locator()).ok_or_else(|| anyhow!("'{register}' does not exist"))?;
// Return the value for the given register or register member.
let circuit_value = match register {
// If the register is a locator, then return the stack value.
Register::Locator(..) => circuit_value.clone(),
// If the register is a register member, then load the specific stack value.
Register::Member(_, ref path) => {
// Inject the path.
let path = path.iter().map(|member| circuit::Identifier::constant(*member)).collect::<Vec<_>>();
match circuit_value {
// Retrieve the plaintext member from the path.
circuit::Value::Plaintext(plaintext) => circuit::Value::Plaintext(plaintext.find(&path)?),
// Retrieve the record entry from the path.
circuit::Value::Record(record) => match record.find(&path)? {
circuit::Entry::Constant(plaintext)
| circuit::Entry::Public(plaintext)
| circuit::Entry::Private(plaintext) => circuit::Value::Plaintext(plaintext),
},
}
}
};
// Retrieve the register type.
match self.register_types.get_type(stack, register) {
// Ensure the stack value matches the register type.
Ok(register_type) => {
stack.matches_register_type(&circuit::Eject::eject_value(&circuit_value), ®ister_type)?
}
// Ensure the register is defined.
Err(error) => bail!("Register '{register}' is not a member of the function: {error}"),
};
Ok(circuit_value)
}
}