cao-lang 0.2.6

The back-end of cao-lang, a node based visual scripting language
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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
pub mod cao_lang_function;
pub mod cao_lang_object;
pub mod cao_lang_string;
pub mod cao_lang_table;

use std::{alloc::Layout, pin::Pin, ptr::NonNull};

use crate::{
    alloc::{AllocProxy, Allocator, CaoLangAllocator},
    collections::{bounded_stack::BoundedStack, value_stack::ValueStack},
    prelude::*,
    value::Value,
    vm::runtime::cao_lang_object::CaoLangObjectBody,
};
use tracing::debug;

use self::{
    cao_lang_function::{CaoLangClosure, CaoLangFunction, CaoLangNativeFunction, CaoLangUpvalue},
    cao_lang_object::{CaoLangObject, GcMarker, ObjectGcGuard},
    cao_lang_string::CaoLangString,
};

pub struct RuntimeData {
    pub(crate) value_stack: ValueStack,
    pub(crate) call_stack: BoundedStack<CallFrame>,
    pub(crate) global_vars: Vec<Value>,
    pub(crate) memory: AllocProxy,
    pub(crate) object_list: Vec<NonNull<CaoLangObject>>,
    pub(crate) current_program: *const CaoCompiledProgram,
    pub(crate) open_upvalues: *mut CaoLangObject,
}

impl Drop for RuntimeData {
    fn drop(&mut self) {
        self.clear();
    }
}

pub(crate) struct CallFrame {
    /// Store src addresses of Function calls
    pub src_instr_ptr: u32,
    /// Store return addresses of Function calls
    pub dst_instr_ptr: u32,
    /// beginning of the local stack
    pub stack_offset: u32,
    pub closure: *mut CaoLangClosure,
}

impl RuntimeData {
    pub fn new(
        memory_limit: usize,
        stack_size: usize,
        call_stack_size: usize,
    ) -> Result<Pin<Box<Self>>, ExecutionErrorPayload> {
        // we have a chicken-egg problem if we want to store the allocator in this structure
        let allocator = CaoLangAllocator::new(std::ptr::null_mut(), memory_limit);
        let memory: AllocProxy = allocator.into();
        let mut res = Box::pin(Self {
            value_stack: ValueStack::new(stack_size),
            call_stack: BoundedStack::new(call_stack_size),
            global_vars: Vec::with_capacity(16),
            object_list: Vec::with_capacity(16),
            memory,
            current_program: std::ptr::null(),
            open_upvalues: std::ptr::null_mut(),
        });
        unsafe {
            let reference: &mut Self = Pin::get_mut(res.as_mut());
            res.memory.get_inner().runtime = reference as *mut Self;
        }
        Ok(res)
    }

    /// Initialize a new cao-lang table and return a pointer to it
    pub fn init_table(&mut self) -> Result<ObjectGcGuard, ExecutionErrorPayload> {
        unsafe {
            let obj_ptr = self
                .memory
                .alloc(Layout::new::<CaoLangObject>())
                .map_err(|err| {
                    debug!("Failed to allocate table {:?}", err);
                    ExecutionErrorPayload::OutOfMemory
                })?;
            let table = CaoLangTable::with_capacity(8, self.memory.clone()).map_err(|err| {
                debug!("Failed to init table {:?}", err);
                ExecutionErrorPayload::OutOfMemory
            })?;

            let obj_ptr: NonNull<CaoLangObject> = obj_ptr.cast();
            let obj = CaoLangObject {
                marker: GcMarker::White,
                body: CaoLangObjectBody::Table(table),
            };
            std::ptr::write(obj_ptr.as_ptr(), obj);
            self.object_list.push(obj_ptr);
            Ok(ObjectGcGuard::new(obj_ptr))
        }
    }

    pub fn init_native_function(
        &mut self,
        handle: Handle,
    ) -> Result<ObjectGcGuard, ExecutionErrorPayload> {
        unsafe {
            let obj_ptr = self
                .memory
                .alloc(Layout::new::<CaoLangObject>())
                .map_err(|err| {
                    debug!("Failed to allocate NativeFunction {:?}", err);
                    ExecutionErrorPayload::OutOfMemory
                })?;

            let obj_ptr: NonNull<CaoLangObject> = obj_ptr.cast();
            let obj = CaoLangObject {
                marker: GcMarker::White,
                body: CaoLangObjectBody::NativeFunction(CaoLangNativeFunction { handle }),
            };
            std::ptr::write(obj_ptr.as_ptr(), obj);
            self.object_list.push(obj_ptr);

            Ok(ObjectGcGuard::new(obj_ptr))
        }
    }

