LLVM OpenMP 22.0.0git
AssertMacros.h File Reference

Provides macros to be used in unit tests for OMPT events. More...

Go to the source code of this file.

Macros

#define OMPTEST_EXCLUDED_EVENT   omptest::ObserveState::Never
#define OMPTEST_REQUIRED_EVENT   omptest::ObserveState::Always
#define OMPT_GENERATE_EVENTS(NumberOfCopies, EventMacro)
 ASSERT MACROS TO BE USED BY THE USER.
#define OMPT_ASSERT_SET_EVENT(Name, Group, EventTy, ...)
#define OMPT_ASSERT_SET(EventTy, ...)
#define OMPT_ASSERT_SET_GROUPED(Group, EventTy, ...)
#define OMPT_ASSERT_SET_NAMED(Name, EventTy, ...)
#define OMPT_ASSERT_SET_EVENT_NOT(Name, Group, EventTy, ...)
#define OMPT_ASSERT_SET_NOT(EventTy, ...)
#define OMPT_ASSERT_SET_GROUPED_NOT(Group, EventTy, ...)
#define OMPT_ASSERT_SET_NAMED_NOT(Name, EventTy, ...)
#define OMPT_ASSERT_SEQUENCE_EVENT(Name, Group, EventTy, ...)
#define OMPT_ASSERT_SEQUENCE(EventTy, ...)
#define OMPT_ASSERT_SEQUENCE_GROUPED(Group, EventTy, ...)
#define OMPT_ASSERT_SEQUENCE_NAMED(Name, EventTy, ...)
#define OMPT_ASSERT_SEQUENCE_EVENT_NOT(Name, Group, EventTy, ...)
#define OMPT_ASSERT_SEQUENCE_NOT(EventTy, ...)
#define OMPT_ASSERT_SEQUENCE_GROUPED_NOT(Group, EventTy, ...)
#define OMPT_ASSERT_SEQUENCE_NAMED_NOT(Name, EventTy, ...)
#define OMPT_ASSERT_SEQUENCE_SUSPEND()
#define OMPT_ASSERT_SEQUENCE_ONLY(EventTy, ...)
#define OMPT_ASSERT_SEQUENCE_GROUPED_ONLY(Group, EventTy, ...)
#define OMPT_ASSERT_SEQUENCE_NAMED_ONLY(Name, EventTy, ...)
#define OMPT_ASSERTER_MODE_STRICT(Asserter)
#define OMPT_ASSERTER_MODE_RELAXED(Asserter)
#define OMPT_ASSERT_SEQUENCE_MODE_STRICT()
#define OMPT_ASSERT_SEQUENCE_MODE_RELAXED()
#define OMPT_ASSERT_SET_MODE_STRICT()
#define OMPT_ASSERT_SET_MODE_RELAXED()
#define OMPT_ASSERTER_DISABLE(Asserter)
#define OMPT_ASSERTER_ENABLE(Asserter)
#define OMPT_ASSERT_SET_DISABLE()
#define OMPT_ASSERT_SET_ENABLE()
#define OMPT_ASSERT_SEQUENCE_DISABLE()
#define OMPT_ASSERT_SEQUENCE_ENABLE()
#define OMPT_REPORT_EVENT_DISABLE()
#define OMPT_REPORT_EVENT_ENABLE()
#define OMPT_ASSERTER_PERMIT_EVENT(Asserter, EventTy)
#define OMPT_ASSERTER_SUPPRESS_EVENT(Asserter, EventTy)
#define OMPT_PERMIT_EVENT(EventTy)
#define OMPT_SUPPRESS_EVENT(EventTy)
#define OMPT_ASSERTER_LOG_LEVEL(Asserter, LogLevel)
#define OMPT_ASSERTER_LOG_FORMATTED(Asserter, FormatLog)
#define OMPT_ASSERT_SYNC_POINT(SyncPointName)

Detailed Description

Provides macros to be used in unit tests for OMPT events.

Definition in file AssertMacros.h.

Macro Definition Documentation

◆ OMPT_ASSERT_SEQUENCE

#define OMPT_ASSERT_SEQUENCE ( EventTy,
... )
Value:
OMPT_ASSERT_SEQUENCE_EVENT("", "", EventTy, __VA_ARGS__)
#define OMPT_ASSERT_SEQUENCE_EVENT(Name, Group, EventTy,...)

