torc::architecture::DDB Class Reference

Device database, including complete wiring and logic support. More...

#include <DDB.hpp>

Inheritance diagram for torc::architecture::DDB:

Collaboration diagram for torc::architecture::DDB:

Public Types
enum	EExpandDirection { eExpandDirectionNone = 0, eExpandDirectionSinkward = 1, eExpandDirectionSourceward = 2, eExpandDirectionBidirectional = eExpandDirectionSinkward | eExpandDirectionSourceward }
	Enumeration to indicate in which directions segments should be expanded. More...

Public Member Functions
	mWireUsage (mTiles)
	DDB (const string &inDeviceName, const string &inPackageName, DDBConsoleStreams inDDBConsoleStreams=DDBConsoleStreams())
	Public constructor. More...
	DDB (const torc::common::DeviceDesignator &inDeviceDesignator, DDBConsoleStreams inDDBConsoleStreams=DDBConsoleStreams())
	Public constructor. More...
	~DDB (void)
	Destructor. More...
const string &	getDeviceName (void) const
	Returns the device name. More...
const string &	getFamilyName (void) const
	Returns the family name. More...
const boost::filesystem::path &	getDevicePath (void) const
	Returns the device database path. More...
const boost::filesystem::path &	getFamilyPath (void) const
	Returns the family database path. More...
const StringVector &	getSpeedGrades (void) const
	Returns a constant reference to a vector of speed grades. More...
const Segments &	getSegments (void) const
	Returns a constant reference to the device segment data. More...
const Sites &	getSites (void) const
	Returns a constant reference to the family and device site data. More...
const Tiles &	getTiles (void) const
	Returns a constant reference to the family and device tile data. More...
ArcUsage &	getArcUsage (void)
	Returns a constant reference to the design arc usage. More...
WireUsage &	getWireUsage (void)
	Returns a constant reference to the design wire usage. More...
virtual void	setConsoleStreams (DDBConsoleStreams inConsoleStreams)
	Sets all of the database console streams. More...
virtual void	setConsoleStreams (istream &inIn, ostream &inOut, ostream &inErr, ostream &inLog)
	Sets all of the database console streams. More...
void	clearUsage (void)
	Clears all arc and wire usage, effectively restaring with an empty device. More...
void	useArc (const Arc &inArc)
	Marks the arc and all of its source and sink segment wires as used. More...
void	releaseArc (const Arc &inArc, bool releaseSource=true, bool releaseSink=true)
	Marks the arc and all of its source and sink segment wires as unused. More...
void	useSegment (const Tilewire &inTilewire)
	Marks all wires on the segment as used. More...
void	releaseSegment (const Tilewire &inTilewire)
	Marks all wires on the segment as unused. More...
void	expandSegment (const Tilewire &inTilewire, TilewireVector &outTilewires, EExpandDirection inExpandDirection=eExpandDirectionNone)
	Expands the given tilewire's segment. More...
void	expandTilewireSinks (const Tilewire &inTilewire, TilewireVector &outSinks, bool inUseTied=true, bool inUseRegular=true, bool inUseIrregular=true, bool inUseRoutethrough=true)
	Expands the given tilewire's arc sinks. More...
void	expandTilewireSources (const Tilewire &inTilewire, TilewireVector &outSources, bool inUseTied=true, bool inUseRegular=true, bool inUseIrregular=true, bool inUseRoutethrough=true)
	Expands the given tilewire's arc sources. More...
void	expandSegmentSinks (const Tilewire &inTilewire, ArcVector &outSinks, EExpandDirection inExpandDirection=eExpandDirectionNone, bool inUseTied=true, bool inUseRegular=true, bool inUseIrregular=true, bool inUseRoutethrough=true)
	Expands all sink arcs for the given tilewire's segment. More...
void	expandSegmentSources (const Tilewire &inTilewire, ArcVector &outSources, EExpandDirection inExpandDirection=eExpandDirectionNone, bool inUseTied=true, bool inUseRegular=true, bool inUseIrregular=true, bool inUseRoutethrough=true)
	Expands all source arcs for the given tilewire's segment. More...
Tilewire	sitePinToTilewire (const std::string &inSiteName, const std::string &inPinName)
	Returns the tilewire for the specified site and pin name pair. More...
Arc	tilePipToArc (const std::string &inTileName, const std::string &inSourceWireName, const std::string &inSinkWireName)
	Returns the arc for the specified pip tile and wires. More...
Tilewire	lookupTilewire (const std::string &inTileName, const std::string &inWireName)
	Returns the tilewire for the specified tile and wire names. More...

Data Fields
	__pad0__: mArcUsage(mTiles)
	Public constructor. More...

Protected Types
typedef std::string	string
	Imported type name. More...
typedef std::vector< string >	StringVector
	Imported type name. More...
typedef xilinx::SiteIndex	SiteIndex
	Imported type name. More...
typedef xilinx::WireIndex	WireIndex
	Imported type name. More...
typedef xilinx::TileIndex	TileIndex
	Imported type name. More...
typedef xilinx::TileOffset	TileOffset
	Imported type name. More...
typedef xilinx::TileTypeIndex	TileTypeIndex
	Imported type name. More...

Protected Member Functions
size_t	readFamilyName (class DigestStream &inStream)
	Reads the family name from a device DigestStream. More...
size_t	readSpeedGrades (class DigestStream &inStream)
	Reads the supported speed grades from a device DigestStream. More...
void	initialize (const string &inDeviceName, const string &inPackageName)
	Initializes the database. More...

