circt::rtg::RtgToolOptions Class Reference

The set of options used to control the behavior of the RTG tool. More...

#include <RtgToolOptions.h>

Collaboration diagram for circt::rtg::RtgToolOptions:

Public Types
enum class	OutputFormat { MLIR , ElaboratedMLIR , ASM }

Public Member Functions
	RtgToolOptions (unsigned seed)
void	setOutputFormat (OutputFormat format)
OutputFormat	getOutputFormat () const
RtgToolOptions &	setSeed (unsigned seed)
unsigned	getSeed () const
RtgToolOptions &	setVerifyPasses (bool enable)
bool	getVerifyPasses () const
RtgToolOptions &	setVerbosePassExecution (bool enable)
bool	getVerbosePassExecution () const
RtgToolOptions &	setUnsupportedInstructions (SmallVector< std::string > &&instr)
RtgToolOptions &	setUnsupportedInstructions (ArrayRef< std::string > instr)
RtgToolOptions &	addUnsupportedInstruction (const std::string &instr)
ArrayRef< std::string >	getUnsupportedInstructions () const
RtgToolOptions &	setUnsupportedInstructionsFile (StringRef filename)
std::string	getUnsupportedInstructionsFile () const
RtgToolOptions &	setSplitOutput (bool enable)
bool	getSplitOutput () const
RtgToolOptions &	setOutputPath (StringRef path)
std::string	getOutputPath () const
RtgToolOptions &	setMemoriesAsImmediates (bool enable)
bool	getMemoriesAsImmediates () const

Private Attributes
OutputFormat	outputFormat = OutputFormat::ElaboratedMLIR
unsigned	seed
bool	verifyPasses = true
bool	verbosePassExecution = false
SmallVector< std::string >	unsupportedInstructions
std::string	unsupportedInstructionsFile
bool	splitOutput = false
std::string	outputPath
bool	memoriesAsImmediates = true

Detailed Description

The set of options used to control the behavior of the RTG tool.

Definition at line 25 of file RtgToolOptions.h.

Member Enumeration Documentation

OutputFormat

enum class circt::rtg::RtgToolOptions::OutputFormat

strong

Enumerator
MLIR
ElaboratedMLIR
ASM

Definition at line 27 of file RtgToolOptions.h.

Constructor & Destructor Documentation

RtgToolOptions()

circt::rtg::RtgToolOptions::RtgToolOptions ( unsigned  seed )

inline

Definition at line 29 of file RtgToolOptions.h.

Member Function Documentation

addUnsupportedInstruction()

RtgToolOptions & circt::rtg::RtgToolOptions::addUnsupportedInstruction ( const std::string &  instr )

inline

Definition at line 60 of file RtgToolOptions.h.

References unsupportedInstructions.

getMemoriesAsImmediates()

bool circt::rtg::RtgToolOptions::getMemoriesAsImmediates ( ) const

inline

Definition at line 92 of file RtgToolOptions.h.

References memoriesAsImmediates.

Referenced by circt::rtg::populateRandomizerPipeline().

getOutputFormat()

OutputFormat circt::rtg::RtgToolOptions::getOutputFormat ( ) const

inline

Definition at line 32 of file RtgToolOptions.h.

References outputFormat.

Referenced by circt::rtg::populateRandomizerPipeline().

getOutputPath()

std::string circt::rtg::RtgToolOptions::getOutputPath ( ) const

inline

Definition at line 86 of file RtgToolOptions.h.

References outputPath.

Referenced by circt::rtg::populateRandomizerPipeline().

getSeed()

unsigned circt::rtg::RtgToolOptions::getSeed ( ) const

inline

Definition at line 38 of file RtgToolOptions.h.

References seed.

Referenced by circt::rtg::populateRandomizerPipeline().

getSplitOutput()

bool circt::rtg::RtgToolOptions::getSplitOutput ( ) const

inline

Definition at line 80 of file RtgToolOptions.h.

References splitOutput.

Referenced by circt::rtg::populateRandomizerPipeline().

getUnsupportedInstructions()

ArrayRef< std::string > circt::rtg::RtgToolOptions::getUnsupportedInstructions ( ) const

inline

Definition at line 64 of file RtgToolOptions.h.

References unsupportedInstructions.

Referenced by circt::rtg::populateRandomizerPipeline().

getUnsupportedInstructionsFile()

std::string circt::rtg::RtgToolOptions::getUnsupportedInstructionsFile ( ) const

inline

Definition at line 72 of file RtgToolOptions.h.

References unsupportedInstructionsFile.

Referenced by circt::rtg::populateRandomizerPipeline().

getVerbosePassExecution()

bool circt::rtg::RtgToolOptions::getVerbosePassExecution ( ) const

inline

Definition at line 50 of file RtgToolOptions.h.

References verbosePassExecution.

Referenced by circt::rtg::populateRandomizerPipeline().

