gem5  v21.1.0.2
debug.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017, 2020 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  * Copyright (c) 2006 The Regents of The University of Michigan
15  * Copyright (c) 2010 The Hewlett-Packard Development Company
16  * All rights reserved.
17  *
18  * Redistribution and use in source and binary forms, with or without
19  * modification, are permitted provided that the following conditions are
20  * met: redistributions of source code must retain the above copyright
21  * notice, this list of conditions and the following disclaimer;
22  * redistributions in binary form must reproduce the above copyright
23  * notice, this list of conditions and the following disclaimer in the
24  * documentation and/or other materials provided with the distribution;
25  * neither the name of the copyright holders nor the names of its
26  * contributors may be used to endorse or promote products derived from
27  * this software without specific prior written permission.
28  *
29  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40  */
41 
42 #include "pybind11/pybind11.h"
43 #include "pybind11/stl.h"
44 
45 #include <map>
46 #include <vector>
47 
48 #include "base/compiler.hh"
49 #include "base/debug.hh"
50 #include "base/output.hh"
51 #include "base/trace.hh"
52 #include "sim/debug.hh"
53 
54 namespace py = pybind11;
55 
56 namespace gem5
57 {
58 
59 GEM5_DEPRECATED_NAMESPACE(Debug, debug);
60 namespace debug
61 {
62 extern int allFlagsVersion;
63 } // namespace debug
64 
65 static void
66 output(const char *filename)
67 {
68  OutputStream *file_stream = simout.find(filename);
69 
70  if (!file_stream)
71  file_stream = simout.create(filename);
72 
74 }
75 
76 static void
77 ignore(const char *expr)
78 {
79  ObjectMatch ignore(expr);
80 
81  Trace::getDebugLogger()->addIgnore(ignore);
82 }
83 
84 void
85 pybind_init_debug(py::module_ &m_native)
86 {
87  py::module_ m_debug = m_native.def_submodule("debug");
88 
89  m_debug
90  .def("getAllFlagsVersion", []() { return debug::allFlagsVersion; })
91  .def("allFlags", &debug::allFlags, py::return_value_policy::reference)
92 
93  .def("schedBreak", &schedBreak)
94  .def("setRemoteGDBPort", &setRemoteGDBPort)
95  ;
96 
97  py::class_<debug::Flag> c_flag(m_debug, "Flag");
98  c_flag
99  .def_property_readonly("name", &debug::Flag::name)
100  .def_property_readonly("desc", &debug::Flag::desc)
101  .def("enable", &debug::Flag::enable)
102  .def("disable", &debug::Flag::disable)
103  .def_property("tracing",
104  [](const debug::Flag *flag) {
105  return flag->tracing();
106  },
107  [](debug::Flag *flag, bool state) {
108  if (state) {
109  flag->enable();
110  } else {
111  flag->disable();
112  }
113  })
114  .def("__bool__", [](const debug::Flag *flag) {
115  return (bool)*flag;
116  })
117  ;
118 
119  py::class_<debug::SimpleFlag>(m_debug, "SimpleFlag", c_flag)
120  .def_property_readonly("isFormat", &debug::SimpleFlag::isFormat)
121  ;
122  py::class_<debug::CompoundFlag>(m_debug, "CompoundFlag", c_flag)
123  .def("kids", &debug::CompoundFlag::kids)
124  ;
125 
126 
127  py::module_ m_trace = m_native.def_submodule("trace");
128  m_trace
129  .def("output", &output)
130  .def("ignore", &ignore)
131  .def("enable", &Trace::enable)
132  .def("disable", &Trace::disable)
133  ;
134 }
135 
136 } // namespace gem5
gem5::debug::Flag
Definition: debug.hh:62
gem5::ObjectMatch
ObjectMatch contains a vector of expressions.
Definition: match.hh:56
gem5::ignore
static void ignore(const char *expr)
Definition: debug.cc:77
gem5::Trace::disable
void disable()
Definition: trace.cc:100
gem5::debug::Flag::name
std::string name() const
Definition: debug.hh:78
gem5::pybind_init_debug
void pybind_init_debug(py::module_ &m_native)
Definition: debug.cc:85
gem5::output
static void output(const char *filename)
Definition: debug.cc:66
gem5::Trace::getDebugLogger
Logger * getDebugLogger()
Get the current global debug logger.
Definition: trace.cc:69
gem5::setRemoteGDBPort
void setRemoteGDBPort(int port)
Definition: debug.cc:128
gem5::simout
OutputDirectory simout
Definition: output.cc:62
gem5::OutputDirectory::create
OutputStream * create(const std::string &name, bool binary=false, bool no_gz=false)
Creates a file in this directory (optionally compressed).
Definition: output.cc:210
gem5::debug::allFlags
FlagsMap & allFlags()
Definition: debug.cc:79
output.hh
gem5::OutputStream::stream
std::ostream * stream() const
Get the output underlying output stream.
Definition: output.hh:62
gem5::debug::allFlagsVersion
int allFlagsVersion
Definition: debug.cc:77
debug.hh
gem5::debug::CompoundFlag::kids
const std::vector< Flag * > & kids() const
Definition: debug.hh:133
gem5::debug::Flag::tracing
bool tracing() const
Definition: debug.hh:81
debug.hh
compiler.hh
gem5::debug::Flag::disable
virtual void disable()=0
gem5::GEM5_DEPRECATED_NAMESPACE
GEM5_DEPRECATED_NAMESPACE(GuestABI, guest_abi)
gem5::Trace::OstreamLogger
Logging wrapper for ostreams with the format: <when>: <name>: <message-body>
Definition: trace.hh:112
gem5::OutputDirectory::find
OutputStream * find(const std::string &name) const
Finds stream associated with an open file or stdout/stderr.
Definition: output.cc:247
gem5::debug::Flag::enable
virtual void enable()=0
gem5::debug::Flag::desc
std::string desc() const
Definition: debug.hh:79
gem5::Trace::setDebugLogger
void setDebugLogger(Logger *logger)
Delete the current global logger and assign a new one.
Definition: trace.cc:85
trace.hh
gem5::schedBreak
void schedBreak(Tick when)
Cause the simulator to execute a breakpoint.
Definition: debug.cc:86
gem5::Trace::enable
void enable()
Enable/disable debug logging.
Definition: trace.cc:94
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::OutputStream
Definition: output.hh:56
gem5::debug::SimpleFlag::isFormat
bool isFormat() const
Checks whether this flag is a conventional debug flag, or a flag that modifies the way debug informat...
Definition: debug.hh:116

Generated on Tue Sep 21 2021 12:24:56 for gem5 by doxygen 1.8.17