Skip to content

Commit f81d079

Browse files
lum1n0uslum1n0us
committed
docs: update tiered support documentation with improved compilation flags and descriptions
1 parent a300125 commit f81d079

1 file changed

Lines changed: 85 additions & 86 deletions

File tree

‎doc/tiered_support.md‎

Lines changed: 85 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -108,92 +108,91 @@ _Privileged Features_ are features that require users' awareness of potential se
108108

109109
# Appendix: All compilation flags
110110

111-
| Compilation flags | Tiered | Default | on Ubuntu |
112-
| ------------------------------------------- | ------ | ------- | --------- |
113-
| WAMR_APP_THREAD_STACK_SIZE_MAX | B | ND[^1] | |
114-
| WAMR_BH_LOG | B | ND | |
115-
| WAMR_BH_VPRINTF | B | ND | |
116-
| WAMR_BUILD_ALLOC_WITH_USAGE | B | ND | |
117-
| WAMR_BUILD_ALLOC_WITH_USER_DATA | B | ND | |
118-
| WAMR_BUILD_AOT | A | ND | 1 |
119-
| WAMR_BUILD_AOT_INTRINSICS | A | 1[^2] | |
120-
| WAMR_BUILD_AOT_STACK_FRAME | A | ND | |
121-
| WAMR_BUILD_AOT_VALIDATOR | B | ND | |
122-
| WAMR_BUILD_BULK_MEMORY | A | 1 | |
123-
| WAMR_BUILD_COPY_CALL_STACK | B | ND | |
124-
| WAMR_BUILD_CUSTOM_NAME_SECTION | B | ND | |
125-
| WAMR_BUILD_DEBUG_AOT | C | ND | |
126-
| WAMR_BUILD_DEBUG_INTERP | B | ND | |
127-
| WAMR_BUILD_DUMP_CALL_STACK | B | ND | |
128-
| WAMR_BUILD_DYNAMIC_AOT_DEBUG | C | ND | |
129-
| WAMR_BUILD_EXCE_HANDLING | C | 0 | |
130-
| WAMR_BUILD_EXTENDED_CONST_EXPR | A | 0 | |
131-
| WAMR_BUILD_FAST_INTERP | A | ND | 1 |
132-
| WAMR_BUILD_FAST_JIT | B | ND | |
133-
| WAMR_BUILD_FAST_JIT_DUMP | B | ND | |
134-
| WAMR_BUILD_GC | B | 0 | |
135-
| WAMR_BUILD_GC_HEAP_VERIFY | B | ND | |
136-
| WAMR_BUILD_GLOBAL_HEAP_POOL | A | ND | |
137-
| WAMR_BUILD_GLOBAL_HEAP_SIZE | A | ND | |
138-
| WAMR_BUILD_INSTRUCTION_METERING | C | ND | |
139-
| WAMR_BUILD_INTERP | A | ND | 1 |
140-
| WAMR_BUILD_INVOKE_NATIVE_GENERAL | B | ND | |
141-
| WAMR_BUILD_JIT | B | ND | |
142-
| WAMR_BUILD_LAZY_JIT | B | 1[^3] | |
143-
| WAMR_BUILD_LIBC_BUILTIN | A | ND | 1 |
144-
| WAMR_BUILD_LIBC_EMCC | C | ND | |
145-
| WAMR_BUILD_LIBC_UVWASI | C | ND | |
146-
| WAMR_BUILD_LIBC_WASI | A | ND | 1 |
147-
| WAMR_BUILD_LIB_PTHREAD | B | ND | |
148-
| WAMR_BUILD_LIB_PTHREAD_SEMAPHORE | B | ND | |
149-
| WAMR_BUILD_LIB_RATS | C | ND | |
150-
| WAMR_BUILD_LIB_WASI_THREADS | B | ND | |
151-
| WAMR_BUILD_LINUX_PERF | B | ND | |
152-
| WAMR_BUILD_LIME1 | A | NO | |
153-
| WAMR_BUILD_LOAD_CUSTOM_SECTION | A | ND | |
154-
| WAMR_BUILD_MEMORY64 | A | 0 | |
155-
| WAMR_BUILD_MEMORY_PROFILING | B | ND | |
156-
| WAMR_BUILD_MINI_LOADER | B | ND | |
157-
| WAMR_BUILD_MODULE_INST_CONTEXT | B | ND | 1 |
158-
| WAMR_BUILD_MULTI_MEMORY | C | 0 | |
159-
| WAMR_BUILD_MULTI_MODULE | B | ND | |
160-
| WAMR_BUILD_PERF_PROFILING | B | ND | |
161-
| WAMR_BUILD_PLATFORM | - | ND | linux |
162-
| WAMR_BUILD_QUICK_AOT_ENTRY | A | 1[^4] | |
163-
| WAMR_BUILD_REF_TYPES | A | ND | 1 |
164-
| WAMR_BUILD_SANITIZER | B | ND | |
165-
| WAMR_BUILD_SGX_IPFS | C | ND | |
166-
| WAMR_BUILD_SHARED_HEAP | A | ND | |
167-
| WAMR_BUILD_SHARED_MEMORY | A | 0 | 1 |
168-
| WAMR_BUILD_SHRUNK_MEMORY | A | ND | 1 |
169-
| WAMR_BUILD_SIMD | A | ND | 1 |
170-
| WAMR_BUILD_SIMDE | A | ND | 1 |
171-
| WAMR_BUILD_SPEC_TEST | A | ND | |
172-
| WAMR_BUILD_STACK_GUARD_SIZE | B | ND | |
173-
| WAMR_BUILD_STATIC_PGO | B | ND | |
174-
| WAMR_BUILD_STRINGREF | B | 0 | |
175-
| WAMR_BUILD_TAIL_CALL | A | 0 | 1 |
176-
| WAMR_BUILD_TARGET | - | ND | X86-64 |
177-
| WAMR_BUILD_THREAD_MGR | A | ND | |
178-
| WAMR_BUILD_WAMR_COMPILER | A | ND | |
179-
| WAMR_BUILD_WASI_EPHEMERAL_NN | B | ND | |
180-
| WAMR_BUILD_WASI_NN | B | ND | |
181-
| WAMR_BUILD_WASI_NN_ENABLE_EXTERNAL_DELEGATE | B | ND | |
182-
| WAMR_BUILD_WASI_NN_ENABLE_GPU | B | ND | |
183-
| WAMR_BUILD_WASI_NN_EXTERNAL_DELEGATE_PATH | B | ND | |
184-
| WAMR_BUILD_WASI_NN_LLAMACPP | B | ND | |
185-
| WAMR_BUILD_WASI_NN_ONNX | B | ND | |
186-
| WAMR_BUILD_WASI_NN_OPENVINO | B | ND | |
187-
| WAMR_BUILD_WASI_NN_TFLITE | B | ND | |
188-
| WAMR_BUILD_WASI_TEST | B | ND | |
189-
| WAMR_BUILD_WASM_CACHE | B | ND | |
190-
| WAMR_CONFIGURABLE_BOUNDS_CHECKS | C | ND | |
191-
| WAMR_DISABLE_APP_ENTRY | A | ND | |
192-
| WAMR_DISABLE_HW_BOUND_CHECK | A | ND | |
193-
| WAMR_DISABLE_STACK_HW_BOUND_CHECK | A | ND | |
194-
| WAMR_DISABLE_WAKEUP_BLOCKING_OP | B | ND | |
195-
| WAMR_DISABLE_WRITE_GS_BASE | B | ND | |
196-
| WAMR_TEST_GC | B | ND | |
111+
| Description | Compilation flags | Tiered | Default | on Ubuntu |
112+
| ------------------------------------ | ------------------------------------------- | ------ | ------- | --------- |
113+
| Maximum stack size for app threads | WAMR_APP_THREAD_STACK_SIZE_MAX | B | ND[^1] | |
114+
| Host defined logging | WAMR_BH_LOG | B | ND | |
115+
| Host defined vprintf | WAMR_BH_VPRINTF | B | ND | |
116+
| Allocation with usage tracking | WAMR_BUILD_ALLOC_WITH_USAGE | B | ND | |
117+
| Allocation with user data | WAMR_BUILD_ALLOC_WITH_USER_DATA | B | ND | |
118+
| AoT compilation | WAMR_BUILD_AOT | A | ND | 1 |
119+
| AoT intrinsics | WAMR_BUILD_AOT_INTRINSICS | A | 1[^2] | |
120+
| AoT stack frame | WAMR_BUILD_AOT_STACK_FRAME | A | ND | |
121+
| AoT validator | WAMR_BUILD_AOT_VALIDATOR | B | ND | |
122+
| bulk memory | WAMR_BUILD_BULK_MEMORY | A | 1 | |
123+
| copy call stack | WAMR_BUILD_COPY_CALL_STACK | B | ND | |
124+
| custom name section | WAMR_BUILD_CUSTOM_NAME_SECTION | B | ND | |
125+
| debug AoT | WAMR_BUILD_DEBUG_AOT | C | ND | |
126+
| debug interpreter | WAMR_BUILD_DEBUG_INTERP | B | ND | |
127+
| dump call stack | WAMR_BUILD_DUMP_CALL_STACK | B | ND | |
128+
| dynamic AoT debugging | WAMR_BUILD_DYNAMIC_AOT_DEBUG | C | ND | |
129+
| exception handling | WAMR_BUILD_EXCE_HANDLING | C | 0 | |
130+
| extended constant expressions | WAMR_BUILD_EXTENDED_CONST_EXPR | A | 0 | |
131+
| fast interpreter | WAMR_BUILD_FAST_INTERP | A | ND | 1 |
132+
| fast JIT | WAMR_BUILD_FAST_JIT | B | ND | |
133+
| fast JIT dump | WAMR_BUILD_FAST_JIT_DUMP | B | ND | |
134+
| garbage collection | WAMR_BUILD_GC | B | 0 | |
135+
| garbage collection heap verification | WAMR_BUILD_GC_HEAP_VERIFY | B | ND | |
136+
| global heap pool | WAMR_BUILD_GLOBAL_HEAP_POOL | A | ND | |
137+
| global heap size | WAMR_BUILD_GLOBAL_HEAP_SIZE | A | ND | |
138+
| instruction metering | WAMR_BUILD_INSTRUCTION_METERING | C | ND | |
139+
| interpreter | WAMR_BUILD_INTERP | A | ND | 1 |
140+
| native general invocation | WAMR_BUILD_INVOKE_NATIVE_GENERAL | B | ND | |
141+
| JIT compilation | WAMR_BUILD_JIT | B | ND | |
142+
| lazy JIT compilation | WAMR_BUILD_LAZY_JIT | B | 1[^3] | |
143+
| libc builtin functions | WAMR_BUILD_LIBC_BUILTIN | A | ND | 1 |
144+
| libc emcc compatibility | WAMR_BUILD_LIBC_EMCC | C | ND | |
145+
| libc uvwasi compatibility | WAMR_BUILD_LIBC_UVWASI | C | ND | |
146+
| wasi libc | WAMR_BUILD_LIBC_WASI | A | ND | 1 |
147+
| pthread library | WAMR_BUILD_LIB_PTHREAD | B | ND | |
148+
| pthread semaphore support | WAMR_BUILD_LIB_PTHREAD_SEMAPHORE | B | ND | |
149+
| RATS library | WAMR_BUILD_LIB_RATS | C | ND | |
150+
| wasi threads | WAMR_BUILD_LIB_WASI_THREADS | B | ND | |
151+
| Linux performance counters | WAMR_BUILD_LINUX_PERF | B | ND | |
152+
| LIME1 runtime | WAMR_BUILD_LIME1 | A | NO | |
153+
| loading custom sections | WAMR_BUILD_LOAD_CUSTOM_SECTION | A | ND | |
154+
| memory64 support | WAMR_BUILD_MEMORY64 | A | 0 | |
155+
| memory profiling | WAMR_BUILD_MEMORY_PROFILING | B | ND | |
156+
| mini loader | WAMR_BUILD_MINI_LOADER | B | ND | |
157+
| module instance context | WAMR_BUILD_MODULE_INST_CONTEXT | B | ND | 1 |
158+
| multi-memory support | WAMR_BUILD_MULTI_MEMORY | C | 0 | |
159+
| multi-module support | WAMR_BUILD_MULTI_MODULE | B | ND | |
160+
| performance profiling | WAMR_BUILD_PERF_PROFILING | B | ND | |
161+
| Default platform | WAMR_BUILD_PLATFORM | - | ND | linux |
162+
| quick AOT entry | WAMR_BUILD_QUICK_AOT_ENTRY | A | 1[^4] | |
163+
| reference types | WAMR_BUILD_REF_TYPES | A | ND | 1 |
164+
| sanitizer | WAMR_BUILD_SANITIZER | B | ND | |
165+
| SGX IPFS support | WAMR_BUILD_SGX_IPFS | C | ND | |
166+
| shared heap | WAMR_BUILD_SHARED_HEAP | A | ND | |
167+
| shared memory | WAMR_BUILD_SHARED_MEMORY | A | 0 | 1 |
168+
| shrunk memory | WAMR_BUILD_SHRUNK_MEMORY | A | ND | 1 |
169+
| SIMD support | WAMR_BUILD_SIMD | A | ND | 1 |
170+
| SIMD E extensions | WAMR_BUILD_SIMDE | A | ND | 1 |
171+
| spec test | WAMR_BUILD_SPEC_TEST | A | ND | |
172+
| Stack guard size | WAMR_BUILD_STACK_GUARD_SIZE | B | ND | |
173+
| Static PGO | WAMR_BUILD_STATIC_PGO | B | ND | |
174+
| String reference support | WAMR_BUILD_STRINGREF | B | 0 | |
175+
| Tail call optimization | WAMR_BUILD_TAIL_CALL | A | 0 | 1 |
176+
| Default target architecture | WAMR_BUILD_TARGET | - | ND | X86-64 |
177+
| Thread manager | WAMR_BUILD_THREAD_MGR | A | ND | |
178+
| WAMR compiler | WAMR_BUILD_WAMR_COMPILER | A | ND | |
179+
| WASI ephemeral NN | WAMR_BUILD_WASI_EPHEMERAL_NN | B | ND | |
180+
| WASI NN | WAMR_BUILD_WASI_NN | B | ND | |
181+
| external delegate for WASI NN | WAMR_BUILD_WASI_NN_ENABLE_EXTERNAL_DELEGATE | B | ND | |
182+
| GPU support for WASI NN | WAMR_BUILD_WASI_NN_ENABLE_GPU | B | ND | |
183+
| External delegate path for WASI NN | WAMR_BUILD_WASI_NN_EXTERNAL_DELEGATE_PATH | B | ND | |
184+
| LLAMA CPP for WASI NN | WAMR_BUILD_WASI_NN_LLAMACPP | B | ND | |
185+
| ONNX for WASI NN | WAMR_BUILD_WASI_NN_ONNX | B | ND | |
186+
| OpenVINO for WASI NN | WAMR_BUILD_WASI_NN_OPENVINO | B | ND | |
187+
| TFLite for WASI NN | WAMR_BUILD_WASI_NN_TFLITE | B | ND | |
188+
| WASM cache | WAMR_BUILD_WASM_CACHE | B | ND | |
189+
| Configurable bounds checks | WAMR_CONFIGURABLE_BOUNDS_CHECKS | C | ND | |
190+
| Disable app entry | WAMR_DISABLE_APP_ENTRY | A | ND | |
191+
| Disable hardware bound check | WAMR_DISABLE_HW_BOUND_CHECK | A | ND | |
192+
| Disable stack hardware bound check | WAMR_DISABLE_STACK_HW_BOUND_CHECK | A | ND | |
193+
| Disable wakeup blocking operation | WAMR_DISABLE_WAKEUP_BLOCKING_OP | B | ND | |
194+
| Disable write GS base | WAMR_DISABLE_WRITE_GS_BASE | B | ND | |
195+
| Test garbage collection | WAMR_TEST_GC | B | ND | |
197196

198197
[^1]: _ND_ represents _not defined_
199198
[^2]: active if `WAMR_BUILD_AOT` is 1

0 commit comments

Comments
 (0)