torc::physical::XdlExporter Class Reference

Physical design exporter for XDL. More...

#include <XdlExporter.hpp>

Collaboration diagram for torc::physical::XdlExporter:

Public Member Functions
	XdlExporter (std::ostream &inStream, const std::string &inIndentString="\t")
	Public constructor. More...
void	operator() (const DesignSharedPtr &inDesignPtr)
	Top level design exporter operator. More...
void	write (const Circuit &circuit)
	Writes the given Circuit. More...
void	write (const Design &design)
	Writes the given Design. More...
void	write (const Module &module)
	Writes the given Module. More...
void	write (const Port &port)
	Writes the given Port. More...
void	write (const Instance &instance)
	Writes the given Instance. More...
void	write (const Net &net)
	Writes the given Net. More...
void	write (const InstancePin &instancePin, EPinDirection pinDirection, bool comma)
	Writes the given InstancePin, with an optional trailing comma. More...
void	write (const Pip &pip, bool comma)
	Writes the given pip, with an options trailing comma. More...
void	write (const Routethrough &routethrough)
	Writes the given Routethrough. More...
void	write (const ConfigMap &configMap)
	Writes the given ConfigMap. More...

Private Member Functions
void	indent (void) const
	Indent the current line. More...

Private Attributes
std::ostream &	mStream
	The output stream. More...
int	mIndentCount
	The indent count. More...
std::string	mIndentString
	The indent string. More...

Detailed Description

Physical design exporter for XDL.

Definition at line 31 of file XdlExporter.hpp.

Constructor & Destructor Documentation

torc::physical::XdlExporter::XdlExporter ( std::ostream &  inStream, const std::string &  inIndentString = "\t"  )

inline

Public constructor.

Parameters

inStream	The output stream.
inIndentString	The indent string. The default parameter uses a single tab.

Definition at line 48 of file XdlExporter.hpp.

            : mStream(inStream), mIndentCount(0), mIndentString(inIndentString) {}

Member Function Documentation

void torc::physical::XdlExporter::indent ( void  ) const

inlineprivate

Indent the current line.

Definition at line 41 of file XdlExporter.hpp.

            { int count = mIndentCount; while(count--) mStream << mIndentString; }

Here is the caller graph for this function:

void torc::physical::XdlExporter::operator()

(

const DesignSharedPtr &

inDesignPtr

)

Top level design exporter operator.

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 25 of file XdlExporter.cpp.

                                                                    {
        //  std::cout << "Design " << inDesignPtr->getName() << std::endl;
        //  std::cout << "    module count: " << inDesignPtr->getModuleCount() << std::endl;
        //  std::cout << "    instance count: " << inDesignPtr->getInstanceCount() << std::endl;
        //  std::cout << "    net count: " << inDesignPtr->getNetCount() << std::endl;

        /// \todo Acquire mutex.

        // export the design statement
        DesignSharedPtr designPtr(inDesignPtr);
        const Design& design = *designPtr;
        write(design);

        /// \todo Release mutex.
    }

Here is the call graph for this function:

void torc::physical::XdlExporter::write

(

const Circuit &

circuit

)

Writes the given Circuit.

