Trace.cpp revision e81561909d128c6e2d8033cb5465a49b2596b26a
16e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)//===- Trace.cpp - Implementation of Trace class --------------------------===//
26e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)//
36e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)//                     The LLVM Compiler Infrastructure
46e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)//
56e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)// This file was developed by the LLVM research group and is distributed under
66e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)// the University of Illinois Open Source License. See LICENSE.TXT for details.
76e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)//
86e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)//===----------------------------------------------------------------------===//
96e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)//
106e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)// This class represents a single trace of LLVM basic blocks.  A trace is a
116e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)// single entry, multiple exit, region of code that is often hot.  Trace-based
126e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)// optimizations treat traces almost like they are a large, strange, basic
136e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)// block: because the trace path is assumed to be hot, optimizations for the
146e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)// fall-through path are made at the expense of the non-fall-through paths.
156e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)//
166e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)//===----------------------------------------------------------------------===//
176e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)
186e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)#include "llvm/Analysis/Trace.h"
196e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)#include "llvm/Function.h"
206e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)#include "llvm/Assembly/Writer.h"
216e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)#include "llvm/Support/Streams.h"
226e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)using namespace llvm;
236e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)
246e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)Function *Trace::getFunction() const {
256e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)  return getEntryBasicBlock()->getParent();
266e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)}
276e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)
286e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)Module *Trace::getModule() const {
296e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)  return getFunction()->getParent();
306e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)}
316e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)
326e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)/// print - Write trace to output stream.
336e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)///
346e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)void Trace::print(OStream &O) const {
356e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)  Function *F = getFunction ();
366e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)  O << "; Trace from function " << F->getName() << ", blocks:\n";
376e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)  for (const_iterator i = begin(), e = end(); i != e; ++i) {
386e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)    O << "; ";
396e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)    if (O.stream())
406e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)      WriteAsOperand(*O.stream(), *i, true, getModule());
416e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)    O << "\n";
426e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)  }
436e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)  O << "; Trace parent function: \n" << *F;
446e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)}
456e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)
466e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)/// dump - Debugger convenience method; writes trace to standard error
476e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)/// output stream.
486e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)///
496e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)void Trace::dump() const {
506e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)  print(cerr);
516e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)}
526e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles)