pi_db 0.19.9

Full cache based database,support transaction
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
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
//! 根提交日志与单个日志表的同步拉取式诊断读取器。
//!
//! inspector 在 `MultiTaskRuntime` 上异步 replay/load,但 `new`/`next` 通过有界通道同步等待;
//! 它们是专用、离线、单消费者、单实例一次性使用的诊断工具,不应与在线数据库共享 logger,
//! 也不应放在事务热路径或不能阻塞的 runtime owner 线程中。解析器信任日志由当前 `pi_db`
//! 版本生成,不能把任意不可信字节作为输入。
//!
//! “诊断读取”只表示不修改数据库表数据、不执行 repair。`CommitLogInspector` 使用
//! `start_replay*` 建立稳定遍历边界,底层可以分裂 WAL、调整检查点或把空日志标记为 `.bak`;
//! `LogTableInspector::new` 使用 `LogFile::open`,也可能创建初始日志或整理目录。调用方必须在
//! 已停止生产访问的专用目录/logger 上使用,并允许检查完成后直接结束 runtime/进程。

use std::fmt::Debug;
use std::convert::TryInto;
use std::path::{Path, PathBuf};
use std::io::{Error, Result, ErrorKind};
use std::sync::{Arc,
                atomic::{AtomicIsize, Ordering}};

use crossbeam_channel::{Sender, Receiver, bounded};

use pi_atom::Atom;
use pi_async_rt::rt::{AsyncRuntime, multi_thread::MultiTaskRuntime};
use pi_async_transaction::AsyncCommitLog;
use pi_store::{commit_logger::{CommitLoggerExt, CommitLogger},
               log_store::log_file::{PairLoader, LogMethod, LogFile}};
use pi_guid::Guid;

use crate::{KVTableMeta,
            db::{DEFAULT_DB_TABLES_META_DIR, binary_to_table},
            tables::{KVTable,
                     meta_table::MetaTable}};

/// 逐项检查根提交日志中的事务表动作。
///
/// [`Self::begin`] 与 [`Self::next`] 组成单消费者 pull 协议;
/// [`Self::begin_with_callback`] 是互斥的 callback 协议。实例用原子状态禁止两种协议同时
///启动,但不保证多个线程并发调用 `next` 时响应归属稳定,因此每次检查只应有一个消费者。
/// 每次检查必须使用新实例;底层 replay 的文件与检查点副作用见模块级说明。
pub struct CommitLogInspector {
    rt:                 MultiTaskRuntime<()>,                                           //运行时
    logger:             CommitLogger,                                                   //提交日志
    status:             Arc<AtomicIsize>,                                               //侦听状态
    request_sender:     Sender<()>,                                                     //请求发送器
    request_receiver:   Receiver<()>,                                                   //请求接收器
    response_sender:    Sender<Option<(Guid, Guid, Atom, bool, Vec<u8>, Vec<u8>)>>,     //响应发送器
    response_receiver:  Receiver<Option<(Guid, Guid, Atom, bool, Vec<u8>, Vec<u8>)>>,   //响应接收器
}

// SAFETY: runtime、CommitLogger、channel 和 AtomicIsize 均提供跨线程同步;外层没有裸指针或
// 可变引用。业务层仍须遵守单消费者 `next` 协议。
unsafe impl Send for CommitLogInspector {}
// SAFETY: `&self` 访问只经线程安全句柄和原子状态;并发调用是否有稳定响应归属是协议问题,
// 不会形成内存数据竞争。
unsafe impl Sync for CommitLogInspector {}

impl CommitLogInspector {
    /// 构造一个尚未开始 replay 的根提交日志 inspector。
    ///
    /// O(1),只 clone logger/runtime 并创建容量为 1 的请求/响应通道,不读取文件。logger 和
    /// runtime 必须在后续整个检查期间保持可用;共享句柄由本实例持有。该 logger 必须属于
    /// 已停止生产访问的离线诊断上下文,不能与数据库提交、确认或 collector 并发使用。
    pub fn new(rt: MultiTaskRuntime<()>, logger: CommitLogger) -> Self {
        let (request_sender, request_receiver) = bounded(1);
        let (response_sender, response_receiver) = bounded(1);

        CommitLogInspector {
            rt,
            logger,
            status: Arc::new(AtomicIsize::new(0)),
            request_sender,
            request_receiver,
            response_sender,
            response_receiver,
        }
    }

