Fix comment for consistency sake.
[llvm/avr.git] / lib / Analysis / Trace.cpp
blobc9b303b48b28b01489b6e6d5d51c90c2c44846e3
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.
16 //===----------------------------------------------------------------------===//
18 #include "llvm/Analysis/Trace.h"
19 #include "llvm/Function.h"
20 #include "llvm/Assembly/Writer.h"
21 #include "llvm/Support/raw_ostream.h"
22 using namespace llvm;
24 Function *Trace::getFunction() const {
25 return getEntryBasicBlock()->getParent();
28 Module *Trace::getModule() const {
29 return getFunction()->getParent();
32 /// print - Write trace to output stream.
33 ///
34 void Trace::print(raw_ostream &O) const {
35 Function *F = getFunction();
36 O << "; Trace from function " << F->getNameStr() << ", blocks:\n";
37 for (const_iterator i = begin(), e = end(); i != e; ++i) {
38 O << "; ";
39 WriteAsOperand(O, *i, true, getModule());
40 O << "\n";
42 O << "; Trace parent function: \n" << *F;
45 /// dump - Debugger convenience method; writes trace to standard error
46 /// output stream.
47 ///
48 void Trace::dump() const {
49 print(errs());