Remarks.h File Reference

#include "llvm-c/ExternC.h"
#include "llvm-c/Types.h"
#include "llvm-c/Visibility.h"
#include <stddef.h>

Go to the source code of this file.

Macros
#define	REMARKS_API_VERSION   1

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

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

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