clang  16.0.0git
Public Member Functions | Static Public Member Functions | List of all members
clang::Builtin::Context Class Reference

Holds information about both target-independent and target-specific builtins, allowing easy queries by clients. More...

#include "clang/Basic/Builtins.h"

Public Member Functions

 Context ()=default
 
void InitializeTarget (const TargetInfo &Target, const TargetInfo *AuxTarget)
 Perform target-specific initialization. More...
 
void initializeBuiltins (IdentifierTable &Table, const LangOptions &LangOpts)
 Mark the identifiers for all the builtins with their appropriate builtin ID # and mark any non-portable builtin identifiers as such. More...
 
const char * getName (unsigned ID) const
 Return the identifier name for the specified builtin, e.g. More...
 
const char * getTypeString (unsigned ID) const
 Get the type descriptor string for the specified builtin. More...
 
bool isTSBuiltin (unsigned ID) const
 Return true if this function is a target-specific builtin. More...
 
bool isPure (unsigned ID) const
 Return true if this function has no side effects. More...
 
bool isConst (unsigned ID) const
 Return true if this function has no side effects and doesn't read memory. More...
 
bool isNoThrow (unsigned ID) const
 Return true if we know this builtin never throws an exception. More...
 
bool isNoReturn (unsigned ID) const
 Return true if we know this builtin never returns. More...
 
bool isReturnsTwice (unsigned ID) const
 Return true if we know this builtin can return twice. More...
 
bool isUnevaluated (unsigned ID) const
 Returns true if this builtin does not perform the side-effects of its arguments. More...
 
