tim::openmp::callback_connector< Components, Api > Struct Template Reference

#include "timemory/components/ompt/tool.hpp"

Collaboration diagram for tim::openmp::callback_connector< Components, Api >:

Public Types
using	api_type = Api
using	type = Components
using	result_type = std::shared_ptr< type >
using	array_type = std::deque< result_type >
using	map_type = std::unordered_map< size_t, array_type >
using	handle_type = component::ompt_handle< api_type >

Public Member Functions
template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::begin_callback >::value, int > = 0>
	callback_connector (T, Args... args)
template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::end_callback >::value, int > = 0>
	callback_connector (T, Args... args)
template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::store_callback >::value, int > = 0>
	callback_connector (T, Args... args)
template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::endpoint_callback >::value, int > = 0>
	callback_connector (T, ompt_scope_endpoint_t endp, Args... args)
template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::endpoint_callback >::value, int > = 0>
	callback_connector (T, ompt_work_t workv, ompt_scope_endpoint_t endp, Args... args)
template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::endpoint_callback >::value, int > = 0>
	callback_connector (T, ompt_sync_region_t syncv, ompt_scope_endpoint_t endp, Args... args)
template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::endpoint_callback >::value, int > = 0>
	callback_connector (T, ompt_target_t targv, ompt_scope_endpoint_t endp, Args... args)

Static Public Member Functions
static bool	is_enabled ()

Protected Member Functions
template<typename T , typename Arg , typename... Args, enable_if_t< std::is_same< T, mode::endpoint_callback >::value, int > = 0>
void	generic_endpoint_connector (T, Arg arg, ompt_scope_endpoint_t endp, Args... args)

Detailed Description

template<typename Components, typename Api>
struct tim::openmp::callback_connector< Components, Api >

Definition at line 646 of file tool.hpp.

Member Typedef Documentation

api_type

template<typename Components , typename Api >

using tim::openmp::callback_connector< Components, Api >::api_type = Api

Definition at line 648 of file tool.hpp.

array_type

template<typename Components , typename Api >

using tim::openmp::callback_connector< Components, Api >::array_type = std::deque<result_type>

Definition at line 651 of file tool.hpp.

handle_type

template<typename Components , typename Api >

using tim::openmp::callback_connector< Components, Api >::handle_type = component::ompt_handle<api_type>

Definition at line 653 of file tool.hpp.

map_type

template<typename Components , typename Api >

using tim::openmp::callback_connector< Components, Api >::map_type = std::unordered_map<size_t, array_type>

Definition at line 652 of file tool.hpp.

result_type

template<typename Components , typename Api >

using tim::openmp::callback_connector< Components, Api >::result_type = std::shared_ptr<type>

Definition at line 650 of file tool.hpp.

type

template<typename Components , typename Api >

using tim::openmp::callback_connector< Components, Api >::type = Components

Definition at line 649 of file tool.hpp.

Constructor & Destructor Documentation

callback_connector() [1/7]

template<typename Components , typename Api >

template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::store_callback >::value, int > >

tim::openmp::callback_connector< Components, Api >::callback_connector	(	T	,
		Args...	args
	)

Definition at line 734 of file tool.hpp.

{
    if(!is_enabled())
        return;
 
    context_handler<api_type> ctx(args...);
    user_context_callback(ctx, ctx.m_key, args...);
 
    // don't provide empty entries
    if(ctx.empty())
        return;
 
    user_context_callback<type>(ctx, T{}, std::forward<Args>(args)...);
}

References tim::openmp::context_handler< Api >::empty(), and tim::openmp::context_handler< Api >::m_key.

callback_connector() [2/7]

template<typename Components , typename Api >

template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::end_callback >::value, int > = 0>

tim::openmp::callback_connector< Components, Api >::callback_connector	(	T	,
		Args...	args
	)

callback_connector() [3/7]

template<typename Components , typename Api >

template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::store_callback >::value, int > = 0>

tim::openmp::callback_connector< Components, Api >::callback_connector	(	T	,
		Args...	args
	)

callback_connector() [4/7]

template<typename Components , typename Api >

template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::endpoint_callback >::value, int > >

tim::openmp::callback_connector< Components, Api >::callback_connector	(	T	,
		ompt_scope_endpoint_t	endp,
		Args...	args
	)

Definition at line 794 of file tool.hpp.

