wasmtime_c_api/
config.rs

1// Don't worry about unused imports if we're frobbing features, only worry about
2// them with the default set of features enabled.
3#![cfg_attr(not(feature = "cache"), allow(unused_imports))]
4
5use crate::{handle_result, wasm_memorytype_t, wasmtime_error_t};
6use std::os::raw::c_char;
7use std::ptr;
8use std::{ffi::CStr, sync::Arc};
9use wasmtime::{
10    Config, LinearMemory, MemoryCreator, OptLevel, ProfilingStrategy, Result, Strategy,
11};
12
13#[repr(C)]
14#[derive(Clone)]
15pub struct wasm_config_t {
16    pub(crate) config: Config,
17}
18
19wasmtime_c_api_macros::declare_own!(wasm_config_t);
20
21#[repr(u8)]
22#[derive(Clone)]
23pub enum wasmtime_strategy_t {
24    WASMTIME_STRATEGY_AUTO,
25    WASMTIME_STRATEGY_CRANELIFT,
26}
27
28#[repr(u8)]
29#[derive(Clone)]
30pub enum wasmtime_opt_level_t {
31    WASMTIME_OPT_LEVEL_NONE,
32    WASMTIME_OPT_LEVEL_SPEED,
33    WASMTIME_OPT_LEVEL_SPEED_AND_SIZE,
34}
35
36#[repr(u8)]
37#[derive(Clone)]
38pub enum wasmtime_profiling_strategy_t {
39    WASMTIME_PROFILING_STRATEGY_NONE,
40    WASMTIME_PROFILING_STRATEGY_JITDUMP,
41    WASMTIME_PROFILING_STRATEGY_VTUNE,
42    WASMTIME_PROFILING_STRATEGY_PERFMAP,
43}
44
45#[unsafe(no_mangle)]
46pub extern "C" fn wasm_config_new() -> Box<wasm_config_t> {
47    Box::new(wasm_config_t {
48        config: Config::default(),
49    })
50}
51
52#[unsafe(no_mangle)]
53pub extern "C" fn wasmtime_config_debug_info_set(c: &mut wasm_config_t, enable: bool) {
54    c.config.debug_info(enable);
55}
56
57#[unsafe(no_mangle)]
58pub extern "C" fn wasmtime_config_consume_fuel_set(c: &mut wasm_config_t, enable: bool) {
59    c.config.consume_fuel(enable);
60}
61
62#[unsafe(no_mangle)]
63pub extern "C" fn wasmtime_config_epoch_interruption_set(c: &mut wasm_config_t, enable: bool) {
64    c.config.epoch_interruption(enable);
65}
66
67#[unsafe(no_mangle)]
68pub extern "C" fn wasmtime_config_max_wasm_stack_set(c: &mut wasm_config_t, size: usize) {
69    c.config.max_wasm_stack(size);
70}
71
72#[unsafe(no_mangle)]
73#[cfg(feature = "threads")]
74pub extern "C" fn wasmtime_config_wasm_threads_set(c: &mut wasm_config_t, enable: bool) {
75    c.config.wasm_threads(enable);
76}
77
78#[unsafe(no_mangle)]
79pub extern "C" fn wasmtime_config_wasm_tail_call_set(c: &mut wasm_config_t, enable: bool) {
80    c.config.wasm_tail_call(enable);
81}
82
83#[unsafe(no_mangle)]
84pub extern "C" fn wasmtime_config_wasm_reference_types_set(c: &mut wasm_config_t, enable: bool) {
85    c.config.wasm_reference_types(enable);
86}
87
88#[unsafe(no_mangle)]
89pub extern "C" fn wasmtime_config_wasm_function_references_set(
90    c: &mut wasm_config_t,
91    enable: bool,
92) {
93    c.config.wasm_function_references(enable);
94}
95
96#[unsafe(no_mangle)]
97pub extern "C" fn wasmtime_config_wasm_gc_set(c: &mut wasm_config_t, enable: bool) {
98    c.config.wasm_gc(enable);
99}
100
101#[unsafe(no_mangle)]
102pub extern "C" fn wasmtime_config_wasm_simd_set(c: &mut wasm_config_t, enable: bool) {
103    c.config.wasm_simd(enable);
104}
105
106#[unsafe(no_mangle)]
107pub extern "C" fn wasmtime_config_wasm_relaxed_simd_set(c: &mut wasm_config_t, enable: bool) {
108    c.config.wasm_relaxed_simd(enable);
109}
110
111#[unsafe(no_mangle)]
112pub extern "C" fn wasmtime_config_wasm_relaxed_simd_deterministic_set(
113    c: &mut wasm_config_t,
114    enable: bool,
115) {
116    c.config.relaxed_simd_deterministic(enable);
117}
118
119#[unsafe(no_mangle)]
120pub extern "C" fn wasmtime_config_wasm_bulk_memory_set(c: &mut wasm_config_t, enable: bool) {
121    c.config.wasm_bulk_memory(enable);
122}
123
124#[unsafe(no_mangle)]
125pub extern "C" fn wasmtime_config_wasm_multi_value_set(c: &mut wasm_config_t, enable: bool) {
126    c.config.wasm_multi_value(enable);
127}
128
129#[unsafe(no_mangle)]
130pub extern "C" fn wasmtime_config_wasm_multi_memory_set(c: &mut wasm_config_t, enable: bool) {
131    c.config.wasm_multi_memory(enable);
132}
133
134#[unsafe(no_mangle)]
135pub extern "C" fn wasmtime_config_wasm_memory64_set(c: &mut wasm_config_t, enable: bool) {
136    c.config.wasm_memory64(enable);
137}
138
139#[unsafe(no_mangle)]
140#[cfg(any(feature = "cranelift", feature = "winch"))]
141pub extern "C" fn wasmtime_config_strategy_set(
142    c: &mut wasm_config_t,
143    strategy: wasmtime_strategy_t,
144) {
145    use wasmtime_strategy_t::*;
146    c.config.strategy(match strategy {
147        WASMTIME_STRATEGY_AUTO => Strategy::Auto,
148        WASMTIME_STRATEGY_CRANELIFT => Strategy::Cranelift,
149    });
150}
151
152#[unsafe(no_mangle)]
153#[cfg(feature = "parallel-compilation")]
154pub extern "C" fn wasmtime_config_parallel_compilation_set(c: &mut wasm_config_t, enable: bool) {
155    c.config.parallel_compilation(enable);
156}
157
158#[unsafe(no_mangle)]
159#[cfg(any(feature = "cranelift", feature = "winch"))]
160pub extern "C" fn wasmtime_config_cranelift_debug_verifier_set(
161    c: &mut wasm_config_t,
162    enable: bool,
163) {
164    c.config.cranelift_debug_verifier(enable);
165}
166
167#[unsafe(no_mangle)]
168#[cfg(any(feature = "cranelift", feature = "winch"))]
169pub extern "C" fn wasmtime_config_cranelift_nan_canonicalization_set(
170    c: &mut wasm_config_t,
171    enable: bool,
172) {
173    c.config.cranelift_nan_canonicalization(enable);
174}
175
176#[unsafe(no_mangle)]
177#[cfg(any(feature = "cranelift", feature = "winch"))]
178pub extern "C" fn wasmtime_config_cranelift_opt_level_set(
179    c: &mut wasm_config_t,
180    opt_level: wasmtime_opt_level_t,
181) {
182    use wasmtime_opt_level_t::*;
183    c.config.cranelift_opt_level(match opt_level {
184        WASMTIME_OPT_LEVEL_NONE => OptLevel::None,
185        WASMTIME_OPT_LEVEL_SPEED => OptLevel::Speed,
186        WASMTIME_OPT_LEVEL_SPEED_AND_SIZE => OptLevel::SpeedAndSize,
187    });
188}
189
190#[unsafe(no_mangle)]
191pub extern "C" fn wasmtime_config_profiler_set(
192    c: &mut wasm_config_t,
193    strategy: wasmtime_profiling_strategy_t,
194) {
195    use wasmtime_profiling_strategy_t::*;
196    c.config.profiler(match strategy {
197        WASMTIME_PROFILING_STRATEGY_NONE => ProfilingStrategy::None,
198        WASMTIME_PROFILING_STRATEGY_JITDUMP => ProfilingStrategy::JitDump,
199        WASMTIME_PROFILING_STRATEGY_VTUNE => ProfilingStrategy::VTune,
200        WASMTIME_PROFILING_STRATEGY_PERFMAP => ProfilingStrategy::PerfMap,
201    });
202}
203
204#[unsafe(no_mangle)]
205#[cfg(feature = "cache")]
206pub unsafe extern "C" fn wasmtime_config_cache_config_load(
207    c: &mut wasm_config_t,
208    filename: *const c_char,
209) -> Option<Box<wasmtime_error_t>> {
210    handle_result(
211        if filename.is_null() {
212            c.config.cache_config_load_default()
213        } else {
214            match CStr::from_ptr(filename).to_str() {
215                Ok(s) => c.config.cache_config_load(s),
216                Err(e) => Err(e.into()),
217            }
218        },
219        |_cfg| {},
220    )
221}
222
223#[unsafe(no_mangle)]
224pub extern "C" fn wasmtime_config_memory_may_move_set(c: &mut wasm_config_t, enable: bool) {
225    c.config.memory_may_move(enable);
226}
227
228#[unsafe(no_mangle)]
229pub extern "C" fn wasmtime_config_memory_reservation_set(c: &mut wasm_config_t, size: u64) {
230    c.config.memory_reservation(size);
231}
232
233#[unsafe(no_mangle)]
234pub extern "C" fn wasmtime_config_memory_guard_size_set(c: &mut wasm_config_t, size: u64) {
235    c.config.memory_guard_size(size);
236}
237
238#[unsafe(no_mangle)]
239pub extern "C" fn wasmtime_config_memory_reservation_for_growth_set(
240    c: &mut wasm_config_t,
241    size: u64,
242) {
243    c.config.memory_reservation_for_growth(size);
244}
245
246#[unsafe(no_mangle)]
247pub extern "C" fn wasmtime_config_native_unwind_info_set(c: &mut wasm_config_t, enabled: bool) {
248    c.config.native_unwind_info(enabled);
249}
250
251#[unsafe(no_mangle)]
252pub unsafe extern "C" fn wasmtime_config_target_set(
253    c: &mut wasm_config_t,
254    target: *const c_char,
255) -> Option<Box<wasmtime_error_t>> {
256    let target = CStr::from_ptr(target).to_str().expect("not valid utf-8");
257    handle_result(c.config.target(target), |_cfg| {})
258}
259
260#[unsafe(no_mangle)]
261pub extern "C" fn wasmtime_config_macos_use_mach_ports_set(c: &mut wasm_config_t, enabled: bool) {
262    c.config.macos_use_mach_ports(enabled);
263}
264
265#[unsafe(no_mangle)]
266#[cfg(any(feature = "cranelift", feature = "winch"))]
267pub unsafe extern "C" fn wasmtime_config_cranelift_flag_enable(
268    c: &mut wasm_config_t,
269    flag: *const c_char,
270) {
271    let flag = CStr::from_ptr(flag).to_str().expect("not valid utf-8");
272    c.config.cranelift_flag_enable(flag);
273}
274
275#[unsafe(no_mangle)]
276#[cfg(any(feature = "cranelift", feature = "winch"))]
277pub unsafe extern "C" fn wasmtime_config_cranelift_flag_set(
278    c: &mut wasm_config_t,
279    flag: *const c_char,
280    value: *const c_char,
281) {
282    let flag = CStr::from_ptr(flag).to_str().expect("not valid utf-8");
283    let value = CStr::from_ptr(value).to_str().expect("not valid utf-8");
284    c.config.cranelift_flag_set(flag, value);
285}
286
287pub type wasmtime_memory_get_callback_t = extern "C" fn(
288    env: *mut std::ffi::c_void,
289    byte_size: &mut usize,
290    maximum_byte_size: &mut usize,
291) -> *mut u8;
292
293pub type wasmtime_memory_grow_callback_t =
294    extern "C" fn(env: *mut std::ffi::c_void, new_size: usize) -> Option<Box<wasmtime_error_t>>;
295
296#[repr(C)]
297pub struct wasmtime_linear_memory_t {
298    env: *mut std::ffi::c_void,
299    get_memory: wasmtime_memory_get_callback_t,
300    grow_memory: wasmtime_memory_grow_callback_t,
301    finalizer: Option<extern "C" fn(arg1: *mut std::ffi::c_void)>,
302}
303
304pub type wasmtime_new_memory_callback_t = extern "C" fn(
305    env: *mut std::ffi::c_void,
306    ty: &wasm_memorytype_t,
307    minimum: usize,
308    maximum: usize,
309    reserved_size_in_bytes: usize,
310    guard_size_in_bytes: usize,
311    memory_ret: *mut wasmtime_linear_memory_t,
312) -> Option<Box<wasmtime_error_t>>;
313
314struct CHostLinearMemory {
315    foreign: crate::ForeignData,
316    get_memory: wasmtime_memory_get_callback_t,
317    grow_memory: wasmtime_memory_grow_callback_t,
318}
319
320unsafe impl LinearMemory for CHostLinearMemory {
321    fn byte_size(&self) -> usize {
322        let mut byte_size = 0;
323        let mut byte_capacity = 0;
324        let cb = self.get_memory;
325        cb(self.foreign.data, &mut byte_size, &mut byte_capacity);
326        return byte_size;
327    }
328    fn byte_capacity(&self) -> usize {
329        let mut byte_size = 0;
330        let mut byte_capacity = 0;
331        let cb = self.get_memory;
332        cb(self.foreign.data, &mut byte_size, &mut byte_capacity);
333        byte_capacity
334    }
335    fn as_ptr(&self) -> *mut u8 {
336        let mut byte_size = 0;
337        let mut byte_capacity = 0;
338        let cb = self.get_memory;
339        cb(self.foreign.data, &mut byte_size, &mut byte_capacity)
340    }
341    fn grow_to(&mut self, new_size: usize) -> Result<()> {
342        let cb = self.grow_memory;
343        let error = cb(self.foreign.data, new_size);
344        if let Some(err) = error {
345            Err((*err).into())
346        } else {
347            Ok(())
348        }
349    }
350}
351
352#[repr(C)]
353pub struct wasmtime_memory_creator_t {
354    env: *mut std::ffi::c_void,
355    new_memory: wasmtime_new_memory_callback_t,
356    finalizer: Option<extern "C" fn(arg1: *mut std::ffi::c_void)>,
357}
358
359struct CHostMemoryCreator {
360    foreign: crate::ForeignData,
361    new_memory: wasmtime_new_memory_callback_t,
362}
363unsafe impl Send for CHostMemoryCreator {}
364unsafe impl Sync for CHostMemoryCreator {}
365
366unsafe impl MemoryCreator for CHostMemoryCreator {
367    fn new_memory(
368        &self,
369        ty: wasmtime::MemoryType,
370        minimum: usize,
371        maximum: Option<usize>,
372        reserved_size_in_bytes: Option<usize>,
373        guard_size_in_bytes: usize,
374    ) -> Result<Box<dyn wasmtime::LinearMemory>, String> {
375        extern "C" fn panic_get_callback(
376            _env: *mut std::ffi::c_void,
377            _byte_size: &mut usize,
378            _maximum_byte_size: &mut usize,
379        ) -> *mut u8 {
380            panic!("a callback must be set");
381        }
382        extern "C" fn panic_grow_callback(
383            _env: *mut std::ffi::c_void,
384            _size: usize,
385        ) -> Option<Box<wasmtime_error_t>> {
386            panic!("a callback must be set");
387        }
388        let mut memory = wasmtime_linear_memory_t {
389            env: ptr::null_mut(),
390            get_memory: panic_get_callback,
391            grow_memory: panic_grow_callback,
392            finalizer: None,
393        };
394        let cb = self.new_memory;
395        let error = cb(
396            self.foreign.data,
397            &wasm_memorytype_t::new(ty),
398            minimum,
399            maximum.unwrap_or(usize::MAX),
400            reserved_size_in_bytes.unwrap_or(0),
401            guard_size_in_bytes,
402            &mut memory,
403        );
404        match error {
405            None => {
406                let foreign = crate::ForeignData {
407                    data: memory.env,
408                    finalizer: memory.finalizer,
409                };
410                Ok(Box::new(CHostLinearMemory {
411                    foreign,
412                    get_memory: memory.get_memory,
413                    grow_memory: memory.grow_memory,
414                }))
415            }
416            Some(err) => {
417                let err: anyhow::Error = (*err).into();
418                Err(format!("{err}"))
419            }
420        }
421    }
422}
423
424#[unsafe(no_mangle)]
425pub unsafe extern "C" fn wasmtime_config_host_memory_creator_set(
426    c: &mut wasm_config_t,
427    creator: &wasmtime_memory_creator_t,
428) {
429    c.config.with_host_memory(Arc::new(CHostMemoryCreator {
430        foreign: crate::ForeignData {
431            data: creator.env,
432            finalizer: creator.finalizer,
433        },
434        new_memory: creator.new_memory,
435    }));
436}
437
438#[unsafe(no_mangle)]
439pub extern "C" fn wasmtime_config_memory_init_cow_set(c: &mut wasm_config_t, enable: bool) {
440    c.config.memory_init_cow(enable);
441}
442
443#[unsafe(no_mangle)]
444pub extern "C" fn wasmtime_config_wasm_wide_arithmetic_set(c: &mut wasm_config_t, enable: bool) {
445    c.config.wasm_wide_arithmetic(enable);
446}