函数栈跟踪

诊断和调试程序错误最有用的技术之一是栈跟踪(stack traceback,即当前正在执行的程序栈上所有函数调用的列表)。跟踪记录是通往错误位置的路线图,能够精确定位错误在“函数树”中发生的位置。很多时候,错误的原因可能位于距错误发生处很远的程序部分,但跟踪记录仍然是重要的起点。

所有 Riverbed 程序(包括仿真)都具备为 Riverbed 提供的函数生成栈跟踪的能力(操作系统的调用不包含在跟踪记录中,因为栈跟踪技术要求被跟踪的函数中包含专门的代码)。如果发生错误,可以使用 op_vuerr 工具打印函数跟踪记录(文档见“op_vuerr“ 第 221 页)。图 1 展示了一个 op_vuerr 输出示例。注意,栈列表由一系列函数引用组成,每个函数引用包含函数名及其参数名列表。函数列表自上而下展开,从顶层函数一直延伸到发生错误的函数。因此在该示例中,函数 #10(sim_err_pk_access())与导致程序中止的段违例相关联。

图 1:op_vuerr 输出示例

extracted the following messages from 'err_log' file:
<<< Program Abort >>>
 * Time:      13:32:07 Wed Aug 06 2003
 * Product:   modeler
 * Program:   op_runsim (Version 10.0.A PL1 Build 2282)
 * System:    Windows NT 5.0 Build 2195
 * Package:   process (acb_fifo) at module (top.m1.queue)
 * Function:  sim_err_pk_access
 * Error:     Packet pointer is NIL
                     T (0), EV (4), MOD (top.m1.queue), KP (op_pk_destroy)

 * Function call stack: (builds down)
   ------------------------------------------------------------
              Call   Block
              Count  Line#  Function
   ------------------------------------------------------------
     0)          1  1073741928  0x09254d0e [name not available]
     1)          1  1879048703  0x00004c00 [name not available]
     2)          1  -805306207  0x0000c400 [name not available]
     3)          1    284  m3_main
     4)          1    935  sim_main
     5)          1   2364  sim_ev_loop
     6)          1    354  sim_strm_insert
     7)          5    522  sim_obj_qps_intrpt
     8)          2      1  acb_fifo [arrival enter execs]
     9)          1   1341  op_pk_destroy (pkptr)
    10)          1   1483  sim_err_pk_access
   ------------------------------------------------------------

在仿真中,所有 Riverbed 提供的函数(包括内核过程和底层的仿真内核函数)都包含了栈跟踪代码。用户定义的仿真函数(出现在进程模型函数块或外部 C/C++ 文件中)也可以被跟踪。事实上,大多数用户发现 op_vuerr 的最佳用途就是辅助调试他们的仿真函数。

要让用户定义的仿真函数被跟踪,它必须包含专门的栈跟踪代码。栈跟踪通过在函数的入口点和出口点插入预处理器宏语句来实现(一个函数只有一个入口点,但由于 C 语言的 return 语句,可以有多个出口点)。这些宏语句名为 FIN、FOUT 和 FRET(分别代表 Function-In、Function-Out 和 Function-Returns)。

Riverbed 分析软件提供的所有示例模型都包含了这些宏。建议用户定义的函数也包含它们。如果 FIN、FOUT 和 FRET 语句被正确地插入用户定义的函数中,那么即使是在一组嵌套的模型函数调用中,也可以使用 op_vuerr 确定程序错误的位置。

这些宏的语法如下。

FIN (<function name & arguments>)
FOUT
FRET (<return type>)

语法与放置说明

  • FIN 插入在函数入口点附近。确切的位置因情况而异,如下所示:
    • 在 C++ 中,FIN 应放在最前面(紧跟左花括号“{“之后),以确保在任何局部变量调用其构造函数之前建立好函数调用栈。
    • 在 C 中,FIN 宏同时包含变量声明和语句。此外,进程模型的状态变量和某些内核过程依赖于在使用之前已经调用过 FIN()。因此为简单起见,我们建议在 FIN 之前声明所有其他函数级变量,并把所有其他 C 语句放在 FIN 之后。
    • 变量声明可以包含常量赋值。但任何涉及函数调用的内容都应放在 FIN 之后,这样可以确保在需要报告错误或警告时函数调用栈已经妥善建立。
    • 如果你的编译器允许 C99 特性(gcc:-std=c99;Intel ICL:/Qstd=c99),变量可以在函数内的任何位置声明。在这种情况下,不妨把 FIN 放在最前面,但要确保代码始终以支持 C99 的方式编译。
  • FOUT 插入在不返回任何值的函数出口点。
  • FRET 插入在返回值的函数出口点。
  • 这些宏不需要结尾的分号(它们自带分号)。
  • FIN 的参数不需要双引号(它自带双引号)。
  • FIN 和 FRET 的参数用于在错误日志中打印函数调用栈以及一般调试。它们在编译期间不作为符号使用,因此你可以包含任何你认为有用的信息。
  • 在某些支持并行仿真的函数中,FIN 宏可能会被 FIN_MT 宏取代(如“Simulation Context Pointer“ 第 423 页所述)。FIN 和 FIN_MT 的语法完全相同。

图 2:FIN / FRET 使用示例

int
sum_three (int a, int b, int c)
	{
	int sum;
	FIN (sum_three (a, b, c))
	sum = a + b + c;
	FRET (sum)
	}

图 3:FIN / FOUT 使用示例

void
pr_banner (char* string)
	{
	FIN (pr_banner (string))
	printf ("-----------\n");
	printf ("%s\n", string);
	printf ("-----------\n");
	FOUT
	}

**警告:**不要在 EMA 或 ET 程序的 main() 函数中使用 FIN、FOUT 和 FRET 宏。如果这些宏出现在 prg_init()、Vos_Init() 或 Ema_Init() 被调用之前,将会发生异常的函数栈不平衡错误。