工具 | 使用 CLion 编译调试 MySQL 8.0

MySQL 源代码是基于关系模型理论的具体实现,是数据库理论与实践的结合。

阅读 MySQL 及相关工具的源代码,不仅是数据库研发人员的日常,也是 DBA 进阶的必经之路,全方位提高技术水平。

  • 夯实原理: 对数据库基础理论以及事务等相关理论更加深刻的认识;
  • 优化性能: 更加深入理解配置项的作用,适配环境,提升性能;
  • 定位故障: 有助于数据库故障的快速定位,知其然也知其所以然;
  • 拥抱开源: 修改源代码(修改 Bug、完善功能、提升性能),回馈开源。

| 从哪开始阅读?

阅读 MySQL 源代码,主要是指阅读 mysql-server[1] 里面的代码。不仅需要理论知识的深入学习,还需要实际应用上手实践,具体可从以下几个角度着手,从不同维度,不同深度去了解 MySQL 源代码。

1. SQL 执行流程

通过环境调试,从理论基础实践掌握 SQL 语句(DDL/DML 等)完整的执行流程。

2. 结构层次

通过 MySQL 源代码结构层次,掌握底层技术原理。

  • 接入层:MySQL 协议、连接线程池等;
  • SQL 层:词法、语法解析、执行器、优化器;
  • 存储引擎层:插件框架、存储引擎设计原理,例如 InnoDB、RocksDB 架构等。

3. 数据抽象/数据转换

数据库对于使用者展现的是二维的关系表。在阅读源码的时候,可以从数据抽象/数据转换的角度去阅读。

  • 数据抽象:二维的关系表在 SQL 层/存储引擎中的数据表现形式
  • 数据转换:二维关系表在 SQL 层到存储引擎的数据转换/存储引擎到磁盘的数据转换

4. 功能实现

通过观察数据库中每种具体功能的实现方式,来熟悉 MySQL 源代码。

| 准备调试环境

正所谓:“工欲善其事必先利其器”,阅读源代码必须要阅读 "动" 态的代码,仅看 "静" 态代码必定是枯燥且无用的。那么搭建一个能够调试 MySQL 源代码的环境,则是阅读 MySQL 源代码,实践并掌握 MySQL 技术知识必不可少的过程。

本文介绍使用 CLion 在 Ubuntu 下的调试过程,来实例演示 MySQL 源代码环境的调试过程,即从实践掌握 SQL 执行流程

CLion 简介

CLion[2] 是一款专门为开发 C 及 C++ 所设计的跨平台 IDE。它包含了插件以及智能功能来帮助开发人员提高开发代码的效率。

环境

  • 操作系统:20.04.1-Ubuntu
  • CLion 版本: CLion 2021.1.1
  • MySQL 版本:8.0.25

编译依赖

apt install libncurses-dev
apt install libssl-dev
apt install cmake
apt-get install bison

*MySQL 8.0.25 依赖 boost 1.73.0 版本[3]

CLion 调试配置

通过 CLion 调试 MySQL 源代码,需将 MySQL 编译路径与 MySQL 安装路径的配置统一。

1. 将下载的源代码放入 home 目录中

2. 解压源代码,并在源代码目录下创建 build 和 /build/data 两个目录

3. 配置 CLion 的 Cmake 的编译目录

4. 配置 CLion 的 Cmake 的编译参数

-DCMAKE_BUILD_TYPE=Debug
-DWITH_BOOST=/home/tool/boost_1_73_0
-DCMAKE_INSTALL_PREFIX=/home/code/mysql-server-mysql-8.0.25/build 
#编译路径与安装路径需一致
-DMYSQL_DATADIR=/home/code/mysql-server-mysql-8.0.25/build/data 
#数据库初始化路径
-DSYSCONFDIR= home/code/mysql-server-mysql-8.0.25/build
-DMYSQL_UNIX_ADDR=/home/code/mysql-server-mysql-8.0.25/build/data/mysql.sock

5. MySQL 编译

方法一:使用 CLion 直接编译


方法二:手动编译

cd /home/code/mysql-server-mysql-8.0.25/build
make -j 4

说明:由于 CLion 导入 MySQL 源代码时,会在 /home/code/mysql-server-mysql-8.0.25/build 下面生成 makefile,可以直接执行 make 命令。

6. MySQL 数据库初始化

# 创建 MySQL 用户组和 MySQL 用户
groupadd mysql
useradd -r -g mysql -s /bin/false mysql
# MySQL 数据库初始化
cd /home/code/mysql-server-mysql-8.0.25/build/bin
./mysqld --basedir=/home/code/mysql-server-mysql-8.0.25/build \
--datadir=/home/code/mysql-server-mysql-8.0.25/build/data \
--initialize-insecure --user=mysql

7. 修改文件权限

chmod -R 777 /home/code/mysql-server-mysql-8.0.25/build/data

8. 设置 CLion 的 mysqld 配置参数

Program arguments 参数设置为:

--basedir=/home/code/mysql-server-mysql-8.0.25/build --datadir=/home/code/mysql-server-mysql-8.0.25/build/data --user=mysql

Working directory 参数设置为:

/home/code/mysql-server-mysql-8.0.25/build/data

9. 调试 mysqld

步骤一:启动 mysqld ,并验证 mysqld 是否启动 ps -ef | grep mysql

步骤二:在 sql_parse.cc 中的 do_command 函数加上断点。

步骤三:登录 MySQL ,验证环境是否正常运行。

 ./mysql -uroot -h127.0.0.1 -P3306 -p

说明:初次登录无需密码,直接回车。初始化时的参数 --initialize-insecure

| 结语

至此 MySQL 源代码调试环境正常运行,可在调试环境上执行相关操作。了解 MySQL 源代码运行机制、实现原理、配置参数作用等。

下期预告

下一期,我们将使用准备好的环境一起来阅读 MySQL 插件框架部分的源码,尽情期待~

参考

[1]. mysql-server:https://github.com/mysql/mysql-server/

[2]. CLion:https://www.jetbrains.com/clion/

[3]. boost :https://www.boost.org/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,406评论 6 503
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,732评论 3 393
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,711评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,380评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,432评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,301评论 1 301
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,145评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,008评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,443评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,649评论 3 334
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,795评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,501评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,119评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,731评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,865评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,899评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,724评论 2 354

推荐阅读更多精彩内容