wasmer/lib/runtime-c-api/wasmer.h

382 lines
11 KiB
C
Raw Normal View History

2019-02-10 00:07:05 +00:00
#ifndef WASMER_H
#define WASMER_H
2019-02-02 04:10:36 +00:00
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
2019-02-01 05:51:34 +00:00
2019-02-14 02:02:11 +00:00
enum wasmer_import_export_kind {
WASM_FUNCTION,
WASM_GLOBAL,
WASM_MEMORY,
WASM_TABLE,
};
typedef uint32_t wasmer_import_export_kind;
2019-02-02 06:26:10 +00:00
typedef enum {
2019-02-12 01:07:28 +00:00
WASMER_OK = 1,
WASMER_ERROR = 2,
} wasmer_result_t;
2019-02-09 19:37:07 +00:00
enum wasmer_value_tag {
WASM_I32,
WASM_I64,
WASM_F32,
WASM_F64,
};
typedef uint32_t wasmer_value_tag;
typedef struct wasmer_instance_context_t wasmer_instance_context_t;
2019-02-02 04:10:36 +00:00
typedef struct wasmer_instance_t wasmer_instance_t;
2019-02-01 05:51:34 +00:00
2019-02-16 01:47:00 +00:00
typedef struct wasmer_module_t wasmer_module_t;
2019-02-09 23:39:15 +00:00
typedef struct {
2019-02-14 02:02:11 +00:00
} wasmer_export_t;
typedef struct {
2019-02-14 06:00:39 +00:00
const uint8_t *bytes;
uint32_t bytes_len;
} wasmer_byte_array;
2019-02-14 02:02:11 +00:00
2019-02-14 06:00:39 +00:00
typedef struct {
} wasmer_func_t;
2019-02-14 02:02:11 +00:00
typedef struct {
2019-02-14 06:00:39 +00:00
} wasmer_exports_t;
2019-02-09 23:39:15 +00:00
typedef union {
int32_t I32;
int64_t I64;
float F32;
double F64;
} wasmer_value;
typedef struct {
wasmer_value_tag tag;
wasmer_value value;
} wasmer_value_t;
2019-02-14 06:00:39 +00:00
typedef struct {
} wasmer_global_t;
2019-02-09 23:39:15 +00:00
typedef struct {
bool mutable_;
wasmer_value_tag kind;
} wasmer_global_descriptor_t;
2019-02-05 03:46:47 +00:00
typedef struct {
} wasmer_memory_t;
typedef struct {
2019-02-15 15:40:28 +00:00
} wasmer_table_t;
typedef union {
const wasmer_func_t *func;
const wasmer_table_t *table;
const wasmer_memory_t *memory;
const wasmer_global_t *global;
} wasmer_import_export_value;
2019-02-05 03:46:47 +00:00
2019-02-09 19:37:07 +00:00
typedef struct {
2019-02-15 15:40:28 +00:00
wasmer_byte_array module_name;
wasmer_byte_array import_name;
wasmer_import_export_kind tag;
wasmer_import_export_value value;
} wasmer_import_t;
2019-02-09 19:37:07 +00:00
typedef struct {
bool has_some;
uint32_t some;
} wasmer_limit_option_t;
2019-02-15 15:40:28 +00:00
typedef struct {
uint32_t min;
wasmer_limit_option_t max;
2019-02-15 15:40:28 +00:00
} wasmer_limits_t;
2019-02-09 19:37:07 +00:00
2019-02-16 01:47:00 +00:00
/**
* Creates a new Module from the given wasm bytes.
* Returns `wasmer_result_t::WASMER_OK` upon success.
* Returns `wasmer_result_t::WASMER_ERROR` upon failure. Use `wasmer_last_error_length`
* and `wasmer_last_error_message` to get an error message.
*/
wasmer_result_t wasmer_compile(wasmer_module_t **module,
uint8_t *wasm_bytes,
uint32_t wasm_bytes_len);
2019-02-14 02:02:11 +00:00
/**
* Gets wasmer_export kind
*/
wasmer_import_export_kind wasmer_export_kind(wasmer_export_t *export_);
2019-02-14 06:00:39 +00:00
/**
2019-02-15 15:40:28 +00:00
* Gets name from wasmer_export
2019-02-14 06:00:39 +00:00
*/
wasmer_byte_array wasmer_export_name(wasmer_export_t *export_);
/**
* Gets func from wasm_export
*/
const wasmer_func_t *wasmer_export_to_func(wasmer_export_t *export_);
2019-02-14 02:02:11 +00:00
/**
* Frees the memory for the given exports
*/
void wasmer_exports_destroy(wasmer_exports_t *exports);
/**
* Gets wasmer_export by index
*/
wasmer_export_t *wasmer_exports_get(wasmer_exports_t *exports, int idx);
/**
* Gets the length of the exports
*/
int wasmer_exports_len(wasmer_exports_t *exports);
2019-02-14 06:00:39 +00:00
/**
* Calls a `func` with the provided parameters.
* Results are set using the provided `results` pointer.
* Returns `wasmer_result_t::WASMER_OK` upon success.
* Returns `wasmer_result_t::WASMER_ERROR` upon failure. Use `wasmer_last_error_length`
* and `wasmer_last_error_message` to get an error message.
*/
wasmer_result_t wasmer_func_call(wasmer_func_t *func,
const wasmer_value_t *params,
int params_len,
wasmer_value_t *results,
int results_len);
2019-02-15 15:40:28 +00:00
/**
* Frees memory for the given Func
*/
void wasmer_func_destroy(wasmer_func_t *func);
/**
* Creates new func
* The caller owns the object and should call `wasmer_func_destroy` to free it.
*/
const wasmer_func_t *wasmer_func_new(void (*func)(void *data),
const wasmer_value_tag *params,
int params_len,
const wasmer_value_tag *returns,
int returns_len);
2019-02-17 20:12:05 +00:00
/**
* Sets the params buffer to the parameter types of the given wasmer_func_t
* Returns `wasmer_result_t::WASMER_OK` upon success.
* Returns `wasmer_result_t::WASMER_ERROR` upon failure. Use `wasmer_last_error_length`
* and `wasmer_last_error_message` to get an error message.
*/
wasmer_result_t wasmer_func_params(wasmer_func_t *func, wasmer_value_tag *params, int params_len);
/**
* Sets the result parameter to the arity of the params of the wasmer_func_t
* Returns `wasmer_result_t::WASMER_OK` upon success.
* Returns `wasmer_result_t::WASMER_ERROR` upon failure. Use `wasmer_last_error_length`
* and `wasmer_last_error_message` to get an error message.
*/
wasmer_result_t wasmer_func_params_arity(wasmer_func_t *func, uint32_t *result);
/**
* Sets the returns buffer to the parameter types of the given wasmer_func_t
* Returns `wasmer_result_t::WASMER_OK` upon success.
* Returns `wasmer_result_t::WASMER_ERROR` upon failure. Use `wasmer_last_error_length`
* and `wasmer_last_error_message` to get an error message.
*/
wasmer_result_t wasmer_func_returns(wasmer_func_t *func,
wasmer_value_tag *returns,
int returns_len);
/**
* Sets the result parameter to the arity of the returns of the wasmer_func_t
* Returns `wasmer_result_t::WASMER_OK` upon success.
* Returns `wasmer_result_t::WASMER_ERROR` upon failure. Use `wasmer_last_error_length`
* and `wasmer_last_error_message` to get an error message.
*/
wasmer_result_t wasmer_func_returns_arity(wasmer_func_t *func, uint32_t *result);
2019-02-12 05:14:32 +00:00
/**
* Frees memory for the given Global
*/
2019-02-09 23:39:15 +00:00
void wasmer_global_destroy(wasmer_global_t *global);
2019-02-12 05:14:32 +00:00
/**
* Gets the value stored by the given Global
*/
2019-02-09 23:39:15 +00:00
wasmer_value_t wasmer_global_get(wasmer_global_t *global);
2019-02-12 05:14:32 +00:00
/**
* Returns a descriptor (type, mutability) of the given Global
*/
2019-02-09 23:39:15 +00:00
wasmer_global_descriptor_t wasmer_global_get_descriptor(wasmer_global_t *global);
2019-02-12 05:14:32 +00:00
/**
* Creates a new Global and returns a pointer to it.
* The caller owns the object and should call `wasmer_global_destroy` to free it.
*/
2019-02-09 23:39:15 +00:00
wasmer_global_t *wasmer_global_new(wasmer_value_t value, bool mutable_);
2019-02-12 05:14:32 +00:00
/**
* Sets the value stored by the given Global
*/
2019-02-09 23:39:15 +00:00
void wasmer_global_set(wasmer_global_t *global, wasmer_value_t value);
2019-02-12 05:14:32 +00:00
/**
* Calls an instances exported function by `name` with the provided parameters.
* Results are set using the provided `results` pointer.
* Returns `wasmer_result_t::WASMER_OK` upon success.
* Returns `wasmer_result_t::WASMER_ERROR` upon failure. Use `wasmer_last_error_length`
* and `wasmer_last_error_message` to get an error message.
*/
2019-02-12 01:07:28 +00:00
wasmer_result_t wasmer_instance_call(wasmer_instance_t *instance,
const char *name,
const wasmer_value_t *params,
int params_len,
wasmer_value_t *results,
int results_len);
2019-02-02 06:26:10 +00:00
2019-02-12 05:14:32 +00:00
/**
* Gets the memory within the context at the index `memory_idx`.
* The index is always 0 until multiple memories are supported.
*/
2019-02-10 20:24:36 +00:00
const wasmer_memory_t *wasmer_instance_context_memory(wasmer_instance_context_t *ctx,
uint32_t memory_idx);
2019-02-12 05:14:32 +00:00
/**
* Frees memory for the given Instance
*/
2019-02-02 06:26:10 +00:00
void wasmer_instance_destroy(wasmer_instance_t *instance);
2019-02-14 02:02:11 +00:00
/**
* Gets Exports for the given instance
* The caller owns the object and should call `wasmer_exports_destroy` to free it.
*/
void wasmer_instance_exports(wasmer_instance_t *instance, wasmer_exports_t **exports);
2019-02-12 05:14:32 +00:00
/**
* Creates a new Instance from the given wasm bytes and imports.
* Returns `wasmer_result_t::WASMER_OK` upon success.
* Returns `wasmer_result_t::WASMER_ERROR` upon failure. Use `wasmer_last_error_length`
* and `wasmer_last_error_message` to get an error message.
*/
2019-02-12 01:07:28 +00:00
wasmer_result_t wasmer_instantiate(wasmer_instance_t **instance,
uint8_t *wasm_bytes,
uint32_t wasm_bytes_len,
2019-02-15 15:40:28 +00:00
wasmer_import_t *imports,
int imports_len);
2019-02-05 03:46:47 +00:00
2019-02-12 05:14:32 +00:00
/**
* Gets the length in bytes of the last error.
* This can be used to dynamically allocate a buffer with the correct number of
* bytes needed to store a message.
* # Example
* ```
* int error_len = wasmer_last_error_length();
* char *error_str = malloc(error_len);
* ```
*/
2019-02-10 23:57:23 +00:00
int wasmer_last_error_length(void);
2019-02-12 05:14:32 +00:00
/**
* Stores the last error message into the provided buffer up to the given `length`.
* The `length` parameter must be large enough to store the last error message.
* Returns the length of the string in bytes.
* Returns `-1` if an error occurs.
* # Example
* ```
* int error_len = wasmer_last_error_length();
* char *error_str = malloc(error_len);
* wasmer_last_error_message(error_str, error_len);
* printf("Error str: `%s`\n", error_str);
* ```
*/
2019-02-10 23:57:23 +00:00
int wasmer_last_error_message(char *buffer, int length);
2019-02-12 05:14:32 +00:00
/**
* Gets the start pointer to the bytes within a Memory
*/
2019-02-10 21:20:35 +00:00
uint8_t *wasmer_memory_data(wasmer_memory_t *mem);
2019-02-12 05:14:32 +00:00
/**
* Gets the size in bytes of a Memory
*/
2019-02-10 20:14:42 +00:00
uint32_t wasmer_memory_data_length(wasmer_memory_t *mem);
2019-02-12 05:14:32 +00:00
/**
* Frees memory for the given Memory
*/
2019-02-05 03:46:47 +00:00
void wasmer_memory_destroy(wasmer_memory_t *memory);
2019-02-12 05:14:32 +00:00
/**
* Grows a Memory by the given number of pages.
* Returns `wasmer_result_t::WASMER_OK` upon success.
* Returns `wasmer_result_t::WASMER_ERROR` upon failure. Use `wasmer_last_error_length`
* and `wasmer_last_error_message` to get an error message.
*/
2019-02-12 01:07:28 +00:00
wasmer_result_t wasmer_memory_grow(wasmer_memory_t *memory, uint32_t delta);
2019-02-09 23:53:03 +00:00
2019-02-12 05:14:32 +00:00
/**
* Returns the current length in pages of the given memory
*/
2019-02-05 03:46:47 +00:00
uint32_t wasmer_memory_length(wasmer_memory_t *memory);
2019-02-12 05:14:32 +00:00
/**
* Creates a new Memory for the given descriptor and initializes the given
* pointer to pointer to a pointer to the new memory.
* The caller owns the object and should call `wasmer_memory_destroy` to free it.
* Returns `wasmer_result_t::WASMER_OK` upon success.
* Returns `wasmer_result_t::WASMER_ERROR` upon failure. Use `wasmer_last_error_length`
* and `wasmer_last_error_message` to get an error message.
*/
2019-02-12 01:07:28 +00:00
wasmer_result_t wasmer_memory_new(wasmer_memory_t **memory, wasmer_limits_t limits);
2019-02-05 06:01:01 +00:00
2019-02-16 01:47:00 +00:00
/**
* Frees memory for the given Module
*/
void wasmer_module_destroy(wasmer_module_t *module);
2019-02-12 05:14:32 +00:00
/**
* Frees memory for the given Table
*/
2019-02-09 19:37:07 +00:00
void wasmer_table_destroy(wasmer_table_t *table);
2019-02-12 05:14:32 +00:00
/**
* Grows a Table by the given number of elements.
* Returns `wasmer_result_t::WASMER_OK` upon success.
* Returns `wasmer_result_t::WASMER_ERROR` upon failure. Use `wasmer_last_error_length`
* and `wasmer_last_error_message` to get an error message.
*/
2019-02-12 01:07:28 +00:00
wasmer_result_t wasmer_table_grow(wasmer_table_t *table, uint32_t delta);
2019-02-09 19:58:50 +00:00
2019-02-12 05:14:32 +00:00
/**
* Returns the current length of the given Table
*/
2019-02-09 19:37:07 +00:00
uint32_t wasmer_table_length(wasmer_table_t *table);
2019-02-12 05:14:32 +00:00
/**
* Creates a new Table for the given descriptor and initializes the given
* pointer to pointer to a pointer to the new Table.
* The caller owns the object and should call `wasmer_table_destroy` to free it.
* Returns `wasmer_result_t::WASMER_OK` upon success.
* Returns `wasmer_result_t::WASMER_ERROR` upon failure. Use `wasmer_last_error_length`
* and `wasmer_last_error_message` to get an error message.
*/
2019-02-12 01:07:28 +00:00
wasmer_result_t wasmer_table_new(wasmer_table_t **table, wasmer_limits_t limits);
2019-02-09 19:37:07 +00:00
2019-02-12 05:14:32 +00:00
/**
* Returns true for valid wasm bytes and false for invalid bytes
*/
2019-02-05 06:01:01 +00:00
bool wasmer_validate(uint8_t *wasm_bytes, uint32_t wasm_bytes_len);
2019-02-10 00:07:05 +00:00
#endif /* WASMER_H */