Embers API

Class Hierarchy

• • Namespace embers
    • Namespace embers::amdgpu
      • Class GFXArch
      • Class HwRegIDs
      • Enum ArchFamily
      • Enum ChipID
    • Namespace embers::crypto
      • Struct hash256_t
    • Template Struct _Unique_if
    • Template Struct _Unique_if< T[] >
    • Template Struct _Unique_if< T[N] >
    • Struct Status
    • Template Class atomic
    • Template Class Barrier
    • Class GridBarrier
    • Template Class LockingQueue1P1C
      • Class LockingQueue1P1C::Contents
    • Template Class MonotonicCounter
    • Template Class NonLockingQueue
      • Class NonLockingQueue::Contents
      • Class NonLockingQueue::Entry
    • Template Class RWLock
    • Template Class SpinLock
    • Class StatusError
    • Template Class TicketLock
    • Template Class unique_ptr
    • Template Class unique_ptr< T[], D >
    • Template Class ValueOrError
    • Template Class ValueOrError< T & >
    • Class Xlator
      • Struct Xlator::Translation
      • Union Xlator::pagemap_entry
    • Enum MemoryScope
  • Namespace std
    • Template Struct hash< embers::unique_ptr< T, Deleter > >

File Hierarchy

• • Directory include
    • Directory embers
      • Directory amdgpu
        • File arch.h
        • File chipid.h
        • File hwid.h
        • File realtime.h
      • Directory crypto
        • Directory ethash
          • File ethash_consts.h
        • File helpers.h
      • Directory helpers
        • File almost_equal.h
        • File almost_equal_impl.h
        • File std_source_location.h
        • File xlator.h
      • Directory memory
        • Directory hip_detail
          • File memory.h
        • File memory_model.h
        • File unique_ptr.h
      • Directory primitives
        • File backoff.h
        • File barrier.h
        • File counters.h
        • File grid_barrier.h
        • File grid_barrier_impl.h
        • File locking_queue.h
        • File locking_queue_impl.h
        • File nonlocking_queue.h
        • File nonlocking_queue_impl.h
        • File rwlock.h
        • File spinlock.h
        • File spinlock_impl.h
        • File ticketlock.h
        • File ticketlock_impl.h
      • Directory rand
        • File fill_buffer_rand.h
        • File lcgparkmiller.h
        • File lcgparkmiller_impl.h
        • File rand.h
      • File atomic.h
      • File memory.h
      • File status.h

Full API

Namespaces

• Namespace embers
  • Namespaces
  • Classes
  • Enums
  • Functions
  • Typedefs
  • Unions
  • Variables

• Namespace embers::amdgpu
  • Classes
  • Enums
  • Functions

• Namespace embers::crypto
  • Namespaces
  • Classes
  • Variables

• Namespace embers::crypto::ethash
  • Variables

• Namespace embers::device

• Namespace embers::host

• Namespace embers::rand
  • Functions

• Namespace std
  • Classes
  • Functions

Classes and Structs

• Template Struct _Unique_if
  • Struct Documentation
    • _Unique_if
      • _Unique_if::_Single_object

• Template Struct _Unique_if< T[] >
  • Struct Documentation
    • _Unique_if
      • _Unique_if::_Unknown_bound

• Template Struct _Unique_if< T[N] >
  • Struct Documentation
    • _Unique_if
      • _Unique_if::_Known_bound

• Struct hash256_t
  • Struct Documentation
    • hash256_t
      • hash256_t::operator==()
      • hash256_t::operator!=()
      • hash256_t::operator^()
      • hash256_t::h8
      • hash256_t::h4
      • hash256_t::h2
      • hash256_t::h1
      • hash256_t::@1

