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