torc::architecture::WireUsage Class Reference

Encapsulation the design wire usage. More...

#include <WireUsage.hpp>

Collaboration diagram for torc::architecture::WireUsage:

Public Member Functions
	WireUsage (const Tiles &inTiles)
	Public constructor. More...
	~WireUsage (void)
	Non-virtual destructor. More...
void	autosize (void)
	Size the wire usage according to the number of device tiles. More...
void	use (const Tilewire &inTilewire)
	Marks the specified tilewire as being used. More...
void	release (const Tilewire &inTilewire)
	Marks the specified tilewire as being unused. More...
void	clear (void)
	Marks all wires as being unused, without releasing the bitset objects. More...
bool	isUsed (const Tilewire &inTilewire)
	Determines whether the specified tilewire is in use. More...
uint32_t	getWireUsageCount (void) const
	Returns the number of wires in use. More...
TileCount	getTileUsageCount (void) const
	Returns the number of tiles that have been touched. More...
uint32_t	getBitCount (void) const
	Returns the number of bits allocated. More...

Protected Types
typedef boost::dynamic_bitset	dynamic_bitset
	Imported type name. More...
typedef xilinx::TileIndex	TileIndex
	Imported type name. More...
typedef xilinx::TileCount	TileCount
	Imported type name. More...
typedef xilinx::TileTypeIndex	TileTypeIndex
	Imported type name. More...
typedef xilinx::WireIndex	WireIndex
	Imported type name. More...

Protected Attributes
const Tiles &	mTiles
	Reference to the database Tiles object. More...
TileCount	mTileUsageCount
	The number of tiles for which bitsets are allocated. More...
Array< dynamic_bitset * >	mBitsets
	The wire usage bitset array. More...
uint32_t	mBitCount
	The number of bits allocated by the usage bitsets. More...
dynamic_bitset	mTileDirty
	The mask of tile bitsets that contain changes. More...

Detailed Description

Encapsulation the design wire usage.

This class uses a compact bitset representation to very efficiently track the wire usage of a design in an entire device. Internal bitset objects are maintained on a per-tile basis, and are not allocated until at least one wire in the tile has been marked used.

Definition at line 35 of file WireUsage.hpp.

Member Typedef Documentation

typedef boost::dynamic_bitset torc::architecture::WireUsage::dynamic_bitset

protected

Imported type name.

Definition at line 38 of file WireUsage.hpp.

typedef xilinx::TileCount torc::architecture::WireUsage::TileCount

protected

Imported type name.

Definition at line 40 of file WireUsage.hpp.

typedef xilinx::TileIndex torc::architecture::WireUsage::TileIndex

protected

Imported type name.

Definition at line 39 of file WireUsage.hpp.

typedef xilinx::TileTypeIndex torc::architecture::WireUsage::TileTypeIndex

protected

Imported type name.

Definition at line 41 of file WireUsage.hpp.

typedef xilinx::WireIndex torc::architecture::WireUsage::WireIndex

protected

Imported type name.

Definition at line 42 of file WireUsage.hpp.

Constructor & Destructor Documentation

torc::architecture::WireUsage::WireUsage ( const Tiles &  inTiles )

inline

Public constructor.

Definition at line 57 of file WireUsage.hpp.

                                        : mTiles(inTiles), mTileUsageCount(), mBitsets(0), 
            mBitCount(0), mTileDirty(0) {}

torc::architecture::WireUsage::~WireUsage ( void  )

inline

Non-virtual destructor.

Definition at line 60 of file WireUsage.hpp.

                         {
            size_t tileCount = mBitsets.getSize();
            for(TileIndex i; i < tileCount; i++) {
                if(mBitsets[i] != 0) { delete mBitsets[i]; mBitsets[i] = 0; }
            }
        }

Here is the call graph for this function:

Member Function Documentation

void torc::architecture::WireUsage::autosize ( void  )

inline

Size the wire usage according to the number of device tiles.