• Struct Status
  • Struct Documentation
    • Status
      • Status::Code
        • Status::Code::SUCCESS
        • Status::Code::ERROR
        • Status::Code::NO_FREE_RESOURCE
        • Status::Code::OUT_OF_RANGE
        • Status::Code::UNEXPECTED_NULL_PTR
        • Status::Code::ALIGNMENT_ERROR
        • Status::Code::ACCESS_NOT_ALLOWED
        • Status::Code::ORDERING_ERR
        • Status::Code::GROUP_NOT_VALID
        • Status::Code::CODE_BUG
        • Status::Code::TIMEOUT
      • Status::Status()
      • Status::operator bool()
      • Status::operator==()
      • Status::operator!=()
      • Status::operator std::string()
      • Status::Message()
      • Status::StatusCode()
      • Status::RaiseIfError()
      • Status::code_
      • Status::msg_

• Struct Xlator::Translation
  • Nested Relationships
  • Struct Documentation
    • Translation
      • Translation::pa
      • Translation::ok

• Template Struct hash< embers::unique_ptr< T, Deleter > >
  • Struct Documentation
    • hash
      • hash::operator()()

• Class GFXArch
  • Class Documentation
    • GFXArch
      • GFXArch::GFXArch()
      • GFXArch::GFXArch()
      • GFXArch::operator std::string()
      • GFXArch::Family()

• Class HwRegIDs
  • Class Documentation
    • HwRegIDs
      • HwRegIDs::HwRegIDs()
      • HwRegIDs::HwRegIDs()
      • HwRegIDs::HwID()
      • HwRegIDs::HwID1()
      • HwRegIDs::HwID2()
      • HwRegIDs::GfxArch()
      • HwRegIDs::WaveID()
      • HwRegIDs::SimdID()
      • HwRegIDs::PipeID()
      • HwRegIDs::CuID()
      • HwRegIDs::ShID()
      • HwRegIDs::SeID()
      • HwRegIDs::DPRate()
      • HwRegIDs::TgID()
      • HwRegIDs::VmID()
      • HwRegIDs::QueueID()
      • HwRegIDs::StateID()
      • HwRegIDs::MeID()
      • HwRegIDs::WgID()
      • HwRegIDs::CompatLevelID()
      • HwRegIDs::WgpID()
      • HwRegIDs::SaID()
      • HwRegIDs::XccID()
      • HwRegIDs::operator std::string()
      • HwRegIDs::MAX_NUM_HWID_REGS

• Template Class atomic
  • Class Documentation
    • atomic
      • atomic::atomic()
      • atomic::atomic()
      • atomic::atomic()
      • atomic::operator=()
      • atomic::store()
      • atomic::load()
      • atomic::operator T()
      • atomic::exchange()
      • atomic::compare_exchange_strong()
      • atomic::compare_exchange_weak()
      • atomic::fetch_add()
      • atomic::fetch_inc()
      • atomic::fetch_sub()
      • atomic::fetch_and()
      • atomic::fetch_or()
      • atomic::fetch_xor()
      • atomic::operator+=()
      • atomic::operator-=()
      • atomic::operator&=()
      • atomic::operator|=()
      • atomic::operator^=()
      • atomic::operator++()
      • atomic::operator++()
      • atomic::operator--()
      • atomic::operator--()

• Template Class Barrier
  • Class Documentation
    • Barrier
      • Barrier::Barrier()
      • Barrier::Barrier()
      • Barrier::~Barrier()
      • Barrier::Sync()

• Class GridBarrier
  • Class Documentation
    • GridBarrier
      • GridBarrier::Counter
      • GridBarrier::GridBarrier()
      • GridBarrier::GridBarrier()
      • GridBarrier::AllocateCounters()
      • GridBarrier::AllocateCountersHost()

• Template Class LockingQueue1P1C
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • LockingQueue1P1C
      • LockingQueue1P1C::LockingQueue1P1C()
      • LockingQueue1P1C::~LockingQueue1P1C()
      • LockingQueue1P1C::LockingQueue1P1C()
      • LockingQueue1P1C::operator=()
      • LockingQueue1P1C::LockingQueue1P1C()
      • LockingQueue1P1C::LockingQueue1P1C()
      • LockingQueue1P1C::Enqueue()
      • LockingQueue1P1C::Dequeue()
      • LockingQueue1P1C::EnqueueMultiple()
      • LockingQueue1P1C::DequeueMultiple()
      • LockingQueue1P1C::EnqueueUpTo()
      • LockingQueue1P1C::DequeueUpTo()
      • LockingQueue1P1C::MakeQueueContents()
      • LockingQueue1P1C::MakeQueueContentsHost()
      • LockingQueue1P1C::Contents

