LLVM: llvm::LLVMContext Class Reference (original) (raw)

This is an important class for using LLVM in a threaded context. More...

#include "[llvm/IR/LLVMContext.h](LLVMContext%5F8h%5Fsource.html)"

This is an important class for using LLVM in a threaded context.

It (opaquely) owns and manages the core "global" data of LLVM's core infrastructure, including the type and constant uniquing tables. LLVMContext itself provides no locking guarantees, so you should be careful to have one context per thread.

Definition at line 68 of file LLVMContext.h.

◆ YieldCallbackTy

◆ anonymous enum

Known operand bundle tag IDs, which always have the same value.

All operand bundle tags that LLVM has special knowledge of are listed here. Additionally, this scheme allows LLVM to efficiently check for specific operand bundle tags without comparing strings. Keep this in sync with LLVMContext::LLVMContext().

Definition at line 89 of file LLVMContext.h.

◆ anonymous enum

Definition at line 67 of file LLVMContext.cpp.

References assert(), getMDKindID(), knownBundleName(), OB_deopt, OB_LastBundleID, pImpl, llvm::SyncScope::SingleThread, and llvm::SyncScope::System.

Referenced by getLLVMRemarkStreamer(), getMainRemarkStreamer(), LLVMContext(), and operator=().

◆ LLVMContext() [2/2]

◆ ~LLVMContext()

◆ deleteGC()

◆ diagnose()

Report a message to the currently installed diagnostic handler.

This function returns, in particular in the case of error reporting (DI.Severity == DS_Error), so the caller should leave the compilation process in a self-consistent state, even though the generated code need not be correct.

The diagnostic message will be implicitly prefixed with a severity keyword according to DI.getSeverity(), i.e., "error: " for DS_Error, "warning: " for DS_Warning, and "note: " for DS_Note.

Definition at line 249 of file LLVMContext.cpp.

References llvm::DS_Error, llvm::dyn_cast(), llvm::errs(), getDiagnosticMessagePrefix(), getLLVMRemarkStreamer(), llvm::DiagnosticInfo::getSeverity(), isDiagnosticEnabled(), pImpl, and llvm::DiagnosticInfo::print().

Referenced by diagnoseInvalidFormatString(), llvm::MachineOptimizationRemarkEmitter::emit(), emitError(), emitError(), llvm::MachineInstr::emitGenericError(), llvm::MachineInstr::emitInlineAsmError(), EmitInlineAsmStr(), emitNonHSAIntrinsicError(), llvm::RISCVFrameLowering::emitPrologue(), emitRemovedIntrinsicError(), emitUnsupportedError(), errorUnsupported(), fail(), InstrumentAllFunctions(), isValidIndirectionTable(), llvm::AMDGPULegalizerInfo::legalizeBVHDualOrBVH8IntersectRayIntrinsic(), llvm::AMDGPULegalizerInfo::legalizeBVHIntersectRayIntrinsic(), llvm::AMDGPULegalizerInfo::legalizeDebugTrap(), llvm::AMDGPULegalizerInfo::legalizeGlobalValue(), llvm::RISCVTargetLowering::LowerCall(), llvm::AMDGPUTargetLowering::LowerDYNAMIC_STACKALLOC(), llvm::NVPTXTargetLowering::LowerDYNAMIC_STACKALLOC(), llvm::SITargetLowering::LowerFormalArguments(), llvm::AMDGPUTargetLowering::LowerGlobalAddress(), llvm::LegalizerHelper::lowerReadWriteRegister(), llvm::RISCVTargetLowering::LowerReturn(), llvm::NVPTXTargetLowering::LowerSTACKRESTORE(), llvm::NVPTXTargetLowering::LowerSTACKSAVE(), llvm::AMDGPUTargetLowering::lowerUnhandledCall(), replaceAtomicSwap128(), reportNonStaticGEPChain(), llvm::KCFIPass::run(), llvm::SelectionDAGISel::runOnMachineFunction(), selectExplicitSectionGlobal(), and verifyLoadedModule().

