src/python/pybind11/debug.cc

   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/debug.hh"
  49 #include "base/output.hh"
  50 #include "base/trace.hh"
  51 #include "sim/debug.hh"
  52
  53 namespace py = pybind11;
  54
  55 namespace Debug {
  56 extern int allFlagsVersion;
  57 }
  58
  59 static void
  60 output(const char *filename)
  61 {
  62     OutputStream *file_stream = simout.find(filename);
  63
  64     if (!file_stream)
  65         file_stream = simout.create(filename);
  66
  67     Trace::setDebugLogger(new Trace::OstreamLogger(*file_stream->stream()));
  68 }
  69
  70 static void
  71 ignore(const char *expr)
  72 {
  73     ObjectMatch ignore(expr);
  74
  75     Trace::getDebugLogger()->addIgnore(ignore);
  76 }
  77
  78 void
  79 pybind_init_debug(py::module &m_native)
  80 {
  81     py::module m_debug = m_native.def_submodule("debug");
  82
  83     m_debug
  84         .def("getAllFlagsVersion", []() { return Debug::allFlagsVersion; })
  85         .def("allFlags", &Debug::allFlags, py::return_value_policy::reference)
  86
  87         .def("schedBreak", &schedBreak)
  88         .def("setRemoteGDBPort", &setRemoteGDBPort)
  89         ;
  90
  91     py::class_<Debug::Flag> c_flag(m_debug, "Flag");
  92     c_flag
  93         .def_property_readonly("name", &Debug::Flag::name)
  94         .def_property_readonly("desc", &Debug::Flag::desc)
  95         .def("enable", &Debug::Flag::enable)
  96         .def("disable", &Debug::Flag::disable)
  97         .def_property("status",
  98                       [](const Debug::Flag *flag) {
  99                           return flag->status();
 100                       },
 101                       [](Debug::Flag *flag, bool state) {
 102                           if (state) {
 103                               flag->enable();
 104                           } else {
 105                               flag->disable();
 106                           }
 107                       })
 108         .def("__bool__", [](const Debug::Flag *flag) {
 109                 return flag->status();
 110             })
 111         ;
 112
 113     py::class_<Debug::SimpleFlag>(m_debug, "SimpleFlag", c_flag);
 114     py::class_<Debug::CompoundFlag>(m_debug, "CompoundFlag", c_flag)
 115         .def("kids", &Debug::CompoundFlag::kids)
 116         ;
 117
 118
 119     py::module m_trace = m_native.def_submodule("trace");
 120     m_trace
 121         .def("output", &output)
 122         .def("ignore", &ignore)
 123         .def("enable", &Trace::enable)
 124         .def("disable", &Trace::disable)
 125         ;
 126 }