lsm 0.4.1

An implementation of log-structured merge trees in pure Rust
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
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
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
use std::collections::VecDeque;
use std::sync::Arc;

#[cfg(not(feature = "async-io"))]
use std::fs;

use tokio::sync::RwLock;
use tokio_condvar::Condvar;

use cfg_if::cfg_if;

use crate::data_blocks::{DataBlocks, DataEntryType};
use crate::level::Level;
use crate::level_logger::LevelLogger;
use crate::manifest::{LevelId, Manifest};
use crate::memtable::{
    ImmMemtableRef, Memtable, MemtableEntry, MemtableEntryRef, MemtableIterator, MemtableRef,
};
use crate::sorted_table::{InternalIterator, Key, TableId, TableIterator};
use crate::wal::WriteAheadLog;
use crate::{Error, Params, StartMode, WriteBatch, WriteOp, WriteOptions};

#[cfg(feature = "wisckey")]
use crate::values::{ValueLog, ValueRef};

use crate::data_blocks::DataEntry;

#[derive(Debug, PartialEq, Eq)]
enum CompactResult {
    NothingToDo,
    DidWork,
    Locked,
}

/// Refers to an entry in the key-value store without copying it
pub enum EntryRef {
    SortedTable {
        entry: DataEntry,
        #[cfg(feature = "wisckey")]
        value_ref: ValueRef,
    },
    Memtable {
        entry: MemtableEntryRef,
    },
}

impl EntryRef {
    pub fn get_value(&self) -> &[u8] {
        match self {
            #[cfg(feature = "wisckey")]
            Self::SortedTable { value_ref, .. } => value_ref.get_value(),
            #[cfg(not(feature = "wisckey"))]
            Self::SortedTable { entry } => entry.get_value().unwrap(),
            Self::Memtable { entry } => entry.get_value().unwrap(),
        }
    }
}

/// The main database logic
///
/// Generally, you will not interact with this directly but use
/// Database instead.
/// This is mainly kept public so that we can implement the sync
/// API in a separate crate.
pub struct DbLogic {
    manifest: Arc<Manifest>,
    params: Arc<Params>,
    memtable: RwLock<MemtableRef>,
    /// Immutable memtables are about to be compacted
    imm_memtables: RwLock<VecDeque<(u64, ImmMemtableRef)>>,
    imm_cond: Condvar,
    levels: Vec<Level>,
    wal: WriteAheadLog,
    level_logger: Option<LevelLogger>,

    #[cfg(feature = "wisckey")]
    value_log: Arc<ValueLog>,
}

impl DbLogic {
    pub async fn new(start_mode: StartMode, params: Params) -> Result<Self, Error> {
        if params.db_path.components().next().is_none() {
            return Err(Error::InvalidParams(
                "DB path must not be empty!".to_string(),
            ));
        }

        if params.db_path.exists() && !params.db_path.is_dir() {
            return Err(Error::InvalidParams(
                "DB path must be a folder!".to_string(),
            ));
        }

        let level_logger = if let Some(path) = &params.log_level_stats {
            Some(LevelLogger::new(path, params.num_levels))
        } else {
            None
        };

        let create = match start_mode {
            StartMode::CreateOrOpen => !params.db_path.exists(),
            StartMode::Open => {
                if !params.db_path.exists() {
                    return Err(Error::InvalidParams("DB does not exist".to_string()));
                }

                false
            }
            StartMode::CreateOrOverride => {
                if params.db_path.exists() {
                    log::info!(
                        "Removing old data at \"{}\"",
                        params.db_path.to_str().unwrap()
                    );

                    cfg_if! {
                        if #[ cfg(feature="async-io") ] {
                            // Not yet supported in tokio_uring
                            std::fs::remove_dir_all(&params.db_path)
                                .expect("Failed to remove existing database");
                        } else {
                            fs::remove_dir_all(&params.db_path)
                                .expect("Failed to remove existing database");
                        }
                    }
                }

                true
            }
        };

        let params = Arc::new(params);
        let manifest;
        let memtable;
        let wal;

        if create {
            cfg_if! {
                if #[ cfg(feature="async-io") ] {
                    // Not yet supported in tokio_uring
                    match std::fs::create_dir(&params.db_path) {
                        Ok(()) => {
                            log::info!("Created database folder at \"{}\"", params.db_path.to_str().unwrap())
                        }
                        Err(err) => {
                            return Err(Error::Io(format!("Failed to create DB folder: {err}")));
                        }
                    }
                } else {
                    #[ cfg(not(feature="async-io")) ]
                    match fs::create_dir(&params.db_path) {
                        Ok(()) => {
                            log::info!("Created database folder at \"{}\"", params.db_path.to_str().unwrap())
                        }
                        Err(err) => {
                            return Err(Error::Io(format!("Failed to create DB folder: {err}")));
                        }
                    }
                }
            }

