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
use crate::cell::*;
use crate::dict::{
make_leaf, make_leaf_with_extra, read_label, rebuild_aug_dict_from_stack,
rebuild_dict_from_stack, split_aug_edge, split_edge, AugDictFn, Branch, Segment, SetMode,
};
use crate::error::Error;
/// Inserts the value associated with key in dictionary
/// in accordance with the logic of the specified [`SetMode`].
pub fn dict_insert(
dict: &mut Option<Cell>,
key: &mut CellSlice,
key_bit_len: u16,
value: &dyn Store,
mode: SetMode,
context: &mut dyn CellContext,
) -> Result<bool, Error> {
if key.size_bits() != key_bit_len {
return Err(Error::CellUnderflow);
}
let mut data = match dict.as_ref() {
// TODO: change mode to `LoadMode::UseGas` if copy-on-write for libraries is not ok.
Some(data) => ok!(context.load_dyn_cell(data.as_ref(), LoadMode::Full)),
None if mode.can_add() => {
*dict = Some(ok!(make_leaf(key, key_bit_len, value, context)));
return Ok(true);
}
None => return Ok(false),
};
let mut stack = Vec::<Segment>::new();
let leaf = loop {
let mut remaining_data = ok!(data.as_slice());
// Read the next part of the key from the current data
let prefix = &mut ok!(read_label(&mut remaining_data, key.size_bits()));
// Match the prefix with the key
let lcp = key.longest_common_data_prefix(prefix);
match lcp.size_bits().cmp(&key.size_bits()) {
// If all bits match, an existing value was found
std::cmp::Ordering::Equal => {
// Check if we can replace the value
if !mode.can_replace() {
// TODO: what is the desired behavior for root as a library?
return Ok(false);
}
// Replace the existing value
break ok!(make_leaf(prefix, key.size_bits(), value, context));
}
// LCP is less than prefix, an edge to slice was found
std::cmp::Ordering::Less if lcp.size_bits() < prefix.size_bits() => {
// Check if we can add a new value
if !mode.can_add() {
// TODO: what is the desired behavior for root as a library?
return Ok(false);
}
break ok!(split_edge(
&remaining_data,
prefix,
&lcp,
key,
value,
context
));
}
// The key contains the entire prefix, but there are still some bits left
std::cmp::Ordering::Less => {
// Fail fast if there are not enough references in the fork
if data.reference_count() != 2 {
return Err(Error::CellUnderflow);
}
// Remove the LCP from the key
let key_bit_len = key.size_bits();
key.skip_first(lcp.size_bits(), 0).ok();
// Load the next branch
let next_branch = match key.load_bit() {
Ok(bit) => Branch::from(bit),
Err(e) => return Err(e),
};
let child = match data.reference(next_branch as u8) {
// TODO: change mode to `LoadMode::UseGas` if copy-on-write for libraries is not ok
Some(cell) => ok!(context.load_dyn_cell(cell, LoadMode::Full)),
None => return Err(Error::CellUnderflow),
};
// Push an intermediate edge to the stack
stack.push(Segment {
data,
next_branch,
key_bit_len,
});
data = child;
}
std::cmp::Ordering::Greater => {
debug_assert!(false, "LCP of prefix and key can't be greater than key");
unsafe { std::hint::unreachable_unchecked() };
}
}
};
*dict = Some(ok!(rebuild_dict_from_stack(stack, leaf, context)));
Ok(true)
}
/// Inserts the value associated with key in aug dictionary
/// in accordance with the logic of the specified [`SetMode`] and comparator for extra
#[allow(clippy::too_many_arguments)]
pub fn aug_dict_insert(
dict: &mut Option<Cell>,
key: &mut CellSlice,
key_bit_len: u16,
extra: &dyn Store,
value: &dyn Store,
mode: SetMode,
comparator: AugDictFn,
context: &mut dyn CellContext,
) -> Result<bool, Error> {
if key.size_bits() != key_bit_len {
return Err(Error::CellUnderflow);
}
let mut data = match dict.as_ref() {
// TODO: change mode to `LoadMode::UseGas` if copy-on-write for libraries is not ok.
Some(data) => {
ok!(context.load_dyn_cell(data.as_ref(), LoadMode::Full))
}
None if mode.can_add() => {
let cell = ok!(make_leaf_with_extra(
key,
key_bit_len,
extra,
value,
context
));
*dict = Some(cell);
return Ok(true);
}
None => return Ok(false),
};
let mut stack = Vec::<Segment>::new();
let leaf = loop {
let mut remaining_data = ok!(data.as_slice());
// Read the next part of the key from the current data
let prefix = &mut ok!(read_label(&mut remaining_data, key.size_bits()));
// Match the prefix with the key
let lcp = key.longest_common_data_prefix(prefix);
match lcp.size_bits().cmp(&key.size_bits()) {
// If all bits match, an existing value was found
std::cmp::Ordering::Equal => {
// Check if we can replace the value
if !mode.can_replace() {
// TODO: what is the desired behavior for root as a library?
return Ok(false);
}
// Replace the existing value
break ok!(make_leaf_with_extra(
prefix,
key.size_bits(),
extra,
value,
context
));
}
// LCP is less than prefix, an edge to slice was found
std::cmp::Ordering::Less if lcp.size_bits() < prefix.size_bits() => {
// Check if we can add a new value
if !mode.can_add() {
// TODO: what is the desired behavior for root as a library?
return Ok(false);
}
break ok!(split_aug_edge(
&mut remaining_data,
prefix,
&lcp,
key,
extra,
value,
comparator,
context,
));
}
// The key contains the entire prefix, but there are still some bits left
std::cmp::Ordering::Less => {
// Fail fast if there are not enough references in the fork
if data.reference_count() != 2 {
return Err(Error::CellUnderflow);
}
// Remove the LCP from the key
let key_bit_len = key.size_bits();
key.skip_first(lcp.size_bits(), 0).ok();
// Load the next branch
let next_branch = match key.load_bit() {
Ok(bit) => Branch::from(bit),
Err(e) => return Err(e),
};
let child = match data.reference(next_branch as u8) {
// TODO: change mode to `LoadMode::UseGas` if copy-on-write for libraries is not ok
Some(cell) => ok!(context.load_dyn_cell(cell, LoadMode::Full)),
None => return Err(Error::CellUnderflow),
};
// Push an intermediate edge to the stack
stack.push(Segment {
data,
next_branch,
key_bit_len,
});
data = child;
}
std::cmp::Ordering::Greater => {
debug_assert!(false, "LCP of prefix and key can't be greater than key");
unsafe { std::hint::unreachable_unchecked() };
}
}
};
*dict = Some(ok!(rebuild_aug_dict_from_stack(
stack, leaf, comparator, context,
)));
Ok(true)
}
/// Inserts the value associated with key in dictionary
/// in accordance with the logic of the specified [`SetMode`].
///
/// Returns a tuple with a new dict root, changed flag and the previous value.
pub fn dict_insert_owned(
dict: &mut Option<Cell>,
key: &mut CellSlice,
key_bit_len: u16,
value: &dyn Store,
mode: SetMode,
context: &mut dyn CellContext,
) -> Result<(bool, Option<CellSliceParts>), Error> {
fn last(
stack: &[Segment],
context: &mut dyn CellContext,
mode: LoadMode,
) -> Result<Option<Cell>, Error> {
match stack.last() {
Some(Segment {
data, next_branch, ..
}) => match data.reference_cloned(*next_branch as u8) {
Some(cell) => context.load_cell(cell, mode).map(Some),
None => Err(Error::CellUnderflow),
},
None => Ok(None),
}
}
if key.size_bits() != key_bit_len {
return Err(Error::CellUnderflow);
}
let root = match &dict {
// TODO: change mode to `LoadMode::UseGas` if copy-on-write for libraries is not ok.
Some(data) => ok!(context.load_cell(data.clone(), LoadMode::Full)),
None if mode.can_add() => {
*dict = Some(ok!(make_leaf(key, key_bit_len, value, context)));
return Ok((true, None));
}
None => return Ok((false, None)),
};
let mut data = root.as_ref();
let mut stack = Vec::<Segment>::new();
let (mut leaf, value_range) = loop {
let mut remaining_data = ok!(data.as_slice());
// Read the next part of the key from the current data
let prefix = &mut ok!(read_label(&mut remaining_data, key.size_bits()));
// Match the prefix with the key
let lcp = key.longest_common_data_prefix(prefix);
match lcp.size_bits().cmp(&key.size_bits()) {
// If all bits match, an existing value was found
std::cmp::Ordering::Equal => {
// Check if we can replace the value
if !mode.can_replace() {
// TODO: change mode to `LoadMode::Noop` if copy-on-write for libraries is not ok.
let value = (
ok!(last(&stack, context, LoadMode::Resolve))
.unwrap_or_else(|| root.clone()),
remaining_data.range(),
);
// TODO: what is the desired behavior for root as a library?
return Ok((false, Some(value)));
}
// Replace the existing value
break (
ok!(make_leaf(prefix, key.size_bits(), value, context)),
Some(remaining_data.range()),
);
}
// LCP is less than prefix, an edge to slice was found
std::cmp::Ordering::Less if lcp.size_bits() < prefix.size_bits() => {
// Check if we can add a new value
if !mode.can_add() {
// TODO: what is the desired behavior for root as a library?
return Ok((false, None));
}
break (
ok!(split_edge(
&remaining_data,
prefix,
&lcp,
key,
value,
context
)),
None,
);
}
// The key contains the entire prefix, but there are still some bits left
std::cmp::Ordering::Less => {
// Fail fast if there are not enough references in the fork
if data.reference_count() != 2 {
return Err(Error::CellUnderflow);
}
// Remove the LCP from the key
let key_bit_len = key.size_bits();
key.skip_first(lcp.size_bits(), 0).ok();
// Load the next branch
let next_branch = match key.load_bit() {
Ok(bit) => Branch::from(bit),
Err(e) => return Err(e),
};
let child = match data.reference(next_branch as u8) {
// TODO: change mode to `LoadMode::UseGas` if copy-on-write for libraries is not ok
Some(cell) => ok!(context.load_dyn_cell(cell, LoadMode::Full)),
None => return Err(Error::CellUnderflow),
};
// Push an intermediate edge to the stack
stack.push(Segment {
data,
next_branch,
key_bit_len,
});
data = child;
}
std::cmp::Ordering::Greater => {
debug_assert!(false, "LCP of prefix and key can't be greater than key");
unsafe { std::hint::unreachable_unchecked() };
}
}
};
let value = match value_range {
Some(range) => {
// TODO: change mode to `LoadMode::Noop` if copy-on-write for libraries is not ok
let last = ok!(last(&stack, context, LoadMode::Resolve));
leaf = ok!(rebuild_dict_from_stack(stack, leaf, context));
Some((last.unwrap_or(root), range))
}
None => {
leaf = ok!(rebuild_dict_from_stack(stack, leaf, context));
None
}
};
*dict = Some(leaf);
Ok((true, value))
}