mirror of https://github.com/tailscale/tailscale/
net/connstats: invert network logging data flow (#6272)
Previously, tstun.Wrapper and magicsock.Conn managed their own statistics data structure and relied on an external call to Extract to extract (and reset) the statistics. This makes it difficult to ensure a maximum size on the statistics as the caller has no introspection into whether the number of unique connections is getting too large. Invert the control flow such that a *connstats.Statistics is registered with tstun.Wrapper and magicsock.Conn. Methods on non-nil *connstats.Statistics are called for every packet. This allows the implementation of connstats.Statistics (in the future) to better control when it needs to flush to ensure bounds on maximum sizes. The value registered into tstun.Wrapper and magicsock.Conn could be an interface, but that has two performance detriments: 1. Method calls on interface values are more expensive since they must go through a virtual method dispatch. 2. The implementation would need a sync.Mutex to protect the statistics value instead of using an atomic.Pointer. Given that methods on constats.Statistics are called for every packet, we want reduce the CPU cost on this hot path. Signed-off-by: Joe Tsai <joetsai@digital-static.net>pull/6548/head
Joe Tsai
2 years ago
committed by
GitHub
parent
35c10373b5
commit
2e5d08ec4f
@ -0,0 +1,109 @@
|
|||||||
|
// Copyright (c) 2022 Tailscale Inc & AUTHORS All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
// Package connstats maintains statistics about connections
|
||||||
|
// flowing through a TUN device (which operate at the IP layer).
|
||||||
|
package connstats
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/netip"
|
||||||
|
"sync"
|
||||||
|
|
||||||
|
"tailscale.com/net/packet"
|
||||||
|
"tailscale.com/types/netlogtype"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Statistics maintains counters for every connection.
|
||||||
|
// All methods are safe for concurrent use.
|
||||||
|
// The zero value is ready for use.
|
||||||
|
type Statistics struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
virtual map[netlogtype.Connection]netlogtype.Counts
|
||||||
|
physical map[netlogtype.Connection]netlogtype.Counts
|
||||||
|
}
|
||||||
|
|
||||||
|
// UpdateTxVirtual updates the counters for a transmitted IP packet
|
||||||
|
// The source and destination of the packet directly correspond with
|
||||||
|
// the source and destination in netlogtype.Connection.
|
||||||
|
func (s *Statistics) UpdateTxVirtual(b []byte) {
|
||||||
|
s.updateVirtual(b, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UpdateRxVirtual updates the counters for a received IP packet.
|
||||||
|
// The source and destination of the packet are inverted with respect to
|
||||||
|
// the source and destination in netlogtype.Connection.
|
||||||
|
func (s *Statistics) UpdateRxVirtual(b []byte) {
|
||||||
|
s.updateVirtual(b, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Statistics) updateVirtual(b []byte, receive bool) {
|
||||||
|
var p packet.Parsed
|
||||||
|
p.Decode(b)
|
||||||
|
conn := netlogtype.Connection{Proto: p.IPProto, Src: p.Src, Dst: p.Dst}
|
||||||
|
if receive {
|
||||||
|
conn.Src, conn.Dst = conn.Dst, conn.Src
|
||||||
|
}
|
||||||
|
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
if s.virtual == nil {
|
||||||
|
s.virtual = make(map[netlogtype.Connection]netlogtype.Counts)
|
||||||
|
}
|
||||||
|
cnts := s.virtual[conn]
|
||||||
|
if receive {
|
||||||
|
cnts.RxPackets++
|
||||||
|
cnts.RxBytes += uint64(len(b))
|
||||||
|
} else {
|
||||||
|
cnts.TxPackets++
|
||||||
|
cnts.TxBytes += uint64(len(b))
|
||||||
|
}
|
||||||
|
s.virtual[conn] = cnts
|
||||||
|
}
|
||||||
|
|
||||||
|
// UpdateTxPhysical updates the counters for a transmitted wireguard packet
|
||||||
|
// The src is always a Tailscale IP address, representing some remote peer.
|
||||||
|
// The dst is a remote IP address and port that corresponds
|
||||||
|
// with some physical peer backing the Tailscale IP address.
|
||||||
|
func (s *Statistics) UpdateTxPhysical(src netip.Addr, dst netip.AddrPort, n int) {
|
||||||
|
s.updatePhysical(src, dst, n, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UpdateRxPhysical updates the counters for a received wireguard packet.
|
||||||
|
// The src is always a Tailscale IP address, representing some remote peer.
|
||||||
|
// The dst is a remote IP address and port that corresponds
|
||||||
|
// with some physical peer backing the Tailscale IP address.
|
||||||
|
func (s *Statistics) UpdateRxPhysical(src netip.Addr, dst netip.AddrPort, n int) {
|
||||||
|
s.updatePhysical(src, dst, n, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Statistics) updatePhysical(src netip.Addr, dst netip.AddrPort, n int, receive bool) {
|
||||||
|
conn := netlogtype.Connection{Src: netip.AddrPortFrom(src, 0), Dst: dst}
|
||||||
|
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
if s.physical == nil {
|
||||||
|
s.physical = make(map[netlogtype.Connection]netlogtype.Counts)
|
||||||
|
}
|
||||||
|
cnts := s.physical[conn]
|
||||||
|
if receive {
|
||||||
|
cnts.RxPackets++
|
||||||
|
cnts.RxBytes += uint64(n)
|
||||||
|
} else {
|
||||||
|
cnts.TxPackets++
|
||||||
|
cnts.TxBytes += uint64(n)
|
||||||
|
}
|
||||||
|
s.physical[conn] = cnts
|
||||||
|
}
|
||||||
|
|
||||||
|
// Extract extracts and resets the counters for all active connections.
|
||||||
|
// It must be called periodically otherwise the memory used is unbounded.
|
||||||
|
func (s *Statistics) Extract() (virtual, physical map[netlogtype.Connection]netlogtype.Counts) {
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
virtual = s.virtual
|
||||||
|
s.virtual = make(map[netlogtype.Connection]netlogtype.Counts)
|
||||||
|
physical = s.physical
|
||||||
|
s.physical = make(map[netlogtype.Connection]netlogtype.Counts)
|
||||||
|
return virtual, physical
|
||||||
|
}
|
||||||
@ -1,70 +0,0 @@
|
|||||||
// Copyright (c) 2022 Tailscale Inc & AUTHORS All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// Package tunstats maintains statistics about connections
|
|
||||||
// flowing through a TUN device (which operate at the IP layer).
|
|
||||||
package tunstats
|
|
||||||
|
|
||||||
import (
|
|
||||||
"sync"
|
|
||||||
|
|
||||||
"tailscale.com/net/packet"
|
|
||||||
"tailscale.com/types/netlogtype"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Statistics maintains counters for every connection.
|
|
||||||
// All methods are safe for concurrent use.
|
|
||||||
// The zero value is ready for use.
|
|
||||||
type Statistics struct {
|
|
||||||
mu sync.Mutex
|
|
||||||
m map[netlogtype.Connection]netlogtype.Counts
|
|
||||||
}
|
|
||||||
|
|
||||||
// UpdateTx updates the counters for a transmitted IP packet
|
|
||||||
// The source and destination of the packet directly correspond with
|
|
||||||
// the source and destination in netlogtype.Connection.
|
|
||||||
func (s *Statistics) UpdateTx(b []byte) {
|
|
||||||
s.update(b, false)
|
|
||||||
}
|
|
||||||
|
|
||||||
// UpdateRx updates the counters for a received IP packet.
|
|
||||||
// The source and destination of the packet are inverted with respect to
|
|
||||||
// the source and destination in netlogtype.Connection.
|
|
||||||
func (s *Statistics) UpdateRx(b []byte) {
|
|
||||||
s.update(b, true)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Statistics) update(b []byte, receive bool) {
|
|
||||||
var p packet.Parsed
|
|
||||||
p.Decode(b)
|
|
||||||
conn := netlogtype.Connection{Proto: p.IPProto, Src: p.Src, Dst: p.Dst}
|
|
||||||
if receive {
|
|
||||||
conn.Src, conn.Dst = conn.Dst, conn.Src
|
|
||||||
}
|
|
||||||
|
|
||||||
s.mu.Lock()
|
|
||||||
defer s.mu.Unlock()
|
|
||||||
if s.m == nil {
|
|
||||||
s.m = make(map[netlogtype.Connection]netlogtype.Counts)
|
|
||||||
}
|
|
||||||
cnts := s.m[conn]
|
|
||||||
if receive {
|
|
||||||
cnts.RxPackets++
|
|
||||||
cnts.RxBytes += uint64(len(b))
|
|
||||||
} else {
|
|
||||||
cnts.TxPackets++
|
|
||||||
cnts.TxBytes += uint64(len(b))
|
|
||||||
}
|
|
||||||
s.m[conn] = cnts
|
|
||||||
}
|
|
||||||
|
|
||||||
// Extract extracts and resets the counters for all active connections.
|
|
||||||
// It must be called periodically otherwise the memory used is unbounded.
|
|
||||||
func (s *Statistics) Extract() map[netlogtype.Connection]netlogtype.Counts {
|
|
||||||
s.mu.Lock()
|
|
||||||
defer s.mu.Unlock()
|
|
||||||
m := s.m
|
|
||||||
s.m = make(map[netlogtype.Connection]netlogtype.Counts)
|
|
||||||
return m
|
|
||||||
}
|
|
||||||
@ -1,66 +0,0 @@
|
|||||||
// Copyright (c) 2022 Tailscale Inc & AUTHORS All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
package netlog
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"net/http"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
qt "github.com/frankban/quicktest"
|
|
||||||
"tailscale.com/logtail"
|
|
||||||
"tailscale.com/tstest"
|
|
||||||
"tailscale.com/types/netlogtype"
|
|
||||||
"tailscale.com/util/must"
|
|
||||||
"tailscale.com/wgengine/router"
|
|
||||||
)
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
testClient = &http.Client{Transport: &roundTripper}
|
|
||||||
}
|
|
||||||
|
|
||||||
var roundTripper roundTripperFunc
|
|
||||||
|
|
||||||
type roundTripperFunc struct {
|
|
||||||
F func(*http.Request) (*http.Response, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f roundTripperFunc) RoundTrip(r *http.Request) (*http.Response, error) {
|
|
||||||
return f.F(r)
|
|
||||||
}
|
|
||||||
|
|
||||||
type fakeDevice struct {
|
|
||||||
toggled int // even => disabled, odd => enabled
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *fakeDevice) SetStatisticsEnabled(enable bool) {
|
|
||||||
if enabled := d.toggled%2 == 1; enabled != enable {
|
|
||||||
d.toggled++
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
func (fakeDevice) ExtractStatistics() map[netlogtype.Connection]netlogtype.Counts {
|
|
||||||
// TODO(dsnet): Add a test that verifies that statistics are correctly
|
|
||||||
// extracted from the device and uploaded. Unfortunately,
|
|
||||||
// we can't reliably run this test until we fix http://go/oss/5856.
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestResourceCheck(t *testing.T) {
|
|
||||||
roundTripper.F = func(r *http.Request) (*http.Response, error) {
|
|
||||||
return &http.Response{StatusCode: 200}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
c := qt.New(t)
|
|
||||||
tstest.ResourceCheck(t)
|
|
||||||
var l Logger
|
|
||||||
var d fakeDevice
|
|
||||||
for i := 0; i < 10; i++ {
|
|
||||||
must.Do(l.Startup("", logtail.PrivateID{}, logtail.PrivateID{}, &d, nil))
|
|
||||||
l.ReconfigRoutes(&router.Config{})
|
|
||||||
must.Do(l.Shutdown(context.Background()))
|
|
||||||
c.Assert(d.toggled, qt.Equals, 2*(i+1))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Loading…
Reference in New Issue