luau-vm 0.732.0

Pure-Rust Luau virtual machine, garbage collector, and standard libraries
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
use core::mem::MaybeUninit;
use core::ptr::{self, NonNull};

use luau_common::{ByteSlice, flags};

use super::stack::RawStackAccess;
use super::{LUA_GLOBALS_INDEX, LUA_NOREF, LUA_REFNIL, LUA_REGISTRY_INDEX, Thread};
use crate::debug::DebugRuntime;
use crate::gc::{GcBarrier, GcRuntime};
use crate::handle::RawHandle;
use crate::native::{NativeFunction, NativeModule};
use crate::state::ThreadState;
use crate::string::StringRuntime;
use crate::table::TableRuntime;
use crate::types::{LUA_TFUNCTION, LUA_TNIL, LUA_TOBJECT, LUA_TTABLE, LUA_TTHREAD, LUA_TUSERDATA};
use crate::value::{RAW_TVALUE_NIL, TValue};
use crate::vm::VmOperations;
use crate::{VmErrorResult, VmResult};

// Table stack API
impl Thread {
    /// `lua_createtable`
    pub unsafe fn create_table(&self, array_size: usize, record_size: usize) -> VmErrorResult {
        let (Ok(array_size), Ok(record_size)) =
            (i32::try_from(array_size), i32::try_from(record_size))
        else {
            return unsafe { crate::run_error!(self, "table overflow") };
        };

        unsafe {
            self.check_gc()?;
            self.thread_barrier();
            self.ensure_stack(self, 1)?;

            let table = self.new_table_internal(array_size, record_size)?;
            let top = self.stack_top();
            top.value_unchecked().set_table_value(table);
            debug_assert!(top < self.current_call_info().top());
            self.set_stack_top(top.add(1));
        }
        Ok(())
    }

    /// `lua_newtable`
    pub unsafe fn new_table(&self) -> VmErrorResult {
        unsafe { self.create_table(0, 0) }
    }

    /// `lua_gettable`
    pub unsafe fn get_table(&self, index: i32) -> VmResult<i32> {
        unsafe {
            let top = self.stack_top().sub(1);
            debug_assert!(top >= self.stack_base());

            self.thread_barrier();

            let table = self.to_object(index).unwrap_unchecked();
            self.get_table_internal(table, top.value_unchecked(), top)?;
            Ok(self.stack_top().sub(1).value_unchecked().tt())
        }
    }

    /// `lua_getfield`
    pub unsafe fn get_field(&self, index: i32, key: impl AsRef<[u8]>) -> VmResult<i32> {
        let key = key.as_ref();
        let mut key_storage = RAW_TVALUE_NIL;
        unsafe {
            self.thread_barrier();
            self.ensure_stack(self, 1)?;

            let table = self.to_object(index).unwrap_unchecked();
            let mut table_storage = MaybeUninit::uninit();
            ptr::copy_nonoverlapping(table.as_ptr(), table_storage.as_mut_ptr(), 1);
            let table = TValue::from_raw(NonNull::new_unchecked(table_storage.as_mut_ptr()));
            let key_value = TValue::from_mut(&mut key_storage);
            key_value.set_string_value(self.intern_string(key.as_bstr())?);
            let top = self.stack_top();
            self.get_table_internal(table, key_value, top)?;
            let top = self.stack_top();
            debug_assert!(top < self.current_call_info().top());
            self.set_stack_top(top.add(1));
            Ok(top.value_unchecked().tt())
        }
    }

    /// `lua_getglobal`
    pub unsafe fn get_global(&self, name: impl AsRef<[u8]>) -> VmResult<i32> {
        unsafe { self.get_field(LUA_GLOBALS_INDEX, name) }
    }

