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