wasm_c_api.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783
  1. // WebAssembly C API
  2. #ifndef WASM_H
  3. #define WASM_H
  4. #include <stddef.h>
  5. #include <stdint.h>
  6. #include <stdbool.h>
  7. #include <string.h>
  8. #include <assert.h>
  9. #ifndef WASM_API_EXTERN
  10. #if defined(_MSC_BUILD)
  11. #if defined(COMPILING_WASM_RUNTIME_API)
  12. #define WASM_API_EXTERN __declspec(dllexport)
  13. #else
  14. #define WASM_API_EXTERN __declspec(dllimport)
  15. #endif
  16. #else
  17. #define WASM_API_EXTERN
  18. #endif
  19. #endif
  20. #ifdef __cplusplus
  21. extern "C" {
  22. #endif
  23. ///////////////////////////////////////////////////////////////////////////////
  24. // Auxiliaries
  25. // Machine types
  26. #if (__STDC_VERSION__) > 199901L
  27. inline void assertions(void) {
  28. static_assert(sizeof(float) == sizeof(uint32_t), "incompatible float type");
  29. static_assert(sizeof(double) == sizeof(uint64_t), "incompatible double type");
  30. static_assert(sizeof(intptr_t) == sizeof(uint32_t) ||
  31. sizeof(intptr_t) == sizeof(uint64_t),
  32. "incompatible pointer type");
  33. }
  34. #endif
  35. typedef char byte_t;
  36. typedef float float32_t;
  37. typedef double float64_t;
  38. // Ownership
  39. #define own
  40. // The qualifier `own` is used to indicate ownership of data in this API.
  41. // It is intended to be interpreted similar to a `const` qualifier:
  42. //
  43. // - `own wasm_xxx_t*` owns the pointed-to data
  44. // - `own wasm_xxx_t` distributes to all fields of a struct or union `xxx`
  45. // - `own wasm_xxx_vec_t` owns the vector as well as its elements(!)
  46. // - an `own` function parameter passes ownership from caller to callee
  47. // - an `own` function result passes ownership from callee to caller
  48. // - an exception are `own` pointer parameters named `out`, which are copy-back
  49. // output parameters passing back ownership from callee to caller
  50. //
  51. // Own data is created by `wasm_xxx_new` functions and some others.
  52. // It must be released with the corresponding `wasm_xxx_delete` function.
  53. //
  54. // Deleting a reference does not necessarily delete the underlying object,
  55. // it merely indicates that this owner no longer uses it.
  56. //
  57. // For vectors, `const wasm_xxx_vec_t` is used informally to indicate that
  58. // neither the vector nor its elements should be modified.
  59. // TODO: introduce proper `wasm_xxx_const_vec_t`?
  60. #define WASM_DECLARE_OWN(name) \
  61. typedef struct wasm_##name##_t wasm_##name##_t; \
  62. \
  63. WASM_API_EXTERN void wasm_##name##_delete(own wasm_##name##_t*);
  64. // Vectors
  65. // size: capacity
  66. // num_elems: current number of elements
  67. // size_of_elem: size of one elemen
  68. #define WASM_DECLARE_VEC(name, ptr_or_none) \
  69. typedef struct wasm_##name##_vec_t { \
  70. size_t size; \
  71. wasm_##name##_t ptr_or_none* data; \
  72. size_t num_elems; \
  73. size_t size_of_elem; \
  74. } wasm_##name##_vec_t; \
  75. \
  76. WASM_API_EXTERN void wasm_##name##_vec_new_empty(own wasm_##name##_vec_t* out); \
  77. WASM_API_EXTERN void wasm_##name##_vec_new_uninitialized( \
  78. own wasm_##name##_vec_t* out, size_t); \
  79. WASM_API_EXTERN void wasm_##name##_vec_new( \
  80. own wasm_##name##_vec_t* out, \
  81. size_t, own wasm_##name##_t ptr_or_none const[]); \
  82. WASM_API_EXTERN void wasm_##name##_vec_copy( \
  83. own wasm_##name##_vec_t* out, const wasm_##name##_vec_t*); \
  84. WASM_API_EXTERN void wasm_##name##_vec_delete(own wasm_##name##_vec_t*);
  85. // Byte vectors
  86. typedef byte_t wasm_byte_t;
  87. WASM_DECLARE_VEC(byte, )
  88. typedef wasm_byte_vec_t wasm_name_t;
  89. #define wasm_name wasm_byte_vec
  90. #define wasm_name_new wasm_byte_vec_new
  91. #define wasm_name_new_empty wasm_byte_vec_new_empty
  92. #define wasm_name_new_new_uninitialized wasm_byte_vec_new_uninitialized
  93. #define wasm_name_copy wasm_byte_vec_copy
  94. #define wasm_name_delete wasm_byte_vec_delete
  95. static inline void wasm_name_new_from_string(
  96. own wasm_name_t* out, const char* s
  97. ) {
  98. wasm_name_new(out, strlen(s), s);
  99. }
  100. static inline void wasm_name_new_from_string_nt(
  101. own wasm_name_t* out, const char* s
  102. ) {
  103. wasm_name_new(out, strlen(s) + 1, s);
  104. }
  105. ///////////////////////////////////////////////////////////////////////////////
  106. // Runtime Environment
  107. // Configuration
  108. WASM_DECLARE_OWN(config)
  109. WASM_API_EXTERN own wasm_config_t* wasm_config_new(void);
  110. // Embedders may provide custom functions for manipulating configs.
  111. // Engine
  112. WASM_DECLARE_OWN(engine)
  113. WASM_API_EXTERN own wasm_engine_t* wasm_engine_new(void);
  114. WASM_API_EXTERN own wasm_engine_t* wasm_engine_new_with_config(own wasm_config_t*);
  115. #ifndef MEM_ALLOC_OPTION_DEFINED
  116. #define MEM_ALLOC_OPTION_DEFINED
  117. /* same definition from wasm_export.h */
  118. /* Memory allocator type */
  119. typedef enum {
  120. /* pool mode, allocate memory from user defined heap buffer */
  121. Alloc_With_Pool = 0,
  122. /* user allocator mode, allocate memory from user defined
  123. malloc function */
  124. Alloc_With_Allocator,
  125. /* system allocator mode, allocate memory from system allocator,
  126. or, platform's os_malloc function */
  127. Alloc_With_System_Allocator,
  128. } mem_alloc_type_t;
  129. /* Memory allocator option */
  130. typedef union MemAllocOption {
  131. struct {
  132. void *heap_buf;
  133. uint32_t heap_size;
  134. } pool;
  135. struct {
  136. void *malloc_func;
  137. void *realloc_func;
  138. void *free_func;
  139. } allocator;
  140. } MemAllocOption;
  141. #endif
  142. WASM_API_EXTERN own wasm_engine_t *
  143. wasm_engine_new_with_args(mem_alloc_type_t type, const MemAllocOption *opts);
  144. // Store
  145. WASM_DECLARE_OWN(store)
  146. WASM_API_EXTERN own wasm_store_t* wasm_store_new(wasm_engine_t*);
  147. ///////////////////////////////////////////////////////////////////////////////
  148. // Type Representations
  149. // Type attributes
  150. typedef uint8_t wasm_mutability_t;
  151. enum wasm_mutability_enum {
  152. WASM_CONST,
  153. WASM_VAR,
  154. };
  155. typedef struct wasm_limits_t {
  156. uint32_t min;
  157. uint32_t max;
  158. } wasm_limits_t;
  159. static const uint32_t wasm_limits_max_default = 0xffffffff;
  160. // Generic
  161. #define WASM_DECLARE_TYPE(name) \
  162. WASM_DECLARE_OWN(name) \
  163. WASM_DECLARE_VEC(name, *) \
  164. \
  165. WASM_API_EXTERN own wasm_##name##_t* wasm_##name##_copy(const wasm_##name##_t*);
  166. // Value Types
  167. WASM_DECLARE_TYPE(valtype)
  168. #ifndef WASM_VALKIND_T_DEFINED
  169. #define WASM_VALKIND_T_DEFINED
  170. typedef uint8_t wasm_valkind_t;
  171. enum wasm_valkind_enum {
  172. WASM_I32,
  173. WASM_I64,
  174. WASM_F32,
  175. WASM_F64,
  176. WASM_ANYREF = 128,
  177. WASM_FUNCREF,
  178. };
  179. #endif
  180. WASM_API_EXTERN own wasm_valtype_t* wasm_valtype_new(wasm_valkind_t);
  181. WASM_API_EXTERN wasm_valkind_t wasm_valtype_kind(const wasm_valtype_t*);
  182. static inline bool wasm_valkind_is_num(wasm_valkind_t k) {
  183. return k < WASM_ANYREF;
  184. }
  185. static inline bool wasm_valkind_is_ref(wasm_valkind_t k) {
  186. return k >= WASM_ANYREF;
  187. }
  188. static inline bool wasm_valtype_is_num(const wasm_valtype_t* t) {
  189. return wasm_valkind_is_num(wasm_valtype_kind(t));
  190. }
  191. static inline bool wasm_valtype_is_ref(const wasm_valtype_t* t) {
  192. return wasm_valkind_is_ref(wasm_valtype_kind(t));
  193. }
  194. // Function Types
  195. WASM_DECLARE_TYPE(functype)
  196. WASM_API_EXTERN own wasm_functype_t* wasm_functype_new(
  197. own wasm_valtype_vec_t* params, own wasm_valtype_vec_t* results);
  198. WASM_API_EXTERN const wasm_valtype_vec_t* wasm_functype_params(const wasm_functype_t*);
  199. WASM_API_EXTERN const wasm_valtype_vec_t* wasm_functype_results(const wasm_functype_t*);
  200. // Global Types
  201. WASM_DECLARE_TYPE(globaltype)
  202. WASM_API_EXTERN own wasm_globaltype_t* wasm_globaltype_new(
  203. own wasm_valtype_t*, wasm_mutability_t);
  204. WASM_API_EXTERN const wasm_valtype_t* wasm_globaltype_content(const wasm_globaltype_t*);
  205. WASM_API_EXTERN wasm_mutability_t wasm_globaltype_mutability(const wasm_globaltype_t*);
  206. // Table Types
  207. WASM_DECLARE_TYPE(tabletype)
  208. WASM_API_EXTERN own wasm_tabletype_t* wasm_tabletype_new(
  209. own wasm_valtype_t*, const wasm_limits_t*);
  210. WASM_API_EXTERN const wasm_valtype_t* wasm_tabletype_element(const wasm_tabletype_t*);
  211. WASM_API_EXTERN const wasm_limits_t* wasm_tabletype_limits(const wasm_tabletype_t*);
  212. // Memory Types
  213. WASM_DECLARE_TYPE(memorytype)
  214. WASM_API_EXTERN own wasm_memorytype_t* wasm_memorytype_new(const wasm_limits_t*);
  215. WASM_API_EXTERN const wasm_limits_t* wasm_memorytype_limits(const wasm_memorytype_t*);
  216. // Extern Types
  217. WASM_DECLARE_TYPE(externtype)
  218. typedef uint8_t wasm_externkind_t;
  219. enum wasm_externkind_enum {
  220. WASM_EXTERN_FUNC,
  221. WASM_EXTERN_GLOBAL,
  222. WASM_EXTERN_TABLE,
  223. WASM_EXTERN_MEMORY,
  224. };
  225. WASM_API_EXTERN wasm_externkind_t wasm_externtype_kind(const wasm_externtype_t*);
  226. WASM_API_EXTERN wasm_externtype_t* wasm_functype_as_externtype(wasm_functype_t*);
  227. WASM_API_EXTERN wasm_externtype_t* wasm_globaltype_as_externtype(wasm_globaltype_t*);
  228. WASM_API_EXTERN wasm_externtype_t* wasm_tabletype_as_externtype(wasm_tabletype_t*);
  229. WASM_API_EXTERN wasm_externtype_t* wasm_memorytype_as_externtype(wasm_memorytype_t*);
  230. WASM_API_EXTERN wasm_functype_t* wasm_externtype_as_functype(wasm_externtype_t*);
  231. WASM_API_EXTERN wasm_globaltype_t* wasm_externtype_as_globaltype(wasm_externtype_t*);
  232. WASM_API_EXTERN wasm_tabletype_t* wasm_externtype_as_tabletype(wasm_externtype_t*);
  233. WASM_API_EXTERN wasm_memorytype_t* wasm_externtype_as_memorytype(wasm_externtype_t*);
  234. WASM_API_EXTERN const wasm_externtype_t* wasm_functype_as_externtype_const(const wasm_functype_t*);
  235. WASM_API_EXTERN const wasm_externtype_t* wasm_globaltype_as_externtype_const(const wasm_globaltype_t*);
  236. WASM_API_EXTERN const wasm_externtype_t* wasm_tabletype_as_externtype_const(const wasm_tabletype_t*);
  237. WASM_API_EXTERN const wasm_externtype_t* wasm_memorytype_as_externtype_const(const wasm_memorytype_t*);
  238. WASM_API_EXTERN const wasm_functype_t* wasm_externtype_as_functype_const(const wasm_externtype_t*);
  239. WASM_API_EXTERN const wasm_globaltype_t* wasm_externtype_as_globaltype_const(const wasm_externtype_t*);
  240. WASM_API_EXTERN const wasm_tabletype_t* wasm_externtype_as_tabletype_const(const wasm_externtype_t*);
  241. WASM_API_EXTERN const wasm_memorytype_t* wasm_externtype_as_memorytype_const(const wasm_externtype_t*);
  242. // Import Types
  243. WASM_DECLARE_TYPE(importtype)
  244. WASM_API_EXTERN own wasm_importtype_t* wasm_importtype_new(
  245. own wasm_name_t* module, own wasm_name_t* name, own wasm_externtype_t*);
  246. WASM_API_EXTERN const wasm_name_t* wasm_importtype_module(const wasm_importtype_t*);
  247. WASM_API_EXTERN const wasm_name_t* wasm_importtype_name(const wasm_importtype_t*);
  248. WASM_API_EXTERN const wasm_externtype_t* wasm_importtype_type(const wasm_importtype_t*);
  249. // Export Types
  250. WASM_DECLARE_TYPE(exporttype)
  251. WASM_API_EXTERN own wasm_exporttype_t* wasm_exporttype_new(
  252. own wasm_name_t*, own wasm_externtype_t*);
  253. WASM_API_EXTERN const wasm_name_t* wasm_exporttype_name(const wasm_exporttype_t*);
  254. WASM_API_EXTERN const wasm_externtype_t* wasm_exporttype_type(const wasm_exporttype_t*);
  255. ///////////////////////////////////////////////////////////////////////////////
  256. // Runtime Objects
  257. // Values
  258. #ifndef WASM_VAL_T_DEFINED
  259. #define WASM_VAL_T_DEFINED
  260. struct wasm_ref_t;
  261. typedef struct wasm_val_t {
  262. wasm_valkind_t kind;
  263. union {
  264. int32_t i32;
  265. int64_t i64;
  266. float32_t f32;
  267. float64_t f64;
  268. struct wasm_ref_t* ref;
  269. } of;
  270. } wasm_val_t;
  271. #endif
  272. WASM_API_EXTERN void wasm_val_delete(own wasm_val_t* v);
  273. WASM_API_EXTERN void wasm_val_copy(own wasm_val_t* out, const wasm_val_t*);
  274. WASM_DECLARE_VEC(val, )
  275. // References
  276. #define WASM_DECLARE_REF_BASE(name) \
  277. WASM_DECLARE_OWN(name) \
  278. \
  279. WASM_API_EXTERN own wasm_##name##_t* wasm_##name##_copy(const wasm_##name##_t*); \
  280. WASM_API_EXTERN bool wasm_##name##_same(const wasm_##name##_t*, const wasm_##name##_t*); \
  281. \
  282. WASM_API_EXTERN void* wasm_##name##_get_host_info(const wasm_##name##_t*); \
  283. WASM_API_EXTERN void wasm_##name##_set_host_info(wasm_##name##_t*, void*); \
  284. WASM_API_EXTERN void wasm_##name##_set_host_info_with_finalizer( \
  285. wasm_##name##_t*, void*, void (*)(void*));
  286. #define WASM_DECLARE_REF(name) \
  287. WASM_DECLARE_REF_BASE(name) \
  288. \
  289. WASM_API_EXTERN wasm_ref_t* wasm_##name##_as_ref(wasm_##name##_t*); \
  290. WASM_API_EXTERN wasm_##name##_t* wasm_ref_as_##name(wasm_ref_t*); \
  291. WASM_API_EXTERN const wasm_ref_t* wasm_##name##_as_ref_const(const wasm_##name##_t*); \
  292. WASM_API_EXTERN const wasm_##name##_t* wasm_ref_as_##name##_const(const wasm_ref_t*);
  293. #define WASM_DECLARE_SHARABLE_REF(name) \
  294. WASM_DECLARE_REF(name) \
  295. WASM_DECLARE_OWN(shared_##name) \
  296. \
  297. WASM_API_EXTERN own wasm_shared_##name##_t* wasm_##name##_share(const wasm_##name##_t*); \
  298. WASM_API_EXTERN own wasm_##name##_t* wasm_##name##_obtain(wasm_store_t*, const wasm_shared_##name##_t*);
  299. WASM_DECLARE_REF_BASE(ref)
  300. // Frames
  301. WASM_DECLARE_OWN(frame)
  302. WASM_DECLARE_VEC(frame, *)
  303. WASM_API_EXTERN own wasm_frame_t* wasm_frame_copy(const wasm_frame_t*);
  304. WASM_API_EXTERN struct wasm_instance_t* wasm_frame_instance(const wasm_frame_t*);
  305. WASM_API_EXTERN uint32_t wasm_frame_func_index(const wasm_frame_t*);
  306. WASM_API_EXTERN size_t wasm_frame_func_offset(const wasm_frame_t*);
  307. WASM_API_EXTERN size_t wasm_frame_module_offset(const wasm_frame_t*);
  308. // Traps
  309. typedef wasm_name_t wasm_message_t; // null terminated
  310. WASM_DECLARE_REF(trap)
  311. WASM_API_EXTERN own wasm_trap_t* wasm_trap_new(wasm_store_t* store, const wasm_message_t*);
  312. WASM_API_EXTERN void wasm_trap_message(const wasm_trap_t*, own wasm_message_t* out);
  313. WASM_API_EXTERN own wasm_frame_t* wasm_trap_origin(const wasm_trap_t*);
  314. WASM_API_EXTERN void wasm_trap_trace(const wasm_trap_t*, own wasm_frame_vec_t* out);
  315. // Foreign Objects
  316. WASM_DECLARE_REF(foreign)
  317. WASM_API_EXTERN own wasm_foreign_t* wasm_foreign_new(wasm_store_t*);
  318. // Modules
  319. // WASM_DECLARE_SHARABLE_REF(module)
  320. #ifndef WASM_MODULE_T_DEFINED
  321. #define WASM_MODULE_T_DEFINED
  322. struct WASMModuleCommon;
  323. typedef struct WASMModuleCommon *wasm_module_t;
  324. #endif
  325. WASM_API_EXTERN own wasm_module_t* wasm_module_new(
  326. wasm_store_t*, const wasm_byte_vec_t* binary);
  327. WASM_API_EXTERN void wasm_module_delete(own wasm_module_t*);
  328. WASM_API_EXTERN bool wasm_module_validate(wasm_store_t*, const wasm_byte_vec_t* binary);
  329. WASM_API_EXTERN void wasm_module_imports(const wasm_module_t*, own wasm_importtype_vec_t* out);
  330. WASM_API_EXTERN void wasm_module_exports(const wasm_module_t*, own wasm_exporttype_vec_t* out);
  331. WASM_API_EXTERN void wasm_module_serialize(const wasm_module_t*, own wasm_byte_vec_t* out);
  332. WASM_API_EXTERN own wasm_module_t* wasm_module_deserialize(wasm_store_t*, const wasm_byte_vec_t*);
  333. // Function Instances
  334. WASM_DECLARE_REF(func)
  335. typedef own wasm_trap_t* (*wasm_func_callback_t)(
  336. const wasm_val_t args[], own wasm_val_t results[]);
  337. typedef own wasm_trap_t* (*wasm_func_callback_with_env_t)(
  338. void* env, const wasm_val_t args[], wasm_val_t results[]);
  339. WASM_API_EXTERN own wasm_func_t* wasm_func_new(
  340. wasm_store_t*, const wasm_functype_t*, wasm_func_callback_t);
  341. WASM_API_EXTERN own wasm_func_t* wasm_func_new_with_env(
  342. wasm_store_t*, const wasm_functype_t* type, wasm_func_callback_with_env_t,
  343. void* env, void (*finalizer)(void*));
  344. WASM_API_EXTERN own wasm_functype_t* wasm_func_type(const wasm_func_t*);
  345. WASM_API_EXTERN size_t wasm_func_param_arity(const wasm_func_t*);
  346. WASM_API_EXTERN size_t wasm_func_result_arity(const wasm_func_t*);
  347. WASM_API_EXTERN own wasm_trap_t* wasm_func_call(
  348. const wasm_func_t*, const wasm_val_t args[], wasm_val_t results[]);
  349. // Global Instances
  350. WASM_DECLARE_REF(global)
  351. WASM_API_EXTERN own wasm_global_t* wasm_global_new(
  352. wasm_store_t*, const wasm_globaltype_t*, const wasm_val_t*);
  353. WASM_API_EXTERN own wasm_globaltype_t* wasm_global_type(const wasm_global_t*);
  354. WASM_API_EXTERN void wasm_global_get(const wasm_global_t*, own wasm_val_t* out);
  355. WASM_API_EXTERN void wasm_global_set(wasm_global_t*, const wasm_val_t*);
  356. // Table Instances
  357. WASM_DECLARE_REF(table)
  358. typedef uint32_t wasm_table_size_t;
  359. WASM_API_EXTERN own wasm_table_t* wasm_table_new(
  360. wasm_store_t*, const wasm_tabletype_t*, wasm_ref_t* init);
  361. WASM_API_EXTERN own wasm_tabletype_t* wasm_table_type(const wasm_table_t*);
  362. WASM_API_EXTERN own wasm_ref_t* wasm_table_get(const wasm_table_t*, wasm_table_size_t index);
  363. WASM_API_EXTERN bool wasm_table_set(wasm_table_t*, wasm_table_size_t index, wasm_ref_t*);
  364. WASM_API_EXTERN wasm_table_size_t wasm_table_size(const wasm_table_t*);
  365. WASM_API_EXTERN bool wasm_table_grow(wasm_table_t*, wasm_table_size_t delta, wasm_ref_t* init);
  366. // Memory Instances
  367. WASM_DECLARE_REF(memory)
  368. typedef uint32_t wasm_memory_pages_t;
  369. static const size_t MEMORY_PAGE_SIZE = 0x10000;
  370. WASM_API_EXTERN own wasm_memory_t* wasm_memory_new(wasm_store_t*, const wasm_memorytype_t*);
  371. WASM_API_EXTERN own wasm_memorytype_t* wasm_memory_type(const wasm_memory_t*);
  372. WASM_API_EXTERN byte_t* wasm_memory_data(wasm_memory_t*);
  373. WASM_API_EXTERN size_t wasm_memory_data_size(const wasm_memory_t*);
  374. WASM_API_EXTERN wasm_memory_pages_t wasm_memory_size(const wasm_memory_t*);
  375. WASM_API_EXTERN bool wasm_memory_grow(wasm_memory_t*, wasm_memory_pages_t delta);
  376. // Externals
  377. WASM_DECLARE_REF(extern)
  378. WASM_DECLARE_VEC(extern, *)
  379. WASM_API_EXTERN wasm_externkind_t wasm_extern_kind(const wasm_extern_t*);
  380. WASM_API_EXTERN own wasm_externtype_t* wasm_extern_type(const wasm_extern_t*);
  381. WASM_API_EXTERN wasm_extern_t* wasm_func_as_extern(wasm_func_t*);
  382. WASM_API_EXTERN wasm_extern_t* wasm_global_as_extern(wasm_global_t*);
  383. WASM_API_EXTERN wasm_extern_t* wasm_table_as_extern(wasm_table_t*);
  384. WASM_API_EXTERN wasm_extern_t* wasm_memory_as_extern(wasm_memory_t*);
  385. WASM_API_EXTERN wasm_func_t* wasm_extern_as_func(wasm_extern_t*);
  386. WASM_API_EXTERN wasm_global_t* wasm_extern_as_global(wasm_extern_t*);
  387. WASM_API_EXTERN wasm_table_t* wasm_extern_as_table(wasm_extern_t*);
  388. WASM_API_EXTERN wasm_memory_t* wasm_extern_as_memory(wasm_extern_t*);
  389. WASM_API_EXTERN const wasm_extern_t* wasm_func_as_extern_const(const wasm_func_t*);
  390. WASM_API_EXTERN const wasm_extern_t* wasm_global_as_extern_const(const wasm_global_t*);
  391. WASM_API_EXTERN const wasm_extern_t* wasm_table_as_extern_const(const wasm_table_t*);
  392. WASM_API_EXTERN const wasm_extern_t* wasm_memory_as_extern_const(const wasm_memory_t*);
  393. WASM_API_EXTERN const wasm_func_t* wasm_extern_as_func_const(const wasm_extern_t*);
  394. WASM_API_EXTERN const wasm_global_t* wasm_extern_as_global_const(const wasm_extern_t*);
  395. WASM_API_EXTERN const wasm_table_t* wasm_extern_as_table_const(const wasm_extern_t*);
  396. WASM_API_EXTERN const wasm_memory_t* wasm_extern_as_memory_const(const wasm_extern_t*);
  397. // Module Instances
  398. WASM_DECLARE_REF(instance)
  399. WASM_API_EXTERN own wasm_instance_t* wasm_instance_new(
  400. wasm_store_t*, const wasm_module_t*, const wasm_extern_t *const imports[],
  401. own wasm_trap_t**
  402. );
  403. // please refer to wasm_runtime_instantiate(...) in core/iwasm/include/wasm_export.h
  404. WASM_API_EXTERN own wasm_instance_t* wasm_instance_new_with_args(
  405. wasm_store_t*, const wasm_module_t*, const wasm_extern_t *const imports[],
  406. own wasm_trap_t**, const uint32_t stack_size, const uint32_t heap_size
  407. );
  408. WASM_API_EXTERN void wasm_instance_exports(const wasm_instance_t*, own wasm_extern_vec_t* out);
  409. ///////////////////////////////////////////////////////////////////////////////
  410. // Convenience
  411. // Vectors
  412. #define WASM_EMPTY_VEC {0, NULL, 0, 0}
  413. #define WASM_ARRAY_VEC(array) {sizeof(array)/sizeof(*(array)), array, sizeof(array)/sizeof(*(array)), sizeof(*(array))}
  414. // Value Type construction short-hands
  415. static inline own wasm_valtype_t* wasm_valtype_new_i32(void) {
  416. return wasm_valtype_new(WASM_I32);
  417. }
  418. static inline own wasm_valtype_t* wasm_valtype_new_i64(void) {
  419. return wasm_valtype_new(WASM_I64);
  420. }
  421. static inline own wasm_valtype_t* wasm_valtype_new_f32(void) {
  422. return wasm_valtype_new(WASM_F32);
  423. }
  424. static inline own wasm_valtype_t* wasm_valtype_new_f64(void) {
  425. return wasm_valtype_new(WASM_F64);
  426. }
  427. static inline own wasm_valtype_t* wasm_valtype_new_anyref(void) {
  428. return wasm_valtype_new(WASM_ANYREF);
  429. }
  430. static inline own wasm_valtype_t* wasm_valtype_new_funcref(void) {
  431. return wasm_valtype_new(WASM_FUNCREF);
  432. }
  433. // Function Types construction short-hands
  434. static inline own wasm_functype_t* wasm_functype_new_0_0(void) {
  435. wasm_valtype_vec_t params, results;
  436. wasm_valtype_vec_new_empty(&params);
  437. wasm_valtype_vec_new_empty(&results);
  438. return wasm_functype_new(&params, &results);
  439. }
  440. static inline own wasm_functype_t* wasm_functype_new_1_0(
  441. own wasm_valtype_t* p
  442. ) {
  443. wasm_valtype_t* ps[1] = {p};
  444. wasm_valtype_vec_t params, results;
  445. wasm_valtype_vec_new(&params, 1, ps);
  446. wasm_valtype_vec_new_empty(&results);
  447. return wasm_functype_new(&params, &results);
  448. }
  449. static inline own wasm_functype_t* wasm_functype_new_2_0(
  450. own wasm_valtype_t* p1, own wasm_valtype_t* p2
  451. ) {
  452. wasm_valtype_t* ps[2] = {p1, p2};
  453. wasm_valtype_vec_t params, results;
  454. wasm_valtype_vec_new(&params, 2, ps);
  455. wasm_valtype_vec_new_empty(&results);
  456. return wasm_functype_new(&params, &results);
  457. }
  458. static inline own wasm_functype_t* wasm_functype_new_3_0(
  459. own wasm_valtype_t* p1, own wasm_valtype_t* p2, own wasm_valtype_t* p3
  460. ) {
  461. wasm_valtype_t* ps[3] = {p1, p2, p3};
  462. wasm_valtype_vec_t params, results;
  463. wasm_valtype_vec_new(&params, 3, ps);
  464. wasm_valtype_vec_new_empty(&results);
  465. return wasm_functype_new(&params, &results);
  466. }
  467. static inline own wasm_functype_t* wasm_functype_new_0_1(
  468. own wasm_valtype_t* r
  469. ) {
  470. wasm_valtype_t* rs[1] = {r};
  471. wasm_valtype_vec_t params, results;
  472. wasm_valtype_vec_new_empty(&params);
  473. wasm_valtype_vec_new(&results, 1, rs);
  474. return wasm_functype_new(&params, &results);
  475. }
  476. static inline own wasm_functype_t* wasm_functype_new_1_1(
  477. own wasm_valtype_t* p, own wasm_valtype_t* r
  478. ) {
  479. wasm_valtype_t* ps[1] = {p};
  480. wasm_valtype_t* rs[1] = {r};
  481. wasm_valtype_vec_t params, results;
  482. wasm_valtype_vec_new(&params, 1, ps);
  483. wasm_valtype_vec_new(&results, 1, rs);
  484. return wasm_functype_new(&params, &results);
  485. }
  486. static inline own wasm_functype_t* wasm_functype_new_2_1(
  487. own wasm_valtype_t* p1, own wasm_valtype_t* p2, own wasm_valtype_t* r
  488. ) {
  489. wasm_valtype_t* ps[2] = {p1, p2};
  490. wasm_valtype_t* rs[1] = {r};
  491. wasm_valtype_vec_t params, results;
  492. wasm_valtype_vec_new(&params, 2, ps);
  493. wasm_valtype_vec_new(&results, 1, rs);
  494. return wasm_functype_new(&params, &results);
  495. }
  496. static inline own wasm_functype_t* wasm_functype_new_3_1(
  497. own wasm_valtype_t* p1, own wasm_valtype_t* p2, own wasm_valtype_t* p3,
  498. own wasm_valtype_t* r
  499. ) {
  500. wasm_valtype_t* ps[3] = {p1, p2, p3};
  501. wasm_valtype_t* rs[1] = {r};
  502. wasm_valtype_vec_t params, results;
  503. wasm_valtype_vec_new(&params, 3, ps);
  504. wasm_valtype_vec_new(&results, 1, rs);
  505. return wasm_functype_new(&params, &results);
  506. }
  507. static inline own wasm_functype_t* wasm_functype_new_0_2(
  508. own wasm_valtype_t* r1, own wasm_valtype_t* r2
  509. ) {
  510. wasm_valtype_t* rs[2] = {r1, r2};
  511. wasm_valtype_vec_t params, results;
  512. wasm_valtype_vec_new_empty(&params);
  513. wasm_valtype_vec_new(&results, 2, rs);
  514. return wasm_functype_new(&params, &results);
  515. }
  516. static inline own wasm_functype_t* wasm_functype_new_1_2(
  517. own wasm_valtype_t* p, own wasm_valtype_t* r1, own wasm_valtype_t* r2
  518. ) {
  519. wasm_valtype_t* ps[1] = {p};
  520. wasm_valtype_t* rs[2] = {r1, r2};
  521. wasm_valtype_vec_t params, results;
  522. wasm_valtype_vec_new(&params, 1, ps);
  523. wasm_valtype_vec_new(&results, 2, rs);
  524. return wasm_functype_new(&params, &results);
  525. }
  526. static inline own wasm_functype_t* wasm_functype_new_2_2(
  527. own wasm_valtype_t* p1, own wasm_valtype_t* p2,
  528. own wasm_valtype_t* r1, own wasm_valtype_t* r2
  529. ) {
  530. wasm_valtype_t* ps[2] = {p1, p2};
  531. wasm_valtype_t* rs[2] = {r1, r2};
  532. wasm_valtype_vec_t params, results;
  533. wasm_valtype_vec_new(&params, 2, ps);
  534. wasm_valtype_vec_new(&results, 2, rs);
  535. return wasm_functype_new(&params, &results);
  536. }
  537. static inline own wasm_functype_t* wasm_functype_new_3_2(
  538. own wasm_valtype_t* p1, own wasm_valtype_t* p2, own wasm_valtype_t* p3,
  539. own wasm_valtype_t* r1, own wasm_valtype_t* r2
  540. ) {
  541. wasm_valtype_t* ps[3] = {p1, p2, p3};
  542. wasm_valtype_t* rs[2] = {r1, r2};
  543. wasm_valtype_vec_t params, results;
  544. wasm_valtype_vec_new(&params, 3, ps);
  545. wasm_valtype_vec_new(&results, 2, rs);
  546. return wasm_functype_new(&params, &results);
  547. }
  548. // Value construction short-hands
  549. static inline void wasm_val_init_ptr(own wasm_val_t* out, void* p) {
  550. #if UINTPTR_MAX == UINT32_MAX
  551. out->kind = WASM_I32;
  552. out->of.i32 = (intptr_t)p;
  553. #elif UINTPTR_MAX == UINT64_MAX
  554. out->kind = WASM_I64;
  555. out->of.i64 = (intptr_t)p;
  556. #endif
  557. }
  558. static inline void* wasm_val_ptr(const wasm_val_t* val) {
  559. #if UINTPTR_MAX == UINT32_MAX
  560. return (void*)(intptr_t)val->of.i32;
  561. #elif UINTPTR_MAX == UINT64_MAX
  562. return (void*)(intptr_t)val->of.i64;
  563. #endif
  564. }
  565. #define WASM_I32_VAL(i) {.kind = WASM_I32, .of = {.i32 = i}}
  566. #define WASM_I64_VAL(i) {.kind = WASM_I64, .of = {.i64 = i}}
  567. #define WASM_F32_VAL(z) {.kind = WASM_F32, .of = {.f32 = z}}
  568. #define WASM_F64_VAL(z) {.kind = WASM_F64, .of = {.f64 = z}}
  569. #define WASM_REF_VAL(r) {.kind = WASM_ANYREF, .of = {.ref = r}}
  570. #define WASM_INIT_VAL {.kind = WASM_ANYREF, .of = {.ref = NULL}}
  571. #define KILOBYTE(n) ((n) * 1024)
  572. ///////////////////////////////////////////////////////////////////////////////
  573. #undef own
  574. #ifdef __cplusplus
  575. } // extern "C"
  576. #endif
  577. #endif // #ifdef WASM_H