1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
use std::os::raw::{c_char, c_int, c_uint}; use va_list::VaList; use crate::tuple::ffi::BoxTuple; // =========================================================================== // Logging #[repr(u32)] #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] pub enum SayLevel { Fatal = 0, System = 1, Error = 2, Crit = 3, Warn = 4, Info = 5, Debug = 6, } pub type SayFunc = Option<unsafe extern "C" fn(c_int, *const c_char, c_int, *const c_char, *const c_char, ...)>; extern "C" { #[link_name = "log_level"] pub static mut LOG_LEVEL: c_int; #[link_name = "_say"] pub static mut SAY_FN: SayFunc; } // =========================================================================== // Slab cache #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct SlabCache { _unused: [u8; 0], } extern "C" { /** * Return SlabCache suitable to use with tarantool/small library */ pub fn cord_slab_cache() -> *mut SlabCache; } // =========================================================================== // CoIO extern "C" { /** * Create new eio task with specified function and * arguments. Yield and wait until the task is complete * or a timeout occurs. * * This function doesn't throw exceptions to avoid double error * checking: in most cases it's also necessary to check the return * value of the called function and perform necessary actions. If * func sets errno, the errno is preserved across the call. * * @retval -1 and errno = ENOMEM if failed to create a task * @retval the function return (errno is preserved). * * @code * static ssize_t openfile_cb(va_list ap) * { * const char *filename = va_arg(ap); * int flags = va_arg(ap); * return open(filename, flags); * } * * if (coio_call(openfile_cb, 0.10, "/tmp/file", 0) == -1) * // handle errors. * ... * @endcode */ pub fn coio_call(func: Option<unsafe extern "C" fn(VaList) -> c_int>, ...) -> isize; } #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct AddrInfo { _unused: [u8; 0], } extern "C" { /** * Fiber-friendly version of getaddrinfo(3). * * @param host host name, i.e. "tarantool.org" * @param port service name, i.e. "80" or "http" * @param hints hints, see getaddrinfo(3) * @param res[out] result, see getaddrinfo(3) * @param timeout timeout * @retval 0 on success, please free @a res using freeaddrinfo(3). * @retval -1 on error, check diag. * Please note that the return value is not compatible with * getaddrinfo(3). * @sa getaddrinfo() */ pub fn coio_getaddrinfo( host: *const c_char, port: *const c_char, hints: *const AddrInfo, res: *mut *mut AddrInfo, timeout: f64 ) -> c_int; } // =========================================================================== // Tuple #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct BoxTupleFormat { _unused: [u8; 0], } extern "C" { /** * Tuple Format. * * Each Tuple has associated format (class). Default format is used to * create tuples which are not attach to any particular space. */ pub fn box_tuple_format_default() -> *mut BoxTupleFormat; } extern "C" { /** * Return the associated format. * \param Tuple Tuple * \return TupleFormat */ pub fn box_tuple_format(tuple: *const BoxTuple) -> *mut BoxTupleFormat; /** * Return the raw Tuple field in MsgPack format. * * The buffer is valid until next call to box_tuple_* functions. * * \param Tuple a Tuple * \param fieldno zero-based index in MsgPack array. * \retval NULL if i >= box_tuple_field_count(Tuple) * \retval msgpack otherwise */ pub fn box_tuple_field(tuple: *const BoxTuple, fieldno: u32) -> *const c_char; } /** * Tuple iterator */ #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct BoxTupleIterator { _unused: [u8; 0], } extern "C" { /** * Allocate and initialize a new Tuple iterator. The Tuple iterator * allow to iterate over fields at root level of MsgPack array. * * Example: * \code * box_tuple_iterator *it = box_tuple_iterator(Tuple); * if (it == NULL) { * // error handling using box_error_last() * } * const char *field; * while (field = box_tuple_next(it)) { * // process raw MsgPack data * } * * // rewind iterator to first position * box_tuple_rewind(it); * assert(box_tuple_position(it) == 0); * * // rewind iterator to first position * field = box_tuple_seek(it, 3); * assert(box_tuple_position(it) == 4); * * box_iterator_free(it); * \endcode * * \post box_tuple_position(it) == 0 */ pub fn box_tuple_iterator(tuple: *mut BoxTuple) -> *mut BoxTupleIterator; /** * Destroy and free Tuple iterator */ pub fn box_tuple_iterator_free(it: *mut BoxTupleIterator); /** * Return zero-based next position in iterator. * That is, this function return the field id of field that will be * returned by the next call to box_tuple_next(it). Returned value is zero * after initialization or rewind and box_tuple_field_count(Tuple) * after the end of iteration. * * \param it Tuple iterator * \returns position. */ pub fn box_tuple_position(it: *mut BoxTupleIterator) -> u32; /** * Rewind iterator to the initial position. * * \param it Tuple iterator * \post box_tuple_position(it) == 0 */ pub fn box_tuple_rewind(it: *mut BoxTupleIterator); /** * Seek the Tuple iterator. * * The returned buffer is valid until next call to box_tuple_* API. * Requested fieldno returned by next call to box_tuple_next(it). * * \param it Tuple iterator * \param fieldno - zero-based position in MsgPack array. * \post box_tuple_position(it) == fieldno if returned value is not NULL * \post box_tuple_position(it) == box_tuple_field_count(Tuple) if returned * value is NULL. */ pub fn box_tuple_seek(it: *mut BoxTupleIterator, fieldno: u32) -> *const c_char; /** * Return the next Tuple field from Tuple iterator. * The returned buffer is valid until next call to box_tuple_* API. * * \param it Tuple iterator. * \retval NULL if there are no more fields. * \retval MsgPack otherwise * \pre box_tuple_position(it) is zerod-based id of returned field * \post box_tuple_position(it) == box_tuple_field_count(Tuple) if returned * value is NULL. */ pub fn box_tuple_next(it: *mut BoxTupleIterator) -> *const c_char; pub fn box_tuple_update(tuple: *const BoxTuple, expr: *const c_char, expr_end: *const c_char) -> *mut BoxTuple; pub fn box_tuple_upsert(tuple: *const BoxTuple, expr: *const c_char, expr_end: *const c_char) -> *mut BoxTuple; } // =========================================================================== // Space pub const BOX_SYSTEM_ID_MIN: u32 = 256; pub const BOX_SCHEMA_ID: u32 = 272; pub const BOX_SPACE_ID: u32 = 280; pub const BOX_VSPACE_ID: u32 = 281; pub const BOX_INDEX_ID: u32 = 288; pub const BOX_VINDEX_ID: u32 = 289; pub const BOX_FUNC_ID: u32 = 296; pub const BOX_VFUNC_ID: u32 = 297; pub const BOX_USER_ID: u32 = 304; pub const BOX_VUSER_ID: u32 = 305; pub const BOX_PRIV_ID: u32 = 312; pub const BOX_VPRIV_ID: u32 = 313; pub const BOX_CLUSTER_ID: u32 = 320; pub const BOX_SYSTEM_ID_MAX: u32 = 511; pub const BOX_ID_NIL: u32 = 2147483647; #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct BoxFunctionCtx { _unused: [u8; 0], } extern "C" { /** * Return a Tuple from stored C procedure. * * Returned Tuple is automatically reference counted by Tarantool. * * \param ctx an opaque structure passed to the stored C procedure by * Tarantool * \param Tuple a Tuple to return * \retval -1 on error (perhaps, out of memory; check box_error_last()) * \retval 0 otherwise */ pub fn box_return_tuple(ctx: *mut BoxFunctionCtx, tuple: *mut BoxTuple) -> c_int; } extern "C" { /** * Clear the last error. */ pub fn box_error_clear(); /** * Set the last error. * * \param code IPROTO error code (enum \link box_error_code \endlink) * \param format (const char * ) - printf()-like format string * \param ... - format arguments * \returns -1 for convention use * * \sa enum box_error_code */ pub fn box_error_set(file: *const c_char, line: c_uint, code: u32, format: *const c_char, ...)-> c_int; } // =========================================================================== // Latch /** * A lock for cooperative multitasking environment */ #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct BoxLatch { _unused: [u8; 0], } extern "C" { /** * Allocate and initialize the new latch. * \returns latch */ pub fn box_latch_new() -> *mut BoxLatch; /** * Destroy and free the latch. * \param latch latch */ pub fn box_latch_delete(latch: *mut BoxLatch); /** * Lock a latch. Waits indefinitely until the current fiber can gain access to * the latch. * * \param latch a latch */ pub fn box_latch_lock(latch: *mut BoxLatch); /** * Try to lock a latch. Return immediately if the latch is locked. * \param latch a latch * \retval 0 - success * \retval 1 - the latch is locked. */ pub fn box_latch_trylock(latch: *mut BoxLatch) -> c_int; /** * Unlock a latch. The fiber calling this function must * own the latch. * * \param latch a latch */ pub fn box_latch_unlock(latch: *mut BoxLatch); } // =========================================================================== // Clock extern "C" { pub fn clock_realtime() -> f64; pub fn clock_monotonic() -> f64; pub fn clock_process() -> f64; pub fn clock_thread() -> f64; pub fn clock_realtime64() -> u64; pub fn clock_monotonic64() -> u64; pub fn clock_process64() -> u64; pub fn clock_thread64() -> u64; }