wasm_c_api.h 24 KB

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