Protected Attributes
string	mDeviceName
	The name of the device. More...
string	mFamilyName
	The name of the family. More...
boost::filesystem::path	mDevicePath
	the device database path. More...
boost::filesystem::path	mFamilyPath
	the family database path. More...
Versions	mDeviceVersion
	The device database version. More...
Versions	mFamilyVersion
	The family database version. More...
StringVector	mSpeedGrades
	The supported speed grades. More...
Segments	mSegments
	The device segment data. More...
Sites	mSites
	The family and device site data. More...
Tiles	mTiles
	The family and device tile data. More...
ArcUsage	mArcUsage
	The design arc usage. More...
WireUsage	mWireUsage
	The design wire usage. More...

Private Types
typedef std::basic_istream< char >	istream
	Internal typedef of istream;. More...
typedef std::basic_ostream< char >	ostream
	Internal typedef of ostream;. More...

Private Member Functions
istream &	mIn (void)
	Returns the database console input stream. More...
ostream &	mOut (void)
	Returns the database console output stream. More...
ostream &	mErr (void)
	Returns the database console error stream. More...
ostream &	mLog (void)
	Returns the database console log stream. More...
istream &	getConsoleIn (void)
	Returns the database console input stream. More...
ostream &	getConsoleOut (void)
	Returns the database console output stream. More...
ostream &	getConsoleErr (void)
	Returns the database console error stream. More...
ostream &	getConsoleLog (void)
	Returns the database console log stream. More...
void	setConsoleIn (istream &inStream)
	Sets the database console input stream. More...
void	setConsoleOut (ostream &inStream)
	Sets the database console output stream. More...
void	setConsoleErr (ostream &inStream)
	Sets the database console error stream. More...
void	setConsoleLog (ostream &inStream)
	Sets the database console log stream. More...

Private Attributes
istream *	mInPtr
	Pointer to the database console input stream. More...
ostream *	mOutPtr
ostream *	mErrPtr
ostream *	mLogPtr

Static Private Attributes
static DDBConsoleStreams	sDefaultConsoleStreams
static DDBConsoleStreams	sNullConsoleStreams

Detailed Description

Device database, including complete wiring and logic support.

Note

The DDBConsoleStreams superclass is a utility class that allows for console stream redirection.

Definition at line 42 of file DDB.hpp.

Member Typedef Documentation

typedef std::basic_istream<char> torc::architecture::DDBConsoleStreams::istream

inherited

Internal typedef of istream;.

Definition at line 41 of file DDBConsoleStreams.hpp.

typedef std::basic_ostream<char> torc::architecture::DDBConsoleStreams::ostream

inherited

Internal typedef of ostream;.

Definition at line 43 of file DDBConsoleStreams.hpp.

typedef xilinx::SiteIndex torc::architecture::DDB::SiteIndex

protected

Imported type name.

Definition at line 47 of file DDB.hpp.

typedef std::string torc::architecture::DDB::string

protected

Imported type name.

Definition at line 45 of file DDB.hpp.

typedef std::vector<string> torc::architecture::DDB::StringVector

protected

Imported type name.

Definition at line 46 of file DDB.hpp.

typedef xilinx::TileIndex torc::architecture::DDB::TileIndex

protected

Imported type name.

Definition at line 49 of file DDB.hpp.

typedef xilinx::TileOffset torc::architecture::DDB::TileOffset

protected

Imported type name.

Definition at line 50 of file DDB.hpp.

typedef xilinx::TileTypeIndex torc::architecture::DDB::TileTypeIndex

protected

Imported type name.

Definition at line 51 of file DDB.hpp.

typedef xilinx::WireIndex torc::architecture::DDB::WireIndex

protected

Imported type name.

Definition at line 48 of file DDB.hpp.

Member Enumeration Documentation

enum torc::architecture::DDB::EExpandDirection

Enumeration to indicate in which directions segments should be expanded.

Segment expansion direction only makes sense when device databases include tied wires (or "fake pips"). When tied wires are present, the caller can request that segment expansions include no tied wires, include tied wires in the sinkward direction, include tied wires in the sourceward direction, or include tied wires in both directions.

Enumerator
eExpandDirectionNone
eExpandDirectionSinkward
eExpandDirectionSourceward
eExpandDirectionBidirectional

Definition at line 92 of file DDB.hpp.

                              { 
            eExpandDirectionNone = 0, eExpandDirectionSinkward = 1, eExpandDirectionSourceward = 2, 
            eExpandDirectionBidirectional = eExpandDirectionSinkward | eExpandDirectionSourceward
        };

Constructor & Destructor Documentation

torc::architecture::DDB::DDB ( const string &  inDeviceName, const string &  inPackageName, DDBConsoleStreams  inDDBConsoleStreams = DDBConsoleStreams()  )

inline

Public constructor.

Parameters

inDeviceName	The name of the device to open. This name should not include any package or speed grade information, nor any extension. Examples are xc2vp100, xc4vfx60, xc5vlx30, et cetera.
inPackageName	The name of the package to use.
inDDBConsoleStreams	The console streams that the database should use.

Definition at line 112 of file DDB.hpp.

            : mArcUsage(mTiles), mWireUsage(mTiles) 
            { setConsoleStreams(inDDBConsoleStreams); initialize(inDeviceName, inPackageName); }

Here is the call graph for this function:

torc::architecture::DDB::DDB ( const torc::common::DeviceDesignator &  inDeviceDesignator, DDBConsoleStreams  inDDBConsoleStreams = DDBConsoleStreams()  )

