ConflictDetectionCodeGenerator.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 ConflictDetectionCodeGenerator.cc
 *
 * Definition of ConflictDetectionCodeGenerator class.
 *
 * @author Viljami Korhonen 2008 (viljami.korhonen-no.spam-tut.fi)
 * @note rating: red
 */
 
#include "ConflictDetectionCodeGenerator.hh"
#include "CompiledSimSymbolGenerator.hh"
#include "Application.hh"
#include "Machine.hh"
#include "FunctionUnit.hh"
#include "Operation.hh"
#include "Machine.hh"
#include "HWOperation.hh"
#include "Environment.hh"
 
#include <string>
#include <sstream>
 
using std::string;
using std::endl;
using namespace TTAMachine;
 
/**
 * The constructor.
 * 
 * Gets the conflict detection settings and initializes the generator
 * @param machine The machine model
 * 
 */
ConflictDetectionCodeGenerator::ConflictDetectionCodeGenerator(
    const TTAMachine::Machine& machine,
    const CompiledSimSymbolGenerator& symbolGenerator, 
    bool conflictDetectionEnabled) :
    machine_(machine), conflictDetectionEnabled_(conflictDetectionEnabled),
    symbolGen_(symbolGenerator) {
    
    if (!conflictDetectionEnabled) {
        return;
    }
    
    string conflictDetectionSetting;
    
    std::string SETTING = 
        Environment::environmentVariable("TTASIM_CONFLICT_DETECTOR");
    if (SETTING == "") {
        conflictDetectionSetting = "AFSA"; // by default
    } else {
        conflictDetectionSetting = SETTING;
    }
 
    if (conflictDetectionSetting == "CRT") {
        conflictDetectorType_ = "ReservationTableFUResourceConflictDetector";
        conflictDetectorMethod_ = "issueOperationInline";
        conflictDetectorAdvanceCycle_ = "advanceCycle";
        conflictDetectorExtraInitMethod_ = "";
    } else if (conflictDetectionSetting == "AFSA") {
        conflictDetectorType_ = "FSAFUResourceConflictDetector";
        conflictDetectorMethod_ = "issueOperationInline";
        conflictDetectorAdvanceCycle_ = "advanceCycle";
        conflictDetectorExtraInitMethod_ = "initializeAllStates";
    } else if (conflictDetectionSetting == "LFSA") {
        conflictDetectorType_ = "FSAFUResourceConflictDetector";
        conflictDetectorMethod_ = "issueOperationLazyInline";
        conflictDetectorAdvanceCycle_ = "advanceCycle";
        conflictDetectorExtraInitMethod_ = "";
    } else if (conflictDetectionSetting == "DCM") {
        conflictDetectorType_ = "DCMFUResourceConflictDetector";
        conflictDetectorMethod_ = "issueOperationInline";
        conflictDetectorAdvanceCycle_ = "advanceCycle";
        conflictDetectorExtraInitMethod_ = "";
    } else {
        Application::logStream()
            << "Unknown CONFLICT_DETECTION_SETTING: '"
            << conflictDetectionSetting << "'" << endl;
        conflictDetectionEnabled_ = false;
        return;
    }
 
    // initialize the detectors
    Application::logStream() 
        << "Using conflict detector " << conflictDetectorType_ << std::endl;
    
    const Machine::FunctionUnitNavigator& fus = 
        machine_.functionUnitNavigator();
    for (int i = 0; i < fus.count(); ++i) {
        const FunctionUnit& fu = *fus.item(i);
        if (!fu.needsConflictDetection()) { // no need for conflict detection?
            continue;
        } else {
            conflictDetectors_[fu.name()] =
                symbolGen_.conflictDetectorSymbol(fu);
        }
    }
    
    // No conflict detection is needed
    if (conflictDetectors_.empty()) {
        conflictDetectionEnabled_ = false;
    }
}
 
/**
 * The destructor
 */
ConflictDetectionCodeGenerator::~ConflictDetectionCodeGenerator() {
}
 
/**
 * Generates code for including the conflict detectors
 * @return The generated code for including the conflict detectors
 */
string
ConflictDetectionCodeGenerator::includes() {
    
    if (!conflictDetectionEnabled_)
        return "";
    
    std::stringstream ss;
    ss << "#include \"FSAFUResourceConflictDetector.hh\"" << endl << endl;
    return ss.str();
}
 
