wrecord 0.1.1

16-byte record format with zero-copy views and SIMD key compare / 16 字节记录格式,含零拷贝视图与 SIMD 键比较
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
use aok::{OK, Void};
use log::info;
use wrecord::{
  ADDRESS_MASK, Error, HEADER_SIZE, MAX_FILLER_BYTES, RecordHeader, RecordMut, RecordRef,
  TOMBSTONE_BIT, encode_to_slice, record_size, try_encode_to_vec,
};

#[ctor::ctor(unsafe)]
fn _log_init() {
  log_init::init();
}

/// 编解码往返一致性测试(支持空与非空键值、常规与边界地址)
#[test]
fn test_roundtrip_encode_decode() -> Void {
  info!("开始测试: 编解码往返一致性");

  // 测试普通键值对
  let key = b"user:10001:profile";
  let val = b"{\"name\":\"Alice\",\"age\":30,\"active\":true}";
  let prev_addr = 0x0000_1234_5678_9abc_u64;

  let encoded = try_encode_to_vec(prev_addr, key, val, false)?;
  assert_eq!(encoded.len(), record_size(key.len(), val.len()));

  let rec_ref = RecordRef::from_slice(&encoded)?;
  assert_eq!(rec_ref.key(), key);
  assert_eq!(rec_ref.value(), val);
  assert_eq!(rec_ref.prev_address(), prev_addr);
  assert!(!rec_ref.is_tombstone());
  assert_eq!(rec_ref.total_size(), encoded.len());

  // 测试空键与空值情况
  let empty_encoded = try_encode_to_vec(0, b"", b"", false)?;
  assert_eq!(empty_encoded.len(), HEADER_SIZE);
  let empty_ref = RecordRef::from_slice(&empty_encoded)?;
  assert_eq!(empty_ref.key(), b"");
  assert_eq!(empty_ref.value(), b"");
  assert_eq!(empty_ref.prev_address(), 0);
  assert!(!empty_ref.is_tombstone());

  // 测试最大 48 位合法地址
  let max_addr = ADDRESS_MASK;
  let max_addr_encoded = try_encode_to_vec(max_addr, b"k", b"v", false)?;
  let max_addr_ref = RecordRef::from_slice(&max_addr_encoded)?;
  assert_eq!(max_addr_ref.prev_address(), max_addr);

  // 测试切片编码与容量足够的大缓冲区
  let mut large_buf = vec![0u8; 1024];
  let written = encode_to_slice(&mut large_buf, prev_addr, key, val, false)?;
  assert_eq!(written, record_size(key.len(), val.len()));

  let slice_ref = RecordRef::from_slice(&large_buf)?;
  assert_eq!(slice_ref.key(), key);
  assert_eq!(slice_ref.value(), val);

  info!("编解码往返一致性测试通过");
  OK
}

/// 墓碑标记设置与检测测试
#[test]
fn test_tombstone_flag() -> Void {
  info!("开始测试: 墓碑标记设置与检测");

  let key = b"deleted_key";
  let val = b"";
  let prev_addr = 0x0000_aabb_ccdd_eeff_u64;

  // 1. 编码为墓碑记录
  let encoded = try_encode_to_vec(prev_addr, key, val, true)?;
  let rec_ref = RecordRef::from_slice(&encoded)?;
  assert!(rec_ref.is_tombstone());
  assert_eq!(rec_ref.prev_address(), prev_addr);

  // 检查底层字节:最高位应已置位
  let raw_header = RecordHeader::from_slice(&encoded[..HEADER_SIZE])?;
  assert_eq!(raw_header.prev_address, prev_addr | TOMBSTONE_BIT);

  // 2. 在 RecordMut 中原位切换墓碑标记
  let mut buf = encoded.clone();
  let mut rec_mut = RecordMut::from_slice_mut(&mut buf)?;
  assert!(rec_mut.is_tombstone());

  // 取消墓碑标记
  rec_mut.set_tombstone(false);
  assert!(!rec_mut.is_tombstone());
  assert_eq!(rec_mut.prev_address(), prev_addr);

  // 重新置为墓碑
  rec_mut.set_tombstone(true);
  assert!(rec_mut.is_tombstone());
  assert_eq!(rec_mut.prev_address(), prev_addr);

  // 重新从切片解码确认底层数据同步写入
  let check_ref = RecordRef::from_slice(&buf)?;
  assert!(check_ref.is_tombstone());
  assert_eq!(check_ref.prev_address(), prev_addr);

  info!("墓碑标记设置与检测测试通过");
  OK
}

