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