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