CompiledSimController.cc

Go to the documentation of this file.

/*
    Copyright (c) 2002-2010 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 CompiledSimController.cc
 *
 * Definition of CompiledSimController class.
 *
 * @author Viljami Korhonen 2007 (viljami.korhonen-no.spam-tut.fi)
 * @author Pekka Jääskeläinen 2010
 * @note rating: red
 */
 
#include <cstdlib>
 
#include "SimulatorFrontend.hh"
#include "CompiledSimController.hh"
#include "CompiledSimCodeGenerator.hh"
#include "CompiledSimCompiler.hh"
#include "FileSystem.hh"
#include "MemorySystem.hh"
#include "SimulatorToolbox.hh"
#include "CompiledSimulation.hh"
#include "POMValidator.hh"
#include "POMValidatorResults.hh"
#include "Instruction.hh"
#include "MathTools.hh"
#include "Program.hh"
#include "SimulationEventHandler.hh"
#include "Conversion.hh"
#include "Machine.hh"
 
using std::endl;
using namespace TTAMachine;
 
//#define DEBUG_COMPILED_SIMULATION
 
/**
 * The constructor
 * 
 * @param frontend Simulator frontend
 * @param machine The machine model
 * @param program The program to be simulated
 * @param leaveDirty Set to true in case the engine should not clean up the
 *                   source files to the engine (in /tmp) after finishing,
 *                   e.g., for debugging purposes.
 */
CompiledSimController::CompiledSimController(
    SimulatorFrontend& frontend, const TTAMachine::Machine& machine, 
    const TTAProgram::Program& program, bool leaveDirty) : 
    TTASimulationController(frontend, machine, program),
    pluginTools_(true, false), compiledSimulationPath_(""), 
    leaveDirty_(leaveDirty) {
 
#ifdef DEBUG_COMPILED_SIMULATION
    leaveDirty_ = true;
#endif
 
    // Make the symbols unique in case we use more than one
    // simulator engines in the same process.
    static int instanceCount = 0;
    instanceId_ = instanceCount;
 
    // Note, this is not thread safe. Thus, the engines should be
    // initialized sequentially.
    ++instanceCount;
 
    reset();
}
 
/**
 * The destructor
 */
CompiledSimController::~CompiledSimController() {
    deleteGeneratedFiles();
}
 
/**
 * Advances simulation by given amount of cycles
 * 
 * @Note The accuracy of this function is one basic block!
 */
void
CompiledSimController::step(double count) {
    assert(state_ == STA_STOPPED || state_ == STA_INITIALIZED);
    stopReasons_.clear();
    state_ = STA_RUNNING;
    stopRequested_ = false;
    
    try {
        simulation_->step(count);
    }  catch (const Exception& e) {
        prepareToStop(SRE_RUNTIME_ERROR);
        return;
    } catch(...) {
        prepareToStop(SRE_RUNTIME_ERROR);
        return;
    }
    
    prepareToStop(SRE_AFTER_STEPPING);
 
    if (simulation_->isFinished()) { 
        state_ = STA_FINISHED;
    } else {
        state_ = STA_STOPPED;
    }
 
    frontend_.eventHandler().handleEvent(
        SimulationEventHandler::SE_SIMULATION_STOPPED);
}
 
/**
 * Advances simulation by a given amout of steps and skip procedure calls.,
 * 
 * @Note The accuracy of this function is one basic block!
 */
void
CompiledSimController::next(int count) {
    assert(state_ == STA_STOPPED || state_ == STA_INITIALIZED);
    stopReasons_.clear();
    state_ = STA_RUNNING;
    stopRequested_ = false;
    
    try {
        simulation_->next(count);
    } catch (const Exception& e) {
        prepareToStop(SRE_RUNTIME_ERROR);
        return;
    }  catch(...) {
        prepareToStop(SRE_RUNTIME_ERROR);
        return;
    }
    
    prepareToStop(SRE_AFTER_STEPPING);
 
    if (simulation_->isFinished()) { 
        state_ = STA_FINISHED;
    } else {
        state_ = STA_STOPPED;
    }
 
    frontend_.eventHandler().handleEvent(
        SimulationEventHandler::SE_SIMULATION_STOPPED);
}
 
/**
 * Advances the simulation until the program ends
 * 
 * @exception SimulationExecutionError If a runtime error occurs in 
 *                                     the simulated program.
 */
