mlir::OpPrintingFlags Class Reference

Set of flags used to control the behavior of the various IR print methods (e.g. More...

#include "mlir/IR/OperationSupport.h"

Public Member Functions
	OpPrintingFlags ()
	Initialize the printing flags with default supplied by the cl::opts above. More...
	OpPrintingFlags (std::nullopt_t)
OpPrintingFlags &	elideLargeElementsAttrs (int64_t largeElementLimit=16)
	Enables the elision of large elements attributes by printing a lexically valid but otherwise meaningless form instead of the element data. More...
OpPrintingFlags &	enableDebugInfo (bool enable=true, bool prettyForm=false)
	Enable or disable printing of debug information (based on enable). More...
OpPrintingFlags &	printGenericOpForm ()
	Always print operations in the generic form. More...
OpPrintingFlags &	skipRegions ()
	Skip printing regions. More...
OpPrintingFlags &	assumeVerified ()
	Do not verify the operation when using custom operation printers. More...
OpPrintingFlags &	useLocalScope ()
	Use local scope when printing the operation. More...
OpPrintingFlags &	printValueUsers ()
	Print users of values as comments. More...
bool	shouldElideElementsAttr (ElementsAttr attr) const
	Return if the given ElementsAttr should be elided. More...
std::optional< int64_t >	getLargeElementsAttrLimit () const
	Return the size limit for printing large ElementsAttr. More...
bool	shouldPrintDebugInfo () const
	Return if debug information should be printed. More...
bool	shouldPrintDebugInfoPrettyForm () const
	Return if debug information should be printed in the pretty form. More...
bool	shouldPrintGenericOpForm () const
	Return if operations should be printed in the generic form. More...
bool	shouldSkipRegions () const
	Return if regions should be skipped. More...
bool	shouldAssumeVerified () const
	Return if operation verification should be skipped. More...
bool	shouldUseLocalScope () const
	Return if the printer should use local scope when dumping the IR. More...
bool	shouldPrintValueUsers () const
	Return if the printer should print users of values. More...

Detailed Description

Set of flags used to control the behavior of the various IR print methods (e.g.

Operation::Print).

Definition at line 816 of file OperationSupport.h.

Constructor & Destructor Documentation

OpPrintingFlags() [1/2]

OpPrintingFlags::OpPrintingFlags

(

)

Initialize the printing flags with default supplied by the cl::opts above.

Definition at line 184 of file AsmPrinter.cpp.

References clOptions.

OpPrintingFlags() [2/2]

mlir::OpPrintingFlags::OpPrintingFlags ( std::nullopt_t  )

inline

Definition at line 819 of file OperationSupport.h.

Member Function Documentation

assumeVerified()

OpPrintingFlags & OpPrintingFlags::assumeVerified

(

)

Do not verify the operation when using custom operation printers.

Definition at line 234 of file AsmPrinter.cpp.

elideLargeElementsAttrs()

OpPrintingFlags & OpPrintingFlags::elideLargeElementsAttrs

(

int64_t

largeElementLimit = 16

)

Enables the elision of large elements attributes by printing a lexically valid but otherwise meaningless form instead of the element data.

Enable the elision of large elements attributes, by printing a '...' instead of the element data, when the number of elements is greater than largeElementLimit.

The largeElementLimit is used to configure what is considered to be a "large" ElementsAttr by providing an upper limit to the number of elements.

Note: The IR generated with this option is not parsable.

Definition at line 207 of file AsmPrinter.cpp.

Referenced by adjustPrintingFlags().

enableDebugInfo()

OpPrintingFlags & OpPrintingFlags::enableDebugInfo	(	bool	enable = true,
		bool	prettyForm = false
	)

Enable or disable printing of debug information (based on enable).

Enable printing of debug information.

If 'prettyForm' is set to true, debug information is printed in a more readable 'pretty' form. Note: The IR generated with 'prettyForm' is not parsable.

If 'prettyForm' is set to true, debug information is printed in a more readable 'pretty' form.

Definition at line 214 of file AsmPrinter.cpp.

getLargeElementsAttrLimit()

std::optional< int64_t > OpPrintingFlags::getLargeElementsAttrLimit

(

)

const

Return the size limit for printing large ElementsAttr.

Definition at line 261 of file AsmPrinter.cpp.

printGenericOpForm()

OpPrintingFlags & OpPrintingFlags::printGenericOpForm

(

)

Always print operations in the generic form.

Definition at line 222 of file AsmPrinter.cpp.

Referenced by adjustPrintingFlags().

printValueUsers()

OpPrintingFlags & OpPrintingFlags::printValueUsers

(

)

Print users of values as comments.

Definition at line 248 of file AsmPrinter.cpp.

shouldAssumeVerified()

bool OpPrintingFlags::shouldAssumeVerified

(

)

const

Return if operation verification should be skipped.

Definition at line 284 of file AsmPrinter.cpp.

Referenced by verifyOpAndAdjustFlags().

shouldElideElementsAttr()

bool OpPrintingFlags::shouldElideElementsAttr

(

ElementsAttr

attr

)

const

Return if the given ElementsAttr should be elided.

Definition at line 254 of file AsmPrinter.cpp.

shouldPrintDebugInfo()

bool OpPrintingFlags::shouldPrintDebugInfo

(

)

const

Return if debug information should be printed.

Definition at line 266 of file AsmPrinter.cpp.

Referenced by mlir::AsmPrinter::Impl::printTrailingLocation().

shouldPrintDebugInfoPrettyForm()

bool OpPrintingFlags::shouldPrintDebugInfoPrettyForm

(

)

const

Return if debug information should be printed in the pretty form.

Definition at line 271 of file AsmPrinter.cpp.

Referenced by mlir::AsmPrinter::Impl::printLocation().

shouldPrintGenericOpForm()

bool OpPrintingFlags::shouldPrintGenericOpForm

(

)

const

Return if operations should be printed in the generic form.

Definition at line 276 of file AsmPrinter.cpp.

Referenced by verifyOpAndAdjustFlags().

shouldPrintValueUsers()

bool OpPrintingFlags::shouldPrintValueUsers

(

)

const

Return if the printer should print users of values.

Definition at line 292 of file AsmPrinter.cpp.

shouldSkipRegions()

bool OpPrintingFlags::shouldSkipRegions

(

)

const

Return if regions should be skipped.

Return if Region should be skipped.

Definition at line 281 of file AsmPrinter.cpp.

Referenced by printBlock().

shouldUseLocalScope()

bool OpPrintingFlags::shouldUseLocalScope

(

)

const

Return if the printer should use local scope when dumping the IR.

Definition at line 289 of file AsmPrinter.cpp.

Referenced by mlir::Operation::print().

skipRegions()

OpPrintingFlags & OpPrintingFlags::skipRegions

(

)

Skip printing regions.

Always skip Regions.

Definition at line 228 of file AsmPrinter.cpp.

Referenced by printBlock().

useLocalScope()

OpPrintingFlags & OpPrintingFlags::useLocalScope

(

)

Use local scope when printing the operation.

This allows for using the printer in a more localized and thread-safe setting, but may not necessarily be identical to what the IR will look like when dumping the full module.

This allows for using the printer in a more localized and thread-safe setting, but may not necessarily be identical of what the IR will look like when dumping the full module.

Definition at line 242 of file AsmPrinter.cpp.

Referenced by adjustPrintingFlags(), mlir::operator<<(), and printIR().

---

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

• include/mlir/IR/OperationSupport.h
• lib/IR/AsmPrinter.cpp