server: fix potential goroutine leak when kill connection (#13051)

Dockerfile

@@ -1,5 +1,5 @@
 # Builder image
-FROM golang:1.12-alpine as builder
+FROM golang:1.13-alpine as builder
 
 RUN apk add --no-cache \
     wget \
@@ -34,4 +34,4 @@ WORKDIR /
 
 EXPOSE 4000
 
-ENTRYPOINT ["/usr/local/bin/dumb-init", "/tidb-server"]
+ENTRYPOINT ["/usr/local/bin/dumb-init", "/tidb-server"]

Makefile

@@ -12,7 +12,8 @@ path_to_add := $(addsuffix /bin,$(subst :,/bin:,$(GOPATH))):$(PWD)/tools/bin
 export PATH := $(path_to_add):$(PATH)
 
 GO        := GO111MODULE=on go
-GOBUILD   := CGO_ENABLED=1 $(GO) build $(BUILD_FLAG)
+GOBUILD   := CGO_ENABLED=1 $(GO) build $(BUILD_FLAG) -trimpath
+GOBUILDCOVERAGE := GOPATH=$(GOPATH) CGO_ENABLED=1 cd tidb-server; $(GO) test -coverpkg="../..." -c .
 GOTEST    := CGO_ENABLED=1 $(GO) test -p 4
 OVERALLS  := CGO_ENABLED=1 GO111MODULE=on overalls
 
@@ -34,6 +35,7 @@ LDFLAGS += -X "github.com/pingcap/tidb/util/printer.TiDBGitBranch=$(shell git re
 LDFLAGS += -X "github.com/pingcap/tidb/util/printer.GoVersion=$(shell go version)"
 
 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}
 
@@ -61,7 +63,7 @@ build:
 # Install the check tools.
 check-setup:tools/bin/revive tools/bin/goword tools/bin/gometalinter tools/bin/gosec
 
-check: fmt errcheck lint tidy check-static vet
+check: fmt errcheck lint tidy testSuite check-static vet
 
 # These need to be fixed before they can be ran regularly
 check-fail: goword check-slow
@@ -106,6 +108,10 @@ tidy:
 	@echo "go mod tidy"
 	./tools/check/check-tidy.sh
 
+testSuite:
+	@echo "testSuite"
+	./tools/check/check_testSuite.sh
+
 clean:
 	$(GO) clean -i ./...
 	rm -rf *.out
@@ -129,8 +135,8 @@ endif
 gotest: failpoint-enable
 ifeq ("$(TRAVIS_COVERAGE)", "1")
 	@echo "Running in TRAVIS_COVERAGE mode."
-	@export log_level=error; \
 	$(GO) get github.com/go-playground/overalls
+	@export log_level=error; \
 	$(OVERALLS) -project=github.com/pingcap/tidb \
 			-covermode=count \
 			-ignore='.git,vendor,cmd,docs,LICENSES' \
@@ -183,6 +189,13 @@ else
 	$(GOBUILD) $(RACE_FLAG) -ldflags '$(CHECK_LDFLAGS)' -o '$(TARGET)' tidb-server/main.go
 endif
 
+server_coverage:
+ifeq ($(TARGET), "")
+	$(GOBUILDCOVERAGE) $(RACE_FLAG) -ldflags '$(LDFLAGS) $(COVERAGE_SERVER_LDFLAGS) $(CHECK_FLAG)' -o ../bin/tidb-server-coverage
+else
+	$(GOBUILDCOVERAGE) $(RACE_FLAG) -ldflags '$(LDFLAGS) $(COVERAGE_SERVER_LDFLAGS) $(CHECK_FLAG)' -o '$(TARGET)'
+endif
+
 benchkv:
 	$(GOBUILD) -ldflags '$(LDFLAGS)' -o bin/benchkv cmd/benchkv/main.go
 

bindinfo/bind_test.go

