allocation.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 ALLOCATION_HPP
#define ALLOCATION_HPP

#include "design_flow_step.hpp"  // for DesignFlowManagerConstRef, Design...
#include "hls_function_step.hpp" // for HLSFunctionStep
#include "hls_manager.hpp"       // for HLS_manager, HLS_manager::io_bind...
#include "hls_step.hpp"          // for HLSFlowStep_Type, HLSFlowStep_Typ...
#include "refcount.hpp"          // for REF_FORWARD_DECL, CONSTREF_FORWAR...
#include <string>                // for string

REF_FORWARD_DECL(AllocationInformation);
REF_FORWARD_DECL(HLS_constraints);
REF_FORWARD_DECL(HLS_device);
CONSTREF_FORWARD_DECL(OpGraph);
REF_FORWARD_DECL(allocation);
REF_FORWARD_DECL(graph);
REF_FORWARD_DECL(library_manager);
REF_FORWARD_DECL(node_kind_prec_info);
REF_FORWARD_DECL(structural_manager);
REF_FORWARD_DECL(technology_node);
REF_FORWARD_DECL(technology_manager);
struct functional_unit;
struct operation;

enum class Allocation_MinMax
{
   MIN,
   MAX
};

class allocation : public HLSFunctionStep
{
 protected:
   AllocationInformationRef allocation_information;
   friend struct updatecopy_HLS_constraints_functor;

   std::map<std::string, std::string> precomputed_pipeline_unit;

   std::map<technology_nodeRef, std::map<unsigned long long, std::map<HLS_manager::io_binding_type, unsigned int>>>
       fu_list;

   HLS_deviceRef HLS_D;

   technology_managerRef TechM;

   technology_nodeRef get_fu(const std::string& fu_name);

   std::string get_compliant_pipelined_unit(double clock, const std::string& pipe_parameter,
                                            const technology_nodeRef current_fu, const std::string& curr_op,
                                            const std::string& library_name, const std::string& template_suffix,
                                            unsigned long long module_prec);

   technology_nodeRef extract_bambu_provided(const std::string& library_name, operation* curr_op,
                                             const std::string& bambu_provided_resource_);

   void set_number_channels(unsigned int fu_name, unsigned int n_ports);

   double get_execution_time_dsp_modified(const unsigned int fu_name, const technology_nodeRef& node_op) const;

   double get_stage_period_dsp_modified(const unsigned int fu_name, const technology_nodeRef& node_op) const;

   void add_proxy_function_module(const HLS_constraintsRef HLS_C, technology_nodeRef techNode_obj,
                                  const std::string& orig_fun_name);

   void add_proxy_function_wrapper(const std::string& library_name, technology_nodeRef techNode_obj,
                                   const std::string& orig_fun_name);

   void BuildProxyWrapper(functional_unit* current_fu, const std::string& orig_fun_name,
                          const std::string& orig_library_name);

   void BuildProxyFunctionVerilog(functional_unit* current_fu);

   void BuildProxyFunctionVHDL(functional_unit* current_fu);

   void BuildProxyFunction(functional_unit* current_fu);

   void add_tech_constraint(technology_nodeRef cur_fu, unsigned int tech_constrain_value, unsigned int pos,
                            bool proxy_constrained);
   void add_resource_to_fu_list(std::string channels_type, const OpGraphConstRef g, technology_nodeRef current_fu,
                                CustomOrderedSet<vertex> vertex_analysed, node_kind_prec_infoRef node_info,
                                unsigned int current_id, CustomOrderedSet<vertex>::const_iterator vert,
                                const std::vector<std::string>& libraries, bool isMemory,
                                std::string bambu_provided_resource, operation* curr_op, std::string specialized_fuName,
                                bool predicate_2, std::string current_op, HLS_manager::io_binding_type constant_id,
                                bool varargs_fu, unsigned int l, std::string memory_ctrl_type,
                                std::map<std::string, technology_nodeRef> new_fu, unsigned int tech_constrain_value);
   bool check_templated_units(double clock_period, node_kind_prec_infoRef node_info, const library_managerRef library,
                              technology_nodeRef current_fu, operation* curr_op);
   bool check_for_memory_compliancy(bool Has_extern_allocated_data, technology_nodeRef current_fu,
                                    const std::string& memory_ctrl_type, const std::string& channels_type);
   bool check_type_and_precision(operation* curr_op, node_kind_prec_infoRef node_info);
   bool check_proxies(const library_managerRef library, const std::string& fu_name_);
   bool check_generated_bambu_flopoco(bool skip_softfloat_resources, structural_managerRef structManager_obj,
                                      std::string& bambu_provided_resource, bool skip_flopoco_resources,
                                      technology_nodeRef current_fu);
   bool is_ram_not_timing_compliant(const HLS_constraintsRef HLS_C, unsigned int var, technology_nodeRef current_fu);
   std::string get_synch_ram_latency(const std::string& ram_template, const std::string& latency_postfix,
                                     const HLS_constraintsRef HLS_C, unsigned int var);

   virtual void IntegrateTechnologyLibraries();

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

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

 public:
   allocation(const ParameterConstRef _parameters, const HLS_managerRef HLSMgr, unsigned int funId,
              const DesignFlowManagerConstRef design_flow_manager,
              const HLSFlowStep_Type = HLSFlowStep_Type::ALLOCATION);

   ~allocation() override;

   DesignFlowStep_Status InternalExec() override;

   void Initialize() override;

   void PrintInitialIR() const override;
};
#endif