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