]> git.ipfire.org Git - thirdparty/wireguard-go.git/commitdiff
device: get rid of nonce routine
authorJason A. Donenfeld <Jason@zx2c4.com>
Wed, 27 Jan 2021 17:13:53 +0000 (18:13 +0100)
committerJason A. Donenfeld <Jason@zx2c4.com>
Wed, 27 Jan 2021 17:38:27 +0000 (18:38 +0100)
This moves to a simple queue with no routine processing it, to reduce
scheduler pressure.

This splits latency in half!

benchmark                  old ns/op     new ns/op     delta
BenchmarkThroughput-16     2394          2364          -1.25%
BenchmarkLatency-16        259652        120810        -53.47%

Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
device/peer.go
device/queueconstants_android.go
device/queueconstants_default.go
device/queueconstants_ios.go
device/receive.go
device/send.go
device/timers.go
device/uapi.go

index a103b5d0e739ed4446facd3eeecdd19fbaa0db88..af2f57f911ff779a0742779c6bdbf50c71eaa151 100644 (file)
@@ -16,10 +16,6 @@ import (
        "golang.zx2c4.com/wireguard/conn"
 )
 
-const (
-       PeerRoutineNumber = 2
-)
-
 type Peer struct {
        isRunning                   AtomicBool
        sync.RWMutex                // Mostly protects endpoint, but is generally taken whenever we modify peer
@@ -54,17 +50,11 @@ type Peer struct {
                sentLastMinuteHandshake AtomicBool
        }
 
-       signals struct {
-               newKeypairArrived chan struct{}
-               flushNonceQueue   chan struct{}
-       }
-
        queue struct {
                sync.RWMutex
-               nonce                           chan *QueueOutboundElement // nonce / pre-handshake queue
-               outbound                        chan *QueueOutboundElement // sequential ordering of work
-               inbound                         chan *QueueInboundElement  // sequential ordering of work
-               packetInNonceQueueIsAwaitingKey AtomicBool
+               staged   chan *QueueOutboundElement // staged packets before a handshake is available
+               outbound chan *QueueOutboundElement // sequential ordering of work
+               inbound  chan *QueueInboundElement  // sequential ordering of work
        }
 
        routines struct {
@@ -197,25 +187,20 @@ func (peer *Peer) Start() {
 
        peer.routines.stopping.Wait()
        peer.routines.stop = make(chan struct{})
-       peer.routines.stopping.Add(PeerRoutineNumber)
+       peer.routines.stopping.Add(1)
 
        // prepare queues
        peer.queue.Lock()
-       peer.queue.nonce = make(chan *QueueOutboundElement, QueueOutboundSize)
+       peer.queue.staged = make(chan *QueueOutboundElement, QueueStagedSize)
        peer.queue.outbound = make(chan *QueueOutboundElement, QueueOutboundSize)
        peer.queue.inbound = make(chan *QueueInboundElement, QueueInboundSize)
        peer.queue.Unlock()
 
        peer.timersInit()
        peer.handshake.lastSentHandshake = time.Now().Add(-(RekeyTimeout + time.Second))
-       peer.signals.newKeypairArrived = make(chan struct{}, 1)
-       peer.signals.flushNonceQueue = make(chan struct{}, 1)
 
        // wait for routines to start
 
-       // RoutineNonce writes to the encryption queue; keep it alive until we are done.
-       device.queue.encryption.wg.Add(1)
-       go peer.RoutineNonce()
        go peer.RoutineSequentialSender()
        go peer.RoutineSequentialReceiver()
 
@@ -245,7 +230,7 @@ func (peer *Peer) ZeroAndFlushAll() {
        handshake.Clear()
        handshake.mutex.Unlock()
 
-       peer.FlushNonceQueue()
+       peer.FlushStagedPackets()
 }
 
 func (peer *Peer) ExpireCurrentKeypairs() {
@@ -291,8 +276,8 @@ func (peer *Peer) Stop() {
        // close queues
 
        peer.queue.Lock()
-       close(peer.queue.nonce)
        close(peer.queue.inbound)
+       close(peer.queue.outbound)
        peer.queue.Unlock()
 
        peer.ZeroAndFlushAll()
index f19c7bef7c87c731b040c82569f9c838017d0683..f4de5c9172ec1c39d48eae8ff9d9c64d57ec10f5 100644 (file)
@@ -8,6 +8,7 @@ package device
 /* Reduce memory consumption for Android */
 
 const (
+       QueueStagedSize            = 128
        QueueOutboundSize          = 1024
        QueueInboundSize           = 1024
        QueueHandshakeSize         = 1024
index 18f0bea16e433cf31706a0b22ba5c569cbf8a6e4..52a199d286d4461e286f60660fee2697afd0cd6e 100644 (file)
@@ -8,6 +8,7 @@
 package device
 
 const (
+       QueueStagedSize            = 128
        QueueOutboundSize          = 1024
        QueueInboundSize           = 1024
        QueueHandshakeSize         = 1024
index 4c830155fe848cf3a4c9bf186203b13227575b0b..c6c0b16a3ed902272fde930e48b4c7ee8a27eb4e 100644 (file)
@@ -10,6 +10,7 @@ package device
 /* Fit within memory limits for iOS's Network Extension API, which has stricter requirements */
 
 const (
+       QueueStagedSize            = 128
        QueueOutboundSize          = 1024
        QueueInboundSize           = 1024
        QueueHandshakeSize         = 1024
index a8e55ccfd90172354545641cd5cd61ae9ce5ce1d..e891fd0c934441d1ba417fe6b8390336278eb350 100644 (file)
@@ -427,10 +427,6 @@ func (device *Device) RoutineHandshake() {
                        peer.timersSessionDerived()
                        peer.timersHandshakeComplete()
                        peer.SendKeepalive()
-                       select {
-                       case peer.signals.newKeypairArrived <- struct{}{}:
-                       default:
-                       }
                }
        }
 }
@@ -485,10 +481,7 @@ func (peer *Peer) RoutineSequentialReceiver() {
                // check if using new keypair
                if peer.ReceivedWithKeypair(elem.keypair) {
                        peer.timersHandshakeComplete()
-                       select {
-                       case peer.signals.newKeypairArrived <- struct{}{}:
-                       default:
-                       }
+                       peer.SendStagedPackets()
                }
 
                peer.keepKeyFreshReceiving()
index 2d9af789a6ff86f5b875ecf8cc5238e9862ff30b..8bec144f6c3b952c7f4d2cdc889b00f88a1271a9 100644 (file)
@@ -71,41 +71,26 @@ func (elem *QueueOutboundElement) clearPointers() {
        elem.peer = nil
 }
 
-func addToNonceQueue(queue chan *QueueOutboundElement, elem *QueueOutboundElement, device *Device) {
-       for {
-               select {
-               case queue <- elem:
-                       return
-               default:
-                       select {
-                       case old := <-queue:
-                               device.PutMessageBuffer(old.buffer)
-                               device.PutOutboundElement(old)
-                       default:
-                       }
-               }
-       }
-}
-
 /* Queues a keepalive if no packets are queued for peer
  */
-func (peer *Peer) SendKeepalive() bool {
+func (peer *Peer) SendKeepalive() {
+       var elem *QueueOutboundElement
        peer.queue.RLock()
-       defer peer.queue.RUnlock()
-       if len(peer.queue.nonce) != 0 || peer.queue.packetInNonceQueueIsAwaitingKey.Get() || !peer.isRunning.Get() {
-               return false
+       if len(peer.queue.staged) != 0 || !peer.isRunning.Get() {
+               goto out
        }
-       elem := peer.device.NewOutboundElement()
+       elem = peer.device.NewOutboundElement()
        elem.packet = nil
        select {
-       case peer.queue.nonce <- elem:
+       case peer.queue.staged <- elem:
                peer.device.log.Verbosef("%v - Sending keepalive packet", peer)
-               return true
        default:
                peer.device.PutMessageBuffer(elem.buffer)
                peer.device.PutOutboundElement(elem)
-               return false
        }
+out:
+       peer.queue.RUnlock()
+       peer.SendStagedPackets()
 }
 
 func (peer *Peer) SendHandshakeInitiation(isRetry bool) error {
@@ -220,7 +205,7 @@ func (peer *Peer) keepKeyFreshSending() {
 }
 
 /* Reads packets from the TUN and inserts
- * into nonce queue for peer
+ * into staged queue for peer
  *
  * Obs. Single instance per TUN device
  */
@@ -287,136 +272,53 @@ func (device *Device) RoutineReadFromTUN() {
                if peer == nil {
                        continue
                }
-
-               // insert into nonce/pre-handshake queue
-
-               peer.queue.RLock()
                if peer.isRunning.Get() {
-                       if peer.queue.packetInNonceQueueIsAwaitingKey.Get() {
-                               peer.SendHandshakeInitiation(false)
-                       }
-                       addToNonceQueue(peer.queue.nonce, elem, device)
+                       peer.StagePacket(elem)
                        elem = nil
+                       peer.SendStagedPackets()
                }
-               peer.queue.RUnlock()
        }
 }
 
-func (peer *Peer) FlushNonceQueue() {
-       select {
-       case peer.signals.flushNonceQueue <- struct{}{}:
-       default:
-       }
-}
-
-/* Queues packets when there is no handshake.
- * Then assigns nonces to packets sequentially
- * and creates "work" structs for workers
- *
- * Obs. A single instance per peer
- */
-func (peer *Peer) RoutineNonce() {
-       var keypair *Keypair
-       device := peer.device
-
-       flush := func() {
-               for {
+func (peer *Peer) StagePacket(elem *QueueOutboundElement) {
+       for {
+               select {
+               case peer.queue.staged <- elem:
+                       return
+               default:
                        select {
-                       case elem := <-peer.queue.nonce:
-                               device.PutMessageBuffer(elem.buffer)
-                               device.PutOutboundElement(elem)
+                       case tooOld := <-peer.queue.staged:
+                               peer.device.PutMessageBuffer(tooOld.buffer)
+                               peer.device.PutOutboundElement(tooOld)
                        default:
-                               return
                        }
                }
        }
+}
 
-       defer func() {
-               flush()
-               device.log.Verbosef("%v - Routine: nonce worker - stopped", peer)
-               peer.queue.packetInNonceQueueIsAwaitingKey.Set(false)
-               device.queue.encryption.wg.Done() // no more writes from us
-               close(peer.queue.outbound)        // no more writes to this channel
-               peer.routines.stopping.Done()
-       }()
+func (peer *Peer) SendStagedPackets() {
+top:
+       if len(peer.queue.staged) == 0 || !peer.device.isUp.Get() {
+               return
+       }
 
-       device.log.Verbosef("%v - Routine: nonce worker - started", peer)
+       keypair := peer.keypairs.Current()
+       if keypair == nil || atomic.LoadUint64(&keypair.sendNonce) >= RejectAfterMessages || time.Since(keypair.created) >= RejectAfterTime {
+               peer.SendHandshakeInitiation(false)
+               return
+       }
+       peer.device.queue.encryption.wg.Add(1)
+       defer peer.device.queue.encryption.wg.Done()
 
-NextPacket:
        for {
-               peer.queue.packetInNonceQueueIsAwaitingKey.Set(false)
-
                select {
-               case <-peer.routines.stop:
-                       return
-
-               case <-peer.signals.flushNonceQueue:
-                       flush()
-                       continue NextPacket
-
-               case elem, ok := <-peer.queue.nonce:
-
-                       if !ok {
-                               return
-                       }
-
-                       // make sure to always pick the newest key
-
-                       for {
-
-                               // check validity of newest key pair
-
-                               keypair = peer.keypairs.Current()
-                               if keypair != nil && atomic.LoadUint64(&keypair.sendNonce) < RejectAfterMessages {
-                                       if time.Since(keypair.created) < RejectAfterTime {
-                                               break
-                                       }
-                               }
-                               peer.queue.packetInNonceQueueIsAwaitingKey.Set(true)
-
-                               // no suitable key pair, request for new handshake
-
-                               select {
-                               case <-peer.signals.newKeypairArrived:
-                               default:
-                               }
-
-                               peer.SendHandshakeInitiation(false)
-
-                               // wait for key to be established
-
-                               device.log.Verbosef("%v - Awaiting keypair", peer)
-
-                               select {
-                               case <-peer.signals.newKeypairArrived:
-                                       device.log.Verbosef("%v - Obtained awaited keypair", peer)
-
-                               case <-peer.signals.flushNonceQueue:
-                                       device.PutMessageBuffer(elem.buffer)
-                                       device.PutOutboundElement(elem)
-                                       flush()
-                                       continue NextPacket
-
-                               case <-peer.routines.stop:
-                                       device.PutMessageBuffer(elem.buffer)
-                                       device.PutOutboundElement(elem)
-                                       return
-                               }
-                       }
-                       peer.queue.packetInNonceQueueIsAwaitingKey.Set(false)
-
-                       // populate work element
-
+               case elem := <-peer.queue.staged:
                        elem.peer = peer
                        elem.nonce = atomic.AddUint64(&keypair.sendNonce, 1) - 1
-
-                       // double check in case of race condition added by future code
-
                        if elem.nonce >= RejectAfterMessages {
                                atomic.StoreUint64(&keypair.sendNonce, RejectAfterMessages)
-                               device.PutMessageBuffer(elem.buffer)
-                               device.PutOutboundElement(elem)
-                               continue NextPacket
+                               peer.StagePacket(elem) // XXX: Out of order, but we can't front-load go chans
+                               goto top
                        }
 
                        elem.keypair = keypair
@@ -424,7 +326,21 @@ NextPacket:
 
                        // add to parallel and sequential queue
                        peer.queue.outbound <- elem
-                       device.queue.encryption.c <- elem
+                       peer.device.queue.encryption.c <- elem
+               default:
+                       return
+               }
+       }
+}
+
+func (peer *Peer) FlushStagedPackets() {
+       for {
+               select {
+               case elem := <-peer.queue.staged:
+                       peer.device.PutMessageBuffer(elem.buffer)
+                       peer.device.PutOutboundElement(elem)
+               default:
+                       return
                }
        }
 }
index 25bef8c53b6ee9f2d1694da0ed9c109fb08489c1..0678f1e0cc3b46b499495a7adc7f3c7d09ff4750 100644 (file)
@@ -87,7 +87,7 @@ func expiredRetransmitHandshake(peer *Peer) {
                /* We drop all packets without a keypair and don't try again,
                 * if we try unsuccessfully for too long to make a handshake.
                 */
-               peer.FlushNonceQueue()
+               peer.FlushStagedPackets()
 
                /* We set a timer for destroying any residue that might be left
                 * of a partial exchange.
index cbfe25ef631313c50092ce79e0614a51572a46d0..bfef8779da5ca7293f53b941a9b03852ab5abab9 100644 (file)
@@ -156,6 +156,7 @@ func (device *Device) IpcSetOperation(r io.Reader) (err error) {
                        if deviceConfig {
                                deviceConfig = false
                        }
+                       peer.handlePostConfig()
                        // Load/create the peer we are now configuring.
                        err := device.handlePublicKeyLine(peer, value)
                        if err != nil {
@@ -174,6 +175,7 @@ func (device *Device) IpcSetOperation(r io.Reader) (err error) {
                        return err
                }
        }
+       peer.handlePostConfig()
 
        if err := scanner.Err(); err != nil {
                return ipcErrorf(ipc.IpcErrorIO, "failed to read input: %w", err)
@@ -241,6 +243,12 @@ type ipcSetPeer struct {
        created bool // new reports whether this is a newly created peer
 }
 
+func (peer *ipcSetPeer) handlePostConfig() {
+       if peer.Peer != nil && !peer.dummy && peer.Peer.device.isUp.Get() {
+               peer.SendStagedPackets()
+       }
+}
+
 func (device *Device) handlePublicKeyLine(peer *ipcSetPeer, value string) error {
        // Load/create the peer we are configuring.
        var publicKey NoisePublicKey