mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
911 lines
31 KiB
C++
911 lines
31 KiB
C++
// EVMC: Ethereum Client-VM Connector API.
|
|
// Copyright 2018 The EVMC Authors.
|
|
// Licensed under the Apache License, Version 2.0.
|
|
#pragma once
|
|
|
|
#include <evmc/evmc.h>
|
|
#include <evmc/helpers.h>
|
|
#include <evmc/hex.hpp>
|
|
|
|
#include <functional>
|
|
#include <initializer_list>
|
|
#include <ostream>
|
|
#include <string_view>
|
|
#include <utility>
|
|
|
|
static_assert(EVMC_LATEST_STABLE_REVISION <= EVMC_MAX_REVISION,
|
|
"latest stable revision ill-defined");
|
|
|
|
/// EVMC C++ API - wrappers and bindings for C++
|
|
/// @ingroup cpp
|
|
namespace evmc
|
|
{
|
|
/// String view of uint8_t chars.
|
|
using bytes_view = std::basic_string_view<uint8_t>;
|
|
|
|
/// The big-endian 160-bit hash suitable for keeping an Ethereum address.
|
|
///
|
|
/// This type wraps C ::evmc_address to make sure objects of this type are always initialized.
|
|
struct address : evmc_address
|
|
{
|
|
/// Default and converting constructor.
|
|
///
|
|
/// Initializes bytes to zeros if not other @p init value provided.
|
|
constexpr address(evmc_address init = {}) noexcept : evmc_address{init} {}
|
|
|
|
/// Converting constructor from unsigned integer value.
|
|
///
|
|
/// This constructor assigns the @p v value to the last 8 bytes [12:19]
|
|
/// in big-endian order.
|
|
constexpr explicit address(uint64_t v) noexcept
|
|
: evmc_address{{0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
static_cast<uint8_t>(v >> 56),
|
|
static_cast<uint8_t>(v >> 48),
|
|
static_cast<uint8_t>(v >> 40),
|
|
static_cast<uint8_t>(v >> 32),
|
|
static_cast<uint8_t>(v >> 24),
|
|
static_cast<uint8_t>(v >> 16),
|
|
static_cast<uint8_t>(v >> 8),
|
|
static_cast<uint8_t>(v >> 0)}}
|
|
{}
|
|
|
|
/// Explicit operator converting to bool.
|
|
inline constexpr explicit operator bool() const noexcept;
|
|
|
|
/// Implicit operator converting to bytes_view.
|
|
inline constexpr operator bytes_view() const noexcept { return {bytes, sizeof(bytes)}; }
|
|
};
|
|
|
|
/// The fixed size array of 32 bytes for storing 256-bit EVM values.
|
|
///
|
|
/// This type wraps C ::evmc_bytes32 to make sure objects of this type are always initialized.
|
|
struct bytes32 : evmc_bytes32
|
|
{
|
|
/// Default and converting constructor.
|
|
///
|
|
/// Initializes bytes to zeros if not other @p init value provided.
|
|
constexpr bytes32(evmc_bytes32 init = {}) noexcept : evmc_bytes32{init} {}
|
|
|
|
/// Converting constructor from unsigned integer value.
|
|
///
|
|
/// This constructor assigns the @p v value to the last 8 bytes [24:31]
|
|
/// in big-endian order.
|
|
constexpr explicit bytes32(uint64_t v) noexcept
|
|
: evmc_bytes32{{0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
static_cast<uint8_t>(v >> 56),
|
|
static_cast<uint8_t>(v >> 48),
|
|
static_cast<uint8_t>(v >> 40),
|
|
static_cast<uint8_t>(v >> 32),
|
|
static_cast<uint8_t>(v >> 24),
|
|
static_cast<uint8_t>(v >> 16),
|
|
static_cast<uint8_t>(v >> 8),
|
|
static_cast<uint8_t>(v >> 0)}}
|
|
{}
|
|
|
|
/// Explicit operator converting to bool.
|
|
inline constexpr explicit operator bool() const noexcept;
|
|
|
|
/// Implicit operator converting to bytes_view.
|
|
inline constexpr operator bytes_view() const noexcept { return {bytes, sizeof(bytes)}; }
|
|
};
|
|
|
|
/// The alias for evmc::bytes32 to represent a big-endian 256-bit integer.
|
|
using uint256be = bytes32;
|
|
|
|
|
|
/// Loads 64 bits / 8 bytes of data from the given @p data array in big-endian order.
|
|
inline constexpr uint64_t load64be(const uint8_t* data) noexcept
|
|
{
|
|
return (uint64_t{data[0]} << 56) | (uint64_t{data[1]} << 48) | (uint64_t{data[2]} << 40) |
|
|
(uint64_t{data[3]} << 32) | (uint64_t{data[4]} << 24) | (uint64_t{data[5]} << 16) |
|
|
(uint64_t{data[6]} << 8) | uint64_t{data[7]};
|
|
}
|
|
|
|
/// Loads 64 bits / 8 bytes of data from the given @p data array in little-endian order.
|
|
inline constexpr uint64_t load64le(const uint8_t* data) noexcept
|
|
{
|
|
return uint64_t{data[0]} | (uint64_t{data[1]} << 8) | (uint64_t{data[2]} << 16) |
|
|
(uint64_t{data[3]} << 24) | (uint64_t{data[4]} << 32) | (uint64_t{data[5]} << 40) |
|
|
(uint64_t{data[6]} << 48) | (uint64_t{data[7]} << 56);
|
|
}
|
|
|
|
/// Loads 32 bits / 4 bytes of data from the given @p data array in big-endian order.
|
|
inline constexpr uint32_t load32be(const uint8_t* data) noexcept
|
|
{
|
|
return (uint32_t{data[0]} << 24) | (uint32_t{data[1]} << 16) | (uint32_t{data[2]} << 8) |
|
|
uint32_t{data[3]};
|
|
}
|
|
|
|
/// Loads 32 bits / 4 bytes of data from the given @p data array in little-endian order.
|
|
inline constexpr uint32_t load32le(const uint8_t* data) noexcept
|
|
{
|
|
return uint32_t{data[0]} | (uint32_t{data[1]} << 8) | (uint32_t{data[2]} << 16) |
|
|
(uint32_t{data[3]} << 24);
|
|
}
|
|
|
|
namespace fnv
|
|
{
|
|
constexpr auto prime = 0x100000001b3; ///< The 64-bit FNV prime number.
|
|
constexpr auto offset_basis = 0xcbf29ce484222325; ///< The 64-bit FNV offset basis.
|
|
|
|
/// The hashing transformation for 64-bit inputs based on the FNV-1a formula.
|
|
inline constexpr uint64_t fnv1a_by64(uint64_t h, uint64_t x) noexcept
|
|
{
|
|
return (h ^ x) * prime;
|
|
}
|
|
} // namespace fnv
|
|
|
|
|
|
/// The "equal to" comparison operator for the evmc::address type.
|
|
inline constexpr bool operator==(const address& a, const address& b) noexcept
|
|
{
|
|
return load64le(&a.bytes[0]) == load64le(&b.bytes[0]) &&
|
|
load64le(&a.bytes[8]) == load64le(&b.bytes[8]) &&
|
|
load32le(&a.bytes[16]) == load32le(&b.bytes[16]);
|
|
}
|
|
|
|
/// The "not equal to" comparison operator for the evmc::address type.
|
|
inline constexpr bool operator!=(const address& a, const address& b) noexcept
|
|
{
|
|
return !(a == b);
|
|
}
|
|
|
|
/// The "less than" comparison operator for the evmc::address type.
|
|
inline constexpr bool operator<(const address& a, const address& b) noexcept
|
|
{
|
|
return load64be(&a.bytes[0]) < load64be(&b.bytes[0]) ||
|
|
(load64be(&a.bytes[0]) == load64be(&b.bytes[0]) &&
|
|
(load64be(&a.bytes[8]) < load64be(&b.bytes[8]) ||
|
|
(load64be(&a.bytes[8]) == load64be(&b.bytes[8]) &&
|
|
load32be(&a.bytes[16]) < load32be(&b.bytes[16]))));
|
|
}
|
|
|
|
/// The "greater than" comparison operator for the evmc::address type.
|
|
inline constexpr bool operator>(const address& a, const address& b) noexcept
|
|
{
|
|
return b < a;
|
|
}
|
|
|
|
/// The "less than or equal to" comparison operator for the evmc::address type.
|
|
inline constexpr bool operator<=(const address& a, const address& b) noexcept
|
|
{
|
|
return !(b < a);
|
|
}
|
|
|
|
/// The "greater than or equal to" comparison operator for the evmc::address type.
|
|
inline constexpr bool operator>=(const address& a, const address& b) noexcept
|
|
{
|
|
return !(a < b);
|
|
}
|
|
|
|
/// The "equal to" comparison operator for the evmc::bytes32 type.
|
|
inline constexpr bool operator==(const bytes32& a, const bytes32& b) noexcept
|
|
{
|
|
return load64le(&a.bytes[0]) == load64le(&b.bytes[0]) &&
|
|
load64le(&a.bytes[8]) == load64le(&b.bytes[8]) &&
|
|
load64le(&a.bytes[16]) == load64le(&b.bytes[16]) &&
|
|
load64le(&a.bytes[24]) == load64le(&b.bytes[24]);
|
|
}
|
|
|
|
/// The "not equal to" comparison operator for the evmc::bytes32 type.
|
|
inline constexpr bool operator!=(const bytes32& a, const bytes32& b) noexcept
|
|
{
|
|
return !(a == b);
|
|
}
|
|
|
|
/// The "less than" comparison operator for the evmc::bytes32 type.
|
|
inline constexpr bool operator<(const bytes32& a, const bytes32& b) noexcept
|
|
{
|
|
return load64be(&a.bytes[0]) < load64be(&b.bytes[0]) ||
|
|
(load64be(&a.bytes[0]) == load64be(&b.bytes[0]) &&
|
|
(load64be(&a.bytes[8]) < load64be(&b.bytes[8]) ||
|
|
(load64be(&a.bytes[8]) == load64be(&b.bytes[8]) &&
|
|
(load64be(&a.bytes[16]) < load64be(&b.bytes[16]) ||
|
|
(load64be(&a.bytes[16]) == load64be(&b.bytes[16]) &&
|
|
load64be(&a.bytes[24]) < load64be(&b.bytes[24]))))));
|
|
}
|
|
|
|
/// The "greater than" comparison operator for the evmc::bytes32 type.
|
|
inline constexpr bool operator>(const bytes32& a, const bytes32& b) noexcept
|
|
{
|
|
return b < a;
|
|
}
|
|
|
|
/// The "less than or equal to" comparison operator for the evmc::bytes32 type.
|
|
inline constexpr bool operator<=(const bytes32& a, const bytes32& b) noexcept
|
|
{
|
|
return !(b < a);
|
|
}
|
|
|
|
/// The "greater than or equal to" comparison operator for the evmc::bytes32 type.
|
|
inline constexpr bool operator>=(const bytes32& a, const bytes32& b) noexcept
|
|
{
|
|
return !(a < b);
|
|
}
|
|
|
|
/// Checks if the given address is the zero address.
|
|
inline constexpr bool is_zero(const address& a) noexcept
|
|
{
|
|
return a == address{};
|
|
}
|
|
|
|
inline constexpr address::operator bool() const noexcept
|
|
{
|
|
return !is_zero(*this);
|
|
}
|
|
|
|
/// Checks if the given bytes32 object has all zero bytes.
|
|
inline constexpr bool is_zero(const bytes32& a) noexcept
|
|
{
|
|
return a == bytes32{};
|
|
}
|
|
|
|
inline constexpr bytes32::operator bool() const noexcept
|
|
{
|
|
return !is_zero(*this);
|
|
}
|
|
|
|
namespace literals
|
|
{
|
|
/// Converts a raw literal into value of type T.
|
|
///
|
|
/// This function is expected to be used on literals in constexpr context only.
|
|
/// In case the input is invalid the std::terminate() is called.
|
|
/// TODO(c++20): Use consteval.
|
|
template <typename T>
|
|
constexpr T parse(std::string_view s) noexcept
|
|
{
|
|
return from_hex<T>(s).value();
|
|
}
|
|
|
|
/// Literal for evmc::address.
|
|
constexpr address operator""_address(const char* s) noexcept
|
|
{
|
|
return parse<address>(s);
|
|
}
|
|
|
|
/// Literal for evmc::bytes32.
|
|
constexpr bytes32 operator""_bytes32(const char* s) noexcept
|
|
{
|
|
return parse<bytes32>(s);
|
|
}
|
|
} // namespace literals
|
|
|
|
using namespace literals;
|
|
|
|
|
|
/// @copydoc evmc_status_code_to_string
|
|
inline const char* to_string(evmc_status_code status_code) noexcept
|
|
{
|
|
return evmc_status_code_to_string(status_code);
|
|
}
|
|
|
|
/// @copydoc evmc_revision_to_string
|
|
inline const char* to_string(evmc_revision rev) noexcept
|
|
{
|
|
return evmc_revision_to_string(rev);
|
|
}
|
|
|
|
|
|
/// Alias for evmc_make_result().
|
|
constexpr auto make_result = evmc_make_result;
|
|
|
|
/// @copydoc evmc_result
|
|
///
|
|
/// This is a RAII wrapper for evmc_result and objects of this type
|
|
/// automatically release attached resources.
|
|
class Result : private evmc_result
|
|
{
|
|
public:
|
|
using evmc_result::create_address;
|
|
using evmc_result::gas_left;
|
|
using evmc_result::gas_refund;
|
|
using evmc_result::output_data;
|
|
using evmc_result::output_size;
|
|
using evmc_result::status_code;
|
|
|
|
/// Creates the result from the provided arguments.
|
|
///
|
|
/// The provided output is copied to memory allocated with malloc()
|
|
/// and the evmc_result::release function is set to one invoking free().
|
|
///
|
|
/// @param _status_code The status code.
|
|
/// @param _gas_left The amount of gas left.
|
|
/// @param _gas_refund The amount of refunded gas.
|
|
/// @param _output_data The pointer to the output.
|
|
/// @param _output_size The output size.
|
|
explicit Result(evmc_status_code _status_code,
|
|
int64_t _gas_left,
|
|
int64_t _gas_refund,
|
|
const uint8_t* _output_data,
|
|
size_t _output_size) noexcept
|
|
: evmc_result{make_result(_status_code, _gas_left, _gas_refund, _output_data, _output_size)}
|
|
{}
|
|
|
|
/// Creates the result without output.
|
|
///
|
|
/// @param _status_code The status code.
|
|
/// @param _gas_left The amount of gas left.
|
|
/// @param _gas_refund The amount of refunded gas.
|
|
explicit Result(evmc_status_code _status_code = EVMC_INTERNAL_ERROR,
|
|
int64_t _gas_left = 0,
|
|
int64_t _gas_refund = 0) noexcept
|
|
: evmc_result{make_result(_status_code, _gas_left, _gas_refund, nullptr, 0)}
|
|
{}
|
|
|
|
/// Creates the result of contract creation.
|
|
///
|
|
/// @param _status_code The status code.
|
|
/// @param _gas_left The amount of gas left.
|
|
/// @param _gas_refund The amount of refunded gas.
|
|
/// @param _create_address The address of the possibly created account.
|
|
explicit Result(evmc_status_code _status_code,
|
|
int64_t _gas_left,
|
|
int64_t _gas_refund,
|
|
const evmc_address& _create_address) noexcept
|
|
: evmc_result{make_result(_status_code, _gas_left, _gas_refund, nullptr, 0)}
|
|
{
|
|
create_address = _create_address;
|
|
}
|
|
|
|
/// Converting constructor from raw evmc_result.
|
|
///
|
|
/// This object takes ownership of the resources of @p res.
|
|
explicit Result(const evmc_result& res) noexcept : evmc_result{res} {}
|
|
|
|
/// Destructor responsible for automatically releasing attached resources.
|
|
~Result() noexcept
|
|
{
|
|
if (release != nullptr)
|
|
release(this);
|
|
}
|
|
|
|
/// Move constructor.
|
|
Result(Result&& other) noexcept : evmc_result{other}
|
|
{
|
|
other.release = nullptr; // Disable releasing of the rvalue object.
|
|
}
|
|
|
|
/// Move assignment operator.
|
|
///
|
|
/// The self-assignment MUST never happen.
|
|
///
|
|
/// @param other The other result object.
|
|
/// @return The reference to the left-hand side object.
|
|
Result& operator=(Result&& other) noexcept
|
|
{
|
|
this->~Result(); // Release this object.
|
|
static_cast<evmc_result&>(*this) = other; // Copy data.
|
|
other.release = nullptr; // Disable releasing of the rvalue object.
|
|
return *this;
|
|
}
|
|
|
|
/// Releases the ownership and returns the raw copy of evmc_result.
|
|
///
|
|
/// This method drops the ownership of the result
|
|
/// (result's resources are not going to be released when this object is destructed).
|
|
/// It is the caller's responsibility having the returned copy of the result to release it.
|
|
/// This object MUST NOT be used after this method is invoked.
|
|
///
|
|
/// @return The copy of this object converted to raw evmc_result.
|
|
evmc_result release_raw() noexcept
|
|
{
|
|
const auto out = evmc_result{*this}; // Copy data.
|
|
this->release = nullptr; // Disable releasing of this object.
|
|
return out;
|
|
}
|
|
};
|
|
|
|
|
|
/// The EVMC Host interface
|
|
class HostInterface
|
|
{
|
|
public:
|
|
virtual ~HostInterface() noexcept = default;
|
|
|
|
/// @copydoc evmc_host_interface::account_exists
|
|
virtual bool account_exists(const address& addr) const noexcept = 0;
|
|
|
|
/// @copydoc evmc_host_interface::get_storage
|
|
virtual bytes32 get_storage(const address& addr, const bytes32& key) const noexcept = 0;
|
|
|
|
/// @copydoc evmc_host_interface::set_storage
|
|
virtual evmc_storage_status set_storage(const address& addr,
|
|
const bytes32& key,
|
|
const bytes32& value) noexcept = 0;
|
|
|
|
/// @copydoc evmc_host_interface::get_balance
|
|
virtual uint256be get_balance(const address& addr) const noexcept = 0;
|
|
|
|
/// @copydoc evmc_host_interface::get_code_size
|
|
virtual size_t get_code_size(const address& addr) const noexcept = 0;
|
|
|
|
/// @copydoc evmc_host_interface::get_code_hash
|
|
virtual bytes32 get_code_hash(const address& addr) const noexcept = 0;
|
|
|
|
/// @copydoc evmc_host_interface::copy_code
|
|
virtual size_t copy_code(const address& addr,
|
|
size_t code_offset,
|
|
uint8_t* buffer_data,
|
|
size_t buffer_size) const noexcept = 0;
|
|
|
|
/// @copydoc evmc_host_interface::selfdestruct
|
|
virtual bool selfdestruct(const address& addr, const address& beneficiary) noexcept = 0;
|
|
|
|
/// @copydoc evmc_host_interface::call
|
|
virtual Result call(const evmc_message& msg) noexcept = 0;
|
|
|
|
/// @copydoc evmc_host_interface::get_tx_context
|
|
virtual evmc_tx_context get_tx_context() const noexcept = 0;
|
|
|
|
/// @copydoc evmc_host_interface::get_block_hash
|
|
virtual bytes32 get_block_hash(int64_t block_number) const noexcept = 0;
|
|
|
|
/// @copydoc evmc_host_interface::emit_log
|
|
virtual void emit_log(const address& addr,
|
|
const uint8_t* data,
|
|
size_t data_size,
|
|
const bytes32 topics[],
|
|
size_t num_topics) noexcept = 0;
|
|
|
|
/// @copydoc evmc_host_interface::access_account
|
|
virtual evmc_access_status access_account(const address& addr) noexcept = 0;
|
|
|
|
/// @copydoc evmc_host_interface::access_storage
|
|
virtual evmc_access_status access_storage(const address& addr, const bytes32& key) noexcept = 0;
|
|
};
|
|
|
|
|
|
/// Wrapper around EVMC host context / host interface.
|
|
///
|
|
/// To be used by VM implementations as better alternative to using ::evmc_host_context directly.
|
|
class HostContext : public HostInterface
|
|
{
|
|
const evmc_host_interface* host = nullptr;
|
|
evmc_host_context* context = nullptr;
|
|
|
|
public:
|
|
/// Default constructor for null Host context.
|
|
HostContext() = default;
|
|
|
|
/// Constructor from the EVMC Host primitives.
|
|
/// @param interface The reference to the Host interface.
|
|
/// @param ctx The pointer to the Host context object. This parameter MAY be null.
|
|
HostContext(const evmc_host_interface& interface, evmc_host_context* ctx) noexcept
|
|
: host{&interface}, context{ctx}
|
|
{}
|
|
|
|
bool account_exists(const address& address) const noexcept final
|
|
{
|
|
return host->account_exists(context, &address);
|
|
}
|
|
|
|
bytes32 get_storage(const address& address, const bytes32& key) const noexcept final
|
|
{
|
|
return host->get_storage(context, &address, &key);
|
|
}
|
|
|
|
evmc_storage_status set_storage(const address& address,
|
|
const bytes32& key,
|
|
const bytes32& value) noexcept final
|
|
{
|
|
return host->set_storage(context, &address, &key, &value);
|
|
}
|
|
|
|
uint256be get_balance(const address& address) const noexcept final
|
|
{
|
|
return host->get_balance(context, &address);
|
|
}
|
|
|
|
size_t get_code_size(const address& address) const noexcept final
|
|
{
|
|
return host->get_code_size(context, &address);
|
|
}
|
|
|
|
bytes32 get_code_hash(const address& address) const noexcept final
|
|
{
|
|
return host->get_code_hash(context, &address);
|
|
}
|
|
|
|
size_t copy_code(const address& address,
|
|
size_t code_offset,
|
|
uint8_t* buffer_data,
|
|
size_t buffer_size) const noexcept final
|
|
{
|
|
return host->copy_code(context, &address, code_offset, buffer_data, buffer_size);
|
|
}
|
|
|
|
bool selfdestruct(const address& addr, const address& beneficiary) noexcept final
|
|
{
|
|
return host->selfdestruct(context, &addr, &beneficiary);
|
|
}
|
|
|
|
Result call(const evmc_message& message) noexcept final
|
|
{
|
|
return Result{host->call(context, &message)};
|
|
}
|
|
|
|
/// @copydoc HostInterface::get_tx_context()
|
|
evmc_tx_context get_tx_context() const noexcept final { return host->get_tx_context(context); }
|
|
|
|
bytes32 get_block_hash(int64_t number) const noexcept final
|
|
{
|
|
return host->get_block_hash(context, number);
|
|
}
|
|
|
|
void emit_log(const address& addr,
|
|
const uint8_t* data,
|
|
size_t data_size,
|
|
const bytes32 topics[],
|
|
size_t topics_count) noexcept final
|
|
{
|
|
host->emit_log(context, &addr, data, data_size, topics, topics_count);
|
|
}
|
|
|
|
evmc_access_status access_account(const address& address) noexcept final
|
|
{
|
|
return host->access_account(context, &address);
|
|
}
|
|
|
|
evmc_access_status access_storage(const address& address, const bytes32& key) noexcept final
|
|
{
|
|
return host->access_storage(context, &address, &key);
|
|
}
|
|
};
|
|
|
|
|
|
/// Abstract class to be used by Host implementations.
|
|
///
|
|
/// When implementing EVMC Host, you can directly inherit from the evmc::Host class.
|
|
/// This way your implementation will be simpler by avoiding manual handling
|
|
/// of the ::evmc_host_context and the ::evmc_host_interface.
|
|
class Host : public HostInterface
|
|
{
|
|
public:
|
|
/// Provides access to the global host interface.
|
|
/// @returns Reference to the host interface object.
|
|
static const evmc_host_interface& get_interface() noexcept;
|
|
|
|
/// Converts the Host object to the opaque host context pointer.
|
|
/// @returns Pointer to evmc_host_context.
|
|
evmc_host_context* to_context() noexcept { return reinterpret_cast<evmc_host_context*>(this); }
|
|
|
|
/// Converts the opaque host context pointer back to the original Host object.
|
|
/// @tparam DerivedClass The class derived from the Host class.
|
|
/// @param context The opaque host context pointer.
|
|
/// @returns The pointer to DerivedClass.
|
|
template <typename DerivedClass = Host>
|
|
static DerivedClass* from_context(evmc_host_context* context) noexcept
|
|
{
|
|
// Get pointer of the Host base class.
|
|
auto* h = reinterpret_cast<Host*>(context);
|
|
|
|
// Additional downcast, only possible if DerivedClass inherits from Host.
|
|
return static_cast<DerivedClass*>(h);
|
|
}
|
|
};
|
|
|
|
|
|
/// @copybrief evmc_vm
|
|
///
|
|
/// This is a RAII wrapper for evmc_vm, and object of this type
|
|
/// automatically destroys the VM instance.
|
|
class VM
|
|
{
|
|
public:
|
|
VM() noexcept = default;
|
|
|
|
/// Converting constructor from evmc_vm.
|
|
explicit VM(evmc_vm* vm) noexcept : m_instance{vm} {}
|
|
|
|
/// Destructor responsible for automatically destroying the VM instance.
|
|
~VM() noexcept
|
|
{
|
|
if (m_instance != nullptr)
|
|
m_instance->destroy(m_instance);
|
|
}
|
|
|
|
VM(const VM&) = delete;
|
|
VM& operator=(const VM&) = delete;
|
|
|
|
/// Move constructor.
|
|
VM(VM&& other) noexcept : m_instance{other.m_instance} { other.m_instance = nullptr; }
|
|
|
|
/// Move assignment operator.
|
|
VM& operator=(VM&& other) noexcept
|
|
{
|
|
this->~VM();
|
|
m_instance = other.m_instance;
|
|
other.m_instance = nullptr;
|
|
return *this;
|
|
}
|
|
|
|
/// The constructor that captures a VM instance and configures the instance
|
|
/// with the provided list of options.
|
|
inline VM(evmc_vm* vm,
|
|
std::initializer_list<std::pair<const char*, const char*>> options) noexcept;
|
|
|
|
/// Checks if contains a valid pointer to the VM instance.
|
|
explicit operator bool() const noexcept { return m_instance != nullptr; }
|
|
|
|
/// Checks whenever the VM instance is ABI compatible with the current EVMC API.
|
|
bool is_abi_compatible() const noexcept { return m_instance->abi_version == EVMC_ABI_VERSION; }
|
|
|
|
/// @copydoc evmc_vm::name
|
|
char const* name() const noexcept { return m_instance->name; }
|
|
|
|
/// @copydoc evmc_vm::version
|
|
char const* version() const noexcept { return m_instance->version; }
|
|
|
|
/// Checks if the VM has the given capability.
|
|
bool has_capability(evmc_capabilities capability) const noexcept
|
|
{
|
|
return (get_capabilities() & static_cast<evmc_capabilities_flagset>(capability)) != 0;
|
|
}
|
|
|
|
/// @copydoc evmc_vm::get_capabilities
|
|
evmc_capabilities_flagset get_capabilities() const noexcept
|
|
{
|
|
return m_instance->get_capabilities(m_instance);
|
|
}
|
|
|
|
/// @copydoc evmc_set_option()
|
|
evmc_set_option_result set_option(const char name[], const char value[]) noexcept
|
|
{
|
|
return evmc_set_option(m_instance, name, value);
|
|
}
|
|
|
|
/// @copydoc evmc_execute()
|
|
Result execute(const evmc_host_interface& host,
|
|
evmc_host_context* ctx,
|
|
evmc_revision rev,
|
|
const evmc_message& msg,
|
|
const uint8_t* code,
|
|
size_t code_size) noexcept
|
|
{
|
|
return Result{m_instance->execute(m_instance, &host, ctx, rev, &msg, code, code_size)};
|
|
}
|
|
|
|
/// Convenient variant of the VM::execute() that takes reference to evmc::Host class.
|
|
Result execute(Host& host,
|
|
evmc_revision rev,
|
|
const evmc_message& msg,
|
|
const uint8_t* code,
|
|
size_t code_size) noexcept
|
|
{
|
|
return execute(Host::get_interface(), host.to_context(), rev, msg, code, code_size);
|
|
}
|
|
|
|
/// Executes code without the Host context.
|
|
///
|
|
/// The same as
|
|
/// execute(const evmc_host_interface&, evmc_host_context*, evmc_revision,
|
|
/// const evmc_message&, const uint8_t*, size_t),
|
|
/// but without providing the Host context and interface.
|
|
/// This method is for experimental precompiles support where execution is
|
|
/// guaranteed not to require any Host access.
|
|
Result execute(evmc_revision rev,
|
|
const evmc_message& msg,
|
|
const uint8_t* code,
|
|
size_t code_size) noexcept
|
|
{
|
|
return Result{
|
|
m_instance->execute(m_instance, nullptr, nullptr, rev, &msg, code, code_size)};
|
|
}
|
|
|
|
/// Returns the pointer to C EVMC struct representing the VM.
|
|
///
|
|
/// Gives access to the C EVMC VM struct to allow advanced interaction with the VM not supported
|
|
/// by the C++ interface. Use as the last resort.
|
|
/// This object still owns the VM after returning the pointer. The returned pointer MAY be null.
|
|
evmc_vm* get_raw_pointer() const noexcept { return m_instance; }
|
|
|
|
private:
|
|
evmc_vm* m_instance = nullptr;
|
|
};
|
|
|
|
inline VM::VM(evmc_vm* vm,
|
|
std::initializer_list<std::pair<const char*, const char*>> options) noexcept
|
|
: m_instance{vm}
|
|
{
|
|
// This constructor is implemented outside of the class definition to workaround a doxygen bug.
|
|
for (const auto& option : options)
|
|
set_option(option.first, option.second);
|
|
}
|
|
|
|
|
|
namespace internal
|
|
{
|
|
inline bool account_exists(evmc_host_context* h, const evmc_address* addr) noexcept
|
|
{
|
|
return Host::from_context(h)->account_exists(*addr);
|
|
}
|
|
|
|
inline evmc_bytes32 get_storage(evmc_host_context* h,
|
|
const evmc_address* addr,
|
|
const evmc_bytes32* key) noexcept
|
|
{
|
|
return Host::from_context(h)->get_storage(*addr, *key);
|
|
}
|
|
|
|
inline evmc_storage_status set_storage(evmc_host_context* h,
|
|
const evmc_address* addr,
|
|
const evmc_bytes32* key,
|
|
const evmc_bytes32* value) noexcept
|
|
{
|
|
return Host::from_context(h)->set_storage(*addr, *key, *value);
|
|
}
|
|
|
|
inline evmc_uint256be get_balance(evmc_host_context* h, const evmc_address* addr) noexcept
|
|
{
|
|
return Host::from_context(h)->get_balance(*addr);
|
|
}
|
|
|
|
inline size_t get_code_size(evmc_host_context* h, const evmc_address* addr) noexcept
|
|
{
|
|
return Host::from_context(h)->get_code_size(*addr);
|
|
}
|
|
|
|
inline evmc_bytes32 get_code_hash(evmc_host_context* h, const evmc_address* addr) noexcept
|
|
{
|
|
return Host::from_context(h)->get_code_hash(*addr);
|
|
}
|
|
|
|
inline size_t copy_code(evmc_host_context* h,
|
|
const evmc_address* addr,
|
|
size_t code_offset,
|
|
uint8_t* buffer_data,
|
|
size_t buffer_size) noexcept
|
|
{
|
|
return Host::from_context(h)->copy_code(*addr, code_offset, buffer_data, buffer_size);
|
|
}
|
|
|
|
inline bool selfdestruct(evmc_host_context* h,
|
|
const evmc_address* addr,
|
|
const evmc_address* beneficiary) noexcept
|
|
{
|
|
return Host::from_context(h)->selfdestruct(*addr, *beneficiary);
|
|
}
|
|
|
|
inline evmc_result call(evmc_host_context* h, const evmc_message* msg) noexcept
|
|
{
|
|
return Host::from_context(h)->call(*msg).release_raw();
|
|
}
|
|
|
|
inline evmc_tx_context get_tx_context(evmc_host_context* h) noexcept
|
|
{
|
|
return Host::from_context(h)->get_tx_context();
|
|
}
|
|
|
|
inline evmc_bytes32 get_block_hash(evmc_host_context* h, int64_t block_number) noexcept
|
|
{
|
|
return Host::from_context(h)->get_block_hash(block_number);
|
|
}
|
|
|
|
inline void emit_log(evmc_host_context* h,
|
|
const evmc_address* addr,
|
|
const uint8_t* data,
|
|
size_t data_size,
|
|
const evmc_bytes32 topics[],
|
|
size_t num_topics) noexcept
|
|
{
|
|
Host::from_context(h)->emit_log(*addr, data, data_size, static_cast<const bytes32*>(topics),
|
|
num_topics);
|
|
}
|
|
|
|
inline evmc_access_status access_account(evmc_host_context* h, const evmc_address* addr) noexcept
|
|
{
|
|
return Host::from_context(h)->access_account(*addr);
|
|
}
|
|
|
|
inline evmc_access_status access_storage(evmc_host_context* h,
|
|
const evmc_address* addr,
|
|
const evmc_bytes32* key) noexcept
|
|
{
|
|
return Host::from_context(h)->access_storage(*addr, *key);
|
|
}
|
|
} // namespace internal
|
|
|
|
inline const evmc_host_interface& Host::get_interface() noexcept
|
|
{
|
|
static constexpr evmc_host_interface interface = {
|
|
::evmc::internal::account_exists, ::evmc::internal::get_storage,
|
|
::evmc::internal::set_storage, ::evmc::internal::get_balance,
|
|
::evmc::internal::get_code_size, ::evmc::internal::get_code_hash,
|
|
::evmc::internal::copy_code, ::evmc::internal::selfdestruct,
|
|
::evmc::internal::call, ::evmc::internal::get_tx_context,
|
|
::evmc::internal::get_block_hash, ::evmc::internal::emit_log,
|
|
::evmc::internal::access_account, ::evmc::internal::access_storage,
|
|
};
|
|
return interface;
|
|
}
|
|
} // namespace evmc
|
|
|
|
|
|
/// "Stream out" operator implementation for ::evmc_status_code.
|
|
///
|
|
/// @note This is defined in global namespace to match ::evmc_status_code definition and allow
|
|
/// convenient operator overloading usage.
|
|
inline std::ostream& operator<<(std::ostream& os, evmc_status_code status_code)
|
|
{
|
|
return os << evmc::to_string(status_code);
|
|
}
|
|
|
|
/// "Stream out" operator implementation for ::evmc_revision.
|
|
///
|
|
/// @note This is defined in global namespace to match ::evmc_revision definition and allow
|
|
/// convenient operator overloading usage.
|
|
inline std::ostream& operator<<(std::ostream& os, evmc_revision rev)
|
|
{
|
|
return os << evmc::to_string(rev);
|
|
}
|
|
|
|
namespace std
|
|
{
|
|
/// Hash operator template specialization for evmc::address. Needed for unordered containers.
|
|
template <>
|
|
struct hash<evmc::address>
|
|
{
|
|
/// Hash operator using FNV1a-based folding.
|
|
constexpr size_t operator()(const evmc::address& s) const noexcept
|
|
{
|
|
using namespace evmc;
|
|
using namespace fnv;
|
|
return static_cast<size_t>(fnv1a_by64(
|
|
fnv1a_by64(fnv1a_by64(fnv::offset_basis, load64le(&s.bytes[0])), load64le(&s.bytes[8])),
|
|
load32le(&s.bytes[16])));
|
|
}
|
|
};
|
|
|
|
/// Hash operator template specialization for evmc::bytes32. Needed for unordered containers.
|
|
template <>
|
|
struct hash<evmc::bytes32>
|
|
{
|
|
/// Hash operator using FNV1a-based folding.
|
|
constexpr size_t operator()(const evmc::bytes32& s) const noexcept
|
|
{
|
|
using namespace evmc;
|
|
using namespace fnv;
|
|
return static_cast<size_t>(
|
|
fnv1a_by64(fnv1a_by64(fnv1a_by64(fnv1a_by64(fnv::offset_basis, load64le(&s.bytes[0])),
|
|
load64le(&s.bytes[8])),
|
|
load64le(&s.bytes[16])),
|
|
load64le(&s.bytes[24])));
|
|
}
|
|
};
|
|
} // namespace std
|