乾貨｜Linux程式函式棧列印工具gstack原始碼解讀、運用及擴充套件程式設計

點選上方“中興開發者社群”，關注我們

每天讀一篇一線開發者原創好文

一.需求場景

近期在工作中需要分析一個Linux伺服器程式長期執行時的處理流程，想知道程式都執行了哪些函式呼叫鏈？比如，假設程式中有數千個函式，有時會觸發func1() -> func2() -> func3()呼叫鏈；有時會觸發func5() -> func2() -> func9()呼叫鏈；有時會觸發func107() -> func999() -> fun3() -> func557() -> func 123()呼叫鏈；等等。通過分析函式呼叫鏈，有助於加深理解程式執行流程，便於重點分明地分析和走查原始碼，提高工作效率，好處諸多。

二.思路分析

我們知道gdb的bt（backtrace）可以列印函式呼叫棧，但需要手動敲命令執行，不能批量多次執行，似乎不太方便。有沒有更好的工具和方法搞定這個需求呢？有的，gstack就是一款用於方便檢視函式呼叫棧的工具。gstack的用途是“print a stack trace of a running process”，即列印一個正在執行的程式的函式呼叫棧。下面以一個正在執行的redis-server程式為例，執行gstack `pidof redis-server`即可看到該程式當前正在執行的3個執行緒各自的函式呼叫棧。這其實與gdb bt看到的差不多，而且我們的目標是隻需要函式名，而不需要地址資訊，那麼gstack有沒有什麼引數可以去掉每行的地址，以精簡列印呢？

如下所示，gstack竟然沒有幫助，這不像是一個正常的程式啊。用file `which gstack`檢視，果然，它只是一個指令碼，並不是一個正常的程式。

檢視/usr/bin/gstack指令碼原始碼，發現它其實只是包裝了gdb bt，並用sed對gdb bt的輸出結果做了過濾而已。如下給出gstack指令碼原始碼的解讀，該指令碼分為五部分：

• 第一部分：檢查是否提供一個入參，如果入引數量不是1，則列印用法提示，並退出指令碼。

• 第二部分：檢查入參必須是一個當前正在執行的程式的PID，如果不是，則退出指令碼。

• 第三部分：判斷核心是否支援gdb列印所有執行緒函式棧，如果不支援，則後續會將“bt”命令輸入gdb中；如果支援，則後續會將“thread apply all bt”命令輸入gdb中。

• 第四部分：執行gdb，通過“gdb [options] [executable-file] [process-id]”方式附著到指定PID的程式上，通過<<EOF方式為gdb傳入多個命令，並將執行輸出的結果通過管道“|”傳給後續的sed命令。

• 第五部分：用sed去掉gdb輸出的無效行，只提取含有執行緒資訊、函式資訊的行。

通過上述對gstack指令碼原始碼的分析可知，gstack只是gdb bt的簡單封裝，與我們的目標還有一定差距。看來需要自己編寫一些擴充套件指令碼或程式，才能進一步達成目標。

首先，需要編寫一個指令碼，重複執行多次gstack，採集目標程式足夠多次函式呼叫棧；其次，需要進一步淨化資料，比如函式地址資訊就需要過濾掉；還有，需要歸併出不同的函式呼叫棧，找到不同的函式呼叫鏈，因為gstack輸出的函式棧是用Thread行分隔的，可以編寫一個程式來解析Thread行，將每個Thread塊（多行）放到雜湊桶中排重（即，排除重複項），從而得到唯一不同的函式呼叫鏈。

三.擴充套件程式設計

 首先，編寫一個makefile指令碼，用shell for迴圈不斷呼叫gstack，將輸出結果追加到臨時文字檔案中。

仍以redis-server為例，執行 make gstack_log PID=`pidof redis-server` NN=5，即可對redis-server連續執行5次gstack，並將結果儲存到一個臨時檔案tmp_gstack_1353.txt中。在正式採集時，可以將NN設定為很大，比如NN=2000次，以採集到足夠多的不同的函式呼叫棧資訊。

然後，檢視一下輸出的臨時檔案的內容，即多次gstack輸出結果的羅列。下一步需要將每個Thread行所分隔的塊（多行），如塊1、塊2、塊3、塊4、、、進行淨化和排重。

編寫一個Node.js小程式gstack_data_format.js，用於對gstack輸出結果淨化並排重。程式讀入gstack結果檔案（如：tmp_gstack_1353.txt），一行一行地讀入並累加到一個字串變數中，遇到Thread行則停止累加，並將該字串作為KEY新增到一個HASH桶中，因為HASH KEY天然不會重複，利用這個特點進行排重；遇到Thread行後，清空該字串變數，重新開始累加；依次往復，直到讀完整個檔案。程式基本流程如下，具體原始碼請見本文附錄。

