SchultesDev/wireguard-go
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

device: change logging interface to use functions

Browse Source 
This commit overhauls wireguard-go's logging.

The primary, motivating change is to use a function instead
of a *log.Logger as the basic unit of logging.
Using functions provides a lot more flexibility for
people to bring their own logging system.

It also introduces logging helper methods on Device.
These reduce line noise at the call site.
They also allow for log functions to be nil;
when nil, instead of generating a log line and throwing it away,
we don't bother generating it at all.
This spares allocation and pointless work.

This is a breaking change, although the fix required
of clients is fairly straightforward.

Signed-off-by: Josh Bleecher Snyder <josh@tailscale.com>
This commit is contained in:
Josh Bleecher Snyder
2021-01-22 14:11:17 -08:00
committed by Jason A. Donenfeld
parent 37efdcaccf
commit 7139279cd0
11 changed files with 147 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
device/tun.go
View File

@@ -15,41 +15,37 @@ const DefaultMTU = 1420
func (device *Device) RoutineTUNEventReader() {
setUp := false
logDebug := device.log.Debug
logInfo := device.log.Info
logError := device.log.Error
logDebug.Println("Routine: event worker - started")
device.debugf("Routine: event worker - started")
for event := range device.tun.device.Events() {
if event&tun.EventMTUUpdate != 0 {
mtu, err := device.tun.device.MTU()
old := atomic.LoadInt32(&device.tun.mtu)
if err != nil {
logError.Println("Failed to load updated MTU of device:", err)
device.errorf("Failed to load updated MTU of device: %v", err)
} else if int(old) != mtu {
if mtu+MessageTransportSize > MaxMessageSize {
logInfo.Println("MTU updated:", mtu, "(too large)")
device.infof("MTU updated: %v (too large)", mtu)
} else {
logInfo.Println("MTU updated:", mtu)
device.infof("MTU updated: %v", mtu)
}
atomic.StoreInt32(&device.tun.mtu, int32(mtu))
}
}
if event&tun.EventUp != 0 && !setUp {
logInfo.Println("Interface set up")
device.infof("Interface set up")
setUp = true
device.Up()
}
if event&tun.EventDown != 0 && setUp {
logInfo.Println("Interface set down")
device.infof("Interface set down")
setUp = false
device.Down()
}
}
logDebug.Println("Routine: event worker - stopped")
device.debugf("Routine: event worker - stopped")
device.state.stopping.Done()
}