LCOV - code coverage report
Current view: top level - libs/walproposer/src - api_bindings.rs (source / functions) Coverage Total Hit
Test: b837401fb09d2d9818b70e630fdb67e9799b7b0d.info Lines: 95.9 % 368 353
Test Date: 2024-04-18 15:32:49 Functions: 97.1 % 35 34

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

Generated by: LCOV version 2.1-beta