function_frontend_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 FUNCTION_FRONTEND_FLOW_STEP_HPP
#define FUNCTION_FRONTEND_FLOW_STEP_HPP

#include "design_flow_step.hpp"   // for DesignFlowStep_S...
#include "frontend_flow_step.hpp" // for FrontendFlowStep...
#include "refcount.hpp"           // for REF_FORWARD_DECL
#include <string>                 // for string

REF_FORWARD_DECL(ArchManager);
CONSTREF_FORWARD_DECL(DesignFlowManager);
REF_FORWARD_DECL(FunctionBehavior);

enum class FunctionFrontendFlowStep_Movable
{
   UNMOVABLE, 
   TIMING,    
   MOVABLE    
};

class FunctionFrontendFlowStep : public FrontendFlowStep
{
 protected:
   virtual DesignFlowStep_Status InternalExec() = 0;

   const FunctionBehaviorRef function_behavior;

   const unsigned int function_id;

   unsigned int bb_version;

   unsigned int bitvalue_version;

   void WriteBBGraphDot(const std::string& filename) const;

 private:
   bool HasToBeExecuted0() const;

 public:
   FunctionFrontendFlowStep(const application_managerRef AppM, const unsigned int function_id,
                            const FrontendFlowStepType frontend_flow_step_type,
                            const DesignFlowManagerConstRef design_flow_manager, const ParameterConstRef parameters);

   ~FunctionFrontendFlowStep() override;

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

   std::string GetSignature() const override;

   std::string GetName() const override;

   DesignFlowStep_Status Exec() final;

   static const std::string ComputeSignature(const FrontendFlowStepType frontend_flow_step_type,
                                             const unsigned int function_id);

   bool HasToBeExecuted() const override;

   unsigned int CGetBBVersion() const;

   unsigned int GetBitValueVersion() const;

   void PrintInitialIR() const override;

   void PrintFinalIR() const override;
};
#endif