1e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao//===- llvm/Analysis/Trace.h - Represent one trace of LLVM code -*- C++ -*-===// 2e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao// 3e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao// The LLVM Compiler Infrastructure 4e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao// 5e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao// This file is distributed under the University of Illinois Open Source 6e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao// License. See LICENSE.TXT for details. 7e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao// 8e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao//===----------------------------------------------------------------------===// 9e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao// 10e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao// This class represents a single trace of LLVM basic blocks. A trace is a 11e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao// single entry, multiple exit, region of code that is often hot. Trace-based 12e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao// optimizations treat traces almost like they are a large, strange, basic 13e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao// block: because the trace path is assumed to be hot, optimizations for the 14e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao// fall-through path are made at the expense of the non-fall-through paths. 15e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao// 16e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao//===----------------------------------------------------------------------===// 17e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 18e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao#ifndef LLVM_ANALYSIS_TRACE_H 19e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao#define LLVM_ANALYSIS_TRACE_H 20e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 21e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao#include <vector> 22e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao#include <cassert> 23e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 24e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaonamespace llvm { 25e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao class BasicBlock; 26e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao class Function; 27e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao class Module; 28e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao class raw_ostream; 29e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 30e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaoclass Trace { 31e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao typedef std::vector<BasicBlock *> BasicBlockListType; 32e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao BasicBlockListType BasicBlocks; 33e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 34e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaopublic: 35e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// Trace ctor - Make a new trace from a vector of basic blocks, 36e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// residing in the function which is the parent of the first 37e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// basic block in the vector. 38e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// 39e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao Trace(const std::vector<BasicBlock *> &vBB) : BasicBlocks (vBB) {} 40e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 41e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// getEntryBasicBlock - Return the entry basic block (first block) 42e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// of the trace. 43e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// 44e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao BasicBlock *getEntryBasicBlock () const { return BasicBlocks[0]; } 45e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 46e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// operator[]/getBlock - Return basic block N in the trace. 47e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// 48e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao BasicBlock *operator[](unsigned i) const { return BasicBlocks[i]; } 49e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao BasicBlock *getBlock(unsigned i) const { return BasicBlocks[i]; } 50e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 51e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// getFunction - Return this trace's parent function. 52e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// 53e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao Function *getFunction () const; 54e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 55e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// getModule - Return this Module that contains this trace's parent 56e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// function. 57e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// 58e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao Module *getModule () const; 59e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 60e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// getBlockIndex - Return the index of the specified basic block in the 61e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// trace, or -1 if it is not in the trace. 62e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao int getBlockIndex(const BasicBlock *X) const { 63e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao for (unsigned i = 0, e = BasicBlocks.size(); i != e; ++i) 64e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao if (BasicBlocks[i] == X) 65e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao return i; 66e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao return -1; 67e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao } 68e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 69e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// contains - Returns true if this trace contains the given basic 70e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// block. 71e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// 72e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao bool contains(const BasicBlock *X) const { 73e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao return getBlockIndex(X) != -1; 74e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao } 75e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 76e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// Returns true if B1 occurs before B2 in the trace, or if it is the same 77e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// block as B2.. Both blocks must be in the trace. 78e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// 79e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao bool dominates(const BasicBlock *B1, const BasicBlock *B2) const { 80e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao int B1Idx = getBlockIndex(B1), B2Idx = getBlockIndex(B2); 81e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao assert(B1Idx != -1 && B2Idx != -1 && "Block is not in the trace!"); 82e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao return B1Idx <= B2Idx; 83e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao } 84e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 85e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao // BasicBlock iterators... 86e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao typedef BasicBlockListType::iterator iterator; 87e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao typedef BasicBlockListType::const_iterator const_iterator; 88e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao typedef std::reverse_iterator<const_iterator> const_reverse_iterator; 89e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao typedef std::reverse_iterator<iterator> reverse_iterator; 90e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 91e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao iterator begin() { return BasicBlocks.begin(); } 92e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao const_iterator begin() const { return BasicBlocks.begin(); } 93e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao iterator end () { return BasicBlocks.end(); } 94e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao const_iterator end () const { return BasicBlocks.end(); } 95e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 96e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao reverse_iterator rbegin() { return BasicBlocks.rbegin(); } 97e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao const_reverse_iterator rbegin() const { return BasicBlocks.rbegin(); } 98e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao reverse_iterator rend () { return BasicBlocks.rend(); } 99e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao const_reverse_iterator rend () const { return BasicBlocks.rend(); } 100e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 101e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao unsigned size() const { return BasicBlocks.size(); } 102e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao bool empty() const { return BasicBlocks.empty(); } 103e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 104e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao iterator erase(iterator q) { return BasicBlocks.erase (q); } 105e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao iterator erase(iterator q1, iterator q2) { return BasicBlocks.erase (q1, q2); } 106e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 107e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// print - Write trace to output stream. 108e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// 109e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao void print(raw_ostream &O) const; 110e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 111e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// dump - Debugger convenience method; writes trace to standard error 112e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// output stream. 113e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao /// 114e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao void dump() const; 115e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao}; 116e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 117e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao} // end namespace llvm 118e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 119e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao#endif // TRACE_H 120