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