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