Definition at line 68 of file WireUsage.hpp.

                            {
            // release any existing bitsets
            for(TileCount i; i < mBitsets.getSize(); i++) {
                if(mBitsets[i] != 0) { delete mBitsets[i]; mBitsets[i] = 0; }
                mTileDirty.reset(i);
            }
            // resize for the new dimensions
            TileCount tileCount = mTiles.getTileCount();
            mBitsets.setSize(tileCount);
            for(TileCount i; i < tileCount; i++) mBitsets[i] = 0;
            mTileDirty.resize(tileCount);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::architecture::WireUsage::clear ( void  )

inline

Marks all wires as being unused, without releasing the bitset objects.

This capability allows the tracer to track the wires that it has visited while processing a particular net, and then to start again from scratch without incurring allocation and construction overheads.

Definition at line 121 of file WireUsage.hpp.

                         {
            // iterate over all of the tiles
            size_t tileCount = mBitsets.getSize();
            for(TileIndex i; i < tileCount; i++) {
                // skip this tile if it isn't dirty
                if(!mTileDirty[i]) continue;
                // mark the tile clean
                mTileDirty.reset(i);
                // look up the bitset for this tile
                dynamic_bitset* bitset = mBitsets[i];
                // skip tiles without an associated bitset (should never happen for dirty tiles)
                if(bitset == 0) continue;
                // clear the entire bitset
                bitset->reset();
            }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t torc::architecture::WireUsage::getBitCount ( void  ) const

inline

Returns the number of bits allocated.

Definition at line 171 of file WireUsage.hpp.

{ return mBitCount; }

TileCount torc::architecture::WireUsage::getTileUsageCount ( void  ) const

inline

Returns the number of tiles that have been touched.

Definition at line 169 of file WireUsage.hpp.

{ return mTileUsageCount; }

uint32_t torc::architecture::WireUsage::getWireUsageCount ( void  ) const

inline

Returns the number of wires in use.

Todo:

Question: can we get away with only checking dirty bitsets? / skip this tile if it isn't dirty

Definition at line 151 of file WireUsage.hpp.

                                               {
            uint32_t usageCount = 0;
            size_t tileCount = mBitsets.getSize();
            for(TileIndex i; i < tileCount; i++) {
                /// \todo Question: can we get away with only checking dirty bitsets?
                //// skip this tile if it isn't dirty
                //if(!mTileDirty[i]) continue;
                // look up the bitset for this tile
                dynamic_bitset* bitset = mBitsets[i];
                // skip tiles without an associated bitset
                if(bitset == 0) continue;
                // clear the entire bitset
                usageCount += bitset->count();
            }
            return usageCount;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

bool torc::architecture::WireUsage::isUsed ( const Tilewire &  inTilewire )

inline

Determines whether the specified tilewire is in use.

Definition at line 138 of file WireUsage.hpp.

                                                {
            // extract the tile and wire indexes
            TileIndex tileIndex = inTilewire.getTileIndex();
            WireIndex wireIndex = inTilewire.getWireIndex();

            // if there is no entry for the tile, the tilewire is already implicitly unused.
            dynamic_bitset* bitset = mBitsets[tileIndex];
            if(bitset == 0) return false;

            // otherwise, interrogate the bit
            return bitset->test(wireIndex);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::architecture::WireUsage::release ( const Tilewire &  inTilewire )

inline

Marks the specified tilewire as being unused.

Definition at line 104 of file WireUsage.hpp.

                                                 {
            // extract the tile and wire indexes
            TileIndex tileIndex = inTilewire.getTileIndex();
            WireIndex wireIndex = inTilewire.getWireIndex();

            // if there is no entry for the tile, the tilewire is already implicitly unused.
            dynamic_bitset* bitset = mBitsets[tileIndex];
            if(bitset == 0) return;

            // otherwise clear the bit and mark the tile dirty
            bitset->set(wireIndex, false);
            mTileDirty.set(tileIndex, true);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::architecture::WireUsage::use ( const Tilewire &  inTilewire )

inline

Marks the specified tilewire as being used.

Definition at line 81 of file WireUsage.hpp.

                                             {
            // extract the tile and wire indexes
            TileIndex tileIndex = inTilewire.getTileIndex();
            WireIndex wireIndex = inTilewire.getWireIndex();

            // look up the appropriate bitset, allocating it if necessary
            dynamic_bitset* bitset = mBitsets[tileIndex];
            if(bitset == 0) {
                // determine how many wires are in this tile
                const TileInfo& tileInfo = mTiles.getTileInfo(tileIndex);
                TileTypeIndex tileTypeIndex = tileInfo.getTypeIndex();
                size_t size = mTiles.getWireInfo(tileTypeIndex).getSize();
                bitset = mBitsets[tileIndex] = new dynamic_bitset(size);
                // track the statistics
                mTileUsageCount++;
                mBitCount += size;
            }

            // set the bit and mark the tile dirty
            bitset->set(wireIndex, true);
            mTileDirty.set(tileIndex, true);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

uint32_t torc::architecture::WireUsage::mBitCount

protected

The number of bits allocated by the usage bitsets.

Definition at line 51 of file WireUsage.hpp.

Array<dynamic_bitset*> torc::architecture::WireUsage::mBitsets

protected

The wire usage bitset array.

Definition at line 49 of file WireUsage.hpp.

dynamic_bitset torc::architecture::WireUsage::mTileDirty

protected

The mask of tile bitsets that contain changes.

Definition at line 53 of file WireUsage.hpp.

const Tiles& torc::architecture::WireUsage::mTiles

protected

Reference to the database Tiles object.

Definition at line 45 of file WireUsage.hpp.

TileCount torc::architecture::WireUsage::mTileUsageCount

protected

The number of tiles for which bitsets are allocated.

Definition at line 47 of file WireUsage.hpp.

---

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

• WireUsage.hpp