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
use std::alloc;
use std::hash::{Hash, Hasher};
use std::mem::MaybeUninit;
use std::{fmt, mem};
use crate::boxed::refs::Gc;
use crate::boxed::types::field_value::FieldGcRefIter;
use crate::boxed::*;
pub type RecordClassId = u32;
#[repr(C)]
struct RecordHeader {
header: Header,
inline_byte_len: u8,
may_contain_gc_refs: bool,
class_id: RecordClassId,
}
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum RecordStorage {
Inline(BoxSize),
External,
}
impl RecordStorage {
pub fn box_size(self) -> BoxSize {
match self {
RecordStorage::Inline(box_size) => box_size,
RecordStorage::External => BoxSize::Size32,
}
}
}
#[repr(C, align(16))]
pub struct Record {
record_header: RecordHeader,
padding: [u8; Record::MAX_INLINE_BYTES],
}
impl Boxed for Record {}
impl Record {
pub const MAX_INLINE_BYTES: usize = 24;
pub const EXTERNAL_INLINE_LEN: u8 = (Self::MAX_INLINE_BYTES as u8) + 1;
const INLINE_DATA_ALIGNMENT: usize = 8;
pub fn new(heap: &mut impl AsHeap, class_id: RecordClassId, data: RecordData) -> Gc<Record> {
let storage = Self::storage_for_data_layout(data.layout());
let box_size = storage.box_size();
let boxed = unsafe {
match storage {
RecordStorage::External => {
mem::transmute(ExternalRecord::new(box_size, class_id, data))
}
RecordStorage::Inline(_) => {
mem::transmute(InlineRecord::new(box_size, class_id, data))
}
}
};
heap.as_heap_mut().place_box(boxed)
}
pub fn storage_for_data_layout(data_layout: Option<alloc::Layout>) -> RecordStorage {
match data_layout {
None => RecordStorage::Inline(BoxSize::Size16),
Some(data_layout) => {
if data_layout.align() > Self::INLINE_DATA_ALIGNMENT {
return RecordStorage::External;
}
match data_layout.size() {
0..=8 => RecordStorage::Inline(BoxSize::Size16),
9..=Record::MAX_INLINE_BYTES => RecordStorage::Inline(BoxSize::Size32),
_ => RecordStorage::External,
}
}
}
}
pub fn class_id(&self) -> RecordClassId {
self.record_header.class_id
}
pub fn field_values<'cm>(&self, heap: &'cm Heap) -> FieldValueIter<'cm> {
let classmap_class = heap
.type_info()
.class_map()
.class_for_record_class_id(self.class_id());
FieldValueIter {
classmap_field_iter: classmap_class.field_iter(),
record_data: self.data_ptr(),
}
}
pub(crate) fn field_gc_refs<'cm>(&mut self, heap: &'cm Heap) -> FieldGcRefIter<'cm> {
if !self.record_header.may_contain_gc_refs {
return FieldGcRefIter::empty();
}
let classmap_class = heap
.type_info()
.class_map()
.class_for_record_class_id(self.class_id());
FieldGcRefIter {
classmap_field_iter: classmap_class.field_iter(),
record_data: self.data_ptr(),
}
}
fn data_ptr(&self) -> *const u8 {
match self.as_repr() {
Repr::Inline(inline) => inline.inline_data.as_ptr() as *const u8,
Repr::External(external) => external.external_data.as_ptr(),
}
}
fn is_empty(&self) -> bool {
self.record_header.inline_byte_len == 0
}
fn is_inline(&self) -> bool {
self.record_header.inline_byte_len <= Self::MAX_INLINE_BYTES as u8
}
fn as_repr(&self) -> Repr<'_> {
if self.is_inline() {
Repr::Inline(unsafe { &*(self as *const Record as *const InlineRecord) })
} else {
Repr::External(unsafe { &*(self as *const Record as *const ExternalRecord) })
}
}
fn as_repr_mut(&mut self) -> ReprMut<'_> {
if self.is_inline() {
ReprMut::Inline(unsafe { &mut *(self as *mut Record as *mut InlineRecord) })
} else {
ReprMut::External(unsafe { &mut *(self as *mut Record as *mut ExternalRecord) })
}
}
}
impl PartialEqInHeap for Record {
fn eq_in_heap(&self, heap: &Heap, other: &Record) -> bool {
if self.class_id() != other.class_id() {
return false;
}
if self.is_empty() {
return true;
}
self.field_values(heap)
.zip(other.field_values(heap))
.all(|(self_field, other_field)| self_field.eq_in_heap(heap, &other_field))
}
}
impl HashInHeap for Record {
fn hash_in_heap<H: Hasher>(&self, heap: &Heap, state: &mut H) {
Self::TYPE_TAG.hash(state);
self.class_id().hash(state);
if !self.is_empty() {
for field in self.field_values(heap) {
field.hash_in_heap(heap, state);
}
}
}
}
impl fmt::Debug for Record {
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
write!(formatter, "Record({:?})", self.class_id())
}
}
#[repr(C, align(16))]
struct InlineRecord {
record_header: RecordHeader,
inline_data: MaybeUninit<[u8; Record::MAX_INLINE_BYTES]>,
}
impl InlineRecord {
fn new(box_size: BoxSize, class_id: RecordClassId, data: RecordData) -> InlineRecord {
let header = Record::TYPE_TAG.to_heap_header(box_size);
unsafe {
let mut inline_data = mem::MaybeUninit::<[u8; Record::MAX_INLINE_BYTES]>::uninit();
if let Some(data_layout) = data.layout() {
ptr::copy(
data.as_ptr(),
inline_data.as_mut_ptr() as *mut _,
data_layout.size(),
);
}
InlineRecord {
record_header: RecordHeader {
header,
inline_byte_len: match data.layout() {
Some(layout) => layout.size() as u8,
None => 0,
},
may_contain_gc_refs: data.layout().is_some(),
class_id,
},
inline_data,
}
}
}
}
#[repr(C, align(16))]
struct ExternalRecord {
record_header: RecordHeader,
external_data: RecordData,
}
impl ExternalRecord {
fn new(box_size: BoxSize, class_id: RecordClassId, data: RecordData) -> ExternalRecord {
let header = Record::TYPE_TAG.to_heap_header(box_size);
ExternalRecord {
record_header: RecordHeader {
header,
inline_byte_len: std::u8::MAX,
may_contain_gc_refs: true,
class_id,
},
external_data: data,
}
}
}
enum Repr<'a> {
Inline(&'a InlineRecord),
External(&'a ExternalRecord),
}
enum ReprMut<'a> {
Inline(&'a mut InlineRecord),
External(&'a mut ExternalRecord),
}
impl Drop for Record {
fn drop(&mut self) {
match self.as_repr_mut() {
ReprMut::Inline(_) => {
}
ReprMut::External(external) => unsafe { ptr::drop_in_place(external) },
}
}
}
#[cfg(test)]
mod test {
use super::*;
use crate::boxed::heap::Heap;
#[test]
fn sizes() {
assert_eq!(32, mem::size_of::<Record>());
assert_eq!(32, mem::size_of::<InlineRecord>());
assert_eq!(32, mem::size_of::<ExternalRecord>());
}
#[test]
fn equality() {
let mut heap = Heap::empty();
let record_class_one_instance1 = Record::new(&mut heap, 1, RecordData::empty());
let record_class_one_instance2 = Record::new(&mut heap, 1, RecordData::empty());
let record_class_two_instance1 = Record::new(&mut heap, 2, RecordData::empty());
assert!(record_class_one_instance1.eq_in_heap(&heap, &record_class_one_instance2));
assert!(!record_class_one_instance1.eq_in_heap(&heap, &record_class_two_instance1));
}
#[test]
fn fmt_debug() {
let mut heap = Heap::empty();
let boxed_one = Record::new(&mut heap, 1, RecordData::empty());
assert_eq!("Record(1)", format!("{:?}", boxed_one));
}
}