2007-02-22 08:56:17 +00:00
|
|
|
//===- LoopPass.h - LoopPass class ----------------------------------------===//
|
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-29 19:59:42 +00:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2007-02-22 08:56:17 +00:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This file defines LoopPass class. All loop optimization
|
|
|
|
// and transformation passes are derived from LoopPass.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_LOOP_PASS_H
|
|
|
|
#define LLVM_LOOP_PASS_H
|
|
|
|
|
|
|
|
#include "llvm/Analysis/LoopInfo.h"
|
|
|
|
#include "llvm/Pass.h"
|
|
|
|
#include "llvm/PassManagers.h"
|
|
|
|
#include "llvm/Function.h"
|
2010-08-07 00:53:01 +00:00
|
|
|
#include <deque>
|
2007-02-22 08:56:17 +00:00
|
|
|
|
|
|
|
namespace llvm {
|
|
|
|
|
|
|
|
class LPPassManager;
|
|
|
|
class Function;
|
2008-03-14 18:14:29 +00:00
|
|
|
class PMStack;
|
2007-02-22 08:56:17 +00:00
|
|
|
|
|
|
|
class LoopPass : public Pass {
|
2009-02-17 19:34:54 +00:00
|
|
|
public:
|
2010-08-06 18:33:48 +00:00
|
|
|
explicit LoopPass(char &pid) : Pass(PT_Loop, pid) {}
|
2007-05-01 21:15:47 +00:00
|
|
|
|
2010-04-02 23:17:14 +00:00
|
|
|
/// getPrinterPass - Get a pass to print the function corresponding
|
|
|
|
/// to a Loop.
|
|
|
|
Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const;
|
|
|
|
|
2007-07-02 14:53:37 +00:00
|
|
|
// runOnLoop - This method should be implemented by the subclass to perform
|
2008-07-11 22:48:20 +00:00
|
|
|
// whatever action is necessary for the specified Loop.
|
2009-02-17 19:34:54 +00:00
|
|
|
virtual bool runOnLoop(Loop *L, LPPassManager &LPM) = 0;
|
2007-02-22 08:56:17 +00:00
|
|
|
|
2007-03-06 16:59:03 +00:00
|
|
|
// Initialization and finalization hooks.
|
2009-02-17 19:34:54 +00:00
|
|
|
virtual bool doInitialization(Loop *L, LPPassManager &LPM) {
|
|
|
|
return false;
|
2007-03-06 16:59:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Finalization hook does not supply Loop because at this time
|
|
|
|
// loop nest is completely different.
|
|
|
|
virtual bool doFinalization() { return false; }
|
2007-03-06 17:59:37 +00:00
|
|
|
|
|
|
|
// Check if this pass is suitable for the current LPPassManager, if
|
|
|
|
// available. This pass P is not suitable for a LPPassManager if P
|
|
|
|
// is not preserving higher level analysis info used by other
|
|
|
|
// LPPassManager passes. In such case, pop LPPassManager from the
|
|
|
|
// stack. This will force assignPassManager() to create new
|
|
|
|
// LPPassManger as expected.
|
|
|
|
void preparePassManager(PMStack &PMS);
|
|
|
|
|
2009-12-07 09:06:37 +00:00
|
|
|
/// Assign pass manager to manage this pass
|
2007-02-23 00:36:57 +00:00
|
|
|
virtual void assignPassManager(PMStack &PMS,
|
2010-08-07 01:25:32 +00:00
|
|
|
PassManagerType PMT);
|
2007-02-23 00:36:57 +00:00
|
|
|
|
2007-04-16 18:51:25 +00:00
|
|
|
/// Return what kind of Pass Manager can manage this pass.
|
|
|
|
virtual PassManagerType getPotentialPassManagerType() const {
|
|
|
|
return PMT_LoopPassManager;
|
|
|
|
}
|
2007-07-31 08:00:57 +00:00
|
|
|
|
|
|
|
//===--------------------------------------------------------------------===//
|
|
|
|
/// SimpleAnalysis - Provides simple interface to update analysis info
|
|
|
|
/// maintained by various passes. Note, if required this interface can
|
|
|
|
/// be extracted into a separate abstract class but it would require
|
2008-07-11 22:51:32 +00:00
|
|
|
/// additional use of multiple inheritance in Pass class hierarchy, something
|
2007-07-31 08:00:57 +00:00
|
|
|
/// we are trying to avoid.
|
|
|
|
|
2008-07-11 22:48:20 +00:00
|
|
|
/// Each loop pass can override these simple analysis hooks to update
|
2007-07-31 08:00:57 +00:00
|
|
|
/// desired analysis information.
|
|
|
|
/// cloneBasicBlockAnalysis - Clone analysis info associated with basic block.
|
|
|
|
virtual void cloneBasicBlockAnalysis(BasicBlock *F, BasicBlock *T, Loop *L) {}
|
|
|
|
|
2009-12-07 09:06:37 +00:00
|
|
|
/// deleteAnalysisValue - Delete analysis info associated with value V.
|
2007-07-31 08:00:57 +00:00
|
|
|
virtual void deleteAnalysisValue(Value *V, Loop *L) {}
|
2007-02-22 08:56:17 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
class LPPassManager : public FunctionPass, public PMDataManager {
|
|
|
|
public:
|
2007-05-03 01:11:54 +00:00
|
|
|
static char ID;
|
2011-08-29 17:07:00 +00:00
|
|
|
explicit LPPassManager();
|
2007-02-22 08:56:17 +00:00
|
|
|
|
|
|
|
/// run - Execute all of the passes scheduled for execution. Keep track of
|
|
|
|
/// whether any of the passes modifies the module, and if so, return true.
|
|
|
|
bool runOnFunction(Function &F);
|
|
|
|
|
|
|
|
/// Pass Manager itself does not invalidate any analysis info.
|
2009-02-17 19:34:54 +00:00
|
|
|
// LPPassManager needs LoopInfo.
|
|
|
|
void getAnalysisUsage(AnalysisUsage &Info) const;
|
|
|
|
|
2007-02-22 08:56:17 +00:00
|
|
|
virtual const char *getPassName() const {
|
|
|
|
return "Loop Pass Manager";
|
|
|
|
}
|
2009-02-17 19:34:54 +00:00
|
|
|
|
2010-01-22 05:24:46 +00:00
|
|
|
virtual PMDataManager *getAsPMDataManager() { return this; }
|
|
|
|
virtual Pass *getAsPass() { return this; }
|
|
|
|
|
2009-02-17 19:41:26 +00:00
|
|
|
/// Print passes managed by this manager
|
|
|
|
void dumpPassStructure(unsigned Offset);
|
2009-02-17 19:34:54 +00:00
|
|
|
|
2010-08-11 20:34:43 +00:00
|
|
|
LoopPass *getContainedPass(unsigned N) {
|
2009-02-17 19:34:54 +00:00
|
|
|
assert(N < PassVector.size() && "Pass number out of range!");
|
2010-08-11 20:34:43 +00:00
|
|
|
LoopPass *LP = static_cast<LoopPass *>(PassVector[N]);
|
|
|
|
return LP;
|
2007-02-22 08:56:17 +00:00
|
|
|
}
|
|
|
|
|
2009-02-17 19:34:54 +00:00
|
|
|
virtual PassManagerType getPassManagerType() const {
|
|
|
|
return PMT_LoopPassManager;
|
2007-02-22 08:56:17 +00:00
|
|
|
}
|
|
|
|
|
2007-02-23 00:10:16 +00:00
|
|
|
public:
|
2007-03-06 19:00:02 +00:00
|
|
|
// Delete loop from the loop queue and loop nest (LoopInfo).
|
2007-02-23 00:10:16 +00:00
|
|
|
void deleteLoopFromQueue(Loop *L);
|
2009-02-17 19:34:54 +00:00
|
|
|
|
2009-09-27 23:49:43 +00:00
|
|
|
// Insert loop into the loop queue and add it as a child of the
|
|
|
|
// given parent.
|
2007-03-06 19:00:02 +00:00
|
|
|
void insertLoop(Loop *L, Loop *ParentLoop);
|
2007-02-23 00:16:44 +00:00
|
|
|
|
2009-09-27 23:49:43 +00:00
|
|
|
// Insert a loop into the loop queue.
|
|
|
|
void insertLoopIntoQueue(Loop *L);
|
|
|
|
|
2007-02-23 00:16:44 +00:00
|
|
|
// Reoptimize this loop. LPPassManager will re-insert this loop into the
|
|
|
|
// queue. This allows LoopPass to change loop nest for the loop. This
|
|
|
|
// utility may send LPPassManager into infinite loops so use caution.
|
|
|
|
void redoLoop(Loop *L);
|
2007-06-29 23:13:42 +00:00
|
|
|
|
2007-07-31 08:00:57 +00:00
|
|
|
//===--------------------------------------------------------------------===//
|
|
|
|
/// SimpleAnalysis - Provides simple interface to update analysis info
|
|
|
|
/// maintained by various passes. Note, if required this interface can
|
|
|
|
/// be extracted into a separate abstract class but it would require
|
2008-07-11 22:51:32 +00:00
|
|
|
/// additional use of multiple inheritance in Pass class hierarchy, something
|
2007-07-31 08:00:57 +00:00
|
|
|
/// we are trying to avoid.
|
|
|
|
|
|
|
|
/// cloneBasicBlockSimpleAnalysis - Invoke cloneBasicBlockAnalysis hook for
|
|
|
|
/// all passes that implement simple analysis interface.
|
|
|
|
void cloneBasicBlockSimpleAnalysis(BasicBlock *From, BasicBlock *To, Loop *L);
|
|
|
|
|
|
|
|
/// deleteSimpleAnalysisValue - Invoke deleteAnalysisValue hook for all passes
|
|
|
|
/// that implement simple analysis interface.
|
|
|
|
void deleteSimpleAnalysisValue(Value *V, Loop *L);
|
2009-02-17 19:34:54 +00:00
|
|
|
|
2007-02-23 00:10:16 +00:00
|
|
|
private:
|
2007-03-06 02:30:46 +00:00
|
|
|
std::deque<Loop *> LQ;
|
2007-02-23 00:10:16 +00:00
|
|
|
bool skipThisLoop;
|
2007-02-23 00:16:44 +00:00
|
|
|
bool redoThisLoop;
|
2007-03-06 18:38:33 +00:00
|
|
|
LoopInfo *LI;
|
|
|
|
Loop *CurrentLoop;
|
2007-02-22 08:56:17 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
} // End llvm namespace
|
|
|
|
|
|
|
|
#endif
|