ocaml-boxroot-sys 0.4.0

Boxroot for OCaml: fast movable GC roots (C API)
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

ocaml-boxroot 0.4.0
===================

- Fix clang compatibility
  (Guillaume Munch-Maccagnoni, report and tests by Zach Shipko)


ocaml-boxroot 0.4.0-rc1
=======================

### General changes

- Support for OCaml ≥ 5.3 (no longer assume a low max number of domains).
  (Guillaume Munch-Maccagnoni, review by Gabriel Scherer)

- Add support for including the headers from C++, and add a C++ smart
  pointer `Boxroot` based on `unique_ptr` in `cpp/boxroot.h`.
  (Guillaume Munch-Maccagnoni)

- Add function `boxroot_error_string`.
  (Guillaume Munch-Maccagnoni)

- Simplified constraints for calling `boxroot_setup` with OCaml 4.
  Rust crate users now only need to call `boxroot_setup`
  appropriately, regardless of whether systhread is linked.
  `boxroot_setup_systhreads` is deprecated in favour of
  `boxroot_setup` in OCaml 4. `boxroot_setup` is still obsolete for
  OCaml 5.
  (Guillaume Munch-Maccagnoni, review by Konstantin Olkhovskiy)

### Internal changes

- Improve stat collection.
  (Guillaume Munch-Maccagnoni, review by Gabriel Scherer)

### Experiments

- Add a bitmap allocator inspired by the Hotspot VM implementation of
  JNI global references, for benchmarking purposes.
  (Guillaume Munch-Maccagnoni)

- Add a new parallel producer-consumer synthetic benchmark.
  (Gabriel Scherer, review by Guillaume Munch-Maccagnoni)

### Packaging

- Use weak linking to offer uniform setup procedure in OCaml 4
  regardless of whether systhreads is linked.
  (Guillaume Munch-Maccagnoni, suggestion by Konstantin Olkhovskiy)


ocaml-boxroot 0.3.1
===================

### Bug fixes

- Introduce `boxroot_setup_systhreads()`, which must be called when
  using OCaml 4 with the Thread module. It must be called between
  OCaml startup and the first thread creation. Fixes !75.
  (Guillaume Munch-Maccagnoni, report and suggestion by Gabriel
  Scherer, review by Bruno Deferrari)


ocaml-boxroot 0.3.0
===================

### General changes

- Add support for OCaml 5.0 (multicore).
  (Guillaume Munch-Maccagnoni, review by Gabriel Scherer)

- Avoid locking a mutex in the fast paths. The option
  `BOXROOT_USE_MUTEX` is removed and the implementation is now
  thread-safe by default.
  (Guillaume Munch-Maccagnoni, review by Gabriel Scherer)

- Boxroot setup is now automatic and `boxroot_setup` is obsolete.
  (Guillaume Munch-Maccagnoni, review by Gabriel Scherer)

- Clarify license (MIT license).
  (Guillaume Munch-Maccagnoni, review by Gabriel Scherer)

- Better error reporting and analysis for API authors
  (`boxroot_status`). `boxroot_create` and `boxroot_modify` now detect
  and safely fail when called without holding the domain lock
  (signature change for `boxroot_modify`).
  (Guillaume Munch-Maccagnoni)

### Internal changes

- Detection of master lock for OCaml 4. Note usage constraints with
  systhreads for OCaml 4 (see documentation of `boxroot_status` in
  `boxroot.h`).
  (Guillaume Munch-Maccagnoni, review by Gabriel Scherer)

- Benchmark improvements.
  (Gabriel Scherer and Guillaume Munch-Maccagnoni)

- Per-domain caching for OCaml multicore. There is no longer a global
  lock for multicore.
  (Guillaume Munch-Maccagnoni)

- Various performance improvements under OCaml 4 and OCaml 5.
  Deallocation is almost-always lock-free.
  (Guillaume Munch-Maccagnoni)

### Experiments

- Simple implementation with a doubly-linked list
  (Gabriel Scherer, review by Jacques-Henri Jourdan and
   Guillaume Munch-Maccagnoni)

- Implementation using the remembered set and a per-pool young
  freelist.
  (Gabriel Scherer, following an idea of Stephen Dolan, review
   by Guillaume Munch-Maccagnoni)

- Optimizing for inlining.
  (Guillaume Munch-Maccagnoni, review by Gabriel Scherer)

### Packaging

- API update for ocaml-boxroot-sys (breaking change).
  (Guillaume Munch-Maccagnoni, review by Zach Shipko)

- Minor improvements.
  (Guillaume Munch-Maccagnoni)

- Remove `without-ocamlopt` feature flag from the Rust crate and add
  `bundle-boxroot`.
  (Bruno Deferrari, review by Guillaume Munch-Maccagnoni)

- Declare `package.links` value in Rust crate.
  (Bruno Deferrari, review by Guillaume Munch-Maccagnoni)

- ocaml-boxroot-sys no longer links to the std library (`[no_std]`).
  Note though that ocaml-boxroot still relies on a system allocator
  (`posix_memalign`).
  (Guillaume Munch-Maccagnoni)


ocaml-boxroot 0.2
=================

### General changes

- Thread-safety using a global lock.
  (Bruno Deferrari)

### Internal changes

- Minor simplifications and performance improvements to the allocator
  and to the benchmarks.
  (Gabriel Scherer and Guillaume Munch-Maccagnoni)

### Packaging

- Add `without-ocamlopt` feature flag for compiling the Rust crate
  without an OCaml install requirement.
  (Bruno Deferrari)


ocaml-boxroot 0.1
=================

- First numbered prototype & experimentation.
  (Bruno Deferrari, Guillaume Munch-Maccagnoni, Gabriel Scherer)

### Packaging

- First version published with the Rust crate ocaml-boxroot-sys.
  (Bruno Deferrari)