vt::trace namespace

Classes

struct Event
struct EventClass
struct Log
struct Trace
A optional VT component that traces execution on multiple node for performance analysis.
class TraceContainers
template<typename EventT>
struct TraceEventSeqCompare
struct TraceLite
struct TraceProcessingTag
Tracking information for beginProcessing/endProcessing.
struct TraceRegistry
struct TraceScopedEvent
struct TraceScopedEventHash
struct TraceScopedNote
struct UserEventRegistry
struct vt_gzFile

Enums

enum class eTraceConstants: int32_t { InvalidTraceType = -1, Creation = 1, BeginProcessing = 2, EndProcessing = 3, Enqueue = 4, Dequeue = 5, BeginComputation = 6, EndComputation = 7, BeginInterrupt = 8, EndInterrupt = 9, MessageRecv = 10, BeginTrace = 11, EndTrace = 12, UserEvent = 13, BeginIdle = 14, EndIdle = 15, BeginPack = 16, EndPack = 17, BeginUnpack = 18, EndUnpack = 19, CreationBcast = 20, CreationMulticast = 21, BeginFunc = 22, EndFunc = 23, MemoryMalloc = 24, MemoryFree = 25, UserSupplied = 26, MemoryUsageCurrent = 27, UserSuppliedNote = 28, UserSuppliedBracketedNote = 29, EndPhase = 30, SurrogateBlock = 31, UserStat = 32, BeginUserEventPair = 98, EndUserEventPair = 99, UserEventPair = 100 }
enum eTraceEnvelopeTypes { NewChareMsg = 1, NewVChareMsg = 2, BocInitMsg = 3, ForChareMsg = 4, ForBocMsg = 5, ForVidMsg = 6, FillVidMsg = 7, DeleteVidMsg = 8, RODataMsg = 9, ROMsgMsg = 10, StartExitMsg = 11, ExitMsg = 12, ReqStatMsg = 13, StatMsg = 14, StatDoneMsg = 15, NodeBocInitMsg = 16, ForNodeBocMsg = 17, ArrayEltInitMsg = 18, ForArrayEltMsg = 19, ForIDedObjMsg = 20 }
enum eUserEventLayoutBits { Manu = 0, Root = eUserEventLayoutBits::Manu + manu_bits, Hash = eUserEventLayoutBits::Root + root_bits, Node = eUserEventLayoutBits::Hash + hash_bits, ID = eUserEventLayoutBits::Node + node_bits }

Typedefs

using TraceContainersType = TraceContainers
using LogType = Trace::LogType
using TraceEntryIDType = size_t
using TraceEntrySeqType = uint32_t
using TraceEventIDType = uint32_t
using TraceMsgLenType = size_t
using UserSpecEventIDType = int32_t
using UserEventIDType = int64_t
using TraceEventType = Event
using EventClassType = EventClass
using TraceContainerEventType = std::unordered_map<TraceEntryIDType, TraceEventType>
using TraceContainerEventClassType = std::unordered_map<TraceEntryIDType, EventClassType>

Functions

void reducedEventsHan(] const UserEventRegistry& gathered_user_events)
void insertNewUserEvent(] UserEventIDType event, ] std::string const& name)
void reducedEventsHan(const UserEventRegistry& gathered_user_events)
auto getEventId(std::string const& str) -> TraceEntryIDType
auto registerEventCollective(] std::string const& name) -> UserEventIDType
auto registerEventRooted(] std::string const& name) -> UserEventIDType
auto registerEventHashed(] std::string const& name) -> UserEventIDType
void addUserEvent(] UserEventIDType event)
void addUserNote(] std::string const& note)
void addUserData(] int32_t data)
void addUserNotePre(] std::string const& in_note, ] TraceEventIDType const in_event)
void addUserNoteEpi(] std::string const& in_note, ] TraceEventIDType const in_event)
auto registerEventCollective(std::string const& name) -> UserEventIDType
Register a user event collectively.
auto registerEventRooted(std::string const& name) -> UserEventIDType
Register a user event (rooted) on a single node.
auto registerEventHashed(std::string const& name) -> UserEventIDType
Idempotent registration of a user event on a single node.
void addUserEvent(UserEventIDType event)
Log a user event.
void addUserNote(std::string const& note)
Log a user note.
void addUserData(int32_t data)
Log user data as an integer.
void addUserNotePre(std::string const& note, TraceEventIDType const event)
Log the start for a bracketed user event with a note.
void addUserNoteEpi(std::string const& note, TraceEventIDType const event)
Log the end for a bracketed user event with a note.
auto operator+(UserEventRegistry r1, UserEventRegistry const& r2) -> UserEventRegistry
void insertNewUserEvent(UserEventIDType event, std::string const& name)

