maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/llvm/test/Other/cgscc-iterate-function-muta...

342 lines
6.3 KiB
LLVM
Raw Normal View History

[PM] Introduce basic update capabilities to the new PM's CGSCC pass manager, including both plumbing and logic to handle function pass updates. There are three fundamentally tied changes here: 1) Plumbing *some* mechanism for updating the CGSCC pass manager as the CG changes while passes are running. 2) Changing the CGSCC pass manager infrastructure to have support for the underlying graph to mutate mid-pass run. 3) Actually updating the CG after function passes run. I can separate them if necessary, but I think its really useful to have them together as the needs of #3 drove #2, and that in turn drove #1. The plumbing technique is to extend the "run" method signature with extra arguments. We provide the call graph that intrinsically is available as it is the basis of the pass manager's IR units, and an output parameter that records the results of updating the call graph during an SCC passes's run. Note that "...UpdateResult" isn't a *great* name here... suggestions very welcome. I tried a pretty frustrating number of different data structures and such for the innards of the update result. Every other one failed for one reason or another. Sometimes I just couldn't keep the layers of complexity right in my head. The thing that really worked was to just directly provide access to the underlying structures used to walk the call graph so that their updates could be informed by the *particular* nature of the change to the graph. The technique for how to make the pass management infrastructure cope with mutating graphs was also something that took a really, really large number of iterations to get to a place where I was happy. Here are some of the considerations that drove the design: - We operate at three levels within the infrastructure: RefSCC, SCC, and Node. In each case, we are working bottom up and so we want to continue to iterate on the "lowest" node as the graph changes. Look at how we iterate over nodes in an SCC running function passes as those function passes mutate the CG. We continue to iterate on the "lowest" SCC, which is the one that continues to contain the function just processed. - The call graph structure re-uses SCCs (and RefSCCs) during mutation events for the *highest* entry in the resulting new subgraph, not the lowest. This means that it is necessary to continually update the current SCC or RefSCC as it shifts. This is really surprising and subtle, and took a long time for me to work out. I actually tried changing the call graph to provide the opposite behavior, and it breaks *EVERYTHING*. The graph update algorithms are really deeply tied to this particualr pattern. - When SCCs or RefSCCs are split apart and refined and we continually re-pin our processing to the bottom one in the subgraph, we need to enqueue the newly formed SCCs and RefSCCs for subsequent processing. Queuing them presents a few challenges: 1) SCCs and RefSCCs use wildly different iteration strategies at a high level. We end up needing to converge them on worklist approaches that can be extended in order to be able to handle the mutations. 2) The order of the enqueuing need to remain bottom-up post-order so that we don't get surprising order of visitation for things like the inliner. 3) We need the worklists to have set semantics so we don't duplicate things endlessly. We don't need a *persistent* set though because we always keep processing the bottom node!!!! This is super, super surprising to me and took a long time to convince myself this is correct, but I'm pretty sure it is... Once we sink down to the bottom node, we can't re-split out the same node in any way, and the postorder of the current queue is fixed and unchanging. 4) We need to make sure that the "current" SCC or RefSCC actually gets enqueued here such that we re-visit it because we continue processing a *new*, *bottom* SCC/RefSCC. - We also need the ability to *skip* SCCs and RefSCCs that get merged into a larger component. We even need the ability to skip *nodes* from an SCC that are no longer part of that SCC. This led to the design you see in the patch which uses SetVector-based worklists. The RefSCC worklist is always empty until an update occurs and is just used to handle those RefSCCs created by updates as the others don't even exist yet and are formed on-demand during the bottom-up walk. The SCC worklist is pre-populated from the RefSCC, and we push new SCCs onto it and blacklist existing SCCs on it to get the desired processing. We then *directly* update these when updating the call graph as I was never able to find a satisfactory abstraction around the update strategy. Finally, we need to compute the updates for function passes. This is mostly used as an initial customer of all the update mechanisms to drive their design to at least cover some real set of use cases. There are a bunch of interesting things that came out of doing this: - It is really nice to do this a function at a time because that function is likely hot in the cache. This means we want even the function pass adaptor to support online updates to the call graph! - To update the call graph after arbitrary function pass mutations is quite hard. We have to build a fairly comprehensive set of data structures and then process them. Fortunately, some of this code is related to the code for building the cal graph in the first place. Unfortunately, very little of it makes any sense to share because the nature of what we're doing is so very different. I've factored out the one part that made sense at least. - We need to transfer these updates into the various structures for the CGSCC pass manager. Once those were more sanely worked out, this became relatively easier. But some of those needs necessitated changes to the LazyCallGraph interface to make it significantly easier to extract the changed SCCs from an update operation. - We also need to update the CGSCC analysis manager as the shape of the graph changes. When an SCC is merged away we need to clear analyses associated with it from the analysis manager which we didn't have support for in the analysis manager infrsatructure. New SCCs are easy! But then we have the case that the original SCC has its shape changed but remains in the call graph. There we need to *invalidate* the analyses associated with it. - We also need to invalidate analyses after we *finish* processing an SCC. But the analyses we need to invalidate here are *only those for the newly updated SCC*!!! Because we only continue processing the bottom SCC, if we split SCCs apart the original one gets invalidated once when its shape changes and is not processed farther so its analyses will be correct. It is the bottom SCC which continues being processed and needs to have the "normal" invalidation done based on the preserved analyses set. All of this is mostly background and context for the changes here. Many thanks to all the reviewers who helped here. Especially Sanjoy who caught several interesting bugs in the graph algorithms, David, Sean, and others who all helped with feedback. Differential Revision: http://reviews.llvm.org/D21464 llvm-svn: 279618
2016-08-24 17:37:14 +08:00
; RUN: opt -aa-pipeline=basic-aa -passes='cgscc(function-attrs,function(simplify-cfg))' -S < %s | FileCheck %s
declare void @readnone() readnone
declare void @unknown()
declare void @reference_function_pointer(void()*) readnone
; The @test1_* set of functions checks that when we mutate functions with
; simplify-cfg to delete call edges and this ends up splitting both the SCCs
; and the RefSCCs that those functions are in, we re-run the CGSCC passes to
; observe the refined call graph structure.
; CHECK: define void @test1_a() {
define void @test1_a() {
call void @test1_b1()
call void @test1_b2()
call void @test1_b3()
call void @test1_b4()
ret void
}
; CHECK: define void @test1_b1() #0 {
define void @test1_b1() {
call void @readnone()
ret void
}
; CHECK: define void @test1_b2() #0 {
define void @test1_b2() {
call void @readnone()
br i1 false, label %dead, label %exit
dead:
call void @test1_a()
br label %exit
exit:
ret void
}
; CHECK: define void @test1_b3() {
define void @test1_b3() {
call void @unknown()
br i1 false, label %dead, label %exit
dead:
call void @test1_a()
br label %exit
exit:
ret void
}
; CHECK: define void @test1_b4() #0 {
define void @test1_b4() {
call void @readnone()
br i1 false, label %dead, label %exit
dead:
call void @test1_a()
br label %exit
exit:
ret void
}
; The @test2_* set of functions provide similar checks to @test1_* but only
; splitting the SCCs while leaving the RefSCC intact. This is accomplished by
; having dummy ref edges to the root function.
; CHECK: define void @test2_a() {
define void @test2_a() {
call void @test2_b1()
call void @test2_b2()
call void @test2_b3()
call void @test2_b4()
ret void
}
; CHECK: define void @test2_b1() #0 {
define void @test2_b1() {
call void @readnone()
ret void
}
; CHECK: define void @test2_b2() #0 {
define void @test2_b2() {
call void @reference_function_pointer(void()* @test2_a)
br i1 false, label %dead, label %exit
dead:
call void @test2_a()
br label %exit
exit:
ret void
}
; CHECK: define void @test2_b3() {
define void @test2_b3() {
call void @reference_function_pointer(void()* @test2_a)
call void @unknown()
br i1 false, label %dead, label %exit
dead:
call void @test2_a()
br label %exit
exit:
ret void
}
; CHECK: define void @test2_b4() #0 {
define void @test2_b4() {
call void @reference_function_pointer(void()* @test2_a)
br i1 false, label %dead, label %exit
dead:
call void @test2_a()
br label %exit
exit:
ret void
}
; The @test3_* set of functions are the same challenge as @test1_* but with
; multiple layers that have to be traversed in the correct order instead of
; a single node.
; CHECK: define void @test3_a() {
define void @test3_a() {
call void @test3_b11()
call void @test3_b21()
call void @test3_b31()
call void @test3_b41()
ret void
}
; CHECK: define void @test3_b11() #0 {
define void @test3_b11() {
call void @test3_b12()
ret void
}
; CHECK: define void @test3_b12() #0 {
define void @test3_b12() {
call void @test3_b13()
ret void
}
; CHECK: define void @test3_b13() #0 {
define void @test3_b13() {
call void @readnone()
ret void
}
; CHECK: define void @test3_b21() #0 {
define void @test3_b21() {
call void @test3_b22()
ret void
}
; CHECK: define void @test3_b22() #0 {
define void @test3_b22() {
call void @test3_b23()
ret void
}
; CHECK: define void @test3_b23() #0 {
define void @test3_b23() {
call void @readnone()
br i1 false, label %dead, label %exit
dead:
call void @test3_a()
br label %exit
exit:
ret void
}
; CHECK: define void @test3_b31() {
define void @test3_b31() {
call void @test3_b32()
ret void
}
; CHECK: define void @test3_b32() {
define void @test3_b32() {
call void @test3_b33()
ret void
}
; CHECK: define void @test3_b33() {
define void @test3_b33() {
call void @unknown()
br i1 false, label %dead, label %exit
dead:
call void @test3_a()
br label %exit
exit:
ret void
}
; CHECK: define void @test3_b41() #0 {
define void @test3_b41() {
call void @test3_b42()
ret void
}
; CHECK: define void @test3_b42() #0 {
define void @test3_b42() {
call void @test3_b43()
ret void
}
; CHECK: define void @test3_b43() #0 {
define void @test3_b43() {
call void @readnone()
br i1 false, label %dead, label %exit
dead:
call void @test3_a()
br label %exit
exit:
ret void
}
; The @test4_* functions exercise the same core challenge as the @test2_*
; functions, but again include long chains instead of single nodes and ensure
; we traverse the chains in the correct order.
; CHECK: define void @test4_a() {
define void @test4_a() {
call void @test4_b11()
call void @test4_b21()
call void @test4_b31()
call void @test4_b41()
ret void
}
; CHECK: define void @test4_b11() #0 {
define void @test4_b11() {
call void @test4_b12()
ret void
}
; CHECK: define void @test4_b12() #0 {
define void @test4_b12() {
call void @test4_b13()
ret void
}
; CHECK: define void @test4_b13() #0 {
define void @test4_b13() {
call void @readnone()
ret void
}
; CHECK: define void @test4_b21() #0 {
define void @test4_b21() {
call void @test4_b22()
ret void
}
; CHECK: define void @test4_b22() #0 {
define void @test4_b22() {
call void @test4_b23()
ret void
}
; CHECK: define void @test4_b23() #0 {
define void @test4_b23() {
call void @reference_function_pointer(void()* @test4_a)
br i1 false, label %dead, label %exit
dead:
call void @test4_a()
br label %exit
exit:
ret void
}
; CHECK: define void @test4_b31() {
define void @test4_b31() {
call void @test4_b32()
ret void
}
; CHECK: define void @test4_b32() {
define void @test4_b32() {
call void @test4_b33()
ret void
}
; CHECK: define void @test4_b33() {
define void @test4_b33() {
call void @reference_function_pointer(void()* @test4_a)
call void @unknown()
br i1 false, label %dead, label %exit
dead:
call void @test4_a()
br label %exit
exit:
ret void
}
; CHECK: define void @test4_b41() #0 {
define void @test4_b41() {
call void @test4_b42()
ret void
}
; CHECK: define void @test4_b42() #0 {
define void @test4_b42() {
call void @test4_b43()
ret void
}
; CHECK: define void @test4_b43() #0 {
define void @test4_b43() {
call void @reference_function_pointer(void()* @test4_a)
br i1 false, label %dead, label %exit
dead:
call void @test4_a()
br label %exit
exit:
ret void
}
; CHECK: attributes #0 = { readnone }