homelab/traefik
1
0
Fork 0
Code Activity

Feature: add udp timeout configuration

Browse source
This commit is contained in:
Linden Krouse 2021-01-07 11:16:03 -05:00 • committed by GitHub
parent e5a01c7cc8
commit fc7ec17905
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 98 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

14
pkg/config/static/entrypoints.go
View file

@ -5,6 +5,7 @@ import (
"math"
"strings"
ptypes "github.com/traefik/paerser/types"
"github.com/traefik/traefik/v2/pkg/types"
)
@ -16,6 +17,7 @@ type EntryPoint struct {
ForwardedHeaders *ForwardedHeaders `description:"Trust client forwarding headers." json:"forwardedHeaders,omitempty" toml:"forwardedHeaders,omitempty" yaml:"forwardedHeaders,omitempty" export:"true"`
HTTP HTTPConfig `description:"HTTP configuration." json:"http,omitempty" toml:"http,omitempty" yaml:"http,omitempty" export:"true"`
EnableHTTP3 bool `description:"Enable HTTP3." json:"enableHTTP3,omitempty" toml:"enableHTTP3,omitempty" yaml:"enableHTTP3,omitempty" export:"true"`
UDP *UDPConfig `description:"UDP configuration." json:"udp,omitempty" toml:"udp,omitempty" yaml:"udp,omitempty"`
}
// GetAddress strips any potential protocol part of the address field of the
@ -46,6 +48,8 @@ func (ep *EntryPoint) SetDefaults() {
ep.Transport = &EntryPointsTransport{}
ep.Transport.SetDefaults()
ep.ForwardedHeaders = &ForwardedHeaders{}
ep.UDP = &UDPConfig{}
ep.UDP.SetDefaults()
}
// HTTPConfig is the HTTP configuration of an entry point.
@ -110,3 +114,13 @@ func (t *EntryPointsTransport) SetDefaults() {
t.RespondingTimeouts = &RespondingTimeouts{}
t.RespondingTimeouts.SetDefaults()
}
// UDPConfig is the UDP configuration of an entry point.
type UDPConfig struct {
Timeout ptypes.Duration `description:"Timeout defines how long to wait on an idle session before releasing the related resources." json:"timeout,omitempty" toml:"timeout,omitempty" yaml:"timeout,omitempty"`
}
// SetDefaults sets the default values.
func (u *UDPConfig) SetDefaults() {
u.Timeout = ptypes.Duration(DefaultUDPTimeout)
}

4
pkg/config/static/static_config.go
View file

@ -51,6 +51,10 @@ const (
// DefaultAcmeCAServer is the default ACME API endpoint.
DefaultAcmeCAServer = "https://acme-v02.api.letsencrypt.org/directory"
// DefaultUDPTimeout defines how long to wait by default on an idle session,
// before releasing all resources related to that session.
DefaultUDPTimeout = 3 * time.Second
)
// Configuration is the static configuration.

3
pkg/server/server_entrypoint_udp.go
View file

