exetrace.cc revision 2654:9559cfa91b9d 
1/*
2 * Copyright (c) 2001-2005 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 "base/loader/symtab.hh"
33#include "cpu/base.hh"
34#include "cpu/exetrace.hh"
35#include "cpu/static_inst.hh"
36#include "sim/param.hh"
37#include "sim/system.hh"
38
39using namespace std;
40
41
42////////////////////////////////////////////////////////////////////////
43//
44//  Methods for the InstRecord object
45//
46
47
48void
49Trace::InstRecord::dump(ostream &outs)
50{
51    if (flags[INTEL_FORMAT]) {
52#if FULL_SYSTEM
53        bool is_trace_system = (cpu->system->name() == trace_system);
54#else
55        bool is_trace_system = true;
56#endif
57        if (is_trace_system) {
58            ccprintf(outs, "%7d ) ", cycle);
59            outs << "0x" << hex << PC << ":\t";
60            if (staticInst->isLoad()) {
61                outs << "<RD 0x" << hex << addr;
62                outs << ">";
63            } else if (staticInst->isStore()) {
64                outs << "<WR 0x" << hex << addr;
65                outs << ">";
66            }
67            outs << endl;
68        }
69    } else {
70        if (flags[PRINT_CYCLE])
71            ccprintf(outs, "%7d: ", cycle);
72
73        outs << cpu->name() << " ";
74
75        if (flags[TRACE_MISSPEC])
76            outs << (misspeculating ? "-" : "+") << " ";
77
78        if (flags[PRINT_THREAD_NUM])
79            outs << "T" << thread << " : ";
80
81
82        std::string sym_str;
83        Addr sym_addr;
84        if (debugSymbolTable
85            && debugSymbolTable->findNearestSymbol(PC, sym_str, sym_addr)
86            && flags[PC_SYMBOL]) {
87            if (PC != sym_addr)
88                sym_str += csprintf("+%d", PC - sym_addr);
89            outs << "@" << sym_str << " : ";
90        }
91        else {
92            outs << "0x" << hex << PC << " : ";
93        }
94
95        //
96        //  Print decoded instruction
97        //
98
99#if defined(__GNUC__) && (__GNUC__ < 3)
100        // There's a bug in gcc 2.x library that prevents setw()
101        // from working properly on strings
102        string mc(staticInst->disassemble(PC, debugSymbolTable));
103        while (mc.length() < 26)
104            mc += " ";
105        outs << mc;
106#else
107        outs << setw(26) << left << staticInst->disassemble(PC, debugSymbolTable);
108#endif
109
110        outs << " : ";
111
112        if (flags[PRINT_OP_CLASS]) {
113            outs << opClassStrings[staticInst->opClass()] << " : ";
114        }
115
116        if (flags[PRINT_RESULT_DATA] && data_status != DataInvalid) {
117            outs << " D=";
118#if 0
119            if (data_status == DataDouble)
120                ccprintf(outs, "%f", data.as_double);
121            else
122                ccprintf(outs, "%#018x", data.as_int);
123#else
124            ccprintf(outs, "%#018x", data.as_int);
125#endif
126        }
127
128        if (flags[PRINT_EFF_ADDR] && addr_valid)
129            outs << " A=0x" << hex << addr;
130
131        if (flags[PRINT_INT_REGS] && regs_valid) {
132            for (int i = 0; i < TheISA::NumIntRegs;)
133                for (int j = i + 1; i <= j; i++)
134                    ccprintf(outs, "r%02d = %#018x%s", i,
135                            iregs->regs.readReg(i),
136                            ((i == j) ? "\n" : "    "));
137            outs << "\n";
138        }
139
140        if (flags[PRINT_FETCH_SEQ] && fetch_seq_valid)
141            outs << "  FetchSeq=" << dec << fetch_seq;
142
143        if (flags[PRINT_CP_SEQ] && cp_seq_valid)
144            outs << "  CPSeq=" << dec << cp_seq;
145
146        //
147        //  End of line...
148        //
149        outs << endl;
150    }
151}
152
153
154vector<bool> Trace::InstRecord::flags(NUM_BITS);
155string Trace::InstRecord::trace_system;
156
157////////////////////////////////////////////////////////////////////////
158//
159// Parameter space for per-cycle execution address tracing options.
160// Derive from ParamContext so we can override checkParams() function.
161//
162class ExecutionTraceParamContext : public ParamContext
163{
164  public:
165    ExecutionTraceParamContext(const string &_iniSection)
166        : ParamContext(_iniSection)
167        {
168        }
169
170    void checkParams();	// defined at bottom of file
171};
172
173ExecutionTraceParamContext exeTraceParams("exetrace");
174
175Param<bool> exe_trace_spec(&exeTraceParams, "speculative",
176                           "capture speculative instructions", true);
177
178Param<bool> exe_trace_print_cycle(&exeTraceParams, "print_cycle",
179                                  "print cycle number", true);
180Param<bool> exe_trace_print_opclass(&exeTraceParams, "print_opclass",
181                                  "print op class", true);
182Param<bool> exe_trace_print_thread(&exeTraceParams, "print_thread",
183                                  "print thread number", true);
184Param<bool> exe_trace_print_effaddr(&exeTraceParams, "print_effaddr",
185                                  "print effective address", true);
186Param<bool> exe_trace_print_data(&exeTraceParams, "print_data",
187                                  "print result data", true);
188Param<bool> exe_trace_print_iregs(&exeTraceParams, "print_iregs",
189                                  "print all integer regs", false);
190Param<bool> exe_trace_print_fetchseq(&exeTraceParams, "print_fetchseq",
191                                  "print fetch sequence number", false);
192Param<bool> exe_trace_print_cp_seq(&exeTraceParams, "print_cpseq",
193                                  "print correct-path sequence number", false);
194Param<bool> exe_trace_pc_symbol(&exeTraceParams, "pc_symbol",
195                                  "Use symbols for the PC if available", true);
196Param<bool> exe_trace_intel_format(&exeTraceParams, "intel_format",
197                                   "print trace in intel compatible format", false);
198Param<string> exe_trace_system(&exeTraceParams, "trace_system",
199                                   "print trace of which system (client or server)",
200                                   "client");
201
202
203//
204// Helper function for ExecutionTraceParamContext::checkParams() just
205// to get us into the InstRecord namespace
206//
207void
208Trace::InstRecord::setParams()
209{
210    flags[TRACE_MISSPEC]     = exe_trace_spec;
211
212    flags[PRINT_CYCLE]       = exe_trace_print_cycle;
213    flags[PRINT_OP_CLASS]    = exe_trace_print_opclass;
214    flags[PRINT_THREAD_NUM]  = exe_trace_print_thread;
215    flags[PRINT_RESULT_DATA] = exe_trace_print_effaddr;
216    flags[PRINT_EFF_ADDR]    = exe_trace_print_data;
217    flags[PRINT_INT_REGS]    = exe_trace_print_iregs;
218    flags[PRINT_FETCH_SEQ]   = exe_trace_print_fetchseq;
219    flags[PRINT_CP_SEQ]      = exe_trace_print_cp_seq;
220    flags[PC_SYMBOL]         = exe_trace_pc_symbol;
221    flags[INTEL_FORMAT]      = exe_trace_intel_format;
222    trace_system	     = exe_trace_system;
223}
224
225void
226ExecutionTraceParamContext::checkParams()
227{
228    Trace::InstRecord::setParams();
229}
230
231