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
use crate::{
error::TarantoolErrorCode::ProcC,
ffi::tarantool as ffi,
set_error,
tuple::{FunctionCtx, RawByteBuf, RawBytes, Tuple, TupleBuffer},
};
use serde::Serialize;
use std::{fmt::Display, os::raw::c_int, path::Path};
macro_rules! unwrap_or_report_err {
($res:expr) => {
match $res {
Ok(o) => o,
Err(e) => {
set_error!(ProcC, "{}", e);
-1
}
}
};
}
////////////////////////////////////////////////////////////////////////////////
// Proc
////////////////////////////////////////////////////////////////////////////////
/// Description of a tarantool stored procedure defined using the
/// `#[`[`tarantool::proc`]`]` macro attribute.
///
/// See also [`all_procs`].
///
/// [`tarantool::proc`]: macro@crate::proc
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Proc {
name: &'static str,
proc: ffi::Proc,
}
impl Proc {
/// Create a new stored proc description.
///
/// This function is called when `#[`[`tarantool::proc`]`]` attribute is
/// used, so users don't usually use it directly.
///
/// See also [`module_path`]
///
/// [`tarantool::proc`]: macro@crate::proc
/// [`module_path`]: module_path()
pub const fn new(name: &'static str, proc: ffi::Proc) -> Self {
Self { name, proc }
}
/// Get the name of the stored procedure NOT including the module name.
pub const fn name(&self) -> &'static str {
self.name
}
/// Get the proc's function pointer.
///
/// This function is usually not necessary for defining tarantool's stored
/// procedures, the name is enough. But it is there if you need it for some
/// reason.
pub const fn proc(&self) -> ffi::Proc {
self.proc
}
}
// Linkme distributed_slice exports a symbol with the given name, so we must
// make sure the name is unique, so as not to conflict with distributed slices
// from other crates or any other global symbols.
#[doc(hidden)]
#[::linkme::distributed_slice]
pub static TARANTOOL_MODULE_STORED_PROCS: [Proc] = [..];
/// Returns a slice of all stored procedures defined using the
/// `#[`[`tarantool::proc`]`]` macro attribute.
///
/// The order of procs in the slice is undefined.
///
/// [`tarantool::proc`]: macro@crate::proc
pub fn all_procs() -> &'static [Proc] {
&TARANTOOL_MODULE_STORED_PROCS
}
////////////////////////////////////////////////////////////////////////////////
// module_name
////////////////////////////////////////////////////////////////////////////////
/// Returns a path to the dynamically linked ojbect in which the symbol pointed
/// to by `sym` is defined.
///
/// This can be used to dynamically figure out the module name for tarantool's
/// stored procedure definition, for example by passing in a pointer to the
/// function defined using `#[`[`tarantool::proc`]`]` macro attribute, but is
/// NOT GUARANTEED TO WORK.
///
/// ```no_run
/// use tarantool::proc::module_path;
///
/// #[tarantool::proc]
/// fn my_proc() -> i32 {
/// 69
/// }
///
/// let path = module_path(my_proc as _).unwrap();
/// let filename = path.file_stem().unwrap();
/// assert_eq!(filename, std::ffi::OsStr::new("libmy_library"));
/// ```
///
/// [`tarantool::proc`]: macro@crate::proc
pub fn module_path(sym: *const ()) -> Option<&'static Path> {
unsafe {
let mut info: libc::Dl_info = std::mem::zeroed();
if libc::dladdr(sym as _, &mut info) == 0 {
return None;
}
if info.dli_fname.is_null() {
return None;
}
let path = std::ffi::CStr::from_ptr(info.dli_fname);
let path: &std::ffi::OsStr = std::os::unix::ffi::OsStrExt::from_bytes(path.to_bytes());
Some(Path::new(path))
}
}
////////////////////////////////////////////////////////////////////////////////
// ReturnMsgpack
////////////////////////////////////////////////////////////////////////////////
/// A wrapper type for returning custom types from stored procedures. Consider
/// using the `custom_ret` attribute parameter instead (see [`tarantool::proc`]
/// docs for examples).
///
/// # using `ReturnMsgpack` directly
///
/// You can either return `ReturnMsgpack` directly:
///
/// ```
/// use tarantool::proc::ReturnMsgpack;
///
/// #[tarantool::proc]
/// fn foo(x: i32) -> ReturnMsgpack<MyStruct> {
/// ReturnMsgpack(MyStruct { x, y: x * 2 })
/// }
///
/// #[derive(serde::Serialize)]
/// struct MyStruct { x: i32, y: i32 }
/// ```
///
/// # implementing `Return` for custom type
///
/// Or you can use it to implement `Return` for your custom type:
///
/// ```
/// use std::os::raw::c_int;
/// use tarantool::{proc::{Return, ReturnMsgpack}, tuple::FunctionCtx};
///
/// #[tarantool::proc]
/// fn foo(x: i32) -> MyStruct {
/// MyStruct { x, y: x * 2 }
/// }
///
/// #[derive(serde::Serialize)]
/// struct MyStruct { x: i32, y: i32 }
///
/// impl Return for MyStruct {
/// fn ret(self, ctx: FunctionCtx) -> c_int {
/// ReturnMsgpack(self).ret(ctx)
/// }
/// }
/// ```
///
/// [`tarantool::proc`]: macro@crate::proc
pub struct ReturnMsgpack<T>(pub T);
impl<T: Serialize> Return for ReturnMsgpack<T> {
#[inline(always)]
fn ret(self, ctx: FunctionCtx) -> c_int {
unwrap_or_report_err!(ctx.return_mp(&self.0))
}
}
////////////////////////////////////////////////////////////////////////////////
// Return
////////////////////////////////////////////////////////////////////////////////
pub trait Return: Sized {
fn ret(self, ctx: FunctionCtx) -> c_int;
}
impl Return for Tuple {
#[inline]
fn ret(self, ctx: FunctionCtx) -> c_int {
let res = ctx.return_tuple(&self);
unwrap_or_report_err!(res)
}
}
impl<E> Return for Result<Tuple, E>
where
E: Display,
{
#[inline(always)]
fn ret(self, ctx: FunctionCtx) -> c_int {
unwrap_or_report_err!(self.map(|t| t.ret(ctx)))
}
}
impl Return for TupleBuffer {
#[inline]
fn ret(self, ctx: FunctionCtx) -> c_int {
let res = ctx.return_bytes(self.as_ref());
unwrap_or_report_err!(res)
}
}
impl<E> Return for Result<TupleBuffer, E>
where
E: Display,
{
#[inline(always)]
fn ret(self, ctx: FunctionCtx) -> c_int {
unwrap_or_report_err!(self.map(|t| t.ret(ctx)))
}
}
impl Return for &RawBytes {
#[inline]
fn ret(self, ctx: FunctionCtx) -> c_int {
let res = ctx.return_bytes(self);
unwrap_or_report_err!(res)
}
}
impl<E> Return for Result<&RawBytes, E>
where
E: Display,
{
#[inline(always)]
fn ret(self, ctx: FunctionCtx) -> c_int {
unwrap_or_report_err!(self.map(|t| t.ret(ctx)))
}
}
impl Return for RawByteBuf {
#[inline]
fn ret(self, ctx: FunctionCtx) -> c_int {
let res = ctx.return_bytes(&self);
unwrap_or_report_err!(res)
}
}
impl<E> Return for Result<RawByteBuf, E>
where
E: Display,
{
#[inline(always)]
fn ret(self, ctx: FunctionCtx) -> c_int {
unwrap_or_report_err!(self.map(|t| t.ret(ctx)))
}
}
impl Return for () {
#[inline(always)]
fn ret(self, _: FunctionCtx) -> c_int {
0
}
}
impl<O, E> Return for Result<O, E>
where
O: Serialize,
E: Display,
{
#[inline(always)]
fn ret(self, ctx: FunctionCtx) -> c_int {
match self {
Ok(o) => match ctx.return_mp(&o) {
Ok(_) => 0,
Err(e) => {
set_error!(ProcC, "{}", e);
-1
}
},
Err(e) => {
set_error!(ProcC, "{}", e);
-1
}
}
}
}
macro_rules! impl_return {
(impl $([ $( $tp:tt )* ])? for $t:ty) => {
impl $(< $($tp)* >)? Return for $t
where
Self: Serialize,
{
#[inline(always)]
fn ret(self, ctx: FunctionCtx) -> c_int {
unwrap_or_report_err!(ctx.return_mp(&self))
}
}
};
($( $t:ty )+) => {
$( impl_return!{ impl for $t } )+
}
}
impl_return! { impl[V] for Option<V> }
impl_return! { impl[V] for Vec<V> }
impl_return! { impl[V] for &'_ [V] }
impl_return! { impl[V, const N: usize] for [V; N] }
impl_return! { impl[K, V] for std::collections::HashMap<K, V> }
impl_return! { impl[K] for std::collections::HashSet<K> }
impl_return! { impl[K, V] for std::collections::BTreeMap<K, V> }
impl_return! { impl[K] for std::collections::BTreeSet<K> }
impl_return! {
bool
i8 u8 i16 u16 i32 u32 i64 u64 i128 u128 isize usize
f32 f64
String &'_ str
std::ffi::CString &'_ std::ffi::CStr
}
macro_rules! impl_return_for_tuple {
() => {};
($h:ident $($t:ident)*) => {
impl<$h, $($t),*> Return for ($h, $($t,)*)
where
Self: Serialize,
{
#[inline(always)]
fn ret(self, ctx: FunctionCtx) -> c_int {
unwrap_or_report_err!(ctx.return_mp(&self))
}
}
impl_return_for_tuple!{$($t)*}
}
}
impl_return_for_tuple! {A B C D E F G H I J K L M N O P Q}