    /// `lua_rawgetfield`
    pub unsafe fn raw_get_field(&self, index: i32, key: impl AsRef<[u8]>) -> VmErrorResult<i32> {
        let key = key.as_ref();
        unsafe {
            self.thread_barrier();
            self.ensure_stack(self, 1)?;

            let object = self.to_object(index).unwrap_unchecked();
            debug_assert!(object.is_table());
            let table = object.table_value();
            let string = self.intern_string(key.as_bstr())?;
            let top = self.stack_top();
            top.value_unchecked().set_obj(table.get_str(string));
            debug_assert!(top < self.current_call_info().top());
            self.set_stack_top(top.add(1));
            Ok(top.value_unchecked().tt())
        }
    }

    /// `lua_rawget`
    pub unsafe fn raw_get(&self, index: i32) -> i32 {
        unsafe {
            self.thread_barrier();

            let table = self.to_object(index).unwrap_unchecked();
            debug_assert!(table.is_table());

            let top = self.stack_top().sub(1);
            top.value_unchecked()
                .set_obj(table.table_value().get(top.value_unchecked()));
            top.value_unchecked().tt()
        }
    }

    /// `lua_rawgeti`
    pub unsafe fn raw_geti(&self, index: i32, key: i32) -> VmErrorResult<i32> {
        unsafe {
            self.thread_barrier();
            self.ensure_stack(self, 1)?;

            let table = self.to_object(index).unwrap_unchecked();
            debug_assert!(table.is_table());

            let top = self.stack_top();
            top.value_unchecked()
                .set_obj(table.table_value().get_num(key));
            debug_assert!(top < self.current_call_info().top());
            self.set_stack_top(top.add(1));
            Ok(top.value_unchecked().tt())
        }
    }

    /// `lua_rawgetptagged`
    pub unsafe fn raw_getp_tagged(&self, index: i32, key: *mut (), tag: i32) -> VmErrorResult<i32> {
        unsafe {
            self.thread_barrier();
            self.ensure_stack(self, 1)?;

            let table = self.to_object(index).unwrap_unchecked();
            debug_assert!(table.is_table());

            let top = self.stack_top();
            top.value_unchecked()
                .set_obj(table.table_value().getp(key, tag));
            debug_assert!(top < self.current_call_info().top());
            self.set_stack_top(top.add(1));
            Ok(top.value_unchecked().tt())
        }
    }

    /// `lua_rawgetp`
    pub unsafe fn raw_getp(&self, index: i32, key: *mut ()) -> VmErrorResult<i32> {
        unsafe { self.raw_getp_tagged(index, key, 0) }
    }

    /// `lua_setreadonly`
    pub unsafe fn set_readonly(&self, index: i32, enabled: i32) {
        unsafe {
            let object = self.to_object(index).unwrap_unchecked();
            debug_assert!(object.is_table());

            let table = object.table_value();
            let registry = self.global().registry().table_value();
            debug_assert!(table != registry);
            table.as_ptr().as_mut().unwrap_unchecked().readonly = u8::from(enabled != 0);
        }
    }

    /// `lua_getreadonly`
    pub unsafe fn get_readonly(&self, index: i32) -> i32 {
        unsafe {
            let object = self.to_object(index).unwrap_unchecked();
            debug_assert!(object.is_table());
            i32::from(
                object
                    .table_value()
                    .as_ptr()
                    .as_ref()
                    .unwrap_unchecked()
                    .readonly
                    != 0,
            )
        }
    }

    /// `lua_setsafeenv`
    pub unsafe fn set_safe_env(&self, index: i32, enabled: i32) {
        let object = unsafe { self.to_object(index).unwrap_unchecked() };
        debug_assert!(object.is_table());

        unsafe {
            object
                .table_value()
                .as_ptr()
                .as_mut()
                .unwrap_unchecked()
                .safe_env = u8::from(enabled != 0);
        }
    }

