OperationContext.cc

Go to the documentation of this file.

/*
    Copyright (c) 2002-2020 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 OperationContext.cc
 *
 * Non-inline definitions of OperationContext class.
 *
 * @author Pekka Jääskeläinen 2004 (pekka.jaaskelainen-no.spam-tut.fi)
 * @note rating: yellow
 * @note reviewed 7 September 2004 by pj, jn, jm, ao
 */
 
#include <string>
 
#include "OperationContext.hh"
#include "Application.hh"
#include "Memory.hh"
#include "OperationState.hh"
#include "SimValue.hh"
#include "OperationContextPimpl.hh"
 
using std::string;
 
/**
 * Constructor for contexts suitable for basic operations.
 */
OperationContext::OperationContext() : pimpl_(new OperationContextPimpl(DEFAULT_FU_NAME)) {
}
 
/**
 * Constructor for basic operations in simulation -- FU name passed.
 */
OperationContext::OperationContext(const TCEString& name) : pimpl_(new OperationContextPimpl(name)) {
}
 
/**
 * Constructor for contexts suitable for any kinds of operations.
 *
 * @param memory The memory model instance.
 * @param programCounter The program counter register.
 * @param returnAddress The return address register.
 *
 */
OperationContext::OperationContext(
    Memory* memory,
    InstructionAddress& programCounter,
    SimValue& returnAddress,
    int delayCycles) :
    pimpl_(new OperationContextPimpl(
               DEFAULT_FU_NAME, memory, programCounter,
               returnAddress, delayCycles)) {
}
 
/**
 * A copy constructor that performs a deep copy for the pimpl_
 * 
 * @param context OperationContext
 */
OperationContext::OperationContext(const OperationContext& context) : 
    pimpl_(new OperationContextPimpl(*context.pimpl_)) {
}
 
/**
 * Destructor. Deletes the pimpl object
 */
OperationContext::~OperationContext() {
    delete pimpl_;
    pimpl_ = NULL;
}
 
/**
 * Looks up the (concrete) operation state identified by the string name.
 *
 * @param name The state identifier.
 * @return The found operation state instance.
 * @exception KeyNotFound If state by name couldn't be found.
 */
OperationState&
OperationContext::state(const char* name) const {
    return pimpl_->state(name);
}
 
/**
 * Advances the internal clock of each registered operation state object.
 */
void 
OperationContext::advanceClock() {
    pimpl_->advanceClock(*this);
}
 
/**
 * Registers the operation state for given name.
 *
 * Called in the createState() of the custom OperationBehavior classes.
 * If state with given identifier is already found in the context, program
 * is aborted. This method is only for internal use. Used by the macro 
 * definitions of OSAL.hh.
 *
 * @param name The identifier for the registered state instance.
 * @param stateToRegister The state instance.
 */
void 
OperationContext::registerState(OperationState* stateToRegister) {
    pimpl_->registerState(stateToRegister);
}
 
/**
 * Unregisters the operation state of given name.
 *
 * This method is only for internal use. Used by the macro 
 * definitions of OSAL.hh.
 *
 * Called in deleteState() of the custom OperationBehavior classes.
 * Aborts if there's no state with given identifier in the context.
 */    
void 
OperationContext::unregisterState(const char* name) {
    pimpl_->unregisterState(name);
}
 
/**
 * Returns a reference to the current value of the program counter register.
 *
 * The value of the program counter can be changed through this reference. 
 * This is used to implement control transfer operations like jumps and calls 
 * to subroutines. 
 *
 * @return The program counter value as a reference.
 */
InstructionAddress& 
OperationContext::programCounter() {
    return pimpl_->programCounter();
}
 
const InstructionAddress&
OperationContext::programCounter() const {
    return pimpl_->programCounter();
}
 
void
OperationContext::setUpdateProgramCounter(bool value) {
    pimpl_->setUpdateProgramCounter(value);
}
 
 
 
bool
OperationContext::updateProgramCounter() const {
    return pimpl_->updateProgramCounter();
}
 
 
/**
 * Makes the return address to be saved in the RA register.
 *
 * This is used by CALL instruction to save the RA before jumping.
 *
 * @param value Value to set to.
 * @return The return address value as a reference.
 */
void 
OperationContext::setSaveReturnAddress(bool value) {
    pimpl_->setSaveReturnAddress(value);
}   
 
/**
 * Returns true if RA should saved before executing next control flow 
 * operation.
 *
 * @return The return address value as a reference.
 */
bool 
OperationContext::saveReturnAddress() {
    return pimpl_->saveReturnAddress();
}  
 
/**
 * Returns a reference to the current value of the return address register.
 *
 * The value of the return address can be changed through this reference. 
 * This is used in implementing calls to subroutines.
 *
 * @return The return address value as a reference.
 */
SimValue& 
OperationContext::returnAddress() {
    return pimpl_->returnAddress();
} 
 
const SimValue&
OperationContext::returnAddress() const {
    return pimpl_->returnAddress();
}
 
/**
 * Returns true if there are no operation state objects stored in the
 * context.
 *
 * @return True if there are no operation state objects stored in the
 * context.
 */
bool 
OperationContext::isEmpty() const {
    return pimpl_->isEmpty();
}
        
        
/**
 * Sets the reference to a Memory Module instance.
 *
 * This instance can be accessed by the function unit and behavior 
 * simulation methods to simulate memory access.
 *
 * @param memory The Memory instance.
 */
void
OperationContext::setMemory(Memory* memory) {
    pimpl_->setMemory(memory);
}
 
/**
 * Returns a reference to a Memory Module wrapper instance.
 *
 * This instance can be accessed by the function unit and behavior 
 * simulation methods to simulate memory access.
 *
 * @return The Memory instance.
 */
Memory& 
OperationContext::memory() {
    return pimpl_->memory();
}
 
const Memory&
OperationContext::memory() const {
    return pimpl_->memory();
}
 
/**
 * Returns the unique id of the OperationContext instance.
 *
 * @return The unique id for the OperationContext instance.
 */
int 
OperationContext::contextId() const {
    return pimpl_->contextId();
}
 
/**
 * Returns the FU name of the OperationContext instance.
 *
 * @return The FU name for the OperationContext instance.
 */
const TCEString& 
OperationContext::functionUnitName() const {
    return pimpl_->functionUnitName();
}
 
/**
 * Returns the elapsed time since the beginning of simulation.
 *
 * Can be used to implement real time timer operations, etc. Uses
 * the simulator's cycle count, if available, otherwise uses internal
 * cycle counter that is incremented with the advanceClock();
 */
CycleCount
OperationContext::cycleCount() const {
    return pimpl_->cycleCount(); 
}
 
/**
 * Sets the variable that contains the current simulation cycle count
 * at the best possible accuracy. 
 *
 * Used by real time operations to track simulation time during
 * simulations.
 */
void 
OperationContext::setCycleCountVariable(CycleCount& cycleCount) {
    pimpl_->setCycleCountVariable(cycleCount);
}
 
/**
 * Returns the amount of pipeline delay cycles.
 */
int
OperationContext::branchDelayCycles() const {
    return pimpl_->branchDelayCycles(); 
}
 
void
OperationContext::setStateRegistry(StateRegistry& stateRegistry) {
    pimpl_->setStateRegistry(stateRegistry);
}
 
void
OperationContext::unsetStateRegistry() {
    pimpl_->unsetStateRegistry();
}
 
OperationContext::StateRegistry&
OperationContext::stateRegistry() {
    return pimpl_->stateRegistry();
}