The type of the emitted remark. (enum LLVMRemarkType)

Enum values:

• RemarkTypeUnknown
• RemarkTypePassed
• RemarkTypeMissed
• RemarkTypeAnalysis
• RemarkTypeAnalysisFPCommute
• RemarkTypeAnalysisAliasing
• RemarkTypeFailure

The type of the emitted remark. (enum LLVMRemarkType)

Enum values:

• RemarkTypeUnknown
• RemarkTypePassed
• RemarkTypeMissed
• RemarkTypeAnalysis
• RemarkTypeAnalysisFPCommute
• RemarkTypeAnalysisAliasing
• RemarkTypeFailure

The type of the emitted remark. (enum LLVMRemarkType)

Enum values:

• RemarkTypeUnknown
• RemarkTypePassed
• RemarkTypeMissed
• RemarkTypeAnalysis
• RemarkTypeAnalysisFPCommute
• RemarkTypeAnalysisAliasing
• RemarkTypeFailure

The type of the emitted remark. (enum LLVMRemarkType)

Enum values:

• RemarkTypeUnknown
• RemarkTypePassed
• RemarkTypeMissed
• RemarkTypeAnalysis
• RemarkTypeAnalysisFPCommute
• RemarkTypeAnalysisAliasing
• RemarkTypeFailure

The type of the emitted remark. (enum LLVMRemarkType)

Enum values:

• RemarkTypeUnknown
• RemarkTypePassed
• RemarkTypeMissed
• RemarkTypeAnalysis
• RemarkTypeAnalysisFPCommute
• RemarkTypeAnalysisAliasing
• RemarkTypeFailure

The type of the emitted remark. (enum LLVMRemarkType)

Enum values:

• RemarkTypeUnknown
• RemarkTypePassed
• RemarkTypeMissed
• RemarkTypeAnalysis
• RemarkTypeAnalysisFPCommute
• RemarkTypeAnalysisAliasing
• RemarkTypeFailure

The type of the emitted remark. (enum LLVMRemarkType)

Enum values:

• RemarkTypeUnknown
• RemarkTypePassed
• RemarkTypeMissed
• RemarkTypeAnalysis
• RemarkTypeAnalysisFPCommute
• RemarkTypeAnalysisAliasing
• RemarkTypeFailure

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.

Annotations

@NativeType:LLVMRemarkDebugLocRef

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.

Annotations

@NativeType:LLVMRemarkStringRef

Returns the value of an argument. This is a string that can contain newlines.

Annotations

@NativeType:LLVMRemarkStringRef

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

Annotations

@NativeType:uint32_t

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

Annotations

@NativeType:LLVMRemarkStringRef

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

Annotations

@NativeType:uint32_t

Free the resources used by the remark entry.

Returns the debug location that is attached to this remark.

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

Annotations

@NativeType:LLVMRemarkDebugLocRef

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.

Annotations

@NativeType:LLVMRemarkArgRef

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

Annotations

@NativeType:LLVMRemarkStringRef

Return the hotness of the remark.

A hotness of 0 means this value is not set.

Annotations

@NativeType:uint64_t

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.

Annotations

@NativeType:LLVMRemarkArgRef

The number of arguments the remark holds.

Annotations

@NativeType:uint32_t

Get the name of the pass that emitted this remark.

Annotations

@NativeType:LLVMRemarkStringRef

Get an identifier of the remark.

Annotations

@NativeType:LLVMRemarkStringRef

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

Annotations

@NativeType:enum LLVMRemarkType

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 RemarkParserDispose to avoid leaking resources.

Annotations

@NativeType:LLVMRemarkParserRef

Since

10

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 RemarkParserDispose to avoid leaking resources.

Annotations

@NativeType:LLVMRemarkParserRef

Releases all the resources used by 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 RemarkParserDispose is called, the memory of the string will be released.

Annotations

@Nullable

@NativeType:char const *

Returns the next remark in the file.

The value pointed to by the return value needs to be disposed using a call to RemarkEntryDispose.

All the entries in the returned value that are of LLVMRemarkStringRef type will become invalidated once a call to RemarkParserDispose 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:

• RemarkParserHasError will return 1.
• RemarkParserGetErrorMessage will return a descriptive error message.

An error may occur if:

• An argument is invalid.
• There is a parsing error. This can occur on things like malformed YAML.
• 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:

LLVMRemarkParserRef Parser = LLVMRemarkParserCreateYAML(Buf, Size);
LLVMRemarkEntryRef Remark = NULL;
while ((Remark = LLVMRemarkParserGetNext(Parser))) {
    // use Remark
    LLVMRemarkEntryDispose(Remark); // Release memory.
}
bool HasError = LLVMRemarkParserHasError(Parser);
LLVMRemarkParserDispose(Parser);

Annotations

@NativeType:LLVMRemarkEntryRef

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

Annotations

@NativeType:LLVMBool

Returns the buffer holding the string.

Annotations

@Nullable

@NativeType:char const *

Returns the size of the string.

Annotations

@NativeType:uint32_t

Returns the version of the remarks library.

Annotations

@NativeType:uint32_t

Unsafe version of: RemarkParserCreateBitstream

Unsafe version of: RemarkParserCreateYAML

Unsafe version of: RemarkParserGetErrorMessage

Unsafe version of: RemarkStringGetData