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