InterfaceInfer.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) 2022-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 INTERFACE_INFER_HPP
#define INTERFACE_INFER_HPP

#include "application_frontend_flow_step.hpp"
#include "custom_set.hpp"
#include "refcount.hpp"

#include <list>
#include <set>

REF_FORWARD_DECL(tree_node);
CONSTREF_FORWARD_DECL(tree_node);
REF_FORWARD_DECL(tree_manipulation);
REF_FORWARD_DECL(tree_manager);
REF_FORWARD_DECL(FunctionArchitecture);
struct statement_list;
struct function_decl;
struct gimple_assign;
struct gimple_node;

class InterfaceInfer : public ApplicationFrontendFlowStep
{
 private:
   enum class m_axi_type;
   enum class datatype;
   struct interface_info;

   bool already_executed;

   const CustomUnorderedSet<std::pair<FrontendFlowStepType, FunctionRelationship>>
   ComputeFrontendRelationships(const DesignFlowStep::RelationshipType relationship_type) const override;

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

   void ChasePointerInterfaceRecurse(CustomOrderedSet<unsigned>& Visited, tree_nodeRef ptr_var,
                                     std::list<tree_nodeRef>& writeStmt, std::list<tree_nodeRef>& readStmt,
                                     interface_info& info);

   void ChasePointerInterface(tree_nodeRef ptr_var, std::list<tree_nodeRef>& writeStmt,
                              std::list<tree_nodeRef>& readStmt, interface_info& info);

   void forwardInterface(const tree_nodeRef& fnode, const tree_nodeRef& parm_node, const interface_info& info);

   void setReadInterface(tree_nodeRef stmt, const std::string& arg_name, std::set<std::string>& operationsR,
                         bool commonRWSignature, tree_nodeConstRef interface_datatype,
                         const tree_manipulationRef tree_man, const tree_managerRef TM);

   void setWriteInterface(tree_nodeRef stmt, const std::string& arg_name, std::set<std::string>& operationsW,
                          bool commonRWSignature, tree_nodeConstRef interface_datatype,
                          const tree_manipulationRef tree_man, const tree_managerRef TM);

   void create_resource_Read_simple(const std::set<std::string>& operations, const interface_info& info,
                                    FunctionArchitectureRef func_arch, bool IO_port) const;

   void create_resource_Write_simple(const std::set<std::string>& operations, const interface_info& info,
                                     FunctionArchitectureRef func_arch, bool IO_port) const;

   void create_resource_array(const std::set<std::string>& operationsR, const std::set<std::string>& operationsW,
                              const interface_info& info, FunctionArchitectureRef func_arch) const;

   void create_resource_m_axi(const std::set<std::string>& operationsR, const std::set<std::string>& operationsW,
                              const interface_info& info, FunctionArchitectureRef func_arch) const;

   void create_resource(const std::set<std::string>& operationsR, const std::set<std::string>& operationsW,
                        const interface_info& info, FunctionArchitectureRef func_arch) const;

 public:
   InterfaceInfer(const application_managerRef AppM, const DesignFlowManagerConstRef design_flow_manager,
                  const ParameterConstRef parameters);

   ~InterfaceInfer() override;

   bool HasToBeExecuted() const override;

   DesignFlowStep_Status Exec() override;
};

#endif