OutputFUBroker.cc

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file OutputFUBroker.cc
 *
 * Implementation of OutputFUBroker class.
 *
 * @author Ari Mets�halme 2006 (ari.metsahalme-no.spam-tut.fi)
 * @author Vladimir Guzma 2007 (vladimir.guzma-no.spam-tut.fi)
 * @note rating: red
 */
 
#include "OutputFUBroker.hh"
#include "OutputFUResource.hh"
#include "ResourceMapper.hh"
#include "ControlUnit.hh"
#include "Machine.hh"
#include "Operation.hh"
#include "SpecialRegisterPort.hh"
#include "FUPort.hh"
#include "HWOperation.hh"
#include "ProgramOperation.hh"
#include "MapTools.hh"
#include "AssocTools.hh"
#include "ProgramAnnotation.hh"
#include "TCEString.hh"
#include "TerminalFUPort.hh"
#include "MoveNodeSet.hh"
#include "OutputPSocketResource.hh"
#include "ResourceManager.hh"
#include "Move.hh"
#include "MachineConnectivityCheck.hh"
#include "LLVMTCECmdLineOptions.hh"
#include "MoveGuard.hh"
#include "Guard.hh"
 
using std::string;
using namespace TTAMachine;
using namespace TTAProgram;
 
/**
 * Constructor.
 */
OutputFUBroker::OutputFUBroker(std::string name, unsigned int initiationInterval) :
    FUBroker(name, initiationInterval) {
}
 
/**
 * Destructor.
 */
OutputFUBroker::~OutputFUBroker(){
}
 
/**
 * Return all resources managed by this broker that can be assigned to
 * the given node in the given cycle.
 *
 * @param cycle Cycle.
 * @param node Node.
 * @return All resources managed by this broker that can be assigned to
 * the given node in the given cycle.
 */
