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
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
// Copyright (c) 2017-present, PingCAP, Inc. Licensed under Apache-2.0.

use std::collections::VecDeque;
use std::fs::File as StdFile;
use std::path::PathBuf;
use std::sync::Arc;

use crossbeam::utils::CachePadded;
use fail::fail_point;
use log::error;
use parking_lot::{Mutex, MutexGuard, RwLock};

use crate::config::Config;
use crate::env::{FileSystem, Permission};
use crate::errors::is_no_space_err;
use crate::event_listener::EventListener;
use crate::metrics::*;
use crate::pipe_log::{
    FileBlockHandle, FileId, FileSeq, LogFileContext, LogQueue, PipeLog, ReactiveBytes,
};
use crate::{perf_context, Error, Result};

use super::format::{build_reserved_file_name, FileNameExt, LogFileFormat};
use super::log_file::build_file_reader;
use super::log_file::{build_file_writer, LogFileWriter};

pub type PathId = usize;
pub type Paths = Vec<PathBuf>;

/// Main directory path id.
pub const DEFAULT_PATH_ID: PathId = 0;
/// FileSeq of logs must start from `1` by default to keep backward
/// compatibility.
pub const DEFAULT_FIRST_FILE_SEQ: FileSeq = 1;

pub struct File<F: FileSystem> {
    pub seq: FileSeq,
    pub handle: Arc<F::Handle>,
    pub format: LogFileFormat,
    pub path_id: PathId,
    pub reserved: bool,
}

struct WritableFile<F: FileSystem> {
    pub seq: FileSeq,
    pub writer: LogFileWriter<F>,
    pub format: LogFileFormat,
}

/// A file-based log storage that arranges files as one single queue.
pub(super) struct SinglePipe<F: FileSystem> {
    queue: LogQueue,
    paths: Paths,
    file_system: Arc<F>,
    listeners: Vec<Arc<dyn EventListener>>,
    default_format: LogFileFormat,
    target_file_size: usize,

    capacity: usize,
    active_files: CachePadded<RwLock<VecDeque<File<F>>>>,
    /// This contains both reserved files and files recycled from
    /// `active_files`.
    recycled_files: CachePadded<RwLock<VecDeque<File<F>>>>,

    /// The log file opened for write.
    ///
    /// `writable_file` must be locked first to acquire both `files` and
    /// `writable_file`
    writable_file: CachePadded<Mutex<WritableFile<F>>>,
}

impl<F: FileSystem> Drop for SinglePipe<F> {
    fn drop(&mut self) {
        let mut writable_file = self.writable_file.lock();
        if let Err(e) = writable_file.writer.close() {
            error!("error while closing the active writer: {e}");
        }
        let mut recycled_files = self.recycled_files.write();
        let mut next_reserved_seq = recycled_files
            .iter()
            .rev()
            .find_map(|f| if f.reserved { Some(f.seq + 1) } else { None })
            .unwrap_or(DEFAULT_FIRST_FILE_SEQ);
        while let Some(f) = recycled_files.pop_back() {
            if f.reserved {
                break;
            }
            let file_id = FileId::new(self.queue, f.seq);
            let path = file_id.build_file_path(&self.paths[f.path_id]);
            let dst = self.paths[0].join(build_reserved_file_name(next_reserved_seq));
            if let Err(e) = self.file_system.reuse(path, dst) {
                error!("error while renaming recycled file during shutdown: {}", e);
            } else {
                next_reserved_seq += 1;
            }
        }
    }
}

