summaryrefslogtreecommitdiffhomepage
path: root/tools/checklocks/test/globals.go
blob: 656b0c9a3a2c67deff586bd318c9c47a5b017876 (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
// 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"
)

var (
	globalMu   sync.Mutex
	globalRWMu sync.RWMutex
)

var globalStruct struct {
	mu sync.Mutex
	// +checklocks:mu
	guardedField int
}

var otherStruct struct {
	// +checklocks:globalMu
	guardedField1 int
	// +checklocks:globalRWMu
	guardedField2 int
	// +checklocks:globalStruct.mu
	guardedField3 int
}

func testGlobalValid() {
	globalMu.Lock()
	otherStruct.guardedField1 = 1
	globalMu.Unlock()

	globalRWMu.Lock()
	otherStruct.guardedField2 = 1
	globalRWMu.Unlock()

	globalRWMu.RLock()
	_ = otherStruct.guardedField2
	globalRWMu.RUnlock()

	globalStruct.mu.Lock()
	globalStruct.guardedField = 1
	otherStruct.guardedField3 = 1
	globalStruct.mu.Unlock()
}

// +checklocks:globalStruct.mu
func testGlobalValidPreconditions0() {
	globalStruct.guardedField = 1
}

// +checklocks:globalMu
func testGlobalValidPreconditions1() {
	otherStruct.guardedField1 = 1
}

// +checklocks:globalRWMu
func testGlobalValidPreconditions2() {
	otherStruct.guardedField2 = 1
}

// +checklocks:globalStruct.mu
func testGlobalValidPreconditions3() {
	otherStruct.guardedField3 = 1
}

func testGlobalInvalid() {
	globalStruct.guardedField = 1 // +checklocksfail
	otherStruct.guardedField1 = 1 // +checklocksfail
	otherStruct.guardedField2 = 1 // +checklocksfail
	otherStruct.guardedField3 = 1 // +checklocksfail
}