MemoryBuiltins.cpp File Reference

#include "llvm/Analysis/MemoryBuiltins.h"
#include "llvm/ADT/APInt.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/Analysis/AliasAnalysis.h"
#include "llvm/Analysis/TargetFolder.h"
#include "llvm/Analysis/TargetLibraryInfo.h"
#include "llvm/Analysis/Utils/Local.h"
#include "llvm/Analysis/ValueTracking.h"
#include "llvm/IR/Argument.h"
#include "llvm/IR/Attributes.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/DataLayout.h"
#include "llvm/IR/DerivedTypes.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/GlobalAlias.h"
#include "llvm/IR/GlobalVariable.h"
#include "llvm/IR/Instruction.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/IntrinsicInst.h"
#include "llvm/IR/Operator.h"
#include "llvm/IR/Type.h"
#include "llvm/IR/Value.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/MathExtras.h"
#include "llvm/Support/raw_ostream.h"
#include <cassert>
#include <cstdint>
#include <iterator>
#include <numeric>
#include <optional>
#include <utility>

Go to the source code of this file.

Classes
struct	AllocFnsTy
struct	FreeFnsTy

Macros
#define	DEBUG_TYPE   "memory-builtins"

Enumerations
enum	AllocType : uint8_t {   OpNewLike = 1<<0 , MallocLike = 1<<1 , StrDupLike = 1<<2 , MallocOrOpNewLike = MallocLike | OpNewLike ,   AllocLike = MallocOrOpNewLike | StrDupLike , AnyAlloc = AllocLike }
enum class	MallocFamily {   Malloc , CPPNew , CPPNewAligned , CPPNewArray ,   CPPNewArrayAligned , MSVCNew , MSVCArrayNew , VecMalloc ,   KmpcAllocShared }

Functions
StringRef	mangledNameForMallocFamily (const MallocFamily &Family)
static const Function *	getCalledFunction (const Value *V)
static std::optional< AllocFnsTy >	getAllocationDataForFunction (const Function *Callee, AllocType AllocTy, const TargetLibraryInfo *TLI)
	Returns the allocation data for the given value if it's a call to a known allocation function.
static std::optional< AllocFnsTy >	getAllocationData (const Value *V, AllocType AllocTy, const TargetLibraryInfo *TLI)
static std::optional< AllocFnsTy >	getAllocationData (const Value *V, AllocType AllocTy, function_ref< const TargetLibraryInfo &(Function &)> GetTLI)
static std::optional< AllocFnsTy >	getAllocationSize (const CallBase *CB, const TargetLibraryInfo *TLI)
static AllocFnKind	getAllocFnKind (const Value *V)
static AllocFnKind	getAllocFnKind (const Function *F)
static bool	checkFnAllocKind (const Value *V, AllocFnKind Wanted)
static bool	checkFnAllocKind (const Function *F, AllocFnKind Wanted)
static bool	CheckedZextOrTrunc (APInt &I, unsigned IntTyBits)
	When we're compiling N-bit code, and the user uses parameters that are greater than N bits (e.g.
std::optional< FreeFnsTy >	getFreeFunctionDataForFunction (const Function *Callee, const LibFunc TLIFn)
static APInt	getSizeWithOverflow (const SizeOffsetAPInt &Data)
	STATISTIC (ObjectVisitorArgument, "Number of arguments with unsolved size and offset")
	STATISTIC (ObjectVisitorLoad, "Number of load instructions with unsolved size and offset")
static std::optional< APInt >	combinePossibleConstantValues (std::optional< APInt > LHS, std::optional< APInt > RHS, ObjectSizeOpts::Mode EvalMode)
static std::optional< APInt >	aggregatePossibleConstantValuesImpl (const Value *V, ObjectSizeOpts::Mode EvalMode, unsigned recursionDepth)
static std::optional< APInt >	aggregatePossibleConstantValues (const Value *V, ObjectSizeOpts::Mode EvalMode)

Variables
static cl::opt< unsigned >	ObjectSizeOffsetVisitorMaxVisitInstructions ("object-size-offset-visitor-max-visit-instructions", cl::desc("Maximum number of instructions for ObjectSizeOffsetVisitor to " "look at"), cl::init(100))
static const std::pair< LibFunc, AllocFnsTy >	AllocationFnData []
static const std::pair< LibFunc, FreeFnsTy >	FreeFnData []

Macro Definition Documentation

DEBUG_TYPE

#define DEBUG_TYPE   "memory-builtins"

Definition at line 51 of file MemoryBuiltins.cpp.

