Line data Source code
1 : //! A C-Rust shim: defines implementation of C walproposer API, assuming wp
2 : //! callback_data stores Box to some Rust implementation.
3 :
4 : #![allow(dead_code)]
5 :
6 : use std::ffi::CStr;
7 : use std::ffi::CString;
8 :
9 : use crate::bindings::uint32;
10 : use crate::bindings::walproposer_api;
11 : use crate::bindings::NeonWALReadResult;
12 : use crate::bindings::PGAsyncReadResult;
13 : use crate::bindings::PGAsyncWriteResult;
14 : use crate::bindings::Safekeeper;
15 : use crate::bindings::Size;
16 : use crate::bindings::StringInfoData;
17 : use crate::bindings::TimestampTz;
18 : use crate::bindings::WalProposer;
19 : use crate::bindings::WalProposerConnStatusType;
20 : use crate::bindings::WalProposerConnectPollStatusType;
21 : use crate::bindings::WalProposerExecStatusType;
22 : use crate::bindings::WalproposerShmemState;
23 : use crate::bindings::XLogRecPtr;
24 : use crate::walproposer::ApiImpl;
25 : use crate::walproposer::StreamingCallback;
26 : use crate::walproposer::WaitResult;
27 :
28 11310 : extern "C" fn get_shmem_state(wp: *mut WalProposer) -> *mut WalproposerShmemState {
29 11310 : unsafe {
30 11310 : let callback_data = (*(*wp).config).callback_data;
31 11310 : let api = callback_data as *mut Box<dyn ApiImpl>;
32 11310 : (*api).get_shmem_state()
33 11310 : }
34 11310 : }
35 :
36 1203 : extern "C" fn start_streaming(wp: *mut WalProposer, startpos: XLogRecPtr) {
37 1203 : unsafe {
38 1203 : let callback_data = (*(*wp).config).callback_data;
39 1203 : let api = callback_data as *mut Box<dyn ApiImpl>;
40 1203 : let callback = StreamingCallback::new(wp);
41 1203 : (*api).start_streaming(startpos, &callback);
42 1203 : }
43 1203 : }
44 :
45 792 : extern "C" fn get_flush_rec_ptr(wp: *mut WalProposer) -> XLogRecPtr {
46 792 : unsafe {
47 792 : let callback_data = (*(*wp).config).callback_data;
48 792 : let api = callback_data as *mut Box<dyn ApiImpl>;
49 792 : (*api).get_flush_rec_ptr()
50 792 : }
51 792 : }
52 :
53 6905 : extern "C" fn update_donor(wp: *mut WalProposer, donor: *mut Safekeeper, donor_lsn: XLogRecPtr) {
54 6905 : unsafe {
55 6905 : let callback_data = (*(*wp).config).callback_data;
56 6905 : let api = callback_data as *mut Box<dyn ApiImpl>;
57 6905 : (*api).update_donor(&mut (*donor), donor_lsn)
58 6905 : }
59 6905 : }
60 :
61 2508351 : extern "C" fn get_current_timestamp(wp: *mut WalProposer) -> TimestampTz {
62 2508351 : unsafe {
63 2508351 : let callback_data = (*(*wp).config).callback_data;
64 2508351 : let api = callback_data as *mut Box<dyn ApiImpl>;
65 2508351 : (*api).get_current_timestamp()
66 2508351 : }
67 2508351 : }
68 :
69 87031 : extern "C" fn conn_error_message(sk: *mut Safekeeper) -> *mut ::std::os::raw::c_char {
70 87031 : unsafe {
71 87031 : let callback_data = (*(*(*sk).wp).config).callback_data;
72 87031 : let api = callback_data as *mut Box<dyn ApiImpl>;
73 87031 : let msg = (*api).conn_error_message(&mut (*sk));
74 87031 : let msg = CString::new(msg).unwrap();
75 87031 : // TODO: fix leaking error message
76 87031 : msg.into_raw()
77 87031 : }
78 87031 : }
79 :
80 267083 : extern "C" fn conn_status(sk: *mut Safekeeper) -> WalProposerConnStatusType {
81 267083 : unsafe {
82 267083 : let callback_data = (*(*(*sk).wp).config).callback_data;
83 267083 : let api = callback_data as *mut Box<dyn ApiImpl>;
84 267083 : (*api).conn_status(&mut (*sk))
85 267083 : }
86 267083 : }
87 :
88 267083 : extern "C" fn conn_connect_start(sk: *mut Safekeeper) {
89 267083 : unsafe {
90 267083 : let callback_data = (*(*(*sk).wp).config).callback_data;
91 267083 : let api = callback_data as *mut Box<dyn ApiImpl>;
92 267083 : (*api).conn_connect_start(&mut (*sk))
93 267083 : }
94 267083 : }
95 :
96 240380 : extern "C" fn conn_connect_poll(sk: *mut Safekeeper) -> WalProposerConnectPollStatusType {
97 240380 : unsafe {
98 240380 : let callback_data = (*(*(*sk).wp).config).callback_data;
99 240380 : let api = callback_data as *mut Box<dyn ApiImpl>;
100 240380 : (*api).conn_connect_poll(&mut (*sk))
101 240380 : }
102 240380 : }
103 :
104 240380 : extern "C" fn conn_send_query(sk: *mut Safekeeper, query: *mut ::std::os::raw::c_char) -> bool {
105 240380 : let query = unsafe { CStr::from_ptr(query) };
106 240380 : let query = query.to_str().unwrap();
107 240380 :
108 240380 : unsafe {
109 240380 : let callback_data = (*(*(*sk).wp).config).callback_data;
110 240380 : let api = callback_data as *mut Box<dyn ApiImpl>;
111 240380 : (*api).conn_send_query(&mut (*sk), query)
112 240380 : }
113 240380 : }
114 :
115 240380 : extern "C" fn conn_get_query_result(sk: *mut Safekeeper) -> WalProposerExecStatusType {
116 240380 : unsafe {
117 240380 : let callback_data = (*(*(*sk).wp).config).callback_data;
118 240380 : let api = callback_data as *mut Box<dyn ApiImpl>;
119 240380 : (*api).conn_get_query_result(&mut (*sk))
120 240380 : }
121 240380 : }
122 :
123 0 : extern "C" fn conn_flush(sk: *mut Safekeeper) -> ::std::os::raw::c_int {
124 0 : unsafe {
125 0 : let callback_data = (*(*(*sk).wp).config).callback_data;
126 0 : let api = callback_data as *mut Box<dyn ApiImpl>;
127 0 : (*api).conn_flush(&mut (*sk))
128 0 : }
129 0 : }
130 :
131 89390 : extern "C" fn conn_finish(sk: *mut Safekeeper) {
132 89390 : unsafe {
133 89390 : let callback_data = (*(*(*sk).wp).config).callback_data;
134 89390 : let api = callback_data as *mut Box<dyn ApiImpl>;
135 89390 : (*api).conn_finish(&mut (*sk))
136 89390 : }
137 89390 : }
138 :
139 134573 : extern "C" fn conn_async_read(
140 134573 : sk: *mut Safekeeper,
141 134573 : buf: *mut *mut ::std::os::raw::c_char,
142 134573 : amount: *mut ::std::os::raw::c_int,
143 134573 : ) -> PGAsyncReadResult {
144 134573 : unsafe {
145 134573 : let callback_data = (*(*(*sk).wp).config).callback_data;
146 134573 : let api = callback_data as *mut Box<dyn ApiImpl>;
147 134573 :
148 134573 : // This function has guarantee that returned buf will be valid until
149 134573 : // the next call. So we can store a Vec in each Safekeeper and reuse
150 134573 : // it on the next call.
151 134573 : let mut inbuf = take_vec_u8(&mut (*sk).inbuf).unwrap_or_default();
152 134573 : inbuf.clear();
153 134573 :
154 134573 : let result = (*api).conn_async_read(&mut (*sk), &mut inbuf);
155 134573 :
156 134573 : // Put a Vec back to sk->inbuf and return data ptr.
157 134573 : *amount = inbuf.len() as i32;
158 134573 : *buf = store_vec_u8(&mut (*sk).inbuf, inbuf);
159 134573 :
160 134573 : result
161 134573 : }
162 134573 : }
163 :
164 32391 : extern "C" fn conn_async_write(
165 32391 : sk: *mut Safekeeper,
166 32391 : buf: *const ::std::os::raw::c_void,
167 32391 : size: usize,
168 32391 : ) -> PGAsyncWriteResult {
169 32391 : unsafe {
170 32391 : let buf = std::slice::from_raw_parts(buf as *const u8, size);
171 32391 : let callback_data = (*(*(*sk).wp).config).callback_data;
172 32391 : let api = callback_data as *mut Box<dyn ApiImpl>;
173 32391 : (*api).conn_async_write(&mut (*sk), buf)
174 32391 : }
175 32391 : }
176 :
177 269395 : extern "C" fn conn_blocking_write(
178 269395 : sk: *mut Safekeeper,
179 269395 : buf: *const ::std::os::raw::c_void,
180 269395 : size: usize,
181 269395 : ) -> bool {
182 269395 : unsafe {
183 269395 : let buf = std::slice::from_raw_parts(buf as *const u8, size);
184 269395 : let callback_data = (*(*(*sk).wp).config).callback_data;
185 269395 : let api = callback_data as *mut Box<dyn ApiImpl>;
186 269395 : (*api).conn_blocking_write(&mut (*sk), buf)
187 269395 : }
188 269395 : }
189 :
190 5620 : extern "C" fn recovery_download(wp: *mut WalProposer, sk: *mut Safekeeper) -> bool {
191 5620 : unsafe {
192 5620 : let callback_data = (*(*(*sk).wp).config).callback_data;
193 5620 : let api = callback_data as *mut Box<dyn ApiImpl>;
194 5620 :
195 5620 : // currently `recovery_download` is always called right after election
196 5620 : (*api).after_election(&mut (*wp));
197 5620 :
198 5620 : (*api).recovery_download(&mut (*wp), &mut (*sk))
199 5620 : }
200 5620 : }
201 :
202 7301 : extern "C" fn wal_reader_allocate(sk: *mut Safekeeper) {
203 7301 : unsafe {
204 7301 : let callback_data = (*(*(*sk).wp).config).callback_data;
205 7301 : let api = callback_data as *mut Box<dyn ApiImpl>;
206 7301 : (*api).wal_reader_allocate(&mut (*sk));
207 7301 : }
208 7301 : }
209 :
210 : #[allow(clippy::unnecessary_cast)]
211 25090 : extern "C" fn wal_read(
212 25090 : sk: *mut Safekeeper,
213 25090 : buf: *mut ::std::os::raw::c_char,
214 25090 : startptr: XLogRecPtr,
215 25090 : count: Size,
216 25090 : _errmsg: *mut *mut ::std::os::raw::c_char,
217 25090 : ) -> NeonWALReadResult {
218 25090 : unsafe {
219 25090 : let buf = std::slice::from_raw_parts_mut(buf as *mut u8, count);
220 25090 : let callback_data = (*(*(*sk).wp).config).callback_data;
221 25090 : let api = callback_data as *mut Box<dyn ApiImpl>;
222 25090 : // TODO: errmsg is not forwarded
223 25090 : (*api).wal_read(&mut (*sk), buf, startptr)
224 25090 : }
225 25090 : }
226 :
227 104034 : extern "C" fn wal_reader_events(sk: *mut Safekeeper) -> uint32 {
228 104034 : unsafe {
229 104034 : let callback_data = (*(*(*sk).wp).config).callback_data;
230 104034 : let api = callback_data as *mut Box<dyn ApiImpl>;
231 104034 : (*api).wal_reader_events(&mut (*sk))
232 104034 : }
233 104034 : }
234 :
235 72310 : extern "C" fn init_event_set(wp: *mut WalProposer) {
236 72310 : unsafe {
237 72310 : let callback_data = (*(*wp).config).callback_data;
238 72310 : let api = callback_data as *mut Box<dyn ApiImpl>;
239 72310 : (*api).init_event_set(&mut (*wp));
240 72310 : }
241 72310 : }
242 :
243 530857 : extern "C" fn update_event_set(sk: *mut Safekeeper, events: uint32) {
244 530857 : unsafe {
245 530857 : let callback_data = (*(*(*sk).wp).config).callback_data;
246 530857 : let api = callback_data as *mut Box<dyn ApiImpl>;
247 530857 : (*api).update_event_set(&mut (*sk), events);
248 530857 : }
249 530857 : }
250 :
251 36902 : extern "C" fn active_state_update_event_set(sk: *mut Safekeeper) {
252 36902 : unsafe {
253 36902 : let callback_data = (*(*(*sk).wp).config).callback_data;
254 36902 : let api = callback_data as *mut Box<dyn ApiImpl>;
255 36902 : (*api).active_state_update_event_set(&mut (*sk));
256 36902 : }
257 36902 : }
258 :
259 480760 : extern "C" fn add_safekeeper_event_set(sk: *mut Safekeeper, events: uint32) {
260 480760 : unsafe {
261 480760 : let callback_data = (*(*(*sk).wp).config).callback_data;
262 480760 : let api = callback_data as *mut Box<dyn ApiImpl>;
263 480760 : (*api).add_safekeeper_event_set(&mut (*sk), events);
264 480760 : }
265 480760 : }
266 :
267 303067 : extern "C" fn rm_safekeeper_event_set(sk: *mut Safekeeper) {
268 303067 : unsafe {
269 303067 : let callback_data = (*(*(*sk).wp).config).callback_data;
270 303067 : let api = callback_data as *mut Box<dyn ApiImpl>;
271 303067 : (*api).rm_safekeeper_event_set(&mut (*sk));
272 303067 : }
273 303067 : }
274 :
275 698849 : extern "C" fn wait_event_set(
276 698849 : wp: *mut WalProposer,
277 698849 : timeout: ::std::os::raw::c_long,
278 698849 : event_sk: *mut *mut Safekeeper,
279 698849 : events: *mut uint32,
280 698849 : ) -> ::std::os::raw::c_int {
281 698849 : unsafe {
282 698849 : let callback_data = (*(*wp).config).callback_data;
283 698849 : let api = callback_data as *mut Box<dyn ApiImpl>;
284 698849 : let result = (*api).wait_event_set(&mut (*wp), timeout);
285 698849 : match result {
286 : WaitResult::Latch => {
287 71360 : *event_sk = std::ptr::null_mut();
288 71360 : *events = crate::bindings::WL_LATCH_SET;
289 71360 : 1
290 : }
291 : WaitResult::Timeout => {
292 22101 : *event_sk = std::ptr::null_mut();
293 22101 : // WaitEventSetWait returns 0 for timeout.
294 22101 : *events = 0;
295 22101 : 0
296 : }
297 605388 : WaitResult::Network(sk, event_mask) => {
298 605388 : *event_sk = sk;
299 605388 : *events = event_mask;
300 605388 : 1
301 : }
302 : }
303 : }
304 698849 : }
305 :
306 72310 : extern "C" fn strong_random(
307 72310 : wp: *mut WalProposer,
308 72310 : buf: *mut ::std::os::raw::c_void,
309 72310 : len: usize,
310 72310 : ) -> bool {
311 72310 : unsafe {
312 72310 : let buf = std::slice::from_raw_parts_mut(buf as *mut u8, len);
313 72310 : let callback_data = (*(*wp).config).callback_data;
314 72310 : let api = callback_data as *mut Box<dyn ApiImpl>;
315 72310 : (*api).strong_random(buf)
316 72310 : }
317 72310 : }
318 :
319 2172 : extern "C" fn get_redo_start_lsn(wp: *mut WalProposer) -> XLogRecPtr {
320 2172 : unsafe {
321 2172 : let callback_data = (*(*wp).config).callback_data;
322 2172 : let api = callback_data as *mut Box<dyn ApiImpl>;
323 2172 : (*api).get_redo_start_lsn()
324 2172 : }
325 2172 : }
326 :
327 2748 : extern "C" fn finish_sync_safekeepers(wp: *mut WalProposer, lsn: XLogRecPtr) {
328 2748 : unsafe {
329 2748 : let callback_data = (*(*wp).config).callback_data;
330 2748 : let api = callback_data as *mut Box<dyn ApiImpl>;
331 2748 : (*api).finish_sync_safekeepers(lsn)
332 2748 : }
333 2748 : }
334 :
335 12709 : extern "C" fn process_safekeeper_feedback(wp: *mut WalProposer, sk: *mut Safekeeper) {
336 12709 : unsafe {
337 12709 : let callback_data = (*(*wp).config).callback_data;
338 12709 : let api = callback_data as *mut Box<dyn ApiImpl>;
339 12709 : (*api).process_safekeeper_feedback(&mut (*wp), &mut (*sk));
340 12709 : }
341 12709 : }
342 :
343 713530 : extern "C" fn log_internal(
344 713530 : wp: *mut WalProposer,
345 713530 : level: ::std::os::raw::c_int,
346 713530 : line: *const ::std::os::raw::c_char,
347 713530 : ) {
348 713530 : unsafe {
349 713530 : let callback_data = (*(*wp).config).callback_data;
350 713530 : let api = callback_data as *mut Box<dyn ApiImpl>;
351 713530 : let line = CStr::from_ptr(line);
352 713530 : let line = line.to_str().unwrap();
353 713530 : (*api).log_internal(&mut (*wp), Level::from(level as u32), line)
354 713530 : }
355 713530 : }
356 :
357 : #[derive(Debug, PartialEq)]
358 : pub enum Level {
359 : Debug5,
360 : Debug4,
361 : Debug3,
362 : Debug2,
363 : Debug1,
364 : Log,
365 : Info,
366 : Notice,
367 : Warning,
368 : Error,
369 : Fatal,
370 : Panic,
371 : WPEvent,
372 : }
373 :
374 : impl Level {
375 713530 : pub fn from(elevel: u32) -> Level {
376 713530 : use crate::bindings::*;
377 713530 :
378 713530 : match elevel {
379 25090 : DEBUG5 => Level::Debug5,
380 0 : DEBUG4 => Level::Debug4,
381 0 : DEBUG3 => Level::Debug3,
382 12709 : DEBUG2 => Level::Debug2,
383 0 : DEBUG1 => Level::Debug1,
384 585339 : LOG => Level::Log,
385 0 : INFO => Level::Info,
386 0 : NOTICE => Level::Notice,
387 89786 : WARNING => Level::Warning,
388 0 : ERROR => Level::Error,
389 571 : FATAL => Level::Fatal,
390 35 : PANIC => Level::Panic,
391 0 : WPEVENT => Level::WPEvent,
392 0 : _ => panic!("unknown log level {}", elevel),
393 : }
394 713530 : }
395 : }
396 :
397 72310 : pub(crate) fn create_api() -> walproposer_api {
398 72310 : walproposer_api {
399 72310 : get_shmem_state: Some(get_shmem_state),
400 72310 : start_streaming: Some(start_streaming),
401 72310 : get_flush_rec_ptr: Some(get_flush_rec_ptr),
402 72310 : update_donor: Some(update_donor),
403 72310 : get_current_timestamp: Some(get_current_timestamp),
404 72310 : conn_error_message: Some(conn_error_message),
405 72310 : conn_status: Some(conn_status),
406 72310 : conn_connect_start: Some(conn_connect_start),
407 72310 : conn_connect_poll: Some(conn_connect_poll),
408 72310 : conn_send_query: Some(conn_send_query),
409 72310 : conn_get_query_result: Some(conn_get_query_result),
410 72310 : conn_flush: Some(conn_flush),
411 72310 : conn_finish: Some(conn_finish),
412 72310 : conn_async_read: Some(conn_async_read),
413 72310 : conn_async_write: Some(conn_async_write),
414 72310 : conn_blocking_write: Some(conn_blocking_write),
415 72310 : recovery_download: Some(recovery_download),
416 72310 : wal_reader_allocate: Some(wal_reader_allocate),
417 72310 : wal_read: Some(wal_read),
418 72310 : wal_reader_events: Some(wal_reader_events),
419 72310 : init_event_set: Some(init_event_set),
420 72310 : update_event_set: Some(update_event_set),
421 72310 : active_state_update_event_set: Some(active_state_update_event_set),
422 72310 : add_safekeeper_event_set: Some(add_safekeeper_event_set),
423 72310 : rm_safekeeper_event_set: Some(rm_safekeeper_event_set),
424 72310 : wait_event_set: Some(wait_event_set),
425 72310 : strong_random: Some(strong_random),
426 72310 : get_redo_start_lsn: Some(get_redo_start_lsn),
427 72310 : finish_sync_safekeepers: Some(finish_sync_safekeepers),
428 72310 : process_safekeeper_feedback: Some(process_safekeeper_feedback),
429 72310 : log_internal: Some(log_internal),
430 72310 : }
431 72310 : }
432 :
433 72310 : pub fn empty_shmem() -> crate::bindings::WalproposerShmemState {
434 72310 : let empty_feedback = crate::bindings::PageserverFeedback {
435 72310 : present: false,
436 72310 : currentClusterSize: 0,
437 72310 : last_received_lsn: 0,
438 72310 : disk_consistent_lsn: 0,
439 72310 : remote_consistent_lsn: 0,
440 72310 : replytime: 0,
441 72310 : shard_number: 0,
442 72310 : };
443 72310 :
444 72310 : crate::bindings::WalproposerShmemState {
445 72310 : propEpochStartLsn: crate::bindings::pg_atomic_uint64 { value: 0 },
446 72310 : donor_name: [0; 64],
447 72310 : donor_conninfo: [0; 1024],
448 72310 : donor_lsn: 0,
449 72310 : mutex: 0,
450 72310 : mineLastElectedTerm: crate::bindings::pg_atomic_uint64 { value: 0 },
451 72310 : backpressureThrottlingTime: crate::bindings::pg_atomic_uint64 { value: 0 },
452 72310 : currentClusterSize: crate::bindings::pg_atomic_uint64 { value: 0 },
453 72310 : shard_ps_feedback: [empty_feedback; 128],
454 72310 : num_shards: 0,
455 72310 : min_ps_feedback: empty_feedback,
456 72310 : }
457 72310 : }
458 :
459 : impl std::fmt::Display for Level {
460 2296 : fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
461 2296 : write!(f, "{:?}", self)
462 2296 : }
463 : }
464 :
465 : /// Take ownership of `Vec<u8>` from StringInfoData.
466 : #[allow(clippy::unnecessary_cast)]
467 351487 : pub(crate) fn take_vec_u8(pg: &mut StringInfoData) -> Option<Vec<u8>> {
468 351487 : if pg.data.is_null() {
469 216924 : return None;
470 134563 : }
471 134563 :
472 134563 : let ptr = pg.data as *mut u8;
473 134563 : let length = pg.len as usize;
474 134563 : let capacity = pg.maxlen as usize;
475 134563 :
476 134563 : pg.data = std::ptr::null_mut();
477 134563 : pg.len = 0;
478 134563 : pg.maxlen = 0;
479 134563 :
480 134563 : unsafe { Some(Vec::from_raw_parts(ptr, length, capacity)) }
481 351487 : }
482 :
483 : /// Store `Vec<u8>` in StringInfoData.
484 134573 : fn store_vec_u8(pg: &mut StringInfoData, vec: Vec<u8>) -> *mut ::std::os::raw::c_char {
485 134573 : let ptr = vec.as_ptr() as *mut ::std::os::raw::c_char;
486 134573 : let length = vec.len();
487 134573 : let capacity = vec.capacity();
488 134573 :
489 134573 : assert!(pg.data.is_null());
490 :
491 134573 : pg.data = ptr;
492 134573 : pg.len = length as i32;
493 134573 : pg.maxlen = capacity as i32;
494 134573 :
495 134573 : std::mem::forget(vec);
496 134573 :
497 134573 : ptr
498 134573 : }
|