Variables

static const TraceEntryIDType no_trace_entry_id constexpr
static const TraceEntrySeqType no_trace_entry_seq constexpr
static const TraceEventIDType no_trace_event constexpr
static const BitCountType trace_event_num_bits constexpr
static const UserEventIDType no_user_event_id constexpr
static const NodeType designated_root_node constexpr
static EventClassType not_found_
static const BitCountType user_bits constexpr
static const BitCountType root_bits constexpr
static const BitCountType manu_bits constexpr
static const BitCountType hash_bits constexpr
static const BitCountType node_bits constexpr
static const BitCountType spec_bits constexpr

Enum documentation

enum class vt::trace::eTraceConstants: int32_t

Typedef documentation

typedef Trace::LogType vt::trace::LogType

using vt::trace::TraceEntryIDType = size_t

using vt::trace::TraceEntrySeqType = uint32_t

using vt::trace::TraceEventIDType = uint32_t

using vt::trace::TraceMsgLenType = size_t

using vt::trace::UserSpecEventIDType = int32_t

using vt::trace::UserEventIDType = int64_t

Function documentation

void vt::trace::reducedEventsHan(] const UserEventRegistry& gathered_user_events)

void vt::trace::insertNewUserEvent(] UserEventIDType event, ] std::string const& name)

void vt::trace::reducedEventsHan(const UserEventRegistry& gathered_user_events)

TraceEntryIDType vt::trace::getEventId(std::string const& str)

UserEventIDType vt::trace::registerEventCollective(] std::string const& name)

UserEventIDType vt::trace::registerEventRooted(] std::string const& name)

UserEventIDType vt::trace::registerEventHashed(] std::string const& name)

void vt::trace::addUserEvent(] UserEventIDType event)

void vt::trace::addUserNote(] std::string const& note)

void vt::trace::addUserData(] int32_t data)

void vt::trace::addUserNotePre(] std::string const& in_note, ] TraceEventIDType const in_event)

void vt::trace::addUserNoteEpi(] std::string const& in_note, ] TraceEventIDType const in_event)

UserEventIDType vt::trace::registerEventCollective(std::string const& name)

Register a user event collectively.

Parameters
name in the name of the event
Returns the user event ID for logging

UserEventIDType vt::trace::registerEventRooted(std::string const& name)

Register a user event (rooted) on a single node.

Parameters
name in the name of the event
Returns the user event ID for logging

UserEventIDType vt::trace::registerEventHashed(std::string const& name)

Idempotent registration of a user event on a single node.

Parameters
name in the name of the event
Returns the user event ID for logging

void vt::trace::addUserEvent(UserEventIDType event)

Log a user event.

Parameters
event in the event ID to log

void vt::trace::addUserNote(std::string const& note)

Log a user note.

Parameters
note in the note to log

void vt::trace::addUserData(int32_t data)

Log user data as an integer.

Parameters
data in the integer to log

void vt::trace::addUserNotePre(std::string const& note, TraceEventIDType const event)

Log the start for a bracketed user event with a note.

Parameters
note in the note
event in the pre-registered user event ID

void vt::trace::addUserNoteEpi(std::string const& note, TraceEventIDType const event)

Log the end for a bracketed user event with a note.

Parameters
note in the note
event in the pre-registered user event ID

void vt::trace::insertNewUserEvent(UserEventIDType event, std::string const& name)

Variable documentation

static const TraceEntryIDType vt::trace::no_trace_entry_id constexpr

static const TraceEntrySeqType vt::trace::no_trace_entry_seq constexpr

static const TraceEventIDType vt::trace::no_trace_event constexpr

static const BitCountType vt::trace::trace_event_num_bits constexpr

static const UserEventIDType vt::trace::no_user_event_id constexpr

static const NodeType vt::trace::designated_root_node constexpr

static const BitCountType vt::trace::user_bits constexpr

static const BitCountType vt::trace::root_bits constexpr

static const BitCountType vt::trace::manu_bits constexpr

static const BitCountType vt::trace::hash_bits constexpr

static const BitCountType vt::trace::node_bits constexpr

static const BitCountType vt::trace::spec_bits constexpr