CompiledSimCompiler.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 CompiledSimCompiler.cc
 *
 * Definition of CompiledSimCompiler class.
 *
 * @author Viljami Korhonen 2007 (viljami.korhonen-no.spam-tut.fi)
 * @note rating: red
 */
 
#include <boost/format.hpp>
#include <ctime>
#include <cstdlib>
 
#include "CompiledSimCompiler.hh"
#include "Conversion.hh"
#include "tce_config.h"
#include "Application.hh"
#include "Environment.hh"
#include "FileSystem.hh"
 
using std::string;
using std::endl;
using std::vector;
using std::time_t;
 
 
// Initialize statics
 
// the most important one is "fno-working-directory" which is used because 
// c5Bcache doesn't like changing directory paths. Rest is just minor tweaks.
const char* CompiledSimCompiler::COMPILED_SIM_CPP_FLAGS = " -fpic -std=c++11 "
#ifndef __clang__
// not supported (yet) in Clang 3.4
    " -fno-working-directory "
    "-fno-enforce-eh-specs "
#endif
    "-fno-rtti -DNDEBUG ";
//     "-fno-rtti "
//     "-fno-threadsafe-statics "
//     "-fvisibility=hidden "
//     "-fvisibility-inlines-hidden ";
 
// this was not recognized on Ubuntu 6.06's gcc:
//    "-fno-stack-protector "
 
// Flags when compiling shared libraries
#ifdef __APPLE__
const char* CompiledSimCompiler::COMPILED_SIM_SO_FLAGS = SHARED_CXX_FLAGS;
#else
const char* CompiledSimCompiler::COMPILED_SIM_SO_FLAGS = " -shared -fpic ";
#endif
 
/**
 * The constructor
 */
CompiledSimCompiler::CompiledSimCompiler() {
    
    // Get number of threads
    threadCount_ = 3;
    std::string USER_THREAD_COUNT = 
        Environment::environmentVariable("TTASIM_COMPILER_THREADS");
    if (USER_THREAD_COUNT != "") {
        threadCount_ = Conversion::toInt(string(USER_THREAD_COUNT));
    }
    
    // Get compiler
    compiler_ = "g++";
    std::string USER_COMPILER = 
        Environment::environmentVariable("TTASIM_COMPILER");
    if (USER_COMPILER != "") {
        compiler_ = string(USER_COMPILER);
    }
    
    // Get global compile flags
    globalCompileFlags_ = " -O0 ";
    std::string fl = 
        Environment::environmentVariable("TTASIM_COMPILER_FLAGS");
    if (fl != "")
        globalCompileFlags_ = std::string(fl);
}
 
/**
 * The destructor
 */
CompiledSimCompiler::~CompiledSimCompiler() {
}
    
/**
 * Compiles a directory with given flags using a pre-generated makefile
 * 
 * In case environment variable TTASIM_COMPILER is set, it is used
 * to compile the simulation code, otherwise 'gcc' is used. The
 * count of compiler threads is read from TTASIM_COMPILER_THREADS,
 * and defaults to 3.
 *
 * @param dirName a source directory containing the .cpp files and the Makefile
 * @param flags additional compile flags given by the user. for instance, "-O3"
 * @param verbose Print information of the compilation progress.
 * @return Return value given by system(). 0 on success. !=0 on failure
 */
int
CompiledSimCompiler::compileDirectory(
    const string& dirName,
    const string& flags,
    bool verbose) const {
 
    string command = 
        "make -sC " + dirName + " CC=\"" + compiler_ + "\" opt_flags=\"" +
        globalCompileFlags_ + " " + flags + " \" -j" +
        Conversion::toString(threadCount_);
 
    if (verbose) {
        Application::logStream()
            << "Compiling the simulation engine with command " 
            << command << endl;
    }
 
    time_t startTime = std::time(NULL);
    int retval = system(command.c_str());
    time_t endTime = std::time(NULL);
 
    time_t elapsed = endTime - startTime;
 
    if (verbose) {
        Application::logStream()
            << "Compiling the simulation engine with opt. switches '"
            << globalCompileFlags_ << " " << flags 
            << "' took " << elapsed / 60 << "m " << (elapsed % 60) << "s " 
            << endl;
    }
 
    return retval;
}
 
/**
 * Compiles a single C++ file using the set flags
 * 
 * @param path Path to the file
 * @param flags custom flags to be used for compiling
 * @param outputExtension extension to append to the filename. default is ".o"
 * @param verbose Print information of the compilation progress.
 * @return Return value given by system() call. 0 on success. !=0 on failure
 */
int
CompiledSimCompiler::compileFile(
    const std::string& path,
    const string& flags,
    const string& outputExtension,
    bool verbose) const {
 
    std::string directory = FileSystem::directoryOfPath(path);
    std::string fileNameBody = FileSystem::fileNameBody(path);
    std::string fileName = FileSystem::fileOfPath(path);   
    std::string DS = FileSystem::DIRECTORY_SEPARATOR;
    
    // Get includes
    vector<string> includePaths = Environment::includeDirPaths();
    string includes;
    for (vector<string>::const_iterator it = includePaths.begin(); 
        it != includePaths.end(); ++it) {
        includes += "-I" + *it + " ";
    }
 
    if (verbose) {
        Application::logStream() << "Compiling simulation file " 
            << path << endl;
    }
    
    string command = compiler_ + " " + includes + COMPILED_SIM_CPP_FLAGS
        + globalCompileFlags_ + " " + flags + " " 
        + path + " -o " + directory + DS + fileNameBody + outputExtension;
    
    return system(command.c_str());
}
 
/**
 * Compiles a single C++ file to a shared library (.so)
 * 
 * Used for generating .so files in dynamic compiled simulation
 * 
 * @param path Path to the file
 * @param flags custom flags to be used for compiling
 * @param verbose Print information of the compilation progress.
 * @return Return value given by system() call. 0 on success. !=0 on failure
 */
int
CompiledSimCompiler::compileToSO(
    const std::string& path,
    const string& flags,
    bool verbose) const {
 
    return compileFile(path, COMPILED_SIM_SO_FLAGS + flags, ".so", verbose);
}