    /// 启动 pull 模式 replay。
    ///
    /// 返回 `false` 表示本实例已有进行中的 pull 或 callback replay;返回 `true` 仅表示状态已
    /// 切换且任务已提交,不表示 WAL 已成功打开、解析或读取。每个动作都会等待一次
    /// [`Self::next`] 请求,消费者停止调用会让 replay 任务停在通道等待处。`start_replay`
    /// 的正常成功或错误返回都会先配对 `finish_replay`,再发布结束状态;底层错误仅写日志,
    /// 当前不会通过本 API 返回。截断或格式不匹配的 prepare buffer 可能 panic;panic 或
    /// runtime 被终止不属于正常返回,离线调用方应直接废弃该 Inspector 和 runtime。
    pub fn begin(&self) -> bool {
        match self.status.compare_exchange(0, 1, Ordering::Acquire, Ordering::Relaxed) {
            Err(_) => {
                //不允许正在侦听时,开始侦听
                return false;
            },
            Ok(_) => {
                //侦听未开始,则开始侦听
                ()
            },
        }

        let request_receiver = self.request_receiver.clone();
        let response_sender = self.response_sender.clone();

        let inspect_callback = move |commit_uid: Guid, prepare_output: Vec<u8>| -> Result<()> {
            let meta_table_name = Atom::from(DEFAULT_DB_TABLES_META_DIR);
            let bytes_len = prepare_output.len(); //获取日志缓冲区长度
            let mut offset = 0; //日志缓冲区偏移
            let bytes = prepare_output.as_slice();
            let uid = u128::from_le_bytes(bytes[0..16].try_into().unwrap()); //获取事务唯一id
            let transaciton_uid = Guid(uid);
            offset += 16; //移动缓冲区指针

            //迭代日志缓冲区中,本次未确认的提交日志中执行写操作的表和相关键值对
            while offset < bytes_len {
                //获取表名、操作的键值对数量和新的日志缓冲区偏移
                let (table, kvs_len, new_offset) =
                    <MetaTable<usize, CommitLogger> as KVTable>::get_init_table_prepare_output(&prepare_output, offset);

                //获取操作的表键值列表和新的日志缓冲区偏移
                let (writes, new_offset)
                    = <MetaTable<usize, CommitLogger> as KVTable>::get_all_key_value_from_table_prepare_output(&prepare_output, &table, kvs_len, new_offset);

                if table == meta_table_name {
                    //未确认的提交日志操作的表是元信息表
                    for write in writes {
                        if let Some(value) = write.value {
                            //有值,则创建表
                            pause(&request_receiver)?;

                            let table_name = match binary_to_table(&write.key) {
                                Err(e) => {
                                    //反序列化表名失败
                                    return Err(Error::new(ErrorKind::Other, format!("From binary to table name failed, reason: {:?}", e)));
                                },
                                Ok(table_name) => {
                                    //反序列化表名成功
                                    table_name
                                }
                            };
                            let table_meta = KVTableMeta::from(value);

                            //响应元信息表的插入日志
                            let _ = response_sender.send(Some((transaciton_uid.clone(),
                                                               commit_uid.clone(),
                                                               meta_table_name.clone(),
                                                               true,
                                                               table_name.as_str().as_bytes().to_vec(),
                                                               format!("{:?}", table_meta).as_bytes().to_vec())));
                        } else {
                            //无值,则删除表
                            pause(&request_receiver)?;

                            let table_name = Atom::from(write.key.as_ref());

                            //响应元信息表的删除日志
                            let _ = response_sender.send(Some((transaciton_uid.clone(),
                                                               commit_uid.clone(),
                                                               meta_table_name.clone(),
                                                               false,
                                                               table_name.as_str().as_bytes().to_vec(),
                                                               vec![0])));
                        }
                    }
                } else {
                    //未确认的提交日志操作的表是其它表
                    for write in writes {
                        if write.exist_value() {
                            //有值,则执行插入或更新操作
                            pause(&request_receiver)?;

                            //响应用户表的插入日志
                            let _ = response_sender.send(Some((transaciton_uid.clone(),
                                                               commit_uid.clone(),
                                                               write.table,
                                                               true,
                                                               write.key.as_ref().to_vec(),
                                                               write.value.unwrap().as_ref().to_vec())));
                        } else {
                            //无值,则执行删除操作
                            pause(&request_receiver)?;

                            let _ = response_sender.send(Some((transaciton_uid.clone(),
                                                               commit_uid.clone(),
                                                               write.table,
                                                               false,
                                                               write.key.as_ref().to_vec(),
                                                               vec![0])));
                        }
                    }
                }

                //更新日志缓冲区偏移
                offset = new_offset;
            }

            Ok(())
        };

        let logger = self.logger.clone();
        let status = self.status.clone();
        let request_receiver = self.request_receiver.clone();
        let response_sender = self.response_sender.clone();
        let _ = self.rt.spawn(async move {
            let replay_result = logger.start_replay(Arc::new(inspect_callback)).await;
            // start_replay 在检查空 WAL 和任何后续错误前已经设置 replay 状态。无论正常结果
            // 是 Ok 还是 Err,都必须执行 finish_replay;否则 collector 会持续跳过工作,
            // 后续 confirm 也只会进入 replay 缓冲。finish 可能应用离线检查期间意外到达的
            // confirm,因此本工具禁止与在线数据库共享 logger。
            let finish_result = logger.finish_replay().await;
            if let Err(e) = replay_result {
                log::error!("Inspect commit log replay failed, reason: {:?}", e);
            }
            if let Err(e) = finish_result {
                log::error!("Finish inspected commit log replay failed, reason: {:?}", e);
            }

            //侦听已结束
            let _ = status.compare_exchange(1,
                                            0,
                                            Ordering::Acquire,
                                            Ordering::Relaxed);
            match request_receiver.recv() {
                Err(e) => {
                    panic!("Inspect next failed, reason: {:?}", e);
                },
                Ok(_) => {
                    //响应侦听已结束
                    let _ = response_sender.send(None);
                },
            }
        });

        true
    }

