|
| 1 | +// Copyright 2025 The Cockroach Authors. |
| 2 | +// |
| 3 | +// Use of this software is governed by the CockroachDB Software License |
| 4 | +// included in the /LICENSE file. |
| 5 | + |
| 6 | +//go:build linux |
| 7 | + |
| 8 | +package sysutil |
| 9 | + |
| 10 | +import ( |
| 11 | + "context" |
| 12 | + "io" |
| 13 | + "net" |
| 14 | + "runtime" |
| 15 | + "testing" |
| 16 | + "time" |
| 17 | + |
| 18 | + "github.com/cockroachdb/cockroach/pkg/testutils/skip" |
| 19 | + "github.com/stretchr/testify/require" |
| 20 | +) |
| 21 | + |
| 22 | +// GetRTTInfo doesn't panic when it's called with a nil connection. |
| 23 | +func TestGetTCPInfoNilConn(t *testing.T) { |
| 24 | + var conn *net.TCPConn |
| 25 | + info, ok := GetRTTInfo(conn) |
| 26 | + require.Nil(t, info) |
| 27 | + require.False(t, ok) |
| 28 | +} |
| 29 | + |
| 30 | +func TestGetTCPInfoLinux(t *testing.T) { |
| 31 | + if runtime.GOOS != "linux" { |
| 32 | + skip.IgnoreLint(t, "skipping test; RTT inspection is only supported on Linux") |
| 33 | + } |
| 34 | + |
| 35 | + ctx, cancel := context.WithCancel(context.Background()) |
| 36 | + defer cancel() |
| 37 | + |
| 38 | + // Start a TCP echo server. |
| 39 | + listener, _, err := createEchoServer(ctx, "127.0.0.1:0") |
| 40 | + require.NoError(t, err) |
| 41 | + defer func() { |
| 42 | + require.NoError(t, listener.Close()) |
| 43 | + }() |
| 44 | + |
| 45 | + // Connect a client. |
| 46 | + conn, err := net.Dial("tcp", listener.Addr().String()) |
| 47 | + require.NoError(t, err) |
| 48 | + defer func() { |
| 49 | + require.NoError(t, conn.Close()) |
| 50 | + }() |
| 51 | + |
| 52 | + // Give the connection a moment to be established. |
| 53 | + time.Sleep(10 * time.Millisecond) |
| 54 | + |
| 55 | + pingPayload := []byte("ping") |
| 56 | + pongBuffer := make([]byte, len(pingPayload)) |
| 57 | + |
| 58 | + // Write a "ping". |
| 59 | + _, err = conn.Write(pingPayload) |
| 60 | + require.NoError(t, err) |
| 61 | + |
| 62 | + // Read the "pong" echo. |
| 63 | + _, err = io.ReadFull(conn, pongBuffer) |
| 64 | + require.NoError(t, err) |
| 65 | + |
| 66 | + // RTT info is only available on TCP connections. GetRTTInfo takes a |
| 67 | + // *net.TCPConn, forcing the caller to perform a type assertion. |
| 68 | + tcpConn, ok := conn.(*net.TCPConn) |
| 69 | + require.True(t, ok) |
| 70 | + |
| 71 | + info, ok := GetRTTInfo(tcpConn) |
| 72 | + |
| 73 | + require.True(t, ok) |
| 74 | + require.NotNil(t, info) |
| 75 | +} |
| 76 | + |
| 77 | +// createEchoServer creates a TCP echo server that echoes back all received data. |
| 78 | +// It returns the listener and a channel that will receive any server errors. |
| 79 | +func createEchoServer(ctx context.Context, addr string) (net.Listener, <-chan error, error) { |
| 80 | + listener, err := net.Listen("tcp", addr) |
| 81 | + if err != nil { |
| 82 | + return nil, nil, err |
| 83 | + } |
| 84 | + |
| 85 | + serverErrChan := make(chan error, 1) |
| 86 | + go func() { |
| 87 | + conn, err := listener.Accept() |
| 88 | + if err != nil { |
| 89 | + // If the context is canceled, the listener may be closed, |
| 90 | + // resulting in an error. This is expected during cleanup. |
| 91 | + select { |
| 92 | + case <-ctx.Done(): |
| 93 | + serverErrChan <- nil |
| 94 | + default: |
| 95 | + serverErrChan <- err |
| 96 | + } |
| 97 | + return |
| 98 | + } |
| 99 | + defer conn.Close() |
| 100 | + // Echo all data received back to the client. This will run until |
| 101 | + // the client closes the connection, resulting in an io.EOF. |
| 102 | + if _, err := io.Copy(conn, conn); err != nil && err != io.EOF { |
| 103 | + serverErrChan <- err |
| 104 | + } else { |
| 105 | + serverErrChan <- nil |
| 106 | + } |
| 107 | + }() |
| 108 | + |
| 109 | + return listener, serverErrChan, nil |
| 110 | +} |
0 commit comments