github.com/hlts2/go@v0.0.0-20170904000733-812b34efaed8/src/net/http/transport.go (about) 1 // Copyright 2011 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 // HTTP client implementation. See RFC 2616. 6 // 7 // This is the low-level Transport implementation of RoundTripper. 8 // The high-level interface is in client.go. 9 10 package http 11 12 import ( 13 "bufio" 14 "compress/gzip" 15 "container/list" 16 "context" 17 "crypto/tls" 18 "errors" 19 "fmt" 20 "io" 21 "log" 22 "net" 23 "net/http/httptrace" 24 "net/url" 25 "os" 26 "strings" 27 "sync" 28 "sync/atomic" 29 "time" 30 31 "golang_org/x/net/lex/httplex" 32 "golang_org/x/net/proxy" 33 ) 34 35 // DefaultTransport is the default implementation of Transport and is 36 // used by DefaultClient. It establishes network connections as needed 37 // and caches them for reuse by subsequent calls. It uses HTTP proxies 38 // as directed by the $HTTP_PROXY and $NO_PROXY (or $http_proxy and 39 // $no_proxy) environment variables. 40 var DefaultTransport RoundTripper = &Transport{ 41 Proxy: ProxyFromEnvironment, 42 DialContext: (&net.Dialer{ 43 Timeout: 30 * time.Second, 44 KeepAlive: 30 * time.Second, 45 DualStack: true, 46 }).DialContext, 47 MaxIdleConns: 100, 48 IdleConnTimeout: 90 * time.Second, 49 TLSHandshakeTimeout: 10 * time.Second, 50 ExpectContinueTimeout: 1 * time.Second, 51 } 52 53 // DefaultMaxIdleConnsPerHost is the default value of Transport's 54 // MaxIdleConnsPerHost. 55 const DefaultMaxIdleConnsPerHost = 2 56 57 // Transport is an implementation of RoundTripper that supports HTTP, 58 // HTTPS, and HTTP proxies (for either HTTP or HTTPS with CONNECT). 59 // 60 // By default, Transport caches connections for future re-use. 61 // This may leave many open connections when accessing many hosts. 62 // This behavior can be managed using Transport's CloseIdleConnections method 63 // and the MaxIdleConnsPerHost and DisableKeepAlives fields. 64 // 65 // Transports should be reused instead of created as needed. 66 // Transports are safe for concurrent use by multiple goroutines. 67 // 68 // A Transport is a low-level primitive for making HTTP and HTTPS requests. 69 // For high-level functionality, such as cookies and redirects, see Client. 70 // 71 // Transport uses HTTP/1.1 for HTTP URLs and either HTTP/1.1 or HTTP/2 72 // for HTTPS URLs, depending on whether the server supports HTTP/2, 73 // and how the Transport is configured. The DefaultTransport supports HTTP/2. 74 // To explicitly enable HTTP/2 on a transport, use golang.org/x/net/http2 75 // and call ConfigureTransport. See the package docs for more about HTTP/2. 76 type Transport struct { 77 idleMu sync.Mutex 78 wantIdle bool // user has requested to close all idle conns 79 idleConn map[connectMethodKey][]*persistConn // most recently used at end 80 idleConnCh map[connectMethodKey]chan *persistConn 81 idleLRU connLRU 82 83 reqMu sync.Mutex 84 reqCanceler map[*Request]func(error) 85 86 altMu sync.Mutex // guards changing altProto only 87 altProto atomic.Value // of nil or map[string]RoundTripper, key is URI scheme 88 89 // Proxy specifies a function to return a proxy for a given 90 // Request. If the function returns a non-nil error, the 91 // request is aborted with the provided error. 92 // 93 // The proxy type is determined by the URL scheme. "http" 94 // and "socks5" are supported. If the scheme is empty, 95 // "http" is assumed. 96 // 97 // If Proxy is nil or returns a nil *URL, no proxy is used. 98 Proxy func(*Request) (*url.URL, error) 99 100 // DialContext specifies the dial function for creating unencrypted TCP connections. 101 // If DialContext is nil (and the deprecated Dial below is also nil), 102 // then the transport dials using package net. 103 DialContext func(ctx context.Context, network, addr string) (net.Conn, error) 104 105 // Dial specifies the dial function for creating unencrypted TCP connections. 106 // 107 // Deprecated: Use DialContext instead, which allows the transport 108 // to cancel dials as soon as they are no longer needed. 109 // If both are set, DialContext takes priority. 110 Dial func(network, addr string) (net.Conn, error) 111 112 // DialTLS specifies an optional dial function for creating 113 // TLS connections for non-proxied HTTPS requests. 114 // 115 // If DialTLS is nil, Dial and TLSClientConfig are used. 116 // 117 // If DialTLS is set, the Dial hook is not used for HTTPS 118 // requests and the TLSClientConfig and TLSHandshakeTimeout 119 // are ignored. The returned net.Conn is assumed to already be 120 // past the TLS handshake. 121 DialTLS func(network, addr string) (net.Conn, error) 122 123 // TLSClientConfig specifies the TLS configuration to use with 124 // tls.Client. 125 // If nil, the default configuration is used. 126 // If non-nil, HTTP/2 support may not be enabled by default. 127 TLSClientConfig *tls.Config 128 129 // TLSHandshakeTimeout specifies the maximum amount of time waiting to 130 // wait for a TLS handshake. Zero means no timeout. 131 TLSHandshakeTimeout time.Duration 132 133 // DisableKeepAlives, if true, prevents re-use of TCP connections 134 // between different HTTP requests. 135 DisableKeepAlives bool 136 137 // DisableCompression, if true, prevents the Transport from 138 // requesting compression with an "Accept-Encoding: gzip" 139 // request header when the Request contains no existing 140 // Accept-Encoding value. If the Transport requests gzip on 141 // its own and gets a gzipped response, it's transparently 142 // decoded in the Response.Body. However, if the user 143 // explicitly requested gzip it is not automatically 144 // uncompressed. 145 DisableCompression bool 146 147 // MaxIdleConns controls the maximum number of idle (keep-alive) 148 // connections across all hosts. Zero means no limit. 149 MaxIdleConns int 150 151 // MaxIdleConnsPerHost, if non-zero, controls the maximum idle 152 // (keep-alive) connections to keep per-host. If zero, 153 // DefaultMaxIdleConnsPerHost is used. 154 MaxIdleConnsPerHost int 155 156 // IdleConnTimeout is the maximum amount of time an idle 157 // (keep-alive) connection will remain idle before closing 158 // itself. 159 // Zero means no limit. 160 IdleConnTimeout time.Duration 161 162 // ResponseHeaderTimeout, if non-zero, specifies the amount of 163 // time to wait for a server's response headers after fully 164 // writing the request (including its body, if any). This 165 // time does not include the time to read the response body. 166 ResponseHeaderTimeout time.Duration 167 168 // ExpectContinueTimeout, if non-zero, specifies the amount of 169 // time to wait for a server's first response headers after fully 170 // writing the request headers if the request has an 171 // "Expect: 100-continue" header. Zero means no timeout and 172 // causes the body to be sent immediately, without 173 // waiting for the server to approve. 174 // This time does not include the time to send the request header. 175 ExpectContinueTimeout time.Duration 176 177 // TLSNextProto specifies how the Transport switches to an 178 // alternate protocol (such as HTTP/2) after a TLS NPN/ALPN 179 // protocol negotiation. If Transport dials an TLS connection 180 // with a non-empty protocol name and TLSNextProto contains a 181 // map entry for that key (such as "h2"), then the func is 182 // called with the request's authority (such as "example.com" 183 // or "example.com:1234") and the TLS connection. The function 184 // must return a RoundTripper that then handles the request. 185 // If TLSNextProto is not nil, HTTP/2 support is not enabled 186 // automatically. 187 TLSNextProto map[string]func(authority string, c *tls.Conn) RoundTripper 188 189 // ProxyConnectHeader optionally specifies headers to send to 190 // proxies during CONNECT requests. 191 ProxyConnectHeader Header 192 193 // MaxResponseHeaderBytes specifies a limit on how many 194 // response bytes are allowed in the server's response 195 // header. 196 // 197 // Zero means to use a default limit. 198 MaxResponseHeaderBytes int64 199 200 // nextProtoOnce guards initialization of TLSNextProto and 201 // h2transport (via onceSetNextProtoDefaults) 202 nextProtoOnce sync.Once 203 h2transport *http2Transport // non-nil if http2 wired up 204 205 // TODO: tunable on max per-host TCP dials in flight (Issue 13957) 206 } 207 208 // onceSetNextProtoDefaults initializes TLSNextProto. 209 // It must be called via t.nextProtoOnce.Do. 210 func (t *Transport) onceSetNextProtoDefaults() { 211 if strings.Contains(os.Getenv("GODEBUG"), "http2client=0") { 212 return 213 } 214 if t.TLSNextProto != nil { 215 // This is the documented way to disable http2 on a 216 // Transport. 217 return 218 } 219 if t.TLSClientConfig != nil || t.Dial != nil || t.DialTLS != nil { 220 // Be conservative and don't automatically enable 221 // http2 if they've specified a custom TLS config or 222 // custom dialers. Let them opt-in themselves via 223 // http2.ConfigureTransport so we don't surprise them 224 // by modifying their tls.Config. Issue 14275. 225 return 226 } 227 t2, err := http2configureTransport(t) 228 if err != nil { 229 log.Printf("Error enabling Transport HTTP/2 support: %v", err) 230 return 231 } 232 t.h2transport = t2 233 234 // Auto-configure the http2.Transport's MaxHeaderListSize from 235 // the http.Transport's MaxResponseHeaderBytes. They don't 236 // exactly mean the same thing, but they're close. 237 // 238 // TODO: also add this to x/net/http2.Configure Transport, behind 239 // a +build go1.7 build tag: 240 if limit1 := t.MaxResponseHeaderBytes; limit1 != 0 && t2.MaxHeaderListSize == 0 { 241 const h2max = 1<<32 - 1 242 if limit1 >= h2max { 243 t2.MaxHeaderListSize = h2max 244 } else { 245 t2.MaxHeaderListSize = uint32(limit1) 246 } 247 } 248 } 249 250 // ProxyFromEnvironment returns the URL of the proxy to use for a 251 // given request, as indicated by the environment variables 252 // HTTP_PROXY, HTTPS_PROXY and NO_PROXY (or the lowercase versions 253 // thereof). HTTPS_PROXY takes precedence over HTTP_PROXY for https 254 // requests. 255 // 256 // The environment values may be either a complete URL or a 257 // "host[:port]", in which case the "http" scheme is assumed. 258 // An error is returned if the value is a different form. 259 // 260 // A nil URL and nil error are returned if no proxy is defined in the 261 // environment, or a proxy should not be used for the given request, 262 // as defined by NO_PROXY. 263 // 264 // As a special case, if req.URL.Host is "localhost" (with or without 265 // a port number), then a nil URL and nil error will be returned. 266 func ProxyFromEnvironment(req *Request) (*url.URL, error) { 267 var proxy string 268 if req.URL.Scheme == "https" { 269 proxy = httpsProxyEnv.Get() 270 } 271 if proxy == "" { 272 proxy = httpProxyEnv.Get() 273 if proxy != "" && os.Getenv("REQUEST_METHOD") != "" { 274 return nil, errors.New("net/http: refusing to use HTTP_PROXY value in CGI environment; see golang.org/s/cgihttpproxy") 275 } 276 } 277 if proxy == "" { 278 return nil, nil 279 } 280 if !useProxy(canonicalAddr(req.URL)) { 281 return nil, nil 282 } 283 proxyURL, err := url.Parse(proxy) 284 if err != nil || 285 (proxyURL.Scheme != "http" && 286 proxyURL.Scheme != "https" && 287 proxyURL.Scheme != "socks5") { 288 // proxy was bogus. Try prepending "http://" to it and 289 // see if that parses correctly. If not, we fall 290 // through and complain about the original one. 291 if proxyURL, err := url.Parse("http://" + proxy); err == nil { 292 return proxyURL, nil 293 } 294 295 } 296 if err != nil { 297 return nil, fmt.Errorf("invalid proxy address %q: %v", proxy, err) 298 } 299 return proxyURL, nil 300 } 301 302 // ProxyURL returns a proxy function (for use in a Transport) 303 // that always returns the same URL. 304 func ProxyURL(fixedURL *url.URL) func(*Request) (*url.URL, error) { 305 return func(*Request) (*url.URL, error) { 306 return fixedURL, nil 307 } 308 } 309 310 // transportRequest is a wrapper around a *Request that adds 311 // optional extra headers to write and stores any error to return 312 // from roundTrip. 313 type transportRequest struct { 314 *Request // original request, not to be mutated 315 extra Header // extra headers to write, or nil 316 trace *httptrace.ClientTrace // optional 317 318 mu sync.Mutex // guards err 319 err error // first setError value for mapRoundTripError to consider 320 } 321 322 func (tr *transportRequest) extraHeaders() Header { 323 if tr.extra == nil { 324 tr.extra = make(Header) 325 } 326 return tr.extra 327 } 328 329 func (tr *transportRequest) setError(err error) { 330 tr.mu.Lock() 331 if tr.err == nil { 332 tr.err = err 333 } 334 tr.mu.Unlock() 335 } 336 337 // RoundTrip implements the RoundTripper interface. 338 // 339 // For higher-level HTTP client support (such as handling of cookies 340 // and redirects), see Get, Post, and the Client type. 341 func (t *Transport) RoundTrip(req *Request) (*Response, error) { 342 t.nextProtoOnce.Do(t.onceSetNextProtoDefaults) 343 ctx := req.Context() 344 trace := httptrace.ContextClientTrace(ctx) 345 346 if req.URL == nil { 347 req.closeBody() 348 return nil, errors.New("http: nil Request.URL") 349 } 350 if req.Header == nil { 351 req.closeBody() 352 return nil, errors.New("http: nil Request.Header") 353 } 354 scheme := req.URL.Scheme 355 isHTTP := scheme == "http" || scheme == "https" 356 if isHTTP { 357 for k, vv := range req.Header { 358 if !httplex.ValidHeaderFieldName(k) { 359 return nil, fmt.Errorf("net/http: invalid header field name %q", k) 360 } 361 for _, v := range vv { 362 if !httplex.ValidHeaderFieldValue(v) { 363 return nil, fmt.Errorf("net/http: invalid header field value %q for key %v", v, k) 364 } 365 } 366 } 367 } 368 369 altProto, _ := t.altProto.Load().(map[string]RoundTripper) 370 if altRT := altProto[scheme]; altRT != nil { 371 if resp, err := altRT.RoundTrip(req); err != ErrSkipAltProtocol { 372 return resp, err 373 } 374 } 375 if !isHTTP { 376 req.closeBody() 377 return nil, &badStringError{"unsupported protocol scheme", scheme} 378 } 379 if req.Method != "" && !validMethod(req.Method) { 380 return nil, fmt.Errorf("net/http: invalid method %q", req.Method) 381 } 382 if req.URL.Host == "" { 383 req.closeBody() 384 return nil, errors.New("http: no Host in request URL") 385 } 386 387 for { 388 // treq gets modified by roundTrip, so we need to recreate for each retry. 389 treq := &transportRequest{Request: req, trace: trace} 390 cm, err := t.connectMethodForRequest(treq) 391 if err != nil { 392 req.closeBody() 393 return nil, err 394 } 395 396 // Get the cached or newly-created connection to either the 397 // host (for http or https), the http proxy, or the http proxy 398 // pre-CONNECTed to https server. In any case, we'll be ready 399 // to send it requests. 400 pconn, err := t.getConn(treq, cm) 401 if err != nil { 402 t.setReqCanceler(req, nil) 403 req.closeBody() 404 return nil, err 405 } 406 407 var resp *Response 408 if pconn.alt != nil { 409 // HTTP/2 path. 410 t.setReqCanceler(req, nil) // not cancelable with CancelRequest 411 resp, err = pconn.alt.RoundTrip(req) 412 } else { 413 resp, err = pconn.roundTrip(treq) 414 } 415 if err == nil { 416 return resp, nil 417 } 418 if !pconn.shouldRetryRequest(req, err) { 419 // Issue 16465: return underlying net.Conn.Read error from peek, 420 // as we've historically done. 421 if e, ok := err.(transportReadFromServerError); ok { 422 err = e.err 423 } 424 return nil, err 425 } 426 testHookRoundTripRetried() 427 428 // Rewind the body if we're able to. (HTTP/2 does this itself so we only 429 // need to do it for HTTP/1.1 connections.) 430 if req.GetBody != nil && pconn.alt == nil { 431 newReq := *req 432 var err error 433 newReq.Body, err = req.GetBody() 434 if err != nil { 435 return nil, err 436 } 437 req = &newReq 438 } 439 } 440 } 441 442 // shouldRetryRequest reports whether we should retry sending a failed 443 // HTTP request on a new connection. The non-nil input error is the 444 // error from roundTrip. 445 func (pc *persistConn) shouldRetryRequest(req *Request, err error) bool { 446 if err == http2ErrNoCachedConn { 447 // Issue 16582: if the user started a bunch of 448 // requests at once, they can all pick the same conn 449 // and violate the server's max concurrent streams. 450 // Instead, match the HTTP/1 behavior for now and dial 451 // again to get a new TCP connection, rather than failing 452 // this request. 453 return true 454 } 455 if err == errMissingHost { 456 // User error. 457 return false 458 } 459 if !pc.isReused() { 460 // This was a fresh connection. There's no reason the server 461 // should've hung up on us. 462 // 463 // Also, if we retried now, we could loop forever 464 // creating new connections and retrying if the server 465 // is just hanging up on us because it doesn't like 466 // our request (as opposed to sending an error). 467 return false 468 } 469 if _, ok := err.(nothingWrittenError); ok { 470 // We never wrote anything, so it's safe to retry, if there's no body or we 471 // can "rewind" the body with GetBody. 472 return req.outgoingLength() == 0 || req.GetBody != nil 473 } 474 if !req.isReplayable() { 475 // Don't retry non-idempotent requests. 476 return false 477 } 478 if _, ok := err.(transportReadFromServerError); ok { 479 // We got some non-EOF net.Conn.Read failure reading 480 // the 1st response byte from the server. 481 return true 482 } 483 if err == errServerClosedIdle { 484 // The server replied with io.EOF while we were trying to 485 // read the response. Probably an unfortunately keep-alive 486 // timeout, just as the client was writing a request. 487 return true 488 } 489 return false // conservatively 490 } 491 492 // ErrSkipAltProtocol is a sentinel error value defined by Transport.RegisterProtocol. 493 var ErrSkipAltProtocol = errors.New("net/http: skip alternate protocol") 494 495 // RegisterProtocol registers a new protocol with scheme. 496 // The Transport will pass requests using the given scheme to rt. 497 // It is rt's responsibility to simulate HTTP request semantics. 498 // 499 // RegisterProtocol can be used by other packages to provide 500 // implementations of protocol schemes like "ftp" or "file". 501 // 502 // If rt.RoundTrip returns ErrSkipAltProtocol, the Transport will 503 // handle the RoundTrip itself for that one request, as if the 504 // protocol were not registered. 505 func (t *Transport) RegisterProtocol(scheme string, rt RoundTripper) { 506 t.altMu.Lock() 507 defer t.altMu.Unlock() 508 oldMap, _ := t.altProto.Load().(map[string]RoundTripper) 509 if _, exists := oldMap[scheme]; exists { 510 panic("protocol " + scheme + " already registered") 511 } 512 newMap := make(map[string]RoundTripper) 513 for k, v := range oldMap { 514 newMap[k] = v 515 } 516 newMap[scheme] = rt 517 t.altProto.Store(newMap) 518 } 519 520 // CloseIdleConnections closes any connections which were previously 521 // connected from previous requests but are now sitting idle in 522 // a "keep-alive" state. It does not interrupt any connections currently 523 // in use. 524 func (t *Transport) CloseIdleConnections() { 525 t.nextProtoOnce.Do(t.onceSetNextProtoDefaults) 526 t.idleMu.Lock() 527 m := t.idleConn 528 t.idleConn = nil 529 t.idleConnCh = nil 530 t.wantIdle = true 531 t.idleLRU = connLRU{} 532 t.idleMu.Unlock() 533 for _, conns := range m { 534 for _, pconn := range conns { 535 pconn.close(errCloseIdleConns) 536 } 537 } 538 if t2 := t.h2transport; t2 != nil { 539 t2.CloseIdleConnections() 540 } 541 } 542 543 // CancelRequest cancels an in-flight request by closing its connection. 544 // CancelRequest should only be called after RoundTrip has returned. 545 // 546 // Deprecated: Use Request.WithContext to create a request with a 547 // cancelable context instead. CancelRequest cannot cancel HTTP/2 548 // requests. 549 func (t *Transport) CancelRequest(req *Request) { 550 t.cancelRequest(req, errRequestCanceled) 551 } 552 553 // Cancel an in-flight request, recording the error value. 554 func (t *Transport) cancelRequest(req *Request, err error) { 555 t.reqMu.Lock() 556 cancel := t.reqCanceler[req] 557 delete(t.reqCanceler, req) 558 t.reqMu.Unlock() 559 if cancel != nil { 560 cancel(err) 561 } 562 } 563 564 // 565 // Private implementation past this point. 566 // 567 568 var ( 569 httpProxyEnv = &envOnce{ 570 names: []string{"HTTP_PROXY", "http_proxy"}, 571 } 572 httpsProxyEnv = &envOnce{ 573 names: []string{"HTTPS_PROXY", "https_proxy"}, 574 } 575 noProxyEnv = &envOnce{ 576 names: []string{"NO_PROXY", "no_proxy"}, 577 } 578 ) 579 580 // envOnce looks up an environment variable (optionally by multiple 581 // names) once. It mitigates expensive lookups on some platforms 582 // (e.g. Windows). 583 type envOnce struct { 584 names []string 585 once sync.Once 586 val string 587 } 588 589 func (e *envOnce) Get() string { 590 e.once.Do(e.init) 591 return e.val 592 } 593 594 func (e *envOnce) init() { 595 for _, n := range e.names { 596 e.val = os.Getenv(n) 597 if e.val != "" { 598 return 599 } 600 } 601 } 602 603 // reset is used by tests 604 func (e *envOnce) reset() { 605 e.once = sync.Once{} 606 e.val = "" 607 } 608 609 func (t *Transport) connectMethodForRequest(treq *transportRequest) (cm connectMethod, err error) { 610 if port := treq.URL.Port(); !validPort(port) { 611 return cm, fmt.Errorf("invalid URL port %q", port) 612 } 613 cm.targetScheme = treq.URL.Scheme 614 cm.targetAddr = canonicalAddr(treq.URL) 615 if t.Proxy != nil { 616 cm.proxyURL, err = t.Proxy(treq.Request) 617 if err == nil && cm.proxyURL != nil { 618 if port := cm.proxyURL.Port(); !validPort(port) { 619 return cm, fmt.Errorf("invalid proxy URL port %q", port) 620 } 621 } 622 } 623 return cm, err 624 } 625 626 // proxyAuth returns the Proxy-Authorization header to set 627 // on requests, if applicable. 628 func (cm *connectMethod) proxyAuth() string { 629 if cm.proxyURL == nil { 630 return "" 631 } 632 if u := cm.proxyURL.User; u != nil { 633 username := u.Username() 634 password, _ := u.Password() 635 return "Basic " + basicAuth(username, password) 636 } 637 return "" 638 } 639 640 // error values for debugging and testing, not seen by users. 641 var ( 642 errKeepAlivesDisabled = errors.New("http: putIdleConn: keep alives disabled") 643 errConnBroken = errors.New("http: putIdleConn: connection is in bad state") 644 errWantIdle = errors.New("http: putIdleConn: CloseIdleConnections was called") 645 errTooManyIdle = errors.New("http: putIdleConn: too many idle connections") 646 errTooManyIdleHost = errors.New("http: putIdleConn: too many idle connections for host") 647 errCloseIdleConns = errors.New("http: CloseIdleConnections called") 648 errReadLoopExiting = errors.New("http: persistConn.readLoop exiting") 649 errServerClosedIdle = errors.New("http: server closed idle connection") 650 errIdleConnTimeout = errors.New("http: idle connection timeout") 651 errNotCachingH2Conn = errors.New("http: not caching alternate protocol's connections") 652 ) 653 654 // transportReadFromServerError is used by Transport.readLoop when the 655 // 1 byte peek read fails and we're actually anticipating a response. 656 // Usually this is just due to the inherent keep-alive shut down race, 657 // where the server closed the connection at the same time the client 658 // wrote. The underlying err field is usually io.EOF or some 659 // ECONNRESET sort of thing which varies by platform. But it might be 660 // the user's custom net.Conn.Read error too, so we carry it along for 661 // them to return from Transport.RoundTrip. 662 type transportReadFromServerError struct { 663 err error 664 } 665 666 func (e transportReadFromServerError) Error() string { 667 return fmt.Sprintf("net/http: Transport failed to read from server: %v", e.err) 668 } 669 670 func (t *Transport) putOrCloseIdleConn(pconn *persistConn) { 671 if err := t.tryPutIdleConn(pconn); err != nil { 672 pconn.close(err) 673 } 674 } 675 676 func (t *Transport) maxIdleConnsPerHost() int { 677 if v := t.MaxIdleConnsPerHost; v != 0 { 678 return v 679 } 680 return DefaultMaxIdleConnsPerHost 681 } 682 683 // tryPutIdleConn adds pconn to the list of idle persistent connections awaiting 684 // a new request. 685 // If pconn is no longer needed or not in a good state, tryPutIdleConn returns 686 // an error explaining why it wasn't registered. 687 // tryPutIdleConn does not close pconn. Use putOrCloseIdleConn instead for that. 688 func (t *Transport) tryPutIdleConn(pconn *persistConn) error { 689 if t.DisableKeepAlives || t.MaxIdleConnsPerHost < 0 { 690 return errKeepAlivesDisabled 691 } 692 if pconn.isBroken() { 693 return errConnBroken 694 } 695 if pconn.alt != nil { 696 return errNotCachingH2Conn 697 } 698 pconn.markReused() 699 key := pconn.cacheKey 700 701 t.idleMu.Lock() 702 defer t.idleMu.Unlock() 703 704 waitingDialer := t.idleConnCh[key] 705 select { 706 case waitingDialer <- pconn: 707 // We're done with this pconn and somebody else is 708 // currently waiting for a conn of this type (they're 709 // actively dialing, but this conn is ready 710 // first). Chrome calls this socket late binding. See 711 // https://insouciant.org/tech/connection-management-in-chromium/ 712 return nil 713 default: 714 if waitingDialer != nil { 715 // They had populated this, but their dial won 716 // first, so we can clean up this map entry. 717 delete(t.idleConnCh, key) 718 } 719 } 720 if t.wantIdle { 721 return errWantIdle 722 } 723 if t.idleConn == nil { 724 t.idleConn = make(map[connectMethodKey][]*persistConn) 725 } 726 idles := t.idleConn[key] 727 if len(idles) >= t.maxIdleConnsPerHost() { 728 return errTooManyIdleHost 729 } 730 for _, exist := range idles { 731 if exist == pconn { 732 log.Fatalf("dup idle pconn %p in freelist", pconn) 733 } 734 } 735 t.idleConn[key] = append(idles, pconn) 736 t.idleLRU.add(pconn) 737 if t.MaxIdleConns != 0 && t.idleLRU.len() > t.MaxIdleConns { 738 oldest := t.idleLRU.removeOldest() 739 oldest.close(errTooManyIdle) 740 t.removeIdleConnLocked(oldest) 741 } 742 if t.IdleConnTimeout > 0 { 743 if pconn.idleTimer != nil { 744 pconn.idleTimer.Reset(t.IdleConnTimeout) 745 } else { 746 pconn.idleTimer = time.AfterFunc(t.IdleConnTimeout, pconn.closeConnIfStillIdle) 747 } 748 } 749 pconn.idleAt = time.Now() 750 return nil 751 } 752 753 // getIdleConnCh returns a channel to receive and return idle 754 // persistent connection for the given connectMethod. 755 // It may return nil, if persistent connections are not being used. 756 func (t *Transport) getIdleConnCh(cm connectMethod) chan *persistConn { 757 if t.DisableKeepAlives { 758 return nil 759 } 760 key := cm.key() 761 t.idleMu.Lock() 762 defer t.idleMu.Unlock() 763 t.wantIdle = false 764 if t.idleConnCh == nil { 765 t.idleConnCh = make(map[connectMethodKey]chan *persistConn) 766 } 767 ch, ok := t.idleConnCh[key] 768 if !ok { 769 ch = make(chan *persistConn) 770 t.idleConnCh[key] = ch 771 } 772 return ch 773 } 774 775 func (t *Transport) getIdleConn(cm connectMethod) (pconn *persistConn, idleSince time.Time) { 776 key := cm.key() 777 t.idleMu.Lock() 778 defer t.idleMu.Unlock() 779 for { 780 pconns, ok := t.idleConn[key] 781 if !ok { 782 return nil, time.Time{} 783 } 784 if len(pconns) == 1 { 785 pconn = pconns[0] 786 delete(t.idleConn, key) 787 } else { 788 // 2 or more cached connections; use the most 789 // recently used one at the end. 790 pconn = pconns[len(pconns)-1] 791 t.idleConn[key] = pconns[:len(pconns)-1] 792 } 793 t.idleLRU.remove(pconn) 794 if pconn.isBroken() { 795 // There is a tiny window where this is 796 // possible, between the connecting dying and 797 // the persistConn readLoop calling 798 // Transport.removeIdleConn. Just skip it and 799 // carry on. 800 continue 801 } 802 if pconn.idleTimer != nil && !pconn.idleTimer.Stop() { 803 // We picked this conn at the ~same time it 804 // was expiring and it's trying to close 805 // itself in another goroutine. Don't use it. 806 continue 807 } 808 return pconn, pconn.idleAt 809 } 810 } 811 812 // removeIdleConn marks pconn as dead. 813 func (t *Transport) removeIdleConn(pconn *persistConn) { 814 t.idleMu.Lock() 815 defer t.idleMu.Unlock() 816 t.removeIdleConnLocked(pconn) 817 } 818 819 // t.idleMu must be held. 820 func (t *Transport) removeIdleConnLocked(pconn *persistConn) { 821 if pconn.idleTimer != nil { 822 pconn.idleTimer.Stop() 823 } 824 t.idleLRU.remove(pconn) 825 key := pconn.cacheKey 826 pconns := t.idleConn[key] 827 switch len(pconns) { 828 case 0: 829 // Nothing 830 case 1: 831 if pconns[0] == pconn { 832 delete(t.idleConn, key) 833 } 834 default: 835 for i, v := range pconns { 836 if v != pconn { 837 continue 838 } 839 // Slide down, keeping most recently-used 840 // conns at the end. 841 copy(pconns[i:], pconns[i+1:]) 842 t.idleConn[key] = pconns[:len(pconns)-1] 843 break 844 } 845 } 846 } 847 848 func (t *Transport) setReqCanceler(r *Request, fn func(error)) { 849 t.reqMu.Lock() 850 defer t.reqMu.Unlock() 851 if t.reqCanceler == nil { 852 t.reqCanceler = make(map[*Request]func(error)) 853 } 854 if fn != nil { 855 t.reqCanceler[r] = fn 856 } else { 857 delete(t.reqCanceler, r) 858 } 859 } 860 861 // replaceReqCanceler replaces an existing cancel function. If there is no cancel function 862 // for the request, we don't set the function and return false. 863 // Since CancelRequest will clear the canceler, we can use the return value to detect if 864 // the request was canceled since the last setReqCancel call. 865 func (t *Transport) replaceReqCanceler(r *Request, fn func(error)) bool { 866 t.reqMu.Lock() 867 defer t.reqMu.Unlock() 868 _, ok := t.reqCanceler[r] 869 if !ok { 870 return false 871 } 872 if fn != nil { 873 t.reqCanceler[r] = fn 874 } else { 875 delete(t.reqCanceler, r) 876 } 877 return true 878 } 879 880 var zeroDialer net.Dialer 881 882 func (t *Transport) dial(ctx context.Context, network, addr string) (net.Conn, error) { 883 if t.DialContext != nil { 884 return t.DialContext(ctx, network, addr) 885 } 886 if t.Dial != nil { 887 c, err := t.Dial(network, addr) 888 if c == nil && err == nil { 889 err = errors.New("net/http: Transport.Dial hook returned (nil, nil)") 890 } 891 return c, err 892 } 893 return zeroDialer.DialContext(ctx, network, addr) 894 } 895 896 // getConn dials and creates a new persistConn to the target as 897 // specified in the connectMethod. This includes doing a proxy CONNECT 898 // and/or setting up TLS. If this doesn't return an error, the persistConn 899 // is ready to write requests to. 900 func (t *Transport) getConn(treq *transportRequest, cm connectMethod) (*persistConn, error) { 901 req := treq.Request 902 trace := treq.trace 903 ctx := req.Context() 904 if trace != nil && trace.GetConn != nil { 905 trace.GetConn(cm.addr()) 906 } 907 if pc, idleSince := t.getIdleConn(cm); pc != nil { 908 if trace != nil && trace.GotConn != nil { 909 trace.GotConn(pc.gotIdleConnTrace(idleSince)) 910 } 911 // set request canceler to some non-nil function so we 912 // can detect whether it was cleared between now and when 913 // we enter roundTrip 914 t.setReqCanceler(req, func(error) {}) 915 return pc, nil 916 } 917 918 type dialRes struct { 919 pc *persistConn 920 err error 921 } 922 dialc := make(chan dialRes) 923 924 // Copy these hooks so we don't race on the postPendingDial in 925 // the goroutine we launch. Issue 11136. 926 testHookPrePendingDial := testHookPrePendingDial 927 testHookPostPendingDial := testHookPostPendingDial 928 929 handlePendingDial := func() { 930 testHookPrePendingDial() 931 go func() { 932 if v := <-dialc; v.err == nil { 933 t.putOrCloseIdleConn(v.pc) 934 } 935 testHookPostPendingDial() 936 }() 937 } 938 939 cancelc := make(chan error, 1) 940 t.setReqCanceler(req, func(err error) { cancelc <- err }) 941 942 go func() { 943 pc, err := t.dialConn(ctx, cm) 944 dialc <- dialRes{pc, err} 945 }() 946 947 idleConnCh := t.getIdleConnCh(cm) 948 select { 949 case v := <-dialc: 950 // Our dial finished. 951 if v.pc != nil { 952 if trace != nil && trace.GotConn != nil && v.pc.alt == nil { 953 trace.GotConn(httptrace.GotConnInfo{Conn: v.pc.conn}) 954 } 955 return v.pc, nil 956 } 957 // Our dial failed. See why to return a nicer error 958 // value. 959 select { 960 case <-req.Cancel: 961 // It was an error due to cancelation, so prioritize that 962 // error value. (Issue 16049) 963 return nil, errRequestCanceledConn 964 case <-req.Context().Done(): 965 return nil, req.Context().Err() 966 case err := <-cancelc: 967 if err == errRequestCanceled { 968 err = errRequestCanceledConn 969 } 970 return nil, err 971 default: 972 // It wasn't an error due to cancelation, so 973 // return the original error message: 974 return nil, v.err 975 } 976 case pc := <-idleConnCh: 977 // Another request finished first and its net.Conn 978 // became available before our dial. Or somebody 979 // else's dial that they didn't use. 980 // But our dial is still going, so give it away 981 // when it finishes: 982 handlePendingDial() 983 if trace != nil && trace.GotConn != nil { 984 trace.GotConn(httptrace.GotConnInfo{Conn: pc.conn, Reused: pc.isReused()}) 985 } 986 return pc, nil 987 case <-req.Cancel: 988 handlePendingDial() 989 return nil, errRequestCanceledConn 990 case <-req.Context().Done(): 991 handlePendingDial() 992 return nil, req.Context().Err() 993 case err := <-cancelc: 994 handlePendingDial() 995 if err == errRequestCanceled { 996 err = errRequestCanceledConn 997 } 998 return nil, err 999 } 1000 } 1001 1002 type oneConnDialer <-chan net.Conn 1003 1004 func newOneConnDialer(c net.Conn) proxy.Dialer { 1005 ch := make(chan net.Conn, 1) 1006 ch <- c 1007 return oneConnDialer(ch) 1008 } 1009 1010 func (d oneConnDialer) Dial(network, addr string) (net.Conn, error) { 1011 select { 1012 case c := <-d: 1013 return c, nil 1014 default: 1015 return nil, io.EOF 1016 } 1017 } 1018 1019 func (t *Transport) dialConn(ctx context.Context, cm connectMethod) (*persistConn, error) { 1020 pconn := &persistConn{ 1021 t: t, 1022 cacheKey: cm.key(), 1023 reqch: make(chan requestAndChan, 1), 1024 writech: make(chan writeRequest, 1), 1025 closech: make(chan struct{}), 1026 writeErrCh: make(chan error, 1), 1027 writeLoopDone: make(chan struct{}), 1028 } 1029 trace := httptrace.ContextClientTrace(ctx) 1030 tlsDial := t.DialTLS != nil && cm.targetScheme == "https" && cm.proxyURL == nil 1031 if tlsDial { 1032 var err error 1033 pconn.conn, err = t.DialTLS("tcp", cm.addr()) 1034 if err != nil { 1035 return nil, err 1036 } 1037 if pconn.conn == nil { 1038 return nil, errors.New("net/http: Transport.DialTLS returned (nil, nil)") 1039 } 1040 if tc, ok := pconn.conn.(*tls.Conn); ok { 1041 // Handshake here, in case DialTLS didn't. TLSNextProto below 1042 // depends on it for knowing the connection state. 1043 if trace != nil && trace.TLSHandshakeStart != nil { 1044 trace.TLSHandshakeStart() 1045 } 1046 if err := tc.Handshake(); err != nil { 1047 go pconn.conn.Close() 1048 if trace != nil && trace.TLSHandshakeDone != nil { 1049 trace.TLSHandshakeDone(tls.ConnectionState{}, err) 1050 } 1051 return nil, err 1052 } 1053 cs := tc.ConnectionState() 1054 if trace != nil && trace.TLSHandshakeDone != nil { 1055 trace.TLSHandshakeDone(cs, nil) 1056 } 1057 pconn.tlsState = &cs 1058 } 1059 } else { 1060 conn, err := t.dial(ctx, "tcp", cm.addr()) 1061 if err != nil { 1062 if cm.proxyURL != nil { 1063 // Return a typed error, per Issue 16997: 1064 err = &net.OpError{Op: "proxyconnect", Net: "tcp", Err: err} 1065 } 1066 return nil, err 1067 } 1068 pconn.conn = conn 1069 } 1070 1071 // Proxy setup. 1072 switch { 1073 case cm.proxyURL == nil: 1074 // Do nothing. Not using a proxy. 1075 case cm.proxyURL.Scheme == "socks5": 1076 conn := pconn.conn 1077 var auth *proxy.Auth 1078 if u := cm.proxyURL.User; u != nil { 1079 auth = &proxy.Auth{} 1080 auth.User = u.Username() 1081 auth.Password, _ = u.Password() 1082 } 1083 p, err := proxy.SOCKS5("", cm.addr(), auth, newOneConnDialer(conn)) 1084 if err != nil { 1085 conn.Close() 1086 return nil, err 1087 } 1088 if _, err := p.Dial("tcp", cm.targetAddr); err != nil { 1089 conn.Close() 1090 return nil, err 1091 } 1092 case cm.targetScheme == "http": 1093 pconn.isProxy = true 1094 if pa := cm.proxyAuth(); pa != "" { 1095 pconn.mutateHeaderFunc = func(h Header) { 1096 h.Set("Proxy-Authorization", pa) 1097 } 1098 } 1099 case cm.targetScheme == "https": 1100 conn := pconn.conn 1101 hdr := t.ProxyConnectHeader 1102 if hdr == nil { 1103 hdr = make(Header) 1104 } 1105 connectReq := &Request{ 1106 Method: "CONNECT", 1107 URL: &url.URL{Opaque: cm.targetAddr}, 1108 Host: cm.targetAddr, 1109 Header: hdr, 1110 } 1111 if pa := cm.proxyAuth(); pa != "" { 1112 connectReq.Header.Set("Proxy-Authorization", pa) 1113 } 1114 connectReq.Write(conn) 1115 1116 // Read response. 1117 // Okay to use and discard buffered reader here, because 1118 // TLS server will not speak until spoken to. 1119 br := bufio.NewReader(conn) 1120 resp, err := ReadResponse(br, connectReq) 1121 if err != nil { 1122 conn.Close() 1123 return nil, err 1124 } 1125 if resp.StatusCode != 200 { 1126 f := strings.SplitN(resp.Status, " ", 2) 1127 conn.Close() 1128 return nil, errors.New(f[1]) 1129 } 1130 } 1131 1132 if cm.targetScheme == "https" && !tlsDial { 1133 // Initiate TLS and check remote host name against certificate. 1134 cfg := cloneTLSConfig(t.TLSClientConfig) 1135 if cfg.ServerName == "" { 1136 cfg.ServerName = cm.tlsHost() 1137 } 1138 plainConn := pconn.conn 1139 tlsConn := tls.Client(plainConn, cfg) 1140 errc := make(chan error, 2) 1141 var timer *time.Timer // for canceling TLS handshake 1142 if d := t.TLSHandshakeTimeout; d != 0 { 1143 timer = time.AfterFunc(d, func() { 1144 errc <- tlsHandshakeTimeoutError{} 1145 }) 1146 } 1147 go func() { 1148 if trace != nil && trace.TLSHandshakeStart != nil { 1149 trace.TLSHandshakeStart() 1150 } 1151 err := tlsConn.Handshake() 1152 if timer != nil { 1153 timer.Stop() 1154 } 1155 errc <- err 1156 }() 1157 if err := <-errc; err != nil { 1158 plainConn.Close() 1159 if trace != nil && trace.TLSHandshakeDone != nil { 1160 trace.TLSHandshakeDone(tls.ConnectionState{}, err) 1161 } 1162 return nil, err 1163 } 1164 if !cfg.InsecureSkipVerify { 1165 if err := tlsConn.VerifyHostname(cfg.ServerName); err != nil { 1166 plainConn.Close() 1167 return nil, err 1168 } 1169 } 1170 cs := tlsConn.ConnectionState() 1171 if trace != nil && trace.TLSHandshakeDone != nil { 1172 trace.TLSHandshakeDone(cs, nil) 1173 } 1174 pconn.tlsState = &cs 1175 pconn.conn = tlsConn 1176 } 1177 1178 if s := pconn.tlsState; s != nil && s.NegotiatedProtocolIsMutual && s.NegotiatedProtocol != "" { 1179 if next, ok := t.TLSNextProto[s.NegotiatedProtocol]; ok { 1180 return &persistConn{alt: next(cm.targetAddr, pconn.conn.(*tls.Conn))}, nil 1181 } 1182 } 1183 1184 pconn.br = bufio.NewReader(pconn) 1185 pconn.bw = bufio.NewWriter(persistConnWriter{pconn}) 1186 go pconn.readLoop() 1187 go pconn.writeLoop() 1188 return pconn, nil 1189 } 1190 1191 // persistConnWriter is the io.Writer written to by pc.bw. 1192 // It accumulates the number of bytes written to the underlying conn, 1193 // so the retry logic can determine whether any bytes made it across 1194 // the wire. 1195 // This is exactly 1 pointer field wide so it can go into an interface 1196 // without allocation. 1197 type persistConnWriter struct { 1198 pc *persistConn 1199 } 1200 1201 func (w persistConnWriter) Write(p []byte) (n int, err error) { 1202 n, err = w.pc.conn.Write(p) 1203 w.pc.nwrite += int64(n) 1204 return 1205 } 1206 1207 // useProxy reports whether requests to addr should use a proxy, 1208 // according to the NO_PROXY or no_proxy environment variable. 1209 // addr is always a canonicalAddr with a host and port. 1210 func useProxy(addr string) bool { 1211 if len(addr) == 0 { 1212 return true 1213 } 1214 host, _, err := net.SplitHostPort(addr) 1215 if err != nil { 1216 return false 1217 } 1218 if host == "localhost" { 1219 return false 1220 } 1221 if ip := net.ParseIP(host); ip != nil { 1222 if ip.IsLoopback() { 1223 return false 1224 } 1225 } 1226 1227 noProxy := noProxyEnv.Get() 1228 if noProxy == "*" { 1229 return false 1230 } 1231 1232 addr = strings.ToLower(strings.TrimSpace(addr)) 1233 if hasPort(addr) { 1234 addr = addr[:strings.LastIndex(addr, ":")] 1235 } 1236 1237 for _, p := range strings.Split(noProxy, ",") { 1238 p = strings.ToLower(strings.TrimSpace(p)) 1239 if len(p) == 0 { 1240 continue 1241 } 1242 if hasPort(p) { 1243 p = p[:strings.LastIndex(p, ":")] 1244 } 1245 if addr == p { 1246 return false 1247 } 1248 if len(p) == 0 { 1249 // There is no host part, likely the entry is malformed; ignore. 1250 continue 1251 } 1252 if p[0] == '.' && (strings.HasSuffix(addr, p) || addr == p[1:]) { 1253 // no_proxy ".foo.com" matches "bar.foo.com" or "foo.com" 1254 return false 1255 } 1256 if p[0] != '.' && strings.HasSuffix(addr, p) && addr[len(addr)-len(p)-1] == '.' { 1257 // no_proxy "foo.com" matches "bar.foo.com" 1258 return false 1259 } 1260 } 1261 return true 1262 } 1263 1264 // connectMethod is the map key (in its String form) for keeping persistent 1265 // TCP connections alive for subsequent HTTP requests. 1266 // 1267 // A connect method may be of the following types: 1268 // 1269 // Cache key form Description 1270 // ----------------- ------------------------- 1271 // |http|foo.com http directly to server, no proxy 1272 // |https|foo.com https directly to server, no proxy 1273 // http://proxy.com|https|foo.com http to proxy, then CONNECT to foo.com 1274 // http://proxy.com|http http to proxy, http to anywhere after that 1275 // socks5://proxy.com|http|foo.com socks5 to proxy, then http to foo.com 1276 // socks5://proxy.com|https|foo.com socks5 to proxy, then https to foo.com 1277 // 1278 // Note: no support to https to the proxy yet. 1279 // 1280 type connectMethod struct { 1281 proxyURL *url.URL // nil for no proxy, else full proxy URL 1282 targetScheme string // "http" or "https" 1283 targetAddr string // Not used if http proxy + http targetScheme (4th example in table) 1284 } 1285 1286 func (cm *connectMethod) key() connectMethodKey { 1287 proxyStr := "" 1288 targetAddr := cm.targetAddr 1289 if cm.proxyURL != nil { 1290 proxyStr = cm.proxyURL.String() 1291 if strings.HasPrefix(cm.proxyURL.Scheme, "http") && cm.targetScheme == "http" { 1292 targetAddr = "" 1293 } 1294 } 1295 return connectMethodKey{ 1296 proxy: proxyStr, 1297 scheme: cm.targetScheme, 1298 addr: targetAddr, 1299 } 1300 } 1301 1302 // addr returns the first hop "host:port" to which we need to TCP connect. 1303 func (cm *connectMethod) addr() string { 1304 if cm.proxyURL != nil { 1305 return canonicalAddr(cm.proxyURL) 1306 } 1307 return cm.targetAddr 1308 } 1309 1310 // tlsHost returns the host name to match against the peer's 1311 // TLS certificate. 1312 func (cm *connectMethod) tlsHost() string { 1313 h := cm.targetAddr 1314 if hasPort(h) { 1315 h = h[:strings.LastIndex(h, ":")] 1316 } 1317 return h 1318 } 1319 1320 // connectMethodKey is the map key version of connectMethod, with a 1321 // stringified proxy URL (or the empty string) instead of a pointer to 1322 // a URL. 1323 type connectMethodKey struct { 1324 proxy, scheme, addr string 1325 } 1326 1327 func (k connectMethodKey) String() string { 1328 // Only used by tests. 1329 return fmt.Sprintf("%s|%s|%s", k.proxy, k.scheme, k.addr) 1330 } 1331 1332 // persistConn wraps a connection, usually a persistent one 1333 // (but may be used for non-keep-alive requests as well) 1334 type persistConn struct { 1335 // alt optionally specifies the TLS NextProto RoundTripper. 1336 // This is used for HTTP/2 today and future protocols later. 1337 // If it's non-nil, the rest of the fields are unused. 1338 alt RoundTripper 1339 1340 t *Transport 1341 cacheKey connectMethodKey 1342 conn net.Conn 1343 tlsState *tls.ConnectionState 1344 br *bufio.Reader // from conn 1345 bw *bufio.Writer // to conn 1346 nwrite int64 // bytes written 1347 reqch chan requestAndChan // written by roundTrip; read by readLoop 1348 writech chan writeRequest // written by roundTrip; read by writeLoop 1349 closech chan struct{} // closed when conn closed 1350 isProxy bool 1351 sawEOF bool // whether we've seen EOF from conn; owned by readLoop 1352 readLimit int64 // bytes allowed to be read; owned by readLoop 1353 // writeErrCh passes the request write error (usually nil) 1354 // from the writeLoop goroutine to the readLoop which passes 1355 // it off to the res.Body reader, which then uses it to decide 1356 // whether or not a connection can be reused. Issue 7569. 1357 writeErrCh chan error 1358 1359 writeLoopDone chan struct{} // closed when write loop ends 1360 1361 // Both guarded by Transport.idleMu: 1362 idleAt time.Time // time it last become idle 1363 idleTimer *time.Timer // holding an AfterFunc to close it 1364 1365 mu sync.Mutex // guards following fields 1366 numExpectedResponses int 1367 closed error // set non-nil when conn is closed, before closech is closed 1368 canceledErr error // set non-nil if conn is canceled 1369 broken bool // an error has happened on this connection; marked broken so it's not reused. 1370 reused bool // whether conn has had successful request/response and is being reused. 1371 // mutateHeaderFunc is an optional func to modify extra 1372 // headers on each outbound request before it's written. (the 1373 // original Request given to RoundTrip is not modified) 1374 mutateHeaderFunc func(Header) 1375 } 1376 1377 func (pc *persistConn) maxHeaderResponseSize() int64 { 1378 if v := pc.t.MaxResponseHeaderBytes; v != 0 { 1379 return v 1380 } 1381 return 10 << 20 // conservative default; same as http2 1382 } 1383 1384 func (pc *persistConn) Read(p []byte) (n int, err error) { 1385 if pc.readLimit <= 0 { 1386 return 0, fmt.Errorf("read limit of %d bytes exhausted", pc.maxHeaderResponseSize()) 1387 } 1388 if int64(len(p)) > pc.readLimit { 1389 p = p[:pc.readLimit] 1390 } 1391 n, err = pc.conn.Read(p) 1392 if err == io.EOF { 1393 pc.sawEOF = true 1394 } 1395 pc.readLimit -= int64(n) 1396 return 1397 } 1398 1399 // isBroken reports whether this connection is in a known broken state. 1400 func (pc *persistConn) isBroken() bool { 1401 pc.mu.Lock() 1402 b := pc.closed != nil 1403 pc.mu.Unlock() 1404 return b 1405 } 1406 1407 // canceled returns non-nil if the connection was closed due to 1408 // CancelRequest or due to context cancelation. 1409 func (pc *persistConn) canceled() error { 1410 pc.mu.Lock() 1411 defer pc.mu.Unlock() 1412 return pc.canceledErr 1413 } 1414 1415 // isReused reports whether this connection is in a known broken state. 1416 func (pc *persistConn) isReused() bool { 1417 pc.mu.Lock() 1418 r := pc.reused 1419 pc.mu.Unlock() 1420 return r 1421 } 1422 1423 func (pc *persistConn) gotIdleConnTrace(idleAt time.Time) (t httptrace.GotConnInfo) { 1424 pc.mu.Lock() 1425 defer pc.mu.Unlock() 1426 t.Reused = pc.reused 1427 t.Conn = pc.conn 1428 t.WasIdle = true 1429 if !idleAt.IsZero() { 1430 t.IdleTime = time.Since(idleAt) 1431 } 1432 return 1433 } 1434 1435 func (pc *persistConn) cancelRequest(err error) { 1436 pc.mu.Lock() 1437 defer pc.mu.Unlock() 1438 pc.canceledErr = err 1439 pc.closeLocked(errRequestCanceled) 1440 } 1441 1442 // closeConnIfStillIdle closes the connection if it's still sitting idle. 1443 // This is what's called by the persistConn's idleTimer, and is run in its 1444 // own goroutine. 1445 func (pc *persistConn) closeConnIfStillIdle() { 1446 t := pc.t 1447 t.idleMu.Lock() 1448 defer t.idleMu.Unlock() 1449 if _, ok := t.idleLRU.m[pc]; !ok { 1450 // Not idle. 1451 return 1452 } 1453 t.removeIdleConnLocked(pc) 1454 pc.close(errIdleConnTimeout) 1455 } 1456 1457 // mapRoundTripError returns the appropriate error value for 1458 // persistConn.roundTrip. 1459 // 1460 // The provided err is the first error that (*persistConn).roundTrip 1461 // happened to receive from its select statement. 1462 // 1463 // The startBytesWritten value should be the value of pc.nwrite before the roundTrip 1464 // started writing the request. 1465 func (pc *persistConn) mapRoundTripError(req *transportRequest, startBytesWritten int64, err error) error { 1466 if err == nil { 1467 return nil 1468 } 1469 1470 // If the request was canceled, that's better than network 1471 // failures that were likely the result of tearing down the 1472 // connection. 1473 if cerr := pc.canceled(); cerr != nil { 1474 return cerr 1475 } 1476 1477 // See if an error was set explicitly. 1478 req.mu.Lock() 1479 reqErr := req.err 1480 req.mu.Unlock() 1481 if reqErr != nil { 1482 return reqErr 1483 } 1484 1485 if err == errServerClosedIdle { 1486 // Don't decorate 1487 return err 1488 } 1489 1490 if _, ok := err.(transportReadFromServerError); ok { 1491 // Don't decorate 1492 return err 1493 } 1494 if pc.isBroken() { 1495 <-pc.writeLoopDone 1496 if pc.nwrite == startBytesWritten { 1497 return nothingWrittenError{err} 1498 } 1499 return fmt.Errorf("net/http: HTTP/1.x transport connection broken: %v", err) 1500 } 1501 return err 1502 } 1503 1504 func (pc *persistConn) readLoop() { 1505 closeErr := errReadLoopExiting // default value, if not changed below 1506 defer func() { 1507 pc.close(closeErr) 1508 pc.t.removeIdleConn(pc) 1509 }() 1510 1511 tryPutIdleConn := func(trace *httptrace.ClientTrace) bool { 1512 if err := pc.t.tryPutIdleConn(pc); err != nil { 1513 closeErr = err 1514 if trace != nil && trace.PutIdleConn != nil && err != errKeepAlivesDisabled { 1515 trace.PutIdleConn(err) 1516 } 1517 return false 1518 } 1519 if trace != nil && trace.PutIdleConn != nil { 1520 trace.PutIdleConn(nil) 1521 } 1522 return true 1523 } 1524 1525 // eofc is used to block caller goroutines reading from Response.Body 1526 // at EOF until this goroutines has (potentially) added the connection 1527 // back to the idle pool. 1528 eofc := make(chan struct{}) 1529 defer close(eofc) // unblock reader on errors 1530 1531 // Read this once, before loop starts. (to avoid races in tests) 1532 testHookMu.Lock() 1533 testHookReadLoopBeforeNextRead := testHookReadLoopBeforeNextRead 1534 testHookMu.Unlock() 1535 1536 alive := true 1537 for alive { 1538 pc.readLimit = pc.maxHeaderResponseSize() 1539 _, err := pc.br.Peek(1) 1540 1541 pc.mu.Lock() 1542 if pc.numExpectedResponses == 0 { 1543 pc.readLoopPeekFailLocked(err) 1544 pc.mu.Unlock() 1545 return 1546 } 1547 pc.mu.Unlock() 1548 1549 rc := <-pc.reqch 1550 trace := httptrace.ContextClientTrace(rc.req.Context()) 1551 1552 var resp *Response 1553 if err == nil { 1554 resp, err = pc.readResponse(rc, trace) 1555 } else { 1556 err = transportReadFromServerError{err} 1557 closeErr = err 1558 } 1559 1560 if err != nil { 1561 if pc.readLimit <= 0 { 1562 err = fmt.Errorf("net/http: server response headers exceeded %d bytes; aborted", pc.maxHeaderResponseSize()) 1563 } 1564 1565 select { 1566 case rc.ch <- responseAndError{err: err}: 1567 case <-rc.callerGone: 1568 return 1569 } 1570 return 1571 } 1572 pc.readLimit = maxInt64 // effictively no limit for response bodies 1573 1574 pc.mu.Lock() 1575 pc.numExpectedResponses-- 1576 pc.mu.Unlock() 1577 1578 hasBody := rc.req.Method != "HEAD" && resp.ContentLength != 0 1579 1580 if resp.Close || rc.req.Close || resp.StatusCode <= 199 { 1581 // Don't do keep-alive on error if either party requested a close 1582 // or we get an unexpected informational (1xx) response. 1583 // StatusCode 100 is already handled above. 1584 alive = false 1585 } 1586 1587 if !hasBody { 1588 pc.t.setReqCanceler(rc.req, nil) 1589 1590 // Put the idle conn back into the pool before we send the response 1591 // so if they process it quickly and make another request, they'll 1592 // get this same conn. But we use the unbuffered channel 'rc' 1593 // to guarantee that persistConn.roundTrip got out of its select 1594 // potentially waiting for this persistConn to close. 1595 // but after 1596 alive = alive && 1597 !pc.sawEOF && 1598 pc.wroteRequest() && 1599 tryPutIdleConn(trace) 1600 1601 select { 1602 case rc.ch <- responseAndError{res: resp}: 1603 case <-rc.callerGone: 1604 return 1605 } 1606 1607 // Now that they've read from the unbuffered channel, they're safely 1608 // out of the select that also waits on this goroutine to die, so 1609 // we're allowed to exit now if needed (if alive is false) 1610 testHookReadLoopBeforeNextRead() 1611 continue 1612 } 1613 1614 waitForBodyRead := make(chan bool, 2) 1615 body := &bodyEOFSignal{ 1616 body: resp.Body, 1617 earlyCloseFn: func() error { 1618 waitForBodyRead <- false 1619 return nil 1620 1621 }, 1622 fn: func(err error) error { 1623 isEOF := err == io.EOF 1624 waitForBodyRead <- isEOF 1625 if isEOF { 1626 <-eofc // see comment above eofc declaration 1627 } else if err != nil { 1628 if cerr := pc.canceled(); cerr != nil { 1629 return cerr 1630 } 1631 } 1632 return err 1633 }, 1634 } 1635 1636 resp.Body = body 1637 if rc.addedGzip && strings.EqualFold(resp.Header.Get("Content-Encoding"), "gzip") { 1638 resp.Body = &gzipReader{body: body} 1639 resp.Header.Del("Content-Encoding") 1640 resp.Header.Del("Content-Length") 1641 resp.ContentLength = -1 1642 resp.Uncompressed = true 1643 } 1644 1645 select { 1646 case rc.ch <- responseAndError{res: resp}: 1647 case <-rc.callerGone: 1648 return 1649 } 1650 1651 // Before looping back to the top of this function and peeking on 1652 // the bufio.Reader, wait for the caller goroutine to finish 1653 // reading the response body. (or for cancelation or death) 1654 select { 1655 case bodyEOF := <-waitForBodyRead: 1656 pc.t.setReqCanceler(rc.req, nil) // before pc might return to idle pool 1657 alive = alive && 1658 bodyEOF && 1659 !pc.sawEOF && 1660 pc.wroteRequest() && 1661 tryPutIdleConn(trace) 1662 if bodyEOF { 1663 eofc <- struct{}{} 1664 } 1665 case <-rc.req.Cancel: 1666 alive = false 1667 pc.t.CancelRequest(rc.req) 1668 case <-rc.req.Context().Done(): 1669 alive = false 1670 pc.t.cancelRequest(rc.req, rc.req.Context().Err()) 1671 case <-pc.closech: 1672 alive = false 1673 } 1674 1675 testHookReadLoopBeforeNextRead() 1676 } 1677 } 1678 1679 func (pc *persistConn) readLoopPeekFailLocked(peekErr error) { 1680 if pc.closed != nil { 1681 return 1682 } 1683 if n := pc.br.Buffered(); n > 0 { 1684 buf, _ := pc.br.Peek(n) 1685 log.Printf("Unsolicited response received on idle HTTP channel starting with %q; err=%v", buf, peekErr) 1686 } 1687 if peekErr == io.EOF { 1688 // common case. 1689 pc.closeLocked(errServerClosedIdle) 1690 } else { 1691 pc.closeLocked(fmt.Errorf("readLoopPeekFailLocked: %v", peekErr)) 1692 } 1693 } 1694 1695 // readResponse reads an HTTP response (or two, in the case of "Expect: 1696 // 100-continue") from the server. It returns the final non-100 one. 1697 // trace is optional. 1698 func (pc *persistConn) readResponse(rc requestAndChan, trace *httptrace.ClientTrace) (resp *Response, err error) { 1699 if trace != nil && trace.GotFirstResponseByte != nil { 1700 if peek, err := pc.br.Peek(1); err == nil && len(peek) == 1 { 1701 trace.GotFirstResponseByte() 1702 } 1703 } 1704 resp, err = ReadResponse(pc.br, rc.req) 1705 if err != nil { 1706 return 1707 } 1708 if rc.continueCh != nil { 1709 if resp.StatusCode == 100 { 1710 if trace != nil && trace.Got100Continue != nil { 1711 trace.Got100Continue() 1712 } 1713 rc.continueCh <- struct{}{} 1714 } else { 1715 close(rc.continueCh) 1716 } 1717 } 1718 if resp.StatusCode == 100 { 1719 pc.readLimit = pc.maxHeaderResponseSize() // reset the limit 1720 resp, err = ReadResponse(pc.br, rc.req) 1721 if err != nil { 1722 return 1723 } 1724 } 1725 resp.TLS = pc.tlsState 1726 return 1727 } 1728 1729 // waitForContinue returns the function to block until 1730 // any response, timeout or connection close. After any of them, 1731 // the function returns a bool which indicates if the body should be sent. 1732 func (pc *persistConn) waitForContinue(continueCh <-chan struct{}) func() bool { 1733 if continueCh == nil { 1734 return nil 1735 } 1736 return func() bool { 1737 timer := time.NewTimer(pc.t.ExpectContinueTimeout) 1738 defer timer.Stop() 1739 1740 select { 1741 case _, ok := <-continueCh: 1742 return ok 1743 case <-timer.C: 1744 return true 1745 case <-pc.closech: 1746 return false 1747 } 1748 } 1749 } 1750 1751 // nothingWrittenError wraps a write errors which ended up writing zero bytes. 1752 type nothingWrittenError struct { 1753 error 1754 } 1755 1756 func (pc *persistConn) writeLoop() { 1757 defer close(pc.writeLoopDone) 1758 for { 1759 select { 1760 case wr := <-pc.writech: 1761 startBytesWritten := pc.nwrite 1762 err := wr.req.Request.write(pc.bw, pc.isProxy, wr.req.extra, pc.waitForContinue(wr.continueCh)) 1763 if bre, ok := err.(requestBodyReadError); ok { 1764 err = bre.error 1765 // Errors reading from the user's 1766 // Request.Body are high priority. 1767 // Set it here before sending on the 1768 // channels below or calling 1769 // pc.close() which tears town 1770 // connections and causes other 1771 // errors. 1772 wr.req.setError(err) 1773 } 1774 if err == nil { 1775 err = pc.bw.Flush() 1776 } 1777 if err != nil { 1778 wr.req.Request.closeBody() 1779 if pc.nwrite == startBytesWritten { 1780 err = nothingWrittenError{err} 1781 } 1782 } 1783 pc.writeErrCh <- err // to the body reader, which might recycle us 1784 wr.ch <- err // to the roundTrip function 1785 if err != nil { 1786 pc.close(err) 1787 return 1788 } 1789 case <-pc.closech: 1790 return 1791 } 1792 } 1793 } 1794 1795 // wroteRequest is a check before recycling a connection that the previous write 1796 // (from writeLoop above) happened and was successful. 1797 func (pc *persistConn) wroteRequest() bool { 1798 select { 1799 case err := <-pc.writeErrCh: 1800 // Common case: the write happened well before the response, so 1801 // avoid creating a timer. 1802 return err == nil 1803 default: 1804 // Rare case: the request was written in writeLoop above but 1805 // before it could send to pc.writeErrCh, the reader read it 1806 // all, processed it, and called us here. In this case, give the 1807 // write goroutine a bit of time to finish its send. 1808 // 1809 // Less rare case: We also get here in the legitimate case of 1810 // Issue 7569, where the writer is still writing (or stalled), 1811 // but the server has already replied. In this case, we don't 1812 // want to wait too long, and we want to return false so this 1813 // connection isn't re-used. 1814 select { 1815 case err := <-pc.writeErrCh: 1816 return err == nil 1817 case <-time.After(50 * time.Millisecond): 1818 return false 1819 } 1820 } 1821 } 1822 1823 // responseAndError is how the goroutine reading from an HTTP/1 server 1824 // communicates with the goroutine doing the RoundTrip. 1825 type responseAndError struct { 1826 res *Response // else use this response (see res method) 1827 err error 1828 } 1829 1830 type requestAndChan struct { 1831 req *Request 1832 ch chan responseAndError // unbuffered; always send in select on callerGone 1833 1834 // whether the Transport (as opposed to the user client code) 1835 // added the Accept-Encoding gzip header. If the Transport 1836 // set it, only then do we transparently decode the gzip. 1837 addedGzip bool 1838 1839 // Optional blocking chan for Expect: 100-continue (for send). 1840 // If the request has an "Expect: 100-continue" header and 1841 // the server responds 100 Continue, readLoop send a value 1842 // to writeLoop via this chan. 1843 continueCh chan<- struct{} 1844 1845 callerGone <-chan struct{} // closed when roundTrip caller has returned 1846 } 1847 1848 // A writeRequest is sent by the readLoop's goroutine to the 1849 // writeLoop's goroutine to write a request while the read loop 1850 // concurrently waits on both the write response and the server's 1851 // reply. 1852 type writeRequest struct { 1853 req *transportRequest 1854 ch chan<- error 1855 1856 // Optional blocking chan for Expect: 100-continue (for receive). 1857 // If not nil, writeLoop blocks sending request body until 1858 // it receives from this chan. 1859 continueCh <-chan struct{} 1860 } 1861 1862 type httpError struct { 1863 err string 1864 timeout bool 1865 } 1866 1867 func (e *httpError) Error() string { return e.err } 1868 func (e *httpError) Timeout() bool { return e.timeout } 1869 func (e *httpError) Temporary() bool { return true } 1870 1871 var errTimeout error = &httpError{err: "net/http: timeout awaiting response headers", timeout: true} 1872 var errRequestCanceled = errors.New("net/http: request canceled") 1873 var errRequestCanceledConn = errors.New("net/http: request canceled while waiting for connection") // TODO: unify? 1874 1875 func nop() {} 1876 1877 // testHooks. Always non-nil. 1878 var ( 1879 testHookEnterRoundTrip = nop 1880 testHookWaitResLoop = nop 1881 testHookRoundTripRetried = nop 1882 testHookPrePendingDial = nop 1883 testHookPostPendingDial = nop 1884 1885 testHookMu sync.Locker = fakeLocker{} // guards following 1886 testHookReadLoopBeforeNextRead = nop 1887 ) 1888 1889 func (pc *persistConn) roundTrip(req *transportRequest) (resp *Response, err error) { 1890 testHookEnterRoundTrip() 1891 if !pc.t.replaceReqCanceler(req.Request, pc.cancelRequest) { 1892 pc.t.putOrCloseIdleConn(pc) 1893 return nil, errRequestCanceled 1894 } 1895 pc.mu.Lock() 1896 pc.numExpectedResponses++ 1897 headerFn := pc.mutateHeaderFunc 1898 pc.mu.Unlock() 1899 1900 if headerFn != nil { 1901 headerFn(req.extraHeaders()) 1902 } 1903 1904 // Ask for a compressed version if the caller didn't set their 1905 // own value for Accept-Encoding. We only attempt to 1906 // uncompress the gzip stream if we were the layer that 1907 // requested it. 1908 requestedGzip := false 1909 if !pc.t.DisableCompression && 1910 req.Header.Get("Accept-Encoding") == "" && 1911 req.Header.Get("Range") == "" && 1912 req.Method != "HEAD" { 1913 // Request gzip only, not deflate. Deflate is ambiguous and 1914 // not as universally supported anyway. 1915 // See: http://www.gzip.org/zlib/zlib_faq.html#faq38 1916 // 1917 // Note that we don't request this for HEAD requests, 1918 // due to a bug in nginx: 1919 // http://trac.nginx.org/nginx/ticket/358 1920 // https://golang.org/issue/5522 1921 // 1922 // We don't request gzip if the request is for a range, since 1923 // auto-decoding a portion of a gzipped document will just fail 1924 // anyway. See https://golang.org/issue/8923 1925 requestedGzip = true 1926 req.extraHeaders().Set("Accept-Encoding", "gzip") 1927 } 1928 1929 var continueCh chan struct{} 1930 if req.ProtoAtLeast(1, 1) && req.Body != nil && req.expectsContinue() { 1931 continueCh = make(chan struct{}, 1) 1932 } 1933 1934 if pc.t.DisableKeepAlives { 1935 req.extraHeaders().Set("Connection", "close") 1936 } 1937 1938 gone := make(chan struct{}) 1939 defer close(gone) 1940 1941 defer func() { 1942 if err != nil { 1943 pc.t.setReqCanceler(req.Request, nil) 1944 } 1945 }() 1946 1947 const debugRoundTrip = false 1948 1949 // Write the request concurrently with waiting for a response, 1950 // in case the server decides to reply before reading our full 1951 // request body. 1952 startBytesWritten := pc.nwrite 1953 writeErrCh := make(chan error, 1) 1954 pc.writech <- writeRequest{req, writeErrCh, continueCh} 1955 1956 resc := make(chan responseAndError) 1957 pc.reqch <- requestAndChan{ 1958 req: req.Request, 1959 ch: resc, 1960 addedGzip: requestedGzip, 1961 continueCh: continueCh, 1962 callerGone: gone, 1963 } 1964 1965 var respHeaderTimer <-chan time.Time 1966 cancelChan := req.Request.Cancel 1967 ctxDoneChan := req.Context().Done() 1968 for { 1969 testHookWaitResLoop() 1970 select { 1971 case err := <-writeErrCh: 1972 if debugRoundTrip { 1973 req.logf("writeErrCh resv: %T/%#v", err, err) 1974 } 1975 if err != nil { 1976 pc.close(fmt.Errorf("write error: %v", err)) 1977 return nil, pc.mapRoundTripError(req, startBytesWritten, err) 1978 } 1979 if d := pc.t.ResponseHeaderTimeout; d > 0 { 1980 if debugRoundTrip { 1981 req.logf("starting timer for %v", d) 1982 } 1983 timer := time.NewTimer(d) 1984 defer timer.Stop() // prevent leaks 1985 respHeaderTimer = timer.C 1986 } 1987 case <-pc.closech: 1988 if debugRoundTrip { 1989 req.logf("closech recv: %T %#v", pc.closed, pc.closed) 1990 } 1991 return nil, pc.mapRoundTripError(req, startBytesWritten, pc.closed) 1992 case <-respHeaderTimer: 1993 if debugRoundTrip { 1994 req.logf("timeout waiting for response headers.") 1995 } 1996 pc.close(errTimeout) 1997 return nil, errTimeout 1998 case re := <-resc: 1999 if (re.res == nil) == (re.err == nil) { 2000 panic(fmt.Sprintf("internal error: exactly one of res or err should be set; nil=%v", re.res == nil)) 2001 } 2002 if debugRoundTrip { 2003 req.logf("resc recv: %p, %T/%#v", re.res, re.err, re.err) 2004 } 2005 if re.err != nil { 2006 return nil, pc.mapRoundTripError(req, startBytesWritten, re.err) 2007 } 2008 return re.res, nil 2009 case <-cancelChan: 2010 pc.t.CancelRequest(req.Request) 2011 cancelChan = nil 2012 case <-ctxDoneChan: 2013 pc.t.cancelRequest(req.Request, req.Context().Err()) 2014 cancelChan = nil 2015 ctxDoneChan = nil 2016 } 2017 } 2018 } 2019 2020 // tLogKey is a context WithValue key for test debugging contexts containing 2021 // a t.Logf func. See export_test.go's Request.WithT method. 2022 type tLogKey struct{} 2023 2024 func (tr *transportRequest) logf(format string, args ...interface{}) { 2025 if logf, ok := tr.Request.Context().Value(tLogKey{}).(func(string, ...interface{})); ok { 2026 logf(time.Now().Format(time.RFC3339Nano)+": "+format, args...) 2027 } 2028 } 2029 2030 // markReused marks this connection as having been successfully used for a 2031 // request and response. 2032 func (pc *persistConn) markReused() { 2033 pc.mu.Lock() 2034 pc.reused = true 2035 pc.mu.Unlock() 2036 } 2037 2038 // close closes the underlying TCP connection and closes 2039 // the pc.closech channel. 2040 // 2041 // The provided err is only for testing and debugging; in normal 2042 // circumstances it should never be seen by users. 2043 func (pc *persistConn) close(err error) { 2044 pc.mu.Lock() 2045 defer pc.mu.Unlock() 2046 pc.closeLocked(err) 2047 } 2048 2049 func (pc *persistConn) closeLocked(err error) { 2050 if err == nil { 2051 panic("nil error") 2052 } 2053 pc.broken = true 2054 if pc.closed == nil { 2055 pc.closed = err 2056 if pc.alt != nil { 2057 // Do nothing; can only get here via getConn's 2058 // handlePendingDial's putOrCloseIdleConn when 2059 // it turns out the abandoned connection in 2060 // flight ended up negotiating an alternate 2061 // protocol. We don't use the connection 2062 // freelist for http2. That's done by the 2063 // alternate protocol's RoundTripper. 2064 } else { 2065 pc.conn.Close() 2066 close(pc.closech) 2067 } 2068 } 2069 pc.mutateHeaderFunc = nil 2070 } 2071 2072 var portMap = map[string]string{ 2073 "http": "80", 2074 "https": "443", 2075 "socks5": "1080", 2076 } 2077 2078 // canonicalAddr returns url.Host but always with a ":port" suffix 2079 func canonicalAddr(url *url.URL) string { 2080 addr := url.Hostname() 2081 if v, err := idnaASCII(addr); err == nil { 2082 addr = v 2083 } 2084 port := url.Port() 2085 if port == "" { 2086 port = portMap[url.Scheme] 2087 } 2088 return net.JoinHostPort(addr, port) 2089 } 2090 2091 // bodyEOFSignal is used by the HTTP/1 transport when reading response 2092 // bodies to make sure we see the end of a response body before 2093 // proceeding and reading on the connection again. 2094 // 2095 // It wraps a ReadCloser but runs fn (if non-nil) at most 2096 // once, right before its final (error-producing) Read or Close call 2097 // returns. fn should return the new error to return from Read or Close. 2098 // 2099 // If earlyCloseFn is non-nil and Close is called before io.EOF is 2100 // seen, earlyCloseFn is called instead of fn, and its return value is 2101 // the return value from Close. 2102 type bodyEOFSignal struct { 2103 body io.ReadCloser 2104 mu sync.Mutex // guards following 4 fields 2105 closed bool // whether Close has been called 2106 rerr error // sticky Read error 2107 fn func(error) error // err will be nil on Read io.EOF 2108 earlyCloseFn func() error // optional alt Close func used if io.EOF not seen 2109 } 2110 2111 var errReadOnClosedResBody = errors.New("http: read on closed response body") 2112 2113 func (es *bodyEOFSignal) Read(p []byte) (n int, err error) { 2114 es.mu.Lock() 2115 closed, rerr := es.closed, es.rerr 2116 es.mu.Unlock() 2117 if closed { 2118 return 0, errReadOnClosedResBody 2119 } 2120 if rerr != nil { 2121 return 0, rerr 2122 } 2123 2124 n, err = es.body.Read(p) 2125 if err != nil { 2126 es.mu.Lock() 2127 defer es.mu.Unlock() 2128 if es.rerr == nil { 2129 es.rerr = err 2130 } 2131 err = es.condfn(err) 2132 } 2133 return 2134 } 2135 2136 func (es *bodyEOFSignal) Close() error { 2137 es.mu.Lock() 2138 defer es.mu.Unlock() 2139 if es.closed { 2140 return nil 2141 } 2142 es.closed = true 2143 if es.earlyCloseFn != nil && es.rerr != io.EOF { 2144 return es.earlyCloseFn() 2145 } 2146 err := es.body.Close() 2147 return es.condfn(err) 2148 } 2149 2150 // caller must hold es.mu. 2151 func (es *bodyEOFSignal) condfn(err error) error { 2152 if es.fn == nil { 2153 return err 2154 } 2155 err = es.fn(err) 2156 es.fn = nil 2157 return err 2158 } 2159 2160 // gzipReader wraps a response body so it can lazily 2161 // call gzip.NewReader on the first call to Read 2162 type gzipReader struct { 2163 body *bodyEOFSignal // underlying HTTP/1 response body framing 2164 zr *gzip.Reader // lazily-initialized gzip reader 2165 zerr error // any error from gzip.NewReader; sticky 2166 } 2167 2168 func (gz *gzipReader) Read(p []byte) (n int, err error) { 2169 if gz.zr == nil { 2170 if gz.zerr == nil { 2171 gz.zr, gz.zerr = gzip.NewReader(gz.body) 2172 } 2173 if gz.zerr != nil { 2174 return 0, gz.zerr 2175 } 2176 } 2177 2178 gz.body.mu.Lock() 2179 if gz.body.closed { 2180 err = errReadOnClosedResBody 2181 } 2182 gz.body.mu.Unlock() 2183 2184 if err != nil { 2185 return 0, err 2186 } 2187 return gz.zr.Read(p) 2188 } 2189 2190 func (gz *gzipReader) Close() error { 2191 return gz.body.Close() 2192 } 2193 2194 type readerAndCloser struct { 2195 io.Reader 2196 io.Closer 2197 } 2198 2199 type tlsHandshakeTimeoutError struct{} 2200 2201 func (tlsHandshakeTimeoutError) Timeout() bool { return true } 2202 func (tlsHandshakeTimeoutError) Temporary() bool { return true } 2203 func (tlsHandshakeTimeoutError) Error() string { return "net/http: TLS handshake timeout" } 2204 2205 // fakeLocker is a sync.Locker which does nothing. It's used to guard 2206 // test-only fields when not under test, to avoid runtime atomic 2207 // overhead. 2208 type fakeLocker struct{} 2209 2210 func (fakeLocker) Lock() {} 2211 func (fakeLocker) Unlock() {} 2212 2213 // clneTLSConfig returns a shallow clone of cfg, or a new zero tls.Config if 2214 // cfg is nil. This is safe to call even if cfg is in active use by a TLS 2215 // client or server. 2216 func cloneTLSConfig(cfg *tls.Config) *tls.Config { 2217 if cfg == nil { 2218 return &tls.Config{} 2219 } 2220 return cfg.Clone() 2221 } 2222 2223 type connLRU struct { 2224 ll *list.List // list.Element.Value type is of *persistConn 2225 m map[*persistConn]*list.Element 2226 } 2227 2228 // add adds pc to the head of the linked list. 2229 func (cl *connLRU) add(pc *persistConn) { 2230 if cl.ll == nil { 2231 cl.ll = list.New() 2232 cl.m = make(map[*persistConn]*list.Element) 2233 } 2234 ele := cl.ll.PushFront(pc) 2235 if _, ok := cl.m[pc]; ok { 2236 panic("persistConn was already in LRU") 2237 } 2238 cl.m[pc] = ele 2239 } 2240 2241 func (cl *connLRU) removeOldest() *persistConn { 2242 ele := cl.ll.Back() 2243 pc := ele.Value.(*persistConn) 2244 cl.ll.Remove(ele) 2245 delete(cl.m, pc) 2246 return pc 2247 } 2248 2249 // remove removes pc from cl. 2250 func (cl *connLRU) remove(pc *persistConn) { 2251 if ele, ok := cl.m[pc]; ok { 2252 cl.ll.Remove(ele) 2253 delete(cl.m, pc) 2254 } 2255 } 2256 2257 // len returns the number of items in the cache. 2258 func (cl *connLRU) len() int { 2259 return len(cl.m) 2260 } 2261 2262 // validPort reports whether p (without the colon) is a valid port in 2263 // a URL, per RFC 3986 Section 3.2.3, which says the port may be 2264 // empty, or only contain digits. 2265 func validPort(p string) bool { 2266 for _, r := range []byte(p) { 2267 if r < '0' || r > '9' { 2268 return false 2269 } 2270 } 2271 return true 2272 }