    /// 同步请求并返回下一条根提交日志动作。
    ///
    /// tuple 依次为 `(tid, cid, table, is_upsert, key, value)`;两个 ID 以十进制字符串返回。
    /// `is_upsert = false` 表示 delete,此时 `value` 是当前诊断格式使用的 `[0]` 占位,不是
    /// 被删除的旧值。Meta 的 Key/Value 会转换为表名和调试形式的表元数据。
    ///
    /// 未开始、replay 已结束或通道失败时返回 `None`;无法从 `None` 区分这些原因。活动期会
    /// 阻塞当前 OS 线程直到 runtime 产生响应,只允许单消费者按顺序调用。
    pub fn next(&self) -> Option<(String, String, String, bool, Vec<u8>, Vec<u8>)> {
        if self.status.load(Ordering::Relaxed) == 0 {
            //侦听已完成,则立即返回侦听结束
            return None;
        }

        if self.request_sender.send(()).is_err() {
            //侦听请求错误,则立即返回侦听结束
            return None;
        }

        //侦听请求成功,则等待侦听响应
        match self.response_receiver.recv() {
            Err(_) => {
                //侦听响应错误,则立即返回侦听结束
                None
            },
            Ok(result) => {
                //侦听响应成功
                if let Some((tid, cid, table, method, key, value)) = result {
                    Some((tid.0.to_string(), cid.0.to_string(), table.as_str().to_string(), method, key, value))
                } else {
                    None
                }
            },
        }
    }