◆ disableDebugTypeODRUniquing()

◆ emitError() [1/2]

emitError - Emit an error message to the currently installed error handler with optional location information.

This function returns, so code should be prepared to drop the erroneous construct on the floor and "not crash". The generated code need not be correct. The error message will be implicitly prefixed with "error: " and should not end with a ".".

Definition at line 214 of file LLVMContext.cpp.

References assert(), diagnose(), and I.

Referenced by checkIntrinsicImmArg(), emitErrorAndReplaceIntrinsicResults(), emitErrorMsg(), emitIntrinsicErrorMessage(), emitIntrinsicWithChainErrorMessage(), llvm::AsmPrinter::emitSpecialLLVMGlobal(), getBBAddrMapFeature(), llvm::SITargetLowering::getRegisterByName(), INITIALIZE_PASS(), legalizeIntrinsicImmArg(), lowerVectorBitClearImm(), lowerVectorBitRevImm(), lowerVectorBitSetImm(), lowerVectorPickVE2GR(), lowerVectorSplatImm(), and llvm::LoongArchTargetLowering::ReplaceNodeResults().

◆ emitError() [2/2]

◆ enableDebugTypeODRUniquing()

◆ generateMachineFunctionNum()

◆ getDefaultTargetCPU()

Get or set the current "default" target CPU (target-cpu function attribute).

The intent is that compiler frontends will set this to a value that reflects the attribute that a function would get "by default" without any specific function attributes, and compiler passes will attach the attribute to newly created functions that are not associated with a particular function, such as global initializers. Function::createWithDefaultAttr() will create functions with this attribute. This function should only be called by passes that run at compile time and not by the backend or LTO passes.

Definition at line 369 of file LLVMContext.cpp.

References pImpl.

◆ getDefaultTargetFeatures()

Similar to {get,set}DefaultTargetCPU() but for default target-features.

Definition at line 377 of file LLVMContext.cpp.

References pImpl.

◆ getDiagHandlerPtr()

◆ getDiagnosticContext()

getDiagnosticContext - Return the diagnostic context set by setDiagnosticContext.

Definition at line 195 of file LLVMContext.cpp.

References pImpl.

◆ getDiagnosticHandler()

◆ getDiagnosticHandlerCallBack()

getDiagnosticHandlerCallBack - Return the diagnostic handler call back set by setDiagnosticHandlerCallBack.

Definition at line 191 of file LLVMContext.cpp.

References pImpl.

◆ getDiagnosticMessagePrefix()

◆ getDiagnosticsHotnessRequested()

◆ getDiagnosticsHotnessThreshold()

Return the minimum hotness value a diagnostic would need in order to be included in optimization diagnostics.

Three possible return values: 0 - threshold is disabled. Everything will be printed out. positive int - threshold is set. UINT64_MAX - threshold is not yet set, and needs to be synced from profile summary. Note that in case of missing profile summary, threshold will be kept at "MAX", effectively suppresses all remarks output.

Definition at line 153 of file LLVMContext.cpp.

References pImpl, and UINT64_MAX.

◆ getDiagnosticsMisExpectTolerance()

◆ getGC()

◆ getLLVMRemarkStreamer() [1/2]

The "LLVM remark streamer" used by LLVM to serialize remark diagnostics comming from IR and MIR passes.

If it does not exist, diagnostics are not saved in a file but only emitted via the diagnostic handler.

Definition at line 179 of file LLVMContext.cpp.

References pImpl.

Referenced by diagnose(), and getLLVMRemarkStreamer().

◆ getLLVMRemarkStreamer() [2/2]

◆ getMainRemarkStreamer() [1/2]

The "main remark streamer" used by all the specialized remark streamers.

This streamer keeps generic remark metadata in memory throughout the life of the LLVMContext. This metadata may be emitted in a section in object files depending on the format requirements.