/**
 * Creates symbol declaration code for the given FU's conflict detectors
 * 
 * @param fu FU to create the conflict detector for
 * @return The generated symbol declaration code
 */
string 
ConflictDetectionCodeGenerator::symbolDeclaration(const FunctionUnit& fu) {
    
    if (!conflictDetectionEnabled_ || !fu.needsConflictDetection())
        return "";
 
    std::stringstream ss;
    ss << "\t" << conflictDetectorType_ << " " 
       << symbolGen_.conflictDetectorSymbol(fu) << ";" << endl;
 
    return ss.str();
}
 
/**
 * Generates exra initialization call for conflict detectors that require a one
 * 
 * @return The generated code for extra initialization call
 */
string 
ConflictDetectionCodeGenerator::extraInitialization() {
    std::stringstream ss;
    if (conflictDetectionEnabled_ && conflictDetectorExtraInitMethod_ != "") {
        for (ConflictDetectorObjectNameMap::const_iterator i = 
            conflictDetectors_.begin(); i != conflictDetectors_.end(); ++i) {
                ss << "\t" << i->second << "." 
                   << conflictDetectorExtraInitMethod_ << "();" << std::endl;
        }
    }
    return ss.str();
}
 
/**
 * Generates code for notifying of detected conflicts
 * 
 * @return Generated code for notifying of detected conflicts
 */
string
ConflictDetectionCodeGenerator::notifyOfConflicts() {
    
    if (!conflictDetectionEnabled_)
        return "";
    
    std::stringstream ss;
    ss << endl 
       << "\tif (conflictDetected_) {" << endl
       << "\thaltSimulation(__FILE__, __LINE__, __FUNCTION__,"
       << "\"Conflict detected!\");" << endl
       << "\t}" << endl;
    
    return ss.str();
}
 
/**
 * Generates code for notifying of detected conflicts
 * 
 * @return Generated code for notifying of detected conflicts
 */
string
ConflictDetectionCodeGenerator::updateSymbolDeclarations() {
    if (!conflictDetectionEnabled_)
        return "";
    
    std::stringstream ss;
 
    for (ConflictDetectorObjectNameMap::const_iterator i = 
        conflictDetectors_.begin(); i != conflictDetectors_.end(); ++i) {
    ss << "\t," << i->second
       << "(functionUnit(\"" << i->first << "\"))"
       << endl;
    }
    return ss.str();
}
 
/**
 * Generates code for a function that advances clocks of each conflict detector
 * 
 * @return A std::string containing generated code for the clock advances
 */
string
ConflictDetectionCodeGenerator::advanceClockCode() {
    
    if (!conflictDetectionEnabled_)
        return "";
 
    std::stringstream ss;
    // advance clock of all conflict detection models
    for (ConflictDetectorObjectNameMap::const_iterator i = 
        conflictDetectors_.begin(); i != conflictDetectors_.end(); ++i) {
        ss << "\t" << (*i).second << "." 
           << conflictDetectorAdvanceCycle_ << "();" << endl;
    }
    
    return ss.str();
}
 
/**
 * Generates code for detecting an FU pipeline resource conflicts.
 * 
 * @param op the triggered operation
 * @return A std::string containing generated code for the operation call
 */
string
ConflictDetectionCodeGenerator::detectConflicts(
    const TTAMachine::HWOperation& op) {
 
    if (!conflictDetectionEnabled_)
        return "";
 
    const TTAMachine::FunctionUnit& fu = *op.parentUnit();
 
    if (conflictDetectors_.find(fu.name()) == conflictDetectors_.end()) 
        return ""; // no conflict detection for the FU of the given operation
 
    int operationID = -1;
    for (int i = 0; i < fu.operationCount(); ++i) {
        if (fu.operation(i)->name() == op.name()) {
            operationID = i;
            break;
        }
    }
    std::stringstream ss;
    std::string detector = conflictDetectors_[fu.name()];
    ss << "engine.conflictDetected_ |= !engine." << detector << "." 
       << conflictDetectorMethod_ << "(" << operationID << ");" << endl;
    return ss.str();
}
 
/**
 * Returns a boolean describing if the conflict detection is enabled or not
 * 
 * @return True if the conflict detection is enabled
 */
bool 
ConflictDetectionCodeGenerator::conflictDetectionEnabled() const {
    return conflictDetectionEnabled_;
}