call_graph.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_HPP
#define CALL_GRAPH_HPP
#include "custom_map.hpp"
#include "custom_set.hpp"
#include "edge_info.hpp"  // for EdgeInfo, EdgeIn...
#include "graph.hpp"      // for graph, vertex
#include "graph_info.hpp" // for GraphInfo
#include "node_info.hpp"  // for NodeInfo
#include "refcount.hpp"   // for refcount, Refcou...

#include <iosfwd> // for ostream
#include <string> // for string

REF_FORWARD_DECL(FunctionBehavior);

#define STD_SELECTOR (1 << 0)
#define FEEDBACK_SELECTOR (1 << 1)

struct FunctionInfo : public NodeInfo
{
   unsigned int nodeID;

   FunctionInfo();
};

struct FunctionEdgeInfo : public EdgeInfo
{
   CustomOrderedSet<unsigned int> direct_call_points;
   CustomOrderedSet<unsigned int> indirect_call_points;
   CustomOrderedSet<unsigned int> function_addresses;

   enum class CallType
   {
      direct_call,
      indirect_call,
      function_address,
      call_any
   };

   FunctionEdgeInfo();
};
using FunctionEdgeInfoRef = refcount<FunctionEdgeInfo>;
using FunctionEdgeInfoConstRef = refcount<const FunctionEdgeInfo>;

struct CallGraphInfo : public GraphInfo
{
 public:
   std::map<unsigned int, FunctionBehaviorRef> behaviors;
};
using CallGraphInfoRef = refcount<CallGraphInfo>;
using CallGraphInfoConstRef = refcount<const CallGraphInfo>;

class CallGraphsCollection : public graphs_collection
{
 public:
   CallGraphsCollection(const CallGraphInfoRef call_graph_info, const ParameterConstRef _parameters);

   ~CallGraphsCollection() override;

   inline EdgeDescriptor AddEdge(const vertex source, const vertex target, const int selector)
   {
      if(ExistsEdge(source, target))
      {
         return AddSelector(source, target, selector);
      }
      else
      {
         return InternalAddEdge(source, target, selector, EdgeInfoRef(new FunctionEdgeInfo()));
      }
   }
};
using CallGraphsCollectionRef = refcount<CallGraphsCollection>;
using CallGraphsCollectionConstRef = refcount<const CallGraphsCollection>;

class CallGraph : public graph
{
 public:
   CallGraph(const CallGraphsCollectionRef call_graphs_collection, const int selector);

   CallGraph(const CallGraphsCollectionRef call_graphs_collection, const int selector,
             const CustomUnorderedSet<vertex>& vertices);

   ~CallGraph() override;

   inline const FunctionEdgeInfoConstRef CGetFunctionEdgeInfo(const EdgeDescriptor edge) const
   {
      return RefcountCast<const FunctionEdgeInfo>(graph::CGetEdgeInfo(edge));
   }

   inline const CallGraphInfoConstRef CGetCallGraphInfo() const
   {
      return RefcountCast<const CallGraphInfo>(graph::CGetGraphInfo());
   }

   inline CallGraphInfoRef GetCallGraphInfo()
   {
      return RefcountCast<CallGraphInfo>(graph::GetGraphInfo());
   }

   void WriteDot(const std::string& file_name) const;
};
using CallGraphRef = refcount<CallGraph>;
using CallGraphConstRef = refcount<const CallGraph>;

class FunctionWriter : public VertexWriter
{
 private:
   const std::map<unsigned int, FunctionBehaviorRef>& behaviors;

 public:
   explicit FunctionWriter(const CallGraph* call_graph);

   void operator()(std::ostream& out, const vertex& v) const override;
};

class FunctionEdgeWriter : public EdgeWriter
{
 private:
   const std::map<unsigned int, FunctionBehaviorRef>& behaviors;

 public:
   explicit FunctionEdgeWriter(const CallGraph* call_graph);

   ~FunctionEdgeWriter() override;

   void operator()(std::ostream& out, const EdgeDescriptor& e) const override;
};
#endif