All specialized remark streamers should convert remarks to llvm::remarks::Remark and emit them through this streamer.

Definition at line 168 of file LLVMContext.cpp.

References pImpl.

Referenced by getMainRemarkStreamer().

◆ getMainRemarkStreamer() [2/2]

◆ getMDKindID()

◆ getMDKindNames()

◆ getMisExpectWarningRequested()

◆ getOperandBundleTagID()

◆ getOperandBundleTags()

◆ getOptPassGate()

Access the object which can disable optional passes and individual optimizations at compile time.

Definition at line 353 of file LLVMContext.cpp.

References pImpl.

◆ getOrInsertBundleTag()

getOrInsertBundleTag - Returns the Tag to use for an operand bundle of name TagName.

Definition at line 302 of file LLVMContext.cpp.

References pImpl.

◆ getOrInsertSyncScopeID()

◆ getSyncScopeName()

◆ getSyncScopeNames()

getSyncScopeNames - Populates client supplied SmallVector with synchronization scope names registered with LLVMContext.

Synchronization scope names are ordered by increasing synchronization scope IDs.

Definition at line 314 of file LLVMContext.cpp.

References pImpl.

◆ incNextDILocationAtomGroup()

Key Instructions: get the next free atom group number and increment the global tracker.

Definition at line 389 of file LLVMContext.cpp.

References pImpl.

◆ isDiagnosticsHotnessThresholdSetFromPSI()

Return if hotness threshold is requested from PSI.

Definition at line 164 of file LLVMContext.cpp.

References pImpl.

◆ isODRUniquingDebugTypes()

Whether there is a string map for uniquing debug info identifiers across the context.

Off by default.

Definition at line 338 of file LLVMContext.cpp.

References pImpl.

◆ operator=()

◆ setDefaultTargetCPU()

◆ setDefaultTargetFeatures()

◆ setDiagnosticHandler()

◆ setDiagnosticHandlerCallBack()

setDiagnosticHandlerCallBack - This method sets a handler call back that is invoked when the backend needs to report anything to the user.

The first argument is a function pointer and the second is a context pointer that gets passed into the DiagHandler. The third argument should be set to true if the handler only expects enabled diagnostics.

LLVMContext doesn't take ownership or interpret either of these pointers.

Definition at line 123 of file LLVMContext.cpp.

References pImpl.

◆ setDiagnosticsHotnessRequested()

Set if a code hotness metric should be included in optimization diagnostics.

Definition at line 137 of file LLVMContext.cpp.

References pImpl.

◆ setDiagnosticsHotnessThreshold()

Set the minimum hotness value a diagnostic needs in order to be included in optimization diagnostics.

Definition at line 144 of file LLVMContext.cpp.

References pImpl.

◆ setDiagnosticsMisExpectTolerance()

◆ setDiscardValueNames()

◆ setGC()

◆ setLLVMRemarkStreamer()

◆ setMainRemarkStreamer()

◆ setMisExpectWarningRequested()

◆ setOptPassGate()

Set the object which can disable optional passes and individual optimizations at compile time.

The lifetime of the object must be guaranteed to extend as long as the LLVMContext is used by compilation.

Definition at line 357 of file LLVMContext.cpp.

References pImpl.

◆ setYieldCallback()

Registers a yield callback with the given context.

The yield callback function may be called by LLVM to transfer control back to the client that invoked the LLVM compilation. This can be used to yield control of the thread, or perform periodic work needed by the client. There is no guaranteed frequency at which callbacks must occur; in fact, the client is not guaranteed to ever receive this callback. It is at the sole discretion of LLVM to do so and only if it can guarantee that suspending the thread won't block any forward progress in other LLVM contexts in the same process.

At a suspend point, the state of the current LLVM context is intentionally undefined. No assumptions about it can or should be made. Only LLVM context API calls that explicitly state that they can be used during a yield callback are allowed to be used. Any other API calls into the context are not supported until the yield callback function returns control to LLVM. Other LLVM contexts are unaffected by this restriction.