• Class LockingQueue1P1C::Contents
  • Nested Relationships
  • Class Documentation
    • Contents

• Template Class MonotonicCounter
  • Class Documentation
    • MonotonicCounter
      • MonotonicCounter::counter_int_type
      • MonotonicCounter::MonotonicCounter()
      • MonotonicCounter::~MonotonicCounter()
      • MonotonicCounter::MonotonicCounter()
      • MonotonicCounter::operator=()
      • MonotonicCounter::MonotonicCounter()
      • MonotonicCounter::Value()
      • MonotonicCounter::Increment()
      • MonotonicCounter::Check()
      • MonotonicCounter::Appoint()
      • MonotonicCounter::Reset()

• Template Class NonLockingQueue
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • NonLockingQueue
      • NonLockingQueue::NonLockingQueue()
      • NonLockingQueue::~NonLockingQueue()
      • NonLockingQueue::NonLockingQueue()
      • NonLockingQueue::operator=()
      • NonLockingQueue::NonLockingQueue()
      • NonLockingQueue::NonLockingQueue()
      • NonLockingQueue::Enqueue()
      • NonLockingQueue::Dequeue()
      • NonLockingQueue::Reset()
      • NonLockingQueue::MakeQueueContents()
      • NonLockingQueue::MakeQueueContentsHost()
      • NonLockingQueue::Contents
      • NonLockingQueue::Entry
        • NonLockingQueue::Entry::Entry()

• Class NonLockingQueue::Contents
  • Nested Relationships
  • Class Documentation
    • Contents

• Class NonLockingQueue::Entry
  • Nested Relationships
  • Class Documentation
    • Entry
      • Entry::Entry()

• Template Class RWLock
  • Class Documentation
    • RWLock
      • RWLock::RWLock()
      • RWLock::~RWLock()
      • RWLock::RWLock()
      • RWLock::operator=()
      • RWLock::RWLock()
      • RWLock::AcquireShared()
      • RWLock::TryAcquireShared()
      • RWLock::ReleaseShared()
      • RWLock::Acquire()
      • RWLock::TryAcquire()
      • RWLock::Release()

• Template Class SpinLock
  • Class Documentation
    • SpinLock
      • SpinLock::SpinLock()
      • SpinLock::~SpinLock()
      • SpinLock::SpinLock()
      • SpinLock::operator=()
      • SpinLock::SpinLock()
      • SpinLock::Acquire()
      • SpinLock::Release()
      • SpinLock::TryAcquire()

• Class StatusError
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • StatusError
      • StatusError::StatusError()
      • StatusError::StatusError()
      • StatusError::what()
      • StatusError::GetStatus()

• Template Class TicketLock
  • Class Documentation
    • TicketLock
      • TicketLock::TicketLock()
      • TicketLock::~TicketLock()
      • TicketLock::TicketLock()
      • TicketLock::operator=()
      • TicketLock::TicketLock()
      • TicketLock::Acquire()
      • TicketLock::Release()

• Template Class unique_ptr
  • Class Documentation
    • unique_ptr
      • unique_ptr::pointer
      • unique_ptr::element_type
      • unique_ptr::deleter_type
      • unique_ptr::unique_ptr()
      • unique_ptr::unique_ptr()
      • unique_ptr::unique_ptr()
      • unique_ptr::unique_ptr()
      • unique_ptr::unique_ptr()
      • unique_ptr::swap()
      • unique_ptr::unique_ptr()
      • unique_ptr::unique_ptr()
      • unique_ptr::operator=()
      • unique_ptr::operator=()
      • unique_ptr::operator=()
      • unique_ptr::release()
      • unique_ptr::reset()
      • unique_ptr::get()
      • unique_ptr::get_deleter()
      • unique_ptr::get_deleter()
      • unique_ptr::operator bool()
      • unique_ptr::operator*()
      • unique_ptr::operator->()

