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