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