Merge pull request #47 from emlearn/neighbors-usermod

neighbors: Support building as user module

Author: jonnor

src/emlearn_neighbors/micropython.cmake

@@ -0,0 +1,17 @@
+add_library(usermod_emlearn_neighbors INTERFACE)
+
+execute_process(
+    COMMAND python3 -c "import emlearn; print(emlearn.includedir)"
+    OUTPUT_VARIABLE EMLEARN_DIR
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+target_sources(usermod_emlearn_neighbors INTERFACE
+    ${CMAKE_CURRENT_LIST_DIR}/neighbors.c
+)
+
+target_include_directories(usermod_emlearn_neighbors INTERFACE
+    ${EMLEARN_DIR}
+)
+
+target_link_libraries(usermod INTERFACE usermod_emlearn_neighbors)

src/emlearn_neighbors/micropython.mk

@@ -0,0 +1,9 @@
+MOD_DIR := $(USERMOD_DIR)
+
+# Add all C files to SRC_USERMOD.
+SRC_USERMOD_C += $(MOD_DIR)/neighbors.c
+
+EMLEARN_DIR := $(shell python3 -c "import emlearn; print(emlearn.includedir)")
+
+# We can add our module folder to include paths if needed
+CFLAGS_USERMOD += -I$(EMLEARN_DIR)

src/emlearn_neighbors/neighbors.c

@@ -1,5 +1,9 @@
 // Include the header file to get access to the MicroPython API
+#ifdef MICROPY_ENABLE_DYNRUNTIME
 #include "py/dynruntime.h"
+#else
+#include "py/runtime.h"
+#endif
 
 #define EML_LOG_ENABLE 0
 #if EML_LOG_ENABLE
@@ -11,6 +15,7 @@
 
 #include <string.h>
 
+#ifdef MICROPY_ENABLE_DYNRUNTIME
 // memset is used by some standard C constructs
 #if !defined(__linux__)
 void *memcpy(void *dst, const void *src, size_t n) {
@@ -20,8 +25,7 @@ void *memset(void *s, int c, size_t n) {
     return mp_fun_table.memset_(s, c, n);
 }
 #endif
-
-
+#endif // MICROPY_ENABLE_DYNRUNTIME
 
 
 // MicroPython type for EmlNeighborsModel
@@ -31,7 +35,12 @@ typedef struct _mp_obj_neighbors_model_t {
     EmlNeighborsDistanceItem *distances;
 } mp_obj_neighbors_model_t;
 
+#ifdef MICROPY_ENABLE_DYNRUNTIME
 mp_obj_full_type_t neighbors_model_type;
+#else
+static const mp_obj_type_t neighbors_model_type;
+#endif
+
 
 // Create a new instace
 static mp_obj_t neighbors_model_new(mp_obj_t items_obj, mp_obj_t features_obj, mp_obj_t neighbors_obj) {
@@ -71,9 +80,9 @@ static mp_obj_t neighbors_model_del(mp_obj_t self_obj) {
     EmlNeighborsModel *self = &o->model;   
 
     // free allocated memory
-    m_free(self->data);
-    m_free(self->labels);
-    m_free(o->distances);
+    m_del(int16_t, self->data, self->n_features*self->max_items);
+    m_del(int16_t, self->labels, self->max_items);
+    m_del(EmlNeighborsDistanceItem, o->distances, self->max_items);
 
     return mp_const_none;
 }
@@ -145,17 +154,14 @@ static MP_DEFINE_CONST_FUN_OBJ_3(neighbors_model_get_item_obj, neighbors_model_g
 
 
 // Takes a integer array
-static mp_obj_t neighbors_model_predict(mp_obj_fun_bc_t *self_obj,
-        size_t n_args, size_t n_kw, mp_obj_t *args) {
-    // Check number of arguments is valid
-    mp_arg_check_num(n_args, n_kw, 2, 2, false);
+static mp_obj_t neighbors_model_predict(mp_obj_t self_obj, mp_obj_t data_obj) {
 
-    mp_obj_neighbors_model_t *o = MP_OBJ_TO_PTR(args[0]);
+    mp_obj_neighbors_model_t *o = MP_OBJ_TO_PTR(self_obj);
     EmlNeighborsModel *self = &o->model;    
 
     // Extract buffer pointer and verify typecode
     mp_buffer_info_t bufinfo;
-    mp_get_buffer_raise(args[1], &bufinfo, MP_BUFFER_RW);
+    mp_get_buffer_raise(data_obj, &bufinfo, MP_BUFFER_RW);
     if (bufinfo.typecode != 'h') {
         mp_raise_ValueError(MP_ERROR_TEXT("expecting int16 array"));
     }
@@ -174,6 +180,7 @@ static mp_obj_t neighbors_model_predict(mp_obj_fun_bc_t *self_obj,
 
     return mp_obj_new_int(out);
 }
+static MP_DEFINE_CONST_FUN_OBJ_2(neighbors_model_predict_obj, neighbors_model_predict);
 
 // Access details about prediction result
 static mp_obj_t neighbors_model_get_result(mp_obj_t self_obj, mp_obj_t index_obj) {
@@ -200,7 +207,7 @@ static MP_DEFINE_CONST_FUN_OBJ_2(neighbors_model_get_result_obj, neighbors_model
 
 
 
-
+#ifdef MICROPY_ENABLE_DYNRUNTIME
 // Module setup
 mp_map_elem_t neighbors_model_locals_dict_table[5];
 static MP_DEFINE_CONST_DICT(neighbors_model_locals_dict, neighbors_model_locals_dict_table);
@@ -216,7 +223,7 @@ mp_obj_t mpy_init(mp_obj_fun_bc_t *self, size_t n_args, size_t n_kw, mp_obj_t *a
     neighbors_model_type.flags = MP_TYPE_FLAG_ITER_IS_CUSTOM;
     neighbors_model_type.name = MP_QSTR_emlneighbors;
     // methods
-    neighbors_model_locals_dict_table[0] = (mp_map_elem_t){ MP_OBJ_NEW_QSTR(MP_QSTR_predict), MP_DYNRUNTIME_MAKE_FUNCTION(neighbors_model_predict) };
+    neighbors_model_locals_dict_table[0] = (mp_map_elem_t){ MP_OBJ_NEW_QSTR(MP_QSTR_predict), MP_OBJ_FROM_PTR(&neighbors_model_predict_obj) };
     neighbors_model_locals_dict_table[1] = (mp_map_elem_t){ MP_OBJ_NEW_QSTR(MP_QSTR_additem), MP_OBJ_FROM_PTR(&neighbors_model_additem_obj) };
     neighbors_model_locals_dict_table[2] = (mp_map_elem_t){ MP_OBJ_NEW_QSTR(MP_QSTR___del__), MP_OBJ_FROM_PTR(&neighbors_model_del_obj) };
     neighbors_model_locals_dict_table[3] = (mp_map_elem_t){ MP_OBJ_NEW_QSTR(MP_QSTR_getresult), MP_OBJ_FROM_PTR(&neighbors_model_get_result_obj) };
@@ -227,4 +234,38 @@ mp_obj_t mpy_init(mp_obj_fun_bc_t *self, size_t n_args, size_t n_kw, mp_obj_t *a
     // This must be last, it restores the globals dict
     MP_DYNRUNTIME_INIT_EXIT
 }
+#else
+
+
+// Define the class
+static const mp_rom_map_elem_t neighbors_model_locals_dict_table[] = {
+
+    { MP_ROM_QSTR(MP_QSTR_predict), MP_ROM_PTR(&neighbors_model_predict_obj) },
+    { MP_ROM_QSTR(MP_QSTR_additem), MP_ROM_PTR(&neighbors_model_additem_obj) },
+    { MP_ROM_QSTR(MP_QSTR___del__), MP_ROM_PTR(&neighbors_model_del_obj) },
+    { MP_ROM_QSTR(MP_QSTR_getresult), MP_ROM_PTR(&neighbors_model_get_result_obj) },
+    { MP_ROM_QSTR(MP_QSTR_getitem), MP_ROM_PTR(&neighbors_model_get_item_obj) }
+};
+static MP_DEFINE_CONST_DICT(neighbors_model_locals_dict, neighbors_model_locals_dict_table);
+
+static MP_DEFINE_CONST_OBJ_TYPE(
+    neighbors_model_type,
+    MP_QSTR_emlneighbors,
+    MP_TYPE_FLAG_NONE,
+    locals_dict, &neighbors_model_locals_dict
+);
+
+// Define module object.
+static const mp_rom_map_elem_t emlearn_neighbors_globals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR_new), MP_ROM_PTR(&neighbors_model_new_obj) },
+};
+static MP_DEFINE_CONST_DICT(emlearn_neighbors_globals, emlearn_neighbors_globals_table);
+
+const mp_obj_module_t emlearn_neighbors_cmodule = {
+    .base = { &mp_type_module },
+    .globals = (mp_obj_dict_t *)&emlearn_neighbors_globals,
+};
+
+MP_REGISTER_MODULE(MP_QSTR_emlearn_neighbors, emlearn_neighbors_cmodule);
+#endif
 

src/micropython.cmake

@@ -2,5 +2,6 @@
 include(${CMAKE_CURRENT_LIST_DIR}/emlearn_trees/micropython.cmake)
 include(${CMAKE_CURRENT_LIST_DIR}/emlearn_fft/micropython.cmake)
 include(${CMAKE_CURRENT_LIST_DIR}/emlearn_iir/micropython.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/emlearn_neighbors/micropython.cmake)
 include(${CMAKE_CURRENT_LIST_DIR}/emlearn_arrayutils/micropython.cmake)
 include(${CMAKE_CURRENT_LIST_DIR}/tinymaix_cnn/micropython.cmake)