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