EVMC Helpers

EVMC Helpers. More...

Modules
	Result Optional Storage
	Helpers for optional storage of evmc_result.

Macros
#define	EVMC_EXPORT   __attribute__((visibility("default")))
	Marks a function to be exported from a shared library.
#define	EVMC_NOEXCEPT
	Safe way of marking a function with noexcept C++ specifier.

Functions
static bool	evmc_is_abi_compatible (struct evmc_vm *vm)
	Returns true if the VM has a compatible ABI version.
static const char *	evmc_vm_name (struct evmc_vm *vm)
	Returns the name of the VM.
static const char *	evmc_vm_version (struct evmc_vm *vm)
	Returns the version of the VM.
static bool	evmc_vm_has_capability (struct evmc_vm *vm, enum evmc_capabilities capability)
	Checks if the VM has the given capability.
static void	evmc_destroy (struct evmc_vm *vm)
	Destroys the VM instance.
static enum evmc_set_option_result	evmc_set_option (struct evmc_vm *vm, char const *name, char const *value)
	Sets the option for the VM, if the feature is supported by the VM.
static struct evmc_result	evmc_execute (struct evmc_vm *vm, const struct evmc_host_interface *host, struct evmc_host_context *context, enum evmc_revision rev, const struct evmc_message *msg, uint8_t const *code, size_t code_size)
	Executes code in the VM instance.
static void	evmc_free_result_memory (const struct evmc_result *result)
	The evmc_result release function using free() for releasing the memory.
static struct evmc_result	evmc_make_result (enum evmc_status_code status_code, int64_t gas_left, int64_t gas_refund, const uint8_t *output_data, size_t output_size)
	Creates the result from the provided arguments.
static void	evmc_release_result (struct evmc_result *result)
	Releases the resources allocated to the execution result.
static const char *	evmc_status_code_to_string (enum evmc_status_code status_code)
	Returns text representation of the evmc_status_code.
static const char *	evmc_revision_to_string (enum evmc_revision rev)
	Returns the name of the evmc_revision.

Detailed Description

EVMC Helpers.

A collection of C helper functions for invoking a VM instance methods. These are convenient for languages where invoking function pointers is "ugly" or impossible (such as Go).

Macro Definition Documentation

EVMC_EXPORT

#define EVMC_EXPORT   __attribute__((visibility("default")))

Marks a function to be exported from a shared library.

Definition at line 22 of file utils.h.

EVMC_NOEXCEPT

#define EVMC_NOEXCEPT

Safe way of marking a function with noexcept C++ specifier.

Definition at line 32 of file utils.h.

Function Documentation

evmc_destroy()

static void evmc_destroy ( struct evmc_vm *  vm )

inlinestatic

Destroys the VM instance.

See also

evmc_destroy_fn

Definition at line 68 of file helpers.h.

{
    vm->destroy(vm);
}

evmc_execute()

static struct evmc_result evmc_execute ( struct evmc_vm *  vm, const struct evmc_host_interface *  host, struct evmc_host_context *  context, enum evmc_revision  rev, const struct evmc_message *  msg, uint8_t const *  code, size_t  code_size  )

inlinestatic

Executes code in the VM instance.

See also

evmc_execute_fn.

Definition at line 92 of file helpers.h.

{
    return vm->execute(vm, host, context, rev, msg, code, code_size);
}

evmc_free_result_memory()

static void evmc_free_result_memory ( const struct evmc_result *  result )

static

The evmc_result release function using free() for releasing the memory.

This function is used in the evmc_make_result(), but may be also used in other case if convenient.

Parameters

result

The result object.

Definition at line 109 of file helpers.h.

{
    free((uint8_t*)result->output_data);
}

evmc_is_abi_compatible()

static bool evmc_is_abi_compatible ( struct evmc_vm *  vm )

inlinestatic

Returns true if the VM has a compatible ABI version.

Definition at line 32 of file helpers.h.

{
    return vm->abi_version == EVMC_ABI_VERSION;
}

evmc_make_result()

static struct evmc_result evmc_make_result ( enum evmc_status_code  status_code, int64_t  gas_left, int64_t  gas_refund, const uint8_t *  output_data, size_t  output_size  )

inlinestatic

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().

In case of memory allocation failure, the result has all fields zeroed and only evmc_result::status_code is set to EVMC_OUT_OF_MEMORY internal error.

Parameters

status_code	The status code.
gas_left	The amount of gas left.
gas_refund	The amount of refunded gas.
output_data	The pointer to the output.
output_size	The output size.

Definition at line 127 of file helpers.h.

{
    struct evmc_result result;
    memset(&result, 0, sizeof(result));
 
    if (output_size != 0)
    {
        uint8_t* buffer = (uint8_t*)malloc(output_size);
 
        if (!buffer)
        {
            result.status_code = EVMC_OUT_OF_MEMORY;
            return result;
        }
 
        memcpy(buffer, output_data, output_size);
        result.output_data = buffer;
        result.output_size = output_size;
        result.release = evmc_free_result_memory;
    }
 
    result.status_code = status_code;
    result.gas_left = gas_left;
    result.gas_refund = gas_refund;
    return result;
}