Enumeration Type Documentation

AllocType

enum AllocType : uint8_t

Enumerator
OpNewLike
MallocLike
StrDupLike
MallocOrOpNewLike
AllocLike
AnyAlloc

Definition at line 59 of file MemoryBuiltins.cpp.

MallocFamily

enum class MallocFamily

strong

Enumerator
Malloc
CPPNew
CPPNewAligned
CPPNewArray
CPPNewArrayAligned
MSVCNew
MSVCArrayNew
VecMalloc
KmpcAllocShared

Definition at line 68 of file MemoryBuiltins.cpp.

Function Documentation

aggregatePossibleConstantValues()

static std::optional< APInt > aggregatePossibleConstantValues ( const Value *  V, ObjectSizeOpts::Mode  EvalMode  )

static

Definition at line 718 of file MemoryBuiltins.cpp.

References aggregatePossibleConstantValuesImpl().

Referenced by llvm::ObjectSizeOffsetVisitor::visitAllocaInst(), and llvm::ObjectSizeOffsetVisitor::visitCallBase().

aggregatePossibleConstantValuesImpl()

static std::optional< APInt > aggregatePossibleConstantValuesImpl ( const Value *  V, ObjectSizeOpts::Mode  EvalMode, unsigned  recursionDepth  )

static

Definition at line 685 of file MemoryBuiltins.cpp.

References aggregatePossibleConstantValuesImpl(), combinePossibleConstantValues(), and I.

Referenced by aggregatePossibleConstantValues(), and aggregatePossibleConstantValuesImpl().

CheckedZextOrTrunc()

static bool CheckedZextOrTrunc ( APInt &  I, unsigned  IntTyBits  )

static

When we're compiling N-bit code, and the user uses parameters that are greater than N bits (e.g.

uint64_t on a 32-bit build), we can run into trouble with APInt size issues. This function handles resizing + overflow checks for us. Check and zext or trunc I depending on IntTyBits and I's value.

Definition at line 355 of file MemoryBuiltins.cpp.

References I.

Referenced by llvm::getAllocSize().

checkFnAllocKind() [1/2]

static bool checkFnAllocKind ( const Function *  F, AllocFnKind  Wanted  )

static

Definition at line 280 of file MemoryBuiltins.cpp.

References F, and getAllocFnKind().

checkFnAllocKind() [2/2]

static bool checkFnAllocKind ( const Value *  V, AllocFnKind  Wanted  )

static

Definition at line 276 of file MemoryBuiltins.cpp.

References getAllocFnKind().

Referenced by llvm::getAllocationFamily(), llvm::getFreedOperand(), llvm::getReallocatedOperand(), llvm::isAllocationFn(), llvm::isAllocLikeFn(), llvm::isLibFreeFunction(), and llvm::isReallocLikeFn().

combinePossibleConstantValues()

static std::optional< APInt > combinePossibleConstantValues ( std::optional< APInt >  LHS, std::optional< APInt >  RHS, ObjectSizeOpts::Mode  EvalMode  )

static

Definition at line 674 of file MemoryBuiltins.cpp.

References LHS, and RHS.

Referenced by aggregatePossibleConstantValuesImpl().

getAllocationData() [1/2]

static std::optional< AllocFnsTy > getAllocationData ( const Value *  V, AllocType  AllocTy, const TargetLibraryInfo *  TLI  )

static

Definition at line 219 of file MemoryBuiltins.cpp.

References getAllocationDataForFunction(), and getCalledFunction().

Referenced by llvm::getAllocAlignment(), llvm::getInitialValueOfAllocation(), llvm::isAllocationFn(), llvm::isAllocLikeFn(), llvm::isMallocOrCallocLikeFn(), and llvm::isNewLikeFn().

getAllocationData() [2/2]

static std::optional< AllocFnsTy > getAllocationData ( const Value *  V, AllocType  AllocTy, function_ref< const TargetLibraryInfo &(Function &)>  GetTLI  )

static

Definition at line 227 of file MemoryBuiltins.cpp.

References getAllocationDataForFunction(), and getCalledFunction().

getAllocationDataForFunction()

static std::optional< AllocFnsTy > getAllocationDataForFunction ( const Function *  Callee, AllocType  AllocTy, const TargetLibraryInfo *  TLI  )

static

Returns the allocation data for the given value if it's a call to a known allocation function.

Definition at line 177 of file MemoryBuiltins.cpp.

