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