ExecutionPipelineResource.hh

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 ExecutionPipelineResource.hh
 *
 * Declaration of prototype of Resource Model:
 * declaration of the ExecutionPipelineResource class.
 *
 * @author Vladimir Guzma 2006 (vladimir.guzma-no.spam-tut.fi)
 * @author Heikki Kultala 2009 (heikki.kultala-no-spam-tut.fi)
 * @note rating: red
 */
 
#ifndef TTA_EXECUTIONPIPELINERESOURCE_HH
#define TTA_EXECUTIONPIPELINERESOURCE_HH
 
#include <climits>
#include <string>
#include <vector>
#include <map>
 
#include "SchedulingResource.hh"
#include "MoveNode.hh"
#include "SparseVectorMap.hh"
 
class DataDependenceGraph;
class ExecutionPipelineResourceTable;
 
class PSocketResource;
class ProgramOperation;
 
namespace TTAMachine {
    class FunctionUnit;
    class Port;
    class HWOperation;
}
 
/**
 * ExecutionPipelineResource keeps book of pipeline resource reservation
 * status. It uses rather simple resource reservation table approach.
 *
 */
class ExecutionPipelineResource : public SchedulingResource {
public:
    ExecutionPipelineResource(
        const TTAMachine::FunctionUnit& fu,
        const unsigned int ii = 0);
    virtual ~ExecutionPipelineResource();
 
    virtual bool isInUse(const int cycle) const override;
    virtual bool isAvailable(const int cycle) const override;
    virtual bool canAssign(const int cycle, const MoveNode& node) const override;
    virtual bool canAssignSource(
        int cycle,
        const MoveNode& node,
        const TTAMachine::Port& resultPort) const;
    virtual bool canAssignDestination(
        const int cycle,
        const MoveNode& node,
        const bool triggering = false) const;
    virtual void assign(const int cycle, MoveNode& node) override;
    virtual void assignSource(
        int cycle, MoveNode& node);
    virtual void assignDestination(
        const int cycle, MoveNode& node);
    virtual void unassign(const int cycle, MoveNode& node) override;
    virtual void unassignSource(
        const int cycle, MoveNode& node);
    virtual void unassignDestination(const int cycle, MoveNode& node);
    virtual bool isExecutionPipelineResource() const override;
    int highestKnownCycle() const;
    int nextResultCycle(
        const TTAMachine::Port& port,
        int cycle, const MoveNode& node, const MoveNode* trigger = NULL,
        int triggerCycle=INT_MAX) const;
 
    bool otherTriggerBeforeMyTrigger(const TTAMachine::Port& port, const MoveNode& node, int cycle) const;
 
    bool resultNotOverWritten(
        int resultReadCycle, int resultReadyCycle,
        const MoveNode& node, const TTAMachine::Port& port,
        const MoveNode* trigger, int triggerCycle) const;
 
    bool
    hasConflictingResultsOnCycle(
        const ProgramOperation& po,
        const TTAMachine::Port&
        port, int cycle) const;
 
    bool operandsOverwritten(
        int triggerCycle, const MoveNode& trigger) const;
 
    void clear() override;
    void setDDG(const DataDependenceGraph* ddg);
    virtual void setMaxCycle(unsigned int maxCycle) override { maxCycle_ = maxCycle;  }
protected:
    virtual bool validateDependentGroups() override;
    virtual bool validateRelatedGroups() override;
    unsigned int size() const;
private:
 
    inline bool cyclesOverlap(
        int rangeFirst, int rangeLast, int targetCycle) const ;
 
    bool cyclesConflict(
        const MoveNode* mn1, const MoveNode* mn2, int guardCycle,
        int rangeFirst, int rangeLast, int targetCycle) const;
 
    bool isLoopBypass(const MoveNode& node) const;
 
    struct ResultHelper {
        unsigned int realCycle;
        const ProgramOperation* po;
        int count;
        ResultHelper() : realCycle(0), po(NULL), count(0) {};
        ResultHelper(int rc, const ProgramOperation* p, int c) : 
            realCycle(rc), po(p), count(c) {}
    };
 
    struct OperandUseHelper {
        unsigned int realCycle;
        const ProgramOperation* po;
        OperandUseHelper(): realCycle(0), po(NULL){}
        OperandUseHelper(int rc, const ProgramOperation* p): realCycle(rc), po(p){}
    };
 
    typedef std::pair<ResultHelper,ResultHelper> ResultHelperPair;
    typedef std::pair<OperandUseHelper,OperandUseHelper> OperandUsePair;
 
    typedef std::pair<const MoveNode*,const MoveNode*> ResourceReservation;
 
 
    /// Type for resource vector, represents one cycle of use.
    /// Includes the ownerships of the reservation.
    typedef std::vector<ResourceReservation> 
    ResourceReservationVector;
 
    /// Used for both result read and result written.
    typedef SparseVector<ResultHelperPair> ResultVector;
 
    typedef std::map<const TTAMachine::Port*, ResultVector> ResultMap;
       
    typedef std::pair<MoveNode*,MoveNode*> MoveNodePtrPair;
 
    typedef SparseVector<MoveNodePtrPair> OperandWriteVector;
    typedef SparseVector<OperandUsePair> OperandUseVector;
 
    typedef std::map<const TTAMachine::Port*, OperandUseVector> OperandUseMap;
    typedef std::map<const TTAMachine::Port*, OperandWriteVector> 
    OperandWriteMap;
 
