Namespaces
namespace	ErrorMessages

Classes
class	BuildNamespace
	Represents a single namespace in the build process. More...
struct	Comparator
	An EntityPointerLevel represents a level of the declared pointer/array type of an entity. More...
class	EntityId
	Lightweight opaque handle representing an entity in an EntityIdTable. More...
class	EntityIdTable
	Manages entity name interning and provides efficient EntityId handles. More...
class	EntityLinkage
	Represents the linkage properties of an entity in the program model. More...
class	EntityLinker
class	EntityName
	Uniquely identifies an entity in a program. More...
class	EntitySummary
	Base class for analysis-specific summary data. More...
class	EntitySummaryEncoding
	Represents EntitySummary data in its serialized, format-specific encoding. More...
class	ErrorBuilder
	Fluent API for constructing contextual errors. More...
struct	FormatInfoEntry
class	JSONEntitySummaryEncoding
class	JSONFormat
class	LUSummary
	Represents a link unit (LU) summary containing merged entity summaries. More...
class	LUSummaryEncoding
	Represents a link unit summary in its serialized encoding. More...
class	NestedBuildNamespace
	Represents a hierarchical sequence of build namespaces. More...
class	SerializationFormat
	Abstract base class for serialization formats. More...
class	SummaryName
	Uniquely identifies an analysis summary. More...
class	TUSummary
	Data extracted for a given translation unit and for a given set of analyses. More...
class	TUSummaryBuilder
class	TUSummaryEncoding
	Represents a translation unit summary in its serialized encoding. More...
class	TUSummaryExtractor
class	UnsafeBufferUsageTUSummaryExtractor

Typedefs
using	SerializationFormatRegistry = llvm::Registry<SerializationFormat>
template<typename Derived>
using	DerivesFromEntitySummary
using	TUSummaryExtractorRegistry
using	Array = llvm::json::Array
using	Object = llvm::json::Object
using	Value = llvm::json::Value

Enumerations
enum class	BuildNamespaceKind : unsigned short { CompilationUnit , LinkUnit }
enum class	EntityLinkageType { None , Internal , External }

Functions
std::optional< EntityName >	getEntityName (const Decl *D)
	Maps a declaration to an EntityName.
std::optional< EntityName >	getEntityNameForReturn (const FunctionDecl *FD)
	Maps return entity of a function to an EntityName.
llvm::raw_ostream &	operator<< (llvm::raw_ostream &OS, BuildNamespaceKind BNK)
llvm::raw_ostream &	operator<< (llvm::raw_ostream &OS, const BuildNamespace &BN)
llvm::raw_ostream &	operator<< (llvm::raw_ostream &OS, const NestedBuildNamespace &NBN)
llvm::raw_ostream &	operator<< (llvm::raw_ostream &OS, const EntityId &Id)
llvm::raw_ostream &	operator<< (llvm::raw_ostream &OS, EntityLinkageType Linkage)
	Writes a string representation of the linkage type to the stream.
llvm::raw_ostream &	operator<< (llvm::raw_ostream &OS, const EntityLinkage &Linkage)
llvm::raw_ostream &	operator<< (llvm::raw_ostream &OS, const EntityName &EN)
llvm::raw_ostream &	operator<< (llvm::raw_ostream &OS, const SummaryName &SN)
void	initializeJSONFormat ()
	Call this from main() to prevent the linker from dead-stripping the JSONFormat library and its static registration objects.
bool	isFormatRegistered (llvm::StringRef FormatName)
	Check if a SerializationFormat was registered with a given name.
std::unique_ptr< SerializationFormat >	makeFormat (llvm::StringRef FormatName)
	Try to instantiate a SerializationFormat with a given name.
bool	isTUSummaryExtractorRegistered (llvm::StringRef SummaryName)
	Check if a TUSummaryExtractor was registered with a given name.
std::unique_ptr< ASTConsumer >	makeTUSummaryExtractor (llvm::StringRef SummaryName, TUSummaryBuilder &Builder)
	Try to instantiate a TUSummaryExtractor with a given name.
