Allow setting pooling allocation in the C API (#10484)

* Allow setting pooling allocation in the C API

* Formatting

* Switch to object-style API

* Delete function

* Add wasmtime_ prefix

* More documentation and minor fixes

* Update doxygen config to exclude the WASMTIME_POOLING_ALLOCATION_CONFIG_PROP macro.

Author: fridaymore

crates/c-api/Cargo.toml

@@ -58,5 +58,6 @@ cranelift = ['wasmtime/cranelift']
 winch = ['wasmtime/winch']
 debug-builtins = ['wasmtime/debug-builtins']
 wat = ['dep:wat', 'wasmtime/wat']
+pooling-allocator = ["wasmtime/pooling-allocator"]
 # ... if you add a line above this be sure to change the other locations
 # marked WASMTIME_FEATURE_LIST

crates/c-api/artifact/Cargo.toml

@@ -39,6 +39,7 @@ default = [
   'cranelift',
   'winch',
   'debug-builtins',
+  'pooling-allocator',
   # ... if you add a line above this be sure to change the other locations
   # marked WASMTIME_FEATURE_LIST
 ]
@@ -60,5 +61,6 @@ gc-null = ["wasmtime-c-api/gc-null"]
 cranelift = ["wasmtime-c-api/cranelift"]
 winch = ["wasmtime-c-api/winch"]
 debug-builtins = ["wasmtime-c-api/debug-builtins"]
+pooling-allocator = ["wasmtime-c-api/pooling-allocator"]
 # ... if you add a line above this be sure to read the comment at the end of
 # `default`

crates/c-api/build.rs

@@ -21,6 +21,7 @@ const FEATURES: &[&str] = &[
     "WINCH",
     "DEBUG_BUILTINS",
     "WAT",
+    "POOLING_ALLOCATOR",
 ];
 // ... if you add a line above this be sure to change the other locations
 // marked WASMTIME_FEATURE_LIST

crates/c-api/cmake/features.cmake

@@ -44,5 +44,6 @@ feature(async ON)
 feature(cranelift ON)
 feature(winch ON)
 feature(debug-builtins ON)
+feature(pooling-allocator ON)
 # ... if you add a line above this be sure to change the other locations
 # marked WASMTIME_FEATURE_LIST

crates/c-api/doxygen.conf.in

@@ -942,6 +942,7 @@ EXCLUDE_SYMBOLS        = assertions \
                          WASMTIME_DECLARE_OWN \
                          WASI_DECLARE_OWN \
                          WASMTIME_CONFIG_PROP \
+                         WASMTIME_POOLING_ALLOCATION_CONFIG_PROP \
                          own \
                          wasm_*_enum
 

crates/c-api/include/wasmtime/conf.h.in

@@ -26,6 +26,7 @@
 #cmakedefine WASMTIME_FEATURE_CRANELIFT
 #cmakedefine WASMTIME_FEATURE_WINCH
 #cmakedefine WASMTIME_FEATURE_DEBUG_BUILTINS
+#cmakedefine WASMTIME_FEATURE_POOLING_ALLOCATOR
 // ... if you add a line above this be sure to change the other locations
 // marked WASMTIME_FEATURE_LIST
 

crates/c-api/include/wasmtime/config.h

@@ -542,6 +542,228 @@ wasmtime_config_host_memory_creator_set(wasm_config_t *,
  */
 WASMTIME_CONFIG_PROP(void, memory_init_cow, bool)
 
+#ifdef WASMTIME_FEATURE_POOLING_ALLOCATOR
+
+/**
+ * \brief A type containing configuration options for the pooling allocator.
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html
+ */
+typedef struct wasmtime_pooling_allocation_config_t
+    wasmtime_pooling_allocation_config_t;
+
+/**
+ * \brief Creates a new pooling allocation configuration object. Must be
+ * deallocated with a call to wasmtime_pooling_allocation_config_delete.
+ */
+WASM_API_EXTERN wasmtime_pooling_allocation_config_t *
+wasmtime_pooling_allocation_config_new();
+
+/**
+ * \brief Deallocates a pooling allocation configuration object created with a
+ * call to wasmtime_pooling_allocation_config_new.
+ */
+WASM_API_EXTERN void wasmtime_pooling_allocation_config_delete(
+    wasmtime_pooling_allocation_config_t *);
+
+#define WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(name, ty)                      \
+  WASM_API_EXTERN void wasmtime_pooling_allocation_config_##name##_set(        \
+      wasmtime_pooling_allocation_config_t *, ty);
+
+/**
+ * \brief Configures the maximum number of “unused warm slots” to retain in the
+ * pooling allocator.
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.max_unused_warm_slots.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(max_unused_warm_slots, uint32_t)
+
+/**
+ * \brief The target number of decommits to do per batch.
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.decommit_batch_size.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(decommit_batch_size, size_t)
+
+#ifdef WASMTIME_FEATURE_ASYNC
+/**
+ * \brief How much memory, in bytes, to keep resident for async stacks allocated
+ * with the pooling allocator.
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.async_stack_keep_resident.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(async_stack_keep_resident, size_t)
+#endif
+
+/**
+ * \brief How much memory, in bytes, to keep resident for each linear memory
+ * after deallocation.
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.linear_memory_keep_resident.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(linear_memory_keep_resident, size_t)
+
+/**
+ * \brief How much memory, in bytes, to keep resident for each table after
+ * deallocation.
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.table_keep_resident.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(table_keep_resident, size_t)
+
+/**
+ * \brief The maximum number of concurrent component instances supported
+ * (default is 1000).
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.total_component_instances.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(total_component_instances, uint32_t)
+
+/**
+ * \brief The maximum size, in bytes, allocated for a component instance’s
+ * VMComponentContext metadata.
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.max_component_instance_size.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(max_component_instance_size, size_t)
+
+/**
+ * \brief The maximum number of core instances a single component may contain
+ * (default is unlimited).
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.max_core_instances_per_component.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(max_core_instances_per_component,
+                                        uint32_t)
+
+/**
+ * \brief The maximum number of Wasm linear memories that a single component may
+ * transitively contain (default is unlimited).
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.max_memories_per_component.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(max_memories_per_component, uint32_t)
+
+/**
+ * \brief The maximum number of tables that a single component may transitively
+ * contain (default is unlimited).
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.max_tables_per_component.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(max_tables_per_component, uint32_t)
+
+/**
+ * \brief The maximum number of concurrent Wasm linear memories supported
+ * (default is 1000).
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.total_memories.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(total_memories, uint32_t)
+
+/**
+ * \brief The maximum number of concurrent tables supported (default is 1000).
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.total_tables.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(total_tables, uint32_t)
+
+#ifdef WASMTIME_FEATURE_ASYNC
+/**
+ * \brief The maximum number of execution stacks allowed for asynchronous
+ * execution, when enabled (default is 1000).
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.total_stacks.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(total_stacks, uint32_t)
+#endif
+
+/**
+ * \brief The maximum number of concurrent core instances supported (default is
+ * 1000).
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.total_core_instances.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(total_core_instances, uint32_t)
+
+/**
+ * \brief The maximum size, in bytes, allocated for a core instance’s VMContext
+ * metadata.
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.max_core_instance_size.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(max_core_instance_size, size_t)
+
+/**
+ * \brief The maximum number of defined tables for a core module (default is 1).
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.max_tables_per_module.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(max_tables_per_module, uint32_t)
+
+/**
+ * \brief The maximum table elements for any table defined in a module (default
+ * is 20000).
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.table_elements.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(table_elements, size_t)
+
+/**
+ * \brief The maximum number of defined linear memories for a module (default is
+ * 1).
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.max_memories_per_module.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(max_memories_per_module, uint32_t)
+
+/**
+ * \brief The maximum byte size that any WebAssembly linear memory may grow to.
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.max_memory_size.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(max_memory_size, size_t)
+
+/**
+ * \brief The maximum number of concurrent GC heaps supported (default is 1000).
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.PoolingAllocationConfig.html#method.total_gc_heaps.
+ */
+WASMTIME_POOLING_ALLOCATION_CONFIG_PROP(total_gc_heaps, uint32_t)
+
+/**
+ * \brief Sets the Wasmtime allocation strategy to use the pooling allocator. It
+ * does not take ownership of the pooling allocation configuration object, which
+ * must be deleted with a call to wasmtime_pooling_allocation_config_delete.
+ *
+ * For more information see the Rust documentation at
+ * https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.allocation_strategy.
+ */
+WASM_API_EXTERN void wasmtime_pooling_allocation_strategy_set(
+    wasm_config_t *, const wasmtime_pooling_allocation_config_t *);
+
+#endif // WASMTIME_FEATURE_POOLING_ALLOCATOR
+
 #ifdef __cplusplus
 } // extern "C"
 #endif