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