llvm::StringRef	buildNamespaceKindToString (BuildNamespaceKind BNK)
	Returns the canonical string representation of `BNK` used for serialization and display (e.g.
std::optional< BuildNamespaceKind >	buildNamespaceKindFromString (llvm::StringRef Str)
	Parses a string produced by buildNamespaceKindToString().
llvm::StringRef	entityLinkageTypeToString (EntityLinkageType LT)
	Returns the canonical string representation of `LT` used for serialization and display (e.g.
std::optional< EntityLinkageType >	entityLinkageTypeFromString (llvm::StringRef Str)
	Parses a string produced by entityLinkageTypeToString().
llvm::Expected< Value >	readJSON (llvm::StringRef Path)
llvm::Error	writeJSON (Value &&V, llvm::StringRef Path)
SummaryName	summaryNameFromJSON (llvm::StringRef SummaryNameStr)
llvm::StringRef	summaryNameToJSON (const SummaryName &SN)
llvm::Expected< BuildNamespaceKind >	buildNamespaceKindFromJSON (llvm::StringRef BuildNamespaceKindStr)
llvm::StringRef	buildNamespaceKindToJSON (BuildNamespaceKind BNK)
llvm::Expected< EntityLinkageType >	entityLinkageTypeFromJSON (llvm::StringRef EntityLinkageTypeStr)
llvm::StringRef	entityLinkageTypeToJSON (EntityLinkageType LT)

Variables
constexpr const char *	JSONFormatFileExtension = ".json"
constexpr const char *	JSONEntityIdKey = "@"
	An entity ID is encoded as the single-key object {"@": <index>}.
static constexpr llvm::StringLiteral	ErrorSeparator = " + "
static constexpr llvm::StringLiteral	ContextSeparator = "\n"

Typedef Documentation

◆ Array

using clang::ssaf::Array = llvm::json::Array

Definition at line 36 of file JSONFormatImpl.h.

◆ DerivesFromEntitySummary

template<typename Derived>

using clang::ssaf::DerivesFromEntitySummary

Initial value:

std::enable_if_t<std::is_base_of_v<EntitySummary, Derived>>

Definition at line 25 of file EntitySummary.h.

◆ Object

using clang::ssaf::Object = llvm::json::Object

Definition at line 37 of file JSONFormatImpl.h.

◆ SerializationFormatRegistry

using clang::ssaf::SerializationFormatRegistry = llvm::Registry<SerializationFormat>

Definition at line 74 of file SerializationFormatRegistry.h.

◆ TUSummaryExtractorRegistry

using clang::ssaf::TUSummaryExtractorRegistry

Initial value:

llvm::Registry<TUSummaryExtractor, TUSummaryBuilder &>

Definition at line 38 of file ExtractorRegistry.h.

◆ Value

using clang::ssaf::Value = llvm::json::Value

Definition at line 38 of file JSONFormatImpl.h.

Enumeration Type Documentation

◆ BuildNamespaceKind

enum class clang::ssaf::BuildNamespaceKind : unsigned short

strong

Enumerator
CompilationUnit
LinkUnit

Definition at line 30 of file BuildNamespace.h.

◆ EntityLinkageType

enum class clang::ssaf::EntityLinkageType

strong

Enumerator
None	local variables, function parameters
Internal	static functions/variables, anonymous namespace
External	globally visible across translation units

Definition at line 17 of file EntityLinkage.h.

Function Documentation

◆ buildNamespaceKindFromJSON()

llvm::Expected< BuildNamespaceKind > clang::ssaf::buildNamespaceKindFromJSON ( llvm::StringRef BuildNamespaceKindStr )

Definition at line 196 of file JSONFormatImpl.cpp.

References clang::ssaf::ErrorBuilder::build(), buildNamespaceKindFromString(), clang::ssaf::ErrorBuilder::create(), and clang::ssaf::ErrorMessages::InvalidBuildNamespaceKind.

◆ buildNamespaceKindFromString()

std::optional< BuildNamespaceKind > clang::ssaf::buildNamespaceKindFromString ( llvm::StringRef Str )

inline

Parses a string produced by buildNamespaceKindToString().

Returns std::nullopt if Str does not match any known BuildNamespaceKind value.

Definition at line 46 of file ModelStringConversions.h.

References CompilationUnit, and LinkUnit.

Referenced by buildNamespaceKindFromJSON().

◆ buildNamespaceKindToJSON()

llvm::StringRef clang::ssaf::buildNamespaceKindToJSON ( BuildNamespaceKind BNK )

Definition at line 209 of file JSONFormatImpl.cpp.

References buildNamespaceKindToString().

◆ buildNamespaceKindToString()

llvm::StringRef clang::ssaf::buildNamespaceKindToString ( BuildNamespaceKind BNK )

inline

Returns the canonical string representation of BNK used for serialization and display (e.g.

"CompilationUnit", "LinkUnit").

Definition at line 33 of file ModelStringConversions.h.

References CompilationUnit, and LinkUnit.

Referenced by buildNamespaceKindToJSON(), and operator<<().

◆ entityLinkageTypeFromJSON()

llvm::Expected< EntityLinkageType > clang::ssaf::entityLinkageTypeFromJSON ( llvm::StringRef EntityLinkageTypeStr )

Definition at line 353 of file JSONFormatImpl.cpp.

References clang::ssaf::ErrorBuilder::build(), clang::ssaf::ErrorBuilder::create(), entityLinkageTypeFromString(), and clang::ssaf::ErrorMessages::InvalidEntityLinkageType.

◆ entityLinkageTypeFromString()

std::optional< EntityLinkageType > clang::ssaf::entityLinkageTypeFromString ( llvm::StringRef Str )

inline

Parses a string produced by entityLinkageTypeToString().

Returns std::nullopt if Str does not match any known EntityLinkageType value.

Definition at line 75 of file ModelStringConversions.h.

References External, Internal, and None.

Referenced by entityLinkageTypeFromJSON().

◆ entityLinkageTypeToJSON()

llvm::StringRef clang::ssaf::entityLinkageTypeToJSON ( EntityLinkageType LT )

Definition at line 365 of file JSONFormatImpl.cpp.

References entityLinkageTypeToString().

◆ entityLinkageTypeToString()

llvm::StringRef clang::ssaf::entityLinkageTypeToString ( EntityLinkageType LT )

inline

Returns the canonical string representation of LT used for serialization and display (e.g.

"None", "Internal", "External").

Definition at line 60 of file ModelStringConversions.h.

References External, Internal, and None.

Referenced by entityLinkageTypeToJSON(), and operator<<().

◆ getEntityName()

std::optional< EntityName > clang::ssaf::getEntityName ( const Decl * D )

Maps a declaration to an EntityName.

Supported declaration types for entity mapping:

Functions and methods
Global Variables
Function parameters
Struct/class/union type definitions
Struct/class/union fields

Implicit declarations and compiler builtins are not mapped.

Parameters

D	The declaration to map. Must not be null.

Returns: An EntityName if the declaration can be mapped, std::nullopt otherwise.

Definition at line 21 of file ASTEntityMapping.cpp.

References clang::cast(), clang::index::generateUSRForDecl(), clang::isa(), and clang::Decl::isImplicit().

◆ getEntityNameForReturn()

std::optional< EntityName > clang::ssaf::getEntityNameForReturn ( const FunctionDecl * FD )

Maps return entity of a function to an EntityName.

The returned name uniquely identifies the return value of function

Parameters

FD.
FD	The function declaration. Must not be null.

Returns: An EntityName for the function's return entity.

Definition at line 62 of file ASTEntityMapping.cpp.

References clang::index::generateUSRForDecl(), clang::FunctionDecl::getBuiltinID(), and clang::Decl::isImplicit().

◆ initializeJSONFormat()

void clang::ssaf::initializeJSONFormat ( )

Call this from main() to prevent the linker from dead-stripping the JSONFormat library and its static registration objects.

Definition at line 22 of file JSONFormatImpl.cpp.

◆ isFormatRegistered()

bool clang::ssaf::isFormatRegistered ( llvm::StringRef FormatName )

Check if a SerializationFormat was registered with a given name.

Definition at line 17 of file SerializationFormatRegistry.cpp.

References isFormatRegistered().

Referenced by isFormatRegistered().

◆ isTUSummaryExtractorRegistered()

bool clang::ssaf::isTUSummaryExtractorRegistered ( llvm::StringRef SummaryName )

Check if a TUSummaryExtractor was registered with a given name.

Definition at line 20 of file ExtractorRegistry.cpp.

◆ makeFormat()

std::unique_ptr< SerializationFormat > clang::ssaf::makeFormat ( llvm::StringRef FormatName )

Try to instantiate a SerializationFormat with a given name.

This might return null if the construction of the desired SerializationFormat failed. It's a fatal error if there is no format registered with the name.

Definition at line 25 of file SerializationFormatRegistry.cpp.

◆ makeTUSummaryExtractor()

std::unique_ptr< ASTConsumer > clang::ssaf::makeTUSummaryExtractor	(	llvm::StringRef	SummaryName,
		TUSummaryBuilder &	Builder )

Try to instantiate a TUSummaryExtractor with a given name.

This might return null if the construction of the desired TUSummaryExtractor failed. It's a fatal error if there is no extractor registered with the name.

Definition at line 28 of file ExtractorRegistry.cpp.

◆ operator<<() [1/8]

llvm::raw_ostream & clang::ssaf::operator<<	(	llvm::raw_ostream &	OS,
		BuildNamespaceKind	BNK )

Definition at line 57 of file BuildNamespace.cpp.

References buildNamespaceKindToString().

◆ operator<<() [2/8]

llvm::raw_ostream & clang::ssaf::operator<<	(	llvm::raw_ostream &	OS,
		const BuildNamespace &	BN )

Definition at line 61 of file BuildNamespace.cpp.

◆ operator<<() [3/8]

llvm::raw_ostream & clang::ssaf::operator<<	(	llvm::raw_ostream &	OS,
		const EntityId &	Id )

Definition at line 13 of file EntityId.cpp.

◆ operator<<() [4/8]

llvm::raw_ostream & clang::ssaf::operator<<	(	llvm::raw_ostream &	OS,
		const EntityLinkage &	Linkage )

Definition at line 28 of file EntityLinkage.cpp.

◆ operator<<() [5/8]

llvm::raw_ostream & clang::ssaf::operator<<	(	llvm::raw_ostream &	OS,
		const EntityName &	EN )

Definition at line 36 of file EntityName.cpp.

◆ operator<<() [6/8]

llvm::raw_ostream & clang::ssaf::operator<<	(	llvm::raw_ostream &	OS,
		const NestedBuildNamespace &	NBN )

Definition at line 65 of file BuildNamespace.cpp.

◆ operator<<() [7/8]

llvm::raw_ostream & clang::ssaf::operator<<	(	llvm::raw_ostream &	OS,
		const SummaryName &	SN )

Definition at line 13 of file SummaryName.cpp.

References clang::ssaf::SummaryName::str().

◆ operator<<() [8/8]

llvm::raw_ostream & clang::ssaf::operator<<	(	llvm::raw_ostream &	OS,
		EntityLinkageType	Linkage )

Writes a string representation of the linkage type to the stream.

Definition at line 23 of file EntityLinkage.cpp.

References entityLinkageTypeToString().

◆ readJSON()

llvm::Expected< Value > clang::ssaf::readJSON ( llvm::StringRef Path )

Definition at line 28 of file JSONFormatImpl.cpp.

References clang::ssaf::ErrorBuilder::build(), clang::ssaf::ErrorBuilder::create(), clang::ssaf::ErrorMessages::FailedToReadFile, clang::ssaf::ErrorMessages::FileIsDirectory, clang::ssaf::ErrorMessages::FileIsNotJSON, clang::ssaf::ErrorMessages::FileNotFound, and JSONFormatFileExtension.

Referenced by clang::ssaf::JSONFormat::readLUSummary(), clang::ssaf::JSONFormat::readLUSummaryEncoding(), clang::ssaf::JSONFormat::readTUSummary(), and clang::ssaf::JSONFormat::readTUSummaryEncoding().

◆ summaryNameFromJSON()

SummaryName clang::ssaf::summaryNameFromJSON ( llvm::StringRef SummaryNameStr )

Definition at line 139 of file JSONFormatImpl.cpp.

◆ summaryNameToJSON()

llvm::StringRef clang::ssaf::summaryNameToJSON ( const SummaryName & SN )

Definition at line 143 of file JSONFormatImpl.cpp.

References clang::ssaf::SummaryName::str().

◆ writeJSON()

llvm::Error clang::ssaf::writeJSON	(	Value &&	V,
		llvm::StringRef	Path )

Definition at line 62 of file JSONFormatImpl.cpp.

References clang::ssaf::ErrorBuilder::build(), clang::ssaf::ErrorBuilder::create(), clang::ssaf::ErrorMessages::FailedToWriteFile, clang::ssaf::ErrorMessages::FileExists, clang::ssaf::ErrorMessages::FileIsNotJSON, JSONFormatFileExtension, clang::ssaf::ErrorMessages::ParentDirectoryNotFound, and V.

Referenced by clang::ssaf::JSONFormat::writeLUSummary(), clang::ssaf::JSONFormat::writeLUSummaryEncoding(), clang::ssaf::JSONFormat::writeTUSummary(), and clang::ssaf::JSONFormat::writeTUSummaryEncoding().

Variable Documentation

◆ ContextSeparator

llvm::StringLiteral clang::ssaf::ContextSeparator = "\n"

staticconstexpr

Definition at line 17 of file ErrorBuilder.cpp.

Referenced by clang::ssaf::ErrorBuilder::build().

◆ ErrorSeparator

llvm::StringLiteral clang::ssaf::ErrorSeparator = " + "

staticconstexpr

Definition at line 16 of file ErrorBuilder.cpp.

Referenced by clang::ssaf::ErrorBuilder::wrap().

◆ JSONEntityIdKey

const char* clang::ssaf::JSONEntityIdKey = "@"

inlineconstexpr

An entity ID is encoded as the single-key object {"@": <index>}.

Definition at line 126 of file JSONFormatImpl.h.

◆ JSONFormatFileExtension

const char* clang::ssaf::JSONFormatFileExtension = ".json"

inlineconstexpr

Definition at line 44 of file JSONFormatImpl.h.

Referenced by readJSON(), and writeJSON().

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ Array

◆ DerivesFromEntitySummary

◆ Object

◆ SerializationFormatRegistry

◆ TUSummaryExtractorRegistry

◆ Value

Enumeration Type Documentation

◆ BuildNamespaceKind

◆ EntityLinkageType

Function Documentation

◆ buildNamespaceKindFromJSON()

◆ buildNamespaceKindFromString()

◆ buildNamespaceKindToJSON()

◆ buildNamespaceKindToString()

◆ entityLinkageTypeFromJSON()

◆ entityLinkageTypeFromString()

◆ entityLinkageTypeToJSON()

◆ entityLinkageTypeToString()

◆ getEntityName()

◆ getEntityNameForReturn()

◆ initializeJSONFormat()

◆ isFormatRegistered()

◆ isTUSummaryExtractorRegistered()

◆ makeFormat()

◆ makeTUSummaryExtractor()

◆ operator<<() [1/8]

◆ operator<<() [2/8]

◆ operator<<() [3/8]

◆ operator<<() [4/8]

◆ operator<<() [5/8]

◆ operator<<() [6/8]

◆ operator<<() [7/8]

◆ operator<<() [8/8]

◆ readJSON()

◆ summaryNameFromJSON()

◆ summaryNameToJSON()

◆ writeJSON()

Variable Documentation

◆ ContextSeparator

◆ ErrorSeparator

◆ JSONEntityIdKey

◆ JSONFormatFileExtension