lib/Analysis/Trace.cpp

   1 //===- Trace.cpp - Implementation of Trace class --------------------------===//
   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 class represents a single trace of LLVM basic blocks.  A trace is a
  11 // single entry, multiple exit, region of code that is often hot.  Trace-based
  12 // optimizations treat traces almost like they are a large, strange, basic
  13 // block: because the trace path is assumed to be hot, optimizations for the
  14 // fall-through path are made at the expense of the non-fall-through paths.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #include "llvm/Analysis/Trace.h"
  19 #include "llvm/IR/Function.h"
  20 #include "llvm/IR/Writer.h"
  21 #include "llvm/Support/Debug.h"
  22 #include "llvm/Support/raw_ostream.h"
  23 using namespace llvm;
  24
  25 Function *Trace::getFunction() const {
  26   return getEntryBasicBlock()->getParent();
  27 }
  28
  29 Module *Trace::getModule() const {
  30   return getFunction()->getParent();
  31 }
  32
  33 /// print - Write trace to output stream.
  34 ///
  35 void Trace::print(raw_ostream &O) const {
  36   Function *F = getFunction();
  37   O << "; Trace from function " << F->getName() << ", blocks:\n";
  38   for (const_iterator i = begin(), e = end(); i != e; ++i) {
  39     O << "; ";
  40     WriteAsOperand(O, *i, true, getModule());
  41     O << "\n";
  42   }
  43   O << "; Trace parent function: \n" << *F;
  44 }
  45
  46 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
  47 /// dump - Debugger convenience method; writes trace to standard error
  48 /// output stream.
  49 ///
  50 void Trace::dump() const {
  51   print(dbgs());
  52 }
  53 #endif