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