InputFUResource.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 InputFUResource.cc
 *
 * Implementation of prototype of Resource Model:
 * implementation of the InputFUResource.
 *
 * @author Vladimir Guzma 2006 (vladimir.guzma-no.spam-tut.fi)
 * @note rating: red
 */
 
#include "InputFUResource.hh"
#include "FUPort.hh"
#include "Application.hh"
#include "Exception.hh"
#include "MoveNode.hh"
#include "ExecutionPipelineResource.hh"
#include "ResourceManager.hh"
#include "InputPSocketResource.hh"
 
using TTAMachine::BaseFUPort;
using TTAMachine::FUPort;
using TTAMachine::Port;
 
/**
 * Constructor defining name of resource.
 *
 * @param name Name of resource
 */
InputFUResource::InputFUResource(
    const std::string& name, int opCount, int nopSlotWeight,
    unsigned int initiationInterval) :
    FUResource(name, opCount, nopSlotWeight, initiationInterval) {
}
 
/**
 * Empty destructor
 */
InputFUResource::~InputFUResource() {    
}
 
/**
 * Not to be used, aborts!
 *
 * Use version with third InputPSocket operand!
 */
bool
InputFUResource::canAssign(const int, const MoveNode&) const {
    abortWithError("Wrong method. Use canAssign with PSocket!");
    return false;
}
 
/**
 * Assign resource to given node for given cycle
 * as a side effect, assign also execution pipeline for triggering moves.
 *
 * @param cycle Cycle to assign
 * @param node MoveNode assigned
 * @param pSocket InputPSocket used for writting operand
 * @throw In case the assignment is impossible, should have been tested
 * with canAssing first.
 */
void
InputFUResource::assign(
    const int cycle,
    MoveNode& node) {
 
    for (int i = 0; i < dependentResourceGroupCount(); i++) {
        for (int j = 0, count = dependentResourceCount(i); j < count; j++) {
            if (dependentResource(i, j).isExecutionPipelineResource()) {
                SchedulingResource* res = &dependentResource(i, j);
                ExecutionPipelineResource* epRes =
                    dynamic_cast<ExecutionPipelineResource*>(res);
                epRes->assignDestination(cycle, node);
                increaseUseCount();
                return;
            }
        }
    }
    abortWithError("InputFUResource has no execution pipeline registered!");
}
 
/**
 * Unassign resource from given node for given cycle,
 * for triggering moves also unassign execution pipeline.
 *
 * @param cycle Cycle to remove assignment from
 * @param node MoveNode to remove assignment from
 * @param pSocket InputPSocket used for writting operand
 * @throw In case PSocket is not connected to FU
 */
void
InputFUResource::unassign(
    const int cycle,
    MoveNode& node) {
 
    for (int i = 0; i < dependentResourceGroupCount(); i++) {
        for (int j = 0, count = dependentResourceCount(i); j < count; j++) {
            if (dependentResource(i, j).isExecutionPipelineResource()) {
                SchedulingResource* res = &dependentResource(i, j);
                ExecutionPipelineResource* epRes =
                    dynamic_cast<ExecutionPipelineResource*>(res);
                epRes->unassignDestination(cycle, node);
                decreaseUseCount();
                return;
            }
        }
    }
    abortWithError("InputFUResource has no execution pipeline registered!");
}
 
/**
 * Return true if resource can be assigned for given node in given cycle.
 *
 * @param cycle Cycle to test
 * @param node MoveNode to test
 * @param pSocket InputPSocket used for writting operand
 * @return true if node can be assigned to cycle
 * @throw Internal error, PSocket is not conencted to FU or ExecutionPipeline
 */
bool
InputFUResource::canAssign(
    const int cycle,
    const MoveNode& node,
    const InputPSocketResource& pSocket,
    const bool triggers) const {
 
    if (!hasDependentResource(pSocket)) {
        std::string msg = "InputPSocket ";
        msg += pSocket.name();
        msg += " is not connected to ";
        msg += name();
        msg += "!";
        throw ModuleRunTimeError(__FILE__, __LINE__, __func__, msg);
        return false;
    }
 
    if (!pSocket.canAssign(cycle, node)) {
        debugLogRM("cannot assign pSocket");
        return false;
    }
 
    for (int i = 0; i < dependentResourceGroupCount(); i++) {
        for (int j = 0, count = dependentResourceCount(i); j < count; j++) {
            SchedulingResource& depRes = dependentResource(i, j);
            if (depRes.isExecutionPipelineResource()) {
                ExecutionPipelineResource* epRes =
                    static_cast<ExecutionPipelineResource*>(&depRes);
                if (!(epRes->canAssignDestination(cycle, node, triggers))) {
                    debugLogRM("cannot assign execution pipeline resource");
                    return false;
                } else {
                    return true;
                }
            }
        }
    }
    debugLogRM("could not find a depedent resource I could assign");
    return false;
}
 
/**
 * Test if resource InputFUResource is available.
 *
 * Not all the PSocket are inUse and there is some operation possible for
 * triggering moves.
 *
 * @param cycle Cycle which to test
 * @return True if FUResource is available in cycle
 */
bool
InputFUResource::isAvailable(const int cycle) const {
    // Test availability of PSockets using parent class
    if (!FUResource::isAvailable(cycle)) {
        return false;
    }
    for (int i = 0; i < dependentResourceGroupCount(); i++) {
        for (int j = 0, count = dependentResourceCount(i); j < count; j++) {
            if (dependentResource(i, j).isExecutionPipelineResource() &&
                dependentResource(i, j).isAvailable(cycle)) {
                return true;
            }
        }
    }
    return false;
}
 
/**
 * Test if resource InputFUResource is used in given cycle.
 *
 * True if some of InputPSockets are already used or there is
 * operation already in execution pipeline.
 *
 * @param cycle Cycle which to test
 * @return True if InputFUResource is already used in cycle
 */
bool
InputFUResource::isInUse(const int cycle) const {
    // Test isInUse of PSockets using parent class
    if (FUResource::isInUse(cycle)) {
        return true;
    }
    for (int i = 0; i < dependentResourceGroupCount(); i++) {
        for (int j = 0, count = dependentResourceCount(i); j < count; j++) {
            if (dependentResource(i, j).isExecutionPipelineResource() &&
                dependentResource(i, j).isInUse(cycle)) {
                return true;
            }
        }
    }
    return false;
}
 
/**
 * Allways return true
 *
 * @return true
 */
bool
InputFUResource::isInputFUResource() const {
    return true;
}
 
/**
 * Tests if all referred resource in dependent groups are of
 * proper types.
 *
 * @return true If all resources in dependent groups are
 *              input or output PSockets or executionPipeline
 */
bool
InputFUResource::validateDependentGroups() {
    for (int i = 0; i < dependentResourceGroupCount(); i++) {
        for (int j = 0, count = dependentResourceCount(i); j < count; j++) {
            if (!(dependentResource(i, j).isInputPSocketResource() ||
                dependentResource(i, j).isOutputPSocketResource() ||
                dependentResource(i, j).isExecutionPipelineResource())) {
                return false;
            }
        }
    }
    return true;
}
 
/**
 * Tests if related resource groups are empty.
 *
 * @return true If all related resource groups are
 *              empty
 */
bool
InputFUResource::validateRelatedGroups() {
    for (int i = 0; i < relatedResourceGroupCount(); i++) {
        if (relatedResourceCount(i) > 0) {
            return false;
        }
    }
    return true;
}