Stores options for the analyzer from the command line. More...

#include "clang/StaticAnalyzer/Core/AnalyzerOptions.h"

Public Types
using	ConfigTable = llvm::StringMap<std::string>

Public Member Functions
bool	isUnknownAnalyzerConfig (llvm::StringRef Name)
	AnalyzerOptions ()
int	getCheckerIntegerOption (StringRef CheckerName, StringRef OptionName, bool SearchInParents=false) const
	Interprets an option's string value as a boolean.
int	getCheckerIntegerOption (const ento::CheckerBase *C, StringRef OptionName, bool SearchInParents=false) const
StringRef	getCheckerStringOption (StringRef CheckerName, StringRef OptionName, bool SearchInParents=false) const
	Query an option's string value.
StringRef	getCheckerStringOption (const ento::CheckerBase *C, StringRef OptionName, bool SearchInParents=false) const
ExplorationStrategyKind	getExplorationStrategy () const
CTUPhase1InliningKind	getCTUPhase1Inlining () const
IPAKind	getIPAMode () const
	Returns the inter-procedural analysis mode.
bool	mayInlineCXXMemberFunction (CXXInlineableMemberKind K) const
	Returns the option controlling which C++ member functions will be considered for inlining.
ento::PathDiagnosticConsumerOptions	getDiagOpts () const

Static Public Member Functions
static std::vector< StringRef >	getRegisteredCheckers (bool IncludeExperimental=false)
	Retrieves the list of checkers generated from Checkers.td.
static std::vector< StringRef >	getRegisteredPackages (bool IncludeExperimental=false)
	Retrieves the list of packages generated from Checkers.td.
static void	printFormattedEntry (llvm::raw_ostream &Out, std::pair< StringRef, StringRef > EntryDescPair, size_t InitialPad, size_t EntryWidth, size_t MinLineWidth=0)
	Convenience function for printing options or checkers and their description in a formatted manner.

Public Attributes
std::vector< std::pair< std::string, bool > >	CheckersAndPackages
	Pairs of checker/package name and enable/disable.
std::vector< std::string >	SilencedCheckersAndPackages
	Vector of checker/package names which will not emit warnings.
ConfigTable	Config
	A key-value table of use-specified configuration values.
AnalysisConstraints	AnalysisConstraintsOpt = RangeConstraintsModel
AnalysisDiagClients	AnalysisDiagOpt = PD_HTML
AnalysisPurgeMode	AnalysisPurgeOpt = PurgeStmt
std::string	AnalyzeSpecificFunction
std::string	DumpExplodedGraphTo
	File path to which the exploded graph should be dumped.
std::string	FullCompilerInvocation
	Store full compiler invocation for reproducible instructions in the generated report.
unsigned	maxBlockVisitOnPath
	The maximum number of times the analyzer visits a block.
unsigned	DisableAllCheckers: 1
	Disable all analyzer checkers.
unsigned	ShowCheckerHelp: 1
unsigned	ShowCheckerHelpAlpha: 1
unsigned	ShowCheckerHelpDeveloper: 1
unsigned	ShowCheckerOptionList: 1
unsigned	ShowCheckerOptionAlphaList: 1
unsigned	ShowCheckerOptionDeveloperList: 1
unsigned	ShowEnabledCheckerList: 1
unsigned	ShowConfigOptionsList: 1
unsigned	ShouldEmitErrorsOnInvalidConfigValue: 1
unsigned	AnalyzeAll: 1
unsigned	AnalyzerDisplayProgress: 1
unsigned	AnalyzerNoteAnalysisEntryPoints: 1
unsigned	TrimGraph: 1
unsigned	visualizeExplodedGraphWithGraphViz: 1
unsigned	UnoptimizedCFG: 1
unsigned	PrintStats: 1
unsigned	NoRetryExhausted: 1
	Do not re-analyze paths leading to exhausted nodes with a different strategy.
unsigned	AnalyzerWerror: 1
	Emit analyzer warnings as errors.
unsigned	InlineMaxStackDepth
	The inlining stack depth limit.
AnalysisInliningMode	InliningMode = NoRedundancy
	The mode of function selection used during inlining.

Detailed Description

Stores options for the analyzer from the command line.

Some options are frontend flags (e.g.: -analyzer-output), but some are analyzer configuration options, which are preceded by -analyzer-config (e.g.: -analyzer-config notes-as-events=true).

If you'd like to add a new frontend flag, add it to include/clang/Driver/CC1Options.td, add a new field to store the value of that flag in this class, and initialize it in lib/Frontend/CompilerInvocation.cpp.

