This holds a decoded list of input/inout and output ports for a module or instance. More...

#include <PortImplementation.h>

Collaboration diagram for circt::hw::ModulePortInfo:

[legend]

Public Types
using	iterator = SmallVector< PortInfo >::iterator

using	const_iterator = SmallVector< PortInfo >::const_iterator

using	PortDirectionRange = llvm::iterator_range< llvm::filter_iterator< iterator, std::function< bool(const PortInfo &)> > >

using	ConstPortDirectionRange = llvm::iterator_range< llvm::filter_iterator< const_iterator, std::function< bool(const PortInfo &)> > >

Public Member Functions
	ModulePortInfo (ArrayRef< PortInfo > inputs, ArrayRef< PortInfo > outputs)

	ModulePortInfo (ArrayRef< PortInfo > mergedPorts)

iterator	begin ()

iterator	end ()

const_iterator	begin () const

const_iterator	end () const

PortDirectionRange	getPortsOfDirection (bool input)

ConstPortDirectionRange	getPortsOfDirection (bool input) const

PortDirectionRange	getInputs ()

PortDirectionRange	getOutputs ()

ConstPortDirectionRange	getInputs () const

ConstPortDirectionRange	getOutputs () const

size_t	size () const

size_t	sizeInputs () const

size_t	sizeOutputs () const

size_t	portNumForInput (size_t idx) const

size_t	portNumForOutput (size_t idx) const

PortInfo &	at (size_t idx)

PortInfo &	atInput (size_t idx)

PortInfo &	atOutput (size_t idx)

const PortInfo &	at (size_t idx) const

const PortInfo &	atInput (size_t idx) const

const PortInfo &	atOutput (size_t idx) const

void	eraseInput (size_t idx)

Private Member Functions
void	sanitizeInOut ()

Private Attributes
SmallVector< PortInfo >	ports
	This contains a list of all ports. Input first.

Detailed Description

This holds a decoded list of input/inout and output ports for a module or instance.

Definition at line 57 of file PortImplementation.h.

Member Typedef Documentation

◆ const_iterator

using circt::hw::ModulePortInfo::const_iterator = SmallVector<PortInfo>::const_iterator

Definition at line 71 of file PortImplementation.h.

◆ ConstPortDirectionRange

using circt::hw::ModulePortInfo::ConstPortDirectionRange = llvm::iterator_range<llvm::filter_iterator< const_iterator, std::function<bool(const PortInfo &)> >>

Definition at line 81 of file PortImplementation.h.

◆ iterator

using circt::hw::ModulePortInfo::iterator = SmallVector<PortInfo>::iterator

Definition at line 70 of file PortImplementation.h.

◆ PortDirectionRange

using circt::hw::ModulePortInfo::PortDirectionRange = llvm::iterator_range< llvm::filter_iterator<iterator, std::function<bool(const PortInfo &)> >>

Definition at line 78 of file PortImplementation.h.

Constructor & Destructor Documentation

◆ ModulePortInfo() [1/2]

circt::hw::ModulePortInfo::ModulePortInfo	(	ArrayRef< PortInfo >	inputs,
		ArrayRef< PortInfo >	outputs
	)

inlineexplicit

Definition at line 58 of file PortImplementation.h.

References ports, and sanitizeInOut().

◆ ModulePortInfo() [2/2]

circt::hw::ModulePortInfo::ModulePortInfo ( ArrayRef< PortInfo > mergedPorts )

inlineexplicit

Definition at line 65 of file PortImplementation.h.

References sanitizeInOut().

Member Function Documentation

◆ at() [1/2]

PortInfo & circt::hw::ModulePortInfo::at ( size_t idx )

inline

Definition at line 156 of file PortImplementation.h.

References ports.

Referenced by circt::hw::HWModulePortAccessor::HWModulePortAccessor().

◆ at() [2/2]

const PortInfo & circt::hw::ModulePortInfo::at ( size_t idx ) const

inline

Definition at line 160 of file PortImplementation.h.

References ports.

◆ atInput() [1/2]

PortInfo & circt::hw::ModulePortInfo::atInput ( size_t idx )

inline

Definition at line 157 of file PortImplementation.h.

References portNumForInput(), and ports.

Referenced by circt::msft::getValueName().

◆ atInput() [2/2]

const PortInfo & circt::hw::ModulePortInfo::atInput ( size_t idx ) const

inline

Definition at line 161 of file PortImplementation.h.

References portNumForInput(), and ports.

◆ atOutput() [1/2]

PortInfo & circt::hw::ModulePortInfo::atOutput ( size_t idx )

inline

Definition at line 158 of file PortImplementation.h.

References portNumForOutput(), and ports.

◆ atOutput() [2/2]

const PortInfo & circt::hw::ModulePortInfo::atOutput ( size_t idx ) const

inline

Definition at line 164 of file PortImplementation.h.

References portNumForOutput(), and ports.

◆ begin() [1/2]

iterator circt::hw::ModulePortInfo::begin ( )

inline

Definition at line 73 of file PortImplementation.h.

References ports.

◆ begin() [2/2]

const_iterator circt::hw::ModulePortInfo::begin ( ) const

inline

Definition at line 75 of file PortImplementation.h.

References ports.

◆ end() [1/2]

iterator circt::hw::ModulePortInfo::end ( )

inline

Definition at line 74 of file PortImplementation.h.

References ports.

◆ end() [2/2]

const_iterator circt::hw::ModulePortInfo::end ( ) const

inline

Definition at line 76 of file PortImplementation.h.

References ports.

◆ eraseInput()

