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