@@ -19,21 +19,22 @@ import (
 	"fmt"
 	"os"
 	"testing"
-	"time"
 
 	. "github.com/pingcap/check"
 	"github.com/pingcap/parser"
 	"github.com/pingcap/tidb/bindinfo"
 	"github.com/pingcap/tidb/domain"
 	"github.com/pingcap/tidb/kv"
 	"github.com/pingcap/tidb/meta/autoid"
+	"github.com/pingcap/tidb/metrics"
 	"github.com/pingcap/tidb/session"
 	"github.com/pingcap/tidb/store/mockstore"
 	"github.com/pingcap/tidb/store/mockstore/mocktikv"
 	"github.com/pingcap/tidb/util/logutil"
 	"github.com/pingcap/tidb/util/mock"
 	"github.com/pingcap/tidb/util/testkit"
 	"github.com/pingcap/tidb/util/testleak"
+	dto "github.com/prometheus/client_model/go"
 )
 
 func TestT(t *testing.T) {
@@ -73,7 +74,7 @@ func (s *testSuite) SetUpSuite(c *C) {
 		c.Assert(err, IsNil)
 		s.store = store
 		session.SetSchemaLease(0)
-		session.SetStatsLease(0)
+		session.DisableStats4Test()
 	}
 	d, err := session.BootstrapSession(s.store)
 	c.Assert(err, IsNil)
@@ -133,6 +134,11 @@ func (s *testSuite) TestBindParse(c *C) {
 	c.Check(bindData.Collation, Equals, "utf8mb4_bin")
 	c.Check(bindData.CreateTime, NotNil)
 	c.Check(bindData.UpdateTime, NotNil)
+
+	// Test fields with quotes or slashes.
+	sql = `CREATE GLOBAL BINDING FOR  select * from t where a BETWEEN "a" and "b" USING select * from t use index(idx) where a BETWEEN "a\nb\rc\td\0e" and 'x'`
+	tk.MustExec(sql)
+	tk.MustExec(`DROP global binding for select * from t use index(idx) where a BETWEEN "a\nb\rc\td\0e" and "x"`)
 }
 
 func (s *testSuite) TestGlobalBinding(c *C) {
@@ -145,13 +151,21 @@ func (s *testSuite) TestGlobalBinding(c *C) {
 	tk.MustExec("create table t1(i int, s varchar(20))")
 	tk.MustExec("create index index_t on t(i,s)")
 
+	metrics.BindTotalGauge.Reset()
+	metrics.BindMemoryUsage.Reset()
+
 	_, err := tk.Exec("create global binding for select * from t where i>100 using select * from t use index(index_t) where i>100")
 	c.Assert(err, IsNil, Commentf("err %v", err))
 
-	time.Sleep(time.Second * 1)
 	_, err = tk.Exec("create global binding for select * from t where i>99 using select * from t use index(index_t) where i>99")
 	c.Assert(err, IsNil)
 
+	pb := &dto.Metric{}
+	metrics.BindTotalGauge.WithLabelValues(metrics.ScopeGlobal, bindinfo.Using).Write(pb)
+	c.Assert(pb.GetGauge().GetValue(), Equals, float64(1))
+	metrics.BindMemoryUsage.WithLabelValues(metrics.ScopeGlobal, bindinfo.Using).Write(pb)
+	c.Assert(pb.GetGauge().GetValue(), Equals, float64(161))
+
 	sql, hash := parser.NormalizeDigest("select * from t where i > ?")
 
 	bindData := s.domain.BindHandle().GetBindRecord(hash, sql, "test")
@@ -167,7 +181,7 @@ func (s *testSuite) TestGlobalBinding(c *C) {
 
 	rs, err := tk.Exec("show global bindings")
 	c.Assert(err, IsNil)
-	chk := rs.NewRecordBatch()
+	chk := rs.NewChunk()
 	err = rs.Next(context.TODO(), chk)
 	c.Check(err, IsNil)
 	c.Check(chk.NumRows(), Equals, 1)
@@ -202,6 +216,12 @@ func (s *testSuite) TestGlobalBinding(c *C) {
 	bindData = s.domain.BindHandle().GetBindRecord(hash, sql, "test")
 	c.Check(bindData, IsNil)
 
+	metrics.BindTotalGauge.WithLabelValues(metrics.ScopeGlobal, bindinfo.Using).Write(pb)
+	c.Assert(pb.GetGauge().GetValue(), Equals, float64(0))
+	metrics.BindMemoryUsage.WithLabelValues(metrics.ScopeGlobal, bindinfo.Using).Write(pb)
+	// From newly created global bind handle.
+	c.Assert(pb.GetGauge().GetValue(), Equals, float64(161))
+
 	bindHandle = bindinfo.NewBindHandle(tk.Se)
 	err = bindHandle.Update(true)
 	c.Check(err, IsNil)
@@ -212,7 +232,7 @@ func (s *testSuite) TestGlobalBinding(c *C) {
 
 	rs, err = tk.Exec("show global bindings")
 	c.Assert(err, IsNil)
-	chk = rs.NewRecordBatch()
+	chk = rs.NewChunk()
 	err = rs.Next(context.TODO(), chk)
 	c.Check(err, IsNil)
 	c.Check(chk.NumRows(), Equals, 0)
@@ -234,13 +254,21 @@ func (s *testSuite) TestSessionBinding(c *C) {
 	tk.MustExec("create table t1(i int, s varchar(20))")
 	tk.MustExec("create index index_t on t(i,s)")
 
+	metrics.BindTotalGauge.Reset()
+	metrics.BindMemoryUsage.Reset()
+
 	_, err := tk.Exec("create session binding for select * from t where i>100 using select * from t use index(index_t) where i>100")
 	c.Assert(err, IsNil, Commentf("err %v", err))
 
-	time.Sleep(time.Second * 1)
 	_, err = tk.Exec("create session binding for select * from t where i>99 using select * from t use index(index_t) where i>99")
 	c.Assert(err, IsNil)
 
+	pb := &dto.Metric{}
+	metrics.BindTotalGauge.WithLabelValues(metrics.ScopeSession, bindinfo.Using).Write(pb)
+	c.Assert(pb.GetGauge().GetValue(), Equals, float64(1))
+	metrics.BindMemoryUsage.WithLabelValues(metrics.ScopeSession, bindinfo.Using).Write(pb)
+	c.Assert(pb.GetGauge().GetValue(), Equals, float64(161))
+
 	handle := tk.Se.Value(bindinfo.SessionBindInfoKeyType).(*bindinfo.SessionHandle)
 	bindData := handle.GetBindRecord("select * from t where i > ?", "test")
 	c.Check(bindData, NotNil)
@@ -255,14 +283,14 @@ func (s *testSuite) TestSessionBinding(c *C) {
 
 	rs, err := tk.Exec("show global bindings")
 	c.Assert(err, IsNil)
-	chk := rs.NewRecordBatch()
+	chk := rs.NewChunk()
 	err = rs.Next(context.TODO(), chk)
 	c.Check(err, IsNil)
 	c.Check(chk.NumRows(), Equals, 0)
 
 	rs, err = tk.Exec("show session bindings")
 	c.Assert(err, IsNil)
-	chk = rs.NewRecordBatch()
+	chk = rs.NewChunk()
 	err = rs.Next(context.TODO(), chk)
 	c.Check(err, IsNil)
 	c.Check(chk.NumRows(), Equals, 1)
@@ -282,6 +310,11 @@ func (s *testSuite) TestSessionBinding(c *C) {
 	c.Check(bindData, NotNil)
 	c.Check(bindData.OriginalSQL, Equals, "select * from t where i > ?")
 	c.Check(bindData.Status, Equals, "deleted")
+
+	metrics.BindTotalGauge.WithLabelValues(metrics.ScopeSession, bindinfo.Using).Write(pb)
+	c.Assert(pb.GetGauge().GetValue(), Equals, float64(0))
+	metrics.BindMemoryUsage.WithLabelValues(metrics.ScopeSession, bindinfo.Using).Write(pb)
+	c.Assert(pb.GetGauge().GetValue(), Equals, float64(0))
 }
 
 func (s *testSuite) TestGlobalAndSessionBindingBothExist(c *C) {
@@ -317,6 +350,7 @@ func (s *testSuite) TestGlobalAndSessionBindingBothExist(c *C) {
 
 	tk.MustExec("create global binding for SELECT * from t1,t2 where t1.id = t2.id using SELECT  /*+ TIDB_SMJ(t1, t2) */  * from t1,t2 where t1.id = t2.id")
 
+	metrics.BindUsageCounter.Reset()
 	tk.MustQuery("explain SELECT * from t1,t2 where t1.id = t2.id").Check(testkit.Rows(
 		"MergeJoin_7 12487.50 root inner join, left key:test.t1.id, right key:test.t2.id",
 		"├─Sort_11 9990.00 root test.t1.id:asc",
@@ -328,6 +362,9 @@ func (s *testSuite) TestGlobalAndSessionBindingBothExist(c *C) {
 		"    └─Selection_13 9990.00 cop not(isnull(test.t2.id))",
 		"      └─TableScan_12 10000.00 cop table:t2, range:[-inf,+inf], keep order:false, stats:pseudo",
 	))
+	pb := &dto.Metric{}
+	metrics.BindUsageCounter.WithLabelValues(metrics.ScopeGlobal).Write(pb)
+	c.Assert(pb.GetCounter().GetValue(), Equals, float64(1))
 
 	tk.MustExec("drop global binding for SELECT * from t1,t2 where t1.id = t2.id")
 
@@ -423,7 +460,7 @@ func (s *testSuite) TestErrorBind(c *C) {
 
 	rs, err := tk.Exec("show global bindings")
 	c.Assert(err, IsNil)
-	chk := rs.NewRecordBatch()
+	chk := rs.NewChunk()
 	err = rs.Next(context.TODO(), chk)
 	c.Check(err, IsNil)
 	c.Check(chk.NumRows(), Equals, 0)

bindinfo/cache.go

@@ -14,7 +14,10 @@
 package bindinfo
 
 import (
+	"unsafe"
+
 	"github.com/pingcap/parser/ast"
+	"github.com/pingcap/tidb/metrics"
 	"github.com/pingcap/tidb/types"
 	"github.com/pingcap/tidb/util/chunk"
 )
@@ -64,3 +67,19 @@ func newBindRecord(row chunk.Row) *BindRecord {
 		Collation:   row.GetString(7),
 	}
 }
+
+// size calculates the memory size of a bind meta.
+func (m *BindRecord) size() float64 {
+	res := len(m.OriginalSQL) + len(m.BindSQL) + len(m.Db) + len(m.Status) + 2*int(unsafe.Sizeof(m.CreateTime)) + len(m.Charset) + len(m.Collation)
+	return float64(res)
+}
+
+func (m *BindRecord) updateMetrics(scope string, inc bool) {
+	if inc {
+		metrics.BindMemoryUsage.WithLabelValues(scope, m.Status).Add(float64(m.size()))
+		metrics.BindTotalGauge.WithLabelValues(scope, m.Status).Inc()
+	} else {
+		metrics.BindMemoryUsage.WithLabelValues(scope, m.Status).Sub(float64(m.size()))
+		metrics.BindTotalGauge.WithLabelValues(scope, m.Status).Dec()
+	}
+}