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
|
// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
// vim: ts=8 sw=2 smarttab
#pragma once
#include <iostream>
#include <boost/intrusive/list.hpp>
#include <boost/intrusive_ptr.hpp>
#include <boost/smart_ptr/intrusive_ref_counter.hpp>
#include "seastar/core/shared_future.hh"
#include "include/buffer.h"
#include "crimson/common/errorator.h"
#include "crimson/common/interruptible_future.h"
#include "crimson/os/seastore/seastore_types.h"
struct btree_lba_manager_test;
namespace crimson::os::seastore {
class Transaction;
class CachedExtent;
using CachedExtentRef = boost::intrusive_ptr<CachedExtent>;
class SegmentedAllocator;
class TransactionManager;
class ExtentPlacementManager;
template <
typename node_key_t,
typename node_val_t,
typename internal_node_t,
typename leaf_node_t,
typename pin_t,
size_t node_size,
bool leaf_has_children>
class FixedKVBtree;
template <typename, typename>
class BtreeNodeMapping;
// #define DEBUG_CACHED_EXTENT_REF
#ifdef DEBUG_CACHED_EXTENT_REF
void intrusive_ptr_add_ref(CachedExtent *);
void intrusive_ptr_release(CachedExtent *);
#endif
template <typename T>
using TCachedExtentRef = boost::intrusive_ptr<T>;
/**
* CachedExtent
*/
namespace onode {
class DummyNodeExtent;
class TestReplayExtent;
}
template <typename T>
class read_set_item_t {
using set_hook_t = boost::intrusive::set_member_hook<
boost::intrusive::link_mode<
boost::intrusive::auto_unlink>>;
set_hook_t trans_hook;
using set_hook_options = boost::intrusive::member_hook<
read_set_item_t,
set_hook_t,
&read_set_item_t::trans_hook>;
public:
struct cmp_t {
using is_transparent = paddr_t;
bool operator()(const read_set_item_t<T> &lhs, const read_set_item_t &rhs) const;
bool operator()(const paddr_t &lhs, const read_set_item_t<T> &rhs) const;
bool operator()(const read_set_item_t<T> &lhs, const paddr_t &rhs) const;
};
struct trans_cmp_t {
bool operator()(
const read_set_item_t<Transaction> &lhs,
const read_set_item_t<Transaction> &rhs) const {
return lhs.t < rhs.t;
}
bool operator()(
const Transaction *lhs,
const read_set_item_t<Transaction> &rhs) const {
return lhs < rhs.t;
}
bool operator()(
const read_set_item_t<Transaction> &lhs,
const Transaction *rhs) const {
return lhs.t < rhs;
}
};
using trans_set_t = boost::intrusive::set<
read_set_item_t,
set_hook_options,
boost::intrusive::constant_time_size<false>,
boost::intrusive::compare<trans_cmp_t>>;
T *t = nullptr;
CachedExtentRef ref;
read_set_item_t(T *t, CachedExtentRef ref);
read_set_item_t(const read_set_item_t &) = delete;
read_set_item_t(read_set_item_t &&) = default;
~read_set_item_t() = default;
};
template <typename T>
using read_set_t = std::set<
read_set_item_t<T>,
typename read_set_item_t<T>::cmp_t>;
struct trans_spec_view_t {
// if the extent is pending, contains the id of the owning transaction;
// TRANS_ID_NULL otherwise
transaction_id_t pending_for_transaction = TRANS_ID_NULL;
struct cmp_t {
bool operator()(
const trans_spec_view_t &lhs,
const trans_spec_view_t &rhs) const
{
return lhs.pending_for_transaction < rhs.pending_for_transaction;
}
bool operator()(
const transaction_id_t &lhs,
const trans_spec_view_t &rhs) const
{
return lhs < rhs.pending_for_transaction;
}
bool operator()(
const trans_spec_view_t &lhs,
const transaction_id_t &rhs) const
{
return lhs.pending_for_transaction < rhs;
}
};
using trans_view_hook_t =
boost::intrusive::set_member_hook<
boost::intrusive::link_mode<
boost::intrusive::auto_unlink>>;
trans_view_hook_t trans_view_hook;
using trans_view_member_options =
boost::intrusive::member_hook<
trans_spec_view_t,
trans_view_hook_t,
&trans_spec_view_t::trans_view_hook>;
using trans_view_set_t = boost::intrusive::set<
trans_spec_view_t,
trans_view_member_options,
boost::intrusive::constant_time_size<false>,
boost::intrusive::compare<cmp_t>>;
};
class ExtentIndex;
class CachedExtent
: public boost::intrusive_ref_counter<
CachedExtent, boost::thread_unsafe_counter>,
public trans_spec_view_t {
enum class extent_state_t : uint8_t {
INITIAL_WRITE_PENDING, // In Transaction::write_set and fresh_block_list
MUTATION_PENDING, // In Transaction::write_set and mutated_block_list
CLEAN_PENDING, // CLEAN, but not yet read out
CLEAN, // In Cache::extent_index, Transaction::read_set
// during write, contents match disk, version == 0
DIRTY, // Same as CLEAN, but contents do not match disk,
// version > 0
EXIST_CLEAN, // Similar to CLEAN, but its metadata not yet
// persisted to disk.
// In Transaction::write_set and existing_block_list.
// After transaction commits, state becomes CLEAN
// and add extent to Cache. Modifing such extents
// will cause state turn to EXIST_MUTATION_PENDING.
EXIST_MUTATION_PENDING,// Similar to MUTATION_PENDING, but its prior_instance
// is empty.
// In Transaction::write_set, existing_block_list and
// mutated_block_list. State becomes DIRTY and it is
// added to Cache after transaction commits.
INVALID // Part of no ExtentIndex set
} state = extent_state_t::INVALID;
friend std::ostream &operator<<(std::ostream &, extent_state_t);
// allow a dummy extent to pretend it is at a specific state
friend class onode::DummyNodeExtent;
friend class onode::TestReplayExtent;
template <
typename node_key_t,
typename node_val_t,
typename internal_node_t,
typename leaf_node_t,
typename pin_t,
size_t node_size,
bool leaf_has_children>
friend class FixedKVBtree;
uint32_t last_committed_crc = 0;
// Points at current version while in state MUTATION_PENDING
CachedExtentRef prior_instance;
// time of the last modification
sea_time_point modify_time = NULL_TIME;
public:
void init(extent_state_t _state,
paddr_t paddr,
placement_hint_t hint,
rewrite_gen_t gen,
transaction_id_t trans_id) {
assert(gen == NULL_GENERATION || is_rewrite_generation(gen));
state = _state;
set_paddr(paddr);
user_hint = hint;
rewrite_generation = gen;
pending_for_transaction = trans_id;
}
void set_modify_time(sea_time_point t) {
modify_time = t;
}
sea_time_point get_modify_time() const {
return modify_time;
}
/**
* duplicate_for_write
*
* Implementation should return a fresh CachedExtentRef
* which represents a copy of *this until on_delta_write()
* is complete, at which point the user may assume *this
* will be in state INVALID. As such, the implementation
* may involve a copy of get_bptr(), or an ancillary
* structure which defers updating the actual buffer until
* on_delta_write().
*/
virtual CachedExtentRef duplicate_for_write(Transaction &t) = 0;
/**
* prepare_write
*
* Called prior to reading buffer.
* Implemenation may use this callback to fully write out
* updates to the buffer.
*/
virtual void prepare_write() {}
/**
* prepare_commit
*
* Called prior to committing the transaction in which this extent
* is living.
*/
virtual void prepare_commit() {}
/**
* on_initial_write
*
* Called after commit of extent. State will be CLEAN.
* Implentation may use this call to fixup the buffer
* with the newly available absolute get_paddr().
*/
virtual void on_initial_write() {}
/**
* on_clean_read
*
* Called after read of initially written extent.
* State will be CLEAN. Implentation may use this
* call to fixup the buffer with the newly available
* absolute get_paddr().
*/
virtual void on_clean_read() {}
/**
* on_delta_write
*
* Called after commit of delta. State will be DIRTY.
* Implentation may use this call to fixup any relative
* references in the the buffer with the passed
* record_block_offset record location.
*/
virtual void on_delta_write(paddr_t record_block_offset) {}
/**
* on_replace_prior
*
* Called after the extent has replaced a previous one. State
* of the extent must be MUTATION_PENDING. Implementation
* may use this call to synchronize states that must be synchronized
* with the states of Cache and can't wait till transaction
* completes.
*/
virtual void on_replace_prior(Transaction &t) {}
/**
* on_invalidated
*
* Called after the extent is invalidated, either by Cache::invalidate_extent
* or Transaction::add_to_retired_set. Implementation may use this
* call to adjust states that must be changed immediately once
* invalidated.
*/
virtual void on_invalidated(Transaction &t) {}
/**
* get_type
*
* Returns concrete type.
*/
virtual extent_types_t get_type() const = 0;
virtual bool is_logical() const {
return false;
}
virtual bool may_conflict() const {
return true;
}
friend std::ostream &operator<<(std::ostream &, extent_state_t);
virtual std::ostream &print_detail(std::ostream &out) const { return out; }
std::ostream &print(std::ostream &out) const {
std::string prior_poffset_str = prior_poffset
? fmt::format("{}", *prior_poffset)
: "nullopt";
out << "CachedExtent(addr=" << this
<< ", type=" << get_type()
<< ", version=" << version
<< ", dirty_from_or_retired_at=" << dirty_from_or_retired_at
<< ", modify_time=" << sea_time_point_printer_t{modify_time}
<< ", paddr=" << get_paddr()
<< ", prior_paddr=" << prior_poffset_str
<< ", length=" << get_length()
<< ", state=" << state
<< ", last_committed_crc=" << last_committed_crc
<< ", refcount=" << use_count()
<< ", user_hint=" << user_hint
<< ", fully_loaded=" << is_fully_loaded()
<< ", rewrite_gen=" << rewrite_gen_printer_t{rewrite_generation};
if (state != extent_state_t::INVALID &&
state != extent_state_t::CLEAN_PENDING) {
print_detail(out);
}
return out << ")";
}
/**
* get_delta
*
* Must return a valid delta usable in apply_delta() in submit_transaction
* if state == MUTATION_PENDING.
*/
virtual ceph::bufferlist get_delta() = 0;
/**
* apply_delta
*
* bl is a delta obtained previously from get_delta. The versions will
* match. Implementation should mutate buffer based on bl. base matches
* the address passed on_delta_write.
*
* Implementation *must* use set_last_committed_crc to update the crc to
* what the crc of the buffer would have been at submission. For physical
* extents that use base to adjust internal record-relative deltas, this
* means that the crc should be of the buffer after applying the delta,
* but before that adjustment. We do it this way because the crc in the
* commit path does not yet know the record base address.
*
* LogicalCachedExtent overrides this method and provides a simpler
* apply_delta override for LogicalCachedExtent implementers.
*/
virtual void apply_delta_and_adjust_crc(
paddr_t base, const ceph::bufferlist &bl) = 0;
/**
* Called on dirty CachedExtent implementation after replay.
* Implementation should perform any reads/in-memory-setup
* necessary. (for instance, the lba implementation will use this
* to load in lba_manager blocks)
*/
using complete_load_ertr = crimson::errorator<
crimson::ct_error::input_output_error>;
virtual complete_load_ertr::future<> complete_load() {
return complete_load_ertr::now();
}
/**
* cast
*
* Returns a TCachedExtentRef of the specified type.
* TODO: add dynamic check that the requested type is actually correct.
*/
template <typename T>
TCachedExtentRef<T> cast() {
return TCachedExtentRef<T>(static_cast<T*>(this));
}
template <typename T>
TCachedExtentRef<const T> cast() const {
return TCachedExtentRef<const T>(static_cast<const T*>(this));
}
/// Returns true if extent can be mutated in an open transaction
bool is_mutable() const {
return state == extent_state_t::INITIAL_WRITE_PENDING ||
state == extent_state_t::MUTATION_PENDING ||
state == extent_state_t::EXIST_MUTATION_PENDING;
}
/// Returns true if extent is part of an open transaction
bool is_pending() const {
return is_mutable() || state == extent_state_t::EXIST_CLEAN;
}
/// Returns true if extent is stable and shared among transactions
bool is_stable() const {
return state == extent_state_t::CLEAN_PENDING ||
state == extent_state_t::CLEAN ||
state == extent_state_t::DIRTY;
}
/// Returns true if extent has a pending delta
bool is_mutation_pending() const {
return state == extent_state_t::MUTATION_PENDING;
}
/// Returns true if extent is a fresh extent
bool is_initial_pending() const {
return state == extent_state_t::INITIAL_WRITE_PENDING;
}
/// Returns true if extent is clean (does not have deltas on disk)
bool is_clean() const {
ceph_assert(is_valid());
return state == extent_state_t::INITIAL_WRITE_PENDING ||
state == extent_state_t::CLEAN ||
state == extent_state_t::CLEAN_PENDING ||
state == extent_state_t::EXIST_CLEAN;
}
// Returs true if extent is stable and clean
bool is_stable_clean() const {
ceph_assert(is_valid());
return state == extent_state_t::CLEAN ||
state == extent_state_t::CLEAN_PENDING;
}
/// Ruturns true if data is persisted while metadata isn't
bool is_exist_clean() const {
return state == extent_state_t::EXIST_CLEAN;
}
/// Returns true if the extent with EXTIST_CLEAN is modified
bool is_exist_mutation_pending() const {
return state == extent_state_t::EXIST_MUTATION_PENDING;
}
/// Returns true if extent is dirty (has deltas on disk)
bool is_dirty() const {
ceph_assert(is_valid());
return !is_clean();
}
/// Returns true if extent has not been superceded or retired
bool is_valid() const {
return state != extent_state_t::INVALID;
}
/// Returns true if extent or prior_instance has been invalidated
bool has_been_invalidated() const {
return !is_valid() || (is_mutation_pending() && !prior_instance->is_valid());
}
/// Returns true if extent is a plcaeholder
bool is_placeholder() const {
return get_type() == extent_types_t::RETIRED_PLACEHOLDER;
}
bool is_pending_io() const {
return !!io_wait_promise;
}
/// Return journal location of oldest relevant delta, only valid while DIRTY
auto get_dirty_from() const {
ceph_assert(is_dirty());
return dirty_from_or_retired_at;
}
/// Return journal location of oldest relevant delta, only valid while RETIRED
auto get_retired_at() const {
ceph_assert(!is_valid());
return dirty_from_or_retired_at;
}
/// Return true if extent is fully loaded or is about to be fully loaded (call
/// wait_io() in this case)
bool is_fully_loaded() const {
return ptr.has_value();
}
/**
* get_paddr
*
* Returns current address of extent. If is_initial_pending(), address will
* be relative, otherwise address will be absolute.
*/
paddr_t get_paddr() const { return poffset; }
/// Returns length of extent data in disk
extent_len_t get_length() const {
return length;
}
extent_len_t get_loaded_length() const {
if (ptr.has_value()) {
return ptr->length();
} else {
return 0;
}
}
/// Returns version, get_version() == 0 iff is_clean()
extent_version_t get_version() const {
return version;
}
/// Returns crc32c of buffer
uint32_t get_crc32c() {
return ceph_crc32c(
1,
reinterpret_cast<const unsigned char *>(get_bptr().c_str()),
get_length());
}
/// Get ref to raw buffer
bufferptr &get_bptr() {
assert(ptr.has_value());
return *ptr;
}
const bufferptr &get_bptr() const {
assert(ptr.has_value());
return *ptr;
}
/// Compare by paddr
friend bool operator< (const CachedExtent &a, const CachedExtent &b) {
return a.poffset < b.poffset;
}
friend bool operator> (const CachedExtent &a, const CachedExtent &b) {
return a.poffset > b.poffset;
}
friend bool operator== (const CachedExtent &a, const CachedExtent &b) {
return a.poffset == b.poffset;
}
virtual ~CachedExtent();
placement_hint_t get_user_hint() const {
return user_hint;
}
rewrite_gen_t get_rewrite_generation() const {
return rewrite_generation;
}
void invalidate_hints() {
user_hint = PLACEMENT_HINT_NULL;
rewrite_generation = NULL_GENERATION;
}
/// assign the target rewrite generation for the followup rewrite
void set_target_rewrite_generation(rewrite_gen_t gen) {
assert(is_target_rewrite_generation(gen));
user_hint = placement_hint_t::REWRITE;
rewrite_generation = gen;
}
bool is_inline() const {
return poffset.is_relative();
}
paddr_t get_prior_paddr_and_reset() {
assert(prior_poffset);
auto ret = *prior_poffset;
prior_poffset.reset();
return ret;
}
void set_invalid(Transaction &t);
// a rewrite extent has an invalid prior_instance,
// and a mutation_pending extent has a valid prior_instance
CachedExtentRef get_prior_instance() {
return prior_instance;
}
private:
template <typename T>
friend class read_set_item_t;
friend struct paddr_cmp;
friend struct ref_paddr_cmp;
friend class ExtentIndex;
/// Pointer to containing index (or null)
ExtentIndex *parent_index = nullptr;
/// hook for intrusive extent_index
boost::intrusive::set_member_hook<> extent_index_hook;
using index_member_options = boost::intrusive::member_hook<
CachedExtent,
boost::intrusive::set_member_hook<>,
&CachedExtent::extent_index_hook>;
using index = boost::intrusive::set<CachedExtent, index_member_options>;
friend class ExtentIndex;
friend class Transaction;
bool is_linked() {
return extent_index_hook.is_linked();
}
/// set bufferptr
void set_bptr(ceph::bufferptr &&nptr) {
ptr = nptr;
}
/// Returns true if the extent part of the open transaction
bool is_pending_in_trans(transaction_id_t id) const {
return is_pending() && pending_for_transaction == id;
}
/// hook for intrusive ref list (mainly dirty or lru list)
boost::intrusive::list_member_hook<> primary_ref_list_hook;
using primary_ref_list_member_options = boost::intrusive::member_hook<
CachedExtent,
boost::intrusive::list_member_hook<>,
&CachedExtent::primary_ref_list_hook>;
using list = boost::intrusive::list<
CachedExtent,
primary_ref_list_member_options>;
/**
* dirty_from_or_retired_at
*
* Encodes ordering token for primary_ref_list -- dirty_from when
* dirty or retired_at if retired.
*/
journal_seq_t dirty_from_or_retired_at;
/// cache data contents, std::nullopt if no data in cache
std::optional<ceph::bufferptr> ptr;
/// disk data length
extent_len_t length;
/// number of deltas since initial write
extent_version_t version = 0;
/// address of original block -- record relative iff is_initial_pending()
paddr_t poffset;
/// relative address before ool write, used to update mapping
std::optional<paddr_t> prior_poffset = std::nullopt;
/// used to wait while in-progress commit completes
std::optional<seastar::shared_promise<>> io_wait_promise;
void set_io_wait() {
ceph_assert(!io_wait_promise);
io_wait_promise = seastar::shared_promise<>();
}
void complete_io() {
ceph_assert(io_wait_promise);
io_wait_promise->set_value();
io_wait_promise = std::nullopt;
}
seastar::future<> wait_io() {
if (!io_wait_promise) {
return seastar::now();
} else {
return io_wait_promise->get_shared_future();
}
}
CachedExtent* get_transactional_view(Transaction &t);
CachedExtent* get_transactional_view(transaction_id_t tid);
read_set_item_t<Transaction>::trans_set_t transactions;
placement_hint_t user_hint = PLACEMENT_HINT_NULL;
// the target rewrite generation for the followup rewrite
// or the rewrite generation for the fresh write
rewrite_gen_t rewrite_generation = NULL_GENERATION;
protected:
trans_view_set_t mutation_pendings;
CachedExtent(CachedExtent &&other) = delete;
CachedExtent(ceph::bufferptr &&_ptr) : ptr(std::move(_ptr)) {
length = ptr->length();
assert(length > 0);
}
/// construct new CachedExtent, will deep copy the buffer
CachedExtent(const CachedExtent &other)
: state(other.state),
dirty_from_or_retired_at(other.dirty_from_or_retired_at),
length(other.get_length()),
version(other.version),
poffset(other.poffset) {
assert((length % CEPH_PAGE_SIZE) == 0);
if (other.is_fully_loaded()) {
ptr.emplace(buffer::create_page_aligned(length));
other.ptr->copy_out(0, length, ptr->c_str());
} else {
// the extent must be fully loaded before CoW
assert(length == 0); // in case of root
}
}
struct share_buffer_t {};
/// construct new CachedExtent, will shallow copy the buffer
CachedExtent(const CachedExtent &other, share_buffer_t)
: state(other.state),
dirty_from_or_retired_at(other.dirty_from_or_retired_at),
ptr(other.ptr),
length(other.get_length()),
version(other.version),
poffset(other.poffset) {}
// 0 length is only possible for the RootBlock
struct zero_length_t {};
CachedExtent(zero_length_t) : ptr(ceph::bufferptr(0)), length(0) {};
struct retired_placeholder_t{};
CachedExtent(retired_placeholder_t, extent_len_t _length)
: state(extent_state_t::INVALID),
length(_length) {
assert(length > 0);
}
/// no buffer extent, for lazy read
CachedExtent(extent_len_t _length) : length(_length) {
assert(length > 0);
}
friend class Cache;
template <typename T, typename... Args>
static TCachedExtentRef<T> make_cached_extent_ref(
Args&&... args) {
return new T(std::forward<Args>(args)...);
}
template <typename T>
static TCachedExtentRef<T> make_placeholder_cached_extent_ref(
extent_len_t length) {
return new T(length);
}
void reset_prior_instance() {
prior_instance.reset();
}
/// Sets last_committed_crc
void set_last_committed_crc(uint32_t crc) {
last_committed_crc = crc;
}
void set_paddr(paddr_t offset, bool need_update_mapping = false) {
if (need_update_mapping) {
assert(!prior_poffset);
prior_poffset = poffset;
}
poffset = offset;
}
/**
* maybe_generate_relative
*
* There are three kinds of addresses one might want to
* store within an extent:
* - addr for a block within the same transaction relative to the
* physical location of this extent in the
* event that we will read it in the initial read of the extent
* - addr relative to the physical location of the next record to a
* block within that record to contain a delta for this extent in
* the event that we'll read it from a delta and overlay it onto a
* dirty representation of the extent.
* - absolute addr to a block already written outside of the current
* transaction.
*
* This helper checks addr and the current state to create the correct
* reference.
*/
paddr_t maybe_generate_relative(paddr_t addr) {
if (is_initial_pending() && addr.is_record_relative()) {
return addr.block_relative_to(get_paddr());
} else {
ceph_assert(!addr.is_record_relative() || is_mutation_pending());
return addr;
}
}
friend class crimson::os::seastore::SegmentedAllocator;
friend class crimson::os::seastore::TransactionManager;
friend class crimson::os::seastore::ExtentPlacementManager;
template <typename, typename>
friend class BtreeNodeMapping;
friend class ::btree_lba_manager_test;
};
std::ostream &operator<<(std::ostream &, CachedExtent::extent_state_t);
std::ostream &operator<<(std::ostream &, const CachedExtent&);
bool is_backref_mapped_extent_node(const CachedExtentRef &extent);
/// Compare extents by paddr
struct paddr_cmp {
bool operator()(paddr_t lhs, const CachedExtent &rhs) const {
return lhs < rhs.poffset;
}
bool operator()(const CachedExtent &lhs, paddr_t rhs) const {
return lhs.poffset < rhs;
}
};
/// Compare extent refs by paddr
struct ref_paddr_cmp {
using is_transparent = paddr_t;
bool operator()(const CachedExtentRef &lhs, const CachedExtentRef &rhs) const {
return lhs->poffset < rhs->poffset;
}
bool operator()(const paddr_t &lhs, const CachedExtentRef &rhs) const {
return lhs < rhs->poffset;
}
bool operator()(const CachedExtentRef &lhs, const paddr_t &rhs) const {
return lhs->poffset < rhs;
}
};
template <typename T, typename C>
class addr_extent_list_base_t
: public std::list<std::pair<T, C>> {};
using pextent_list_t = addr_extent_list_base_t<paddr_t, CachedExtentRef>;
template <typename T, typename C, typename Cmp>
class addr_extent_set_base_t
: public std::set<C, Cmp> {};
using pextent_set_t = addr_extent_set_base_t<
paddr_t,
CachedExtentRef,
ref_paddr_cmp
>;
template <typename T>
using t_pextent_list_t = addr_extent_list_base_t<paddr_t, TCachedExtentRef<T>>;
/**
* ExtentIndex
*
* Index of CachedExtent & by poffset, does not hold a reference,
* user must ensure each extent is removed prior to deletion
*/
class ExtentIndex {
friend class Cache;
CachedExtent::index extent_index;
public:
auto get_overlap(paddr_t addr, extent_len_t len) {
auto bottom = extent_index.upper_bound(addr, paddr_cmp());
if (bottom != extent_index.begin())
--bottom;
if (bottom != extent_index.end() &&
bottom->get_paddr().add_offset(bottom->get_length()) <= addr)
++bottom;
auto top = extent_index.lower_bound(addr.add_offset(len), paddr_cmp());
return std::make_pair(
bottom,
top
);
}
void clear() {
struct cached_extent_disposer {
void operator() (CachedExtent* extent) {
extent->parent_index = nullptr;
}
};
extent_index.clear_and_dispose(cached_extent_disposer());
bytes = 0;
}
void insert(CachedExtent &extent) {
// sanity check
ceph_assert(!extent.parent_index);
auto [a, b] = get_overlap(
extent.get_paddr(),
extent.get_length());
ceph_assert(a == b);
[[maybe_unused]] auto [iter, inserted] = extent_index.insert(extent);
assert(inserted);
extent.parent_index = this;
bytes += extent.get_length();
}
void erase(CachedExtent &extent) {
assert(extent.parent_index);
assert(extent.is_linked());
[[maybe_unused]] auto erased = extent_index.erase(
extent_index.s_iterator_to(extent));
extent.parent_index = nullptr;
assert(erased);
bytes -= extent.get_length();
}
void replace(CachedExtent &to, CachedExtent &from) {
assert(to.get_length() == from.get_length());
extent_index.replace_node(extent_index.s_iterator_to(from), to);
from.parent_index = nullptr;
to.parent_index = this;
}
bool empty() const {
return extent_index.empty();
}
auto find_offset(paddr_t offset) {
return extent_index.find(offset, paddr_cmp());
}
auto begin() {
return extent_index.begin();
}
auto end() {
return extent_index.end();
}
auto size() const {
return extent_index.size();
}
auto get_bytes() const {
return bytes;
}
~ExtentIndex() {
assert(extent_index.empty());
assert(bytes == 0);
}
private:
uint64_t bytes = 0;
};
class ChildableCachedExtent;
class LogicalCachedExtent;
class child_pos_t {
public:
child_pos_t(CachedExtentRef stable_parent, uint16_t pos)
: stable_parent(stable_parent), pos(pos) {}
template <typename parent_t>
TCachedExtentRef<parent_t> get_parent() {
ceph_assert(stable_parent);
return stable_parent->template cast<parent_t>();
}
uint16_t get_pos() {
return pos;
}
void link_child(ChildableCachedExtent *c);
private:
CachedExtentRef stable_parent;
uint16_t pos = std::numeric_limits<uint16_t>::max();
};
using get_child_ertr = crimson::errorator<
crimson::ct_error::input_output_error>;
template <typename T>
struct get_child_ret_t {
std::variant<child_pos_t, get_child_ertr::future<TCachedExtentRef<T>>> ret;
get_child_ret_t(child_pos_t pos)
: ret(std::move(pos)) {}
get_child_ret_t(get_child_ertr::future<TCachedExtentRef<T>> child)
: ret(std::move(child)) {}
bool has_child() const {
return ret.index() == 1;
}
child_pos_t &get_child_pos() {
ceph_assert(ret.index() == 0);
return std::get<0>(ret);
}
get_child_ertr::future<TCachedExtentRef<T>> &get_child_fut() {
ceph_assert(ret.index() == 1);
return std::get<1>(ret);
}
};
template <typename key_t, typename>
class PhysicalNodeMapping;
template <typename key_t, typename val_t>
using PhysicalNodeMappingRef = std::unique_ptr<PhysicalNodeMapping<key_t, val_t>>;
template <typename key_t, typename val_t>
class PhysicalNodeMapping {
public:
virtual extent_len_t get_length() const = 0;
virtual extent_types_t get_type() const = 0;
virtual val_t get_val() const = 0;
virtual key_t get_key() const = 0;
virtual PhysicalNodeMappingRef<key_t, val_t> duplicate() const = 0;
virtual bool has_been_invalidated() const = 0;
virtual CachedExtentRef get_parent() const = 0;
virtual uint16_t get_pos() const = 0;
// An lba pin may be indirect, see comments in lba_manager/btree/btree_lba_manager.h
virtual bool is_indirect() const { return false; }
virtual key_t get_intermediate_key() const { return min_max_t<key_t>::null; }
virtual key_t get_intermediate_base() const { return min_max_t<key_t>::null; }
virtual extent_len_t get_intermediate_length() const { return 0; }
// The start offset of the pin, must be 0 if the pin is not indirect
virtual extent_len_t get_intermediate_offset() const {
return std::numeric_limits<extent_len_t>::max();
}
virtual get_child_ret_t<LogicalCachedExtent>
get_logical_extent(Transaction &t) = 0;
void link_child(ChildableCachedExtent *c) {
ceph_assert(child_pos);
child_pos->link_child(c);
}
virtual ~PhysicalNodeMapping() {}
protected:
std::optional<child_pos_t> child_pos = std::nullopt;
};
using LBAMapping = PhysicalNodeMapping<laddr_t, paddr_t>;
using LBAMappingRef = PhysicalNodeMappingRef<laddr_t, paddr_t>;
std::ostream &operator<<(std::ostream &out, const LBAMapping &rhs);
using lba_pin_list_t = std::list<LBAMappingRef>;
std::ostream &operator<<(std::ostream &out, const lba_pin_list_t &rhs);
using BackrefMapping = PhysicalNodeMapping<paddr_t, laddr_t>;
using BackrefMappingRef = PhysicalNodeMappingRef<paddr_t, laddr_t>;
using backref_pin_list_t = std::list<BackrefMappingRef>;
/**
* RetiredExtentPlaceholder
*
* Cache::retire_extent_addr(Transaction&, paddr_t, extent_len_t) can retire an
* extent not currently in cache. In that case, in order to detect transaction
* invalidation, we need to add a placeholder to the cache to create the
* mapping back to the transaction. And whenever there is a transaction tries
* to read the placeholder extent out, Cache is responsible to replace the
* placeholder by the real one. Anyway, No placeholder extents should escape
* the Cache interface boundary.
*/
class RetiredExtentPlaceholder : public CachedExtent {
public:
RetiredExtentPlaceholder(extent_len_t length)
: CachedExtent(CachedExtent::retired_placeholder_t{}, length) {}
CachedExtentRef duplicate_for_write(Transaction&) final {
ceph_assert(0 == "Should never happen for a placeholder");
return CachedExtentRef();
}
ceph::bufferlist get_delta() final {
ceph_assert(0 == "Should never happen for a placeholder");
return ceph::bufferlist();
}
static constexpr extent_types_t TYPE = extent_types_t::RETIRED_PLACEHOLDER;
extent_types_t get_type() const final {
return TYPE;
}
void apply_delta_and_adjust_crc(
paddr_t base, const ceph::bufferlist &bl) final {
ceph_assert(0 == "Should never happen for a placeholder");
}
bool is_logical() const final {
return false;
}
std::ostream &print_detail(std::ostream &out) const final {
return out << ", RetiredExtentPlaceholder";
}
void on_delta_write(paddr_t record_block_offset) final {
ceph_assert(0 == "Should never happen for a placeholder");
}
};
class parent_tracker_t
: public boost::intrusive_ref_counter<
parent_tracker_t, boost::thread_unsafe_counter> {
public:
parent_tracker_t(CachedExtentRef parent)
: parent(parent) {}
parent_tracker_t(CachedExtent* parent)
: parent(parent) {}
~parent_tracker_t();
template <typename T = CachedExtent>
TCachedExtentRef<T> get_parent() const {
ceph_assert(parent);
if constexpr (std::is_same_v<T, CachedExtent>) {
return parent;
} else {
return parent->template cast<T>();
}
}
void reset_parent(CachedExtentRef p) {
parent = p;
}
bool is_valid() const {
return parent && parent->is_valid();
}
private:
CachedExtentRef parent;
};
std::ostream &operator<<(std::ostream &, const parent_tracker_t &);
using parent_tracker_ref = boost::intrusive_ptr<parent_tracker_t>;
class ChildableCachedExtent : public CachedExtent {
public:
template <typename... T>
ChildableCachedExtent(T&&... t) : CachedExtent(std::forward<T>(t)...) {}
bool has_parent_tracker() const {
return (bool)parent_tracker;
}
void reset_parent_tracker(parent_tracker_t *p = nullptr) {
parent_tracker.reset(p);
}
bool is_parent_valid() const {
return parent_tracker && parent_tracker->is_valid();
}
template <typename T = CachedExtent>
TCachedExtentRef<T> get_parent_node() const {
assert(parent_tracker);
return parent_tracker->template get_parent<T>();
}
void take_prior_parent_tracker() {
auto &prior = (ChildableCachedExtent&)(*get_prior_instance());
parent_tracker = prior.parent_tracker;
}
std::ostream &print_detail(std::ostream &out) const final;
private:
parent_tracker_ref parent_tracker;
virtual std::ostream &_print_detail(std::ostream &out) const {
return out;
}
};
/**
* LogicalCachedExtent
*
* CachedExtent with associated lba mapping.
*
* Users of TransactionManager should be using extents derived from
* LogicalCachedExtent.
*/
class LogicalCachedExtent : public ChildableCachedExtent {
public:
template <typename... T>
LogicalCachedExtent(T&&... t)
: ChildableCachedExtent(std::forward<T>(t)...)
{}
bool has_laddr() const {
return laddr != L_ADDR_NULL;
}
laddr_t get_laddr() const {
assert(laddr != L_ADDR_NULL);
return laddr;
}
void set_laddr(laddr_t nladdr) {
laddr = nladdr;
}
void maybe_set_intermediate_laddr(LBAMapping &mapping) {
laddr = mapping.is_indirect()
? mapping.get_intermediate_base()
: mapping.get_key();
}
void apply_delta_and_adjust_crc(
paddr_t base, const ceph::bufferlist &bl) final {
apply_delta(bl);
set_last_committed_crc(get_crc32c());
}
bool is_logical() const final {
return true;
}
std::ostream &_print_detail(std::ostream &out) const final;
void on_replace_prior(Transaction &t) final;
virtual ~LogicalCachedExtent();
protected:
virtual void apply_delta(const ceph::bufferlist &bl) = 0;
virtual std::ostream &print_detail_l(std::ostream &out) const {
return out;
}
virtual void logical_on_delta_write() {}
void on_delta_write(paddr_t record_block_offset) final {
assert(is_exist_mutation_pending() ||
get_prior_instance());
logical_on_delta_write();
}
private:
// the logical address of the extent, and if shared,
// it is the intermediate_base, see BtreeLBAMapping comments.
laddr_t laddr = L_ADDR_NULL;
};
using LogicalCachedExtentRef = TCachedExtentRef<LogicalCachedExtent>;
struct ref_laddr_cmp {
using is_transparent = laddr_t;
bool operator()(const LogicalCachedExtentRef &lhs,
const LogicalCachedExtentRef &rhs) const {
return lhs->get_laddr() < rhs->get_laddr();
}
bool operator()(const laddr_t &lhs,
const LogicalCachedExtentRef &rhs) const {
return lhs < rhs->get_laddr();
}
bool operator()(const LogicalCachedExtentRef &lhs,
const laddr_t &rhs) const {
return lhs->get_laddr() < rhs;
}
};
template <typename T>
read_set_item_t<T>::read_set_item_t(T *t, CachedExtentRef ref)
: t(t), ref(ref)
{}
template <typename T>
inline bool read_set_item_t<T>::cmp_t::operator()(
const read_set_item_t<T> &lhs, const read_set_item_t<T> &rhs) const {
return lhs.ref->poffset < rhs.ref->poffset;
}
template <typename T>
inline bool read_set_item_t<T>::cmp_t::operator()(
const paddr_t &lhs, const read_set_item_t<T> &rhs) const {
return lhs < rhs.ref->poffset;
}
template <typename T>
inline bool read_set_item_t<T>::cmp_t::operator()(
const read_set_item_t<T> &lhs, const paddr_t &rhs) const {
return lhs.ref->poffset < rhs;
}
using lextent_set_t = addr_extent_set_base_t<
laddr_t,
LogicalCachedExtentRef,
ref_laddr_cmp
>;
template <typename T>
using lextent_list_t = addr_extent_list_base_t<
laddr_t, TCachedExtentRef<T>>;
}
#if FMT_VERSION >= 90000
template <> struct fmt::formatter<crimson::os::seastore::lba_pin_list_t> : fmt::ostream_formatter {};
template <> struct fmt::formatter<crimson::os::seastore::CachedExtent> : fmt::ostream_formatter {};
template <> struct fmt::formatter<crimson::os::seastore::LogicalCachedExtent> : fmt::ostream_formatter {};
template <> struct fmt::formatter<crimson::os::seastore::LBAMapping> : fmt::ostream_formatter {};
#endif
|