llvm::setupLLVMOptimizationRemarks

Synopses

Declared in <llvm/IR/LLVMRemarkStreamer.h>

Set up optimization remarks that output to a file.

Expected<LLVMRemarkFileHandle>
setupLLVMOptimizationRemarks(
    LLVMContext& Context,
    StringRef RemarksFilename,
    StringRef RemarksPasses,
    StringRef RemarksFormat,
    bool RemarksWithHotness,
    std::optional<uint64_t> RemarksHotnessThreshold = 0);

» more...

Set up optimization remarks that output directly to a raw_ostream.

Error
setupLLVMOptimizationRemarks(
    LLVMContext& Context,
    raw_ostream& OS,
    StringRef RemarksPasses,
    StringRef RemarksFormat,
    bool RemarksWithHotness,
    std::optional<uint64_t> RemarksHotnessThreshold = 0);

» more...

Return Value

Handle owning the remarks output file, or an error on failure.
Success, or an error if remark setup fails.

Parameters

Name	Description
Context	LLVM context that receives the remark streamer.
RemarksFilename	Output path for optimization remarks.
RemarksPasses	Regex of pass names whose remarks should be emitted.
RemarksFormat	Serialization format for remarks.
RemarksWithHotness	Whether to include profile hotness information.
RemarksHotnessThreshold	Minimum hotness required to emit a remark.
OS	Stream that receives serialized remarks.