在 ODB 中使用跟踪记录
ODB 中的*跟踪记录(trace)*主要是进程响应某个事件或调用所调用的函数(包括内核过程和某些自定义函数)的列表。跟踪记录用于在动态仿真上下文中观察进程逻辑的执行、衡量进程执行的进展,以及验证进程所调用函数的参数值和返回值。跟踪记录提供关于三类调用的信息:
- 内核过程(KP)
- 包含 FIN/FOUT/FRET 宏的用户自定义函数
- 进程
跟踪记录输出格式
单个内核过程调用的跟踪信息格式如图 16所示。当用户只有“use”访问权限时,受保护进程模型的跟踪输出会被抑制;此时会显示一条说明该模型受保护的消息。
图 16:ODB 内核过程调用跟踪格式

内核过程跟踪通常显示以下各项:
- 内核过程名称
- 内核过程参数名称列表
- 内核过程参数的值(在其打印值意义不大的情况下除外,例如指针)
- 与内核过程参数直接相关的值(例如表示数据包指针参数值的包 ID)
- 内核过程的返回值(在有返回值的情况下)
如果你在自己定义的函数中包含 FIN/FOUT/FRET 宏,这些函数也会出现在跟踪记录中。与内核过程不同,跟踪中只会自动显示 FIN 文本。要显示用户自定义函数的参数值和返回值,可以使用第 25 章“Trace Package”第 1 页中介绍的 op_trace… 系列内核过程。
注: FIN 宏除了用于函数跟踪外,进程模型代码中也必须使用 FIN 宏才能访问状态变量(除非将“no_fin_required_for_state_vars”属性设为 TRUE)。
除了函数特定的信息外,跟踪记录还包含正在执行的进程的信息。当被跟踪的进程被调用时,会显示其模型名称。当进程状态的 enter executives 或 exit executives 开始被跟踪执行时,会显示状态名称和 executive 标题。这些进程相关消息的示例如图 17所示。
图 17:ODB 进程消息格式

如果为某个特定模块设置了跟踪记录,它将包含该模块中调用的所有进程的跟踪信息(启用全局跟踪时也是如此)。如果此类模块中包含调用子进程的进程,跟踪输出将包含嵌套的进程调用和返回消息,如下面所列。
图 18:ODB 嵌套进程消息

