File: failpoint.go

package info (click to toggle)
golang-github-etcd-io-gofail 0.0.0%2Bgit.2022.09.25.d0d2a96a6e-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 276 kB
  • sloc: makefile: 24
file content (83 lines) | stat: -rw-r--r-- 1,953 bytes parent folder | download
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
// Copyright 2016 CoreOS, 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,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package runtime

import (
	"context"
	"fmt"
	"sync"
)

type Failpoint struct {
	cmu      sync.RWMutex
	ctx      context.Context
	cancel   context.CancelFunc
	donec    chan struct{}
	released bool

	mu sync.RWMutex
	t  *terms
}

func NewFailpoint(pkg, name string, goFailGo bool) *Failpoint {
	fp := &Failpoint{}
	if goFailGo {
		fp.ctx, fp.cancel = context.WithCancel(context.Background())
		fp.donec = make(chan struct{})
	}
	register(pkg+"/"+name, fp)
	return fp
}

// Acquire gets evalutes the failpoint terms; if the failpoint
// is active, it will return a value. Otherwise, returns a non-nil error.
func (fp *Failpoint) Acquire() (interface{}, error) {
	fp.mu.RLock()
	if fp.t == nil {
		fp.mu.RUnlock()
		return nil, ErrDisabled
	}
	v, err := fp.t.eval()
	if v == nil {
		err = ErrDisabled
	}
	if err != nil {
		fp.mu.RUnlock()
	}
	return v, err
}

// Release is called when the failpoint exists.
func (fp *Failpoint) Release() {
	fp.cmu.RLock()
	ctx := fp.ctx
	donec := fp.donec
	fp.cmu.RUnlock()
	if ctx != nil && !fp.released {
		<-ctx.Done()
		select {
		case <-donec:
		default:
			close(donec)
		}
	}

	fp.mu.RUnlock()
}

// BadType is called when the failpoint evaluates to the wrong type.
func (fp *Failpoint) BadType(v interface{}, t string) {
	fmt.Printf("failpoint: %q got value %v of type \"%T\" but expected type %q\n", fp.t.fpath, v, v, t)
}