    /// `lua_getmetatable`
    pub unsafe fn get_metatable(&self, index: i32) -> VmErrorResult<i32> {
        unsafe {
            self.thread_barrier();
            self.ensure_stack(self, 1)?;

            let object = self.to_object(index);
            let metatable = if let Some(object) = object {
                match object.tt() {
                    x if x == LUA_TTABLE => object.table_value().metatable(),
                    x if x == LUA_TUSERDATA => object.userdata_value().metatable(),
                    x if x == LUA_TOBJECT => object.object_value().class().instance_metatable(),
                    tag => self.global().metatable(tag as usize),
                }
            } else {
                None
            };

            if let Some(metatable) = metatable {
                let top = self.stack_top();
                top.value_unchecked().set_table_value(metatable);
                debug_assert!(top < self.current_call_info().top());
                self.set_stack_top(top.add(1));
                Ok(1)
            } else {
                Ok(0)
            }
        }
    }

    /// `lua_getfenv`
    pub unsafe fn get_fenv(&self, index: i32) -> VmErrorResult {
        unsafe {
            self.thread_barrier();
            self.ensure_stack(self, 1)?;

            let object = self.to_object(index).unwrap_unchecked();
            let top = self.stack_top();
            match object.tt() {
                x if x == LUA_TFUNCTION => top
                    .value_unchecked()
                    .set_table_value(object.closure_value().env()),
                x if x == LUA_TTHREAD => top
                    .value_unchecked()
                    .set_table_value(object.thread_value().globals()),
                _ => top.value_unchecked().set_nil(),
            }

            debug_assert!(top < self.current_call_info().top());
            self.set_stack_top(top.add(1));
        }
        Ok(())
    }

    /// `lua_settable`
    pub unsafe fn set_table(&self, index: i32) -> VmResult {
        unsafe {
            let top = self.stack_top();
            debug_assert!(top.offset_from(self.stack_base()) >= 2);

            let table = self.to_object(index).unwrap_unchecked();
            let key = top.sub(2).value_unchecked();
            let value = top.sub(1).value_unchecked();
            self.set_table_internal(table, key, value)?;
            self.set_stack_top(self.stack_top().sub(2));
        }
        Ok(())
    }

    /// `lua_setfield`
    pub unsafe fn set_field(&self, index: i32, key: impl AsRef<[u8]>) -> VmResult {
        let key = key.as_ref();
        let mut key_storage = RAW_TVALUE_NIL;
        unsafe {
            let top = self.stack_top();
            debug_assert!(top.offset_from(self.stack_base()) > 0);

            let table = self.to_object(index).unwrap_unchecked();
            let mut table_storage = MaybeUninit::uninit();
            ptr::copy_nonoverlapping(table.as_ptr(), table_storage.as_mut_ptr(), 1);
            let table = TValue::from_raw(NonNull::new_unchecked(table_storage.as_mut_ptr()));
            let key_value = TValue::from_mut(&mut key_storage);
            key_value.set_string_value(self.intern_string(key.as_bstr())?);
            let value = top.sub(1).value_unchecked();

            self.set_table_internal(table, key_value, value)?;
            self.set_stack_top(self.stack_top().sub(1));
        }
        Ok(())
    }

    /// `lua_rawsetfield`
    pub unsafe fn raw_set_field(&self, index: i32, key: impl AsRef<[u8]>) -> VmErrorResult {
        let key = key.as_ref();
        unsafe {
            let top = self.stack_top();
            debug_assert!(top.offset_from(self.stack_base()) > 0);

            let object = self.to_object(index).unwrap_unchecked();
            debug_assert!(object.is_table());
            let table = object.table_value();
            let value = top.sub(1).value_unchecked();

            if table.as_ptr().as_ref().unwrap_unchecked().readonly != 0 {
                return self.readonly_error();
            }

            let string = self.intern_string(key.as_bstr())?;
            let node_cursor = self.set_str(table, string)?;
            node_cursor
                .node_unchecked()
                .value_unchecked()
                .set_obj(value);
            if value.is_collectable() {
                self.barrier_table(table, value.gc_value());
            }

            self.set_stack_top(top.sub(1));
        }
        Ok(())
    }

