1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
// Copyright 2020 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package tcp_linger_test
import (
"context"
"flag"
"syscall"
"testing"
"time"
"golang.org/x/sys/unix"
"gvisor.dev/gvisor/pkg/tcpip/header"
"gvisor.dev/gvisor/test/packetimpact/testbench"
)
func init() {
testbench.RegisterFlags(flag.CommandLine)
}
func createSocket(t *testing.T, dut testbench.DUT) (int32, int32, testbench.TCPIPv4) {
listenFD, remotePort := dut.CreateListener(t, unix.SOCK_STREAM, unix.IPPROTO_TCP, 1)
conn := testbench.NewTCPIPv4(t, testbench.TCP{DstPort: &remotePort}, testbench.TCP{SrcPort: &remotePort})
conn.Connect(t)
acceptFD, _ := dut.Accept(t, listenFD)
return acceptFD, listenFD, conn
}
func closeAll(t *testing.T, dut testbench.DUT, listenFD int32, conn testbench.TCPIPv4) {
conn.Close(t)
dut.Close(t, listenFD)
dut.TearDown()
}
// lingerDuration is the timeout value used with SO_LINGER socket option.
const lingerDuration = 3 * time.Second
// TestTCPLingerZeroTimeout tests when SO_LINGER is set with zero timeout. DUT
// should send RST-ACK when socket is closed.
func TestTCPLingerZeroTimeout(t *testing.T) {
// Create a socket, listen, TCP connect, and accept.
dut := testbench.NewDUT(t)
acceptFD, listenFD, conn := createSocket(t, dut)
defer closeAll(t, dut, listenFD, conn)
dut.SetSockLingerOption(t, acceptFD, 0, true)
dut.Close(t, acceptFD)
// If the linger timeout is set to zero, the DUT should send a RST.
if _, err := conn.Expect(t, testbench.TCP{Flags: testbench.Uint8(header.TCPFlagRst | header.TCPFlagAck)}, time.Second); err != nil {
t.Errorf("expected RST-ACK packet within a second but got none: %s", err)
}
conn.Send(t, testbench.TCP{Flags: testbench.Uint8(header.TCPFlagAck)})
}
// TestTCPLingerOff tests when SO_LINGER is not set. DUT should send FIN-ACK
// when socket is closed.
func TestTCPLingerOff(t *testing.T) {
// Create a socket, listen, TCP connect, and accept.
dut := testbench.NewDUT(t)
acceptFD, listenFD, conn := createSocket(t, dut)
defer closeAll(t, dut, listenFD, conn)
dut.Close(t, acceptFD)
// If SO_LINGER is not set, DUT should send a FIN-ACK.
if _, err := conn.Expect(t, testbench.TCP{Flags: testbench.Uint8(header.TCPFlagFin | header.TCPFlagAck)}, time.Second); err != nil {
t.Errorf("expected FIN-ACK packet within a second but got none: %s", err)
}
conn.Send(t, testbench.TCP{Flags: testbench.Uint8(header.TCPFlagAck)})
}
// TestTCPLingerNonZeroTimeout tests when SO_LINGER is set with non-zero timeout.
// DUT should close the socket after timeout.
func TestTCPLingerNonZeroTimeout(t *testing.T) {
for _, tt := range []struct {
description string
lingerOn bool
}{
{"WithNonZeroLinger", true},
{"WithoutLinger", false},
} {
t.Run(tt.description, func(t *testing.T) {
// Create a socket, listen, TCP connect, and accept.
dut := testbench.NewDUT(t)
acceptFD, listenFD, conn := createSocket(t, dut)
defer closeAll(t, dut, listenFD, conn)
dut.SetSockLingerOption(t, acceptFD, lingerDuration, tt.lingerOn)
// Increase timeout as Close will take longer time to
// return when SO_LINGER is set with non-zero timeout.
timeout := lingerDuration + 1*time.Second
ctx, cancel := context.WithTimeout(context.Background(), timeout)
defer cancel()
start := time.Now()
dut.CloseWithErrno(ctx, t, acceptFD)
end := time.Now()
diff := end.Sub(start)
if tt.lingerOn && diff < lingerDuration {
t.Errorf("expected close to return after %v seconds, but returned sooner", lingerDuration)
} else if !tt.lingerOn && diff > 1*time.Second {
t.Errorf("expected close to return within a second, but returned later")
}
if _, err := conn.Expect(t, testbench.TCP{Flags: testbench.Uint8(header.TCPFlagFin | header.TCPFlagAck)}, time.Second); err != nil {
t.Errorf("expected FIN-ACK packet within a second but got none: %s", err)
}
conn.Send(t, testbench.TCP{Flags: testbench.Uint8(header.TCPFlagAck)})
})
}
}
// TestTCPLingerSendNonZeroTimeout tests when SO_LINGER is set with non-zero
// timeout and send a packet. DUT should close the socket after timeout.
func TestTCPLingerSendNonZeroTimeout(t *testing.T) {
for _, tt := range []struct {
description string
lingerOn bool
}{
{"WithSendNonZeroLinger", true},
{"WithoutLinger", false},
} {
t.Run(tt.description, func(t *testing.T) {
// Create a socket, listen, TCP connect, and accept.
dut := testbench.NewDUT(t)
acceptFD, listenFD, conn := createSocket(t, dut)
defer closeAll(t, dut, listenFD, conn)
dut.SetSockLingerOption(t, acceptFD, lingerDuration, tt.lingerOn)
// Send data.
sampleData := []byte("Sample Data")
dut.Send(t, acceptFD, sampleData, 0)
// Increase timeout as Close will take longer time to
// return when SO_LINGER is set with non-zero timeout.
timeout := lingerDuration + 1*time.Second
ctx, cancel := context.WithTimeout(context.Background(), timeout)
defer cancel()
start := time.Now()
dut.CloseWithErrno(ctx, t, acceptFD)
end := time.Now()
diff := end.Sub(start)
if tt.lingerOn && diff < lingerDuration {
t.Errorf("expected close to return after %v seconds, but returned sooner", lingerDuration)
} else if !tt.lingerOn && diff > 1*time.Second {
t.Errorf("expected close to return within a second, but returned later")
}
samplePayload := &testbench.Payload{Bytes: sampleData}
if _, err := conn.ExpectData(t, &testbench.TCP{}, samplePayload, time.Second); err != nil {
t.Fatalf("expected a packet with payload %v: %s", samplePayload, err)
}
if _, err := conn.Expect(t, testbench.TCP{Flags: testbench.Uint8(header.TCPFlagFin | header.TCPFlagAck)}, time.Second); err != nil {
t.Errorf("expected FIN-ACK packet within a second but got none: %s", err)
}
conn.Send(t, testbench.TCP{Flags: testbench.Uint8(header.TCPFlagAck)})
})
}
}
// TestTCPLingerShutdownZeroTimeout tests SO_LINGER with shutdown() and zero
// timeout. DUT should send RST-ACK when socket is closed.
func TestTCPLingerShutdownZeroTimeout(t *testing.T) {
// Create a socket, listen, TCP connect, and accept.
dut := testbench.NewDUT(t)
acceptFD, listenFD, conn := createSocket(t, dut)
defer closeAll(t, dut, listenFD, conn)
dut.SetSockLingerOption(t, acceptFD, 0, true)
dut.Shutdown(t, acceptFD, syscall.SHUT_RDWR)
dut.Close(t, acceptFD)
// Shutdown will send FIN-ACK with read/write option.
if _, err := conn.Expect(t, testbench.TCP{Flags: testbench.Uint8(header.TCPFlagFin | header.TCPFlagAck)}, time.Second); err != nil {
t.Errorf("expected FIN-ACK packet within a second but got none: %s", err)
}
// If the linger timeout is set to zero, the DUT should send a RST.
if _, err := conn.Expect(t, testbench.TCP{Flags: testbench.Uint8(header.TCPFlagRst | header.TCPFlagAck)}, time.Second); err != nil {
t.Errorf("expected RST-ACK packet within a second but got none: %s", err)
}
conn.Send(t, testbench.TCP{Flags: testbench.Uint8(header.TCPFlagAck)})
}
// TestTCPLingerShutdownSendNonZeroTimeout tests SO_LINGER with shutdown() and
// non-zero timeout. DUT should close the socket after timeout.
func TestTCPLingerShutdownSendNonZeroTimeout(t *testing.T) {
for _, tt := range []struct {
description string
lingerOn bool
}{
{"shutdownRDWR", true},
{"shutdownRDWR", false},
} {
t.Run(tt.description, func(t *testing.T) {
// Create a socket, listen, TCP connect, and accept.
dut := testbench.NewDUT(t)
acceptFD, listenFD, conn := createSocket(t, dut)
defer closeAll(t, dut, listenFD, conn)
dut.SetSockLingerOption(t, acceptFD, lingerDuration, tt.lingerOn)
// Send data.
sampleData := []byte("Sample Data")
dut.Send(t, acceptFD, sampleData, 0)
dut.Shutdown(t, acceptFD, syscall.SHUT_RDWR)
// Increase timeout as Close will take longer time to
// return when SO_LINGER is set with non-zero timeout.
timeout := lingerDuration + 1*time.Second
ctx, cancel := context.WithTimeout(context.Background(), timeout)
defer cancel()
start := time.Now()
dut.CloseWithErrno(ctx, t, acceptFD)
end := time.Now()
diff := end.Sub(start)
if tt.lingerOn && diff < lingerDuration {
t.Errorf("expected close to return after %v seconds, but returned sooner", lingerDuration)
} else if !tt.lingerOn && diff > 1*time.Second {
t.Errorf("expected close to return within a second, but returned later")
}
samplePayload := &testbench.Payload{Bytes: sampleData}
if _, err := conn.ExpectData(t, &testbench.TCP{}, samplePayload, time.Second); err != nil {
t.Fatalf("expected a packet with payload %v: %s", samplePayload, err)
}
if _, err := conn.Expect(t, testbench.TCP{Flags: testbench.Uint8(header.TCPFlagFin | header.TCPFlagAck)}, time.Second); err != nil {
t.Errorf("expected FIN-ACK packet within a second but got none: %s", err)
}
conn.Send(t, testbench.TCP{Flags: testbench.Uint8(header.TCPFlagAck)})
})
}
}
|
