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