SchedulingResourceSet
OutputFUBroker::allAvailableResources(
    int cycle,
    const MoveNode& node,
    const TTAMachine::Bus*,
    const TTAMachine::FunctionUnit* srcFU,
    const TTAMachine::FunctionUnit*, int,
    const TTAMachine::ImmediateUnit*,
    int) const {
 
    int modCycle = instructionIndex(cycle);
    if (!isApplicable(node)) {
        string msg = "Broker not capable of assigning resources to node: "
        + node.toString();
        throw ModuleRunTimeError(__FILE__, __LINE__, __func__, msg);
    }
 
    const TTAMachine::FunctionUnit* foundFU = srcFU;
    int opIndex = -1;
    ProgramOperation* PO = nullptr;
    SchedulingResourceSet resourceSet;
    ResourceMap::const_iterator resIter = resMap_.begin();
 
    const Operation* op = nullptr;
 
    if (node.move().source().isFUPort()) {
        TerminalFUPort& src =
            static_cast<TerminalFUPort&>(node.move().source());
 
        if (dynamic_cast<const SpecialRegisterPort*>(&src.port()) != NULL) {
            // only gcu applies
            while (resIter != resMap_.end()) {
                const ControlUnit* gcu =
                    dynamic_cast<const ControlUnit*>((*resIter).first);
                if (gcu != NULL) {
                    if ((*resIter).second->isAvailable(modCycle)) {
                        resourceSet.insert(*(*resIter).second);
                    }
                    return resourceSet;
                }
                resIter++;
            }
            abortWithError("No GCU found!");
        }
 
        op = &src.hintOperation();
        opIndex = src.operationIndex();
 
        // check if a unit has already been assigned to some node
        // of the same operation and use it.
        if (node.isSourceOperation()) {
            PO = &node.sourceOperation();
        } else {
            assert(false);
        }
    } else {
        // port guard?
        PO = &node.guardOperation();
        opIndex = PO->outputIndexFromGuardOfMove(node);
        op = &PO->operation();
    }
 
    auto a = findFUOfPO(*PO, foundFU);
    if (a.first) {
        foundFU = a.second;
    } else { // conflicting FUs, cannot schedule
        return SchedulingResourceSet();
    }
 
    if (foundFU) {
        OutputFUResource& fuRes =
            static_cast<OutputFUResource&>(*resourceOf(*foundFU));
        // Find what is the port on a new FU for given
        // operation index. Find a socket for testing.
        HWOperation* hwOp = foundFU->operation(op->name());
        assert(hwOp != nullptr);
        Port* resultPort = hwOp->port(opIndex);
        assert (resultPort != nullptr);
        if (fuRes.canAssign(cycle, node, *resultPort)) {
            resourceSet.insert(fuRes);
        }
        return resourceSet;
    }
 
    // check if the move has a candidate FU set which limits the
    // choice of FU for the node
    std::set<TCEString> candidateFUs;
    std::set<TCEString> allowedFUs;
    std::set<TCEString> rejectedFUs;
 
    // TODO: why is this in loop for operands but not in loop for results?
    // do multiple return values break or work?
    MachineConnectivityCheck::addAnnotatedFUs(
        candidateFUs, node.move(),
        TTAProgram::ProgramAnnotation::ANN_CONN_CANDIDATE_UNIT_SRC);
    MachineConnectivityCheck::addAnnotatedFUs(
        allowedFUs, node.move(),
        TTAProgram::ProgramAnnotation::ANN_ALLOWED_UNIT_SRC);
    MachineConnectivityCheck::addAnnotatedFUs(
        rejectedFUs, node.move(),
        TTAProgram::ProgramAnnotation::ANN_REJECTED_UNIT_SRC);
 
    // find units that support operation and are available at given cycle
    while (resIter != resMap_.end()) {
        const FunctionUnit* unit =
            static_cast<const FunctionUnit*>((*resIter).first);
        if (srcFU != NULL && unit != srcFU) {
            debugLogRM(TCEString("Skipping unit") << unit->name()
                       << " because it's not the pre-set one: "
                       << srcFU->name());
            resIter++;
            continue;
        }
        // in case the unit is limited by a candidate set, skip FUs that are
        // not in it
        debugLogRM(TCEString("checking ") << unit->name());        
        if (candidateFUs.size() > 0 &&
            !AssocTools::containsKey(candidateFUs, unit->name())) {
            ++resIter;
            continue;
        }
        if (allowedFUs.size() > 0 &&
            !AssocTools::containsKey(allowedFUs, unit->name())) {
            debugLogRM(
                TCEString("skipped ") << unit->name() << " because it was not"
                " in the allowed set. The set contents: ");
            for (auto allowedUnit : allowedFUs)
                debugLogRM(allowedUnit + "\n");
            ++resIter;
            continue;
        }
 
        if (AssocTools::containsKey(rejectedFUs, unit->name())) {
            debugLogRM(
                TCEString("skipped ") << unit->name() << " because it was"
                " in the rejected set.");
            ++resIter;
            continue;
        }            
 
        if (unit->hasOperation(op->name())) {
            OutputFUResource& fuRes =
                static_cast<OutputFUResource&>(*resourceOf(*unit));
                // Find what is the port on a new FU for given
                // operation index. Find a socket for testing.
            HWOperation* hwOp = unit->operation(op->name());
            Port* resultPort = hwOp->port(opIndex);
            if (fuRes.canAssign(cycle, node, *resultPort)) {
                debugLogRM("testing " + op->name());
                resourceSet.insert(*(*resIter).second);
            } else {
                debugLogRM("could not assign the fuRes to it.");
            }
        } else {
            debugLogRM(TCEString("does not have operation ") + op->name());
        }
        resIter++;
    }
    return resourceSet;
}
 
/**
 * Mark given resource as in use for the given node, and assign the
 * corresponding machine part (if applicable) to the node's move.
 *
 * If the node is already assigned to given resource, this method does
 * nothing.
 *
 * @param cycle Cycle.
 * @param node Node to assign.
 * @param res Resource representing Output of FU
 * @exception WrongSubclass If this broker does not recognise the given
 * type of resource.
 * @exception InvalidParameters If he given resource cannot be assigned to
 * given node or no corresponding machine part is found.
 */
