| //===- OMPConstants.h - OpenMP related constants and helpers ------ C++ -*-===// |
| // |
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| // See https://llvm.org/LICENSE.txt for license information. |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| // |
| //===----------------------------------------------------------------------===// |
| /// \file |
| /// |
| /// This file defines constans and helpers used when dealing with OpenMP. |
| /// |
| //===----------------------------------------------------------------------===// |
| |
| #ifndef LLVM_OPENMP_CONSTANTS_H |
| #define LLVM_OPENMP_CONSTANTS_H |
| |
| #include "llvm/ADT/BitmaskEnum.h" |
| #include "llvm/ADT/StringRef.h" |
| |
| namespace llvm { |
| class Type; |
| class Module; |
| class StructType; |
| class PointerType; |
| class FunctionType; |
| |
| namespace omp { |
| LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE(); |
| |
| /// IDs for all OpenMP directives. |
| enum class Directive { |
| #define OMP_DIRECTIVE(Enum, ...) Enum, |
| #include "llvm/Frontend/OpenMP/OMPKinds.def" |
| }; |
| |
| /// Make the enum values available in the llvm::omp namespace. This allows us to |
| /// write something like OMPD_parallel if we have a `using namespace omp`. At |
| /// the same time we do not loose the strong type guarantees of the enum class, |
| /// that is we cannot pass an unsigned as Directive without an explicit cast. |
| #define OMP_DIRECTIVE(Enum, ...) constexpr auto Enum = omp::Directive::Enum; |
| #include "llvm/Frontend/OpenMP/OMPKinds.def" |
| |
| /// IDs for all omp runtime library (RTL) functions. |
| enum class RuntimeFunction { |
| #define OMP_RTL(Enum, ...) Enum, |
| #include "llvm/Frontend/OpenMP/OMPKinds.def" |
| }; |
| |
| #define OMP_RTL(Enum, ...) constexpr auto Enum = omp::RuntimeFunction::Enum; |
| #include "llvm/Frontend/OpenMP/OMPKinds.def" |
| |
| /// IDs for the different proc bind kinds. |
| enum class ProcBindKind { |
| #define OMP_PROC_BIND_KIND(Enum, Str, Value) Enum = Value, |
| #include "llvm/Frontend/OpenMP/OMPKinds.def" |
| }; |
| |
| #define OMP_PROC_BIND_KIND(Enum, ...) \ |
| constexpr auto Enum = omp::ProcBindKind::Enum; |
| #include "llvm/Frontend/OpenMP/OMPKinds.def" |
| |
| /// IDs for all omp runtime library ident_t flag encodings (see |
| /// their defintion in openmp/runtime/src/kmp.h). |
| enum class IdentFlag { |
| #define OMP_IDENT_FLAG(Enum, Str, Value) Enum = Value, |
| #include "llvm/Frontend/OpenMP/OMPKinds.def" |
| LLVM_MARK_AS_BITMASK_ENUM(0x7FFFFFFF) |
| }; |
| |
| #define OMP_IDENT_FLAG(Enum, ...) constexpr auto Enum = omp::IdentFlag::Enum; |
| #include "llvm/Frontend/OpenMP/OMPKinds.def" |
| |
| /// Parse \p Str and return the directive it matches or OMPD_unknown if none. |
| Directive getOpenMPDirectiveKind(StringRef Str); |
| |
| /// Return a textual representation of the directive \p D. |
| StringRef getOpenMPDirectiveName(Directive D); |
| |
| /// Forward declarations for LLVM-IR types (simple, function and structure) are |
| /// generated below. Their names are defined and used in OpenMP/OMPKinds.def. |
| /// Here we provide the forward declarations, the initializeTypes function will |
| /// provide the values. |
| /// |
| ///{ |
| namespace types { |
| |
| #define OMP_TYPE(VarName, InitValue) extern Type *VarName; |
| #define OMP_FUNCTION_TYPE(VarName, IsVarArg, ReturnType, ...) \ |
| extern FunctionType *VarName; \ |
| extern PointerType *VarName##Ptr; |
| #define OMP_STRUCT_TYPE(VarName, StrName, ...) \ |
| extern StructType *VarName; \ |
| extern PointerType *VarName##Ptr; |
| #include "llvm/Frontend/OpenMP/OMPKinds.def" |
| |
| /// Helper to initialize all types defined in OpenMP/OMPKinds.def. |
| void initializeTypes(Module &M); |
| |
| /// Helper to uninitialize all types defined in OpenMP/OMPKinds.def. |
| void uninitializeTypes(); |
| |
| } // namespace types |
| ///} |
| |
| } // end namespace omp |
| |
| } // end namespace llvm |
| |
| #endif // LLVM_OPENMP_CONSTANTS_H |