call_graph_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 CALL_GRAPH_MANAGER_HPP
#define CALL_GRAPH_MANAGER_HPP

#include "call_graph.hpp" // for CallGraph (ptr o...
#include "custom_map.hpp"
#include "custom_set.hpp"
#include "graph.hpp"                          // for vertex, EdgeDesc...
#include "refcount.hpp"                       // for CONSTREF_FORWARD...
#include <boost/graph/depth_first_search.hpp> // for default_dfs_visitor

REF_FORWARD_DECL(application_manager);
CONSTREF_FORWARD_DECL(application_manager);
CONSTREF_FORWARD_DECL(CallGraph);
REF_FORWARD_DECL(CallGraph);
REF_FORWARD_DECL(CallGraphsCollection);
CONSTREF_FORWARD_DECL(FunctionExpander);
REF_FORWARD_DECL(FunctionBehavior);
CONSTREF_FORWARD_DECL(OpGraph);
CONSTREF_FORWARD_DECL(Parameter);
CONSTREF_FORWARD_DECL(tree_manager);
REF_FORWARD_DECL(tree_manager);
REF_FORWARD_DECL(tree_node);

class CallGraphManager
{
 private:
   friend class call_graph_computation;

   const CallGraphsCollectionRef call_graphs_collection;

   const CallGraphRef call_graph;

   const tree_managerConstRef tree_manager;

   std::map<unsigned int, CustomSet<unsigned int>> called_by;

   std::map<unsigned int, vertex> functionID_vertex_map;

   const bool allow_recursive_functions;

   CustomSet<unsigned int> root_functions;

   CustomSet<unsigned int> reached_body_functions;

   CustomSet<unsigned int> reached_library_functions;

   CustomSet<unsigned int> addressed_functions;

   const ParameterConstRef Param;

   const int debug_level;

   void AddCallPoint(unsigned int caller_id, unsigned int called_id, unsigned int call_id,
                     enum FunctionEdgeInfo::CallType call_type);
   void AddFunctionAndCallPoint(unsigned int caller_id, unsigned int called_id, unsigned int call_id,
                                const FunctionBehaviorRef called_function_behavior,
                                enum FunctionEdgeInfo::CallType call_type);
   bool IsCallPoint(unsigned int caller_id, unsigned int called_id, unsigned int call_id,
                    enum FunctionEdgeInfo::CallType call_type) const;

   void ComputeRootAndReachedFunctions();

 public:
   const FunctionExpanderConstRef function_expander;

   CallGraphManager(const FunctionExpanderConstRef function_expander, const bool allow_recursive_functions,
                    const tree_managerConstRef tree_manager, const ParameterConstRef Param);

   ~CallGraphManager();

   CallGraphConstRef CGetAcyclicCallGraph() const;

   CallGraphConstRef CGetCallGraph() const;

   CallGraphConstRef CGetCallSubGraph(const CustomUnorderedSet<vertex>& vertices) const;

   CustomSet<unsigned int> get_called_by(unsigned int index) const;

   CustomSet<unsigned int> get_called_by(const OpGraphConstRef cfg, const vertex& caller) const;

   unsigned int get_function(vertex node) const;

   vertex GetVertex(const unsigned int index) const;

   void SetRootFunctions(const CustomSet<unsigned int>& root_functions);

   CustomSet<unsigned int> GetRootFunctions() const;

   const CustomSet<unsigned int>& GetReachedBodyFunctions() const;

   CustomSet<unsigned int> GetReachedFunctionsFrom(unsigned int from_f, bool with_body = true) const;

   unsigned int GetRootFunction(unsigned int fid) const;

   CustomSet<unsigned int> GetReachedLibraryFunctions() const;

   bool IsVertex(unsigned int functionID) const;

   void AddFunction(unsigned int new_function_id, const FunctionBehaviorRef fun_behavior);

   void AddFunctionAndCallPoint(const application_managerRef AppM, unsigned int caller_id, unsigned int called_id,
                                unsigned int call_id, enum FunctionEdgeInfo::CallType call_type);

   void RemoveCallPoint(const unsigned int caller_id, const unsigned int called_id, const unsigned int call_id);

   void RemoveCallPoint(EdgeDescriptor e, const unsigned int callid);

   void ReplaceCallPoint(const EdgeDescriptor e, const unsigned int orig, const unsigned int repl);

   bool ExistsAddressedFunction() const;

   CustomSet<unsigned int> GetAddressedFunctions() const;

   static void call_graph_computation_recursive(CustomUnorderedSet<unsigned int>& AV, const application_managerRef AM,
                                                unsigned int current, const tree_managerRef& TM, const tree_nodeRef& tn,
                                                unsigned int node_stmt, enum FunctionEdgeInfo::CallType call_type,
                                                int DL);
   static void expandCallGraphFromFunction(CustomUnorderedSet<unsigned int>& AV, const application_managerRef AM,
                                           unsigned int f_id, int DL);
   static void addCallPointAndExpand(CustomUnorderedSet<unsigned int>& AV, const application_managerRef AM,
                                     unsigned int caller_id, unsigned int called_id, unsigned int call_id,
                                     enum FunctionEdgeInfo::CallType call_type, int DL);
};

using CallGraphManagerRef = refcount<CallGraphManager>;
using CallGraphManagerConstRef = refcount<const CallGraphManager>;

#endif