• Template Class unique_ptr< T[], D >
  • Class Documentation
    • unique_ptr
      • unique_ptr::pointer
      • unique_ptr::element_type
      • unique_ptr::deleter_type
      • unique_ptr::unique_ptr()
      • unique_ptr::unique_ptr()
      • unique_ptr::unique_ptr()
      • unique_ptr::unique_ptr()
      • unique_ptr::unique_ptr()
      • unique_ptr::swap()
      • unique_ptr::unique_ptr()
      • unique_ptr::operator[]()
      • unique_ptr::operator=()
      • unique_ptr::operator=()
      • unique_ptr::operator=()
      • unique_ptr::release()
      • unique_ptr::reset()
      • unique_ptr::get()
      • unique_ptr::get_deleter()
      • unique_ptr::get_deleter()
      • unique_ptr::operator bool()
      • unique_ptr::operator*()
      • unique_ptr::operator->()

• Template Class ValueOrError
  • Class Documentation
    • ValueOrError
      • ValueOrError::ValueOrError()
      • ValueOrError::ValueOrError()
      • ValueOrError::Err()
      • ValueOrError::operator*()
      • ValueOrError::operator*()
      • ValueOrError::operator bool()

• Template Class ValueOrError< T & >
  • Class Documentation
    • ValueOrError
      • ValueOrError::ValueOrError()
      • ValueOrError::ValueOrError()
      • ValueOrError::Err()
      • ValueOrError::operator*()
      • ValueOrError::operator*()
      • ValueOrError::operator bool()

• Class Xlator
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • Xlator
      • Xlator::Xlator()
      • Xlator::~Xlator()
      • Xlator::ClearCache()
      • Xlator::CanTranslate()
      • Xlator::VAtoPA()

Enums

• Enum ArchFamily
  • Enum Documentation
    • ArchFamily
      • ArchFamily::INVALID
      • ArchFamily::GFX9
      • ArchFamily::GFX940Plus
      • ArchFamily::GFX10Plus
      • ArchFamily::GFX11Plus

• Enum ChipID
  • Enum Documentation
    • ChipID
      • ChipID::NAVI10_W5700X
      • ChipID::NAVI10_W5700
      • ChipID::NAVI10_5700
      • ChipID::NAVI10_5600
      • ChipID::NAVI21_V620
      • ChipID::NAVI21_W6900X
      • ChipID::NAVI21_W6800
      • ChipID::NAVI21_6950XT
      • ChipID::NAVI21_W6800X
      • ChipID::NAVI21_V620MX
      • ChipID::NAVI21_6900XT
      • ChipID::NAVI21_6800XT
      • ChipID::NAVI31_W7900
      • ChipID::NAVI31_7900XT
      • ChipID::NAVI31_W7800
      • ChipID::VEGA20_INSTINCT
      • ChipID::VEGA20_MI50
      • ChipID::VEGA20
      • ChipID::VEGA20_VEGAII
      • ChipID::VEGA20_VII
      • ChipID::MI100_0
      • ChipID::MI100_1
      • ChipID::MI100_2
      • ChipID::MI210
      • ChipID::MI250X
      • ChipID::MI250X_MI250
      • ChipID::MI300X
      • ChipID::MI300X_SRIOV
      • ChipID::MI300X_HF
      • ChipID::MI300X_HF_SRIOV
      • ChipID::MI300A
      • ChipID::MI300A_SRIOV
      • ChipID::MI308X
      • ChipID::MI308X_SRIOV
      • ChipID::MI325X
      • ChipID::MI325X_SRIOV

• Enum MemoryScope
  • Enum Documentation
    • MemoryScope
      • MemoryScope::SINGLE_THREAD
      • MemoryScope::WAVEFRONT
      • MemoryScope::WORKGROUP
      • MemoryScope::AGENT
      • MemoryScope::SYSTEM

Unions

• Union Xlator::pagemap_entry
  • Nested Relationships
  • Union Documentation
    • pagemap_entry
      • pagemap_entry::val
      • pagemap_entry::pfn
      • pagemap_entry::other_bits
      • pagemap_entry::present
      • pagemap_entry::@3

