Support ELF files loadable with gdb

examples/get-started/hello_world/.gdbinit.ci

@@ -0,0 +1,13 @@
+# Connect to a running instance of OpenOCD
+target remote 127.0.0.1:3333
+# Reset and halt the target
+mon reset halt
+# Run to a specific point in ROM code,
+#  where most of initialization is complete.
+thb *0x40007901
+c
+# Load the application into RAM
+load
+# Run till app_main
+tb app_main
+c

examples/get-started/hello_world/loadable_elf_example_test.py

@@ -0,0 +1,129 @@
+import os
+import pexpect
+import serial
+import sys
+import threading
+import time
+
+try:
+    import IDF
+except ImportError:
+    test_fw_path = os.getenv('TEST_FW_PATH')
+    if test_fw_path and test_fw_path not in sys.path:
+        sys.path.insert(0, test_fw_path)
+    import IDF
+
+import Utility
+
+
+class CustomProcess(object):
+    def __init__(self, cmd, logfile):
+        self.f = open(logfile, 'wb')
+        self.p = pexpect.spawn(cmd, timeout=60, logfile=self.f)
+
+    def __enter__(self):
+        return self
+
+    def close(self):
+        self.p.terminate(force=True)
+
+    def __exit__(self, type, value, traceback):
+        self.close()
+        self.f.close()
+
+
+class OCDProcess(CustomProcess):
+    def __init__(self, proj_path):
+        cmd = 'openocd -f interface/ftdi/esp32_devkitj_v1.cfg -f board/esp-wroom-32.cfg'
+        log_file = os.path.join(proj_path, 'openocd.log')
+        super(OCDProcess, self).__init__(cmd, log_file)
+        i = self.p.expect_exact(['Info : Listening on port 3333 for gdb connections', 'Error:'])
+        if i == 0:
+            Utility.console_log('openocd is listening for gdb connections')
+        else:
+            raise RuntimeError('openocd initialization has failed')
+
+    def close(self):
+        try:
+            self.p.sendcontrol('c')
+            self.p.expect_exact('shutdown command invoked')
+        except Exception:
+            Utility.console_log('openocd needs to be killed', 'O')
+            super(OCDProcess, self).close()
+
+
+class GDBProcess(CustomProcess):
+    def __init__(self, proj_path, elf_path):
+        cmd = 'xtensa-esp32-elf-gdb -x {} --directory={} {}'.format(os.path.join(proj_path, '.gdbinit.ci'),
+                                                                    os.path.join(proj_path, 'main'),
+                                                                    elf_path)
+        log_file = os.path.join(proj_path, 'gdb.log')
+        super(GDBProcess, self).__init__(cmd, log_file)
+        self.p.sendline('')  # it is for "---Type <return> to continue, or q <return> to quit---"
+        i = self.p.expect_exact(['Thread 1 hit Temporary breakpoint 2, app_main ()',
+                                 'Load failed'])
+        if i == 0:
+            Utility.console_log('gdb is at breakpoint')
+        else:
+            raise RuntimeError('Load failed: probably the ELF file was not built for loading with gdb')
+        self.p.expect_exact('(gdb)')
+
+    def close(self):
+        try:
+            self.p.sendline('q')
+            self.p.expect_exact('Quit anyway? (y or n)')
+            self.p.sendline('y')
+            self.p.expect_exact('Ending remote debugging.')
+        except Exception:
+            Utility.console_log('gdb needs to be killed', 'O')
+            super(GDBProcess, self).close()
+
+    def break_till_end(self):
+        self.p.sendline('b esp_restart')
+        self.p.sendline('c')
+        self.p.expect_exact('Thread 1 hit Breakpoint 3, esp_restart ()')
+
+
+class SerialThread(object):
+    def run(self, log_path, exit_event):
+        with serial.Serial('/dev/ttyUSB1', 115200) as ser, open(log_path, 'wb') as f:
+            while True:
+                f.write(ser.read(ser.in_waiting))
+                if exit_event.is_set():
+                    break
+                time.sleep(1)
+
+    def __init__(self, log_path):
+        self.exit_event = threading.Event()
+        self.t = threading.Thread(target=self.run, args=(log_path, self.exit_event,))
+        self.t.start()
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, type, value, traceback):
+        self.exit_event.set()
+        self.t.join(60)
+        if self.t.is_alive():
+            Utility.console_log('The pyserial thread is still alive', 'O')
+
+
+@IDF.idf_example_test(env_tag="test_jtag_arm")
+def test_examples_loadable_elf(env, extra_data):
+
+    idf_path = os.environ['IDF_PATH']
+    rel_project_path = os.path.join('examples', 'get-started', 'hello_world')
+    proj_path = os.path.join(idf_path, rel_project_path)
+    elf_path = os.path.join(IDF.Example(rel_project_path).get_binary_path(rel_project_path), 'hello-world.elf')
+    esp_log_path = os.path.join(proj_path, 'esp.log')
+
+    with SerialThread(esp_log_path):
+        with OCDProcess(proj_path), GDBProcess(proj_path, elf_path) as gdb:
+            gdb.break_till_end()
+
+    if pexpect.run('grep "Restarting now." {}'.format(esp_log_path), withexitstatus=True)[1]:
+        raise RuntimeError('Expected output from ESP was not received')
+
+
+if __name__ == '__main__':
+    test_examples_loadable_elf()

examples/get-started/hello_world/sdkconfig.ci

@@ -0,0 +1,6 @@
+CONFIG_APP_BUILD_TYPE_ELF_RAM=y
+CONFIG_VFS_SUPPORT_TERMIOS=
+CONFIG_NEWLIB_NANO_FORMAT=y
+CONFIG_ESP32_PANIC_PRINT_HALT=y
+CONFIG_ESP32_DEBUG_STUBS_ENABLE=
+CONFIG_ESP_ERR_TO_NAME_LOOKUP=