python: Fix weird memory issue in wrapped AddrRange vectors

There is a weird issue with the PyBind wrapper of
vector<AddrRange>. Assigning new values to a param that is a vector of
AddrRange sometimes results in an out-of-bounds memory access.

We work around this issue by treating AddrRange vectors as opaque
types. This slightly changes the semantics of the wrapper since Python
now manipulates the real object rather than a copy that has been
converted to a list.

Change-Id: Ie027c06e7a7262214b43b19a76b24fe4b20426c5
Signed-off-by: Andreas Sandberg <andreas.sandberg@arm.com>
Reviewed-by: Sascha Bischoff <sascha.bischoff@arm.com>
Reviewed-by: Curtis Dunham <curtis.dunham@arm.com>
Reviewed-by: Timothy Hayes <timothy.hayes@arm.com>
Reviewed-on: https://gem5-review.googlesource.com/3223
Reviewed-by: Jason Lowe-Power <jason@lowepower.com>

3 files changed, 66 insertions, 1 deletions

diff --git a/src/python/m5/SimObject.py b/src/python/m5/SimObject.py
index d60d7cec1..569142e34 100644
--- a/src/python/m5/SimObject.py
+++ b/src/python/m5/SimObject.py
@@ -681,6 +681,7 @@ class MetaSimObject(type):
 #include "pybind11/stl.h"
 
 #include "params/$cls.hh"
+#include "python/pybind11/core.hh"
 #include "sim/init.hh"
 #include "sim/sim_object.hh"
 
@@ -1418,7 +1419,14 @@ class SimObject(object):
                 assert isinstance(value, list)
                 vec = getattr(cc_params, param)
                 assert not len(vec)
-                setattr(cc_params, param, list(value))
+                # Some types are exposed as opaque types. They support
+                # the append operation unlike the automatically
+                # wrapped types.
+                if isinstance(vec, list):
+                    setattr(cc_params, param, list(value))
+                else:
+                    for v in value:
+                        getattr(cc_params, param).append(v)
             else:
                 setattr(cc_params, param, value)
 
diff --git a/src/python/pybind11/core.cc b/src/python/pybind11/core.cc
index a11ad7f6b..7ad45b408 100644
--- a/src/python/pybind11/core.cc
+++ b/src/python/pybind11/core.cc
@@ -46,6 +46,8 @@
 
 #include "pybind11/pybind11.h"
 
+#include "python/pybind11/core.hh"
+
 #include <ctime>
 
 #include "base/addr_range.hh"
@@ -163,6 +165,10 @@ init_range(py::module &m_native)
         .def("isSubset", &AddrRange::isSubset)
         ;
 
+    // We need to make vectors of AddrRange opaque to avoid a weird
+    // memory allocation issues in PyBind's STL wrappers.
+    py::bind_vector<std::vector<AddrRange>>(m, "AddrRangeVector");
+
     m.def("RangeEx", &RangeEx);
     m.def("RangeIn", &RangeIn);
     m.def("RangeSize", &RangeSize);
diff --git a/src/python/pybind11/core.hh b/src/python/pybind11/core.hh
new file mode 100644
index 000000000..81e762710
--- /dev/null
+++ b/src/python/pybind11/core.hh
@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2017 ARM Limited
+ * All rights reserved
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Andreas Sandberg
+ */
+
+#ifndef __PYTHON_PYBIND11_CORE_HH__
+#define __PYTHON_PYBIND11_CORE_HH__
+
+#include "pybind11/stl_bind.h"
+
+#include <vector>
+
+#include "base/addr_range.hh"
+
+PYBIND11_MAKE_OPAQUE(std::vector<AddrRange>);
+
+#endif