/// 零拷贝借用 RecordRef 测试(指针比对确认无内存分配与拷贝)
#[test]
fn test_record_ref_zero_copy() -> Void {
  info!("开始测试: 零拷贝借用 RecordRef");

  let key = b"my_benchmark_key_12345";
  let val = b"my_benchmark_val_67890";
  let prev_addr = 0x42;

  let encoded = try_encode_to_vec(prev_addr, key, val, false)?;
  let rec_ref = RecordRef::from_slice(&encoded)?;

  // 检验借用切片指针与原始缓冲区精确一致
  let expected_key_ptr = unsafe { encoded.as_ptr().add(HEADER_SIZE) };
  let expected_val_ptr = unsafe { encoded.as_ptr().add(HEADER_SIZE + key.len()) };

  assert_eq!(rec_ref.key().as_ptr(), expected_key_ptr);
  assert_eq!(rec_ref.value().as_ptr(), expected_val_ptr);
  assert_eq!(rec_ref.key().len(), key.len());
  assert_eq!(rec_ref.value().len(), val.len());

  info!("零拷贝借用指针精确匹配测试通过");
  OK
}

/// 原位值更新 RecordMut 测试(成功更新与长度不匹配防御拦截)
#[test]
fn test_record_mut_in_place_update() -> Void {
  info!("开始测试: 原位值更新与防御拦截");

  let key = b"counter_key";
  let initial_val = b"0000000010"; // 10 字节
  let prev_addr = 0x0000_0001_0000_0000_u64;

  let mut buf = try_encode_to_vec(prev_addr, key, initial_val, false)?;
  let mut rec_mut = RecordMut::from_slice_mut(&mut buf)?;

  assert_eq!(rec_mut.key(), key);
  assert_eq!(rec_mut.value(), initial_val);

  // 1. 等长原位更新成功
  let updated_val = b"0000000020"; // 同样为 10 字节
  rec_mut.update_value_in_place(updated_val)?;
  assert_eq!(rec_mut.value(), updated_val);

  // 2. 长度过短拦截
  let short_val = b"0020";
  let err_short = rec_mut.update_value_in_place(short_val);
  assert_eq!(
    err_short,
    Err(Error::ValueLengthMismatch {
      expected: 10,
      actual: 4,
    })
  );

  // 3. 长度过长拦截
  let long_val = b"00000000000000000020";
  let err_long = rec_mut.update_value_in_place(long_val);
  assert_eq!(
    err_long,
    Err(Error::ValueLengthMismatch {
      expected: 10,
      actual: 20,
    })
  );

  // 确认失败的更新未破坏原有值
  assert_eq!(rec_mut.value(), updated_val);

  // 4. 原位更新前驱地址
  let new_prev_addr = 0x0000_0002_0000_0000_u64;
  rec_mut.set_prev_address(new_prev_addr)?;
  assert_eq!(rec_mut.prev_address(), new_prev_addr);

  // 5. 尝试更新超出 48 位的非法地址
  let invalid_addr = 1u64 << 48;
  let err_addr = rec_mut.set_prev_address(invalid_addr);
  assert_eq!(err_addr, Err(Error::AddressOverflow(invalid_addr)));

  // 6. 转换为 RecordRef 检验最终一致性
  let view = rec_mut.as_ref();
  assert_eq!(view.key(), key);
  assert_eq!(view.value(), updated_val);
  assert_eq!(view.prev_address(), new_prev_addr);

  info!("原位值更新与防御拦截测试通过");
  OK
}

