Line data Source code
1 : //!
2 : //! Helper functions for dealing with filenames of the image and delta layer files.
3 : //!
4 : use crate::repository::Key;
5 : use std::borrow::Cow;
6 : use std::cmp::Ordering;
7 : use std::fmt;
8 : use std::ops::Range;
9 : use std::str::FromStr;
10 :
11 : use regex::Regex;
12 : use utils::lsn::Lsn;
13 :
14 : use super::PersistentLayerDesc;
15 :
16 : // Note: Timeline::load_layer_map() relies on this sort order
17 : #[derive(PartialEq, Eq, Clone, Hash)]
18 : pub struct DeltaLayerName {
19 : pub key_range: Range<Key>,
20 : pub lsn_range: Range<Lsn>,
21 : }
22 :
23 : impl std::fmt::Debug for DeltaLayerName {
24 0 : fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
25 0 : use super::RangeDisplayDebug;
26 0 :
27 0 : f.debug_struct("DeltaLayerName")
28 0 : .field("key_range", &RangeDisplayDebug(&self.key_range))
29 0 : .field("lsn_range", &self.lsn_range)
30 0 : .finish()
31 0 : }
32 : }
33 :
34 : impl PartialOrd for DeltaLayerName {
35 0 : fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
36 0 : Some(self.cmp(other))
37 0 : }
38 : }
39 :
40 : impl Ord for DeltaLayerName {
41 0 : fn cmp(&self, other: &Self) -> Ordering {
42 0 : let mut cmp = self.key_range.start.cmp(&other.key_range.start);
43 0 : if cmp != Ordering::Equal {
44 0 : return cmp;
45 0 : }
46 0 : cmp = self.key_range.end.cmp(&other.key_range.end);
47 0 : if cmp != Ordering::Equal {
48 0 : return cmp;
49 0 : }
50 0 : cmp = self.lsn_range.start.cmp(&other.lsn_range.start);
51 0 : if cmp != Ordering::Equal {
52 0 : return cmp;
53 0 : }
54 0 : cmp = self.lsn_range.end.cmp(&other.lsn_range.end);
55 0 :
56 0 : cmp
57 0 : }
58 : }
59 :
60 : /// Represents the region of the LSN-Key space covered by a DeltaLayer
61 : ///
62 : /// ```text
63 : /// <key start>-<key end>__<LSN start>-<LSN end>
64 : /// ```
65 : impl DeltaLayerName {
66 : /// Parse the part of a delta layer's file name that represents the LayerName. Returns None
67 : /// if the filename does not match the expected pattern.
68 3250 : pub fn parse_str(fname: &str) -> Option<Self> {
69 3250 : let mut parts = fname.split("__");
70 3250 : let mut key_parts = parts.next()?.split('-');
71 3250 : let mut lsn_parts = parts.next()?.split('-');
72 :
73 3250 : let key_start_str = key_parts.next()?;
74 3250 : let key_end_str = key_parts.next()?;
75 3250 : let lsn_start_str = lsn_parts.next()?;
76 3250 : let lsn_end_str = lsn_parts.next()?;
77 :
78 1630 : if parts.next().is_some() || key_parts.next().is_some() || key_parts.next().is_some() {
79 0 : return None;
80 1630 : }
81 1630 :
82 1630 : if key_start_str.len() != 36
83 1630 : || key_end_str.len() != 36
84 1630 : || lsn_start_str.len() != 16
85 1630 : || lsn_end_str.len() != 16
86 : {
87 0 : return None;
88 1630 : }
89 :
90 1630 : let key_start = Key::from_hex(key_start_str).ok()?;
91 1630 : let key_end = Key::from_hex(key_end_str).ok()?;
92 :
93 1630 : let start_lsn = Lsn::from_hex(lsn_start_str).ok()?;
94 1630 : let end_lsn = Lsn::from_hex(lsn_end_str).ok()?;
95 :
96 1630 : if start_lsn >= end_lsn {
97 0 : return None;
98 : // or panic?
99 1630 : }
100 1630 :
101 1630 : if key_start >= key_end {
102 0 : return None;
103 : // or panic?
104 1630 : }
105 1630 :
106 1630 : Some(DeltaLayerName {
107 1630 : key_range: key_start..key_end,
108 1630 : lsn_range: start_lsn..end_lsn,
109 1630 : })
110 3250 : }
111 : }
112 :
113 : impl fmt::Display for DeltaLayerName {
114 39412 : fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
115 39412 : write!(
116 39412 : f,
117 39412 : "{}-{}__{:016X}-{:016X}",
118 39412 : self.key_range.start,
119 39412 : self.key_range.end,
120 39412 : u64::from(self.lsn_range.start),
121 39412 : u64::from(self.lsn_range.end),
122 39412 : )
123 39412 : }
124 : }
125 :
126 : #[derive(PartialEq, Eq, Clone, Hash)]
127 : pub struct ImageLayerName {
128 : pub key_range: Range<Key>,
129 : pub lsn: Lsn,
130 : }
131 :
132 : impl std::fmt::Debug for ImageLayerName {
133 0 : fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
134 0 : use super::RangeDisplayDebug;
135 0 :
136 0 : f.debug_struct("ImageLayerName")
137 0 : .field("key_range", &RangeDisplayDebug(&self.key_range))
138 0 : .field("lsn", &self.lsn)
139 0 : .finish()
140 0 : }
141 : }
142 :
143 : impl PartialOrd for ImageLayerName {
144 0 : fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
145 0 : Some(self.cmp(other))
146 0 : }
147 : }
148 :
149 : impl Ord for ImageLayerName {
150 0 : fn cmp(&self, other: &Self) -> Ordering {
151 0 : let mut cmp = self.key_range.start.cmp(&other.key_range.start);
152 0 : if cmp != Ordering::Equal {
153 0 : return cmp;
154 0 : }
155 0 : cmp = self.key_range.end.cmp(&other.key_range.end);
156 0 : if cmp != Ordering::Equal {
157 0 : return cmp;
158 0 : }
159 0 : cmp = self.lsn.cmp(&other.lsn);
160 0 :
161 0 : cmp
162 0 : }
163 : }
164 :
165 : impl ImageLayerName {
166 1604 : pub fn lsn_as_range(&self) -> Range<Lsn> {
167 1604 : // Saves from having to copypaste this all over
168 1604 : PersistentLayerDesc::image_layer_lsn_range(self.lsn)
169 1604 : }
170 : }
171 :
172 : ///
173 : /// Represents the part of the Key-LSN space covered by an ImageLayer
174 : ///
175 : /// ```text
176 : /// <key start>-<key end>__<LSN>
177 : /// ```
178 : impl ImageLayerName {
179 : /// Parse a string as then LayerName part of an image layer file name. Returns None if the
180 : /// filename does not match the expected pattern.
181 3250 : pub fn parse_str(fname: &str) -> Option<Self> {
182 3250 : let mut parts = fname.split("__");
183 3250 : let mut key_parts = parts.next()?.split('-');
184 :
185 3250 : let key_start_str = key_parts.next()?;
186 3250 : let key_end_str = key_parts.next()?;
187 3250 : let lsn_str = parts.next()?;
188 3250 : if parts.next().is_some() || key_parts.next().is_some() {
189 0 : return None;
190 3250 : }
191 3250 :
192 3250 : if key_start_str.len() != 36 || key_end_str.len() != 36 || lsn_str.len() != 16 {
193 1630 : return None;
194 1620 : }
195 :
196 1620 : let key_start = Key::from_hex(key_start_str).ok()?;
197 1620 : let key_end = Key::from_hex(key_end_str).ok()?;
198 :
199 1620 : let lsn = Lsn::from_hex(lsn_str).ok()?;
200 :
201 1620 : Some(ImageLayerName {
202 1620 : key_range: key_start..key_end,
203 1620 : lsn,
204 1620 : })
205 3250 : }
206 : }
207 :
208 : impl fmt::Display for ImageLayerName {
209 3437 : fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
210 3437 : write!(
211 3437 : f,
212 3437 : "{}-{}__{:016X}",
213 3437 : self.key_range.start,
214 3437 : self.key_range.end,
215 3437 : u64::from(self.lsn),
216 3437 : )
217 3437 : }
218 : }
219 :
220 : /// LayerName is the logical identity of a layer within a LayerMap at a moment in time. The
221 : /// LayerName is not a unique filename, as the same LayerName may have multiple physical incarnations
222 : /// over time (e.g. across shard splits or compression). The physical filenames of layers in local
223 : /// storage and object names in remote storage consist of the LayerName plus some extra qualifiers
224 : /// that uniquely identify the physical incarnation of a layer (see [crate::tenant::remote_timeline_client::remote_layer_path])
225 : /// and [`crate::tenant::storage_layer::layer::local_layer_path`])
226 : #[derive(Debug, PartialEq, Eq, Hash, Clone)]
227 : pub enum LayerName {
228 : Image(ImageLayerName),
229 : Delta(DeltaLayerName),
230 : }
231 :
232 : impl LayerName {
233 : /// Determines if this layer file is considered to be in future meaning we will discard these
234 : /// layers during timeline initialization from the given disk_consistent_lsn.
235 17494 : pub(crate) fn is_in_future(&self, disk_consistent_lsn: Lsn) -> bool {
236 : use LayerName::*;
237 1040 : match self {
238 1040 : Image(file_name) if file_name.lsn > disk_consistent_lsn => true,
239 16454 : Delta(file_name) if file_name.lsn_range.end > disk_consistent_lsn + 1 => true,
240 17482 : _ => false,
241 : }
242 17494 : }
243 :
244 0 : pub(crate) fn kind(&self) -> &'static str {
245 0 : use LayerName::*;
246 0 : match self {
247 0 : Delta(_) => "delta",
248 0 : Image(_) => "image",
249 : }
250 0 : }
251 :
252 : /// Gets the key range encoded in the layer name.
253 0 : pub fn key_range(&self) -> &Range<Key> {
254 0 : match &self {
255 0 : LayerName::Image(layer) => &layer.key_range,
256 0 : LayerName::Delta(layer) => &layer.key_range,
257 : }
258 0 : }
259 : }
260 :
261 : impl fmt::Display for LayerName {
262 7191 : fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
263 7191 : match self {
264 1023 : Self::Image(fname) => write!(f, "{fname}"),
265 6168 : Self::Delta(fname) => write!(f, "{fname}"),
266 : }
267 7191 : }
268 : }
269 :
270 : impl From<ImageLayerName> for LayerName {
271 1229 : fn from(fname: ImageLayerName) -> Self {
272 1229 : Self::Image(fname)
273 1229 : }
274 : }
275 : impl From<DeltaLayerName> for LayerName {
276 7826 : fn from(fname: DeltaLayerName) -> Self {
277 7826 : Self::Delta(fname)
278 7826 : }
279 : }
280 :
281 : impl FromStr for LayerName {
282 : type Err = String;
283 :
284 : /// Conversion from either a physical layer filename, or the string-ization of
285 : /// Self. When loading a physical layer filename, we drop any extra information
286 : /// not needed to build Self.
287 3250 : fn from_str(value: &str) -> Result<Self, Self::Err> {
288 3250 : let gen_suffix_regex = Regex::new("^(?<base>.+)(?<gen>-v1-[0-9a-f]{8})$").unwrap();
289 3250 : let file_name: Cow<str> = match gen_suffix_regex.captures(value) {
290 20 : Some(captures) => captures
291 20 : .name("base")
292 20 : .expect("Non-optional group")
293 20 : .as_str()
294 20 : .into(),
295 3230 : None => value.into(),
296 : };
297 :
298 3250 : let delta = DeltaLayerName::parse_str(&file_name);
299 3250 : let image = ImageLayerName::parse_str(&file_name);
300 3250 : let ok = match (delta, image) {
301 : (None, None) => {
302 0 : return Err(format!(
303 0 : "neither delta nor image layer file name: {value:?}"
304 0 : ))
305 : }
306 1630 : (Some(delta), None) => Self::Delta(delta),
307 1620 : (None, Some(image)) => Self::Image(image),
308 0 : (Some(_), Some(_)) => unreachable!(),
309 : };
310 3250 : Ok(ok)
311 3250 : }
312 : }
313 :
314 : impl serde::Serialize for LayerName {
315 35386 : fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
316 35386 : where
317 35386 : S: serde::Serializer,
318 35386 : {
319 35386 : match self {
320 2142 : Self::Image(fname) => serializer.collect_str(fname),
321 33244 : Self::Delta(fname) => serializer.collect_str(fname),
322 : }
323 35386 : }
324 : }
325 :
326 : impl<'de> serde::Deserialize<'de> for LayerName {
327 3184 : fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
328 3184 : where
329 3184 : D: serde::Deserializer<'de>,
330 3184 : {
331 3184 : deserializer.deserialize_string(LayerNameVisitor)
332 3184 : }
333 : }
334 :
335 : struct LayerNameVisitor;
336 :
337 : impl<'de> serde::de::Visitor<'de> for LayerNameVisitor {
338 : type Value = LayerName;
339 :
340 0 : fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
341 0 : write!(
342 0 : formatter,
343 0 : "a string that is a valid image or delta layer file name"
344 0 : )
345 0 : }
346 3184 : fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
347 3184 : where
348 3184 : E: serde::de::Error,
349 3184 : {
350 3184 : v.parse().map_err(|e| E::custom(e))
351 3184 : }
352 : }
353 :
354 : #[cfg(test)]
355 : mod test {
356 : use super::*;
357 : #[test]
358 2 : fn image_layer_parse() {
359 2 : let expected = LayerName::Image(ImageLayerName {
360 2 : key_range: Key::from_i128(0)
361 2 : ..Key::from_hex("000000067F00000001000004DF0000000006").unwrap(),
362 2 : lsn: Lsn::from_hex("00000000014FED58").unwrap(),
363 2 : });
364 2 : let parsed = LayerName::from_str("000000000000000000000000000000000000-000000067F00000001000004DF0000000006__00000000014FED58-v1-00000001").unwrap();
365 2 : assert_eq!(parsed, expected,);
366 :
367 : // Omitting generation suffix is valid
368 2 : let parsed = LayerName::from_str("000000000000000000000000000000000000-000000067F00000001000004DF0000000006__00000000014FED58").unwrap();
369 2 : assert_eq!(parsed, expected,);
370 2 : }
371 :
372 : #[test]
373 2 : fn delta_layer_parse() {
374 2 : let expected = LayerName::Delta(DeltaLayerName {
375 2 : key_range: Key::from_i128(0)
376 2 : ..Key::from_hex("000000067F00000001000004DF0000000006").unwrap(),
377 2 : lsn_range: Lsn::from_hex("00000000014FED58").unwrap()
378 2 : ..Lsn::from_hex("000000000154C481").unwrap(),
379 2 : });
380 2 : let parsed = LayerName::from_str("000000000000000000000000000000000000-000000067F00000001000004DF0000000006__00000000014FED58-000000000154C481-v1-00000001").unwrap();
381 2 : assert_eq!(parsed, expected);
382 :
383 : // Omitting generation suffix is valid
384 2 : let parsed = LayerName::from_str("000000000000000000000000000000000000-000000067F00000001000004DF0000000006__00000000014FED58-000000000154C481").unwrap();
385 2 : assert_eq!(parsed, expected);
386 2 : }
387 : }
|
