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