[Ardunio] 利用GDB进行ESP8266/ESP32调试

在做ESP8266/ESP32开发的时候，经常会应该调试困难而阻碍开发。ESP8266/ESP32的常见开发方案有这么几种：

• 基于ESP的Arduino封装SDK开发
• 基于原生freeRTOS SDK、non-RTOS SDK、IDF SDK开发
• 基于PlatformIO来开发

常见的调试方式无非以下几种：

• 利用Serial打印Log
• 如果基于原生SDK开发，还可以利用编译dump出来的.S文件来定位异常时的代码行

但不见得每种手段都能用于所有的解决方案，如果遇到运行中报出异常，且手头也没有.S文件用于代码行定位，那除了打印一堆Log来定位问题代码外，还有别的办法吗？

以上几种编译方法都会产生.elf文件，我们只要在.elf中包含symbols就可以用来帮我们定位问题代码行了

1. 找到xtense编译器自带的gdb

ESP8266/ESP32的编译都是使用xtense的编译工具链来完成的，所以无论你使用Arduino、PlatformIO还是原生SDK，你都能找到这个编译工具链。

下面的目录都是适用于Linux中的开发，如果你是在Windows中开发，目录大同小异，都是运行编译工具链的目录

• Arduino

  在下来目录中寻找gdb:

• Eclipse中基于ArduinoCDT开发，在下面的目录中寻找gdb:

  ~/.arduinocdt/packages/esp8266/tools/xtensa-lx106-elf-gcc/2.5.0-4-b40a506/bin/xtensa-lx106-elf-gdb

• PlatfromIO

  在下来目录中寻找gdb:
  ~/.platformio/packages/toolchain-xtensa/bin/xtensa-lx106-elf-gdb

2. 让编译出来的elf文件携带symbols

想办法在编译时为gcc添加如下编译选项即可：

-Og -ggdb -DDEBUG_ESP_PORT=Serial

• Arduino

  emmm....

• Eclipse中基于ArduinoCDT开发

  emmm....貌似找不到配置的地方

• PlatfromIO

  在项目根目录中的platform.ini添加如下选项后，正常编译即可：
  build_flags = -Og -ggdb -DDEBUG_ESP_PORT=Serial

3. gdb调试

1. 打开终端terminal

2. 把xtense的gdb导出为一个环境变量ESP_GDB(不同操作系统方法不同)

3. cd到项目根目录

4. 输入下列语句来启动GDB，参数为项目目录下编译目录中的elf文件，以PlatformIO为例

   $ESP_GDB ./.pio/build/nodemcuv2/firmware.elf
   

   接下来你会看到如下输出，则说明GDB已启动并成功加载了elf文件：

   GNU gdb (GDB) 8.2.50.20180723-git
   Copyright (C) 2018 Free Software Foundation, Inc.
   License GPLv3+: GNU GPL version 3 or later 
   This is free software: you are free to change and redistribute it.
   There is NO WARRANTY, to the extent permitted by law.
   Type "show copying" and "show warranty" for details.
   This GDB was configured as "--host=x86_64-linux-gnu --target=xtensa-lx106-elf".
   Type "show configuration" for configuration details.
   For bug reporting instructions, please see:
   .
   Find the GDB manual and other documentation resources online at:
       .
   
   For help, type "help".
   Type "apropos word" to search for commands related to "word"...
   Reading symbols from ./firmware.elf...done.
   (gdb) 
   

5. 此时就可以利用gdb来调试了
   举个简单的例子，当你遇到ESP8266在运行时抛出如下报错时：

   Fatal exception 28(LoadProhibitedCause):
   epc1=0x402018aa, epc2=0x00000000, epc3=0x00000000, excvaddr=0x00000000, depc=0x00000000

   >>>stack>>>
   ctx: cont
   sp: 3ffffdd0 end: 3fffffc0 offset: 01a0
   3fffff70: 4020c4e0 3ffee5c0 3ffee5cc 40201631
   3fffff80: 00000000 00000000 00000000 3ffee66c
   3fffff90: 3fffdad0 00000000 3ffee62c 40201664
   3fffffa0: 3fffdad0 00000000 3ffee62c 402034e8
   3fffffb0: feefeffe feefeffe 3ffe84f8 401012ad
   <<

   报错中的epc1为程序计数器，此时可在gdb的交互式界面里输入如下内容：

   (gdb) info line *0x402018aa
   

   然后gdb就会输入epc1所指示的代码行：

   (gdb) info line *0x402018aa
   Line 108 of "lib/ESP8266Audio/AudioGeneratorWAV.cpp"
      starts at address 0x402018a8 
      and ends at 0x402018b1 .