From 13b45a08c90912e8baa33b618b152cf41293bb9d Mon Sep 17 00:00:00 2001 From: Brent Stapleton Date: Tue, 17 Apr 2018 13:48:29 -0700 Subject: mpm: add device-specific Boost.Python bindings Separating Boost.Python bindings into device-specific files. N3XX code now lives in n3xx/pyusrp_periphs. Only one src file should be added for pyusrp_periphs.so by CMake. --- mpm/python/CMakeLists.txt | 5 +- mpm/python/converters.hpp | 94 ----------------------- mpm/python/pyusrp_periphs.cpp | 76 ------------------ mpm/python/pyusrp_periphs/converters.hpp | 94 +++++++++++++++++++++++ mpm/python/pyusrp_periphs/n3xx/pyusrp_periphs.cpp | 64 +++++++++++++++ 5 files changed, 162 insertions(+), 171 deletions(-) delete mode 100644 mpm/python/converters.hpp delete mode 100644 mpm/python/pyusrp_periphs.cpp create mode 100644 mpm/python/pyusrp_periphs/converters.hpp create mode 100644 mpm/python/pyusrp_periphs/n3xx/pyusrp_periphs.cpp (limited to 'mpm/python') diff --git a/mpm/python/CMakeLists.txt b/mpm/python/CMakeLists.txt index 2fd71b744..697c597dd 100644 --- a/mpm/python/CMakeLists.txt +++ b/mpm/python/CMakeLists.txt @@ -8,7 +8,10 @@ # This file included, use CMake directory variables ######################################################################## -ADD_LIBRARY(pyusrp_periphs SHARED pyusrp_periphs.cpp) +if(MPM_DEVICE STREQUAL "n3xx") + ADD_LIBRARY(pyusrp_periphs SHARED pyusrp_periphs/n3xx/pyusrp_periphs.cpp) +endif(MPM_DEVICE STREQUAL "n3xx") + TARGET_INCLUDE_DIRECTORIES(pyusrp_periphs PUBLIC ${PYTHON_INCLUDE_DIRS} ${CMAKE_SOURCE_DIR}/lib/ diff --git a/mpm/python/converters.hpp b/mpm/python/converters.hpp deleted file mode 100644 index ede9507a9..000000000 --- a/mpm/python/converters.hpp +++ /dev/null @@ -1,94 +0,0 @@ -// -// Copyright 2017 Ettus Research, a National Instruments Company -// -// SPDX-License-Identifier: GPL-3.0-or-later -// - -#pragma once - -#include -#include -#include -#include - -namespace bp = boost::python; - -template -struct map_to_python_dict -{ - static PyObject* convert(MapType const& input_map) - { - bp::dict py_dict; - for (const auto& element: input_map){ - py_dict[element.first] = element.second; - } - return bp::incref(py_dict.ptr()); - } - -}; - -template -struct iterable_to_python_list -{ - static PyObject* convert(Container const& input) - { - bp::list py_list; - for (const auto& element: input){ - py_list.append(element); - } - return bp::incref(py_list.ptr()); - } -}; - -// Converter for std::vector / std::list arguments from python iterables -struct iterable_converter -{ - template - iterable_converter& - from_python() - { - bp::converter::registry::push_back( - &iterable_converter::convertible, - &iterable_converter::construct, - bp::type_id()); - return *this; - } - - static void* convertible(PyObject* object) - { - return PyObject_GetIter(object) ? object : NULL; - } - - template - static void construct( - PyObject* object, - bp::converter::rvalue_from_python_stage1_data* data) - { - // Object is a borrowed reference, so create a handle indicting it is - // borrowed for proper reference counting. - bp::handle<> handle(bp::borrowed(object)); - - // Obtain a handle to the memory block that the converter has allocated - // for the C++ type. - typedef bp::converter::rvalue_from_python_storage - storage_type; - void* storage = reinterpret_cast(data)->storage.bytes; - - typedef bp::stl_input_iterator - iterator; - - // Allocate the C++ type into the converter's memory block, and assign - // its handle to the converter's convertible variable. The C++ - // container is populated by passing the begin and end iterators of - // the python object to the container's constructor. - new (storage) Container( - iterator(bp::object(handle)), // begin - iterator()); // end - data->convertible = storage; - } -}; - -void export_converter(){ - // LIBMPM_BOOST_PREAMBLE("helper") - bp::to_python_converter, iterable_to_python_list >, false>(); -} diff --git a/mpm/python/pyusrp_periphs.cpp b/mpm/python/pyusrp_periphs.cpp deleted file mode 100644 index feb7c2bad..000000000 --- a/mpm/python/pyusrp_periphs.cpp +++ /dev/null @@ -1,76 +0,0 @@ -// -// Copyright 2017 Ettus Research, a National Instruments Company -// -// SPDX-License-Identifier: GPL-3.0-or-later -// - -// include hackery to only include boost python and define the macro here -#include -#include -#define LIBMPM_PYTHON -#define LIBMPM_BOOST_PREAMBLE(module) \ - /* Register submodule types */ \ - namespace bp = boost::python; \ - bp::object py_module(bp::handle<>(bp::borrowed(PyImport_AddModule("libpyusrp_periphs." module)))); \ - bp::scope().attr(module) = py_module; \ - bp::scope io_scope = py_module; - -//! RAII-style GIL release method -// -// To release the GIL using this method, simply instantiate this class in the -// scope that needs to release the GIL. -// -// Note that using this class assumes that threads have already been -// initialized. See also https://docs.python.org/3.5/c-api/init.html for more -// documentation on Python initialization and threads. -class scoped_gil_release -{ -public: - inline scoped_gil_release() - { - _thread_state = PyEval_SaveThread(); - } - - inline ~scoped_gil_release() - { - PyEval_RestoreThread(_thread_state); - _thread_state = nullptr; - } - -private: - PyThreadState* _thread_state; -}; - -//#include "types.hpp" -#include "converters.hpp" -#include -#include -#include - -#ifdef ENABLE_MYKONOS -#include -#endif - -#ifdef ENABLE_MAGNESIUM -#include -#endif - -#include - -namespace bp = boost::python; - -BOOST_PYTHON_MODULE(libpyusrp_periphs) -{ - bp::object package = bp::scope(); - package.attr("__path__") = "libpyusrp_periphs"; - export_converter(); - export_types(); - export_spi(); -#ifdef ENABLE_MYKONOS - export_mykonos(); -#endif - export_xbar(); -#ifdef ENABLE_MAGNESIUM - export_magnesium(); -#endif -} diff --git a/mpm/python/pyusrp_periphs/converters.hpp b/mpm/python/pyusrp_periphs/converters.hpp new file mode 100644 index 000000000..ede9507a9 --- /dev/null +++ b/mpm/python/pyusrp_periphs/converters.hpp @@ -0,0 +1,94 @@ +// +// Copyright 2017 Ettus Research, a National Instruments Company +// +// SPDX-License-Identifier: GPL-3.0-or-later +// + +#pragma once + +#include +#include +#include +#include + +namespace bp = boost::python; + +template +struct map_to_python_dict +{ + static PyObject* convert(MapType const& input_map) + { + bp::dict py_dict; + for (const auto& element: input_map){ + py_dict[element.first] = element.second; + } + return bp::incref(py_dict.ptr()); + } + +}; + +template +struct iterable_to_python_list +{ + static PyObject* convert(Container const& input) + { + bp::list py_list; + for (const auto& element: input){ + py_list.append(element); + } + return bp::incref(py_list.ptr()); + } +}; + +// Converter for std::vector / std::list arguments from python iterables +struct iterable_converter +{ + template + iterable_converter& + from_python() + { + bp::converter::registry::push_back( + &iterable_converter::convertible, + &iterable_converter::construct, + bp::type_id()); + return *this; + } + + static void* convertible(PyObject* object) + { + return PyObject_GetIter(object) ? object : NULL; + } + + template + static void construct( + PyObject* object, + bp::converter::rvalue_from_python_stage1_data* data) + { + // Object is a borrowed reference, so create a handle indicting it is + // borrowed for proper reference counting. + bp::handle<> handle(bp::borrowed(object)); + + // Obtain a handle to the memory block that the converter has allocated + // for the C++ type. + typedef bp::converter::rvalue_from_python_storage + storage_type; + void* storage = reinterpret_cast(data)->storage.bytes; + + typedef bp::stl_input_iterator + iterator; + + // Allocate the C++ type into the converter's memory block, and assign + // its handle to the converter's convertible variable. The C++ + // container is populated by passing the begin and end iterators of + // the python object to the container's constructor. + new (storage) Container( + iterator(bp::object(handle)), // begin + iterator()); // end + data->convertible = storage; + } +}; + +void export_converter(){ + // LIBMPM_BOOST_PREAMBLE("helper") + bp::to_python_converter, iterable_to_python_list >, false>(); +} diff --git a/mpm/python/pyusrp_periphs/n3xx/pyusrp_periphs.cpp b/mpm/python/pyusrp_periphs/n3xx/pyusrp_periphs.cpp new file mode 100644 index 000000000..048ca6a44 --- /dev/null +++ b/mpm/python/pyusrp_periphs/n3xx/pyusrp_periphs.cpp @@ -0,0 +1,64 @@ +// +// Copyright 2017 Ettus Research, a National Instruments Company +// +// SPDX-License-Identifier: GPL-3.0-or-later +// + +// include hackery to only include boost python and define the macro here +#include +#define LIBMPM_PYTHON +#define LIBMPM_BOOST_PREAMBLE(module) \ + /* Register submodule types */ \ + namespace bp = boost::python; \ + bp::object py_module(bp::handle<>(bp::borrowed(PyImport_AddModule("libpyusrp_periphs." module)))); \ + bp::scope().attr(module) = py_module; \ + bp::scope io_scope = py_module; + +//! RAII-style GIL release method +// +// To release the GIL using this method, simply instantiate this class in the +// scope that needs to release the GIL. +// +// Note that using this class assumes that threads have already been +// initialized. See also https://docs.python.org/3.5/c-api/init.html for more +// documentation on Python initialization and threads. +class scoped_gil_release +{ +public: + inline scoped_gil_release() + { + _thread_state = PyEval_SaveThread(); + } + + inline ~scoped_gil_release() + { + PyEval_RestoreThread(_thread_state); + _thread_state = nullptr; + } + +private: + PyThreadState* _thread_state; +}; + +//#include "types.hpp" +#include "../converters.hpp" +#include +#include +#include +#include +#include +#include + +namespace bp = boost::python; + +BOOST_PYTHON_MODULE(libpyusrp_periphs) +{ + bp::object package = bp::scope(); + package.attr("__path__") = "libpyusrp_periphs"; + export_converter(); + export_types(); + export_spi(); + export_mykonos(); + export_xbar(); + export_magnesium(); +} -- cgit v1.2.3