Terminal.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 Terminal.cc
 *
 * Implementation of Terminal class.
 *
 * @author Ari Metsähalme 2005 (ari.metsahalme-no.spam-tut.fi)
 * @note rating: red
 */
 
#include "Exception.hh"
#include "Terminal.hh"
#include "InstructionReference.hh"
 
using namespace TTAMachine;
 
namespace TTAProgram {
 
/////////////////////////////////////////////////////////////////////////////
// Terminal
/////////////////////////////////////////////////////////////////////////////
 
/**
 * The constructor.
 */
Terminal::Terminal() {
}
 
/**
 * The destructor.
 */
Terminal::~Terminal() {
}
 
/**
 * Tells whether the terminal is an inline immediate value.
 *
 * @return True if the terminal is an inline immediate value.
 */
bool
Terminal::isImmediate() const {
    return false;
}
 
/**
 * Tells whether the terminal is an inline immediate value that refers
 * to an address.
 *
 * @return True if the terminal is an inline immediate value that refers
 *         to an address.
 */
bool
Terminal::isAddress() const {
    return false;
}
 
/**
 * Tells whether the terminal is an inline immediate value that refers
 * to an instruction address.
 *
 * @return True if the terminal is an inline immediate value that refers
 *         to an instruction address.
 */
bool
Terminal::isInstructionAddress() const {
    return false;
}
 
/**
 * Tells whether the terminal is a long immediate register.
 *
 * @return True if the terminal is a long immediate register.
 */
bool
Terminal::isImmediateRegister() const {
    return false;
}
 
/**
 * Tells whether the terminal is a general-purpose register.
 *
 * @return True if the terminal is a general-purpose register.
 */
bool
Terminal::isGPR() const {
    return false;
}
 
/**
 * Tells whether the terminal is a function unit port (possibly,
 * including an operation code).
 *
 * @return True if the terminal is a function unit port.
 */
bool
Terminal::isFUPort() const {
    return false;
}
 
/**
 * Tells whether the terminal is a the return address port
 * in gcu.
 *
 * @return True if the terminal is a the RA port.
 */
bool
Terminal::isRA() const {
    return false;
}
 
/**
 * Tells whether the terminal is reference to a basic block.
 *
 * @return True if the terminal is a ref to a basic block
 */
bool
Terminal::isBasicBlockReference() const {
    return false;
}
 
bool
Terminal::isProgramOperationReference() const {
    return false;
}
 
/**
 * Tells whether the terminal is reference to a code symbol
 *
 * @return True if the terminal is a ref to a code symbol
 */
bool
Terminal::isCodeSymbolReference() const {
    return false;
}
 
/**
 * Tells whether the terminal is a reg in UniversalMachine
 *
 * @return True if the terminal is a register in universalmachine,
 * ie. not in any real machine. This practically means the
 * register is unallocated and meant to be bypassed.
 */
bool
Terminal::isUniversalMachineRegister() const {
    return false;
}
 
/**
 * Returns the value of the inline immediate.
 *
 * @return The value of the inline immediate.
 * @exception WrongSubclass if the terminal is not an instance of
 *            TerminalImmediate.
 */
SimValue
Terminal::value() const {
    throw WrongSubclass(__FILE__, __LINE__);
}
 
/**
 * Returns a reference to the instruction to which the immediate points.
 *
 * @return A reference to the instruction to which the immediate points.
 */
const InstructionReference&
Terminal::instructionReference() const {
    throw WrongSubclass(__FILE__, __LINE__);
}
 
/**
 * Returns a reference to the instruction to which the immediate points.
 *
 * @return A reference to the instruction to which the immediate points.
 */
InstructionReference&
Terminal::instructionReference() {
    throw WrongSubclass(__FILE__, __LINE__);
}
 
/**
 * Returns the address held by this terminal.
 *
 * @return A memory address.
 * @exception WrongSubclass if the terminal is not an instance of
 *     TerminalAddress.
 */
Address
Terminal::address() const {
    throw WrongSubclass(__FILE__, __LINE__);
}
 
/**
 * Returns the register file of the general-purpose register.
 *
 * Applicable only if the unit of the terminal is an instance of
 * RegisterFile.
 *
 * @return The register file of the general-purpose register.
 * @exception WrongSubclass if the unit of the terminal is not an instance
 *            of RegisterFile.
 */
const RegisterFile&
Terminal::registerFile() const {
    throw WrongSubclass(__FILE__, __LINE__);
}
 
/**
 * Returns the immediate unit of the long immediate register.
 *
 * Applicable only if the unit of the terminal is an instance of
 * ImmediateUnit.
 *
 * @return The immediate unit of the long immediate register.
 * @exception WrongSubclass if the unit of the terminal is not an instance
 *            of ImmediateUnit.
 */
const ImmediateUnit&
Terminal::immediateUnit() const {
    throw WrongSubclass(__FILE__, __LINE__);
}
 
/**
 * Returns the function unit of the port.
 *
 * @exception WrongSubclass if the terminal is not an instance of
 *            TerminalFUPort.
 */
const FunctionUnit&
Terminal::functionUnit() const {
    throw WrongSubclass(__FILE__, __LINE__);
}
 
/**
 * Returns a reference to the basic block to which the immediate points.
 *
 * @return A reference to the basic block to which the immediate points.
 */
const BasicBlock&
Terminal::basicBlock() const {
    throw WrongSubclass(__FILE__, __LINE__);
}
 
/**
 * Return the index of the register (either a long immediate or a
 * general-purpose register).
 *
 * @return The index of the register.
 * @exception WrongSubclass if the terminal is not an instance of
 *            TerminalRegister.
 */
int
Terminal::index() const {
    throw WrongSubclass(__FILE__, __LINE__);
}
 
/**
 * Tells whether terminal transports an opcode to a function unit port.
 *
 * @return True if the terminal transports an opcode to a function unit port.
 * @exception WrongSubclass always.
*/
bool
Terminal::isOpcodeSetting() const {
    throw WrongSubclass(
        __FILE__, __LINE__, __func__,
        "Terminal must be TerminalFUPort for this method.");
}
 
/**
 * Tells whether terminal is a triggering FU port.
 *
 * @return True if the terminal is a triggering port.
 * @exception WrongSubclass always.
*/
bool
Terminal::isTriggering() const {
    throw WrongSubclass(
        __FILE__, __LINE__, __func__,
        "Terminal must be TerminalFUPort for this method.");
}
 
/**
 * Return the operation code transported into the function unit port by this
 * terminal.
 *
 * Throws an error condition if the terminal does not read from or write to
 * a function unit port (that is, if the terminal if of a wrong type). 
 * Throws an error condition also if the terminal does not access an
 * opcode-setting function unit port.
 *
 * @exception WrongSubclass If the terminal is of the wrong type.
 * @exception InvalidData If the terminal is of the right type, but it does
 *     not carry an operation-code.
 * @return The operation carried by this terminal.
 */
Operation&
Terminal::operation() const {
    throw WrongSubclass(
        __FILE__, __LINE__, __func__,
        "Terminal must be TerminalFUPort for this method.");
}
 
/**
 * Return the operation to which this terminal was originally bound.
 *
 * NOTE! : Method must not be used for checkin if terminal contains
 *         opcode. See. operation().
 *
 * Method is mainly used for preserving information to which operation
 * port reference is bound, during TPEF -> POM -> TPEF write cycles.
 *
 * @return The operation code to which terminal was originally bound.
 *         Null operation if terminal does not contain operation code.
 *
 * @todo This should be probably merged with operation() as "hints" are
 * not really useful, we should make sure the operation of the move is known.
 */
Operation&
Terminal::hintOperation() const {
    throw WrongSubclass(
        __FILE__, __LINE__, __func__,
        "Terminal must be TerminalFUPort for this method.");
}
 
/**
 * Return the index that identifies the operation input or output that
 * is represented by this terminal.
 *
 * Throws an error condition if the terminal does not read from or write to
 * a function unit port (that is, if the terminal if of a wrong type). 
 * Throws an error condition also if the terminal does not access an
 * opcode-setting function unit port, nor it bears auxiliary "hint
 * operation" information.
 *
 * @return The index that identifies the operation input or output that
 * is represented by this terminal.
 * @exception WrongSubclass If the terminal is of the wrong type.
 * @exception InvalidData If the terminal is of the right type, but does
 *     not have any operation-related information.
 */
int
Terminal::operationIndex() const {
    throw WrongSubclass(
        __FILE__, __LINE__, __func__,
        "Terminal must be TerminalFUPort for this method.");
}
 
/**
 * Return the port accessed by this terminal.
 *
 * @return The port of the unit of the terminal.
 * @exception WrongSubclass if the terminal is not an instance of
 *            TerminalFUPort or TerminalRegister.
 */
const Port&
Terminal::port() const {
    throw WrongSubclass(__FILE__, __LINE__);
}
 
/**
 * Change the register of the register file to the given index.
 *
 * @param index The new register index.
 * @exception OutOfRange if index is not smaller than the size of the
 *            register file or immediate unit it belongs to.
 * @exception WrongSubclass if the terminal is not an instance of
 *            TerminalRegister.
 */
void
Terminal::setIndex(int) {
    throw WrongSubclass(__FILE__, __LINE__);
}
 
/**
 * Set a new referred instruction.
 *
 * @param ref The new instruction reference.
 * @exception WrongSubclass if the terminal is not an instance of
 *            TerminalInstructionAddress
 */
void
Terminal::setInstructionReference(InstructionReference) {
    throw WrongSubclass(__FILE__, __LINE__);
}
 
/**
 * Comparison operator for Terminals.
 *
 * Delegates the comparison to dynamically bound equals() method.
 *
 * @param other Comparison target.
 * @return True in case the objects are equal.
 */
bool
Terminal::operator==(const Terminal& other) const {
    return equals(other);
}
 
}