    pub fn init_function(
        &mut self,
        handle: Handle,
        arity: u32,
    ) -> Result<ObjectGcGuard, ExecutionErrorPayload> {
        unsafe {
            let obj_ptr = self
                .memory
                .alloc(Layout::new::<CaoLangObject>())
                .map_err(|err| {
                    debug!("Failed to allocate table {:?}", err);
                    ExecutionErrorPayload::OutOfMemory
                })?;

            let obj_ptr: NonNull<CaoLangObject> = obj_ptr.cast();
            let obj = CaoLangObject {
                marker: GcMarker::White,
                body: CaoLangObjectBody::Function(CaoLangFunction { handle, arity }),
            };
            std::ptr::write(obj_ptr.as_ptr(), obj);
            self.object_list.push(obj_ptr);

            Ok(ObjectGcGuard::new(obj_ptr))
        }
    }

    pub fn init_closure(
        &mut self,
        handle: Handle,
        arity: u32,
    ) -> Result<ObjectGcGuard, ExecutionErrorPayload> {
        unsafe {
            let obj_ptr = self
                .memory
                .alloc(Layout::new::<CaoLangObject>())
                .map_err(|err| {
                    debug!("Failed to allocate table {:?}", err);
                    ExecutionErrorPayload::OutOfMemory
                })?;

            let obj_ptr: NonNull<CaoLangObject> = obj_ptr.cast();
            let obj = CaoLangObject {
                marker: GcMarker::White,
                body: CaoLangObjectBody::Closure(CaoLangClosure {
                    function: CaoLangFunction { handle, arity },
                    upvalues: vec![],
                }),
            };
            std::ptr::write(obj_ptr.as_ptr(), obj);
            self.object_list.push(obj_ptr);

            Ok(ObjectGcGuard::new(obj_ptr))
        }
    }

    pub fn init_upvalue(
        &mut self,
        location: *mut Value,
    ) -> Result<ObjectGcGuard, ExecutionErrorPayload> {
        unsafe {
            let obj_ptr = self
                .memory
                .alloc(Layout::new::<CaoLangObject>())
                .map_err(|err| {
                    debug!("Failed to allocate table {:?}", err);
                    ExecutionErrorPayload::OutOfMemory
                })?;

            let obj_ptr: NonNull<CaoLangObject> = obj_ptr.cast();
            let obj = CaoLangObject {
                marker: GcMarker::White,
                body: CaoLangObjectBody::Upvalue(CaoLangUpvalue {
                    location,
                    value: Value::Nil,
                    next: std::ptr::null_mut(),
                }),
            };
            std::ptr::write(obj_ptr.as_ptr(), obj);
            self.object_list.push(obj_ptr);

            Ok(ObjectGcGuard::new(obj_ptr))
        }
    }

    pub fn init_string(&mut self, payload: &str) -> Result<ObjectGcGuard, ExecutionErrorPayload> {
        unsafe {
            let obj_ptr = self
                .memory
                .alloc(Layout::new::<CaoLangObject>())
                .map_err(|err| {
                    debug!("Failed to allocate table {:?}", err);
                    ExecutionErrorPayload::OutOfMemory
                })?;

            let layout = CaoLangString::layout(payload.len());
            let mut ptr = self
                .memory
                .alloc(layout)
                .map_err(|_| ExecutionErrorPayload::OutOfMemory)?;

            let result: *mut u8 = ptr.as_mut();
            std::ptr::copy(payload.as_ptr(), result, payload.len());

            let obj_ptr: NonNull<CaoLangObject> = obj_ptr.cast();
            let obj = CaoLangObject {
                marker: GcMarker::White,
                body: CaoLangObjectBody::String(CaoLangString {
                    len: payload.len(),
                    ptr,
                    alloc: self.memory.clone(),
                }),
            };
            std::ptr::write(obj_ptr.as_ptr(), obj);
            self.object_list.push(obj_ptr);

            Ok(ObjectGcGuard::new(obj_ptr))
        }
    }

    pub fn free_object(&mut self, obj: NonNull<CaoLangObject>) {
        unsafe {
            std::ptr::drop_in_place(obj.as_ptr());
            self.memory
                .dealloc(obj.cast(), Layout::new::<CaoLangObject>());
        }
    }

    pub fn clear(&mut self) {
        self.clear_objects();
        self.value_stack.clear();
        self.global_vars.clear();
        self.call_stack.clear();
        self.open_upvalues = std::ptr::null_mut();
    }

