xref: /freebsd/contrib/llvm-project/openmp/runtime/src/ompt-event-specific.h (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1*0b57cec5SDimitry Andric /******************************************************************************
2*0b57cec5SDimitry Andric  * File: ompt-event-specific.h
3*0b57cec5SDimitry Andric  *
4*0b57cec5SDimitry Andric  * Description:
5*0b57cec5SDimitry Andric  *
6*0b57cec5SDimitry Andric  *   specify which of the OMPT events are implemented by this runtime system
7*0b57cec5SDimitry Andric  *   and the level of their implementation by a runtime system.
8*0b57cec5SDimitry Andric  *****************************************************************************/
9*0b57cec5SDimitry Andric 
10*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
11*0b57cec5SDimitry Andric //
12*0b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
13*0b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
14*0b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
15*0b57cec5SDimitry Andric //
16*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
17*0b57cec5SDimitry Andric 
18*0b57cec5SDimitry Andric #ifndef __OMPT_EVENT_SPECIFIC_H__
19*0b57cec5SDimitry Andric #define __OMPT_EVENT_SPECIFIC_H__
20*0b57cec5SDimitry Andric 
21*0b57cec5SDimitry Andric #define _ompt_tokenpaste_helper(x, y) x##y
22*0b57cec5SDimitry Andric #define _ompt_tokenpaste(x, y) _ompt_tokenpaste_helper(x, y)
23*0b57cec5SDimitry Andric #define ompt_event_implementation_status(e) _ompt_tokenpaste(e, _implemented)
24*0b57cec5SDimitry Andric 
25*0b57cec5SDimitry Andric /*----------------------------------------------------------------------------
26*0b57cec5SDimitry Andric  | Specify whether an event may occur or not, and whether event callbacks
27*0b57cec5SDimitry Andric  | never, sometimes, or always occur.
28*0b57cec5SDimitry Andric  |
29*0b57cec5SDimitry Andric  | The values for these constants are defined in section 6.1.2 of
30*0b57cec5SDimitry Andric  | the OMPT TR. They are exposed to tools through ompt_set_callback.
31*0b57cec5SDimitry Andric  +--------------------------------------------------------------------------*/
32*0b57cec5SDimitry Andric 
33*0b57cec5SDimitry Andric #define ompt_event_UNIMPLEMENTED ompt_set_never
34*0b57cec5SDimitry Andric #define ompt_event_MAY_CONVENIENT ompt_set_sometimes
35*0b57cec5SDimitry Andric #define ompt_event_MAY_ALWAYS ompt_set_always
36*0b57cec5SDimitry Andric 
37*0b57cec5SDimitry Andric #if OMPT_OPTIONAL
38*0b57cec5SDimitry Andric #define ompt_event_MAY_ALWAYS_OPTIONAL ompt_event_MAY_ALWAYS
39*0b57cec5SDimitry Andric #else
40*0b57cec5SDimitry Andric #define ompt_event_MAY_ALWAYS_OPTIONAL ompt_event_UNIMPLEMENTED
41*0b57cec5SDimitry Andric #endif
42*0b57cec5SDimitry Andric 
43*0b57cec5SDimitry Andric /*----------------------------------------------------------------------------
44*0b57cec5SDimitry Andric  | Mandatory Events
45*0b57cec5SDimitry Andric  +--------------------------------------------------------------------------*/
46*0b57cec5SDimitry Andric 
47*0b57cec5SDimitry Andric #define ompt_callback_thread_begin_implemented ompt_event_MAY_ALWAYS
48*0b57cec5SDimitry Andric #define ompt_callback_thread_end_implemented ompt_event_MAY_ALWAYS
49*0b57cec5SDimitry Andric 
50*0b57cec5SDimitry Andric #define ompt_callback_parallel_begin_implemented ompt_event_MAY_ALWAYS
51*0b57cec5SDimitry Andric #define ompt_callback_parallel_end_implemented ompt_event_MAY_ALWAYS
52*0b57cec5SDimitry Andric 
53*0b57cec5SDimitry Andric #define ompt_callback_task_create_implemented ompt_event_MAY_ALWAYS
54*0b57cec5SDimitry Andric #define ompt_callback_task_schedule_implemented ompt_event_MAY_ALWAYS
55*0b57cec5SDimitry Andric 
56*0b57cec5SDimitry Andric #define ompt_callback_implicit_task_implemented ompt_event_MAY_ALWAYS
57*0b57cec5SDimitry Andric 
58*0b57cec5SDimitry Andric #define ompt_callback_target_implemented ompt_event_UNIMPLEMENTED
59*0b57cec5SDimitry Andric #define ompt_callback_target_data_op_implemented ompt_event_UNIMPLEMENTED
60*0b57cec5SDimitry Andric #define ompt_callback_target_submit_implemented ompt_event_UNIMPLEMENTED
61*0b57cec5SDimitry Andric 
62*0b57cec5SDimitry Andric #define ompt_callback_control_tool_implemented ompt_event_MAY_ALWAYS
63*0b57cec5SDimitry Andric 
64*0b57cec5SDimitry Andric #define ompt_callback_device_initialize_implemented ompt_event_UNIMPLEMENTED
65*0b57cec5SDimitry Andric #define ompt_callback_device_finalize_implemented ompt_event_UNIMPLEMENTED
66*0b57cec5SDimitry Andric 
67*0b57cec5SDimitry Andric #define ompt_callback_device_load_implemented ompt_event_UNIMPLEMENTED
68*0b57cec5SDimitry Andric #define ompt_callback_device_unload_implemented ompt_event_UNIMPLEMENTED
69*0b57cec5SDimitry Andric 
70*0b57cec5SDimitry Andric /*----------------------------------------------------------------------------
71*0b57cec5SDimitry Andric  | Optional Events
72*0b57cec5SDimitry Andric  +--------------------------------------------------------------------------*/
73*0b57cec5SDimitry Andric 
74*0b57cec5SDimitry Andric #define ompt_callback_sync_region_wait_implemented                             \
75*0b57cec5SDimitry Andric   ompt_event_MAY_ALWAYS_OPTIONAL
76*0b57cec5SDimitry Andric 
77*0b57cec5SDimitry Andric #define ompt_callback_mutex_released_implemented ompt_event_MAY_ALWAYS_OPTIONAL
78*0b57cec5SDimitry Andric 
79*0b57cec5SDimitry Andric #define ompt_callback_dependences_implemented                             \
80*0b57cec5SDimitry Andric   ompt_event_MAY_ALWAYS_OPTIONAL
81*0b57cec5SDimitry Andric #define ompt_callback_task_dependence_implemented ompt_event_MAY_ALWAYS_OPTIONAL
82*0b57cec5SDimitry Andric 
83*0b57cec5SDimitry Andric #define ompt_callback_work_implemented ompt_event_MAY_ALWAYS_OPTIONAL
84*0b57cec5SDimitry Andric 
85*0b57cec5SDimitry Andric #define ompt_callback_master_implemented ompt_event_MAY_ALWAYS_OPTIONAL
86*0b57cec5SDimitry Andric 
87*0b57cec5SDimitry Andric #define ompt_callback_target_map_implemented ompt_event_UNIMPLEMENTED
88*0b57cec5SDimitry Andric 
89*0b57cec5SDimitry Andric #define ompt_callback_sync_region_implemented ompt_event_MAY_ALWAYS_OPTIONAL
90*0b57cec5SDimitry Andric 
91*0b57cec5SDimitry Andric #define ompt_callback_lock_init_implemented ompt_event_MAY_ALWAYS_OPTIONAL
92*0b57cec5SDimitry Andric #define ompt_callback_lock_destroy_implemented ompt_event_MAY_ALWAYS_OPTIONAL
93*0b57cec5SDimitry Andric 
94*0b57cec5SDimitry Andric #define ompt_callback_mutex_acquire_implemented ompt_event_MAY_ALWAYS_OPTIONAL
95*0b57cec5SDimitry Andric #define ompt_callback_mutex_acquired_implemented ompt_event_MAY_ALWAYS_OPTIONAL
96*0b57cec5SDimitry Andric #define ompt_callback_nest_lock_implemented ompt_event_MAY_ALWAYS_OPTIONAL
97*0b57cec5SDimitry Andric 
98*0b57cec5SDimitry Andric #define ompt_callback_flush_implemented ompt_event_MAY_ALWAYS_OPTIONAL
99*0b57cec5SDimitry Andric 
100*0b57cec5SDimitry Andric #define ompt_callback_cancel_implemented ompt_event_MAY_ALWAYS_OPTIONAL
101*0b57cec5SDimitry Andric 
102*0b57cec5SDimitry Andric #define ompt_callback_reduction_implemented ompt_event_UNIMPLEMENTED
103*0b57cec5SDimitry Andric 
104*0b57cec5SDimitry Andric #define ompt_callback_dispatch_implemented ompt_event_UNIMPLEMENTED
105*0b57cec5SDimitry Andric 
106*0b57cec5SDimitry Andric #endif
107