design_flow_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 DESIGN_FLOW_STEP_HPP
#define DESIGN_FLOW_STEP_HPP
#include "config_HAVE_UNORDERED.hpp" // for HAVE_UNORDERED

#include "graph.hpp"    // for vertex
#include "refcount.hpp" // for CONSTREF_FORWARD...
#include <iosfwd>       // for ostream
#include <string>       // for string

CONSTREF_FORWARD_DECL(DesignFlowManager);
REF_FORWARD_DECL(DesignFlowStep);
CONSTREF_FORWARD_DECL(DesignFlowStepFactory);
CONSTREF_FORWARD_DECL(Parameter);

#if HAVE_UNORDERED
#include "custom_set.hpp"
class DesignFlowStepSet : public CustomUnorderedSet<DesignFlowStepRef>
{
};
#else
#include <functional> // for binary_function
#include <set>        // for set
class DesignFlowStepSorter : std::binary_function<vertex, vertex, bool>
{
 public:
   DesignFlowStepSorter();

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

class DesignFlowStepSet : public std::set<DesignFlowStepRef, DesignFlowStepSorter>
{
 public:
   DesignFlowStepSet();
};
#endif

enum class DesignFlowStep_Status
{
   ABORTED,     
   EMPTY,       
   NONEXISTENT, 
   SKIPPED,     
   SUCCESS,     
   UNCHANGED,   
   UNEXECUTED,  
   UNNECESSARY, 
};

class DesignFlowStep
{
 protected:
   bool composed;

   const Wrefcount<const DesignFlowManager> design_flow_manager;

   const ParameterConstRef parameters;

   int debug_level;

   const int output_level;

 public:
   enum RelationshipType
   {
      DEPENDENCE_RELATIONSHIP,   
      INVALIDATION_RELATIONSHIP, 
      PRECEDENCE_RELATIONSHIP    
   };

   DesignFlowStep(const DesignFlowManagerConstRef design_flow_manager, const ParameterConstRef parameters);

   virtual ~DesignFlowStep();

   virtual DesignFlowStep_Status Exec() = 0;

   virtual bool HasToBeExecuted() const = 0;

   virtual void Initialize();

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

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

   DesignFlowStep_Status GetStatus() const;

   virtual void ComputeRelationships(DesignFlowStepSet& relationship,
                                     const DesignFlowStep::RelationshipType relationship_type) = 0;

   virtual void WriteDot(std::ostream& out) const;

   virtual DesignFlowStepFactoryConstRef CGetDesignFlowStepFactory() const = 0;

   bool IsComposed() const;

   int CGetDebugLevel() const;

   virtual void PrintInitialIR() const;

   virtual void PrintFinalIR() const;
};
using DesignFlowStepRef = refcount<DesignFlowStep>;
using DesignFlowStepConstRef = refcount<const DesignFlowStep>;

#endif