内置跟踪记录
ODB 中跟踪输出的生成可以对所有函数启用或禁用。但是,如果只在函数于特定条件下执行时(例如在特定模块内或被特定进程调用时)才启用跟踪,跟踪将是有用得多的工具。通过将跟踪限制在聚焦的条件下,可以避免大量无关的跟踪消息。与断点一样,每当出现 ODB 提示符时都可以设置新的跟踪记录。ODB 支持可用于设置限定于特定模块、进程、数据包或称为数据包树的数据包组的跟踪记录的命令。
表 11:基本跟踪记录设置命令
| "encaptrace" | 启用封装跟踪,即当被跟踪的数据包(数据包 A)被设置为某数据包(数据包 B)的字段之一时,自动为该数据包(数据包 B)开启跟踪。 |
| "exectrace" | 启用执行跟踪,即在每个事件之后生成特殊的跟踪信息。 |
| "fulltrace" | 在启用或禁用全局函数调用跟踪之间切换(初始模式为禁用)。 |
| "icitrace" | 为涉及指定 ICI 的函数设置跟踪记录。 |
| "interfacetrace" | 为应用于外部系统指定接口的函数设置跟踪记录。 |
| "mtrace" | 为在指定模块内调用的函数设置跟踪记录。 |
| "mttrace" | 设置并行内核的跟踪打印模式。 |
| "pktrace" | 为应用于指定数据包的函数设置跟踪记录。 |
| "protrace" | 为由指定进程调用的函数设置跟踪记录。 |
| "pttrace" | 为应用于数据包树中任何数据包的函数设置跟踪记录(数据包树定义为通过复制从同一个原始源数据包派生出的所有数据包的集合)。 |
| "ptrtrace" | 控制跟踪记录显示指针的方式。 |
| "tracefmt" | 在图 17所示的缩进跟踪格式与 10.0 版本之前使用的平铺格式之间切换。 |
用户自定义跟踪记录
上述基本跟踪记录产生的输出由 ODB 决定,只显示关于函数调用和进程状态边界的信息。仍然隐藏的信息包括进程临时变量和状态变量的值,以及不调用函数的进程语句的结果。要在 ODB 中获得这类信息,可以在进程模型中添加用户自定义的跟踪语句。用户自定义的跟踪语句可以格式化,以便便捷地汇总相关的进程信息供快速评估,其形式可简单可复杂。
- 简单的跟踪语句通常以 ODB 的风格显示消息或变量值,使用内核过程
op_prg_odb_print_major()和op_prg_odb_print_minor();若需要更灵活的格式,也可以通过 C 函数 printf()。 - 复杂的跟踪语句可以执行特殊的诊断操作,包括调用内核过程和用户自定义函数,甚至可以实际改变被跟踪进程的状态变量。
在 ODB 内部,用户自定义跟踪记录可以通过带标签跟踪记录来控制,使用与部分基本跟踪记录命令相对应的若干命令来启用。
注: 跟踪记录使用的标签与带标签断点使用的标签处于不同的空间。跟踪记录和断点可以有同名的标签,但它们互不影响。
要让 ODB 能够控制用户自定义的跟踪语句,这些语句必须使用内核过程 op_prg_odb_ltrace_active() 检查带标签跟踪记录是否存在,如图 19所示。该函数返回一个布尔值(0 或 1)。
图 19:进程状态中的用户自定义跟踪语句
/* Print trace information if enabled. */
if (op_prg_odb_ltrace_active ("tcp"))
{
sprintf (msg0, "Removing connection (%d) from TCB list.", conn_id);
op_prg_odb_print_minor (msg0, OPC_NIL);
}
表 12:带标签跟踪记录设置命令
| "ltrace" | 为指定标签设置跟踪记录。只有带有匹配标签的 op_prg_odb_ltrace_active() 调用返回 1。 |
| "mltrace" | 为指定标签设置限定于指定模块的跟踪记录。只有在指定模块内带有匹配标签的 op_prg_odb_ltrace_active() 调用返回 1。 |
| "proltrace" | 为指定标签设置限定于指定进程的跟踪记录。只有由指定进程发出的带有匹配标签的 op_prg_odb_ltrace_active() 调用返回 1。 |
控制跟踪记录
与断点一样,使用表 12中的命令之一设置跟踪记录,会将其添加到待触发跟踪记录列表中。ODB 利用跟踪记录列表决定哪些函数通过跟踪消息加以指示,以及哪些 op_prg_odb_ltrace_active() 调用将返回 1。列表左侧的数字是跟踪记录 ID,用于在修改跟踪记录的 ODB 命令中标识特定的跟踪记录。
表 13:跟踪记录列表命令
| "status" | 显示待触发断点、跟踪记录和动作的列表。 |
图 20:status 命令显示的跟踪记录列表
ODB> status
...
Traces :
0) trace on label (x_requests)
1) trace on module (top.f_0.p_1)
2) trace on packet with ID (46) (packet not in system)
跟踪记录与断点类似,也有两种状态之一:激活或挂起。激活的跟踪记录在其关联条件出现时显示跟踪消息,或使进程能够执行用户自定义的跟踪语句。挂起的跟踪记录被临时停用,即使其关联条件出现,也不会显示跟踪消息或启用跟踪语句。跟踪记录的挂起与激活允许用户开关跟踪记录,而无需完全重建它们。跟踪记录可以随时从列表中删除。ODB 支持激活、挂起和删除跟踪记录的命令。
表 14:跟踪记录修改命令
| "acttrace" | 重新激活指定的挂起跟踪记录。 |
| "deltrace" | 从已设置的跟踪记录列表中删除指定的跟踪记录。也可以删除列表中的所有跟踪记录。 |
| "susptrace" | 挂起指定的跟踪记录,使其在重新激活之前不显示输出。 |
你也可以在代码内部挂起和重新激活跟踪,使用内核过程 op_trace_suspend() 和 op_trace_resume()。这可以帮助你聚焦于值得关注的问题,跳过长串相似调用的跟踪输出,例如在遍历 Prg 列表时。