backtrace、backtrace_symbols、backtrace_symbols_fd-support for application self-debugging

標籤：

backtrace是庫函數引入的應用自調試函數。

系列裡的三個函數可以緩衝或輸出棧幀。

#include <execinfo.h>

int backtrace(void **buffer, int size);

char **backtrace_symbols(void *const *buffer, int size);

void backtrace_symbols_fd(void *const *buffer, int size, int fd);

轉自：http://www.linuxidc.com/Linux/2012-11/73470.htm

一般察看函數運行時堆棧的方法是使用GDB（bt命令）之類的外部調試器,但是,有些時候為了剖析器的BUG,(主要針對長時間運行程式的分析),在程式出錯時列印出函數的呼叫堆疊是非常有用的。

在glibc標頭檔"execinfo.h"中聲明了三個函數用於擷取當前線程的函數呼叫堆疊。

int backtrace(void **buffer,int size) 

該函數用於擷取當前線程的呼叫堆疊,擷取的資訊將會被存放在buffer中,它是一個指標列表。參數 size 用來指定buffer中可以儲存多少個void* 元素。函數傳回值是實際擷取的指標個數,最大不超過size大小。

在buffer中的指標實際是從堆棧中擷取的返回地址,每一個堆棧架構有一個返回地址。

注意:某些編譯器的最佳化選項對擷取正確的呼叫堆疊有幹擾,另外內嵌函式沒有堆棧架構;刪除架構指標也會導致無法正確解析堆棧內容

char ** backtrace_symbols (void *const *buffer, int size) 

backtrace_symbols將從backtrace函數擷取的資訊轉化為一個字串數組. 參數buffer應該是從backtrace函數擷取的指標數組,size是該數組中的元素個數(backtrace的傳回值)

函數傳回值是一個指向字串數組的指標,它的大小同buffer相同.每個字串包含了一個相對於buffer中對應元素的可列印資訊.它包括函數名，函數的位移地址,和實際的返回地址。

現在,只有使用ELF二進位格式的程式才能擷取函數名稱和位移地址.在其他系統,只有16進位的返回地址能被擷取.另外,你可能需要傳遞相應的符號給連結器,以能支援函數名功能(比如,在使用GNU ld連結器的系統中,你需要傳遞(-rdynamic)， -rdynamic可用來通知連結器將所有符號添加到動態符號表中，如果你的連結器支援-rdynamic的話，建議將其加上！)

該函數的傳回值是通過malloc函數申請的空間,因此調用者必須使用free函數來釋放指標.

注意:如果不能為字串擷取足夠的空間函數的傳回值將會為NULL

void backtrace_symbols_fd (void *const *buffer, int size, int fd) 

backtrace_symbols_fd與backtrace_symbols 函數具有相同的功能,不同的是它不會給調用者返回字串數組,而是將結果寫入檔案描述符為fd的檔案中,每個函數對應一行.它不需要調用malloc函數,因此適用於有可能調用該函數會失敗的情況
 
下面是glibc中的執行個體（稍有修改）：

#include <execinfo.h>
#include <stdio.h>
#include <stdlib.h>

/* Obtain a backtrace and print it to @code{stdout}. */
void print_trace (void)
{
 void *array[10];
 size_t size;
 char **strings;
　 size_t i;
　
 size = backtrace (array, 10);
 strings = backtrace_symbols (array, size);
 if (NULL == strings)
 {
　  perror("backtrace_synbols");
  Exit(EXIT_FAILURE);
 }

 printf ("Obtained %zd stack frames.\n", size);

 for (i = 0; i < size; i++)
  printf ("%s\n", strings[i]);

 free (strings);
　 strings = NULL;
}

/* A dummy function to make the backtrace more interesting. */
void dummy_function (void)
{
 print_trace ();
}

int main (int argc, char *argv[])
{
 dummy_function ();
 return 0;
}

輸出如下：

Obtained 4 stack frames.
./execinfo() [0x80484dd]
./execinfo() [0x8048549]
./execinfo() [0x8048556]
/lib/i386-linux-gnu/libc.so.6(__libc_start_main+0xf3) [0x70a113]

我們還可以利用這backtrace來定位段錯誤位置。

通常情況系，程式發生段錯誤時系統會發送SIGSEGV訊號給程式，預設處理是退出函數。我們可以使用 signal(SIGSEGV, &your_function);函數來接管SIGSEGV訊號的處理，程式在發生段錯誤後，自動調用我們準備好的函數，從而在那個函數裡來擷取當前函數調用棧。

舉例如下：

#include <stdio.h>
#include <stdlib.h>
#include <stddef.h>
#include <execinfo.h>
#include <signal.h>

void dump(int signo)
{
 void *buffer[30] = {0};
 size_t size;
 char **strings = NULL;
 size_t i = 0;

 size = backtrace(buffer, 30);
 fprintf(stdout, "Obtained %zd stack frames.nm\n", size);
 strings = backtrace_symbols(buffer, size);
 if (strings == NULL)
 {
  perror("backtrace_symbols.");
  exit(EXIT_FAILURE);
 }
 
 for (i = 0; i < size; i++)
 {
  fprintf(stdout, "%s\n", strings[i]);
 }
 free(strings);
 strings = NULL;
 exit(0);
}

void func_c()
{
 *((volatile char *)0x0) = 0x9999;
}

void func_b()
{
 func_c();
}

void func_a()
{
 func_b();
}

int main(int argc, const char *argv[])
{
 if (signal(SIGSEGV, dump) == SIG_ERR)
  perror("can‘t catch SIGSEGV");
 func_a();
 return 0;
}

編譯器：
gcc -g -rdynamic test.c -o test; ./test
輸出如下：

Obtained6stackframes.nm
./backstrace_debug(dump+0x45)[0x80487c9]
[0x468400]
./backstrace_debug(func_b+0x8)[0x804888c]
./backstrace_debug(func_a+0x8)[0x8048896]
./backstrace_debug(main+0x33)[0x80488cb]
/lib/i386-linux-gnu/libc.so.6(__libc_start_main+0xf3)[0x129113]

接著：
objdump -d test > test.s
在test.s中搜尋804888c如下：

8048884 <func_b>:
8048884: 55          push %ebp
8048885: 89 e5      mov %esp, %ebp
8048887: e8 eb ff ff ff      call 8048877 <func_c>
804888c: 5d            pop %ebp
804888d: c3            ret

其中80488c時調用（call 8048877）C函數後的地址，雖然並沒有直接定位到C函數，通過彙編代碼， 基本可以推出是C函數出問題了（pop指令不會導致段錯誤的）。
我們也可以通過addr2line來查看

addr2line 0x804888c -e backstrace_debug -f 

輸出：

func_b
/home/astrol/c/backstrace_debug.c:57

backtrace、backtrace_symbols、backtrace_symbols_fd-support for application self-debugging