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