If you'd like to add a new non-checker configuration, register it in include/clang/StaticAnalyzer/Core/AnalyzerOptions.def, and refer to the top of the file for documentation.

If you'd like to add a new checker option, call getChecker*Option() whenever.

Some of the options are controlled by raw frontend flags for no good reason, and should be eventually converted into -analyzer-config flags. New analyzer options should not be implemented as frontend flags. Frontend flags still make sense for things that do not affect the actual analysis.

Definition at line 180 of file AnalyzerOptions.h.

Member Typedef Documentation

◆ ConfigTable

using clang::AnalyzerOptions::ConfigTable = llvm::StringMap<std::string>

Definition at line 182 of file AnalyzerOptions.h.

Constructor & Destructor Documentation

◆ AnalyzerOptions()

clang::AnalyzerOptions::AnalyzerOptions ( )

inline

Member Function Documentation

◆ getCheckerIntegerOption() [1/2]

int AnalyzerOptions::getCheckerIntegerOption	(	const ento::CheckerBase *	C,
		StringRef	OptionName,
		bool	SearchInParents = false ) const

Definition at line 194 of file AnalyzerOptions.cpp.

References clang::C, and getCheckerIntegerOption().

◆ getCheckerIntegerOption() [2/2]

int AnalyzerOptions::getCheckerIntegerOption	(	StringRef	CheckerName,
		StringRef	OptionName,
		bool	SearchInParents = false ) const

Interprets an option's string value as a boolean.

The "true" string is interpreted as true and the "false" string is interpreted as false.

If an option value is not provided, returns the given DefaultVal.

Parameters

[in]	CheckerName	The full name of the checker. One may retrieve this from the checker object's field `Name`, or through `CheckerManager::getCurrentCheckerName` within the checker's registry function. Checker options are retrieved in the following format: `-analyzer-config CheckerName:OptionName=Value. /
[in]	OptionName	Name for option to retrieve. /
[in]	SearchInParents	If set to true and the searched option was not / specified for the given checker the options for the parent packages will / be searched as well. The inner packages take precedence over the outer / ones. bool getCheckerBooleanOption(StringRef CheckerName, StringRef OptionName, bool SearchInParents = false) const;

bool getCheckerBooleanOption(const ento::CheckerBase *C, StringRef OptionName, bool SearchInParents = false) const;

/ Interprets an option's string value as an integer value. / / If an option value is not provided, returns the given DefaultVal. /

Parameters

[in]	CheckerName	The full name of the checker. One may retrieve / this from the checker object's field `Name`, or through `/` CheckerManager::getCurrentCheckerName within the checker's registry / function. / Checker options are retrieved in the following format: / `-analyzer-config CheckerName:OptionName=Value.
[in]	OptionName	Name for option to retrieve.
[in]	SearchInParents	If set to true and the searched option was not specified for the given checker the options for the parent packages will be searched as well. The inner packages take precedence over the outer ones.

Definition at line 180 of file AnalyzerOptions.cpp.

References getCheckerStringOption().

Referenced by getCheckerIntegerOption().

◆ getCheckerStringOption() [1/2]

StringRef AnalyzerOptions::getCheckerStringOption	(	const ento::CheckerBase *	C,
		StringRef	OptionName,
		bool	SearchInParents = false ) const

Definition at line 151 of file AnalyzerOptions.cpp.

References clang::C, and getCheckerStringOption().

◆ getCheckerStringOption() [2/2]

StringRef AnalyzerOptions::getCheckerStringOption	(	StringRef	CheckerName,
		StringRef	OptionName,
		bool	SearchInParents = false ) const

Query an option's string value.

If an option value is not provided, returns the given DefaultVal.

Parameters

