Line data Source code
1 : use core::fmt::Display;
2 : use pageserver_api::shard::TenantShardId;
3 : use std::ops::Range;
4 : use utils::{id::TimelineId, lsn::Lsn};
5 :
6 : use crate::repository::Key;
7 :
8 : use super::{DeltaLayerName, ImageLayerName, LayerName};
9 :
10 : use serde::{Deserialize, Serialize};
11 :
12 : #[cfg(test)]
13 : use utils::id::TenantId;
14 :
15 : /// A unique identifier of a persistent layer.
16 : ///
17 : /// This is different from `LayerDescriptor`, which is only used in the benchmarks.
18 : /// This struct contains all necessary information to find the image / delta layer. It also provides
19 : /// a unified way to generate layer information like file name.
20 0 : #[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize, Hash)]
21 : pub struct PersistentLayerDesc {
22 : pub tenant_shard_id: TenantShardId,
23 : pub timeline_id: TimelineId,
24 : /// Range of keys that this layer covers
25 : pub key_range: Range<Key>,
26 : /// Inclusive start, exclusive end of the LSN range that this layer holds.
27 : ///
28 : /// - For an open in-memory layer, the end bound is MAX_LSN
29 : /// - For a frozen in-memory layer or a delta layer, the end bound is a valid lsn after the
30 : /// range start
31 : /// - An image layer represents snapshot at one LSN, so end_lsn is always the snapshot LSN + 1
32 : pub lsn_range: Range<Lsn>,
33 : /// Whether this is a delta layer, and also, is this incremental.
34 : pub is_delta: bool,
35 : pub file_size: u64,
36 : }
37 :
38 : /// A unique identifier of a persistent layer within the context of one timeline.
39 : #[derive(Debug, PartialEq, Eq, Clone, Hash)]
40 : pub struct PersistentLayerKey {
41 : pub key_range: Range<Key>,
42 : pub lsn_range: Range<Lsn>,
43 : pub is_delta: bool,
44 : }
45 :
46 : impl std::fmt::Display for PersistentLayerKey {
47 16 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
48 16 : write!(
49 16 : f,
50 16 : "{}..{} {}..{} is_delta={}",
51 16 : self.key_range.start,
52 16 : self.key_range.end,
53 16 : self.lsn_range.start,
54 16 : self.lsn_range.end,
55 16 : self.is_delta
56 16 : )
57 16 : }
58 : }
59 :
60 : impl PersistentLayerDesc {
61 561286 : pub fn key(&self) -> PersistentLayerKey {
62 561286 : PersistentLayerKey {
63 561286 : key_range: self.key_range.clone(),
64 561286 : lsn_range: self.lsn_range.clone(),
65 561286 : is_delta: self.is_delta,
66 561286 : }
67 561286 : }
68 :
69 1946 : pub fn short_id(&self) -> impl Display {
70 1946 : self.layer_name()
71 1946 : }
72 :
73 : #[cfg(test)]
74 10 : pub fn new_test(key_range: Range<Key>, lsn_range: Range<Lsn>, is_delta: bool) -> Self {
75 10 : Self {
76 10 : tenant_shard_id: TenantShardId::unsharded(TenantId::generate()),
77 10 : timeline_id: TimelineId::generate(),
78 10 : key_range,
79 10 : lsn_range,
80 10 : is_delta,
81 10 : file_size: 0,
82 10 : }
83 10 : }
84 :
85 310 : pub fn new_img(
86 310 : tenant_shard_id: TenantShardId,
87 310 : timeline_id: TimelineId,
88 310 : key_range: Range<Key>,
89 310 : lsn: Lsn,
90 310 : file_size: u64,
91 310 : ) -> Self {
92 310 : Self {
93 310 : tenant_shard_id,
94 310 : timeline_id,
95 310 : key_range,
96 310 : lsn_range: Self::image_layer_lsn_range(lsn),
97 310 : is_delta: false,
98 310 : file_size,
99 310 : }
100 310 : }
101 :
102 1430 : pub fn new_delta(
103 1430 : tenant_shard_id: TenantShardId,
104 1430 : timeline_id: TimelineId,
105 1430 : key_range: Range<Key>,
106 1430 : lsn_range: Range<Lsn>,
107 1430 : file_size: u64,
108 1430 : ) -> Self {
109 1430 : Self {
110 1430 : tenant_shard_id,
111 1430 : timeline_id,
112 1430 : key_range,
113 1430 : lsn_range,
114 1430 : is_delta: true,
115 1430 : file_size,
116 1430 : }
117 1430 : }
118 :
119 24 : pub fn from_filename(
120 24 : tenant_shard_id: TenantShardId,
121 24 : timeline_id: TimelineId,
122 24 : filename: LayerName,
123 24 : file_size: u64,
124 24 : ) -> Self {
125 24 : match filename {
126 4 : LayerName::Image(i) => {
127 4 : Self::new_img(tenant_shard_id, timeline_id, i.key_range, i.lsn, file_size)
128 : }
129 20 : LayerName::Delta(d) => Self::new_delta(
130 20 : tenant_shard_id,
131 20 : timeline_id,
132 20 : d.key_range,
133 20 : d.lsn_range,
134 20 : file_size,
135 20 : ),
136 : }
137 24 : }
138 :
139 : /// Get the LSN that the image layer covers.
140 2540632 : pub fn image_layer_lsn(&self) -> Lsn {
141 2540632 : assert!(!self.is_delta);
142 2540632 : assert!(self.lsn_range.start + 1 == self.lsn_range.end);
143 2540632 : self.lsn_range.start
144 2540632 : }
145 :
146 : /// Get the LSN range corresponding to a single image layer LSN.
147 1984 : pub fn image_layer_lsn_range(lsn: Lsn) -> Range<Lsn> {
148 1984 : lsn..(lsn + 1)
149 1984 : }
150 :
151 : /// Get a delta layer name for this layer.
152 : ///
153 : /// Panic: if this is not a delta layer.
154 6579 : pub fn delta_layer_name(&self) -> DeltaLayerName {
155 6579 : assert!(self.is_delta);
156 6579 : DeltaLayerName {
157 6579 : key_range: self.key_range.clone(),
158 6579 : lsn_range: self.lsn_range.clone(),
159 6579 : }
160 6579 : }
161 :
162 : /// Get a image layer name for this layer.
163 : ///
164 : /// Panic: if this is not an image layer, or the lsn range is invalid
165 1150 : pub fn image_layer_name(&self) -> ImageLayerName {
166 1150 : assert!(!self.is_delta);
167 1150 : assert!(self.lsn_range.start + 1 == self.lsn_range.end);
168 1150 : ImageLayerName {
169 1150 : key_range: self.key_range.clone(),
170 1150 : lsn: self.lsn_range.start,
171 1150 : }
172 1150 : }
173 :
174 7729 : pub fn layer_name(&self) -> LayerName {
175 7729 : if self.is_delta {
176 6579 : self.delta_layer_name().into()
177 : } else {
178 1150 : self.image_layer_name().into()
179 : }
180 7729 : }
181 :
182 : // TODO: remove this in the future once we refactor timeline APIs.
183 :
184 3690170 : pub fn get_lsn_range(&self) -> Range<Lsn> {
185 3690170 : self.lsn_range.clone()
186 3690170 : }
187 :
188 94376 : pub fn get_key_range(&self) -> Range<Key> {
189 94376 : self.key_range.clone()
190 94376 : }
191 :
192 0 : pub fn get_timeline_id(&self) -> TimelineId {
193 0 : self.timeline_id
194 0 : }
195 :
196 : /// Does this layer only contain some data for the key-range (incremental),
197 : /// or does it contain a version of every page? This is important to know
198 : /// for garbage collecting old layers: an incremental layer depends on
199 : /// the previous non-incremental layer.
200 5272 : pub fn is_incremental(&self) -> bool {
201 5272 : self.is_delta
202 5272 : }
203 :
204 5736482 : pub fn is_delta(&self) -> bool {
205 5736482 : self.is_delta
206 5736482 : }
207 :
208 16 : pub fn dump(&self) {
209 16 : if self.is_delta {
210 14 : println!(
211 14 : "----- delta layer for ten {} tli {} keys {}-{} lsn {}-{} is_incremental {} size {} ----",
212 14 : self.tenant_shard_id,
213 14 : self.timeline_id,
214 14 : self.key_range.start,
215 14 : self.key_range.end,
216 14 : self.lsn_range.start,
217 14 : self.lsn_range.end,
218 14 : self.is_incremental(),
219 14 : self.file_size,
220 14 : );
221 14 : } else {
222 2 : println!(
223 2 : "----- image layer for ten {} tli {} key {}-{} at {} is_incremental {} size {} ----",
224 2 : self.tenant_shard_id,
225 2 : self.timeline_id,
226 2 : self.key_range.start,
227 2 : self.key_range.end,
228 2 : self.image_layer_lsn(),
229 2 : self.is_incremental(),
230 2 : self.file_size
231 2 : );
232 2 : }
233 16 : }
234 :
235 104 : pub fn file_size(&self) -> u64 {
236 104 : self.file_size
237 104 : }
238 : }
|
