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