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