Support Bluetooth communcation JerryScript debugger

Documentation can be found in 07.DEBUGGER.md

JerryScript-DCO-1.0-Signed-off-by: Bence Gabor Kis [email protected]

Author: Bence Gabor Kis

.travis.yml

@@ -19,7 +19,11 @@ matrix:
     - name: "Checks"
       env:
         - OPTS="--check-signed-off=travis --check-cppcheck --check-doxygen --check-vera --check-license --check-magic-strings --check-pylint"
-      install: pip install --user pylint==1.6.5
+      install:
+        - sudo apt-get install -q libbluetooth-dev
+        - sudo apt-get install -q python-dev
+        - pip install --user pylint==1.6.5
+        - pip install --user pybluez
       addons:
         apt:
           packages: [doxygen, cppcheck, vera++]
@@ -68,7 +72,10 @@ matrix:
     - name: "Debugger Tests"
       env:
         - OPTS="--jerry-debugger"
-
+      install:
+        - sudo apt-get install -q libbluetooth-dev
+        - sudo apt-get install -q python-dev
+        - pip install --user pybluez
     - name: "Conformance Tests"
       env:
         - OPTS="--test262"

docs/07.DEBUGGER.md

@@ -9,7 +9,7 @@ This simple application demonstrates the communication protocol
 between the client and server, and can be reused by integrated
 development environments.
 
-## Setting up the debugger server
+## Setting up TCP/IP debugger server
 
 The following arguments must be passed to `tools/build.py`:
 
@@ -21,6 +21,24 @@ JerryScript extension, which transmits messages over TCP/IP networks.
 If necessary/implemented, any reliable stream or datagram based
 protocol can be used for transmitting debugger messages.
 
+## Setting up Bluetooth debugger server
+
+The following arguments must be passed to `tools/build.py`:
+
+`--jerry-bl-debugger=on`
+
+The transport layer of the communication protocol is pluggable.
+At the moment, a WebSocket-based implementation is provided as a
+JerryScript extension, which transmits messages over Bluetooth network.
+
+The following library is needed to build JerryScript
+- libbluetooth-dev
+
+The following python commands needed to run jerry-client.py
+- sudo apt-get install -q python-dev
+- pip install --user pylint==1.6.5
+- pip install --user pybluez
+
 ## Debugging JavaScript applications
 
 The debugger client must be connected to the server before the
@@ -43,6 +61,12 @@ source code:
 
 `--debugger-wait-source`
 
+The following argument makes JerryScript create a server with
+the given type. There are two choices, tcp or bluetooth.
+(default: tcp)
+
+`--server-type bluetooth`
+
 It is also recommended to increase the log level to see
 the *Waiting for client connection* message:
 

jerry-core/CMakeLists.txt

@@ -22,6 +22,7 @@ set(ENABLE_ALL_IN_ONE          OFF     CACHE BOOL   "Enable all-in-one build?")
 # Optional features
 set(FEATURE_CPOINTER_32_BIT    OFF     CACHE BOOL   "Enable 32 bit compressed pointers?")
 set(FEATURE_DEBUGGER           OFF     CACHE BOOL   "Enable JerryScript debugger?")
+set(FEATURE_BL_DEBUGGER        OFF     CACHE BOOL   "Enable JerryScript bluetooth?")
 set(FEATURE_ERROR_MESSAGES     OFF     CACHE BOOL   "Enable error messages?")
 set(FEATURE_EXTERNAL_CONTEXT   OFF     CACHE BOOL   "Enable external context?")
 set(FEATURE_JS_PARSER          ON      CACHE BOOL   "Enable js-parser?")
@@ -73,9 +74,14 @@ if(FEATURE_MEM_STATS OR FEATURE_PARSER_DUMP OR FEATURE_REGEXP_DUMP)
   set(FEATURE_LOGGING_MESSAGE " (FORCED BY STATS OR DUMP)")
 endif()
 
+if(FEATURE_BL_DEBUGGER)
+ set(FEATURE_DEBUGGER ON)
+endif()
+
 # Status messages
 message(STATUS "ENABLE_ALL_IN_ONE           " ${ENABLE_ALL_IN_ONE} ${ENABLE_ALL_IN_ONE_MESSAGE})
 message(STATUS "FEATURE_CPOINTER_32_BIT     " ${FEATURE_CPOINTER_32_BIT} ${FEATURE_CPOINTER_32_BIT_MESSAGE})
