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