ModuleGenerator.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) 2022-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 _MODULE_GENERATOR_FACTORY_HPP_
#define _MODULE_GENERATOR_FACTORY_HPP_

#include "Factory.hpp"
#include "graph.hpp"
#include "refcount.hpp"

#include <functional>
#include <iostream>
#include <string>
#include <vector>

class module;
enum class HDLWriter_Language;
REF_FORWARD_DECL(HLS_manager);
REF_FORWARD_DECL(structural_object);

class ModuleGenerator : public Factory<ModuleGenerator, const HLS_managerRef&>
{
 public:
   struct parameter
   {
      std::string name;
      std::string type;
      unsigned long long type_size;
      unsigned long long alignment;

      parameter() = default;
      parameter(const structural_objectRef& port);
   };

 protected:
   const HLS_managerRef HLSMgr;

   ModuleGenerator(Key, const HLS_managerRef& _HLSMgr) : HLSMgr(_HLSMgr)
   {
   }

   virtual void InternalExec(std::ostream& out, structural_objectRef mod, unsigned int function_id, vertex op_v,
                             const HDLWriter_Language language, const std::vector<parameter>& _p,
                             const std::vector<parameter>& _ports_in, const std::vector<parameter>& _ports_out,
                             const std::vector<parameter>& _ports_inout) = 0;

 public:
   virtual ~ModuleGenerator() = default;

   void Exec(std::ostream& out, structural_objectRef mod, unsigned int function_id, vertex op_v,
             const std::vector<parameter>& _p, const HDLWriter_Language language);
};

#endif