TestApplication.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2012 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 TestApplication.hh
 *
 * Declaration of TestApplication class.
 *
 * @author Jari Mäntyneva 2007 (jari.mantyneva-no.spam-tut.fi)
 * @author Pekka Jääskeläinen 2012, 2025
 * @note rating: red
 */
 
#ifndef TTA_TEST_APPLICATION_HH
#define TTA_TEST_APPLICATION_HH
 
#include <sstream>
#include <string>
#include <vector>
 
#include "Exception.hh"
#include "TCEString.hh"
 
/**
 * Class for handling files in test application directory.
 */
class TestApplication {
public:
    typedef double Runtime;
    typedef int ClockCycles;
 
    TestApplication(const std::string& testApplicationPath);
    virtual ~TestApplication();
 
    std::vector<std::string> description() const;
 
    bool hasApplication() const;
    bool hasSetupSimulation() const;
    bool hasSimulateTTASim() const;
    bool hasCorrectOutput() const;
    bool hasVerifySimulation() const;
    bool hasCleanupSimulation() const;
    bool hasFunctionsOfInterest() const;
    bool isValid() const { 
        return hasApplication() && 
            (hasCorrectOutput() || hasVerifySimulation());
    }
 
    const std::string applicationPath() const;
    void setupSimulation() const;
    std::istream* simulateTTASim() const;
    const std::string correctOutput() const;
    bool verifySimulation() const;
    void cleanupSimulation() const;
    ClockCycles cycleCount() const;
    Runtime maxRuntime() const;
    const std::vector<TCEString>&
    functionsOfInterest() const {
        return functionsOfInterest_;
    }
 
private:
    /// Path of the test application directory.
    const std::string testApplicationPath_;
    /// Maximum runtime of the test appication in nano seconds
    Runtime maxRuntime_;
    /// The names of the functions of interest (in terms of cycle count).
    std::vector<TCEString> functionsOfInterest_;
 
    /// File name of the description text for the application.
    static const std::string DESCRIPTION_FILE_NAME_;
    /// Name of the sequential program file.
    /// Base name of the file that contains the fully linked program.
    /// The actual file name will be formed by appending either .bc or .ll,
    /// whichever is found first.
    static const std::string APPLICATION_BASE_FILE_NAME_;
    /// Name of the file that contains setup script.
    static const std::string SETUP_FILE_NAME_;
    /// Name of the file that runs the simulation.
    static const std::string SIMULATE_TTASIM_FILE_NAME_;
    /// Name of the correct simulation output file.
    static const std::string CORRECT_OUTPUT_FILE_NAME_;
    /// Name of the verify script file.
    static const std::string VERIFY_FILE_NAME_;
    /// Name of the clean up file.
    static const std::string CLEANUP_FILE_NAME_;
    /// Name of the file that has a comma separated list of functions of
    /// interest for the cycle count measurements in the given app.
    /// The exclusive profile of these functions will be used as the
    /// cycle count in evaluation.
    static const std::string FUNCTIONS_OF_INTEREST_FILE_NAME_;
    /// Name of the file that contains maximum runtime.
    static const std::string MAX_RUNTIME_;
    /// Maximum line length in a file.
    static const int MAX_LINE_LENGTH_;
};
 
 
 
 
#endif