Definition at line 54 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_DISABLE

#define OMPT_ASSERT_SEQUENCE_DISABLE ( )
Value:
OMPT_ASSERTER_DISABLE(SequenceAsserter)
#define OMPT_ASSERTER_DISABLE(Asserter)

Definition at line 104 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_ENABLE

#define OMPT_ASSERT_SEQUENCE_ENABLE ( )
Value:
OMPT_ASSERTER_ENABLE(SequenceAsserter)
#define OMPT_ASSERTER_ENABLE(Asserter)

Definition at line 105 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_EVENT

#define OMPT_ASSERT_SEQUENCE_EVENT ( Name,
Group,
EventTy,
... )
Value:
SequenceAsserter->insert(OmptAssertEvent::EventTy( \
Name, Group, OMPTEST_REQUIRED_EVENT, __VA_ARGS__));
#define OMPTEST_REQUIRED_EVENT

Definition at line 51 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_EVENT_NOT

#define OMPT_ASSERT_SEQUENCE_EVENT_NOT ( Name,
Group,
EventTy,
... )
Value:
SequenceAsserter->insert(OmptAssertEvent::EventTy( \
Name, Group, OMPTEST_EXCLUDED_EVENT, __VA_ARGS__));
#define OMPTEST_EXCLUDED_EVENT

Definition at line 61 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_GROUPED

#define OMPT_ASSERT_SEQUENCE_GROUPED ( Group,
EventTy,
... )
Value:
OMPT_ASSERT_SEQUENCE_EVENT("", Group, EventTy, __VA_ARGS__)

Definition at line 56 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_GROUPED_NOT

#define OMPT_ASSERT_SEQUENCE_GROUPED_NOT ( Group,
EventTy,
... )
Value:
OMPT_ASSERT_SEQUENCE_EVENT_NOT("", Group, EventTy, __VA_ARGS__)
#define OMPT_ASSERT_SEQUENCE_EVENT_NOT(Name, Group, EventTy,...)

Definition at line 66 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_GROUPED_ONLY

#define OMPT_ASSERT_SEQUENCE_GROUPED_ONLY ( Group,
EventTy,
... )
Value:
OMPT_ASSERT_SEQUENCE_EVENT("", Group, EventTy, __VA_ARGS__) \
OMPT_ASSERT_SEQUENCE_SUSPEND()
#define OMPT_ASSERT_SEQUENCE_SUSPEND()

Definition at line 79 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_MODE_RELAXED

#define OMPT_ASSERT_SEQUENCE_MODE_RELAXED ( )
Value:
OMPT_ASSERTER_MODE_RELAXED(SequenceAsserter)
#define OMPT_ASSERTER_MODE_RELAXED(Asserter)

Definition at line 94 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_MODE_STRICT

#define OMPT_ASSERT_SEQUENCE_MODE_STRICT ( )
Value:
OMPT_ASSERTER_MODE_STRICT(SequenceAsserter)
#define OMPT_ASSERTER_MODE_STRICT(Asserter)

Definition at line 92 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_NAMED

#define OMPT_ASSERT_SEQUENCE_NAMED ( Name,
EventTy,
... )
Value:
OMPT_ASSERT_SEQUENCE_EVENT(Name, "", EventTy, __VA_ARGS__)

Definition at line 58 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_NAMED_NOT

#define OMPT_ASSERT_SEQUENCE_NAMED_NOT ( Name,
EventTy,
... )
Value:
OMPT_ASSERT_SEQUENCE_EVENT_NOT(Name, "", EventTy, __VA_ARGS__)

Definition at line 68 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_NAMED_ONLY

#define OMPT_ASSERT_SEQUENCE_NAMED_ONLY ( Name,
EventTy,
... )
Value:
OMPT_ASSERT_SEQUENCE_EVENT(Name, "", EventTy, __VA_ARGS__) \
OMPT_ASSERT_SEQUENCE_SUSPEND()

Definition at line 83 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_NOT

#define OMPT_ASSERT_SEQUENCE_NOT ( EventTy,
... )
Value:
OMPT_ASSERT_SEQUENCE_EVENT_NOT("", "", EventTy, __VA_ARGS__)

Definition at line 64 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_ONLY

#define OMPT_ASSERT_SEQUENCE_ONLY ( EventTy,
... )
Value:
OMPT_ASSERT_SEQUENCE_EVENT("", "", EventTy, __VA_ARGS__) \
OMPT_ASSERT_SEQUENCE_SUSPEND()

