Captures attributes that affect generating LLVM-IR using the OpenMPIRBuilder and related classes. More...

#include "llvm/Frontend/OpenMP/OMPIRBuilder.h"

Public Member Functions
	OpenMPIRBuilderConfig ()

	OpenMPIRBuilderConfig (bool IsTargetDevice, bool IsGPU, bool OpenMPOffloadMandatory, bool HasRequiresReverseOffload, bool HasRequiresUnifiedAddress, bool HasRequiresUnifiedSharedMemory, bool HasRequiresDynamicAllocators)

bool	isTargetDevice () const

bool	isGPU () const

bool	openMPOffloadMandatory () const

omp::GV	getGridValue () const

bool	hasRequiresFlags () const

bool	hasRequiresReverseOffload () const

bool	hasRequiresUnifiedAddress () const

bool	hasRequiresUnifiedSharedMemory () const

bool	hasRequiresDynamicAllocators () const

int64_t	getRequiresFlags () const
	Returns requires directive clauses as flags compatible with those expected by libomptarget.

StringRef	firstSeparator () const

StringRef	separator () const

void	setIsTargetDevice (bool Value)

void	setIsGPU (bool Value)

void	setEmitLLVMUsed (bool Value=true)

void	setOpenMPOffloadMandatory (bool Value)

void	setFirstSeparator (StringRef FS)

void	setSeparator (StringRef S)

void	setGridValue (omp::GV G)

void	setHasRequiresReverseOffload (bool Value)

void	setHasRequiresUnifiedAddress (bool Value)

void	setHasRequiresUnifiedSharedMemory (bool Value)

void	setHasRequiresDynamicAllocators (bool Value)

Public Attributes
std::optional< bool >	IsTargetDevice
	Flag to define whether to generate code for the role of the OpenMP host (if set to false) or device (if set to true) in an offloading context.

std::optional< bool >	IsGPU
	Flag for specifying if the compilation is done for an accelerator.

std::optional< bool >	EmitLLVMUsedMetaInfo
	Flag for specifying if LLVMUsed information should be emitted.

std::optional< bool >	OpenMPOffloadMandatory
	Flag for specifying if offloading is mandatory.

std::optional< StringRef >	FirstSeparator
	First separator used between the initial two parts of a name.

std::optional< StringRef >	Separator
	Separator used between all of the rest consecutive parts of s name.

std::optional< omp::GV >	GridValue