void
OutputFUBroker::assign(
    int cycle, MoveNode& node, SchedulingResource& res, int, int) {
    // TODO: this breaks execpipeline
//    cycle = instructionIndex(cycle);
    if (!isApplicable(node)) {
        string msg = "Broker not capable of assigning resources to node!";
        throw WrongSubclass(__FILE__, __LINE__, __func__, msg);
    }
 
    if (!hasResource(res)) {
        string msg = "Broker does not contain given resource.";
        throw InvalidData(__FILE__, __LINE__, __func__, msg);
    }
    OutputFUResource& fuRes = static_cast<OutputFUResource&>(res);
    Move& move = const_cast<MoveNode&>(node).move();
 
    int opIndex = -1;
    const Operation* op = nullptr;
    TerminalFUPort* src = dynamic_cast<TerminalFUPort*>(&move.source());
    if (src != nullptr &&
        dynamic_cast<const SpecialRegisterPort*>(&src->port()) != NULL) {
        const ControlUnit* gcu =
            dynamic_cast<const ControlUnit*>(&machinePartOf(res));
        if (gcu != NULL) {
            // output of GCU is ra read
            TerminalFUPort* newSrc =
                new TerminalFUPort(*gcu->returnAddressPort());
            move.setSource(newSrc);
            Socket* outputSocket = newSrc->port().outputSocket();
            
            if (outputSocket == NULL) {
                throw InvalidData(
                    __FILE__, __LINE__, __func__, "GCU is missing RA port - "
                    "socket connection!");
            }
            assignedResources_.insert(
                std::pair<const MoveNode*, SchedulingResource*>(
                &node, &fuRes));
            return;
        } else {
            abortWithError(
                "GCU required but tried to assign something else!");
        }
    }
 
    if (node.isSourceOperation()) {
 
        opIndex = src->operationIndex();
        op = &src->hintOperation();
        const FunctionUnit& unit =
            static_cast<const FunctionUnit&>(machinePartOf(res));
        HWOperation* hwOp = unit.operation(op->name());
        TerminalFUPort* newSrc = new TerminalFUPort(*hwOp, opIndex);
        move.setSource(newSrc);
        fuRes.assign(cycle, node);
        assignedResources_.insert(
            std::pair<const MoveNode*, SchedulingResource*>(
                &node, &fuRes));
    } else {
        assert(node.isGuardOperation());
        ProgramOperation& po = node.guardOperation();
        opIndex = po.outputIndexOfMove(node);
        op = &po.operation();
 
        fuRes.assign(cycle, node);
        assignedResources_.insert(
            std::pair<const MoveNode*, SchedulingResource*>(
                &node, &fuRes));
    }
}
 
/**
 * Free the resource type managed by this broker and unassign it from
 * given node.
 *
 * If this broker is not applicable to the given node, or the node is
 * not assigned a resource of the managed type, this method does
 * nothing.
 *
 * @param node Node.
 */
void
OutputFUBroker::unassign(MoveNode& node) {
    if (!isApplicable(node)) {
        return;
    }
    if (MapTools::containsKey(assignedResources_, &node)) {
 
        TTAProgram::Move& move = node.move();
        const TerminalFUPort* src = dynamic_cast<const TerminalFUPort*>(&move.source());
        if (src) {
            const TerminalFUPort* src = dynamic_cast<const TerminalFUPort*>(&move.source());
            assert(src);
            SchedulingResource& res = *resourceOf(src->functionUnit());
            const ControlUnit* gcu =
                dynamic_cast<const ControlUnit*>(&machinePartOf(res));
 
            // not ra read? unassign from fu
            if (gcu == NULL) {
                OutputFUResource* fuRes = dynamic_cast<OutputFUResource*>(&res);
                fuRes->unassign(node.cycle(), node);
            }
        } else {
            if (node.isGuardOperation()) {
                ProgramOperation& gop = node.guardOperation();
                SchedulingResource& res = *resourceOf(*gop.fuFromOutMove(node));
                res.unassign(node.cycle(), node);
            }
        }
        // removed from assigned resources also if ra read
        assignedResources_.erase(&node);
    }
}
 
/**
 * Return the earliest cycle, starting from given cycle, where a
 * resource of the type managed by this broker can be assigned to the
 * given node.
 *
 * @param cycle Cycle.
 * @param node Node.
 * @return The earliest cycle, starting from given cycle, where a
 * resource of the type managed by this broker can be assigned to the
 * given node.
 */
int
OutputFUBroker::earliestCycle(int, const MoveNode&,
                              const TTAMachine::Bus*,
                              const TTAMachine::FunctionUnit*,
                              const TTAMachine::FunctionUnit*, int,
                              const TTAMachine::ImmediateUnit*,
                              int) const {
    abortWithError("Not implemented.");
    return -1;
}
 
/**
 * Return the latest cycle, starting from given cycle, where a
 * resource of the type managed by this broker can be assigned to the
 * given node.
 *
 * @param cycle Cycle.
 * @param node Node.
 * @return The latest cycle, starting from given cycle, where a
 * resource of the type managed by this broker can be assigned to the
 * given node.
 */
int
OutputFUBroker::latestCycle(int, const MoveNode&, const TTAMachine::Bus*,
                            const TTAMachine::FunctionUnit*,
                            const TTAMachine::FunctionUnit*,int,
                            const TTAMachine::ImmediateUnit*,
                            int) const {
    abortWithError("Not implemented.");
    return -1;
}
 
