TiDB源码阅读(一) TiDB的入口

微信扫一扫,分享到朋友圈

TiDB源码阅读(一) TiDB的入口

写这个东西也是因为想简单掌握下TiDB的源码,在同事的指导下有了一些阅读思路,所以积累在这里。有些地方理解的有问题还请指出,如果不小心误导了读者,还请见谅:blush:

TiDB源码

TiDB模块是使用Go语言开发的,使用GoLand编译器就可以了。

闲话少说,阅读源码,要寻找好的切入点,我们选择

tidb-server/main.go

作为阅读源码的入口。 理由是,这里的main函数可以debug,也是TiDB启动的开头。

稍微简化一下

func main() {
registerStores()
registerMetrics()
config.InitializeConfig(*configPath, *configCheck, *configStrict, reloadConfig, overrideConfig)
if config.GetGlobalConfig().OOMUseTmpStorage {
config.GetGlobalConfig().UpdateTempStoragePath()
initializeTempDir()
}
setCPUAffinity()
setupLog()
setupTracing()
setupBinlogClient()
setupMetrics()
createStoreAndDomain()
createServer()
runServer()
}
复制代码

从代码可以看出来,TiDB的启动流程做了很多操作,每个步骤都按照函数封装好了,大致了解下都做什么

// 注册store
func registerStores() {
err := kvstore.Register("tikv", tikv.Driver{}) //注册TiKV
tikv.NewGCHandlerFunc = gcworker.NewGCWorker //为TiKV生成GCworker
err = kvstore.Register("mocktikv", mockstore.MockDriver{}) //注册默认存储引擎MockTiKV
}
复制代码
//共注册100+ prometheus监控项,这里只表一项
func RegisterMetrics() {
prometheus.MustRegister(AutoAnalyzeCounter)
}
复制代码
// get全局config
func InitializeConfig(confPath string, configCheck, configStrict bool, reloadFunc ConfReloadFunc, enforceCmdArgs func(*Config)) {
cfg := GetGlobalConfig()
StoreGlobalConfig(cfg)
}
复制代码
if config.GetGlobalConfig().OOMUseTmpStorage {
config.GetGlobalConfig().UpdateTempStoragePath()
initializeTempDir()
}
复制代码

这是判断什么呢?

设置是否在单条 SQL 语句的内存使用超出mem-quota-query 限制时为某些算子启用临时磁盘。故若为true,则初始化TempStoragePath。

// 设置CPU亲和性
func setCPUAffinity() { /
err := linux.SetAffinity(cpu)
runtime.GOMAXPROCS(len(cpu))
}
复制代码
//配置系统log
func setupLog() {
err = logutil.InitLogger(cfg.Log.ToLogConfig()) // 这里配置格式、文件名、slowlog等
}
复制代码
//注册分布式系统追踪链 jaeger
func setupTracing() {
tracingCfg := cfg.OpenTracing.ToTracingConfig()
tracingCfg.ServiceName = "TiDB"
tracer, _, err := tracingCfg.NewTracer()
opentracing.SetGlobalTracer(tracer)
}
复制代码
// 设置binlog信息
func setupBinlogClient() {
if !cfg.Binlog.Enable { //若binlog.enable=false,则不开启binlog
return
}
if cfg.Binlog.IgnoreError { //若为true,则忽略binlog报错
binloginfo.SetIgnoreError(true)
}
if len(cfg.Binlog.BinlogSocket) == 0 { //配置binlog输出网络地址
...
}
binloginfo.SetPumpsClient(client) //配置binlog信息到pump客户端
}
复制代码
// 配置监控
func setupMetrics() {
runtime.SetMutexProfileFraction(10)// 对锁调用的跟踪
systimeErrHandler := func() {
metrics.TimeJumpBackCounter.Inc() // 表示TiDB的进程是否仍然存在。
// 若10分钟内tidb_monitor_keep_alive_total
// 次数<100,TiDB可能退出,此时会报警
}
callBackCount := 0
sucessCallBack := func() {
callBackCount++
if callBackCount >= 5 {
callBackCount = 0
metrics.KeepAliveCounter.Inc() // KeepAlive监控
}
}
}
复制代码
// 启动了一些重要的后台进程
func createStoreAndDomain() {
fullPath := fmt.Sprintf("%s://%s", cfg.Store, cfg.Path)
storage, err = kvstore.New(fullPath)
dom, err = session.BootstrapSession(storage)}
}
复制代码
// 创建TiDB server
func createServer() {
driver := server.NewTiDBDriver(storage)
svr, err = server.NewServer(cfg, driver)
svr.SetDomain(dom)
}
复制代码

runServer() //启动服务

可以看到, runServer() 是启动TiDB流程中的的最后一步。

所以我们跳转到 server.Run() 中,

这里有很多接受请求时的异常处理逻辑,在此不表。简化一下大概有四步,如下:

if s.cfg.Status.ReportStatus {
s.startStatusHTTP() //配置路由信息
}
for{
conn, err := s.listener.Accept()// 监听客户端请求
clientConn := s.newConn(conn)// 创建connection
go s.onConn(clientConn)// 使用connection处理请求
}
复制代码

首先配置了关于TiDB组件的很多路由信息,有兴趣的可以看看。

server 不断监听网络请求,出现新的客户端请求就创建一个新的connection,使用一个新 goroutine 来持续为它提供服务。

后续就是通过 go s.onConn(clientConn) 处理客户端请求,我们来一探究竟接下来的流程,简化下代码,大致如下

func (s *Server) onConn(conn *clientConn) {
ctx := logutil.WithConnID(context.Background(), conn.connectionID)
if err := conn.handshake(ctx); err != nil {
if plugin.IsEnable(plugin.Audit) && conn.ctx != nil {
conn.ctx.GetSessionVars().ConnectionInfo = conn.connectInfo()
})
}
}
connectedTime := time.Now()
conn.Run(ctx)
}
复制代码

将建链info写入到session中,统计一下链路建立成功的时间,之后就run起来了。

建链成功后,通过 conn.Run(ctx) 处理客户端请求

func (cc *clientConn) Run(ctx context.Context) {
for {
waitTimeout := cc.getSessionVarsWaitTimeout(ctx)
cc.pkt.setReadTimeout(time.Duration(waitTimeout) * time.Second)
data, err := cc.readPacket()
if err = cc.dispatch(ctx, data); err != nil {
...
}
}
}
复制代码

简化后,处理逻辑大致是,

不停的通过 cc.readPacket() 读取客户端发来的网络包。如果这个期间发生了等待网络包超时的现象,则close connection。

读取data成功后,将它传入 cc.dispatch(ctx,data) ,这也是处理SQL请求的入口了。

下一篇会继续通过 cc.dispatch(ctx,data) 了解TiDB处理SQl请求的后续流程。

微信扫一扫,分享到朋友圈

TiDB源码阅读(一) TiDB的入口

Linux网络设备驱动之网络设备的打开与释放(四)

上一篇

初学linux

下一篇

你也可能喜欢

TiDB源码阅读(一) TiDB的入口

长按储存图像,分享给朋友