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 <[email protected]>
Reviewed-by: Michael Knyszek <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Damien Neil <[email protected]>

Author: panjf2000

doc/next/6-stdlib/99-minor/syscall/65817.md

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

src/internal/syscall/windows/types_windows.go

@@ -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
+)

src/internal/syscall/windows/version_windows.go

@@ -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
+})

src/net/tcpconn_keepalive_conf_darwin_test.go

@@ -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) {}

src/net/tcpconn_keepalive_conf_posix_test.go

@@ -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,
+	},
+}

src/net/tcpconn_keepalive_conf_unix_test.go

@@ -2,101 +2,28 @@
 // Use of this source code is governed by a BSD-style
 // 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
 
-import "time"
+import (
+	"runtime"
+	"syscall"
+	"testing"
+)
 
-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,
-	},
+const (
+	syscall_TCP_KEEPIDLE  = syscall.TCP_KEEPIDLE
+	syscall_TCP_KEEPCNT   = syscall.TCP_KEEPCNT
+	syscall_TCP_KEEPINTVL = syscall.TCP_KEEPINTVL
+)
+
+type fdType = int
+
+func maybeSkipKeepAliveTest(t *testing.T) {
+	// TODO(panjf2000): stop skipping this test on Solaris
+	//  when https://go.dev/issue/64251 is fixed.
+	if runtime.GOOS == "solaris" {
+		t.Skip("skipping on solaris for now")
+	}
 }

src/net/tcpconn_keepalive_conf_windows_test.go

@@ -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")
+	}
+}

src/net/tcpconn_keepalive_darwin_test.go renamed to src/net/tcpconn_keepalive_posix_test.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-//go:build darwin
+//go:build aix || darwin || dragonfly || freebsd || linux || netbsd || windows
 
 package net
 
@@ -12,20 +12,20 @@ import (
 	"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)
 	if err != nil {
 		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 {
 		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 {
 		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 {
 		return
 	}
@@ -38,7 +38,7 @@ func getCurrentKeepAliveSettings(fd int) (cfg KeepAliveConfig, err error) {
 	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 {
 		cfg.Idle = defaultTCPKeepAliveIdle
 	}
@@ -66,23 +66,23 @@ func verifyKeepAliveSettings(t *testing.T, fd int, oldCfg, cfg KeepAliveConfig)
 		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 {
 		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, sysTCP_KEEPINTVL)
+	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, sysTCP_KEEPCNT)
+	tcpKeepAliveCount, err := syscall.GetsockoptInt(fd, syscall.IPPROTO_TCP, syscall_TCP_KEEPCNT)
 	if err != nil {
 		t.Fatal(err)
 	}