hls_constraints.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_CONSTRAINTS_HPP
#define HLS_CONSTRAINTS_HPP

#include <iosfwd>
#include <limits>
#include <string>
#include <utility>

#include "custom_map.hpp"
#include "refcount.hpp"

REF_FORWARD_DECL(HLS_constraints);
CONSTREF_FORWARD_DECL(Parameter);
REF_FORWARD_DECL(generic_device);
class xml_element;

#define ENCODE_FU_LIB(fu_name, library) ((fu_name) + ":" + (library))

class HLS_constraints
{
   CustomMap<std::string, unsigned int> tech_constraints;

   CustomMap<std::string, std::pair<std::string, std::pair<std::string, unsigned int>>> binding_constraints;

   CustomMap<std::string, int> scheduling_constraints;

   double clock_period;

   double clock_period_resource_fraction;

   unsigned int registers;

   std::string fun_name;

   const ParameterConstRef parameters;

 public:
   friend class allocation;

   HLS_constraints(const ParameterConstRef& Param, std::string _fun_name);

   std::string get_function_name() const;

   void add_builtin_constraints();

   void read_HLS_constraints_File(const std::string& f);

   void write_HLS_constraints_File(const std::string& f);

   void set_number_fu(const std::string& name, const std::string& library,
                      unsigned int n_resources = std::numeric_limits<unsigned int>::max());

   unsigned int get_number_fu(const std::string& name, const std::string& library) const;

   unsigned int get_number_fu(const std::string& combined) const;

   void bind_vertex_to_fu(const std::string& vertex_name, const std::string& fu_name, const std::string& fu_library,
                          const unsigned int fu_index);

   bool has_binding_to_fu(const std::string& vertex_name) const;

   void set_scheduling_priority(const std::string& vertex_name, int Priority);

   CustomMap<std::string, int> get_scheduling_priority() const;

   void set_clock_period(double period);

   double get_clock_period() const
   {
      return clock_period;
   }

   double get_clock_period_resource_fraction() const
   {
      return clock_period_resource_fraction;
   }

   void set_max_registers(unsigned int n_resources);

   unsigned int get_max_registers() const
   {
      return registers;
   }

   void xload(const xml_element* Enode);

   void xwrite(xml_element* rootnode);

   void xwriteHLSConstraints(xml_element* Enode, bool forDump = false);

   void xwriteFUConstraints(xml_element* Enode, const std::string& fu_name, const std::string& fu_library,
                            unsigned int number_fu, bool forDump = false);

   void xwriteBindingConstraints(xml_element* Enode, const std::string& vertex_name, const std::string& fu_name,
                                 const std::string& fu_library, unsigned int fu_index);

   void xwriteSchedulingConstraints(xml_element* Enode, const std::string& vertex_name, int priority);

   void print(std::ostream& os) const;

   friend std::ostream& operator<<(std::ostream& os, const HLS_constraints& s)
   {
      s.print(os);
      return os;
   }

   std::string get_kind_text() const
   {
      return std::string("HLS_constraints");
   }
};
using HLS_constraintsRef = refcount<HLS_constraints>;

#endif