[LLVMdev] How to keep FunctionPass analysis result alive in Module Pass?

[Fan Long]

This surprises me too. Here is the real code from my module pass:

 89 bool SymbolicDataflow::runOnModule(llvm::Module &M) {
 90     // Init per module goes here
 91     AA = &getAnalysis<llvm::AliasAnalysis>();
 92     LIs.clear();
 93     DTs.clear();
 94     for (llvm::Module::iterator it = M.begin(); it != M.end(); ++it) {
 95         llvm::Function *F = &*it;
 96         if (!F->isDeclaration()) {
 97             llvm::LoopInfo *LI = &getAnalysis<llvm::LoopInfo>(*F);
 98             llvm::DominatorTree *DT = &getAnalysis<llvm::DominatorTree>(*F);
 99             LIs[F] = LI;
100             DTs[F] = DT;
101             DEBUG(llvm::errs() << "PASS INIT " << LI << " " << DT << " " << F->getName() << "\n");
102         }
103     }
	……

It prints out the poiner value of each instance, and it is same for all Function… At least on my machine...

Best,
Fan

On Mar 9, 2012, at 5:34 PM, John Criswell wrote:

> On 3/9/12 4:28 PM, Fan Long wrote:
>> 
>> Thank you for your quick reply.
>> 
>> Actually I am using a std::map to map Function* to LoopInfo*, but that does not help in this case. Each time I call         getAnalysis<llvm::LoopInfo>(*F), it returns the same instance of llvm::LoopInfo, so the std::map is just mapping every function into the same instance. It seems only the analysis result for the last function is valid, because all the result for all previous functions are erased.
> 
> Just to make sure I understand: you are saying that every time you call getAnalysis<LoopInfo>(), you get the *same* LoopInfo * regardless of whether you call it on the same function or on a different function.  Is that correct?
> 
> Getting the same LoopInfo * when you call getAnalysis<> on the same function twice would not surprise me.  Getting the same LoopInfo * when you call getAnalysis on F1 and F2 where F1 and F2 are different functions would surprise me greatly.
> 
>> 
>> The only workaround solution I have now is to copy all analysis result out of the data structure of LoopInfo before I call next &getAnalysis(). Because llvm::LoopInfo does not provide copy method, this will be very dirty to do so.
> 
> Yes, that may be what you have to do.
> 
> -- John T.
> 
>> 
>> Best,
>> Fan
>> 
>> On Mar 9, 2012, at 5:20 PM, John Criswell wrote:
>> 
>>> On 3/9/12 4:10 PM, Fan Long wrote:
>>>> 
>>>> Hello,
>>>> 	I am trying to write a new ModulePass using LoopInfo analysis result, but it seems I misunderstand some concept about PassManager. Basically I want to keep LoopInfo analysis result alive. Here is an example showing the problem I encountered, assuming I already addRequired<llvm::LoopInfo>() in getAnalysisUsage:
>>>> 	
>>>> 	void foo(llvm::Function *F1, llvm::Function *F2) {
>>>> 		llvm::LoopInfo *LI1, LI2;
>>>> 		LI1 = &getAnalysis<llvm::LoopInfo>(*F1);
>>>> 		llvm::Loop* L1 = LI1->getLoopFor(F1->begin());
>>>> 		LI2 = &getAnalysis<llvm::LoopInfo>(*F2);
>>>> 		llvm::Loop* L2 = LI2->getLoopFor(F2->begin());
>>>> 		L1->dump();  // crash
>>>> 		L2->dump();
>>>> 	}
>>>> 
>>>> 	I checked why this program crashes. It is because the getAnalysis returns same LoopInfo instance. Each time it clears previous results and run it on the new function. Thus it invalidate the pointer L1 after calling &getAnalysis<llvm::LoopInfo>(*F2).
>>> 
>>> To the best of my knowledge, the LLVM pass manager never preserves a FunctionPass analysis that is requested by a ModulePass; every time you call getAnalysis for a function, the FunctionPass is re-run.
>>>> 	
>>>> 	My questions is whether there is a way to get around this, and to keep the analysis result of Function Pass of all functions alive during my Module Pass? I am using LLVM-3.1-svn version. I would really appreciate your help!
>>> 
>>> The trick I've used is to structure the code so that getAnalysis<>() is only called once per function.  For example, your ModulePass can have a std::map that maps between Function * and LoopInfo *.  You then provide a method getLoopInfo(Function * F) that checks to see if F is in the map.  If it is, it returns what is in the map.  If it isn't, it calls getAnalysis on F, stores the result in the map, and returns the LoopInfo pointer.
>>> 
>>> This is important not only for functionality (in your case) but also for performance; you don't want to calculate an analysis twice for the same function.
>>> 
>>> -- John T.
>>> 
>>>> Best,
>>>> Fan
>>>> 
>>>> 
>>>> _______________________________________________
>>>> LLVM Developers mailing list
>>>> LLVMdev at cs.uiuc.edu         http://llvm.cs.uiuc.edu
>>>> http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
>>> 
>> 
> 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20120309/e1da9d6b/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 3744 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20120309/e1da9d6b/attachment.bin>