LLVM  14.0.0git
Trace.cpp
Go to the documentation of this file.
1 //===- Trace.cpp - Implementation of Trace class --------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This class represents a single trace of LLVM basic blocks. A trace is a
10 // single entry, multiple exit, region of code that is often hot. Trace-based
11 // optimizations treat traces almost like they are a large, strange, basic
12 // block: because the trace path is assumed to be hot, optimizations for the
13 // fall-through path are made at the expense of the non-fall-through paths.
14 //
15 //===----------------------------------------------------------------------===//
16 
17 #include "llvm/Analysis/Trace.h"
18 #include "llvm/Config/llvm-config.h"
19 #include "llvm/IR/BasicBlock.h"
20 #include "llvm/IR/Function.h"
21 #include "llvm/Support/Compiler.h"
22 #include "llvm/Support/Debug.h"
24 
25 using namespace llvm;
26 
28  return getEntryBasicBlock()->getParent();
29 }
30 
32  return getFunction()->getParent();
33 }
34 
35 /// print - Write trace to output stream.
36 void Trace::print(raw_ostream &O) const {
37  Function *F = getFunction();
38  O << "; Trace from function " << F->getName() << ", blocks:\n";
39  for (const_iterator i = begin(), e = end(); i != e; ++i) {
40  O << "; ";
41  (*i)->printAsOperand(O, true, getModule());
42  O << "\n";
43  }
44  O << "; Trace parent function: \n" << *F;
45 }
46 
47 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
48 /// dump - Debugger convenience method; writes trace to standard error
49 /// output stream.
51  print(dbgs());
52 }
53 #endif
i
i
Definition: README.txt:29
Trace.h
llvm::Trace::getModule
Module * getModule() const
getModule - Return this Module that contains this trace's parent function.
Definition: Trace.cpp:31
LLVM_DUMP_METHOD
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds.
Definition: Compiler.h:491
llvm
---------------------— PointerInfo ------------------------------------—
Definition: AllocatorList.h:23
llvm::BasicBlock::getParent
const Function * getParent() const
Return the enclosing method, or null if none.
Definition: BasicBlock.h:107
llvm::Function
Definition: Function.h:61
llvm::Trace::const_iterator
BasicBlockListType::const_iterator const_iterator
Definition: Trace.h:81
llvm::Trace::dump
void dump() const
dump - Debugger convenience method; writes trace to standard error output stream.
Definition: Trace.cpp:50
F
#define F(x, y, z)
Definition: MD5.cpp:56
llvm::dbgs
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:163
llvm::Trace::getFunction
Function * getFunction() const
getFunction - Return this trace's parent function.
Definition: Trace.cpp:27
llvm::Trace::end
iterator end()
Definition: Trace.h:87
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:53
BasicBlock.h
llvm::RISCVFenceField::O
@ O
Definition: RISCVBaseInfo.h:197
llvm::Trace::print
void print(raw_ostream &O) const
print - Write trace to output stream.
Definition: Trace.cpp:36
llvm::GlobalValue::getParent
Module * getParent()
Get the module that this global value is contained inside of...
Definition: GlobalValue.h:578
llvm::numbers::e
constexpr double e
Definition: MathExtras.h:57
llvm::Trace::getEntryBasicBlock
BasicBlock * getEntryBasicBlock() const
getEntryBasicBlock - Return the entry basic block (first block) of the trace.
Definition: Trace.h:43
llvm::Module
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:67
Compiler.h
llvm::Trace::begin
iterator begin()
Definition: Trace.h:85
Function.h
raw_ostream.h
Debug.h