Definition at line 75 of file AssertMacros.h.

◆ OMPT_ASSERT_SEQUENCE_SUSPEND

#define OMPT_ASSERT_SEQUENCE_SUSPEND ( )
Value:
SequenceAsserter->insert( \
OmptAssertEvent::AssertionSuspend("", "", OMPTEST_EXCLUDED_EVENT));

Definition at line 72 of file AssertMacros.h.

◆ OMPT_ASSERT_SET

#define OMPT_ASSERT_SET ( EventTy,
... )
Value:
OMPT_ASSERT_SET_EVENT("", "", EventTy, __VA_ARGS__)
#define OMPT_ASSERT_SET_EVENT(Name, Group, EventTy,...)

Definition at line 32 of file AssertMacros.h.

◆ OMPT_ASSERT_SET_DISABLE

#define OMPT_ASSERT_SET_DISABLE ( )
Value:

Definition at line 102 of file AssertMacros.h.

◆ OMPT_ASSERT_SET_ENABLE

#define OMPT_ASSERT_SET_ENABLE ( )
Value:

Definition at line 103 of file AssertMacros.h.

◆ OMPT_ASSERT_SET_EVENT

#define OMPT_ASSERT_SET_EVENT ( Name,
Group,
EventTy,
... )
Value:
SetAsserter->insert(OmptAssertEvent::EventTy( \
Name, Group, OMPTEST_REQUIRED_EVENT, __VA_ARGS__));

Definition at line 29 of file AssertMacros.h.

◆ OMPT_ASSERT_SET_EVENT_NOT

#define OMPT_ASSERT_SET_EVENT_NOT ( Name,
Group,
EventTy,
... )
Value:
SetAsserter->insert(OmptAssertEvent::EventTy( \
Name, Group, OMPTEST_EXCLUDED_EVENT, __VA_ARGS__));

Definition at line 39 of file AssertMacros.h.

◆ OMPT_ASSERT_SET_GROUPED

#define OMPT_ASSERT_SET_GROUPED ( Group,
EventTy,
... )
Value:
OMPT_ASSERT_SET_EVENT("", Group, EventTy, __VA_ARGS__)

Definition at line 34 of file AssertMacros.h.

◆ OMPT_ASSERT_SET_GROUPED_NOT

#define OMPT_ASSERT_SET_GROUPED_NOT ( Group,
EventTy,
... )
Value:
OMPT_ASSERT_SET_EVENT_NOT("", Group, EventTy, __VA_ARGS__)
#define OMPT_ASSERT_SET_EVENT_NOT(Name, Group, EventTy,...)

Definition at line 44 of file AssertMacros.h.

◆ OMPT_ASSERT_SET_MODE_RELAXED

#define OMPT_ASSERT_SET_MODE_RELAXED ( )
Value:

Definition at line 97 of file AssertMacros.h.

◆ OMPT_ASSERT_SET_MODE_STRICT

#define OMPT_ASSERT_SET_MODE_STRICT ( )
Value:

Definition at line 96 of file AssertMacros.h.

◆ OMPT_ASSERT_SET_NAMED

#define OMPT_ASSERT_SET_NAMED ( Name,
EventTy,
... )
Value:
OMPT_ASSERT_SET_EVENT(Name, "", EventTy, __VA_ARGS__)

Definition at line 36 of file AssertMacros.h.

◆ OMPT_ASSERT_SET_NAMED_NOT

#define OMPT_ASSERT_SET_NAMED_NOT ( Name,
EventTy,
... )
Value:
OMPT_ASSERT_SET_EVENT_NOT(Name, "", EventTy, __VA_ARGS__)

Definition at line 46 of file AssertMacros.h.

◆ OMPT_ASSERT_SET_NOT

#define OMPT_ASSERT_SET_NOT ( EventTy,
... )
Value:
OMPT_ASSERT_SET_EVENT_NOT("", "", EventTy, __VA_ARGS__)

Definition at line 42 of file AssertMacros.h.

◆ OMPT_ASSERT_SYNC_POINT

#define OMPT_ASSERT_SYNC_POINT ( SyncPointName)
Value:
OmptCallbackHandler::get().handleAssertionSyncPoint(SyncPointName);
int flush_traced_devices()

Definition at line 134 of file AssertMacros.h.