    /// 启动 callback 模式 replay。
    ///
    /// callback 在 runtime replay 任务中同步执行;每条记录依次收到
    /// `(tid, cid, table, method, timestamp, key, value)`,结束时收到一次 `None`。长时间阻塞、
    /// panic 或重入 callback 会直接影响 replay 任务,调用方必须自行把重工作转交其它执行器。
    /// 返回 `false` 表示已有检查正在进行;`true` 只表示任务已提交。正常 `Ok/Err` replay
    /// 返回后都会先执行 `finish_replay`,随后才把状态切为结束并回调一次 `None`;`None`
    /// 表示生命周期已闭合,不表示 replay 一定成功,底层错误当前只写日志。本模式不与
    /// [`Self::next`] 联用。
    pub fn begin_with_callback(&self,
                               callback: impl Fn(Option<(Guid, Guid, String, LogMethod, u64, Vec<u8>, Vec<u8>)>) + Send + Sync + 'static)
        -> bool
    {
        match self.status.compare_exchange(0, 1, Ordering::Acquire, Ordering::Relaxed) {
            Err(_) => {
                //不允许正在侦听时,开始侦听
                return false;
            },
            Ok(_) => {
                //侦听未开始,则开始侦听
                ()
            },
        }

        let callback = Arc::new(callback);
        let callback_for_replay = callback.clone();
        let inspect_callback = move |response: Option<(Guid, LogMethod, u64, Vec<u8>)>| -> Result<()>
            {
                let (commit_uid,
                    method,
                    time,
                    prepare_output) = if let Some(response) = response
                {
                    response
                } else {
                    // pi_store 的 None 只表示 WAL load 已结束;CommitLogger 仍处于 replay
                    // 状态。公开完成通知必须延迟到外层 finish_replay 成功尝试之后。
                    return Ok(());
                };

                let meta_table_name = Atom::from(DEFAULT_DB_TABLES_META_DIR);
                let bytes_len = prepare_output.len(); //获取日志缓冲区长度
                let mut offset = 0; //日志缓冲区偏移
                let bytes = prepare_output.as_slice();
                let uid = u128::from_le_bytes(bytes[0..16].try_into().unwrap()); //获取事务唯一id
                let transaciton_uid = Guid(uid);
                offset += 16; //移动缓冲区指针

                //迭代日志缓冲区中,本次未确认的提交日志中执行写操作的表和相关键值对
                while offset < bytes_len {
                    //获取表名、操作的键值对数量和新的日志缓冲区偏移
                    let (table, kvs_len, new_offset) =
                        <MetaTable<usize, CommitLogger> as KVTable>::get_init_table_prepare_output(&prepare_output, offset);

                    //获取操作的表键值列表和新的日志缓冲区偏移
                    let (writes, new_offset)
                        = <MetaTable<usize, CommitLogger> as KVTable>::get_all_key_value_from_table_prepare_output(&prepare_output, &table, kvs_len, new_offset);

                    if table == meta_table_name {
                        //未确认的提交日志操作的表是元信息表
                        for write in writes {
                            if let Some(value) = write.value {
                                //有值,则创建表
                                let table_name = match binary_to_table(&write.key) {
                                    Err(e) => {
                                        //反序列化表名失败
                                        return Err(Error::new(ErrorKind::Other,
                                                              format!("From binary to table name failed, reason: {:?}",
                                                                      e)));
                                    },
                                    Ok(table_name) => {
                                        //反序列化表名成功
                                        table_name
                                    }
                                };
                                let table_meta = KVTableMeta::from(value);

                                //回调元信息表的插入日志
                                let response = Some((transaciton_uid.clone(),
                                                     commit_uid.clone(),
                                                     meta_table_name.as_str().to_string(),
                                                     method,
                                                     time,
                                                     table_name.as_str().as_bytes().to_vec(),
                                                     format!("{:?}", table_meta).as_bytes().to_vec()));
                                callback_for_replay(response);
                            } else {
                                //无值,则删除表
                                let table_name = Atom::from(write.key.as_ref());

                                //回调元信息表的删除日志
                                let response = Some((transaciton_uid.clone(),
                                                     commit_uid.clone(),
                                                     meta_table_name.as_str().to_string(),
                                                     method,
                                                     time,
                                                     table_name.as_str().as_bytes().to_vec(),
                                                     vec![0]));
                                callback_for_replay(response);
                            }
                        }
                    } else {
                        //未确认的提交日志操作的表是其它表
                        for write in writes {
                            if write.exist_value() {
                                //有值则回调用户表的插入日志
                                let response = Some((transaciton_uid.clone(),
                                                     commit_uid.clone(),
                                                     write.table.as_str().to_string(),
                                                     method,
                                                     time,
                                                     write.key.as_ref().to_vec(),
                                                     write.value.unwrap().as_ref().to_vec()));
                                callback_for_replay(response);
                            } else {
                                //无值,则回调用户表的删除日志
                                let response = Some((transaciton_uid.clone(),
                                                     commit_uid.clone(),
                                                     write.table.as_str().to_string(),
                                                     method,
                                                     time,
                                                     write.key.as_ref().to_vec(),
                                                     vec![0]));
                                callback_for_replay(response);
                            }
                        }
                    }

                    //更新日志缓冲区偏移
                    offset = new_offset;
                }

                Ok(())
            };

        let logger = self.logger.clone();
        let status = self.status.clone();
        let callback_for_completion = callback;
        let _ = self.rt.spawn(async move {
            let replay_result = logger.start_replay_ext(Arc::new(inspect_callback)).await;
            // 与 pull 模式相同,空 WAL 和错误返回也必须闭合 replay 状态;公开 None 不能早于
            // finish,否则调用方可能在 logger 仍缓冲 confirm 时误判检查已经完成。
            let finish_result = logger.finish_replay().await;
            if let Err(e) = replay_result {
                log::error!("Inspect commit log replay with callback failed, reason: {:?}", e);
            }
            if let Err(e) = finish_result {
                log::error!("Finish inspected commit log replay with callback failed, reason: {:?}", e);
            }

            //侦听已结束
            let _ = status.compare_exchange(1,
                                            0,
                                            Ordering::Acquire,
                                            Ordering::Relaxed);
            callback_for_completion(None);
        });

        true
    }
}

/// 逐项检查单个 LogOrdered/日志格式表目录的 pull 式读取器。
///
/// 该工具读取日志记录而不修改数据库表,不建立事务快照,也不提供数据库查询语义。构造时
/// 使用的 `LogFile::open` 可能创建初始日志、清理非日志文件或调整 `.bak` 文件拓扑,因此
/// “读取”不等于物理目录严格只读;只能对已停止生产访问的专用离线目录使用。调用方必须按
/// `new -> begin -> next* -> None` 使用并保持单消费者,每次检查创建新实例。
pub struct LogTableInspector {
    rt:                 MultiTaskRuntime<()>,                               //运行时
    log_file:           LogFile,                                            //日志文件
    status:             Arc<AtomicIsize>,                                   //侦听状态
    request_sender:     Sender<()>,                                         //请求发送器
    request_receiver:   Receiver<()>,                                       //请求接收器
    response_sender:    Sender<Option<(String, bool, Vec<u8>, Vec<u8>)>>,   //响应发送器
    response_receiver:  Receiver<Option<(String, bool, Vec<u8>, Vec<u8>)>>, //响应接收器
}

// SAFETY: 所有字段均为线程安全 runtime/LogFile/channel/atomic 句柄;移动 inspector 不移动
// 自引用数据。单消费者是响应归属约束,不是内存安全前提。
unsafe impl Send for LogTableInspector {}
// SAFETY: 共享访问只通过 LogFile、channel 和 AtomicIsize 的同步 API,不暴露内部可变引用。
unsafe impl Sync for LogTableInspector {}

impl LogTableInspector {
    /// 打开指定表目录并构造尚未开始加载的 inspector。
    ///
    /// 文件打开在 `rt` 上异步执行,但本函数同步等待有界通道,因此可能阻塞当前 OS 线程。
    /// 打开或通道失败返回 `io::ErrorKind::Other`;成功不表示日志内容已完整校验。底层 open
    /// 具有模块级说明中的目录维护副作用,不得指向在线表目录。不要在无法继续调度打开任务的
    /// runtime owner 线程中调用。
    pub fn new<P: AsRef<Path> + Debug + Clone + Send + Sync + 'static>(rt: MultiTaskRuntime<()>,
                                                                       table_path: P) -> Result<Self> {
        let rt_copy = rt.clone();
        let table_path_copy = table_path.clone();
        let (sender, receiver) = bounded(1);
        let _ = rt.spawn(async move {
            match LogFile::open(rt_copy,
                                table_path_copy,
                                2 * 1024 * 1024,
                                512 * 1024 * 1024,
                                None).await {
                Err(e) => {
                    //打开日志文件失败,则立即抛出异常
                    let _ = sender.send(Err(format!("Open log ordered table failed, reason: {:?}", e)));
                },
                Ok(log_file) => {
                    let _ = sender.send(Ok(log_file));
                }
            }
        });

        let log_file = match receiver.recv() {
            Err(e) => {
                return Err(Error::new(ErrorKind::Other, format!("Create LogTableInspector failed, path: {:?}, reason: {:?}", e, table_path)));
            },
            Ok(result) => {
                match result {
                    Err(e) => {
                        return Err(Error::new(ErrorKind::Other, format!("Create LogTableInspector failed, path: {:?}, reason: {:?}", e, table_path)));
                    },
                    Ok(log_file) => {
                        log_file
                    }
                }
            }
        };

        let (request_sender, request_receiver) = bounded(1);
        let (response_sender, response_receiver) = bounded(1);

        Ok(LogTableInspector {
            rt,
            log_file,
            status: Arc::new(AtomicIsize::new(0)),
            request_sender,
            request_receiver,
            response_sender,
            response_receiver,
        })
    }

