1/*
2 * Copyright (c) 2017 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 * Authors: Nathan Binkert
42 *          Andreas Sandberg
43 */
44
45#include "pybind11/pybind11.h"
46#include "pybind11/stl.h"
47
48#include <map>
49#include <vector>
50
51#include "base/debug.hh"
52#include "base/output.hh"
53#include "base/trace.hh"
54#include "sim/debug.hh"
55
56namespace py = pybind11;
57
58namespace Debug {
59extern int allFlagsVersion;
60}
61
62static void
63output(const char *filename)
64{
65    OutputStream *file_stream = simout.find(filename);
66
67    if (!file_stream)
68        file_stream = simout.create(filename);
69
70    Trace::setDebugLogger(new Trace::OstreamLogger(*file_stream->stream()));
71}
72
73static void
74ignore(const char *expr)
75{
76    ObjectMatch ignore(expr);
77
78    Trace::getDebugLogger()->addIgnore(ignore);
79}
80
81void
82pybind_init_debug(py::module &m_native)
83{
84    py::module m_debug = m_native.def_submodule("debug");
85
86    m_debug
87        .def("getAllFlagsVersion", []() { return Debug::allFlagsVersion; })
88        .def("allFlags", &Debug::allFlags, py::return_value_policy::reference)
89        .def("findFlag", &Debug::findFlag)
90        .def("setDebugFlag", &setDebugFlag)
91        .def("clearDebugFlag", &clearDebugFlag)
92        .def("dumpDebugFlags", &dumpDebugFlags)
93
94        .def("schedBreak", &schedBreak)
95        .def("setRemoteGDBPort", &setRemoteGDBPort)
96        ;
97
98    py::class_<Debug::Flag> c_flag(m_debug, "Flag");
99    c_flag
100        .def("name", &Debug::Flag::name)
101        .def("desc", &Debug::Flag::desc)
102        .def("kids", &Debug::Flag::kids)
103        .def("enable", &Debug::Flag::enable)
104        .def("disable", &Debug::Flag::disable)
105        .def("sync", &Debug::Flag::sync)
106        ;
107
108    py::class_<Debug::SimpleFlag>(m_debug, "SimpleFlag", c_flag);
109    py::class_<Debug::CompoundFlag>(m_debug, "CompoundFlag", c_flag);
110
111
112    py::module m_trace = m_native.def_submodule("trace");
113    m_trace
114        .def("output", &output)
115        .def("ignore", &ignore)
116        .def("enable", &Trace::enable)
117        .def("disable", &Trace::disable)
118        ;
119}
120