    /// `lua_setglobal`
    pub unsafe fn set_global(&self, name: impl AsRef<[u8]>) -> VmErrorResult {
        unsafe { self.raw_set_field(LUA_GLOBALS_INDEX, name) }
    }

    /// `lua_concat`
    pub unsafe fn concat(&self, count: i32) -> VmResult {
        debug_assert!(count >= 0);

        if count >= 2 {
            unsafe {
                self.check_gc()?;
                self.thread_barrier();
                self.concat_internal(count, self.get_top() - 1)?;
                self.set_stack_top(self.stack_top().sub((count - 1) as usize));
            }
        } else if count == 0 {
            unsafe {
                self.thread_barrier();
                self.ensure_stack(self, 1)?;
                self.push_string("")?;
            }
        }
        Ok(())
    }

    /// `lua_rawset`
    pub unsafe fn raw_set(&self, index: i32) -> VmErrorResult {
        unsafe {
            let top = self.stack_top();
            debug_assert!(top.offset_from(self.stack_base()) >= 2);

            let object = self.to_object(index).unwrap_unchecked();
            debug_assert!(object.is_table());
            let table = object.table_value();
            let key = top.sub(2).value_unchecked();
            let value = top.sub(1).value_unchecked();

            if table.as_ptr().as_ref().unwrap_unchecked().readonly != 0 {
                return self.readonly_error();
            }

            let slot = self.set(table, key)?;
            slot.set_obj(value);
            if value.is_collectable() {
                self.barrier_table(table, value.gc_value());
            }

            self.set_stack_top(top.sub(2));
        }
        Ok(())
    }

    /// `lua_rawseti`
    pub unsafe fn raw_seti(&self, index: i32, key: i32) -> VmErrorResult {
        unsafe {
            let top = self.stack_top();
            debug_assert!(top.offset_from(self.stack_base()) > 0);

            let object = self.to_object(index).unwrap_unchecked();
            debug_assert!(object.is_table());
            let table = object.table_value();
            let value = top.sub(1).value_unchecked();

            if table.as_ptr().as_ref().unwrap_unchecked().readonly != 0 {
                return self.readonly_error();
            }

            let slot = self.set_num(table, key)?;
            slot.set_obj(value);
            if value.is_collectable() {
                self.barrier_table(table, value.gc_value());
            }

            self.set_stack_top(top.sub(1));
        }
        Ok(())
    }

    /// `lua_rawsetptagged`
    pub unsafe fn raw_setp_tagged(&self, index: i32, key: *mut (), tag: i32) -> VmErrorResult {
        unsafe {
            let top = self.stack_top();
            debug_assert!(top.offset_from(self.stack_base()) > 0);

            let object = self.to_object(index).unwrap_unchecked();
            debug_assert!(object.is_table());
            let table = object.table_value();
            let value = top.sub(1).value_unchecked();

            if table.as_ptr().as_ref().unwrap_unchecked().readonly != 0 {
                return self.readonly_error();
            }

            let slot = self.setp(table, key, tag)?;
            slot.set_obj(value);
            if value.is_collectable() {
                self.barrier_table(table, value.gc_value());
            }

            self.set_stack_top(top.sub(1));
        }
        Ok(())
    }

    /// `lua_rawsetp`
    pub unsafe fn raw_setp(&self, index: i32, key: *mut ()) -> VmErrorResult {
        unsafe { self.raw_setp_tagged(index, key, 0) }
    }