void circt::hw::ModulePortInfo::eraseInput ( size_t idx )

inline

Definition at line 168 of file PortImplementation.h.

References assert(), portNumForInput(), ports, and sizeInputs().

Referenced by convertExtMemoryOps().

◆ getInputs() [1/2]

PortDirectionRange circt::hw::ModulePortInfo::getInputs ( )

inline

Definition at line 114 of file PortImplementation.h.

References getPortsOfDirection().

Referenced by llvm::DOTGraphTraits< circt::hw::HWModuleOp >::addCustomGraphFeatures(), convertExtMemoryOps(), circt::hw::ModulePortLookupInfo::ModulePortLookupInfo(), and sizeInputs().

◆ getInputs() [2/2]

ConstPortDirectionRange circt::hw::ModulePortInfo::getInputs ( ) const

inline

Definition at line 118 of file PortImplementation.h.

References getPortsOfDirection().

◆ getOutputs() [1/2]

PortDirectionRange circt::hw::ModulePortInfo::getOutputs ( )

inline

Definition at line 116 of file PortImplementation.h.

References getPortsOfDirection().

Referenced by convertExtMemoryOps(), circt::hw::HWModulePortAccessor::HWModulePortAccessor(), circt::hw::ModulePortLookupInfo::ModulePortLookupInfo(), sizeOutputs(), and circt::hw::PortConverterImpl::updateInstance().

◆ getOutputs() [2/2]

ConstPortDirectionRange circt::hw::ModulePortInfo::getOutputs ( ) const

inline

Definition at line 122 of file PortImplementation.h.

References getPortsOfDirection().

◆ getPortsOfDirection() [1/2]

PortDirectionRange circt::hw::ModulePortInfo::getPortsOfDirection ( bool input )

inline

Definition at line 84 of file PortImplementation.h.

References circt::hw::ModulePort::InOut, circt::hw::ModulePort::Input, circt::hw::ModulePort::Output, and ports.

Referenced by getInputs(), getInputs(), getOutputs(), and getOutputs().

◆ getPortsOfDirection() [2/2]

ConstPortDirectionRange circt::hw::ModulePortInfo::getPortsOfDirection ( bool input ) const

inline

Definition at line 99 of file PortImplementation.h.

References circt::hw::ModulePort::InOut, circt::hw::ModulePort::Input, circt::hw::ModulePort::Output, and ports.

◆ portNumForInput()

size_t circt::hw::ModulePortInfo::portNumForInput ( size_t idx ) const

inline

Definition at line 136 of file PortImplementation.h.

References ports.

Referenced by atInput(), atInput(), and eraseInput().

◆ portNumForOutput()

size_t circt::hw::ModulePortInfo::portNumForOutput ( size_t idx ) const

inline

Definition at line 146 of file PortImplementation.h.

References ports.

Referenced by atOutput(), and atOutput().

◆ sanitizeInOut()

void circt::hw::ModulePortInfo::sanitizeInOut ( )

inlineprivate

Definition at line 175 of file PortImplementation.h.

References circt::hw::ModulePort::InOut, and ports.

Referenced by ModulePortInfo(), and ModulePortInfo().

◆ size()

size_t circt::hw::ModulePortInfo::size ( ) const

inline

Definition at line 126 of file PortImplementation.h.

References ports.

Referenced by esiaccel.types.ArrayType::bit_width(), esiaccel.types.ArrayType::deserialize(), and esiaccel.types.ArrayType::is_valid().

◆ sizeInputs()

size_t circt::hw::ModulePortInfo::sizeInputs ( ) const

inline

Definition at line 127 of file PortImplementation.h.

References getInputs().

Referenced by eraseInput(), circt::hw::HWModulePortAccessor::HWModulePortAccessor(), circt::hw::PortConverterImpl::run(), and circt::hw::PortConverterImpl::updateInstance().

◆ sizeOutputs()

size_t circt::hw::ModulePortInfo::sizeOutputs ( ) const

inline

Definition at line 131 of file PortImplementation.h.

References getOutputs().

Referenced by circt::hw::HWModulePortAccessor::HWModulePortAccessor(), and circt::hw::PortConverterImpl::run().

Member Data Documentation

◆ ports

SmallVector<PortInfo> circt::hw::ModulePortInfo::ports

private

This contains a list of all ports. Input first.

Definition at line 184 of file PortImplementation.h.

Referenced by at(), at(), atInput(), atInput(), atOutput(), atOutput(), begin(), begin(), end(), end(), eraseInput(), getPortsOfDirection(), getPortsOfDirection(), ModulePortInfo(), portNumForInput(), portNumForOutput(), sanitizeInOut(), and size().

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

/home/runner/work/circt-www/circt-www/circt_src/include/circt/Dialect/HW/PortImplementation.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ ConstPortDirectionRange

◆ iterator

◆ PortDirectionRange

Constructor & Destructor Documentation

◆ ModulePortInfo() [1/2]

◆ ModulePortInfo() [2/2]

Member Function Documentation

◆ at() [1/2]

◆ at() [2/2]

◆ atInput() [1/2]

◆ atInput() [2/2]

◆ atOutput() [1/2]

◆ atOutput() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ eraseInput()

◆ getInputs() [1/2]

◆ getInputs() [2/2]

◆ getOutputs() [1/2]

◆ getOutputs() [2/2]

◆ getPortsOfDirection() [1/2]

◆ getPortsOfDirection() [2/2]

◆ portNumForInput()

◆ portNumForOutput()

◆ sanitizeInOut()

◆ size()

◆ sizeInputs()

◆ sizeOutputs()

Member Data Documentation

◆ ports