带你读 MySQL 源码：limit, offset

2023-04-10 · 预计阅读 4 分钟 · MySQL 8.0.32 源码

我一直想写 MySQL 源码分析文章，希望能够达成 2 个目标：

不想研究源码的朋友，可以通过文章了解 MySQL 常用功能的实现逻辑，做到知其然，也知其所以然。
想研究源码的朋友，能够以文章为切入点，迈进 MySQL 源码研究之门。

目标是明确的，任务是艰巨的。

MySQL 源码数量庞大，各种功能的代码盘根错节，相互交织在一起，形成一张复杂的网。

想要把这张网中的某些部分拎出来写成文章，还要做到通俗易懂，这并不是件容易的事，我也就迟迟没有动手。

万事开头难，但是再难，总得开始，才能有后续，所以，就有了这篇文章。

写文章是件费时费力的事，写出来了总希望有更多人看，否则就没有写下去的动力了。

对 MySQL 源码感兴趣的朋友们，如果想看到源码分析系列的更多文章，请帮忙把文章传播出去，分享给更多人。

唠叨完前因后果，再说说我准备怎么写这个系列文章：

我会挑一些常用功能，每篇文章介绍一个单点功能的源码，从简单功能开始，逐渐过渡到复杂功能。
每篇文章只会介绍核心源码逻辑，源码之中增加注释，源码之外尽可能用文字展开介绍源码逻辑，以帮助大家更好的理解源码。
每篇文章不会太长，如果功能复杂导致内容太长，我会拆分文章，尽量降低大家的阅读负担。

接下来，我们开始源码分析系列的第 1 篇文章。

本文内容基于 MySQL 8.0.32 源码。

目录
[TOC]

正文

1. 准备工作

创建测试表：

1CREATE TABLE `t1` (
2  `id` int unsigned NOT NULL AUTO_INCREMENT,
3  `str1` varchar(255) NOT NULL DEFAULT '',
4  `i1` int NOT NULL DEFAULT '0',
5  PRIMARY KEY (`id`) USING BTREE
6) ENGINE=InnoDB DEFAULT CHARSET=utf8mb3;

插入测试数据：

1INSERT INTO t1(id, str1, i1) VALUES
2(1, 's1', 10),
3(2, 's2', 20),
4(3, 's3', 30),
5(4, 's4', 40),
6(5, 's5', 50),
7(6, 's6', 60),
8(7, 's7', 70),
9(8, 's8', 80);

示例 SQL：

1select * from t1 limit 5, 2

2. 整体介绍

我们先通过 explain 来看一下执行计划：

从 explain 输出可以看到，执行计划比较简单，SQL 执行过程包含 2 个迭代器：

Limit/Offset，对应 LimitOffsetIterator 迭代器。
Table scan，对应 TableScanIterator 迭代器。

代码执行时堆栈如下：

 1| > handle_connection(void*) sql/conn_handler/connection_handler_per_thread.cc:302
 2| + > do_command(THD*) sql/sql_parse.cc:1439
 3| + - > dispatch_command(...) sql/sql_parse.cc:2036
 4| + - x > dispatch_sql_command(THD*, Parser_state*) sql/sql_parse.cc:5322
 5| + - x = > mysql_execute_command(THD*, bool) sql/sql_parse.cc:4688
 6| + - x = | > Sql_cmd_dml::execute(THD*) sql/sql_select.cc:578
 7| + - x = | + > Sql_cmd_dml::execute_inner(THD*) sql/sql_select.cc:778
 8| + - x = | + - > Query_expression::execute(THD*) sql/sql_union.cc:1823
 9| + - x = | + - x > // 查询入口
10| + - x = | + - x > Query_expression::ExecuteIteratorQuery(THD*) sql/sql_union.cc:1770
11| + - x = | + - x = > // 实现 limit, offset
12| + - x = | + - x = > LimitOffsetIterator::Read() sql/iterators/composite_iterators.cc:128
13| + - x = | + - x = | > // 从存储引擎读取一条记录
14| + - x = | + - x = | > TableScanIterator::Read() sql/iterators/basic_row_iterators.cc:218

3. 源码分析

TableScanIterator 迭代器用于从存储引擎读取记录，留到以后的文章介绍。

limit, offset 由 LimitOffsetIterator 迭代器实现，我们会介绍两个方法的代码：

Query_expression::ExecuteIteratorQuery(THD*)，这是查询入口方法，介绍了它，流程才算完整。
LimitOffsetIterator::Read()，limit, offset 的逻辑都在这个方法里实现。

3.1 ExecuteIteratorQuery()

 1// sql/sql_union.cc
 2bool Query_expression::ExecuteIteratorQuery(THD *thd) {
 3  ...
 4  {
 5    ...
 6    for (;;) {
 7      // 从存储引擎读取一条记录
 8      int error = m_root_iterator->Read();
 9      DBUG_EXECUTE_IF("bug13822652_1", thd->killed = THD::KILL_QUERY;);
10
11      // 读取出错，直接返回
12      if (error > 0 || thd->is_error())  // Fatal error
13        return true;
14      // error < 0
15      // 表示已经读完了所有符合条件的记录
16      // 查询结束
17      else if (error < 0)
18        break;
19      // SQL 被客户端干掉了
20      else if (thd->killed)  // Aborted by user
21      {
22        thd->send_kill_message();
23        return true;
24      }
25      ...
26      // 发送数据给客户端
27      if (query_result->send_data(thd, *fields)) {
28        return true;
29      }
30      ...
31    }
32  }
33  ...
34}

