LLVM  10.0.0svn
Macros | Typedefs | Enumerations | Functions
Collaboration diagram for Remarks:

Macros

#define REMARKS_API_VERSION   1
 

Typedefs

typedef struct LLVMRemarkOpaqueString * LLVMRemarkStringRef
 String containing a buffer and a length. More...
 
typedef struct LLVMRemarkOpaqueDebugLoc * LLVMRemarkDebugLocRef
 DebugLoc containing File, Line and Column. More...
 
typedef struct LLVMRemarkOpaqueArg * LLVMRemarkArgRef
 Element of the "Args" list. More...
 
typedef struct LLVMRemarkOpaqueEntry * LLVMRemarkEntryRef
 A remark emitted by the compiler. More...
 
typedef struct LLVMRemarkOpaqueParser * LLVMRemarkParserRef
 

Enumerations

enum  LLVMRemarkType {
  LLVMRemarkTypeUnknown, LLVMRemarkTypePassed, LLVMRemarkTypeMissed, LLVMRemarkTypeAnalysis,
  LLVMRemarkTypeAnalysisFPCommute, LLVMRemarkTypeAnalysisAliasing, LLVMRemarkTypeFailure
}
 The type of the emitted remark. More...
 

Functions

const charLLVMRemarkStringGetData (LLVMRemarkStringRef String)
 Returns the buffer holding the string. More...
 
uint32_t LLVMRemarkStringGetLen (LLVMRemarkStringRef String)
 Returns the size of the string. More...
 
LLVMRemarkStringRef LLVMRemarkDebugLocGetSourceFilePath (LLVMRemarkDebugLocRef DL)
 Return the path to the source file for a debug location. More...
 
uint32_t LLVMRemarkDebugLocGetSourceLine (LLVMRemarkDebugLocRef DL)
 Return the line in the source file for a debug location. More...
 
uint32_t LLVMRemarkDebugLocGetSourceColumn (LLVMRemarkDebugLocRef DL)
 Return the column in the source file for a debug location. More...
 
LLVMRemarkStringRef LLVMRemarkArgGetKey (LLVMRemarkArgRef Arg)
 Returns the key of an argument. More...
 
LLVMRemarkStringRef LLVMRemarkArgGetValue (LLVMRemarkArgRef Arg)
 Returns the value of an argument. More...
 
LLVMRemarkDebugLocRef LLVMRemarkArgGetDebugLoc (LLVMRemarkArgRef Arg)
 Returns the debug location that is attached to the value of this argument. More...
 
void LLVMRemarkEntryDispose (LLVMRemarkEntryRef Remark)
 Free the resources used by the remark entry. More...
 
enum LLVMRemarkType LLVMRemarkEntryGetType (LLVMRemarkEntryRef Remark)
 The type of the remark. More...
 
LLVMRemarkStringRef LLVMRemarkEntryGetPassName (LLVMRemarkEntryRef Remark)
 Get the name of the pass that emitted this remark. More...
 
LLVMRemarkStringRef LLVMRemarkEntryGetRemarkName (LLVMRemarkEntryRef Remark)
 Get an identifier of the remark. More...
 
LLVMRemarkStringRef LLVMRemarkEntryGetFunctionName (LLVMRemarkEntryRef Remark)
 Get the name of the function being processed when the remark was emitted. More...
 
LLVMRemarkDebugLocRef LLVMRemarkEntryGetDebugLoc (LLVMRemarkEntryRef Remark)
 Returns the debug location that is attached to this remark. More...
 
uint64_t LLVMRemarkEntryGetHotness (LLVMRemarkEntryRef Remark)
 Return the hotness of the remark. More...
 
uint32_t LLVMRemarkEntryGetNumArgs (LLVMRemarkEntryRef Remark)
 The number of arguments the remark holds. More...
 
LLVMRemarkArgRef LLVMRemarkEntryGetFirstArg (LLVMRemarkEntryRef Remark)
 Get a new iterator to iterate over a remark's argument. More...
 
LLVMRemarkArgRef LLVMRemarkEntryGetNextArg (LLVMRemarkArgRef It, LLVMRemarkEntryRef Remark)
 Get the next argument in Remark from the position of It. More...
 
LLVMRemarkParserRef LLVMRemarkParserCreateYAML (const void *Buf, uint64_t Size)
 Creates a remark parser that can be used to parse the buffer located in Buf of size Size bytes. More...
 
LLVMRemarkParserRef LLVMRemarkParserCreateBitstream (const void *Buf, uint64_t Size)
 Creates a remark parser that can be used to parse the buffer located in Buf of size Size bytes. More...
 
