[modules] Create a new build target 'dynamic' (#1784)

This new target allows an app to run JS files from the FS, allowing
you to change what JS is running on the fly in regular non-ashell
builds. This mode only gives read access, but it does include the
parser.

Signed-off-by: Brian J Jones <[email protected]>

Author: brianjjones

Makefile

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2017, Intel Corporation.
+# Copyright (c) 2016-2018, Intel Corporation.
 
 # a place to add temporary defines to ZJS builds such as -DZJS_GPIO_MOCK
 #ZJS_FLAGS :=
@@ -109,7 +109,7 @@ JERRY_BASE ?= $(ZJS_BASE)/deps/jerryscript
 JERRY_OUTPUT = $(OUT)/$(BOARD)/jerry/build
 
 # Generate and run snapshot as byte code instead of running JS directly
-ifneq (,$(filter $(MAKECMDGOALS),ide ashell linux))
+ifneq (,$(filter $(MAKECMDGOALS),ide ashell linux dynamic))
 SNAPSHOT=off
 # if the user passes in SNAPSHOT=on for ide, ashell, or linux give an error
 ifeq ($(SNAPSHOT), on)
@@ -141,6 +141,11 @@ ZJS_FLAGS += -DIDE_GPIO_PIN=$(IDE_GPIO_PIN)
 endif
 endif
 
+# Settings for dynamic load builds
+ifneq (,$(filter $(MAKECMDGOALS),dynamic))
+FORCED := dynamic_load.json,$(FORCED)
+endif
+
 ifeq ($(BOARD), arduino_101)
 ARC = arc
 ARC_RAM = $$((79 - $(RAM)))
@@ -222,6 +227,9 @@ ide: zephyr
 .PHONY: ashell
 ashell: zephyr
 
+.PHONY: dynamic
+dynamic: zephyr
+
 # Flash images
 .PHONY: dfu
 dfu:
@@ -491,6 +499,7 @@ help:
 	@echo "    pristine:   Completely remove all generated files"
 	@echo "    check:      Run all the automated build tests"
 	@echo "    quickcheck: Run the quick Linux subset of automated build tests"
+	@echo "    dynamic     Build Zephyr in dynamic loading mode. Includes the parser"
 	@echo
 	@echo "Build options:"
 	@echo "    BOARD=      Specify a Zephyr board to build for"

src/ashell/jerry-code.c

@@ -15,7 +15,7 @@
 #include <zephyr.h>
 
 // JerryScript includes
-#include "file-utils.h"
+#include "../zjs_file_utils.h"
 #include "jerry-code.h"
 #include "jerryscript-port.h"
 
@@ -41,12 +41,6 @@ void javascript_eval_code(const char *source_buffer, ssize_t size)
     }
 }
 
-void restore_zjs_api()
-{
-    jerry_init(JERRY_INIT_EMPTY);
-    zjs_modules_init();
-}
-
 void javascript_stop()
 {
     if (parsed_code == 0)
@@ -55,16 +49,7 @@ void javascript_stop()
     /* Parsed source code must be freed */
     jerry_release_value(parsed_code);
     parsed_code = 0;
-
-    /* Cleanup engine */
-    zjs_modules_cleanup();
-    zjs_remove_all_callbacks();
-#ifdef CONFIG_BOARD_ARDUINO_101
-    zjs_ipm_free_callbacks();
-#endif
-    jerry_cleanup();
-
-    restore_zjs_api();
+    zjs_stop_js();
 }
 
 int javascript_parse_code(const char *file_name)

src/ashell/term-cmd.c

@@ -13,7 +13,7 @@
 #include <string.h>
 
 // Zephyr includes
-#include "file-utils.h"
+#include "../zjs_file_utils.h"
 #include "jerryscript-port.h"
 #include <atomic.h>
 #include <misc/printk.h>

src/ashell/term-ihex.c

@@ -22,7 +22,7 @@
 #include "term-cmd.h"
 #include "term-uart.h"
 
-#include "file-utils.h"
+#include "../zjs_file_utils.h"
 
 #ifndef CONFIG_IHEX_UPLOADER_DEBUG
 #define DBG(...) { ; }

src/dynamic_load.json

@@ -0,0 +1,12 @@
+{
+    "module": "dynamicload",
+    "depends": ["buffer", "fs"],
+    "zjs_config": [
+        "-I${ZEPHYR_BASE}/ext/fs/fat/include",
+        "-I./deps",
+        "-DZJS_DYNAMIC_LOAD"
+    ],
+    "src": [
+        "src/zjs_file_utils.c"
+    ]
+}

src/main.c

@@ -20,12 +20,14 @@
 #endif  // ZJS_LINUX_BUILD
 #include "zjs_script.h"
 #include "zjs_util.h"