inline

Public constructor.

Parameters

inDeviceDesignator	A designator for the device to open.
inDDBConsoleStreams	The console streams that the database should use.

Definition at line 119 of file DDB.hpp.

            : mArcUsage(mTiles), mWireUsage(mTiles) {
            setConsoleStreams(inDDBConsoleStreams); 
            initialize(inDeviceDesignator.getDeviceName(), inDeviceDesignator.getDevicePackage());
        }

Here is the call graph for this function:

torc::architecture::DDB::~DDB ( void  )

inline

Destructor.

Definition at line 126 of file DDB.hpp.

                   {
            DDBStreamHelper::dissociate(*this);
        }

Here is the call graph for this function:

Member Function Documentation

void torc::architecture::DDB::clearUsage ( void  )

inline

Clears all arc and wire usage, effectively restaring with an empty device.

Definition at line 168 of file DDB.hpp.

                              {
            mWireUsage.clear();
            mArcUsage.clear();
        }

Here is the call graph for this function:

void torc::architecture::DDB::expandSegment	(	const Tilewire &	inTilewire,
		TilewireVector &	outTilewires,
		EExpandDirection	inExpandDirection = eExpandDirectionNone
	)

Expands the given tilewire's segment.

Given a tilewire belonging to a segment, this function populates the supplied vector with all of the tilewires on the segment. An optional parameter allows the expansion to continue in the sinkward or sourceward directions in cases where tied sources or sinks are available.

