wasm_c_api.h 25 KB

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