微信号:pingcap2015

介绍:PingCAP 专注于新型分布式数据库的研发,是知名开源数据库 TiDB (Github 4100 stars) 背后的团队,研发总部在北京,是国内第一家开源的新型分布式 NewSQL 数据库公司,也是国内领先的大数据技术和解决方案提供商.

TiDB 源码阅读系列文章(二)初识 TiDB 源码

2018-03-02 17:40 申砾

本文为 TiDB 源码阅读系列文章的第二篇,第一篇文章介绍整体的架构,知道 TiDB 有哪些模块,分别是做什么的,从哪里入手比较好,哪些可以忽略,哪些需要仔细阅读。

这篇文章是一篇入门文档,难度系数比较低,其中部分内容可能大家在其他渠道已经看过,不过为了内容完整性,我们还是会放在这里。


 TiDB 架构 

本次 TiDB 源码之旅从这幅简单的架构图开始,这幅图很多人都看过,我们可以用一句话来描述这个图:『TiDB 是一个支持 MySQL 协议,以某种支持事务的分布式 KV 存储引擎为底层存储的 SQL 引擎』。从这句话可以看出有三个重要的事情,第一是如何支持 MySQL 协议,与 Client 交互,第二是如何与底层的存储引擎打交道,存取数据,第三是如何实现 SQL 的功能。本篇文章会先介绍一些 TiDB 有哪些模块及其功能简要介绍,然后以这三点为线索,将这些模块串联起来。


 代码简介 