[in]	CheckerName	The full name of the checker. One may retrieve this from the checker object's field `Name`, or through `CheckerManager::getCurrentCheckerName` within the checker's registry function. Checker options are retrieved in the following format: `-analyzer-config CheckerName:OptionName=Value.
[in]	OptionName	Name for option to retrieve.
[in]	SearchInParents	If set to true and the searched option was not specified for the given checker the options for the parent packages will be searched as well. The inner packages take precedence over the outer ones.

Definition at line 124 of file AnalyzerOptions.cpp.

References Config.

Referenced by getCheckerIntegerOption(), and getCheckerStringOption().

◆ getCTUPhase1Inlining()

CTUPhase1InliningKind AnalyzerOptions::getCTUPhase1Inlining ( ) const

Definition at line 81 of file AnalyzerOptions.cpp.

References clang::All, clang::None, and clang::Small.

Referenced by REGISTER_MAP_WITH_PROGRAMSTATE().

◆ getDiagOpts()

ento::PathDiagnosticConsumerOptions clang::AnalyzerOptions::getDiagOpts ( ) const

inline

Definition at line 405 of file AnalyzerOptions.h.

References AnalyzerWerror, and FullCompilerInvocation.

◆ getExplorationStrategy()

ExplorationStrategyKind AnalyzerOptions::getExplorationStrategy ( ) const

Definition at line 63 of file AnalyzerOptions.cpp.

References clang::BFS, clang::BFSBlockDFSContents, clang::DFS, clang::UnexploredFirst, clang::UnexploredFirstLocationQueue, and clang::UnexploredFirstQueue.

Referenced by generateWorkList().

◆ getIPAMode()

IPAKind AnalyzerOptions::getIPAMode ( ) const

Returns the inter-procedural analysis mode.

Definition at line 92 of file AnalyzerOptions.cpp.

References clang::IPAK_BasicInlining, clang::IPAK_DynamicDispatch, clang::IPAK_DynamicDispatchBifurcate, clang::IPAK_Inlining, and clang::IPAK_None.

Referenced by clang::ento::ExprEngine::defaultEvalCall(), and mayInlineCXXMemberFunction().

◆ getRegisteredCheckers()

std::vector< StringRef > clang::AnalyzerOptions::getRegisteredCheckers ( bool IncludeExperimental = false )

inlinestatic

Retrieves the list of checkers generated from Checkers.td.

This doesn't contain statically linked but non-generated checkers and plugin checkers!

Definition at line 429 of file AnalyzerOptions.h.

Referenced by parseAnalyzerConfigs().

◆ getRegisteredPackages()

std::vector< StringRef > clang::AnalyzerOptions::getRegisteredPackages ( bool IncludeExperimental = false )

inlinestatic

Retrieves the list of packages generated from Checkers.td.

This doesn't contain statically linked but non-generated packages and plugin packages!

Definition at line 448 of file AnalyzerOptions.h.

Referenced by parseAnalyzerConfigs().

◆ isUnknownAnalyzerConfig()

bool clang::AnalyzerOptions::isUnknownAnalyzerConfig ( llvm::StringRef Name )

inline

Definition at line 294 of file AnalyzerOptions.h.

Referenced by ParseAnalyzerArgs().

◆ mayInlineCXXMemberFunction()

bool AnalyzerOptions::mayInlineCXXMemberFunction ( CXXInlineableMemberKind K ) const

Returns the option controlling which C++ member functions will be considered for inlining.

This is controlled by the 'c++-inlining' config option.

See also: CXXMemberInliningMode

Definition at line 106 of file AnalyzerOptions.cpp.

References clang::CIMK_Constructors, clang::CIMK_Destructors, clang::CIMK_MemberFunctions, clang::CIMK_None, getIPAMode(), and clang::IPAK_Inlining.

◆ printFormattedEntry()

void AnalyzerOptions::printFormattedEntry	(	llvm::raw_ostream &	Out,
		std::pair< StringRef, StringRef >	EntryDescPair,
		size_t	InitialPad,
		size_t	EntryWidth,
		size_t	MinLineWidth = 0 )

static

Convenience function for printing options or checkers and their description in a formatted manner.

If MinLineWidth is set to 0, no line breaks are introduced for the description.

Format, depending whether the option name's length is less than EntryWidth:

<padding>EntryName<padding>Description <------—padding--------->Description <------—padding--------->Description

<padding>VeryVeryLongEntryName <------—padding--------->Description <------—padding--------->Description ^~~~~~~~~InitialPad ^~~~~~~~~~~~~~~~~~EntryWidth ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~MinLineWidth

Definition at line 31 of file AnalyzerOptions.cpp.

References clang::C.

Referenced by clang::ento::CheckerRegistryData::printCheckerOptionList(), and clang::ento::CheckerRegistryData::printCheckerWithDescList().

Member Data Documentation

◆ AnalysisConstraintsOpt

AnalysisConstraints clang::AnalyzerOptions::AnalysisConstraintsOpt = RangeConstraintsModel

Definition at line 225 of file AnalyzerOptions.h.

Referenced by GenerateAnalyzerArgs(), and ParseAnalyzerArgs().

◆ AnalysisDiagOpt

AnalysisDiagClients clang::AnalyzerOptions::AnalysisDiagOpt = PD_HTML

Definition at line 226 of file AnalyzerOptions.h.

Referenced by constructDebugPieceForTrackedCondition(), GenerateAnalyzerArgs(), and ParseAnalyzerArgs().

◆ AnalysisPurgeOpt

AnalysisPurgeMode clang::AnalyzerOptions::AnalysisPurgeOpt = PurgeStmt

Definition at line 227 of file AnalyzerOptions.h.

Referenced by GenerateAnalyzerArgs(), ParseAnalyzerArgs(), and shouldRemoveDeadBindings().

◆ AnalyzeAll

unsigned clang::AnalyzerOptions::AnalyzeAll

Definition at line 259 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions().

◆ AnalyzerDisplayProgress

unsigned clang::AnalyzerOptions::AnalyzerDisplayProgress

Definition at line 260 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions(), and reportAnalyzerFunctionMisuse().

◆ AnalyzerNoteAnalysisEntryPoints

unsigned clang::AnalyzerOptions::AnalyzerNoteAnalysisEntryPoints

Definition at line 261 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions().

◆ AnalyzerWerror

unsigned clang::AnalyzerOptions::AnalyzerWerror

Emit analyzer warnings as errors.

Definition at line 274 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions(), and getDiagOpts().

◆ AnalyzeSpecificFunction

std::string clang::AnalyzerOptions::AnalyzeSpecificFunction

Definition at line 229 of file AnalyzerOptions.h.

Referenced by reportAnalyzerFunctionMisuse().

◆ CheckersAndPackages

std::vector<std::pair<std::string, bool> > clang::AnalyzerOptions::CheckersAndPackages

Pairs of checker/package name and enable/disable.

Definition at line 217 of file AnalyzerOptions.h.

Referenced by GenerateAnalyzerArgs(), and ParseAnalyzerArgs().

◆ Config

ConfigTable clang::AnalyzerOptions::Config

A key-value table of use-specified configuration values.

Definition at line 224 of file AnalyzerOptions.h.

Referenced by clang::ento::CreateAnalysisConsumer(), GenerateAnalyzerArgs(), getCheckerStringOption(), insertAndValidate(), and ParseAnalyzerArgs().

◆ DisableAllCheckers

unsigned clang::AnalyzerOptions::DisableAllCheckers

Disable all analyzer checkers.

This flag allows one to disable analyzer checkers on the code processed by the given analysis consumer. Note, the code will get parsed and the command-line options will get checked.

Definition at line 246 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions().

◆ DumpExplodedGraphTo

std::string clang::AnalyzerOptions::DumpExplodedGraphTo

File path to which the exploded graph should be dumped.

Definition at line 232 of file AnalyzerOptions.h.

◆ FullCompilerInvocation

std::string clang::AnalyzerOptions::FullCompilerInvocation

Store full compiler invocation for reproducible instructions in the generated report.

Definition at line 236 of file AnalyzerOptions.h.

Referenced by getDiagOpts(), and ParseAnalyzerArgs().

◆ InlineMaxStackDepth

unsigned clang::AnalyzerOptions::InlineMaxStackDepth

The inlining stack depth limit.

Definition at line 277 of file AnalyzerOptions.h.

◆ InliningMode

AnalysisInliningMode clang::AnalyzerOptions::InliningMode = NoRedundancy

The mode of function selection used during inlining.

Definition at line 280 of file AnalyzerOptions.h.

Referenced by GenerateAnalyzerArgs(), and ParseAnalyzerArgs().

◆ maxBlockVisitOnPath

unsigned clang::AnalyzerOptions::maxBlockVisitOnPath

The maximum number of times the analyzer visits a block.

Definition at line 239 of file AnalyzerOptions.h.

◆ NoRetryExhausted

unsigned clang::AnalyzerOptions::NoRetryExhausted

Do not re-analyze paths leading to exhausted nodes with a different strategy.

We get better code coverage when retry is enabled.

Definition at line 270 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions().

◆ PrintStats

unsigned clang::AnalyzerOptions::PrintStats

Definition at line 266 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions().

◆ ShouldEmitErrorsOnInvalidConfigValue

unsigned clang::AnalyzerOptions::ShouldEmitErrorsOnInvalidConfigValue

Definition at line 258 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions(), clang::cross_tu::CrossTranslationUnitContext::CrossTranslationUnitContext(), insertAndValidate(), isOptionContainedIn(), and ParseAnalyzerArgs().

◆ ShowCheckerHelp

unsigned clang::AnalyzerOptions::ShowCheckerHelp

Definition at line 248 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions(), clang::ExecuteCompilerInvocation(), and clang::ento::CheckerRegistryData::printCheckerWithDescList().

◆ ShowCheckerHelpAlpha

unsigned clang::AnalyzerOptions::ShowCheckerHelpAlpha

Definition at line 249 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions(), clang::ExecuteCompilerInvocation(), and clang::ento::CheckerRegistryData::printCheckerWithDescList().

◆ ShowCheckerHelpDeveloper

unsigned clang::AnalyzerOptions::ShowCheckerHelpDeveloper

Definition at line 250 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions(), clang::ExecuteCompilerInvocation(), and clang::ento::CheckerRegistryData::printCheckerWithDescList().

◆ ShowCheckerOptionAlphaList

unsigned clang::AnalyzerOptions::ShowCheckerOptionAlphaList

Definition at line 253 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions(), clang::ExecuteCompilerInvocation(), and clang::ento::CheckerRegistryData::printCheckerOptionList().

◆ ShowCheckerOptionDeveloperList

unsigned clang::AnalyzerOptions::ShowCheckerOptionDeveloperList

Definition at line 254 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions(), clang::ExecuteCompilerInvocation(), and clang::ento::CheckerRegistryData::printCheckerOptionList().

◆ ShowCheckerOptionList

unsigned clang::AnalyzerOptions::ShowCheckerOptionList

Definition at line 252 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions(), clang::ExecuteCompilerInvocation(), and clang::ento::CheckerRegistryData::printCheckerOptionList().

◆ ShowConfigOptionsList

unsigned clang::AnalyzerOptions::ShowConfigOptionsList

Definition at line 257 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions(), and clang::ExecuteCompilerInvocation().

◆ ShowEnabledCheckerList

unsigned clang::AnalyzerOptions::ShowEnabledCheckerList

Definition at line 256 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions(), and clang::ExecuteCompilerInvocation().

◆ SilencedCheckersAndPackages

std::vector<std::string> clang::AnalyzerOptions::SilencedCheckersAndPackages

Vector of checker/package names which will not emit warnings.

Definition at line 220 of file AnalyzerOptions.h.

Referenced by parseAnalyzerConfigs().

◆ TrimGraph

unsigned clang::AnalyzerOptions::TrimGraph

Definition at line 263 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions().

◆ UnoptimizedCFG

unsigned clang::AnalyzerOptions::UnoptimizedCFG

Definition at line 265 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions().

◆ visualizeExplodedGraphWithGraphViz

unsigned clang::AnalyzerOptions::visualizeExplodedGraphWithGraphViz

Definition at line 264 of file AnalyzerOptions.h.

Referenced by AnalyzerOptions().

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

include/clang/StaticAnalyzer/Core/AnalyzerOptions.h
lib/StaticAnalyzer/Core/AnalyzerOptions.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ ConfigTable

Constructor & Destructor Documentation

◆ AnalyzerOptions()

Member Function Documentation

◆ getCheckerIntegerOption() [1/2]

◆ getCheckerIntegerOption() [2/2]

◆ getCheckerStringOption() [1/2]

◆ getCheckerStringOption() [2/2]

◆ getCTUPhase1Inlining()

◆ getDiagOpts()

◆ getExplorationStrategy()

◆ getIPAMode()

◆ getRegisteredCheckers()

◆ getRegisteredPackages()

◆ isUnknownAnalyzerConfig()

◆ mayInlineCXXMemberFunction()

◆ printFormattedEntry()

Member Data Documentation

◆ AnalysisConstraintsOpt

◆ AnalysisDiagOpt

◆ AnalysisPurgeOpt

◆ AnalyzeAll

◆ AnalyzerDisplayProgress

◆ AnalyzerNoteAnalysisEntryPoints

◆ AnalyzerWerror

◆ AnalyzeSpecificFunction

◆ CheckersAndPackages

◆ Config

◆ DisableAllCheckers

◆ DumpExplodedGraphTo

◆ FullCompilerInvocation

◆ InlineMaxStackDepth

◆ InliningMode

◆ maxBlockVisitOnPath

◆ NoRetryExhausted

◆ PrintStats

◆ ShouldEmitErrorsOnInvalidConfigValue

◆ ShowCheckerHelp

◆ ShowCheckerHelpAlpha

◆ ShowCheckerHelpDeveloper

◆ ShowCheckerOptionAlphaList

◆ ShowCheckerOptionDeveloperList

◆ ShowCheckerOptionList

◆ ShowConfigOptionsList

◆ ShowEnabledCheckerList

◆ SilencedCheckersAndPackages

◆ TrimGraph

◆ UnoptimizedCFG

◆ visualizeExplodedGraphWithGraphViz