重庆分公司,新征程启航
为企业提供网站建设、域名注册、服务器等服务
前几天看到姜老师的旧文 用 VSCode 编译和调试 MySQL,每个 DBA 都应 get 的小技能[1] , 文末留了一个思考题,如何修改源码,自定义版本,使得 select version() 输出自定义内容
为嘉荫等地区用户提供了全套网页设计制作服务,及嘉荫网站建设行业解决方案。主营业务为网站制作、成都网站建设、嘉荫网站设计,以传统方式定制建设网站,并提供域名空间备案等一条龙服务,秉承以专业、用心的态度为用户提供真诚的服务。我们深信只要达到每一位用户的要求,就会得到认可,从而选择与我们长期合作。这样,我们也可以走得更远!
调试过程参考 macOS VSCode 编译调试 MySQL 5.7[2]
内部 Item 对象参考 从SQL语句到MySQL内部对象[3]
源码面前没有秘密,建义对 DB 感兴趣的尝试 debug 调试。本文环境为 mac + vscode + lldb
vscode 插件:
mysql 源码:
补丁: MySQL = 8.0.21 需要对 cmake/mysql_version.cmake 文件打补丁 (没有严格测试所有版本)
创建 cmake-build-debug 目录,后续 mysql 编译结果,以及启动后生成的文件都在这里
在 mysql 工程目录下面创建 .vscode/settings.json 文件
内容没啥好说的,都是指定目录及 boost 配置,其中 WITH_DEBUG 打开 debug 模式,会在 /tmp/debug.trace 生成 debug 信息
View - Command Palette - CMake: Configure 执行后生成 cmake 配置
View - Command Palette - CMake: Build 编译生成最终 mysql 相关命令
发现老版本编译很麻烦,各种报错,mysql 5.7 代码量远超过 5.5, 只能硬着头皮看 5.7
首先初始化 my.cnf 配置,简单的就可以,共它均默认
初始化数据文件,非安全模式,调试用
由于用 vscode 接管 mysql, 所以需要配置 .vscode/launch.json
然后点击 run and debug mysqld
mysql 启动,看到输出日志无异常,此时可以用 mysql-client 连接
首先在 sql_parser.cc:5435 处打断点
mysql_parse 是 sql 处理的入口,至于 tcp connection 连接先可以忽略
执行上述 sql 自动跳转到断点处, Step Into , Step Over , Step Out 这些调试熟悉下即可
接下来分别调用主要函数: mysql_execute_command , execute_sqlcom_select , handle_query , select-join-exec() , Query_result_send::send_data , Item::send , Item_string:val_str , Protocol_text::store , net_send_ok
启动 mysql 时 init_common_variables 会初始化一堆变量,其中会调用 set_server_version 生成版本信息,修改这个就可以
看好条件编译的是哪块,修改即可, 重新 CMake: Build 编译再运行
这里不做过深分析,简单讲
sql_yacc.cc 函数 PTI_function_call_generic_ident_sys 解析 sql, 识别出 version() 是一个函数调用
find_native_function_builder 查找 hash 表,找到对应 version 函数注册的单例工厂函数
mysql 启动时调用 item_create_init 将这些函数 builder 注册到 hash 表 native_functions_hash
MySQL 代码太庞大,5.1 大约 100w 行,5.5 130w 行,5.7 以后 330w 行,只能挑重点读源码。最近很多群里的人在背八股,没必要,有那时间学着调试下源码,读读多好
原文出处:
解决方案:
因为 MySQL 5.6 初始化数据比较麻烦,不支持 mysqld 的 --initialize-insecure 选项。
所以不选用这种方式了。
第(2)和第(4)步可以参考 使用 CLion 调试 redis 。
编译成功输出:
击菜单栏【Build】=》【Install】进行安装。
安装成功输出:
初始化数据目录:
选择 mysqld configuration , 以 Debug 模式运行。
成功运行输出:
在 CLion 中,对 sql_parse.cc 中的 mysql_execute_command() 方法进行断点。
执行下面的语句连接上 mysql 服务。
在 mysql-client 中执行如下命令:
然后在 CLion 中即可发现已经被断点拦截,且可以发现 Statement class 中的 query_string 字段和 我们上面输入的命令 show databases 是一样。
至此,已经完成了 CLion 调试 MySQL 环境的搭建。
对于 mysqld ,可以通过设置 debug 系统变量在运行时更改 DBUG设置 。
此变量具有全局值和会话值:
该 debug_options 值是用 冒号( : )分隔 的字段的序列:
值中的每个字段都包含一个强制性标志字符。
我们使用的标志字符如下所示:
以 root 用户连接到 mysqld。
然后,在 mysql 中执行 select 语句,就可以在 CLion console 中观察到如下图所示输出。
准备工作:
安装一个编译器,推荐Microsoft visual studio 2008吧
另外需要装:
GNU Bison for Windows :
CMake 2.6.0 or later :
开始编译:
这里以mysql-5.1.38的源码编译为例:
mysql-5.1.38的代码下载可以到mysql官方网站下载,具体怎么下载不在说明。
打开一个cmd窗口:
输入:
cscript //H:CScript
然后:
cd /path/mysql-5.1.38
win\configure WITH_INNOBASE_STORAGE_ENGINE __NT__
win\build-vs9.bat
到此我们将会创建一个mysql.sln 的工程文件,如果对想学习代码的朋友,到此即可以,然后可以用Microsoft visual studio 2008打开这个文件就可以查看相应的代码了。
如果需要调试或单步执行调试:
这里以mysqld项目为例:
打开项目 mysqld 的属性 点击 debugging
在mysqld的属性页设置命令参数(Command Arguments)为:–console。这样就可以用debug方式调试代码了。
同样对于其它项目的调试,也是这样处理,属性,添加命令行参数:–console。
对于想跟踪的项目可以执行build,然后可以在mysql-5.1.38/client/Debug下生成相应的执行文件。