memory.hpp

Go to the documentation of this file.

#ifndef KAGOME_MEMORY_HPP
#define KAGOME_MEMORY_HPP

#include <array>

#include <gsl/span>
#include <optional>

#include "common/buffer.hpp"
#include "common/literals.hpp"
#include "runtime/types.hpp"

namespace kagome::runtime {

  constexpr inline size_t kInitialMemorySize = []() {
    using kagome::common::literals::operator""_MB;
    return 2_MB;
  }();

  // according to $3.1.2.1 in the Polkadot Host Spec
  constexpr inline size_t kMemoryPageSize = []() {
    using kagome::common::literals::operator""_kB;
    return 64_kB;
  }();

  class Memory {
   public:
    virtual ~Memory() = default;

    constexpr static uint32_t kMaxMemorySize =
        std::numeric_limits<uint32_t>::max();

    virtual WasmSize size() const = 0;

    virtual void resize(WasmSize new_size) = 0;

    virtual WasmPointer allocate(WasmSize size) = 0;

    virtual std::optional<WasmSize> deallocate(WasmPointer ptr) = 0;

    virtual int8_t load8s(WasmPointer addr) const = 0;
    virtual uint8_t load8u(WasmPointer addr) const = 0;
    virtual int16_t load16s(WasmPointer addr) const = 0;
    virtual uint16_t load16u(WasmPointer addr) const = 0;
    virtual int32_t load32s(WasmPointer addr) const = 0;
    virtual uint32_t load32u(WasmPointer addr) const = 0;
    virtual int64_t load64s(WasmPointer addr) const = 0;
    virtual uint64_t load64u(WasmPointer addr) const = 0;
    virtual std::array<uint8_t, 16> load128(WasmPointer addr) const = 0;

    virtual common::Buffer loadN(WasmPointer addr, WasmSize n) const = 0;
    virtual std::string loadStr(WasmPointer addr, WasmSize n) const = 0;

    virtual void store8(WasmPointer addr, int8_t value) = 0;
    virtual void store16(WasmPointer addr, int16_t value) = 0;
    virtual void store32(WasmPointer addr, int32_t value) = 0;
    virtual void store64(WasmPointer addr, int64_t value) = 0;
    virtual void store128(WasmPointer addr,
                          const std::array<uint8_t, 16> &value) = 0;
    virtual void storeBuffer(WasmPointer addr,
                             gsl::span<const uint8_t> value) = 0;

    virtual WasmSpan storeBuffer(gsl::span<const uint8_t> value) = 0;
  };
}  // namespace kagome::runtime

#endif  // KAGOME_MEMORY_HPP