一、背景
MySQL是當(dāng)今世上最受歡迎的使用最廣泛的開源數(shù)據(jù)庫，它的繁榮離不開它的開源特性。放在過去商業(yè)數(shù)據(jù)庫的時代，大家都沒有機會接觸到數(shù)據(jù)庫的源代碼，但在如今開源數(shù)據(jù)庫的時代，越來越多的人開始研究數(shù)據(jù)庫的源碼，并給社區(qū)貢獻代碼，MySQL官方每次發(fā)布新版本都要感謝一些在社區(qū)上貢獻代碼的程序員?，F(xiàn)在新的數(shù)據(jù)庫時代也給DBA提出了更高的要求，學(xué)會調(diào)試源碼，通過源碼定位問題，這是DBA進階的方向。MySQL的源碼有幾百上千萬行，想全部搞懂幾乎是不可能的，研究源碼一般推薦從某個功能點入手。而學(xué)會調(diào)試源碼，不管對研究源碼或通過源碼定位問題，都是必備的技能。本文將介紹Linux平臺下如何通過gdb進行MySQL源碼調(diào)試，并簡單介紹通過調(diào)試源碼定位一條select語句的執(zhí)行流程。
二、源碼調(diào)試方法
關(guān)于源碼的編譯及調(diào)試，不同的平臺可以通過不同的工具來進行：windows平臺下可以通過visual studio來進行，https://www.cnblogs.com/huangxincheng/p/13084736.html 按照這篇文章的方法可以進行5.7的調(diào)試，通過cmake生成mysql.sln文件，然后給打開sln文件編譯成功后，就可以進入調(diào)試模式了。在某個函數(shù)處打下斷點，F(xiàn)5進入調(diào)試模式后，就可以對數(shù)據(jù)庫進行操作了，命中斷點后就可以查看堆棧的函數(shù)調(diào)用關(guān)系。一般在實際應(yīng)用中，MySQL都是運行在Linux平臺下，在Linux平臺下一般是通過GDB(GNU symbolic debugger)工具進行調(diào)試，C/C++ 項目的開發(fā)和調(diào)試包括故障排查都是利用 GDB 完成的。此外，VsCODE這種IDE工具可以在本地的windows操作系統(tǒng)下，通過ssh遠程調(diào)試Linux平臺下的MySQL，https://mp.weixin.qq.com/s/RO_Ipa9_SH8_DuVholrgvg，姜老師這篇文章也簡單講了一下如何操作。
三、GDB調(diào)試MySQL源碼
3.1 MySQL源碼下載
首先需要在MySQL官網(wǎng)上下載MySQL源碼，操作系統(tǒng)選擇為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 編譯安裝環(huán)境準(zhǔn)備
源碼編譯需要gcc等基礎(chǔ)軟件支持，MySQL8.0版本 gcc至少需要7.1以上，一般推薦直接升級到最高版本，在線環(huán)境比較好辦直接通過yum安裝即可。離線環(huán)境的下載及安裝可以參考這兩篇文章分別升級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加上這幾個參數(shù)，其中-DWITH_DEBUG=1是為了開啟調(diào)試模式。
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，就可以初始化數(shù)據(jù)庫并啟動數(shù)據(jù)庫了。
mysqld --initialize --user=mysql
mysqld_safe --user=mysql &
啟動完數(shù)據(jù)庫后，登錄數(shù)據(jù)庫可以發(fā)現(xiàn)現(xiàn)在已經(jīng)是debug模式了。
3.4 gdb調(diào)試源碼
完成MySQLdebug版本的安裝和啟動后，gdb命令下attach mysql的進程號，就可以對mysql進程進行打斷點調(diào)試了。
?gdb調(diào)試過程中常用的命令可以參考如下：
attach 進程號 #進入調(diào)試模式 b Sql_cmd_insert::mysql_insert #在某個函數(shù)打下斷點 b filename:linenum #在文件的某行打下斷點 clear function #在某個函數(shù)處刪除斷點 bt #查看堆棧信息 n #next 單步調(diào)試，每次只執(zhí)行往下一行代碼，對于調(diào)用的函數(shù)來說，next 命令只會將其視作一行代碼。 #n 3 往下執(zhí)行三行代碼 s #step 單步調(diào)試，當(dāng) step 命令所執(zhí)行的代碼行中包含函數(shù)時，會進入該函數(shù)內(nèi)部，并在函數(shù)第一行代碼處停止執(zhí)行。 c #continue 當(dāng)程序在某一斷點處停止運行后，使用該指令可以繼續(xù)執(zhí)行，直至遇到下一個斷點或者程序結(jié)束。 l #list 顯示源程序代碼的內(nèi)容，包括各行代碼所在的行號。 p xxx #print 打印指定xxx變量的值 info breakpoint #查看斷點信息
?
四、一條select語句的調(diào)試
在handle_connection函數(shù)處打下斷點，然后在mysql客戶端執(zhí)行一條select語句，可以在gdb里面看到，程序很快命中了斷點，接下來便可以通過單步調(diào)試，一步一步定位select語句的執(zhí)行流程。
#客戶端連接的線程處理函數(shù) handle_connection (arg=0xb998240) at /gdb/mysql-8.0.23/sql/conn_handler/connection_handler_per_thread.cc #讀取連接發(fā)來的命令，然后執(zhí)行 do_command (thd=0x7f5a3815d3c0) at /gdb/mysql-8.0.23/sql/sql_parse.cc:1320 #THD類，描述每個客戶端連接產(chǎn)生的后臺進程 #發(fā)出命令 dispatch_command (thd=0x7f5a3815d3c0, com_data=0x7f5afc7adb00, command=COM_QUERY) #根據(jù)command=COM_QUERY，調(diào)用alloc_query函數(shù)（讀取查詢語句并存在thd->query中） if (alloc_query(thd, com_data->com_query.query,com_data->com_query.length)) #執(zhí)行到dispatch_sql_command(thd, &parser_state); 解析sql語句，然后把結(jié)果發(fā)給executor dispatch_sql_command(thd, &parser_state); #進入dispatch_sql_command函數(shù)，執(zhí)行到mysql_execute_command函數(shù)（Execute command saved in thd and lex->sql_command） error = mysql_execute_command(thd, true); #在mysql_execute_command函數(shù)中，執(zhí)行到case SQLCOM_SELECT，res = lex->m_sql_cmd->execute(thd)，進入到execute函數(shù) #在mysql_execute_command函數(shù)中，switch (lex->sql_command)通過case SQLCOM_XXX，轉(zhuǎn)到不同語句的執(zhí)行器 #這時候就進入到了lex的公共屬性m_sql_cmd類下面的execute函數(shù)； #通過單步調(diào)試，此時程序進入到了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函數(shù)中完成的，Sql_cmd_dml::execute的函數(shù)主要有6步 Prelocking；Preparation；Locking of tables；Optimization；Execution or explain；Cleanup #lock_tables(thd, lex->query_tables, lex->table_count, 0) 鎖表 #execute_inner(thd) 執(zhí)行 #進入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)) #優(yōu)化 if (unit->execute(thd)) return true; #執(zhí)行 #此時執(zhí)行到了SELECT_LEX_UNIT::execute (this=0x7f1ca0023e48, thd=0x7f1ca0005ed0) at /gdb/mysql-8.0.23/sql/sql_union.cc:1267 return ExecuteIteratorQuery(thd); #執(zhí)行ExecuteIteratorQuery這個函數(shù) SELECT_LEX_UNIT::ExecuteIteratorQuery (this=0x7f1ca0023e48, thd=0x7f1ca0005ed0) at /gdb/mysql-8.0.23/sql/sql_union.cc:1125 #執(zhí)行完成后返回查詢語句的結(jié)果值 return query_result->send_eof(thd); #這個時候Sql_cmd_dml::execute_inner函數(shù)也執(zhí)行完成了，進而Sql_cmd_dml::execute，mysql_execute_command也接著執(zhí)行完成 #執(zhí)行到dispatch_command函數(shù)的thd->send_statement_status(); 這一行，看到客戶端執(zhí)行的查詢語句也輸出了結(jié)果 #執(zhí)行到handle_connection的while (thd_connection_alive(thd)) {if (do_command(thd)) break;}; 意味著mysql連接結(jié)束了，這時候調(diào)試也隨之結(jié)束。
select語句的執(zhí)行流程可以總結(jié)如下，這些函數(shù)可以方便以后打斷點，更快的定位問題：
1. 客戶端連接線程處理函數(shù) handle_connection (arg=0xb998240) at /gdb/mysql-8.0.23/sql/conn_handler/connection_handler_per_thread.cc:301 2. 讀取連接發(fā)來的命令，然后執(zhí)行 do_command (thd=0x7f5a3815d3c0) at /gdb/mysql-8.0.23/sql/sql_parse.cc:1320 3. 發(fā)出命令，并將查詢語句存在thd->query中 dispatch_command (thd=0x7f1ca0011100, com_data=0x7f1d644d3b00, command=COM_QUERY) at /gdb/mysql-8.0.23/sql/sql_parse.cc:1836 4. 解析sql語句，然后把結(jié)果發(fā)給executor dispatch_sql_command (thd=0x7f1ca0011100, parser_state=0x7f1d644d2a60) at /gdb/mysql-8.0.23/sql/sql_parse.cc:4988 5. 執(zhí)行存在thd中的語句 mysql_execute_command (thd=0x7f1ca0011100, first_level=true) at /gdb/mysql-8.0.23/sql/sql_parse.cc:4407 6. SELECT語句的：準(zhǔn)備，鎖表，優(yōu)化，執(zhí)行 Sql_cmd_dml::execute (this=0x7f1ca09feb28, thd=0x7f1ca0011100) at /gdb/mysql-8.0.23/sql/sql_select.cc:612 7. SELECT語句的優(yōu)化和執(zhí)行 Sql_cmd_dml::execute_inner (this=0x7f1ca0011858, thd=0x7f1ca0005ed0) at /gdb/mysql-8.0.23/sql/sql_select.cc:809 8. SELECT語句的執(zhí)行 SELECT_LEX_UNIT::execute (this=0x7f1ca0023e48, thd=0x7f1ca0005ed0) at /gdb/mysql-8.0.23/sql/sql_union.cc:1267 9. 執(zhí)行語句，返回結(jié)果 SELECT_LEX_UNIT::ExecuteIteratorQuery (this=0x7f1ca0023e48, thd=0x7f1ca0005ed0) at /gdb/mysql-8.0.23/sql/sql_union.cc:1125
五、總結(jié)文章來源：http://www.zghlxwxcb.cn/news/detail-437976.html
不管是研究MySQL源碼還是通過源碼定位問題，學(xué)會調(diào)試MySQL源碼都是必備的基礎(chǔ)技能，MySQL源碼體系十分龐大，調(diào)試源碼可以更快更清晰從源碼中定位問題。文章來源地址http://www.zghlxwxcb.cn/news/detail-437976.html
到了這里，關(guān)于如何進行MySQL源碼調(diào)試（一條select語句的執(zhí)行流程）的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
