File: sockettest.go

package info (click to toggle)
golang-github-mdlayher-socket 0.5.1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental, forky, sid, trixie, trixie-proposed-updates
  • size: 256 kB
  • sloc: makefile: 2
file content (259 lines) | stat: -rw-r--r-- 5,784 bytes parent folder | download
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
254
255
256
257
258
259
// Package sockettest implements net.Listener and net.Conn types based on
// *socket.Conn for use in the package's tests.
package sockettest

import (
	"context"
	"fmt"
	"io"
	"net"
	"os"
	"time"

	"github.com/mdlayher/socket"
	"golang.org/x/sys/unix"
)

// A Listener is a net.Listener which can be extended with context support.
type Listener struct {
	addr *net.TCPAddr
	c    *socket.Conn
	ctx  context.Context
}

func (l *Listener) Context(ctx context.Context) *Listener {
	l.ctx = ctx
	return l
}

// Listen creates an IPv6 TCP net.Listener backed by a *socket.Conn on the
// specified port with optional configuration. Context ctx will be passed
// to accept and accepted connections.
func Listen(port int, cfg *socket.Config) (*Listener, error) {
	c, err := socket.Socket(unix.AF_INET6, unix.SOCK_STREAM, 0, "tcpv6-server", cfg)
	if err != nil {
		return nil, fmt.Errorf("failed to open socket: %v", err)
	}

	// Be sure to close the Conn if any of the system calls fail before we
	// return the Conn to the caller.

	if err := c.Bind(&unix.SockaddrInet6{Port: port}); err != nil {
		_ = c.Close()
		return nil, fmt.Errorf("failed to bind: %v", err)
	}

	if err := c.Listen(unix.SOMAXCONN); err != nil {
		_ = c.Close()
		return nil, fmt.Errorf("failed to listen: %v", err)
	}

	sa, err := c.Getsockname()
	if err != nil {
		_ = c.Close()
		return nil, fmt.Errorf("failed to getsockname: %v", err)
	}

	return &Listener{
		addr: newTCPAddr(sa),
		c:    c,
	}, nil
}

// FileListener creates an IPv6 TCP net.Listener backed by a *socket.Conn from
// the input file.
func FileListener(f *os.File) (*Listener, error) {
	c, err := socket.FileConn(f, "tcpv6-server")
	if err != nil {
		return nil, fmt.Errorf("failed to open file conn: %v", err)
	}

	sa, err := c.Getsockname()
	if err != nil {
		_ = c.Close()
		return nil, fmt.Errorf("failed to getsockname: %v", err)
	}

	return &Listener{
		addr: newTCPAddr(sa),
		c:    c,
	}, nil
}

func (l *Listener) Addr() net.Addr { return l.addr }
func (l *Listener) Close() error   { return l.c.Close() }
func (l *Listener) Accept() (net.Conn, error) {
	ctx := context.Background()
	if l.ctx != nil {
		ctx = l.ctx
	}

	// SOCK_CLOEXEC and SOCK_NONBLOCK set automatically by Accept when possible.
	conn, rsa, err := l.c.Accept(ctx, 0)
	if err != nil {
		return nil, err
	}

	lsa, err := conn.Getsockname()
	if err != nil {
		// Don't leak the Conn if the system call fails.
		_ = conn.Close()
		return nil, err
	}

	c := &Conn{
		Conn:   conn,
		local:  newTCPAddr(lsa),
		remote: newTCPAddr(rsa),
	}

	if l.ctx != nil {
		return c.Context(l.ctx), nil
	}

	return c, nil
}

// A Conn is a net.Conn which can be extended with context support.
type Conn struct {
	Conn          *socket.Conn
	local, remote *net.TCPAddr
	ctx           context.Context
}

func (c *Conn) Context(ctx context.Context) *Conn {
	c.ctx = ctx
	return c
}

// Dial creates an IPv4 or IPv6 TCP net.Conn backed by a *socket.Conn with
// optional configuration.
func Dial(ctx context.Context, addr net.Addr, cfg *socket.Config) (*Conn, error) {
	ta, ok := addr.(*net.TCPAddr)
	if !ok {
		return nil, fmt.Errorf("expected *net.TCPAddr, but got: %T", addr)
	}

	var (
		family int
		name   string
		sa     unix.Sockaddr
	)

	if ta.IP.To16() != nil && ta.IP.To4() == nil {
		// IPv6.
		family = unix.AF_INET6
		name = "tcpv6-client"

		var sa6 unix.SockaddrInet6
		copy(sa6.Addr[:], ta.IP)
		sa6.Port = ta.Port

		sa = &sa6
	} else {
		// IPv4.
		family = unix.AF_INET
		name = "tcpv4-client"

		var sa4 unix.SockaddrInet4
		copy(sa4.Addr[:], ta.IP.To4())
		sa4.Port = ta.Port

		sa = &sa4
	}

	c, err := socket.Socket(family, unix.SOCK_STREAM, 0, name, cfg)
	if err != nil {
		return nil, fmt.Errorf("failed to open socket: %v", err)
	}

	// Be sure to close the Conn if any of the system calls fail before we
	// return the Conn to the caller.

	rsa, err := c.Connect(ctx, sa)
	if err != nil {
		_ = c.Close()
		// Don't wrap, we want the raw error for tests.
		return nil, err
	}

	lsa, err := c.Getsockname()
	if err != nil {
		_ = c.Close()
		return nil, err
	}

	return &Conn{
		Conn:   c,
		local:  newTCPAddr(lsa),
		remote: newTCPAddr(rsa),
	}, nil
}

func (c *Conn) Close() error                       { return c.Conn.Close() }
func (c *Conn) CloseRead() error                   { return c.Conn.CloseRead() }
func (c *Conn) CloseWrite() error                  { return c.Conn.CloseWrite() }
func (c *Conn) LocalAddr() net.Addr                { return c.local }
func (c *Conn) RemoteAddr() net.Addr               { return c.remote }
func (c *Conn) SetDeadline(t time.Time) error      { return c.Conn.SetDeadline(t) }
func (c *Conn) SetReadDeadline(t time.Time) error  { return c.Conn.SetReadDeadline(t) }
func (c *Conn) SetWriteDeadline(t time.Time) error { return c.Conn.SetWriteDeadline(t) }

func (c *Conn) Read(b []byte) (int, error) {
	var (
		n   int
		err error
	)

	if c.ctx != nil {
		n, err = c.Conn.ReadContext(c.ctx, b)
	} else {
		n, err = c.Conn.Read(b)
	}

	return n, opError("read", err)
}

func (c *Conn) Write(b []byte) (int, error) {
	var (
		n   int
		err error
	)

	if c.ctx != nil {
		n, err = c.Conn.WriteContext(c.ctx, b)
	} else {
		n, err = c.Conn.Write(b)
	}

	return n, opError("write", err)
}

func opError(op string, err error) error {
	// This is still a bit simplistic but sufficient for nettest.TestConn.
	switch err {
	case nil:
		return nil
	case io.EOF:
		return io.EOF
	default:
		return &net.OpError{Op: op, Err: err}
	}
}

func newTCPAddr(sa unix.Sockaddr) *net.TCPAddr {
	switch sa := sa.(type) {
	case *unix.SockaddrInet4:
		return &net.TCPAddr{
			IP:   sa.Addr[:],
			Port: sa.Port,
		}
	case *unix.SockaddrInet6:
		return &net.TCPAddr{
			IP:   sa.Addr[:],
			Port: sa.Port,
		}
	}

	panic("unknown address family")
}