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