NullabilityChecker.cpp File Reference

#include "clang/StaticAnalyzer/Checkers/BuiltinCheckerRegistration.h"
#include "clang/Analysis/AnyCall.h"
#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h"
#include "clang/StaticAnalyzer/Core/Checker.h"
#include "clang/StaticAnalyzer/Core/CheckerManager.h"
#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerHelpers.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/Support/Path.h"

Go to the source code of this file.

Macros
#define	REGISTER_CHECKER(NAME, TRACKING_REQUIRED)

Enumerations
enum class	NullConstraint { IsNull , IsNotNull , Unknown }

Functions
	REGISTER_MAP_WITH_PROGRAMSTATE (NullabilityMap, const MemRegion *, NullabilityState) REGISTER_MAP_WITH_PROGRAMSTATE(PropertyAccessesMap
static NullConstraint	getNullConstraint (DefinedOrUnknownSVal Val, ProgramStateRef State)
static bool	isValidPointerType (QualType T)
static bool	checkValueAtLValForInvariantViolation (ProgramStateRef State, SVal LV, QualType T)
	Returns true when the value stored at the given location has been constrained to null after being passed through an object of nonnnull type.
static bool	checkParamsForPreconditionViolation (ArrayRef< ParmVarDecl * > Params, ProgramStateRef State, const LocationContext *LocCtxt)
static bool	checkSelfIvarsForInvariantViolation (ProgramStateRef State, const LocationContext *LocCtxt)
static bool	checkInvariantViolation (ProgramStateRef State, ExplodedNode *N, CheckerContext &C)
static const Expr *	lookThroughImplicitCasts (const Expr *E)
	Find the outermost subexpression of E that is not an implicit cast.
static Nullability	getReceiverNullability (const ObjCMethodCall &M, ProgramStateRef State)
static const Expr *	matchValueExprForBind (const Stmt *S)
	For a given statement performing a bind, attempt to syntactically match the expression resulting in the bound value.
static bool	isARCNilInitializedLocal (CheckerContext &C, const Stmt *S)
	Returns true if.

Variables
	ObjectPropPair
constexpr llvm::StringLiteral	GroupName = "nullability"
constexpr llvm::StringLiteral	GroupOptName = "NoDiagnoseCallsToSystemHeaders"

Macro Definition Documentation

REGISTER_CHECKER

#define REGISTER_CHECKER	(		NAME,
			TRACKING_REQUIRED )

Value:

  void ento::register##NAME##Checker(CheckerManager &Mgr) {                    \
    NullabilityChecker *Chk = Mgr.getChecker<NullabilityChecker>();            \
    Chk->NAME.enable(Mgr);                                                     \
    Chk->NeedTracking = Chk->NeedTracking || TRACKING_REQUIRED;                \
    Chk->NoDiagnoseCallsToSystemHeaders =                                      \
        Mgr.getAnalyzerOptions().getCheckerBooleanOption(GroupName,            \
                                                         GroupOptName, true);  \
  }                                                                            \
                                                                               \
  bool ento::shouldRegister##NAME##Checker(const CheckerManager &) {           \
    return true;                                                               \
  }

Definition at line 1397 of file NullabilityChecker.cpp.

Enumeration Type Documentation

NullConstraint

enum class NullConstraint

strong

Enumerator
IsNull
IsNotNull
Unknown

Definition at line 299 of file NullabilityChecker.cpp.

Function Documentation

checkInvariantViolation()

bool checkInvariantViolation ( ProgramStateRef State, ExplodedNode * N, CheckerContext & C )

static

Definition at line 450 of file NullabilityChecker.cpp.

References clang::C, checkParamsForPreconditionViolation(), checkSelfIvarsForInvariantViolation(), clang::LocationContext::getDecl(), and clang::ento::ExplodedNode::isSink().

checkParamsForPreconditionViolation()

bool checkParamsForPreconditionViolation ( ArrayRef< ParmVarDecl * > Params, ProgramStateRef State, const LocationContext * LocCtxt )

static