+message(STATUS "FEATURE_BL_DEBUGGER         " ${FEATURE_BL_DEBUGGER})
 message(STATUS "FEATURE_DEBUGGER            " ${FEATURE_DEBUGGER})
 message(STATUS "FEATURE_ERROR_MESSAGES      " ${FEATURE_ERROR_MESSAGES})
 message(STATUS "FEATURE_EXTERNAL_CONTEXT    " ${FEATURE_EXTERNAL_CONTEXT})
@@ -208,6 +214,11 @@ if(FEATURE_MEM_STATS)
   set(DEFINES_JERRY ${DEFINES_JERRY} JMEM_STATS)
 endif()
 
+# Enable bluetooth_debugger
+if(FEATURE_BL_DEBUGGER)
+  set(DEFINES_JERRY ${DEFINES_JERRY} JERRY_BL_DEBUGGER)
+endif()
+
 # Enable debugger
 if(FEATURE_DEBUGGER)
   set(DEFINES_JERRY ${DEFINES_JERRY} JERRY_DEBUGGER)

jerry-debugger/jerry_client.py

@@ -22,6 +22,7 @@
 import sys
 import logging
 import time
+import bluetooth
 import jerry_client_ws
 
 def write(string):
@@ -291,6 +292,15 @@ def main():
 if __name__ == "__main__":
     try:
         main()
+    except bluetooth.BluetoothError as error_msg:
+        ERRNO = int(str(error_msg).split(",")[0].split("(")[1])
+        MSG = str(error_msg)
+        if ERRNO == 111:
+            sys.exit("Failed to connect to the JerryScript debugger.")
+        elif ERRNO == 32 or ERRNO == 104:
+            sys.exit("Connection closed.")
+        else:
+            sys.exit("Failed to connect to the JerryScript debugger.\nError: %s" % (MSG))
     except socket.error as error_msg:
         ERRNO = error_msg.errno
         MSG = str(error_msg)

jerry-debugger/jerry_client_ws.py

@@ -22,6 +22,7 @@
 import socket
 import struct
 import sys
+import bluetooth
 
 # Expected debugger protocol version.
 JERRY_DEBUGGER_VERSION = 8
@@ -266,15 +267,24 @@ def get_text(self):
 
 
 class JerryDebugger(object):
-    # pylint: disable=too-many-instance-attributes,too-many-statements,too-many-public-methods,no-self-use
+    # pylint: disable=too-many-instance-attributes,too-many-statements,too-many-public-methods,no-self-use,too-many-branches
     def __init__(self, address):
 
         if ":" not in address:
             self.host = address
             self.port = 5001  # use default port
+            self.client_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+
+        elif len(address.split(":")) == 2:
+            self.host = address.split(":")[0]
+            self.port = int(address.split(":")[1])
+            self.client_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        elif len(address.split(":")) == 6:
+            self.host = address
+            self.port = 1
+            self.client_socket = bluetooth.BluetoothSocket(bluetooth.RFCOMM)
         else:
-            self.host, self.port = address.split(":")
-            self.port = int(self.port)
+            sys.exit()
 
         print("Connecting to: %s:%s" % (self.host, self.port))
 
@@ -303,7 +313,6 @@ def __init__(self, address):
         self.nocolor = ''
         self.src_offset = 0
         self.src_offset_diff = 0
-        self.client_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
         self.client_socket.connect((self.host, self.port))
         self.non_interactive = False
         self.current_out = b""
@@ -385,7 +394,10 @@ def __init__(self, address):
             self.message_data = result[len_expected:]
 
     def __del__(self):
-        self.client_socket.close()
+        try:
+            self.client_socket.close()
+        except AttributeError:
+            print ('Wrong address type')
 
     def _exec_command(self, command_id):
         self.send_command(command_id)

jerry-ext/CMakeLists.txt

@@ -53,5 +53,9 @@ target_include_directories(${JERRY_EXT_NAME} PRIVATE ${INCLUDE_EXT_PRIVATE})
 target_compile_definitions(${JERRY_EXT_NAME} PUBLIC ${DEFINES_EXT})
 target_link_libraries(${JERRY_EXT_NAME} jerry-core)
 
+if(FEATURE_BL_DEBUGGER)
+  target_link_libraries(${JERRY_EXT_NAME} -lbluetooth)
+endif()
+
 install(TARGETS ${JERRY_EXT_NAME} DESTINATION lib)
 install(DIRECTORY ${INCLUDE_EXT_PUBLIC}/ DESTINATION include)