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