Merge branch 'python'

Signed-off-by: David Shah <davey1576@gmail.com>

5 files changed, 241 insertions, 63 deletions

diff --git a/common/pybindings.cc b/common/pybindings.cc
index 7a542dc1..a051eea6 100644
--- a/common/pybindings.cc
+++ b/common/pybindings.cc
@@ -36,7 +36,67 @@
 // 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>("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>("PortRef")
+			.def_readwrite("cell", &PortRef::cell)
+			.def_readwrite("port", &PortRef::port);
+
+	class_<NetInfo, NetInfo*>("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_<vector<PortRef>>("PortRefVector")
+			.def(vector_indexing_suite<vector<PortRef>>());
+
+	enum_<PortType>("PortType")
+			.value("PORT_IN", PORT_IN)
+			.value("PORT_OUT", PORT_OUT)
+			.value("PORT_INOUT", PORT_INOUT)
+			.export_values();
+
+	class_<PortInfo>("PortInfo")
+			.def_readwrite("name", &PortInfo::name)
+			.def_readwrite("net", &PortInfo::net)
+			.def_readwrite("type", &PortInfo::type);
+
+	class_<CellInfo, CellInfo*>("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);
+
+	WRAP_MAP(decltype(CellInfo::ports), "IdPortMap");
+	//WRAP_MAP(decltype(CellInfo::pins), "IdIdMap");
+
+	class_<Design, Design*>("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();
 }
 
@@ -57,6 +117,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 5b2adc6a..a99ad51b 100644
--- a/common/pybindings.h
+++ b/common/pybindings.h
@@ -20,66 +20,23 @@
 
 #ifndef COMMON_PYBINDINGS_H
 #define COMMON_PYBINDINGS_H
+
+#include "pycontainers.h"
+
 #include <utility>
 #include <stdexcept>
 #include <boost/python.hpp>
 #include <boost/python/suite/indexing/vector_indexing_suite.hpp>
 #include <boost/python/suite/indexing/map_indexing_suite.hpp>
 #include <boost/python/suite/indexing/map_indexing_suite.hpp>
+#include <Python.h>
 using namespace boost::python;
-/*
-A wrapper for a Pythonised nextpnr Iterator. The actual class wrapped is a
-pair<Iterator, Iterator> containing (current, end)
-*/
-
-template<typename T>
-struct iterator_wrapper {
-    typedef decltype(*(std::declval<T>())) value_t;
-
-    static value_t next(std::pair<T, T> &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);
-    }
-};
-
-/*
-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<typename T>
-struct range_wrapper {
-    typedef decltype(std::declval<T>().begin()) iterator_t;
-
-    static std::pair<iterator_t, iterator_t> iter(T &range) {
-        return std::make_pair(range.begin(), range.end());
-    }
-
-    static void wrap(const char *range_name, const char *iter_name) {
-        class_<T>(range_name, no_init)
-                .def("__iter__", iter);
-        iterator_wrapper<iterator_t>().wrap(iter_name);
-    }
-};
 
 /*
 A wrapper to enable custom type/ID to/from string conversions
  */
-template <typename T> struct string_wrapper {
+template<typename T>
+struct string_wrapper {
 	template<typename F>
 	struct from_pystring_converter {
 		from_pystring_converter() {
@@ -89,34 +46,37 @@ template <typename T> struct string_wrapper {
 					boost::python::type_id<T>());
 		};
 
-		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<T>*)
+			void *storage = (
+					(boost::python::converter::rvalue_from_python_storage<T> *)
 							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<typename F> struct to_str_wrapper {
+	template<typename F>
+	struct to_str_wrapper {
 		static F fn;
-		std::string str(T& x) {
+
+		std::string str(T &x) {
 			return fn(x);
 		}
 	};
 
-	template<typename F1, typename F2> static void wrap(const char *type_name, F1 to_str_fn, F2 from_str_fn) {
+	template<typename F1, typename F2>
+	static void wrap(const char *type_name, F1 to_str_fn, F2 from_str_fn) {
 		from_pystring_converter<F2>::fn = from_str_fn;
 		from_pystring_converter<F2>();
 		to_str_wrapper<F1>::fn = to_str_fn;
@@ -124,13 +84,34 @@ template <typename T> struct string_wrapper {
 	};
 };
 
-#define WRAP_RANGE(t) range_wrapper<t##Range>().wrap(#t "Range", #t "Iterator")
+std::string parse_python_exception();
+
+template<typename Tn>
+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 = incref(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/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 <clifford@clifford.at>
+ *  Copyright (C) 2018  David Shah <dave@ds0.me>
+ *
+ *  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 <utility>
+#include <stdexcept>
+#include <type_traits>
+#include <boost/python.hpp>
+#include <boost/python/suite/indexing/vector_indexing_suite.hpp>
+#include <boost/python/suite/indexing/map_indexing_suite.hpp>
+#include <boost/python/suite/indexing/map_indexing_suite.hpp>
+
+using namespace boost::python;
+
+/*
+A wrapper for a Pythonised nextpnr Iterator. The actual class wrapped is a
+pair<Iterator, Iterator> containing (current, end)
+*/
+
+template<typename T, typename P>
+struct iterator_wrapper {
+	typedef decltype(*(std::declval<T>())) value_t;
+
+	static value_t next(std::pair <T, T> &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<typename T, typename P = return_value_policy<return_by_value>>
+struct range_wrapper {
+	typedef decltype(std::declval<T>().begin()) iterator_t;
+
+	static std::pair <iterator_t, iterator_t> iter(T &range) {
+		return std::make_pair(range.begin(), range.end());
+	}
+
+	static void wrap(const char *range_name, const char *iter_name) {
+		class_<T>(range_name, no_init)
+				.def("__iter__", iter);
+		iterator_wrapper<iterator_t, P>().wrap(iter_name);
+	}
+	typedef iterator_wrapper<iterator_t, P> iter_wrap;
+};
+
+#define WRAP_RANGE(t) range_wrapper<t##Range>().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<typename T>
+struct map_wrapper {
+	typedef boost::remove_cv_t<boost::remove_reference_t<typename T::key_type>> 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>(kv_name)
+				.def_readonly("first", &KV::first)
+				.def_readwrite("second", &KV::second);
+		typedef range_wrapper<T, return_value_policy<copy_non_const_reference>> rw;
+		typename rw::iter_wrap().wrap(iter_name);
+		class_<T>(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<t>().wrap(#name, #name "KeyValue", #name "Iterator")
+
+#endif
diff --git a/ice40/main.cc b/ice40/main.cc
index ae5c59b2..445e81ba 100644
--- a/ice40/main.cc
+++ b/ice40/main.cc
@@ -151,6 +151,7 @@ int main(int argc, char *argv[])
 
 	Design design(chipArgs);
 	init_python(argv[0]);
+	python_export_global("design", design);
 
 	if (vm.count("test"))
 	{
@@ -232,7 +233,7 @@ int main(int argc, char *argv[])
 		
 		parse_json_file(f, filename, &design);
 	}	
-	
+
 	if (vm.count("run"))
 	{
 		std::vector<std::string> files = vm["file"].as<std::vector<std::string>>();
diff --git a/python/dump_design.py b/python/dump_design.py
new file mode 100644
index 00000000..b8436288
--- /dev/null
+++ b/python/dump_design.py
@@ -0,0 +1,6 @@
+# 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))