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