SimulationTool.hpp

Go to the documentation of this file.

/*
 *
 *                   _/_/_/    _/_/   _/    _/ _/_/_/    _/_/
 *                  _/   _/ _/    _/ _/_/  _/ _/   _/ _/    _/
 *                 _/_/_/  _/_/_/_/ _/  _/_/ _/   _/ _/_/_/_/
 *                _/      _/    _/ _/    _/ _/   _/ _/    _/
 *               _/      _/    _/ _/    _/ _/_/_/  _/    _/
 *
 *             ***********************************************
 *                              PandA Project
 *                     URL: http://panda.dei.polimi.it
 *                       Politecnico di Milano - DEIB
 *                        System Architectures Group
 *             ***********************************************
 *              Copyright (C) 2004-2024 Politecnico di Milano
 *
 *   This file is part of the PandA framework.
 *
 *   The PandA framework is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
#ifndef _SIMULATION_TOOL_HPP_
#define _SIMULATION_TOOL_HPP_

#include "refcount.hpp"

#include <list>
#include <string>
#include <vector>

CONSTREF_FORWARD_DECL(Parameter);
REF_FORWARD_DECL(SimulationTool);
class SimulationTool
{
 public:
   using type_t = enum { UNKNOWN = 0, MODELSIM, XSIM, VERILATOR };

   static type_t to_sim_type(const std::string& str);

 protected:
   const ParameterConstRef Param;

   int debug_level;

   unsigned int output_level;

   const std::string top_fname;

   std::string generated_script;

   std::string log_file;

   const std::string inc_dirs;

   virtual std::string GenerateScript(std::ostream& script, const std::string& top_filename,
                                      const std::list<std::string>& file_list) = 0;

   std::string GenerateLibraryBuildScript(std::ostream& script, const std::string& libtb_filename,
                                          std::string& beh_cflags) const;

 public:
   explicit SimulationTool(const ParameterConstRef& Param, const std::string& top_fname, const std::string& inc_dirs);

   virtual ~SimulationTool();

   static SimulationToolRef CreateSimulationTool(type_t type, const ParameterConstRef& Param, const std::string& suffix,
                                                 const std::string& top_fname, const std::string& inc_dirs);

   virtual void CheckExecution();

   virtual std::string GenerateSimulationScript(const std::string& top_filename, std::list<std::string> file_list);

   virtual void Simulate(unsigned long long& accum_cycles, unsigned long long& n_testcases);

   void DetermineCycles(unsigned long long int& accum_cycles, unsigned long long& n_testcases);

   virtual void Clean() const;
};
using SimulationToolRef = refcount<SimulationTool>;
#endif