    /// `lua_setmetatable`
    pub unsafe fn set_metatable(&self, index: i32) -> VmErrorResult<i32> {
        unsafe {
            let top = self.stack_top();
            debug_assert!(top.offset_from(self.stack_base()) > 0);

            let object = self.to_object(index).unwrap_unchecked();
            let metatable_value = top.sub(1).value_unchecked();

            let metatable = if metatable_value.is_nil() {
                None
            } else {
                debug_assert!(metatable_value.is_table());
                Some(metatable_value.table_value())
            };

            match object.tt() {
                x if x == LUA_TTABLE => {
                    let table = object.table_value();
                    if table.as_ptr().as_ref().unwrap_unchecked().readonly != 0 {
                        return self.readonly_error();
                    }

                    table.set_metatable(metatable);
                    if let Some(metatable) = metatable {
                        self.object_barrier(table.into(), metatable.into());
                    }
                }
                x if x == LUA_TUSERDATA => {
                    let userdata = object.userdata_value();
                    userdata.set_metatable(metatable);
                    if let Some(metatable) = metatable {
                        self.object_barrier(userdata.into(), metatable.into());
                    }
                }
                tag => {
                    self.global().as_ptr().as_mut().unwrap_unchecked().mt[tag as usize] =
                        metatable.map_or(ptr::null_mut(), |table| table.as_ptr());
                }
            }

            self.set_stack_top(top.sub(1));
            Ok(1)
        }
    }

    /// `lua_setfenv`
    pub unsafe fn set_fenv(&self, index: i32) -> i32 {
        unsafe {
            let top = self.stack_top();
            debug_assert!(top.offset_from(self.stack_base()) > 0);
            let object = self.to_object(index).unwrap_unchecked();
            let environment = top.sub(1).value_unchecked();
            debug_assert!(environment.is_table());

            let environment = environment.table_value();
            let result = match object.tt() {
                x if x == LUA_TFUNCTION => {
                    let closure = object.closure_value();
                    closure.set_env(environment);
                    self.object_barrier(closure.into(), environment.into());
                    1
                }
                x if x == LUA_TTHREAD => {
                    let thread = object.thread_value();
                    thread.set_globals(environment);
                    self.object_barrier((&thread).into(), environment.into());
                    1
                }
                _ => 0,
            };

            self.set_stack_top(top.sub(1));
            result
        }
    }

    /// `lua_next`
    pub unsafe fn next(&self, index: i32) -> VmErrorResult<i32> {
        unsafe {
            let top = self.stack_top();
            debug_assert!(top.offset_from(self.stack_base()) > 0);
            self.thread_barrier();
            self.ensure_stack(self, 1)?;

            let table = self.to_object(index).unwrap_unchecked();
            debug_assert!(table.is_table());
            let key = top.sub(1);

            let more = self.next_internal(table.table_value(), key)?;
            if more != 0 {
                debug_assert!(top < self.current_call_info().top());
                self.set_stack_top(top.add(1));
            } else {
                self.set_stack_top(top.sub(1));
            }

            Ok(more)
        }
    }

    /// `lua_rawiter`
    pub unsafe fn raw_iter(&self, index: i32, mut iter: i32) -> VmErrorResult<i32> {
        unsafe {
            self.thread_barrier();
            self.ensure_stack(self, 2)?;

            let table = self.to_object(index).unwrap_unchecked();
            debug_assert!(table.is_table());
            debug_assert!(iter >= 0);

            let table = table.table_value();
            let size_array = table.as_ptr().as_ref().unwrap_unchecked().size_array;

            while (iter as u32) < size_array as u32 {
                let entry = table.array_slot(iter as usize);
                if !entry.is_nil() {
                    let top = self.stack_top();
                    top.value_unchecked().set_number((iter + 1) as f64);
                    top.add(1).value_unchecked().set_obj(entry);
                    debug_assert!(top.add(2) <= self.current_call_info().top());
                    self.set_stack_top(top.add(2));
                    return Ok(iter + 1);
                }
                iter += 1;
            }

            let size_node = table.node_count();
            while ((iter - size_array) as u32) < size_node as u32 {
                let node = table.node(iter - size_array);
                if !node.value_unchecked().is_nil() {
                    let top = self.stack_top();
                    node.write_key_to_value(top.value_unchecked());
                    top.add(1).value_unchecked().set_obj(node.value_unchecked());
                    debug_assert!(top.add(2) <= self.current_call_info().top());
                    self.set_stack_top(top.add(2));
                    return Ok(iter + 1);
                }
                iter += 1;
            }

            Ok(-1)
        }
    }

