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