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
use ckb_metrics::metrics;
use fail::fail_point;
use lru::LruCache;
use snap::raw::{Decoder as SnappyDecoder, Encoder as SnappyEncoder};
use std::fs::{self, File};
use std::io::{Error as IoError, ErrorKind as IoErrorKind};
use std::io::{Read, Write};
use std::io::{Seek, SeekFrom};
use std::path::{Path, PathBuf};
use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::Arc;
const MAX_FILE_SIZE: u64 = 2 * 1_000 * 1_000 * 1_000;
const OPEN_FILES_LIMIT: usize = 256;
const INDEX_FILE_NAME: &str = "INDEX";
pub(crate) const INDEX_ENTRY_SIZE: u64 = 12;
pub type FileId = u32;
pub(crate) struct Head {
pub(crate) file: File,
pub(crate) bytes: u64,
}
impl Head {
pub fn new(file: File, bytes: u64) -> Self {
Head { file, bytes }
}
pub fn write(&mut self, data: &[u8]) -> Result<(), IoError> {
fail_point!("write-head");
self.file.write_all(data)?;
self.bytes += data.len() as u64;
Ok(())
}
}
pub struct FreezerFiles {
pub(crate) files: LruCache<FileId, File>,
pub(crate) head: Head,
pub(crate) number: Arc<AtomicU64>,
max_size: u64,
pub(crate) tail_id: FileId,
pub(crate) head_id: FileId,
file_path: PathBuf,
pub(crate) index: File,
pub(crate) enable_compression: bool,
}
pub struct IndexEntry {
pub file_id: FileId,
pub offset: u64,
}
impl Default for IndexEntry {
fn default() -> Self {
IndexEntry {
file_id: 0,
offset: 0,
}
}
}
impl IndexEntry {
pub fn encode(&self) -> Vec<u8> {
fail_point!("IndexEntry encode");
let mut bytes = Vec::with_capacity(INDEX_ENTRY_SIZE as usize);
bytes.extend_from_slice(&self.file_id.to_le_bytes());
bytes.extend_from_slice(&self.offset.to_le_bytes());
bytes
}
pub fn decode(raw: &[u8]) -> Result<Self, IoError> {
fail_point!("IndexEntry decode");
debug_assert!(raw.len() == INDEX_ENTRY_SIZE as usize);
let (raw_file_id, raw_offset) = raw.split_at(::std::mem::size_of::<u32>());
let file_id = u32::from_le_bytes(
raw_file_id
.try_into()
.map_err(|e| IoError::new(IoErrorKind::Other, format!("decode file_id {}", e)))?,
);
let offset = u64::from_le_bytes(
raw_offset
.try_into()
.map_err(|e| IoError::new(IoErrorKind::Other, format!("decode offset {}", e)))?,
);
Ok(IndexEntry { offset, file_id })
}
}
impl FreezerFiles {
pub fn open(file_path: PathBuf) -> Result<FreezerFiles, IoError> {
let mut files = FreezerFilesBuilder::new(file_path).build()?;
files.preopen()?;
Ok(files)
}
#[inline]
pub fn number(&self) -> u64 {
self.number.load(Ordering::SeqCst)
}
pub fn append(&mut self, number: u64, input: &[u8]) -> Result<(), IoError> {
let expected = self.number.load(Ordering::SeqCst);
fail_point!("append-unexpected-number");
if expected != number {
return Err(IoError::new(
IoErrorKind::Other,
format!(
"appending unexpected block expected {} have {}",
expected, number
),
));
}
#[allow(unused_mut)]
let mut compressed_data;
let mut data = input;
if self.enable_compression {
compressed_data = SnappyEncoder::new()
.compress_vec(data)
.map_err(|e| IoError::new(IoErrorKind::Other, format!("compress error {}", e)))?;
data = &compressed_data;
};
let data_size = data.len();
if self.head.bytes + data_size as u64 > self.max_size {
let head_id = self.head_id;
let next_id = head_id + 1;
let new_head_file = self.open_truncated(next_id)?;
self.release(head_id);
self.open_read_only(head_id)?;
self.head_id = next_id;
self.head = Head::new(new_head_file, 0);
}
self.head.write(data)?;
self.write_index(self.head_id, self.head.bytes)?;
self.number.fetch_add(1, Ordering::SeqCst);
metrics!(
gauge,
"ckb-freezer.size",
data_size as i64 + INDEX_ENTRY_SIZE as i64
);
Ok(())
}
pub fn sync_all(&self) -> Result<(), IoError> {
self.head.file.sync_all()?;
self.index.sync_all()?;
Ok(())
}
pub fn retrieve(&mut self, item: u64) -> Result<Option<Vec<u8>>, IoError> {
if item < 1 {
return Ok(None);
}
if self.number.load(Ordering::SeqCst) <= item {
return Ok(None);
}
let bounds = self.get_bounds(item)?;
if let Some((start_offset, end_offset, file_id)) = bounds {
let open_read_only;
let mut file = if let Some(file) = self.files.get(&file_id) {
file
} else {
open_read_only = self.open_read_only(file_id)?;
&open_read_only
};
let size = (end_offset - start_offset) as usize;
let mut data = vec![0u8; size];
file.seek(SeekFrom::Start(start_offset))?;
file.read_exact(&mut data)?;
if self.enable_compression {
data = SnappyDecoder::new().decompress_vec(&data).map_err(|e| {
IoError::new(
IoErrorKind::Other,
format!(
"decompress file-id-{} offset-{} size-{}: error {}",
file_id, start_offset, size, e
),
)
})?;
}
metrics!(
counter,
"ckb-freezer.read",
size as u64 + 2 * INDEX_ENTRY_SIZE
);
Ok(Some(data))
} else {
Ok(None)
}
}
fn get_bounds(&self, item: u64) -> Result<Option<(u64, u64, FileId)>, IoError> {
let mut buffer = [0; INDEX_ENTRY_SIZE as usize];
let mut index = &self.index;
if let Err(e) = index.seek(SeekFrom::Start(item * INDEX_ENTRY_SIZE)) {
ckb_logger::trace!("Freezer get_bounds seek {} {}", item * INDEX_ENTRY_SIZE, e);
return Ok(None);
}
if let Err(e) = index.read_exact(&mut buffer) {
ckb_logger::trace!("Freezer get_bounds read_exact {}", e);
return Ok(None);
}
let end_index = IndexEntry::decode(&buffer)?;
if item == 1 {
return Ok(Some((0, end_index.offset, end_index.file_id)));
}
if let Err(e) = index.seek(SeekFrom::Start((item - 1) * INDEX_ENTRY_SIZE)) {
ckb_logger::trace!(
"Freezer get_bounds seek {} {}",
(item - 1) * INDEX_ENTRY_SIZE,
e
);
return Ok(None);
}
if let Err(e) = index.read_exact(&mut buffer) {
ckb_logger::trace!("Freezer get_bounds read_exact {}", e);
return Ok(None);
}
let start_index = IndexEntry::decode(&buffer)?;
if start_index.file_id != end_index.file_id {
return Ok(Some((0, end_index.offset, end_index.file_id)));
}
Ok(Some((
start_index.offset,
end_index.offset,
end_index.file_id,
)))
}
pub fn truncate(&mut self, item: u64) -> Result<(), IoError> {
if item < 1 || ((item + 1) >= self.number()) {
return Ok(());
}
ckb_logger::trace!("Freezer truncate items {}", item);
let mut buffer = [0; INDEX_ENTRY_SIZE as usize];
helper::truncate_file(&mut self.index, (item + 1) * INDEX_ENTRY_SIZE)?;
self.index.seek(SeekFrom::Start(item * INDEX_ENTRY_SIZE))?;
self.index.read_exact(&mut buffer)?;
let new_index = IndexEntry::decode(&buffer)?;
if new_index.file_id != self.head_id {
self.release(new_index.file_id);
let (new_head_file, offset) = self.open_append(new_index.file_id)?;
self.delete_after(new_index.file_id)?;
self.head_id = new_index.file_id;
self.head = Head::new(new_head_file, offset);
}
helper::truncate_file(&mut self.head.file, new_index.offset)?;
self.head.bytes = new_index.offset;
self.number.store(item + 1, Ordering::SeqCst);
Ok(())
}
pub fn preopen(&mut self) -> Result<(), IoError> {
self.release_all();
for id in self.tail_id..self.head_id {
self.open_read_only(id)?;
}
self.files.put(self.head_id, self.head.file.try_clone()?);
Ok(())
}
fn write_index(&mut self, file_id: FileId, offset: u64) -> Result<(), IoError> {
fail_point!("write-index");
let index = IndexEntry { file_id, offset };
self.index.seek(SeekFrom::End(0))?;
self.index.write_all(&index.encode())?;
Ok(())
}
fn release(&mut self, id: FileId) {
self.files.pop(&id);
}
fn release_all(&mut self) {
self.files.clear();
}
fn delete_after(&mut self, id: FileId) -> Result<(), IoError> {
let released: Vec<_> = self
.files
.iter()
.filter_map(|(k, _)| if k > &id { Some(k) } else { None })
.copied()
.collect();
for k in released.iter() {
self.files.pop(k);
}
self.delete_files_by_id(released.into_iter())
}
fn delete_files_by_id(&self, file_ids: impl Iterator<Item = FileId>) -> Result<(), IoError> {
for file_id in file_ids {
let path = self.file_path.join(helper::file_name(file_id));
fs::remove_file(path)?;
}
Ok(())
}
fn open_read_only(&mut self, id: FileId) -> Result<File, IoError> {
fail_point!("open_read_only");
let mut opt = fs::OpenOptions::new();
opt.read(true);
self.open_file(id, opt)
}
fn open_truncated(&mut self, id: FileId) -> Result<File, IoError> {
fail_point!("open_truncated");
let mut opt = fs::OpenOptions::new();
opt.create(true).read(true).write(true).truncate(true);
self.open_file(id, opt)
}
fn open_append(&mut self, id: FileId) -> Result<(File, u64), IoError> {
fail_point!("open_append");
let mut opt = fs::OpenOptions::new();
opt.create(true).read(true).write(true);
let mut file = self.open_file(id, opt)?;
let offset = file.seek(SeekFrom::End(0))?;
Ok((file, offset))
}
fn open_file(&mut self, id: FileId, opt: fs::OpenOptions) -> Result<File, IoError> {
let name = helper::file_name(id);
let file = opt.open(self.file_path.join(name))?;
self.files.put(id, file.try_clone()?);
Ok(file)
}
}
pub struct FreezerFilesBuilder {
file_path: PathBuf,
max_file_size: u64,
enable_compression: bool,
open_files_limit: usize,
}
impl FreezerFilesBuilder {
pub fn new(file_path: PathBuf) -> Self {
FreezerFilesBuilder {
file_path,
max_file_size: MAX_FILE_SIZE,
enable_compression: true,
open_files_limit: OPEN_FILES_LIMIT,
}
}
#[allow(dead_code)]
pub fn max_file_size(mut self, size: u64) -> Self {
self.max_file_size = size;
self
}
#[allow(dead_code)]
pub fn open_files_limit(mut self, limit: usize) -> Self {
assert!(limit > 1);
self.open_files_limit = limit;
self
}
#[allow(dead_code)]
pub fn enable_compression(mut self, enable_compression: bool) -> Self {
self.enable_compression = enable_compression;
self
}
pub fn build(self) -> Result<FreezerFiles, IoError> {
fs::create_dir_all(&self.file_path)?;
let (mut index, mut index_size) = self.open_index()?;
let mut buffer = [0; INDEX_ENTRY_SIZE as usize];
index.seek(SeekFrom::Start(0))?;
index.read_exact(&mut buffer)?;
let tail_index = IndexEntry::decode(&buffer)?;
let tail_id = tail_index.file_id;
index.seek(SeekFrom::Start(index_size - INDEX_ENTRY_SIZE))?;
index.read_exact(&mut buffer)?;
ckb_logger::debug!("Freezer index_size {} head {:?}", index_size, buffer);
let mut head_index = IndexEntry::decode(&buffer)?;
let head_file_name = helper::file_name(head_index.file_id);
let (mut head, mut head_size) = self.open_append(self.file_path.join(head_file_name))?;
let mut expect_head_size = head_index.offset;
while expect_head_size != head_size {
if expect_head_size < head_size {
ckb_logger::warn!(
"Truncating dangling head {} {}",
head_size,
expect_head_size,
);
helper::truncate_file(&mut head, expect_head_size)?;
head_size = expect_head_size;
}
if expect_head_size > head_size {
ckb_logger::warn!(
"Truncating dangling indexes {} {}",
head_size,
expect_head_size,
);
helper::truncate_file(&mut index, index_size - INDEX_ENTRY_SIZE)?;
index_size -= INDEX_ENTRY_SIZE;
index.seek(SeekFrom::Start(index_size - INDEX_ENTRY_SIZE))?;
index.read_exact(&mut buffer)?;
let new_index = IndexEntry::decode(&buffer)?;
if new_index.file_id != head_index.file_id {
let head_file_name = helper::file_name(head_index.file_id);
let (new_head, size) = self.open_append(self.file_path.join(head_file_name))?;
head = new_head;
head_size = size;
}
expect_head_size = new_index.offset;
head_index = new_index;
}
}
head.sync_all()?;
index.sync_all()?;
let number = index_size / INDEX_ENTRY_SIZE;
Ok(FreezerFiles {
files: LruCache::new(self.open_files_limit),
head: Head::new(head, head_size),
tail_id,
number: Arc::new(AtomicU64::new(number)),
max_size: self.max_file_size,
head_id: head_index.file_id,
file_path: self.file_path,
index,
enable_compression: self.enable_compression,
})
}
fn open_append<P: AsRef<Path>>(&self, path: P) -> Result<(File, u64), IoError> {
let mut file = fs::OpenOptions::new()
.create(true)
.read(true)
.write(true)
.open(path)?;
let offset = file.seek(SeekFrom::End(0))?;
Ok((file, offset))
}
fn open_index(&self) -> Result<(File, u64), IoError> {
let (mut index, mut size) = self.open_append(self.file_path.join(INDEX_FILE_NAME))?;
if size == 0 {
index.write_all(&IndexEntry::default().encode())?;
size += INDEX_ENTRY_SIZE;
}
let tail = size % INDEX_ENTRY_SIZE;
if (tail != 0) && (size != 0) {
size -= tail;
helper::truncate_file(&mut index, size)?;
}
Ok((index, size))
}
}
pub(crate) mod helper {
use super::*;
pub(crate) fn truncate_file(file: &mut File, size: u64) -> Result<(), IoError> {
file.set_len(size)?;
file.seek(SeekFrom::End(0))?;
Ok(())
}
#[inline]
pub(crate) fn file_name(file_id: FileId) -> String {
format!("blk{:06}", file_id)
}
}