← Back to branch summary

~ubuntu-branches/ubuntu/maverick/clamav/maverick-backports

« back to all changes in this revision

Viewing changes to libclamav/c++/llvm/lib/Transforms/Scalar/LoopRotation.cpp

  • Committer: Bazaar Package Importer
  • Author(s): Stephen Gran, Stephen Gran, Michael Tautschnig
  • Date: 2010-04-26 21:41:18 UTC
  • mfrom: (2.1.6 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100426214118-i6lo606wnh7ywfj6
Tags: 0.96+dfsg-4
http://bugs.debian.org/579271
http://bugs.debian.org/579068
[ Stephen Gran ]
* Fixed typo in clamav-milter's postinst

[ Michael Tautschnig ]
* Fixed typo in clamav-freshclam's postinst (closes: #579271)
* Debconf translation updates
  - Portuguese (closes: #579068)

Show diffs side-by-side

added added

removed removed

Lines of Context:
libclamav/c++/llvm/lib/Transforms/Scalar/LoopRotation.cpp
 
1
//===- LoopRotation.cpp - Loop Rotation Pass ------------------------------===//
 
2
//
 
3
//                     The LLVM Compiler Infrastructure
 
4
//
 
5
// This file is distributed under the University of Illinois Open Source
 
6
// License. See LICENSE.TXT for details.
 
7
//
 
8
//===----------------------------------------------------------------------===//
 
9
//
 
10
// This file implements Loop Rotation Pass.
 
11
//
 
12
//===----------------------------------------------------------------------===//
 
13
 
 
14
#define DEBUG_TYPE "loop-rotate"
 
15
#include "llvm/Transforms/Scalar.h"
 
16
#include "llvm/Function.h"
 
17
#include "llvm/IntrinsicInst.h"
 
18
#include "llvm/Analysis/LoopPass.h"
 
19
#include "llvm/Analysis/Dominators.h"
 
20
#include "llvm/Analysis/ScalarEvolution.h"
 
21
#include "llvm/Transforms/Utils/Local.h"
 
22
#include "llvm/Transforms/Utils/BasicBlockUtils.h"
 
23
#include "llvm/Transforms/Utils/SSAUpdater.h"
 
24
#include "llvm/Support/CommandLine.h"
 
25
#include "llvm/Support/Debug.h"
 
26
#include "llvm/ADT/Statistic.h"
 
27
#include "llvm/ADT/SmallVector.h"
 
28
using namespace llvm;
 
29
 
 
30
#define MAX_HEADER_SIZE 16
 
31
 
 
32
STATISTIC(NumRotated, "Number of loops rotated");
 
33
namespace {
 
34
 
 
35
  class LoopRotate : public LoopPass {
 
36
  public:
 
37
    static char ID; // Pass ID, replacement for typeid
 
38
    LoopRotate() : LoopPass(&ID) {}
 
39
 
 
40
    // Rotate Loop L as many times as possible. Return true if
 
41
    // loop is rotated at least once.
 
42
    bool runOnLoop(Loop *L, LPPassManager &LPM);
 
43
 
 
44
    // LCSSA form makes instruction renaming easier.
 
45
    virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 
46
      AU.addRequiredID(LoopSimplifyID);
 
47
      AU.addPreservedID(LoopSimplifyID);
 
48
      AU.addRequiredID(LCSSAID);
 
49
      AU.addPreservedID(LCSSAID);
 
50
      AU.addPreserved<ScalarEvolution>();
 
51
      AU.addRequired<LoopInfo>();
 
52
      AU.addPreserved<LoopInfo>();
 
53
      AU.addPreserved<DominatorTree>();
 
54
      AU.addPreserved<DominanceFrontier>();
 
55
    }
 
56
 
 
57
    // Helper functions
 
58
 
 
59
    /// Do actual work
 
60
    bool rotateLoop(Loop *L, LPPassManager &LPM);
 
61
    
 
62
    /// Initialize local data
 
63
    void initialize();
 
64
 
 
65
    /// After loop rotation, loop pre-header has multiple sucessors.
 
66
    /// Insert one forwarding basic block to ensure that loop pre-header
 
67
    /// has only one successor.
 
68
    void preserveCanonicalLoopForm(LPPassManager &LPM);
 
69
 
 
70
  private:
 
71
    Loop *L;
 
72
    BasicBlock *OrigHeader;
 
73
    BasicBlock *OrigPreHeader;
 
74
    BasicBlock *OrigLatch;
 
75
    BasicBlock *NewHeader;
 
76
    BasicBlock *Exit;
 
77
    LPPassManager *LPM_Ptr;
 
78
  };
 
79
}
 
80
  
 
81
char LoopRotate::ID = 0;
 
82
static RegisterPass<LoopRotate> X("loop-rotate", "Rotate Loops");
 
83
 
 
84
Pass *llvm::createLoopRotatePass() { return new LoopRotate(); }
 
85
 
 
86
/// Rotate Loop L as many times as possible. Return true if
 
87
/// the loop is rotated at least once.
 
88
bool LoopRotate::runOnLoop(Loop *Lp, LPPassManager &LPM) {
 
89
 
 
90
  bool RotatedOneLoop = false;
 
91
  initialize();
 
92
  LPM_Ptr = &LPM;
 
93
 
 
94
  // One loop can be rotated multiple times.
 
95
  while (rotateLoop(Lp,LPM)) {
 
96
    RotatedOneLoop = true;
 
97
    initialize();
 
98
  }
 
99
 
 
100
  return RotatedOneLoop;
 
101
}
 
102
 
 
103
/// Rotate loop LP. Return true if the loop is rotated.
 
104
bool LoopRotate::rotateLoop(Loop *Lp, LPPassManager &LPM) {
 
105
  L = Lp;
 
106
 
 
107
  OrigPreHeader = L->getLoopPreheader();
 
108
  if (!OrigPreHeader) return false;
 
109
 
 
110
  OrigLatch = L->getLoopLatch();
 
111
  if (!OrigLatch) return false;
 
112
 
 
113
  OrigHeader =  L->getHeader();
 
114
 
 
115
  // If the loop has only one block then there is not much to rotate.
 
116
  if (L->getBlocks().size() == 1)
 
117
    return false;
 
118
 
 
119
  // If the loop header is not one of the loop exiting blocks then
 
120
  // either this loop is already rotated or it is not
 
121
  // suitable for loop rotation transformations.
 
122
  if (!L->isLoopExiting(OrigHeader))
 
123
    return false;
 
124
 
 
125
  BranchInst *BI = dyn_cast<BranchInst>(OrigHeader->getTerminator());
 
126
  if (!BI)
 
127
    return false;
 
128
  assert(BI->isConditional() && "Branch Instruction is not conditional");
 
129
 
 
130
  // Updating PHInodes in loops with multiple exits adds complexity. 
 
131
  // Keep it simple, and restrict loop rotation to loops with one exit only.
 
132
  // In future, lift this restriction and support for multiple exits if
 
133
  // required.
 
134
  SmallVector<BasicBlock*, 8> ExitBlocks;
 
135
  L->getExitBlocks(ExitBlocks);
 
136
  if (ExitBlocks.size() > 1)
 
137
    return false;
 
138
 
 
139
  // Check size of original header and reject
 
140
  // loop if it is very big.
 
141
  unsigned Size = 0;
 
142
  
 
143
  // FIXME: Use common api to estimate size.
 
144
  for (BasicBlock::const_iterator OI = OrigHeader->begin(), 
 
145
         OE = OrigHeader->end(); OI != OE; ++OI) {
 
146
      if (isa<PHINode>(OI)) 
 
147
        continue;           // PHI nodes don't count.
 
148
      if (isa<DbgInfoIntrinsic>(OI))
 
149
        continue;  // Debug intrinsics don't count as size.
 
150
      Size++;
 
151
  }
 
152
 
 
153
  if (Size > MAX_HEADER_SIZE)
 
154
    return false;
 
155
 
 
156
  // Now, this loop is suitable for rotation.
 
157
 
 
158
  // Anything ScalarEvolution may know about this loop or the PHI nodes
 
159
  // in its header will soon be invalidated.
 
160
  if (ScalarEvolution *SE = getAnalysisIfAvailable<ScalarEvolution>())
 
161
    SE->forgetLoop(L);
 
162
 
 
163
  // Find new Loop header. NewHeader is a Header's one and only successor
 
164
  // that is inside loop.  Header's other successor is outside the
 
165
  // loop.  Otherwise loop is not suitable for rotation.
 
166
  Exit = BI->getSuccessor(0);
 
167
  NewHeader = BI->getSuccessor(1);
 
168
  if (L->contains(Exit))
 
169
    std::swap(Exit, NewHeader);
 
170
  assert(NewHeader && "Unable to determine new loop header");
 
171
  assert(L->contains(NewHeader) && !L->contains(Exit) && 
 
172
         "Unable to determine loop header and exit blocks");
 
173
  
 
174
  // This code assumes that the new header has exactly one predecessor.
 
175
  // Remove any single-entry PHI nodes in it.
 
176
  assert(NewHeader->getSinglePredecessor() &&
 
177
         "New header doesn't have one pred!");
 
178
  FoldSingleEntryPHINodes(NewHeader);
 
179
 
 
180
  // Begin by walking OrigHeader and populating ValueMap with an entry for
 
181
  // each Instruction.
 
182
  BasicBlock::iterator I = OrigHeader->begin(), E = OrigHeader->end();
 
183
  DenseMap<const Value *, Value *> ValueMap;
 
184
 
 
185
  // For PHI nodes, the value available in OldPreHeader is just the
 
186
  // incoming value from OldPreHeader.
 
187
  for (; PHINode *PN = dyn_cast<PHINode>(I); ++I)
 
188
    ValueMap[PN] = PN->getIncomingValue(PN->getBasicBlockIndex(OrigPreHeader));
 
189
 
 
190
  // For the rest of the instructions, create a clone in the OldPreHeader.
 
191
  TerminatorInst *LoopEntryBranch = OrigPreHeader->getTerminator();
 
192
  for (; I != E; ++I) {
 
193
    Instruction *C = I->clone();
 
194
    C->setName(I->getName());
 
195
    C->insertBefore(LoopEntryBranch);
 
196
    ValueMap[I] = C;
 
197
  }
 
198
 
 
199
  // Along with all the other instructions, we just cloned OrigHeader's
 
200
  // terminator into OrigPreHeader. Fix up the PHI nodes in each of OrigHeader's
 
201
  // successors by duplicating their incoming values for OrigHeader.
 
202
  TerminatorInst *TI = OrigHeader->getTerminator();
 
203
  for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
 
204
    for (BasicBlock::iterator BI = TI->getSuccessor(i)->begin();
 
205
         PHINode *PN = dyn_cast<PHINode>(BI); ++BI)
 
206
      PN->addIncoming(PN->getIncomingValueForBlock(OrigHeader), OrigPreHeader);
 
207
 
 
208
  // Now that OrigPreHeader has a clone of OrigHeader's terminator, remove
 
209
  // OrigPreHeader's old terminator (the original branch into the loop), and
 
210
  // remove the corresponding incoming values from the PHI nodes in OrigHeader.
 
211
  LoopEntryBranch->eraseFromParent();
 
212
  for (I = OrigHeader->begin(); PHINode *PN = dyn_cast<PHINode>(I); ++I)
 
213
    PN->removeIncomingValue(PN->getBasicBlockIndex(OrigPreHeader));
 
214
 
 
215
  // Now fix up users of the instructions in OrigHeader, inserting PHI nodes
 
216
  // as necessary.
 
217
  SSAUpdater SSA;
 
218
  for (I = OrigHeader->begin(); I != E; ++I) {
 
219
    Value *OrigHeaderVal = I;
 
220
    Value *OrigPreHeaderVal = ValueMap[OrigHeaderVal];
 
221
 
 
222
    // The value now exits in two versions: the initial value in the preheader
 
223
    // and the loop "next" value in the original header.
 
224
    SSA.Initialize(OrigHeaderVal);
 
225
    SSA.AddAvailableValue(OrigHeader, OrigHeaderVal);
 
226
    SSA.AddAvailableValue(OrigPreHeader, OrigPreHeaderVal);
 
227
 
 
228
    // Visit each use of the OrigHeader instruction.
 
229
    for (Value::use_iterator UI = OrigHeaderVal->use_begin(),
 
230
         UE = OrigHeaderVal->use_end(); UI != UE; ) {
 
231
      // Grab the use before incrementing the iterator.
 
232
      Use &U = UI.getUse();
 
233
 
 
234
      // Increment the iterator before removing the use from the list.
 
235
      ++UI;
 
236
 
 
237
      // SSAUpdater can't handle a non-PHI use in the same block as an
 
238
      // earlier def. We can easily handle those cases manually.
 
239
      Instruction *UserInst = cast<Instruction>(U.getUser());
 
240
      if (!isa<PHINode>(UserInst)) {
 
241
        BasicBlock *UserBB = UserInst->getParent();
 
242
 
 
243
        // The original users in the OrigHeader are already using the
 
244
        // original definitions.
 
245
        if (UserBB == OrigHeader)
 
246
          continue;
 
247
 
 
248
        // Users in the OrigPreHeader need to use the value to which the
 
249
        // original definitions are mapped.
 
250
        if (UserBB == OrigPreHeader) {
 
251
          U = OrigPreHeaderVal;
 
252
          continue;
 
253
        }
 
254
      }
 
255
 
 
256
      // Anything else can be handled by SSAUpdater.
 
257
      SSA.RewriteUse(U);
 
258
    }
 
259
  }
 
260
 
 
261
  // NewHeader is now the header of the loop.
 
262
  L->moveToHeader(NewHeader);
 
263
 
 
264
  preserveCanonicalLoopForm(LPM);
 
265
 
 
266
  NumRotated++;
 
267
  return true;
 
268
}
 
269
 
 
270
/// Initialize local data
 
271
void LoopRotate::initialize() {
 
272
  L = NULL;
 
273
  OrigHeader = NULL;
 
274
  OrigPreHeader = NULL;
 
275
  NewHeader = NULL;
 
276
  Exit = NULL;
 
277
}
 
278
 
 
279
/// After loop rotation, loop pre-header has multiple sucessors.
 
280
/// Insert one forwarding basic block to ensure that loop pre-header
 
281
/// has only one successor.
 
282
void LoopRotate::preserveCanonicalLoopForm(LPPassManager &LPM) {
 
283
 
 
284
  // Right now original pre-header has two successors, new header and
 
285
  // exit block. Insert new block between original pre-header and
 
286
  // new header such that loop's new pre-header has only one successor.
 
287
  BasicBlock *NewPreHeader = BasicBlock::Create(OrigHeader->getContext(),
 
288
                                                "bb.nph",
 
289
                                                OrigHeader->getParent(), 
 
290
                                                NewHeader);
 
291
  LoopInfo &LI = getAnalysis<LoopInfo>();
 
292
  if (Loop *PL = LI.getLoopFor(OrigPreHeader))
 
293
    PL->addBasicBlockToLoop(NewPreHeader, LI.getBase());
 
294
  BranchInst::Create(NewHeader, NewPreHeader);
 
295
  
 
296
  BranchInst *OrigPH_BI = cast<BranchInst>(OrigPreHeader->getTerminator());
 
297
  if (OrigPH_BI->getSuccessor(0) == NewHeader)
 
298
    OrigPH_BI->setSuccessor(0, NewPreHeader);
 
299
  else {
 
300
    assert(OrigPH_BI->getSuccessor(1) == NewHeader &&
 
301
           "Unexpected original pre-header terminator");
 
302
    OrigPH_BI->setSuccessor(1, NewPreHeader);
 
303
  }
 
304
 
 
305
  PHINode *PN;
 
306
  for (BasicBlock::iterator I = NewHeader->begin();
 
307
       (PN = dyn_cast<PHINode>(I)); ++I) {
 
308
    int index = PN->getBasicBlockIndex(OrigPreHeader);
 
309
    assert(index != -1 && "Expected incoming value from Original PreHeader");
 
310
    PN->setIncomingBlock(index, NewPreHeader);
 
311
    assert(PN->getBasicBlockIndex(OrigPreHeader) == -1 && 
 
312
           "Expected only one incoming value from Original PreHeader");
 
313
  }
 
314
 
 
315
  if (DominatorTree *DT = getAnalysisIfAvailable<DominatorTree>()) {
 
316
    DT->addNewBlock(NewPreHeader, OrigPreHeader);
 
317
    DT->changeImmediateDominator(L->getHeader(), NewPreHeader);
 
318
    DT->changeImmediateDominator(Exit, OrigPreHeader);
 
319
    for (Loop::block_iterator BI = L->block_begin(), BE = L->block_end();
 
320
         BI != BE; ++BI) {
 
321
      BasicBlock *B = *BI;
 
322
      if (L->getHeader() != B) {
 
323
        DomTreeNode *Node = DT->getNode(B);
 
324
        if (Node && Node->getBlock() == OrigHeader)
 
325
          DT->changeImmediateDominator(*BI, L->getHeader());
 
326
      }
 
327
    }
 
328
    DT->changeImmediateDominator(OrigHeader, OrigLatch);
 
329
  }
 
330
 
 
331
  if (DominanceFrontier *DF = getAnalysisIfAvailable<DominanceFrontier>()) {
 
332
    // New Preheader's dominance frontier is Exit block.
 
333
    DominanceFrontier::DomSetType NewPHSet;
 
334
    NewPHSet.insert(Exit);
 
335
    DF->addBasicBlock(NewPreHeader, NewPHSet);
 
336
 
 
337
    // New Header's dominance frontier now includes itself and Exit block
 
338
    DominanceFrontier::iterator HeadI = DF->find(L->getHeader());
 
339
    if (HeadI != DF->end()) {
 
340
      DominanceFrontier::DomSetType & HeaderSet = HeadI->second;
 
341
      HeaderSet.clear();
 
342
      HeaderSet.insert(L->getHeader());
 
343
      HeaderSet.insert(Exit);
 
344
    } else {
 
345
      DominanceFrontier::DomSetType HeaderSet;
 
346
      HeaderSet.insert(L->getHeader());
 
347
      HeaderSet.insert(Exit);
 
348
      DF->addBasicBlock(L->getHeader(), HeaderSet);
 
349
    }
 
350
 
 
351
    // Original header (new Loop Latch)'s dominance frontier is Exit.
 
352
    DominanceFrontier::iterator LatchI = DF->find(L->getLoopLatch());
 
353
    if (LatchI != DF->end()) {
 
354
      DominanceFrontier::DomSetType &LatchSet = LatchI->second;
 
355
      LatchSet = LatchI->second;
 
356
      LatchSet.clear();
 
357
      LatchSet.insert(Exit);
 
358
    } else {
 
359
      DominanceFrontier::DomSetType LatchSet;
 
360
      LatchSet.insert(Exit);
 
361
      DF->addBasicBlock(L->getHeader(), LatchSet);
 
362
    }
 
363
 
 
364
    // If a loop block dominates new loop latch then add to its frontiers
 
365
    // new header and Exit and remove new latch (which is equal to original
 
366
    // header).
 
367
    BasicBlock *NewLatch = L->getLoopLatch();
 
368
 
 
369
    assert(NewLatch == OrigHeader && "NewLatch is inequal to OrigHeader");
 
370
 
 
371
    if (DominatorTree *DT = getAnalysisIfAvailable<DominatorTree>()) {
 
372
      for (Loop::block_iterator BI = L->block_begin(), BE = L->block_end();
 
373
           BI != BE; ++BI) {
 
374
        BasicBlock *B = *BI;
 
375
        if (DT->dominates(B, NewLatch)) {
 
376
          DominanceFrontier::iterator BDFI = DF->find(B);
 
377
          if (BDFI != DF->end()) {
 
378
            DominanceFrontier::DomSetType &BSet = BDFI->second;
 
379
            BSet.erase(NewLatch);
 
380
            BSet.insert(L->getHeader());
 
381
            BSet.insert(Exit);
 
382
          } else {
 
383
            DominanceFrontier::DomSetType BSet;
 
384
            BSet.insert(L->getHeader());
 
385
            BSet.insert(Exit);
 
386
            DF->addBasicBlock(B, BSet);
 
387
          }
 
388
        }
 
389
      }
 
390
    }
 
391
  }
 
392
 
 
393
  // Preserve canonical loop form, which means Exit block should
 
394
  // have only one predecessor.
 
395
  SplitEdge(L->getLoopLatch(), Exit, this);
 
396
 
 
397
  assert(NewHeader && L->getHeader() == NewHeader &&
 
398
         "Invalid loop header after loop rotation");
 
399
  assert(NewPreHeader && L->getLoopPreheader() == NewPreHeader &&
 
400
         "Invalid loop preheader after loop rotation");
 
401
  assert(L->getLoopLatch() &&
 
402
         "Invalid loop latch after loop rotation");
 
403
}