summaryrefslogtreecommitdiffhomepage
path: root/tools/checklocks/test/basics.go
blob: 7a773171f0523ce9b89902dcb426b983881cd0b9 (plain)
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
// Copyright 2020 The gVisor Authors.
//
// 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 test

import (
	"sync"
)

func testLockedAccessValid(tc *oneGuardStruct) {
	tc.mu.Lock()
	tc.guardedField = 1
	tc.mu.Unlock()
}

func testLockedAccessIgnore(tc *oneGuardStruct) {
	tc.mu.Lock()
	tc.unguardedField = 1
	tc.mu.Unlock()
}

func testUnlockedAccessInvalidWrite(tc *oneGuardStruct) {
	tc.guardedField = 2 // +checklocksfail
}

func testUnlockedAccessInvalidRead(tc *oneGuardStruct) {
	x := tc.guardedField // +checklocksfail
	_ = x
}

func testUnlockedAccessValid(tc *oneGuardStruct) {
	tc.unguardedField = 2
}

func testCallValidAccess(tc *oneGuardStruct) {
	callValidAccess(tc)
}

func callValidAccess(tc *oneGuardStruct) {
	tc.mu.Lock()
	tc.guardedField = 1
	tc.mu.Unlock()
}

func testCallValueMixup(tc *oneGuardStruct) {
	callValueMixup(tc, tc)
}

func callValueMixup(tc1, tc2 *oneGuardStruct) {
	tc1.mu.Lock()
	tc2.guardedField = 2 // +checklocksfail
	tc1.mu.Unlock()
}

func testCallPreconditionsInvalid(tc *oneGuardStruct) {
	callPreconditions(tc) // +checklocksfail
}

func testCallPreconditionsValid(tc *oneGuardStruct) {
	tc.mu.Lock()
	callPreconditions(tc)
	tc.mu.Unlock()
}

// +checklocks:tc.mu
func callPreconditions(tc *oneGuardStruct) {
	tc.guardedField = 1
}

type nestedFieldsStruct struct {
	mu sync.Mutex

	// +checklocks:mu
	nestedStruct struct {
		nested1 int
		nested2 int
	}
}

func testNestedGuardValid(tc *nestedFieldsStruct) {
	tc.mu.Lock()
	tc.nestedStruct.nested1 = 1
	tc.nestedStruct.nested2 = 2
	tc.mu.Unlock()
}

func testNestedGuardInvalid(tc *nestedFieldsStruct) {
	tc.nestedStruct.nested1 = 1 // +checklocksfail
}

type rwGuardStruct struct {
	rwMu sync.RWMutex

	// +checklocks:rwMu
	guardedField int
}

func testRWValidRead(tc *rwGuardStruct) {
	tc.rwMu.Lock()
	tc.guardedField = 1
	tc.rwMu.Unlock()
}

func testRWValidWrite(tc *rwGuardStruct) {
	tc.rwMu.RLock()
	tc.guardedField = 2
	tc.rwMu.RUnlock()
}

func testRWInvalidWrite(tc *rwGuardStruct) {
	tc.guardedField = 3 // +checklocksfail
}

func testRWInvalidRead(tc *rwGuardStruct) {
	x := tc.guardedField + 3 // +checklocksfail
	_ = x
}

func testTwoLocksDoubleGuardStructValid(tc *twoLocksDoubleGuardStruct) {
	tc.mu.Lock()
	tc.secondMu.Lock()
	tc.doubleGuardedField = 1
	tc.secondMu.Unlock()
}

func testTwoLocksDoubleGuardStructOnlyOne(tc *twoLocksDoubleGuardStruct) {
	tc.mu.Lock()
	tc.doubleGuardedField = 2 // +checklocksfail
	tc.mu.Unlock()
}

func testTwoLocksDoubleGuardStructInvalid(tc *twoLocksDoubleGuardStruct) {
	tc.doubleGuardedField = 3 // +checklocksfail:2
}