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