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
|
// Copyright 2021 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.
package checkpoint
import (
"bufio"
"context"
"encoding/json"
"io"
"os"
"runtime"
"strings"
"sync/atomic"
"github.com/pingcap/errors"
"github.com/pingcap/tiup/pkg/version"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"golang.org/x/sync/semaphore"
)
type contextKey string
const (
semKey = contextKey("CHECKPOINT_SEMAPHORE")
goroutineKey = contextKey("CHECKPOINT_GOROUTINE")
funcKey = "__func__"
hashKey = "__hash__"
// At most 10M for each line in audit log
maxTokenSize = 10 * 1024 * 1024
)
var (
checkpoint *CheckPoint
// DebugCheckpoint is a switch used to debug if:
// - The context passed to checkpoint is generated by checkpoint.NewContext
// - multilple context acquire applied to the same context belone to the sampe goroutine
DebugCheckpoint = os.Getenv("DEBUG_CHECKPOINT") == "1"
)
// SetCheckPoint set global checkpoint for replay
func SetCheckPoint(file string) error {
pointReader, err := os.Open(file)
if err != nil {
return errors.AddStack(err)
}
defer pointReader.Close()
checkpoint, err = NewCheckPoint(pointReader)
if err != nil {
return err
}
return nil
}
// HasCheckPoint returns if SetCheckPoint has been called
func HasCheckPoint() bool {
return checkpoint != nil
}
// Acquire wraps CheckPoint.Acquire
func Acquire(ctx context.Context, fs FieldSet, point map[string]any) *Point {
if ctx.Value(goroutineKey) == nil || ctx.Value(semKey) == nil {
if DebugCheckpoint {
panic("the context passed to checkpoint.Acquire is not generated by checkpoint.NewContext")
}
zap.L().Debug("context missing for checkpoint, the result of replaying this operation may be unexpected!")
ctx = NewContext(ctx)
}
// Check goroutine if we are in test
gptr := ctx.Value(goroutineKey).(*goroutineLock)
g := atomic.LoadUint64((*uint64)(gptr))
if g == 0 {
atomic.StoreUint64((*uint64)(gptr), uint64(newGoroutineLock()))
} else {
goroutineLock(g).check()
}
pc, _, _, _ := runtime.Caller(1)
fn := runtime.FuncForPC(pc).Name()
// If checkpoint is disabled, return a mock point
if checkpoint == nil {
return &Point{nil, fn, nil, true}
}
return checkpoint.acquire(ctx, fs, fn, point)
}
// NewContext wraps given context with value needed by checkpoint
func NewContext(ctx context.Context) context.Context {
switch {
case ctx.Value(semKey) == nil:
ctx = context.WithValue(ctx, semKey, semaphore.NewWeighted(1))
case ctx.Value(semKey).(*semaphore.Weighted).TryAcquire(1):
defer ctx.Value(semKey).(*semaphore.Weighted).Release(1)
ctx = context.WithValue(ctx, semKey, semaphore.NewWeighted(1))
default:
ctx = context.WithValue(ctx, semKey, semaphore.NewWeighted(0))
}
return context.WithValue(ctx, goroutineKey, new(goroutineLock))
}
// CheckPoint provides the ability to recover from a failed command at the failpoint
type CheckPoint struct {
points []map[string]any
}
// NewCheckPoint returns a CheckPoint by given audit file
func NewCheckPoint(r io.Reader) (*CheckPoint, error) {
cp := CheckPoint{points: make([]map[string]any, 0)}
scanner := bufio.NewScanner(r)
scanner.Buffer(nil, maxTokenSize)
for scanner.Scan() {
line := scanner.Text()
m, err := checkLine(line)
if err != nil {
return nil, errors.Annotate(err, "initial checkpoint failed")
}
if m == nil {
continue
}
cp.points = append(cp.points, m)
}
if err := scanner.Err(); err != nil {
return nil, errors.Annotate(err, "failed to parse audit file %s")
}
return &cp, nil
}
// Acquire get point from checkpoints
func (c *CheckPoint) acquire(ctx context.Context, fs FieldSet, fn string, point map[string]any) *Point {
acquired := ctx.Value(semKey).(*semaphore.Weighted).TryAcquire(1)
point[funcKey] = fn
point[hashKey] = version.GitHash
next_point:
for _, p := range c.points {
for _, cf := range fs.Slice() {
if cf.eq == nil {
continue
}
if !contains(p, cf.field) || !contains(point, cf.field) || !cf.eq(p[cf.field], point[cf.field]) {
continue next_point
}
}
return &Point{ctx, fn, p, acquired}
}
return &Point{ctx, fn, nil, acquired}
}
// Point is a point of checkpoint
type Point struct {
ctx context.Context
fn string
point map[string]any
acquired bool
}
// Hit returns value of the point, it will be nil if not hit.
func (p *Point) Hit() map[string]any {
return p.point
}
// Release write checkpoint into log file
func (p *Point) Release(err error, fields ...zapcore.Field) {
logfn := zap.L().Info
if err != nil {
logfn = zap.L().Error
fields = append(fields, zap.Error(err))
}
fields = append(fields,
zap.String(hashKey, version.GitHash),
zap.String(funcKey, p.fn),
zap.Bool("hit", p.Hit() != nil))
if p.acquired {
logfn("CheckPoint", fields...)
// If checkpoint is disabled, the p.ctx will be nil
if p.ctx != nil {
p.ctx.Value(semKey).(*semaphore.Weighted).Release(1)
}
}
}
func checkLine(line string) (map[string]any, error) {
// target log format:
// 2021-01-13T14:11:02.987+0800 INFO SCPCommand {k:v...}
// 2021-01-13T14:11:03.780+0800 INFO SSHCommand {k:v...}
ss := strings.Fields(line)
pos := strings.Index(line, "{")
if len(ss) < 4 || ss[1] != "INFO" || ss[2] != "CheckPoint" || pos == -1 {
return nil, nil
}
m := make(map[string]any)
if err := json.Unmarshal([]byte(line[pos:]), &m); err != nil {
return nil, errors.AddStack(err)
}
return m, nil
}
func contains(m map[string]any, f string) bool {
_, ok := m[f]
return ok
}
|