-#ifdef ZJS_ASHELL
+#if defined (ZJS_ASHELL) || defined (ZJS_DYNAMIC_LOAD)
 #include <gpio.h>
 #include "zjs_board.h"
+#include "zjs_file_utils.h"
+#ifdef ZJS_ASHELL
 #include "ashell/ashell.h"
-#include "ashell/file-utils.h"
-#endif
+#endif // ZJS_ASHELL
+#endif // defined (ZJS_ASHELL) || defined (ZJS_DYNAMIC_LOAD)
 
 // JerryScript includes
 #include "jerryscript.h"
@@ -183,7 +185,7 @@ int main(int argc, char *argv[])
 
     file_name = argv[1];
     file_name_len = strlen(argv[1]);
-#elif defined ZJS_ASHELL
+#elif defined ZJS_ASHELL || defined ZJS_DYNAMIC_LOAD
     char *script = NULL;
 #else
     const char *script = NULL;
@@ -356,6 +358,10 @@ int main(int argc, char *argv[])
     }
 #endif
     while (1) {
+#ifdef ZJS_DYNAMIC_LOAD
+        // Check if we should load a new JS file
+        zjs_modules_check_load_file();
+#endif
 #ifdef ZJS_ASHELL
         if (ashell_mode) {
             zjs_ashell_process();

src/zjs_ashell.json

@@ -18,7 +18,7 @@
     ],
     "targets": ["arduino_101", "stm32f4_disco", "olimex_stm32_e407"],
     "src": [
-        "src/ashell/file-utils.c",
+        "src/zjs_file_utils.c",
         "src/ashell/jerry-code.c",
         "src/ashell/term-cmd.c",
         "src/ashell/term-ihex.c",

src/ashell/file-utils.c renamed to src/zjs_file_utils.c

@@ -1,4 +1,4 @@
-// Copyright (c) 2016-2017, Intel Corporation.
+// Copyright (c) 2016-2018, Intel Corporation.
 
 /**
 * @file
@@ -8,6 +8,7 @@
 */
 
 // C includes
+#if defined(ZJS_ASHELL) || defined(ZJS_DYNAMIC_LOAD)
 #include <ctype.h>
 #include <errno.h>
 #include <stdint.h>
@@ -24,8 +25,8 @@
 #include <misc/printk.h>
 
 // ZJS includes
-#include "file-utils.h"
-#include "../zjs_util.h"
+#include "zjs_file_utils.h"
+#include "zjs_util.h"
 
 #define FILE_ERR ERR_PRINT("Read file failed\n")
 
@@ -210,3 +211,4 @@ char *read_file_alloc(const char *file_name, ssize_t *size)
     fs_close_alloc(fp);
     return file_buf;
 }
+#endif // defined(ZJS_ASHELL) || defined(ZJS_DYNAMIC_LOAD)

src/ashell/file-utils.h renamed to src/zjs_file_utils.h

@@ -2,7 +2,7 @@
 
 #ifndef __file_wrapper_h__
 #define __file_wrapper_h__
-
+#if defined(ZJS_ASHELL) || defined(ZJS_DYNAMIC_LOAD)
 #include <ff.h>
 #include <fs.h>
 #include <fs/fat_fs.h>
@@ -18,4 +18,5 @@ ssize_t fs_size(fs_file_t *file);
 bool fs_valid_filename(char *filename);
 char *read_file_alloc(const char *file_name, ssize_t *size);
 int fs_get_boot_cfg_filename(const char *timestamp, char *filename);
+#endif // defined(ZJS_ASHELL) || defined(ZJS_DYNAMIC_LOAD)
 #endif  // __file_wrapper_h__

src/zjs_modules.c

@@ -24,24 +24,27 @@
 #include "zjs_timers.h"
 #include "zjs_util.h"
 #include "jerryscript-ext/module.h"
-#ifdef ZJS_ASHELL
-#include "ashell/file-utils.h"
+#if defined(ZJS_ASHELL) || defined(ZJS_DYNAMIC_LOAD)
+#include "zjs_file_utils.h"
 #endif
 
 struct routine_map {
     zjs_service_routine func;
     void *handle;
 };
 
+#ifdef ZJS_DYNAMIC_LOAD
+static char *load_file;
+#endif // ZJS_DYNAMIC_LOAD
+
 static u8_t num_routines = 0;
 struct routine_map svc_routine_map[NUM_SERVICE_ROUTINES];
 
 /*****************************************************************
 *   Real board JavaScript module resolver (ASHELL only currently)
 ******************************************************************/
 #ifndef ZJS_LINUX_BUILD
-#ifdef ZJS_ASHELL
-
+#if defined(ZJS_ASHELL) || defined(ZJS_DYNAMIC_LOAD)
 // Eval the JavaScript, and return the module.
 static bool javascript_eval_code(const char *source_buffer, ssize_t size,
                                  jerry_value_t *ret_val)
@@ -53,14 +56,14 @@ static bool javascript_eval_code(const char *source_buffer, ssize_t size,
     }
     return true;
 }
