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