LLVMRemarkEntryRef LLVMRemarkParserGetNext (LLVMRemarkParserRef Parser)
 Returns the next remark in the file. More...
 
LLVMBool LLVMRemarkParserHasError (LLVMRemarkParserRef Parser)
 Returns 1 if the parser encountered an error while parsing the buffer. More...
 
const charLLVMRemarkParserGetErrorMessage (LLVMRemarkParserRef Parser)
 Returns a null-terminated string containing an error message. More...
 
void LLVMRemarkParserDispose (LLVMRemarkParserRef Parser)
 Releases all the resources used by Parser. More...
 
uint32_t LLVMRemarkVersion (void)
 Returns the version of the remarks library. More...
 

Detailed Description

Macro Definition Documentation

◆ REMARKS_API_VERSION

#define REMARKS_API_VERSION   1

Definition at line 34 of file Remarks.h.

Typedef Documentation

◆ LLVMRemarkArgRef

typedef struct LLVMRemarkOpaqueArg* LLVMRemarkArgRef

Element of the "Args" list.

The key might give more information about what the semantics of the value are, e.g. "Callee" will tell you that the value is a symbol that names a function.

Since
REMARKS_API_VERSION=0

Definition at line 107 of file Remarks.h.

◆ LLVMRemarkDebugLocRef

typedef struct LLVMRemarkOpaqueDebugLoc* LLVMRemarkDebugLocRef

DebugLoc containing File, Line and Column.

Since
REMARKS_API_VERSION=0

Definition at line 76 of file Remarks.h.

◆ LLVMRemarkEntryRef

typedef struct LLVMRemarkOpaqueEntry* LLVMRemarkEntryRef

A remark emitted by the compiler.

Since
REMARKS_API_VERSION=0

Definition at line 138 of file Remarks.h.

◆ LLVMRemarkParserRef

typedef struct LLVMRemarkOpaqueParser* LLVMRemarkParserRef

Definition at line 228 of file Remarks.h.

◆ LLVMRemarkStringRef

typedef struct LLVMRemarkOpaqueString* LLVMRemarkStringRef

String containing a buffer and a length.

The buffer is not guaranteed to be zero-terminated.

Since
REMARKS_API_VERSION=0

Definition at line 55 of file Remarks.h.

Enumeration Type Documentation

◆ LLVMRemarkType

The type of the emitted remark.

Enumerator
LLVMRemarkTypeUnknown 
LLVMRemarkTypePassed 
LLVMRemarkTypeMissed 
LLVMRemarkTypeAnalysis 
LLVMRemarkTypeAnalysisFPCommute 
LLVMRemarkTypeAnalysisAliasing 
LLVMRemarkTypeFailure 

Definition at line 39 of file Remarks.h.

Function Documentation

◆ LLVMRemarkArgGetDebugLoc()

LLVMRemarkDebugLocRef LLVMRemarkArgGetDebugLoc ( LLVMRemarkArgRef  Arg)

Returns the debug location that is attached to the value of this argument.

If there is no debug location, the return value will be NULL.

Since
REMARKS_API_VERSION=0

Definition at line 63 of file Remark.cpp.

References llvm::remarks::Remark::Loc, llvm::unwrap(), and llvm::wrap().

◆ LLVMRemarkArgGetKey()

LLVMRemarkStringRef LLVMRemarkArgGetKey ( LLVMRemarkArgRef  Arg)

Returns the key of an argument.

The key defines what the value is, and the same key can appear multiple times in the list of arguments.

Since
REMARKS_API_VERSION=0

Definition at line 54 of file Remark.cpp.

References llvm::unwrap(), and llvm::wrap().

◆ LLVMRemarkArgGetValue()

LLVMRemarkStringRef LLVMRemarkArgGetValue ( LLVMRemarkArgRef  Arg)

Returns the value of an argument.

This is a string that can contain newlines.

Since
REMARKS_API_VERSION=0

Definition at line 58 of file Remark.cpp.

References llvm::unwrap(), and llvm::wrap().

◆ LLVMRemarkDebugLocGetSourceColumn()

uint32_t LLVMRemarkDebugLocGetSourceColumn ( LLVMRemarkDebugLocRef  DL)

Return the column in the source file for a debug location.

Since
REMARKS_API_VERSION=0

Definition at line 50 of file Remark.cpp.

References llvm::unwrap().

◆ LLVMRemarkDebugLocGetSourceFilePath()

LLVMRemarkStringRef LLVMRemarkDebugLocGetSourceFilePath ( LLVMRemarkDebugLocRef  DL)