void
CompiledSimController::run() {
    stopRequested_ = false;
    stopReasons_.clear();
    state_ = STA_RUNNING;
    
    // Run the program
    try {
        simulation_->run();
    } catch (const Exception& e) {
        prepareToStop(SRE_RUNTIME_ERROR);
        return;
    }  catch(...) {
        prepareToStop(SRE_RUNTIME_ERROR);
        return;
    }
 
    if (simulation_->isFinished()) { 
        state_ = STA_FINISHED;
    } else {
        state_ = STA_STOPPED;
    }
 
    frontend_.eventHandler().handleEvent(
        SimulationEventHandler::SE_SIMULATION_STOPPED);
}
 
/**
 * Advances the simulation until a given address is reached.
 * 
 * @Note The accuracy of this function is one basic block!
 * 
 * @param address the address after the simulation execution should end
 * @exception SimulationExecutionError If a runtime error occurs in 
 *                                     the simulated program.
 */
void
CompiledSimController::runUntil(UIntWord address) {
    stopRequested_ = false;
    stopReasons_.clear();
    state_ = STA_RUNNING;
    address = basicBlockStart(address); // find nearest bb start
    
    try {
        simulation_->runUntil(address);
    } catch (const Exception& e) {
        prepareToStop(SRE_RUNTIME_ERROR);
        return;
    }  catch(...) {
        prepareToStop(SRE_RUNTIME_ERROR);
        return;
    }
    
    prepareToStop(SRE_AFTER_UNTIL);
 
    if (simulation_->isFinished()) { 
        state_ = STA_FINISHED;
    } else {
        state_ = STA_STOPPED;
    }
 
    frontend_.eventHandler().handleEvent(
        SimulationEventHandler::SE_SIMULATION_STOPPED);
}
 
/**
 * Resets the simulation so it can be started from the beginning.
 *
 * Resets everything to initial values (program counter, clock cycles etc.)
 */
void 
CompiledSimController::reset() {
    
    state_ = STA_INITIALIZING;
    stopRequested_ = false;
    clockCount_ = 0;
    
    deleteGeneratedFiles();
        
    compiledSimulationPath_ = FileSystem::createTempDirectory();
    if (compiledSimulationPath_ == "") {
        Application::logStream() 
            << "Cannot create temporary path "
            << "for the generated simulation code!" << endl;
        return;
    }
 
    // Generate all simulation code at once
    CompiledSimCodeGenerator generator(
        sourceMachine_, program_, *this,
        frontend_.fuResourceConflictDetection(),
        frontend_.executionTracing() || frontend_.procedureTransferTracing(),
        !frontend_.staticCompilation(), 
        false, !frontend_.staticCompilation(),
        Conversion::toString(instanceId_));
 
    CATCH_ANY(generator.generateToDirectory(compiledSimulationPath_));
#ifdef DEBUG_COMPILED_SIMULATION
    std::cerr << "Generated compiled simulation sources to: '"
              << compiledSimulationPath_ << "'" << std::endl;
#endif
    basicBlocks_ = generator.basicBlocks();
    procedureBBRelations_ = generator.procedureBBRelations();
 
    CompiledSimCompiler compiler;
    
    // Compile everything when using static compiled simulation
    if (frontend_.staticCompilation()) {
        if (compiler.compileDirectory(compiledSimulationPath_, "", false) 
            != 0) {
            Application::logStream() << "Compilation aborted." << endl;
            return;
        }
    } else { // Compile main engine file
        compiler.compileToSO(compiledSimulationPath_ 
            + FileSystem::DIRECTORY_SEPARATOR + "CompiledSimulationEngine.cc");
        
        // Precompile the simulation header
        compiler.compileFile(compiledSimulationPath_ 
            + FileSystem::DIRECTORY_SEPARATOR + "CompiledSimulationEngine.hh", 
            "-xc++-header", ".gch");
    }
 
    SimulationGetterFunction* simulationGetter = NULL;
    pluginTools_.addSearchPath(compiledSimulationPath_);
 
    // register individual simulation functions
    std::vector<std::string> sos;
    FileSystem::globPath(compiledSimulationPath_ + "/simulate_*.so", sos);
    for (std::size_t i = 0; i < sos.size(); ++i) {
        const std::string& so = FileSystem::fileOfPath(sos.at(i));
        pluginTools_.registerModule(so);
    }
 
    // register simulation getter function symbol
    pluginTools_.registerModule("CompiledSimulationEngine.so");
    pluginTools_.importSymbol(
         "getSimulation_" + Conversion::toString(instanceId_), simulationGetter);
    simulation_.reset(
        simulationGetter(sourceMachine_, program_.entryAddress().location(),
            program_.lastInstruction().address().location(), 
            frontend_, *this, memorySystem(0), !frontend_.staticCompilation(), 
            procedureBBRelations_));
    
    state_ = STA_INITIALIZED;
}
 
