Realm
A distributed, event-based tasking library
Loading...
Searching...
No Matches
Realm::ID Class Reference

#include <id.h>

Collaboration diagram for Realm::ID:
[legend]

Classes

struct  FMT_Event
struct  FMT_Barrier
struct  FMT_Reservation
struct  FMT_Memory
struct  FMT_IB_Memory
struct  FMT_Instance
struct  FMT_Processor
struct  FMT_ProcGroup
struct  FMT_Sparsity
struct  FMT_CompQueue
struct  FMT_Subgraph

Public Types

enum  ID_Types {
  ID_SPECIAL , ID_UNUSED_1 , ID_EVENT , ID_BARRIER ,
  ID_LOCK , ID_UNUSED_5 , ID_MEMORY , ID_IB_MEMORY ,
  ID_PROCESSOR , ID_PROCGROUP , ID_INDEXSPACE , ID_SPARSITY ,
  ID_SUBGRAPH , ID_UNUSED_13 , ID_INSTANCE , ID_UNUSED_15
}
typedef ::realm_id_t IDType

Public Member Functions

bool is_null (void) const
bool is_event (void) const
bool is_barrier (void) const
bool is_reservation (void) const
bool is_memory (void) const
bool is_ib_memory (void) const
bool is_instance (void) const
bool is_processor (void) const
bool is_procgroup (void) const
bool is_sparsity (void) const
bool is_compqueue (void) const
bool is_subgraph (void) const
 ID (void)
 ID (IDType _id)
 ID (const ID &copy_from)
ID & operator= (const ID &copy_from)
template<class T>
 ID (T thing_to_get_id_from)
bool operator== (const ID &rhs) const
bool operator!= (const ID &rhs) const
template<class T>
T convert (void) const

Static Public Member Functions

static ID make_event (unsigned creator_node, unsigned gen_event_idx, unsigned generation)
static ID make_barrier (unsigned creator_node, unsigned barrier_idx, unsigned generation)
static ID make_reservation (unsigned creator_node, unsigned rsrv_idx)
static ID make_memory (unsigned owner_node, unsigned mem_idx)
static ID make_ib_memory (unsigned owner_node, unsigned mem_idx)
static ID make_instance (unsigned owner_node, unsigned creator_node, unsigned mem_idx, unsigned inst_idx)
static ID make_processor (unsigned owner_node, unsigned proc_idx)
static ID make_procgroup (unsigned owner_node, unsigned creator_node, unsigned pgroup_idx)
static ID make_sparsity (unsigned owner_node, unsigned creator_node, unsigned sparsity_idx)
static ID make_compqueue (unsigned owner_node, unsigned cq_idx)
static ID make_subgraph (unsigned owner_node, unsigned creator_node, unsigned subgraph_idx)

Public Attributes

bitpack< IDType > id

Static Public Attributes

static const int NODE_FIELD_WIDTH = 16
static const unsigned MAX_NODE_ID
static const int EVENT_GENERATION_WIDTH
static const int MEMORY_INDEX_WIDTH = 8
static const int INSTANCE_INDEX_WIDTH = 22
static const IDType ID_NULL = 0

Friends

std::ostream & operator<< (std::ostream &os, ID id)

Member Typedef Documentation

◆ IDType

Member Enumeration Documentation

◆ ID_Types

Enumerator
ID_SPECIAL 
ID_UNUSED_1 
ID_EVENT 
ID_BARRIER 
ID_LOCK 
ID_UNUSED_5 
ID_MEMORY 
ID_IB_MEMORY 
ID_PROCESSOR 
ID_PROCGROUP 
ID_INDEXSPACE 
ID_SPARSITY 
ID_SUBGRAPH 
ID_UNUSED_13 
ID_INSTANCE 
ID_UNUSED_15 

Constructor & Destructor Documentation

◆ ID() [1/4]

Realm::ID::ID ( void )

◆ ID() [2/4]

Realm::ID::ID ( IDType _id)

◆ ID() [3/4]

Realm::ID::ID ( const ID & copy_from)

◆ ID() [4/4]

