src/net/tcpsock.go

   1 // Copyright 2009 The Go Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style
   3 // license that can be found in the LICENSE file.
   4
   5 package net
   6
   7 import (
   8         "context"
   9         "internal/itoa"
  10         "io"
  11         "net/netip"
  12         "os"
  13         "syscall"
  14         "time"
  15 )
  16
  17 // BUG(mikio): On JS and Windows, the File method of TCPConn and
  18 // TCPListener is not implemented.
  19
  20 // TCPAddr represents the address of a TCP end point.
  21 type TCPAddr struct {
  22         IP   IP
  23         Port int
  24         Zone string // IPv6 scoped addressing zone
  25 }
  26
  27 // AddrPort returns the TCPAddr a as a netip.AddrPort.
  28 //
  29 // If a.Port does not fit in a uint16, it's silently truncated.
  30 //
  31 // If a is nil, a zero value is returned.
  32 func (a *TCPAddr) AddrPort() netip.AddrPort {
  33         if a == nil {
  34                 return netip.AddrPort{}
  35         }
  36         na, _ := netip.AddrFromSlice(a.IP)
  37         na = na.WithZone(a.Zone)
  38         return netip.AddrPortFrom(na, uint16(a.Port))
  39 }
  40
  41 // Network returns the address's network name, "tcp".
  42 func (a *TCPAddr) Network() string { return "tcp" }
  43
  44 func (a *TCPAddr) String() string {
  45         if a == nil {
  46                 return "<nil>"
  47         }
  48         ip := ipEmptyString(a.IP)
  49         if a.Zone != "" {
  50                 return JoinHostPort(ip+"%"+a.Zone, itoa.Itoa(a.Port))
  51         }
  52         return JoinHostPort(ip, itoa.Itoa(a.Port))
  53 }
  54
  55 func (a *TCPAddr) isWildcard() bool {
  56         if a == nil || a.IP == nil {
  57                 return true
  58         }
  59         return a.IP.IsUnspecified()
  60 }
  61
  62 func (a *TCPAddr) opAddr() Addr {
  63         if a == nil {
  64                 return nil
  65         }
  66         return a
  67 }
  68
  69 // ResolveTCPAddr returns an address of TCP end point.
  70 //
  71 // The network must be a TCP network name.
  72 //
  73 // If the host in the address parameter is not a literal IP address or
  74 // the port is not a literal port number, ResolveTCPAddr resolves the
  75 // address to an address of TCP end point.
  76 // Otherwise, it parses the address as a pair of literal IP address
  77 // and port number.
  78 // The address parameter can use a host name, but this is not
  79 // recommended, because it will return at most one of the host name's
  80 // IP addresses.
  81 //
  82 // See func Dial for a description of the network and address
  83 // parameters.
  84 func ResolveTCPAddr(network, address string) (*TCPAddr, error) {
  85         switch network {
  86         case "tcp", "tcp4", "tcp6":
  87         case "": // a hint wildcard for Go 1.0 undocumented behavior
  88                 network = "tcp"
  89         default:
  90                 return nil, UnknownNetworkError(network)
  91         }
  92         addrs, err := DefaultResolver.internetAddrList(context.Background(), network, address)
  93         if err != nil {
  94                 return nil, err
  95         }
  96         return addrs.forResolve(network, address).(*TCPAddr), nil
  97 }
  98
  99 // TCPAddrFromAddrPort returns addr as a TCPAddr. If addr.IsValid() is false,
 100 // then the returned TCPAddr will contain a nil IP field, indicating an
 101 // address family-agnostic unspecified address.
 102 func TCPAddrFromAddrPort(addr netip.AddrPort) *TCPAddr {
 103         return &TCPAddr{
 104                 IP:   addr.Addr().AsSlice(),
 105                 Zone: addr.Addr().Zone(),
 106                 Port: int(addr.Port()),
 107         }
 108 }
 109
 110 // TCPConn is an implementation of the Conn interface for TCP network
 111 // connections.
 112 type TCPConn struct {
 113         conn
 114 }
 115
 116 // SyscallConn returns a raw network connection.
 117 // This implements the syscall.Conn interface.
 118 func (c *TCPConn) SyscallConn() (syscall.RawConn, error) {
 119         if !c.ok() {
 120                 return nil, syscall.EINVAL
 121         }
 122         return newRawConn(c.fd), nil
 123 }
 124
 125 // ReadFrom implements the io.ReaderFrom ReadFrom method.
 126 func (c *TCPConn) ReadFrom(r io.Reader) (int64, error) {
 127         if !c.ok() {
 128                 return 0, syscall.EINVAL
 129         }
 130         n, err := c.readFrom(r)
 131         if err != nil && err != io.EOF {
 132                 err = &OpError{Op: "readfrom", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err}
 133         }
 134         return n, err
 135 }
 136
 137 // CloseRead shuts down the reading side of the TCP connection.
 138 // Most callers should just use Close.
 139 func (c *TCPConn) CloseRead() error {
 140         if !c.ok() {
 141                 return syscall.EINVAL
 142         }
 143         if err := c.fd.closeRead(); err != nil {
 144                 return &OpError{Op: "close", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err}
 145         }
 146         return nil
 147 }
 148
 149 // CloseWrite shuts down the writing side of the TCP connection.
 150 // Most callers should just use Close.
 151 func (c *TCPConn) CloseWrite() error {
 152         if !c.ok() {
 153                 return syscall.EINVAL
 154         }
 155         if err := c.fd.closeWrite(); err != nil {
 156                 return &OpError{Op: "close", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err}
 157         }
 158         return nil
 159 }
 160
 161 // SetLinger sets the behavior of Close on a connection which still
 162 // has data waiting to be sent or to be acknowledged.
 163 //
 164 // If sec < 0 (the default), the operating system finishes sending the
 165 // data in the background.
 166 //
 167 // If sec == 0, the operating system discards any unsent or
 168 // unacknowledged data.
 169 //
 170 // If sec > 0, the data is sent in the background as with sec < 0.
 171 // On some operating systems including Linux, this may cause Close to block
 172 // until all data has been sent or discarded.
 173 // On some operating systems after sec seconds have elapsed any remaining
 174 // unsent data may be discarded.
 175 func (c *TCPConn) SetLinger(sec int) error {
 176         if !c.ok() {
 177                 return syscall.EINVAL
 178         }
 179         if err := setLinger(c.fd, sec); err != nil {
 180                 return &OpError{Op: "set", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err}
 181         }
 182         return nil
 183 }
 184
 185 // SetKeepAlive sets whether the operating system should send
 186 // keep-alive messages on the connection.
 187 func (c *TCPConn) SetKeepAlive(keepalive bool) error {
 188         if !c.ok() {
 189                 return syscall.EINVAL
 190         }
 191         if err := setKeepAlive(c.fd, keepalive); err != nil {
 192                 return &OpError{Op: "set", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err}
 193         }
 194         return nil
 195 }
 196
 197 // SetKeepAlivePeriod sets period between keep-alives.
 198 func (c *TCPConn) SetKeepAlivePeriod(d time.Duration) error {
 199         if !c.ok() {
 200                 return syscall.EINVAL
 201         }
 202         if err := setKeepAlivePeriod(c.fd, d); err != nil {
 203                 return &OpError{Op: "set", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err}
 204         }
 205         return nil
 206 }
 207
 208 // SetNoDelay controls whether the operating system should delay
 209 // packet transmission in hopes of sending fewer packets (Nagle's
 210 // algorithm).  The default is true (no delay), meaning that data is
 211 // sent as soon as possible after a Write.
 212 func (c *TCPConn) SetNoDelay(noDelay bool) error {
 213         if !c.ok() {
 214                 return syscall.EINVAL
 215         }
 216         if err := setNoDelay(c.fd, noDelay); err != nil {
 217                 return &OpError{Op: "set", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err}
 218         }
 219         return nil
 220 }
 221
 222 // MultipathTCP reports whether the ongoing connection is using MPTCP.
 223 //
 224 // If Multipath TCP is not supported by the host, by the other peer or
 225 // intentionally / accidentally filtered out by a device in between, a
 226 // fallback to TCP will be done. This method does its best to check if
 227 // MPTCP is still being used or not.
 228 //
 229 // On Linux, more conditions are verified on kernels >= v5.16, improving
 230 // the results.
 231 func (c *TCPConn) MultipathTCP() (bool, error) {
 232         if !c.ok() {
 233                 return false, syscall.EINVAL
 234         }
 235         return isUsingMultipathTCP(c.fd), nil
 236 }
 237
 238 func newTCPConn(fd *netFD, keepAlive time.Duration, keepAliveHook func(time.Duration)) *TCPConn {
 239         setNoDelay(fd, true)
 240         if keepAlive == 0 {
 241                 keepAlive = defaultTCPKeepAlive
 242         }
 243         if keepAlive > 0 {
 244                 setKeepAlive(fd, true)
 245                 setKeepAlivePeriod(fd, keepAlive)
 246                 if keepAliveHook != nil {
 247                         keepAliveHook(keepAlive)
 248                 }
 249         }
 250         return &TCPConn{conn{fd}}
 251 }
 252
 253 // DialTCP acts like Dial for TCP networks.
 254 //
 255 // The network must be a TCP network name; see func Dial for details.
 256 //
 257 // If laddr is nil, a local address is automatically chosen.
 258 // If the IP field of raddr is nil or an unspecified IP address, the
 259 // local system is assumed.
 260 func DialTCP(network string, laddr, raddr *TCPAddr) (*TCPConn, error) {
 261         switch network {
 262         case "tcp", "tcp4", "tcp6":
 263         default:
 264                 return nil, &OpError{Op: "dial", Net: network, Source: laddr.opAddr(), Addr: raddr.opAddr(), Err: UnknownNetworkError(network)}
 265         }
 266         if raddr == nil {
 267                 return nil, &OpError{Op: "dial", Net: network, Source: laddr.opAddr(), Addr: nil, Err: errMissingAddress}
 268         }
 269         sd := &sysDialer{network: network, address: raddr.String()}
 270         c, err := sd.dialTCP(context.Background(), laddr, raddr)
 271         if err != nil {
 272                 return nil, &OpError{Op: "dial", Net: network, Source: laddr.opAddr(), Addr: raddr.opAddr(), Err: err}
 273         }
 274         return c, nil
 275 }
 276
 277 // TCPListener is a TCP network listener. Clients should typically
 278 // use variables of type Listener instead of assuming TCP.
 279 type TCPListener struct {
 280         fd *netFD
 281         lc ListenConfig
 282 }
 283
 284 // SyscallConn returns a raw network connection.
 285 // This implements the syscall.Conn interface.
 286 //
 287 // The returned RawConn only supports calling Control. Read and
 288 // Write return an error.
 289 func (l *TCPListener) SyscallConn() (syscall.RawConn, error) {
 290         if !l.ok() {
 291                 return nil, syscall.EINVAL
 292         }
 293         return newRawListener(l.fd), nil
 294 }
 295
 296 // AcceptTCP accepts the next incoming call and returns the new
 297 // connection.
 298 func (l *TCPListener) AcceptTCP() (*TCPConn, error) {
 299         if !l.ok() {
 300                 return nil, syscall.EINVAL
 301         }
 302         c, err := l.accept()
 303         if err != nil {
 304                 return nil, &OpError{Op: "accept", Net: l.fd.net, Source: nil, Addr: l.fd.laddr, Err: err}
 305         }
 306         return c, nil
 307 }
 308
 309 // Accept implements the Accept method in the Listener interface; it
 310 // waits for the next call and returns a generic Conn.
 311 func (l *TCPListener) Accept() (Conn, error) {
 312         if !l.ok() {
 313                 return nil, syscall.EINVAL
 314         }
 315         c, err := l.accept()
 316         if err != nil {
 317                 return nil, &OpError{Op: "accept", Net: l.fd.net, Source: nil, Addr: l.fd.laddr, Err: err}
 318         }
 319         return c, nil
 320 }
 321
 322 // Close stops listening on the TCP address.
 323 // Already Accepted connections are not closed.
 324 func (l *TCPListener) Close() error {
 325         if !l.ok() {
 326                 return syscall.EINVAL
 327         }
 328         if err := l.close(); err != nil {
 329                 return &OpError{Op: "close", Net: l.fd.net, Source: nil, Addr: l.fd.laddr, Err: err}
 330         }
 331         return nil
 332 }
 333
 334 // Addr returns the listener's network address, a *TCPAddr.
 335 // The Addr returned is shared by all invocations of Addr, so
 336 // do not modify it.
 337 func (l *TCPListener) Addr() Addr { return l.fd.laddr }
 338
 339 // SetDeadline sets the deadline associated with the listener.
 340 // A zero time value disables the deadline.
 341 func (l *TCPListener) SetDeadline(t time.Time) error {
 342         if !l.ok() {
 343                 return syscall.EINVAL
 344         }
 345         return l.fd.SetDeadline(t)
 346 }
 347
 348 // File returns a copy of the underlying os.File.
 349 // It is the caller's responsibility to close f when finished.
 350 // Closing l does not affect f, and closing f does not affect l.
 351 //
 352 // The returned os.File's file descriptor is different from the
 353 // connection's. Attempting to change properties of the original
 354 // using this duplicate may or may not have the desired effect.
 355 func (l *TCPListener) File() (f *os.File, err error) {
 356         if !l.ok() {
 357                 return nil, syscall.EINVAL
 358         }
 359         f, err = l.file()
 360         if err != nil {
 361                 return nil, &OpError{Op: "file", Net: l.fd.net, Source: nil, Addr: l.fd.laddr, Err: err}
 362         }
 363         return
 364 }
 365
 366 // ListenTCP acts like Listen for TCP networks.
 367 //
 368 // The network must be a TCP network name; see func Dial for details.
 369 //
 370 // If the IP field of laddr is nil or an unspecified IP address,
 371 // ListenTCP listens on all available unicast and anycast IP addresses
 372 // of the local system.
 373 // If the Port field of laddr is 0, a port number is automatically
 374 // chosen.
 375 func ListenTCP(network string, laddr *TCPAddr) (*TCPListener, error) {
 376         switch network {
 377         case "tcp", "tcp4", "tcp6":
 378         default:
 379                 return nil, &OpError{Op: "listen", Net: network, Source: nil, Addr: laddr.opAddr(), Err: UnknownNetworkError(network)}
 380         }
 381         if laddr == nil {
 382                 laddr = &TCPAddr{}
 383         }
 384         sl := &sysListener{network: network, address: laddr.String()}
 385         ln, err := sl.listenTCP(context.Background(), laddr)
 386         if err != nil {
 387                 return nil, &OpError{Op: "listen", Net: network, Source: nil, Addr: laddr.opAddr(), Err: err}
 388         }
 389         return ln, nil
 390 }
 391
 392 // roundDurationUp rounds d to the next multiple of to.
 393 func roundDurationUp(d time.Duration, to time.Duration) time.Duration {
 394         return (d + to - 1) / to
 395 }