Definition at line 41 of file XdlExporter.cpp.

                                                  {
        // export the instances
        Circuit::InstanceSharedPtrConstIterator pi = circuit.instancesBegin();
        Circuit::InstanceSharedPtrConstIterator ei = circuit.instancesEnd();
        while(pi < ei) write(**pi++);

        // export the nets
        Circuit::NetSharedPtrConstIterator pn = circuit.netsBegin();
        Circuit::NetSharedPtrConstIterator en = circuit.netsEnd();
        while(pn < en) write(**pn++);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::physical::XdlExporter::write

(

const Design &

design

)

Writes the given Design.

Definition at line 53 of file XdlExporter.cpp.

                                                {
        indent();
        mStream << "design \"" << design.getName() << "\" " << design.getDevice() 
            << design.getPackage() << design.getSpeedGrade() << " " << design.getXdlVersion();
        if(!design.configIsEmpty()) 
            { mStream << ", "; write(static_cast<const ConfigMap&>(design)); }
        mStream << ";" << std::endl;
        // export the modules
        Design::ModuleSharedPtrConstIterator p = design.modulesBegin();
        Design::ModuleSharedPtrConstIterator e = design.modulesEnd();
        while(p < e) write(**p++);
        // export the instances and nets
        write(static_cast<Circuit>(design));

    }

Here is the call graph for this function:

void torc::physical::XdlExporter::write

(

const Module &

module

)

Writes the given Module.

Definition at line 69 of file XdlExporter.cpp.

                                                {
        indent();
        mStream << "module \"" << module.getName() << "\" \"" << module.getAnchor() << "\"";
        if(!module.configIsEmpty()) 
            { mStream << ", "; write(static_cast<const ConfigMap&>(module)); }
        mStream << ";" << std::endl;
        // increment the indent
        mIndentCount++;
        // export the ports
        Module::PortSharedPtrConstIterator p = module.portsBegin();
        Module::PortSharedPtrConstIterator e = module.portsEnd();
        while(p < e) write(**p++);
        // export the instances and nets
        write(static_cast<Circuit>(module));
        // decrement the indent
        mIndentCount--;
        // close out the module
        indent();
        mStream << "endmodule \"" << module.getName() << "\";" << std::endl;
    }

Here is the call graph for this function:

void torc::physical::XdlExporter::write

(

const Port &

port

)

Writes the given Port.

Definition at line 90 of file XdlExporter.cpp.

                                            {
        indent();
        std::string instanceName = port.getInstancePtr().expired() 
            ? "[expired instance]" : port.getInstancePtr().lock()->getName();
        mStream << "port \"" << port.getName() << "\" \"" << instanceName << "\" \"" 
            << port.getPinName() << "\";" << std::endl;
    }

Here is the call graph for this function:

void torc::physical::XdlExporter::write

(

const Instance &

instance

)

Writes the given Instance.

Definition at line 117 of file XdlExporter.cpp.

                                                    {
        indent();
        mStream << "inst \"" << instance.getName() << "\" \"" << instance.getType() << "\", ";
        const std::string& site = instance.getSite();
        std::string tile = instance.getTile();
        EInstanceBonding bonding = instance.getBonding();
        if(site.empty()) {
            mStream << "unplaced";
            // bonding may be specified for unplaced IOBs, but is ignored for unplaced instances of 
            // other types, and is illegal for placed instances of any type
            if(bonding != eInstanceBondingUnknown) {
                mStream << " " << (bonding == eInstanceBondingUnbonded ? "unbonded" : "bonded");
            }
        } else {
            if(tile.empty()) tile = "unknown";
            mStream << "placed " << tile << " " << site;
        }
        InstanceReferenceSharedPtr instanceReferencePtr = instance.getInstanceReferencePtr();
        if(instanceReferencePtr.get() != 0) {
            const InstanceReference& instanceReference = *instanceReferencePtr;
            std::string moduleName = instanceReference.getModulePtr().expired() 
                ? "[expired module]" : instanceReference.getModulePtr().lock()->getName();
            std::string instanceName = instanceReference.getInstancePtr().expired()
                ? "[expired instance]" : instanceReference.getInstancePtr().lock()->getName();
            mStream << ", module \"" << instanceReference.getInstantiationName() << "\" \"" 
                << moduleName << "\" \"" << instanceName << "\"";
        }
        if(!instance.configIsEmpty()) 
            { mStream << ", "; write(static_cast<const ConfigMap&>(instance)); }
        mStream << ";" << std::endl;
    }

Here is the call graph for this function:

void torc::physical::XdlExporter::write

(

const Net &

net

)

Writes the given Net.

Definition at line 149 of file XdlExporter.cpp.

                                          {
        indent();
        // write the header
        mStream << "net \"" << net.getName() << "\"";
        switch(net.getNetType()) {
            case eNetTypePower: mStream << " power"; break;
            case eNetTypeGround: mStream << " ground"; break;
            default: break;
        }
        size_t left = net.getSourceCount() + net.getSinkCount() + net.getPipCount() 
            + (net.configIsEmpty() ? 0 : 1);
        bool empty = (left == 0);
        mStream << (empty ? "" : ",") << std::endl;
        // write the sources
        Net::InstancePinSharedPtrConstIterator sop = net.sourcesBegin();
        Net::InstancePinSharedPtrConstIterator soe = net.sourcesEnd();
        while(sop < soe) write(**sop++, ePinDirectionOutpin, --left > 0);
        // write the sinks
        Net::InstancePinSharedPtrConstIterator sip = net.sinksBegin();
        Net::InstancePinSharedPtrConstIterator sie = net.sinksEnd();
        while(sip < sie) write(**sip++, ePinDirectionInpin, --left > 0);
        // write the pips
        Net::PipConstIterator pip = net.pipsBegin();
        Net::PipConstIterator pie = net.pipsEnd();
        while(pip < pie) write(*pip++, --left > 0);
        // write the config string if there is one
        if(!net.configIsEmpty()) { 
            indent(); 
            mStream << mIndentString;
            write(static_cast<const ConfigMap&>(net)); 
            mStream << std::endl; 
        }
        // indent before the closing semicolon if the net was not completely empty
        if(!empty) { indent(); mStream << mIndentString; }
        mStream << ";" << std::endl;
    }

Here is the call graph for this function:

void torc::physical::XdlExporter::write	(	const InstancePin &	instancePin,
		EPinDirection	pinDirection,
		bool	comma
	)

Writes the given InstancePin, with an optional trailing comma.

Definition at line 186 of file XdlExporter.cpp.

                    {
        indent();
        std::string instanceName = instancePin.getInstancePtr().expired() 
            ? "[expired instance]" : instancePin.getInstancePtr().lock()->getName();
        mStream << mIndentString << (pinDirection == ePinDirectionInpin ? "inpin" : "outpin") 
            << " \"" << instanceName << "\" " << instancePin.getPinName() << (comma ? "," : "") 
            << std::endl;
    }

Here is the call graph for this function:

void torc::physical::XdlExporter::write	(	const Pip &	pip,
		bool	comma
	)

Writes the given pip, with an options trailing comma.

Definition at line 196 of file XdlExporter.cpp.

                                                      {
        indent();
        mStream << mIndentString 
            << "pip " << pip.getTileName() << " " << pip.getSourceWireName() 
            << " " << pip.getDirectionString() << " " << pip.getSinkWireName() 
            << (comma ? "," : "");
        if(pip.isRoutethrough()) write(*pip.getRoutethroughPtr());
        mStream << std::endl;
    }

Here is the call graph for this function:

void torc::physical::XdlExporter::write

(

const Routethrough &

routethrough

)

Writes the given Routethrough.

Definition at line 206 of file XdlExporter.cpp.

                                                            {
        std::string instanceName = routethrough.getInstancePtr().expired() 
            ? "[expired instance]" : routethrough.getInstancePtr().lock()->getName();
        mStream << " # " << routethrough.getSetting() << ":" << routethrough.getName() << ":" 
            << routethrough.getValue() << " \"" << instanceName << "\" " 
            << routethrough.getSourceWireName() << " -> " << routethrough.getSinkWireName();
    }

Here is the call graph for this function:

void torc::physical::XdlExporter::write

(

const ConfigMap &

configMap

)

Writes the given ConfigMap.

Definition at line 98 of file XdlExporter.cpp.

                                                      {
        // nothing to do if the configMap is empty
        if(configMap.configIsEmpty()) return;
        // write the config keyword and double quotes
        mStream << "cfg \"";
        // iterate through the config settings
        ConfigMap::const_iterator p = configMap.configBegin();
        ConfigMap::const_iterator e = configMap.configEnd();
        while(p != e) {
            const std::string& setting = p->first;
            const Config& config = p->second;
            mStream << setting << ":" << config.getName() << ":" << config.getValue();
            p++;
            if(p != e) mStream << " ";
        }
        // close the double quotes
        mStream << "\"";
    }

Here is the call graph for this function:

Field Documentation

int torc::physical::XdlExporter::mIndentCount

private

The indent count.

Definition at line 36 of file XdlExporter.hpp.

std::string torc::physical::XdlExporter::mIndentString

private

The indent string.

Definition at line 38 of file XdlExporter.hpp.

std::ostream& torc::physical::XdlExporter::mStream

private

The output stream.

Definition at line 34 of file XdlExporter.hpp.

---

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

• XdlExporter.hpp
• XdlExporter.cpp