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