            manifest = Arc::new(Manifest::new(params.clone()).await);
            memtable = RwLock::new(MemtableRef::wrap(Memtable::new(1)));
            wal = WriteAheadLog::new(params.clone()).await?;
        } else {
            log::info!(
                "Opening database folder at \"{}\"",
                params.db_path.to_str().unwrap()
            );

            manifest = Arc::new(Manifest::open(params.clone()).await?);

            let mut mtable = Memtable::new(manifest.get_seq_number_offset().await);
            wal = WriteAheadLog::open(params.clone(), manifest.get_log_offset().await, &mut mtable)
                .await?;

            memtable = RwLock::new(MemtableRef::wrap(mtable));
        }

        #[cfg(feature = "wisckey")]
        let value_log = Arc::new(ValueLog::new(params.clone(), manifest.clone()).await);

        let data_blocks = Arc::new(DataBlocks::new(params.clone(), manifest.clone()));

        if params.num_levels == 0 {
            panic!("Need at least one level!");
        }

        let mut levels = Vec::new();
        for index in 0..params.num_levels {
            let index = index as LevelId;
            let level = Level::new(index, data_blocks.clone(), params.clone(), manifest.clone());
            levels.push(level);
        }

        if !create {
            for (level_id, tables) in manifest.get_table_ids().await.iter().enumerate() {
                for table_id in tables {
                    levels[level_id].load_table(*table_id).await?;
                }
            }
        }

        Ok(Self {
            manifest,
            params,
            memtable,
            imm_memtables: Default::default(),
            imm_cond: Default::default(),
            levels,
            wal,
            level_logger,
            #[cfg(feature = "wisckey")]
            value_log,
        })
    }

    #[cfg(feature = "wisckey")]
    pub fn get_value_log(&self) -> Arc<ValueLog> {
        self.value_log.clone()
    }

    pub async fn prepare_iter(
        &self,
        min_key: Option<&[u8]>,
        max_key: Option<&[u8]>,
    ) -> (
        Vec<MemtableIterator>,
        Vec<TableIterator>,
        Option<Vec<u8>>,
        Option<Vec<u8>>,
    ) {
        let mut table_iters = Vec::new();
        let mut mem_iters = Vec::new();

        if let Some(min_key) = &min_key
            && let Some(max_key) = &max_key
        {
            assert!(min_key < max_key);
        }

        {
            let memtable = self.memtable.read().await;
            let imm_mems = self.imm_memtables.read().await;

            mem_iters.push(memtable.clone_immutable().into_iter(false).await);

            for (_, imm) in imm_mems.iter() {
                let iter = imm.clone().into_iter(false).await;
                mem_iters.push(iter);
            }
        }

        for level in self.levels.iter() {
            let tables = level.get_tables_ro().await;

            for table in tables.iter() {
                let mut skip = false;

                if let Some(min_key) = min_key {
                    if table.get_max() < min_key {
                        skip = true;
                    }
                }

                if let Some(max_key) = max_key {
                    if table.get_min() > max_key {
                        skip = true;
                    }
                }

                if !skip {
                    let iter = TableIterator::new(table.clone(), false).await;
                    table_iters.push(iter);
                }
            }
        }

        (
            mem_iters,
            table_iters,
            min_key.map(|k| k.to_vec()),
            max_key.map(|k| k.to_vec()),
        )
    }

    /// Iterate over the specified range in reverse
    pub async fn prepare_reverse_iter(
        &self,
        max_key: Option<&[u8]>,
        min_key: Option<&[u8]>,
    ) -> (
        Vec<MemtableIterator>,
        Vec<TableIterator>,
        Option<Vec<u8>>,
        Option<Vec<u8>>,
    ) {
        let mut table_iters = Vec::new();
        let mut mem_iters = Vec::new();

        if let Some(min_key) = &min_key
            && let Some(max_key) = &max_key
        {
            assert!(min_key < max_key);
        };

        {
            let memtable = self.memtable.read().await;
            let imm_mems = self.imm_memtables.read().await;

            mem_iters.push(memtable.clone_immutable().into_iter(true).await);

            for (_, imm) in imm_mems.iter() {
                let iter = imm.clone().into_iter(true).await;
                mem_iters.push(iter);
            }
        }

        for level in self.levels.iter() {
            let tables = level.get_tables_ro().await;

            for table in tables.iter() {
                let mut skip = false;

                if let Some(min_key) = min_key {
                    if table.get_max() < min_key {
                        skip = true;
                    }
                }

                if let Some(max_key) = max_key {
                    if table.get_min() > max_key {
                        skip = true;
                    }
                }

                if !skip {
                    let iter = TableIterator::new(table.clone(), true).await;
                    table_iters.push(iter);
                }
            }
        }

        (
            mem_iters,
            table_iters,
            min_key.map(|k| k.to_vec()),
            max_key.map(|k| k.to_vec()),
        )
    }

    #[cfg(feature = "wisckey")]
    #[tracing::instrument(skip(self, key))]
    pub async fn get(&self, key: &[u8]) -> Result<(bool, Option<EntryRef>), Error> {
        let mut compaction_triggered = false;

        {
            let memtable = self.memtable.read().await;

            if let Some(entry) = memtable.get().get(key) {
                match entry.get_type() {
                    DataEntryType::Put => {
                        let entry = EntryRef::Memtable { entry };
                        return Ok((compaction_triggered, Some(entry)));
                    }
                    DataEntryType::Delete => {
                        return Ok((compaction_triggered, None));
                    }
                }
            }
        }

        {
            let imm_mems = self.imm_memtables.read().await;

            for (_, imm) in imm_mems.iter().rev() {
                if let Some(entry) = imm.get().get(key) {
                    match entry.get_type() {
                        DataEntryType::Put => {
                            let entry = EntryRef::Memtable { entry };
                            return Ok((compaction_triggered, Some(entry)));
                        }
                        DataEntryType::Delete => {
                            return Ok((compaction_triggered, None));
                        }
                    }
                }
            }
        }

        for level in self.levels.iter() {
            let (level_compact_triggered, result) = level.get(key).await;
            if level_compact_triggered {
                compaction_triggered = true;
            }

            if let Some(entry) = result {
                match entry.get_type() {
                    DataEntryType::Put => {
                        let value_ref = self
                            .value_log
                            .get_ref(entry.get_value_id().unwrap())
                            .await
                            .unwrap();
                        let entry = EntryRef::SortedTable { entry, value_ref };
                        return Ok((compaction_triggered, Some(entry)));
                    }
                    DataEntryType::Delete => {
                        return Ok((compaction_triggered, None));
                    }
                }
            }
        }

        // Does not exist
        Ok((compaction_triggered, None))
    }

    #[cfg(not(feature = "wisckey"))]
    #[tracing::instrument(skip(self, key))]
    pub async fn get(&self, key: &[u8]) -> Result<(bool, Option<EntryRef>), Error> {
        let mut compaction_triggered = false;

        {
            let memtable = self.memtable.read().await;

            if let Some(entry) = memtable.get().get(key) {
                match entry.get_type() {
                    DataEntryType::Put => {
                        let entry = EntryRef::Memtable { entry };
                        return Ok((compaction_triggered, Some(entry)));
                    }
                    DataEntryType::Delete => {
                        return Ok((compaction_triggered, None));
                    }
                }
            }
        }

        {
            let imm_mems = self.imm_memtables.read().await;

            for (_, imm) in imm_mems.iter().rev() {
                if let Some(entry) = imm.get().get(key) {
                    match entry.get_type() {
                        DataEntryType::Put => {
                            let entry = EntryRef::Memtable { entry };
                            return Ok((compaction_triggered, Some(entry)));
                        }
                        DataEntryType::Delete => {
                            return Ok((compaction_triggered, None));
                        }
                    }
                }
            }
        }

        for level in self.levels.iter() {
            let (level_compact_triggered, result) = level.get(key).await;
            if level_compact_triggered {
                compaction_triggered = true;
            }

            if let Some(entry) = result {
                match entry.get_type() {
                    DataEntryType::Put => {
                        let entry = EntryRef::SortedTable { entry };
                        return Ok((compaction_triggered, Some(entry)));
                    }
                    DataEntryType::Delete => {
                        return Ok((compaction_triggered, None));
                    }
                }
            }
        }

        Ok((compaction_triggered, None))
    }

    pub async fn synchronize(&self) -> Result<(), Error> {
        self.wal.sync().await?;
        Ok(())
    }

    #[tracing::instrument(skip(self, write_batch, opt))]
    pub async fn write_opts(
        &self,
        mut write_batch: WriteBatch,
        opt: &WriteOptions,
    ) -> Result<bool, Error> {
        let mut memtable = self.memtable.write().await;
        let mem_inner = unsafe { memtable.get_mut() };

        let wal_offset = {
            let log_pos = self.wal.store(&write_batch.writes).await?;

            if opt.sync {
                self.wal.sync().await?;
            }

            for op in write_batch.writes.drain(..) {
                match op {
                    WriteOp::Put(key, value) => mem_inner.put(key, value),
                    WriteOp::Delete(key) => mem_inner.delete(key),
                }
            }

            log_pos
        };

        // If the current memtable is full, mark it as immutable, so it can be flushed to L0
        if mem_inner.is_full(&self.params) {
            let next_seq_num = mem_inner.get_next_seq_number();
            let imm = memtable.take(next_seq_num);
            let mut imm_mems = self.imm_memtables.write().await;

            while !imm_mems.is_empty() {
                imm_mems = self
                    .imm_cond
                    .rw_write_wait(&self.imm_memtables, imm_mems)
                    .await;
            }

            imm_mems.push_back((wal_offset, imm));

            Ok(true)
        } else {
            Ok(false)
        }
    }

    #[tracing::instrument(skip(self))]
    pub async fn do_memtable_compaction(&self) -> Result<bool, Error> {
        log::trace!("Attempting memtable compaction");

        // SAFETY
        // Only one task will do the memtable compaction, so it is
        // fine to not hold the lock the entire time

        let to_compact = self.imm_memtables.read().await.front().cloned();

        if let Some((log_offset, mem)) = to_compact {
            log::trace!("Found memtable to compact");

            // First create table
            let (min_key, max_key) = mem.get().get_min_max_key();
            let l0 = self.levels.first().unwrap();
            let table_id = self.manifest.next_table_id().await;
            let mut table_builder = l0.build_table(table_id, min_key.to_vec(), max_key.to_vec());

            let memtable_entries = mem.get().get_entries();

            cfg_if! {
                if #[cfg(feature="wisckey")] {
                    let mut vbuilder = self.value_log.make_batch().await;

                    for (key, mem_entry) in memtable_entries.into_iter() {
                        match mem_entry {
                            MemtableEntry::Value{seq_number, value} => {
                                let value_ref = vbuilder.add_value(value).await;
                                table_builder.add_value(&key, seq_number, value_ref).await?;
                            }
                            MemtableEntry::Deletion{seq_number} => {
                                table_builder.add_deletion(&key, seq_number).await?;
                            }
                        }
                    }

                    vbuilder.finish().await?;
                } else {
                    for (key, mem_entry) in memtable_entries.into_iter() {
                        match mem_entry {
                            MemtableEntry::Value{seq_number, value} => {
                                table_builder.add_value(&key, seq_number, &value).await?;
                            }
                            MemtableEntry::Deletion{seq_number} => {
                                table_builder.add_deletion(&key, seq_number).await?;
                            }
                        }
                    }
                }
            }

            let table = table_builder.finish().await?;
            let table_id = table.get_id();
            l0.add_l0_table(table).await;

            if let Some(logger) = &self.level_logger {
                logger.l0_table_added();
            }

            // Then update manifest and flush WAL
            let seq_offset = mem.get().get_next_seq_number();
            self.manifest.set_seq_number_offset(seq_offset).await;
            self.manifest
                .update_table_set(vec![(0, table_id)], vec![])
                .await;

            self.wal.set_offset(log_offset).await;
            self.manifest.set_log_offset(log_offset).await;

            // Finally, remove immutable memtable
            {
                let mut imm_mems = self.imm_memtables.write().await;
                let entry = imm_mems.pop_front();
                assert!(entry.is_some());
            }
            log::debug!("Created new L0 table");
            self.imm_cond.notify_all();

            Ok(true)
        } else {
            log::trace!("Found no memtable to compact");
            Ok(false)
        }
    }

    /// Do compaction if necessary
    ///
    /// Returns true if we should try again. This can happen for two reasons:
    ///     1. Compaction succeded and there might be more to compact
    ///     2. Compaction failed due to locks and we should try to grab the locks again
    #[tracing::instrument(skip(self))]
    pub async fn do_level_compaction(&self) -> Result<bool, Error> {
        let mut was_locked = false;
        log::trace!("Attempting level compaction");

        // level-to-level compaction
        for (level_pos, level) in self.levels.iter().enumerate() {
            // Last level cannot be compacted
            if level_pos < self.params.num_levels - 1 {
                match self
                    .compact_level(level, &self.levels[level_pos + 1])
                    .await?
                {
                    CompactResult::DidWork => {
                        log::trace!("Compacted level {level_pos}");
                        return Ok(true);
                    }
                    CompactResult::Locked => {
                        log::trace!("Cannot compact level {level_pos} right now; lock was held");
                        was_locked = true;
                    }
                    CompactResult::NothingToDo => {
                        log::trace!("Nothing to do for level {level_pos}");
                    }
                }
            }
        }

        // We'll try again if it was locked
        Ok(was_locked)
    }

    /// Compact the specified level
    ///
    /// This has three possible behaviors:
    ///    1. A "fast" compaction where a table simply gets moved down one level
    ///    2. Regular compaction where one or multiple tables get merged with a table on a level below
    ///    3. Abort due to concurrency
    #[tracing::instrument(skip(self, parent_level, child_level))]
    async fn compact_level(
        &self,
        parent_level: &Level,
        child_level: &Level,
    ) -> Result<CompactResult, Error> {
        assert_eq!(parent_level.get_index() + 1, child_level.get_index());

        let parent_tbls_to_compact = match parent_level.maybe_start_compaction().await {
            Ok(Some(result)) => result,
            Ok(None) => return Ok(CompactResult::NothingToDo),
            Err(()) => return Ok(CompactResult::Locked),
        };
        assert!(!parent_tbls_to_compact.is_empty());

        log::trace!("Starting compaction on level {}", parent_level.get_index());

        let mut min_key = parent_tbls_to_compact[0].get_min();
        let mut max_key = parent_tbls_to_compact[0].get_max();

        if parent_tbls_to_compact.len() > 1 {
            for table in parent_tbls_to_compact[1..].iter() {
                min_key = min_key.min(table.get_min());
                max_key = max_key.max(table.get_max());
            }
        }

        let overlap_result = if parent_tbls_to_compact.len() == 1 {
            child_level
                .get_overlaps(min_key, max_key, Some(parent_tbls_to_compact[0].get_id()))
                .await
        } else {
            child_level.get_overlaps(min_key, max_key, None).await
        };

        // Abort due to concurrency?
        let (table_id, child_tbls_to_compact) = match overlap_result {
            Some(res) => res,
            None => {
                log::trace!("Aborting compaction due to concurrency");
                for parent_table in parent_tbls_to_compact {
                    parent_table.abort_compaction();
                }
                return Ok(CompactResult::NothingToDo);
            }
        };

        // Fast path
        if parent_tbls_to_compact.len() == 1 && child_tbls_to_compact.is_empty() {
            assert_eq!(parent_tbls_to_compact[0].get_id(), table_id);
            self.fast_compaction(parent_level, child_level, table_id)
                .await;
            return Ok(CompactResult::DidWork);
        }

        // At this point, the compaction flag/lock has been set on all affected tables
        // and a placeholder was created on the child level

        log::debug!(
            "Compacting {} table(s) in level {} with {} table(s) in level {} into table #{table_id}",
            parent_tbls_to_compact.len(),
            parent_level.get_index(),
            child_tbls_to_compact.len(),
            child_level.get_index(),
        );

        for table in child_tbls_to_compact.iter() {
            min_key = min_key.min(table.get_min());
            max_key = max_key.max(table.get_max());
        }

        // Table can potentially contain a single entry
        assert!(min_key <= max_key);

        let min_key = min_key.to_vec();
        let max_key = max_key.to_vec();

        let mut table_iters = Vec::new();
        for table in parent_tbls_to_compact.iter() {
            table_iters.push(TableIterator::new(table.clone(), false).await);
        }

        for child in child_tbls_to_compact.iter() {
            table_iters.push(TableIterator::new(child.clone(), false).await);
        }

        let mut last_key: Option<Key> = None;

        #[cfg(feature = "wisckey")]
        let mut deleted_values = vec![];

        let mut table_builder = child_level.build_table(table_id, min_key, max_key);

        loop {
            log::trace!("Starting compaction for next key");
            let mut min_key: Option<Vec<u8>> = None;

            for table_iter in table_iters.iter_mut() {
                // Advance the iterator, if needed
                if let Some(last_key) = &last_key {
                    while !table_iter.at_end() && table_iter.get_key() <= last_key.as_slice() {
                        table_iter.step().await;
                    }
                }

                if !table_iter.at_end() {
                    if let Some(key) = &min_key {
                        if table_iter.get_key() < key.as_slice() {
                            min_key = Some(table_iter.get_key().to_vec());
                        }
                    } else {
                        min_key = Some(table_iter.get_key().to_vec());
                    }
                }
            }

            if min_key.is_none() {
                break;
            }

            let mut min_iter: Option<&TableIterator> = None;
            let min_key = min_key.unwrap().clone();

            for table_iter in table_iters.iter_mut() {
                if table_iter.at_end() {
                    continue;
                }

                // Figure out if this table's entry is more recent
                let key = table_iter.get_key();

                if key != min_key {
                    continue;
                }

                if let Some(other_iter) = min_iter {
                    if table_iter.get_seq_number() > other_iter.get_seq_number() {
                        log::trace!(
                            "Overriding key {key:?}: new seq #{}, old seq #{}",
                            table_iter.get_seq_number(),
                            other_iter.get_seq_number()
                        );

                        // Check whether we overwrote a key that is about to
                        // be garbage collected
                        #[cfg(feature = "wisckey")]
                        deleted_values.push(other_iter.get_value_id().unwrap());

                        min_iter = Some(table_iter);
                    }
                } else {
                    log::trace!("Found new key {key:?}");
                    min_iter = Some(table_iter);
                }
            }

            let min_iter = min_iter.unwrap();
            match min_iter.get_entry_type() {
                DataEntryType::Put => {
                    table_builder
                        .add_value(
                            &min_key,
                            min_iter.get_seq_number(),
                            #[cfg(feature = "wisckey")]
                            min_iter.get_value_id().unwrap(),
                            #[cfg(not(feature = "wisckey"))]
                            min_iter.get_entry().unwrap().get_value(),
                        )
                        .await?;
                }
                DataEntryType::Delete => {
                    table_builder
                        .add_deletion(&min_key, min_iter.get_seq_number())
                        .await?;
                }
            }

            last_key = Some(min_key.to_vec());
        }

        let new_table = table_builder.finish().await?;

        let add_set = vec![(child_level.get_index(), new_table.get_id())];
        let mut remove_set = vec![];

        // Update tables atomically
        let mut all_parent_tables = parent_level.get_tables_rw().await;
        let mut all_child_tables = child_level.get_tables_rw().await;

        // Remove all previous child tables
        for table in child_tbls_to_compact.iter() {
            let mut found = false;
            for (pos, other_table) in all_child_tables.iter().enumerate() {
                if other_table.get_id() == table.get_id() {
                    remove_set.push((child_level.get_index(), table.get_id()));
                    all_child_tables.remove(pos);
                    found = true;
                    break;
                }
            }
            assert!(found);
        }

        // Find position for new child table
        let mut new_pos = all_child_tables.len();
        for (pos, other_table) in all_child_tables.iter().enumerate() {
            if other_table.get_min() > new_table.get_min() {
                new_pos = pos;
                break;
            }
        }

        // Add new table to child level
        all_child_tables.insert(new_pos, Arc::new(new_table));
        child_level.remove_table_placeholder(table_id).await;

        // Remove table entries from parent level
        for table in parent_tbls_to_compact.iter() {
            let mut found = false;
            for (pos, other_table) in all_parent_tables.iter().enumerate() {
                if other_table.get_id() == table.get_id() {
                    remove_set.push((parent_level.get_index(), table.get_id()));
                    all_parent_tables.remove(pos);
                    found = true;
                    break;
                }
            }
            assert!(found);
        }

        #[cfg(feature = "wisckey")]
        for vid in deleted_values.into_iter() {
            self.value_log.mark_value_deleted(vid).await?;
        }

        if let Some(logger) = &self.level_logger {
            logger.compaction(parent_level.get_index(), add_set.len(), remove_set.len());
        }

        self.manifest.update_table_set(add_set, remove_set).await;

        log::trace!("Done compacting tables");
        Ok(CompactResult::DidWork)
    }

    pub async fn stop(&self) -> Result<(), Error> {
        self.wal.stop().await
    }

    async fn fast_compaction(&self, parent_level: &Level, child_level: &Level, table_id: TableId) {
        let mut all_parent_tables = parent_level.get_tables_rw().await;
        let mut all_child_tables = child_level.get_tables_rw().await;

        // Remove table entry from parent level
        let table = {
            let mut iter = all_parent_tables.iter().enumerate();

            loop {
                let (pos, other_table) = iter.next().expect("Entry for parent table not found");
                if other_table.get_id() == table_id {
                    break all_parent_tables.remove(pos);
                }
            }
        };

        log::debug!(
            "Moving table #{} from level {} to level {}",
            table_id,
            parent_level.get_index(),
            child_level.get_index(),
        );

        // Figure out where to place the table on the child lavel
        let mut new_pos = 0;
        for (pos, other_table) in all_child_tables.iter().enumerate() {
            if other_table.get_min() > table.get_min() {
                new_pos = pos;
                break;
            }
        }

        // Add table to child level
        all_child_tables.insert(new_pos, table.clone());
        child_level.remove_table_placeholder(table_id).await;

        for (pos, other_table) in all_parent_tables.iter().enumerate() {
            if table.get_id() == other_table.get_id() {
                all_parent_tables.remove(pos);
                break;
            }
        }

        // Update manifest
        let add_set = vec![(child_level.get_index(), table.get_id())];
        let remove_set = vec![(parent_level.get_index(), table.get_id())];
        self.manifest.update_table_set(add_set, remove_set).await;

        if let Some(logger) = &self.level_logger {
            logger.compaction(parent_level.get_index(), 1, 1);
        }

        // Unlock table
        table.finish_fast_compaction();

        log::trace!("Done moving table #{table_id}");
    }
}

