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