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
use std::sync::Arc;
use std::sync::atomic::AtomicBool;
use self::reader::LogReader;
use super::*;
#[doc(hidden)]
pub const MSG_HEADER_LEN: usize = 15;
#[doc(hidden)]
pub const SEG_HEADER_LEN: usize = 18;
#[doc(hidden)]
pub const SEG_TRAILER_LEN: usize = 10;
pub struct Log {
iobufs: Arc<IoBufs>,
config: FinalConfig,
flusher_shutdown: Arc<AtomicBool>,
flusher_handle: Option<std::thread::JoinHandle<()>>,
}
unsafe impl Send for Log {}
unsafe impl Sync for Log {}
impl Drop for Log {
fn drop(&mut self) {
self.flusher_shutdown.store(
true,
std::sync::atomic::Ordering::SeqCst,
);
if let Some(join_handle) = self.flusher_handle.take() {
join_handle.join().unwrap();
}
#[cfg(feature = "cpuprofiler")]
{
cpuprofiler::PROFILER.lock().unwrap().stop().unwrap();
}
}
}
impl Log {
pub fn start<R>(config: FinalConfig, snapshot: Snapshot<R>) -> Log {
let iobufs = Arc::new(IoBufs::start(config.clone(), snapshot));
let flusher_shutdown = Arc::new(AtomicBool::new(false));
let flusher_handle =
config.get_flush_every_ms().map(|flush_every_ms| {
periodic_flusher::flusher(
"log flusher".to_owned(),
Arc::clone(&iobufs),
Arc::clone(&flusher_shutdown),
flush_every_ms,
).unwrap()
});
Log {
iobufs: iobufs,
config: config,
flusher_shutdown: flusher_shutdown,
flusher_handle: flusher_handle,
}
}
pub fn start_raw_log(config: FinalConfig) -> Log {
let log_iter = raw_segment_iter_from(0, &config);
let snapshot = advance_snapshot::<NullMaterializer, (), ()>(
log_iter,
Snapshot::default(),
&config,
);
Log::start::<()>(config, snapshot)
}
pub fn flush(&self) {
for _ in 0..self.config.get_io_bufs() {
self.iobufs.flush();
}
}
pub fn reserve(&self, buf: Vec<u8>) -> Reservation {
self.iobufs.reserve(buf)
}
pub fn write(&self, buf: Vec<u8>) -> (Lsn, LogID) {
self.iobufs.reserve(buf).complete()
}
pub fn iter_from(&self, lsn: Lsn) -> LogIter {
trace!("iterating from lsn {}", lsn);
let io_buf_size = self.config.get_io_buf_size();
let segment_base_lsn = lsn / io_buf_size as Lsn * io_buf_size as Lsn;
let min_lsn = segment_base_lsn + SEG_HEADER_LEN as Lsn;
let corrected_lsn = std::cmp::max(lsn, min_lsn);
let segment_iter =
self.with_sa(|sa| sa.segment_snapshot_iter_from(corrected_lsn));
LogIter {
config: self.config.clone(),
max_lsn: self.stable_offset(),
cur_lsn: corrected_lsn,
segment_base: None,
segment_iter: segment_iter,
segment_len: io_buf_size,
use_compression: self.config.get_use_compression(),
trailer: None,
}
}
pub fn read(&self, lsn: Lsn, lid: LogID) -> io::Result<LogRead> {
trace!("reading log lsn {} lid {}", lsn, lid);
self.make_stable(lsn);
let f = self.config.file();
let read = f.read_message(
lid,
self.config.get_io_buf_size(),
self.config.get_use_compression(),
);
read.and_then(|log_read| match log_read {
LogRead::Flush(read_lsn, _, _) => {
assert_eq!(lsn, read_lsn);
Ok(log_read)
}
_ => Ok(log_read),
})
}
pub fn stable_offset(&self) -> Lsn {
self.iobufs.stable()
}
pub fn make_stable(&self, lsn: Lsn) {
let start = clock();
while self.iobufs.stable() < lsn {
self.iobufs.flush();
let waiter = self.iobufs.intervals.lock().unwrap();
if self.iobufs.stable() < lsn {
trace!("waiting on cond var for make_stable({})", lsn);
let _waiter =
self.iobufs.interval_updated.wait(waiter).unwrap();
} else {
trace!("make_stable({}) returning", lsn);
break;
}
}
M.make_stable.measure(clock() - start);
}
pub(in io) fn with_sa<B, F>(&self, f: F) -> B
where F: FnOnce(&mut SegmentAccountant) -> B
{
self.iobufs.with_sa(f)
}
}
#[derive(Debug, Copy, Clone, PartialEq)]
pub(crate) struct MessageHeader {
pub successful_flush: bool,
pub lsn: Lsn,
pub len: usize,
pub crc16: [u8; 2],
}
#[derive(Debug, Copy, Clone, PartialEq)]
pub(crate) struct SegmentHeader {
pub lsn: Lsn,
pub prev: LogID,
pub ok: bool,
}
#[derive(Debug, Copy, Clone, PartialEq)]
pub(crate) struct SegmentTrailer {
pub lsn: Lsn,
pub ok: bool,
}
#[doc(hidden)]
#[derive(Debug)]
pub enum LogRead {
Flush(Lsn, Vec<u8>, usize),
Zeroed(usize),
Corrupted(usize),
}
impl LogRead {
pub fn flush(self) -> Option<(Lsn, Vec<u8>, usize)> {
match self {
LogRead::Flush(lsn, bytes, len) => Some((lsn, bytes, len)),
_ => None,
}
}
pub fn is_flush(&self) -> bool {
match *self {
LogRead::Flush(_, _, _) => true,
_ => false,
}
}
pub fn is_zeroed(&self) -> bool {
match *self {
LogRead::Zeroed(_) => true,
_ => false,
}
}
pub fn is_corrupt(&self) -> bool {
match *self {
LogRead::Corrupted(_) => true,
_ => false,
}
}
pub fn unwrap(self) -> (Lsn, Vec<u8>, usize) {
match self {
LogRead::Flush(lsn, bytes, len) => (lsn, bytes, len),
_ => panic!("called unwrap on a non-flush LogRead"),
}
}
pub fn expect<'a>(self, msg: &'a str) -> (Lsn, Vec<u8>, usize) {
match self {
LogRead::Flush(lsn, bytes, len) => (lsn, bytes, len),
_ => panic!("{}", msg),
}
}
}
impl From<[u8; MSG_HEADER_LEN]> for MessageHeader {
fn from(buf: [u8; MSG_HEADER_LEN]) -> MessageHeader {
let valid = buf[0] == 1;
let lsn_buf = &buf[1..9];
let mut lsn_arr = [0u8; 8];
lsn_arr.copy_from_slice(&*lsn_buf);
let lsn: Lsn = unsafe { std::mem::transmute(lsn_arr) };
let len_buf = &buf[9..13];
let mut len_arr = [0u8; 4];
len_arr.copy_from_slice(&*len_buf);
let len: u32 = unsafe { std::mem::transmute(len_arr) };
let crc16 = [buf[13] ^ 0xFF, buf[14] ^ 0xFF];
MessageHeader {
successful_flush: valid,
lsn: lsn,
len: len as usize,
crc16: crc16,
}
}
}
impl Into<[u8; MSG_HEADER_LEN]> for MessageHeader {
fn into(self) -> [u8; MSG_HEADER_LEN] {
let mut buf = [0u8; MSG_HEADER_LEN];
if self.successful_flush {
buf[0] = 1;
}
let lsn_arr: [u8; 8] = unsafe { std::mem::transmute(self.lsn) };
buf[1..9].copy_from_slice(&lsn_arr);
let len_arr: [u8; 4] = unsafe { std::mem::transmute(self.len as u32) };
buf[9..13].copy_from_slice(&len_arr);
buf[13] = self.crc16[0] ^ 0xFF;
buf[14] = self.crc16[1] ^ 0xFF;
buf
}
}
impl From<[u8; SEG_HEADER_LEN]> for SegmentHeader {
fn from(buf: [u8; SEG_HEADER_LEN]) -> SegmentHeader {
let crc16 = [buf[0] ^ 0xFF, buf[1] ^ 0xFF];
let lsn_buf = &buf[2..10];
let mut lsn_arr = [0u8; 8];
lsn_arr.copy_from_slice(&*lsn_buf);
let xor_lsn: Lsn = unsafe { std::mem::transmute(lsn_arr) };
let lsn = xor_lsn ^ 0xFFFF_FFFF;
let prev_lid_buf = &buf[10..18];
let mut prev_lid_arr = [0u8; 8];
prev_lid_arr.copy_from_slice(&*prev_lid_buf);
let xor_prev_lid: LogID = unsafe { std::mem::transmute(prev_lid_arr) };
let prev_lid = xor_prev_lid ^ 0xFFFF_FFFF_FFFF_FFFF;
let crc16_tested = crc16_arr(&prev_lid_arr);
SegmentHeader {
lsn: lsn,
prev: prev_lid,
ok: crc16_tested == crc16,
}
}
}
impl Into<[u8; SEG_HEADER_LEN]> for SegmentHeader {
fn into(self) -> [u8; SEG_HEADER_LEN] {
let mut buf = [0u8; SEG_HEADER_LEN];
let xor_lsn = self.lsn ^ 0xFFFF_FFFF;
let lsn_arr: [u8; 8] = unsafe { std::mem::transmute(xor_lsn) };
buf[2..10].copy_from_slice(&lsn_arr);
let xor_prev_lid = self.prev ^ 0xFFFF_FFFF_FFFF_FFFF;
let prev_lid_arr: [u8; 8] =
unsafe { std::mem::transmute(xor_prev_lid) };
buf[10..18].copy_from_slice(&prev_lid_arr);
let crc16 = crc16_arr(&prev_lid_arr);
buf[0] = crc16[0] ^ 0xFF;
buf[1] = crc16[1] ^ 0xFF;
buf
}
}
impl From<[u8; SEG_TRAILER_LEN]> for SegmentTrailer {
fn from(buf: [u8; SEG_TRAILER_LEN]) -> SegmentTrailer {
let crc16 = [buf[0] ^ 0xFF, buf[1] ^ 0xFF];
let lsn_buf = &buf[2..10];
let mut lsn_arr = [0u8; 8];
lsn_arr.copy_from_slice(&*lsn_buf);
let xor_lsn: Lsn = unsafe { std::mem::transmute(lsn_arr) };
let lsn = xor_lsn ^ 0xFFFF_FFFF;
let crc16_tested = crc16_arr(&lsn_arr);
SegmentTrailer {
lsn: lsn,
ok: crc16_tested == crc16,
}
}
}
impl Into<[u8; SEG_TRAILER_LEN]> for SegmentTrailer {
fn into(self) -> [u8; SEG_TRAILER_LEN] {
let mut buf = [0u8; SEG_TRAILER_LEN];
let xor_lsn = self.lsn ^ 0xFFFF_FFFF;
let lsn_arr: [u8; 8] = unsafe { std::mem::transmute(xor_lsn) };
buf[2..10].copy_from_slice(&lsn_arr);
let crc16 = crc16_arr(&lsn_arr);
buf[0] = crc16[0] ^ 0xFF;
buf[1] = crc16[1] ^ 0xFF;
buf
}
}