Definition at line 199 of file LLVMContext.cpp.

References pImpl.

◆ shouldDiscardValueNames()

Return true if the Context runtime configuration is set to discard all value names.

When true, only GlobalValue names will be available in the IR.

Definition at line 334 of file LLVMContext.cpp.

References pImpl.

◆ updateDILocationAtomGroupWaterline()

Key Instructions: update the highest number atom group emitted for any function.

Definition at line 385 of file LLVMContext.cpp.

References pImpl.

◆ yield()

Calls the yield callback (if applicable).

This transfers control of the current thread back to the client, which may suspend the current thread. Only call this method when LLVM doesn't hold any global mutex or cannot block the execution in another LLVM context.

Definition at line 205 of file LLVMContext.cpp.

References pImpl.

◆ Module

◆ pImpl

Definition at line 70 of file LLVMContext.h.

Referenced by llvm::Value::addMetadata(), llvm::Value::clearMetadata(), deleteGC(), diagnose(), disableDebugTypeODRUniquing(), enableDebugTypeODRUniquing(), llvm::Value::eraseMetadata(), llvm::Value::eraseMetadataIf(), generateMachineFunctionNum(), llvm::BlockAddress::get(), llvm::ConstantExpr::get(), llvm::ConstantPointerNull::get(), llvm::ConstantPtrAuth::get(), llvm::DSOLocalEquivalent::get(), llvm::NoCFIValue::get(), llvm::PoisonValue::get(), llvm::TypedPointerType::get(), llvm::UndefValue::get(), llvm::Instruction::getAAMetadata(), llvm::Value::getAllMetadata(), getDefaultTargetCPU(), getDefaultTargetFeatures(), getDiagHandlerPtr(), getDiagnosticContext(), getDiagnosticHandler(), getDiagnosticHandlerCallBack(), getDiagnosticsHotnessRequested(), getDiagnosticsHotnessThreshold(), getDiagnosticsMisExpectTolerance(), llvm::ConstantExpr::getExtractElement(), getGC(), llvm::ConstantExpr::getInsertElement(), getLLVMRemarkStreamer(), getMainRemarkStreamer(), getMDKindID(), getMDKindNames(), llvm::Value::getMetadata(), getMisExpectWarningRequested(), getOperandBundleTagID(), getOperandBundleTags(), getOptPassGate(), getOrInsertBundleTag(), getOrInsertSyncScopeID(), llvm::GlobalValue::getPartition(), llvm::GlobalValue::getSanitizerMetadata(), llvm::ConstantExpr::getShuffleVector(), getSyncScopeName(), getSyncScopeNames(), llvm::DIArgList::handleChangedOperand(), incNextDILocationAtomGroup(), isDiagnosticsHotnessThresholdSetFromPSI(), isODRUniquingDebugTypes(), LLVMContext(), llvm::BlockAddress::lookup(), llvm::CallBase::populateBundleOperandInfos(), llvm::GlobalValue::removeSanitizerMetadata(), setDefaultTargetCPU(), setDefaultTargetFeatures(), setDiagnosticHandler(), setDiagnosticHandlerCallBack(), setDiagnosticsHotnessRequested(), setDiagnosticsHotnessThreshold(), setDiagnosticsMisExpectTolerance(), setDiscardValueNames(), setGC(), setLLVMRemarkStreamer(), setMainRemarkStreamer(), llvm::Value::setMetadata(), setMisExpectWarningRequested(), setOptPassGate(), llvm::GlobalValue::setPartition(), llvm::GlobalValue::setSanitizerMetadata(), llvm::GlobalObject::setSection(), setYieldCallback(), shouldDiscardValueNames(), llvm::MDNode::storeDistinctInContext(), updateDILocationAtomGroupWaterline(), yield(), ~LLVMContext(), and llvm::MetadataAsValue::~MetadataAsValue().

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

• include/llvm/IR/LLVMContext.h
• lib/IR/LLVMContext.cpp