reg_binding.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 REG_BINDING_HPP
#define REG_BINDING_HPP

#include "Variable.hpp"
#include "custom_set.hpp"
#include "refcount.hpp"
#include <iosfwd>
#include <map>
#include <string>

REF_FORWARD_DECL(hls);
REF_FORWARD_DECL(HLS_manager);
REF_FORWARD_DECL(reg_binding);
REF_FORWARD_DECL(generic_obj);
REF_FORWARD_DECL(structural_object);
CONSTREF_FORWARD_DECL(FunctionBehavior);
class register_obj;
class reg_binsign_creator;

class reg_binding : public variable2obj<generic_objRef>
{
   friend class reg_binding_creator;

 public:
   using type_t = enum { STG = 0, CDFG };

 protected:
   int debug;

   unsigned int used_regs;

   std::map<unsigned int, generic_objRef> unique_table;

   std::map<unsigned int, generic_objRef> stall_reg_table;

   std::map<unsigned int, unsigned int> reverse_map;

   std::map<unsigned int, unsigned long long> bitsize_map;

   hlsRef HLS;

   const HLS_managerRef HLSMgr;

   std::map<unsigned int, CustomOrderedSet<unsigned int>> reg2storage_values;

   CustomOrderedSet<unsigned int> is_without_enable;

   bool all_regs_without_enable;

   const FunctionBehaviorConstRef FB;

   static std::string reset_type;

   void compute_is_without_enable();

   virtual void specialise_reg(structural_objectRef& reg, unsigned int r);

 public:
   reg_binding(const hlsRef& HLS, const HLS_managerRef HLSMgr_);

   ~reg_binding() override;

   static reg_bindingRef create_reg_binding(const hlsRef& HLS, const HLS_managerRef HLSMgr_);

   void bind(unsigned int sv, unsigned int index);

   virtual std::string GetRegisterFUName(unsigned int i);

   unsigned int get_used_regs() const
   {
      return used_regs;
   }

   void set_used_regs(unsigned int regs)
   {
      used_regs = regs;
   }

   unsigned int get_register(unsigned int sv) const
   {
      return reverse_map.find(sv)->second;
   }

   bool is_all_regs_without_enable()
   {
      return all_regs_without_enable;
   }

   void print_el(const_iterator& it) const override;

   generic_objRef get(const unsigned int& r) const
   {
      return unique_table.find(r) != unique_table.end() ? unique_table.find(r)->second : generic_objRef();
   }

   const register_obj& operator[](unsigned int v);

   virtual void add_to_SM(structural_objectRef clock_port, structural_objectRef reset_port);

   unsigned long long get_bitsize(unsigned int r) const;

 private:
   CustomOrderedSet<unsigned int> get_vars(const unsigned int& r) const;

   unsigned long long compute_bitsize(unsigned int r);
};

using reg_bindingRef = refcount<reg_binding>;

#endif