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