5d1b7120dcaa5e9a204dc1227d78d1064e9caf14
[gem5.git] / src / arch / arm / tracers / tarmac_tracer.cc
1 /*
2 * Copyright (c) 2017-2018 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 "tarmac_tracer.hh"
39
40 #include <string>
41
42 #include "arch/arm/system.hh"
43 #include "cpu/base.hh"
44
45 namespace Trace {
46
47 std::string
48 TarmacContext::tarmacCpuName() const
49 {
50 auto id = thread->getCpuPtr()->cpuId();
51 return "cpu" + std::to_string(id);
52 }
53
54 TarmacTracer::TarmacTracer(const Params &p)
55 : InstTracer(p),
56 startTick(p.start_tick),
57 endTick(p.end_tick)
58 {
59 // Wrong parameter setting: The trace end happens before the
60 // trace start.
61 panic_if(startTick > endTick,
62 "Tarmac start point: %lu is bigger than "
63 "Tarmac end point: %lu\n", startTick, endTick);
64
65 // By default cpu tracers in gem5 are not tracing faults
66 // (exceptions).
67 // This is not in compliance with the Tarmac specification:
68 // instructions like SVC, SMC, HVC have to be traced.
69 // Tarmac Tracer is then automatically enabling this behaviour.
70 setDebugFlag("ExecFaulting");
71 }
72
73 InstRecord *
74 TarmacTracer::getInstRecord(Tick when, ThreadContext *tc,
75 const StaticInstPtr staticInst,
76 ArmISA::PCState pc,
77 const StaticInstPtr macroStaticInst)
78 {
79 // Check if we need to start tracing since we have passed the
80 // tick start point.
81 if (when < startTick || when > endTick)
82 return nullptr;
83
84 if (ArmSystem::highestELIs64(tc)) {
85 // TarmacTracerV8
86 return new TarmacTracerRecordV8(when, tc, staticInst, pc, *this,
87 macroStaticInst);
88 } else {
89 // TarmacTracer
90 return new TarmacTracerRecord(when, tc, staticInst, pc, *this,
91 macroStaticInst);
92 }
93 }
94
95 } // namespace Trace
96
97 Trace::TarmacTracer *
98 TarmacTracerParams::create() const
99 {
100 return new Trace::TarmacTracer(*this);
101 }