From e576f71838290ff12b98145fb02af84563fc03c1 Mon Sep 17 00:00:00 2001 From: David Shah Date: Thu, 7 Jun 2018 11:41:54 +0200 Subject: Developing Python bindings for Design and related types --- common/pybindings.cc | 47 ++++++++++++++++++ common/pybindings.h | 52 ++------------------ common/pycontainers.h | 129 ++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 179 insertions(+), 49 deletions(-) create mode 100644 common/pycontainers.h diff --git a/common/pybindings.cc b/common/pybindings.cc index 7a542dc1..04b2fa27 100644 --- a/common/pybindings.cc +++ b/common/pybindings.cc @@ -36,7 +36,54 @@ // architectures void arch_wrap_python(); +bool operator==(const PortRef &a, const PortRef &b) { + return (a.cell == b.cell) && (a.port == b.port); +} + BOOST_PYTHON_MODULE (MODULE_NAME) { + class_("GraphicElement") + .def_readwrite("style", &GraphicElement::style) + .def_readwrite("type", &GraphicElement::type) + .def_readwrite("x1", &GraphicElement::x1) + .def_readwrite("y1", &GraphicElement::y1) + .def_readwrite("x2", &GraphicElement::x2) + .def_readwrite("y2", &GraphicElement::y2) + .def_readwrite("text", &GraphicElement::text); + + class_("PortRef") + .def_readwrite("cell", &PortRef::cell) + .def_readwrite("port", &PortRef::port); + + class_("NetInfo") + .def_readwrite("name", &NetInfo::name) + .def_readwrite("driver", &NetInfo::driver) + .def_readwrite("users", &NetInfo::users) + .def_readwrite("attrs", &NetInfo::attrs) + .def_readwrite("wires", &NetInfo::wires); + + WRAP_MAP(decltype(NetInfo::attrs), "IdStrMap"); + + class_>("PortRefVector") + .def(vector_indexing_suite>()); + + class_("PortInfo") + .def_readwrite("name", &PortInfo::name) + .def_readwrite("net", &PortInfo::net) + .def_readwrite("type", &PortInfo::type); + + class_("CellInfo") + .def_readwrite("name", &CellInfo::name) + .def_readwrite("type", &CellInfo::type) + .def_readwrite("ports", &CellInfo::ports) + .def_readwrite("attrs", &CellInfo::attrs) + .def_readwrite("params", &CellInfo::params) + .def_readwrite("bel", &CellInfo::bel) + .def_readwrite("pins", &CellInfo::pins); + + class_("Design", no_init) + .def_readwrite("chip", &Design::chip) + .def_readwrite("nets", &Design::nets) + .def_readwrite("cells", &Design::cells); arch_wrap_python(); } diff --git a/common/pybindings.h b/common/pybindings.h index 5b2adc6a..3dfadeee 100644 --- a/common/pybindings.h +++ b/common/pybindings.h @@ -20,6 +20,9 @@ #ifndef COMMON_PYBINDINGS_H #define COMMON_PYBINDINGS_H + +#include "pycontainers.h" + #include #include #include @@ -27,54 +30,6 @@ #include #include using namespace boost::python; -/* -A wrapper for a Pythonised nextpnr Iterator. The actual class wrapped is a -pair containing (current, end) -*/ - -template -struct iterator_wrapper { - typedef decltype(*(std::declval())) value_t; - - static value_t next(std::pair &iter) { - if (iter.first != iter.second) { - value_t val = *iter.first; - ++iter.first; - return val; - } else { - PyErr_SetString(PyExc_StopIteration, "End of range reached"); - boost::python::throw_error_already_set(); - // Should be unreachable, but prevent control may reach end of non-void - throw std::runtime_error("unreachable"); - } - } - - static void wrap(const char *python_name) { - class_>(python_name, no_init) - .def("__next__", next); - } -}; - -/* -A wrapper for a nextpnr Range. Ranges should have two functions, begin() -and end() which return iterator-like objects supporting ++, * and != -Full STL iterator semantics are not required, unlike the standard Boost wrappers -*/ - -template -struct range_wrapper { - typedef decltype(std::declval().begin()) iterator_t; - - static std::pair iter(T &range) { - return std::make_pair(range.begin(), range.end()); - } - - static void wrap(const char *range_name, const char *iter_name) { - class_(range_name, no_init) - .def("__iter__", iter); - iterator_wrapper().wrap(iter_name); - } -}; /* A wrapper to enable custom type/ID to/from string conversions @@ -124,7 +79,6 @@ template struct string_wrapper { }; }; -#define WRAP_RANGE(t) range_wrapper().wrap(#t "Range", #t "Iterator") void init_python(const char *executable); void deinit_python(); diff --git a/common/pycontainers.h b/common/pycontainers.h new file mode 100644 index 00000000..64fb265b --- /dev/null +++ b/common/pycontainers.h @@ -0,0 +1,129 @@ +/* + * nextpnr -- Next Generation Place and Route + * + * Copyright (C) 2018 Clifford Wolf + * Copyright (C) 2018 David Shah + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + * + */ + +#ifndef COMMON_PYCONTAINERS_H +#define COMMON_PYCONTAINERS_H + +#include +#include +#include +#include +#include +#include +#include + +using namespace boost::python; + +/* +A wrapper for a Pythonised nextpnr Iterator. The actual class wrapped is a +pair containing (current, end) +*/ + +template +struct iterator_wrapper { + typedef decltype(*(std::declval())) value_t; + + static value_t next(std::pair &iter) { + if (iter.first != iter.second) { + value_t val = *iter.first; + ++iter.first; + return val; + } else { + PyErr_SetString(PyExc_StopIteration, "End of range reached"); + boost::python::throw_error_already_set(); + // Should be unreachable, but prevent control may reach end of non-void + throw std::runtime_error("unreachable"); + } + } + + static void wrap(const char *python_name) { + class_ < std::pair < T, T >> (python_name, no_init) + .def("__next__", next, P()); + } +}; + +/* +A wrapper for a nextpnr Range. Ranges should have two functions, begin() +and end() which return iterator-like objects supporting ++, * and != +Full STL iterator semantics are not required, unlike the standard Boost wrappers +*/ + +template> +struct range_wrapper { + typedef decltype(std::declval().begin()) iterator_t; + + static std::pair iter(T &range) { + return std::make_pair(range.begin(), range.end()); + } + + static void wrap(const char *range_name, const char *iter_name) { + class_(range_name, no_init) + .def("__iter__", iter); + iterator_wrapper().wrap(iter_name); + } + typedef iterator_wrapper iter_wrap; +}; + +#define WRAP_RANGE(t) range_wrapper().wrap(#t "Range", #t "Iterator") + +/* +Wrapper for a map, either an unordered_map, regular map or dict + */ +inline void KeyError() { PyErr_SetString(PyExc_KeyError, "Key not found"); } + +template +struct map_wrapper { + typedef boost::remove_cv_t> K; + typedef typename T::mapped_type V; + typedef typename T::value_type KV; + + static V &get(T &x, K const &i) { + if (x.find(i) != x.end()) return x.at(i); + KeyError(); + std::terminate(); + } + + static void set(T &x, K const &i, V const &v) { + x[i] = v; + } + + static void del(T const &x, K const &i) { + if (x.find(i) != x.end()) x.erase(i); + else KeyError(); + std::terminate(); + } + + static void wrap(const char *map_name, const char *kv_name, const char *iter_name) { + class_(kv_name) + .def_readonly("first", &KV::first) + .def_readwrite("second", &KV::second); + typedef range_wrapper> rw; + typename rw::iter_wrap().wrap(iter_name); + class_(map_name, no_init) + .def("__iter__", rw::iter) + .def("__len__", &T::size) + .def("__getitem__", get, return_internal_reference<>()) + .def("__setitem__", set, with_custodian_and_ward<1,2>()); + } +}; + +#define WRAP_MAP(t, name) map_wrapper().wrap(#name, #name "KeyValue", #name "Iterator") + +#endif -- cgit v1.2.3 From a5249da02d2a55d4b838dd8c29e159513dd71418 Mon Sep 17 00:00:00 2001 From: David Shah Date: Thu, 7 Jun 2018 12:40:31 +0200 Subject: Working on global Python design object Signed-off-by: David Shah --- common/pybindings.cc | 10 +++++++++- common/pybindings.h | 53 ++++++++++++++++++++++++++++++++++++++------------- ice40/main.cc | 1 + python/dump_design.py | 2 ++ 4 files changed, 52 insertions(+), 14 deletions(-) create mode 100644 python/dump_design.py diff --git a/common/pybindings.cc b/common/pybindings.cc index 04b2fa27..4ae83cb0 100644 --- a/common/pybindings.cc +++ b/common/pybindings.cc @@ -80,10 +80,17 @@ BOOST_PYTHON_MODULE (MODULE_NAME) { .def_readwrite("bel", &CellInfo::bel) .def_readwrite("pins", &CellInfo::pins); - class_("Design", no_init) + WRAP_MAP(decltype(CellInfo::ports), "IdPortMap"); + //WRAP_MAP(decltype(CellInfo::pins), "IdIdMap"); + + class_("Design", no_init) .def_readwrite("chip", &Design::chip) .def_readwrite("nets", &Design::nets) .def_readwrite("cells", &Design::cells); + + WRAP_MAP(decltype(Design::nets), "IdNetMap"); + WRAP_MAP(decltype(Design::cells), "IdCellMap"); + arch_wrap_python(); } @@ -104,6 +111,7 @@ void init_python(const char *executable) { emb::append_inittab(); Py_SetProgramName(program); Py_Initialize(); + PyImport_ImportModule(TOSTRING(MODULE_NAME)); } catch (boost::python::error_already_set const &) { // Parse and output the exception std::string perror_str = parse_python_exception(); diff --git a/common/pybindings.h b/common/pybindings.h index 3dfadeee..44898198 100644 --- a/common/pybindings.h +++ b/common/pybindings.h @@ -29,12 +29,14 @@ #include #include #include +#include using namespace boost::python; /* A wrapper to enable custom type/ID to/from string conversions */ -template struct string_wrapper { +template +struct string_wrapper { template struct from_pystring_converter { from_pystring_converter() { @@ -44,34 +46,37 @@ template struct string_wrapper { boost::python::type_id()); }; - static void* convertible(PyObject* object) { + static void *convertible(PyObject *object) { return PyUnicode_Check(object) ? object : 0; } static void construct( - PyObject* object, - converter::rvalue_from_python_stage1_data* data) { - const wchar_t* value = PyUnicode_AsUnicode(object); + PyObject *object, + converter::rvalue_from_python_stage1_data *data) { + const wchar_t *value = PyUnicode_AsUnicode(object); const std::wstring value_ws(value); if (value == 0) throw_error_already_set(); - void* storage = ( - (boost::python::converter::rvalue_from_python_storage*) + void *storage = ( + (boost::python::converter::rvalue_from_python_storage *) data)->storage.bytes; - new (storage) T(fn(std::string(value_ws.begin(), value_ws.end()))); + new(storage) T(fn(std::string(value_ws.begin(), value_ws.end()))); data->convertible = storage; } - static F fn; + static F fn; }; - template struct to_str_wrapper { + template + struct to_str_wrapper { static F fn; - std::string str(T& x) { + + std::string str(T &x) { return fn(x); } }; - template static void wrap(const char *type_name, F1 to_str_fn, F2 from_str_fn) { + template + static void wrap(const char *type_name, F1 to_str_fn, F2 from_str_fn) { from_pystring_converter::fn = from_str_fn; from_pystring_converter(); to_str_wrapper::fn = to_str_fn; @@ -79,12 +84,34 @@ template struct string_wrapper { }; }; +std::string parse_python_exception(); + +template +void python_export_global(const char *name, Tn &x) { + PyObject * m, *d; + m = PyImport_AddModule("__main__"); + if (m == NULL) + return; + d = PyModule_GetDict(m); + try { + PyObject * p = object(boost::ref(x)).ptr(); + PyDict_SetItemString(d, name, p); + } catch (boost::python::error_already_set const &) { + // Parse and output the exception + std::string perror_str = parse_python_exception(); + std::cout << "Error in Python: " << perror_str << std::endl; + std::terminate(); + } +}; void init_python(const char *executable); + void deinit_python(); -void execute_python_file(const char* python_file); +void execute_python_file(const char *python_file); + std::string parse_python_exception(); + void arch_appendinittab(); #endif /* end of include guard: COMMON_PYBINDINGS_HH */ diff --git a/ice40/main.cc b/ice40/main.cc index 5d00fcc8..12c6b86c 100644 --- a/ice40/main.cc +++ b/ice40/main.cc @@ -123,6 +123,7 @@ int main(int argc, char *argv[]) Design design(chipArgs); init_python(argv[0]); + python_export_global("design", design); if (vm.count("test")) { diff --git a/python/dump_design.py b/python/dump_design.py new file mode 100644 index 00000000..9d8ade3e --- /dev/null +++ b/python/dump_design.py @@ -0,0 +1,2 @@ +for cell in design.cells: + print(cell.first) -- cgit v1.2.3 From b0e66d441cf584e7e48049d4f07afcc8e743309a Mon Sep 17 00:00:00 2001 From: David Shah Date: Thu, 7 Jun 2018 12:57:52 +0200 Subject: Global design object working Signed-off-by: David Shah --- common/pybindings.cc | 6 ++++++ common/pybindings.h | 2 +- ice40/main.cc | 2 +- python/dump_design.py | 8 ++++++-- 4 files changed, 14 insertions(+), 4 deletions(-) diff --git a/common/pybindings.cc b/common/pybindings.cc index 4ae83cb0..a051eea6 100644 --- a/common/pybindings.cc +++ b/common/pybindings.cc @@ -66,6 +66,12 @@ BOOST_PYTHON_MODULE (MODULE_NAME) { class_>("PortRefVector") .def(vector_indexing_suite>()); + enum_("PortType") + .value("PORT_IN", PORT_IN) + .value("PORT_OUT", PORT_OUT) + .value("PORT_INOUT", PORT_INOUT) + .export_values(); + class_("PortInfo") .def_readwrite("name", &PortInfo::name) .def_readwrite("net", &PortInfo::net) diff --git a/common/pybindings.h b/common/pybindings.h index 44898198..a99ad51b 100644 --- a/common/pybindings.h +++ b/common/pybindings.h @@ -94,7 +94,7 @@ void python_export_global(const char *name, Tn &x) { return; d = PyModule_GetDict(m); try { - PyObject * p = object(boost::ref(x)).ptr(); + PyObject * p = incref(object(boost::ref(x)).ptr()); PyDict_SetItemString(d, name, p); } catch (boost::python::error_already_set const &) { // Parse and output the exception diff --git a/ice40/main.cc b/ice40/main.cc index 12c6b86c..88ef4155 100644 --- a/ice40/main.cc +++ b/ice40/main.cc @@ -205,7 +205,7 @@ int main(int argc, char *argv[]) parse_json_file(f, filename, &design); } - + if (vm.count("file")) { std::vector files = vm["file"].as>(); diff --git a/python/dump_design.py b/python/dump_design.py index 9d8ade3e..b8436288 100644 --- a/python/dump_design.py +++ b/python/dump_design.py @@ -1,2 +1,6 @@ -for cell in design.cells: - print(cell.first) +# Run ./nextpnr-ice40 --json ice40/blinky.json --file python/dump_design.py +for cell in sorted(design.cells, key=lambda x: x.first): + print("Cell {} : {}".format(cell.first, cell.second.type)) + for port in sorted(cell.second.ports, key=lambda x: x.first): + dir = (" <-- ", " --> ", " <-> ")[int(port.second.type)] + print(" {} {} {}".format(port.first, dir, port.second.net.name)) -- cgit v1.2.3