llvm::remarks

Types

Name	Description
`Argument`	A key-value pair with a debug location that is used to display the remarks at the right place in the source.
`BitstreamMetaSerializer`	Serializer of metadata for bitstream remarks.
`BitstreamRemarkSerializer`	Implementation of the remark serializer using LLVM bitstream.
`BitstreamRemarkSerializerHelper`	Serialize the remarks to LLVM bitstream. This class provides ways to emit remarks in the LLVM bitstream format and its associated metadata.
`EndOfFileError`
`HotnessThresholdParser`
`MetaSerializer`	This is the base class for a remark metadata serializer.
`ParsedStringTable`	In-memory representation of the string table parsed from a buffer (e.g. the remarks section).
`Remark`	A remark type used for both emission and parsing.
`RemarkLinker`
`RemarkLocation`	The debug location used to track a remark back to the source file.
`RemarkParser`	Parser used to parse a raw buffer to remarks::Remark objects.
`RemarkSerializer`	This is the base class for a remark serializer. It includes support for using a string table while emitting.
`RemarkStreamer`
`Remarks`
`StringTable`	The string table used for serializing remarks. This table can be for example serialized in a section to be consumed after the compilation.
`YAMLMetaSerializer`
`YAMLRemarkSerializer`	Serialize the remarks to YAML. One remark entry looks like this: --- !<TYPE> Pass: <PASSNAME> Name: <REMARKNAME> DebugLoc: { File: <SOURCEFILENAME>, Line: <SOURCELINE>, Column: <SOURCECOLUMN> } Function: <FUNCTIONNAME> Args: - <KEY>: <VALUE> DebugLoc: { File: <FILE>, Line: <LINE>, Column: <COL> } ...

Enums

Name	Description
`BitstreamRemarkContainerType`	Type of the remark container.
`BlockIDs`	The possible blocks that will be encountered in a bitstream remark container.
`Format`	The format used for serializing/deserializing remarks.
`RecordIDs`	The possible records that can be encountered in the previously described blocks.
`Type`	The type of the remark.

Functions

Name	Description
`createRemarkParser`
`createRemarkParserFromMeta`
`createRemarkSerializer`	`createRemarkSerializer` overloads
`detectFormat`	Detect format based on selected format and magic number
`getRemarksSectionContents`	Returns a buffer with the contents of the remarks section depending on the format of the file. If the section doesn't exist, this returns an empty optional.
`magicToFormat`	Parse and validate a magic number to a remark format.
`parseFormat`	Parse and validate a string for the remark format.
`parseHotnessThresholdOption`
`typeToStr`
`unwrap`
`wrap`
`operator<<`	Stream insertion operators
`operator==`	Equality operators
`operator!=`	Inequality operators
`operator<`	Comparison operators for Remark objects and dependent objects.

Variables

Name	Description
`ContainerMagic`	The magic number used for identifying remark blocks.
`CurrentContainerVersion`	The current version of the remark container. Note: this is different from the version of the remark entry.
`CurrentRemarkVersion`	The current version of the remark entry.
`Magic`
`MetaBlockName`
`MetaContainerInfoName`
`MetaExternalFileName`
`MetaRemarkVersionName`
`MetaStrTabName`
`RemarkArgWithDebugLocName`
`RemarkArgWithoutDebugLocName`
`RemarkBlockName`
`RemarkDebugLocName`
`RemarkHeaderName`
`RemarkHotnessName`