Minor format tweaks on config file documentation.
[gem5.git] / cpu / exetrace.cc
1 /*
2 * Copyright (c) 2001-2004 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 #include <fstream>
30 #include <iomanip>
31
32 #include "sim/param.hh"
33 #include "cpu/full_cpu/dyn_inst.hh"
34 #include "cpu/full_cpu/spec_state.hh"
35 #include "cpu/full_cpu/issue.hh"
36 #include "cpu/exetrace.hh"
37 #include "cpu/exec_context.hh"
38 #include "base/loader/symtab.hh"
39 #include "cpu/base_cpu.hh"
40 #include "cpu/static_inst.hh"
41
42 using namespace std;
43
44
45 ////////////////////////////////////////////////////////////////////////
46 //
47 // Methods for the InstRecord object
48 //
49
50
51 void
52 Trace::InstRecord::dump(ostream &outs)
53 {
54
55 if (flags[PRINT_CYCLE])
56 ccprintf(outs, "%7d: ", cycle);
57
58 outs << cpu->name() << " ";
59
60 if (flags[TRACE_MISSPEC])
61 outs << (misspeculating ? "-" : "+") << " ";
62
63 if (flags[PRINT_THREAD_NUM])
64 outs << "T" << thread << " : ";
65
66
67 std::string sym_str;
68 Addr sym_addr;
69 if (debugSymbolTable
70 && debugSymbolTable->findNearestSymbol(PC, sym_str, sym_addr)) {
71 if (PC != sym_addr)
72 sym_str += csprintf("+%d", PC - sym_addr);
73 outs << "@" << sym_str << " : ";
74 }
75 else {
76 outs << "0x" << hex << PC << " : ";
77 }
78
79 //
80 // Print decoded instruction
81 //
82
83 #if defined(__GNUC__) && (__GNUC__ < 3)
84 // There's a bug in gcc 2.x library that prevents setw()
85 // from working properly on strings
86 string mc(staticInst->disassemble(PC, debugSymbolTable));
87 while (mc.length() < 26)
88 mc += " ";
89 outs << mc;
90 #else
91 outs << setw(26) << left << staticInst->disassemble(PC, debugSymbolTable);
92 #endif
93
94 outs << " : ";
95
96 if (flags[PRINT_OP_CLASS]) {
97 outs << opClassStrings[staticInst->opClass()] << " : ";
98 }
99
100 if (flags[PRINT_RESULT_DATA] && data_status != DataInvalid) {
101 outs << " D=";
102 #if 0
103 if (data_status == DataDouble)
104 ccprintf(outs, "%f", data.as_double);
105 else
106 ccprintf(outs, "%#018x", data.as_int);
107 #else
108 ccprintf(outs, "%#018x", data.as_int);
109 #endif
110 }
111
112 if (flags[PRINT_EFF_ADDR] && addr_valid)
113 outs << " A=0x" << hex << addr;
114
115 if (flags[PRINT_INT_REGS] && regs_valid) {
116 for (int i = 0; i < 32;)
117 for (int j = i + 1; i <= j; i++)
118 ccprintf(outs, "r%02d = %#018x%s", i, iregs->regs[i],
119 ((i == j) ? "\n" : " "));
120 outs << "\n";
121 }
122
123 if (flags[PRINT_FETCH_SEQ] && fetch_seq_valid)
124 outs << " FetchSeq=" << dec << fetch_seq;
125
126 if (flags[PRINT_CP_SEQ] && cp_seq_valid)
127 outs << " CPSeq=" << dec << cp_seq;
128
129 //
130 // End of line...
131 //
132 outs << endl;
133 }
134
135
136 vector<bool> Trace::InstRecord::flags(NUM_BITS);
137
138 ////////////////////////////////////////////////////////////////////////
139 //
140 // Parameter space for per-cycle execution address tracing options.
141 // Derive from ParamContext so we can override checkParams() function.
142 //
143 class ExecutionTraceParamContext : public ParamContext
144 {
145 public:
146 ExecutionTraceParamContext(const string &_iniSection)
147 : ParamContext(_iniSection)
148 {
149 }
150
151 void checkParams(); // defined at bottom of file
152 };
153
154 ExecutionTraceParamContext exeTraceParams("exetrace");
155
156 Param<bool> exe_trace_spec(&exeTraceParams, "speculative",
157 "capture speculative instructions", true);
158
159 Param<bool> exe_trace_print_cycle(&exeTraceParams, "print_cycle",
160 "print cycle number", true);
161 Param<bool> exe_trace_print_opclass(&exeTraceParams, "print_opclass",
162 "print op class", true);
163 Param<bool> exe_trace_print_thread(&exeTraceParams, "print_thread",
164 "print thread number", true);
165 Param<bool> exe_trace_print_effaddr(&exeTraceParams, "print_effaddr",
166 "print effective address", true);
167 Param<bool> exe_trace_print_data(&exeTraceParams, "print_data",
168 "print result data", true);
169 Param<bool> exe_trace_print_iregs(&exeTraceParams, "print_iregs",
170 "print all integer regs", false);
171 Param<bool> exe_trace_print_fetchseq(&exeTraceParams, "print_fetchseq",
172 "print fetch sequence number", false);
173 Param<bool> exe_trace_print_cp_seq(&exeTraceParams, "print_cpseq",
174 "print correct-path sequence number", false);
175
176 //
177 // Helper function for ExecutionTraceParamContext::checkParams() just
178 // to get us into the InstRecord namespace
179 //
180 void
181 Trace::InstRecord::setParams()
182 {
183 flags[TRACE_MISSPEC] = exe_trace_spec;
184
185 flags[PRINT_CYCLE] = exe_trace_print_cycle;
186 flags[PRINT_OP_CLASS] = exe_trace_print_opclass;
187 flags[PRINT_THREAD_NUM] = exe_trace_print_thread;
188 flags[PRINT_RESULT_DATA] = exe_trace_print_effaddr;
189 flags[PRINT_EFF_ADDR] = exe_trace_print_data;
190 flags[PRINT_INT_REGS] = exe_trace_print_iregs;
191 flags[PRINT_FETCH_SEQ] = exe_trace_print_fetchseq;
192 flags[PRINT_CP_SEQ] = exe_trace_print_cp_seq;
193 }
194
195 void
196 ExecutionTraceParamContext::checkParams()
197 {
198 Trace::InstRecord::setParams();
199 }
200