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