/// 缓冲区截断与越界错误处理测试
#[test]
fn test_buffer_too_short_and_bounds_check() -> Void {
  info!("开始测试: 缓冲区截断与越界防御");

  // 1. 头长度不足 16 字节
  let tiny_buf = [0u8; 15];
  assert_eq!(
    RecordHeader::from_slice(&tiny_buf),
    Err(Error::BufferTooShort {
      expected: 16,
      actual: 15,
    })
  );
  assert_eq!(
    RecordRef::from_slice(&tiny_buf),
    Err(Error::BufferTooShort {
      expected: 16,
      actual: 15,
    })
  );

  let mut tiny_mut_buf = [0u8; 10];
  assert_eq!(
    RecordMut::from_slice_mut(&mut tiny_mut_buf),
    Err(Error::BufferTooShort {
      expected: 16,
      actual: 10,
    })
  );

  // 2. 头合法,但键值数据截断
  let key = b"test_key";
  let val = b"test_val_12345";
  let full_buf = try_encode_to_vec(1, key, val, false)?;
  let total_len = full_buf.len();

  // 模拟截断 1 字节
  let truncated_buf = &full_buf[..total_len - 1];
  assert_eq!(
    RecordRef::from_slice(truncated_buf),
    Err(Error::BufferTooShort {
      expected: total_len,
      actual: total_len - 1,
    })
  );

  // 3. 编码时目标缓冲区容量不足
  let mut small_dst = vec![0u8; total_len - 1];
  assert_eq!(
    encode_to_slice(&mut small_dst, 1, key, val, false),
    Err(Error::BufferTooShort {
      expected: total_len,
      actual: total_len - 1,
    })
  );

  // 4. 地址溢出防御
  let overflow_addr = 1u64 << 48;
  assert_eq!(
    try_encode_to_vec(overflow_addr, key, val, false),
    Err(Error::AddressOverflow(overflow_addr))
  );

  let mut valid_dst = vec![0u8; total_len];
  assert_eq!(
    encode_to_slice(&mut valid_dst, overflow_addr, key, val, false),
    Err(Error::AddressOverflow(overflow_addr))
  );

  assert_eq!(
    RecordHeader::new(overflow_addr, 1, 1, false),
    Err(Error::AddressOverflow(overflow_addr))
  );

  info!("缓冲区截断与越界防御测试通过");
  OK
}

/// RecordHeader 与 RecordMut 墓碑翻转与原位更新判断测试
#[test]
fn test_tombstone_flip_and_can_update_in_place() -> Void {
  info!("开始测试: RecordHeader/RecordMut 翻转墓碑与原位更新判断");

  // 1. RecordHeader 原生测试
  let mut header = RecordHeader::new(0x1234, 10, 20, false)?;
  assert!(!header.is_tombstone());
  assert!(header.can_update_in_place(20));
  assert!(!header.can_update_in_place(19));
  assert!(!header.can_update_in_place(21));

  // 翻转为墓碑
  assert!(header.flip_tombstone());
  assert!(header.is_tombstone());
  // 墓碑状态下禁止原位更新
  assert!(!header.can_update_in_place(20));

  // 再次翻转清除墓碑
  assert!(!header.flip_tombstone());
  assert!(!header.is_tombstone());
  assert!(header.can_update_in_place(20));

  // 2. RecordMut 原位翻转测试
  let mut buf = try_encode_to_vec(0x5678, b"test_key", b"1234567890", false)?;
  {
    let mut rec_mut = RecordMut::from_slice_mut(&mut buf)?;
    assert!(!rec_mut.is_tombstone());
    assert!(rec_mut.can_update_in_place(10));
    assert!(!rec_mut.can_update_in_place(5));

    // 原位翻转并检查底层切片同步
    assert!(rec_mut.flip_tombstone());
    assert!(rec_mut.is_tombstone());
    assert_eq!(rec_mut.prev_address(), 0x5678);
    assert!(!rec_mut.can_update_in_place(10));
  }

  // 检查底层字节是否同步改变
  let ref_check = RecordRef::from_slice(&buf)?;
  assert!(ref_check.is_tombstone());
  assert!(!ref_check.can_update_in_place(10));

  // 再次原位翻转取消墓碑
  {
    let mut rec_mut = RecordMut::from_slice_mut(&mut buf)?;
    assert!(!rec_mut.flip_tombstone());
    assert!(!rec_mut.is_tombstone());
    assert!(rec_mut.can_update_in_place(10));
  }

  let ref_check2 = RecordRef::from_slice(&buf)?;
  assert!(!ref_check2.is_tombstone());
  assert!(ref_check2.can_update_in_place(10));

  info!("RecordHeader/RecordMut 翻转墓碑与原位更新判断测试通过");
  OK
}

