smg-wasm 1.1.0

WebAssembly runtime and module management for Shepherd Model Gateway
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353

//! WASM Runtime Configuration
//!
//! Defines configuration parameters for the WASM runtime,
//! including memory limits, execution timeouts, and thread pool settings.

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct WasmRuntimeConfig {
    /// Maximum memory size in pages (64KB per page)
    pub max_memory_pages: u32,
    /// Maximum execution time in milliseconds
    pub max_execution_time_ms: u64,
    /// Maximum stack size in bytes
    pub max_stack_size: usize,
    /// Number of worker threads in the pool
    pub thread_pool_size: usize,
    /// Maximum number of modules to cache per worker
    pub module_cache_size: usize,
    /// Maximum HTTP body size in bytes for middleware request/response processing
    pub max_body_size: usize,
}

impl Default for WasmRuntimeConfig {
    fn default() -> Self {
        let default_thread_pool_size = std::thread::available_parallelism()
            .map(|n| n.get())
            .unwrap_or(4)
            .clamp(1, 4);

        Self {
            max_memory_pages: 1024,                     // 64MB
            max_execution_time_ms: 1000,                // 1 seconds
            max_stack_size: 1024 * 1024,                // 1MB
            thread_pool_size: default_thread_pool_size, // based on cpu count and capped
            module_cache_size: 10,                      // Cache up to 10 modules per worker
            max_body_size: 10 * 1024 * 1024,            // 10MB
        }
    }
}

impl WasmRuntimeConfig {
    /// Validate the configuration parameters
    pub fn validate(&self) -> Result<(), String> {
        // Validate max_memory_pages
        if self.max_memory_pages == 0 {
            return Err("max_memory_pages cannot be 0".to_string());
        }
        if self.max_memory_pages > 65536 {
            return Err("max_memory_pages cannot exceed 65536 (4GB)".to_string());
        }

        // Validate max_execution_time_ms
        if self.max_execution_time_ms == 0 {
            return Err("max_execution_time_ms cannot be 0".to_string());
        }
        if self.max_execution_time_ms > 300000 {
            return Err("max_execution_time_ms cannot exceed 300000ms (5 minutes)".to_string());
        }

        // Validate max_stack_size
        if self.max_stack_size == 0 {
            return Err("max_stack_size cannot be 0".to_string());
        }
        if self.max_stack_size < 64 * 1024 {
            return Err("max_stack_size must be at least 64KB".to_string());
        }
        if self.max_stack_size > 16 * 1024 * 1024 {
            return Err("max_stack_size cannot exceed 16MB".to_string());
        }

        // Validate thread_pool_size
        if self.thread_pool_size == 0 {
            return Err("thread_pool_size cannot be 0".to_string());
        }
        if self.thread_pool_size > 128 {
            return Err("thread_pool_size cannot exceed 128".to_string());
        }

        // Validate module_cache_size
        if self.module_cache_size == 0 {
            return Err("module_cache_size cannot be 0".to_string());
        }
        if self.module_cache_size > 1000 {
            return Err("module_cache_size cannot exceed 1000".to_string());
        }

        // Validate max_body_size
        if self.max_body_size == 0 {
            return Err("max_body_size cannot be 0".to_string());
        }
        if self.max_body_size > 100 * 1024 * 1024 {
            return Err("max_body_size cannot exceed 100MB".to_string());
        }

        Ok(())
    }

    /// Create a new config with validation
    pub fn new(
        max_memory_pages: u32,
        max_execution_time_ms: u64,
        max_stack_size: usize,
        thread_pool_size: usize,
        module_cache_size: usize,
        max_body_size: usize,
    ) -> Result<Self, String> {
        let config = Self {
            max_memory_pages,
            max_execution_time_ms,
            max_stack_size,
            thread_pool_size,
            module_cache_size,
            max_body_size,
        };
        config.validate()?;
        Ok(config)
    }

    /// Get the total memory size in bytes
    pub fn get_total_memory_bytes(&self) -> u64 {
        self.max_memory_pages as u64 * 64 * 1024 // 64KB per page
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_default_config_validation() {
        let config = WasmRuntimeConfig::default();
        assert!(config.validate().is_ok());
    }

    #[test]
    fn test_config_new_with_validation() {
        let config = WasmRuntimeConfig::new(1024, 1000, 1024 * 1024, 2, 10, 10 * 1024 * 1024);
        assert!(config.is_ok());
    }

    #[test]
    fn test_validation_max_memory_pages_zero() {
        let config = WasmRuntimeConfig {
            max_memory_pages: 0,
            max_execution_time_ms: 1000,
            max_stack_size: 1024 * 1024,
            thread_pool_size: 2,
            module_cache_size: 10,
            max_body_size: 10 * 1024 * 1024,
        };
        let result = config.validate();
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("max_memory_pages cannot be 0"));
    }