    /// `lua_cleartable`
    pub unsafe fn clear_table(&self, index: i32) -> VmErrorResult {
        unsafe {
            let object = self.to_object(index).unwrap_unchecked();
            debug_assert!(object.is_table());

            let table = object.table_value();
            if table.as_ptr().as_ref().unwrap_unchecked().readonly != 0 {
                return self.readonly_error();
            }

            table.clear();
        }
        Ok(())
    }

    /// `lua_clonetable`
    pub unsafe fn clone_table(&self, index: i32) -> VmErrorResult {
        unsafe {
            if flags::LuauCloneTableFix.get() {
                self.check_gc()?;
                self.thread_barrier();
            }
            self.ensure_stack(self, 1)?;

            let object = self.to_object(index).unwrap_unchecked();
            debug_assert!(object.is_table());

            let cloned = self.clone_table_internal(object.table_value())?;
            let top = self.stack_top();
            top.value_unchecked().set_table_value(cloned);
            debug_assert!(top < self.current_call_info().top());
            self.set_stack_top(top.add(1));
        }
        Ok(())
    }
}

// Registry references
impl Thread {
    unsafe fn ref_in_registry(
        &self,
        index: i32,
        registry: crate::Table,
        registry_free: i32,
    ) -> VmErrorResult<(i32, i32)> {
        let Some(object) = (unsafe { self.to_object(index) }) else {
            return Ok((LUA_REFNIL, registry_free));
        };
        if object.is_nil() {
            return Ok((LUA_REFNIL, registry_free));
        }

        unsafe {
            let reference = if registry_free != 0 {
                registry_free
            } else {
                registry.getn() + 1
            };

            let slot = self.set_num(registry, reference)?;
            let next_free = if registry_free != 0 {
                slot.number_value() as i32
            } else {
                registry_free
            };

            slot.set_obj(object);
            if object.is_collectable() {
                self.barrier_table(registry, object.gc_value());
            }

            Ok((reference, next_free))
        }
    }

    unsafe fn unref_in_registry(
        &self,
        reference: i32,
        registry: crate::Table,
        registry_free: i32,
    ) -> i32 {
        if reference <= LUA_REFNIL {
            return registry_free;
        }

        unsafe {
            let slot = registry.get_num(reference);
            debug_assert!(slot != crate::value::nil_object());
            slot.set_number(registry_free as f64);
        }

        reference
    }

    /// `lua_getref`
    pub unsafe fn get_ref(&self, reference: i32) -> VmErrorResult<i32> {
        unsafe { self.raw_geti(LUA_REGISTRY_INDEX, reference) }
    }

    /// `lua_ref`
    pub unsafe fn ref_value(&self, index: i32) -> VmErrorResult<i32> {
        debug_assert!(index != LUA_REGISTRY_INDEX);
        unsafe {
            let global = self.global();
            let (reference, registry_free) = self.ref_in_registry(
                index,
                global.registry().table_value(),
                global.registry_free(),
            )?;
            global.set_registry_free(registry_free);
            Ok(reference)
        }
    }

    /// `lua_unref`
    pub unsafe fn unref_value(&self, reference: i32) -> i32 {
        unsafe {
            let global = self.global();
            let registry_free = self.unref_in_registry(
                reference,
                global.registry().table_value(),
                global.registry_free(),
            );
            global.set_registry_free(registry_free);
        }

        LUA_NOREF
    }

