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