LLVM 18.0.0git
OMPConstants.h
Go to the documentation of this file.
1//===- OMPConstants.h - OpenMP related constants and helpers ------ C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8/// \file
9///
10/// This file defines constans and helpers used when dealing with OpenMP.
11///
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_FRONTEND_OPENMP_OMPCONSTANTS_H
15#define LLVM_FRONTEND_OPENMP_OMPCONSTANTS_H
16
18
19#include "llvm/ADT/StringRef.h"
20#include "llvm/Frontend/OpenMP/OMP.h.inc"
21
22namespace llvm {
23namespace omp {
25
26/// IDs for all Internal Control Variables (ICVs).
28#define ICV_DATA_ENV(Enum, ...) Enum,
29#include "llvm/Frontend/OpenMP/OMPKinds.def"
30};
31
32#define ICV_DATA_ENV(Enum, ...) \
33 constexpr auto Enum = omp::InternalControlVar::Enum;
34#include "llvm/Frontend/OpenMP/OMPKinds.def"
35
36enum class ICVInitValue {
37#define ICV_INIT_VALUE(Enum, Name) Enum,
38#include "llvm/Frontend/OpenMP/OMPKinds.def"
39};
40
41#define ICV_INIT_VALUE(Enum, Name) \
42 constexpr auto Enum = omp::ICVInitValue::Enum;
43#include "llvm/Frontend/OpenMP/OMPKinds.def"
44
45/// IDs for all omp runtime library (RTL) functions.
46enum class RuntimeFunction {
47#define OMP_RTL(Enum, ...) Enum,
48#include "llvm/Frontend/OpenMP/OMPKinds.def"
49};
50
51#define OMP_RTL(Enum, ...) constexpr auto Enum = omp::RuntimeFunction::Enum;
52#include "llvm/Frontend/OpenMP/OMPKinds.def"
53
54/// IDs for the different default kinds.
55enum class DefaultKind {
56#define OMP_DEFAULT_KIND(Enum, Str) Enum,
57#include "llvm/Frontend/OpenMP/OMPKinds.def"
58};
59
60#define OMP_DEFAULT_KIND(Enum, ...) \
61 constexpr auto Enum = omp::DefaultKind::Enum;
62#include "llvm/Frontend/OpenMP/OMPKinds.def"
63
64/// IDs for all omp runtime library ident_t flag encodings (see
65/// their defintion in openmp/runtime/src/kmp.h).
66enum class IdentFlag {
67#define OMP_IDENT_FLAG(Enum, Str, Value) Enum = Value,
68#include "llvm/Frontend/OpenMP/OMPKinds.def"
70};
71
72#define OMP_IDENT_FLAG(Enum, ...) constexpr auto Enum = omp::IdentFlag::Enum;
73#include "llvm/Frontend/OpenMP/OMPKinds.def"
74
75// Version of the kernel argument format used by the omp runtime.
76#define OMP_KERNEL_ARG_VERSION 2
77
78/// \note This needs to be kept in sync with kmp.h enum sched_type.
79/// Todo: Update kmp.h to include this file, and remove the enums in kmp.h
80enum class OMPScheduleType {
81 // For typed comparisons, not a valid schedule
82 None = 0,
83
84 // Schedule algorithms
86 BaseStatic = 2,
89 BaseRuntime = 5,
90 BaseAuto = 6,
92 BaseGreedy = 8,
93 BaseBalanced = 9,
96 BaseSteal = 12,
97
98 // with chunk adjustment (e.g., simd)
100 BaseGuidedSimd = 14,
101 BaseRuntimeSimd = 15,
102
103 // static schedules algorithims for distribute
105 BaseDistribute = 28,
106
107 // Modifier flags to be combined with schedule algorithms
108 ModifierUnordered = (1 << 5),
109 ModifierOrdered = (1 << 6),
110 ModifierNomerge = (1 << 7),
111 ModifierMonotonic = (1 << 29),
112 ModifierNonmonotonic = (1 << 30),
113
114 // Masks combining multiple flags
118
119 // valid schedule type values, without monotonicity flags
134
139
147
150
174
187
188 LLVM_MARK_AS_BITMASK_ENUM(/* LargestValue */ ModifierMask)
189};
190
191/// Values for bit flags used to specify the mapping type for
192/// offloading.
194 /// No flags
195 OMP_MAP_NONE = 0x0,
196 /// Allocate memory on the device and move data from host to device.
197 OMP_MAP_TO = 0x01,
198 /// Allocate memory on the device and move data from device to host.
199 OMP_MAP_FROM = 0x02,
200 /// Always perform the requested mapping action on the element, even
201 /// if it was already mapped before.
202 OMP_MAP_ALWAYS = 0x04,
203 /// Delete the element from the device environment, ignoring the
204 /// current reference count associated with the element.
205 OMP_MAP_DELETE = 0x08,
206 /// The element being mapped is a pointer-pointee pair; both the
207 /// pointer and the pointee should be mapped.
208 OMP_MAP_PTR_AND_OBJ = 0x10,
209 /// This flags signals that the base address of an entry should be
210 /// passed to the target kernel as an argument.
212 /// Signal that the runtime library has to return the device pointer
213 /// in the current position for the data being mapped. Used when we have the
214 /// use_device_ptr or use_device_addr clause.
216 /// This flag signals that the reference being passed is a pointer to
217 /// private data.
218 OMP_MAP_PRIVATE = 0x80,
219 /// Pass the element to the device by value.
220 OMP_MAP_LITERAL = 0x100,
221 /// Implicit map
222 OMP_MAP_IMPLICIT = 0x200,
223 /// Close is a hint to the runtime to allocate memory close to
224 /// the target device.
225 OMP_MAP_CLOSE = 0x400,
226 /// 0x800 is reserved for compatibility with XLC.
227 /// Produce a runtime error if the data is not already allocated.
228 OMP_MAP_PRESENT = 0x1000,
229 // Increment and decrement a separate reference counter so that the data
230 // cannot be unmapped within the associated region. Thus, this flag is
231 // intended to be used on 'target' and 'target data' directives because they
232 // are inherently structured. It is not intended to be used on 'target
233 // enter data' and 'target exit data' directives because they are inherently
234 // dynamic.
235 // This is an OpenMP extension for the sake of OpenACC support.
236 OMP_MAP_OMPX_HOLD = 0x2000,
237 /// Signal that the runtime library should use args as an array of
238 /// descriptor_dim pointers and use args_size as dims. Used when we have
239 /// non-contiguous list items in target update directive
240 OMP_MAP_NON_CONTIG = 0x100000000000,
241 /// The 16 MSBs of the flags indicate whether the entry is member of some
242 /// struct/class.
243 OMP_MAP_MEMBER_OF = 0xffff000000000000,
245};
246
248 /// Device ID if the device was not defined, runtime should get it
249 /// from environment variables in the spec.
252
253enum class AddressSpace : unsigned {
254 Generic = 0,
255 Global = 1,
256 Shared = 3,
257 Constant = 4,
258 Local = 5,
259};
260
261/// \note This needs to be kept in sync with interop.h enum kmp_interop_type_t.:
263
264/// Atomic compare operations. Currently OpenMP only supports ==, >, and <.
265enum class OMPAtomicCompareOp : unsigned { EQ, MIN, MAX };
266
267/// Fields ids in kmp_depend_info record.
269
270/// Dependence kind for RTL.
272 DepUnknown = 0x0,
273 DepIn = 0x01,
274 DepInOut = 0x3,
275 DepMutexInOutSet = 0x4,
276 DepInOutSet = 0x8,
277 DepOmpAllMem = 0x80,
278};
279
280} // end namespace omp
281
282} // end namespace llvm
283
284#include "OMPDeviceConstants.h"
285
286#endif // LLVM_FRONTEND_OPENMP_OMPCONSTANTS_H
This file defines constans that will be used by both host and device compilation.
This is an important base class in LLVM.
Definition: Constant.h:41
OpenMPOffloadMappingFlags
Values for bit flags used to specify the mapping type for offloading.
Definition: OMPConstants.h:193
@ OMP_MAP_TO
Allocate memory on the device and move data from host to device.
@ OMP_MAP_NON_CONTIG
Signal that the runtime library should use args as an array of descriptor_dim pointers and use args_s...
@ OMP_MAP_LITERAL
Pass the element to the device by value.
@ OMP_MAP_RETURN_PARAM
Signal that the runtime library has to return the device pointer in the current position for the data...
@ OMP_MAP_PTR_AND_OBJ
The element being mapped is a pointer-pointee pair; both the pointer and the pointee should be mapped...
@ OMP_MAP_TARGET_PARAM
This flags signals that the base address of an entry should be passed to the target kernel as an argu...
@ OMP_MAP_PRESENT
0x800 is reserved for compatibility with XLC.
@ OMP_MAP_CLOSE
Close is a hint to the runtime to allocate memory close to the target device.
@ OMP_MAP_PRIVATE
This flag signals that the reference being passed is a pointer to private data.
@ OMP_MAP_MEMBER_OF
The 16 MSBs of the flags indicate whether the entry is member of some struct/class.
@ OMP_MAP_DELETE
Delete the element from the device environment, ignoring the current reference count associated with ...
@ OMP_MAP_ALWAYS
Always perform the requested mapping action on the element, even if it was already mapped before.
@ OMP_MAP_FROM
Allocate memory on the device and move data from device to host.
OpenMPOffloadingReservedDeviceIDs
Definition: OMPConstants.h:247
@ OMP_DEVICEID_UNDEF
Device ID if the device was not defined, runtime should get it from environment variables in the spec...
Definition: OMPConstants.h:250
IdentFlag
IDs for all omp runtime library ident_t flag encodings (see their defintion in openmp/runtime/src/kmp...
Definition: OMPConstants.h:66
RTLDependInfoFields
Fields ids in kmp_depend_info record.
Definition: OMPConstants.h:268
RTLDependenceKindTy
Dependence kind for RTL.
Definition: OMPConstants.h:271
InternalControlVar
IDs for all Internal Control Variables (ICVs).
Definition: OMPConstants.h:27
RuntimeFunction
IDs for all omp runtime library (RTL) functions.
Definition: OMPConstants.h:46
LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE()
OMPAtomicCompareOp
Atomic compare operations. Currently OpenMP only supports ==, >, and <.
Definition: OMPConstants.h:265
DefaultKind
IDs for the different default kinds.
Definition: OMPConstants.h:55
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18