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
use crate::error::{CamlError, Error};
use crate::tag::Tag;
use crate::{interop::BoxRoot, root::Root, sys, util, OCaml, OCamlRef, Pointer, Runtime};
pub type Size = sys::Size;
#[derive(Debug, Clone, PartialEq, PartialOrd, Eq)]
pub enum Value {
Root(Root),
Raw(sys::Value),
}
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd, Eq)]
#[repr(transparent)]
pub struct Raw(pub sys::Value);
impl Raw {
pub unsafe fn as_value(&self) -> Value {
Value::Raw(self.0)
}
pub unsafe fn as_pointer<T>(&self) -> Pointer<T> {
Pointer::from_value(self.as_value())
}
}
impl AsRef<sys::Value> for Raw {
fn as_ref(&self) -> &sys::Value {
&self.0
}
}
impl From<sys::Value> for Raw {
fn from(x: sys::Value) -> Raw {
Raw(x)
}
}
impl From<Raw> for sys::Value {
fn from(x: Raw) -> sys::Value {
x.0
}
}
pub unsafe trait ToValue {
fn to_value(&self, rt: &Runtime) -> Value;
}
pub unsafe trait FromValue {
fn from_value(v: Value) -> Self;
}
unsafe impl ToValue for Value {
fn to_value(&self, _rt: &Runtime) -> Value {
self.clone()
}
}
unsafe impl FromValue for Value {
fn from_value(v: Value) -> Value {
v
}
}
unsafe impl ToValue for Raw {
fn to_value(&self, _rt: &Runtime) -> Value {
unsafe { Value::new(self.0) }
}
}
unsafe impl FromValue for Raw {
#[inline]
fn from_value(v: Value) -> Raw {
v.raw()
}
}
unsafe impl<'a, T> ToValue for OCaml<'a, T> {
fn to_value(&self, _rt: &Runtime) -> Value {
unsafe { Value::new(self.raw()) }
}
}
unsafe impl<'a, T> ToValue for OCamlRef<'a, T> {
fn to_value(&self, _rt: &Runtime) -> Value {
unsafe { Value::new(self.get_raw()) }
}
}
unsafe impl<T> ToValue for BoxRoot<T> {
fn to_value(&self, _rt: &Runtime) -> Value {
unsafe { Value::new(self.get_raw()) }
}
}
unsafe impl<T> FromValue for BoxRoot<T> {
fn from_value(v: Value) -> BoxRoot<T> {
let ocaml: OCaml<T> = FromValue::from_value(v);
ocaml.root()
}
}
unsafe impl<'a, T> FromValue for OCaml<'a, T> {
fn from_value<'b>(v: Value) -> OCaml<'a, T> {
let rt = unsafe { Runtime::recover_handle() };
unsafe { OCaml::new(rt, v.raw().into()) }
}
}
unsafe impl<T> crate::interop::ToOCaml<T> for Value {
fn to_ocaml<'a>(&self, gc: &'a mut Runtime) -> OCaml<'a, T> {
unsafe { OCaml::new(gc, self.raw().into()) }
}
}
unsafe impl<T> crate::interop::FromOCaml<T> for Value {
fn from_ocaml(v: OCaml<T>) -> Value {
unsafe { Value::new(v.raw()) }
}
}
impl Value {
pub fn raw(&self) -> Raw {
match self {
Value::Root(r) => unsafe { r.get().into() },
Value::Raw(r) => Raw(*r),
}
}
pub fn to<T: FromValue>(&self) -> T {
T::from_value(Value::Raw(self.raw().0))
}
pub fn into<T: FromValue>(self) -> T {
T::from_value(self)
}
pub unsafe fn named(name: &str) -> Option<Value> {
let s = match util::CString::new(name) {
Ok(s) => s,
Err(_) => return None,
};
let named = sys::caml_named_value(s.as_ptr());
if named.is_null() {
return None;
}
Some(Value::new(*named))
}
pub unsafe fn alloc(n: usize, tag: Tag) -> Value {
Value::new(sys::caml_alloc(n, tag.into()))
}
pub unsafe fn alloc_double_array(n: usize) -> Value {
Value::new(sys::caml_alloc_float_array(n))
}
pub unsafe fn alloc_tuple(n: usize) -> Value {
Value::new(sys::caml_alloc_tuple(n))
}
pub unsafe fn alloc_small(n: usize, tag: Tag) -> Value {
Value::new(sys::caml_alloc_small(n, tag.into()))
}
pub unsafe fn alloc_final<T>(
finalizer: unsafe extern "C" fn(Raw),
cfg: Option<(usize, usize)>,
) -> Value {
let (used, max) = cfg.unwrap_or((0, 1));
Value::new(sys::caml_alloc_final(
core::mem::size_of::<T>(),
core::mem::transmute(finalizer),
used,
max,
))
}
pub unsafe fn alloc_custom<T: crate::Custom>() -> Value {
let size = core::mem::size_of::<T>();
Value::new(sys::caml_alloc_custom(
T::ops() as *const _ as *const sys::custom_operations,
size,
T::USED,
T::MAX,
))
}
pub unsafe fn alloc_abstract_ptr<T>(ptr: *mut T) -> Value {
let x = Self::alloc(1, Tag::ABSTRACT);
let dest = x.raw().0 as *mut *mut T;
*dest = ptr;
x
}
#[inline]
pub unsafe fn new<T: Into<sys::Value>>(v: T) -> Value {
Value::Root(Root::new(v.into()))
}
pub unsafe fn array_length(&self) -> usize {
sys::caml_array_length(self.raw().into())
}
pub unsafe fn register_global_root(&mut self) {
sys::caml_register_global_root(&mut self.raw().0)
}
pub unsafe fn remove_global_root(&mut self) {
sys::caml_remove_global_root(&mut self.raw().0)
}
pub unsafe fn tag(&self) -> Tag {
sys::tag_val(self.raw().0).into()
}
pub unsafe fn bool(b: bool) -> Value {
Value::int(b as crate::Int)
}
pub unsafe fn string<S: AsRef<str>>(s: S) -> Value {
let s = s.as_ref();
Value::new(sys::caml_alloc_initialized_string(
s.len(),
s.as_ptr() as *const _,
))
}
pub unsafe fn bytes<S: AsRef<[u8]>>(s: S) -> Value {
let s = s.as_ref();
Value::new(sys::caml_alloc_initialized_string(
s.len(),
s.as_ptr() as *const _,
))
}
pub unsafe fn of_str(s: &str) -> Value {
Value::new(s.as_ptr() as isize)
}
pub unsafe fn of_bytes(s: &[u8]) -> Value {
Value::new(s.as_ptr() as isize)
}
pub unsafe fn some<V: ToValue>(rt: &Runtime, v: V) -> Value {
let v = v.to_value(rt);
let mut x = Value::new(sys::caml_alloc(1, 0));
x.store_field(rt, 0, &v);
x
}
#[inline(always)]
pub fn none() -> Value {
unsafe { Value::new(sys::NONE) }
}
#[inline(always)]
pub fn unit() -> Value {
unsafe { Value::new(sys::UNIT) }
}
pub unsafe fn variant(rt: &Runtime, tag: u8, value: Option<Value>) -> Value {
match value {
Some(v) => {
let mut value = Value::new(sys::caml_alloc(1, tag));
value.store_field(rt, 0, v);
value
}
None => Value::new(sys::caml_alloc(0, tag)),
}
}
pub unsafe fn result_ok<T: ToValue>(rt: &Runtime, value: T) -> Value {
Self::variant(rt, 0, Some(value.to_value(rt)))
}
pub unsafe fn result<A: FromValue, B: FromValue>(&self) -> Result<A, B> {
let tag = self.tag();
if tag.0 == 0 {
Ok(FromValue::from_value(self.field(0)))
} else {
Err(FromValue::from_value(self.field(0)))
}
}
pub unsafe fn result_error<T: ToValue>(rt: &Runtime, value: T) -> Value {
Self::variant(rt, 1, Some(value.to_value(rt)))
}
pub unsafe fn int(i: crate::Int) -> Value {
Value::new(sys::val_int(i))
}
pub unsafe fn uint(i: crate::Uint) -> Value {
Value::new(sys::val_int(i as crate::Int))
}
pub unsafe fn int64(i: i64) -> Value {
Value::new(sys::caml_copy_int64(i))
}
pub unsafe fn int32(i: i32) -> Value {
Value::new(sys::caml_copy_int32(i))
}
pub unsafe fn nativeint(i: isize) -> Value {
Value::new(sys::caml_copy_nativeint(i))
}
pub unsafe fn double(d: f64) -> Value {
Value::new(sys::caml_copy_double(d))
}
pub unsafe fn is_block(&self) -> bool {
sys::is_block(self.raw().0)
}
pub unsafe fn is_long(&self) -> bool {
sys::is_long(self.raw().0)
}
pub unsafe fn field(&self, i: Size) -> Value {
Value::new(*sys::field(self.raw().0, i))
}
pub unsafe fn double_field(&self, i: Size) -> f64 {
sys::caml_sys_double_field(self.raw().0, i)
}
pub unsafe fn store_field<V: ToValue>(&mut self, rt: &Runtime, i: Size, val: V) {
let v = val.to_value(rt);
sys::store_field(self.raw().0, i, v.raw().0)
}
pub unsafe fn store_double_field(&mut self, i: Size, val: f64) {
sys::caml_sys_store_double_field(self.raw().0, i, val)
}
pub unsafe fn int_val(&self) -> isize {
sys::int_val(self.raw().0)
}
pub unsafe fn double_val(&self) -> f64 {
sys::caml_sys_double_val(self.raw().0)
}
pub unsafe fn store_double_val(&mut self, val: f64) {
sys::caml_sys_store_double_val(self.raw().0, val)
}
pub unsafe fn int32_val(&self) -> i32 {
*self.custom_ptr_val::<i32>()
}
pub unsafe fn int64_val(&self) -> i64 {
*self.custom_ptr_val::<i64>()
}
pub unsafe fn nativeint_val(&self) -> isize {
*self.custom_ptr_val::<isize>()
}
pub unsafe fn custom_ptr_val<T>(&self) -> *const T {
sys::field(self.raw().0, 1) as *const T
}
pub unsafe fn custom_ptr_val_mut<T>(&mut self) -> *mut T {
sys::field(self.raw().0, 1) as *mut T
}
pub unsafe fn abstract_ptr_val<T>(&self) -> *const T {
*(self.raw().0 as *const *const T)
}
pub unsafe fn abstract_ptr_val_mut<T>(&self) -> *mut T {
*(self.raw().0 as *mut *mut T)
}
pub unsafe fn string_val(&self) -> &str {
let len = sys::caml_string_length(self.raw().0);
let ptr = sys::string_val(self.raw().0);
let slice = ::core::slice::from_raw_parts(ptr, len);
::core::str::from_utf8(slice).expect("Invalid UTF-8")
}
pub unsafe fn bytes_val(&self) -> &[u8] {
let len = sys::caml_string_length(self.raw().0);
let ptr = sys::string_val(self.raw().0);
::core::slice::from_raw_parts(ptr, len)
}
pub unsafe fn string_val_mut(&mut self) -> &mut str {
let len = sys::caml_string_length(self.raw().0);
let ptr = sys::string_val(self.raw().0);
let slice = ::core::slice::from_raw_parts_mut(ptr, len);
::core::str::from_utf8_mut(slice).expect("Invalid UTF-8")
}
pub unsafe fn bytes_val_mut(&mut self) -> &mut [u8] {
let len = sys::caml_string_length(self.raw().0);
let ptr = sys::string_val(self.raw().0);
::core::slice::from_raw_parts_mut(ptr, len)
}
pub unsafe fn exception(&self) -> Option<Value> {
if !self.is_exception_result() {
return None;
}
Some(Value::new(sys::extract_exception(self.raw().0)))
}
unsafe fn check_result(mut self) -> Result<Value, Error> {
if !self.is_exception_result() {
return Ok(self);
}
match &mut self {
Value::Root(r) => {
r.modify(sys::extract_exception(r.get()));
}
Value::Raw(mut r) => sys::caml_modify(&mut r, sys::extract_exception(r)),
}
Err(CamlError::Exception(self).into())
}
pub unsafe fn call1<A: ToValue>(&self, rt: &Runtime, arg1: A) -> Result<Value, Error> {
if self.tag() != Tag::CLOSURE {
return Err(Error::NotCallable);
}
let v = {
let arg1 = arg1.to_value(rt);
Value::new(sys::caml_callback_exn(self.raw().0, arg1.raw().0))
};
v.check_result()
}
pub unsafe fn call2<A: ToValue, B: ToValue>(
&self,
rt: &Runtime,
arg1: A,
arg2: B,
) -> Result<Value, Error> {
if self.tag() != Tag::CLOSURE {
return Err(Error::NotCallable);
}
let v = {
let arg1 = arg1.to_value(rt);
let arg2 = arg2.to_value(rt);
Value::new(sys::caml_callback2_exn(
self.raw().0,
arg1.raw().0,
arg2.raw().0,
))
};
v.check_result().map(Value::into)
}
pub unsafe fn call3<A: ToValue, B: ToValue, C: ToValue>(
&self,
rt: &Runtime,
arg1: A,
arg2: B,
arg3: C,
) -> Result<Value, Error> {
if self.tag() != Tag::CLOSURE {
return Err(Error::NotCallable);
}
let v = {
let arg1 = arg1.to_value(rt);
let arg2 = arg2.to_value(rt);
let arg3 = arg3.to_value(rt);
Value::new(sys::caml_callback3_exn(
self.raw().0,
arg1.raw().0,
arg2.raw().0,
arg3.raw().0,
))
};
v.check_result().map(Value::into)
}
pub unsafe fn call_n<A: AsRef<[Raw]>>(&self, args: A) -> Result<Value, Error> {
if self.tag() != Tag::CLOSURE {
return Err(Error::NotCallable);
}
let n = args.as_ref().len();
let v: Value = Value::new(sys::caml_callbackN_exn(
self.raw().0,
n,
args.as_ref().as_ptr() as *mut sys::Value,
));
v.check_result()
}
#[cfg(not(feature = "no-std"))]
pub unsafe fn call<const N: usize, T: FromValue>(
&self,
rt: &Runtime,
args: [impl ToValue; N],
) -> Result<T, Error> {
if self.tag() != Tag::CLOSURE {
return Err(Error::NotCallable);
}
let n = args.len();
let mut a = vec![];
for arg in args {
a.push(arg.to_value(rt));
}
if a.is_empty() {
a.push(Value::unit());
}
let b: Vec<Raw> = a.iter().map(|x| x.raw()).collect();
let v: Value = Value::new(sys::caml_callbackN_exn(
self.raw().0,
n,
b.as_ptr() as *mut sys::Value,
));
FromValue::from_value(v.check_result()?)
}
pub unsafe fn modify<V: ToValue>(&mut self, rt: &Runtime, v: V) {
let v = v.to_value(rt);
match self {
Value::Root(r) => {
r.modify(v.raw().into());
}
Value::Raw(r) => sys::caml_modify(r, v.raw().into()),
}
}
pub unsafe fn modify_raw(&mut self, v: Raw) {
match self {
Value::Root(r) => r.modify(v.into()),
Value::Raw(r) => sys::caml_modify(r, v.into()),
}
}
pub unsafe fn is_exception_result(&self) -> bool {
sys::is_exception_result(self.raw().0)
}
pub unsafe fn hash_variant<S: AsRef<str>>(rt: &Runtime, name: S, a: Option<Value>) -> Value {
let s = util::CString::new(name.as_ref()).expect("Invalid C string");
let hash = Value::new(sys::caml_hash_variant(s.as_ptr() as *const u8));
match a {
Some(x) => {
let mut output = Value::alloc_small(2, Tag(0));
output.store_field(rt, 0, &hash);
output.store_field(rt, 1, &x);
output
}
None => hash,
}
}
pub unsafe fn method<S: AsRef<str>>(&self, rt: &Runtime, name: S) -> Option<Value> {
if self.tag() != Tag::OBJECT {
return None;
}
let variant = Self::hash_variant(rt, name, None);
let v = sys::caml_get_public_method(self.raw().0, variant.raw().0);
if v == 0 {
return None;
}
Some(Value::new(v))
}
pub unsafe fn seq_next(&self) -> Result<Option<(Value, Value)>, Error> {
let x = self.call_n(&[Value::unit().raw()])?;
if !x.is_block() {
return Ok(None);
}
let v = x.field(0);
let next = x.field(1);
Ok(Some((v, next)))
}
#[cfg(not(feature = "no-std"))]
pub unsafe fn exception_to_string(&self) -> Result<String, core::str::Utf8Error> {
let ptr = ocaml_sys::caml_format_exception(self.raw().0);
std::ffi::CStr::from_ptr(ptr).to_str().map(|x| x.to_owned())
}
pub unsafe fn initialize(&mut self, value: Value) {
sys::caml_initialize(&mut self.raw().0, value.raw().0)
}
#[doc(hidden)]
pub unsafe fn slice<'a>(&self) -> &'a [Raw] {
::core::slice::from_raw_parts(
(self.raw().0 as *const Raw).offset(-1),
sys::wosize_val(self.raw().0) + 1,
)
}
#[doc(hidden)]
pub unsafe fn slice_mut<'a>(&self) -> &'a mut [Raw] {
::core::slice::from_raw_parts_mut(
(self.raw().0 as *mut Raw).offset(-1),
sys::wosize_val(self.raw().0) + 1,
)
}
pub unsafe fn deep_clone_to_ocaml(self) -> Self {
if self.is_long() {
return self;
}
let wosize = sys::wosize_val(self.raw().0);
let val1 = Self::alloc(wosize, self.tag());
let ptr0 = self.raw().0 as *const sys::Value;
let ptr1 = val1.raw().0 as *mut sys::Value;
if self.tag() >= Tag::NO_SCAN {
ptr0.copy_to_nonoverlapping(ptr1, wosize);
return val1;
}
for i in 0..(wosize as isize) {
sys::caml_initialize(
ptr1.offset(i),
Value::new(ptr0.offset(i).read())
.deep_clone_to_ocaml()
.raw()
.0,
);
}
val1
}
#[cfg(not(feature = "no-std"))]
pub unsafe fn deep_clone_to_rust(&self) -> Self {
if self.is_long() {
return self.clone();
}
if self.tag() >= Tag::NO_SCAN {
let slice0 = self.slice();
let vec1 = slice0.to_vec();
let ptr1 = vec1.as_ptr();
core::mem::forget(vec1);
return Value::new(ptr1.offset(1) as isize);
}
let slice0 = self.slice();
Value::new(slice0.as_ptr().offset(1) as isize)
}
}