github.com/SagerNet/gvisor@v0.0.0-20210707092255-7731c139d75c/tools/checklocks/test/incompat.go (about)

     1  // Copyright 2020 The gVisor Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package test
    16  
    17  import (
    18  	"sync"
    19  )
    20  
    21  // unsupportedLockerStruct verifies that trying to annotate a field that is not a
    22  // sync.Mutex or sync.RWMutex results in a failure.
    23  type unsupportedLockerStruct struct {
    24  	mu sync.Locker
    25  
    26  	// +checklocks:mu
    27  	x int // +checklocksfail
    28  }
    29  
    30  // badFieldsStruct verifies that refering invalid fields fails.
    31  type badFieldsStruct struct {
    32  	// +checklocks:mu
    33  	x int // +checklocksfail
    34  }
    35  
    36  // redundantStruct verifies that redundant annotations fail.
    37  type redundantStruct struct {
    38  	mu sync.Mutex
    39  
    40  	// +checklocks:mu
    41  	// +checklocks:mu
    42  	x int // +checklocksfail
    43  }
    44  
    45  // conflictsStruct verifies that conflicting annotations fail.
    46  type conflictsStruct struct {
    47  	// +checkatomicignore
    48  	// +checkatomic
    49  	x int // +checklocksfail
    50  
    51  	// +checkatomic
    52  	// +checkatomicignore
    53  	y int // +checklocksfail
    54  }