c_backend.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 C_BACKEND_HPP
#define C_BACKEND_HPP

#include "custom_set.hpp"
#include "design_flow_step.hpp"
#include "graph.hpp"
#include "refcount.hpp"

#include <fstream>
#include <iosfwd>
#include <list>
#include <ostream>
#include <sstream>
#include <string>
#include <vector>

CONSTREF_FORWARD_DECL(BehavioralHelper);
CONSTREF_FORWARD_DECL(CBackendInformation);
REF_FORWARD_DECL(CWriter);
REF_FORWARD_DECL(IndentedOutputStream);
CONSTREF_FORWARD_DECL(OpGraph);
class OpVertexSet;
CONSTREF_FORWARD_DECL(Parameter);
CONSTREF_FORWARD_DECL(application_manager);
CONSTREF_FORWARD_DECL(tree_manager);
CONSTREF_FORWARD_DECL(tree_node);

class CBackend : public DesignFlowStep
{
 protected:
   CustomUnorderedSet<unsigned int> already_visited;

   const IndentedOutputStreamRef indented_output_stream;

   const CWriterRef writer;

   const application_managerConstRef AppM;

   const tree_managerConstRef TM;

   void compute_variables(const OpGraphConstRef inGraph, const CustomUnorderedSet<unsigned int>& gblVariables,
                          std::list<unsigned int>& funParams, CustomUnorderedSet<unsigned int>& vars);

   virtual void AnalyzeInclude(const tree_nodeConstRef& tn, const BehavioralHelperConstRef& BH,
                               CustomOrderedSet<std::string>& includes);

   virtual void writeIncludes();

   virtual void WriteGlobalDeclarations();

   virtual void writeImplementations();

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

 private:
   // CBackendStepFactory is the only class allowed to construct CBackend
   friend class CBackendStepFactory;

   CustomOrderedSet<unsigned int> functions_to_be_declared;

   CustomOrderedSet<unsigned int> functions_to_be_defined;

   CBackend(const CBackendInformationConstRef c_backend_information,
            const DesignFlowManagerConstRef design_flow_manager, const application_managerConstRef AppM,
            const ParameterConstRef _parameters);

 public:
   const CBackendInformationConstRef c_backend_info;

   bool HasToBeExecuted() const override;

   void Initialize() override;

   DesignFlowStep_Status Exec() override;

   std::string GetSignature() const final;

   std::string GetName() const final;

   DesignFlowStepFactoryConstRef CGetDesignFlowStepFactory() const override;

   const CWriterRef GetCWriter() const;

   static std::string ComputeSignature(const CBackendInformationConstRef type);
};
using CBackendRef = refcount<CBackend>;
using CBackendConstRef = refcount<const CBackend>;
#endif