2019-01-02 08:59:57 -05:00
应用层跟踪库
============
2019-01-25 04:46:32 -05:00
:link_to_translation:`en:[English]`
2019-01-02 08:59:57 -05:00
概述
----
2019-12-10 01:55:35 -05:00
为了分析应用程序的行为，
2019-01-02 08:59:57 -05:00
开发人员可以使用这个功能库将应用程序的运行状态发送给主机，在运行时接收来自主机的命令或者其他类型的信息。该库的主要使用场景有：
1. 收集应用程序特定的数据，具体请参阅 :ref: `app_trace-application-specific-tracing`
2. 轻量级的日志记录，具体请参阅 :ref: `app_trace-logging-to-host`
3. 系统行为分析，具体请参阅 :ref: `app_trace-system-behaviour-analysis-with-segger-systemview`
使用 JTAG 接口的跟踪组件工作示意图：
.. figure :: ../../_static/app_trace-overview.jpg
:align: center
:alt: Tracing Components when Working Over JTAG
:figclass: align-center
使用 JTAG 接口的跟踪组件
运行模式
--------
该库支持两种操作模式：
**后验模式：** 这是默认的模式，该模式不需要和主机进行交互。在这种模式下，跟踪模块不会检查主机是否已经从 *HW UP BUFFER* 缓冲区读走所有数据，而是直接使用新数据覆盖旧数据。该模式在用户仅对最新的跟踪数据感兴趣时会很有用，例如分析程序在崩溃之前的行为。主机可以稍后根据用户的请求来读取数据，例如通过特殊的 OpenOCD 命令（假如使用了 JTAG 接口）。
2019-12-10 01:55:35 -05:00
**流模式：** 当主机连接到 {IDF_TARGET_NAME} 时，跟踪模块会进入此模式。在这种模式下，跟踪模块在新数据写入 *HW UP BUFFER* 之前会检查其中是否有足够的空间，并在必要的时候等待主机读取数据并释放足够的内存。用户会将最长的等待时间作为超时时间参数传递给相应的 API 函数，如果超时时间是个有限值，那么应用程序有可能会因为超时而将待写的数据丢弃。尤其需要注意，如果在讲究时效的代码中（如中断处理函数，操作系统调度等）指定了无限的超时时间，那么系统会产生故障。为了避免丢失此类关键数据，开发人员可以通过在 menuconfig 中开启 :ref: `CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX` 选项来启用额外的数据缓冲区。此宏还指定了在上述条件下可以缓冲的数据大小，它有助于缓解由于 USB 总线拥塞等原因导致的向主机传输数据间歇性减缓的状况。但是，当跟踪数据流的平均比特率超过硬件接口的能力时，它也无能为力。
2019-01-02 08:59:57 -05:00
配置选项与依赖项
----------------
使用此功能需要在主机端和目标端做相应的配置：
1. **主机端：** 应用程序跟踪是通过 JTAG 来完成的，因此需要在主机上安装并运行 OpenOCD。相关详细信息请参阅 :doc: `JTAG Debugging <../api-guides/jtag-debugging/index>` 。
2019-09-13 08:49:11 -04:00
2. **目标端：** 在 menuconfig 中开启应用程序跟踪功能。 *Component config > Application Level Tracing* 菜单允许选择跟踪数据的传输目标（具体用于传输的硬件接口），选择任一非 None 的目标都会自动开启 `` CONFIG_APPTRACE_ENABLE `` 这个选项。
2019-01-02 08:59:57 -05:00
.. note ::
为了实现更高的数据速率并降低丢包率，建议优化 JTAG 的时钟频率，使其达到能够稳定运行的最大值。详细信息请参阅 :ref: `jtag-debugging-tip-optimize-jtag-speed` 。
以下为前述未提及的另外两个 menuconfig 选项：
2019-09-13 08:49:11 -04:00
1. *Threshold for flushing last trace data to host on panic* （ :ref: `CONFIG_APPTRACE_POSTMORTEM_FLUSH_THRESH` ）。由于在 JTAG 上工作的性质，此选项是必选项。在该模式下，跟踪数据以 16 KB 数据块的形式曝露给主机。在后验模式中，当一个块被填充时，它会曝露给主机，而之前的块会变得不可用。换句话说，跟踪数据以 16 KB 的粒度进行覆盖。在发生 panic 的时候，当前输入块的最新数据将会被曝露给主机，主机可以读取它们以进行后续分析。如果系统发生 panic 的时候仍有少量数据还没来得及曝光给主机，那么之前收集的 16 KB 的数据将丢失，主机只能看到非常少的最新的跟踪部分，它可能不足以用来诊断问题所在。此 menuconfig 选项允许避免此类情况，它可以控制在发生 panic 时刷新数据的阈值，例如用户可以确定它需要不少于 512 字节的最新跟踪数据，所以如果在发生 panic 时待处理的数据少于 512 字节，它们不会被刷新，也不会覆盖之前的 16 KB。该选项仅在后验模式和 JTAG 工作时有意义。
2019-01-02 08:59:57 -05:00
2019-09-13 08:49:11 -04:00
2. *Timeout for flushing last trace data to host on panic* （ :ref: `CONFIG_APPTRACE_ONPANIC_HOST_FLUSH_TMO` ）。该选项仅在流模式下才起作用，它控制跟踪模块在发生 panic 时等待主机读取最新数据的最长时间。
2019-01-02 08:59:57 -05:00
如何使用这个库
--------------
2019-12-10 01:55:35 -05:00
该库提供了用于在主机和 {IDF_TARGET_NAME} 之间传输任意数据的 API。当在 menuconfig 中启用时，目标应用程序的跟踪模块会在系统启动时自动初始化，因此用户需要做的就是调用相应的 API 来发送、接收或者刷新数据。
2019-01-02 08:59:57 -05:00
.. _app_trace-application-specific-tracing:
特定应用程序的跟踪
~~~~~~~~~~~~~~~~~~
通常，用户需要决定在每个方向上待传输数据的类型以及如何解析（处理）这些数据。要想在目标和主机之间传输数据，用户必须要执行以下几个步骤。
1. 在目标端，用户需要实现将跟踪数据写入主机的算法，下面的代码片段展示了如何执行此操作。
.. code-block :: c
#include "esp_app_trace.h"
...
char buf[] = "Hello World!";
esp_err_t res = esp_apptrace_write(ESP_APPTRACE_DEST_TRAX, buf, strlen(buf), ESP_APPTRACE_TMO_INFINITE);
if (res != ESP_OK) {
ESP_LOGE(TAG, "Failed to write data to host!");
return res;
}
`` esp_apptrace_write() `` 函数使用 memcpy 把用户数据复制到内部缓存中。在某些情况下，使用 `` esp_apptrace_buffer_get() `` 和 `` esp_apptrace_buffer_put() `` 函数会更加理想，它们允许开发人员自行分配缓冲区并填充。下面的代码片段展示了如何执行此操作。
.. code-block :: c
#include "esp_app_trace.h"
...
int number = 10;
char *ptr = (char * )esp_apptrace_buffer_get(ESP_APPTRACE_DEST_TRAX, 32, 100/*tmo in us* /);
if (ptr == NULL) {
ESP_LOGE(TAG, "Failed to get buffer!");
return ESP_FAIL;
}
sprintf(ptr, "Here is the number %d", number);
esp_err_t res = esp_apptrace_buffer_put(ESP_APPTRACE_DEST_TRAX, ptr, 100/*tmo in us* /);
if (res != ESP_OK) {
/* in case of error host tracing tool (e.g. OpenOCD) will report incomplete user buffer * /
ESP_LOGE(TAG, "Failed to put buffer!");
return res;
}
另外，根据实际项目的需要，用户可能希望从主机接收数据。下面的代码片段展示了如何执行此操作。
.. code-block :: c
#include "esp_app_trace.h"
...
char buf[32];
char down_buf[32];
size_t sz = sizeof(buf);
/* config down buffer * /
esp_apptrace_down_buffer_config(down_buf, sizeof(down_buf));
/* check for incoming data and read them if any * /
esp_err_t res = esp_apptrace_read(ESP_APPTRACE_DEST_TRAX, buf, &sz, 0/*do not wait* /);
if (res != ESP_OK) {
ESP_LOGE(TAG, "Failed to read data from host!");
return res;
}
if (sz > 0) {
/* we have data, process them * /
...
}
`` esp_apptrace_read() `` 函数使用 memcpy 来把主机端的数据复制到用户缓存区。在某些情况下，使用 `` esp_apptrace_down_buffer_get() `` 和 `` esp_apptrace_down_buffer_put() `` 函数可能更为理想。它们允许开发人员占用一块读缓冲区并就地进行有关处理操作。下面的代码片段展示了如何执行此操作。
.. code-block :: c
#include "esp_app_trace.h"
...
char down_buf[32];
uint32_t *number;
size_t sz = 32;
/* config down buffer * /
esp_apptrace_down_buffer_config(down_buf, sizeof(down_buf));
char *ptr = (char * )esp_apptrace_down_buffer_get(ESP_APPTRACE_DEST_TRAX, &sz, 100/*tmo in us* /);
if (ptr == NULL) {
ESP_LOGE(TAG, "Failed to get buffer!");
return ESP_FAIL;
}
if (sz > 4) {
number = (uint32_t *)ptr;
printf("Here is the number %d", *number);
} else {
printf("No data");
}
esp_err_t res = esp_apptrace_down_buffer_put(ESP_APPTRACE_DEST_TRAX, ptr, 100/*tmo in us* /);
if (res != ESP_OK) {
/* in case of error host tracing tool (e.g. OpenOCD) will report incomplete user buffer * /
ESP_LOGE(TAG, "Failed to put buffer!");
return res;
}
2019-06-24 21:26:53 -04:00
2. 下一步是编译应用程序的镜像并将其下载到目标板上，这一步可以参考文档 :ref: `构建并烧写 <get-started-build>` 。
2019-01-02 08:59:57 -05:00
3. 运行 OpenOCD（ :doc: `JTAG 调试 <../api-guides/jtag-debugging/index>` ）。
4. 连接到 OpenOCD 的 telnet 服务器，在终端执行如下命令 `` telnet <oocd_host> 4444 ` ` 。如果在运行 OpenOCD 的同一台机器上打开
telnet 会话，您可以使用 `` localhost `` 替换上面命令中的 `` <oocd_host> ` ` 。
5. 使用特殊的 OpenOCD 命令开始收集待跟踪的命令，此命令将传输跟踪数据并将其重定向到指定的文件或套接字（当前仅支持文件作为跟踪数据目标）。相关命令的说明请参阅 :ref: `jtag-debugging-launching-debugger` 。
6. 最后一步是处理接收到的数据，由于数据格式由用户定义，因此处理阶段超出了本文档的范围。数据处理的范例可以参考位于 `` $IDF_PATH/tools/esp_app_trace `` 下的 Python 脚本 `` apptrace_proc.py `` （用于功能测试）和 `` logtrace_proc.py `` （请参阅 :ref: `app_trace-logging-to-host` 章节中的详细信息）。
OpenOCD 应用程序跟踪命令
^^^^^^^^^^^^^^^^^^^^^^^^
*HW UP BUFFER* 在用户数据块之间共享，并且会替 API 的调用者（在任务或者中断上下文中）填充分配到的内存。在多线程环境中，正在填充缓冲区的任务/中断可能会被另一个高优先级的任务/中断抢占， ， ， （ ） （
下面是 OpenOCD 应用程序跟踪命令的使用说明。
.. note ::
目前，
命令用法：
`` esp32 apptrace [start <options>] | [stop] | [status] | [dump <cores_num> <outfile>] ``
子命令：
`` start ``
开始跟踪（连续流模式）。
`` stop ``
停止跟踪。
`` status ``
获取跟踪状态。
`` dump ``
转储所有后验模式的数据。
Start 子命令的语法：
`` start <outfile> [poll_period [trace_size [stop_tmo [wait4halt [skip_size]]]] ``
`` outfile ``
用于保存来自两个 CPU 的数据文件的路径，该参数需要具有以下格式： `` file://path/to/file ` ` 。
`` poll_period ``
轮询跟踪数据的周期（单位：毫秒），如果大于 0 则以非阻塞模式运行。默认为 1 毫秒。
`` trace_size ``
最多要收集的数据量（单位：字节），接收到指定数量的数据后将会停止跟踪。默认情况下是 -1（ ）
`` stop_tmo ``
空闲超时（单位：秒），如果指定的时间段内都没有数据就会停止跟踪。默认为 -1（ ） （ ）
`` wait4halt ``
如果设置为 0 则立即开始跟踪，否则命令等待目标停止（复位，打断点等），然后自动恢复它并开始跟踪。默认值为 0。
`` skip_size ``
开始时要跳过的字节数，默认为 0。
.. note ::
如果 `` poll_period `` 为 0， ， `` trace_size `` 并等待，当收集到指定数据量时，跟踪会自动停止。
命令使用示例：
.. highlight :: none
1. 将 2048 个字节的跟踪数据收集到 “trace.log” 文件中，该文件将保存在 “openocd-esp32” 目录中。
::
esp32 apptrace start file://trace.log 1 2048 5 0 0
跟踪数据会被检索并以非阻塞的模式保存到文件中，如果收集满 2048 字节的数据或者在 5 秒内都没有新的数据，那么该过程就会停止。
.. note::
在将数据提供给 OpenOCD 之前，会对其进行缓冲。如果看到 “Data timeout!” 的消息，则目标可能在超时之前没有发送足够的数据给 OpenOCD 来清空缓冲区。增加超时时间或者使用函数 `` esp_apptrace_flush() `` 以特定间隔刷新数据都可以解决这个问题。
2. 在非阻塞模式下无限地检索跟踪数据。
::
esp32 apptrace start file://trace.log 1 -1 -1 0 0
对收集数据的大小没有限制，并且没有设置任何超时时间。可以通过在 OpenOCD 的 telnet 会话窗口中发送 `` esp32 apptrace stop `` 命令，或者在 OpenOCD 窗口中使用快捷键 Ctrl+C 来停止此过程。
3. 检索跟踪数据并无限期保存。
::
esp32 apptrace start file://trace.log 0 -1 -1 0 0
在跟踪停止之前，
4. 等待目标停止，然后恢复目标的操作并开始检索数据。当收集满 2048 字节的数据后就停止：
::
esp32 apptrace start file://trace.log 0 2048 -1 1 0
想要复位后立即开始跟踪，请使用 OpenOCD 的 `` reset halt `` 命令。
.. _app_trace-logging-to-host:
记录日志到主机
^^^^^^^^^^^^^^
记录日志到主机是 IDF 的一个非常实用的功能： （ ） ， `` ESP_LOGx `` 将待打印的字符串发送到 UART 的日志记录方式，这个功能的优势在于它减少了本地的工作量，而将大部分工作转移到了主机端。
IDF 的日志库会默认使用类 vprintf 的函数将格式化的字符串输出到专用的 UART。一般来说， ：
1. 解析格式字符串以获取每个参数的类型。
2. 根据其类型，将每个参数都转换为字符串。
3. 格式字符串与转换后的参数一起发送到 UART。
虽然可以将类 vprintf 函数优化到一定程度，但是上述步骤在任何情况下都是必须要执行的，并且每个步骤都会消耗一定的时间（尤其是步骤 3） ： ， ， ， ，
解决此类问题的可能方法是使用更高的波特率或者其他更快的接口，并将字符串格式化的工作转移到主机端。
通过应用层跟踪库的 `` esp_apptrace_vprintf `` 函数，可以将日志信息发送到主机，该函数不执行格式字符串和参数的完全解析，而仅仅计算传递的参数的数量，并将它们与格式字符串地址一起发送给主机。主机端会通过一个特殊的 Python 脚本来处理并打印接收到的日志数据。
局限
""""
目前通过 JTAG 实现记录日志还存在以下几点局限：
1. 不支持使用 `` ESP_EARLY_LOGx `` 宏进行跟踪。
2. 不支持大小超过 4 字节的 printf 参数（例如 `` double `` 和 `` uint64_t ` ` ）。
3. 仅支持 .rodata 段中的格式字符串和参数。
4. printf 参数最多 256 个。
如何使用
""""""""
为了使用跟踪模块来记录日志，用户需要执行以下步骤：
1. 在目标端，需要安装特殊的类 vprintf 函数，正如前面提到过的，这个函数是 `` esp_apptrace_vprintf ` ` ，它会负责将日志数据发送给主机。示例代码参见 :example: ` system/app_trace_to_host ` 。
2. 按照 :ref: `app_trace-application-specific-tracing` 章节中第 2-5 步骤中的说明进行操作。
3. 打印接收到的日志记录，请在终端运行以下命令：`` $IDF_PATH/tools/esp_app_trace/logtrace_proc.py /path/to/trace/file /path/to/program/elf/file ` ` 。
Log Trace Processor 命令选项
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
命令用法：
`` logtrace_proc.py [-h] [--no-errors] <trace_file> <elf_file> ``
位置参数（必要）：
`` trace_file ``
日志跟踪文件的路径
`` elf_file ``
程序 ELF 文件的路径
可选参数：
`` -h `` , `` --help ``
显示此帮助信息并退出
`` --no-errors `` , `` -n ``
不打印错误信息
.. _app_trace-system-behaviour-analysis-with-segger-systemview:
基于 SEGGER SystemView 的系统行为分析
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
IDF 中另一个基于应用层跟踪库的实用功能是系统级跟踪，它会生成与 `SEGGER SystemView 工具 <https://www.segger.com/products/development-tools/systemview/> `_ 相兼容的跟踪信息。SEGGER SystemView 是一种实时记录和可视化工具，用来分析应用程序运行时的行为。
.. note ::
目前，基于 IDF 的应用程序能够以文件的形式生成与 SystemView 格式兼容的跟踪信息，并可以使用 SystemView 工具软件打开。但是还无法使用该工具控制跟踪的过程。
如何使用
""""""""
2020-12-21 12:17:42 -05:00
若需使用这个功能，需要在 menuconfig 中开启 :ref: `CONFIG_APPTRACE_SV_ENABLE` 选项，具体路径为： *Component config > Application Level Tracing > FreeRTOS SystemView Tracing* 。在同一个菜单栏下还开启了其他几个选项：
2019-01-02 08:59:57 -05:00
2020-12-21 12:17:42 -05:00
1. *{IDF_TARGET_NAME} timer to use as SystemView timestamp source* （ :ref: `CONFIG_APPTRACE_SV_TS_SOURCE` ）选择 SystemView 事件使用的时间戳来源。在单核模式下，使用 {IDF_TARGET_NAME} 内部的循环计数器生成时间戳，其最大的工作频率是 240 MHz（ ） ，
2. 可以单独启用或禁用的 SystemView 事件集合（`` CONFIG_APPTRACE_SV_EVT_XXX ` ` ） ：
2019-01-02 08:59:57 -05:00
- Trace Buffer Overflow Event
- ISR Enter Event
- ISR Exit Event
- ISR Exit to Scheduler Event
- Task Start Execution Event
- Task Stop Execution Event
- Task Start Ready State Event
- Task Stop Ready State Event
- Task Create Event
- Task Terminate Event
- System Idle Event
2019-12-10 01:55:35 -05:00
- Timer Enter Event
2019-01-02 08:59:57 -05:00
- Timer Exit Event
IDF 中已经包含了所有用于生成兼容 SystemView 跟踪信息的代码，用户只需配置必要的项目选项（如上所示），然后构建、烧写映像到目标板，接着参照前面的介绍，使用 OpenOCD 收集数据。
OpenOCD SystemView 跟踪命令选项
"""""""""""""""""""""""""""""""
命令用法：
`` esp32 sysview [start <options>] | [stop] | [status] ``
自命令：
`` start ``
开启跟踪（连续流模式）。
`` stop ``
停止跟踪。
`` status ``
获取跟踪状态。
Start 子命令语法：
`` start <outfile1> [outfile2] [poll_period [trace_size [stop_tmo]]] ``
`` outfile1 ``
保存 PRO CPU 数据的文件路径，此参数需要具有如下格式：`` file://path/to/file ` ` 。
`` outfile2 ``
保存 APP CPU 数据的文件路径，此参数需要具有如下格式：`` file://path/to/file ` ` 。
`` poll_period ``
跟踪数据的轮询周期（单位：毫秒）。如果该值大于 0，
`` trace_size ``
最多要收集的数据量（单位：字节）。当收到指定数量的数据后，将停止跟踪。默认值是 -1 （禁用跟踪大小停止触发器）。
`` stop_tmo ``
空闲超时（单位：秒）。如果指定的时间内没有数据，将停止跟踪。默认值是 -1（ ）
.. note ::
如果 `` poll_period `` 为 0， ， `` trace_size `` 然后等到收集满指定数量的数据后自动停止跟踪。
命令使用示例：
.. highlight :: none
1. 将 SystemView 跟踪数据收集到文件 “pro-cpu.SVDat” 和 “pro-cpu.SVDat” 中。这些文件会被保存在 “openocd-esp32” 目录中。
::
esp32 sysview start file://pro-cpu.SVDat file://app-cpu.SVDat
跟踪数据被检索并以非阻塞的方式保存，要停止此过程，需要在 OpenOCD 的 telnet 会话窗口输入 `` esp32 apptrace stop `` 命令，或者也可以在 OpenOCD 窗口中按下 Ctrl+C。
2. 检索跟踪数据并无限保存。
::
esp32 sysview start file://pro-cpu.SVDat file://app-cpu.SVDat 0 -1 -1
OpenOCD 的 telnet 命令行在跟踪停止前会无法使用，要停止跟踪，请在 OpenOCD 窗口按下 Ctrl+C。
数据可视化
""""""""""
2019-12-10 01:55:35 -05:00
收集到跟踪数据后， ， ，
2019-01-02 08:59:57 -05:00
在工具中单独分析每个核的跟踪数据是比较棘手的，幸运的是， Eclipse 中有一款 *Impulse* 的插件可以加载多个跟踪文件，并且可以在同一个视图中检查来自两个内核的事件。此外，与免费版的 SystemView 相比，此插件没有 1,000,000 个事件的限制。
关于如何安装、配置 Impulse 并使用它可视化来自单个核心的跟踪数据，请参阅 `官方教程 <https://mcuoneclipse.com/2016/07/31/impulse-segger-systemview-in-eclipse/> `_ 。
.. note ::
IDF 使用自己的 SystemView FreeRTOS 事件 ID 映射，因此用户需要将 `` $SYSVIEW_INSTALL_DIR/Description/SYSVIEW_FreeRTOS.txt `` 替换成 `` $IDF_PATH/docs/api-guides/SYSVIEW_FreeRTOS.txt ` ` 。
在使用上述链接配置 SystemView 序列化程序时，也应该使用该 IDF 特定文件的内容。
配置 Impulse 实现双核跟踪
~~~~~~~~~~~~~~~~~~~~~~~~~
在安装好 Impulse 插件后，先确保它能够在单独的选项卡中成功加载每个核心的跟踪文件，然后用户可以添加特殊的 Multi Adapter 端口并将这两个文件加载到一个视图中。为此，用户需要在 Eclipse 中执行以下操作：
1. 打开 “Signal Ports” 视图，前往 Windows->Show View->Other 菜单，在 Impulse 文件夹中找到 “Signal Ports” 视图，然后双击它。
2. 在 “Signal Ports” 视图中，右键单击 “Ports” 并选择 “Add ...”，然后选择 New Multi Adapter Port。
3. 在打开的对话框中按下 “Add” 按钮，选择 “New Pipe/File”。
4. 在打开的对话框中选择 “SystemView Serializer” 并设置 PRO CPU 跟踪文件的路径，按下确定保存设置。
5. 对 APP CPU 的跟踪文件重复步骤 3 和 4。
6. 双击创建的端口，会打开此端口的视图。
7. 单击 Start/Stop Streaming 按钮，数据将会被加载。
8. 使用 “Zoom Out”，
9. 有关设置测量光标和其他的功能，请参阅 `Impulse 官方文档 <http://toem.de/index.php/projects/impulse> `_ 。
.. note ::
如果您在可视化方面遇到了问题（ ） ， ，
