#include "llvm/Transforms/Instrumentation/NumericalStabilitySanitizer.h"
#include "llvm/ADT/DenseMap.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/Analysis/TargetLibraryInfo.h"
#include "llvm/Analysis/ValueTracking.h"
#include "llvm/IR/DataLayout.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/IntrinsicInst.h"
#include "llvm/IR/Intrinsics.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/MDBuilder.h"
#include "llvm/IR/Metadata.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Type.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/Regex.h"
#include "llvm/Support/raw_ostream.h"
#include "llvm/Transforms/Utils/BasicBlockUtils.h"
#include "llvm/Transforms/Utils/Instrumentation.h"
#include "llvm/Transforms/Utils/Local.h"
#include "llvm/Transforms/Utils/ModuleUtils.h"
#include <cstdint>

Macros
#define	DEBUG_TYPE "nsan"
#define	MOVE_FLAG(attr, setter)

Enumerations
enum class	ContinuationType { ContinueWithShadow = 0 , ResumeFromValue = 1 }

Functions
	STATISTIC (NumInstrumentedFTLoads, "Number of instrumented floating-point loads")
	STATISTIC (NumInstrumentedFTCalls, "Number of instrumented floating-point calls")
	STATISTIC (NumInstrumentedFTRets, "Number of instrumented floating-point returns")
	STATISTIC (NumInstrumentedFTStores, "Number of instrumented floating-point stores")
	STATISTIC (NumInstrumentedNonFTStores, "Number of instrumented non floating-point stores")
	STATISTIC (NumInstrumentedNonFTMemcpyStores, "Number of instrumented non floating-point stores with memcpy semantics")
	STATISTIC (NumInstrumentedFCmp, "Number of instrumented fcmps")
constexpr StringLiteral	kNsanModuleCtorName ("nsan.module_ctor")
constexpr StringLiteral	kNsanInitName ("__nsan_init")
static GlobalValue *	createThreadLocalGV (const char Name, Module &M, Type Ty)
static bool	shouldCheckArgs (CallBase &CI, const TargetLibraryInfo &TLI, const std::optional< Regex > &CheckFunctionsFilter)
static FunctionType *	makeDoubleDouble (LLVMContext &C)
static FunctionType *	makeX86FP80X86FP80 (LLVMContext &C)
static FunctionType *	makeDoubleDoubleI32 (LLVMContext &C)
static FunctionType *	makeX86FP80X86FP80I32 (LLVMContext &C)
static FunctionType *	makeDoubleDoubleDouble (LLVMContext &C)
static FunctionType *	makeX86FP80X86FP80X86FP80 (LLVMContext &C)
static FunctionType *	makeDoubleDoubleDoubleDouble (LLVMContext &C)
static FunctionType *	makeX86FP80X86FP80X86FP80X86FP80 (LLVMContext &C)
static const char *	getIntrinsicFromLibfunc (Function &Fn, Type *VT, const TargetLibraryInfo &TLI)
static void	moveFastMathFlags (Function &F, std::vector< Instruction * > &Instructions)
static uint64_t	GetMemOpSize (Value *V)

Variables
static cl::opt< std::string >	ClShadowMapping ("nsan-shadow-type-mapping", cl::init("dqq"), cl::desc("One shadow type id for each of `float`, `double`, `long double`. " "`d`,`l`,`q`,`e` mean double, x86_fp80, fp128 (quad) and " "ppc_fp128 (extended double) respectively. The default is to " "shadow `float` as `double`, and `double` and `x86_fp80` as " "`fp128`"), cl::Hidden)
static cl::opt< bool >	ClInstrumentFCmp ("nsan-instrument-fcmp", cl::init(true), cl::desc("Instrument floating-point comparisons"), cl::Hidden)
static cl::opt< std::string >	ClCheckFunctionsFilter ("check-functions-filter", cl::desc("Only emit checks for arguments of functions " "whose names match the given regular expression"), cl::value_desc("regex"))
static cl::opt< bool >	ClTruncateFCmpEq ("nsan-truncate-fcmp-eq", cl::init(true), cl::desc("This flag controls the behaviour of fcmp equality comparisons." "For equality comparisons such as `x == 0.0f`, we can perform the " "shadow check in the shadow (`x_shadow == 0.0) == (x == 0.0f)`) or app " " domain (`(trunc(x_shadow) == 0.0f) == (x == 0.0f)`). This helps " "catch the case when `x_shadow` is accurate enough (and therefore " "close enough to zero) so that `trunc(x_shadow)` is zero even though " "both `x` and `x_shadow` are not"), cl::Hidden)
static cl::opt< bool >	ClCheckLoads ("nsan-check-loads", cl::desc("Check floating-point load"), cl::Hidden)
static cl::opt< bool >	ClCheckStores ("nsan-check-stores", cl::init(true), cl::desc("Check floating-point stores"), cl::Hidden)
static cl::opt< bool >	ClCheckRet ("nsan-check-ret", cl::init(true), cl::desc("Check floating-point return values"), cl::Hidden)
static cl::opt< bool >	ClPropagateNonFTConstStoresAsFT ("nsan-propagate-non-ft-const-stores-as-ft", cl::desc("Propagate non floating-point const stores as floating point values." "For debugging purposes only"), cl::Hidden)
constexpr int	kShadowScale = 2
constexpr int	kMaxVectorWidth = 8
constexpr int	kMaxNumArgs = 128
constexpr int	kMaxShadowTypeSizeBytes = 16

