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