forked from kubernetes/kubernetes
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request kubernetes#16053 from saad-ali/attachDetachMutextFix
Fix GCE Cloud/Attach/Detach stability issues
- Loading branch information
Showing
6 changed files
with
264 additions
and
352 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
/* | ||
Copyright 2015 The Kubernetes Authors All rights reserved. | ||
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 keymutex | ||
|
||
import ( | ||
"fmt" | ||
"github.com/golang/glog" | ||
"sync" | ||
) | ||
|
||
// KeyMutex is a thread-safe interface for aquiring locks on arbitrary strings. | ||
type KeyMutex interface { | ||
// Aquires a lock associated with the specified ID, creates the lock if one doesn't already exist. | ||
LockKey(id string) | ||
|
||
// Releases the lock associated with the specified ID. | ||
// Returns an error if the specified ID doesn't exist. | ||
UnlockKey(id string) error | ||
} | ||
|
||
// Returns a new instance of a key mutex. | ||
func NewKeyMutex() KeyMutex { | ||
return &keyMutex{ | ||
mutexMap: make(map[string]*sync.Mutex), | ||
} | ||
} | ||
|
||
type keyMutex struct { | ||
sync.RWMutex | ||
mutexMap map[string]*sync.Mutex | ||
} | ||
|
||
// Aquires a lock associated with the specified ID (creates the lock if one doesn't already exist). | ||
func (km *keyMutex) LockKey(id string) { | ||
glog.V(5).Infof("LockKey(...) called for id %q\r\n", id) | ||
mutex := km.getOrCreateLock(id) | ||
mutex.Lock() | ||
glog.V(5).Infof("LockKey(...) for id %q completed.\r\n", id) | ||
} | ||
|
||
// Releases the lock associated with the specified ID. | ||
// Returns an error if the specified ID doesn't exist. | ||
func (km *keyMutex) UnlockKey(id string) error { | ||
glog.V(5).Infof("UnlockKey(...) called for id %q\r\n", id) | ||
km.RLock() | ||
defer km.RUnlock() | ||
mutex, exists := km.mutexMap[id] | ||
if !exists { | ||
return fmt.Errorf("id %q not found", id) | ||
} | ||
glog.V(5).Infof("UnlockKey(...) for id. Mutex found, trying to unlock it. %q\r\n", id) | ||
|
||
mutex.Unlock() | ||
glog.V(5).Infof("UnlockKey(...) for id %q completed.\r\n", id) | ||
return nil | ||
} | ||
|
||
// Returns lock associated with the specified ID, or creates the lock if one doesn't already exist. | ||
func (km *keyMutex) getOrCreateLock(id string) *sync.Mutex { | ||
km.Lock() | ||
defer km.Unlock() | ||
|
||
if _, exists := km.mutexMap[id]; !exists { | ||
km.mutexMap[id] = &sync.Mutex{} | ||
} | ||
|
||
return km.mutexMap[id] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,111 @@ | ||
/* | ||
Copyright 2015 The Kubernetes Authors All rights reserved. | ||
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 keymutex | ||
|
||
import ( | ||
"testing" | ||
"time" | ||
) | ||
|
||
const ( | ||
callbackTimeout = 1 * time.Second | ||
) | ||
|
||
func Test_SingleLock_NoUnlock(t *testing.T) { | ||
// Arrange | ||
km := NewKeyMutex() | ||
key := "fakeid" | ||
callbackCh := make(chan interface{}) | ||
|
||
// Act | ||
go lockAndCallback(km, key, callbackCh) | ||
|
||
// Assert | ||
verifyCallbackHappens(t, callbackCh) | ||
} | ||
|
||
func Test_SingleLock_SingleUnlock(t *testing.T) { | ||
// Arrange | ||
km := NewKeyMutex() | ||
key := "fakeid" | ||
callbackCh := make(chan interface{}) | ||
|
||
// Act & Assert | ||
go lockAndCallback(km, key, callbackCh) | ||
verifyCallbackHappens(t, callbackCh) | ||
km.UnlockKey(key) | ||
} | ||
|
||
func Test_DoubleLock_DoubleUnlock(t *testing.T) { | ||
// Arrange | ||
km := NewKeyMutex() | ||
key := "fakeid" | ||
callbackCh1stLock := make(chan interface{}) | ||
callbackCh2ndLock := make(chan interface{}) | ||
|
||
// Act & Assert | ||
go lockAndCallback(km, key, callbackCh1stLock) | ||
verifyCallbackHappens(t, callbackCh1stLock) | ||
go lockAndCallback(km, key, callbackCh2ndLock) | ||
verifyCallbackDoesntHappens(t, callbackCh2ndLock) | ||
km.UnlockKey(key) | ||
verifyCallbackHappens(t, callbackCh2ndLock) | ||
km.UnlockKey(key) | ||
} | ||
|
||
func lockAndCallback(km KeyMutex, id string, callbackCh chan<- interface{}) { | ||
km.LockKey(id) | ||
callbackCh <- true | ||
} | ||
|
||
func verifyCallbackHappens(t *testing.T, callbackCh <-chan interface{}) bool { | ||
select { | ||
case <-callbackCh: | ||
return true | ||
case <-time.After(callbackTimeout): | ||
t.Fatalf("Timed out waiting for callback.") | ||
return false | ||
} | ||
} | ||
|
||
func verifyCallbackDoesntHappens(t *testing.T, callbackCh <-chan interface{}) bool { | ||
select { | ||
case <-callbackCh: | ||
t.Fatalf("Unexpected callback.") | ||
return false | ||
case <-time.After(callbackTimeout): | ||
return true | ||
} | ||
} | ||
|
||
func verifyNoError(t *testing.T, err error, name string) { | ||
if err != nil { | ||
t.Fatalf("Unexpected response on %q. Expected: <no error> Actual: <%v>", name, err) | ||
} | ||
} | ||
|
||
func verifyError(t *testing.T, err error, name string) { | ||
if err == nil { | ||
t.Fatalf("Unexpected response on %q. Expected: <error> Actual: <no error>", name) | ||
} | ||
} | ||
|
||
func verifyMsg(t *testing.T, expected, actual string) { | ||
if actual != expected { | ||
t.Fatalf("Unexpected testMsg value. Expected: <%v> Actual: <%v>", expected, actual) | ||
} | ||
} |
Oops, something went wrong.