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 179 180 181
// This file is part of Gear.
// Copyright (C) 2022-2024 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
// This program 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.
// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
use super::*;
use crate::storage::{MapStorage, TripleMapStorage};
use core::fmt::Debug;
/// Trait for ProgramStorage errors.
///
/// Contains constructors for all existing errors.
pub trait Error {
/// Program already exists in storage.
fn duplicate_item() -> Self;
/// Program is not found in the storage.
fn program_not_found() -> Self;
/// Program is not an instance of ActiveProgram.
fn not_active_program() -> Self;
/// There is no data for specified `program_id` and `page`.
fn cannot_find_page_data() -> Self;
/// Resume session is not found in the storage.
fn resume_session_not_found() -> Self;
/// Specified user is not an owner of the resume session.
fn not_session_owner() -> Self;
/// Failed to resume the program due to incorrect provided data.
fn resume_session_failed() -> Self;
/// Failed to find the program binary code.
fn program_code_not_found() -> Self;
/// Resume session with the specified id already exists in storage.
fn duplicate_resume_session() -> Self;
}
pub type MemoryMap = BTreeMap<GearPage, PageBuf>;
/// Trait to work with program data in a storage.
pub trait ProgramStorage {
type InternalError: Error;
type Error: From<Self::InternalError> + Debug;
type BlockNumber: Copy + Saturating;
type AccountId: Eq + PartialEq;
type ProgramMap: MapStorage<Key = ProgramId, Value = Program<Self::BlockNumber>>;
type MemoryPageMap: TripleMapStorage<
Key1 = ProgramId,
Key2 = MemoryInfix,
Key3 = GearPage,
Value = PageBuf,
>;
/// Attempt to remove all items from all the associated maps.
fn reset() {
Self::ProgramMap::clear();
Self::MemoryPageMap::clear();
}
/// Store a program to be associated with the given key `program_id` from the map.
fn add_program(
program_id: ProgramId,
program: ActiveProgram<Self::BlockNumber>,
) -> Result<(), Self::Error> {
Self::ProgramMap::mutate(program_id, |maybe| {
if maybe.is_some() {
return Err(Self::InternalError::duplicate_item().into());
}
*maybe = Some(Program::Active(program));
Ok(())
})
}
/// Load the program associated with the given key `program_id` from the map.
fn get_program(program_id: ProgramId) -> Option<Program<Self::BlockNumber>> {
Self::ProgramMap::get(&program_id)
}
/// Does the program (explicitly) exist in storage?
fn program_exists(program_id: ProgramId) -> bool {
Self::ProgramMap::contains_key(&program_id)
}
/// Update the active program under the given key `program_id`.
fn update_active_program<F, ReturnType>(
program_id: ProgramId,
update_action: F,
) -> Result<ReturnType, Self::Error>
where
F: FnOnce(&mut ActiveProgram<Self::BlockNumber>) -> ReturnType,
{
Self::update_program_if_active(program_id, |program, _bn| match program {
Program::Active(active_program) => update_action(active_program),
_ => unreachable!("invariant kept by update_program_if_active"),
})
}
/// Update the program under the given key `program_id` only if the
/// stored program is an active one.
fn update_program_if_active<F, ReturnType>(
program_id: ProgramId,
update_action: F,
) -> Result<ReturnType, Self::Error>
where
F: FnOnce(&mut Program<Self::BlockNumber>, Self::BlockNumber) -> ReturnType,
{
let mut program =
Self::ProgramMap::get(&program_id).ok_or(Self::InternalError::program_not_found())?;
let bn = match program {
Program::Active(ref p) => p.expiration_block,
_ => return Err(Self::InternalError::not_active_program().into()),
};
let result = update_action(&mut program, bn);
Self::ProgramMap::insert(program_id, program);
Ok(result)
}
/// Return program data for each page from `pages`.
fn get_program_data_for_pages<'a>(
program_id: ProgramId,
memory_infix: MemoryInfix,
pages: impl Iterator<Item = &'a GearPage>,
) -> Result<MemoryMap, Self::Error> {
let mut pages_data = BTreeMap::new();
for page in pages {
let data = Self::MemoryPageMap::get(&program_id, &memory_infix, page)
.ok_or(Self::InternalError::cannot_find_page_data())?;
pages_data.insert(*page, data);
}
Ok(pages_data)
}
/// Store a memory page buffer to be associated with the given keys `program_id`, `memory_infix` and `page` from the map.
fn set_program_page_data(
program_id: ProgramId,
memory_infix: MemoryInfix,
page: GearPage,
page_buf: PageBuf,
) {
Self::MemoryPageMap::insert(program_id, memory_infix, page, page_buf);
}
/// Remove a memory page buffer under the given keys `program_id`, `memory_infix` and `page`.
fn remove_program_page_data(
program_id: ProgramId,
memory_infix: MemoryInfix,
page_num: GearPage,
) {
Self::MemoryPageMap::remove(program_id, memory_infix, page_num);
}
/// Remove all memory page buffers under the given keys `program_id` and `memory_infix`.
fn remove_program_pages(program_id: ProgramId, memory_infix: MemoryInfix) {
Self::MemoryPageMap::clear_prefix(program_id, memory_infix);
}
/// Final full prefix that prefixes all keys of memory pages.
fn pages_final_prefix() -> [u8; 32];
}