#[cfg(all(test, not(feature = "wisckey")))]
mod tests {
    use std::sync::Arc;

    use tempfile::TempDir;

    #[cfg(feature = "async-io")]
    use tokio_uring_executor::test as async_test;

    #[cfg(not(feature = "async-io"))]
    use tokio::test as async_test;

    use crate::params::Params;
    use crate::StartMode;

    use super::{CompactResult, DbLogic};

    async fn test_init() -> (TempDir, DbLogic) {
        let _ = env_logger::builder().is_test(true).try_init();

        let tmpdir = tempfile::Builder::new()
            .prefix("lsm-logic-test-")
            .tempdir()
            .unwrap();

        let params = Params {
            db_path: tmpdir.path().to_path_buf(),
            ..Default::default()
        };

        let logic = DbLogic::new(StartMode::CreateOrOverride, params)
            .await
            .unwrap();

        (tmpdir, logic)
    }

    async fn test_cleanup(tmpdir: TempDir, logic: DbLogic) {
        logic.stop().await.unwrap();

        drop(logic);
        drop(tmpdir);
    }

    /// Here we create overlapping tables on both level 0 and 1
    /// This checks if compaction also works if there is a cross-level overlap   
    #[async_test]
    async fn compact_with_child_level() {
        let (tempdir, logic) = test_init().await;
        let num_tables = 6;

        // Create five tables with the exact same key entries
        for idx in 0..num_tables {
            let level = if idx < num_tables - 1 {
                &logic.levels[0]
            } else {
                &logic.levels[1]
            };

            let table_id = logic.manifest.next_table_id().await;

            let min_key = "000".to_string().into_bytes();
            let max_key = "100".to_string().into_bytes();

            let mut table_builder = level.build_table(table_id, min_key, max_key);
            let mut seq_offset = 1;

            for num in 0..=100 {
                let key = format!("{num:03}").into_bytes();
                let value = "somevalue".to_string().into_bytes();
                let seq_number = seq_offset;
                seq_offset += 1;

                table_builder
                    .add_value(&key, seq_number, &value)
                    .await
                    .unwrap();
            }

            let table = table_builder.finish().await.unwrap();
            let table_id = table.get_id();

            level.get_tables_rw().await.push(Arc::new(table));

            logic
                .manifest
                .update_table_set(vec![(level.get_index(), table_id)], vec![])
                .await;
        }

        assert_eq!(logic.levels[0].get_tables_ro().await.len(), num_tables - 1);
        assert_eq!(
            logic.manifest.get_table_ids().await[0].len(),
            num_tables - 1
        );
        assert_eq!(logic.levels[1].get_tables_ro().await.len(), 1);
        assert_eq!(logic.manifest.get_table_ids().await[1].len(), 1);

        let old_table_id = logic.levels[1].get_tables_ro().await[0].get_id();

        let did_work = logic.do_level_compaction().await.unwrap();
        assert!(did_work);

        assert!(logic.levels[0].get_tables_ro().await.is_empty());
        assert!(logic.manifest.get_table_ids().await[0].is_empty());
        assert_eq!(logic.levels[1].get_tables_ro().await.len(), 1);
        assert_eq!(logic.manifest.get_table_ids().await[1].len(), 1);

        // Ensure a new table was created
        let new_table_id = logic.levels[1].get_tables_ro().await[0].get_id();
        assert_ne!(old_table_id, new_table_id);

        test_cleanup(tempdir, logic).await;
    }

