diff options
| author | Shravan Narayan <shravanrn@gmail.com> | 2024-01-19 15:36:46 -0600 |
|---|---|---|
| committer | Shravan Narayan <shravanrn@gmail.com> | 2024-01-30 22:27:24 -0600 |
| commit | cfe0f5e7690c940c0c6ee27fa1e44791e5afee43 (patch) | |
| tree | e07ac68b07fb2616ceba423b9ba8c7ea791160d4 /wasm2c | |
| parent | 80b4f087aa65a7f23d3489f80eaa298a1cdb3913 (diff) | |
| download | wabt-cfe0f5e7690c940c0c6ee27fa1e44791e5afee43.tar.gz wabt-cfe0f5e7690c940c0c6ee27fa1e44791e5afee43.tar.bz2 wabt-cfe0f5e7690c940c0c6ee27fa1e44791e5afee43.zip | |
wasm2c: Cleanup formatting of wasm-rt.h
Diffstat (limited to 'wasm2c')
| -rw-r--r-- | wasm2c/wasm-rt.h | 121 |
1 files changed, 63 insertions, 58 deletions
diff --git a/wasm2c/wasm-rt.h b/wasm2c/wasm-rt.h index cbd09a31..c8d7bd01 100644 --- a/wasm2c/wasm-rt.h +++ b/wasm2c/wasm-rt.h @@ -28,7 +28,7 @@ extern "C" { #endif #ifndef __has_builtin -#define __has_builtin(x) 0 // Compatibility with non-clang compilers. +#define __has_builtin(x) 0 /** Compatibility with non-clang compilers. */ #endif #if __has_builtin(__builtin_expect) @@ -138,14 +138,14 @@ extern "C" { * no 64-bit memories --- are met. This falls back to BOUNDS otherwise. */ -// Check if Guard checks are supported +/** Check if Guard checks are supported */ #if UINTPTR_MAX > 0xffffffff && WASM_RT_USE_MMAP && !SUPPORT_MEMORY64 #define WASM_RT_GUARD_PAGES_SUPPORTED 1 #else #define WASM_RT_GUARD_PAGES_SUPPORTED 0 #endif -// Specify defaults for memory checks if unspecified +/** Specify defaults for memory checks if unspecified */ #if !defined(WASM_RT_MEMCHECK_GUARD_PAGES) && \ !defined(WASM_RT_MEMCHECK_BOUNDS_CHECK) #if WASM_RT_GUARD_PAGES_SUPPORTED @@ -155,7 +155,7 @@ extern "C" { #endif #endif -// Ensure the macros are defined +/** Ensure the macros are defined */ #ifndef WASM_RT_MEMCHECK_GUARD_PAGES #define WASM_RT_MEMCHECK_GUARD_PAGES 0 #endif @@ -163,7 +163,7 @@ extern "C" { #define WASM_RT_MEMCHECK_BOUNDS_CHECK 0 #endif -// Sanity check the use of guard pages +/** Sanity check the use of guard pages */ #if WASM_RT_MEMCHECK_GUARD_PAGES && !WASM_RT_GUARD_PAGES_SUPPORTED #error \ "WASM_RT_MEMCHECK_GUARD_PAGES not supported on this platform/configuration" @@ -194,7 +194,8 @@ extern "C" { #define WASM_RT_INSTALL_SIGNAL_HANDLER 0 #endif -/* This macro, if defined, allows the embedder to disable all stack exhaustion +/** + * This macro, if defined, allows the embedder to disable all stack exhaustion * checks. This a non conformant configuration, i.e., this does not respect * Wasm's specification, and may compromise security. Use with caution. */ @@ -202,9 +203,11 @@ extern "C" { #define WASM_RT_NONCONFORMING_UNCHECKED_STACK_EXHAUSTION 0 #endif -/* We need to detect and trap stack overflows. If we use a signal handler on +/** + * We need to detect and trap stack overflows. If we use a signal handler on * POSIX systems, this can detect call stack overflows. On windows, or platforms - * without a signal handler, we use stack depth counting. */ + * without a signal handler, we use stack depth counting. + */ #if !defined(WASM_RT_STACK_DEPTH_COUNT) && \ !defined(WASM_RT_STACK_EXHAUSTION_HANDLER) && \ !WASM_RT_NONCONFORMING_UNCHECKED_STACK_EXHAUSTION @@ -217,7 +220,7 @@ extern "C" { #endif -// Ensure the stack macros are defined +/** Ensure the stack macros are defined */ #ifndef WASM_RT_STACK_DEPTH_COUNT #define WASM_RT_STACK_DEPTH_COUNT 0 #endif @@ -290,7 +293,7 @@ typedef enum { WASM_RT_TRAP_INVALID_CONVERSION, /** Conversion from NaN to integer. */ WASM_RT_TRAP_UNREACHABLE, /** Unreachable instruction executed. */ WASM_RT_TRAP_CALL_INDIRECT, /** Invalid call_indirect, for any reason. */ - WASM_RT_TRAP_UNCAUGHT_EXCEPTION, /* Exception thrown and not caught. */ + WASM_RT_TRAP_UNCAUGHT_EXCEPTION, /** Exception thrown and not caught. */ WASM_RT_TRAP_UNALIGNED, /** Unaligned atomic instruction executed. */ #if WASM_RT_MERGED_OOB_AND_EXHAUSTION_TRAPS WASM_RT_TRAP_EXHAUSTION = WASM_RT_TRAP_OOB, @@ -335,19 +338,25 @@ typedef struct wasm_rt_tailcallee_t { */ typedef const char* wasm_rt_func_type_t; -/** A function instance (the runtime representation of a function). - * These can be stored in tables of type funcref, or used as values. */ +/** + * A function instance (the runtime representation of a function). + * These can be stored in tables of type funcref, or used as values. + */ typedef struct { /** The function's type. */ wasm_rt_func_type_t func_type; - /** The function. The embedder must know the actual C signature of the - * function and cast to it before calling. */ + /** + * The function. The embedder must know the actual C signature of the function + * and cast to it before calling. + */ wasm_rt_function_ptr_t func; /** An alternate version of the function to be used when tail-called. */ wasm_rt_tailcallee_t func_tailcallee; - /** A function instance is a closure of the function over an instance + /** + * A function instance is a closure of the function over an instance * of the originating module. The module_instance element will be passed into - * the function at runtime. */ + * the function at runtime. + */ void* module_instance; } wasm_rt_funcref_t; @@ -365,9 +374,13 @@ typedef void* wasm_rt_externref_t; typedef struct { /** The linear memory data, with a byte length of `size`. */ uint8_t* data; - /** The current and maximum page count for this Memory object. If there is no - * maximum, `max_pages` is 0xffffffffu (i.e. UINT32_MAX). */ - uint64_t pages, max_pages; + /** The current page count for this Memory object. */ + uint64_t pages; + /** + * The maximum page count for this Memory object. If there is no maximum, + * `max_pages` is 0xffffffffu (i.e. UINT32_MAX). + */ + uint64_t max_pages; /** The current size of the linear memory, in bytes. */ uint64_t size; /** Is this memory indexed by u64 (as opposed to default u32) */ @@ -386,12 +399,16 @@ typedef struct { * atomic32 being read from the same location an atomic64 is read. One way to * prevent optimizations from assuming non-overlapping behavior as typically * done in C is to mark the memory as volatile. Thus the memory is atomic and - * volatile. */ + * volatile. + */ _Atomic volatile uint8_t* data; + /** The current page count for this Memory object. */ + uint64_t pages; /** - * The current and maximum page count for this Memory object. If there is no - * maximum, `max_pages` is 0xffffffffu (i.e. UINT32_MAX). */ - uint64_t pages, max_pages; + * The maximum page count for this Memory object. If there is no maximum, + * `max_pages` is 0xffffffffu (i.e. UINT32_MAX). + */ + uint64_t max_pages; /** The current size of the linear memory, in bytes. */ uint64_t size; /** Is this memory indexed by u64 (as opposed to default u32) */ @@ -405,8 +422,10 @@ typedef struct { typedef struct { /** The table element data, with an element count of `size`. */ wasm_rt_funcref_t* data; - /** The maximum element count of this Table object. If there is no maximum, - * `max_size` is 0xffffffffu (i.e. UINT32_MAX). */ + /** + * The maximum element count of this Table object. If there is no maximum, + * `max_size` is 0xffffffffu (i.e. UINT32_MAX). + */ uint32_t max_size; /** The current element count of the table. */ uint32_t size; @@ -416,8 +435,10 @@ typedef struct { typedef struct { /** The table element data, with an element count of `size`. */ wasm_rt_externref_t* data; - /** The maximum element count of this Table object. If there is no maximum, - * `max_size` is 0xffffffffu (i.e. UINT32_MAX). */ + /** + * The maximum element count of this Table object. If there is no maximum, + * `max_size` is 0xffffffffu (i.e. UINT32_MAX). + */ uint32_t max_size; /** The current element count of the table. */ uint32_t size; @@ -445,13 +466,11 @@ void wasm_rt_init_thread(void); */ void wasm_rt_free_thread(void); -/** - * A hardened jmp_buf that allows checking for initialization before use - */ +/** A hardened jmp_buf that allows checking for initialization before use */ typedef struct { - /* Is the jmp buf intialized? */ + /** Is the jmp buf intialized? */ bool initialized; - /* jmp_buf contents */ + /** jmp_buf contents */ jmp_buf buffer; } wasm_rt_jmp_buf; @@ -470,11 +489,11 @@ typedef struct { #define WASM_RT_LONGJMP_UNCHECKED(buf, val) longjmp(buf, val) #endif -#define WASM_RT_LONGJMP(buf, val) \ - /* Abort on failure as this may be called in the trap handler */ \ - if (!((buf).initialized)) \ - abort(); \ - (buf).initialized = false; \ +#define WASM_RT_LONGJMP(buf, val) \ + /** Abort on failure as this may be called in the trap handler */ \ + if (!((buf).initialized)) \ + abort(); \ + (buf).initialized = false; \ WASM_RT_LONGJMP_UNCHECKED((buf).buffer, val) /** @@ -485,9 +504,7 @@ typedef struct { */ WASM_RT_NO_RETURN void wasm_rt_trap(wasm_rt_trap_t); -/** - * Return a human readable error string based on a trap type. - */ +/** Return a human readable error string based on a trap type. */ const char* wasm_rt_strerror(wasm_rt_trap_t trap); #define wasm_rt_try(target) WASM_RT_SETJMP(target) @@ -525,28 +542,20 @@ void wasm_rt_allocate_memory(wasm_rt_memory_t*, */ uint64_t wasm_rt_grow_memory(wasm_rt_memory_t*, uint64_t pages); -/** - * Free a Memory object. - */ +/** Free a Memory object. */ void wasm_rt_free_memory(wasm_rt_memory_t*); #ifdef WASM_RT_C11_AVAILABLE -/** - * Shared memory version of wasm_rt_allocate_memory - */ +/** Shared memory version of wasm_rt_allocate_memory */ void wasm_rt_allocate_memory_shared(wasm_rt_shared_memory_t*, uint64_t initial_pages, uint64_t max_pages, bool is64); -/** - * Shared memory version of wasm_rt_grow_memory - */ +/** Shared memory version of wasm_rt_grow_memory */ uint64_t wasm_rt_grow_memory_shared(wasm_rt_shared_memory_t*, uint64_t pages); -/** - * Shared memory version of wasm_rt_free_memory - */ +/** Shared memory version of wasm_rt_free_memory */ void wasm_rt_free_memory_shared(wasm_rt_shared_memory_t*); #endif @@ -564,9 +573,7 @@ void wasm_rt_allocate_funcref_table(wasm_rt_funcref_table_t*, uint32_t elements, uint32_t max_elements); -/** - * Free a funcref Table object. - */ +/** Free a funcref Table object. */ void wasm_rt_free_funcref_table(wasm_rt_funcref_table_t*); /** @@ -578,9 +585,7 @@ void wasm_rt_allocate_externref_table(wasm_rt_externref_table_t*, uint32_t elements, uint32_t max_elements); -/** - * Free an externref Table object. - */ +/** Free an externref Table object. */ void wasm_rt_free_externref_table(wasm_rt_externref_table_t*); /** |