Macro Definition Documentation

◆ DEBUG_TYPE

#define DEBUG_TYPE "nsan"

Definition at line 47 of file NumericalStabilitySanitizer.cpp.

◆ MOVE_FLAG

#define MOVE_FLAG	(		attr,
			setter )

Value:

  if (F.getFnAttribute(attr).getValueAsString() == "true") {                   \
    F.removeFnAttr(attr);                                                      \
    FMF.set##setter();                                                         \
  }

Referenced by moveFastMathFlags().

Enumeration Type Documentation

◆ ContinuationType

enum class ContinuationType

strong

Enumerator
ContinueWithShadow
ResumeFromValue

Definition at line 888 of file NumericalStabilitySanitizer.cpp.

Function Documentation

◆ createThreadLocalGV()

GlobalValue * createThreadLocalGV	(	const char *	Name,
		Module &	M,
		Type *	Ty )

static

Definition at line 645 of file NumericalStabilitySanitizer.cpp.

References llvm::GlobalValue::ExternalLinkage, and llvm::GlobalValue::InitialExecTLSModel.

◆ getIntrinsicFromLibfunc()

const char * getIntrinsicFromLibfunc	(	Function &	Fn,
		Type *	VT,
		const TargetLibraryInfo &	TLI )

static

Definition at line 1536 of file NumericalStabilitySanitizer.cpp.

References llvm::errs(), llvm::TargetLibraryInfo::getLibFunc(), llvm::TargetLibraryInfo::getName(), and LLVM_DEBUG.

◆ GetMemOpSize()

uint64_t GetMemOpSize ( Value * V )

static

Definition at line 2183 of file NumericalStabilitySanitizer.cpp.

References llvm::CallingConv::C, and llvm::dyn_cast().

◆ kNsanInitName()

StringLiteral kNsanInitName ( "__nsan_init" )

constexpr

Referenced by llvm::NumericalStabilitySanitizerPass::run().

◆ kNsanModuleCtorName()

StringLiteral kNsanModuleCtorName ( "nsan.module_ctor" )

constexpr

Referenced by llvm::NumericalStabilitySanitizerPass::run().

◆ makeDoubleDouble()

FunctionType * makeDoubleDouble ( LLVMContext & C )

static

Definition at line 1316 of file NumericalStabilitySanitizer.cpp.

References llvm::CallingConv::C, llvm::FunctionType::get(), and llvm::Type::getDoubleTy().

◆ makeDoubleDoubleDouble()

FunctionType * makeDoubleDoubleDouble ( LLVMContext & C )

static

Definition at line 1336 of file NumericalStabilitySanitizer.cpp.

References llvm::CallingConv::C, llvm::FunctionType::get(), and llvm::Type::getDoubleTy().

◆ makeDoubleDoubleDoubleDouble()

FunctionType * makeDoubleDoubleDoubleDouble ( LLVMContext & C )

static

Definition at line 1347 of file NumericalStabilitySanitizer.cpp.

References llvm::CallingConv::C, llvm::FunctionType::get(), and llvm::Type::getDoubleTy().

◆ makeDoubleDoubleI32()

FunctionType * makeDoubleDoubleI32 ( LLVMContext & C )

static

Definition at line 1325 of file NumericalStabilitySanitizer.cpp.

References llvm::CallingConv::C, llvm::FunctionType::get(), llvm::Type::getDoubleTy(), and llvm::Type::getInt32Ty().

◆ makeX86FP80X86FP80()

FunctionType * makeX86FP80X86FP80 ( LLVMContext & C )

static

Definition at line 1320 of file NumericalStabilitySanitizer.cpp.

References llvm::CallingConv::C, llvm::FunctionType::get(), and llvm::Type::getX86_FP80Ty().

◆ makeX86FP80X86FP80I32()

FunctionType * makeX86FP80X86FP80I32 ( LLVMContext & C )

static

Definition at line 1330 of file NumericalStabilitySanitizer.cpp.

