forked from pingcap/tidb
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
executor: support global kill (pingcap#17649)
- Loading branch information
Showing
45 changed files
with
2,619 additions
and
144 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| # Copyright 2020 PingCAP, Inc. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| PROJECT=tidb | ||
| GOPATH ?= $(shell go env GOPATH) | ||
| P=8 | ||
|
|
||
| # Ensure GOPATH is set before running build process. | ||
| ifeq "$(GOPATH)" "" | ||
| $(error Please set the environment variable GOPATH before running `make`) | ||
| endif | ||
| FAIL_ON_STDOUT := awk '{ print } END { if (NR > 0) { exit 1 } }' | ||
|
|
||
| CURDIR := $(shell pwd) | ||
| path_to_add := $(addsuffix /bin,$(subst :,/bin:,$(GOPATH))):$(PWD)/tools/bin | ||
| export PATH := $(path_to_add):$(PATH) | ||
|
|
||
| GO := GO111MODULE=on go | ||
| GOBUILD := $(GO) build $(BUILD_FLAG) -tags codes | ||
| GOBUILDCOVERAGE := GOPATH=$(GOPATH) cd tidb-server; $(GO) test -coverpkg="../..." -c . | ||
| GOTEST := $(GO) test -p $(P) | ||
| OVERALLS := GO111MODULE=on overalls | ||
| STATICCHECK := GO111MODULE=on staticcheck | ||
| TIDB_EDITION ?= Community | ||
|
|
||
| # Ensure TIDB_EDITION is set to Community or Enterprise before running build process. | ||
| ifneq "$(TIDB_EDITION)" "Community" | ||
| ifneq "$(TIDB_EDITION)" "Enterprise" | ||
| $(error Please set the correct environment variable TIDB_EDITION before running `make`) | ||
| endif | ||
| endif | ||
|
|
||
| ARCH := "`uname -s`" | ||
| LINUX := "Linux" | ||
| MAC := "Darwin" | ||
| PACKAGE_LIST := go list ./...| grep -vE "cmd|github.com\/pingcap\/tidb\/tests" | ||
| PACKAGES ?= $$($(PACKAGE_LIST)) | ||
| PACKAGE_DIRECTORIES := $(PACKAGE_LIST) | sed 's|github.com/pingcap/$(PROJECT)/||' | ||
| FILES := $$(find $$($(PACKAGE_DIRECTORIES)) -name "*.go") | ||
|
|
||
| FAILPOINT_ENABLE := $$(find $$PWD/ -type d | grep -vE "(\.git|tools)" | xargs tools/bin/failpoint-ctl enable) | ||
| FAILPOINT_DISABLE := $$(find $$PWD/ -type d | grep -vE "(\.git|tools)" | xargs tools/bin/failpoint-ctl disable) | ||
|
|
||
| LDFLAGS += -X "github.com/pingcap/parser/mysql.TiDBReleaseVersion=$(shell git describe --tags --dirty --always)" | ||
| LDFLAGS += -X "github.com/pingcap/tidb/util/versioninfo.TiDBBuildTS=$(shell date -u '+%Y-%m-%d %H:%M:%S')" | ||
| LDFLAGS += -X "github.com/pingcap/tidb/util/versioninfo.TiDBGitHash=$(shell git rev-parse HEAD)" | ||
| LDFLAGS += -X "github.com/pingcap/tidb/util/versioninfo.TiDBGitBranch=$(shell git rev-parse --abbrev-ref HEAD)" | ||
| LDFLAGS += -X "github.com/pingcap/tidb/util/versioninfo.TiDBEdition=$(TIDB_EDITION)" | ||
|
|
||
| TEST_LDFLAGS = -X "github.com/pingcap/tidb/config.checkBeforeDropLDFlag=1" | ||
| COVERAGE_SERVER_LDFLAGS = -X "github.com/pingcap/tidb/tidb-server.isCoverageServer=1" | ||
|
|
||
| CHECK_LDFLAGS += $(LDFLAGS) ${TEST_LDFLAGS} | ||
|
|
||
| TARGET = "" | ||
|
|
||
| # VB = Vector Benchmark | ||
| VB_FILE = | ||
| VB_FUNC = | ||
|
|
||
| RACE_FLAG = | ||
| ifeq ("$(WITH_RACE)", "1") | ||
| RACE_FLAG = -race | ||
| GOBUILD = GOPATH=$(GOPATH) $(GO) build | ||
| endif | ||
|
|
||
| CHECK_FLAG = | ||
| ifeq ("$(WITH_CHECK)", "1") | ||
| CHECK_FLAG = $(TEST_LDFLAGS) | ||
| endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # Global Kill | ||
|
|
||
| - Author(s): [pingyu](https://github.com/pingyu) (Ping Yu) | ||
| - Last updated: 2020-10-25 | ||
| - Discussion at: https://github.com/pingcap/tidb/issues/8854 | ||
|
|
||
| ## Abstract | ||
|
|
||
| This document introduces the design of global connection id, and the global `KILL <connId>` based on it. | ||
|
|
||
| ## Background | ||
|
|
||
| Currently connection ids are local to TiDB instances, which means that a `KILL x` must be directed to the correct instance, and can not safely be load balanced across the cluster, as discussed [here](https://github.com/pingcap/tidb/issues/8854). | ||
|
|
||
| ## Proposal | ||
|
|
||
| To support "Global Kill", we need: | ||
| 1. Global connection ids, which are unique among all TiDB instances. | ||
| 2. Redirect `KILL x` to target TiDB instance, on which the connection `x` is running. | ||
| 3. Support both 32 & 64 bits `connId`, to be compatible with legacy 32 bits clients. In this stage, we only design the 64 bits `connId`, and left a `markup` to distinguish between these two kinds. | ||
|
|
||
| ## Rationale | ||
|
|
||
| #### 1. Structure of `connId` | ||
| ##### 64 bits version | ||
| ``` | ||
| 63 62 41 40 1 0 | ||
| +--+---------------------+--------------------------------------+------+ | ||
| | | serverId | local connId |markup| | ||
| |=0| (22b) | (40b) | =1 | | ||
| +--+---------------------+--------------------------------------+------+ | ||
| ``` | ||
| ##### 32 bits version | ||
| (To be discussed in another RFC) | ||
| ``` | ||
| 31 1 0 | ||
| +-----------------------------+------+ | ||
| | ??? |markup| | ||
| | ??? | =0 | | ||
| +-----------------------------+------+ | ||
| ``` | ||
|
|
||
| #### 2. bit 63 | ||
| Bit 63 is always __ZERO__, making `connId` in range of non-negative int64, to be more friendly to exists codes, and some languages don't have primitive type `uint64`. | ||
|
|
||
| #### 3. markup | ||
| - `markup == 0` indicates that the `connID` is just 32 bits long effectively, and high 32 bits should be all zeros. Compatible with legacy 32 bits clients. | ||
| - `markup == 1` indicates that the `connID` is 64 bits long. Incompatible with legacy 32 bits clients. | ||
| - `markup == 1` while __high 32 bits are zeros__, indicates that 32 bits truncation happens. See `Compatibility` section. | ||
|
|
||
|
|
||
| #### 4. serverId | ||
| `serverId` is selected RANDOMLY by each TiDB instance on startup, and the uniqueness is guaranteed by PD(etcd). `serverId` should be larger or equal to 1, to ensure that high 32 bits of `connId` is always non-zero, and make it possible to detect truncation. | ||
|
|
||
| On failure (e.g. fail connecting to PD, or all `serverId` are unavailable), we block any new connection. | ||
|
|
||
| `serverId` is kept by PD with a lease (defaults to 12 hours, long enough to avoid brutally killing any long-run SQL). If TiDB is disconnected to PD longer than half of the lease (defaults to 6 hours), all connections are killed, and no new connection is accepted, to avoid running with stale/incorrect `serverId`. On connection to PD restored, a new `serverId` is acquired before accepting new connection. | ||
|
|
||
| On single TiDB instance without PD, a `serverId` of `1` is assigned. | ||
|
|
||
| #### 5. local connId | ||
| `local connId` is allocated by each TiDB instance on establishing connections incrementally. | ||
|
|
||
| Integer overflow is ignored at this stage, as `local connId` should be long enough. | ||
|
|
||
| #### 6. global kill | ||
| On processing `KILL x` command, first extract `serverId` from `x`. Then if `serverId` aims to a remote TiDB instance, get the address from cluster info (see also [`CLUSTER_INFO`](https://docs.pingcap.com/tidb/stable/information-schema-cluster-info#cluster_info)), and redirect the command to it by "Coprocessor API" provided by the remote TiDB, along with the original user authentication. | ||
|
|
||
| ## Compatibility | ||
|
|
||
| - Incompatible with legacy 32 bits clients. (According to some quick tests by now, MySQL client v8.0.19 supports `KILL` a connection with 64 bits `connId`, while `CTRL-C` does not, because it truncates the `connId` to 32 bits). A warning is set prompting that truncation happened, but user cannot see it, because `CTRL-C` is sent by a new connection in an instant. | ||
|
|
||
| - [`KILL TIDB`](https://docs.pingcap.com/tidb/v4.0/sql-statement-kill) syntax and [`compatible-kill-query`](https://docs.pingcap.com/tidb/v4.0/tidb-configuration-file#compatible-kill-query) configuration item are deprecated. |
Oops, something went wrong.