hls_step.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_STEP_HPP
#define HLS_STEP_HPP

#include "config_HAVE_FROM_PRAGMA_BUILT.hpp"
#include "config_HAVE_ILP_BUILT.hpp"
#include "config_HAVE_LIBRARY_CHARACTERIZATION_BUILT.hpp"
#include "config_HAVE_SIMULATION_WRAPPER_BUILT.hpp"
#include "config_HAVE_TASTE.hpp"
#include "config_HAVE_VCD_BUILT.hpp"

#include "design_flow_step.hpp"

#include <string>

#include "custom_map.hpp"

#include "refcount.hpp"

CONSTREF_FORWARD_DECL(Parameter);
REF_FORWARD_DECL(hls);
REF_FORWARD_DECL(HLS_manager);
REF_FORWARD_DECL(HLS_step);
class xml_element;

class HLSFlowStepSpecialization
{
 public:
   HLSFlowStepSpecialization();

   virtual ~HLSFlowStepSpecialization();

   virtual std::string GetKindText() const = 0;

   virtual std::string GetSignature() const = 0;
};
using HLSFlowStepSpecializationConstRef = refcount<const HLSFlowStepSpecialization>;

enum class HLSFlowStep_Type
{
   UNKNOWN = 0,
   ADD_LIBRARY,
   ALLOCATION,
   BB_STG_CREATOR,
   CALL_GRAPH_UNFOLDING,
   CDFC_MODULE_BINDING,
   CHORDAL_COLORING_REGISTER_BINDING,
   CLASSIC_DATAPATH_CREATOR,
   DATAPATH_CS_CREATOR,
   DATAPATH_CS_PARALLEL_CREATOR,
   CLASSICAL_HLS_SYNTHESIS_FLOW,
   COLORING_REGISTER_BINDING,
   CONTROL_FLOW_CHECKER,
   C_TESTBENCH_EXECUTION,
   DOMINATOR_ALLOCATION,
   DOMINATOR_FUNCTION_ALLOCATION,
   DOMINATOR_MEMORY_ALLOCATION,
   DOMINATOR_MEMORY_ALLOCATION_CS,
   DRY_RUN_EVALUATION,
   EASY_MODULE_BINDING,
   EVALUATION,
   FSM_CONTROLLER_CREATOR,
   FSM_CS_CONTROLLER_CREATOR,
   FSM_NI_SSA_LIVENESS,
   GENERATE_HDL,
   GENERATE_SIMULATION_SCRIPT,
   GENERATE_SYNTHESIS_SCRIPT,
#if HAVE_TASTE
   GENERATE_TASTE_HDL_ARCHITECTURE,
   GENERATE_TASTE_SYNTHESIS_SCRIPT,
#endif
   HLS_FUNCTION_BIT_VALUE,
   HLS_SYNTHESIS_FLOW,
   HW_PATH_COMPUTATION,
   HW_DISCREPANCY_ANALYSIS,
   INFERRED_INTERFACE_GENERATION,
   INITIALIZE_HLS,
   INTERFACE_CS_GENERATION,
   LIST_BASED_SCHEDULING,
   MINIMAL_INTERFACE_GENERATION,
   MUX_INTERCONNECTION_BINDING,
#if HAVE_FROM_PRAGMA_BUILT
   OMP_ALLOCATION,
#endif
#if HAVE_FROM_PRAGMA_BUILT
#endif
   OMP_BODY_LOOP_SYNTHESIS_FLOW,
#if HAVE_FROM_PRAGMA_BUILT
   OMP_FOR_WRAPPER_CS_SYNTHESIS_FLOW,
#endif
#if HAVE_FROM_PRAGMA_BUILT
   OMP_FUNCTION_ALLOCATION,
#endif
#if HAVE_FROM_PRAGMA_BUILT
   OMP_FUNCTION_ALLOCATION_CS,
#endif
   PIPELINE_CONTROLLER_CREATOR,
   PORT_SWAPPING,
   SCHED_CHAINING,
#if HAVE_ILP_BUILT
   SDC_SCHEDULING,
#endif
#if HAVE_SIMULATION_WRAPPER_BUILT
   SIMULATION_EVALUATION,
#endif
   STANDARD_HLS_FLOW,
#if HAVE_LIBRARY_CHARACTERIZATION_BUILT
   SYNTHESIS_EVALUATION,
#endif
#if HAVE_TASTE
   TASTE_INTERFACE_GENERATION,
#endif
   TESTBENCH_GENERATION,
   TEST_VECTOR_PARSER,
   TOP_ENTITY_CS_CREATION,
   TOP_ENTITY_CS_PARALLEL_CREATION,
   TOP_ENTITY_CREATION,
   TOP_ENTITY_MEMORY_MAPPED_CREATION,
   UNIQUE_MODULE_BINDING,
   UNIQUE_REGISTER_BINDING,
   VALUES_SCHEME_STORAGE_VALUE_INSERTION,
#if HAVE_VCD_BUILT
   VCD_SIGNAL_SELECTION,
   VCD_UTILITY,
#endif
   VIRTUAL_DESIGN_FLOW,
   WB4_INTERCON_INTERFACE_GENERATION,
   WB4_INTERFACE_GENERATION,
   WEIGHTED_CLIQUE_REGISTER_BINDING,
   WRITE_HLS_SUMMARY
};

enum class HLSFlowStep_Relationship
{
   ALL_FUNCTIONS,
   CALLED_FUNCTIONS,
   SAME_FUNCTION,
   TOP_FUNCTION,
   WHOLE_APPLICATION
};

class HLS_step : public DesignFlowStep
{
 protected:
   static CustomUnorderedMap<std::string, HLSFlowStep_Type> command_line_name_to_enum;

   const HLS_managerRef HLSMgr;

   const HLSFlowStep_Type hls_flow_step_type;

   const HLSFlowStepSpecializationConstRef hls_flow_step_specialization;

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

 public:
   HLS_step(const ParameterConstRef _parameters, const HLS_managerRef HLSMgr,
            const DesignFlowManagerConstRef design_flow_manager, const HLSFlowStep_Type hls_flow_step_type,
            const HLSFlowStepSpecializationConstRef hls_flow_step_specialization = HLSFlowStepSpecializationConstRef());

   ~HLS_step() override;

   std::string GetSignature() const override;

   std::string GetName() const override;

   virtual std::string GetKindText() const;

   static std::string EnumToName(const HLSFlowStep_Type hls_flow_step_type);

   DesignFlowStepFactoryConstRef CGetDesignFlowStepFactory() const final;

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

   static const std::string ComputeSignature(const HLSFlowStep_Type hls_flow_step_type,
                                             const HLSFlowStepSpecializationConstRef hls_flow_step_specialization);
};
using HLS_stepRef = refcount<HLS_step>;

namespace std
{
   template <>
   struct hash<HLSFlowStep_Type> : public unary_function<HLSFlowStep_Type, size_t>
   {
      size_t operator()(HLSFlowStep_Type step) const
      {
         hash<int> hasher;
         return hasher(static_cast<int>(step));
      }
   };
} // namespace std

namespace std
{
   template <>
   struct hash<std::tuple<HLSFlowStep_Type, HLSFlowStepSpecializationConstRef, HLSFlowStep_Relationship>>
       : public unary_function<
             std::tuple<HLSFlowStep_Type, HLSFlowStepSpecializationConstRef, HLSFlowStep_Relationship>, size_t>
   {
      size_t
      operator()(std::tuple<HLSFlowStep_Type, HLSFlowStepSpecializationConstRef, HLSFlowStep_Relationship> step) const
      {
         std::size_t ret = 0;
         hash<int> hasher;
         boost::hash_combine(ret, hasher(static_cast<int>(std::get<0>(step))));
         boost::hash_combine(ret, std::get<1>(step));
         boost::hash_combine(ret, hasher(static_cast<int>(std::get<2>(step))));
         return ret;
      }
   };
} // namespace std

namespace std
{
   template <>
   struct hash<std::pair<HLSFlowStep_Type, HLSFlowStepSpecializationConstRef>>
       : public unary_function<std::tuple<HLSFlowStep_Type, HLSFlowStepSpecializationConstRef>, size_t>
   {
      size_t operator()(std::pair<HLSFlowStep_Type, HLSFlowStepSpecializationConstRef> step) const
      {
         std::size_t ret = 0;
         hash<int> hasher;
         boost::hash_combine(ret, hasher(static_cast<int>(step.first)));
         boost::hash_combine(ret, step.second);
         return ret;
      }
   };
} // namespace std

#endif