// Smoldot

// Copyright (C) 2019-2022  Parity Technologies (UK) Ltd.

// 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 <http://www.gnu.org/licenses/>.

//! WebAssembly runtime code execution.

//!

//! WebAssembly (often abbreviated *Wasm*) plays a big role in Substrate/Polkadot. The storage of

//! each block in the chain has a special key named `:code` which contains the WebAssembly code

//! of what we call *the runtime*.

//!

//! The runtime is a program (in WebAssembly) that decides, amongst other things, whether

//! transactions are valid and how to apply them on the storage, and whether blocks themselves are

//! valid.

//!

//! This module contains everything necessary to execute runtime code. The highest-level

//! sub-module is [`runtime_call`].

mod allocator; // TODO: make public after refactoring

pub mod host;

pub mod runtime_call;

pub mod storage_diff;

pub mod trie_root_calculator;

pub mod vm;

pub use host::{CoreVersion, CoreVersionError, CoreVersionRef};

/// Default number of heap pages if the storage doesn't specify otherwise.

///

/// # Context

///

/// In order to initialize a [`host::HostVmPrototype`], one needs to pass a certain number of

/// heap pages that are available to the runtime.

///

/// This number is normally found in the storage, at the key `:heappages`. But if it is not

/// specified, then the value of this constant must be used.

pub const DEFAULT_HEAP_PAGES: vm::HeapPages = vm::HeapPages::new(2048);

/// Converts a value of the key `:heappages` found in the storage to an actual number of heap

/// pages.

pub fn storage_heap_pages_to_value(

    storage_value: Option<&[u8]>,

) -> Result<vm::HeapPages, InvalidHeapPagesError> {

    if let Some(
storage_value0
) = storage_value {

        let bytes =

            <[u8; 8]>::try_from(storage_value).map_err(|_| InvalidHeapPagesError::WrongLen)?;

Unexecuted instantiation: _RNCNvNtCsN16ciHI6Qf_7smoldot8executor27storage_heap_pages_to_value0B5_

Unexecuted instantiation: _RNCNvNtCseuYC0Zibziv_7smoldot8executor27storage_heap_pages_to_value0B5_

        let num = u64::from_le_bytes(bytes);

        let num = u32::try_from(num).map_err(|_| InvalidHeapPagesError::TooLarge)?;

Unexecuted instantiation: _RNCNvNtCsN16ciHI6Qf_7smoldot8executor27storage_heap_pages_to_values_0B5_

Unexecuted instantiation: _RNCNvNtCseuYC0Zibziv_7smoldot8executor27storage_heap_pages_to_values_0B5_

        Ok(vm::HeapPages::from(num))

    } else {

        Ok(DEFAULT_HEAP_PAGES)

    }

}

_RNvNtCsN16ciHI6Qf_7smoldot8executor27storage_heap_pages_to_value

Line

Count

Source

53

5

pub fn storage_heap_pages_to_value(

54

5

    storage_value: Option<&[u8]>,

55

5

) -> Result<vm::HeapPages, InvalidHeapPagesError> {

56

5

    if let Some(
storage_value0
) = storage_value {

57

0

        let bytes =

58

0

            <[u8; 8]>::try_from(storage_value).map_err(|_| InvalidHeapPagesError::WrongLen)?;

59

0

        let num = u64::from_le_bytes(bytes);

60

0

        let num = u32::try_from(num).map_err(|_| InvalidHeapPagesError::TooLarge)?;

61

0

        Ok(vm::HeapPages::from(num))

62

    } else {

63

5

        Ok(DEFAULT_HEAP_PAGES)

64

    }

65

5

}

_RNvNtCseuYC0Zibziv_7smoldot8executor27storage_heap_pages_to_value

Line

Count

Source

53

86

pub fn storage_heap_pages_to_value(

54

86

    storage_value: Option<&[u8]>,

55

86

) -> Result<vm::HeapPages, InvalidHeapPagesError> {

56

86

    if let Some(
storage_value0
) = storage_value {

57

0

        let bytes =

58

0

            <[u8; 8]>::try_from(storage_value).map_err(|_| InvalidHeapPagesError::WrongLen)?;

59

0

        let num = u64::from_le_bytes(bytes);

60

0

        let num = u32::try_from(num).map_err(|_| InvalidHeapPagesError::TooLarge)?;

61

0

        Ok(vm::HeapPages::from(num))

62

    } else {

63

86

        Ok(DEFAULT_HEAP_PAGES)

64

    }

65

86

}

/// Error potentially returned by [`storage_heap_pages_to_value`].

#[derive(Debug, derive_more::Display, Clone)]

Unexecuted instantiation: _RNvXs_NtCsN16ciHI6Qf_7smoldot8executorNtB4_21InvalidHeapPagesErrorNtNtCsaYZPK01V26L_4core3fmt7Display3fmt

Unexecuted instantiation: _RNvXs_NtCseuYC0Zibziv_7smoldot8executorNtB4_21InvalidHeapPagesErrorNtNtCsaYZPK01V26L_4core3fmt7Display3fmt

pub enum InvalidHeapPagesError {

    /// Storage value has the wrong length.

    WrongLen,

    /// Number of heap pages is too large.

    TooLarge,

}