template<class T>
Realm::ID::ID ( T thing_to_get_id_from)

Member Function Documentation

◆ convert()

template<class T>
T Realm::ID::convert ( void ) const

◆ is_barrier()

bool Realm::ID::is_barrier ( void ) const

◆ is_compqueue()

bool Realm::ID::is_compqueue ( void ) const

◆ is_event()

bool Realm::ID::is_event ( void ) const

◆ is_ib_memory()

bool Realm::ID::is_ib_memory ( void ) const

◆ is_instance()

bool Realm::ID::is_instance ( void ) const

◆ is_memory()

bool Realm::ID::is_memory ( void ) const

◆ is_null()

bool Realm::ID::is_null ( void ) const

◆ is_processor()

bool Realm::ID::is_processor ( void ) const

◆ is_procgroup()

bool Realm::ID::is_procgroup ( void ) const

◆ is_reservation()

bool Realm::ID::is_reservation ( void ) const

◆ is_sparsity()

bool Realm::ID::is_sparsity ( void ) const

◆ is_subgraph()

bool Realm::ID::is_subgraph ( void ) const

◆ make_barrier()

ID Realm::ID::make_barrier ( unsigned creator_node,
unsigned barrier_idx,
unsigned generation )
static

◆ make_compqueue()

ID Realm::ID::make_compqueue ( unsigned owner_node,
unsigned cq_idx )
static

◆ make_event()

ID Realm::ID::make_event ( unsigned creator_node,
unsigned gen_event_idx,
unsigned generation )
static

◆ make_ib_memory()

ID Realm::ID::make_ib_memory ( unsigned owner_node,
unsigned mem_idx )
static

◆ make_instance()

ID Realm::ID::make_instance ( unsigned owner_node,
unsigned creator_node,
unsigned mem_idx,
unsigned inst_idx )
static

◆ make_memory()

ID Realm::ID::make_memory ( unsigned owner_node,
unsigned mem_idx )
static

◆ make_processor()

ID Realm::ID::make_processor ( unsigned owner_node,
unsigned proc_idx )
static

◆ make_procgroup()

ID Realm::ID::make_procgroup ( unsigned owner_node,
unsigned creator_node,
unsigned pgroup_idx )
static

◆ make_reservation()

ID Realm::ID::make_reservation ( unsigned creator_node,
unsigned rsrv_idx )
static

◆ make_sparsity()

ID Realm::ID::make_sparsity ( unsigned owner_node,
unsigned creator_node,
unsigned sparsity_idx )
static

◆ make_subgraph()

ID Realm::ID::make_subgraph ( unsigned owner_node,
unsigned creator_node,
unsigned subgraph_idx )
static

◆ operator!=()

bool Realm::ID::operator!= ( const ID & rhs) const

◆ operator=()

ID & Realm::ID::operator= ( const ID & copy_from)

◆ operator==()

bool Realm::ID::operator== ( const ID & rhs) const

◆ operator<<

std::ostream & operator<< ( std::ostream & os,
ID id )
friend

Member Data Documentation

◆ EVENT_GENERATION_WIDTH

const int Realm::ID::EVENT_GENERATION_WIDTH
static
Initial value:
=
#define REALM_EVENT_GENERATION_BITS
Definition realm_config.h:30

◆ id

bitpack<IDType> Realm::ID::id

◆ ID_NULL

const IDType Realm::ID::ID_NULL = 0
static

◆ INSTANCE_INDEX_WIDTH

const int Realm::ID::INSTANCE_INDEX_WIDTH = 22
static

◆ MAX_NODE_ID

const unsigned Realm::ID::MAX_NODE_ID
static
Initial value:
=
(1U << NODE_FIELD_WIDTH) - 2
static const int NODE_FIELD_WIDTH
Definition id.h:53

◆ MEMORY_INDEX_WIDTH

const int Realm::ID::MEMORY_INDEX_WIDTH = 8
static

◆ NODE_FIELD_WIDTH

const int Realm::ID::NODE_FIELD_WIDTH = 16
static

The documentation for this class was generated from the following file:
  • /home/runner/work/realm/realm/realm-src/src/realm/id.h