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