circt::Namespace Class Reference

A namespace that is used to store existing names and generate new names in some scope within the IR. More...

#include <Namespace.h>

Inheritance diagram for circt::Namespace:

Collaboration diagram for circt::Namespace:

Public Member Functions
	Namespace ()
	Namespace (const Namespace &other)=default
	Namespace (Namespace &&other)
Namespace &	operator= (const Namespace &other)=default
Namespace &	operator= (Namespace &&other)
void	add (mlir::ModuleOp module)
void	add (SymbolCache &symCache)
	SymbolCache initializer; initialize from every key that is convertible to a StringAttr in the SymbolCache. More...
bool	erase (llvm::StringRef symbol)
	Removes a symbol from the namespace. More...
void	clear ()
	Empty the namespace. More...
StringRef	newName (const Twine &name)
	Return a unique name, derived from the input name, and add the new name to the internal namespace. More...
StringRef	newName (const Twine &name, const Twine &suffix)
	Return a unique name, derived from the input name and ensure the returned name has the input suffix. More...

Protected Attributes
llvm::StringMap< size_t >	nextIndex
bool	locked = false

Detailed Description

A namespace that is used to store existing names and generate new names in some scope within the IR.

This exists to work around limitations of SymbolTables. This acts as a base class providing facilities common to all namespaces implementations.

Definition at line 30 of file Namespace.h.

Constructor & Destructor Documentation

Namespace() [1/3]

circt::Namespace::Namespace ( )

inline

Definition at line 32 of file Namespace.h.

References nextIndex.

Namespace() [2/3]

circt::Namespace::Namespace ( const Namespace &  other )

default

Namespace() [3/3]

circt::Namespace::Namespace ( Namespace &&  other )

inline

Definition at line 38 of file Namespace.h.

Member Function Documentation

add() [1/2]

void circt::Namespace::add ( mlir::ModuleOp  module )

inline

Definition at line 48 of file Namespace.h.

References assert(), and nextIndex.

Referenced by circt::SMTGlobalsHandler::create(), circt::FirMemLowering::FirMemLowering(), LowerDPIFunc::LowerDPIFunc(), circt::ExportVerilog::lowerHWInstanceChoices(), and circt::SMTGlobalsHandler::SMTGlobalsHandler().

add() [2/2]

void circt::Namespace::add ( SymbolCache &  symCache )

inline

SymbolCache initializer; initialize from every key that is convertible to a StringAttr in the SymbolCache.

Definition at line 58 of file Namespace.h.

References nextIndex.

clear()

void circt::Namespace::clear ( )

inline

Empty the namespace.

Definition at line 73 of file Namespace.h.

References locked, and nextIndex.

erase()

bool circt::Namespace::erase ( llvm::StringRef  symbol )

inline

Removes a symbol from the namespace.

Returns true if the symbol was removed, false if the symbol was not found. This is only allowed to be called before any call to newName.

Definition at line 67 of file Namespace.h.

References assert(), locked, and nextIndex.

newName() [1/2]

StringRef circt::Namespace::newName ( const Twine &  name )

inline

Return a unique name, derived from the input name, and add the new name to the internal namespace.

There are two possible outcomes for the returned name:

1. The original name is returned.
2. The name is given a _<n> suffix where <n> is a number starting from 0 and incrementing by one each time (_0, ...).

Definition at line 85 of file Namespace.h.

References locked, and nextIndex.

Referenced by circt::firrtl::applyGCTMemTaps(), circt::SMTGlobalsHandler::create(), circt::FirMemLowering::createMemoryModule(), createModuleForCut(), circt::ExportVerilog::lowerHWInstanceChoices(), LowerLayersPass::preprocessLayers(), ModuleNameSanitizer::rewrite(), and LowerLayersPass::runOnOperation().

newName() [2/2]

StringRef circt::Namespace::newName ( const Twine &  name, const Twine &  suffix  )

inline

Return a unique name, derived from the input name and ensure the returned name has the input suffix.

Also add the new name to the internal namespace. There are two possible outcomes for the returned name:

1. The original name + _<suffix> is returned.
2. The name is given a suffix _<n>_<suffix> where <n> is a number starting from 0 and incrementing by one each time.

Definition at line 119 of file Namespace.h.

References concat(), locked, and nextIndex.

operator=() [1/2]

Namespace& circt::Namespace::operator= ( const Namespace &  other )

default

operator=() [2/2]

Namespace& circt::Namespace::operator= ( Namespace &&  other )

inline

Definition at line 42 of file Namespace.h.

References locked, and nextIndex.

Member Data Documentation

locked

bool circt::Namespace::locked = false

protected

Definition at line 164 of file Namespace.h.

Referenced by clear(), erase(), newName(), and operator=().

nextIndex

llvm::StringMap<size_t> circt::Namespace::nextIndex

protected

Definition at line 159 of file Namespace.h.

Referenced by circt::firrtl::CircuitNamespace::add(), add(), circt::hw::InnerSymbolNamespace::add(), clear(), erase(), Namespace(), newName(), and operator=().

---

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

• /home/runner/work/circt-www/circt-www/circt_src/include/circt/Support/Namespace.h