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/Support/Debug.h"
21 #include "llvm/Support/raw_ostream.h"
22 using namespace llvm;
23 
getFunction() const24 Function *Trace::getFunction() const {
25   return getEntryBasicBlock()->getParent();
26 }
27 
getModule() const28 Module *Trace::getModule() const {
29   return getFunction()->getParent();
30 }
31 
32 /// print - Write trace to output stream.
33 ///
print(raw_ostream & O) const34 void Trace::print(raw_ostream &O) const {
35   Function *F = getFunction();
36   O << "; Trace from function " << F->getName() << ", blocks:\n";
37   for (const_iterator i = begin(), e = end(); i != e; ++i) {
38     O << "; ";
39     (*i)->printAsOperand(O, true, getModule());
40     O << "\n";
41   }
42   O << "; Trace parent function: \n" << *F;
43 }
44 
45 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
46 /// dump - Debugger convenience method; writes trace to standard error
47 /// output stream.
48 ///
dump() const49 void Trace::dump() const {
50   print(dbgs());
51 }
52 #endif
53