一、背景
MySQL是當今世上最受歡迎的使用最廣泛的開源資料庫，它的繁榮離不開它的開源特性，放在過去商業資料庫的時代，大家都沒有機會接觸到資料庫的源代碼，但在如今開源資料庫的時代，越來越多的人開始研究資料庫的原始碼，并給社區貢獻代碼，MySQL官方每次發布新版本都要感謝一些在社區上貢獻代碼的程式員，現在新的資料庫時代也給DBA提出了更高的要求，學會除錯原始碼，通過原始碼定位問題，這是DBA進階的方向，MySQL的原始碼有幾百上千萬行，想全部搞懂幾乎是不可能的，研究原始碼一般推薦從某個功能點入手，而學會除錯原始碼，不管對研究原始碼或通過原始碼定位問題，都是必備的技能，本文將介紹Linux平臺下如何通過gdb進行MySQL原始碼除錯，并簡單介紹通過除錯原始碼定位一條select陳述句的執行流程，
二、原始碼除錯方法
關于原始碼的編譯及除錯，不同的平臺可以通過不同的工具來進行：windows平臺下可以通過visual studio來進行，https://www.cnblogs.com/huangxincheng/p/13084736.html 按照這篇文章的方法可以進行5.7的除錯，通過cmake生成mysql.sln檔案，然后給打開sln檔案編譯成功后，就可以進入除錯模式了，在某個函式處打下斷點，F5進入除錯模式后，就可以對資料庫進行操作了，命中斷點后就可以查看堆疊的函式呼叫關系，一般在實際應用中，MySQL都是運行在Linux平臺下，在Linux平臺下一般是通過GDB(GNU symbolic debugger)工具進行除錯，C/C++ 專案的開發和除錯包括故障排查都是利用 GDB 完成的，此外，VsCODE這種IDE工具可以在本地的windows作業系統下，通過ssh遠程除錯Linux平臺下的MySQL，https://mp.weixin.qq.com/s/RO_Ipa9_SH8_DuVholrgvg，姜老師這篇文章也簡單講了一下如何操作，
三、GDB除錯MySQL原始碼
3.1 MySQL原始碼下載
首先需要在MySQL官網上下載MySQL原始碼，作業系統選擇為source code，OS版本選擇為ALL OPERATING SYSTEM，下載帶boost頭檔案的原始碼包，如果對MySQL的版本沒有特別要求的話，一般推薦下載最新版本的，因為老版本中存在bug的概率較大，編譯程序需要解決這些bug，比如在8.0.23版本中編譯程序中報了這個錯：buf0buf.cc:1227:44: error: ‘SYS_gettid’ was not declared in this scope，參考MySQL官方論壇：https://forums.mysql.com/read.php?117,674410,676378#msg-676378，在storage/innobase/buf/buf0flu.cc檔案代碼中加上宣告#include <sys/syscall.h>，解決了這個報錯，
3.2 編譯安裝環境準備
原始碼編譯需要gcc等基礎軟體支持，MySQL8.0版本 gcc至少需要7.1以上，一般推薦直接升級到最高版本，在線環境比較好辦直接通過yum安裝即可，離線環境的下載及安裝可以參考這兩篇文章分別升級gcc和cmake：
https://mp.weixin.qq.com/s/kWPD1o5fWTAxUNETGsXA7g、https://mp.weixin.qq.com/s/5sHPJ0Kxkmj2llW-UvEbkg，把gcc和cmake搞定后，就可以開始編譯安裝mysql了，
3.3 編譯和安裝MySQL
參考官方檔案通過原始碼安裝mysql這一章可以完成mysql的編譯和安裝：
實際cmake加上這幾個引數，其中-DWITH_DEBUG=1是為了開啟除錯模式，
cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local/mysql -DWITH_BOOST=/root/gdb_mysql/mysql-8.0.23/boost/boost_1_73_0 -DWITH_DEBUG=1
接著make install成功后，配置好組態檔/etc/my.cnf，就可以初始化資料庫并啟動資料庫了，
mysqld --initialize --user=mysql
mysqld_safe --user=mysql &
啟動完資料庫后，登錄資料庫可以發現現在已經是debug模式了，
3.4 gdb除錯原始碼
完成MySQLdebug版本的安裝和啟動后，gdb命令下attach mysql的行程號，就可以對mysql行程進行打斷點除錯了，
gdb除錯程序中常用的命令可以參考如下：
attach 行程號 #進入除錯模式 b Sql_cmd_insert::mysql_insert #在某個函式打下斷點 b filename:linenum #在檔案的某行打下斷點 clear function #在某個函式處洗掉斷點 bt #查看堆疊資訊 n #next 單步除錯，每次只執行往下一行代碼，對于呼叫的函式來說，next 命令只會將其視作一行代碼， #n 3 往下執行三行代碼 s #step 單步除錯，當 step 命令所執行的代碼行中包含函式時，會進入該函式內部，并在函式第一行代碼處停止執行， c #continue 當程式在某一斷點處停止運行后，使用該指令可以繼續執行，直至遇到下一個斷點或者程式結束， l #list 顯示源程式代碼的內容，包括各行代碼所在的行號， p xxx #print 列印指定xxx變數的值 info breakpoint #查看斷點資訊
四、一條select陳述句的除錯
在handle_connection函式處打下斷點，然后在mysql客戶端執行一條select陳述句，可以在gdb里面看到，程式很快命中了斷點，接下來便可以通過單步除錯，一步一步定位select陳述句的執行流程，
#客戶端連接的執行緒處理函式 handle_connection (arg=0xb998240) at /gdb/mysql-8.0.23/sql/conn_handler/connection_handler_per_thread.cc #讀取連接發來的命令，然后執行 do_command (thd=0x7f5a3815d3c0) at /gdb/mysql-8.0.23/sql/sql_parse.cc:1320 #THD類，描述每個客戶端連接產生的后臺行程 #發出命令 dispatch_command (thd=0x7f5a3815d3c0, com_data=https://www.cnblogs.com/coygfly/p/0x7f5afc7adb00, command=COM_QUERY) #根據command=COM_QUERY，呼叫alloc_query函式（讀取查詢陳述句并存在thd->query中） if (alloc_query(thd, com_data->com_query.query,com_data->com_query.length)) #執行到dispatch_sql_command(thd, &parser_state); 決議sql陳述句，然后把結果發給executor dispatch_sql_command(thd, &parser_state); #進入dispatch_sql_command函式，執行到mysql_execute_command函式（Execute command saved in thd and lex->sql_command） error = mysql_execute_command(thd, true); #在mysql_execute_command函式中，執行到case SQLCOM_SELECT，res = lex->m_sql_cmd->execute(thd)，進入到execute函式 #在mysql_execute_command函式中，switch (lex->sql_command)通過case SQLCOM_XXX，轉到不同陳述句的執行器 #這時候就進入到了lex的公共屬性m_sql_cmd類下面的execute函式； #通過單步除錯，此時程式進入到了Sql_cmd_dml::execute (this=0x7f5a38bee0b0, thd=0x7f5a3815d3c0) at /gdb/mysql-8.0.23/sql/sql_select.cc:517 #此時可以看到，決議SQL是在dispatch_sql_command和mysql_execute_command函式中完成的，Sql_cmd_dml::execute的函式主要有6步 Prelocking；Preparation；Locking of tables；Optimization；Execution or explain；Cleanup #lock_tables(thd, lex->query_tables, lex->table_count, 0) 鎖表 #execute_inner(thd) 執行 #進入execute階段 Sql_cmd_dml::execute_inner (this=0x7f1ca0011858, thd=0x7f1ca0005ed0) at /gdb/mysql-8.0.23/sql/sql_select.cc:809 if (unit->optimize(thd, /*materialize_destination=*/nullptr, /*create_iterators=*/true)) #優化 if (unit->execute(thd)) return true; #執行 #此時執行到了SELECT_LEX_UNIT::execute (this=0x7f1ca0023e48, thd=0x7f1ca0005ed0) at /gdb/mysql-8.0.23/sql/sql_union.cc:1267 return ExecuteIteratorQuery(thd); #執行ExecuteIteratorQuery這個函式 SELECT_LEX_UNIT::ExecuteIteratorQuery (this=0x7f1ca0023e48, thd=0x7f1ca0005ed0) at /gdb/mysql-8.0.23/sql/sql_union.cc:1125 #執行完成后回傳查詢陳述句的結果值 return query_result->send_eof(thd); #這個時候Sql_cmd_dml::execute_inner函式也執行完成了，進而Sql_cmd_dml::execute，mysql_execute_command也接著執行完成 #執行到dispatch_command函式的thd->send_statement_status(); 這一行，看到客戶端執行的查詢陳述句也輸出了結果 #執行到handle_connection的while (thd_connection_alive(thd)) {if (do_command(thd)) break;}; 意味著mysql連接結束了，這時候除錯也隨之結束，
select陳述句的執行流程可以總結如下，這些函式可以方便以后打斷點，更快的定位問題：
1. 客戶端連接執行緒處理函式 handle_connection (arg=0xb998240) at /gdb/mysql-8.0.23/sql/conn_handler/connection_handler_per_thread.cc:301 2. 讀取連接發來的命令，然后執行 do_command (thd=0x7f5a3815d3c0) at /gdb/mysql-8.0.23/sql/sql_parse.cc:1320 3. 發出命令，并將查詢陳述句存在thd->query中 dispatch_command (thd=0x7f1ca0011100, com_data=https://www.cnblogs.com/coygfly/p/0x7f1d644d3b00, command=COM_QUERY) at /gdb/mysql-8.0.23/sql/sql_parse.cc:1836 4. 決議sql陳述句，然后把結果發給executor dispatch_sql_command (thd=0x7f1ca0011100, parser_state=0x7f1d644d2a60) at /gdb/mysql-8.0.23/sql/sql_parse.cc:4988 5. 執行存在thd中的陳述句 mysql_execute_command (thd=0x7f1ca0011100, first_level=true) at /gdb/mysql-8.0.23/sql/sql_parse.cc:4407 6. SELECT陳述句的：準備，鎖表，優化，執行 Sql_cmd_dml::execute (this=0x7f1ca09feb28, thd=0x7f1ca0011100) at /gdb/mysql-8.0.23/sql/sql_select.cc:612 7. SELECT陳述句的優化和執行 Sql_cmd_dml::execute_inner (this=0x7f1ca0011858, thd=0x7f1ca0005ed0) at /gdb/mysql-8.0.23/sql/sql_select.cc:809 8. SELECT陳述句的執行 SELECT_LEX_UNIT::execute (this=0x7f1ca0023e48, thd=0x7f1ca0005ed0) at /gdb/mysql-8.0.23/sql/sql_union.cc:1267 9. 執行陳述句，回傳結果 SELECT_LEX_UNIT::ExecuteIteratorQuery (this=0x7f1ca0023e48, thd=0x7f1ca0005ed0) at /gdb/mysql-8.0.23/sql/sql_union.cc:1125
五、總結
不管是研究MySQL原始碼還是通過原始碼定位問題，學會除錯MySQL原始碼都是必備的基礎技能，MySQL原始碼體系十分龐大，除錯原始碼可以更快更清晰從原始碼中定位問題，
轉載請註明出處，本文鏈接：https://www.uj5u.com/shujuku/552161.html
標籤：MySQL
下一篇：返回列表