    fn clear_objects(&mut self) {
        for obj_ptr in std::mem::take(&mut self.object_list).into_iter() {
            self.free_object(obj_ptr);
        }
    }

    pub fn set_memory_limit(&mut self, capacity: usize) {
        self.clear();
        unsafe {
            self.memory
                .get_inner()
                .limit
                .store(capacity, std::sync::atomic::Ordering::Relaxed);
        }
    }

    /// Types implementing Drop are not supported, thus the `Copy` bound
    pub fn write_to_memory<T: Sized + Copy>(
        &mut self,
        val: T,
    ) -> Result<*mut T, ExecutionErrorPayload> {
        let l = std::alloc::Layout::new::<T>();
        unsafe {
            let ptr = self
                .memory
                .alloc(l)
                .map_err(|_| ExecutionErrorPayload::OutOfMemory)?;

            std::ptr::write(ptr.as_ptr() as *mut T, val);
            Ok(ptr.as_ptr() as *mut T)
        }
    }

    pub fn gc(&mut self) {
        debug!("• GC");
        // mark all roots for collection
        let mut progress_tracker = Vec::with_capacity(self.value_stack.len());
        for val in self.value_stack.iter() {
            if let Value::Object(mut t) = val {
                unsafe {
                    let t = t.as_mut();
                    t.marker = GcMarker::Gray;
                    progress_tracker.push(t);
                }
            }
        }
        // mark globals
        for val in self.global_vars.iter() {
            if let Value::Object(mut t) = val {
                unsafe {
                    let t = t.as_mut();
                    t.marker = GcMarker::Gray;
                    progress_tracker.push(t);
                }
            }
        }

        macro_rules! checked_enqueue_value {
            ($val: ident) => {
                if let Value::Object(mut value) = $val {
                    let t = value.as_mut();
                    if matches!(t.marker, GcMarker::White) {
                        t.marker = GcMarker::Gray;
                        progress_tracker.push(t);
                    }
                }
            };
        }

        // mark referenced objects for collection
        while let Some(obj) = progress_tracker.pop() {
            obj.marker = GcMarker::Black;
            match &mut obj.body {
                CaoLangObjectBody::Table(obj) => {
                    for (key, value) in obj.iter() {
                        unsafe {
                            checked_enqueue_value!(key);
                            checked_enqueue_value!(value);
                        }
                    }
                }
                CaoLangObjectBody::Closure(c) => {
                    for upvalue in &mut c.upvalues {
                        unsafe {
                            let t = upvalue.as_mut();
                            if matches!(t.marker, GcMarker::White) {
                                t.marker = GcMarker::Gray;
                                progress_tracker.push(t);
                            }
                        }
                    }
                }
                CaoLangObjectBody::String(_) => {
                    // strings don't have children
                }
                CaoLangObjectBody::Function(_) => {
                    // function objects don't have children
                }
                CaoLangObjectBody::NativeFunction(_) => {
                    // native function objects don't have children
                }
                CaoLangObjectBody::Upvalue(u) => unsafe {
                    if let Some(t) = u.location.as_mut() {
                        checked_enqueue_value!(t);
                    }
                },
            }
        }
        // sweep
        //
        let mut collected = Vec::with_capacity(self.object_list.len());
        for (i, object) in self.object_list.iter().copied().enumerate() {
            unsafe {
                let obj = object.as_ref();
                if matches!(obj.marker, GcMarker::White) {
                    collected.push(i);
                }
            }
        }
        for i in collected.into_iter().rev() {
            let obj = self.object_list.swap_remove(i);
            self.free_object(obj);
        }
        // unmark remaning objects
        for table in self.object_list.iter_mut() {
            unsafe {
                let table = table.as_mut();
                if !matches!(table.marker, GcMarker::Protected) {
                    table.marker = GcMarker::White;
                }
            }
        }
        debug!("✓ GC");
    }

    pub fn capture_upvalue() {}
}

#[cfg(test)]
mod tests {
    use std::ops::DerefMut;

    use super::*;

    #[test]
    fn field_table_can_be_queried_by_str_test() {
        let mut vm = Vm::new(()).unwrap();

        let s = vm.init_string("poggers").unwrap();
        let mut o = vm.init_table().unwrap();
        let o = o.deref_mut().as_table_mut().unwrap();

        o.insert(Value::Object(s.into_inner()), Value::Integer(42))
            .unwrap();

        let res = o.get("poggers").unwrap();

        assert_eq!(res, &Value::Integer(42));
    }
}