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