gem5  v22.0.0.1
inst_pb_trace.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014 ARM Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef __CPU_INST_PB_TRACE_HH__
39 #define __CPU_INST_PB_TRACE_HH__
40 
41 #include "arch/generic/pcstate.hh"
42 #include "base/trace.hh"
43 #include "base/types.hh"
44 #include "cpu/static_inst_fwd.hh"
45 #include "params/InstPBTrace.hh"
46 #include "proto/protoio.hh"
47 #include "sim/insttracer.hh"
48 
49 namespace ProtoMessage {
50 class Inst;
51 }
52 
53 namespace gem5
54 {
55 
56 class ThreadContext;
57 
58 namespace Trace {
59 
67 {
68  public:
70  const StaticInstPtr si, const PCStateBase &pc,
71  const StaticInstPtr mi = NULL)
72  : InstRecord(when, tc, si, pc, mi), tracer(_tracer)
73  {}
74 
79  void dump() override;
80 
81  protected:
83 
84 };
85 
86 class InstPBTrace : public InstTracer
87 {
88  public:
89  InstPBTrace(const InstPBTraceParams &p);
90  virtual ~InstPBTrace();
91 
94  const StaticInstPtr mi = NULL) override;
95 
96  protected:
97  std::unique_ptr<uint8_t []> buf;
98  size_t bufSize;
99 
104 
105 
109  ProtoMessage::Inst *curMsg;
110 
115  void createTraceFile(std::string filename);
116 
119  void closeStreams();
120 
127 
134  void traceMem(StaticInstPtr si, Addr a, Addr s, unsigned f);
135 
136  friend class InstPBTraceRecord;
137 };
138 
139 } // namespace Trace
140 } // namespace gem5
141 
142 #endif // __CPU_INST_PB_TRACE_HH__
gem5::Trace::InstPBTraceRecord::InstPBTraceRecord
InstPBTraceRecord(InstPBTrace &_tracer, Tick when, ThreadContext *tc, const StaticInstPtr si, const PCStateBase &pc, const StaticInstPtr mi=NULL)
Definition: inst_pb_trace.hh:69
gem5::VegaISA::s
Bitfield< 1 > s
Definition: pagetable.hh:64
gem5::VegaISA::f
Bitfield< 56 > f
Definition: pagetable.hh:53
gem5::Trace::InstPBTraceRecord
This in an instruction tracer that records the flow of instructions through multiple cpus and systems...
Definition: inst_pb_trace.hh:66
gem5::Trace::InstPBTraceRecord::dump
void dump() override
called by the cpu when the instruction commits.
Definition: inst_pb_trace.cc:59
insttracer.hh
gem5::Trace::InstPBTrace::bufSize
size_t bufSize
Definition: inst_pb_trace.hh:98
protoio.hh
gem5::ArmISA::a
Bitfield< 8 > a
Definition: misc_types.hh:66
gem5::Trace::InstPBTrace::buf
std::unique_ptr< uint8_t[]> buf
Definition: inst_pb_trace.hh:97
gem5::Trace::InstPBTrace::traceStream
static ProtoOutputStream * traceStream
One output stream for the entire simulation.
Definition: inst_pb_trace.hh:103
gem5::Trace::InstPBTrace::getInstRecord
InstPBTraceRecord * getInstRecord(Tick when, ThreadContext *tc, const StaticInstPtr si, const PCStateBase &pc, const StaticInstPtr mi=NULL) override
Definition: inst_pb_trace.cc:123
gem5::RefCountingPtr< StaticInst >
gem5::ArmISA::mi
Bitfield< 14 > mi
Definition: misc_types.hh:818
gem5::ThreadContext
ThreadContext is the external interface to all thread state for anything outside of the CPU.
Definition: thread_context.hh:94
gem5::VegaISA::p
Bitfield< 54 > p
Definition: pagetable.hh:70
gem5::Trace::InstPBTrace::createTraceFile
void createTraceFile(std::string filename)
Create the output file and write the header into it.
Definition: inst_pb_trace.cc:81
gem5::Trace::InstPBTrace::curMsg
ProtoMessage::Inst * curMsg
This is the message were working on writing.
Definition: inst_pb_trace.hh:109
gem5::Trace::InstPBTrace::traceInst
void traceInst(ThreadContext *tc, StaticInstPtr si, const PCStateBase &pc)
Write an instruction to the trace file.
Definition: inst_pb_trace.cc:135
gem5::Trace::InstPBTrace::~InstPBTrace
virtual ~InstPBTrace()
Definition: inst_pb_trace.cc:117
gem5::Trace::InstPBTrace::traceMem
void traceMem(StaticInstPtr si, Addr a, Addr s, unsigned f)
Write a memory request to the trace file as part of the cur instruction.
Definition: inst_pb_trace.cc:167
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::Trace::InstPBTrace
Definition: inst_pb_trace.hh:86
gem5::Trace::InstTracer
Definition: insttracer.hh:295
gem5::Trace::InstPBTraceRecord::tracer
InstPBTrace & tracer
Definition: inst_pb_trace.hh:82
gem5::ArmISA::si
Bitfield< 6 > si
Definition: misc_types.hh:825
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::Trace::InstPBTrace::InstPBTrace
InstPBTrace(const InstPBTraceParams &p)
Definition: inst_pb_trace.cc:73
gem5::Trace::InstRecord::pc
std::unique_ptr< PCStateBase > pc
Definition: insttracer.hh:72
pcstate.hh
types.hh
static_inst_fwd.hh
gem5::MipsISA::pc
Bitfield< 4 > pc
Definition: pra_constants.hh:243
gem5::Trace::InstPBTrace::closeStreams
void closeStreams()
If there is a pending message still write it out and then close the file.
Definition: inst_pb_trace.cc:102
trace.hh
gem5::Trace::InstRecord
Definition: insttracer.hh:61
gem5::PCStateBase
Definition: pcstate.hh:57
gem5::Trace::InstRecord::when
Tick when
Definition: insttracer.hh:64
ProtoMessage
Definition: inst_pb_trace.hh:49
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: gpu_translation_state.hh:37
ProtoOutputStream
A ProtoOutputStream wraps a coded stream, potentially with compression, based on looking at the file ...
Definition: protoio.hh:90

Generated on Sat Jun 18 2022 08:12:20 for gem5 by doxygen 1.8.17