svf-tools 1.0.595 → 1.0.597

package/include/Graphs/DOTGraphTraits.h

@@ -0,0 +1,188 @@
+//===-- Graphs/DOTGraphTraits.h - Customize .dot output ---*- C++ -*-===//
+//
+// From the LLVM Project with some modifications, under the Apache License v2.0
+// with LLVM Exceptions. See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines a template class that can be used to customize dot output
+// graphs generated by the GraphWriter.h file.  The default implementation of
+// this file will produce a simple, but not very polished graph.  By
+// specializing this template, lots of customization opportunities are possible.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef GRAPHS_DOTGRAPHTRAITS_H
+#define GRAPHS_DOTGRAPHTRAITS_H
+
+#include <string>
+
+namespace SVF
+{
+
+/// DefaultDOTGraphTraits - This class provides the default implementations of
+/// all of the DOTGraphTraits methods.  If a specialization does not need to
+/// override all methods here it should inherit so that it can get the default
+/// implementations.
+///
+struct DefaultDOTGraphTraits
+{
+private:
+    bool IsSimple;
+
+protected:
+    bool isSimple()
+    {
+        return IsSimple;
+    }
+
+public:
+    explicit DefaultDOTGraphTraits(bool simple=false) : IsSimple (simple) {}
+
+    /// getGraphName - Return the label for the graph as a whole.  Printed at the
+    /// top of the graph.
+    ///
+    template<typename GraphType>
+    static std::string getGraphName(const GraphType &)
+    {
+        return "";
+    }
+
+    /// getGraphProperties - Return any custom properties that should be included
+    /// in the top level graph structure for dot.
+    ///
+    template<typename GraphType>
+    static std::string getGraphProperties(const GraphType &)
+    {
+        return "";
+    }
+
+    /// renderGraphFromBottomUp - If this function returns true, the graph is
+    /// emitted bottom-up instead of top-down.  This requires graphviz 2.0 to work
+    /// though.
+    static bool renderGraphFromBottomUp()
+    {
+        return false;
+    }
+
+    /// isNodeHidden - If the function returns true, the given node is not
+    /// displayed in the graph.
+    template <typename GraphType>
+    static bool isNodeHidden(const void *, const GraphType &)
+    {
+        return false;
+    }
+
+    /// getNodeLabel - Given a node and a pointer to the top level graph, return
+    /// the label to print in the node.
+    template<typename GraphType>
+    std::string getNodeLabel(const void *, const GraphType &)
+    {
+        return "";
+    }
+
+    // getNodeIdentifierLabel - Returns a string representing the
+    // address or other unique identifier of the node. (Only used if
+    // non-empty.)
+    template <typename GraphType>
+    static std::string getNodeIdentifierLabel(const void *, const GraphType &)
+    {
+        return "";
+    }
+
+    template<typename GraphType>
+    static std::string getNodeDescription(const void *, const GraphType &)
+    {
+        return "";
+    }
+
+    /// If you want to specify custom node attributes, this is the place to do so
+    ///
+    template<typename GraphType>
+    static std::string getNodeAttributes(const void *,
+                                         const GraphType &)
+    {
+        return "";
+    }
+
+    /// If you want to override the dot attributes printed for a particular edge,
+    /// override this method.
+    template<typename EdgeIter, typename GraphType>
+    static std::string getEdgeAttributes(const void *, EdgeIter,
+                                         const GraphType &)
+    {
+        return "";
+    }
+
+    /// getEdgeSourceLabel - If you want to label the edge source itself,
+    /// implement this method.
+    template<typename EdgeIter>
+    static std::string getEdgeSourceLabel(const void *, EdgeIter)
+    {
+        return "";
+    }
+
+    /// edgeTargetsEdgeSource - This method returns true if this outgoing edge
+    /// should actually target another edge source, not a node.  If this method is
+    /// implemented, getEdgeTarget should be implemented.
+    template<typename EdgeIter>
+    static bool edgeTargetsEdgeSource(const void *, EdgeIter)
+    {
+        return false;
+    }
+
+    /// getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is
+    /// called to determine which outgoing edge of Node is the target of this
+    /// edge.
+    template<typename EdgeIter>
+    static EdgeIter getEdgeTarget(const void *, EdgeIter I)
+    {
+        return I;
+    }
+
+    /// hasEdgeDestLabels - If this function returns true, the graph is able
+    /// to provide labels for edge destinations.
+    static bool hasEdgeDestLabels()
+    {
+        return false;
+    }
+
+    /// numEdgeDestLabels - If hasEdgeDestLabels, this function returns the
+    /// number of incoming edge labels the given node has.
+    static unsigned numEdgeDestLabels(const void *)
+    {
+        return 0;
+    }
+
+    /// getEdgeDestLabel - If hasEdgeDestLabels, this function returns the
+    /// incoming edge label with the given index in the given node.
+    static std::string getEdgeDestLabel(const void *, unsigned)
+    {
+        return "";
+    }
+
+    /// addCustomGraphFeatures - If a graph is made up of more than just
+    /// straight-forward nodes and edges, this is the place to put all of the
+    /// custom stuff necessary.  The GraphWriter object, instantiated with your
+    /// GraphType is passed in as an argument.  You may call arbitrary methods on
+    /// it to add things to the output graph.
+    ///
+    template<typename GraphType, typename GraphWriter>
+    static void addCustomGraphFeatures(const GraphType &, GraphWriter &) {}
+};
+
+
+/// DOTGraphTraits - Template class that can be specialized to customize how
+/// graphs are converted to 'dot' graphs.  When specializing, you may inherit
+/// from DefaultDOTGraphTraits if you don't need to override everything.
+///
+template <typename Ty>
+struct DOTGraphTraits : public DefaultDOTGraphTraits
+{
+    DOTGraphTraits (bool simple=false) : DefaultDOTGraphTraits (simple) {}
+};
+
+} // End llvm namespace
+
+#endif

