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