Functions

• Template Function embers::AlmostEqualAbsolute
  • Function Documentation
    • AlmostEqualAbsolute()

• Template Function embers::AlmostEqualRelative
  • Function Documentation
    • AlmostEqualRelative()

• Function embers::amdgpu::get_realtime
  • Function Documentation
    • get_realtime()

• Function embers::amdgpu::IsMI100
  • Function Documentation
    • IsMI100()

• Function embers::amdgpu::IsMI200
  • Function Documentation
    • IsMI200()

• Function embers::amdgpu::IsMI300
  • Function Documentation
    • IsMI300()

• Function embers::amdgpu::IsMI300A
  • Function Documentation
    • IsMI300A()

• Function embers::amdgpu::IsMI300X
  • Function Documentation
    • IsMI300X()

• Function embers::amdgpu::IsMI300XHF
  • Function Documentation
    • IsMI300XHF()

• Function embers::amdgpu::IsMI308X
  • Function Documentation
    • IsMI308X()

• Function embers::amdgpu::IsMI325X
  • Function Documentation
    • IsMI325X()

• Function embers::amdgpu::IsMI3XX
  • Function Documentation
    • IsMI3XX()

• Function embers::amdgpu::IsNAVI10
  • Function Documentation
    • IsNAVI10()

• Function embers::amdgpu::IsNAVI21
  • Function Documentation
    • IsNAVI21()

• Function embers::amdgpu::IsNAVI31
  • Function Documentation
    • IsNAVI31()

• Function embers::amdgpu::IsVEGA20
  • Function Documentation
    • IsVEGA20()

• Function embers::backoff
  • Function Documentation
    • backoff()

• Function embers::memory_scope_as_int
  • Function Documentation
    • memory_scope_as_int()

• Template Function embers::MemoryScopeToChar
  • Function Documentation
    • MemoryScopeToChar()

• Specialized Template Function embers::MemoryScopeToChar< MemoryScope::AGENT >
  • Function Documentation
    • MemoryScopeToChar()

• Specialized Template Function embers::MemoryScopeToChar< MemoryScope::SINGLE_THREAD >
  • Function Documentation
    • MemoryScopeToChar()

• Specialized Template Function embers::MemoryScopeToChar< MemoryScope::SYSTEM >
  • Function Documentation
    • MemoryScopeToChar()

• Specialized Template Function embers::MemoryScopeToChar< MemoryScope::WAVEFRONT >
  • Function Documentation
    • MemoryScopeToChar()

• Specialized Template Function embers::MemoryScopeToChar< MemoryScope::WORKGROUP >
  • Function Documentation
    • MemoryScopeToChar()

• Template Function embers::operator<(const unique_ptr<T1, D1>&, const unique_ptr<T2, D2>&)
  • Function Documentation

• Template Function embers::operator<(const unique_ptr<T, D>&, std::nullptr_t)
  • Function Documentation

• Template Function embers::operator<(std::nullptr_t, const unique_ptr<T, D>&)
  • Function Documentation

• Template Function embers::operator<(const unique_ptr<T1, D1>&, const unique_ptr<T2, D2>&)
  • Function Documentation

• Template Function embers::operator<(const unique_ptr<T, D>&, std::nullptr_t)
  • Function Documentation

• Template Function embers::operator<(std::nullptr_t, const unique_ptr<T, D>&)
  • Function Documentation

• Template Function embers::operator<=(const unique_ptr<T1, D1>&, const unique_ptr<T2, D2>&)
  • Function Documentation

• Template Function embers::operator<=(const unique_ptr<T, D>&, std::nullptr_t)
  • Function Documentation

• Template Function embers::operator<=(std::nullptr_t, const unique_ptr<T, D>&)
  • Function Documentation

• Template Function embers::operator<=(const unique_ptr<T1, D1>&, const unique_ptr<T2, D2>&)
  • Function Documentation

• Template Function embers::operator<=(const unique_ptr<T, D>&, std::nullptr_t)
  • Function Documentation