    /// `lua_weakref`
    pub unsafe fn weak_ref_value(&self, index: i32) -> VmErrorResult<i32> {
        debug_assert!(flags::LuauGcTraceUdata.get());

        unsafe {
            let global = self.global();
            let (reference, registry_free) = self.ref_in_registry(
                index,
                global.weak_registry().table_value(),
                global.weak_registry_free(),
            )?;
            global.set_weak_registry_free(registry_free);
            Ok(reference)
        }
    }

    /// `lua_weakunref`
    pub unsafe fn weak_unref_value(&self, reference: i32) -> i32 {
        debug_assert!(flags::LuauGcTraceUdata.get());

        unsafe {
            let global = self.global();
            let registry_free = self.unref_in_registry(
                reference,
                global.weak_registry().table_value(),
                global.weak_registry_free(),
            );
            global.set_weak_registry_free(registry_free);
        }

        LUA_NOREF
    }

    /// `lua_getweakref`
    pub unsafe fn get_weak_ref(&self, reference: i32) -> VmErrorResult<i32> {
        debug_assert!(flags::LuauGcTraceUdata.get());

        unsafe {
            self.thread_barrier();
            self.ensure_stack(self, 1)?;

            let global = self.global();
            let registry = global.weak_registry().table_value();
            let top = self.stack_top();
            top.value_unchecked().set_obj(registry.get_num(reference));
            self.set_stack_top(top.add(1));
            Ok(top.value_unchecked().tt())
        }
    }
}

// Metatables and module registration
impl Thread {
    /// `luaL_getmetafield`
    pub unsafe fn get_metafield(&self, index: i32, event: &str) -> VmErrorResult<i32> {
        unsafe {
            if self.get_metatable(index)? == 0 {
                return Ok(0);
            }

            self.push_optional_string(Some(event))?;
            let result = self.raw_get(-2);
            if result == LUA_TNIL {
                self.pop(2);
                Ok(0)
            } else {
                self.remove(-2);
                Ok(1)
            }
        }
    }

    /// `luaL_callmeta`
    pub unsafe fn call_meta(&self, object: i32, event: &str) -> VmResult<i32> {
        unsafe {
            let object = self.abs_index(object);
            if self.get_metafield(object, event)? == 0 {
                return Ok(0);
            }

            self.push_value(object)?;
            self.call(1, 1)?;
            Ok(1)
        }
    }

    /// `luaL_newmetatable`
    pub unsafe fn new_metatable(&self, table_name: &str) -> VmErrorResult<i32> {
        let result = unsafe { self.raw_get_field(LUA_REGISTRY_INDEX, table_name)? };
        if result != LUA_TNIL {
            return Ok(0);
        }

        unsafe {
            self.pop(1);
            self.create_table(0, 0)?;
            self.push_value(-1)?;

            let registry = self.global().registry().table_value();
            let key = self.intern_string(table_name.as_bytes().as_bstr())?;
            let node_cursor = self.set_str(registry, key)?;
            let value = self.stack_top().sub(1);
            node_cursor
                .node_unchecked()
                .value_unchecked()
                .set_obj(value.value_unchecked());
            self.barrier_value(registry.into(), value.value_unchecked());
            self.pop(1);
        }

        Ok(1)
    }