bool isLibFunction (unsigned ID) const
 Return true if this is a builtin for a libc/libm function, with a "__builtin_" prefix (e.g. More...
 
bool isPredefinedLibFunction (unsigned ID) const
 Determines whether this builtin is a predefined libc/libm function, such as "malloc", where we know the signature a priori. More...
 
bool isHeaderDependentFunction (unsigned ID) const
 Returns true if this builtin requires appropriate header in other compilers. More...
 
bool isPredefinedRuntimeFunction (unsigned ID) const
 Determines whether this builtin is a predefined compiler-rt/libgcc function, such as "__clear_cache", where we know the signature a priori. More...
 
bool isInStdNamespace (unsigned ID) const
 Determines whether this builtin is a C++ standard library function that lives in (possibly-versioned) namespace std, possibly a template specialization, where the signature is determined by the standard library declaration. More...
 
bool isDirectlyAddressable (unsigned ID) const
 Determines whether this builtin can have its address taken with no special action required. More...
 
bool hasCustomTypechecking (unsigned ID) const
 Determines whether this builtin has custom typechecking. More...
 
bool allowTypeMismatch (unsigned ID) const
 Determines whether a declaration of this builtin should be recognized even if the type doesn't match the specified signature. More...
 
bool hasPtrArgsOrResult (unsigned ID) const
 Determines whether this builtin has a result or any arguments which are pointer types. More...
 
bool hasReferenceArgsOrResult (unsigned ID) const
 Return true if this builtin has a result or any arguments which are reference types. More...
 
const char * getHeaderName (unsigned ID) const
 If this is a library function that comes from a specific header, retrieve that header name. More...
 
bool isPrintfLike (unsigned ID, unsigned &FormatIdx, bool &HasVAListArg)
 Determine whether this builtin is like printf in its formatting rules and, if so, set the index to the format string argument and whether this function as a va_list argument. More...
 
bool isScanfLike (unsigned ID, unsigned &FormatIdx, bool &HasVAListArg)
 Determine whether this builtin is like scanf in its formatting rules and, if so, set the index to the format string argument and whether this function as a va_list argument. More...
 
bool performsCallback (unsigned ID, llvm::SmallVectorImpl< int > &Encoding) const
 Determine whether this builtin has callback behavior (see llvm::AbstractCallSites for details). More...
 
bool isConstWithoutErrnoAndExceptions (unsigned ID) const
 Return true if this function has no side effects and doesn't read memory, except for possibly errno or raising FP exceptions. More...
 
bool isConstWithoutExceptions (unsigned ID) const
 
const char * getRequiredFeatures (unsigned ID) const
 
unsigned getRequiredVectorWidth (unsigned ID) const
 
bool isAuxBuiltinID (unsigned ID) const
 Return true if builtin ID belongs to AuxTarget. More...
 
unsigned getAuxBuiltinID (unsigned ID) const
 Return real builtin ID (i.e. More...
 
bool canBeRedeclared (unsigned ID) const
 Returns true if this is a builtin that can be redeclared. More...
 
bool isConstantEvaluated (unsigned ID) const
 Return true if this function can be constant evaluated by Clang frontend. More...
 

Static Public Member Functions

static bool isBuiltinFunc (llvm::StringRef Name)
 Returns true if this is a libc/libm function without the '__builtin_' prefix. More...
 

Detailed Description

Holds information about both target-independent and target-specific builtins, allowing easy queries by clients.

Builtins from an optional auxiliary target are stored in AuxTSRecords. Their IDs are shifted up by TSRecords.size() and need to be translated back with getAuxBuiltinID() before use.

Definition at line 71 of file Builtins.h.

Constructor & Destructor Documentation

◆ Context()

clang::Builtin::Context::Context ( )
default

Member Function Documentation

◆ allowTypeMismatch()

bool clang::Builtin::Context::allowTypeMismatch ( unsigned  ID) const
inline

Determines whether a declaration of this builtin should be recognized even if the type doesn't match the specified signature.

Definition at line 190 of file Builtins.h.

References hasCustomTypechecking().

◆ canBeRedeclared()

bool Builtin::Context::canBeRedeclared ( unsigned  ID) const

Returns true if this is a builtin that can be redeclared.

Returns true for non-builtins.

Definition at line 210 of file Builtins.cpp.

References clang::Builtin::NotBuiltin.

Referenced by clang::ASTContext::canBuiltinBeRedeclared().

◆ getAuxBuiltinID()

unsigned clang::Builtin::Context::getAuxBuiltinID ( unsigned  ID) const
inline

Return real builtin ID (i.e.

ID it would have during compilation for AuxTarget).

Definition at line 256 of file Builtins.h.

Referenced by ArmSveAliasValid().

◆ getHeaderName()

const char* clang::Builtin::Context::getHeaderName ( unsigned  ID) const
inline

If this is a library function that comes from a specific header, retrieve that header name.

Definition at line 210 of file Builtins.h.

References clang::Builtin::Info::HeaderName.

◆ getName()

const char* clang::Builtin::Context::getName ( unsigned  ID) const
inline

Return the identifier name for the specified builtin, e.g.

"__builtin_abs".

Definition at line 89 of file Builtins.h.

References clang::Builtin::Info::Name.

◆ getRequiredFeatures()

const char* clang::Builtin::Context::getRequiredFeatures ( unsigned  ID) const
inline

◆ getRequiredVectorWidth()

unsigned Builtin::Context::getRequiredVectorWidth ( unsigned  ID) const

Definition at line 134 of file Builtins.cpp.

◆ getTypeString()

const char* clang::Builtin::Context::getTypeString ( unsigned  ID) const
inline

Get the type descriptor string for the specified builtin.

Definition at line 94 of file Builtins.h.

References clang::Builtin::Info::Type.

Referenced by clang::ASTContext::GetBuiltinType().

◆ hasCustomTypechecking()

bool clang::Builtin::Context::hasCustomTypechecking ( unsigned  ID) const
inline

Determines whether this builtin has custom typechecking.

Definition at line 184 of file Builtins.h.

Referenced by allowTypeMismatch(), clang::Sema::BuildResolvedCallExpr(), clang::ASTContext::canBuiltinBeRedeclared(), and clang::Sema::ConvertArgumentsForCall().

◆ hasPtrArgsOrResult()

bool clang::Builtin::Context::hasPtrArgsOrResult ( unsigned  ID) const
inline

Determines whether this builtin has a result or any arguments which are pointer types.

Definition at line 197 of file Builtins.h.

Referenced by rewriteBuiltinFunctionDecl().

◆ hasReferenceArgsOrResult()

bool clang::Builtin::Context::hasReferenceArgsOrResult ( unsigned  ID) const
inline

Return true if this builtin has a result or any arguments which are reference types.

Definition at line 203 of file Builtins.h.

◆ initializeBuiltins()

void Builtin::Context::initializeBuiltins ( IdentifierTable Table,
const LangOptions LangOpts 
)

Mark the identifiers for all the builtins with their appropriate builtin ID # and mark any non-portable builtin identifiers as such.

initializeBuiltins - Mark the identifiers for all the builtins with their appropriate builtin ID # and mark any non-portable builtin identifiers as such.

Definition at line 102 of file Builtins.cpp.

Referenced by clang::FrontendAction::BeginSourceFile(), and clang::createChainedIncludesSource().

◆ InitializeTarget()

void Builtin::Context::InitializeTarget ( const TargetInfo Target,
const TargetInfo AuxTarget 
)

Perform target-specific initialization.

Parameters
AuxTargetTarget info to incorporate builtins from. May be nullptr.

Definition at line 43 of file Builtins.cpp.

References clang::TargetInfo::getTargetBuiltins(), and clang::Target.

◆ isAuxBuiltinID()

bool clang::Builtin::Context::isAuxBuiltinID ( unsigned  ID) const
inline

Return true if builtin ID belongs to AuxTarget.

Definition at line 250 of file Builtins.h.

References clang::Builtin::FirstTSBuiltin.

Referenced by clang::Sema::AddKnownFunctionAttributes(), and ArmSveAliasValid().

◆ isBuiltinFunc()

bool Builtin::Context::isBuiltinFunc ( llvm::StringRef  Name)
static

Returns true if this is a libc/libm function without the '__builtin_' prefix.

Definition at line 51 of file Builtins.cpp.

References BuiltinInfo, clang::Builtin::FirstTSBuiltin, clang::Builtin::Info::Name, and clang::Builtin::NotBuiltin.

Referenced by getAllNoBuiltinFuncValues().

◆ isConst()

bool clang::Builtin::Context::isConst ( unsigned  ID) const
inline

Return true if this function has no side effects and doesn't read memory.

Definition at line 110 of file Builtins.h.

Referenced by clang::Sema::AddKnownFunctionAttributes().

◆ isConstantEvaluated()

bool clang::Builtin::Context::isConstantEvaluated ( unsigned  ID) const
inline

Return true if this function can be constant evaluated by Clang frontend.

Definition at line 267 of file Builtins.h.

◆ isConstWithoutErrnoAndExceptions()

bool clang::Builtin::Context::isConstWithoutErrnoAndExceptions ( unsigned  ID) const
inline

Return true if this function has no side effects and doesn't read memory, except for possibly errno or raising FP exceptions.

Such functions can be const when the MathErrno lang option and FP exceptions are disabled.

Definition at line 235 of file Builtins.h.

Referenced by clang::Sema::AddKnownFunctionAttributes().

◆ isConstWithoutExceptions()

bool clang::Builtin::Context::isConstWithoutExceptions ( unsigned  ID) const
inline

Definition at line 239 of file Builtins.h.

Referenced by clang::Sema::AddKnownFunctionAttributes().

◆ isDirectlyAddressable()

bool clang::Builtin::Context::isDirectlyAddressable ( unsigned  ID) const
inline

Determines whether this builtin can have its address taken with no special action required.

Definition at line 176 of file Builtins.h.

References isInStdNamespace(), and isPredefinedLibFunction().

Referenced by clang::Sema::BuildDeclarationNameExpr(), and clang::Sema::FixOverloadedFunctionReference().

◆ isHeaderDependentFunction()

bool clang::Builtin::Context::isHeaderDependentFunction ( unsigned  ID) const
inline

Returns true if this builtin requires appropriate header in other compilers.

In Clang it will work even without including it, but we can emit a warning about missing header.

Definition at line 155 of file Builtins.h.

◆ isInStdNamespace()

bool clang::Builtin::Context::isInStdNamespace ( unsigned  ID) const
inline

Determines whether this builtin is a C++ standard library function that lives in (possibly-versioned) namespace std, possibly a template specialization, where the signature is determined by the standard library declaration.

Definition at line 170 of file Builtins.h.

Referenced by clang::Sema::CheckPlaceholderExpr(), and isDirectlyAddressable().

◆ isLibFunction()

bool clang::Builtin::Context::isLibFunction ( unsigned  ID) const
inline

Return true if this is a builtin for a libc/libm function, with a "__builtin_" prefix (e.g.

__builtin_abs).

Definition at line 137 of file Builtins.h.

Referenced by clang::CodeGen::CodeGenModule::getBuiltinLibFunction().

◆ isNoReturn()

bool clang::Builtin::Context::isNoReturn ( unsigned  ID) const
inline

Return true if we know this builtin never returns.

Definition at line 120 of file Builtins.h.

Referenced by clang::ASTContext::GetBuiltinType().

◆ isNoThrow()

bool clang::Builtin::Context::isNoThrow ( unsigned  ID) const
inline

Return true if we know this builtin never throws an exception.

Definition at line 115 of file Builtins.h.

Referenced by clang::Sema::AddKnownFunctionAttributes(), and clang::ASTContext::GetBuiltinType().

◆ isPredefinedLibFunction()

bool clang::Builtin::Context::isPredefinedLibFunction ( unsigned  ID) const
inline

Determines whether this builtin is a predefined libc/libm function, such as "malloc", where we know the signature a priori.

In C, such functions behave as if they are predeclared, possibly with a warning on first use. In Objective-C and C++, they do not, but they are recognized as builtins once we see a declaration.

Definition at line 148 of file Builtins.h.

Referenced by clang::Sema::ActOnStartOfFunctionDef(), EmitDirectCallee(), clang::FunctionDecl::getBuiltinID(), and isDirectlyAddressable().

◆ isPredefinedRuntimeFunction()

bool clang::Builtin::Context::isPredefinedRuntimeFunction ( unsigned  ID) const
inline

Determines whether this builtin is a predefined compiler-rt/libgcc function, such as "__clear_cache", where we know the signature a priori.

Definition at line 162 of file Builtins.h.

Referenced by clang::Sema::ActOnStartOfFunctionDef().

◆ isPrintfLike()

bool Builtin::Context::isPrintfLike ( unsigned  ID,
unsigned FormatIdx,
bool HasVAListArg 
)

Determine whether this builtin is like printf in its formatting rules and, if so, set the index to the format string argument and whether this function as a va_list argument.

Definition at line 173 of file Builtins.cpp.

Referenced by clang::Sema::AddKnownFunctionAttributes().

◆ isPure()

bool clang::Builtin::Context::isPure ( unsigned  ID) const
inline

Return true if this function has no side effects.

Definition at line 104 of file Builtins.h.

Referenced by clang::Sema::AddKnownFunctionAttributes().

◆ isReturnsTwice()

bool clang::Builtin::Context::isReturnsTwice ( unsigned  ID) const
inline

Return true if we know this builtin can return twice.

Definition at line 125 of file Builtins.h.

Referenced by clang::Sema::AddKnownFunctionAttributes().

◆ isScanfLike()

bool Builtin::Context::isScanfLike ( unsigned  ID,
unsigned FormatIdx,
bool HasVAListArg 
)

Determine whether this builtin is like scanf in its formatting rules and, if so, set the index to the format string argument and whether this function as a va_list argument.

Definition at line 178 of file Builtins.cpp.

Referenced by clang::Sema::AddKnownFunctionAttributes().

◆ isTSBuiltin()

bool clang::Builtin::Context::isTSBuiltin ( unsigned  ID) const
inline

Return true if this function is a target-specific builtin.

Definition at line 99 of file Builtins.h.

References clang::Builtin::FirstTSBuiltin.

Referenced by clang::Sema::AddKnownFunctionAttributes().

◆ isUnevaluated()

bool clang::Builtin::Context::isUnevaluated ( unsigned  ID) const
inline

Returns true if this builtin does not perform the side-effects of its arguments.

Definition at line 131 of file Builtins.h.

Referenced by clang::CallExpr::isUnevaluatedBuiltinCall().

◆ performsCallback()

bool Builtin::Context::performsCallback ( unsigned  ID,
llvm::SmallVectorImpl< int > &  Encoding 
) const

Determine whether this builtin has callback behavior (see llvm::AbstractCallSites for details).

If so, add the index to the callback callee argument and the callback payload arguments.

Definition at line 183 of file Builtins.cpp.

Referenced by clang::Sema::AddKnownFunctionAttributes().


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