    /// 启动表日志 pull 加载。
    ///
    /// 已有加载任务时返回 `false`;否则切换状态、提交异步 load 并返回 `true`。`true` 不代表
    /// load 已成功,底层加载错误会在 runtime 任务中 panic。每条记录都等待一次
    /// [`Self::next`] 请求;停止消费会使任务停在通道等待处。
    pub fn begin(&self) -> bool {
        match self.status.compare_exchange(0, 1, Ordering::Acquire, Ordering::Relaxed) {
            Err(_) => {
                //不允许正在侦听时,开始侦听
                return false;
            },
            Ok(_) => {
                //侦听未开始,则开始侦听
                ()
            },
        }

        let log_file = self.log_file.clone();
        let status = self.status.clone();
        let request_receiver = self.request_receiver.clone();
        let response_sender = self.response_sender.clone();
        let _ = self.rt.spawn(async move {
            let mut loader = LogTableLoader {
                request_receiver: request_receiver.clone(),
                response_sender: response_sender.clone(),
            };

            if let Err(e) = log_file.load(&mut loader,
                                          None,
                                          8192,
                                          true).await {
                //加载指定的日志文件失败,则立即抛出异常
                panic!("Load log ordered table failed, path: {:?}, reason: {:?}",
                       log_file.path(),
                       e);
            }

            //侦听已结束
            let _ = status.compare_exchange(1,
                                            0,
                                            Ordering::Acquire,
                                            Ordering::Relaxed);
            match request_receiver.recv() {
                Err(_e) => {
                    let _ = response_sender.send(None);
                },
                Ok(_) => {
                    //响应侦听已结束
                    let _ = response_sender.send(None);
                },
            }
        });

        true
    }