impl<F: FileSystem> SinglePipe<F> {
    /// Opens a new [`SinglePipe`].
    pub fn open(
        cfg: &Config,
        paths: Paths,
        file_system: Arc<F>,
        listeners: Vec<Arc<dyn EventListener>>,
        queue: LogQueue,
        mut active_files: Vec<File<F>>,
        recycled_files: Vec<File<F>>,
    ) -> Result<Self> {
        let alignment = || {
            fail_point!("file_pipe_log::open::force_set_alignment", |_| { 16 });
            0
        };
        let default_format = LogFileFormat::new(cfg.format_version, alignment());

        // Open or create active file.
        let no_active_files = active_files.is_empty();
        if no_active_files {
            let path_id = find_available_dir(&paths, cfg.target_file_size.0 as usize);
            let file_id = FileId::new(queue, DEFAULT_FIRST_FILE_SEQ);
            let path = file_id.build_file_path(&paths[path_id]);
            active_files.push(File {
                seq: file_id.seq,
                handle: file_system.create(path)?.into(),
                format: default_format,
                path_id,
                reserved: false,
            });
        }
        let f = active_files.last().unwrap();
        // If starting from active_files.emtpy(), we should reset the first file with
        // given file format.
        let writable_file = WritableFile {
            seq: f.seq,
            writer: build_file_writer(
                file_system.as_ref(),
                f.handle.clone(),
                f.format,
                no_active_files, /* force_reset */
            )?,
            format: f.format,
        };

        let (len, recycled_len) = (active_files.len(), recycled_files.len());
        for f in active_files.iter() {
            for listener in &listeners {
                listener.post_new_log_file(FileId { queue, seq: f.seq });
            }
        }

        let pipe = Self {
            queue,
            paths,
            file_system,
            listeners,
            default_format,
            target_file_size: cfg.target_file_size.0 as usize,
            capacity: if queue == LogQueue::Append {
                cfg.recycle_capacity()
            } else {
                0
            },
            active_files: RwLock::new(active_files.into()).into(),
            recycled_files: RwLock::new(recycled_files.into()).into(),
            writable_file: Mutex::new(writable_file).into(),
        };
        pipe.flush_metrics(len);
        pipe.flush_recycle_metrics(recycled_len);
        Ok(pipe)
    }

    /// Synchronizes all metadatas associated with the working directory to the
    /// filesystem.
    fn sync_dir(&self, path_id: PathId) -> Result<()> {
        debug_assert!(!self.paths.is_empty());

        // Skip syncing directory in Windows. Refer to badger's discussion for more
        // detail: https://github.com/dgraph-io/badger/issues/699
        #[cfg(not(windows))]
        std::fs::File::open(PathBuf::from(&self.paths[path_id])).and_then(|d| d.sync_all())?;
        Ok(())
    }

    /// Recycles one obsolete file from the recycled file list and return its
    /// [`PathId`] and [`F::Handle`] if success.
    fn recycle_file(&self, seq: FileSeq) -> Option<Result<(PathId, F::Handle)>> {
        let new_file_id = FileId {
            seq,
            queue: self.queue,
        };
        let (recycle_file, recycle_len) = {
            let mut recycled_files = self.recycled_files.write();
            (recycled_files.pop_front(), recycled_files.len())
        };
        if let Some(f) = recycle_file {
            let fname = if f.reserved {
                build_reserved_file_name(f.seq)
            } else {
                FileId::new(self.queue, f.seq).build_file_name()
            };
            let src_path = self.paths[f.path_id].join(fname);
            let dst_path = new_file_id.build_file_path(&self.paths[f.path_id]);
            if let Err(e) = self.file_system.reuse(&src_path, &dst_path) {
                error!("error while trying to reuse recycled file, err: {e}");
                if let Err(e) = self.file_system.delete(&src_path) {
                    error!("error while trying to delete recycled file, err: {e}");
                }
            } else {
                self.flush_recycle_metrics(recycle_len);
                return match self.file_system.open(&dst_path, Permission::ReadWrite) {
                    Ok(handle) => Some(Ok((f.path_id, handle))),
                    Err(e) => Some(Err(e.into())),
                };
            }
        }
        None
    }

    /// Creates a new log file according to the given [`FileSeq`].
    fn new_file(&self, seq: FileSeq) -> Result<(PathId, F::Handle)> {
        let new_file_id = FileId {
            seq,
            queue: self.queue,
        };
        let path_id = find_available_dir(&self.paths, self.target_file_size);
        let path = new_file_id.build_file_path(&self.paths[path_id]);
        Ok((path_id, self.file_system.create(path)?))
    }

    /// Returns a shared [`LogFd`] for the specified file sequence number.
    fn get_fd(&self, file_seq: FileSeq) -> Result<Arc<F::Handle>> {
        let files = self.active_files.read();
        if !(files[0].seq..files[0].seq + files.len() as u64).contains(&file_seq) {
            return Err(Error::Corruption("file seqno out of range".to_owned()));
        }
        Ok(files[(file_seq - files[0].seq) as usize].handle.clone())
    }