{
    if(!is_enabled())
        return;
 
    context_handler<api_type> ctx(endp, args...);
    user_context_callback(ctx, ctx.m_key, endp, args...);
 
    // don't provide empty entries
    if(ctx.empty())
        return;
 
    user_context_callback<type>(ctx, T{}, endp, std::forward<Args>(args)...);
}

References tim::openmp::context_handler< Api >::empty(), and tim::openmp::context_handler< Api >::m_key.

callback_connector() [5/7]

template<typename Components , typename Api >

template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::endpoint_callback >::value, int > = 0>

tim::openmp::callback_connector< Components, Api >::callback_connector ( T  , ompt_work_t  workv, ompt_scope_endpoint_t  endp, Args...  args  )

inline

Definition at line 690 of file tool.hpp.

    {
        if(!is_enabled())
            return;
        generic_endpoint_connector(T{}, workv, endp, args...);
    }

References tim::openmp::callback_connector< Components, Api >::generic_endpoint_connector(), and tim::openmp::callback_connector< Components, Api >::is_enabled().

callback_connector() [6/7]

template<typename Components , typename Api >

template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::endpoint_callback >::value, int > = 0>

tim::openmp::callback_connector< Components, Api >::callback_connector ( T  , ompt_sync_region_t  syncv, ompt_scope_endpoint_t  endp, Args...  args  )

inline

Definition at line 699 of file tool.hpp.

    {
        if(!is_enabled())
            return;
        generic_endpoint_connector(T{}, syncv, endp, args...);
    }

References tim::openmp::callback_connector< Components, Api >::generic_endpoint_connector(), and tim::openmp::callback_connector< Components, Api >::is_enabled().

callback_connector() [7/7]

template<typename Components , typename Api >

template<typename T , typename... Args, enable_if_t< std::is_same< T, mode::endpoint_callback >::value, int > = 0>

tim::openmp::callback_connector< Components, Api >::callback_connector ( T  , ompt_target_t  targv, ompt_scope_endpoint_t  endp, Args...  args  )

inline

Definition at line 709 of file tool.hpp.

    {
        if(!is_enabled())
            return;
        generic_endpoint_connector(T{}, targv, endp, args...);
    }

References tim::openmp::callback_connector< Components, Api >::generic_endpoint_connector(), and tim::openmp::callback_connector< Components, Api >::is_enabled().

Member Function Documentation

generic_endpoint_connector()

template<typename Components , typename Api >

template<typename T , typename Arg , typename... Args, enable_if_t< std::is_same< T, mode::endpoint_callback >::value, int > >

void tim::openmp::callback_connector< Components, Api >::generic_endpoint_connector ( T  , Arg  arg, ompt_scope_endpoint_t  endp, Args...  args  )

protected

Definition at line 816 of file tool.hpp.

{
    context_handler<api_type> ctx(arg, endp, args...);
    user_context_callback(ctx, ctx.m_key, arg, endp, args...);
 
    // don't provide empty entries
    if(ctx.empty())
        return;
 
    user_context_callback<type>(ctx, T{}, std::forward<Arg>(arg), endp,
                                std::forward<Args>(args)...);
}

References tim::openmp::context_handler< Api >::empty(), and tim::openmp::context_handler< Api >::m_key.

Referenced by tim::openmp::callback_connector< Components, Api >::callback_connector().

is_enabled()

template<typename Components , typename Api >

static bool tim::openmp::callback_connector< Components, Api >::is_enabled ( )

inlinestatic

Definition at line 655 of file tool.hpp.

    {
        if(!manager::instance() ||
           (manager::instance() && manager::instance()->is_finalizing()))
        {
            trait::runtime_enabled<type>::set(false);
            trait::runtime_enabled<handle_type>::set(false);
            return false;
        }
 
        DEBUG_PRINT_HERE("[timemory-ompt]> %s :: handle enabled = %s",
                         demangle<type>().c_str(),
                         (trait::runtime_enabled<handle_type>::get()) ? "y" : "n");
 
        return (trait::runtime_enabled<handle_type>::get());
    }

References DEBUG_PRINT_HERE, tim::manager::instance(), and tim::trait::runtime_enabled< T >::set().

Referenced by tim::openmp::callback_connector< Components, Api >::callback_connector().

---

The documentation for this struct was generated from the following file:

• timemory/components/ompt/tool.hpp