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