Definition at line 403 of file NullabilityChecker.cpp.

References checkValueAtLValForInvariantViolation(), and clang::ento::SVal::getType().

Referenced by checkInvariantViolation().

checkSelfIvarsForInvariantViolation()

bool checkSelfIvarsForInvariantViolation ( ProgramStateRef State, const LocationContext * LocCtxt )

static

Definition at line 420 of file NullabilityChecker.cpp.

References checkValueAtLValForInvariantViolation(), clang::LocationContext::getDecl(), clang::ObjCObjectPointerType::getInterfaceDecl(), clang::LocationContext::getSelfDecl(), clang::ento::SVal::getType(), and clang::ValueDecl::getType().

Referenced by checkInvariantViolation().

checkValueAtLValForInvariantViolation()

bool checkValueAtLValForInvariantViolation ( ProgramStateRef State, SVal LV, QualType T )

static

Returns true when the value stored at the given location has been constrained to null after being passed through an object of nonnnull type.

Definition at line 377 of file NullabilityChecker.cpp.

References clang::ento::SVal::getAs(), clang::ento::getNullabilityAnnotation(), getNullConstraint(), clang::isa(), IsNull, and clang::T.

Referenced by checkParamsForPreconditionViolation(), and checkSelfIvarsForInvariantViolation().

getNullConstraint()

NullConstraint getNullConstraint ( DefinedOrUnknownSVal Val, ProgramStateRef State )

static

Definition at line 301 of file NullabilityChecker.cpp.

References clang::ento::ConditionTruthVal::isConstrainedFalse(), clang::ento::ConditionTruthVal::isConstrainedTrue(), IsNotNull, IsNull, and Unknown.

Referenced by checkValueAtLValForInvariantViolation(), and getReceiverNullability().

getReceiverNullability()

Nullability getReceiverNullability ( const ObjCMethodCall & M, ProgramStateRef State )

static

Definition at line 918 of file NullabilityChecker.cpp.

References clang::ento::SVal::getAs(), getNullConstraint(), clang::ento::ObjCMethodCall::getReceiverSVal(), IsNotNull, and clang::ento::ObjCMethodCall::isReceiverSelfOrSuper().

isARCNilInitializedLocal()

bool isARCNilInitializedLocal ( CheckerContext & C, const Stmt * S )

static

Returns true if.

Parameters

S	is a DeclStmt for a local variable that ObjC automated reference counting initialized with zero.

Definition at line 1211 of file NullabilityChecker.cpp.

References clang::C, clang::Init, and clang::isa().

isValidPointerType()

bool isValidPointerType ( QualType T )

static

Definition at line 311 of file NullabilityChecker.cpp.

References clang::T.

lookThroughImplicitCasts()

const Expr * lookThroughImplicitCasts ( const Expr * E )

static

Find the outermost subexpression of E that is not an implicit cast.

This looks through the implicit casts to _Nonnull that ARC adds to return expressions of ObjC types when the return type of the function or method is non-null but the express is not.

Definition at line 645 of file NullabilityChecker.cpp.

References clang::Expr::IgnoreImpCasts().

matchValueExprForBind()

const Expr * matchValueExprForBind ( const Stmt * S )

static

For a given statement performing a bind, attempt to syntactically match the expression resulting in the bound value.

Definition at line 1187 of file NullabilityChecker.cpp.

References clang::Init.

REGISTER_MAP_WITH_PROGRAMSTATE()

REGISTER_MAP_WITH_PROGRAMSTATE	(	NullabilityMap	,
		const MemRegion *	,
		NullabilityState	)

Variable Documentation

GroupName

llvm::StringLiteral GroupName = "nullability"

constexpr

Definition at line 1394 of file NullabilityChecker.cpp.

GroupOptName

llvm::StringLiteral GroupOptName = "NoDiagnoseCallsToSystemHeaders"

constexpr

Definition at line 1395 of file NullabilityChecker.cpp.

ObjectPropPair

ObjectPropPair

Definition at line 270 of file NullabilityChecker.cpp.