• Template Function embers::operator<=(std::nullptr_t, const unique_ptr<T, D>&)
  • Function Documentation

• Template Function embers::operator==(const unique_ptr<T1, D1>&, const unique_ptr<T2, D2>&)
  • Function Documentation

• Template Function embers::operator==(const unique_ptr<T, D>&, std::nullptr_t)
  • Function Documentation

• Template Function embers::operator==(const unique_ptr<T1, D1>&, const unique_ptr<T2, D2>&)
  • Function Documentation

• Template Function embers::operator==(const unique_ptr<T, D>&, std::nullptr_t)
  • Function Documentation

• Template Function embers::operator>(const unique_ptr<T1, D1>&, const unique_ptr<T2, D2>&)
  • Function Documentation

• Template Function embers::operator>(const unique_ptr<T, D>&, std::nullptr_t)
  • Function Documentation

• Template Function embers::operator>(std::nullptr_t, const unique_ptr<T, D>&)
  • Function Documentation

• Template Function embers::operator>(const unique_ptr<T1, D1>&, const unique_ptr<T2, D2>&)
  • Function Documentation

• Template Function embers::operator>(const unique_ptr<T, D>&, std::nullptr_t)
  • Function Documentation

• Template Function embers::operator>(std::nullptr_t, const unique_ptr<T, D>&)
  • Function Documentation

• Template Function embers::operator>=(const unique_ptr<T1, D1>&, const unique_ptr<T2, D2>&)
  • Function Documentation

• Template Function embers::operator>=(const unique_ptr<T, D>&, std::nullptr_t)
  • Function Documentation

• Template Function embers::operator>=(std::nullptr_t, const unique_ptr<T, D>&)
  • Function Documentation

• Template Function embers::operator>=(const unique_ptr<T1, D1>&, const unique_ptr<T2, D2>&)
  • Function Documentation

• Template Function embers::operator>=(const unique_ptr<T, D>&, std::nullptr_t)
  • Function Documentation

• Template Function embers::operator>=(std::nullptr_t, const unique_ptr<T, D>&)
  • Function Documentation

• Template Function embers::rand::FillBufferRandom(T *, size_t, xorshift128p_state *, T, T)
  • Function Documentation

• Template Function embers::rand::FillBufferRandom(T *, size_t, xorshift128p_state *, T, T)
  • Function Documentation

• Function embers::rand::lcg_parkmiller
  • Function Documentation
    • lcg_parkmiller()

• Template Function embers::rand::rand
  • Function Documentation
    • rand()

• Function embers::StatusFromHipError
  • Function Documentation
    • StatusFromHipError()

• Function embers::std_memory_order_to_int
  • Function Documentation
    • std_memory_order_to_int()

• Template Function std::swap
  • Function Documentation
    • swap()

Variables

• Variable embers::crypto::ethash::EthashCacheSizes
  • Variable Documentation
    • EthashCacheSizes

• Variable embers::crypto::ethash::EthashDAGSizes
  • Variable Documentation
    • EthashDAGSizes

• Variable embers::crypto::HASH256_H1_NUM_INDEXES
  • Variable Documentation
    • HASH256_H1_NUM_INDEXES

• Variable embers::crypto::HASH256_H2_NUM_INDEXES
  • Variable Documentation
    • HASH256_H2_NUM_INDEXES

• Variable embers::crypto::HASH256_H4_NUM_INDEXES
  • Variable Documentation
    • HASH256_H4_NUM_INDEXES

• Variable embers::crypto::HASH256_H8_NUM_INDEXES
  • Variable Documentation
    • HASH256_H8_NUM_INDEXES

• Variable embers::HAVE_STD_SOURCE_LOCATION
  • Variable Documentation
    • HAVE_STD_SOURCE_LOCATION

Defines

• Define _EMBERS_HAVE_STD_EXP_SOURCE_LOCATION
  • Define Documentation

• Define _EMBERS_HAVE_STD_SOURCE_LOCATION
  • Define Documentation

Typedefs

• Typedef embers::std_source_location
  • Typedef Documentation
    • std_source_location