    /// This adds multiple overlapping tables to L0 and expects them to be
    /// merged into one table in L1
    #[async_test]
    async fn l0_compaction() {
        let (tempdir, logic) = test_init().await;

        let num_tables = 5;

        // Create five tables with the exact same key entries
        for _ in 0..num_tables {
            let l0 = logic.levels.first().unwrap();
            let table_id = logic.manifest.next_table_id().await;

            let min_key = "000".to_string().into_bytes();
            let max_key = "100".to_string().into_bytes();

            let mut table_builder = l0.build_table(table_id, min_key, max_key);
            let mut seq_offset = 1;

            for num in 0..=100 {
                let key = format!("{num:03}").into_bytes();
                let value = "somevalue".to_string().into_bytes();
                let seq_number = seq_offset;
                seq_offset += 1;

                table_builder
                    .add_value(&key, seq_number, &value)
                    .await
                    .unwrap();
            }

            let table = table_builder.finish().await.unwrap();
            let table_id = table.get_id();

            l0.add_l0_table(table).await;

            // Then update manifest and flush WAL
            logic
                .manifest
                .update_table_set(vec![(l0.get_index(), table_id)], vec![])
                .await;
        }

        assert_eq!(logic.levels[0].get_tables_ro().await.len(), num_tables);
        assert_eq!(logic.manifest.get_table_ids().await[0].len(), num_tables);
        assert!(logic.levels[1].get_tables_ro().await.is_empty());
        assert!(logic.manifest.get_table_ids().await[1].is_empty());

        let did_work = logic.do_level_compaction().await.unwrap();
        assert!(did_work);

        assert!(logic.levels[0].get_tables_ro().await.is_empty());
        assert!(logic.manifest.get_table_ids().await[0].is_empty());
        assert_eq!(logic.levels[1].get_tables_ro().await.len(), 1);
        assert_eq!(logic.manifest.get_table_ids().await[1].len(), 1);

        test_cleanup(tempdir, logic).await;
    }