/**
 * Returns the program counter value.
 *
 * @return Program counter value.
 */
InstructionAddress
CompiledSimController::programCounter() const {
    return simulation_->programCounter();
}
 
/**
 * Returns the address of the last executed instruction.
 * 
 * @return The address of the last executed instruction
 */
InstructionAddress
CompiledSimController::lastExecutedInstruction() const {
    return simulation_->lastExecutedInstruction();
}
 
/**
 * Returns the count of clock cycles simulated.
 *
 * @return Count of simulated clock cycles.
 */
ClockCycleCount
CompiledSimController::clockCount() const {
    if (simulation_) {
        return simulation_->cycleCount();
    } else {
        return 0;
    }
}
 
/**
 * Returns a pointer to the current CompiledSimulation object
 * 
 * @return A pointer to the current CompiledSimulation object
 */
boost::shared_ptr<CompiledSimulation> 
CompiledSimController::compiledSimulation() {
    return simulation_;
}
 
/**
 * Will delete all generated code files if leaveDirty_ is not set
 */
void 
CompiledSimController::deleteGeneratedFiles() {
    if (leaveDirty_) {
        return;
    }
    
    if (FileSystem::fileExists(compiledSimulationPath_) 
        && compiledSimulationPath_ != "") {
        FileSystem::removeFileOrDirectory(compiledSimulationPath_);
    }
}
 
/**
 * Returns the start of the basic block containing address
 * 
 * @param address
 * @return instruction address of the basic block start
 */
InstructionAddress 
CompiledSimController::basicBlockStart(InstructionAddress address) const {
    return basicBlocks_.lower_bound(address)->second;
}
 
/**
 * Returns the program model
 * @return the program model
 */
const TTAProgram::Program&
CompiledSimController::program() const {
    return program_;
}
       
/**
 * Returns a string containing the value(s) of the register file
 * 
 * @param rfName name of the register file to search for
 * @param registerIndex index of the register. if -1, all registers are listed
 * @return A string containing the value(s) of the register file
 * @exception InstanceNotFound If the register cannot be found.
 */
std::string 
CompiledSimController::registerFileValue(
    const std::string& rfName, int registerIndex) {
    std::string stringValue("");
 
    if (registerIndex >= 0) {
        stringValue += compiledSimulation()->
            registerFileValue(rfName.c_str(), registerIndex).hexValue();
    } else {
        Machine::RegisterFileNavigator navigator = 
            sourceMachine_.registerFileNavigator();
        RegisterFile& rf = *navigator.item(rfName);
        
        bool firstReg = true;
        for (int i = 0; i < rf.numberOfRegisters(); ++i) {
            if (!firstReg) 
                stringValue += "\n";
            const std::string registerName = 
                rfName + "." + Conversion::toString(i);
 
            SimValue value = compiledSimulation()->
                registerFileValue(rfName.c_str(), i);
            stringValue += registerName + " " + value.hexValue();
 
            firstReg = false;
        }
    }
    
    return stringValue;
}
 
/**
 * Returns the current value of a IU register
 * 
 * @param iuName name of the immediate unit
 * @param index index of the register
 * @return Current value of a IU register
 */
SimValue
CompiledSimController::immediateUnitRegisterValue(
    const std::string& iuName, 
    int index) {
    return compiledSimulation()->immediateUnitRegisterValue(iuName.c_str(),
        index);
}
 
/**
 * Returns a FU port's value
 * 
 * @param fuName name of the function unit
 * @param portIndex Index of the port
 * @return A FU port's value
 */
SimValue 
CompiledSimController::FUPortValue(
    const std::string& fuName, 
    const std::string& portName) {
    return compiledSimulation()->FUPortValue(fuName.c_str(), portName.c_str());
}
 
/**
 * Sends a stop request to the simulation controller and compiled simulation
 * 
 * @param reason The stop reason
 */
void
CompiledSimController::prepareToStop(StopReason reason) {
    TTASimulationController::prepareToStop(reason);
    compiledSimulation()->requestToStop();
}