    /// Type for resource reservation table, resource vector x latency.
    /// Includes the ownerships of the reservation.
    typedef SparseVector<ResourceReservationVector> ResourceReservationTable;
    
 
    //Copying forbidden
    ExecutionPipelineResource(const ExecutionPipelineResource&);
    // Assignment forbidden
    ExecutionPipelineResource& operator=(const ExecutionPipelineResource&);
 
    /// Find first and last cycles already scheduled for same PO
    void findRange(
        const int cycle,
        const MoveNode& node,
        int popIndex,
        int& first,
        int& last,
        int& triggering) const;
 
    int resultReadyCycle(
        const ProgramOperation& po, const TTAMachine::Port& resultPort) const;
 
    void setResultWriten(
        const TTAMachine::Port& port, 
        unsigned int realCycle, 
        const ProgramOperation& po);
 
    void setResultWriten(
        const ProgramOperation& po, 
        unsigned int triggerCycle);
 
    void unsetResultWriten(
        const TTAMachine::Port& port, unsigned int realCycle, 
        const ProgramOperation& po);
 
    void unsetResultWriten(
        const ProgramOperation& po, 
        unsigned int triggerCycle);
 
    void setOperandUsed(
        const TTAMachine::Port& port, 
        unsigned int realCycle, 
        const ProgramOperation& po);
 
    void setOperandsUsed(
        const ProgramOperation& po, 
        unsigned int triggerCycle);
 
    void unsetOperandUsed(
        const TTAMachine::Port& port, unsigned int realCycle, 
        const ProgramOperation& po);
 
    void unsetOperandsUsed(
        const ProgramOperation& po, 
        unsigned int triggerCycle);
 
    const TTAMachine::Port& operandPort(const MoveNode& mn) const;
 
    bool operandOverwritten(
        int operandWriteCycle,
        int triggerCycle,
        const ProgramOperation& po,
        const MoveNode& operand,
        const MoveNode& trigger) const;
 
    bool operandOverwritten(const MoveNode& mn, int cycle) const;
 
    bool testTriggerResult(const MoveNode& trigger, int cycle) const;
    bool resultAllowedAtCycle(
        int resultCycle, const ProgramOperation& po, 
        const TTAMachine::Port& resultPort,
        const MoveNode& trigger, int triggerCycle) const;
 
    bool resourcesAllowTrigger(int cycle, const MoveNode& move) const;
 
    bool operandPossibleAtCycle(
        const TTAMachine::Port& port, const MoveNode& mn, int cycle) const;
 
    bool operandAllowedAtCycle(
        const TTAMachine::Port& port, const MoveNode& mn, int cycle) const;
 
    bool checkOperandAllowed(
        const  MoveNode& currentMn,
        const TTAMachine::Port& port, 
        int operandWriteCycle, 
        const OperandUseHelper &operandUse,
        int operandUseModCycle, ProgramOperation& currOp) const;
 
    bool triggerTooEarly(const MoveNode& trigger, int cycle) const;
 
    bool operandTooLate(const MoveNode& node, int cycle) const;
    
    bool triggerAllowedAtCycle(
        int inputCount,
        const TTAMachine::HWOperation& hwop,
        const MoveNode& node,
        int cycle) const;
 
    bool operandSharePreventsTriggerForScheduledResult(
        const TTAMachine::Port& port, const MoveNode& mn, int cycle) const;
 
    bool resultCausesTriggerBetweenOperandSharing(
        const MoveNode& mn, int cycle) const;
 
    const MoveNode* nodeOfInputPort(
        const ProgramOperation& po, TTAMachine::Port& port);
 
 
    bool poConflictsWithInputPort(
        const TTAMachine::Port& port,
        const ProgramOperation& po,
        const MoveNode& mn) const;
 
    const TTAMachine::Port& resultPort(const MoveNode& mn) const;
 
    bool exclusiveMoves(
        const MoveNode* mn1, const MoveNode* mn2, int cycle=INT_MAX) const;
 
    int latestTriggerWriteCycle(const MoveNode& mn) const;
 
    bool isDestOpOfMN(const MoveNode& mn, const ProgramOperation& po) const;
 
    const ExecutionPipelineResourceTable* resources;
 
    /// Stores one resource vector per cycle of scope for whole FU
    mutable ResourceReservationTable fuExecutionPipeline_;
 
    // Stores PO for each "result ready" a cycle in which it was produced,
#if 0
    // Test if other program operation writes into same register
    // in given cycle
    bool sameRegisterWrite(
    const MoveNode& node,
    ProgramOperation* operation)const;
#endif
 
    OperandWriteMap operandsWriten_;
    OperandUseMap operandsUsed_;
 
    // counts number of results that are ready in that cycle
    ResultMap resultWriten_;
    // Stores PO for each "result read" move a cycle in which it was read,
    // counts number of reads in given cycle
    ResultMap resultRead_;
 
    // Stores for each move a cycle in which the result is written to output
    // register of FU, this information is not available elsewhere
    // these are real cycles.
    std::map<MoveNode*, int, MoveNode::Comparator> storedResultCycles_;
    // stores the set of assigned source nodes
    std::multimap<int, MoveNode*> assignedSourceNodes_;
    // stores the set of assigned destination nodes
    std::multimap<int, MoveNode*> assignedDestinationNodes_;
 
    mutable int cachedSize_;
    int maxCycle_;
 
    const DataDependenceGraph* ddg_;
    const TTAMachine::FunctionUnit& fu_;
    
    // TODO: is this needed or not?
    const TTAMachine::Port* triggerPort_;
 
    int operandShareCount_;
};
 
#endif