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