urcu2 0.1.3

//! Extra RCU types and functions.

pub(crate) mod builder;
pub(crate) mod callback;
pub(crate) mod cleanup;
pub(crate) mod context;
pub(crate) mod flavor;
pub(crate) mod guard;
pub(crate) mod poller;
pub(crate) mod reference;

pub use crate::rcu::callback::{RcuCall, RcuCallFn, RcuDefer, RcuDeferFn};
pub use crate::rcu::reference::RcuRefBox;

/// Returns an immutable RCU-protected pointer.
///
/// > It does not actually dereference the pointer, instead, it protects the pointer
/// > for later dereferencing. It also executes any needed memory-barrier instructions
/// > for a given CPU architecture.
///
/// #### Safety
///
/// * The thread must be inside a RCU critical section.
pub unsafe fn dereference<T>(pointer: *const T) -> *const T {
    // SAFETY: It is safe to cast the pointer to a void*.
    unsafe { urcu_sys::rcu_dereference(pointer as *mut std::ffi::c_void) as *const T }
}

/// Returns a mutable RCU-protected pointer.
///
/// > It does not actually dereference the pointer, instead, it protects the pointer
/// > for later dereferencing. It also executes any needed memory-barrier instructions
/// > for a given CPU architecture.
///
/// #### Safety
///
/// * The thread must be inside a RCU critical section.
pub unsafe fn dereference_mut<T>(pointer: *mut T) -> *mut T {
    // SAFETY: It is safe to cast the pointer to a void*.
    unsafe { urcu_sys::rcu_dereference(pointer as *mut std::ffi::c_void) as *mut T }
}

/// Defines flavor-specific types for `liburcu-bp`.
#[cfg(feature = "flavor-bp")]
pub mod bp {

    pub use crate::rcu::context::RcuContextBp;
    pub use crate::rcu::flavor::RcuFlavorBp;
    pub use crate::rcu::guard::RcuGuardBp;
    pub use crate::rcu::poller::RcuPollerBp;
}

/// Defines flavor-specific types for `liburcu-mb`.
#[cfg(feature = "flavor-mb")]
pub mod mb {
    pub use crate::rcu::context::RcuContextMb;
    pub use crate::rcu::flavor::RcuFlavorMb;
    pub use crate::rcu::guard::RcuGuardMb;
    pub use crate::rcu::poller::RcuPollerMb;
}

/// Defines flavor-specific types for `liburcu-memb`.
#[cfg(feature = "flavor-memb")]
pub mod memb {
    pub use crate::rcu::context::RcuContextMemb;
    pub use crate::rcu::flavor::RcuFlavorMemb;
    pub use crate::rcu::guard::RcuGuardMemb;
    pub use crate::rcu::poller::RcuPollerMemb;
}

/// Defines flavor-specific types for `liburcu-qsbr`.
#[cfg(feature = "flavor-qsbr")]
pub mod qsbr {
    pub use crate::rcu::context::RcuContextQsbr;
    pub use crate::rcu::flavor::RcuFlavorQsbr;
    pub use crate::rcu::guard::RcuGuardQsbr;
    pub use crate::rcu::poller::RcuPollerQsbr;
}

/// Defines flavor-specific types for the default flavor.
pub mod default {
    #[cfg(feature = "flavor-memb")]
    mod memb {
        /// Defines the default RCU flavor.
        pub type RcuDefaultFlavor = crate::rcu::flavor::RcuFlavorMemb;

        /// Defines the default RCU guard.
        pub type RcuDefaultGuard<'a> = crate::rcu::guard::RcuGuardMemb<'a>;

        /// Defines the default RCU poller.
        pub type RcuDefaultPoller<'a> = crate::rcu::poller::RcuPollerMemb<'a>;

        /// Defines the default RCU context.
        pub type RcuDefaultContext<const READ: bool = false, const DEFER: bool = false> =
            crate::rcu::context::RcuContextMemb<READ, DEFER>;
    }

    #[cfg(all(not(feature = "flavor-memb"), feature = "flavor-mb"))]
    mod mb {
        /// Defines the default RCU flavor.
        pub type RcuDefaultFlavor = crate::rcu::flavor::RcuFlavorMb;

        /// Defines the default RCU guard.
        pub type RcuDefaultGuard<'a> = crate::rcu::guard::RcuGuardMb<'a>;

        /// Defines the default RCU poller.
        pub type RcuDefaultPoller<'a> = crate::rcu::poller::RcuPollerMb<'a>;

        /// Defines the default RCU context.
        pub type RcuDefaultContext<const READ: bool = false, const DEFER: bool = false> =
            crate::rcu::context::RcuContextMb<READ, DEFER>;
    }

    #[cfg(all(
        not(feature = "flavor-memb"),
        not(feature = "flavor-mb"),
        feature = "flavor-bp"
    ))]
    mod bp {
        /// Defines the default RCU flavor.
        pub type RcuDefaultFlavor = crate::rcu::flavor::RcuFlavorBp;

        /// Defines the default RCU guard.
        pub type RcuDefaultGuard<'a> = crate::rcu::guard::RcuGuardBp<'a>;

        /// Defines the default RCU poller.
        pub type RcuDefaultPoller<'a> = crate::rcu::poller::RcuPollerBp<'a>;

        /// Defines the default RCU context.
        pub type RcuDefaultContext<const READ: bool = false, const DEFER: bool = false> =
            crate::rcu::context::RcuContextBp<READ, DEFER>;
    }

    #[cfg(all(
        not(feature = "flavor-memb"),
        not(feature = "flavor-mb"),
        not(feature = "flavor-bp"),
        feature = "flavor-qsbr"
    ))]
    mod qsbr {
        /// Defines the default RCU flavor.
        pub type RcuDefaultFlavor = crate::rcu::flavor::RcuFlavorQsbr;

        /// Defines the default RCU guard.
        pub type RcuDefaultGuard<'a> = crate::rcu::guard::RcuGuardQsbr<'a>;

        /// Defines the default RCU poller.
        pub type RcuDefaultPoller<'a> = crate::rcu::poller::RcuPollerQsbr<'a>;

        /// Defines the default RCU context.
        pub type RcuDefaultContext<const READ: bool = false, const DEFER: bool = false> =
            crate::rcu::context::RcuContextQsbr<READ, DEFER>;
    }

    #[cfg(feature = "flavor-memb")]
    pub use memb::*;

    #[cfg(all(not(feature = "flavor-memb"), feature = "flavor-mb"))]
    pub use mb::*;

    #[cfg(all(
        not(feature = "flavor-memb"),
        not(feature = "flavor-mb"),
        feature = "flavor-bp"
    ))]
    pub use bp::*;

    #[cfg(all(
        not(feature = "flavor-memb"),
        not(feature = "flavor-mb"),
        not(feature = "flavor-bp"),
        feature = "flavor-qsbr"
    ))]
    pub use qsbr::*;
}