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