Line data Source code
1 : use std::collections::HashMap;
2 : use std::sync::Arc;
3 :
4 : use parking_lot::Mutex;
5 : use safekeeper::state::TimelinePersistentState;
6 : use utils::id::TenantTimelineId;
7 :
8 : use super::block_storage::BlockStorage;
9 :
10 : use std::{ops::Deref, time::Instant};
11 :
12 : use anyhow::Result;
13 : use bytes::{Buf, BytesMut};
14 : use futures::future::BoxFuture;
15 : use postgres_ffi::{waldecoder::WalStreamDecoder, XLogSegNo};
16 : use safekeeper::{control_file, metrics::WalStorageMetrics, wal_storage};
17 : use tracing::{debug, info};
18 : use utils::lsn::Lsn;
19 :
20 : /// All safekeeper state that is usually saved to disk.
21 : pub struct SafekeeperDisk {
22 : pub timelines: Mutex<HashMap<TenantTimelineId, Arc<TimelineDisk>>>,
23 : }
24 :
25 : impl Default for SafekeeperDisk {
26 0 : fn default() -> Self {
27 0 : Self::new()
28 0 : }
29 : }
30 :
31 : impl SafekeeperDisk {
32 1524 : pub fn new() -> Self {
33 1524 : SafekeeperDisk {
34 1524 : timelines: Mutex::new(HashMap::new()),
35 1524 : }
36 1524 : }
37 :
38 1465 : pub fn put_state(
39 1465 : &self,
40 1465 : ttid: &TenantTimelineId,
41 1465 : state: TimelinePersistentState,
42 1465 : ) -> Arc<TimelineDisk> {
43 1465 : self.timelines
44 1465 : .lock()
45 1465 : .entry(*ttid)
46 1465 : .and_modify(|e| {
47 0 : let mut mu = e.state.lock();
48 0 : *mu = state.clone();
49 1465 : })
50 1465 : .or_insert_with(|| {
51 1465 : Arc::new(TimelineDisk {
52 1465 : state: Mutex::new(state),
53 1465 : wal: Mutex::new(BlockStorage::new()),
54 1465 : })
55 1465 : })
56 1465 : .clone()
57 1465 : }
58 : }
59 :
60 : /// Control file state and WAL storage.
61 : pub struct TimelineDisk {
62 : pub state: Mutex<TimelinePersistentState>,
63 : pub wal: Mutex<BlockStorage>,
64 : }
65 :
66 : /// Implementation of `control_file::Storage` trait.
67 : pub struct DiskStateStorage {
68 : persisted_state: TimelinePersistentState,
69 : disk: Arc<TimelineDisk>,
70 : last_persist_at: Instant,
71 : }
72 :
73 : impl DiskStateStorage {
74 9304 : pub fn new(disk: Arc<TimelineDisk>) -> Self {
75 9304 : let guard = disk.state.lock();
76 9304 : let state = guard.clone();
77 9304 : drop(guard);
78 9304 : DiskStateStorage {
79 9304 : persisted_state: state,
80 9304 : disk,
81 9304 : last_persist_at: Instant::now(),
82 9304 : }
83 9304 : }
84 : }
85 :
86 : impl control_file::Storage for DiskStateStorage {
87 : /// Persist safekeeper state on disk and update internal state.
88 5433 : async fn persist(&mut self, s: &TimelinePersistentState) -> Result<()> {
89 5433 : self.persisted_state = s.clone();
90 5433 : *self.disk.state.lock() = s.clone();
91 5433 : Ok(())
92 5433 : }
93 :
94 : /// Timestamp of last persist.
95 0 : fn last_persist_at(&self) -> Instant {
96 0 : // TODO: don't rely on it in tests
97 0 : self.last_persist_at
98 0 : }
99 : }
100 :
101 : impl Deref for DiskStateStorage {
102 : type Target = TimelinePersistentState;
103 :
104 292377 : fn deref(&self) -> &Self::Target {
105 292377 : &self.persisted_state
106 292377 : }
107 : }
108 :
109 : /// Implementation of `wal_storage::Storage` trait.
110 : pub struct DiskWALStorage {
111 : /// Written to disk, but possibly still in the cache and not fully persisted.
112 : /// Also can be ahead of record_lsn, if happen to be in the middle of a WAL record.
113 : write_lsn: Lsn,
114 :
115 : /// The LSN of the last WAL record written to disk. Still can be not fully flushed.
116 : write_record_lsn: Lsn,
117 :
118 : /// The LSN of the last WAL record flushed to disk.
119 : flush_record_lsn: Lsn,
120 :
121 : /// Decoder is required for detecting boundaries of WAL records.
122 : decoder: WalStreamDecoder,
123 :
124 : /// Bytes of WAL records that are not yet written to disk.
125 : unflushed_bytes: BytesMut,
126 :
127 : /// Contains BlockStorage for WAL.
128 : disk: Arc<TimelineDisk>,
129 : }
130 :
131 : impl DiskWALStorage {
132 9304 : pub fn new(disk: Arc<TimelineDisk>, state: &TimelinePersistentState) -> Result<Self> {
133 9304 : let write_lsn = if state.commit_lsn == Lsn(0) {
134 8496 : Lsn(0)
135 : } else {
136 808 : Self::find_end_of_wal(disk.clone(), state.commit_lsn)?
137 : };
138 :
139 9304 : let flush_lsn = write_lsn;
140 9304 : Ok(DiskWALStorage {
141 9304 : write_lsn,
142 9304 : write_record_lsn: flush_lsn,
143 9304 : flush_record_lsn: flush_lsn,
144 9304 : decoder: WalStreamDecoder::new(flush_lsn, 16),
145 9304 : unflushed_bytes: BytesMut::new(),
146 9304 : disk,
147 9304 : })
148 9304 : }
149 :
150 808 : fn find_end_of_wal(disk: Arc<TimelineDisk>, start_lsn: Lsn) -> Result<Lsn> {
151 808 : let mut buf = [0; 8192];
152 808 : let mut pos = start_lsn.0;
153 808 : let mut decoder = WalStreamDecoder::new(start_lsn, 16);
154 808 : let mut result = start_lsn;
155 : loop {
156 808 : disk.wal.lock().read(pos, &mut buf);
157 808 : pos += buf.len() as u64;
158 808 : decoder.feed_bytes(&buf);
159 :
160 : loop {
161 4042 : match decoder.poll_decode() {
162 3234 : Ok(Some(record)) => result = record.0,
163 808 : Err(e) => {
164 808 : debug!(
165 0 : "find_end_of_wal reached end at {:?}, decode error: {:?}",
166 : result, e
167 : );
168 808 : return Ok(result);
169 : }
170 0 : Ok(None) => break, // need more data
171 : }
172 : }
173 : }
174 808 : }
175 : }
176 :
177 : impl wal_storage::Storage for DiskWALStorage {
178 : // Last written LSN.
179 5239 : fn write_lsn(&self) -> Lsn {
180 5239 : self.write_lsn
181 5239 : }
182 : /// LSN of last durably stored WAL record.
183 38163 : fn flush_lsn(&self) -> Lsn {
184 38163 : self.flush_record_lsn
185 38163 : }
186 :
187 194 : async fn initialize_first_segment(&mut self, _init_lsn: Lsn) -> Result<()> {
188 194 : Ok(())
189 194 : }
190 :
191 : /// Write piece of WAL from buf to disk, but not necessarily sync it.
192 1122 : async fn write_wal(&mut self, startpos: Lsn, buf: &[u8]) -> Result<()> {
193 1122 : if self.write_lsn != startpos {
194 0 : panic!("write_wal called with wrong startpos");
195 1122 : }
196 1122 :
197 1122 : self.unflushed_bytes.extend_from_slice(buf);
198 1122 : self.write_lsn += buf.len() as u64;
199 1122 :
200 1122 : if self.decoder.available() != startpos {
201 0 : info!(
202 0 : "restart decoder from {} to {}",
203 0 : self.decoder.available(),
204 : startpos,
205 : );
206 0 : self.decoder = WalStreamDecoder::new(startpos, 16);
207 1122 : }
208 1122 : self.decoder.feed_bytes(buf);
209 : loop {
210 25076 : match self.decoder.poll_decode()? {
211 1122 : None => break, // no full record yet
212 23954 : Some((lsn, _rec)) => {
213 23954 : self.write_record_lsn = lsn;
214 23954 : }
215 : }
216 : }
217 :
218 1122 : Ok(())
219 1122 : }
220 :
221 : /// Truncate WAL at specified LSN, which must be the end of WAL record.
222 1372 : async fn truncate_wal(&mut self, end_pos: Lsn) -> Result<()> {
223 1372 : if self.write_lsn != Lsn(0) && end_pos > self.write_lsn {
224 0 : panic!(
225 0 : "truncate_wal called on non-written WAL, write_lsn={}, end_pos={}",
226 0 : self.write_lsn, end_pos
227 0 : );
228 1372 : }
229 1372 :
230 1372 : self.flush_wal().await?;
231 :
232 : // write zeroes to disk from end_pos until self.write_lsn
233 1372 : let buf = [0; 8192];
234 1372 : let mut pos = end_pos.0;
235 1375 : while pos < self.write_lsn.0 {
236 3 : self.disk.wal.lock().write(pos, &buf);
237 3 : pos += buf.len() as u64;
238 3 : }
239 :
240 1372 : self.write_lsn = end_pos;
241 1372 : self.write_record_lsn = end_pos;
242 1372 : self.flush_record_lsn = end_pos;
243 1372 : self.unflushed_bytes.clear();
244 1372 : self.decoder = WalStreamDecoder::new(end_pos, 16);
245 1372 :
246 1372 : Ok(())
247 1372 : }
248 :
249 : /// Durably store WAL on disk, up to the last written WAL record.
250 9901 : async fn flush_wal(&mut self) -> Result<()> {
251 9901 : if self.flush_record_lsn == self.write_record_lsn {
252 : // no need to do extra flush
253 8780 : return Ok(());
254 1121 : }
255 1121 :
256 1121 : let num_bytes = self.write_record_lsn.0 - self.flush_record_lsn.0;
257 1121 :
258 1121 : self.disk.wal.lock().write(
259 1121 : self.flush_record_lsn.0,
260 1121 : &self.unflushed_bytes[..num_bytes as usize],
261 1121 : );
262 1121 : self.unflushed_bytes.advance(num_bytes as usize);
263 1121 : self.flush_record_lsn = self.write_record_lsn;
264 1121 :
265 1121 : Ok(())
266 9901 : }
267 :
268 : /// Remove all segments <= given segno. Returns function doing that as we
269 : /// want to perform it without timeline lock.
270 0 : fn remove_up_to(&self, _segno_up_to: XLogSegNo) -> BoxFuture<'static, anyhow::Result<()>> {
271 0 : Box::pin(async move { Ok(()) })
272 0 : }
273 :
274 : /// Release resources associated with the storage -- technically, close FDs.
275 : /// Currently we don't remove timelines until restart (#3146), so need to
276 : /// spare descriptors. This would be useful for temporary tli detach as
277 : /// well.
278 0 : fn close(&mut self) {}
279 :
280 : /// Get metrics for this timeline.
281 0 : fn get_metrics(&self) -> WalStorageMetrics {
282 0 : WalStorageMetrics::default()
283 0 : }
284 : }
|