    /// `luaL_findtable`
    pub unsafe fn find_table<'a, T>(
        &self,
        index: i32,
        name: &'a T,
        size_hint: usize,
    ) -> VmErrorResult<Option<&'a [u8]>>
    where
        T: AsRef<[u8]> + ?Sized,
    {
        let mut remainder = name.as_ref();
        unsafe {
            self.push_value(index)?;

            loop {
                let separator = remainder.iter().position(|byte| *byte == b'.');
                let (field, rest, has_more) = match separator {
                    Some(pos) => (&remainder[..pos], &remainder[pos + 1..], true),
                    None => (remainder, &[][..], false),
                };

                self.push_string(field)?;
                let result = self.raw_get(-2);
                if result == LUA_TNIL {
                    self.pop(1);
                    self.create_table(0, if has_more { 1 } else { size_hint })?;
                    self.push_string(field)?;
                    self.push_value(-2)?;
                    self.raw_set(-4)?;
                } else if result != LUA_TTABLE {
                    self.pop(2);
                    return Ok(Some(remainder));
                }

                self.remove(-2);
                if !has_more {
                    return Ok(None);
                }

                remainder = rest;
            }
        }
    }

    /// `luaL_register`
    pub unsafe fn register(
        &self,
        library_name: Option<&str>,
        functions: &[NativeFunction],
    ) -> VmResult {
        unsafe {
            if let Some(library_name) = library_name {
                if self.find_table(LUA_REGISTRY_INDEX, "_LOADED", 1)?.is_some() {
                    return crate::error!(self, "name conflict for module '_LOADED'")
                        .map_err(Into::into);
                }

                let result = self.get_field(-1, library_name)?;
                if result != LUA_TTABLE {
                    self.pop(1);

                    if let Some(problem) =
                        self.find_table(LUA_GLOBALS_INDEX, library_name, functions.len())?
                    {
                        return crate::error!(self, "name conflict for module '%s'", &problem)
                            .map_err(Into::into);
                    }

                    self.push_value(-1)?;
                    self.set_field(-3, library_name)?;
                }

                self.remove(-2);
            }

            for entry in functions {
                self.push_native_closure_k(entry.function, Some(entry.name), 0, None)?;
                self.set_field(-2, entry.name)?;
            }
        }
        Ok(())
    }

    pub unsafe fn register_module(&self, module: &NativeModule) -> VmResult {
        unsafe { self.register(module.name, module.functions) }
    }
}

// Environment sandboxing
impl Thread {
    /// `luaL_sandbox`
    ///
    /// # Safety
    ///
    /// The caller must ensure that the current globals table can be made
    /// readonly and marked as a safe environment for future loads.
    pub unsafe fn sandbox(&self) -> VmErrorResult {
        unsafe {
            self.push_nil()?;
            while self.next(LUA_GLOBALS_INDEX)? != 0 {
                if self.type_of(-1) == LUA_TTABLE {
                    self.set_readonly(-1, 1);
                }

                self.pop(1);
            }

            self.push_string("")?;
            if self.get_metatable(-1)? != 0 {
                self.set_readonly(-1, 1);
                self.pop(2);
            } else {
                self.pop(1);
            }

            self.set_readonly(LUA_GLOBALS_INDEX, 1);
            self.set_safe_env(LUA_GLOBALS_INDEX, 1);
        }
        Ok(())
    }

    /// `luaL_sandboxthread`
    ///
    /// # Safety
    ///
    /// The caller must ensure that the thread can have its globals table
    /// replaced. If bytecode is loaded into the same sandboxed thread
    /// environment more than once, the caller must clear `safeenv` before the
    /// later load or install a fresh sandboxed environment first.
    pub unsafe fn sandbox_thread(&self) -> VmErrorResult {
        unsafe {
            self.create_table(0, 0)?;
            self.create_table(0, 0)?;
            self.push_value(LUA_GLOBALS_INDEX)?;

            let metatable = self.to_object(-2).unwrap_unchecked().table_value();
            let key = self.intern_string(b"__index".as_bstr())?;
            let node_cursor = self.set_str(metatable, key)?;
            let value = self.stack_top().sub(1);

            node_cursor
                .node_unchecked()
                .value_unchecked()
                .set_obj(value.value_unchecked());
            self.barrier_value(metatable.into(), value.value_unchecked());
            self.pop(1);
            self.set_readonly(-1, 1);
            self.set_metatable(-2)?;
            self.replace(LUA_GLOBALS_INDEX);
            self.set_safe_env(LUA_GLOBALS_INDEX, 1);
        }
        Ok(())
    }
}