state_transition_graph_manager.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 STATE_TRANSITION_GRAPH_MANAGER_HPP
#define STATE_TRANSITION_GRAPH_MANAGER_HPP

#include "graph.hpp"

#include "refcount.hpp"

CONSTREF_FORWARD_DECL(FunctionBehavior);
CONSTREF_FORWARD_DECL(hls);
CONSTREF_FORWARD_DECL(HLS_manager);
CONSTREF_FORWARD_DECL(OpGraph);
CONSTREF_FORWARD_DECL(StateTransitionGraph);
REF_FORWARD_DECL(hls);
REF_FORWARD_DECL(StateTransitionGraph);
REF_FORWARD_DECL(StateTransitionGraph_constructor);
REF_FORWARD_DECL(StateTransitionGraphsCollection);
REF_FORWARD_DECL(structural_object);
REF_FORWARD_DECL(generic_obj);
REF_FORWARD_DECL(structural_manager);

class StateTransitionGraphManager
{
 private:
   const StateTransitionGraphsCollectionRef state_transition_graphs_collection;

   const StateTransitionGraphRef ACYCLIC_STG_graph;

   const StateTransitionGraphRef STG_graph;

   const StateTransitionGraphRef EPP_STG_graph;

   const OpGraphConstRef op_function_graph;

   const ParameterConstRef Param;

   int output_level;

   int debug_level;

   const unsigned int _max_cycles_bounded;

   // Tells to the get_states method which states you are looking for
   enum StateTypes
   {
      EXECUTING,
      STARTING,
      ENDING
   };

   // helper method to retrieve states
   CustomOrderedSet<vertex> get_states(const vertex& op, StateTypes statetypes) const;

   hlsRef HLS;

   std::map<vertex, generic_objRef> multi_unbounded_table;

 public:
   const StateTransitionGraph_constructorRef STG_builder;

   StateTransitionGraphManager(const HLS_managerConstRef HLSMgr, hlsRef HLS, const ParameterConstRef _Param);

   ~StateTransitionGraphManager();

   /* States retrievers */
   CustomOrderedSet<vertex> get_execution_states(const vertex& op) const;
   CustomOrderedSet<vertex> get_ending_states(const vertex& op) const;
   CustomOrderedSet<vertex> get_starting_states(const vertex& op) const;

   void ComputeCyclesCount(bool is_pipelined);

   StateTransitionGraphRef GetStg();

   StateTransitionGraphRef GetEPPStg();

   const StateTransitionGraphConstRef CGetEPPStg() const;

   const StateTransitionGraphConstRef CGetStg() const;

   StateTransitionGraphRef GetAstg();

   const StateTransitionGraphConstRef CGetAstg() const;

   void print_statistics() const;

   vertex get_entry_state() const;

   std::string get_state_name(vertex state) const;

   vertex get_exit_state() const;

   unsigned int get_number_of_states() const;

   void add_multi_unbounded_obj(vertex s, const CustomOrderedSet<vertex>& ops);

   void specialise_mu(structural_objectRef& mu_mod, generic_objRef mu) const;

   const std::map<vertex, generic_objRef>& get_mu_ctrls() const
   {
      return multi_unbounded_table;
   }

   void add_to_SM(structural_objectRef clock_port, structural_objectRef reset_port);
};
using StateTransitionGraphManagerRef = refcount<StateTransitionGraphManager>;
using StateTransitionGraphManagerConstRef = refcount<const StateTransitionGraphManager>;

#define STATE_NAME_PREFIX "S_"

#endif