Definition at line 154 of file DDB.cpp.

                                            {

        // look up the segment specified by this tile and wire
        WireIndex wireIndex = inTilewire.getWireIndex();
        TileIndex tileIndex = inTilewire.getTileIndex();
        const Segments::SegmentReference& compactSegmentReference 
            = mSegments.getTilewireSegment(inTilewire);
        // undefined segments are not real in the current device
        if(!compactSegmentReference.isDefined()) return;

        // initialize the wire array with the segment information or the trivial wire
        Array<Segments::CompactSegmentTilewire> trivialSegmentReference;
        if(compactSegmentReference.isTrivial()) {
            trivialSegmentReference.setSize(1);
            trivialSegmentReference[0] = Segments::CompactSegmentTilewire(wireIndex, 
                TileOffset(tileIndex));
        }
        const Array<Segments::CompactSegmentTilewire>& segmentReference 
            = compactSegmentReference.isTrivial() ? trivialSegmentReference 
                : mSegments.mCompactSegments[compactSegmentReference.getCompactSegmentIndex()];

        // iterate through each wire in the compact segment
        TileIndex anchorTileIndex = compactSegmentReference.getAnchorTileIndex();
        Array<Segments::CompactSegmentTilewire>::const_iterator csp 
            = segmentReference.begin();
        Array<Segments::CompactSegmentTilewire>::const_iterator cse 
            = segmentReference.end();
        bool sinkward = (inExpandDirection & eExpandDirectionSinkward) != 0;
        bool sourceward = (inExpandDirection & eExpandDirectionSourceward) != 0;
        while(csp < cse) {
            // get information about the current tilewire
            const Segments::CompactSegmentTilewire& compactSegmentTilewire = *csp++;
            WireIndex csWireIndex = compactSegmentTilewire.getWireIndex();
            TileOffset csTileOffset = compactSegmentTilewire.getTileOffset();
            TileIndex csTileIndex = csTileOffset + anchorTileIndex;
            // push each wire into the segment
            outTilewires.push_back(Tilewire(csTileIndex, csWireIndex));
            // look up tile and wire information
            const TileInfo& tileInfo = mTiles.getTileInfo(csTileIndex);
            const WireInfo& wireInfo = mTiles.getWireInfo(tileInfo.getTypeIndex(), csWireIndex);
            // include tied sinks
            if(sinkward) {
                const WireArray& tiedSinks = wireInfo.getTiedSinks();
                WireArray::const_iterator p = tiedSinks.begin();
                WireArray::const_iterator e = tiedSinks.end();
                while(p < e) expandSegment(Tilewire(csTileIndex, *p++), outTilewires, 
                    inExpandDirection);
            }
            // include tied sources
            if(sourceward) {
                const WireArray& tiedSources = wireInfo.getTiedSources();
                WireArray::const_iterator p = tiedSources.begin();
                WireArray::const_iterator e = tiedSources.end();
                while(p < e) expandSegment(Tilewire(csTileIndex, *p++), outTilewires, 
                    inExpandDirection);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::architecture::DDB::expandSegmentSinks	(	const Tilewire &	inTilewire,
		ArcVector &	outSinks,
		EExpandDirection	inExpandDirection = eExpandDirectionNone,
		bool	inUseTied = true,
		bool	inUseRegular = true,
		bool	inUseIrregular = true,
		bool	inUseRoutethrough = true
	)

Expands all sink arcs for the given tilewire's segment.

The optional inUseTied, inUseRegular, inUseIrregular, and inUseRoutethrough flags determine whether the corresponding arc types will be included. Note that tied arcs (or "fake pips") are not currently available in the databases.

Definition at line 314 of file DDB.cpp.

                                                         {
        // expand the segment
        TilewireVector segment;
        expandSegment(inTilewire, segment, inExpandDirection);
        // expand all of the arcs
        TilewireVector::const_iterator sep = segment.begin();
        TilewireVector::const_iterator see = segment.end();
        while(sep < see) {
            // expand the tilewire sinks
            const Tilewire& tilewire = *sep++;
            TilewireVector sinks;
            expandTilewireSinks(tilewire, sinks, inUseTied, inUseRegular, inUseIrregular, 
                inUseRoutethrough);
            // rewrite the sinks as arcs
            TilewireVector::const_iterator sip = sinks.begin();
            TilewireVector::const_iterator sie = sinks.end();
            while(sip < sie) outArcs.push_back(Arc(tilewire, *sip++));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::architecture::DDB::expandSegmentSources	(	const Tilewire &	inTilewire,
		ArcVector &	outSources,
		EExpandDirection	inExpandDirection = eExpandDirectionNone,
		bool	inUseTied = true,
		bool	inUseRegular = true,
		bool	inUseIrregular = true,
		bool	inUseRoutethrough = true
	)

Expands all source arcs for the given tilewire's segment.

The optional inUseTied, inUseRegular, inUseIrregular, and inUseRoutethrough flags determine whether the corresponding arc types will be included. Note that tied arcs (or "fake pips") are not currently available in the databases.

Definition at line 336 of file DDB.cpp.

                                                         {
        // expand the segment
        TilewireVector segment;
        expandSegment(inTilewire, segment, inExpandDirection);
        // expand all of the arcs
        TilewireVector::const_iterator sep = segment.begin();
        TilewireVector::const_iterator see = segment.end();
        while(sep < see) {
            // expand the tilewire sources
            const Tilewire& tilewire = *sep++;
            TilewireVector sources;
            expandTilewireSources(tilewire, sources, inUseTied, inUseRegular, inUseIrregular, 
                inUseRoutethrough);
            // rewrite the sources as arcs
            TilewireVector::const_iterator sop = sources.begin();
            TilewireVector::const_iterator soe = sources.end();
            while(sop < soe) outArcs.push_back(Arc(*sop++, tilewire));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::architecture::DDB::expandTilewireSinks	(	const Tilewire &	inTilewire,
		TilewireVector &	outSinks,
		bool	inUseTied = true,
		bool	inUseRegular = true,
		bool	inUseIrregular = true,
		bool	inUseRoutethrough = true
	)

Expands the given tilewire's arc sinks.

The optional inUseTied, inUseRegular, inUseIrregular, and inUseRoutethrough flags determine whether the corresponding arc types will be included. Note that tied arcs (or "fake pips") are not currently available in the databases.

Definition at line 214 of file DDB.cpp.

                                                                                        {
        // get information about the starting tile and wire
        WireIndex wireIndex = inTilewire.getWireIndex();
        TileIndex tileIndex = inTilewire.getTileIndex();
        const TileInfo& tileInfo = mTiles.getTileInfo(tileIndex);
        const WireInfo& wireInfo = mTiles.getWireInfo(tileInfo.getTypeIndex(), wireIndex);

        // add the regular sinks
        if(inUseRegular) {
            const WireArray& sinks = wireInfo.getSinks();
            WireArray::const_iterator sp = sinks.begin();
            WireArray::const_iterator se = sinks.end();
            while(sp < se) outSinks.push_back(Tilewire(tileIndex, *sp++));
        }

        // add any irregular sinks
        if(inUseIrregular) {
            const WireArray& irregularSinks = wireInfo.getIrregularSinks();
            WireArray::const_iterator isp = irregularSinks.begin();
            WireArray::const_iterator ise = irregularSinks.end();
            while(isp < ise) {
                WireIndex sinkWireIndex = *isp++;
                // arcs to undefined segments are likewise undefined
                const Segments::SegmentReference& segment 
                    = mSegments.getTilewireSegment(Tilewire(tileIndex, sinkWireIndex));
                if(!segment.isDefined()) continue;
                // determine whether this irregular arc exists
                const Segments::IrregularArc* irregularArc = mSegments.getIrregularArc(tileIndex, 
                    wireIndex, sinkWireIndex);
                if(irregularArc != 0 && !segment.isDefined()) {
                    mErr() << "WARNING: Irregular arc " << inTilewire << " >> " 
                        << Tilewire(tileIndex, sinkWireIndex) 
                        << " is defined, but the sink segment is undefined." << std::endl;
                }
                if(irregularArc == 0) continue;
                // the arc exists, so add it to the list
                outSinks.push_back(Tilewire(tileIndex, sinkWireIndex));
            }
        }

        // add the routethrough sinks
        if(inUseRoutethrough) {
            const WireArray& routethroughSinks = wireInfo.getRoutethroughSinks();
            WireArray::const_iterator rsp = routethroughSinks.begin();
            WireArray::const_iterator rse = routethroughSinks.end();
            while(rsp < rse) outSinks.push_back(Tilewire(tileIndex, *rsp++));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::architecture::DDB::expandTilewireSources	(	const Tilewire &	inTilewire,
		TilewireVector &	outSources,
		bool	inUseTied = true,
		bool	inUseRegular = true,
		bool	inUseIrregular = true,
		bool	inUseRoutethrough = true
	)

Expands the given tilewire's arc sources.

The optional inUseTied, inUseRegular, inUseIrregular, and inUseRoutethrough flags determine whether the corresponding arc types will be included. Note that tied arcs (or "fake pips") are not currently available in the databases.

Definition at line 264 of file DDB.cpp.

                                                                                        {
        // get information about the starting tile and wire
        WireIndex wireIndex = inTilewire.getWireIndex();
        TileIndex tileIndex = inTilewire.getTileIndex();
        const TileInfo& tileInfo = mTiles.getTileInfo(tileIndex);
        const WireInfo& wireInfo = mTiles.getWireInfo(tileInfo.getTypeIndex(), wireIndex);

        // add the regular sources
        if(inUseRegular) {
            const WireArray& sources = wireInfo.getSources();
            WireArray::const_iterator sp = sources.begin();
            WireArray::const_iterator se = sources.end();
            while(sp < se) outSources.push_back(Tilewire(tileIndex, *sp++));
        }

        // add any irregular sources
        if(inUseIrregular) {
            const WireArray& irregularSources = wireInfo.getIrregularSources();
            WireArray::const_iterator isp = irregularSources.begin();
            WireArray::const_iterator ise = irregularSources.end();
            while(isp < ise) {
                WireIndex sourceWireIndex = *isp++;
                // arcs to undefined segments are likewise undefined
                const Segments::SegmentReference& segment 
                    = mSegments.getTilewireSegment(Tilewire(tileIndex, sourceWireIndex));
                if(!segment.isDefined()) continue;
                // determine whether this irregular arc exists
                const Segments::IrregularArc* irregularArc = mSegments.getIrregularArc(tileIndex, 
                    sourceWireIndex, wireIndex);
                if(irregularArc != 0 && !segment.isDefined()) {
                    mErr() << "WARNING: Irregular arc " << inTilewire << " >> " 
                        << Tilewire(tileIndex, sourceWireIndex) 
                        << " is defined, but the source segment is undefined." << std::endl;
                }
                if(irregularArc == 0) continue;
                // the arc exists, so add it to the list
                outSources.push_back(Tilewire(tileIndex, sourceWireIndex));
            }
        }

        // add the routethrough sinks
        if(inUseRoutethrough) {
            const WireArray& routethroughSources = wireInfo.getRoutethroughSources();
            WireArray::const_iterator rsp = routethroughSources.begin();
            WireArray::const_iterator rse = routethroughSources.end();
            while(rsp < rse) outSources.push_back(Tilewire(tileIndex, *rsp++));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ArcUsage& torc::architecture::DDB::getArcUsage ( void  )

inline

Returns a constant reference to the design arc usage.

Definition at line 148 of file DDB.hpp.

{ return mArcUsage; }

Here is the caller graph for this function:

ostream& torc::architecture::DDBConsoleStreams::getConsoleErr ( void  )

inlineinherited

Returns the database console error stream.

Definition at line 69 of file DDBConsoleStreams.hpp.

{ return mErr(); }

Here is the call graph for this function:

istream& torc::architecture::DDBConsoleStreams::getConsoleIn ( void  )

inlineinherited

Returns the database console input stream.

Definition at line 65 of file DDBConsoleStreams.hpp.

{ return mIn(); }

Here is the call graph for this function:

ostream& torc::architecture::DDBConsoleStreams::getConsoleLog ( void  )

inlineinherited

Returns the database console log stream.

Definition at line 71 of file DDBConsoleStreams.hpp.

{ return mLog(); }

Here is the call graph for this function:

ostream& torc::architecture::DDBConsoleStreams::getConsoleOut ( void  )

inlineinherited

Returns the database console output stream.

Definition at line 67 of file DDBConsoleStreams.hpp.

{ return mOut(); }

Here is the call graph for this function:

const string& torc::architecture::DDB::getDeviceName ( void  ) const

inline

Returns the device name.

Definition at line 132 of file DDB.hpp.

{ return mDeviceName; }

Here is the caller graph for this function:

const boost::filesystem::path& torc::architecture::DDB::getDevicePath ( void  ) const

inline

Returns the device database path.

Definition at line 136 of file DDB.hpp.

{ return mDevicePath; }

const string& torc::architecture::DDB::getFamilyName ( void  ) const

inline

Returns the family name.

Definition at line 134 of file DDB.hpp.

{ return mFamilyName; }

Here is the caller graph for this function:

const boost::filesystem::path& torc::architecture::DDB::getFamilyPath ( void  ) const

inline

Returns the family database path.

Definition at line 138 of file DDB.hpp.

{ return mFamilyPath; }

const Segments& torc::architecture::DDB::getSegments ( void  ) const

inline

Returns a constant reference to the device segment data.

Definition at line 142 of file DDB.hpp.

{ return mSegments; }

const Sites& torc::architecture::DDB::getSites ( void  ) const

inline

Returns a constant reference to the family and device site data.

Definition at line 144 of file DDB.hpp.

{ return mSites; }

Here is the caller graph for this function:

const StringVector& torc::architecture::DDB::getSpeedGrades ( void  ) const

inline

Returns a constant reference to a vector of speed grades.

Definition at line 140 of file DDB.hpp.

{ return mSpeedGrades; }

Here is the caller graph for this function:

const Tiles& torc::architecture::DDB::getTiles ( void  ) const

inline

Returns a constant reference to the family and device tile data.

Definition at line 146 of file DDB.hpp.

{ return mTiles; }

Here is the caller graph for this function:

WireUsage& torc::architecture::DDB::getWireUsage ( void  )

inline

Returns a constant reference to the design wire usage.

Definition at line 150 of file DDB.hpp.

{ return mWireUsage; }

void torc::architecture::DDB::initialize ( const string &  inDeviceName, const string &  inPackageName  )

protected

Initializes the database.

Definition at line 31 of file DDB.cpp.

                                                                                {

        // pull in symbols from other namespaces
        using std::string;
//      using std::cout;
//      using std::cerr;
//      using std::clog;
        using std::endl;
        using std::fstream;
        using boost::uint32_t;

        try {

            // track statistics
            uint32_t familyDatabaseBytesRead = 0;
            uint32_t deviceDatabaseBytesRead = 0;

            // open the device database
            mDeviceName = inDeviceName;
            string deviceFilename = inDeviceName + ".db";
            boost::to_lower(deviceFilename);
            mDevicePath = torc::common::DirectoryTree::getDevicesPath() / deviceFilename;
            mLog() << "Reading device " << inDeviceName << " (" << mDevicePath << ")..." << endl;
            DigestStream deviceDatabaseStream(mDevicePath);
            deviceDatabaseStream.exceptions(fstream::eofbit | fstream::failbit | fstream::badbit);
            deviceDatabaseBytesRead += mDeviceVersion.readVersions(deviceDatabaseStream, true);
            deviceDatabaseBytesRead += readFamilyName(deviceDatabaseStream);

            // open the family database
            mFamilyPath = mDevicePath.parent_path() / (mFamilyName + ".db");
            mOut() << "\tReading family " << mFamilyName << " (" << mFamilyPath << ")..." << endl;
            DigestStream familyDatabaseStream(mFamilyPath);
            familyDatabaseStream.exceptions(fstream::eofbit | fstream::failbit | fstream::badbit);

            // populate the database from family and device data
            familyDatabaseBytesRead += mFamilyVersion.readVersions(familyDatabaseStream, false);
            familyDatabaseBytesRead += mTiles.readTileTypes(familyDatabaseStream);
            familyDatabaseBytesRead += mTiles.readTileWireInfo(familyDatabaseStream);
            deviceDatabaseBytesRead += readSpeedGrades(deviceDatabaseStream);
            deviceDatabaseBytesRead += mSites.readPackages(deviceDatabaseStream);
            deviceDatabaseBytesRead += mTiles.readTileMap(deviceDatabaseStream);
            deviceDatabaseBytesRead += mSegments.readTilewireSegments(deviceDatabaseStream);
            bool extendedAnchorTileCount 
                = mDeviceVersion.getFormat() == torc::common::DottedVersion(1, 0, 1);
            deviceDatabaseBytesRead 
                += mSegments.readSegments(deviceDatabaseStream, extendedAnchorTileCount);
            deviceDatabaseBytesRead += mSegments.readIrregularArcs(deviceDatabaseStream);
            familyDatabaseBytesRead += mSites.readPrimitiveTypes(familyDatabaseStream);
            familyDatabaseBytesRead += mSites.readPrimitivePinMaps(familyDatabaseStream);
            deviceDatabaseBytesRead += mSites.readSites(deviceDatabaseStream);
            mOut() << "Read " << familyDatabaseBytesRead << " bytes from " << mFamilyName << endl;
            mOut() << "Read " << deviceDatabaseBytesRead << " bytes from " << mDeviceName << endl;
            // automatically size the wire and arc usage objects
            mWireUsage.autosize();
            mArcUsage.autosize();

            // activate the specified package if any
            if(inPackageName.length()) mSites.activatePackage(inPackageName);
        }

        catch(fstream::failure f) {
            mErr() << "An unprocessed ifstream::failure exception was thrown: " << f.what() << endl;
            throw;
        }

    }

Here is the call graph for this function:

Here is the caller graph for this function:

Tilewire torc::architecture::DDB::lookupTilewire ( const std::string &  inTileName, const std::string &  inWireName  )

inline

Returns the tilewire for the specified tile and wire names.

Todo:

Add to unit tests.

Definition at line 257 of file DDB.hpp.

                                                                                          {
            TileIndex tileIndex = mTiles.findTileIndex(inTileName);
            if(tileIndex.isUndefined()) return Tilewire::sInvalid;
            const TileInfo& tileInfo = mTiles.getTileInfo(tileIndex);
            TileTypeIndex tileTypeIndex = tileInfo.getTypeIndex();
            WireIndex wireIndex = mTiles.findWireIndex(tileTypeIndex, inWireName);
            if(wireIndex.isUndefined()) return Tilewire::sInvalid;
            return Tilewire(tileIndex, wireIndex);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ostream& torc::architecture::DDBConsoleStreams::mErr ( void  )

inlineinherited

Returns the database console error stream.

Definition at line 61 of file DDBConsoleStreams.hpp.

{ return *mErrPtr; }

Here is the caller graph for this function:

istream& torc::architecture::DDBConsoleStreams::mIn ( void  )

inlineinherited

Returns the database console input stream.

Definition at line 57 of file DDBConsoleStreams.hpp.

{ return *mInPtr; }

Here is the caller graph for this function:

ostream& torc::architecture::DDBConsoleStreams::mLog ( void  )

inlineinherited

Returns the database console log stream.

Definition at line 63 of file DDBConsoleStreams.hpp.

{ return *mLogPtr; }

Here is the caller graph for this function:

ostream& torc::architecture::DDBConsoleStreams::mOut ( void  )

inlineinherited

Returns the database console output stream.

Definition at line 59 of file DDBConsoleStreams.hpp.

{ return *mOutPtr; }

Here is the caller graph for this function:

torc::architecture::DDB::mWireUsage ( mTiles  )

inline

Definition at line 104 of file DDB.hpp.

            : mArcUsage(mTiles), mWireUsage(mTiles) 
            { setConsoleStreams(inDDBConsoleStreams); initialize(inDeviceName, string()); }

Here is the call graph for this function:

size_t torc::architecture::DDB::readFamilyName ( class DigestStream &  inStream )

protected

Reads the family name from a device DigestStream.

Todo:

Throw a proper exception.

Definition at line 98 of file DDB.cpp.

                                                     {
        // prepare to read from the stream
        size_t bytesReadOffset = inStream.getBytesRead();
        char scratch[1 << 10];          // scratch read buffer
        boost::uint16_t nameLength = 0; // length of family name

        // read the section header
        string sectionName;
        inStream.readSectionHeader(sectionName);
        /// \todo Throw a proper exception.
        if(sectionName != ">>>> Family >>>>") throw -1;

        // read the family name
        inStream.read(nameLength);
        if(nameLength > sizeof(scratch)) throw -1;
        inStream.read(scratch, nameLength);
        scratch[nameLength] = 0;
        mFamilyName = scratch;

        // return the number of bytes read
        return inStream.getBytesRead() - bytesReadOffset;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

size_t torc::architecture::DDB::readSpeedGrades ( class DigestStream &  inStream )

protected

Reads the supported speed grades from a device DigestStream.

Todo:

Throw a proper exception.

Definition at line 121 of file DDB.cpp.

                                                      {
        // prepare to read from the stream
        size_t bytesReadOffset = inStream.getBytesRead();
        char scratch[1 << 10];          // scratch read buffer
        uint16_t nameLength = 0;    // length of family name

        // read the section header
        string sectionName;
        inStream.readSectionHeader(sectionName);
        /// \todo Throw a proper exception.
        if(sectionName != ">>>> Speeds >>>>") throw -1;

        // read the speed grade count
        uint16_t speedGradeCount;
        inStream.read(speedGradeCount);
        mOut() << "\tReading " << speedGradeCount << " speed grade" 
            << (speedGradeCount != 1 ? "s" : "") << " (";
        // loop through each speed grade
        for(uint16_t i = 0; i < speedGradeCount; i++) {
            // read the speed grade
            inStream.read(nameLength);
            if(nameLength > sizeof(scratch)) throw -1;
            inStream.read(scratch, nameLength);
            scratch[nameLength] = 0;
            mSpeedGrades.push_back(scratch);
            mOut() << scratch << (i + 1 < speedGradeCount ? ", " : "");
        }
        mOut() << ") ... " << std::endl;

        // return the number of bytes read
        return inStream.getBytesRead() - bytesReadOffset;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::architecture::DDB::releaseArc ( const Arc &  inArc, bool  releaseSource = true, bool  releaseSink = true  )

inline

Marks the arc and all of its source and sink segment wires as unused.

Definition at line 179 of file DDB.hpp.

                                                                                              {
            mArcUsage.release(inArc);
            if(releaseSource) releaseSegment(inArc.getSourceTilewire());
            if(releaseSink) releaseSegment(inArc.getSinkTilewire());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::architecture::DDB::releaseSegment ( const Tilewire &  inTilewire )

inline

Marks all wires on the segment as unused.

Definition at line 193 of file DDB.hpp.

                                                        {
            TilewireVector segment;
            expandSegment(inTilewire, segment);
            TilewireVector::const_iterator p = segment.begin();
            TilewireVector::const_iterator e = segment.end();
            while(p < e) mWireUsage.release(*p++);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::architecture::DDBConsoleStreams::setConsoleErr ( ostream &  inStream )

inlineinherited

Sets the database console error stream.

Definition at line 77 of file DDBConsoleStreams.hpp.

{ mErrPtr = &inStream; }

Here is the caller graph for this function:

void torc::architecture::DDBConsoleStreams::setConsoleIn ( istream &  inStream )

inlineinherited

Sets the database console input stream.

Definition at line 73 of file DDBConsoleStreams.hpp.

{ mInPtr = &inStream; }

Here is the caller graph for this function:

void torc::architecture::DDBConsoleStreams::setConsoleLog ( ostream &  inStream )

inlineinherited

Sets the database console log stream.

Definition at line 79 of file DDBConsoleStreams.hpp.

{ mLogPtr = &inStream; }

Here is the caller graph for this function:

void torc::architecture::DDBConsoleStreams::setConsoleOut ( ostream &  inStream )

inlineinherited

Sets the database console output stream.

Definition at line 75 of file DDBConsoleStreams.hpp.

{ mOutPtr = &inStream; }

Here is the caller graph for this function:

virtual void torc::architecture::DDB::setConsoleStreams ( DDBConsoleStreams  inConsoleStreams )

inlinevirtual

Sets all of the database console streams.

Definition at line 152 of file DDB.hpp.

                                                                           {
            setConsoleStreams(inConsoleStreams.mIn(), inConsoleStreams.mOut(), 
                inConsoleStreams.mErr(), inConsoleStreams.mLog());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void torc::architecture::DDB::setConsoleStreams ( istream &  inIn, ostream &  inOut, ostream &  inErr, ostream &  inLog  )

inlinevirtual

Sets all of the database console streams.

Reimplemented from torc::architecture::DDBConsoleStreams.

Definition at line 157 of file DDB.hpp.

                            { 
            DDBConsoleStreams::setConsoleStreams(inIn, inOut, inErr, inLog);
            mSegments.setConsoleStreams(inIn, inOut, inErr, inLog);
            mSites.setConsoleStreams(inIn, inOut, inErr, inLog);
            mTiles.setConsoleStreams(inIn, inOut, inErr, inLog);
            mDeviceVersion.setConsoleStreams(inIn, inOut, inErr, inLog);
            mFamilyVersion.setConsoleStreams(inIn, inOut, inErr, inLog);
        }

Here is the call graph for this function:

Tilewire torc::architecture::DDB::sitePinToTilewire ( const std::string &  inSiteName, const std::string &  inPinName  )

inline

Returns the tilewire for the specified site and pin name pair.

Definition at line 236 of file DDB.hpp.

                                        {
            SiteIndex siteIndex = mSites.findSiteIndex(inSiteName);
            if(siteIndex.isUndefined()) return Tilewire::sInvalid;
            return mSites.getSite(siteIndex).getPinTilewire(inPinName);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Arc torc::architecture::DDB::tilePipToArc ( const std::string &  inTileName, const std::string &  inSourceWireName, const std::string &  inSinkWireName  )

inline

Returns the arc for the specified pip tile and wires.

Definition at line 243 of file DDB.hpp.

                                             {
            TileIndex tileIndex = mTiles.findTileIndex(inTileName);
            if(tileIndex.isUndefined()) return Arc();
            const TileInfo& tileInfo = mTiles.getTileInfo(tileIndex);
            TileTypeIndex tileTypeIndex = tileInfo.getTypeIndex();
            WireIndex sourceWireIndex = mTiles.findWireIndex(tileTypeIndex, inSourceWireName);
            if(sourceWireIndex.isUndefined()) return Arc();
            WireIndex sinkWireIndex = mTiles.findWireIndex(tileTypeIndex, inSinkWireName);
            if(sinkWireIndex.isUndefined()) return Arc();
            return Arc(Tilewire(tileIndex, sourceWireIndex), Tilewire(tileIndex, sinkWireIndex));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::architecture::DDB::useArc ( const Arc &  inArc )

inline

Marks the arc and all of its source and sink segment wires as used.

Definition at line 173 of file DDB.hpp.

                                      {
            mArcUsage.use(inArc);
            useSegment(inArc.getSourceTilewire());
            useSegment(inArc.getSinkTilewire());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::architecture::DDB::useSegment ( const Tilewire &  inTilewire )

inline

Marks all wires on the segment as used.

Definition at line 185 of file DDB.hpp.

                                                    {
            TilewireVector segment;
            expandSegment(inTilewire, segment);
            TilewireVector::const_iterator p = segment.begin();
            TilewireVector::const_iterator e = segment.end();
            while(p < e) mWireUsage.use(*p++);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

torc::architecture::DDB::__pad0__

Public constructor.

Parameters

inDeviceName	The name of the device to open. This name should not include any package or speed grade information, nor any extension. Examples are xc2vp100, xc4vfx60, xc5vlx30, et cetera.
inDDBConsoleStreams	The console streams that the database should use.

Definition at line 104 of file DDB.hpp.

ArcUsage torc::architecture::DDB::mArcUsage

protected

The design arc usage.

Definition at line 74 of file DDB.hpp.

string torc::architecture::DDB::mDeviceName

protected

The name of the device.

Definition at line 54 of file DDB.hpp.

boost::filesystem::path torc::architecture::DDB::mDevicePath

protected

the device database path.

Definition at line 58 of file DDB.hpp.

Versions torc::architecture::DDB::mDeviceVersion

protected

The device database version.

Definition at line 62 of file DDB.hpp.

ostream* torc::architecture::DDBConsoleStreams::mErrPtr

protectedinherited

Definition at line 96 of file DDBConsoleStreams.hpp.

string torc::architecture::DDB::mFamilyName

protected

The name of the family.

Definition at line 56 of file DDB.hpp.

boost::filesystem::path torc::architecture::DDB::mFamilyPath

protected

the family database path.

Definition at line 60 of file DDB.hpp.

Versions torc::architecture::DDB::mFamilyVersion

protected

The family database version.

Definition at line 64 of file DDB.hpp.

istream* torc::architecture::DDBConsoleStreams::mInPtr

protectedinherited

Pointer to the database console input stream.

Definition at line 94 of file DDBConsoleStreams.hpp.

ostream* torc::architecture::DDBConsoleStreams::mLogPtr

protectedinherited

Definition at line 97 of file DDBConsoleStreams.hpp.

ostream* torc::architecture::DDBConsoleStreams::mOutPtr

protectedinherited

Definition at line 95 of file DDBConsoleStreams.hpp.

Segments torc::architecture::DDB::mSegments

protected

The device segment data.

Definition at line 68 of file DDB.hpp.

Sites torc::architecture::DDB::mSites

protected

The family and device site data.

Definition at line 70 of file DDB.hpp.

StringVector torc::architecture::DDB::mSpeedGrades

protected

The supported speed grades.

Definition at line 66 of file DDB.hpp.

Tiles torc::architecture::DDB::mTiles

protected

The family and device tile data.

Definition at line 72 of file DDB.hpp.

WireUsage torc::architecture::DDB::mWireUsage

protected

The design wire usage.

Definition at line 76 of file DDB.hpp.

DDBConsoleStreams torc::architecture::DDBConsoleStreams::sDefaultConsoleStreams

staticinherited

Definition at line 45 of file DDBConsoleStreams.hpp.

DDBConsoleStreams torc::architecture::DDBConsoleStreams::sNullConsoleStreams

staticinherited

Definition at line 46 of file DDBConsoleStreams.hpp.

---

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

• DDB.hpp
• DDB.cpp