SmallVector< Triple >	TargetTriples
	When compilation is being done for the OpenMP host (i.e.

Detailed Description

Captures attributes that affect generating LLVM-IR using the OpenMPIRBuilder and related classes.

Note that not all attributes are required for all classes or functions. In some use cases the configuration is not necessary at all, because because the only functions that are called are ones that are not dependent on the configuration.

Definition at line 87 of file OMPIRBuilder.h.

Constructor & Destructor Documentation

◆ OpenMPIRBuilderConfig() [1/2]

OpenMPIRBuilderConfig::OpenMPIRBuilderConfig ( )

Definition at line 422 of file OMPIRBuilder.cpp.

◆ OpenMPIRBuilderConfig() [2/2]

OpenMPIRBuilderConfig::OpenMPIRBuilderConfig	(	bool	IsTargetDevice,
		bool	IsGPU,
		bool	OpenMPOffloadMandatory,
		bool	HasRequiresReverseOffload,
		bool	HasRequiresUnifiedAddress,
		bool	HasRequiresUnifiedSharedMemory,
		bool	HasRequiresDynamicAllocators
	)

Definition at line 425 of file OMPIRBuilder.cpp.

Member Function Documentation

◆ firstSeparator()

StringRef llvm::OpenMPIRBuilderConfig::firstSeparator ( ) const

inline

Definition at line 165 of file OMPIRBuilder.h.

References FirstSeparator, and isGPU().

Referenced by llvm::OpenMPIRBuilder::createPlatformSpecificName().

◆ getGridValue()

omp::GV llvm::OpenMPIRBuilderConfig::getGridValue ( ) const

inline

Definition at line 148 of file OMPIRBuilder.h.

References assert(), and GridValue.

◆ getRequiresFlags()

int64_t OpenMPIRBuilderConfig::getRequiresFlags ( ) const

Returns requires directive clauses as flags compatible with those expected by libomptarget.

Definition at line 458 of file OMPIRBuilder.cpp.

References hasRequiresFlags().

Referenced by llvm::OpenMPIRBuilder::createOffloadEntriesAndInfoMetadata().

◆ hasRequiresDynamicAllocators()

bool OpenMPIRBuilderConfig::hasRequiresDynamicAllocators ( ) const

Definition at line 454 of file OMPIRBuilder.cpp.

◆ hasRequiresFlags()

bool llvm::OpenMPIRBuilderConfig::hasRequiresFlags ( ) const

inline

Definition at line 153 of file OMPIRBuilder.h.

Referenced by llvm::OpenMPIRBuilder::createOffloadEntriesAndInfoMetadata(), and getRequiresFlags().

◆ hasRequiresReverseOffload()

bool OpenMPIRBuilderConfig::hasRequiresReverseOffload ( ) const

Definition at line 442 of file OMPIRBuilder.cpp.

◆ hasRequiresUnifiedAddress()

bool OpenMPIRBuilderConfig::hasRequiresUnifiedAddress ( ) const

Definition at line 446 of file OMPIRBuilder.cpp.

◆ hasRequiresUnifiedSharedMemory()

bool OpenMPIRBuilderConfig::hasRequiresUnifiedSharedMemory ( ) const

Definition at line 450 of file OMPIRBuilder.cpp.

Referenced by llvm::OpenMPIRBuilder::createOffloadEntriesAndInfoMetadata(), llvm::OpenMPIRBuilder::getAddrOfDeclareTargetVar(), and llvm::OpenMPIRBuilder::registerTargetGlobalVariable().

◆ isGPU()

bool llvm::OpenMPIRBuilderConfig::isGPU ( ) const

inline

Definition at line 137 of file OMPIRBuilder.h.

References assert(), and IsGPU.

Referenced by llvm::OpenMPIRBuilder::createOffloadEntry(), firstSeparator(), and separator().

◆ isTargetDevice()

bool llvm::OpenMPIRBuilderConfig::isTargetDevice ( ) const

inline

Definition at line 132 of file OMPIRBuilder.h.

References assert(), and IsTargetDevice.

◆ openMPOffloadMandatory()

bool llvm::OpenMPIRBuilderConfig::openMPOffloadMandatory ( ) const

inline

Definition at line 142 of file OMPIRBuilder.h.

References assert(), and OpenMPOffloadMandatory.

Referenced by llvm::OpenMPIRBuilder::emitTargetRegionFunction().

◆ separator()

StringRef llvm::OpenMPIRBuilderConfig::separator ( ) const

inline

Definition at line 175 of file OMPIRBuilder.h.

References isGPU(), and Separator.

Referenced by llvm::OpenMPIRBuilder::createPlatformSpecificName().

◆ setEmitLLVMUsed()

void llvm::OpenMPIRBuilderConfig::setEmitLLVMUsed ( bool Value = true )

inline

Definition at line 185 of file OMPIRBuilder.h.

References EmitLLVMUsedMetaInfo.

Referenced by llvm::OpenMPIRBuilder::createReductionsGPU().

◆ setFirstSeparator()

void llvm::OpenMPIRBuilderConfig::setFirstSeparator ( StringRef FS )

inline

Definition at line 187 of file OMPIRBuilder.h.

References FirstSeparator.

◆ setGridValue()

void llvm::OpenMPIRBuilderConfig::setGridValue ( omp::GV G )

inline

Definition at line 189 of file OMPIRBuilder.h.

References G, and GridValue.

Referenced by llvm::OpenMPIRBuilder::createReductionsGPU().

◆ setHasRequiresDynamicAllocators()

void OpenMPIRBuilderConfig::setHasRequiresDynamicAllocators ( bool Value )

Definition at line 484 of file OMPIRBuilder.cpp.

◆ setHasRequiresReverseOffload()

void OpenMPIRBuilderConfig::setHasRequiresReverseOffload ( bool Value )

Definition at line 463 of file OMPIRBuilder.cpp.

◆ setHasRequiresUnifiedAddress()

void OpenMPIRBuilderConfig::setHasRequiresUnifiedAddress ( bool Value )

Definition at line 470 of file OMPIRBuilder.cpp.

◆ setHasRequiresUnifiedSharedMemory()

void OpenMPIRBuilderConfig::setHasRequiresUnifiedSharedMemory ( bool Value )

Definition at line 477 of file OMPIRBuilder.cpp.

◆ setIsGPU()

void llvm::OpenMPIRBuilderConfig::setIsGPU ( bool Value )

inline

Definition at line 184 of file OMPIRBuilder.h.

References IsGPU.

◆ setIsTargetDevice()

void llvm::OpenMPIRBuilderConfig::setIsTargetDevice ( bool Value )

inline

Definition at line 183 of file OMPIRBuilder.h.

References IsTargetDevice.

◆ setOpenMPOffloadMandatory()

void llvm::OpenMPIRBuilderConfig::setOpenMPOffloadMandatory ( bool Value )

inline

Definition at line 186 of file OMPIRBuilder.h.

References OpenMPOffloadMandatory.

◆ setSeparator()

void llvm::OpenMPIRBuilderConfig::setSeparator ( StringRef S )

inline

Definition at line 188 of file OMPIRBuilder.h.

References Separator.

Member Data Documentation

◆ EmitLLVMUsedMetaInfo

std::optional<bool> llvm::OpenMPIRBuilderConfig::EmitLLVMUsedMetaInfo

Flag for specifying if LLVMUsed information should be emitted.

Definition at line 106 of file OMPIRBuilder.h.

Referenced by llvm::OpenMPIRBuilder::finalize(), and setEmitLLVMUsed().

◆ FirstSeparator

std::optional<StringRef> llvm::OpenMPIRBuilderConfig::FirstSeparator

First separator used between the initial two parts of a name.

Definition at line 112 of file OMPIRBuilder.h.

Referenced by firstSeparator(), and setFirstSeparator().

◆ GridValue

std::optional<omp::GV> llvm::OpenMPIRBuilderConfig::GridValue

Definition at line 117 of file OMPIRBuilder.h.

Referenced by getGridValue(), and setGridValue().

◆ IsGPU

std::optional<bool> llvm::OpenMPIRBuilderConfig::IsGPU

Flag for specifying if the compilation is done for an accelerator.

It is set according to the architecture of the target triple and currently only true when targeting AMDGPU or NVPTX. Today, these targets can only perform the role of an OpenMP target device, so IsTargetDevice must also be true if IsGPU is true. This restriction might be lifted if an accelerator- like target with the ability to work as the OpenMP host is added, or if the capabilities of the currently supported GPU architectures are expanded.

Definition at line 103 of file OMPIRBuilder.h.

Referenced by isGPU(), and setIsGPU().

◆ IsTargetDevice

std::optional<bool> llvm::OpenMPIRBuilderConfig::IsTargetDevice

Flag to define whether to generate code for the role of the OpenMP host (if set to false) or device (if set to true) in an offloading context.

It is set when the -fopenmp-is-target-device compiler frontend option is specified.

Definition at line 93 of file OMPIRBuilder.h.

Referenced by llvm::OpenMPIRBuilder::createTargetData(), isTargetDevice(), and setIsTargetDevice().

◆ OpenMPOffloadMandatory

std::optional<bool> llvm::OpenMPIRBuilderConfig::OpenMPOffloadMandatory

Flag for specifying if offloading is mandatory.

Definition at line 109 of file OMPIRBuilder.h.

Referenced by openMPOffloadMandatory(), and setOpenMPOffloadMandatory().

◆ Separator

std::optional<StringRef> llvm::OpenMPIRBuilderConfig::Separator

Separator used between all of the rest consecutive parts of s name.

Definition at line 114 of file OMPIRBuilder.h.

Referenced by separator(), and setSeparator().

◆ TargetTriples

SmallVector<Triple> llvm::OpenMPIRBuilderConfig::TargetTriples

When compilation is being done for the OpenMP host (i.e.

IsTargetDevice = false), this contains the list of offloading triples associated, if any.

Definition at line 121 of file OMPIRBuilder.h.

The documentation for this class was generated from the following files:

include/llvm/Frontend/OpenMP/OMPIRBuilder.h
lib/Frontend/OpenMP/OMPIRBuilder.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OpenMPIRBuilderConfig() [1/2]

◆ OpenMPIRBuilderConfig() [2/2]

Member Function Documentation

◆ firstSeparator()

◆ getGridValue()

◆ getRequiresFlags()

◆ hasRequiresDynamicAllocators()

◆ hasRequiresFlags()

◆ hasRequiresReverseOffload()

◆ hasRequiresUnifiedAddress()

◆ hasRequiresUnifiedSharedMemory()

◆ isGPU()

◆ isTargetDevice()

◆ openMPOffloadMandatory()

◆ separator()

◆ setEmitLLVMUsed()

◆ setFirstSeparator()

◆ setGridValue()

◆ setHasRequiresDynamicAllocators()

◆ setHasRequiresReverseOffload()

◆ setHasRequiresUnifiedAddress()

◆ setHasRequiresUnifiedSharedMemory()

◆ setIsGPU()

◆ setIsTargetDevice()

◆ setOpenMPOffloadMandatory()

◆ setSeparator()

Member Data Documentation

◆ EmitLLVMUsedMetaInfo

◆ FirstSeparator

◆ GridValue

◆ IsGPU

◆ IsTargetDevice

◆ OpenMPOffloadMandatory

◆ Separator

◆ TargetTriples