References AllocationFnData, AllocFnsTy::AllocTy, llvm::find_if(), AllocFnsTy::FstParam, llvm::TargetLibraryInfo::getLibFunc(), llvm::TargetLibraryInfo::has(), AllocFnsTy::NumParams, P, and AllocFnsTy::SndParam.

Referenced by getAllocationData(), llvm::getAllocationFamily(), and getAllocationSize().

getAllocationSize()

static std::optional< AllocFnsTy > getAllocationSize ( const CallBase *  CB, const TargetLibraryInfo *  TLI  )

static

Definition at line 236 of file MemoryBuiltins.cpp.

References AnyAlloc, llvm::CallBase::arg_size(), getAllocationDataForFunction(), llvm::Attribute::getAllocSizeArgs(), getCalledFunction(), llvm::CallBase::getFnAttr(), and MallocLike.

Referenced by llvm::getAllocSize(), and llvm::ObjectSizeOffsetEvaluator::visitCallBase().

getAllocFnKind() [1/2]

static AllocFnKind getAllocFnKind ( const Function *  F )

static

Definition at line 272 of file MemoryBuiltins.cpp.

References F.

getAllocFnKind() [2/2]

static AllocFnKind getAllocFnKind ( const Value *  V )

static

Definition at line 263 of file MemoryBuiltins.cpp.

References llvm::Attribute::getValueAsInt(), and llvm::Attribute::isValid().

Referenced by checkFnAllocKind(), and llvm::getInitialValueOfAllocation().

getCalledFunction()

static const Function * getCalledFunction ( const Value *  V )

static

Definition at line 159 of file MemoryBuiltins.cpp.

Referenced by llvm::orc::SpeculateQuery::findCalles(), FindPreallocatedCall(), getAllocationData(), llvm::getAllocationFamily(), getAllocationSize(), llvm::getFreedOperand(), llvm::BasicTTIImplBase< T >::getUnrollingPreferences(), llvm::AArch64TTIImpl::getUnrollingPreferences(), llvm::ARMTTIImpl::getUnrollingPreferences(), llvm::RISCVTTIImpl::getUnrollingPreferences(), llvm::SystemZTTIImpl::getUnrollingPreferences(), llvm::WebAssemblyTTIImpl::getUnrollingPreferences(), and isNoReturnDef().

getFreeFunctionDataForFunction()

std::optional< FreeFnsTy > getFreeFunctionDataForFunction	(	const Function *	Callee,
		const LibFunc	TLIFn
	)

Definition at line 488 of file MemoryBuiltins.cpp.

References llvm::find_if(), FreeFnData, and P.

Referenced by llvm::getAllocationFamily(), and llvm::isLibFreeFunction().

getSizeWithOverflow()

static APInt getSizeWithOverflow ( const SizeOffsetAPInt &  Data )

static

Definition at line 564 of file MemoryBuiltins.cpp.

References llvm::APInt::getZero(), llvm::Offset, and Size.

Referenced by llvm::getObjectSize().

mangledNameForMallocFamily()

StringRef mangledNameForMallocFamily

(

const MallocFamily &

Family

)

Definition at line 80 of file MemoryBuiltins.cpp.

References CPPNew, CPPNewAligned, CPPNewArray, CPPNewArrayAligned, KmpcAllocShared, llvm_unreachable, Malloc, MSVCArrayNew, MSVCNew, and VecMalloc.

Referenced by llvm::getAllocationFamily().

STATISTIC() [1/2]

STATISTIC	(	ObjectVisitorArgument	,
		"Number of arguments with unsolved size and offset"
	)

STATISTIC() [2/2]

STATISTIC	(	ObjectVisitorLoad	,
		"Number of load instructions with unsolved size and offset"
	)

Variable Documentation

AllocationFnData

const std::pair<LibFunc, AllocFnsTy> AllocationFnData[]

static

Definition at line 118 of file MemoryBuiltins.cpp.

Referenced by getAllocationDataForFunction().

FreeFnData

const std::pair<LibFunc, FreeFnsTy> FreeFnData[]

static

Definition at line 455 of file MemoryBuiltins.cpp.

Referenced by getFreeFunctionDataForFunction().

ObjectSizeOffsetVisitorMaxVisitInstructions

cl::opt< unsigned > ObjectSizeOffsetVisitorMaxVisitInstructions("object-size-offset-visitor-max-visit-instructions", cl::desc("Maximum number of instructions for ObjectSizeOffsetVisitor to " "look at"), cl::init(100)) ( "object-size-offset-visitor-max-visit-instructions"  , cl::desc("Maximum number of instructions for ObjectSizeOffsetVisitor to " "look at")  , cl::init(100)    )

static