snow/wireguard-go
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

device: fix comment typo and shorten state.mu.Lock to state.Lock

Browse source 
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
This commit is contained in:
Jason A. Donenfeld 2021-02-09 15:35:43 +01:00
parent 02138f1f81
commit a816e8511e
2 changed files with 12 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
device/device.go
View file

@ -24,9 +24,8 @@ type Device struct {
state struct { state struct {
// state holds the device's state. It is accessed atomically. // state holds the device's state. It is accessed atomically.
// Use the device.deviceState method to read it. // Use the device.deviceState method to read it.
// If state.mu is (r)locked, state is the current state of the device. // If state is not locked, state is the current state of the device.
// Without state.mu (r)locked, state is either the current state // If state is locked, state is the current state or intended future state of the device.
// of the device or the intended future state of the device.
// For example, while executing a call to Up, state will be deviceStateUp. // For example, while executing a call to Up, state will be deviceStateUp.
// There is no guarantee that that intended future state of the device // There is no guarantee that that intended future state of the device
// will become the actual state; Up can fail. // will become the actual state; Up can fail.
@ -36,7 +35,7 @@ type Device struct {
// stopping blocks until all inputs to Device have been closed. // stopping blocks until all inputs to Device have been closed.
stopping sync.WaitGroup stopping sync.WaitGroup
// mu protects state changes. // mu protects state changes.
mu sync.Mutex sync.Mutex
} }
net struct { net struct {
@ -145,8 +144,8 @@ func unsafeRemovePeer(device *Device, peer *Peer, key NoisePublicKey) {
// changeState attempts to change the device state to match want. // changeState attempts to change the device state to match want.
func (device *Device) changeState(want deviceState) { func (device *Device) changeState(want deviceState) {
device.state.mu.Lock() device.state.Lock()
defer device.state.mu.Unlock() defer device.state.Unlock()
old := device.deviceState() old := device.deviceState()
if old == deviceStateClosed { if old == deviceStateClosed {
// once closed, always closed // once closed, always closed
@ -353,8 +352,8 @@ func (device *Device) RemoveAllPeers() {
} }
func (device *Device) Close() { func (device *Device) Close() {
device.state.mu.Lock() device.state.Lock()
defer device.state.mu.Unlock() defer device.state.Unlock()
if device.isClosed() { if device.isClosed() {
return return
} }

10
device/peer.go
View file

@ -52,7 +52,7 @@ type Peer struct {
} }
state struct { state struct {
mu sync.Mutex // protects against concurrent Start/Stop sync.Mutex // protects against concurrent Start/Stop
} }
queue struct { queue struct {
@ -161,8 +161,8 @@ func (peer *Peer) Start() {
} }
// prevent simultaneous start/stop operations // prevent simultaneous start/stop operations
peer.state.mu.Lock() peer.state.Lock()
defer peer.state.mu.Unlock() defer peer.state.Unlock()
if peer.isRunning.Get() { if peer.isRunning.Get() {
return return
@ -242,8 +242,8 @@ func (peer *Peer) ExpireCurrentKeypairs() {
} }
func (peer *Peer) Stop() { func (peer *Peer) Stop() {
peer.state.mu.Lock() peer.state.Lock()
defer peer.state.mu.Unlock() defer peer.state.Unlock()
if !peer.isRunning.Swap(false) { if !peer.isRunning.Swap(false) {
return return