Events.hpp File Reference

#include <iomanip>
#include "impl/Kokkos_Profiling.hpp"
#include "kokkos-utils/impl/type_list.hpp"

Go to the source code of this file.

Classes
struct	Kokkos::utils::callbacks::BeginParallelForEvent
struct	Kokkos::utils::callbacks::EndParallelForEvent
	End-parallel-for event associated with Kokkos::Tools::Experimental::EventSet::end_parallel_for. More...
struct	Kokkos::utils::callbacks::BeginParallelReduceEvent
	Begin-parallel-reduce event associated with Kokkos::Tools::Experimental::EventSet::begin_parallel_reduce. More...
struct	Kokkos::utils::callbacks::EndParallelReduceEvent
	End-parallel-reduce event associated with Kokkos::Tools::Experimental::EventSet::end_parallel_reduce. More...
struct	Kokkos::utils::callbacks::BeginParallelScanEvent
	Begin-parallel-scan event associated with Kokkos::Tools::Experimental::EventSet::begin_parallel_scan. More...
struct	Kokkos::utils::callbacks::EndParallelScanEvent
	End-parallel-scan event associated with Kokkos::Tools::Experimental::EventSet::end_parallel_scan. More...
struct	Kokkos::utils::callbacks::BeginFenceEvent
	Begin-fence event associated with Kokkos::Tools::Experimental::EventSet::begin_fence. More...
struct	Kokkos::utils::callbacks::EndFenceEvent
	End-fence event associated with Kokkos::Tools::Experimental::EventSet::end_fence. More...
struct	Kokkos::utils::callbacks::AllocDescriptor
	Helper struct to hold descriptors of a data allocation. More...
struct	Kokkos::utils::callbacks::AllocateDataEvent
	Allocate-data event associated with Kokkos::Tools::Experimental::EventSet::allocate_data. More...
struct	Kokkos::utils::callbacks::DeallocateDataEvent
	Deallocate-data event associated with Kokkos::Tools::Experimental::EventSet::deallocate_data. More...
struct	Kokkos::utils::callbacks::BeginDeepCopyEvent
	Begin-deep-copy event associated with Kokkos::Tools::Experimental::EventSet::begin_deep_copy. More...
struct	Kokkos::utils::callbacks::EndDeepCopyEvent
	End-deep-copy event associated with Kokkos::Tools::Experimental::EventSet::end_deep_copy. More...
struct	Kokkos::utils::callbacks::CreateProfileSectionEvent
	Create-profile-section event associated with Kokkos::Tools::Experimental::EventSet::create_profile_section. More...
struct	Kokkos::utils::callbacks::StartProfileSectionEvent
	Start-profile-section event associated with Kokkos::Tools::Experimental::EventSet::start_profile_section. More...
struct	Kokkos::utils::callbacks::StopProfileSectionEvent
	Stop-profile-section event associated with Kokkos::Tools::Experimental::EventSet::stop_profile_section. More...
struct	Kokkos::utils::callbacks::DestroyProfileSectionEvent
	Destroy-profile-section event associated with Kokkos::Tools::Experimental::EventSet::destroy_profile_section. More...
struct	Kokkos::utils::callbacks::PushRegionEvent
	Push-region event associated with Kokkos::Tools::Experimental::EventSet::push_region. More...
struct	Kokkos::utils::callbacks::PopRegionEvent
	Pop-region event associated with Kokkos::Tools::Experimental::EventSet::pop_region. More...
struct	Kokkos::utils::callbacks::ProfileEvent
	Profile event associated with Kokkos::Tools::Experimental::EventSet::profile_event. More...
struct	Kokkos::utils::callbacks::PairedEventType< BeginParallelForEvent >
struct	Kokkos::utils::callbacks::PairedEventType< BeginParallelReduceEvent >
struct	Kokkos::utils::callbacks::PairedEventType< BeginParallelScanEvent >
struct	Kokkos::utils::callbacks::PairedEventType< BeginFenceEvent >
struct	Kokkos::utils::callbacks::PairedEventType< AllocateDataEvent >
struct	Kokkos::utils::callbacks::PairedEventType< BeginDeepCopyEvent >
struct	Kokkos::utils::callbacks::PairedEventType< CreateProfileSectionEvent >
struct	Kokkos::utils::callbacks::PairedEventType< StartProfileSectionEvent >
struct	Kokkos::utils::callbacks::PairedEventType< PushRegionEvent >

Namespaces
namespace	Kokkos
namespace	Kokkos::utils
namespace	Kokkos::utils::callbacks

Concepts
concept	Kokkos::utils::callbacks::Event
concept	Kokkos::utils::callbacks::BeginEvent
	Concept to constrain any begin event type.
concept	Kokkos::utils::callbacks::EndEvent
	Concept to constrain any end event type.
concept	Kokkos::utils::callbacks::DataEvent
	Concept to constrain any data event type.
concept	Kokkos::utils::callbacks::ProfileSectionManipulationEvent
	Concept to constrain any profile section manipulation event type.