    #[test]
    fn test_validation_max_memory_pages_too_large() {
        let config = WasmRuntimeConfig {
            max_memory_pages: 65537, // Exceeds 4GB limit
            max_execution_time_ms: 1000,
            max_stack_size: 1024 * 1024,
            thread_pool_size: 2,
            module_cache_size: 10,
            max_body_size: 10 * 1024 * 1024,
        };
        let result = config.validate();
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .contains("max_memory_pages cannot exceed 65536"));
    }

    #[test]
    fn test_validation_max_execution_time_zero() {
        let config = WasmRuntimeConfig {
            max_memory_pages: 1024,
            max_execution_time_ms: 0,
            max_stack_size: 1024 * 1024,
            thread_pool_size: 2,
            module_cache_size: 10,
            max_body_size: 10 * 1024 * 1024,
        };
        let result = config.validate();
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .contains("max_execution_time_ms cannot be 0"));
    }

    #[test]
    fn test_validation_max_execution_time_too_large() {
        let config = WasmRuntimeConfig {
            max_memory_pages: 1024,
            max_execution_time_ms: 300001, // Exceeds 5 minutes
            max_stack_size: 1024 * 1024,
            thread_pool_size: 2,
            module_cache_size: 10,
            max_body_size: 10 * 1024 * 1024,
        };
        let result = config.validate();
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .contains("max_execution_time_ms cannot exceed 300000ms"));
    }

    #[test]
    fn test_validation_max_stack_size_too_small() {
        let config = WasmRuntimeConfig {
            max_memory_pages: 1024,
            max_execution_time_ms: 1000,
            max_stack_size: 32 * 1024, // Less than 64KB
            thread_pool_size: 2,
            module_cache_size: 10,
            max_body_size: 10 * 1024 * 1024,
        };
        let result = config.validate();
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .contains("max_stack_size must be at least 64KB"));
    }

    #[test]
    fn test_validation_max_stack_size_too_large() {
        let config = WasmRuntimeConfig {
            max_memory_pages: 1024,
            max_execution_time_ms: 1000,
            max_stack_size: 17 * 1024 * 1024, // Exceeds 16MB
            thread_pool_size: 2,
            module_cache_size: 10,
            max_body_size: 10 * 1024 * 1024,
        };
        let result = config.validate();
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .contains("max_stack_size cannot exceed 16MB"));
    }

    #[test]
    fn test_validation_thread_pool_size_zero() {
        let config = WasmRuntimeConfig {
            max_memory_pages: 1024,
            max_execution_time_ms: 1000,
            max_stack_size: 1024 * 1024,
            thread_pool_size: 0,
            module_cache_size: 10,
            max_body_size: 10 * 1024 * 1024,
        };
        let result = config.validate();
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("thread_pool_size cannot be 0"));
    }

    #[test]
    fn test_validation_thread_pool_size_too_large() {
        let config = WasmRuntimeConfig {
            max_memory_pages: 1024,
            max_execution_time_ms: 1000,
            max_stack_size: 1024 * 1024,
            thread_pool_size: 129, // Exceeds 128
            module_cache_size: 10,
            max_body_size: 10 * 1024 * 1024,
        };
        let result = config.validate();
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .contains("thread_pool_size cannot exceed 128"));
    }

    #[test]
    fn test_validation_module_cache_size_zero() {
        let config = WasmRuntimeConfig {
            max_memory_pages: 1024,
            max_execution_time_ms: 1000,
            max_stack_size: 1024 * 1024,
            thread_pool_size: 2,
            module_cache_size: 0,
            max_body_size: 10 * 1024 * 1024,
        };
        let result = config.validate();
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .contains("module_cache_size cannot be 0"));
    }

    #[test]
    fn test_validation_module_cache_size_too_large() {
        let config = WasmRuntimeConfig {
            max_memory_pages: 1024,
            max_execution_time_ms: 1000,
            max_stack_size: 1024 * 1024,
            thread_pool_size: 2,
            module_cache_size: 1001, // Exceeds 1000
            max_body_size: 10 * 1024 * 1024,
        };
        let result = config.validate();
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .contains("module_cache_size cannot exceed 1000"));
    }

    #[test]
    fn test_get_total_memory_bytes() {
        let config = WasmRuntimeConfig {
            max_memory_pages: 1024,
            max_execution_time_ms: 1000,
            max_stack_size: 1024 * 1024,
            thread_pool_size: 2,
            module_cache_size: 10,
            max_body_size: 10 * 1024 * 1024,
        };
        // 1024 pages * 64KB = 64MB
        assert_eq!(config.get_total_memory_bytes(), 64 * 1024 * 1024);
    }

    #[test]
    fn test_validation_max_body_size_zero() {
        let config = WasmRuntimeConfig {
            max_memory_pages: 1024,
            max_execution_time_ms: 1000,
            max_stack_size: 1024 * 1024,
            thread_pool_size: 2,
            module_cache_size: 10,
            max_body_size: 0,
        };
        let result = config.validate();
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("max_body_size cannot be 0"));
    }

    #[test]
    fn test_validation_max_body_size_too_large() {
        let config = WasmRuntimeConfig {
            max_memory_pages: 1024,
            max_execution_time_ms: 1000,
            max_stack_size: 1024 * 1024,
            thread_pool_size: 2,
            module_cache_size: 10,
            max_body_size: 101 * 1024 * 1024, // Exceeds 100MB
        };
        let result = config.validate();
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .contains("max_body_size cannot exceed 100MB"));
    }
}