    /// Test that fast compaction (simply moving a table down) works as expected
    ///
    /// Note: This test makes some assumptions about the inner workings of
    /// DbLogic and might need to be adjusted with future changes
    #[async_test]
    async fn fast_compaction() {
        let (tempdir, logic) = test_init().await;

        let num_tables = 10;

        // Create five tables with the exact same key entries
        for idx in 0..num_tables {
            let l0 = logic.levels.first().unwrap();
            let table_id = logic.manifest.next_table_id().await;

            let pos = idx * 100;
            let next_pos = (idx + 1) * 100 - 1;

            let min_key = format!("{pos:04}").into_bytes();
            let max_key = format!("{next_pos:04}").into_bytes();

            let mut table_builder = l0.build_table(table_id, min_key, max_key);
            let mut seq_offset = 1;

            for num in pos..next_pos {
                let key = format!("{num:04}").into_bytes();
                let value = "somevalue".to_string().into_bytes();
                let seq_number = seq_offset;
                seq_offset += 1;

                table_builder
                    .add_value(&key, seq_number, &value)
                    .await
                    .unwrap();
            }

            let table = table_builder.finish().await.unwrap();
            let table_id = table.get_id();
            l0.add_l0_table(table).await;

            // Then update manifest and flush WAL
            logic
                .manifest
                .update_table_set(vec![(0, table_id)], vec![])
                .await;
        }

        assert_eq!(logic.levels[0].get_tables_ro().await.len(), num_tables);
        assert_eq!(logic.manifest.get_table_ids().await[0].len(), num_tables);
        assert!(logic.manifest.get_table_ids().await[1].is_empty());

        let did_work = logic.do_level_compaction().await.unwrap();
        assert!(did_work);

        // One table should have moved down
        assert_eq!(logic.levels[0].get_tables_ro().await.len(), num_tables - 1);
        assert_eq!(
            logic.manifest.get_table_ids().await[0].len(),
            num_tables - 1
        );
        assert_eq!(logic.levels[1].get_tables_ro().await.len(), 1);
        assert_eq!(logic.manifest.get_table_ids().await[1].len(), 1);

        let did_work = logic.do_level_compaction().await.unwrap();
        assert!(did_work);

        assert_eq!(
            logic.manifest.get_table_ids().await[0].len(),
            num_tables - 2
        );
        assert_eq!(logic.levels[1].get_tables_ro().await.len(), 2);
        assert_eq!(logic.manifest.get_table_ids().await[1].len(), 2);

        // Ensure no tables exist on both levels
        for table0 in logic.levels[0].get_tables_ro().await.iter() {
            for table1 in logic.levels[1].get_tables_ro().await.iter() {
                assert_ne!(table0.get_id(), table1.get_id());
            }
        }

        test_cleanup(tempdir, logic).await;
    }

