Struct intel_tsx_rtm::HardwareMemoryTransactionManager

pub struct HardwareMemoryTransactionManager { /* fields omitted */ }

A simple wrapper to avoid constantly having to check for support of hardware memory transactions.

Methods

impl HardwareMemoryTransactionManager

fn new() -> Self

Creates a new instance.

fn execute_transaction_once_gracefully<TransactionCallback: FnMut() -> Result<(), u8>>(
    &self,
    transaction_callback: TransactionCallback
) -> Result<(), Option<HardwareMemoryTransactionResult>>

Gracefully executes the transaction once if TSX transaction are supported. If not supported, returns an Err with None. Use this when executing a transaction for the first time in a loop, then adjust to either TSX specific code (eg calling execute_transaction_once() which will panic if TSX is not supported) or a software transactional manager.

fn execute_transaction_once<TransactionCallback: FnMut() -> Result<(), u8>>(
    &self,
    transaction_callback: TransactionCallback
) -> Result<(), HardwareMemoryTransactionResult>

Executes the transaction once. Panics on non x86_64 platforms. Panics on x86_64 platforms which don't have transactions if running with debug assertions enabled. TransactionCallback returns a status code if it wants to explicitly abort.

fn cpu_supports_hardware_transactions(&self) -> bool

Does this x86_64 CPU have hardware transactions (TSX)? This will always be false for non-x86-64 platforms.

fn is_inside_a_running_transaction(&self) -> bool

Use this to detect if inside a transaction callback. Always false if TSX transactions are not supported (eg not x86-64, not a recent Intel Skylake CPU). Can be used to prevent nested transactions, and in code meant to run either as a transaction or in a fallback.

Trait Implementations

impl Debug for HardwareMemoryTransactionManager

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Copy for HardwareMemoryTransactionManager

impl Clone for HardwareMemoryTransactionManager

fn clone(&self) -> HardwareMemoryTransactionManager

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Ord for HardwareMemoryTransactionManager

fn cmp(&self, __arg_0: &HardwareMemoryTransactionManager) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl PartialOrd for HardwareMemoryTransactionManager

fn partial_cmp(
    &self,
    __arg_0: &HardwareMemoryTransactionManager
) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &HardwareMemoryTransactionManager) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &HardwareMemoryTransactionManager) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &HardwareMemoryTransactionManager) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &HardwareMemoryTransactionManager) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for HardwareMemoryTransactionManager

impl PartialEq for HardwareMemoryTransactionManager

fn eq(&self, __arg_0: &HardwareMemoryTransactionManager) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &HardwareMemoryTransactionManager) -> bool

This method tests for !=.

impl Hash for HardwareMemoryTransactionManager

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].