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