net: support TCP_KEEPIDLE, TCP_KEEPINTVL and TCP_KEEPCNT on newer Windows

Follows up CL 542275

Fixes #65817

Change-Id: I0b77c23f15d595d58492dfa20839a08e8670448b
Reviewed-on: https://go-review.googlesource.com/c/go/+/565495
Reviewed-by: Quim Muntal <quimmuntal@gmail.com>
Reviewed-by: Michael Knyszek <mknyszek@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Damien Neil <dneil@google.com>
This commit is contained in:
Andy Pan 2024-02-21 02:30:42 +08:00 committed by Quim Muntal
parent 997636760e
commit 1cce1a6a11
16 changed files with 311 additions and 275 deletions

View File

@ -0,0 +1 @@
The [`GetsockoptInt`](/syscall#GetsockoptInt) function is now supported on Windows.

View File

@ -0,0 +1,12 @@
// Copyright 2024 The Go 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 windows
// Socket related.
const (
TCP_KEEPIDLE = 0x03
TCP_KEEPCNT = 0x10
TCP_KEEPINTVL = 0x11
)

View File

@ -0,0 +1,24 @@
// Copyright 2024 The Go 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 windows
import "sync"
// Version retrieves the major, minor, and build version numbers
// of the current Windows OS from the RtlGetNtVersionNumbers API
// and parse the results properly.
func Version() (major, minor, build uint32) {
rtlGetNtVersionNumbers(&major, &minor, &build)
build &= 0x7fff
return
}
// SupportFullTCPKeepAlive indicates whether the current Windows version
// supports the full TCP keep-alive configurations, the minimal requirement
// is Windows 10, version 1709.
var SupportFullTCPKeepAlive = sync.OnceValue(func() bool {
major, _, build := Version()
return major >= 10 && build >= 16299
})

View File

@ -0,0 +1,22 @@
// Copyright 2024 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
//go:build darwin
package net
import (
"syscall"
"testing"
)
const (
syscall_TCP_KEEPIDLE = syscall.TCP_KEEPALIVE
syscall_TCP_KEEPCNT = sysTCP_KEEPCNT
syscall_TCP_KEEPINTVL = sysTCP_KEEPINTVL
)
type fdType = int
func maybeSkipKeepAliveTest(_ *testing.T) {}

View File

@ -0,0 +1,102 @@
// Copyright 2024 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
//go:build aix || darwin || dragonfly || freebsd || linux || netbsd || windows
package net
import "time"
var testConfigs = []KeepAliveConfig{
{
Enable: true,
Idle: 5 * time.Second,
Interval: 3 * time.Second,
Count: 10,
},
{
Enable: true,
Idle: 0,
Interval: 0,
Count: 0,
},
{
Enable: true,
Idle: -1,
Interval: -1,
Count: -1,
},
{
Enable: true,
Idle: -1,
Interval: 3 * time.Second,
Count: 10,
},
{
Enable: true,
Idle: 5 * time.Second,
Interval: -1,
Count: 10,
},
{
Enable: true,
Idle: 5 * time.Second,
Interval: 3 * time.Second,
Count: -1,
},
{
Enable: true,
Idle: -1,
Interval: -1,
Count: 10,
},
{
Enable: true,
Idle: -1,
Interval: 3 * time.Second,
Count: -1,
},
{
Enable: true,
Idle: 5 * time.Second,
Interval: -1,
Count: -1,
},
{
Enable: true,
Idle: 0,
Interval: 3 * time.Second,
Count: 10,
},
{
Enable: true,
Idle: 5 * time.Second,
Interval: 0,
Count: 10,
},
{
Enable: true,
Idle: 5 * time.Second,
Interval: 3 * time.Second,
Count: 0,
},
{
Enable: true,
Idle: 0,
Interval: 0,
Count: 10,
},
{
Enable: true,
Idle: 0,
Interval: 3 * time.Second,
Count: 0,
},
{
Enable: true,
Idle: 5 * time.Second,
Interval: 0,
Count: 0,
},
}

View File

@ -2,101 +2,28 @@
// Use of this source code is governed by a BSD-style // Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
//go:build aix || freebsd || linux || netbsd || darwin || dragonfly //go:build aix || dragonfly || freebsd || linux || netbsd || solaris
package net package net
import "time" import (
"runtime"
"syscall"
"testing"
)
var testConfigs = []KeepAliveConfig{ const (
{ syscall_TCP_KEEPIDLE = syscall.TCP_KEEPIDLE
Enable: true, syscall_TCP_KEEPCNT = syscall.TCP_KEEPCNT
Idle: 5 * time.Second, syscall_TCP_KEEPINTVL = syscall.TCP_KEEPINTVL
Interval: 3 * time.Second, )
Count: 10,
}, type fdType = int
{
Enable: true, func maybeSkipKeepAliveTest(t *testing.T) {
Idle: 0, // TODO(panjf2000): stop skipping this test on Solaris
Interval: 0, // when https://go.dev/issue/64251 is fixed.
Count: 0, if runtime.GOOS == "solaris" {
}, t.Skip("skipping on solaris for now")
{ }
Enable: true,
Idle: -1,
Interval: -1,
Count: -1,
},
{
Enable: true,
Idle: -1,
Interval: 3 * time.Second,
Count: 10,
},
{
Enable: true,
Idle: 5 * time.Second,
Interval: -1,
Count: 10,
},
{
Enable: true,
Idle: 5 * time.Second,
Interval: 3 * time.Second,
Count: -1,
},
{
Enable: true,
Idle: -1,
Interval: -1,
Count: 10,
},
{
Enable: true,
Idle: -1,
Interval: 3 * time.Second,
Count: -1,
},
{
Enable: true,
Idle: 5 * time.Second,
Interval: -1,
Count: -1,
},
{
Enable: true,
Idle: 0,
Interval: 3 * time.Second,
Count: 10,
},
{
Enable: true,
Idle: 5 * time.Second,
Interval: 0,
Count: 10,
},
{
Enable: true,
Idle: 5 * time.Second,
Interval: 3 * time.Second,
Count: 0,
},
{
Enable: true,
Idle: 0,
Interval: 0,
Count: 10,
},
{
Enable: true,
Idle: 0,
Interval: 3 * time.Second,
Count: 0,
},
{
Enable: true,
Idle: 5 * time.Second,
Interval: 0,
Count: 0,
},
} }

View File

@ -0,0 +1,31 @@
// Copyright 2024 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
//go:build windows
package net
import (
"internal/syscall/windows"
"syscall"
"testing"
)
const (
syscall_TCP_KEEPIDLE = windows.TCP_KEEPIDLE
syscall_TCP_KEEPCNT = windows.TCP_KEEPCNT
syscall_TCP_KEEPINTVL = windows.TCP_KEEPINTVL
)
type fdType = syscall.Handle
func maybeSkipKeepAliveTest(t *testing.T) {
// TODO(panjf2000): Unlike Unix-like OS's, old Windows (prior to Windows 10, version 1709)
// doesn't provide any ways to retrieve the current TCP keep-alive settings, therefore
// we're not able to run the test suite similar to Unix-like OS's on Windows.
// Try to find another proper approach to test the keep-alive settings on old Windows.
if !windows.SupportFullTCPKeepAlive() {
t.Skip("skipping on windows")
}
}

View File

@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style // Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
//go:build darwin //go:build aix || darwin || dragonfly || freebsd || linux || netbsd || windows
package net package net
@ -12,20 +12,20 @@ import (
"time" "time"
) )
func getCurrentKeepAliveSettings(fd int) (cfg KeepAliveConfig, err error) { func getCurrentKeepAliveSettings(fd fdType) (cfg KeepAliveConfig, err error) {
tcpKeepAlive, err := syscall.GetsockoptInt(fd, syscall.SOL_SOCKET, syscall.SO_KEEPALIVE) tcpKeepAlive, err := syscall.GetsockoptInt(fd, syscall.SOL_SOCKET, syscall.SO_KEEPALIVE)
if err != nil { if err != nil {
return return
} }
tcpKeepAliveIdle, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall.TCP_KEEPALIVE) tcpKeepAliveIdle, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall_TCP_KEEPIDLE)
if err != nil { if err != nil {
return return
} }
tcpKeepAliveInterval, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, sysTCP_KEEPINTVL) tcpKeepAliveInterval, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall_TCP_KEEPINTVL)
if err != nil { if err != nil {
return return
} }
tcpKeepAliveCount, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, sysTCP_KEEPCNT) tcpKeepAliveCount, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall_TCP_KEEPCNT)
if err != nil { if err != nil {
return return
} }
@ -38,7 +38,7 @@ func getCurrentKeepAliveSettings(fd int) (cfg KeepAliveConfig, err error) {
return return
} }
func verifyKeepAliveSettings(t *testing.T, fd int, oldCfg, cfg KeepAliveConfig) { func verifyKeepAliveSettings(t *testing.T, fd fdType, oldCfg, cfg KeepAliveConfig) {
if cfg.Idle == 0 { if cfg.Idle == 0 {
cfg.Idle = defaultTCPKeepAliveIdle cfg.Idle = defaultTCPKeepAliveIdle
} }
@ -66,7 +66,7 @@ func verifyKeepAliveSettings(t *testing.T, fd int, oldCfg, cfg KeepAliveConfig)
t.Fatalf("SO_KEEPALIVE: got %t; want %t", tcpKeepAlive != 0, cfg.Enable) t.Fatalf("SO_KEEPALIVE: got %t; want %t", tcpKeepAlive != 0, cfg.Enable)
} }
tcpKeepAliveIdle, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall.TCP_KEEPALIVE) tcpKeepAliveIdle, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall_TCP_KEEPIDLE)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
@ -74,7 +74,7 @@ func verifyKeepAliveSettings(t *testing.T, fd int, oldCfg, cfg KeepAliveConfig)
t.Fatalf("TCP_KEEPIDLE: got %ds; want %v", tcpKeepAliveIdle, cfg.Idle) t.Fatalf("TCP_KEEPIDLE: got %ds; want %v", tcpKeepAliveIdle, cfg.Idle)
} }
tcpKeepAliveInterval, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, sysTCP_KEEPINTVL) tcpKeepAliveInterval, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall_TCP_KEEPINTVL)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
@ -82,7 +82,7 @@ func verifyKeepAliveSettings(t *testing.T, fd int, oldCfg, cfg KeepAliveConfig)
t.Fatalf("TCP_KEEPINTVL: got %ds; want %v", tcpKeepAliveInterval, cfg.Interval) t.Fatalf("TCP_KEEPINTVL: got %ds; want %v", tcpKeepAliveInterval, cfg.Interval)
} }
tcpKeepAliveCount, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, sysTCP_KEEPCNT) tcpKeepAliveCount, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall_TCP_KEEPCNT)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }

View File

@ -33,7 +33,7 @@ var testConfigs = []KeepAliveConfig{
}, },
} }
func getCurrentKeepAliveSettings(fd int) (cfg KeepAliveConfig, err error) { func getCurrentKeepAliveSettings(fd fdType) (cfg KeepAliveConfig, err error) {
tcpKeepAlive, err := syscall.GetsockoptInt(fd, syscall.SOL_SOCKET, syscall.SO_KEEPALIVE) tcpKeepAlive, err := syscall.GetsockoptInt(fd, syscall.SOL_SOCKET, syscall.SO_KEEPALIVE)
if err != nil { if err != nil {
return return
@ -51,7 +51,7 @@ func getCurrentKeepAliveSettings(fd int) (cfg KeepAliveConfig, err error) {
return return
} }
func verifyKeepAliveSettings(t *testing.T, fd int, oldCfg, cfg KeepAliveConfig) { func verifyKeepAliveSettings(t *testing.T, fd fdType, oldCfg, cfg KeepAliveConfig) {
if cfg.Idle == 0 { if cfg.Idle == 0 {
cfg.Idle = defaultTCPKeepAliveIdle cfg.Idle = defaultTCPKeepAliveIdle
} }

View File

@ -2,21 +2,14 @@
// Use of this source code is governed by a BSD-style // Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
//go:build aix || freebsd || linux || netbsd || dragonfly || darwin || solaris || windows //go:build aix || darwin || dragonfly || freebsd || linux || netbsd || solaris || windows
package net package net
import ( import "testing"
"runtime"
"testing"
)
func TestTCPConnDialerKeepAliveConfig(t *testing.T) { func TestTCPConnKeepAliveConfigDialer(t *testing.T) {
// TODO(panjf2000): stop skipping this test on Solaris maybeSkipKeepAliveTest(t)
// when https://go.dev/issue/64251 is fixed.
if runtime.GOOS == "solaris" {
t.Skip("skipping on solaris for now")
}
t.Cleanup(func() { t.Cleanup(func() {
testPreHookSetKeepAlive = func(*netFD) {} testPreHookSetKeepAlive = func(*netFD) {}
@ -26,7 +19,7 @@ func TestTCPConnDialerKeepAliveConfig(t *testing.T) {
oldCfg KeepAliveConfig oldCfg KeepAliveConfig
) )
testPreHookSetKeepAlive = func(nfd *netFD) { testPreHookSetKeepAlive = func(nfd *netFD) {
oldCfg, errHook = getCurrentKeepAliveSettings(int(nfd.pfd.Sysfd)) oldCfg, errHook = getCurrentKeepAliveSettings(fdType(nfd.pfd.Sysfd))
} }
handler := func(ls *localServer, ln Listener) { handler := func(ls *localServer, ln Listener) {
@ -66,19 +59,15 @@ func TestTCPConnDialerKeepAliveConfig(t *testing.T) {
t.Fatal(err) t.Fatal(err)
} }
if err := sc.Control(func(fd uintptr) { if err := sc.Control(func(fd uintptr) {
verifyKeepAliveSettings(t, int(fd), oldCfg, cfg) verifyKeepAliveSettings(t, fdType(fd), oldCfg, cfg)
}); err != nil { }); err != nil {
t.Fatal(err) t.Fatal(err)
} }
} }
} }
func TestTCPConnListenerKeepAliveConfig(t *testing.T) { func TestTCPConnKeepAliveConfigListener(t *testing.T) {
// TODO(panjf2000): stop skipping this test on Solaris maybeSkipKeepAliveTest(t)
// when https://go.dev/issue/64251 is fixed.
if runtime.GOOS == "solaris" {
t.Skip("skipping on solaris for now")
}
t.Cleanup(func() { t.Cleanup(func() {
testPreHookSetKeepAlive = func(*netFD) {} testPreHookSetKeepAlive = func(*netFD) {}
@ -88,7 +77,7 @@ func TestTCPConnListenerKeepAliveConfig(t *testing.T) {
oldCfg KeepAliveConfig oldCfg KeepAliveConfig
) )
testPreHookSetKeepAlive = func(nfd *netFD) { testPreHookSetKeepAlive = func(nfd *netFD) {
oldCfg, errHook = getCurrentKeepAliveSettings(int(nfd.pfd.Sysfd)) oldCfg, errHook = getCurrentKeepAliveSettings(fdType(nfd.pfd.Sysfd))
} }
ch := make(chan Conn, 1) ch := make(chan Conn, 1)
@ -125,19 +114,15 @@ func TestTCPConnListenerKeepAliveConfig(t *testing.T) {
t.Fatal(err) t.Fatal(err)
} }
if err := sc.Control(func(fd uintptr) { if err := sc.Control(func(fd uintptr) {
verifyKeepAliveSettings(t, int(fd), oldCfg, cfg) verifyKeepAliveSettings(t, fdType(fd), oldCfg, cfg)
}); err != nil { }); err != nil {
t.Fatal(err) t.Fatal(err)
} }
} }
} }
func TestTCPConnSetKeepAliveConfig(t *testing.T) { func TestTCPConnKeepAliveConfig(t *testing.T) {
// TODO(panjf2000): stop skipping this test on Solaris maybeSkipKeepAliveTest(t)
// when https://go.dev/issue/64251 is fixed.
if runtime.GOOS == "solaris" {
t.Skip("skipping on solaris for now")
}
handler := func(ls *localServer, ln Listener) { handler := func(ls *localServer, ln Listener) {
for { for {
@ -174,7 +159,7 @@ func TestTCPConnSetKeepAliveConfig(t *testing.T) {
oldCfg KeepAliveConfig oldCfg KeepAliveConfig
) )
if err := sc.Control(func(fd uintptr) { if err := sc.Control(func(fd uintptr) {
oldCfg, errHook = getCurrentKeepAliveSettings(int(fd)) oldCfg, errHook = getCurrentKeepAliveSettings(fdType(fd))
}); err != nil { }); err != nil {
t.Fatal(err) t.Fatal(err)
} }
@ -187,7 +172,7 @@ func TestTCPConnSetKeepAliveConfig(t *testing.T) {
} }
if err := sc.Control(func(fd uintptr) { if err := sc.Control(func(fd uintptr) {
verifyKeepAliveSettings(t, int(fd), oldCfg, cfg) verifyKeepAliveSettings(t, fdType(fd), oldCfg, cfg)
}); err != nil { }); err != nil {
t.Fatal(err) t.Fatal(err)
} }

View File

@ -1,92 +0,0 @@
// Copyright 2023 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
//go:build aix || dragonfly || freebsd || linux || netbsd
package net
import (
"syscall"
"testing"
"time"
)
func getCurrentKeepAliveSettings(fd int) (cfg KeepAliveConfig, err error) {
tcpKeepAlive, err := syscall.GetsockoptInt(fd, syscall.SOL_SOCKET, syscall.SO_KEEPALIVE)
if err != nil {
return
}
tcpKeepAliveIdle, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall.TCP_KEEPIDLE)
if err != nil {
return
}
tcpKeepAliveInterval, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall.TCP_KEEPINTVL)
if err != nil {
return
}
tcpKeepAliveCount, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall.TCP_KEEPCNT)
if err != nil {
return
}
cfg = KeepAliveConfig{
Enable: tcpKeepAlive != 0,
Idle: time.Duration(tcpKeepAliveIdle) * time.Second,
Interval: time.Duration(tcpKeepAliveInterval) * time.Second,
Count: tcpKeepAliveCount,
}
return
}
func verifyKeepAliveSettings(t *testing.T, fd int, oldCfg, cfg KeepAliveConfig) {
if cfg.Idle == 0 {
cfg.Idle = defaultTCPKeepAliveIdle
}
if cfg.Interval == 0 {
cfg.Interval = defaultTCPKeepAliveInterval
}
if cfg.Count == 0 {
cfg.Count = defaultTCPKeepAliveCount
}
if cfg.Idle == -1 {
cfg.Idle = oldCfg.Idle
}
if cfg.Interval == -1 {
cfg.Interval = oldCfg.Interval
}
if cfg.Count == -1 {
cfg.Count = oldCfg.Count
}
tcpKeepAlive, err := syscall.GetsockoptInt(fd, syscall.SOL_SOCKET, syscall.SO_KEEPALIVE)
if err != nil {
t.Fatal(err)
}
if (tcpKeepAlive != 0) != cfg.Enable {
t.Fatalf("SO_KEEPALIVE: got %t; want %t", tcpKeepAlive != 0, cfg.Enable)
}
tcpKeepAliveIdle, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall.TCP_KEEPIDLE)
if err != nil {
t.Fatal(err)
}
if time.Duration(tcpKeepAliveIdle)*time.Second != cfg.Idle {
t.Fatalf("TCP_KEEPIDLE: got %ds; want %v", tcpKeepAliveIdle, cfg.Idle)
}
tcpKeepAliveInterval, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall.TCP_KEEPINTVL)
if err != nil {
t.Fatal(err)
}
if time.Duration(tcpKeepAliveInterval)*time.Second != cfg.Interval {
t.Fatalf("TCP_KEEPINTVL: got %ds; want %v", tcpKeepAliveInterval, cfg.Interval)
}
tcpKeepAliveCount, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall.TCP_KEEPCNT)
if err != nil {
t.Fatal(err)
}
if tcpKeepAliveCount != cfg.Count {
t.Fatalf("TCP_KEEPCNT: got %d; want %d", tcpKeepAliveCount, cfg.Count)
}
}

View File

@ -1,33 +0,0 @@
// Copyright 2023 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
//go:build windows
package net
import (
"testing"
"time"
)
var testConfigs = []KeepAliveConfig{
{
Enable: true,
Idle: 2 * time.Second,
Interval: time.Second,
Count: -1,
},
}
func getCurrentKeepAliveSettings(_ int) (cfg KeepAliveConfig, err error) {
// TODO(panjf2000): same as verifyKeepAliveSettings.
return
}
func verifyKeepAliveSettings(_ *testing.T, _ int, _, _ KeepAliveConfig) {
// TODO(panjf2000): Unlike Unix-like OS's, Windows doesn't provide
// any ways to retrieve the current TCP keep-alive settings, therefore
// we're not able to run the test suite similar to Unix-like OS's on Windows.
// Try to find another proper approach to test the keep-alive settings on Windows.
}

View File

@ -118,12 +118,14 @@ type TCPConn struct {
// If the Idle, Interval, or Count fields are zero, a default value is chosen. // If the Idle, Interval, or Count fields are zero, a default value is chosen.
// If a field is negative, the corresponding socket-level option will be left unchanged. // If a field is negative, the corresponding socket-level option will be left unchanged.
// //
// Note that Windows doesn't support setting the KeepAliveIdle and KeepAliveInterval separately. // Note that prior to Windows 10 version 1709, neither setting Idle and Interval
// It's recommended to set both Idle and Interval to non-negative values on Windows if you // separately nor changing Count (which is usually 10) is supported.
// intend to customize the TCP keep-alive settings. // Therefore, it's recommended to set both Idle and Interval to non-negative values
// By contrast, if only one of Idle and Interval is set to a non-negative value, the other will // in conjunction with a -1 for Count on those old Windows if you intend to customize
// be set to the system default value, and ultimately, set both Idle and Interval to negative // the TCP keep-alive settings.
// values if you want to leave them unchanged. // By contrast, if only one of Idle and Interval is set to a non-negative value,
// the other will be set to the system default value, and ultimately,
// set both Idle and Interval to negative values if you want to leave them unchanged.
type KeepAliveConfig struct { type KeepAliveConfig struct {
// If Enable is true, keep-alive probes are enabled. // If Enable is true, keep-alive probes are enabled.
Enable bool Enable bool
@ -236,8 +238,8 @@ func (c *TCPConn) SetKeepAlive(keepalive bool) error {
return nil return nil
} }
// SetKeepAlivePeriod sets the idle duration the connection // SetKeepAlivePeriod sets the duration the connection needs to
// needs to remain idle before TCP starts sending keepalive probes. // remain idle before TCP starts sending keepalive probes.
// //
// Note that calling this method on Windows will reset the KeepAliveInterval // Note that calling this method on Windows will reset the KeepAliveInterval
// to the default system value, which is normally 1 second. // to the default system value, which is normally 1 second.

View File

@ -4,7 +4,10 @@
package net package net
import "syscall" import (
"internal/syscall/windows"
"syscall"
)
// SetKeepAliveConfig configures keep-alive messages sent by the operating system. // SetKeepAliveConfig configures keep-alive messages sent by the operating system.
func (c *TCPConn) SetKeepAliveConfig(config KeepAliveConfig) error { func (c *TCPConn) SetKeepAliveConfig(config KeepAliveConfig) error {
@ -15,7 +18,14 @@ func (c *TCPConn) SetKeepAliveConfig(config KeepAliveConfig) error {
if err := setKeepAlive(c.fd, config.Enable); err != nil { if err := setKeepAlive(c.fd, config.Enable); err != nil {
return &OpError{Op: "set", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err} return &OpError{Op: "set", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err}
} }
if err := setKeepAliveIdleAndInterval(c.fd, config.Idle, config.Interval); err != nil { if windows.SupportFullTCPKeepAlive() {
if err := setKeepAliveIdle(c.fd, config.Idle); err != nil {
return &OpError{Op: "set", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err}
}
if err := setKeepAliveInterval(c.fd, config.Interval); err != nil {
return &OpError{Op: "set", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err}
}
} else if err := setKeepAliveIdleAndInterval(c.fd, config.Idle, config.Interval); err != nil {
return &OpError{Op: "set", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err} return &OpError{Op: "set", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err}
} }
if err := setKeepAliveCount(c.fd, config.Count); err != nil { if err := setKeepAliveCount(c.fd, config.Count); err != nil {

View File

@ -5,6 +5,7 @@
package net package net
import ( import (
"internal/syscall/windows"
"os" "os"
"runtime" "runtime"
"syscall" "syscall"
@ -20,22 +21,61 @@ const (
) )
func setKeepAliveIdle(fd *netFD, d time.Duration) error { func setKeepAliveIdle(fd *netFD, d time.Duration) error {
if !windows.SupportFullTCPKeepAlive() {
return setKeepAliveIdleAndInterval(fd, d, -1) return setKeepAliveIdleAndInterval(fd, d, -1)
}
if d == 0 {
d = defaultTCPKeepAliveIdle
} else if d < 0 {
return nil
}
// The kernel expects seconds so round to next highest second.
secs := int(roundDurationUp(d, time.Second))
err := fd.pfd.SetsockoptInt(syscall.IPPROTO_TCP, windows.TCP_KEEPIDLE, secs)
runtime.KeepAlive(fd)
return os.NewSyscallError("setsockopt", err)
} }
func setKeepAliveInterval(fd *netFD, d time.Duration) error { func setKeepAliveInterval(fd *netFD, d time.Duration) error {
if !windows.SupportFullTCPKeepAlive() {
return setKeepAliveIdleAndInterval(fd, -1, d) return setKeepAliveIdleAndInterval(fd, -1, d)
}
if d == 0 {
d = defaultTCPKeepAliveInterval
} else if d < 0 {
return nil
}
// The kernel expects seconds so round to next highest second.
secs := int(roundDurationUp(d, time.Second))
err := fd.pfd.SetsockoptInt(syscall.IPPROTO_TCP, windows.TCP_KEEPINTVL, secs)
runtime.KeepAlive(fd)
return os.NewSyscallError("setsockopt", err)
} }
func setKeepAliveCount(_ *netFD, n int) error { func setKeepAliveCount(fd *netFD, n int) error {
if n < 0 { if n == 0 {
n = defaultTCPKeepAliveCount
} else if n < 0 {
return nil return nil
} }
// This value is not capable to be changed on Windows. // This value is not capable to be changed on old versions of Windows.
if !windows.SupportFullTCPKeepAlive() {
return syscall.WSAENOPROTOOPT return syscall.WSAENOPROTOOPT
}
// It is illegal to set TCP_KEEPCNT to a value greater than 255.
if n > 255 {
return syscall.EINVAL
}
err := fd.pfd.SetsockoptInt(syscall.IPPROTO_TCP, windows.TCP_KEEPCNT, n)
runtime.KeepAlive(fd)
return os.NewSyscallError("setsockopt", err)
} }
// setKeepAliveIdleAndInterval serves for kernels prior to Windows 10, version 1709.
func setKeepAliveIdleAndInterval(fd *netFD, idle, interval time.Duration) error { func setKeepAliveIdleAndInterval(fd *netFD, idle, interval time.Duration) error {
// WSAIoctl with SIO_KEEPALIVE_VALS control code requires all fields in // WSAIoctl with SIO_KEEPALIVE_VALS control code requires all fields in
// `tcp_keepalive` struct to be provided. // `tcp_keepalive` struct to be provided.

View File

@ -1163,7 +1163,12 @@ type IPv6Mreq struct {
Interface uint32 Interface uint32
} }
func GetsockoptInt(fd Handle, level, opt int) (int, error) { return -1, EWINDOWS } func GetsockoptInt(fd Handle, level, opt int) (int, error) {
optval := int32(0)
optlen := int32(unsafe.Sizeof(optval))
err := Getsockopt(fd, int32(level), int32(opt), (*byte)(unsafe.Pointer(&optval)), &optlen)
return int(optval), err
}
func SetsockoptLinger(fd Handle, level, opt int, l *Linger) (err error) { func SetsockoptLinger(fd Handle, level, opt int, l *Linger) (err error) {
sys := sysLinger{Onoff: uint16(l.Onoff), Linger: uint16(l.Linger)} sys := sysLinger{Onoff: uint16(l.Onoff), Linger: uint16(l.Linger)}