/// FillerWords 独立词级设置与字节级松弛互斥覆写测试(对标 RecordDataHeader.FillerWords setter)
#[test]
fn test_filler_words_field_setter() -> Void {
  info!("开始测试: FillerWords 词级设置与字节级松弛折算");

  let mut hdr = RecordHeader::new(0x10, 8, 16, false)?;
  assert_eq!(hdr.filler_bytes(), 0);

  // 词级设置:4 词 = 32 字节
  hdr.set_filler_words(4);
  assert_eq!(hdr.filler_words(), 4);
  assert_eq!(hdr.filler_bytes(), 32);
  assert_eq!(hdr.address(), 0x10);

  // 字节级设置覆盖词级:31 = 3 词 + 7 余数
  hdr.set_filler_bytes(31);
  assert_eq!(hdr.filler_words(), 3);
  assert_eq!(hdr.filler_rem(), 7);
  assert_eq!(hdr.filler_bytes(), 31);

  // 词级设置保留余数与其他高位标记:5 词 + 7 余数 = 47 字节
  hdr.set_filler_words(5);
  assert_eq!(hdr.filler_words(), 5);
  assert_eq!(hdr.filler_rem(), 7);
  assert_eq!(hdr.filler_bytes(), 47);
  assert_eq!(hdr.address(), 0x10);

  // 上限钳位:2047 = 255 词 + 7 余数
  hdr.set_filler_bytes(MAX_FILLER_BYTES + 128);
  assert_eq!(hdr.filler_words(), 255);
  assert_eq!(hdr.filler_rem(), 7);
  assert_eq!(hdr.filler_bytes(), MAX_FILLER_BYTES);

  OK
}

/// RecordHeader bitcode 序列化与往返测试
#[test]
fn test_record_header_bitcode() -> Void {
  info!("开始测试: RecordHeader bitcode 序列化往返");

  let header = RecordHeader::new(0x0000_1234_5678_9ABC, 42, 1024, true)?;
  let encoded = header.encode_bitcode();
  assert!(!encoded.is_empty());

  let decoded = RecordHeader::decode_bitcode(&encoded)?;
  assert_eq!(header, decoded);
  assert_eq!(decoded.address(), 0x0000_1234_5678_9ABC);
  assert_eq!(decoded.key_len(), 42);
  assert_eq!(decoded.val_len(), 1024);
  assert!(decoded.is_tombstone());

  // 测试非法数据防崩溃
  let bad_data = [0xFFu8; 3];
  assert!(RecordHeader::decode_bitcode(&bad_data).is_err());

  info!("RecordHeader bitcode 序列化往返测试通过");
  OK
}