如下給出gstack_data_format.js的執行效果。該gstack結果檔案為1186行，採集到237個函式棧，進行淨化、排重後，得到2個唯一不同的函式呼叫棧。

四.總結

正如本文我們一步一步所做，對執行的目標程式，執行多次gstack，獲得大量函式呼叫棧，使用Node.js程式淨化並排重，準確獲得少量的唯一不同的函式呼叫棧。繼而只需要依照這少量函式棧的資訊，走查相關原始碼。這個方法可以幫助我們快速理清程式的主要流程、便於我們快速走讀走查原始碼，提高學習和工作的效率。

附：gstack_data_format.js原始碼（用於對gstack結果淨化排重）

1. var fs = require ('fs');

2. var async = require ('async');

3. var g_iLineMinLen = 4;

4. var g_strFilename = 'tmp_gstack.txt';

5. if (process.argv.length <= 2) {

6.     console.log ("HELP: ", process.argv[0], process.argv[1], "<GSTACK_FILENAME>");

7.     process.exit(0);

8.     return;

9. }

10. g_strFilename = process.argv[2];

11. console.log ("INPUT GSTACK_FILENAME: <<", g_strFilename, ">>");

12. var g_strFileContent = fs.readFileSync(g_strFilename, 'utf-8');

13. var g_strLineAry = new Array();

14. g_strLineAry = g_strFileContent.split("\n");

15. g_strFileContent = null;

16. var g_iAllLineCount = g_strLineAry.length;

17. console.log ('GOT', g_iAllLineCount, 'LINES FROM <<', g_strFilename, '>>');

18. var g_iNotNullCounter = 0;

19. var g_iThreadCounter = 0;

20. var g_strRecord = "";

21. var g_strRecordLineCount = 0;

22. var g_iIsRecordOK = 1;

23. var g_Hash = new Array();

24. async.forEachSeries (g_strLineAry, funcGetOneLine, funcGotAllLines);

25. function funcGetOneLine(strLine, callback) {

26.     if (!strLine) {

27.         callback();

28.         return;

29.     }

30.     var strLeft = strLine.substr (0, 7);

31.     if (strLeft == 'Thread ') {

32.         if (g_iThreadCounter !== 0){

33.             if (g_strRecord && g_iIsRecordOK){

34.                 g_Hash[g_strRecord] = g_strRecordLineCount;

35.             }

36.         }

37.         g_iThreadCounter ++;

38.         g_strRecord = "  ";

39.         g_strRecordLineCount = 0;

40.         g_iIsRecordOK = 1;

41.     } else {

42.         var strNew = strLine.replace (/\(.*\)/g, " ");

43.         strNew = strNew.replace (/0x.*? in /g, "");

44.         if (strNew.length <= g_iLineMinLen) {

45.             g_strRecord = null;

46.             g_iIsRecordOK = 0;

47.         } else {

48.             g_strRecord += strNew + "\n  ";

49.             g_strRecordLineCount ++;

50.         }

51.     }

52.     process.nextTick (function () {

53.         g_iNotNullCounter ++;

54.         callback();

55.     });

56. }

57. function funcGotAllLines(err){

58.     if (err) {

59.         throw err;

60.     }

61.     console.log ('  DONE TOTAL LINE   :', g_iAllLineCount);

62.     console.log ('  DONE NOT NULL LINE:', g_iNotNullCounter);

63.     console.log ('  DONE THREAD LINE  :', g_iThreadCounter);

64.     var iFuncKeyCount = 0;

65.     for (strFuncKey in g_Hash) {

66.         iFuncKeyCount ++;

67.     }

68.     console.log ('  DONE RECORD COUNT :', iFuncKeyCount);

69.     console.log ();

70.     console.log ('DETAILED RECORD INFORMATION:');

71.     iFuncKeyCount = 0;

72.     for (strFuncKey in g_Hash) {

73.         iFuncKeyCount ++;

74.         console.log ('FUNCTION CALLING STACK: NO.'+iFuncKeyCount);

75.         console.log (strFuncKey);

76.     }

77.     process.exit(0);

78.     return;

79. }

擴充閱讀

乾貨｜白話SSL/TLS預設重協商漏洞原理與安全重協商對抗機制

乾貨｜公鑰密碼學在勒索病毒中的應用原理圖解