evmc_release_result()

static void evmc_release_result ( struct evmc_result *  result )

inlinestatic

Releases the resources allocated to the execution result.

Parameters

result

The result object to be released. MUST NOT be NULL.

See also

evmc_result::release() evmc_release_result_fn

Definition at line 165 of file helpers.h.

{
    if (result->release)
        result->release(result);
}

evmc_revision_to_string()

static const char * evmc_revision_to_string ( enum evmc_revision  rev )

inlinestatic

Returns the name of the evmc_revision.

Definition at line 272 of file helpers.h.

{
    switch (rev)
    {
    case EVMC_FRONTIER:
        return "Frontier";
    case EVMC_HOMESTEAD:
        return "Homestead";
    case EVMC_TANGERINE_WHISTLE:
        return "Tangerine Whistle";
    case EVMC_SPURIOUS_DRAGON:
        return "Spurious Dragon";
    case EVMC_BYZANTIUM:
        return "Byzantium";
    case EVMC_CONSTANTINOPLE:
        return "Constantinople";
    case EVMC_PETERSBURG:
        return "Petersburg";
    case EVMC_ISTANBUL:
        return "Istanbul";
    case EVMC_BERLIN:
        return "Berlin";
    case EVMC_LONDON:
        return "London";
    case EVMC_PARIS:
        return "Paris";
    case EVMC_SHANGHAI:
        return "Shanghai";
    case EVMC_CANCUN:
        return "Cancun";
    case EVMC_PRAGUE:
        return "Prague";
    case EVMC_OSAKA:
        return "Osaka";
    }
    return "<unknown>";
}

evmc_set_option()

static enum evmc_set_option_result evmc_set_option ( struct evmc_vm *  vm, char const *  name, char const *  value  )

inlinestatic

Sets the option for the VM, if the feature is supported by the VM.

See also

evmc_set_option_fn

Definition at line 78 of file helpers.h.

{
    if (vm->set_option)
        return vm->set_option(vm, name, value);
    return EVMC_SET_OPTION_INVALID_NAME;
}

evmc_status_code_to_string()

static const char * evmc_status_code_to_string ( enum evmc_status_code  status_code )

inlinestatic

Returns text representation of the evmc_status_code.

Definition at line 221 of file helpers.h.

{
    switch (status_code)
    {
    case EVMC_SUCCESS:
        return "success";
    case EVMC_FAILURE:
        return "failure";
    case EVMC_REVERT:
        return "revert";
    case EVMC_OUT_OF_GAS:
        return "out of gas";
    case EVMC_INVALID_INSTRUCTION:
        return "invalid instruction";
    case EVMC_UNDEFINED_INSTRUCTION:
        return "undefined instruction";
    case EVMC_STACK_OVERFLOW:
        return "stack overflow";
    case EVMC_STACK_UNDERFLOW:
        return "stack underflow";
    case EVMC_BAD_JUMP_DESTINATION:
        return "bad jump destination";
    case EVMC_INVALID_MEMORY_ACCESS:
        return "invalid memory access";
    case EVMC_CALL_DEPTH_EXCEEDED:
        return "call depth exceeded";
    case EVMC_STATIC_MODE_VIOLATION:
        return "static mode violation";
    case EVMC_PRECOMPILE_FAILURE:
        return "precompile failure";
    case EVMC_CONTRACT_VALIDATION_FAILURE:
        return "contract validation failure";
    case EVMC_ARGUMENT_OUT_OF_RANGE:
        return "argument out of range";
    case EVMC_WASM_UNREACHABLE_INSTRUCTION:
        return "wasm unreachable instruction";
    case EVMC_WASM_TRAP:
        return "wasm trap";
    case EVMC_INSUFFICIENT_BALANCE:
        return "insufficient balance";
    case EVMC_INTERNAL_ERROR:
        return "internal error";
    case EVMC_REJECTED:
        return "rejected";
    case EVMC_OUT_OF_MEMORY:
        return "out of memory";
    }
    return "<unknown>";
}

evmc_vm_has_capability()

static bool evmc_vm_has_capability ( struct evmc_vm *  vm, enum evmc_capabilities  capability  )

inlinestatic

Checks if the VM has the given capability.

See also

evmc_get_capabilities_fn

Definition at line 58 of file helpers.h.

{
    return (vm->get_capabilities(vm) & (evmc_capabilities_flagset)capability) != 0;
}

evmc_vm_name()

static const char * evmc_vm_name ( struct evmc_vm *  vm )

inlinestatic

Returns the name of the VM.

Definition at line 40 of file helpers.h.

{
    return vm->name;
}

evmc_vm_version()

static const char * evmc_vm_version ( struct evmc_vm *  vm )

inlinestatic

Returns the version of the VM.

Definition at line 48 of file helpers.h.

{
    return vm->version;
}