getVerifyPasses()

bool circt::rtg::RtgToolOptions::getVerifyPasses ( ) const

inline

Definition at line 44 of file RtgToolOptions.h.

References verifyPasses.

Referenced by circt::rtg::populateRandomizerPipeline().

setMemoriesAsImmediates()

RtgToolOptions & circt::rtg::RtgToolOptions::setMemoriesAsImmediates ( bool  enable )

inline

Definition at line 88 of file RtgToolOptions.h.

References memoriesAsImmediates.

setOutputFormat()

void circt::rtg::RtgToolOptions::setOutputFormat ( OutputFormat  format )

inline

Definition at line 31 of file RtgToolOptions.h.

References outputFormat.

setOutputPath()

RtgToolOptions & circt::rtg::RtgToolOptions::setOutputPath ( StringRef  path )

inline

Definition at line 82 of file RtgToolOptions.h.

References outputPath.

setSeed()

RtgToolOptions & circt::rtg::RtgToolOptions::setSeed ( unsigned  seed )

inline

Definition at line 34 of file RtgToolOptions.h.

References seed.

setSplitOutput()

RtgToolOptions & circt::rtg::RtgToolOptions::setSplitOutput ( bool  enable )

inline

Definition at line 76 of file RtgToolOptions.h.

References splitOutput.

setUnsupportedInstructions() [1/2]

RtgToolOptions & circt::rtg::RtgToolOptions::setUnsupportedInstructions ( ArrayRef< std::string >  instr )

inline

Definition at line 56 of file RtgToolOptions.h.

References unsupportedInstructions.

setUnsupportedInstructions() [2/2]

RtgToolOptions & circt::rtg::RtgToolOptions::setUnsupportedInstructions ( SmallVector< std::string > &&  instr )

inline

Definition at line 52 of file RtgToolOptions.h.

References unsupportedInstructions.

setUnsupportedInstructionsFile()

RtgToolOptions & circt::rtg::RtgToolOptions::setUnsupportedInstructionsFile ( StringRef  filename )

inline

Definition at line 68 of file RtgToolOptions.h.

References unsupportedInstructionsFile.

setVerbosePassExecution()

RtgToolOptions & circt::rtg::RtgToolOptions::setVerbosePassExecution ( bool  enable )

inline

Definition at line 46 of file RtgToolOptions.h.

References verbosePassExecution.

setVerifyPasses()

RtgToolOptions & circt::rtg::RtgToolOptions::setVerifyPasses ( bool  enable )

inline

Definition at line 40 of file RtgToolOptions.h.

References verifyPasses.

Member Data Documentation

memoriesAsImmediates

bool circt::rtg::RtgToolOptions::memoriesAsImmediates = true

private

Definition at line 103 of file RtgToolOptions.h.

Referenced by getMemoriesAsImmediates(), and setMemoriesAsImmediates().

outputFormat

OutputFormat circt::rtg::RtgToolOptions::outputFormat = OutputFormat::ElaboratedMLIR

private

Definition at line 95 of file RtgToolOptions.h.

Referenced by getOutputFormat(), and setOutputFormat().

outputPath

std::string circt::rtg::RtgToolOptions::outputPath

private

Definition at line 102 of file RtgToolOptions.h.

Referenced by getOutputPath(), and setOutputPath().

seed

unsigned circt::rtg::RtgToolOptions::seed

private

Definition at line 96 of file RtgToolOptions.h.

Referenced by getSeed(), and setSeed().

splitOutput

bool circt::rtg::RtgToolOptions::splitOutput = false

private

Definition at line 101 of file RtgToolOptions.h.

Referenced by getSplitOutput(), and setSplitOutput().

unsupportedInstructions

SmallVector<std::string> circt::rtg::RtgToolOptions::unsupportedInstructions

private

Definition at line 99 of file RtgToolOptions.h.

Referenced by addUnsupportedInstruction(), getUnsupportedInstructions(), setUnsupportedInstructions(), and setUnsupportedInstructions().

unsupportedInstructionsFile

std::string circt::rtg::RtgToolOptions::unsupportedInstructionsFile

private

Definition at line 100 of file RtgToolOptions.h.

Referenced by getUnsupportedInstructionsFile(), and setUnsupportedInstructionsFile().

verbosePassExecution

bool circt::rtg::RtgToolOptions::verbosePassExecution = false

private

Definition at line 98 of file RtgToolOptions.h.

Referenced by getVerbosePassExecution(), and setVerbosePassExecution().

verifyPasses

bool circt::rtg::RtgToolOptions::verifyPasses = true

private

Definition at line 97 of file RtgToolOptions.h.

Referenced by getVerifyPasses(), and setVerifyPasses().

---

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

• /home/runner/work/circt-www/circt-www/circt_src/include/circt/Tools/rtgtool/RtgToolOptions.h