    /// Creates a new file for write, and rotates the active log file.
    ///
    /// This operation is atomic in face of errors.
    fn rotate_imp(&self, writable_file: &mut MutexGuard<WritableFile<F>>) -> Result<()> {
        let _t = StopWatch::new((
            &*LOG_ROTATE_DURATION_HISTOGRAM,
            perf_context!(log_rotate_duration),
        ));
        let new_seq = writable_file.seq + 1;
        debug_assert!(new_seq > DEFAULT_FIRST_FILE_SEQ);

        writable_file.writer.close()?;

        let (path_id, handle) = self
            .recycle_file(new_seq)
            .unwrap_or_else(|| self.new_file(new_seq))?;
        let f = File::<F> {
            seq: new_seq,
            handle: handle.into(),
            format: self.default_format,
            path_id,
            reserved: false,
        };
        let mut new_file = WritableFile {
            seq: new_seq,
            writer: build_file_writer(
                self.file_system.as_ref(),
                f.handle.clone(),
                f.format,
                true, /* force_reset */
            )?,
            format: f.format,
        };
        // File header must be persisted. This way we can recover gracefully if power
        // loss before a new entry is written.
        new_file.writer.sync()?;
        self.sync_dir(path_id)?;

        **writable_file = new_file;
        let len = {
            let mut files = self.active_files.write();
            files.push_back(f);
            files.len()
        };
        self.flush_metrics(len);
        for listener in &self.listeners {
            listener.post_new_log_file(FileId {
                queue: self.queue,
                seq: new_seq,
            });
        }
        Ok(())
    }

    /// Synchronizes current states to related metrics.
    fn flush_metrics(&self, len: usize) {
        match self.queue {
            LogQueue::Append => LOG_FILE_COUNT.append.set(len as i64),
            LogQueue::Rewrite => LOG_FILE_COUNT.rewrite.set(len as i64),
        }
    }

    /// Synchronizes current recycled states to related metrics.
    fn flush_recycle_metrics(&self, len: usize) {
        match self.queue {
            LogQueue::Append => RECYCLED_FILE_COUNT.append.set(len as i64),
            LogQueue::Rewrite => RECYCLED_FILE_COUNT.rewrite.set(len as i64),
        }
    }
}

impl<F: FileSystem> SinglePipe<F> {
    fn read_bytes(&self, handle: FileBlockHandle) -> Result<Vec<u8>> {
        let fd = self.get_fd(handle.id.seq)?;
        // As the header of each log file already parsed in the processing of loading
        // log files, we just need to build the `LogFileReader`.
        let mut reader = build_file_reader(self.file_system.as_ref(), fd)?;
        reader.read(handle)
    }

    fn append<T: ReactiveBytes + ?Sized>(&self, bytes: &mut T) -> Result<FileBlockHandle> {
        fail_point!("file_pipe_log::append");
        let mut writable_file = self.writable_file.lock();
        if writable_file.writer.offset() >= self.target_file_size {
            if let Err(e) = self.rotate_imp(&mut writable_file) {
                panic!(
                    "error when rotate [{:?}:{}]: {e}",
                    self.queue, writable_file.seq,
                );
            }
        }

        let seq = writable_file.seq;
        let format = writable_file.format;
        let ctx = LogFileContext {
            id: FileId::new(self.queue, seq),
            version: format.version,
        };
        let writer = &mut writable_file.writer;

        #[cfg(feature = "failpoints")]
        {
            use crate::util::round_up;

            let corrupted_padding = || {
                fail_point!("file_pipe_log::append::corrupted_padding", |_| true);
                false
            };
            if format.version.has_log_signing() && format.alignment > 0 {
                let s_off = round_up(writer.offset(), format.alignment as usize);
                if s_off > writer.offset() {
                    let len = s_off - writer.offset();
                    let mut zeros = vec![0; len];
                    if corrupted_padding() {
                        zeros[len - 1] = 8_u8;
                    }
                    writer.write(&zeros, self.target_file_size)?;
                }
            }
        }
        let start_offset = writer.offset();
        if let Err(e) = writer.write(bytes.as_bytes(&ctx), self.target_file_size) {
            if let Err(te) = writer.truncate() {
                panic!("error when truncate {seq} after error: {e}, get: {}", te);
            }
            if is_no_space_err(&e) {
                // TODO: There exists several corner cases should be tackled if
                // `bytes.len()` > `target_file_size`. For example,
                // - [1] main-dir has no recycled logs, and spill-dir have several recycled
                //   logs.
                // - [2] main-dir has several recycled logs, and sum(recycled_logs.size()) <
                //   expected_file_size, but no recycled logs exist in spill-dir.
                // - [3] Both main-dir and spill-dir have several recycled logs.
                // But as `bytes.len()` is always smaller than `target_file_size` in common
                // cases, this issue will be ignored temprorarily.
                if let Err(e) = self.rotate_imp(&mut writable_file) {
                    panic!(
                        "error when rotate [{:?}:{}]: {e}",
                        self.queue, writable_file.seq
                    );
                }
                // If there still exists free space for this record, rotate the file
                // and return a special TryAgain Err (for retry) to the caller.
                return Err(Error::TryAgain(format!(
                    "error when append [{:?}:{seq}]: {e}",
                    self.queue,
                )));
            }
            return Err(Error::Io(e));
        }
        let handle = FileBlockHandle {
            id: FileId {
                queue: self.queue,
                seq,
            },
            offset: start_offset as u64,
            len: writer.offset() - start_offset,
        };
        for listener in &self.listeners {
            listener.on_append_log_file(handle);
        }
        Ok(handle)
    }