package/include/Graphs/GenericGraph.h

@@ -31,6 +31,8 @@
 #define GENERICGRAPH_H_
 
 #include "SVFIR/SVFValue.h"
+#include "Util/iterator.h"
+#include "Graphs/GraphTraits.h"
 
 namespace SVF
 {
@@ -446,16 +448,54 @@ public:
 } // End namespace SVF
 
 /* !
- * GraphTraits specializations for generic graph algorithms.
+ * GenericGraphTraits specializations for generic graph algorithms.
  * Provide graph traits for tranversing from a node using standard graph traversals.
  */
-namespace llvm
+namespace SVF
+{
+
+// mapped_iter - This is a simple iterator adapter that causes a function to
+// be applied whenever operator* is invoked on the iterator.
+
+template <typename ItTy, typename FuncTy,
+          typename FuncReturnTy =
+          decltype(std::declval<FuncTy>()(*std::declval<ItTy>()))>
+class mapped_iter
+    : public iter_adaptor_base<
+      mapped_iter<ItTy, FuncTy>, ItTy,
+      typename std::iterator_traits<ItTy>::iterator_category,
+      typename std::remove_reference<FuncReturnTy>::type>
+{
+public:
+    mapped_iter(ItTy U, FuncTy F)
+        : mapped_iter::iter_adaptor_base(std::move(U)), F(std::move(F)) {}
+
+    ItTy getCurrent()
+    {
+        return this->I;
+    }
+
+    FuncReturnTy operator*() const
+    {
+        return F(*this->I);
+    }
+
+private:
+    FuncTy F;
+};
+
+// map_iter - Provide a convenient way to create mapped_iters, just like
+// make_pair is useful for creating pairs...
+template <class ItTy, class FuncTy>
+inline mapped_iter<ItTy, FuncTy> map_iter(ItTy I, FuncTy F)
 {
+    return mapped_iter<ItTy, FuncTy>(std::move(I), std::move(F));
+}
 
 /*!
- * GraphTraits for nodes
+ * GenericGraphTraits for nodes
  */
-template<class NodeTy,class EdgeTy> struct GraphTraits<SVF::GenericNode<NodeTy,EdgeTy>*  >
+template<class NodeTy,class EdgeTy> struct GenericGraphTraits<SVF::GenericNode<NodeTy,EdgeTy>*  >
 {
     typedef NodeTy NodeType;
     typedef EdgeTy EdgeType;
@@ -466,7 +506,7 @@ template<class NodeTy,class EdgeTy> struct GraphTraits<SVF::GenericNode<NodeTy,E
     }
 
     // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
-    typedef mapped_iterator<typename SVF::GenericNode<NodeTy,EdgeTy>::iterator, decltype(&edge_dest)> ChildIteratorType;
+    typedef mapped_iter<typename SVF::GenericNode<NodeTy,EdgeTy>::iterator, decltype(&edge_dest)> ChildIteratorType;
 
     static NodeType* getEntryNode(NodeType* pagN)
     {
@@ -475,27 +515,27 @@ template<class NodeTy,class EdgeTy> struct GraphTraits<SVF::GenericNode<NodeTy,E
 
     static inline ChildIteratorType child_begin(const NodeType* N)
     {
-        return map_iterator(N->OutEdgeBegin(), &edge_dest);
+        return map_iter(N->OutEdgeBegin(), &edge_dest);
     }
     static inline ChildIteratorType child_end(const NodeType* N)
     {
-        return map_iterator(N->OutEdgeEnd(), &edge_dest);
+        return map_iter(N->OutEdgeEnd(), &edge_dest);
     }
     static inline ChildIteratorType direct_child_begin(const NodeType *N)
     {
-        return map_iterator(N->directOutEdgeBegin(), &edge_dest);
+        return map_iter(N->directOutEdgeBegin(), &edge_dest);
     }
     static inline ChildIteratorType direct_child_end(const NodeType *N)
     {
-        return map_iterator(N->directOutEdgeEnd(), &edge_dest);
+        return map_iter(N->directOutEdgeEnd(), &edge_dest);
     }
 };
 
 /*!
- * Inverse GraphTraits for node which is used for inverse traversal.
+ * Inverse GenericGraphTraits for node which is used for inverse traversal.
  */
 template<class NodeTy,class EdgeTy>
-struct GraphTraits<Inverse<SVF::GenericNode<NodeTy,EdgeTy>* > >
+struct GenericGraphTraits<Inverse<SVF::GenericNode<NodeTy,EdgeTy>* > >
 {
     typedef NodeTy NodeType;
     typedef EdgeTy EdgeType;
@@ -506,7 +546,7 @@ struct GraphTraits<Inverse<SVF::GenericNode<NodeTy,EdgeTy>* > >
     }
 
     // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
-    typedef mapped_iterator<typename SVF::GenericNode<NodeTy,EdgeTy>::iterator, decltype(&edge_dest)> ChildIteratorType;
+    typedef mapped_iter<typename SVF::GenericNode<NodeTy,EdgeTy>::iterator, decltype(&edge_dest)> ChildIteratorType;
 
     static inline NodeType* getEntryNode(Inverse<NodeType* > G)
     {
@@ -515,11 +555,11 @@ struct GraphTraits<Inverse<SVF::GenericNode<NodeTy,EdgeTy>* > >
 
     static inline ChildIteratorType child_begin(const NodeType* N)
     {
-        return map_iterator(N->InEdgeBegin(), &edge_dest);
+        return map_iter(N->InEdgeBegin(), &edge_dest);
     }
     static inline ChildIteratorType child_end(const NodeType* N)
     {
-        return map_iterator(N->InEdgeEnd(), &edge_dest);
+        return map_iter(N->InEdgeEnd(), &edge_dest);
     }
 
     static inline unsigned getNodeID(const NodeType* N)
@@ -531,7 +571,7 @@ struct GraphTraits<Inverse<SVF::GenericNode<NodeTy,EdgeTy>* > >
 /*!
  * GraphTraints
  */
-template<class NodeTy,class EdgeTy> struct GraphTraits<SVF::GenericGraph<NodeTy,EdgeTy>* > : public GraphTraits<SVF::GenericNode<NodeTy,EdgeTy>*  >
+template<class NodeTy,class EdgeTy> struct GenericGraphTraits<SVF::GenericGraph<NodeTy,EdgeTy>* > : public GenericGraphTraits<SVF::GenericNode<NodeTy,EdgeTy>*  >
 {
     typedef SVF::GenericGraph<NodeTy,EdgeTy> GenericGraphTy;
     typedef NodeTy NodeType;
@@ -549,15 +589,15 @@ template<class NodeTy,class EdgeTy> struct GraphTraits<SVF::GenericGraph<NodeTy,
     }
 
     // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
-    typedef mapped_iterator<typename GenericGraphTy::iterator, decltype(&deref_val)> nodes_iterator;
+    typedef mapped_iter<typename GenericGraphTy::iterator, decltype(&deref_val)> nodes_iterator;
 
     static nodes_iterator nodes_begin(GenericGraphTy *G)
     {
-        return map_iterator(G->begin(), &deref_val);
+        return map_iter(G->begin(), &deref_val);
     }
     static nodes_iterator nodes_end(GenericGraphTy *G)
     {
-        return map_iterator(G->end(), &deref_val);
+        return map_iter(G->end(), &deref_val);
     }
 
     static unsigned graphSize(GenericGraphTy* G)

package/include/Graphs/GraphPrinter.h

@@ -32,12 +32,10 @@
 #define INCLUDE_GRAPHS_GRAPHPRINTER_H_
 
 #include <system_error>
-#include <llvm/Support/ToolOutputFile.h>
-#include <llvm/Support/GraphWriter.h>		// for graph write
-#include <llvm/Support/FileSystem.h>		// for file open flag
-#include <llvm/ADT/GraphTraits.h>
+#include "Graphs/GraphWriter.h"	// for graph write
+#include <fstream>
 
-namespace llvm
+namespace SVF
 {
 
 /*
@@ -60,24 +58,18 @@ public:
     {
         // Filename of the output dot file
         std::string Filename = GraphName + ".dot";
-        O << "Writing '" << Filename << "'...";
-        std::error_code ErrInfo;
-        llvm::ToolOutputFile F(Filename.c_str(), ErrInfo, llvm::sys::fs::OF_None);
-
-        if (!ErrInfo)
+        std::ofstream outFile(Filename);
+        if (outFile.fail())
         {
-            // dump the ValueFlowGraph here
-            WriteGraph(F.os(), GT, simple);
-            F.os().close();
-            if (!F.os().has_error())
-            {
-                O << "\n";
-                F.keep();
-                return;
-            }
+            O << "  error opening file for writing!\n";
+            outFile.close();
+            return;
         }
-        O << "  error opening file for writing!\n";
-        F.os().clear_error();
+
+        O << "Writing '" << Filename << "'...";
+
+        WriteGraph(outFile, GT, simple);
+        outFile.close();
     }
 
     /*!
@@ -88,7 +80,7 @@ public:
                            const GraphType &GT)
     {
         ///Define the GTraits and node iterator for printing
-        typedef llvm::GraphTraits<GraphType> GTraits;
+        typedef GenericGraphTraits<GraphType> GTraits;
 
         typedef typename GTraits::NodeRef NodeRef;
         typedef typename GTraits::nodes_iterator node_iterator;

package/include/Graphs/GraphTraits.h

@@ -0,0 +1,150 @@
+//===- llvm/ADT/GenericGraphTraits.h - Graph traits template -----------*- C++ -*-===//
+//
+// From the LLVM Project with some modifications, under the Apache License v2.0
+// with LLVM Exceptions. See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines the little GenericGraphTraits<X> template class that should be
+// specialized by classes that want to be iteratable by generic graph iterators.
+//
+// This file also defines the marker class Inverse that is used to iterate over
+// graphs in a graph defined, inverse ordering...
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef GRAPHS_GRAPHTRAITS_H
+#define GRAPHS_GRAPHTRAITS_H
+
+#include "Util/iterator_range.h"
+
+namespace SVF
+{
+
+// GenericGraphTraits - This class should be specialized by different graph types...
+// which is why the default version is empty.
+//
+// This template evolved from supporting `BasicBlock` to also later supporting
+// more complex types (e.g. CFG and DomTree).
+//
+// GenericGraphTraits can be used to create a view over a graph interpreting it
+// differently without requiring a copy of the original graph. This could
+// be achieved by carrying more data in NodeRef. See LoopBodyTraits for one
+// example.
+template<class GraphType>
+struct GenericGraphTraits
+{
+    // Elements to provide:
+
+    // typedef NodeRef           - Type of Node token in the graph, which should
+    //                             be cheap to copy.
+    // typedef ChildIteratorType - Type used to iterate over children in graph,
+    //                             dereference to a NodeRef.
+
+    // static NodeRef getEntryNode(const GraphType &)
+    //    Return the entry node of the graph
+
+    // static ChildIteratorType child_begin(NodeRef)
+    // static ChildIteratorType child_end  (NodeRef)
+    //    Return iterators that point to the beginning and ending of the child
+    //    node list for the specified node.
+
+    // typedef  ...iterator nodes_iterator; - dereference to a NodeRef
+    // static nodes_iterator nodes_begin(GraphType *G)
+    // static nodes_iterator nodes_end  (GraphType *G)
+    //    nodes_iterator/begin/end - Allow iteration over all nodes in the graph
+
+    // typedef EdgeRef           - Type of Edge token in the graph, which should
+    //                             be cheap to copy.
+    // typedef ChildEdgeIteratorType - Type used to iterate over children edges in
+    //                             graph, dereference to a EdgeRef.
+
+    // static ChildEdgeIteratorType child_edge_begin(NodeRef)
+    // static ChildEdgeIteratorType child_edge_end(NodeRef)
+    //     Return iterators that point to the beginning and ending of the
+    //     edge list for the given callgraph node.
+    //
+    // static NodeRef edge_dest(EdgeRef)
+    //     Return the destination node of an edge.
+
+    // static unsigned       size       (GraphType *G)
+    //    Return total number of nodes in the graph
+
+    // If anyone tries to use this class without having an appropriate
+    // specialization, make an error.  If you get this error, it's because you
+    // need to include the appropriate specialization of GenericGraphTraits<> for your
+    // graph, or you need to define it for a new graph type. Either that or
+    // your argument to XXX_begin(...) is unknown or needs to have the proper .h
+    // file #include'd.
+    using NodeRef = typename GraphType::UnknownGraphTypeError;
+};
+
+// Inverse - This class is used as a little marker class to tell the graph
+// iterator to iterate over the graph in a graph defined "Inverse" ordering.
+// Not all graphs define an inverse ordering, and if they do, it depends on
+// the graph exactly what that is.  Here's an example of usage with the
+// df_iterator:
+//
+// idf_iterator<Method*> I = idf_begin(M), E = idf_end(M);
+// for (; I != E; ++I) { ... }
+//
+// Which is equivalent to:
+// df_iterator<Inverse<Method*>> I = idf_begin(M), E = idf_end(M);
+// for (; I != E; ++I) { ... }
+//
+template <class GraphType>
+struct Inverse
+{
+    const GraphType &Graph;
+
+    inline Inverse(const GraphType &G) : Graph(G) {}
+};
+
+// Provide a partial specialization of GenericGraphTraits so that the inverse of an
+// inverse falls back to the original graph.
+template <class T> struct GenericGraphTraits<Inverse<Inverse<T>>> : GenericGraphTraits<T> {};
+
+// Provide iterator ranges for the graph traits nodes and children
+template <class GraphType>
+iter_range<typename GenericGraphTraits<GraphType>::nodes_iterator>
+nodes(const GraphType &G)
+{
+    return make_range(GenericGraphTraits<GraphType>::nodes_begin(G),
+                      GenericGraphTraits<GraphType>::nodes_end(G));
+}
+template <class GraphType>
+iter_range<typename GenericGraphTraits<Inverse<GraphType>>::nodes_iterator>
+        inverse_nodes(const GraphType &G)
+{
+    return make_range(GenericGraphTraits<Inverse<GraphType>>::nodes_begin(G),
+                      GenericGraphTraits<Inverse<GraphType>>::nodes_end(G));
+}
+
+template <class GraphType>
+iter_range<typename GenericGraphTraits<GraphType>::ChildIteratorType>
+children(const typename GenericGraphTraits<GraphType>::NodeRef &G)
+{
+    return make_range(GenericGraphTraits<GraphType>::child_begin(G),
+                      GenericGraphTraits<GraphType>::child_end(G));
+}
+
+template <class GraphType>
+iter_range<typename GenericGraphTraits<Inverse<GraphType>>::ChildIteratorType>
+        inverse_children(const typename GenericGraphTraits<GraphType>::NodeRef &G)
+{
+    return make_range(GenericGraphTraits<Inverse<GraphType>>::child_begin(G),
+                      GenericGraphTraits<Inverse<GraphType>>::child_end(G));
+}
+
+template <class GraphType>
+iter_range<typename GenericGraphTraits<GraphType>::ChildEdgeIteratorType>
+children_edges(const typename GenericGraphTraits<GraphType>::NodeRef &G)
+{
+    return make_range(GenericGraphTraits<GraphType>::child_edge_begin(G),
+                      GenericGraphTraits<GraphType>::child_edge_end(G));
+}
+
+} // end namespace llvm
+
+#endif // LLVM_ADT_GRAPHTRAITS_H