src/python/pybind11/pyobject.cc

   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  * All rights reserved.
  16  *
  17  * Redistribution and use in source and binary forms, with or without
  18  * modification, are permitted provided that the following conditions are
  19  * met: redistributions of source code must retain the above copyright
  20  * notice, this list of conditions and the following disclaimer;
  21  * redistributions in binary form must reproduce the above copyright
  22  * notice, this list of conditions and the following disclaimer in the
  23  * documentation and/or other materials provided with the distribution;
  24  * neither the name of the copyright holders nor the names of its
  25  * contributors may be used to endorse or promote products derived from
  26  * this software without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39  *
  40  * Authors: Nathan Binkert
  41  */
  42
  43 #include "pybind11/pybind11.h"
  44
  45 #include <string>
  46
  47 #include "config/the_isa.hh"
  48
  49 #include "dev/net/etherdevice.hh"
  50 #include "dev/net/etherint.hh"
  51 #include "dev/net/etherobject.hh"
  52 #include "mem/mem_object.hh"
  53 #include "mem/ruby/network/Network.hh"
  54 #include "mem/ruby/slicc_interface/AbstractController.hh"
  55 #include "mem/ruby/system/Sequencer.hh"
  56 #include "sim/full_system.hh"
  57
  58 namespace py = pybind11;
  59
  60 /**
  61  * Connect the described MemObject ports.  Called from Python.
  62  * The indices i1 & i2 will be -1 for regular ports, >= 0 for vector ports.
  63  * SimObject1 is the master, and SimObject2 is the slave
  64  */
  65 static int
  66 connectPorts(SimObject *o1, const std::string &name1, int i1,
  67              SimObject *o2, const std::string &name2, int i2)
  68 {
  69     auto *eo1 = dynamic_cast<EtherObject*>(o1);
  70     auto *eo2 = dynamic_cast<EtherObject*>(o2);
  71
  72     if (eo1 && eo2) {
  73         EtherInt *p1 = eo1->getEthPort(name1, i1);
  74         EtherInt *p2 = eo2->getEthPort(name2, i2);
  75
  76         if (p1 && p2) {
  77             p1->setPeer(p2);
  78             p2->setPeer(p1);
  79
  80             return 1;
  81         }
  82     }
  83
  84     // These could be MessageBuffers from the ruby memory system. If so, they
  85     // need not be connected to anything currently.
  86     MessageBuffer *mb1, *mb2;
  87     mb1 = dynamic_cast<MessageBuffer*>(o1);
  88     mb2 = dynamic_cast<MessageBuffer*>(o2);
  89     Network *nw1, *nw2;
  90     nw1 = dynamic_cast<Network*>(o1);
  91     nw2 = dynamic_cast<Network*>(o2);
  92
  93     if ((mb1 || nw1) && (mb2 || nw2)) {
  94         // No need to connect anything here currently. MessageBuffer
  95         // connections in Python only serve to print the connections in
  96         // the config output.
  97         // TODO: Add real ports to MessageBuffers and use MemObject connect
  98         // code below to bind MessageBuffer senders and receivers
  99         return 1;
 100     }
 101
 102     MemObject *mo1, *mo2;
 103     mo1 = dynamic_cast<MemObject*>(o1);
 104     mo2 = dynamic_cast<MemObject*>(o2);
 105
 106     if (mo1 == NULL || mo2 == NULL) {
 107         panic ("Error casting SimObjects %s and %s to MemObject", o1->name(),
 108                o2->name());
 109     }
 110
 111     // generic master/slave port connection
 112     BaseMasterPort& masterPort = mo1->getMasterPort(name1, i1);
 113     BaseSlavePort& slavePort   = mo2->getSlavePort(name2, i2);
 114
 115     masterPort.bind(slavePort);
 116
 117     return 1;
 118 }
 119
 120 void
 121 pybind_init_pyobject(py::module &m_native)
 122 {
 123     py::module m = m_native.def_submodule("pyobject");
 124
 125     m.def("connectPorts", &connectPorts);
 126 }