/// 基于 FillerWords 与动态松弛的原位更新测试(LogRecord.TrySetPinnedValueSpan)
#[test]
fn test_record_mut_dynamic_slack_and_filler_words() -> Void {
  info!("开始测试: FillerWords 动态松弛全生命周期原位覆写与容量自洽");

  let key = b"session:user:1001";
  let initial_val = b"status=active;score=987654;role=admin;meta=verified_2026"; // 56 字节 (8 * 7)
  let prev_addr = 0x0000_1234_5678_0000_u64;

  let mut buf = try_encode_to_vec(prev_addr, key, initial_val, false)?;
  let initial_physical_size = buf.len();

  {
    let mut rec_mut = RecordMut::from_slice_mut(&mut buf)?;
    assert_eq!(rec_mut.val_len(), 56);
    assert_eq!(rec_mut.filler_words(), 0);
    assert_eq!(rec_mut.val_capacity(), 56);
    assert_eq!(rec_mut.physical_size(), initial_physical_size);

    // 1. 动态缩短:从 56 字节缩短至 24 字节(腾出 32 字节 = 4 words filler + 0 rem)
    let short_val = b"status=idle;score=100000"; // 24 字节
    assert!(rec_mut.can_update_with_slack(short_val.len()));
    rec_mut.update_value_with_slack(short_val)?;

    assert_eq!(rec_mut.val_len(), 24);
    assert_eq!(rec_mut.filler_words(), 4); // 32 / 8 = 4
    assert_eq!(rec_mut.filler_rem(), 0);
    assert_eq!(rec_mut.filler_bytes(), 32);
    assert_eq!(rec_mut.val_capacity(), 56); // 24 + 32 = 56 保持不变
    assert_eq!(rec_mut.physical_size(), initial_physical_size); // 物理占用大小绝对恒定
    assert_eq!(rec_mut.value(), short_val);

    // 用 as_ref() 零拷贝视图回读验证
    let rec_ref = rec_mut.as_ref();
    assert_eq!(rec_ref.value(), short_val);
    assert_eq!(rec_ref.val_len(), 24);
    assert_eq!(rec_ref.filler_words(), 4);
    assert_eq!(rec_ref.filler_rem(), 0);
    assert_eq!(rec_ref.physical_size(), initial_physical_size);

    // 1.1 精细单字节余数测试(非 8 整数倍):更新为 25 字节(腾出 31 字节 = 3 words + 7 rem)
    let non_align_val = b"status=idle;score=100000_"; // 25 字节
    assert!(rec_mut.can_update_with_slack(non_align_val.len()));
    rec_mut.update_value_with_slack(non_align_val)?;
    assert_eq!(rec_mut.val_len(), 25);
    assert_eq!(rec_mut.filler_words(), 3); // 31 / 8 = 3
    assert_eq!(rec_mut.filler_rem(), 7); // 31 % 8 = 7
    assert_eq!(rec_mut.filler_bytes(), 31);
    assert_eq!(rec_mut.val_capacity(), 56);
    assert_eq!(rec_mut.physical_size(), initial_physical_size); // 物理占用绝对无任何漂移!
    assert_eq!(rec_mut.value(), non_align_val);

    // 2. 动态扩充:在松弛空间内扩充至 40 字节(消耗 16 字节,剩余 16 字节 = 2 words filler)
    let medium_val = b"status=active;score=20000;role=moderator"; // 40 字节 (8 * 5)
    assert!(rec_mut.can_update_with_slack(medium_val.len()));
    rec_mut.update_value_with_slack(medium_val)?;

    assert_eq!(rec_mut.val_len(), 40);
    assert_eq!(rec_mut.filler_words(), 2); // (56 - 40) / 8 = 2
    assert_eq!(rec_mut.filler_rem(), 0);
    assert_eq!(rec_mut.filler_bytes(), 16);
    assert_eq!(rec_mut.val_capacity(), 56);
    assert_eq!(rec_mut.physical_size(), initial_physical_size);
    assert_eq!(rec_mut.value(), medium_val);

    // 2.1 墓碑化与单次覆写原子链内原地复活测试(revivify_with_slack)
    rec_mut.set_tombstone(true);
    assert!(rec_mut.is_tombstone());
    assert!(!rec_mut.can_update_with_slack(24)); // 墓碑状态下普通更新应被拦截
    rec_mut.revivify_with_slack(short_val)?;
    assert!(!rec_mut.is_tombstone());
    assert_eq!(rec_mut.val_len(), 24);
    assert_eq!(rec_mut.filler_bytes(), 32);
    assert_eq!(rec_mut.val_capacity(), 56);
    assert_eq!(rec_mut.physical_size(), initial_physical_size);
    assert_eq!(rec_mut.value(), short_val);

    // 3. 动态填满:恢复到 56 字节(消耗完所有 filler)
    rec_mut.update_value_with_slack(initial_val)?;
    assert_eq!(rec_mut.val_len(), 56);
    assert_eq!(rec_mut.filler_words(), 0);
    assert_eq!(rec_mut.filler_rem(), 0);
    assert_eq!(rec_mut.val_capacity(), 56);
    assert_eq!(rec_mut.value(), initial_val);

    // 4. 超出容量(60 字节)必须被拦截
    let overflow_val = b"status=active;score=987654;role=admin;meta=verified_2026_exceed_cap"; // 67 字节
    assert!(!rec_mut.can_update_with_slack(overflow_val.len()));
    let err = rec_mut.update_value_with_slack(overflow_val);
    assert_eq!(
      err,
      Err(Error::ValueLengthMismatch {
        expected: 56,
        actual: 67,
      })
    );
  }

  // 最终从底层原始字节完全回读验证
  let final_ref = RecordRef::from_slice(&buf)?;
  assert_eq!(final_ref.value(), initial_val);
  assert_eq!(final_ref.val_len(), 56);
  assert_eq!(final_ref.filler_words(), 0);
  assert_eq!(final_ref.physical_size(), initial_physical_size);

  info!("FillerWords 动态松弛全生命周期原位覆写与容量自洽测试通过");
  OK
}