    fn sync(&self) -> Result<()> {
        let mut writable_file = self.writable_file.lock();
        let seq = writable_file.seq;
        let writer = &mut writable_file.writer;
        {
            let _t = StopWatch::new(perf_context!(log_sync_duration));
            if let Err(e) = writer.sync() {
                panic!("error when sync [{:?}:{seq}]: {e}", self.queue);
            }
        }

        Ok(())
    }

    fn file_span(&self) -> (FileSeq, FileSeq) {
        let files = self.active_files.read();
        (files[0].seq, files[files.len() - 1].seq)
    }

    fn total_size(&self) -> usize {
        let (first_seq, last_seq) = self.file_span();
        (last_seq - first_seq + 1) as usize * self.target_file_size
    }

    fn rotate(&self) -> Result<()> {
        self.rotate_imp(&mut self.writable_file.lock())
    }

    fn purge_to(&self, file_seq: FileSeq) -> Result<usize> {
        let (len, purged_files) = {
            let mut files = self.active_files.write();
            if !(files[0].seq..files[0].seq + files.len() as u64).contains(&file_seq) {
                return Err(box_err!("FileSeq out of range, cannot be purged"));
            }
            let off = (file_seq - files[0].seq) as usize;
            let mut tail = files.split_off(off);
            std::mem::swap(&mut tail, &mut files);
            (files.len(), tail)
        };
        let purged_len = purged_files.len();
        if purged_len > 0 {
            let remains_capacity = self.capacity.saturating_sub(len);
            let mut recycled_len = self.recycled_files.read().len();
            let mut new_recycled = VecDeque::new();
            // We don't rename the append file because on some platform it could cause I/O
            // jitters. Instead we best-effort rename them during shutdown to reduce
            // recovery time.
            for f in purged_files {
                let file_id = FileId {
                    seq: f.seq,
                    queue: self.queue,
                };
                let path = file_id.build_file_path(&self.paths[f.path_id]);
                // Recycle purged files whose version meets the requirement.
                if f.format.version.has_log_signing() && recycled_len < remains_capacity {
                    new_recycled.push_back(f);
                    recycled_len += 1;
                    continue;
                }
                // Remove purged files which are out of capacity and files whose version is
                // marked not recycled.
                self.file_system.delete(path)?;
            }
            debug_assert!(recycled_len <= remains_capacity);
            self.recycled_files.write().append(&mut new_recycled);
            self.flush_recycle_metrics(recycled_len);
        }
        self.flush_metrics(len);
        Ok(purged_len)
    }
}

/// A [`PipeLog`] implementation that stores data in filesystem.
pub struct DualPipes<F: FileSystem> {
    pipes: [SinglePipe<F>; 2],

    _dir_locks: Vec<StdFile>,
}

impl<F: FileSystem> DualPipes<F> {
    /// Open a new [`DualPipes`]. Assumes the two [`SinglePipe`]s share the
    /// same directory, and that directory is locked by `dir_lock`.
    pub(super) fn open(
        dir_locks: Vec<StdFile>,
        appender: SinglePipe<F>,
        rewriter: SinglePipe<F>,
    ) -> Result<Self> {
        // TODO: remove this dependency.
        debug_assert_eq!(LogQueue::Append as usize, 0);
        debug_assert_eq!(LogQueue::Rewrite as usize, 1);

        Ok(Self {
            pipes: [appender, rewriter],
            _dir_locks: dir_locks,
        })
    }

