dart::AtomicBitFieldContainer< T > Class Template Reference

#include <bitfield.h>

Inheritance diagram for dart::AtomicBitFieldContainer< T >:

Public Types
using	ContainedType = T

Public Member Functions
	AtomicBitFieldContainer ()
	operator T () const
T	operator= (T tags)
T	load (std::memory_order order) const
NO_SANITIZE_THREAD T	load_ignore_race () const
void	store (T value, std::memory_order order)
bool	compare_exchange_weak (T old_tags, T new_tags, std::memory_order order)
template<class TargetBitField , std::memory_order order = std::memory_order_relaxed>
TargetBitField::Type	Read () const
template<class TargetBitField , std::memory_order order = std::memory_order_relaxed>
void	UpdateBool (bool value)
template<class TargetBitField >
void	FetchOr (typename TargetBitField::Type value)
template<class TargetBitField >
void	Update (typename TargetBitField::Type value)
template<class TargetBitField >
void	UpdateUnsynchronized (typename TargetBitField::Type value)
template<class TargetBitField >
TargetBitField::Type	UpdateConditional (typename TargetBitField::Type value_to_be_set, typename TargetBitField::Type conditional_old_value)
template<class TargetBitField >
bool	TryAcquire ()
template<class TargetBitField >
bool	TryClear ()

Detailed Description

template<typename T>
class dart::AtomicBitFieldContainer< T >

Definition at line 23 of file bitfield.h.

Member Typedef Documentation

ContainedType

template<typename T >

using dart::AtomicBitFieldContainer< T >::ContainedType = T

Definition at line 28 of file bitfield.h.

Constructor & Destructor Documentation

AtomicBitFieldContainer()

template<typename T >

dart::AtomicBitFieldContainer< T >::AtomicBitFieldContainer ( )

inline

Definition at line 30 of file bitfield.h.

: field_(0) {}

Member Function Documentation

compare_exchange_weak()

template<typename T >

bool dart::AtomicBitFieldContainer< T >::compare_exchange_weak ( T  old_tags, T  new_tags, std::memory_order  order  )

inline

Definition at line 44 of file bitfield.h.

                                                                            {
    return field_.compare_exchange_weak(old_tags, new_tags, order);
  }

FetchOr()

template<typename T >

template<class TargetBitField >

void dart::AtomicBitFieldContainer< T >::FetchOr ( typename TargetBitField::Type  value )

inline

Definition at line 65 of file bitfield.h.

                                                  {
    field_.fetch_or(TargetBitField::encode(value), std::memory_order_relaxed);
  }

load()

template<typename T >

T dart::AtomicBitFieldContainer< T >::load ( std::memory_order  order ) const

inline

Definition at line 38 of file bitfield.h.

{ return field_.load(order); }

load_ignore_race()

template<typename T >

NO_SANITIZE_THREAD T dart::AtomicBitFieldContainer< T >::load_ignore_race ( ) const

inline

Definition at line 39 of file bitfield.h.

                                                {
    return *reinterpret_cast<const T*>(&field_);
  }

operator T()

template<typename T >

dart::AtomicBitFieldContainer< T >::operator T ( ) const

inline

Definition at line 32 of file bitfield.h.

{ return field_.load(std::memory_order_relaxed); }

operator=()

template<typename T >

T dart::AtomicBitFieldContainer< T >::operator= ( T  tags )

inline

Definition at line 33 of file bitfield.h.

                      {
    field_.store(tags, std::memory_order_relaxed);
    return tags;
  }

Read()

template<typename T >

template<class TargetBitField , std::memory_order order = std::memory_order_relaxed>

TargetBitField::Type dart::AtomicBitFieldContainer< T >::Read ( ) const

inline

Definition at line 50 of file bitfield.h.

                                           {
    return TargetBitField::decode(field_.load(order));
  }

store()

template<typename T >

void dart::AtomicBitFieldContainer< T >::store ( T  value, std::memory_order  order  )

inline

Definition at line 42 of file bitfield.h.

{ field_.store(value, order); }

TryAcquire()

template<typename T >

template<class TargetBitField >

bool dart::AtomicBitFieldContainer< T >::TryAcquire ( )

inline

Definition at line 107 of file bitfield.h.

                    {
    T mask = TargetBitField::encode(true);
    T old_field = field_.fetch_or(mask, std::memory_order_relaxed);
    return !TargetBitField::decode(old_field);
  }

TryClear()

template<typename T >

template<class TargetBitField >

bool dart::AtomicBitFieldContainer< T >::TryClear ( )

inline

Definition at line 114 of file bitfield.h.

                  {
    T mask = ~TargetBitField::encode(true);
    T old_field = field_.fetch_and(mask, std::memory_order_relaxed);
    return TargetBitField::decode(old_field);
  }

Update()

template<typename T >

template<class TargetBitField >

void dart::AtomicBitFieldContainer< T >::Update ( typename TargetBitField::Type  value )

inline

Definition at line 70 of file bitfield.h.

                                                 {
    T old_field = field_.load(std::memory_order_relaxed);
    T new_field;
    do {
      new_field = TargetBitField::update(value, old_field);
    } while (!field_.compare_exchange_weak(old_field, new_field,
                                           std::memory_order_relaxed));
  }

UpdateBool()

template<typename T >

template<class TargetBitField , std::memory_order order = std::memory_order_relaxed>

void dart::AtomicBitFieldContainer< T >::UpdateBool ( bool  value )

inline

Definition at line 56 of file bitfield.h.

                              {
    if (value) {
      field_.fetch_or(TargetBitField::encode(true), order);
    } else {
      field_.fetch_and(~TargetBitField::encode(true), order);
    }
  }

UpdateConditional()

template<typename T >

template<class TargetBitField >

TargetBitField::Type dart::AtomicBitFieldContainer< T >::UpdateConditional ( typename TargetBitField::Type  value_to_be_set, typename TargetBitField::Type  conditional_old_value  )

inline

Definition at line 87 of file bitfield.h.

                                                         {
    T old_field = field_.load(std::memory_order_relaxed);
    while (true) {
      // This operation is only performed if the condition is met.
      auto old_value = TargetBitField::decode(old_field);
      if (old_value != conditional_old_value) {
        return old_value;
      }
      T new_tags = TargetBitField::update(value_to_be_set, old_field);
      if (field_.compare_exchange_weak(old_field, new_tags,
                                       std::memory_order_relaxed)) {
        return value_to_be_set;
      }
      // [old_tags] was updated to it's current value.
    }
  }

UpdateUnsynchronized()

template<typename T >

template<class TargetBitField >

void dart::AtomicBitFieldContainer< T >::UpdateUnsynchronized ( typename TargetBitField::Type  value )

inline

Definition at line 80 of file bitfield.h.

                                                               {
    field_.store(
        TargetBitField::update(value, field_.load(std::memory_order_relaxed)),
        std::memory_order_relaxed);
  }

---

The documentation for this class was generated from the following file:

• third_party/dart-lang/sdk/runtime/vm/bitfield.h