[llvm] r222149 - Fix GraphTraits for "const CallGraphNode *" and "const CallGraph *"

[NAKAMURA Takumi]

2014-11-18 2:51 GMT+09:00 Rafael Espindola <rafael.espindola at gmail.com>:
> Author: rafael
> Date: Mon Nov 17 11:51:45 2014
> New Revision: 222149
>
> URL: http://llvm.org/viewvc/llvm-project?rev=222149&view=rev
> Log:
> Fix GraphTraits for "const CallGraphNode *" and "const CallGraph *"
>
> The specializations were broken. For example,
>
> void foo(const CallGraph *G) {
>   auto I = GraphTraits<const CallGraph *>::nodes_begin(G);
>   auto K = I++;
>
>   ...
> }
>
> or
>
> void bar(const CallGraphNode *N) {
>   auto I = GraphTraits<const CallGraphNode *>::nodes_begin(G);
>   auto K = I++;
>
>   ....
> }
>
> would not compile.
>
> Patch by Speziale Ettore!
>
> Added:
>     llvm/trunk/unittests/Analysis/CallGraphTest.cpp
> Modified:
>     llvm/trunk/include/llvm/Analysis/CallGraph.h
>     llvm/trunk/unittests/Analysis/CMakeLists.txt
>     llvm/trunk/unittests/Analysis/Makefile
>
> Modified: llvm/trunk/include/llvm/Analysis/CallGraph.h
> URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Analysis/CallGraph.h?rev=222149&r1=222148&r2=222149&view=diff
> ==============================================================================
> --- llvm/trunk/include/llvm/Analysis/CallGraph.h (original)
> +++ llvm/trunk/include/llvm/Analysis/CallGraph.h Mon Nov 17 11:51:45 2014
> @@ -417,13 +417,24 @@ template <> struct GraphTraits<CallGraph
>
>  template <> struct GraphTraits<const CallGraphNode *> {
>    typedef const CallGraphNode NodeType;
> -  typedef NodeType::const_iterator ChildIteratorType;
> +
> +  typedef CallGraphNode::CallRecord CGNPairTy;
> +  typedef std::pointer_to_unary_function<CGNPairTy, const CallGraphNode *>
> +      CGNDerefFun;
>
>    static NodeType *getEntryNode(const CallGraphNode *CGN) { return CGN; }
> +
> +  typedef mapped_iterator<NodeType::const_iterator, CGNDerefFun>
> +      ChildIteratorType;
> +
>    static inline ChildIteratorType child_begin(NodeType *N) {
> -    return N->begin();
> +    return map_iterator(N->begin(), CGNDerefFun(CGNDeref));
>    }
> -  static inline ChildIteratorType child_end(NodeType *N) { return N->end(); }
> +  static inline ChildIteratorType child_end(NodeType *N) {
> +    return map_iterator(N->end(), CGNDerefFun(CGNDeref));
> +  }
> +
> +  static const CallGraphNode *CGNDeref(CGNPairTy P) { return P.second; }
>  };
>
>  template <>
> @@ -450,12 +461,22 @@ template <>
>  struct GraphTraits<const CallGraph *> : public GraphTraits<
>                                              const CallGraphNode *> {
>    static NodeType *getEntryNode(const CallGraph *CGN) {
> -    return CGN->getExternalCallingNode();
> +    return CGN->getExternalCallingNode(); // Start at the external node!
>    }
> +  typedef std::pair<const Function *, const CallGraphNode *> PairTy;
> +  typedef std::pointer_to_unary_function<PairTy, const CallGraphNode &>
> +      DerefFun;
> +
>    // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
> -  typedef CallGraph::const_iterator nodes_iterator;
> -  static nodes_iterator nodes_begin(const CallGraph *CG) { return CG->begin(); }
> -  static nodes_iterator nodes_end(const CallGraph *CG) { return CG->end(); }
> +  typedef mapped_iterator<CallGraph::const_iterator, DerefFun> nodes_iterator;
> +  static nodes_iterator nodes_begin(const CallGraph *CG) {
> +    return map_iterator(CG->begin(), DerefFun(CGdereference));
> +  }
> +  static nodes_iterator nodes_end(const CallGraph *CG) {
> +    return map_iterator(CG->end(), DerefFun(CGdereference));
> +  }
> +
> +  static const CallGraphNode &CGdereference(PairTy P) { return *P.second; }
>  };
>
>  } // End llvm namespace
>
> Modified: llvm/trunk/unittests/Analysis/CMakeLists.txt
> URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/unittests/Analysis/CMakeLists.txt?rev=222149&r1=222148&r2=222149&view=diff
> ==============================================================================
> --- llvm/trunk/unittests/Analysis/CMakeLists.txt (original)
> +++ llvm/trunk/unittests/Analysis/CMakeLists.txt Mon Nov 17 11:51:45 2014
> @@ -1,4 +1,5 @@
>  set(LLVM_LINK_COMPONENTS
> +  IPA
>    Analysis
>    AsmParser
>    Core
> @@ -6,6 +7,7 @@ set(LLVM_LINK_COMPONENTS
>    )
>
>  add_llvm_unittest(AnalysisTests
> +  CallGraphTest.cpp
>    CFGTest.cpp
>    LazyCallGraphTest.cpp
>    ScalarEvolutionTest.cpp
>
> Added: llvm/trunk/unittests/Analysis/CallGraphTest.cpp
> URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/unittests/Analysis/CallGraphTest.cpp?rev=222149&view=auto
> ==============================================================================
> --- llvm/trunk/unittests/Analysis/CallGraphTest.cpp (added)
> +++ llvm/trunk/unittests/Analysis/CallGraphTest.cpp Mon Nov 17 11:51:45 2014
> @@ -0,0 +1,62 @@
> +//=======- CallGraphTest.cpp - Unit tests for the CG analysis -------------===//
> +//
> +//                     The LLVM Compiler Infrastructure
> +//
> +// This file is distributed under the University of Illinois Open Source
> +// License. See LICENSE.TXT for details.
> +//
> +//===----------------------------------------------------------------------===//
> +
> +#include "llvm/Analysis/CallGraph.h"
> +#include "llvm/IR/LLVMContext.h"
> +#include "llvm/IR/Module.h"
> +#include "gtest/gtest.h"
> +
> +using namespace llvm;
> +
> +namespace {
> +
> +template <typename Ty> void canSpecializeGraphTraitsIterators(Ty *G) {
> +  typedef typename GraphTraits<Ty *>::NodeType NodeTy;
> +
> +  auto I = GraphTraits<Ty *>::nodes_begin(G);
> +  auto E = GraphTraits<Ty *>::nodes_end(G);
> +  auto X = ++I;
> +
> +  // Should be able to iterate over all nodes of the graph.
> +  static_assert(std::is_same<decltype(*I), NodeTy &>::value,
> +                "Node type does not match");
> +  static_assert(std::is_same<decltype(*X), NodeTy &>::value,
> +                "Node type does not match");
> +  static_assert(std::is_same<decltype(*E), NodeTy &>::value,
> +                "Node type does not match");
> +
> +  NodeTy *N = GraphTraits<Ty *>::getEntryNode(G);
> +
> +  auto S = GraphTraits<NodeTy *>::child_begin(N);
> +  auto F = GraphTraits<NodeTy *>::child_end(N);
> +  auto Y = ++S;

It is invalid if S == F. MSVC Debug runtime detects it.
http://bb.pgr.jp/builders/msbuild-llvmclang-x64-msc17-DA/builds/1250

Tweaked in r222233.

> +
> +  // Should be able to iterate over immediate successors of a node.
> +  static_assert(std::is_same<decltype(*S), NodeTy *>::value,
> +                "Node type does not match");
> +  static_assert(std::is_same<decltype(*F), NodeTy *>::value,
> +                "Node type does not match");
> +  static_assert(std::is_same<decltype(*Y), NodeTy *>::value,
> +                "Node type does not match");
> +}
> +
> +TEST(CallGraphTest, GraphTraitsSpecialization) {
> +  Module M("", getGlobalContext());
> +  CallGraph CG(M);
> +
> +  canSpecializeGraphTraitsIterators(&CG);
> +}
> +
> +TEST(CallGraphTest, GraphTraitsConstSpecialization) {
> +  Module M("", getGlobalContext());
> +  CallGraph CG(M);
> +
> +  canSpecializeGraphTraitsIterators(const_cast<const CallGraph *>(&CG));
> +}
> +}
>
> Modified: llvm/trunk/unittests/Analysis/Makefile
> URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/unittests/Analysis/Makefile?rev=222149&r1=222148&r2=222149&view=diff
> ==============================================================================
> --- llvm/trunk/unittests/Analysis/Makefile (original)
> +++ llvm/trunk/unittests/Analysis/Makefile Mon Nov 17 11:51:45 2014
> @@ -9,7 +9,7 @@
>
>  LEVEL = ../..
>  TESTNAME = Analysis
> -LINK_COMPONENTS := analysis asmparser
> +LINK_COMPONENTS := ipa analysis asmparser
>
>  include $(LEVEL)/Makefile.config
>  include $(LLVM_SRC_ROOT)/unittests/Makefile.unittest
>
>
> _______________________________________________
> llvm-commits mailing list
> llvm-commits at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits