You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

377 lines
21 KiB
Markdown

2 years ago
# 25 | MySQL编译器解析一条SQL语句的执行过程
你好我是宫文学。现在就到了我们编译之旅的最后一站了我们一起来探索一下MySQL编译器。
数据库系统能够接受SQL语句并返回数据查询的结果或者对数据库中的数据进行修改可以说几乎每个程序员都使用过它。
而MySQL又是目前使用最广泛的数据库。所以解析一下MySQL编译并执行SQL语句的过程一方面能帮助你加深对数据库领域的编译技术的理解另一方面由于SQL是一种最成功的DSL特定领域语言所以理解了MySQL编译器的内部运作机制也能加深你对所有使用数据操作类DSL的理解比如文档数据库的查询语言。另外解读SQL与它的运行时的关系也有助于你在自己的领域成功地使用DSL技术。
**那么,数据库系统是如何使用编译技术的呢?**接下来我就会花两讲的时间带你进入到MySQL的内部做一次全面的探秘。
今天这一讲我先带你了解一下如何跟踪MySQL的运行了解它处理一个SQL语句的过程以及MySQL在词法分析和语法分析方面的实现机制。
好,让我们开始吧!
## 编译并调试MySQL
按照惯例,你要下载[MySQL的源代码](https://github.com/mysql/mysql-server)。我下载的是8.0版本的分支。
源代码里的主要目录及其作用如下我们需要分析的代码基本都在sql目录下它包含了编译器和服务端的核心组件。
![](https://static001.geekbang.org/resource/image/b8/c6/b8c9a108f1370bace3b1d8b3300b7ec6.jpg)
图1MySQL的源代码包含的主要目录
MySQL的源代码主要是.cc结尾的也就是说MySQL主要是用C++编写的。另外也有少量几个代码文件是用C语言编写的。
为了跟踪MySQL的执行过程你要用Debug模式编译MySQL具体步骤可以参考这篇[开发者文档](https://dev.mysql.com/doc/internals/en/cmake.html)。
如果你用单线程编译大约需要1个小时。编译好以后先初始化出一个数据库来
```
./mysqld --initialize --user=mysql
```
这个过程会为root@localhost用户生成一个缺省的密码。
接着运行MySQL服务器
```
./mysqld &
```
之后通过客户端连接数据库服务器这时我们就可以执行SQL了
```
./mysql -uroot -p #连接mysql server
```
最后我们把GDB调试工具附加到mysqld进程上就可以对它进行调试了。
```
gdb -p `pidof mysqld` #pidof是一个工具用于获取进程的id你可以安装一下
```
提示这一讲中我是采用了一个CentOS 8的虚拟机来编译和调试MySQL。我也试过在macOS下编译并用LLDB进行调试也一样方便。
**注意**,你在调试程序的时候,有两个**设置断点**的好地方:
* **dispatch\_command**在sql/sql\_parse.cc文件里。在接受客户端请求的时候比如一个SQL语句会在这里集中处理。
* **my\_message\_sql**在sql/mysqld.cc文件里。当系统需要输出错误信息的时候会在这里集中处理。
这个时候我们在MySQL的客户端输入一个查询命令就可以从雇员表里查询姓和名了。在这个例子中我采用的数据库是MySQL的一个[示例数据库employees](https://github.com/datacharmer/test_db),你可以根据它的文档来生成示例数据库。
```
mysql> select first_name, last_name from employees; #从mysql库的user表中查询信息
```
这个命令被mysqld接收到以后就会触发断点并停止执行。这个时候客户端也会老老实实地停在那里等候从服务端传回数据。即使你在后端跟踪代码的过程会花很长的时间客户端也不会超时一直在安静地等待。给我的感觉就是MySQL对于调试程序还是很友好的。
在GDB中输入bt命令会打印出调用栈这样你就能了解一个SQL语句在MySQL中执行的完整过程。为了方便你理解和复习这里我整理成了一个表格
![](https://static001.geekbang.org/resource/image/c8/5e/c8115701536a1d0ba093e804bf13735e.jpg)
我也把MySQL执行SQL语句时的一些重要程序入口记录了下来这也需要你重点关注。它反映了执行SQL过程中的一些重要的处理阶段包括语法分析、处理上下文、引用消解、优化和执行。你在这些地方都可以设置断点。
![](https://static001.geekbang.org/resource/image/82/90/829ff647ecefed1ca2653696085f7a90.jpg)
图2MySQL执行SQL语句时的部分重要程序入口
好了现在你就已经做好准备能够分析MySQL的内部实现机制了。不过由于MySQL执行的是SQL语言它跟我们前面分析的高级语言有所不同。所以我们先稍微回顾一下SQL语言的特点。
## SQL语言数据库领域的DSL
SQL是结构化查询语言Structural Query Language的英文缩写。举个例子这是一个很简单的SQL语句
```
select emp_no, first_name, last_name from employees;
```
其实在大部分情况下SQL都是这样一个一个来做语句执行的。这些语句又分为DML数据操纵语言和DDL数据定义语言两类。前者是对数据的查询、修改和删除等操作而后者是用来定义数据库和表的结构又叫模式
我们平常最多使用的是DML。而DML中执行起来最复杂的是select语句。所以在本讲我都是用select语句来给你举例子。
那么SQL跟我们前面分析的高级语言相比有什么不同呢
**第一个特点SQL是声明式Declarative的**。这是什么意思呢其实就是说SQL语句能够表达它的计算逻辑但它不需要描述控制流。
高级语言一般都有控制流也就是详细规定了实现一个功能的流程先调用什么功能再调用什么功能比如if语句、循环语句等等。这种方式叫做**命令式imperative编程**。
更深入一点,声明式编程说的是“要什么”,它不关心实现的过程;而命令式编程强调的是“如何做”。前者更接近人类社会的领域问题,而后者更接近计算机实现。
**第二个特点SQL是一种特定领域语言DSLDomain Specific Language专门针对关系数据库这个领域的**。SQL中的各个元素能够映射成关系代数中的操作术语比如选择、投影、连接、笛卡尔积、交集、并集等操作。它采用的是表、字段、连接等要素而不需要使用常见的高级语言的变量、类、函数等要素。
所以SQL就给其他DSL的设计提供了一个很好的参考
* **采用声明式,更加贴近领域需求。**比如你可以设计一个报表的DSL这个DSL只需要描述报表的特征而不需要描述其实现过程。
* **采用特定领域的模型、术语,甚至是数学理论。**比如针对人工智能领域你完全就可以用张量计算力学概念的术语来定义DSL。
好了现在我们分析了SQL的特点从而也让你了解了DSL的一些共性特点。那么接下来顺着MySQL运行的脉络我们先来了解一下MySQL是如何做词法分析和语法分析的。
## 词法和语法分析
词法分析的代码是在sql/sql\_lex.cc中入口是MYSQLlex()函数。在sql/lex.h中有一个symbols\[\]数组,它定义了各类关键字、操作符。
**MySQL的词法分析器也是手写的这给算法提供了一定的灵活性。**比如SQL语句中Token的解析是跟当前使用的字符集有关的。使用不同的字符集词法分析器所占用的字节数是不一样的判断合法字符的依据也是不同的。而字符集信息取决于当前的系统的配置。词法分析器可以根据这些配置信息正确地解析标识符和字符串。
**MySQL的语法分析器是用bison工具生成的bison是一个语法分析器生成工具它是GNU版本的yacc**。bison支持的语法分析算法是LALR算法而LALR是LR算法家族中的一员它能够支持大部分常见的语法规则。bison的规则文件是sql/sql\_yacc.yy经过编译后会生成sql/sql\_yacc.cc文件。
sql\_yacc.yy中用你熟悉的EBNF格式定义了MySQL的语法规则。我节选了与select语句有关的规则如下所示从中你可以体会一下SQL语句的语法是怎样被一层一层定义出来的
```
select_stmt:
query_expression
| ...
| select_stmt_with_into
;
query_expression:
query_expression_body opt_order_clause opt_limit_clause
| with_clause query_expression_body opt_order_clause opt_limit_clause
| ...
;
query_expression_body:
query_primary
| query_expression_body UNION_SYM union_option query_primary
| ...
;
query_primary:
query_specification
| table_value_constructor
| explicit_table
;
query_specification:
...
| SELECT_SYM /*select关键字*/
select_options /*distinct等选项*/
select_item_list /*select项列表*/
opt_from_clause /*可选from子句*/
opt_where_clause /*可选where子句*/
opt_group_clause /*可选group子句*/
opt_having_clause /*可选having子句*/
opt_window_clause /*可选window子句*/
;
...
```
其中query\_expression就是一个最基础的select语句它包含了SELECT关键字、字段列表、from子句、where子句等。
你可以看一下select\_options、opt\_from\_clause和其他几个以opt开头的规则它们都是SQL语句的组成部分。opt是可选的意思也就是它的产生式可能产生ε。
```
opt_from_clause:
/* Empty. */
| from_clause
;
```
另外你还可以看一下表达式部分的语法。在MySQL编译器当中对于二元运算你可以大胆地写成左递归的文法。因为它的语法分析的算法用的是LALR这个算法能够自动处理左递归。
一般研究表达式的时候我们总是会关注编译器是如何处理结合性和优先级的。那么bison是如何处理的呢
原来bison里面有专门的规则可以规定运算符的优先级和结合性。在sql\_yacc.yy中你会看到如下所示的规则片段
![](https://static001.geekbang.org/resource/image/4e/20/4e0d2706eb5e26143ae125c05bd2e720.jpg)
你可以看一下bit\_expr的产生式它其实完全把加减乘数等运算符并列就行了。
```
bit_expr :
...
| bit_expr '+' bit_expr %prec '+'
| bit_expr '-' bit_expr %prec '-'
| bit_expr '*' bit_expr %prec '*'
| bit_expr '/' bit_expr %prec '/'
...
| simple_expr
```
如果你只是用到加减乘除的运算,那就可以不用在产生式的后面加%prec这个标记。但由于加减乘除这几个还可以用在其他地方比如“-a”可以用来表示把a取负值减号可以用在一元表达式当中这会比用在二元表达式中有更高的优先级。也就是说为了区分同一个Token在不同上下文中的优先级我们可以用%prec来说明该优先级是[上下文依赖](https://www.gnu.org/software/bison/manual/html_node/Contextual-Precedence.html)的。
好了在了解了词法分析器和语法分析器以后我们接着来跟踪一下MySQL的执行看看编译器所生成的解析树和AST是什么样子的。
在sql\_class.cc的sql\_parser()方法中编译器执行完解析程序之后会返回解析树的根节点root在GDB中通过p命令可以逐步打印出整个解析树。你会看到它的根节点是一个PT\_select\_stmt指针见图3
解析树的节点是在语法规则中规定的这是一些C++的代码,它们会嵌入到语法规则中去。
下面展示的这个语法规则就表明编译器在解析完query\_expression规则以后要创建一个PT\_query\_expression的节点其构造函数的参数分别是三个子规则所形成的节点。对于query\_expression\_body和query\_primary这两个规则它们会直接把子节点返回因为它们都只有一个子节点。这样就会简化解析树让它更像一棵AST。关于AST和解析树也叫CST的区别我在解析Python的编译器中讲过了你可以回忆一下。
```
query_expression:
query_expression_body
opt_order_clause
opt_limit_clause
{
$$ = NEW_PTN PT_query_expression($1, $2, $3); /*创建节点*/
}
| ...
query_expression_body:
query_primary
{
$$ = $1; /*直接返回query_primary的节点*/
}
| ...
query_primary:
query_specification
{
$$= $1; /*直接返回query_specification的节点*/
}
| ...
```
最后对于“select first\_name, last\_name from employees”这样一个简单的SQL语句它所形成的解析树如下
![](https://static001.geekbang.org/resource/image/00/26/007f91d9f3fe4c3349722201bec44226.jpg)
图3示例SQL解析后生成的解析树
而对于“select 2 + 3”这样一个做表达式计算的SQL语句所形成的解析树如下。你会看到它跟普通的高级语言的表达式的AST很相似
![](https://static001.geekbang.org/resource/image/da/db/da090cf1095e2aef738a69a5851ffcdb.jpg)
图4“select 2 + 3”对应的解析树
图4中的PT\_query\_expression等类就是解析树的节点它们都是Parse\_tree\_node的子类PT是Parse Tree的缩写。这些类主要定义在sql/parse\_tree\_nodes.h和parse\_tree\_items.h文件中。
其中Item代表了与“值”有关的节点它的子类能够用于表示字段、常量和表达式等。你可以通过Item的val\_int()、val\_str()等方法获取它的值。
![](https://static001.geekbang.org/resource/image/cf/04/cfa126a6144186deafe7d9caff56f304.jpg)
图5解析树的树节点部分
由于SQL是一个个单独的语句所以select、insert、update等语句它们都各自有不同的根节点都是Parse\_tree\_root的子类。
![](https://static001.geekbang.org/resource/image/4a/2a/4a1152566c2ccab84d2f5022f44a022a.jpg)
图6解析树的根节点
好了现在你就已经了解了SQL的解析过程和它所生成的AST了。前面我说过MySQL采用的是LALR算法因此我们可以借助MySQL编译器来加深一下对LR算法家族的理解。
## 重温LR算法
你在阅读yacc.yy文件的时候在注释里你会发现如何跟踪语法分析器的执行过程的一些信息。
你可以用下面的命令,带上“-debug”参数来启动MySQL服务器
```
mysqld --debug="d,parser_debug"
```
然后你可以通过客户端执行一个简单的SQL语句“select 2+3\*5”。在终端会输出语法分析的过程。这里我截取了一部分界面通过这些输出信息你能看出LR算法执行过程中的移进、规约过程以及工作区内和预读的信息。
![](https://static001.geekbang.org/resource/image/69/91/69e4644e93a5156a6695eff41d162891.jpg)
我来给你简单地复现一下这个解析过程。
**第1步编译器处于状态0并且预读了一个select关键字。**你已经知道LR算法是基于一个DFA的。在这里的输出信息中你能看到某些状态的编号达到了一千多所以这个DFA还是比较大的。
**第2步把select关键字移进工作区并进入状态42。**这个时候编译器已经知道后面跟着的一定是一个select语句了也就是会使用下面的语法规则
```
query_specification:
...
| SELECT_SYM /*select关键字*/
select_options /*distinct等选项*/
select_item_list /*select项列表*/
opt_from_clause /*可选from子句*/
opt_where_clause /*可选where子句*/
opt_group_clause /*可选group子句*/
opt_having_clause /*可选having子句*/
opt_window_clause /*可选window子句*/
;
```
为了给你一个直观的印象这里我画了DFA的局部示意图做了一定的简化如下所示。你可以看到在状态42点符号位于“select”关键字之后、select\_options之前。select\_options代表了“distinct”这样的一些关键字但也有可能为空。
![](https://static001.geekbang.org/resource/image/47/0b/474af6c5761e157cb82987fcd87a3c0b.jpg)
图7移进select后的DFA
**第3步因为预读到的Token是一个数字NUM这说明select\_options产生式一定生成了一个ε因为NUM是在select\_options的Follow集合中。**
这就是LALR算法的特点它不仅会依据预读的信息来做判断还要依据Follow集合中的元素。所以编译器做了一个规约也就是让select\_options为空。
也就是编译器依据“select\_options->ε”做了一次规约并进入了新的状态920。**注意**状态42和920从DFA的角度来看它们是同一个大状态。而DFA中包含了多个小状态分别代表了不同的规约情况。
![](https://static001.geekbang.org/resource/image/8f/e1/8f2444e7c1f100485d679cc543073de1.jpg)
图8基于“select\_options->ε”规约后的DFA
**你还需要注意**这个时候老的状态都被压到了栈里所以栈里会有0和42两个状态。栈里的这些状态其实记录了推导的过程让我们知道下一步要怎样继续去做推导。
![](https://static001.geekbang.org/resource/image/c3/76/c3a585e8a1c3753137ff83fac5368576.jpg)
图9做完前3步之后栈里的情况
**第4步移进NUM。**这时又进入一个新状态720。
![](https://static001.geekbang.org/resource/image/04/b9/048df36542d61ba8f8f688c58e00a3b9.jpg)
图10移进NUM后的DFA
而旧的状态也会入栈,记录下推导路径:
![](https://static001.geekbang.org/resource/image/bc/51/bcd744e5d278ce37d0abb1583ceccb51.jpg)
图11移进NUM后栈的状态
**第5~8步依次依据NUM\_literal->NUM、literal->NUM\_literal、simple\_expr->literal、bit\_expr->simple\_expr这四条产生式做规约。**这时候编译器预读的Token是+号,所以你会看到,图中的红点停在+号前。
![](https://static001.geekbang.org/resource/image/33/7a/33b3f6b88214412b6d29b2ce2b03dc7a.jpg)
图12第8步之后的DFA
**第9~10步移进+号和NUM**。这个时候状态又重新回到了720。这跟第4步进入的状态是一样的。
![](https://static001.geekbang.org/resource/image/e3/8d/e3976970cd368c8e9c1547bbc2c6f48d.jpg)
图13第10步之后的DFA
而栈里的目前有5个状态记录了完整的推导路径。
![](https://static001.geekbang.org/resource/image/14/55/142e374173e90ba657579f67566bb755.jpg)
图14第10步之后栈的状态
到这里其实你就已经了解了LR算法做移进和规约的思路了。不过你还可以继续往下研究。由于栈里保留了完整的推导路径因此MySQL编译器最后会依次规约回来把栈里的元素清空并且形成一棵完整的AST。
## 课程小结
这一讲我带你初步探索了MySQL编译SQL语句的过程。你需要记住几个关键点
* **掌握如何用GDB来跟踪MySQL的执行的方法**。你要特别注意的是我给你梳理的那些关键的程序入口它是你理解MySQL运行过程的地图。
* SQL语言是**面向关系数据库的一种DSL它是声明式的**并采用了领域特定的模型和术语可以为你设计自己的DSL提供启发。
* **MySQL的语法分析器是采用bison工具生成的**。这至少说明语法分析器生成工具是很有用的连正式的数据库系统都在使用它所以你也可以大胆地使用它来提高你的工作效率。我在最后的参考资料中给出了bison的手册希望你能自己阅读一下做一些简单的练习掌握bison这个工具。
* 最后,**你一定要知道LR算法的运行原理**,知其所以然,这也会更加有助于你理解和用好工具。
我依然把本讲的内容给你整理成了一张知识地图,供你参考和复习回顾:
![](https://static001.geekbang.org/resource/image/04/5b/04cc0ce4fb5d78d7d9aa18e03088f95b.jpg)
## 一课一思
我们今天讲到了DSL的概念。你能分享一下你的工作领域中的DSL吗它们是否也是采用声明式的里面用到了哪些特定领域的术语欢迎在留言区分享。
感谢你的阅读。如果有收获,欢迎你把今天的内容分享给更多的朋友。
## 参考资料
1. MySQL的内行手册[MySQL Internals Manual](https://dev.mysql.com/doc/internals/en/))能提供一些重要的信息。但我发现文档内容经常跟源代码的版本不同步,比如介绍源代码的目录结构的信息就过时了,你要注意这点。
2. bison的[手册](http://www.gnu.org/software/bison/manual/)。