concept	Kokkos::utils::callbacks::NamedEvent
	Concept to constrain any event type that has a name field.
concept	Kokkos::utils::callbacks::IndexedEvent
	Concept to constrain any event type that has a member variable event_id.
concept	Kokkos::utils::callbacks::EnqueuedEvent
	Concept to constrain any event type that has a member variable dev_id.
concept	Kokkos::utils::callbacks::EventOneOf
	Concept to constrain any event type that is one of the given event types.

Typedefs
using	Kokkos::utils::callbacks::EventTypeList
	Type list holding all event types.

Functions
bool	Kokkos::utils::callbacks::operator== (const Kokkos_Profiling_SpaceHandle &fst, const Kokkos_Profiling_SpaceHandle &snd)
	Equality comparison for Kokkos_Profiling_SpaceHandle.
Stream operators.
template<typename T>
constexpr auto	Kokkos::utils::callbacks::get_name ()
	Helper function to remove the Kokkos::utils::callbacks:: prefix.
template<Event EventType>
std::ostream &	Kokkos::utils::callbacks::operator<< (std::ostream &out, const EventType &)
std::ostream &	Kokkos::utils::callbacks::operator<< (std::ostream &out, const BeginDeepCopyEvent &event)
std::ostream &	Kokkos::utils::callbacks::operator<< (std::ostream &out, const CreateProfileSectionEvent &event)
std::ostream &	Kokkos::utils::callbacks::operator<< (std::ostream &out, const PushRegionEvent &event)
std::ostream &	Kokkos::utils::callbacks::operator<< (std::ostream &out, const ProfileEvent &event)
std::ostream &	Kokkos::utils::callbacks::operator<< (std::ostream &out, const AllocDescriptor &descr)

Get the paired event.
#define	PAIRED_EVENT_TYPE(__begin_eventtype__, __end_eventtype__)
template<Event EventType>
using	Kokkos::utils::callbacks::paired_event_t = typename PairedEventType<EventType>::type

Helpers providing the @c Kokkos::Tools getters and setters corresponding to the event types.
#define	GET_CALLBACK_FROM_EVENTSET(__eventtype__, __callback__)
	Helper macro related to the implementation of Kokkos::utils::callbacks::get_callback_from_eventset.
#define	GET_CALLBACK_SETTER(__eventtype__, __callback_setter__)
	Helper macro related to the implementation of Kokkos::utils::callbacks::get_callback_setter.
template<Event EventType>
auto	Kokkos::utils::callbacks::get_callback_from_eventset (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< BeginParallelForEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< EndParallelForEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< BeginParallelReduceEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< EndParallelReduceEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< BeginParallelScanEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< EndParallelScanEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< BeginFenceEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< EndFenceEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< AllocateDataEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< DeallocateDataEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< BeginDeepCopyEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< EndDeepCopyEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< CreateProfileSectionEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< StartProfileSectionEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< StopProfileSectionEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< DestroyProfileSectionEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< PushRegionEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< PopRegionEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<>
auto	Kokkos::utils::callbacks::get_callback_from_eventset< ProfileEvent > (const Kokkos::Tools::Experimental::EventSet &event_set)
template<Event EventType>
auto	Kokkos::utils::callbacks::get_callback_setter ()
	Get the setter function of a Kokkos profiling callback corresponding to EventType.
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< BeginParallelForEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< EndParallelForEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< BeginParallelReduceEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< EndParallelReduceEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< BeginParallelScanEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< EndParallelScanEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< BeginFenceEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< EndFenceEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< AllocateDataEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< DeallocateDataEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< BeginDeepCopyEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< EndDeepCopyEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< CreateProfileSectionEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< StartProfileSectionEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< StopProfileSectionEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< DestroyProfileSectionEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< PushRegionEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< PopRegionEvent > ()
template<>
auto	Kokkos::utils::callbacks::get_callback_setter< ProfileEvent > ()

Macro Definition Documentation

GET_CALLBACK_FROM_EVENTSET

#define GET_CALLBACK_FROM_EVENTSET	(		__eventtype__,
			__callback__ )

Value:

    template <> \
    inline auto get_callback_from_eventset<__eventtype__>(const Kokkos::Tools::Experimental::EventSet& event_set) { return event_set.__callback__; }

Helper macro related to the implementation of Kokkos::utils::callbacks::get_callback_from_eventset.

Definition at line 383 of file Events.hpp.

GET_CALLBACK_SETTER

#define GET_CALLBACK_SETTER	(		__eventtype__,
			__callback_setter__ )

Value:

    template <> \
    inline auto get_callback_setter<__eventtype__>() { return &Kokkos::Tools::Experimental::__callback_setter__; }

Helper macro related to the implementation of Kokkos::utils::callbacks::get_callback_setter.

Definition at line 412 of file Events.hpp.

PAIRED_EVENT_TYPE

#define PAIRED_EVENT_TYPE	(		__begin_eventtype__,
			__end_eventtype__ )

Value:

    template <> \
    struct PairedEventType<__begin_eventtype__> { using type = __end_eventtype__; };

Definition at line 286 of file Events.hpp.