Line data Source code
1 : //! Safekeeper communication endpoint to WAL proposer (compute node).
2 : //! Gets messages from the network, passes them down to consensus module and
3 : //! sends replies back.
4 :
5 : use std::{collections::HashMap, sync::Arc, time::Duration};
6 :
7 : use anyhow::{bail, Result};
8 : use bytes::{Bytes, BytesMut};
9 : use camino::Utf8PathBuf;
10 : use desim::{
11 : executor::{self, PollSome},
12 : network::TCP,
13 : node_os::NodeOs,
14 : proto::{AnyMessage, NetEvent, NodeEvent},
15 : };
16 : use hyper::Uri;
17 : use safekeeper::{
18 : safekeeper::{ProposerAcceptorMessage, SafeKeeper, ServerInfo, UNKNOWN_SERVER_VERSION},
19 : state::{TimelinePersistentState, TimelineState},
20 : timeline::TimelineError,
21 : wal_storage::Storage,
22 : SafeKeeperConf,
23 : };
24 : use tracing::{debug, info_span, warn};
25 : use utils::{
26 : id::{NodeId, TenantId, TenantTimelineId, TimelineId},
27 : lsn::Lsn,
28 : };
29 :
30 : use super::safekeeper_disk::{DiskStateStorage, DiskWALStorage, SafekeeperDisk, TimelineDisk};
31 :
32 : struct SharedState {
33 : sk: SafeKeeper<DiskStateStorage, DiskWALStorage>,
34 : disk: Arc<TimelineDisk>,
35 : }
36 :
37 : struct GlobalMap {
38 : timelines: HashMap<TenantTimelineId, SharedState>,
39 : conf: SafeKeeperConf,
40 : disk: Arc<SafekeeperDisk>,
41 : }
42 :
43 : impl GlobalMap {
44 : /// Restores global state from disk.
45 38972 : fn new(disk: Arc<SafekeeperDisk>, conf: SafeKeeperConf) -> Result<Self> {
46 38972 : let mut timelines = HashMap::new();
47 :
48 38972 : for (&ttid, disk) in disk.timelines.lock().iter() {
49 29437 : debug!("loading timeline {}", ttid);
50 29437 : let state = disk.state.lock().clone();
51 29437 :
52 29437 : if state.server.wal_seg_size == 0 {
53 0 : bail!(TimelineError::UninitializedWalSegSize(ttid));
54 29437 : }
55 29437 :
56 29437 : if state.server.pg_version == UNKNOWN_SERVER_VERSION {
57 0 : bail!(TimelineError::UninitialinzedPgVersion(ttid));
58 29437 : }
59 29437 :
60 29437 : if state.commit_lsn < state.local_start_lsn {
61 0 : bail!(
62 0 : "commit_lsn {} is higher than local_start_lsn {}",
63 0 : state.commit_lsn,
64 0 : state.local_start_lsn
65 0 : );
66 29437 : }
67 29437 :
68 29437 : let control_store = DiskStateStorage::new(disk.clone());
69 29437 : let wal_store = DiskWALStorage::new(disk.clone(), &control_store)?;
70 :
71 29437 : let sk = SafeKeeper::new(TimelineState::new(control_store), wal_store, conf.my_id)?;
72 29437 : timelines.insert(
73 29437 : ttid,
74 29437 : SharedState {
75 29437 : sk,
76 29437 : disk: disk.clone(),
77 29437 : },
78 29437 : );
79 : }
80 :
81 38972 : Ok(Self {
82 38972 : timelines,
83 38972 : conf,
84 38972 : disk,
85 38972 : })
86 38972 : }
87 :
88 5731 : fn create(&mut self, ttid: TenantTimelineId, server_info: ServerInfo) -> Result<()> {
89 5731 : if self.timelines.contains_key(&ttid) {
90 0 : bail!("timeline {} already exists", ttid);
91 5731 : }
92 5731 :
93 5731 : debug!("creating new timeline {}", ttid);
94 :
95 5731 : let commit_lsn = Lsn::INVALID;
96 5731 : let local_start_lsn = Lsn::INVALID;
97 5731 :
98 5731 : let state =
99 5731 : TimelinePersistentState::new(&ttid, server_info, vec![], commit_lsn, local_start_lsn);
100 5731 :
101 5731 : if state.server.wal_seg_size == 0 {
102 0 : bail!(TimelineError::UninitializedWalSegSize(ttid));
103 5731 : }
104 5731 :
105 5731 : if state.server.pg_version == UNKNOWN_SERVER_VERSION {
106 0 : bail!(TimelineError::UninitialinzedPgVersion(ttid));
107 5731 : }
108 5731 :
109 5731 : if state.commit_lsn < state.local_start_lsn {
110 0 : bail!(
111 0 : "commit_lsn {} is higher than local_start_lsn {}",
112 0 : state.commit_lsn,
113 0 : state.local_start_lsn
114 0 : );
115 5731 : }
116 5731 :
117 5731 : let disk_timeline = self.disk.put_state(&ttid, state);
118 5731 : let control_store = DiskStateStorage::new(disk_timeline.clone());
119 5731 : let wal_store = DiskWALStorage::new(disk_timeline.clone(), &control_store)?;
120 :
121 5731 : let sk = SafeKeeper::new(
122 5731 : TimelineState::new(control_store),
123 5731 : wal_store,
124 5731 : self.conf.my_id,
125 5731 : )?;
126 :
127 5731 : self.timelines.insert(
128 5731 : ttid,
129 5731 : SharedState {
130 5731 : sk,
131 5731 : disk: disk_timeline,
132 5731 : },
133 5731 : );
134 5731 : Ok(())
135 5731 : }
136 :
137 114706 : fn get(&mut self, ttid: &TenantTimelineId) -> &mut SharedState {
138 114706 : self.timelines.get_mut(ttid).expect("timeline must exist")
139 114706 : }
140 :
141 78236 : fn has_tli(&self, ttid: &TenantTimelineId) -> bool {
142 78236 : self.timelines.contains_key(ttid)
143 78236 : }
144 : }
145 :
146 : /// State of a single connection to walproposer.
147 : struct ConnState {
148 : tcp: TCP,
149 :
150 : greeting: bool,
151 : ttid: TenantTimelineId,
152 : flush_pending: bool,
153 :
154 : runtime: tokio::runtime::Runtime,
155 : }
156 :
157 38972 : pub fn run_server(os: NodeOs, disk: Arc<SafekeeperDisk>) -> Result<()> {
158 38972 : let _enter = info_span!("safekeeper", id = os.id()).entered();
159 38972 : debug!("started server");
160 38972 : os.log_event("started;safekeeper".to_owned());
161 38972 : let conf = SafeKeeperConf {
162 38972 : workdir: Utf8PathBuf::from("."),
163 38972 : my_id: NodeId(os.id() as u64),
164 38972 : listen_pg_addr: String::new(),
165 38972 : listen_http_addr: String::new(),
166 38972 : no_sync: false,
167 38972 : broker_endpoint: "/".parse::<Uri>().unwrap(),
168 38972 : broker_keepalive_interval: Duration::from_secs(0),
169 38972 : heartbeat_timeout: Duration::from_secs(0),
170 38972 : remote_storage: None,
171 38972 : max_offloader_lag_bytes: 0,
172 38972 : wal_backup_enabled: false,
173 38972 : listen_pg_addr_tenant_only: None,
174 38972 : advertise_pg_addr: None,
175 38972 : availability_zone: None,
176 38972 : peer_recovery_enabled: false,
177 38972 : backup_parallel_jobs: 0,
178 38972 : pg_auth: None,
179 38972 : pg_tenant_only_auth: None,
180 38972 : http_auth: None,
181 38972 : sk_auth_token: None,
182 38972 : current_thread_runtime: false,
183 38972 : walsenders_keep_horizon: false,
184 38972 : partial_backup_timeout: Duration::from_secs(0),
185 38972 : disable_periodic_broker_push: false,
186 38972 : enable_offload: false,
187 38972 : delete_offloaded_wal: false,
188 38972 : control_file_save_interval: Duration::from_secs(1),
189 38972 : partial_backup_concurrency: 1,
190 38972 : eviction_min_resident: Duration::ZERO,
191 38972 : };
192 :
193 38972 : let mut global = GlobalMap::new(disk, conf.clone())?;
194 38972 : let mut conns: HashMap<usize, ConnState> = HashMap::new();
195 :
196 38972 : for (&_ttid, shared_state) in global.timelines.iter_mut() {
197 29437 : let flush_lsn = shared_state.sk.wal_store.flush_lsn();
198 29437 : let commit_lsn = shared_state.sk.state.commit_lsn;
199 29437 : os.log_event(format!("tli_loaded;{};{}", flush_lsn.0, commit_lsn.0));
200 29437 : }
201 :
202 38972 : let node_events = os.node_events();
203 38972 : let mut epoll_vec: Vec<Box<dyn PollSome>> = vec![];
204 38972 : let mut epoll_idx: Vec<usize> = vec![];
205 :
206 : // TODO: batch events processing (multiple events per tick)
207 : loop {
208 297119 : epoll_vec.clear();
209 297119 : epoll_idx.clear();
210 297119 :
211 297119 : // node events channel
212 297119 : epoll_vec.push(Box::new(node_events.clone()));
213 297119 : epoll_idx.push(0);
214 :
215 : // tcp connections
216 1052776 : for conn in conns.values() {
217 1052776 : epoll_vec.push(Box::new(conn.tcp.recv_chan()));
218 1052776 : epoll_idx.push(conn.tcp.connection_id());
219 1052776 : }
220 :
221 : // waiting for the next message
222 297119 : let index = executor::epoll_chans(&epoll_vec, -1).unwrap();
223 297119 :
224 297119 : if index == 0 {
225 : // got a new connection
226 99891 : match node_events.must_recv() {
227 99891 : NodeEvent::Accept(tcp) => {
228 99891 : conns.insert(
229 99891 : tcp.connection_id(),
230 99891 : ConnState {
231 99891 : tcp,
232 99891 : greeting: false,
233 99891 : ttid: TenantTimelineId::empty(),
234 99891 : flush_pending: false,
235 99891 : runtime: tokio::runtime::Builder::new_current_thread().build()?,
236 : },
237 : );
238 : }
239 0 : NodeEvent::Internal(_) => unreachable!(),
240 : }
241 99891 : continue;
242 197228 : }
243 197228 :
244 197228 : let connection_id = epoll_idx[index];
245 197228 : let conn = conns.get_mut(&connection_id).unwrap();
246 197228 : let mut next_event = Some(conn.tcp.recv_chan().must_recv());
247 :
248 : loop {
249 358210 : let event = match next_event {
250 200974 : Some(event) => event,
251 157236 : None => break,
252 : };
253 :
254 200974 : match event {
255 144720 : NetEvent::Message(msg) => {
256 144720 : let res = conn.process_any(msg, &mut global);
257 144720 : if res.is_err() {
258 39992 : let e = res.unwrap_err();
259 39992 : let estr = e.to_string();
260 39992 : if !estr.contains("finished processing START_REPLICATION") {
261 38972 : warn!("conn {:?} error: {:?}", connection_id, e);
262 0 : panic!("unexpected error at safekeeper: {:#}", e);
263 1020 : }
264 1020 : conns.remove(&connection_id);
265 1020 : break;
266 104728 : }
267 : }
268 56254 : NetEvent::Closed => {
269 56254 : // TODO: remove from conns?
270 56254 : }
271 : }
272 :
273 160982 : next_event = conn.tcp.recv_chan().try_recv();
274 : }
275 :
276 685666 : conns.retain(|_, conn| {
277 685666 : let res = conn.flush(&mut global);
278 685666 : if res.is_err() {
279 0 : debug!("conn {:?} error: {:?}", conn.tcp, res);
280 685666 : }
281 685666 : res.is_ok()
282 685666 : });
283 : }
284 0 : }
285 :
286 : impl ConnState {
287 : /// Process a message from the network. It can be START_REPLICATION request or a valid ProposerAcceptorMessage message.
288 105748 : fn process_any(&mut self, any: AnyMessage, global: &mut GlobalMap) -> Result<()> {
289 105748 : if let AnyMessage::Bytes(copy_data) = any {
290 105748 : let repl_prefix = b"START_REPLICATION ";
291 105748 : if !self.greeting && copy_data.starts_with(repl_prefix) {
292 1020 : self.process_start_replication(copy_data.slice(repl_prefix.len()..), global)?;
293 1020 : bail!("finished processing START_REPLICATION")
294 104728 : }
295 :
296 104728 : let msg = ProposerAcceptorMessage::parse(copy_data)?;
297 104728 : debug!("got msg: {:?}", msg);
298 104728 : self.process(msg, global)
299 : } else {
300 0 : bail!("unexpected message, expected AnyMessage::Bytes");
301 : }
302 105748 : }
303 :
304 : /// Process START_REPLICATION request.
305 1020 : fn process_start_replication(
306 1020 : &mut self,
307 1020 : copy_data: Bytes,
308 1020 : global: &mut GlobalMap,
309 1020 : ) -> Result<()> {
310 : // format is "<tenant_id> <timeline_id> <start_lsn> <end_lsn>"
311 1020 : let str = String::from_utf8(copy_data.to_vec())?;
312 :
313 1020 : let mut parts = str.split(' ');
314 1020 : let tenant_id = parts.next().unwrap().parse::<TenantId>()?;
315 1020 : let timeline_id = parts.next().unwrap().parse::<TimelineId>()?;
316 1020 : let start_lsn = parts.next().unwrap().parse::<u64>()?;
317 1020 : let end_lsn = parts.next().unwrap().parse::<u64>()?;
318 :
319 1020 : let ttid = TenantTimelineId::new(tenant_id, timeline_id);
320 1020 : let shared_state = global.get(&ttid);
321 1020 :
322 1020 : // read bytes from start_lsn to end_lsn
323 1020 : let mut buf = vec![0; (end_lsn - start_lsn) as usize];
324 1020 : shared_state.disk.wal.lock().read(start_lsn, &mut buf);
325 1020 :
326 1020 : // send bytes to the client
327 1020 : self.tcp.send(AnyMessage::Bytes(Bytes::from(buf)));
328 1020 : Ok(())
329 1020 : }
330 :
331 : /// Get or create a timeline.
332 78236 : fn init_timeline(
333 78236 : &mut self,
334 78236 : ttid: TenantTimelineId,
335 78236 : server_info: ServerInfo,
336 78236 : global: &mut GlobalMap,
337 78236 : ) -> Result<()> {
338 78236 : self.ttid = ttid;
339 78236 : if global.has_tli(&ttid) {
340 72505 : return Ok(());
341 5731 : }
342 5731 :
343 5731 : global.create(ttid, server_info)
344 78236 : }
345 :
346 : /// Process a ProposerAcceptorMessage.
347 104728 : fn process(&mut self, msg: ProposerAcceptorMessage, global: &mut GlobalMap) -> Result<()> {
348 104728 : if !self.greeting {
349 78236 : self.greeting = true;
350 78236 :
351 78236 : match msg {
352 78236 : ProposerAcceptorMessage::Greeting(ref greeting) => {
353 78236 : tracing::info!(
354 0 : "start handshake with walproposer {:?} {:?}",
355 : self.tcp,
356 : greeting
357 : );
358 78236 : let server_info = ServerInfo {
359 78236 : pg_version: greeting.pg_version,
360 78236 : system_id: greeting.system_id,
361 78236 : wal_seg_size: greeting.wal_seg_size,
362 78236 : };
363 78236 : let ttid = TenantTimelineId::new(greeting.tenant_id, greeting.timeline_id);
364 78236 : self.init_timeline(ttid, server_info, global)?
365 : }
366 : _ => {
367 0 : bail!("unexpected message {msg:?} instead of greeting");
368 : }
369 : }
370 26492 : }
371 :
372 104728 : let tli = global.get(&self.ttid);
373 104728 :
374 104728 : match msg {
375 10870 : ProposerAcceptorMessage::AppendRequest(append_request) => {
376 10870 : self.flush_pending = true;
377 10870 : self.process_sk_msg(
378 10870 : tli,
379 10870 : &ProposerAcceptorMessage::NoFlushAppendRequest(append_request),
380 10870 : )?;
381 : }
382 93858 : other => {
383 93858 : self.process_sk_msg(tli, &other)?;
384 : }
385 : }
386 :
387 104728 : Ok(())
388 104728 : }
389 :
390 : /// Process FlushWAL if needed.
391 685666 : fn flush(&mut self, global: &mut GlobalMap) -> Result<()> {
392 685666 : // TODO: try to add extra flushes in simulation, to verify that extra flushes don't break anything
393 685666 : if !self.flush_pending {
394 676708 : return Ok(());
395 8958 : }
396 8958 : self.flush_pending = false;
397 8958 : let shared_state = global.get(&self.ttid);
398 8958 : self.process_sk_msg(shared_state, &ProposerAcceptorMessage::FlushWAL)
399 685666 : }
400 :
401 : /// Make safekeeper process a message and send a reply to the TCP
402 113686 : fn process_sk_msg(
403 113686 : &mut self,
404 113686 : shared_state: &mut SharedState,
405 113686 : msg: &ProposerAcceptorMessage,
406 113686 : ) -> Result<()> {
407 113686 : let mut reply = self.runtime.block_on(shared_state.sk.process_msg(msg))?;
408 113686 : if let Some(reply) = &mut reply {
409 : // TODO: if this is AppendResponse, fill in proper hot standby feedback and disk consistent lsn
410 :
411 99413 : let mut buf = BytesMut::with_capacity(128);
412 99413 : reply.serialize(&mut buf)?;
413 :
414 99413 : self.tcp.send(AnyMessage::Bytes(buf.into()));
415 14273 : }
416 113686 : Ok(())
417 113686 : }
418 : }
419 :
420 : impl Drop for ConnState {
421 99863 : fn drop(&mut self) {
422 99863 : debug!("dropping conn: {:?}", self.tcp);
423 99863 : if !std::thread::panicking() {
424 1020 : self.tcp.close();
425 98843 : }
426 : // TODO: clean up non-fsynced WAL
427 99863 : }
428 : }
|