Return the path to the source file for a debug location.

Since
REMARKS_API_VERSION=0

Definition at line 41 of file Remark.cpp.

References llvm::unwrap(), and llvm::wrap().

◆ LLVMRemarkDebugLocGetSourceLine()

uint32_t LLVMRemarkDebugLocGetSourceLine ( LLVMRemarkDebugLocRef  DL)

Return the line in the source file for a debug location.

Since
REMARKS_API_VERSION=0

Definition at line 45 of file Remark.cpp.

References llvm::unwrap().

◆ LLVMRemarkEntryDispose()

void LLVMRemarkEntryDispose ( LLVMRemarkEntryRef  Remark)

Free the resources used by the remark entry.

Since
REMARKS_API_VERSION=0

Definition at line 69 of file Remark.cpp.

References llvm::unwrap().

◆ LLVMRemarkEntryGetDebugLoc()

LLVMRemarkDebugLocRef LLVMRemarkEntryGetDebugLoc ( LLVMRemarkEntryRef  Remark)

Returns the debug location that is attached to this remark.

If there is no debug location, the return value will be NULL.

Since
REMARKS_API_VERSION=0

Definition at line 94 of file Remark.cpp.

References llvm::remarks::Remark::Loc, llvm::unwrap(), and llvm::wrap().

◆ LLVMRemarkEntryGetFirstArg()

LLVMRemarkArgRef LLVMRemarkEntryGetFirstArg ( LLVMRemarkEntryRef  Remark)

Get a new iterator to iterate over a remark's argument.

If there are no arguments in Remark, the return value will be NULL.

The lifetime of the returned value is bound to the lifetime of Remark.

Since
REMARKS_API_VERSION=0

Definition at line 111 of file Remark.cpp.

References llvm::remarks::Remark::Args, llvm::ArrayRef< T >::begin(), llvm::ArrayRef< T >::empty(), and llvm::unwrap().

◆ LLVMRemarkEntryGetFunctionName()

LLVMRemarkStringRef LLVMRemarkEntryGetFunctionName ( LLVMRemarkEntryRef  Remark)

Get the name of the function being processed when the remark was emitted.

Since
REMARKS_API_VERSION=0

Definition at line 89 of file Remark.cpp.

References llvm::remarks::Remark::FunctionName, llvm::unwrap(), and llvm::wrap().

◆ LLVMRemarkEntryGetHotness()

uint64_t LLVMRemarkEntryGetHotness ( LLVMRemarkEntryRef  Remark)

Return the hotness of the remark.

A hotness of 0 means this value is not set.

Since
REMARKS_API_VERSION=0

Definition at line 100 of file Remark.cpp.

References llvm::remarks::Remark::Hotness, and llvm::unwrap().

◆ LLVMRemarkEntryGetNextArg()

LLVMRemarkArgRef LLVMRemarkEntryGetNextArg ( LLVMRemarkArgRef  It,
LLVMRemarkEntryRef  Remark 
)

Get the next argument in Remark from the position of It.

Returns NULL if there are no more arguments available.

The lifetime of the returned value is bound to the lifetime of Remark.

Since
REMARKS_API_VERSION=0

Definition at line 121 of file Remark.cpp.

References llvm::remarks::Remark::Args, and llvm::unwrap().

◆ LLVMRemarkEntryGetNumArgs()

uint32_t LLVMRemarkEntryGetNumArgs ( LLVMRemarkEntryRef  Remark)

The number of arguments the remark holds.

Since
REMARKS_API_VERSION=0

Definition at line 106 of file Remark.cpp.

References llvm::unwrap().

◆ LLVMRemarkEntryGetPassName()

LLVMRemarkStringRef LLVMRemarkEntryGetPassName ( LLVMRemarkEntryRef  Remark)

Get the name of the pass that emitted this remark.

Since
REMARKS_API_VERSION=0

Definition at line 79 of file Remark.cpp.

References llvm::remarks::Remark::PassName, llvm::unwrap(), and llvm::wrap().

◆ LLVMRemarkEntryGetRemarkName()

LLVMRemarkStringRef LLVMRemarkEntryGetRemarkName ( LLVMRemarkEntryRef  Remark)

Get an identifier of the remark.

Since
REMARKS_API_VERSION=0

Definition at line 84 of file Remark.cpp.

References llvm::remarks::Remark::RemarkName, llvm::unwrap(), and llvm::wrap().

◆ LLVMRemarkEntryGetType()

enum LLVMRemarkType LLVMRemarkEntryGetType ( LLVMRemarkEntryRef  Remark)

