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