    /// Test that no compaction happens if tables are already marked with a compaction flag
    #[async_test]
    async fn compaction_flag() {
        let (tempdir, logic) = test_init().await;

        let num_tables = 5;

        // Create five tables with the exact same key entries
        for _ in 0..num_tables {
            let l0 = logic.levels.first().unwrap();
            let table_id = logic.manifest.next_table_id().await;

            let min_key = "000".to_string().into_bytes();
            let max_key = "100".to_string().into_bytes();

            let mut table_builder = l0.build_table(table_id, min_key, max_key);
            let mut seq_offset = 1;

            for num in 0..=100 {
                let key = format!("{num:03}").into_bytes();
                let value = "somevalue".to_string().into_bytes();
                let seq_number = seq_offset;
                seq_offset += 1;

                table_builder
                    .add_value(&key, seq_number, &value)
                    .await
                    .unwrap();
            }

            let table = table_builder.finish().await.unwrap();
            let table_id = table.get_id();

            let could_set_flag = table.maybe_start_compaction();
            assert!(could_set_flag);

            l0.add_l0_table(table).await;

            // Then update manifest and flush WAL
            logic
                .manifest
                .update_table_set(vec![(0, table_id)], vec![])
                .await;
        }

        assert_eq!(logic.levels[0].get_tables_ro().await.len(), num_tables);
        assert_eq!(logic.manifest.get_table_ids().await[0].len(), num_tables);
        assert!(logic.manifest.get_table_ids().await[1].is_empty());

        let result = logic
            .compact_level(&logic.levels[0], &logic.levels[1])
            .await
            .unwrap();
        assert_eq!(result, CompactResult::Locked);

        test_cleanup(tempdir, logic).await;
    }

