design_flow_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 DESIGN_FLOW_MANAGER_HPP
#define DESIGN_FLOW_MANAGER_HPP

#include "custom_map.hpp"
#include "graph.hpp"    // for vertex, Paramete...
#include "refcount.hpp" // for REF_FORWARD_DECL
#include <cstddef>      // for size_t
#include <functional>   // for binary_function
#include <set>          // for set
#include <string>       // for string

class DesignFlowStepSet;
CONSTREF_FORWARD_DECL(DesignFlowGraph);
REF_FORWARD_DECL(DesignFlowGraph);
REF_FORWARD_DECL(DesignFlowGraphsCollection);
REF_FORWARD_DECL(DesignFlowStep);
enum class DesignFlowStep_Status;
CONSTREF_FORWARD_DECL(DesignFlowStepFactory);
REF_FORWARD_DECL(DesignFlowStepInfo);
REF_FORWARD_DECL(Parameter);

class DesignFlowStepNecessitySorter : std::binary_function<vertex, vertex, bool>
{
 private:
   const DesignFlowGraphConstRef design_flow_graph;

 public:
   explicit DesignFlowStepNecessitySorter(const DesignFlowGraphConstRef _design_flow_graph);

   bool operator()(const vertex x, const vertex y) const;
};

class DesignFlowManager final
{
 private:
   static size_t step_counter;

   const DesignFlowGraphsCollectionRef design_flow_graphs_collection;

   const DesignFlowGraphRef design_flow_graph;

   const DesignFlowGraphConstRef feedback_design_flow_graph;

   std::set<vertex, DesignFlowStepNecessitySorter> possibly_ready;

   CustomUnorderedMap<std::string, DesignFlowStepFactoryConstRef> design_flow_step_factories;

#ifndef NDEBUG
   CustomMap<size_t, CustomMap<vertex, DesignFlowStep_Status>> vertex_history;

   CustomMap<size_t, CustomUnorderedMapStable<EdgeDescriptor, int>> edge_history;

   CustomMap<vertex, std::string> step_names;

   CustomMap<vertex, long> accumulated_execution_time;

   CustomMap<vertex, size_t> success_executions;

   CustomMap<vertex, size_t> unchanged_executions;

   CustomMap<vertex, size_t> skipped_executions;
#endif

   const ParameterConstRef parameters;

   const int output_level;

   int debug_level;

   void RecursivelyAddSteps(const DesignFlowStepSet& steps, const bool unnecessary);

   void DeExecute(const vertex starting_vertex, bool force_execution);

   void Consolidate();

#ifndef NDEBUG
   void WriteLoopDot() const;
#endif

 public:
   explicit DesignFlowManager(const ParameterConstRef parameters);

   virtual ~DesignFlowManager();

   void virtual Exec() final;

   void AddStep(const DesignFlowStepRef step);

   void AddSteps(const DesignFlowStepSet& steps);

   const DesignFlowGraphConstRef CGetDesignFlowGraph() const;

   vertex GetDesignFlowStep(const std::string& signature) const;

   DesignFlowStep_Status GetStatus(const std::string& signature) const;

   DesignFlowStepFactoryConstRef CGetDesignFlowStepFactory(const std::string& prefix) const;

   void RegisterFactory(const DesignFlowStepFactoryConstRef factory);

   const DesignFlowStepRef CreateFlowStep(const std::string& signature) const;
};

using DesignFlowManagerRef = refcount<DesignFlowManager>;
#endif