hls_manager.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 HLS_MANAGER_HPP
#define HLS_MANAGER_HPP

#include "application_manager.hpp"
#include "custom_map.hpp"

#include "config_HAVE_TASTE.hpp"

#include <boost/preprocessor/seq/for_each.hpp>

#include <map>
#include <string>

REF_FORWARD_DECL(AadlInformation);
REF_FORWARD_DECL(hls);
REF_FORWARD_DECL(HLS_device);
REF_FORWARD_DECL(HLS_manager);
REF_FORWARD_DECL(functions);
REF_FORWARD_DECL(memory);
REF_FORWARD_DECL(SimulationInformation);
REF_FORWARD_DECL(BackendFlow);

#define ENUM_ID(r, data, elem) elem,
#define FUNC_ARCH_ATTR_ENUM (func_symbol)(func_name)(func_inline)(func_dataflow)(func_pipeline_style)(func_pipeline_ii)
#define FUNC_ARCH_PARM_ATTR_ENUM                                                                            \
   (parm_port)(parm_index)(parm_bundle)(parm_offset)(parm_includes)(parm_typename)(parm_original_typename)( \
       parm_elem_count)(parm_size_in_bytes)
#define FUNC_ARCH_IFACE_ATTR_ENUM                                                                           \
   (iface_name)(iface_mode)(iface_direction)(iface_bitwidth)(iface_alignment)(iface_depth)(iface_register)( \
       iface_cache_ways)(iface_cache_line_count)(iface_cache_line_size)(iface_cache_num_write_outstanding)( \
       iface_cache_rep_policy)(iface_cache_bus_size)(iface_cache_write_policy)

REF_FORWARD_DECL(FunctionArchitecture);

class FunctionArchitecture
{
 public:
   enum func_attr
   {
      BOOST_PP_SEQ_FOR_EACH(ENUM_ID, BOOST_PP_EMPTY, FUNC_ARCH_ATTR_ENUM)
   };
   static enum func_attr to_func_attr(const std::string& attr);

   enum parm_attr
   {
      BOOST_PP_SEQ_FOR_EACH(ENUM_ID, BOOST_PP_EMPTY, FUNC_ARCH_PARM_ATTR_ENUM)
   };
   static enum parm_attr to_parm_attr(const std::string& attr);

   enum iface_attr
   {
      BOOST_PP_SEQ_FOR_EACH(ENUM_ID, BOOST_PP_EMPTY, FUNC_ARCH_IFACE_ATTR_ENUM)
   };
   static enum iface_attr to_iface_attr(const std::string& attr);

   using func_attrs = std::map<enum func_attr, std::string>;
   using parm_attrs = std::map<enum parm_attr, std::string>;
   using iface_attrs = std::map<enum iface_attr, std::string>;

   func_attrs attrs;
   std::map<std::string, parm_attrs> parms;
   std::map<std::string, iface_attrs> ifaces;
};

REF_FORWARD_DECL(ModuleArchitecture);
class ModuleArchitecture
{
 public:
   using FunctionArchitectures = std::map<std::string, FunctionArchitectureRef>;

 private:
   FunctionArchitectures _funcArchs;

 public:
   ModuleArchitecture(const std::string& filename);
   ~ModuleArchitecture();

   FunctionArchitectures::const_iterator cbegin() const
   {
      return _funcArchs.cbegin();
   }

   FunctionArchitectures::const_iterator cend() const
   {
      return _funcArchs.cend();
   }

   FunctionArchitectures::const_iterator begin() const
   {
      return _funcArchs.begin();
   }

   FunctionArchitectures::const_iterator end() const
   {
      return _funcArchs.end();
   }

   FunctionArchitectures::iterator erase(FunctionArchitectures::const_iterator it)
   {
      return _funcArchs.erase(it);
   }

   void AddArchitecture(const std::string& symbol, FunctionArchitectureRef arch);

   FunctionArchitectureRef GetArchitecture(const std::string& funcSymbol) const;

   void RemoveArchitecture(const std::string& funcSymbol);
};

class HLS_manager : public application_manager
{
 public:
   using io_binding_type = std::tuple<unsigned int, unsigned int>;

 private:
   HLS_deviceRef HLS_D;

   std::map<unsigned int, hlsRef> hlsMap;

   BackendFlowRef back_flow;

   unsigned int memory_version;

 public:
   unsigned long long int base_address;

   long HLS_execution_time;

   functionsRef Rfuns;

   memoryRef Rmem;

   SimulationInformationRef RSim;

   CustomMap<std::string, double> evaluations;

   std::list<std::string> aux_files;

   std::list<std::string> hdl_files;

#if HAVE_TASTE
   const AadlInformationRef aadl_information;
#endif

   ModuleArchitectureRef module_arch;

   std::map<std::string, std::map<unsigned, std::map<std::string, std::list<unsigned>>>> design_interface_io;

   std::map<std::pair<std::string, std::string>, std::pair<unsigned, unsigned>> global_resource_constraints;

   HLS_manager(const ParameterConstRef Param, const HLS_deviceRef HLS_D);

   ~HLS_manager() override;

   hlsRef get_HLS(unsigned int funId) const;

   static hlsRef create_HLS(const HLS_managerRef HLSMgr, unsigned int functionId);

   HLS_deviceRef get_HLS_device() const;

   const BackendFlowRef get_backend_flow();

   std::string get_constant_string(unsigned int node, unsigned long long precision);

   void xwrite(const std::string& filename);

   std::vector<io_binding_type> get_required_values(unsigned int fun_id, const vertex& v) const;

   bool is_register_compatible(unsigned int var) const;

   bool is_reading_writing_function(unsigned funID) const;

   CustomOrderedSet<hlsRef> GetAllImplementations() const;

   bool IsSingleWriteMemory() const;

   unsigned int GetMemVersion() const;

   unsigned int UpdateMemVersion();

   static void check_bitwidth(unsigned long long prec);
};
using HLS_managerRef = refcount<HLS_manager>;
using HLS_managerConstRef = refcount<const HLS_manager>;

#endif