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