    #[cfg(test)]
    pub fn file_system(&self) -> Arc<F> {
        self.pipes[0].file_system.clone()
    }
}

impl<F: FileSystem> PipeLog for DualPipes<F> {
    #[inline]
    fn read_bytes(&self, handle: FileBlockHandle) -> Result<Vec<u8>> {
        self.pipes[handle.id.queue as usize].read_bytes(handle)
    }

    #[inline]
    fn append<T: ReactiveBytes + ?Sized>(
        &self,
        queue: LogQueue,
        bytes: &mut T,
    ) -> Result<FileBlockHandle> {
        self.pipes[queue as usize].append(bytes)
    }

    #[inline]
    fn sync(&self, queue: LogQueue) -> Result<()> {
        self.pipes[queue as usize].sync()
    }

    #[inline]
    fn file_span(&self, queue: LogQueue) -> (FileSeq, FileSeq) {
        self.pipes[queue as usize].file_span()
    }

    #[inline]
    fn total_size(&self, queue: LogQueue) -> usize {
        self.pipes[queue as usize].total_size()
    }

    #[inline]
    fn rotate(&self, queue: LogQueue) -> Result<()> {
        self.pipes[queue as usize].rotate()
    }

    #[inline]
    fn purge_to(&self, file_id: FileId) -> Result<usize> {
        self.pipes[file_id.queue as usize].purge_to(file_id.seq)
    }
}

/// Fetch and return a valid `PathId` of the specific directories.
pub(crate) fn find_available_dir(paths: &Paths, target_size: usize) -> PathId {
    fail_point!("file_pipe_log::force_choose_dir", |s| s
        .map_or(DEFAULT_PATH_ID, |n| n.parse::<usize>().unwrap()));
    // Only if one single dir is set by `Config::dir`, can it skip the check of disk
    // space usage.
    if paths.len() > 1 {
        for (t, p) in paths.iter().enumerate() {
            if let Ok(disk_stats) = fs2::statvfs(p) {
                if target_size <= disk_stats.available_space() as usize {
                    return t;
                }
            }
        }
    }
    DEFAULT_PATH_ID
}

#[cfg(test)]
mod tests {
    use std::path::Path;
    use tempfile::Builder;

    use super::super::format::LogFileFormat;
    use super::super::pipe_builder::lock_dir;
    use super::*;
    use crate::env::{DefaultFileSystem, ObfuscatedFileSystem};
    use crate::pipe_log::Version;
    use crate::util::ReadableSize;

    fn new_test_pipe<F: FileSystem>(
        cfg: &Config,
        paths: Paths,
        queue: LogQueue,
        fs: Arc<F>,
    ) -> Result<SinglePipe<F>> {
        SinglePipe::open(cfg, paths, fs, Vec::new(), queue, Vec::new(), Vec::new())
    }

    fn new_test_pipes(cfg: &Config) -> Result<DualPipes<DefaultFileSystem>> {
        DualPipes::open(
            vec![lock_dir(&cfg.dir)?],
            new_test_pipe(
                cfg,
                vec![Path::new(&cfg.dir).to_path_buf()],
                LogQueue::Append,
                Arc::new(DefaultFileSystem),
            )?,
            new_test_pipe(
                cfg,
                vec![Path::new(&cfg.dir).to_path_buf()],
                LogQueue::Rewrite,
                Arc::new(DefaultFileSystem),
            )?,
        )
    }

    #[test]
    fn test_dir_lock() {
        let dir = Builder::new().prefix("test_dir_lock").tempdir().unwrap();
        let path = dir.path().to_str().unwrap();
        let cfg = Config {
            dir: path.to_owned(),
            ..Default::default()
        };

        let _r1 = new_test_pipes(&cfg).unwrap();

        // Only one thread can hold file lock
        let r2 = new_test_pipes(&cfg);

        assert!(format!("{}", r2.err().unwrap())
            .contains("maybe another instance is using this directory"));
    }

