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