References llvm::CallingConv::C, llvm::FunctionType::get(), llvm::Type::getInt32Ty(), and llvm::Type::getX86_FP80Ty().

◆ makeX86FP80X86FP80X86FP80()

FunctionType * makeX86FP80X86FP80X86FP80 ( LLVMContext & C )

static

Definition at line 1341 of file NumericalStabilitySanitizer.cpp.

References llvm::CallingConv::C, llvm::FunctionType::get(), and llvm::Type::getX86_FP80Ty().

◆ makeX86FP80X86FP80X86FP80X86FP80()

FunctionType * makeX86FP80X86FP80X86FP80X86FP80 ( LLVMContext & C )

static

Definition at line 1354 of file NumericalStabilitySanitizer.cpp.

References llvm::CallingConv::C, llvm::FunctionType::get(), and llvm::Type::getX86_FP80Ty().

◆ moveFastMathFlags()

void moveFastMathFlags	(	Function &	F,
		std::vector< Instruction * > &	Instructions )

static

Definition at line 2015 of file NumericalStabilitySanitizer.cpp.

References F, llvm::CallingConv::Fast, I, llvm::isa(), and MOVE_FLAG.

◆ shouldCheckArgs()

bool shouldCheckArgs	(	CallBase &	CI,
		const TargetLibraryInfo &	TLI,
		const std::optional< Regex > &	CheckFunctionsFilter )

static

Definition at line 792 of file NumericalStabilitySanitizer.cpp.

References llvm::CallBase::getCalledFunction(), llvm::Function::getIntrinsicID(), llvm::TargetLibraryInfo::getLibFunc(), llvm::Value::getName(), llvm::isa(), llvm::NumLibFuncs, llvm::StringRef::starts_with(), and llvm::Value::users().

◆ STATISTIC() [1/7]

STATISTIC	(	NumInstrumentedFCmp	,
		"Number of instrumented fcmps"	)

◆ STATISTIC() [2/7]

STATISTIC	(	NumInstrumentedFTCalls	,
		"Number of instrumented floating-point calls"	)

◆ STATISTIC() [3/7]

STATISTIC	(	NumInstrumentedFTLoads	,
		"Number of instrumented floating-point loads"	)

◆ STATISTIC() [4/7]

STATISTIC	(	NumInstrumentedFTRets	,
		"Number of instrumented floating-point returns"	)

◆ STATISTIC() [5/7]

STATISTIC	(	NumInstrumentedFTStores	,
		"Number of instrumented floating-point stores"	)

◆ STATISTIC() [6/7]

STATISTIC	(	NumInstrumentedNonFTMemcpyStores	,
		"Number of instrumented non floating-point stores with memcpy semantics"	)

◆ STATISTIC() [7/7]

STATISTIC	(	NumInstrumentedNonFTStores	,
		"Number of instrumented non floating-point stores"	)

Variable Documentation

◆ ClCheckFunctionsFilter

cl::opt< std::string > ClCheckFunctionsFilter("check-functions-filter", cl::desc("Only emit checks for arguments of functions " "whose names match the given regular expression"), cl::value_desc("regex"))	(	"check-functions-filter"	,
		cl::desc("Only emit checks for arguments of functions " "whose names match the given regular expression")	,
		cl::value_desc("regex")	)

static

◆ ClCheckLoads

cl::opt< bool > ClCheckLoads("nsan-check-loads", cl::desc("Check floating-point load"), cl::Hidden)	(	"nsan-check-loads"	,
		cl::desc("Check floating-point load")	,
		cl::Hidden	)

static

◆ ClCheckRet

cl::opt< bool > ClCheckRet("nsan-check-ret", cl::init(true), cl::desc("Check floating-point return values"), cl::Hidden)	(	"nsan-check-ret"	,
		cl::init(true)	,
		cl::desc("Check floating-point return values")	,
		cl::Hidden	)

static

◆ ClCheckStores

cl::opt< bool > ClCheckStores("nsan-check-stores", cl::init(true), cl::desc("Check floating-point stores"), cl::Hidden)	(	"nsan-check-stores"	,
		cl::init(true)	,
		cl::desc("Check floating-point stores")	,
		cl::Hidden	)

static

◆ ClInstrumentFCmp

cl::opt< bool > ClInstrumentFCmp("nsan-instrument-fcmp", cl::init(true), cl::desc("Instrument floating-point comparisons"), cl::Hidden)	(	"nsan-instrument-fcmp"	,
		cl::init(true)	,
		cl::desc("Instrument floating-point comparisons")	,
		cl::Hidden	)

static

◆ ClPropagateNonFTConstStoresAsFT

