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