    #[test]
    fn test_pipe_log() {
        let dir = Builder::new().prefix("test_pipe_log").tempdir().unwrap();
        let path = dir.path().to_str().unwrap();
        let cfg = Config {
            dir: path.to_owned(),
            target_file_size: ReadableSize::kb(1),
            ..Default::default()
        };
        let queue = LogQueue::Append;

        let pipe_log = new_test_pipes(&cfg).unwrap();
        assert_eq!(pipe_log.file_span(queue), (1, 1));

        let header_size = LogFileFormat::encoded_len(cfg.format_version) as u64;

        // generate file 1, 2, 3
        let content: Vec<u8> = vec![b'a'; 1024];
        let file_handle = pipe_log.append(queue, &mut &content).unwrap();
        assert_eq!(file_handle.id.seq, 1);
        assert_eq!(file_handle.offset, header_size);
        assert_eq!(pipe_log.file_span(queue).1, 1);

        let file_handle = pipe_log.append(queue, &mut &content).unwrap();
        assert_eq!(file_handle.id.seq, 2);
        assert_eq!(file_handle.offset, header_size);
        assert_eq!(pipe_log.file_span(queue).1, 2);

        pipe_log.rotate(queue).unwrap();

        // purge file 1
        assert_eq!(pipe_log.purge_to(FileId { queue, seq: 2 }).unwrap(), 1);
        assert_eq!(pipe_log.file_span(queue).0, 2);

        // cannot purge active file
        assert!(pipe_log.purge_to(FileId { queue, seq: 4 }).is_err());

        // append position
        let s_content = b"short content".to_vec();
        let file_handle = pipe_log.append(queue, &mut &s_content).unwrap();
        assert_eq!(file_handle.id.seq, 3);
        assert_eq!(file_handle.offset, header_size);

        let file_handle = pipe_log.append(queue, &mut &s_content).unwrap();
        assert_eq!(file_handle.id.seq, 3);
        assert_eq!(file_handle.offset, header_size + s_content.len() as u64);

        let content_readed = pipe_log
            .read_bytes(FileBlockHandle {
                id: FileId { queue, seq: 3 },
                offset: header_size,
                len: s_content.len(),
            })
            .unwrap();
        assert_eq!(content_readed, s_content);
        // try to fetch abnormal entry
        let abnormal_content_readed = pipe_log.read_bytes(FileBlockHandle {
            id: FileId { queue, seq: 12 }, // abnormal seq
            offset: header_size,
            len: s_content.len(),
        });
        assert!(abnormal_content_readed.is_err());

        // leave only 1 file to truncate
        pipe_log.purge_to(FileId { queue, seq: 3 }).unwrap();
        assert_eq!(pipe_log.file_span(queue), (3, 3));
    }

    #[test]
    fn test_pipe_log_with_recycle() {
        let dir = Builder::new()
            .prefix("test_pipe_log_with_recycle")
            .tempdir()
            .unwrap();
        let path = dir.path().to_str().unwrap();
        let cfg = Config {
            dir: path.to_owned(),
            target_file_size: ReadableSize(1),
            // super large capacity for recycling
            purge_threshold: ReadableSize::mb(100),
            enable_log_recycle: true,
            format_version: Version::V2,
            ..Default::default()
        };
        let queue = LogQueue::Append;
        let fs = Arc::new(ObfuscatedFileSystem::default());
        let pipe_log =
            new_test_pipe(&cfg, vec![Path::new(&cfg.dir).to_path_buf()], queue, fs).unwrap();
        assert_eq!(pipe_log.file_span(), (1, 1));

        fn content(i: usize) -> Vec<u8> {
            vec![(i % (u8::MAX as usize)) as u8; 16]
        }
        let mut handles = Vec::new();
        for i in 0..10 {
            handles.push(pipe_log.append(&mut &content(i)).unwrap());
            pipe_log.sync().unwrap();
        }
        pipe_log.rotate().unwrap();
        let (first, last) = pipe_log.file_span();
        // Cannot purge already expired logs or not existsed logs.
        assert!(pipe_log.purge_to(first - 1).is_err());
        assert!(pipe_log.purge_to(last + 1).is_err());
        // Retire files.
        assert_eq!(pipe_log.purge_to(last).unwrap() as u64, last - first);
        // Try to read recycled file.
        for (_, handle) in handles.into_iter().enumerate() {
            assert!(pipe_log.read_bytes(handle).is_err());
        }
        // Try to reuse.
        let mut handles = Vec::new();
        for i in 0..10 {
            handles.push(pipe_log.append(&mut &content(i + 1)).unwrap());
            pipe_log.sync().unwrap();
        }
        // Verify the data.
        for (i, handle) in handles.into_iter().enumerate() {
            assert_eq!(pipe_log.read_bytes(handle).unwrap(), content(i + 1));
        }
    }
}