cl::opt< bool > ClPropagateNonFTConstStoresAsFT("nsan-propagate-non-ft-const-stores-as-ft", cl::desc( "Propagate non floating-point const stores as floating point values." "For debugging purposes only"), cl::Hidden)	(	"nsan-propagate-non-ft-const-stores-as-ft"	,
		cl::desc( "Propagate non floating-point const stores as floating point values." "For debugging purposes only")	,
		cl::Hidden	)

static

◆ ClShadowMapping

cl::opt< std::string > ClShadowMapping("nsan-shadow-type-mapping", cl::init("dqq"), cl::desc("One shadow type id for each of `float`, `double`, `long double`. " "`d`,`l`,`q`,`e` mean double, x86_fp80, fp128 (quad) and " "ppc_fp128 (extended double) respectively. The default is to " "shadow `float` as `double`, and `double` and `x86_fp80` as " "`fp128`"), cl::Hidden)	(	"nsan-shadow-type-mapping"	,
		cl::init("dqq")	,
		cl::desc("One shadow type id for each of `float`, `double`, `long double`. " "`d`,`l`,`q`,`e` mean double, x86_fp80, fp128 (quad) and " "ppc_fp128 (extended double) respectively. The default is to " "shadow `float` as `double`, and `double` and `x86_fp80` as " "`fp128`")	,
		cl::Hidden	)

static

◆ ClTruncateFCmpEq

cl::opt< bool > ClTruncateFCmpEq("nsan-truncate-fcmp-eq", cl::init(true), cl::desc( "This flag controls the behaviour of fcmp equality comparisons." "For equality comparisons such as `x == 0.0f`, we can perform the " "shadow check in the shadow (`x_shadow == 0.0) == (x == 0.0f)`) or app " " domain (`(trunc(x_shadow) == 0.0f) == (x == 0.0f)`). This helps " "catch the case when `x_shadow` is accurate enough (and therefore " "close enough to zero) so that `trunc(x_shadow)` is zero even though " "both `x` and `x_shadow` are not"), cl::Hidden)	(	"nsan-truncate-fcmp-eq"	,
		cl::init(true)	,
		cl::desc("This flag controls the behaviour of fcmp equality comparisons." "For equality comparisons such as `x == 0.0f`, we can perform the " "shadow check in the shadow (`x_shadow == 0.0) == (x == 0.0f)`) or app " " domain (`(trunc(x_shadow) == 0.0f) == (x == 0.0f)`). This helps " "catch the case when `x_shadow` is accurate enough (and therefore " "close enough to zero) so that `trunc(x_shadow)` is zero even though " "both `x` and `x_shadow` are not"	)

static

◆ kMaxNumArgs

int kMaxNumArgs = 128

constexpr

Definition at line 140 of file NumericalStabilitySanitizer.cpp.

◆ kMaxShadowTypeSizeBytes

int kMaxShadowTypeSizeBytes = 16

constexpr

Definition at line 141 of file NumericalStabilitySanitizer.cpp.

◆ kMaxVectorWidth

int kMaxVectorWidth = 8

constexpr

Definition at line 139 of file NumericalStabilitySanitizer.cpp.

◆ kShadowScale

int kShadowScale = 2

constexpr

Definition at line 138 of file NumericalStabilitySanitizer.cpp.

Macros

Enumerations

Functions

Variables

Macro Definition Documentation

◆ DEBUG_TYPE

◆ MOVE_FLAG

Enumeration Type Documentation

◆ ContinuationType

Function Documentation

◆ createThreadLocalGV()

◆ getIntrinsicFromLibfunc()

◆ GetMemOpSize()

◆ kNsanInitName()

◆ kNsanModuleCtorName()

◆ makeDoubleDouble()

◆ makeDoubleDoubleDouble()

◆ makeDoubleDoubleDoubleDouble()

◆ makeDoubleDoubleI32()

◆ makeX86FP80X86FP80()

◆ makeX86FP80X86FP80I32()

◆ makeX86FP80X86FP80X86FP80()

◆ makeX86FP80X86FP80X86FP80X86FP80()

◆ moveFastMathFlags()

◆ shouldCheckArgs()

◆ STATISTIC() [1/7]

◆ STATISTIC() [2/7]

◆ STATISTIC() [3/7]

◆ STATISTIC() [4/7]

◆ STATISTIC() [5/7]

◆ STATISTIC() [6/7]

◆ STATISTIC() [7/7]

Variable Documentation

◆ ClCheckFunctionsFilter

◆ ClCheckLoads

◆ ClCheckRet

◆ ClCheckStores

◆ ClInstrumentFCmp

◆ ClPropagateNonFTConstStoresAsFT

◆ ClShadowMapping

◆ ClTruncateFCmpEq

◆ kMaxNumArgs

◆ kMaxShadowTypeSizeBytes

◆ kMaxVectorWidth

◆ kShadowScale