    /// 同步请求并返回下一条表日志记录。
    ///
    /// tuple 为 `(log_file, is_upsert, key, value)`;delete 记录的 `is_upsert` 为 `false`,
    /// `value` 是 `[0]` 占位而非旧值。未开始、已结束或通道错误均返回 `None`,活动期会阻塞
    /// 当前 OS 线程等待 runtime 响应。多个线程不得并发消费同一实例。
    pub fn next(&self) -> Option<(String, bool, Vec<u8>, Vec<u8>)> {
        if self.status.load(Ordering::Relaxed) == 0 {
            //侦听已完成,则立即返回侦听结束
            return None;
        }

        if self.request_sender.send(()).is_err() {
            //侦听请求错误,则立即返回侦听结束
            return None;
        }

        //侦听请求成功,则等待侦听响应
        match self.response_receiver.recv() {
            Err(_) => {
                //侦听响应错误,则立即返回侦听结束
                None
            },
            Ok(result) => {
                //侦听响应成功
                if let Some((file, method, key, value)) = result {
                    Some((file.as_str().to_string(), method, key, value))
                } else {
                    None
                }
            },
        }
    }
}

// 日志表的加载器
struct LogTableLoader {
    request_receiver:   Receiver<()>,                                       //请求接收器
    response_sender:    Sender<Option<(String, bool, Vec<u8>, Vec<u8>)>>,   //响应发送器
}

impl PairLoader for LogTableLoader {
    fn is_require(&self, _log_file: Option<&PathBuf>, _key: &Vec<u8>) -> bool {
        true
    }

    fn load(&mut self,
            log_file: Option<&PathBuf>,
            _method: LogMethod,
            key: Vec<u8>,
            value: Option<Vec<u8>>) {
        if let Some(value) = value {
            //插入或更新指定关键字的值
            if let Err(_) = pause(&self.request_receiver) {
                let _ = self.response_sender.send(None);
            }

            let path = if let Some(path) = log_file {
                path.to_str().unwrap().to_string()
            } else {
                "".to_string()
            };

            //响应日志表的插入日志
            let _ = self.response_sender.send(Some((path,
                                                    true,
                                                    key,
                                                    value)));
        } else {
            if let Err(_) = pause(&self.request_receiver) {
                let _ = self.response_sender.send(None);
            }

            let path = if let Some(path) = log_file {
                path.to_str().unwrap().to_string()
            } else {
                "".to_string()
            };

            //响应日志表的删除日志
            let _ = self.response_sender.send(Some((path,
                                                    false,
                                                    key,
                                                    vec![0])));
        }
    }
}

// 暂停侦听,直到收到继续侦听的请求
#[inline]
fn pause(receiver: &Receiver<()>) -> Result<()> {
    match receiver.recv() {
        Err(e) => {
            Err(Error::new(ErrorKind::ConnectionAborted, format!("Inspect next failed, reason: {:?}", e)))
        },
        Ok(_) => {
            //接收到侦听下一个日志的请求
            Ok(())
        },
    }
}