/**
 * Return true if the given node is already assigned a resource of the
 * type managed by this broker, and the assignment appears valid (that
 * is, the broker has marked that resource as in use in the given
 * cycle).
 *
 * @param cycle Cycle. not used.
 * @param node Node.
 * @return True if the given node is already assigned a resource of the
 * type managed by this broker, and the assignment appears valid (that
 * is, the broker has marked that resource as in use in the given
 * cycle).
 */
bool
OutputFUBroker::isAlreadyAssigned(
    int cycle, const MoveNode& node, const TTAMachine::Bus*) const {
    cycle = instructionIndex(cycle);
    Terminal& src = const_cast<MoveNode&>(node).move().source();
    if (src.isFUPort()) {
        const FunctionUnit& fu = src.functionUnit();
        if (hasResourceOf(fu)) {
            if (MapTools::containsKey(assignedResources_, &node)) {
                return true;
            }
        }
    }
    if (node.isGuardOperation()) {
        const FunctionUnit* fu = node.guardOperation().fuFromOutMove(node);
        if (fu && hasResourceOf(*fu)) {
            if (MapTools::containsKey(assignedResources_, &node)) {
                return true;
            }
        }
    }
    return false;
}
 
/**
 * Return true if the given node needs a resource of the type managed
 * by this broker, false otherwise.
 *
 * @param node Node.
 * @return True if the given node needs a resource of the type managed
 * by this broker, false otherwise.
 */
bool
OutputFUBroker::isApplicable(
    const MoveNode& node, const TTAMachine::Bus*) const {
    if (!node.isMove()) {
        return false;
    }
    Move& move = const_cast<MoveNode&>(node).move();
    if (move.source().isFUPort() ||
        (!move.isUnconditional() &&
         dynamic_cast<const TTAMachine::PortGuard*>(&move.guard().guard()))) {
        return true;
    } else {
        return false;
    }
}
 
/**
 * Build all resource objects of the controlled type required to model
 * scheduling resources of the given target processor.
 *
 * This method cannot set up the resource links (dependent and related
 * resources) of the constructed resource objects.
 *
 * @param target Target machine.
 */
void
OutputFUBroker::buildResources(const TTAMachine::Machine& target) {
 
    std::map<const TTAMachine::FunctionUnit*,int> nopWeights;
 
    Machine::FunctionUnitNavigator navi = target.functionUnitNavigator();
    for (int i = 0; i < navi.count(); i++) {
        FunctionUnit* fu = navi.item(i);
        OutputFUResource* fuResource = new OutputFUResource(
            fu->name(), fu->operationCount(), nopWeights[fu]);
        ResourceBroker::addResource(*fu, fuResource);
    }
    ControlUnit* gcu = target.controlUnit();
    OutputFUResource* fuResource = new OutputFUResource(
        gcu->name(), gcu->operationCount(),0);
    ResourceBroker::addResource(*gcu, fuResource);
}
 
/**
 * Complete resource initialisation by creating the references to
 * other resources due to a dependency or a relation. Use the given
 * resource mapper to lookup dependent and related resources using
 * machine parts as keys.
 *
 * @param mapper Resource mapper.
 */
void
OutputFUBroker::setupResourceLinks(const ResourceMapper& mapper) {
 
    setResourceMapper(mapper);
 
    for (ResourceMap::iterator resIter = resMap_.begin();
         resIter != resMap_.end(); resIter++) {
 
        const FunctionUnit* fu =
            dynamic_cast<const FunctionUnit*>((*resIter).first);
 
        SchedulingResource* fuResource = (*resIter).second;
        for (int i = 0; i < fu->portCount(); i++) {
            Port* port = fu->port(i);
            if (port->outputSocket() != NULL) {
                try {
                    SchedulingResource& depRes =
                        mapper.resourceOf(*port->outputSocket());
                    fuResource->addToDependentGroup(0, depRes);
                } catch (const KeyNotFound& e) {
                    std::string msg = "OutputFUBroker: finding ";
                    msg += " resource for Socket ";
                    msg += " failed with error: ";
                    msg += e.errorMessageStack();
                    throw KeyNotFound(
                        __FILE__, __LINE__, __func__, msg);
                }                                
            }
        }
 
        int fuCount = mapper.resourceCount(*fu);
        for (int i = 0; i < fuCount; i++) {
            SchedulingResource* depRes = &mapper.resourceOf(*fu, i);
            if (depRes->isExecutionPipelineResource()){
                fuResource->addToDependentGroup(1, *depRes);
                break;
            }
        }
    }
    // todo: dependent execution pipeline to support trigger-on-result
}