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