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