TiDB 源码完全托管在 Github 上,从项目主页 (https://github.com/pingcap/tidb)可以看到所有信息。整个项目使用 Go 语言开发,按照功能模块分了很多 Package,通过一些依赖分析工具,可以看到项目内部包之间的依赖关系。

大部分包都以接口的形式对外提供服务,大部分功能也都集中在某个包中,不过有一些包提供了非常基础的功能,会被很多包依赖,这些包需要特别注意。

项目的 main 文件在 tidb-server/main.go,这里面定义了服务如何启动。整个项目的 Build 方法可以在 Makefile (https://github.com/pingcap/tidb/blob/source-code/Makefile#L140) 中找到。

除了代码之外,还有很多测试用例,可以在 xx\_test.go 中找到。另外 `cmd` 目录下面还有几个工具包,用来做性能测试或者是构造测试数据。


 模块介绍 

TiDB 的模块非常多,这里做一个整体介绍,大家可以看到每个模块大致是做什么用的,想看相关功能的代码是,可以直接找到对应的模块。


 从哪里入手 

粗看一下 TiDB 有 80 个包,让人觉得无从下手,不过并不是所有的包都很重要,另外一些功能只会涉及到少量包,从哪里入手去看源码取决于看源码的目的。

如果是想了解某一个具体的功能的实现细节,那么可以参考上面的模块简介,找到对应的模块即可。

如果是相对源码有全面的了解,那么可以从 tidb-server/main.go 入手,看 tidb-server 是如何启动,如何等待并处理用户请求。再跟着代码一直走,看 SQL 的具体执行过程。另外一些重要的模块,需要看一下,知道是如何实现的。辅助性的模块,可以选择性的看一下,有大致的印象即可。


 重要模块 

在全部 80 个模块中,下面几个模块是最重要的,希望大家能仔细阅读,针对这些模块,我们也会用专门的文章来讲解,等所有的文章都 Ready 后,我将下面的表格中的 TODO 换成对应的文章连链接。


 辅助模块 

除了重要的模块之外,余下的是辅助模块,但并不是说这些模块不重要,只是锁这些模块并不在 SQL 执行的关键路径上,我们也会用一定的篇幅描述其中的大部分包。


 SQL 层架构 

这幅图比上一幅图详细很多,大体描述了 SQL 核心模块,大家可以从左边开始,顺着箭头的方向看。


Protocol Layer


最左边是 TiDB 的 Protocol Layer,这里是与 Client 交互的接口,目前 TiDB 只支持 MySQL 协议,相关的代码都在 `server` 包中。

这一层的主要功能是管理客户端 connection,解析 MySQL 命令并返回执行结果。具体的实现是按照 MySQL 协议实现,具体的协议可以参考 MySQL 协议文档 (https://dev.mysql.com/doc/internals/en/client-server-protocol.html)。这个模块我们认为是当前实现最好的一个 MySQL 协议组件,如果大家的项目中需要用到 MySQL 协议解析、处理的功能,可以参考或引用这个模块。

连接建立的逻辑在 server.go 的Run() (https://github.com/pingcap/tidb/blob/source-code/server/server.go#L236) 方法中,主要是下面两行:

单个 Session 处理命令的入口方法是调用 clientConn 类的 dispatch 方法 (https://github.com/pingcap/tidb/blob/source-code/server/conn.go#L465),这里会解析协议并转给不同的处理函数。


SQL Layer


大体上讲,一条 SQL 语句需要经过,语法解析-->合法性验证-->制定查询计划-->优化查询计划-->根据计划生成查询器-->执行并返回结果 等一系列流程。这个主干对应于 TiDB 的下列包:

 KV API Layer


TiDB 依赖于底层的存储引擎提供数据的存取功能,但是并不是依赖于特定的存储引擎(比如 TiKV),而是对存储引擎提出一些要求,满足这些要求的引擎都能使用(其中 TiKV 是最合适的一款)。

最基本的要求是『带事务的 Key-Value 引擎,且提供 Go 语言的 Driver』,再高级一点的要求是『支持分布式计算接口』,这样 TiDB 可以把一些计算请求下推到 存储引擎上进行。

这些要求都可以在 `kv` 这个包的接口 (https://github.com/pingcap/tidb/blob/source-code/kv/kv.go)中找到,存储引擎需要提供实现了这些接口的 Go 语言 Driver,然后 TiDB 利用这些接口操作底层数据。

对于最基本的要求,可以重点看这几个接口:

  • Transaction (https://github.com/pingcap/tidb/blob/source-code/kv/kv.go#L121):事务基本操作

  • Retriever (https://github.com/pingcap/tidb/blob/source-code/kv/kv.go#L75):读取数据的接口

  • Mutator (https://github.com/pingcap/tidb/blob/source-code/kv/kv.go#L91):修改数据的接口

  • Storage (https://github.com/pingcap/tidb/blob/source-code/kv/kv.go#L229):Driver 提供的基本功能

  • Snapshot (https://github.com/pingcap/tidb/blob/source-code/kv/kv.go#L214):在数据 Snapshot 上面的操作

  • Iterator (https://github.com/pingcap/tidb/blob/source-code/kv/kv.go#L255):`Seek` 返回的结果,可以用于遍历数据

有了上面这些接口,可以对数据做各种所需要的操作,完成全部 SQL 功能,但是为了更高效的进行运算,我们还定义了一个高级计算接口,可以关注这三个 Interface/struct :

  • Client (https://github.com/pingcap/tidb/blob/source-code/kv/kv.go#L150):向下层发送请求以及获取下层存储引擎的计算能力

  • Request (https://github.com/pingcap/tidb/blob/source-code/kv/kv.go#L176): 请求的内容

  • Response (https://github.com/pingcap/tidb/blob/source-code/kv/kv.go#L204): 返回结果的抽象


 小结 

至此,读者已经来了解了 TiDB 的源码结构以及三个主要部分的架构,更详细的内容会在后面的章节中详细描述。


延展阅读

TiDB 源码阅读系列文章(一)序



长按关注

新型分布式 NewSQL 数据库

微信号:pingcap2015



 
PingCAP 更多文章 TiDB 源码阅读系列文章(一)序 TiDB 在 Ping++ 金融聚合支付业务中的实践 TiDB 1.1 Beta Release 李雨来 :Query Cache in TiDB FOSDEM 2018 | 唐刘:Rust in TiKV(内含演讲视频)
猜您喜欢 Leanote有中文名了,叫蚂蚁笔记 全国首发 | 腾讯Bugly携手极客学院,「Android Crash 跟踪方法」强势上线! 【本周重磅】高效玩转Gradle 朋友,你的时间够用吗? 企鹅智酷|走访“科技以色列”:犹太性格鲜明的创业军团