The type of the remark.

For example, it can allow users to only keep the missed optimizations from the compiler.

Since
REMARKS_API_VERSION=0

Definition at line 73 of file Remark.cpp.

References llvm::unwrap().

◆ LLVMRemarkParserCreateBitstream()

LLVMRemarkParserRef LLVMRemarkParserCreateBitstream ( const void *  Buf,
uint64_t  Size 
)

Creates a remark parser that can be used to parse the buffer located in Buf of size Size bytes.

Buf cannot be NULL.

This function should be paired with LLVMRemarkParserDispose() to avoid leaking resources.

Since
REMARKS_API_VERSION=1

Definition at line 136 of file RemarkParser.cpp.

References llvm::remarks::Bitstream, and llvm::wrap().

◆ LLVMRemarkParserCreateYAML()

LLVMRemarkParserRef LLVMRemarkParserCreateYAML ( const void *  Buf,
uint64_t  Size 
)

Creates a remark parser that can be used to parse the buffer located in Buf of size Size bytes.

Buf cannot be NULL.

This function should be paired with LLVMRemarkParserDispose() to avoid leaking resources.

Since
REMARKS_API_VERSION=0

Definition at line 130 of file RemarkParser.cpp.

References Size, llvm::wrap(), and llvm::remarks::YAML.

◆ LLVMRemarkParserDispose()

void LLVMRemarkParserDispose ( LLVMRemarkParserRef  Parser)

Releases all the resources used by Parser.

Since
REMARKS_API_VERSION=0

Definition at line 173 of file RemarkParser.cpp.

References llvm::unwrap().

◆ LLVMRemarkParserGetErrorMessage()

const char* LLVMRemarkParserGetErrorMessage ( LLVMRemarkParserRef  Parser)

Returns a null-terminated string containing an error message.

In case of no error, the result is NULL.

The memory of the string is bound to the lifetime of Parser. If LLVMRemarkParserDispose() is called, the memory of the string will be released.

Since
REMARKS_API_VERSION=0

Definition at line 169 of file RemarkParser.cpp.

References llvm::unwrap().

◆ LLVMRemarkParserGetNext()

LLVMRemarkEntryRef LLVMRemarkParserGetNext ( LLVMRemarkParserRef  Parser)

Returns the next remark in the file.

The value pointed to by the return value needs to be disposed using a call to LLVMRemarkEntryDispose().

All the entries in the returned value that are of LLVMRemarkStringRef type will become invalidated once a call to LLVMRemarkParserDispose is made.

If the parser reaches the end of the buffer, the return value will be NULL.

In the case of an error, the return value will be NULL, and:

1) LLVMRemarkParserHasError() will return 1.

2) LLVMRemarkParserGetErrorMessage() will return a descriptive error message.

An error may occur if:

1) An argument is invalid.

2) There is a parsing error. This can occur on things like malformed YAML.

3) There is a Remark semantic error. This can occur on well-formed files with missing or extra fields.

Here is a quick example of the usage:

while ((Remark = LLVMRemarkParserGetNext(Parser))) {
// use Remark
LLVMRemarkEntryDispose(Remark); // Release memory.
}
bool HasError = LLVMRemarkParserHasError(Parser);
Since
REMARKS_API_VERSION=0

Definition at line 143 of file RemarkParser.cpp.

References llvm::consumeError(), E, llvm::remarks::RemarkParser::next(), llvm::Expected< T >::takeError(), llvm::unwrap(), and llvm::wrap().

◆ LLVMRemarkParserHasError()

LLVMBool LLVMRemarkParserHasError ( LLVMRemarkParserRef  Parser)

Returns 1 if the parser encountered an error while parsing the buffer.

Since
REMARKS_API_VERSION=0

Definition at line 164 of file RemarkParser.cpp.

References llvm::unwrap().

◆ LLVMRemarkStringGetData()

const char* LLVMRemarkStringGetData ( LLVMRemarkStringRef  String)

Returns the buffer holding the string.

Since
REMARKS_API_VERSION=0

Definition at line 32 of file Remark.cpp.

References llvm::unwrap().

◆ LLVMRemarkStringGetLen()

uint32_t LLVMRemarkStringGetLen ( LLVMRemarkStringRef  String)

Returns the size of the string.

Since
REMARKS_API_VERSION=0

Definition at line 36 of file Remark.cpp.

References llvm::unwrap().

◆ LLVMRemarkVersion()

uint32_t LLVMRemarkVersion ( void  )

Returns the version of the remarks library.

Since
REMARKS_API_VERSION=0