forked from pingcap/tidb
/
client.go
433 lines (389 loc) · 13.1 KB
/
client.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
// Copyright 2021 PingCAP, Inc. Licensed under Apache-2.0.
package streamhelper
import (
"bytes"
"context"
"encoding/binary"
"strconv"
"strings"
"github.com/gogo/protobuf/proto"
"github.com/pingcap/errors"
backuppb "github.com/pingcap/kvproto/pkg/brpb"
"github.com/pingcap/log"
berrors "github.com/twotigers93/tidb/br/pkg/errors"
"github.com/twotigers93/tidb/br/pkg/redact"
"github.com/twotigers93/tidb/kv"
"github.com/twotigers93/tidb/util/mathutil"
clientv3 "go.etcd.io/etcd/client/v3"
"go.uber.org/zap"
)
// Checkpoint is the polymorphic checkpoint type.
// The `ID` and `Version` implies the type of this checkpoint:
// When ID == 0 and Version == 0, it is the task start ts.
// When ID != 0 and Version == 0, it is the store level checkpoint.
// When ID != 0 and Version != 0, it is the region level checkpoint.
type Checkpoint struct {
ID uint64 `json:"id,omitempty"`
Version uint64 `json:"epoch_version,omitempty"`
TS uint64 `json:"ts"`
IsGlobal bool `json:"-"`
}
type CheckpointType int
const (
CheckpointTypeStore CheckpointType = iota
CheckpointTypeRegion
CheckpointTypeTask
CheckpointTypeGlobal
CheckpointTypeInvalid
)
// Type returns the type(provider) of the checkpoint.
func (cp Checkpoint) Type() CheckpointType {
switch {
case cp.IsGlobal:
return CheckpointTypeGlobal
case cp.ID == 0 && cp.Version == 0:
return CheckpointTypeTask
case cp.ID != 0 && cp.Version == 0:
return CheckpointTypeStore
case cp.ID != 0 && cp.Version != 0:
return CheckpointTypeRegion
default:
return CheckpointTypeInvalid
}
}
// MetaDataClient is the client for operations over metadata.
type MetaDataClient struct {
*clientv3.Client
}
func NewMetaDataClient(c *clientv3.Client) *MetaDataClient {
return &MetaDataClient{c}
}
// ParseCheckpoint parses the checkpoint from a key & value pair.
func ParseCheckpoint(task string, key, value []byte) (Checkpoint, error) {
pfx := []byte(CheckPointsOf(task))
if !bytes.HasPrefix(key, pfx) {
return Checkpoint{}, errors.Annotatef(berrors.ErrInvalidArgument, "the prefix is wrong for key: %s", key)
}
key = bytes.TrimPrefix(key, pfx)
segs := bytes.Split(key, []byte("/"))
var checkpoint Checkpoint
switch string(segs[0]) {
case checkpointTypeStore:
if len(segs) != 2 {
return checkpoint, errors.Annotatef(berrors.ErrPiTRMalformedMetadata,
"the store checkpoint seg mismatch; segs = %v", segs)
}
id, err := strconv.ParseUint(string(segs[1]), 10, 64)
if err != nil {
return checkpoint, err
}
checkpoint.ID = id
case checkpointTypeGlobal:
checkpoint.IsGlobal = true
case checkpointTypeRegion:
if len(segs) != 3 {
return checkpoint, errors.Annotatef(berrors.ErrPiTRMalformedMetadata,
"the region checkpoint seg mismatch; segs = %v", segs)
}
id, err := strconv.ParseUint(string(segs[1]), 10, 64)
if err != nil {
return checkpoint, err
}
version, err := strconv.ParseUint(string(segs[2]), 10, 64)
if err != nil {
return checkpoint, err
}
checkpoint.ID = id
checkpoint.Version = version
default:
if len(key) != 8 {
return checkpoint, errors.Annotatef(berrors.ErrPiTRMalformedMetadata,
"the store id isn't 64bits (it is %d bytes, value = %s)",
len(key),
redact.Key(key))
}
id := binary.BigEndian.Uint64(key)
checkpoint.ID = id
}
if len(value) != 8 {
return checkpoint, errors.Annotatef(berrors.ErrPiTRMalformedMetadata,
"the checkpoint value isn't 64bits (it is %d bytes, value = %s)",
len(segs[0]),
redact.Key(segs[0]))
}
checkpoint.TS = binary.BigEndian.Uint64(value)
return checkpoint, nil
}
// PutTask put a task to the metadata storage.
func (c *MetaDataClient) PutTask(ctx context.Context, task TaskInfo) error {
data, err := task.PBInfo.Marshal()
if err != nil {
return errors.Annotatef(err, "failed to marshal task %s", task.PBInfo.Name)
}
ops := make([]clientv3.Op, 0, 2+len(task.Ranges))
ops = append(ops, clientv3.OpPut(TaskOf(task.PBInfo.Name), string(data)))
for _, r := range task.Ranges {
ops = append(ops, clientv3.OpPut(RangeKeyOf(task.PBInfo.Name, r.StartKey), string(r.EndKey)))
log.Debug("range info",
zap.String("task-name", task.PBInfo.Name),
zap.String("start-key", redact.Key(r.StartKey)),
zap.String("end-key", redact.Key(r.EndKey)),
)
}
if task.Pausing {
ops = append(ops, clientv3.OpPut(Pause(task.PBInfo.Name), ""))
}
txn := c.KV.Txn(ctx)
_, err = txn.Then(ops...).Commit()
if err != nil {
return errors.Annotatef(err, "failed to commit the change for task %s", task.PBInfo.Name)
}
return nil
}
// DeleteTask deletes a task, along with its metadata.
func (c *MetaDataClient) DeleteTask(ctx context.Context, taskName string) error {
_, err := c.KV.Txn(ctx).
Then(
clientv3.OpDelete(TaskOf(taskName)),
clientv3.OpDelete(RangesOf(taskName), clientv3.WithPrefix()),
clientv3.OpDelete(CheckPointsOf(taskName), clientv3.WithPrefix()),
clientv3.OpDelete(Pause(taskName)),
clientv3.OpDelete(LastErrorPrefixOf(taskName), clientv3.WithPrefix()),
clientv3.OpDelete(GlobalCheckpointOf(taskName)),
clientv3.OpDelete(StorageCheckpointOf(taskName), clientv3.WithPrefix()),
).
Commit()
if err != nil {
return errors.Annotatef(err, "failed to delete task itself %s", taskName)
}
return nil
}
func (c *MetaDataClient) PauseTask(ctx context.Context, taskName string) error {
_, err := c.KV.Put(ctx, Pause(taskName), "")
if err != nil {
return errors.Annotatef(err, "failed to pause task %s", taskName)
}
return nil
}
func (c *MetaDataClient) ResumeTask(ctx context.Context, taskName string) error {
_, err := c.KV.Delete(ctx, Pause(taskName))
if err != nil {
return errors.Annotatef(err, "failed to resume task %s", taskName)
}
return nil
}
func (c *MetaDataClient) CleanLastErrorOfTask(ctx context.Context, taskName string) error {
_, err := c.KV.Delete(ctx, LastErrorPrefixOf(taskName), clientv3.WithPrefix())
if err != nil {
return errors.Annotatef(err, "failed to clean last error of task %s", taskName)
}
return nil
}
// GetTask get the basic task handle from the metadata storage.
func (c *MetaDataClient) GetTask(ctx context.Context, taskName string) (*Task, error) {
resp, err := c.Get(ctx, TaskOf(taskName))
if err != nil {
return nil, errors.Annotatef(err, "failed to fetch task %s", taskName)
}
if len(resp.Kvs) == 0 {
return nil, errors.Annotatef(berrors.ErrPiTRTaskNotFound, "no such task %s", taskName)
}
var taskInfo backuppb.StreamBackupTaskInfo
err = proto.Unmarshal(resp.Kvs[0].Value, &taskInfo)
if err != nil {
return nil, errors.Annotatef(err, "invalid binary presentation of task info (name = %s)", taskName)
}
task := &Task{
cli: c,
Info: taskInfo,
}
return task, nil
}
func (c *MetaDataClient) GetTaskWithPauseStatus(ctx context.Context, taskName string) (*Task, bool, error) {
resps, err := c.KV.Txn(ctx).
Then(
clientv3.OpGet(TaskOf(taskName)),
clientv3.OpGet(Pause(taskName)),
).Commit()
if err != nil {
return nil, false, errors.Annotatef(err, "failed to fetch task %s", taskName)
}
if len(resps.Responses) == 0 || len(resps.Responses[0].GetResponseRange().Kvs) == 0 {
return nil, false, errors.Annotatef(berrors.ErrPiTRTaskNotFound, "no such task %s", taskName)
}
var taskInfo backuppb.StreamBackupTaskInfo
err = proto.Unmarshal(resps.Responses[0].GetResponseRange().Kvs[0].Value, &taskInfo)
if err != nil {
return nil, false, errors.Annotatef(err, "invalid binary presentation of task info (name = %s)", taskName)
}
paused := false
if len(resps.Responses) > 1 && len(resps.Responses[1].GetResponseRange().Kvs) > 0 {
paused = true
}
return &Task{cli: c, Info: taskInfo}, paused, nil
}
func (c *MetaDataClient) TaskByInfo(t backuppb.StreamBackupTaskInfo) *Task {
return &Task{cli: c, Info: t}
}
func (c *MetaDataClient) GetAllTasksWithRevision(ctx context.Context) ([]Task, int64, error) {
resp, err := c.KV.Get(ctx, PrefixOfTask(), clientv3.WithPrefix())
if err != nil {
return nil, 0, errors.Trace(err)
}
kvs := resp.Kvs
if len(kvs) == 0 {
return nil, resp.Header.GetRevision(), nil
}
tasks := make([]Task, len(kvs))
for idx, kv := range kvs {
err = proto.Unmarshal(kv.Value, &tasks[idx].Info)
if err != nil {
return nil, 0, errors.Trace(err)
}
tasks[idx].cli = c
}
return tasks, resp.Header.GetRevision(), nil
}
// GetAllTasks get all of tasks from metadata storage.
func (c *MetaDataClient) GetAllTasks(ctx context.Context) ([]Task, error) {
tasks, _, err := c.GetAllTasksWithRevision(ctx)
return tasks, err
}
// GetTaskCount get the count of tasks from metadata storage.
func (c *MetaDataClient) GetTaskCount(ctx context.Context) (int, error) {
scanner := scanEtcdPrefix(c.Client, PrefixOfTask())
kvs, err := scanner.AllPages(ctx, 1)
return len(kvs), errors.Trace(err)
}
// Task presents a remote "task" object.
// returned by a query of task.
// Associated to the client created it, hence be able to fetch remote fields like `ranges`.
type Task struct {
cli *MetaDataClient
Info backuppb.StreamBackupTaskInfo
}
func NewTask(client *MetaDataClient, info backuppb.StreamBackupTaskInfo) *Task {
return &Task{
cli: client,
Info: info,
}
}
// Pause is a shorthand for `metaCli.PauseTask`.
func (t *Task) Pause(ctx context.Context) error {
return t.cli.PauseTask(ctx, t.Info.Name)
}
// Resume is a shorthand for `metaCli.ResumeTask`
func (t *Task) Resume(ctx context.Context) error {
return t.cli.ResumeTask(ctx, t.Info.Name)
}
func (t *Task) IsPaused(ctx context.Context) (bool, error) {
resp, err := t.cli.KV.Get(ctx, Pause(t.Info.Name), clientv3.WithCountOnly())
if err != nil {
return false, errors.Annotatef(err, "failed to fetch the status of task %s", t.Info.Name)
}
return resp.Count > 0, nil
}
// Ranges tries to fetch the range from the metadata storage.
func (t *Task) Ranges(ctx context.Context) (Ranges, error) {
ranges := make(Ranges, 0, 64)
kvs, err := scanEtcdPrefix(t.cli.Client, RangesOf(t.Info.Name)).AllPages(ctx, 64)
if err != nil {
return nil, errors.Annotatef(err, "failed to fetch ranges of task %s", t.Info.Name)
}
commonPrefix := []byte(RangesOf(t.Info.Name))
for _, kvp := range kvs {
// The prefix must matches.
startKey := kvp.Key[len(commonPrefix):]
ranges = append(ranges, kv.KeyRange{StartKey: startKey, EndKey: kvp.Value})
}
return ranges, nil
}
// NextBackupTSList lists the backup ts of each store.
func (t *Task) NextBackupTSList(ctx context.Context) ([]Checkpoint, error) {
cps := make([]Checkpoint, 0)
prefix := CheckPointsOf(t.Info.Name)
scanner := scanEtcdPrefix(t.cli.Client, prefix)
kvs, err := scanner.AllPages(ctx, 1024)
if err != nil {
return nil, errors.Annotatef(err, "failed to get checkpoints of %s", t.Info.Name)
}
for _, kv := range kvs {
cp, err := ParseCheckpoint(t.Info.Name, kv.Key, kv.Value)
if err != nil {
return cps, err
}
cps = append(cps, cp)
}
return cps, nil
}
func (t *Task) GetStorageCheckpoint(ctx context.Context) (uint64, error) {
prefix := StorageCheckpointOf(t.Info.Name)
scanner := scanEtcdPrefix(t.cli.Client, prefix)
kvs, err := scanner.AllPages(ctx, 1024)
if err != nil {
return 0, errors.Annotatef(err, "failed to get checkpoints of %s", t.Info.Name)
}
var storageCheckpoint = t.Info.StartTs
for _, kv := range kvs {
if len(kv.Value) != 8 {
return 0, errors.Annotatef(berrors.ErrPiTRMalformedMetadata,
"the value isn't 64bits (it is %d bytes, value = %s)",
len(kv.Value),
redact.Key(kv.Value))
}
ts := binary.BigEndian.Uint64(kv.Value)
storageCheckpoint = mathutil.Max(storageCheckpoint, ts)
}
return storageCheckpoint, nil
}
// GetGlobalCheckPointTS gets the global checkpoint timestamp according to log task.
func (t *Task) GetGlobalCheckPointTS(ctx context.Context) (uint64, error) {
checkPointMap, err := t.NextBackupTSList(ctx)
if err != nil {
return 0, errors.Trace(err)
}
initialized := false
checkpoint := t.Info.StartTs
for _, cp := range checkPointMap {
if cp.Type() == CheckpointTypeGlobal {
return cp.TS, nil
}
if cp.Type() == CheckpointTypeStore && (!initialized || cp.TS < checkpoint) {
initialized = true
checkpoint = cp.TS
}
}
ts, err := t.GetStorageCheckpoint(ctx)
if err != nil {
return 0, errors.Trace(err)
}
return mathutil.Max(checkpoint, ts), nil
}
func (t *Task) UploadGlobalCheckpoint(ctx context.Context, ts uint64) error {
_, err := t.cli.KV.Put(ctx, GlobalCheckpointOf(t.Info.Name), string(encodeUint64(ts)))
if err != nil {
return err
}
return nil
}
func (t *Task) LastError(ctx context.Context) (map[uint64]backuppb.StreamBackupError, error) {
storeToError := map[uint64]backuppb.StreamBackupError{}
prefix := LastErrorPrefixOf(t.Info.Name)
result, err := t.cli.Get(ctx, prefix, clientv3.WithPrefix())
if err != nil {
return nil, errors.Annotatef(err, "failed to get the last error for task %s", t.Info.GetName())
}
for _, r := range result.Kvs {
storeIDStr := strings.TrimPrefix(string(r.Key), prefix)
storeID, err := strconv.ParseUint(storeIDStr, 10, 64)
if err != nil {
return nil, errors.Annotatef(err, "failed to parse the store ID string %s", storeIDStr)
}
var lastErr backuppb.StreamBackupError
if err := proto.Unmarshal(r.Value, &lastErr); err != nil {
return nil, errors.Annotatef(err, "failed to parse wire encoding for store %d", storeID)
}
storeToError[storeID] = lastErr
}
return storeToError, nil
}