◆ OMPT_ASSERTER_DISABLE

#define OMPT_ASSERTER_DISABLE ( Asserter)
Value:
Asserter->setActive(false);

Definition at line 100 of file AssertMacros.h.

◆ OMPT_ASSERTER_ENABLE

#define OMPT_ASSERTER_ENABLE ( Asserter)
Value:
Asserter->setActive(true);

Definition at line 101 of file AssertMacros.h.

◆ OMPT_ASSERTER_LOG_FORMATTED

#define OMPT_ASSERTER_LOG_FORMATTED ( Asserter,
FormatLog )
Value:
Asserter->getLog()->setFormatOutput(FormatLog);

Definition at line 130 of file AssertMacros.h.

◆ OMPT_ASSERTER_LOG_LEVEL

#define OMPT_ASSERTER_LOG_LEVEL ( Asserter,
LogLevel )
Value:
Asserter->getLog()->setLoggingLevel(LogLevel);

Definition at line 125 of file AssertMacros.h.

◆ OMPT_ASSERTER_MODE_RELAXED

#define OMPT_ASSERTER_MODE_RELAXED ( Asserter)
Value:
Asserter->setOperationMode(AssertMode::Relaxed);

Definition at line 90 of file AssertMacros.h.

◆ OMPT_ASSERTER_MODE_STRICT

#define OMPT_ASSERTER_MODE_STRICT ( Asserter)
Value:
Asserter->setOperationMode(AssertMode::Strict);

Definition at line 88 of file AssertMacros.h.

◆ OMPT_ASSERTER_PERMIT_EVENT

#define OMPT_ASSERTER_PERMIT_EVENT ( Asserter,
EventTy )
Value:
Asserter->permitEvent(EventTy);

Definition at line 110 of file AssertMacros.h.

◆ OMPT_ASSERTER_SUPPRESS_EVENT

#define OMPT_ASSERTER_SUPPRESS_EVENT ( Asserter,
EventTy )
Value:
Asserter->suppressEvent(EventTy);

Definition at line 112 of file AssertMacros.h.

◆ OMPT_GENERATE_EVENTS

#define OMPT_GENERATE_EVENTS ( NumberOfCopies,
EventMacro )
Value:
for (size_t i = 0; i < NumberOfCopies; ++i) { \
EventMacro \
}
#define i
Definition kmp_stub.cpp:87

ASSERT MACROS TO BE USED BY THE USER.

Definition at line 22 of file AssertMacros.h.

◆ OMPT_PERMIT_EVENT

#define OMPT_PERMIT_EVENT ( EventTy)
Value:
OMPT_ASSERTER_PERMIT_EVENT(SetAsserter, EventTy); \
OMPT_ASSERTER_PERMIT_EVENT(EventReporter, EventTy); \
OMPT_ASSERTER_PERMIT_EVENT(SequenceAsserter, EventTy);
#define OMPT_ASSERTER_PERMIT_EVENT(Asserter, EventTy)
static OmptEventReporter * EventReporter

Definition at line 114 of file AssertMacros.h.

◆ OMPT_REPORT_EVENT_DISABLE

#define OMPT_REPORT_EVENT_DISABLE ( )
Value:

Definition at line 106 of file AssertMacros.h.

◆ OMPT_REPORT_EVENT_ENABLE

#define OMPT_REPORT_EVENT_ENABLE ( )
Value:

Definition at line 107 of file AssertMacros.h.

◆ OMPT_SUPPRESS_EVENT

#define OMPT_SUPPRESS_EVENT ( EventTy)
Value:
OMPT_ASSERTER_SUPPRESS_EVENT(SetAsserter, EventTy); \
OMPT_ASSERTER_SUPPRESS_EVENT(EventReporter, EventTy); \
OMPT_ASSERTER_SUPPRESS_EVENT(SequenceAsserter, EventTy);
#define OMPT_ASSERTER_SUPPRESS_EVENT(Asserter, EventTy)

Definition at line 118 of file AssertMacros.h.

◆ OMPTEST_EXCLUDED_EVENT

#define OMPTEST_EXCLUDED_EVENT   omptest::ObserveState::Never

Definition at line 17 of file AssertMacros.h.

◆ OMPTEST_REQUIRED_EVENT

#define OMPTEST_REQUIRED_EVENT   omptest::ObserveState::Always

Definition at line 18 of file AssertMacros.h.