testbench_generation.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/>.
 *
 */
#include "hls_step.hpp"
#include "refcount.hpp"

#include <string>
#include <vector>

class module;
CONSTREF_FORWARD_DECL(tree_manager);
REF_FORWARD_DECL(language_writer);
REF_FORWARD_DECL(memory);
REF_FORWARD_DECL(structural_object);

enum class TestbenchGeneration_MemoryType
{
   INPUT_PARAMETER,
   MEMORY_INITIALIZATION,
   OUTPUT_PARAMETER,
   RETURN
};

class TestbenchGeneration
#if(__GNUC__ == 4 && __GNUC_MINOR__ >= 7)
    final
#endif
    : public HLS_step
{
   const language_writerRef writer;

   structural_objectRef cir;

   const module* mod;

   const std::string output_directory;

   const std::string c_testbench_basename;

   std::string hdl_testbench_basename;

   bool printCacheStats(const module* rootMod) const;

   std::string write_verilator_testbench() const;

   const CustomUnorderedSet<std::tuple<HLSFlowStep_Type, HLSFlowStepSpecializationConstRef, HLSFlowStep_Relationship>>
   ComputeHLSRelationships(const DesignFlowStep::RelationshipType relationship_type) const override;

   void ComputeRelationships(DesignFlowStepSet& design_flow_step_set,
                             const DesignFlowStep::RelationshipType relationship_type) override;

 public:
   TestbenchGeneration(const ParameterConstRef parameters, const HLS_managerRef _HLSMgr,
                       const DesignFlowManagerConstRef design_flow_manager);

   void Initialize() override;

   bool HasToBeExecuted() const override;

   DesignFlowStep_Status Exec() override;

   static std::vector<std::string> print_var_init(const tree_managerConstRef TreeM, unsigned int var,
                                                  const memoryRef mem);

   static unsigned long long generate_init_file(const std::string& dat_filename, const tree_managerConstRef TreeM,
                                                unsigned int var, const memoryRef mem);
};