    #[async_test]
    async fn fast_compaction_with_offset() {
        let (tempdir, logic) = test_init().await;

        let num_tables = 10;

        // Create five tables with the exact same key entries
        for idx in 0..num_tables {
            let l0 = logic.levels.first().unwrap();
            let table_id = logic.manifest.next_table_id().await;

            let pos = idx * 100;
            let next_pos = (idx + 1) * 100 - 1;

            let min_key = format!("{pos:04}").into_bytes();
            let max_key = format!("{next_pos:04}").into_bytes();

            let mut table_builder = l0.build_table(table_id, min_key, max_key);
            let mut seq_offset = 1;

            for num in pos..next_pos {
                let key = format!("{num:04}").into_bytes();
                let value = "somevalue".to_string().into_bytes();
                let seq_number = seq_offset;
                seq_offset += 1;

                table_builder
                    .add_value(&key, seq_number, &value)
                    .await
                    .unwrap();
            }

            let table = table_builder.finish().await.unwrap();
            let table_id = table.get_id();
            l0.add_l0_table(table).await;

            // Then update manifest and flush WAL
            logic
                .manifest
                .update_table_set(vec![(0, table_id)], vec![])
                .await;
        }

        // Check that compaction works fine if it is not the first table that gets pushed down
        logic.levels[0].set_next_compaction_offset(3);

        assert_eq!(logic.levels[0].get_tables_ro().await.len(), num_tables);
        assert_eq!(logic.manifest.get_table_ids().await[0].len(), num_tables);
        assert!(logic.manifest.get_table_ids().await[1].is_empty());

        let did_work = logic.do_level_compaction().await.unwrap();
        assert!(did_work);

        // One table should have moved down
        assert_eq!(logic.levels[0].get_tables_ro().await.len(), num_tables - 1);
        assert_eq!(
            logic.manifest.get_table_ids().await[0].len(),
            num_tables - 1
        );
        assert_eq!(logic.levels[1].get_tables_ro().await.len(), 1);
        assert_eq!(logic.manifest.get_table_ids().await[1].len(), 1);

        let did_work = logic.do_level_compaction().await.unwrap();
        assert!(did_work);

        assert_eq!(
            logic.manifest.get_table_ids().await[0].len(),
            num_tables - 2
        );
        assert_eq!(logic.levels[1].get_tables_ro().await.len(), 2);
        assert_eq!(logic.manifest.get_table_ids().await[1].len(), 2);

        // Ensure no tables exist on both levels
        for table0 in logic.levels[0].get_tables_ro().await.iter() {
            for table1 in logic.levels[1].get_tables_ro().await.iter() {
                assert_ne!(table0.get_id(), table1.get_id());
            }
        }

        test_cleanup(tempdir, logic).await;
    }
}