wasm_c_api.h 24 KB

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