@ -89,7 +89,8 @@ func NewUDPEntryPoint(cfg *static.EntryPoint) (*UDPEntryPoint, error) {
if err != nil {
return nil, err
}
listener, err := udp.Listen("udp", addr)
listener, err := udp.Listen("udp", addr, time.Duration(cfg.UDP.Timeout))
if err != nil {
return nil, err
}

7
pkg/server/server_entrypoint_udp_test.go
View file

@ -14,14 +14,17 @@ import (
)
func TestShutdownUDPConn(t *testing.T) {
entryPoint, err := NewUDPEntryPoint(&static.EntryPoint{
ep := static.EntryPoint{
Address: ":0",
Transport: &static.EntryPointsTransport{
LifeCycle: &static.LifeCycle{
GraceTimeOut: ptypes.Duration(5 * time.Second),
},
},
})
}
ep.SetDefaults()
entryPoint, err := NewUDPEntryPoint(&ep)
require.NoError(t, err)
go entryPoint.Start(context.Background())

25
pkg/udp/conn.go
View file

@ -12,12 +12,6 @@ const receiveMTU = 8192
const closeRetryInterval = 500 * time.Millisecond
// connTimeout determines how long to wait on an idle session,
// before releasing all resources related to that session.
const connTimeout = 3 * time.Second
var timeoutTicker = connTimeout / 10
var errClosedListener = errors.New("udp: listener closed")
// Listener augments a session-oriented Listener over a UDP PacketConn.
@ -31,10 +25,18 @@ type Listener struct {
accepting bool
acceptCh chan *Conn // no need for a Once, already indirectly guarded by accepting.
// timeout defines how long to wait on an idle session,
// before releasing its related resources.
timeout time.Duration
}
// Listen creates a new listener.
func Listen(network string, laddr *net.UDPAddr) (*Listener, error) {
func Listen(network string, laddr *net.UDPAddr, timeout time.Duration) (*Listener, error) {
if timeout <= 0 {
return nil, errors.New("timeout should be greater than zero")
}
conn, err := net.ListenUDP(network, laddr)
if err != nil {
return nil, err
@ -45,6 +47,7 @@ func Listen(network string, laddr *net.UDPAddr) (*Listener, error) {
acceptCh: make(chan *Conn),
conns: make(map[string]*Conn),
accepting: true,
timeout: timeout,
}
go l.readLoop()
@ -179,7 +182,7 @@ func (l *Listener) newConn(rAddr net.Addr) *Conn {
readCh: make(chan []byte),
sizeCh: make(chan int),
doneCh: make(chan struct{}),
timeout: timeoutTicker,
timeout: l.timeout,
}
}
@ -206,7 +209,7 @@ type Conn struct {
// that is to say it waits on readCh to receive the slice of bytes that the Read operation wants to read onto.
// The Read operation receives the signal that the data has been written to the slice of bytes through the sizeCh.
func (c *Conn) readLoop() {
ticker := time.NewTicker(c.timeout)
ticker := time.NewTicker(c.timeout / 10)
defer ticker.Stop()
for {
@ -216,7 +219,7 @@ func (c *Conn) readLoop() {
c.msgs = append(c.msgs, msg)
case <-ticker.C:
c.muActivity.RLock()
deadline := c.lastActivity.Add(connTimeout)
deadline := c.lastActivity.Add(c.timeout)
c.muActivity.RUnlock()
if time.Now().After(deadline) {
c.Close()
@ -236,7 +239,7 @@ func (c *Conn) readLoop() {
c.msgs = append(c.msgs, msg)
case <-ticker.C:
c.muActivity.RLock()
deadline := c.lastActivity.Add(connTimeout)
deadline := c.lastActivity.Add(c.timeout)
c.muActivity.RUnlock()
if time.Now().After(deadline) {
c.Close()

18
pkg/udp/conn_test.go
View file

@ -15,7 +15,7 @@ func TestConsecutiveWrites(t *testing.T) {
addr, err := net.ResolveUDPAddr("udp", ":0")
require.NoError(t, err)
ln, err := Listen("udp", addr)
ln, err := Listen("udp", addr, 3*time.Second)
require.NoError(t, err)
defer func() {
err := ln.Close()
@ -77,7 +77,7 @@ func TestListenNotBlocking(t *testing.T) {
require.NoError(t, err)
ln, err := Listen("udp", addr)
ln, err := Listen("udp", addr, 3*time.Second)
require.NoError(t, err)
defer func() {
err := ln.Close()
@ -162,6 +162,14 @@ func TestListenNotBlocking(t *testing.T) {
}
}
func TestListenWithZeroTimeout(t *testing.T) {
addr, err := net.ResolveUDPAddr("udp", ":0")
require.NoError(t, err)
_, err = Listen("udp", addr, 0)
assert.Error(t, err)
}
func TestTimeoutWithRead(t *testing.T) {
testTimeout(t, true)
}
@ -176,7 +184,7 @@ func testTimeout(t *testing.T, withRead bool) {
addr, err := net.ResolveUDPAddr("udp", ":0")
require.NoError(t, err)
ln, err := Listen("udp", addr)
ln, err := Listen("udp", addr, 3*time.Second)
require.NoError(t, err)
defer func() {
err := ln.Close()
@ -212,7 +220,7 @@ func testTimeout(t *testing.T, withRead bool) {
assert.Equal(t, 10, len(ln.conns))
time.Sleep(4 * time.Second)
time.Sleep(ln.timeout + time.Second)
assert.Equal(t, 0, len(ln.conns))
}
@ -220,7 +228,7 @@ func TestShutdown(t *testing.T) {
addr, err := net.ResolveUDPAddr("udp", ":0")
require.NoError(t, err)
l, err := Listen("udp", addr)
l, err := Listen("udp", addr, 3*time.Second)
require.NoError(t, err)
go func() {

2
pkg/udp/proxy_test.go
View file

@ -46,7 +46,7 @@ func newServer(t *testing.T, addr string, handler Handler) {
addrL, err := net.ResolveUDPAddr("udp", addr)
require.NoError(t, err)
listener, err := Listen("udp", addrL)
listener, err := Listen("udp", addrL, 3*time.Second)
require.NoError(t, err)
for {