MLIR 24.0.0git
mlir::remark::detail::LLVMRemarkStreamer Class Referencefinal

Concrete streamer that writes LLVM optimization remarks to a file (YAML or Bitstream). More...

#include "mlir/Remark/RemarkStreamer.h"

Inheritance diagram for mlir::remark::detail::LLVMRemarkStreamer:

Public Member Functions

void streamOptimizationRemark (const Remark &remark) override
 Stream an optimization remark to the underlying remark streamer.
void finalize () override
 Finalize after all reporting threads have stopped.
 ~LLVMRemarkStreamer () override
Public Member Functions inherited from mlir::remark::detail::MLIRRemarkStreamerBase
virtual ~MLIRRemarkStreamerBase ()=default

Static Public Member Functions

static llvm::Expected< std::unique_ptr< MLIRRemarkStreamerBase > > createToFile (llvm::StringRef path, llvm::remarks::Format fmt)
 Open path and create the serializer for fmt.

Detailed Description

Concrete streamer that writes LLVM optimization remarks to a file (YAML or Bitstream).

Lives outside core.

Definition at line 29 of file RemarkStreamer.h.

Constructor & Destructor Documentation

◆ ~LLVMRemarkStreamer()

mlir::remark::detail::LLVMRemarkStreamer::~LLVMRemarkStreamer ( )
override

Definition at line 46 of file RemarkStreamer.cpp.

Member Function Documentation

◆ createToFile()

llvm::Expected< std::unique_ptr< MLIRRemarkStreamerBase > > mlir::remark::detail::LLVMRemarkStreamer::createToFile ( llvm::StringRef path,
llvm::remarks::Format fmt )
static

Open path and create the serializer for fmt.

Definition at line 15 of file RemarkStreamer.cpp.

References mlir::openOutputFile().

Referenced by mlir::remark::enableOptimizationRemarksWithLLVMStreamer().

◆ finalize()

void mlir::remark::detail::LLVMRemarkStreamer::finalize ( )
overridevirtual

Finalize after all reporting threads have stopped.

Reimplemented from mlir::remark::detail::MLIRRemarkStreamerBase.

Definition at line 51 of file RemarkStreamer.cpp.

◆ streamOptimizationRemark()

void mlir::remark::detail::LLVMRemarkStreamer::streamOptimizationRemark ( const Remark & remark)
overridevirtual

Stream an optimization remark to the underlying remark streamer.

It is called by the RemarkEngine to stream the optimization remarks.

It must be overridden by the derived classes to provide the actual streaming implementation.

Implements mlir::remark::detail::MLIRRemarkStreamerBase.

Definition at line 35 of file RemarkStreamer.cpp.


The documentation for this class was generated from the following files: