VcdSignalSelection.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) 2015-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/>.
 *
 */
#include "hls_step.hpp"

// tree/ include
#include "tree_node.hpp"

CONSTREF_FORWARD_DECL(tree_manager);
REF_FORWARD_DECL(Discrepancy);

class VcdSignalSelection : public HLS_step
{
 protected:
   const tree_managerRef TM;

   const DiscrepancyRef Discr;

   std::string present_state_name;

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

   void SelectInitialAddrParam(const CustomOrderedSet<unsigned int>& reached_body_fun_ids,
                               CustomUnorderedMap<unsigned int, TreeNodeSet>& address_parameters);

   void InitialSsaIsAddress(
       const tree_nodeConstRef& tn, const CustomUnorderedSet<unsigned int>& addr_fun_ids,
       const CustomUnorderedMap<unsigned int, UnorderedSetStdStable<unsigned int>>& call_id_to_called_id);

   void InitialPhiResIsAddress(const tree_nodeConstRef& tn);

   void
   SelectInitialSsa(const CustomOrderedSet<unsigned int>& reached_body_fun_ids,
                    const CustomUnorderedSet<unsigned int>& addr_fun_ids,
                    const CustomUnorderedMap<unsigned int, UnorderedSetStdStable<unsigned int>>& call_id_to_called_id);

   void SingleStepPropagateParamToSsa(const TreeNodeMap<size_t>& used_ssa, const TreeNodeSet& address_parameters);

   void PropagateAddrParamToSsa(const CustomUnorderedMap<unsigned int, TreeNodeSet>& address_parameters,
                                const CustomOrderedSet<unsigned int>& reached_body_fun_ids);

   void SingleStepPropagateAddrSsa(const tree_nodeRef& curr_tn);

   void PropagateAddrSsa();

   void DetectInvalidReturns(const CustomOrderedSet<unsigned int>& reached_body_functions,
                             CustomUnorderedSet<unsigned int>& addr_fun_ids);

   void InProcedurePropagateAddr(const CustomUnorderedMap<unsigned int, TreeNodeSet>& address_parameters,
                                 const CustomOrderedSet<unsigned int>& reached_body_functions,
                                 CustomUnorderedSet<unsigned int>& addr_fun_ids);

   void CrossPropagateAddrSsa(
       CustomUnorderedMap<unsigned int, TreeNodeSet>& address_parameters,
       const CustomOrderedSet<unsigned int>& reached_body_functions,
       const CustomUnorderedSet<unsigned int>& addr_fun_ids,
       const CustomUnorderedMap<unsigned int, UnorderedSetStdStable<unsigned int>>& fu_id_to_call_ids,
       const CustomUnorderedMap<unsigned int, UnorderedSetStdStable<unsigned int>>& call_id_to_called_id);

   void
   SelectAddrSsa(const CustomUnorderedMap<unsigned int, UnorderedSetStdStable<unsigned int>>& fu_id_to_call_ids,
                 const CustomUnorderedMap<unsigned int, UnorderedSetStdStable<unsigned int>>& call_id_to_called_id);

   bool IsAddressType(const unsigned int type_index) const;

   void SelectInternalSignals(
       CustomUnorderedMap<unsigned int, UnorderedSetStdStable<std::string>>& fun_id_to_sig_names) const;

 public:
   VcdSignalSelection(const ParameterConstRef _parameters, const HLS_managerRef HLSMgr,
                      const DesignFlowManagerConstRef design_flow_manager);

   ~VcdSignalSelection() override;

   DesignFlowStep_Status Exec() override;

   bool HasToBeExecuted() const override;
};