-#endif
+#endif  // defined(ZJS_ASHELL) || defined(ZJS_DYNAMIC_LOAD)
 
 // Find the module on the filestystem
 static bool load_js_module_fs(const jerry_value_t module_name,
                               jerry_value_t *result)
 {
-    // Currently searching the filesystem is only supported on ashell
-#ifdef ZJS_ASHELL
+    // Currently searching the filesystem is only supported on arduino 101
+#if defined(ZJS_ASHELL) || defined(ZJS_DYNAMIC_LOAD)
     jerry_size_t module_size = jerry_get_utf8_string_size(module_name) + 1;
     char module[module_size];
     zjs_copy_jstring(module_name, module, &module_size);
@@ -78,7 +81,8 @@ static bool load_js_module_fs(const jerry_value_t module_name,
     return ret;
 #else
     return false;
-#endif
+#endif  // defined(ZJS_ASHELL) || defined(ZJS_DYNAMIC_LOAD)
+
 }
 #else  // ZJS_LINUX_BUILD
 /****************************************
@@ -228,16 +232,23 @@ static ZJS_DECL_FUNC(native_print_handler)
     zjs_free(str);
     return ZJS_UNDEFINED;
 }
-
-static ZJS_DECL_FUNC(stop_js_handler)
+void zjs_stop_js()
 {
+    zjs_modules_cleanup();
+    zjs_remove_all_callbacks();
 #ifdef CONFIG_BOARD_ARDUINO_101
 #ifdef CONFIG_IPM
     zjs_ipm_free_callbacks();
-#endif
-#endif
-    zjs_modules_cleanup();
+#endif // CONFIG_IPM
+#endif // CONFIG_BOARD_ARDUINO_101
     jerry_cleanup();
+    jerry_init(JERRY_INIT_EMPTY);
+    zjs_modules_init();
+}
+
+static ZJS_DECL_FUNC(stop_js_handler)
+{
+    zjs_stop_js();
     return ZJS_UNDEFINED;
 }
 
@@ -255,6 +266,54 @@ static ZJS_DECL_FUNC(process_exit)
     exit(status);
 }
 #endif
+#ifdef ZJS_DYNAMIC_LOAD
+void zjs_modules_check_load_file()
+{
+    // No file waiting to load, just return
+    if (load_file == NULL) {
+        return;
+    }
+
+    zjs_stop_js();
+    char *buf = NULL;
+    size_t size;
+    jerry_value_t parsed_code = 0;
+    buf = read_file_alloc(load_file, &size);
+    parsed_code = jerry_parse((const jerry_char_t *)buf, size, false);
+    zjs_free(buf);
+
+    if (!jerry_value_has_error_flag(parsed_code)) {
+        ZVAL ret_value = jerry_run(parsed_code);
+        if (jerry_value_has_error_flag(ret_value)) {
+            ERR_PRINT("Error running JS\n");
+        }
+    }
+    else {
+        ERR_PRINT("Error parsing JS\n");
+    }
+
+    // Remove the load file so it doesn't load it again
+    zjs_free(load_file);
+    load_file = NULL;
+    jerry_release_value(parsed_code);
+}
+
+static ZJS_DECL_FUNC(zjs_run_js)
+{
+    ZJS_VALIDATE_ARGS(Z_STRING);
+    size_t len = MAX_FILE_NAME;
+    size_t file_len;
+    load_file = zjs_malloc(len);
+
+    zjs_copy_jstring(argv[0], load_file, &file_len);
+
+    if (!fs_exist(load_file)) {
+        return ZJS_ERROR("File doesn't exist");
+    }
+
+    return ZJS_UNDEFINED;
+}
+#endif  // ZJS_DYNAMIC_LOAD
 
 void zjs_modules_init()
 {
@@ -271,6 +330,9 @@ void zjs_modules_init()
     zjs_obj_add_function(global_obj, "eval", native_eval_handler);
     zjs_obj_add_function(global_obj, "print", native_print_handler);
     zjs_obj_add_function(global_obj, "stopJS", stop_js_handler);
+#ifdef ZJS_DYNAMIC_LOAD
+    zjs_obj_add_function(global_obj, "runJS", zjs_run_js);
+#endif // ZJS_DYNAMIC_LOAD
 
     // create the C handler for require JS call
     zjs_obj_add_function(global_obj, "require", native_require_handler);

src/zjs_modules.h

@@ -26,5 +26,6 @@ void zjs_modules_cleanup();
 void zjs_register_service_routine(void *handle, zjs_service_routine func);
 void zjs_unregister_service_routine(zjs_service_routine func);
 s32_t zjs_service_routines(void);
+void zjs_stop_js();
 
 #endif  // __zjs_modules_h__