gem5  v21.1.0.2
mem_trace.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 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 #include "mem/probes/mem_trace.hh"
39 
40 #include "base/callback.hh"
41 #include "base/output.hh"
42 #include "params/MemTraceProbe.hh"
43 #include "proto/packet.pb.h"
44 #include "sim/core.hh"
45 #include "sim/cur_tick.hh"
46 #include "sim/system.hh"
47 
48 namespace gem5
49 {
50 
51 MemTraceProbe::MemTraceProbe(const MemTraceProbeParams &p)
52  : BaseMemProbe(p),
53  traceStream(nullptr),
54  system(p.system),
55  withPC(p.with_pc)
56 {
57  std::string filename;
58  if (p.trace_file != "") {
59  // If the trace file is not specified as an absolute path,
60  // append the current simulation output directory
61  filename = simout.resolve(p.trace_file);
62 
63  const std::string suffix = ".gz";
64  // If trace_compress has been set, check the suffix. Append
65  // accordingly.
66  if (p.trace_compress &&
67  filename.compare(filename.size() - suffix.size(), suffix.size(),
68  suffix) != 0)
69  filename = filename + suffix;
70  } else {
71  // Generate a filename from the name of the SimObject. Append .trc
72  // and .gz if we want compression enabled.
73  filename = simout.resolve(name() + ".trc" +
74  (p.trace_compress ? ".gz" : ""));
75  }
76 
77  traceStream = new ProtoOutputStream(filename);
78 
79  // Register a callback to compensate for the destructor not
80  // being called. The callback forces the stream to flush and
81  // closes the output file.
82  registerExitCallback([this]() { closeStreams(); });
83 }
84 
85 void
87 {
88  // Create a protobuf message for the header and write it to
89  // the stream
90  ProtoMessage::PacketHeader header_msg;
91  header_msg.set_obj_id(name());
92  header_msg.set_tick_freq(sim_clock::Frequency);
93 
94  for (int i = 0; i < system->maxRequestors(); i++) {
95  auto id_string = header_msg.add_id_strings();
96  id_string->set_key(i);
97  id_string->set_value(system->getRequestorName(i));
98  }
99 
100  traceStream->write(header_msg);
101 }
102 
103 void
105 {
106  if (traceStream != NULL)
107  delete traceStream;
108 }
109 
110 void
112 {
113  ProtoMessage::Packet pkt_msg;
114 
115  pkt_msg.set_tick(curTick());
116  pkt_msg.set_cmd(pkt_info.cmd.toInt());
117  pkt_msg.set_flags(pkt_info.flags);
118  pkt_msg.set_addr(pkt_info.addr);
119  pkt_msg.set_size(pkt_info.size);
120  if (withPC && pkt_info.pc != 0)
121  pkt_msg.set_pc(pkt_info.pc);
122  pkt_msg.set_pkt_id(pkt_info.id);
123 
124  traceStream->write(pkt_msg);
125 }
126 
127 } // namespace gem5
gem5::curTick
Tick curTick()
The universal simulation clock.
Definition: cur_tick.hh:46
ProtoOutputStream::write
void write(const google::protobuf::Message &msg)
Write a message to the stream, preprending it with the message size.
Definition: protoio.cc:82
system.hh
gem5::MemTraceProbe::system
System * system
Definition: mem_trace.hh:72
cur_tick.hh
gem5::probing::PacketInfo::flags
Request::FlagsType flags
Definition: mem.hh:63
gem5::simout
OutputDirectory simout
Definition: output.cc:62
gem5::sim_clock::Frequency
Tick Frequency
The simulated frequency of curTick(). (In ticks per second)
Definition: core.cc:48
gem5::probing::PacketInfo::addr
Addr addr
Definition: mem.hh:61
gem5::X86ISA::system
Bitfield< 15 > system
Definition: misc.hh:1003
gem5::probing::PacketInfo::pc
Addr pc
Definition: mem.hh:64
gem5::ArmISA::i
Bitfield< 7 > i
Definition: misc_types.hh:66
mem_trace.hh
output.hh
gem5::BaseMemProbe
Base class for memory system probes accepting Packet instances.
Definition: base.hh:64
gem5::probing::PacketInfo::cmd
MemCmd cmd
Definition: mem.hh:60
gem5::MemTraceProbe::closeStreams
void closeStreams()
Callback to flush and close all open output streams on exit.
Definition: mem_trace.cc:104
gem5::System::maxRequestors
RequestorID maxRequestors()
Get the number of requestors registered in the system.
Definition: system.hh:518
gem5::Named::name
virtual std::string name() const
Definition: named.hh:47
gem5::MemTraceProbe::traceStream
ProtoOutputStream * traceStream
Trace output stream.
Definition: mem_trace.hh:70
gem5::MemTraceProbe::MemTraceProbe
MemTraceProbe(const MemTraceProbeParams &params)
Definition: mem_trace.cc:51
gem5::probing::Packet
ProbePointArg< PacketInfo > Packet
Packet probe point.
Definition: mem.hh:109
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::System::getRequestorName
std::string getRequestorName(RequestorID requestor_id)
Get the name of an object for a given request id.
Definition: system.cc:637
gem5::OutputDirectory::resolve
std::string resolve(const std::string &name) const
Returns relative file names prepended with name of this directory.
Definition: output.cc:204
gem5::MemTraceProbe::startup
void startup() override
startup() is the final initialization call before simulation.
Definition: mem_trace.cc:86
gem5::MemCmd::toInt
int toInt() const
Definition: packet.hh:266
gem5::MemTraceProbe::withPC
const bool withPC
Include the Program Counter in the memory trace.
Definition: mem_trace.hh:77
core.hh
gem5::MemTraceProbe::handleRequest
void handleRequest(const probing::PacketInfo &pkt_info) override
Callback to analyse intercepted Packets.
Definition: mem_trace.cc:111
gem5::probing::PacketInfo::size
uint32_t size
Definition: mem.hh:62
gem5::probing::PacketInfo::id
RequestorID id
Definition: mem.hh:65
gem5::probing::PacketInfo
A struct to hold on to the essential fields from a packet, so that the packet and underlying request ...
Definition: mem.hh:58
gem5::registerExitCallback
void registerExitCallback(const std::function< void()> &callback)
Register an exit callback.
Definition: core.cc:146
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
ProtoOutputStream
A ProtoOutputStream wraps a coded stream, potentially with compression, based on looking at the file ...
Definition: protoio.hh:90
callback.hh

Generated on Tue Sep 21 2021 12:25:34 for gem5 by doxygen 1.8.17