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