从以上代码可以看到，select 查询入口方法的主体是一个无限 for 循环。

每一轮循环都会调用 m_root_iterator->Read() 方法从存储引擎读取一条记录。

对于示例 SQL 来说，m_root_iterator->Read() 就是 LimitOffsetIterator::Read()。

for 循环会一直执行，直到 m_root_iterator->Read() 的返回值命中以下任意一个条件才会结束：

if (error > 0 || thd->is_error())，读取出错了，以错误状态结束查询。
if (error < 0)，已经读完所有符合条件的记录，以正常状态结束查询。
if (thd->killed)，SQL 被客户端通过 kill <query_id> 干掉了，中止查询。

<query_id> 为 show processlist 中的 Id 字段。

for 循环中，每次从存储引擎读取到一条记录，都会调用 query_result->send_data(thd, *fields) 方法。

对于示例 SQL 来说，这个方法的行为就是把记录发送给客户端。

3.2 LimitOffsetIterator::Read()

 1// sql/iterators/composite_iterators.cc
 2int LimitOffsetIterator::Read() {
 3  // 这个 if 括号里的条件理解起来会有点困难
 4  // 所以被省略了，眼不见为净
 5  //【重点】只有读取第一条和最后一条记录时才会进入这个 if 分支
 6  if (...) {
 7    ...
 8    // m_needs_offset = true
 9    // 表示 SQL 语句中指定了 offset
10    if (m_needs_offset) {
11      ...
12      // 循环从存储引擎读取 m_offset 条记录
13      // 每读取到一条记录，直接丢弃
14      for (ha_rows row_idx = 0; row_idx < m_offset; ++row_idx) {
15        // 读取一条记录之后
16        // 如果没有出错，就接着读取下一条记录
17        int err = m_source->Read();
18        // 读取出错，直接返回错误码
19        if (err != 0) {
20          return err;
21        }
22        ...
23      }
24      // 读取 m_offset 条记录并丢弃之后
25      // 把 m_seen_rows 设置为已读取记录数 
26      m_seen_rows = m_offset;
27      // 然后把 m_needs_offset 设置为 false
28      // 表示不需要再处理 offset 逻辑了（因为已处理完成）
29      // 下次读取时也就不需要再跳过 m_offset 条记录了
30      m_needs_offset = false;
31      ...
32    }
33    // 如果已经读取了 m_limit 条记录
34    // 就返回 -1，表示读取结束
35    // m_limit = SQL 中的 limit + offset
36    if (m_seen_rows >= m_limit) {
37      ...
38      return -1;
39    }
40  }
41
42  // 读取需要返回给客户端的记录
43  const int result = m_source->Read();
44  ...
45  // 已读取记录数加 1
46  ++m_seen_rows;
47  // 返回当前读取的记录
48  // 给 Query_expression::ExecuteIteratorQuery() 方法
49  return result;
50}

除了处理 offset 逻辑之外，LimitOffsetIterator::Read() 每次只读取一条记录，这个方法的核心逻辑分为三部分：

第 1 部分：if (m_needs_offset)，SQL 语句中指定了 offset，返回第一条记录给客户端之前，需要读取 offset 条记录并丢弃，从第 offset + 1 条记录开始返回给客户端。

这部分的主要逻辑是一个 for 循环，会循环 offset 次，每次读取一条记录。

如果读取成功，就接着读取下一条记录，而不会对这条记录做任何操作，也就相当于丢弃了。

如果读取失败，直接返回错误码，读取结束，客户端会收到报错信息。

第 2 部分：if (m_seen_rows >= m_limit)，表示已经读取了 m_limit 条记录，返回 -1 表示读取正常结束。

m_limit = SQL 中的 limit + offset。

第 3 部分：result = m_source->Read() 从存储引擎读取一条记录，然后，把结果返回给 Query_expression::ExecuteIteratorQuery() 方法。

4. 总结

limit, offset 逻辑比较简单，全部由 LimitOffsetIterator::Read() 实现，核心逻辑总结如下：

从存储引擎读取返回给客户端的第 1 条记录之前，会先读取 offset 条记录并丢弃，然后再读取一条记录，用于返回给客户端。
从存储引擎读取第 2 ~ limit + offset 条记录时，每读取一条记录，都返回给 Query_expression::ExecuteIteratorQuery()，由该方法把记录返回给客户端。
读取 limit + offset 条记录之后，返回 -1 表示读取流程正常结束。

从 LimitOffsetIterator::Read() 的实现逻辑来看，offset 越大，读取之后被丢弃的记录就越多，读取这些记录所做的都是无用功。

为了提高 SQL 的执行效率，可以通过改写 SQL 让 offset 尽可能小，理想状态是 offset = 0。

欢迎扫码关注公众号，我们一起学习更多 MySQL 知识：