wasm_c_api.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810
  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 user data, only used when
  155. WASM_MEM_ALLOC_WITH_USER_DATA is defined */
  156. void *user_data;
  157. } allocator;
  158. } MemAllocOption;
  159. #endif
  160. WASM_API_EXTERN own wasm_engine_t *
  161. wasm_engine_new_with_args(mem_alloc_type_t type, const MemAllocOption *opts);
  162. // Store
  163. WASM_DECLARE_OWN(store)
  164. WASM_API_EXTERN own wasm_store_t* wasm_store_new(wasm_engine_t*);
  165. ///////////////////////////////////////////////////////////////////////////////
  166. // Type Representations
  167. // Type attributes
  168. typedef uint8_t wasm_mutability_t;
  169. enum wasm_mutability_enum {
  170. WASM_CONST,
  171. WASM_VAR,
  172. };
  173. typedef struct wasm_limits_t {
  174. uint32_t min;
  175. uint32_t max;
  176. } wasm_limits_t;
  177. static const uint32_t wasm_limits_max_default = 0xffffffff;
  178. // Generic
  179. #define WASM_DECLARE_TYPE(name) \
  180. WASM_DECLARE_OWN(name) \
  181. WASM_DECLARE_VEC(name, *) \
  182. \
  183. WASM_API_EXTERN own wasm_##name##_t* wasm_##name##_copy(const wasm_##name##_t*);
  184. // Value Types
  185. WASM_DECLARE_TYPE(valtype)
  186. #ifndef WASM_VALKIND_T_DEFINED
  187. #define WASM_VALKIND_T_DEFINED
  188. typedef uint8_t wasm_valkind_t;
  189. enum wasm_valkind_enum {
  190. WASM_I32,
  191. WASM_I64,
  192. WASM_F32,
  193. WASM_F64,
  194. WASM_ANYREF = 128,
  195. WASM_FUNCREF,
  196. };
  197. #endif
  198. WASM_API_EXTERN own wasm_valtype_t* wasm_valtype_new(wasm_valkind_t);
  199. WASM_API_EXTERN wasm_valkind_t wasm_valtype_kind(const wasm_valtype_t*);
  200. static inline bool wasm_valkind_is_num(wasm_valkind_t k) {
  201. return k < WASM_ANYREF;
  202. }
  203. static inline bool wasm_valkind_is_ref(wasm_valkind_t k) {
  204. return k >= WASM_ANYREF;
  205. }
  206. static inline bool wasm_valtype_is_num(const wasm_valtype_t* t) {
  207. return wasm_valkind_is_num(wasm_valtype_kind(t));
  208. }
  209. static inline bool wasm_valtype_is_ref(const wasm_valtype_t* t) {
  210. return wasm_valkind_is_ref(wasm_valtype_kind(t));
  211. }
  212. // Function Types
  213. WASM_DECLARE_TYPE(functype)
  214. WASM_API_EXTERN own wasm_functype_t* wasm_functype_new(
  215. own wasm_valtype_vec_t* params, own wasm_valtype_vec_t* results);
  216. WASM_API_EXTERN const wasm_valtype_vec_t* wasm_functype_params(const wasm_functype_t*);
  217. WASM_API_EXTERN const wasm_valtype_vec_t* wasm_functype_results(const wasm_functype_t*);
  218. // Global Types
  219. WASM_DECLARE_TYPE(globaltype)
  220. WASM_API_EXTERN own wasm_globaltype_t* wasm_globaltype_new(
  221. own wasm_valtype_t*, wasm_mutability_t);
  222. WASM_API_EXTERN const wasm_valtype_t* wasm_globaltype_content(const wasm_globaltype_t*);
  223. WASM_API_EXTERN wasm_mutability_t wasm_globaltype_mutability(const wasm_globaltype_t*);
  224. // Table Types
  225. WASM_DECLARE_TYPE(tabletype)
  226. WASM_API_EXTERN own wasm_tabletype_t* wasm_tabletype_new(
  227. own wasm_valtype_t*, const wasm_limits_t*);
  228. WASM_API_EXTERN const wasm_valtype_t* wasm_tabletype_element(const wasm_tabletype_t*);
  229. WASM_API_EXTERN const wasm_limits_t* wasm_tabletype_limits(const wasm_tabletype_t*);
  230. // Memory Types
  231. WASM_DECLARE_TYPE(memorytype)
  232. WASM_API_EXTERN own wasm_memorytype_t* wasm_memorytype_new(const wasm_limits_t*);
  233. WASM_API_EXTERN const wasm_limits_t* wasm_memorytype_limits(const wasm_memorytype_t*);
  234. // Extern Types
  235. WASM_DECLARE_TYPE(externtype)
  236. typedef uint8_t wasm_externkind_t;
  237. enum wasm_externkind_enum {
  238. WASM_EXTERN_FUNC,
  239. WASM_EXTERN_GLOBAL,
  240. WASM_EXTERN_TABLE,
  241. WASM_EXTERN_MEMORY,
  242. };
  243. WASM_API_EXTERN wasm_externkind_t wasm_externtype_kind(const wasm_externtype_t*);
  244. WASM_API_EXTERN wasm_externtype_t* wasm_functype_as_externtype(wasm_functype_t*);
  245. WASM_API_EXTERN wasm_externtype_t* wasm_globaltype_as_externtype(wasm_globaltype_t*);
  246. WASM_API_EXTERN wasm_externtype_t* wasm_tabletype_as_externtype(wasm_tabletype_t*);
  247. WASM_API_EXTERN wasm_externtype_t* wasm_memorytype_as_externtype(wasm_memorytype_t*);
  248. WASM_API_EXTERN wasm_functype_t* wasm_externtype_as_functype(wasm_externtype_t*);
  249. WASM_API_EXTERN wasm_globaltype_t* wasm_externtype_as_globaltype(wasm_externtype_t*);
  250. WASM_API_EXTERN wasm_tabletype_t* wasm_externtype_as_tabletype(wasm_externtype_t*);
  251. WASM_API_EXTERN wasm_memorytype_t* wasm_externtype_as_memorytype(wasm_externtype_t*);
  252. WASM_API_EXTERN const wasm_externtype_t* wasm_functype_as_externtype_const(const wasm_functype_t*);
  253. WASM_API_EXTERN const wasm_externtype_t* wasm_globaltype_as_externtype_const(const wasm_globaltype_t*);
  254. WASM_API_EXTERN const wasm_externtype_t* wasm_tabletype_as_externtype_const(const wasm_tabletype_t*);
  255. WASM_API_EXTERN const wasm_externtype_t* wasm_memorytype_as_externtype_const(const wasm_memorytype_t*);
  256. WASM_API_EXTERN const wasm_functype_t* wasm_externtype_as_functype_const(const wasm_externtype_t*);
  257. WASM_API_EXTERN const wasm_globaltype_t* wasm_externtype_as_globaltype_const(const wasm_externtype_t*);
  258. WASM_API_EXTERN const wasm_tabletype_t* wasm_externtype_as_tabletype_const(const wasm_externtype_t*);
  259. WASM_API_EXTERN const wasm_memorytype_t* wasm_externtype_as_memorytype_const(const wasm_externtype_t*);
  260. // Import Types
  261. WASM_DECLARE_TYPE(importtype)
  262. WASM_API_EXTERN own wasm_importtype_t* wasm_importtype_new(
  263. own wasm_name_t* module, own wasm_name_t* name, own wasm_externtype_t*);
  264. WASM_API_EXTERN const wasm_name_t* wasm_importtype_module(const wasm_importtype_t*);
  265. WASM_API_EXTERN const wasm_name_t* wasm_importtype_name(const wasm_importtype_t*);
  266. WASM_API_EXTERN const wasm_externtype_t* wasm_importtype_type(const wasm_importtype_t*);
  267. // Export Types
  268. WASM_DECLARE_TYPE(exporttype)
  269. WASM_API_EXTERN own wasm_exporttype_t* wasm_exporttype_new(
  270. own wasm_name_t*, own wasm_externtype_t*);
  271. WASM_API_EXTERN const wasm_name_t* wasm_exporttype_name(const wasm_exporttype_t*);
  272. WASM_API_EXTERN const wasm_externtype_t* wasm_exporttype_type(const wasm_exporttype_t*);
  273. ///////////////////////////////////////////////////////////////////////////////
  274. // Runtime Objects
  275. // Values
  276. #ifndef WASM_VAL_T_DEFINED
  277. #define WASM_VAL_T_DEFINED
  278. struct wasm_ref_t;
  279. typedef struct wasm_val_t {
  280. wasm_valkind_t kind;
  281. union {
  282. int32_t i32;
  283. int64_t i64;
  284. float32_t f32;
  285. float64_t f64;
  286. struct wasm_ref_t* ref;
  287. } of;
  288. } wasm_val_t;
  289. #endif
  290. WASM_API_EXTERN void wasm_val_delete(own wasm_val_t* v);
  291. WASM_API_EXTERN void wasm_val_copy(own wasm_val_t* out, const wasm_val_t*);
  292. WASM_DECLARE_VEC(val, )
  293. // References
  294. #define WASM_DECLARE_REF_BASE(name) \
  295. WASM_DECLARE_OWN(name) \
  296. \
  297. WASM_API_EXTERN own wasm_##name##_t* wasm_##name##_copy(const wasm_##name##_t*); \
  298. WASM_API_EXTERN bool wasm_##name##_same(const wasm_##name##_t*, const wasm_##name##_t*); \
  299. \
  300. WASM_API_EXTERN void* wasm_##name##_get_host_info(const wasm_##name##_t*); \
  301. WASM_API_EXTERN void wasm_##name##_set_host_info(wasm_##name##_t*, void*); \
  302. WASM_API_EXTERN void wasm_##name##_set_host_info_with_finalizer( \
  303. wasm_##name##_t*, void*, void (*)(void*));
  304. #define WASM_DECLARE_REF(name) \
  305. WASM_DECLARE_REF_BASE(name) \
  306. \
  307. WASM_API_EXTERN wasm_ref_t* wasm_##name##_as_ref(wasm_##name##_t*); \
  308. WASM_API_EXTERN wasm_##name##_t* wasm_ref_as_##name(wasm_ref_t*); \
  309. WASM_API_EXTERN const wasm_ref_t* wasm_##name##_as_ref_const(const wasm_##name##_t*); \
  310. WASM_API_EXTERN const wasm_##name##_t* wasm_ref_as_##name##_const(const wasm_ref_t*);
  311. #define WASM_DECLARE_SHARABLE_REF(name) \
  312. WASM_DECLARE_REF(name) \
  313. WASM_DECLARE_OWN(shared_##name) \
  314. \
  315. WASM_API_EXTERN own wasm_shared_##name##_t* wasm_##name##_share(const wasm_##name##_t*); \
  316. WASM_API_EXTERN own wasm_##name##_t* wasm_##name##_obtain(wasm_store_t*, const wasm_shared_##name##_t*);
  317. WASM_DECLARE_REF_BASE(ref)
  318. // Frames
  319. WASM_DECLARE_OWN(frame)
  320. WASM_DECLARE_VEC(frame, *)
  321. WASM_API_EXTERN own wasm_frame_t* wasm_frame_copy(const wasm_frame_t*);
  322. WASM_API_EXTERN struct wasm_instance_t* wasm_frame_instance(const wasm_frame_t*);
  323. WASM_API_EXTERN uint32_t wasm_frame_func_index(const wasm_frame_t*);
  324. WASM_API_EXTERN size_t wasm_frame_func_offset(const wasm_frame_t*);
  325. WASM_API_EXTERN size_t wasm_frame_module_offset(const wasm_frame_t*);
  326. // Traps
  327. typedef wasm_name_t wasm_message_t; // null terminated
  328. WASM_DECLARE_REF(trap)
  329. WASM_API_EXTERN own wasm_trap_t* wasm_trap_new(wasm_store_t* store, const wasm_message_t*);
  330. WASM_API_EXTERN void wasm_trap_message(const wasm_trap_t*, own wasm_message_t* out);
  331. WASM_API_EXTERN own wasm_frame_t* wasm_trap_origin(const wasm_trap_t*);
  332. WASM_API_EXTERN void wasm_trap_trace(const wasm_trap_t*, own wasm_frame_vec_t* out);
  333. // Foreign Objects
  334. WASM_DECLARE_REF(foreign)
  335. WASM_API_EXTERN own wasm_foreign_t* wasm_foreign_new(wasm_store_t*);
  336. // Modules
  337. // WASM_DECLARE_SHARABLE_REF(module)
  338. #ifndef WASM_MODULE_T_DEFINED
  339. #define WASM_MODULE_T_DEFINED
  340. struct WASMModuleCommon;
  341. typedef struct WASMModuleCommon *wasm_module_t;
  342. #endif
  343. WASM_API_EXTERN own wasm_module_t* wasm_module_new(
  344. wasm_store_t*, const wasm_byte_vec_t* binary);
  345. WASM_API_EXTERN void wasm_module_delete(own wasm_module_t*);
  346. WASM_API_EXTERN bool wasm_module_validate(wasm_store_t*, const wasm_byte_vec_t* binary);
  347. WASM_API_EXTERN void wasm_module_imports(const wasm_module_t*, own wasm_importtype_vec_t* out);
  348. WASM_API_EXTERN void wasm_module_exports(const wasm_module_t*, own wasm_exporttype_vec_t* out);
  349. WASM_API_EXTERN void wasm_module_serialize(wasm_module_t*, own wasm_byte_vec_t* out);
  350. WASM_API_EXTERN own wasm_module_t* wasm_module_deserialize(wasm_store_t*, const wasm_byte_vec_t*);
  351. typedef wasm_module_t wasm_shared_module_t;
  352. WASM_API_EXTERN own wasm_shared_module_t* wasm_module_share(wasm_module_t*);
  353. WASM_API_EXTERN own wasm_module_t* wasm_module_obtain(wasm_store_t*, wasm_shared_module_t*);
  354. WASM_API_EXTERN void wasm_shared_module_delete(own wasm_shared_module_t*);
  355. // Function Instances
  356. WASM_DECLARE_REF(func)
  357. typedef own wasm_trap_t* (*wasm_func_callback_t)(
  358. const wasm_val_vec_t* args, own wasm_val_vec_t *results);
  359. typedef own wasm_trap_t* (*wasm_func_callback_with_env_t)(
  360. void* env, const wasm_val_vec_t *args, wasm_val_vec_t *results);
  361. WASM_API_EXTERN own wasm_func_t* wasm_func_new(
  362. wasm_store_t*, const wasm_functype_t*, wasm_func_callback_t);
  363. WASM_API_EXTERN own wasm_func_t* wasm_func_new_with_env(
  364. wasm_store_t*, const wasm_functype_t* type, wasm_func_callback_with_env_t,
  365. void* env, void (*finalizer)(void*));
  366. WASM_API_EXTERN own wasm_functype_t* wasm_func_type(const wasm_func_t*);
  367. WASM_API_EXTERN size_t wasm_func_param_arity(const wasm_func_t*);
  368. WASM_API_EXTERN size_t wasm_func_result_arity(const wasm_func_t*);
  369. WASM_API_EXTERN own wasm_trap_t* wasm_func_call(
  370. const wasm_func_t*, const wasm_val_vec_t* args, wasm_val_vec_t* results);
  371. // Global Instances
  372. WASM_DECLARE_REF(global)
  373. WASM_API_EXTERN own wasm_global_t* wasm_global_new(
  374. wasm_store_t*, const wasm_globaltype_t*, const wasm_val_t*);
  375. WASM_API_EXTERN own wasm_globaltype_t* wasm_global_type(const wasm_global_t*);
  376. WASM_API_EXTERN void wasm_global_get(const wasm_global_t*, own wasm_val_t* out);
  377. WASM_API_EXTERN void wasm_global_set(wasm_global_t*, const wasm_val_t*);
  378. // Table Instances
  379. WASM_DECLARE_REF(table)
  380. typedef uint32_t wasm_table_size_t;
  381. WASM_API_EXTERN own wasm_table_t* wasm_table_new(
  382. wasm_store_t*, const wasm_tabletype_t*, wasm_ref_t* init);
  383. WASM_API_EXTERN own wasm_tabletype_t* wasm_table_type(const wasm_table_t*);
  384. WASM_API_EXTERN own wasm_ref_t* wasm_table_get(const wasm_table_t*, wasm_table_size_t index);
  385. WASM_API_EXTERN bool wasm_table_set(wasm_table_t*, wasm_table_size_t index, wasm_ref_t*);
  386. WASM_API_EXTERN wasm_table_size_t wasm_table_size(const wasm_table_t*);
  387. WASM_API_EXTERN bool wasm_table_grow(wasm_table_t*, wasm_table_size_t delta, wasm_ref_t* init);
  388. // Memory Instances
  389. WASM_DECLARE_REF(memory)
  390. typedef uint32_t wasm_memory_pages_t;
  391. static const size_t MEMORY_PAGE_SIZE = 0x10000;
  392. WASM_API_EXTERN own wasm_memory_t* wasm_memory_new(wasm_store_t*, const wasm_memorytype_t*);
  393. WASM_API_EXTERN own wasm_memorytype_t* wasm_memory_type(const wasm_memory_t*);
  394. WASM_API_EXTERN byte_t* wasm_memory_data(wasm_memory_t*);
  395. WASM_API_EXTERN size_t wasm_memory_data_size(const wasm_memory_t*);
  396. WASM_API_EXTERN wasm_memory_pages_t wasm_memory_size(const wasm_memory_t*);
  397. WASM_API_EXTERN bool wasm_memory_grow(wasm_memory_t*, wasm_memory_pages_t delta);
  398. // Externals
  399. WASM_DECLARE_REF(extern)
  400. WASM_DECLARE_VEC(extern, *)
  401. WASM_API_EXTERN wasm_externkind_t wasm_extern_kind(const wasm_extern_t*);
  402. WASM_API_EXTERN own wasm_externtype_t* wasm_extern_type(const wasm_extern_t*);
  403. WASM_API_EXTERN wasm_extern_t* wasm_func_as_extern(wasm_func_t*);
  404. WASM_API_EXTERN wasm_extern_t* wasm_global_as_extern(wasm_global_t*);
  405. WASM_API_EXTERN wasm_extern_t* wasm_table_as_extern(wasm_table_t*);
  406. WASM_API_EXTERN wasm_extern_t* wasm_memory_as_extern(wasm_memory_t*);
  407. WASM_API_EXTERN wasm_func_t* wasm_extern_as_func(wasm_extern_t*);
  408. WASM_API_EXTERN wasm_global_t* wasm_extern_as_global(wasm_extern_t*);
  409. WASM_API_EXTERN wasm_table_t* wasm_extern_as_table(wasm_extern_t*);
  410. WASM_API_EXTERN wasm_memory_t* wasm_extern_as_memory(wasm_extern_t*);
  411. WASM_API_EXTERN const wasm_extern_t* wasm_func_as_extern_const(const wasm_func_t*);
  412. WASM_API_EXTERN const wasm_extern_t* wasm_global_as_extern_const(const wasm_global_t*);
  413. WASM_API_EXTERN const wasm_extern_t* wasm_table_as_extern_const(const wasm_table_t*);
  414. WASM_API_EXTERN const wasm_extern_t* wasm_memory_as_extern_const(const wasm_memory_t*);
  415. WASM_API_EXTERN const wasm_func_t* wasm_extern_as_func_const(const wasm_extern_t*);
  416. WASM_API_EXTERN const wasm_global_t* wasm_extern_as_global_const(const wasm_extern_t*);
  417. WASM_API_EXTERN const wasm_table_t* wasm_extern_as_table_const(const wasm_extern_t*);
  418. WASM_API_EXTERN const wasm_memory_t* wasm_extern_as_memory_const(const wasm_extern_t*);
  419. // Module Instances
  420. WASM_DECLARE_REF(instance)
  421. WASM_API_EXTERN own wasm_instance_t* wasm_instance_new(
  422. wasm_store_t*, const wasm_module_t*, const wasm_extern_vec_t *imports,
  423. own wasm_trap_t** trap
  424. );
  425. // please refer to wasm_runtime_instantiate(...) in core/iwasm/include/wasm_export.h
  426. WASM_API_EXTERN own wasm_instance_t* wasm_instance_new_with_args(
  427. wasm_store_t*, const wasm_module_t*, const wasm_extern_vec_t *imports,
  428. own wasm_trap_t** trap, const uint32_t stack_size, const uint32_t heap_size
  429. );
  430. WASM_API_EXTERN void wasm_instance_exports(const wasm_instance_t*, own wasm_extern_vec_t* out);
  431. ///////////////////////////////////////////////////////////////////////////////
  432. // Convenience
  433. // Vectors
  434. #define WASM_EMPTY_VEC {0, NULL, 0, 0, NULL}
  435. #define WASM_ARRAY_VEC(array) {sizeof(array)/sizeof(*(array)), array, sizeof(array)/sizeof(*(array)), sizeof(*(array)), NULL}
  436. // Value Type construction short-hands
  437. static inline own wasm_valtype_t* wasm_valtype_new_i32(void) {
  438. return wasm_valtype_new(WASM_I32);
  439. }
  440. static inline own wasm_valtype_t* wasm_valtype_new_i64(void) {
  441. return wasm_valtype_new(WASM_I64);
  442. }
  443. static inline own wasm_valtype_t* wasm_valtype_new_f32(void) {
  444. return wasm_valtype_new(WASM_F32);
  445. }
  446. static inline own wasm_valtype_t* wasm_valtype_new_f64(void) {
  447. return wasm_valtype_new(WASM_F64);
  448. }
  449. static inline own wasm_valtype_t* wasm_valtype_new_anyref(void) {
  450. return wasm_valtype_new(WASM_ANYREF);
  451. }
  452. static inline own wasm_valtype_t* wasm_valtype_new_funcref(void) {
  453. return wasm_valtype_new(WASM_FUNCREF);
  454. }
  455. // Function Types construction short-hands
  456. static inline own wasm_functype_t* wasm_functype_new_0_0(void) {
  457. wasm_valtype_vec_t params, results;
  458. wasm_valtype_vec_new_empty(&params);
  459. wasm_valtype_vec_new_empty(&results);
  460. return wasm_functype_new(&params, &results);
  461. }
  462. static inline own wasm_functype_t* wasm_functype_new_1_0(
  463. own wasm_valtype_t* p
  464. ) {
  465. wasm_valtype_t* ps[1] = {p};
  466. wasm_valtype_vec_t params, results;
  467. wasm_valtype_vec_new(&params, 1, ps);
  468. wasm_valtype_vec_new_empty(&results);
  469. return wasm_functype_new(&params, &results);
  470. }
  471. static inline own wasm_functype_t* wasm_functype_new_2_0(
  472. own wasm_valtype_t* p1, own wasm_valtype_t* p2
  473. ) {
  474. wasm_valtype_t* ps[2] = {p1, p2};
  475. wasm_valtype_vec_t params, results;
  476. wasm_valtype_vec_new(&params, 2, ps);
  477. wasm_valtype_vec_new_empty(&results);
  478. return wasm_functype_new(&params, &results);
  479. }
  480. static inline own wasm_functype_t* wasm_functype_new_3_0(
  481. own wasm_valtype_t* p1, own wasm_valtype_t* p2, own wasm_valtype_t* p3
  482. ) {
  483. wasm_valtype_t* ps[3] = {p1, p2, p3};
  484. wasm_valtype_vec_t params, results;
  485. wasm_valtype_vec_new(&params, 3, ps);
  486. wasm_valtype_vec_new_empty(&results);
  487. return wasm_functype_new(&params, &results);
  488. }
  489. static inline own wasm_functype_t* wasm_functype_new_0_1(
  490. own wasm_valtype_t* r
  491. ) {
  492. wasm_valtype_t* rs[1] = {r};
  493. wasm_valtype_vec_t params, results;
  494. wasm_valtype_vec_new_empty(&params);
  495. wasm_valtype_vec_new(&results, 1, rs);
  496. return wasm_functype_new(&params, &results);
  497. }
  498. static inline own wasm_functype_t* wasm_functype_new_1_1(
  499. own wasm_valtype_t* p, own wasm_valtype_t* r
  500. ) {
  501. wasm_valtype_t* ps[1] = {p};
  502. wasm_valtype_t* rs[1] = {r};
  503. wasm_valtype_vec_t params, results;
  504. wasm_valtype_vec_new(&params, 1, 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_2_1(
  509. own wasm_valtype_t* p1, own wasm_valtype_t* p2, own wasm_valtype_t* r
  510. ) {
  511. wasm_valtype_t* ps[2] = {p1, p2};
  512. wasm_valtype_t* rs[1] = {r};
  513. wasm_valtype_vec_t params, results;
  514. wasm_valtype_vec_new(&params, 2, ps);
  515. wasm_valtype_vec_new(&results, 1, rs);
  516. return wasm_functype_new(&params, &results);
  517. }
  518. static inline own wasm_functype_t* wasm_functype_new_3_1(
  519. own wasm_valtype_t* p1, own wasm_valtype_t* p2, own wasm_valtype_t* p3,
  520. own wasm_valtype_t* r
  521. ) {
  522. wasm_valtype_t* ps[3] = {p1, p2, p3};
  523. wasm_valtype_t* rs[1] = {r};
  524. wasm_valtype_vec_t params, results;
  525. wasm_valtype_vec_new(&params, 3, ps);
  526. wasm_valtype_vec_new(&results, 1, rs);
  527. return wasm_functype_new(&params, &results);
  528. }
  529. static inline own wasm_functype_t* wasm_functype_new_0_2(
  530. own wasm_valtype_t* r1, own wasm_valtype_t* r2
  531. ) {
  532. wasm_valtype_t* rs[2] = {r1, r2};
  533. wasm_valtype_vec_t params, results;
  534. wasm_valtype_vec_new_empty(&params);
  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_1_2(
  539. own wasm_valtype_t* p, own wasm_valtype_t* r1, own wasm_valtype_t* r2
  540. ) {
  541. wasm_valtype_t* ps[1] = {p};
  542. wasm_valtype_t* rs[2] = {r1, r2};
  543. wasm_valtype_vec_t params, results;
  544. wasm_valtype_vec_new(&params, 1, ps);
  545. wasm_valtype_vec_new(&results, 2, rs);
  546. return wasm_functype_new(&params, &results);
  547. }
  548. static inline own wasm_functype_t* wasm_functype_new_2_2(
  549. own wasm_valtype_t* p1, own wasm_valtype_t* p2,
  550. own wasm_valtype_t* r1, own wasm_valtype_t* r2
  551. ) {
  552. wasm_valtype_t* ps[2] = {p1, p2};
  553. wasm_valtype_t* rs[2] = {r1, r2};
  554. wasm_valtype_vec_t params, results;
  555. wasm_valtype_vec_new(&params, 2, ps);
  556. wasm_valtype_vec_new(&results, 2, rs);
  557. return wasm_functype_new(&params, &results);
  558. }
  559. static inline own wasm_functype_t* wasm_functype_new_3_2(
  560. own wasm_valtype_t* p1, own wasm_valtype_t* p2, own wasm_valtype_t* p3,
  561. own wasm_valtype_t* r1, own wasm_valtype_t* r2
  562. ) {
  563. wasm_valtype_t* ps[3] = {p1, p2, p3};
  564. wasm_valtype_t* rs[2] = {r1, r2};
  565. wasm_valtype_vec_t params, results;
  566. wasm_valtype_vec_new(&params, 3, ps);
  567. wasm_valtype_vec_new(&results, 2, rs);
  568. return wasm_functype_new(&params, &results);
  569. }
  570. // Value construction short-hands
  571. static inline void wasm_val_init_ptr(own wasm_val_t* out, void* p) {
  572. #if UINTPTR_MAX == UINT32_MAX
  573. out->kind = WASM_I32;
  574. out->of.i32 = (intptr_t)p;
  575. #elif UINTPTR_MAX == UINT64_MAX
  576. out->kind = WASM_I64;
  577. out->of.i64 = (intptr_t)p;
  578. #endif
  579. }
  580. static inline void* wasm_val_ptr(const wasm_val_t* val) {
  581. #if UINTPTR_MAX == UINT32_MAX
  582. return (void*)(intptr_t)val->of.i32;
  583. #elif UINTPTR_MAX == UINT64_MAX
  584. return (void*)(intptr_t)val->of.i64;
  585. #endif
  586. }
  587. #define WASM_I32_VAL(i) {.kind = WASM_I32, .of = {.i32 = i}}
  588. #define WASM_I64_VAL(i) {.kind = WASM_I64, .of = {.i64 = i}}
  589. #define WASM_F32_VAL(z) {.kind = WASM_F32, .of = {.f32 = z}}
  590. #define WASM_F64_VAL(z) {.kind = WASM_F64, .of = {.f64 = z}}
  591. #define WASM_REF_VAL(r) {.kind = WASM_ANYREF, .of = {.ref = r}}
  592. #define WASM_INIT_VAL {.kind = WASM_ANYREF, .of = {.ref = NULL}}
  593. #define KILOBYTE(n) ((n) * 1024)
  594. ///////////////////////////////////////////////////////////////////////////////
  595. #undef own
  596. /* clang-format on */
  597. #ifdef __cplusplus
  598. } // extern "C"
  599. #endif
  600. #endif // #ifdef _WASM_C_API_H_