MLIR  19.0.0git
Classes | Public Member Functions | List of all members
mlir::BytecodeReader Class Reference

The BytecodeReader allows to load MLIR bytecode files, while keeping the state explicitly available in order to support lazy loading. More...

#include "mlir/Bytecode/BytecodeReader.h"

Classes

class  Impl
 This class is used to read a bytecode buffer and translate it into MLIR. More...
 

Public Member Functions

 BytecodeReader (llvm::MemoryBufferRef buffer, const ParserConfig &config, bool lazyLoad, const std::shared_ptr< llvm::SourceMgr > &bufferOwnerRef={})
 Create a bytecode reader for the given buffer. More...
 
 ~BytecodeReader ()
 
LogicalResult readTopLevel (Block *block, llvm::function_ref< bool(Operation *)> lazyOps=[](Operation *) { return false;})
 Read the operations defined within the given memory buffer, containing MLIR bytecode, into the provided block. More...
 
int64_t getNumOpsToMaterialize () const
 Return the number of ops that haven't been materialized yet. More...
 
bool isMaterializable (Operation *op)
 Return true if the provided op is materializable. More...
 
LogicalResult materialize (Operation *op, llvm::function_ref< bool(Operation *)> lazyOpsCallback=[](Operation *) { return false;})
 Materialize the provide operation. More...
 
LogicalResult finalize (function_ref< bool(Operation *)> shouldMaterialize=[](Operation *) { return true;})
 Finalize the lazy-loading by calling back with every op that hasn't been materialized to let the client decide if the op should be deleted or materialized. More...
 

Detailed Description

The BytecodeReader allows to load MLIR bytecode files, while keeping the state explicitly available in order to support lazy loading.

The finalize method must be called before destruction.

Definition at line 30 of file BytecodeReader.h.

Constructor & Destructor Documentation

◆ BytecodeReader()

BytecodeReader::BytecodeReader ( llvm::MemoryBufferRef  buffer,
const ParserConfig config,
bool  lazyLoad,
const std::shared_ptr< llvm::SourceMgr > &  bufferOwnerRef = {} 
)
explicit

Create a bytecode reader for the given buffer.

If lazyLoad is true, isolated regions aren't loaded eagerly.

Definition at line 2531 of file BytecodeReader.cpp.

References mlir::get(), and mlir::ParserConfig::getContext().

◆ ~BytecodeReader()

BytecodeReader::~BytecodeReader ( )

Definition at line 2529 of file BytecodeReader.cpp.

References getNumOpsToMaterialize().

Member Function Documentation

◆ finalize()

LogicalResult BytecodeReader::finalize ( function_ref< bool(Operation *)>  shouldMaterialize = [](Operation *) { return true; })

Finalize the lazy-loading by calling back with every op that hasn't been materialized to let the client decide if the op should be deleted or materialized.

The op is materialized if the callback returns true, deleted otherwise. The implementation of the callback must be thread-safe.

Definition at line 2560 of file BytecodeReader.cpp.

◆ getNumOpsToMaterialize()

int64_t BytecodeReader::getNumOpsToMaterialize ( ) const

Return the number of ops that haven't been materialized yet.

Definition at line 2546 of file BytecodeReader.cpp.

Referenced by ~BytecodeReader().

◆ isMaterializable()

bool BytecodeReader::isMaterializable ( Operation op)

Return true if the provided op is materializable.

Definition at line 2550 of file BytecodeReader.cpp.

◆ materialize()

LogicalResult BytecodeReader::materialize ( Operation op,
llvm::function_ref< bool(Operation *)>  lazyOpsCallback = [](Operation *) { return false; } 
)

Materialize the provide operation.

The provided operation must be materializable. The lazyOps call back is invoked for every ops that can be lazy-loaded. This let the client decide if the op should be materialized immediately or delayed. !! Using this materialize withing an IR walk() can be confusing: make sure to use a PreOrder traversal !!

Definition at line 2554 of file BytecodeReader.cpp.

◆ readTopLevel()

LogicalResult BytecodeReader::readTopLevel ( Block block,
llvm::function_ref< bool(Operation *)>  lazyOps = [](Operation *) { return false; } 
)

Read the operations defined within the given memory buffer, containing MLIR bytecode, into the provided block.

If the reader was created with lazyLoad enabled, isolated regions aren't loaded eagerly. The lazyOps call back is invoked for every ops that can be lazy-loaded. This let the client decide if the op should be materialized immediately or delayed.

Definition at line 2541 of file BytecodeReader.cpp.


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