作者：張學程
本文爲 DM 源碼閱讀系列文章的第二篇，第一篇文章 簡單介紹了 DM 源碼閱讀的目的和規劃，以及 DM 的源碼結構以及工具鏈。從本篇文章開始，我們會正式開始閱讀 DM 的源碼。
本篇文章主要介紹 DM 的整體架構，包括 DM 有哪些組件、各組件分別實現什麼功能、組件之間交互的數據模型和 RPC 實現。
整體架構
通過上面的 DM 架構圖，我們可以看出，除上下游數據庫及 Prometheus 監控組件外，DM 自身有 DM-master、DM-worker 及 dmctl 這 3 個組件。其中，DM-master 負責管理和調度數據同步任務的各項操作，DM-worker 負責執行具體的數據同步任務，dmctl 提供用於管理 DM 集羣與數據同步任務的各項命令。
DM-master
DM-master 的入口代碼在 cmd/dm-master/main.go，其中主要操作包括：
- 調用
cfg.Parse解析命令行參數與參數配置文件 - 調用
log.SetLevelByString設置進程的 log 輸出級別 - 調用
signal.Notify註冊系統 signal 通知，用於接受到指定信號時退出進程等 - 調用
server.Start啓動 RPC server，用於響應來自 dmctl 與 DM-worker 的請求
在上面的操作中，可以看出其中最關鍵的是步驟 4，其對應的實現代碼在 dm/master/server.go 中，其核心爲 Server 這個 struct，其中的主要 fields 包括：
-
rootLis, svr：監聽網絡連接，分發 RPC 請求給對應的 handler。 -
workerClients：維護集羣各 DM-worker ID 到對應的 RPC client 的映射關係。 -
taskWorkers：維護用於執行各同步（子）任務的 DM-worker ID 列表。 -
lockKeeper：管理在協調處理 sharding DDL 時的 lock 信息。 -
sqlOperatorHolder：管理手動 skip/replace 指定 sharding DDL 時的 SQL operator 信息。
在本篇文章中，我們暫時不會關注 lockKeeper 與 sqlOperatorHolder，其具體的功能與代碼實現會在後續相關文章中進行介紹。
在 DM-master Server 的入口方法 Start 中：
- 通過
net.Listen初始化rootLis並用於監聽 TCP 連接（藉助 soheilhy/cmux，我們在同一個 port 同時提供 gRPC 與 HTTP 服務）。 - 根據讀取的配置信息（
DeployMap），初始化用於連接到各 DM-worker 的 RPC client 並保存在workerClients中。 - 通過
pb.RegisterMasterServer註冊 gRPC server（svr），並將該Server作爲各 services 的 implementation。 - 調用
m.Serve開始提供服務。
DM-master 提供的 RPC 服務包括 DM 集羣管理、同步任務管理等，對應的 service 以 Protocol Buffers 格式定義在 dm/proto/dmmaster.proto 中，對應的 generated 代碼在 dm/pb/dmmaster.pb.go 中。各 service 的具體實現在 dm/master/server.go 中（*Server）。
DM-worker
DM-worker 的結構與 DM-master 類似，其入口代碼在 cmd/dm-worker/main.go 中。各 RPC services 的 Protocol Buffers 格式定義在 dm/proto/dmworker.proto 中，對應的 generated 代碼在 dm/pb/dmworker.pb.go 中，對應的實現代碼在 dm/worker/server.go 中（*Server）。DM-worker 的啓動流程與 DM-master 類似，在此不再額外說明。
Server 這個 struct 的主要 fields 除用於處理 RPC 的 rootLis 與 svr 外，另一個是用於管理同步任務與 relay log 的 worker（相關代碼在 dm/worker/worker.go 中）。
在 Worker 這個 struct 中，主要 fields 包括：
-
subTasks：維護該 DM-worker 上的所有同步子任務信息。 -
relayHolder：對 relay 處理單元相關操作進行簡單封裝，轉發相關操作請求給 relay 處理單元，獲取 relay 處理單元的狀態信息。 -
relayPurger：根據用戶配置及相關策略，嘗試定期對 relay log 進行 purge 操作。
數據同步子任務管理的代碼實現主要在 dm/worker/subtask.go 中， relay 處理單元管理的代碼實現主要在 dm/worker/relay.go 中，對 relay log 進行 purge 操作的代碼實現主要在 relay/purger pkg 中。在本篇文章中，我們暫時只關注 DM 架構相關的實現，上述各功能的具體實現將在後續的相關文章中展開介紹。
Worker 的入口方法爲 Start，其中的主要操作包括：
- 通過
w.relayHolder.Start啓動 relay 處理單元，開始從上游拉取 binlog。 - 通過
w.relayPurger.Start啓動後臺 purge 線程，嘗試對 relay log 進行定期 purge。
其他的操作主要還包括處理 Server 轉發而來的同步任務管理、relay 處理單元管理、狀態信息查詢等。
dmctl
dmctl 的入口代碼在 cmd/dm-ctl/main.go，其操作除參數解析與 signal 處理外，主要爲調用 loop 進入命令處理循環、等待用戶輸入操作命令。
在 loop 中，我們藉助 chzyer/readline 提供命令行交互環境，讀取用戶輸入的命令並輸出命令執行結果。一個命令的處理流程爲：
- 調用
l.Readline讀取用戶輸入的命令 - 判斷是否需要退出命令行交互環境（exit 命令）或需要進行處理
- 調用
ctl.Start進行命令分發與處理
dmctl 的具體命令處理實現在 dm/ctl pkg 中，入口爲 dm/ctl/ctl.go 中的 Start 方法，命令的分發與參數解析藉助於 spf13/cobra。命令的具體功能實現在相應的子 pkg 中：
-
master：dmctl 與 DM-master 交互的命令，是當前 DM 推薦的命令交互方式。 -
worker：dmctl 與 DM-worker 交互的命令，主要用於開發過程中進行 debug，當前並沒有實現所有 DM-worker 支持的命令，未來可能廢棄。 -
common：多個命令依賴的通用操作及 dmctl 依賴的配置信息等。
每個 dmctl 命令，其主要對應的實現包括 3 個部分：
- 在各命令對應的實現源文件中，通過
New***Cmd形式的方法創建cobra.Command對象。 - 在
dm/ctl/ctl.go中通過調用rootCmd.AddCommand添加該命令。 - 在各命令對應的實現源文件中，通過
***Func形式的方法實現參數驗證、RPC 調用等具體功能。
任務管理調用鏈示例
讓我們用一個啓動數據同步任務的操作示例來說明 DM 中的組件交互與 RPC 調用流程。
- 用戶在 dmctl 命令行交互環境中輸入 start-task 命令及相應參數。
- dmctl 在
dm/ctl/ctl.go的Start方法中進行命令分發，請求dm/ctl/master/start_task.go中的startTaskFunc處理命令。 -
startTaskFunc通過cli.StartTask調用 DM-master 上的 RPC 方法。 - DM-master 中的
Server.StartTask方法（dm/master/server.go）響應來自 dmctl 的 RPC 請求。 -
Server.Start從workerClients中獲取任務對應 DM-worker 的 RPC client，並通過cli.StartSubTask調用 DM-worker 上的 RPC 方法。 - DM-worker 中的
Server.StartSubTask方法（dm/worker/server.go）響應來自 DM-master 的 RPC 請求。 -
Server.StartSubTask中將任務管理請求轉發給Worker.StartSubTask（dm/worker/worker.go），並將處理結果通過 RPC 返回給 DM-master。 - DM-master 將 DM-worker 返回的 RPC 響應重新封裝後通過 RPC 返回給 dmctl。
- dmctl 通過
common.PrettyPrintResponse輸出命令操作的 RPC 響應。
小結
在本篇文章中，我們主要介紹了 DM 的各個組件的入口函數，最後以 dmctl 的 start-task 爲例介紹了交互的調用流程細節。下一篇文章我們會開始介紹 DM-worker 組件內各數據同步處理單元（relay-unit, dump-unit, load-unit, sync-unit）的設計原理與具體實現。
