Line data Source code
1 : //! Control file serialization, deserialization and persistence.
2 :
3 : use anyhow::{bail, ensure, Context, Result};
4 : use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
5 : use camino::{Utf8Path, Utf8PathBuf};
6 : use tokio::fs::File;
7 : use tokio::io::AsyncWriteExt;
8 : use utils::crashsafe::durable_rename;
9 :
10 : use std::io::Read;
11 : use std::ops::Deref;
12 : use std::path::Path;
13 : use std::time::Instant;
14 :
15 : use crate::control_file_upgrade::downgrade_v9_to_v8;
16 : use crate::metrics::PERSIST_CONTROL_FILE_SECONDS;
17 : use crate::state::{EvictionState, TimelinePersistentState};
18 : use crate::{control_file_upgrade::upgrade_control_file, timeline::get_timeline_dir};
19 : use utils::{bin_ser::LeSer, id::TenantTimelineId};
20 :
21 : use crate::SafeKeeperConf;
22 :
23 : pub const SK_MAGIC: u32 = 0xcafeceefu32;
24 : pub const SK_FORMAT_VERSION: u32 = 9;
25 :
26 : // contains persistent metadata for safekeeper
27 : pub const CONTROL_FILE_NAME: &str = "safekeeper.control";
28 : // needed to atomically update the state using `rename`
29 : const CONTROL_FILE_NAME_PARTIAL: &str = "safekeeper.control.partial";
30 : pub const CHECKSUM_SIZE: usize = size_of::<u32>();
31 :
32 : /// Storage should keep actual state inside of it. It should implement Deref
33 : /// trait to access state fields and have persist method for updating that state.
34 : #[async_trait::async_trait]
35 : pub trait Storage: Deref<Target = TimelinePersistentState> {
36 : /// Persist safekeeper state on disk and update internal state.
37 : async fn persist(&mut self, s: &TimelinePersistentState) -> Result<()>;
38 :
39 : /// Timestamp of last persist.
40 : fn last_persist_at(&self) -> Instant;
41 : }
42 :
43 : #[derive(Debug)]
44 : pub struct FileStorage {
45 : // save timeline dir to avoid reconstructing it every time
46 : timeline_dir: Utf8PathBuf,
47 : no_sync: bool,
48 :
49 : /// Last state persisted to disk.
50 : state: TimelinePersistentState,
51 : /// Not preserved across restarts.
52 : last_persist_at: Instant,
53 : }
54 :
55 : impl FileStorage {
56 : /// Initialize storage by loading state from disk.
57 4 : pub fn restore_new(ttid: &TenantTimelineId, conf: &SafeKeeperConf) -> Result<FileStorage> {
58 4 : let timeline_dir = get_timeline_dir(conf, ttid);
59 4 : let state = Self::load_control_file_from_dir(&timeline_dir)?;
60 :
61 2 : Ok(FileStorage {
62 2 : timeline_dir,
63 2 : no_sync: conf.no_sync,
64 2 : state,
65 2 : last_persist_at: Instant::now(),
66 2 : })
67 4 : }
68 :
69 : /// Create file storage for a new timeline, but don't persist it yet.
70 4 : pub fn create_new(
71 4 : timeline_dir: Utf8PathBuf,
72 4 : conf: &SafeKeeperConf,
73 4 : state: TimelinePersistentState,
74 4 : ) -> Result<FileStorage> {
75 4 : // we don't support creating new timelines in offloaded state
76 4 : assert!(matches!(state.eviction_state, EvictionState::Present));
77 :
78 4 : let store = FileStorage {
79 4 : timeline_dir,
80 4 : no_sync: conf.no_sync,
81 4 : state,
82 4 : last_persist_at: Instant::now(),
83 4 : };
84 4 :
85 4 : Ok(store)
86 4 : }
87 :
88 : /// Check the magic/version in the on-disk data and deserialize it, if possible.
89 4 : fn deser_sk_state(buf: &mut &[u8]) -> Result<TimelinePersistentState> {
90 : // Read the version independent part
91 4 : let magic = ReadBytesExt::read_u32::<LittleEndian>(buf)?;
92 4 : if magic != SK_MAGIC {
93 0 : bail!(
94 0 : "bad control file magic: {:X}, expected {:X}",
95 0 : magic,
96 0 : SK_MAGIC
97 0 : );
98 4 : }
99 4 : let version = ReadBytesExt::read_u32::<LittleEndian>(buf)?;
100 4 : if version == SK_FORMAT_VERSION {
101 0 : let res = TimelinePersistentState::des(buf)?;
102 0 : return Ok(res);
103 4 : }
104 4 : // try to upgrade
105 4 : upgrade_control_file(buf, version)
106 4 : }
107 :
108 : /// Load control file from given directory.
109 6 : fn load_control_file_from_dir(timeline_dir: &Utf8Path) -> Result<TimelinePersistentState> {
110 6 : let path = timeline_dir.join(CONTROL_FILE_NAME);
111 6 : Self::load_control_file(path)
112 6 : }
113 :
114 : /// Read in the control file.
115 6 : pub fn load_control_file<P: AsRef<Path>>(
116 6 : control_file_path: P,
117 6 : ) -> Result<TimelinePersistentState> {
118 6 : let mut control_file = std::fs::OpenOptions::new()
119 6 : .read(true)
120 6 : .write(true)
121 6 : .open(&control_file_path)
122 6 : .with_context(|| {
123 0 : format!(
124 0 : "failed to open control file at {}",
125 0 : control_file_path.as_ref().display(),
126 0 : )
127 6 : })?;
128 :
129 6 : let mut buf = Vec::new();
130 6 : control_file
131 6 : .read_to_end(&mut buf)
132 6 : .context("failed to read control file")?;
133 :
134 6 : let calculated_checksum = crc32c::crc32c(&buf[..buf.len() - CHECKSUM_SIZE]);
135 :
136 6 : let expected_checksum_bytes: &[u8; CHECKSUM_SIZE] =
137 6 : buf[buf.len() - CHECKSUM_SIZE..].try_into()?;
138 6 : let expected_checksum = u32::from_le_bytes(*expected_checksum_bytes);
139 6 :
140 6 : ensure!(
141 6 : calculated_checksum == expected_checksum,
142 2 : format!(
143 2 : "safekeeper control file checksum mismatch: expected {} got {}",
144 2 : expected_checksum, calculated_checksum
145 2 : )
146 : );
147 :
148 4 : let state = FileStorage::deser_sk_state(&mut &buf[..buf.len() - CHECKSUM_SIZE])
149 4 : .with_context(|| {
150 0 : format!(
151 0 : "while reading control file {}",
152 0 : control_file_path.as_ref().display(),
153 0 : )
154 4 : })?;
155 4 : Ok(state)
156 6 : }
157 : }
158 :
159 : impl Deref for FileStorage {
160 : type Target = TimelinePersistentState;
161 :
162 0 : fn deref(&self) -> &Self::Target {
163 0 : &self.state
164 0 : }
165 : }
166 :
167 : impl TimelinePersistentState {
168 4 : pub(crate) fn write_to_buf(&self) -> Result<Vec<u8>> {
169 4 : let mut buf: Vec<u8> = Vec::new();
170 4 : WriteBytesExt::write_u32::<LittleEndian>(&mut buf, SK_MAGIC)?;
171 :
172 4 : if self.eviction_state == EvictionState::Present {
173 : // temp hack for forward compatibility
174 : const PREV_FORMAT_VERSION: u32 = 8;
175 4 : let prev = downgrade_v9_to_v8(self);
176 4 : WriteBytesExt::write_u32::<LittleEndian>(&mut buf, PREV_FORMAT_VERSION)?;
177 4 : prev.ser_into(&mut buf)?;
178 : } else {
179 : // otherwise, we write the current format version
180 0 : WriteBytesExt::write_u32::<LittleEndian>(&mut buf, SK_FORMAT_VERSION)?;
181 0 : self.ser_into(&mut buf)?;
182 : }
183 :
184 : // calculate checksum before resize
185 4 : let checksum = crc32c::crc32c(&buf);
186 4 : buf.extend_from_slice(&checksum.to_le_bytes());
187 4 : Ok(buf)
188 4 : }
189 : }
190 :
191 : #[async_trait::async_trait]
192 : impl Storage for FileStorage {
193 : /// Persists state durably to the underlying storage.
194 : ///
195 : /// For a description, see <https://lwn.net/Articles/457667/>.
196 4 : async fn persist(&mut self, s: &TimelinePersistentState) -> Result<()> {
197 4 : let _timer = PERSIST_CONTROL_FILE_SECONDS.start_timer();
198 4 :
199 4 : // write data to safekeeper.control.partial
200 4 : let control_partial_path = self.timeline_dir.join(CONTROL_FILE_NAME_PARTIAL);
201 4 : let mut control_partial = File::create(&control_partial_path).await.with_context(|| {
202 0 : format!(
203 0 : "failed to create partial control file at: {}",
204 0 : &control_partial_path
205 0 : )
206 4 : })?;
207 4 :
208 4 : let buf: Vec<u8> = s.write_to_buf()?;
209 4 :
210 4 : control_partial.write_all(&buf).await.with_context(|| {
211 0 : format!(
212 0 : "failed to write safekeeper state into control file at: {}",
213 0 : control_partial_path
214 0 : )
215 4 : })?;
216 4 : control_partial.flush().await.with_context(|| {
217 0 : format!(
218 0 : "failed to flush safekeeper state into control file at: {}",
219 0 : control_partial_path
220 0 : )
221 4 : })?;
222 4 :
223 4 : let control_path = self.timeline_dir.join(CONTROL_FILE_NAME);
224 28 : durable_rename(&control_partial_path, &control_path, !self.no_sync).await?;
225 4 :
226 4 : // update internal state
227 4 : self.state = s.clone();
228 4 : Ok(())
229 4 : }
230 :
231 0 : fn last_persist_at(&self) -> Instant {
232 0 : self.last_persist_at
233 0 : }
234 : }
235 :
236 : #[cfg(test)]
237 : mod test {
238 : use super::*;
239 : use tokio::fs;
240 : use utils::lsn::Lsn;
241 :
242 4 : fn stub_conf() -> SafeKeeperConf {
243 4 : let workdir = camino_tempfile::tempdir().unwrap().into_path();
244 4 : SafeKeeperConf {
245 4 : workdir,
246 4 : ..SafeKeeperConf::dummy()
247 4 : }
248 4 : }
249 :
250 4 : async fn load_from_control_file(
251 4 : conf: &SafeKeeperConf,
252 4 : ttid: &TenantTimelineId,
253 4 : ) -> Result<(FileStorage, TimelinePersistentState)> {
254 4 : let timeline_dir = get_timeline_dir(conf, ttid);
255 4 : fs::create_dir_all(&timeline_dir)
256 3 : .await
257 4 : .expect("failed to create timeline dir");
258 4 : Ok((
259 4 : FileStorage::restore_new(ttid, conf)?,
260 2 : FileStorage::load_control_file_from_dir(&timeline_dir)?,
261 : ))
262 4 : }
263 :
264 4 : async fn create(
265 4 : conf: &SafeKeeperConf,
266 4 : ttid: &TenantTimelineId,
267 4 : ) -> Result<(FileStorage, TimelinePersistentState)> {
268 4 : let timeline_dir = get_timeline_dir(conf, ttid);
269 4 : fs::create_dir_all(&timeline_dir)
270 4 : .await
271 4 : .expect("failed to create timeline dir");
272 4 : let state = TimelinePersistentState::empty();
273 4 : let storage = FileStorage::create_new(timeline_dir, conf, state.clone())?;
274 4 : Ok((storage, state))
275 4 : }
276 :
277 : #[tokio::test]
278 2 : async fn test_read_write_safekeeper_state() {
279 2 : let conf = stub_conf();
280 2 : let ttid = TenantTimelineId::generate();
281 2 : {
282 2 : let (mut storage, mut state) =
283 2 : create(&conf, &ttid).await.expect("failed to create state");
284 2 : // change something
285 2 : state.commit_lsn = Lsn(42);
286 2 : storage
287 2 : .persist(&state)
288 18 : .await
289 2 : .expect("failed to persist state");
290 2 : }
291 2 :
292 2 : let (_, state) = load_from_control_file(&conf, &ttid)
293 2 : .await
294 2 : .expect("failed to read state");
295 2 : assert_eq!(state.commit_lsn, Lsn(42));
296 2 : }
297 :
298 : #[tokio::test]
299 2 : async fn test_safekeeper_state_checksum_mismatch() {
300 2 : let conf = stub_conf();
301 2 : let ttid = TenantTimelineId::generate();
302 2 : {
303 2 : let (mut storage, mut state) =
304 2 : create(&conf, &ttid).await.expect("failed to read state");
305 2 :
306 2 : // change something
307 2 : state.commit_lsn = Lsn(42);
308 2 : storage
309 2 : .persist(&state)
310 18 : .await
311 2 : .expect("failed to persist state");
312 2 : }
313 2 : let control_path = get_timeline_dir(&conf, &ttid).join(CONTROL_FILE_NAME);
314 2 : let mut data = fs::read(&control_path).await.unwrap();
315 2 : data[0] += 1; // change the first byte of the file to fail checksum validation
316 2 : fs::write(&control_path, &data)
317 2 : .await
318 2 : .expect("failed to write control file");
319 2 :
320 2 : match load_from_control_file(&conf, &ttid).await {
321 2 : Err(err) => assert!(err
322 2 : .to_string()
323 2 : .contains("safekeeper control file checksum mismatch")),
324 2 : Ok(_) => panic!("expected error"),
325 2 : }
326 2 : }
327 : }
|
