transport.go 62 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275
  1. // Copyright 2015 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. // Transport code.
  5. package http2
  6. import (
  7. "bufio"
  8. "bytes"
  9. "compress/gzip"
  10. "crypto/rand"
  11. "crypto/tls"
  12. "errors"
  13. "fmt"
  14. "io"
  15. "io/ioutil"
  16. "log"
  17. "math"
  18. mathrand "math/rand"
  19. "net"
  20. "net/http"
  21. "sort"
  22. "strconv"
  23. "strings"
  24. "sync"
  25. "time"
  26. "golang.org/x/net/http2/hpack"
  27. "golang.org/x/net/idna"
  28. "golang.org/x/net/lex/httplex"
  29. )
  30. const (
  31. // transportDefaultConnFlow is how many connection-level flow control
  32. // tokens we give the server at start-up, past the default 64k.
  33. transportDefaultConnFlow = 1 << 30
  34. // transportDefaultStreamFlow is how many stream-level flow
  35. // control tokens we announce to the peer, and how many bytes
  36. // we buffer per stream.
  37. transportDefaultStreamFlow = 4 << 20
  38. // transportDefaultStreamMinRefresh is the minimum number of bytes we'll send
  39. // a stream-level WINDOW_UPDATE for at a time.
  40. transportDefaultStreamMinRefresh = 4 << 10
  41. defaultUserAgent = "Go-http-client/2.0"
  42. )
  43. // Transport is an HTTP/2 Transport.
  44. //
  45. // A Transport internally caches connections to servers. It is safe
  46. // for concurrent use by multiple goroutines.
  47. type Transport struct {
  48. // DialTLS specifies an optional dial function for creating
  49. // TLS connections for requests.
  50. //
  51. // If DialTLS is nil, tls.Dial is used.
  52. //
  53. // If the returned net.Conn has a ConnectionState method like tls.Conn,
  54. // it will be used to set http.Response.TLS.
  55. DialTLS func(network, addr string, cfg *tls.Config) (net.Conn, error)
  56. // TLSClientConfig specifies the TLS configuration to use with
  57. // tls.Client. If nil, the default configuration is used.
  58. TLSClientConfig *tls.Config
  59. // ConnPool optionally specifies an alternate connection pool to use.
  60. // If nil, the default is used.
  61. ConnPool ClientConnPool
  62. // DisableCompression, if true, prevents the Transport from
  63. // requesting compression with an "Accept-Encoding: gzip"
  64. // request header when the Request contains no existing
  65. // Accept-Encoding value. If the Transport requests gzip on
  66. // its own and gets a gzipped response, it's transparently
  67. // decoded in the Response.Body. However, if the user
  68. // explicitly requested gzip it is not automatically
  69. // uncompressed.
  70. DisableCompression bool
  71. // AllowHTTP, if true, permits HTTP/2 requests using the insecure,
  72. // plain-text "http" scheme. Note that this does not enable h2c support.
  73. AllowHTTP bool
  74. // MaxHeaderListSize is the http2 SETTINGS_MAX_HEADER_LIST_SIZE to
  75. // send in the initial settings frame. It is how many bytes
  76. // of response headers are allowed. Unlike the http2 spec, zero here
  77. // means to use a default limit (currently 10MB). If you actually
  78. // want to advertise an ulimited value to the peer, Transport
  79. // interprets the highest possible value here (0xffffffff or 1<<32-1)
  80. // to mean no limit.
  81. MaxHeaderListSize uint32
  82. // t1, if non-nil, is the standard library Transport using
  83. // this transport. Its settings are used (but not its
  84. // RoundTrip method, etc).
  85. t1 *http.Transport
  86. connPoolOnce sync.Once
  87. connPoolOrDef ClientConnPool // non-nil version of ConnPool
  88. }
  89. func (t *Transport) maxHeaderListSize() uint32 {
  90. if t.MaxHeaderListSize == 0 {
  91. return 10 << 20
  92. }
  93. if t.MaxHeaderListSize == 0xffffffff {
  94. return 0
  95. }
  96. return t.MaxHeaderListSize
  97. }
  98. func (t *Transport) disableCompression() bool {
  99. return t.DisableCompression || (t.t1 != nil && t.t1.DisableCompression)
  100. }
  101. var errTransportVersion = errors.New("http2: ConfigureTransport is only supported starting at Go 1.6")
  102. // ConfigureTransport configures a net/http HTTP/1 Transport to use HTTP/2.
  103. // It requires Go 1.6 or later and returns an error if the net/http package is too old
  104. // or if t1 has already been HTTP/2-enabled.
  105. func ConfigureTransport(t1 *http.Transport) error {
  106. _, err := configureTransport(t1) // in configure_transport.go (go1.6) or not_go16.go
  107. return err
  108. }
  109. func (t *Transport) connPool() ClientConnPool {
  110. t.connPoolOnce.Do(t.initConnPool)
  111. return t.connPoolOrDef
  112. }
  113. func (t *Transport) initConnPool() {
  114. if t.ConnPool != nil {
  115. t.connPoolOrDef = t.ConnPool
  116. } else {
  117. t.connPoolOrDef = &clientConnPool{t: t}
  118. }
  119. }
  120. // ClientConn is the state of a single HTTP/2 client connection to an
  121. // HTTP/2 server.
  122. type ClientConn struct {
  123. t *Transport
  124. tconn net.Conn // usually *tls.Conn, except specialized impls
  125. tlsState *tls.ConnectionState // nil only for specialized impls
  126. singleUse bool // whether being used for a single http.Request
  127. // readLoop goroutine fields:
  128. readerDone chan struct{} // closed on error
  129. readerErr error // set before readerDone is closed
  130. idleTimeout time.Duration // or 0 for never
  131. idleTimer *time.Timer
  132. mu sync.Mutex // guards following
  133. cond *sync.Cond // hold mu; broadcast on flow/closed changes
  134. flow flow // our conn-level flow control quota (cs.flow is per stream)
  135. inflow flow // peer's conn-level flow control
  136. closed bool
  137. wantSettingsAck bool // we sent a SETTINGS frame and haven't heard back
  138. goAway *GoAwayFrame // if non-nil, the GoAwayFrame we received
  139. goAwayDebug string // goAway frame's debug data, retained as a string
  140. streams map[uint32]*clientStream // client-initiated
  141. nextStreamID uint32
  142. pendingRequests int // requests blocked and waiting to be sent because len(streams) == maxConcurrentStreams
  143. pings map[[8]byte]chan struct{} // in flight ping data to notification channel
  144. bw *bufio.Writer
  145. br *bufio.Reader
  146. fr *Framer
  147. lastActive time.Time
  148. // Settings from peer: (also guarded by mu)
  149. maxFrameSize uint32
  150. maxConcurrentStreams uint32
  151. peerMaxHeaderListSize uint64
  152. initialWindowSize uint32
  153. hbuf bytes.Buffer // HPACK encoder writes into this
  154. henc *hpack.Encoder
  155. freeBuf [][]byte
  156. wmu sync.Mutex // held while writing; acquire AFTER mu if holding both
  157. werr error // first write error that has occurred
  158. }
  159. // clientStream is the state for a single HTTP/2 stream. One of these
  160. // is created for each Transport.RoundTrip call.
  161. type clientStream struct {
  162. cc *ClientConn
  163. req *http.Request
  164. trace *clientTrace // or nil
  165. ID uint32
  166. resc chan resAndError
  167. bufPipe pipe // buffered pipe with the flow-controlled response payload
  168. startedWrite bool // started request body write; guarded by cc.mu
  169. requestedGzip bool
  170. on100 func() // optional code to run if get a 100 continue response
  171. flow flow // guarded by cc.mu
  172. inflow flow // guarded by cc.mu
  173. bytesRemain int64 // -1 means unknown; owned by transportResponseBody.Read
  174. readErr error // sticky read error; owned by transportResponseBody.Read
  175. stopReqBody error // if non-nil, stop writing req body; guarded by cc.mu
  176. didReset bool // whether we sent a RST_STREAM to the server; guarded by cc.mu
  177. peerReset chan struct{} // closed on peer reset
  178. resetErr error // populated before peerReset is closed
  179. done chan struct{} // closed when stream remove from cc.streams map; close calls guarded by cc.mu
  180. // owned by clientConnReadLoop:
  181. firstByte bool // got the first response byte
  182. pastHeaders bool // got first MetaHeadersFrame (actual headers)
  183. pastTrailers bool // got optional second MetaHeadersFrame (trailers)
  184. trailer http.Header // accumulated trailers
  185. resTrailer *http.Header // client's Response.Trailer
  186. }
  187. // awaitRequestCancel waits for the user to cancel a request or for the done
  188. // channel to be signaled. A non-nil error is returned only if the request was
  189. // canceled.
  190. func awaitRequestCancel(req *http.Request, done <-chan struct{}) error {
  191. ctx := reqContext(req)
  192. if req.Cancel == nil && ctx.Done() == nil {
  193. return nil
  194. }
  195. select {
  196. case <-req.Cancel:
  197. return errRequestCanceled
  198. case <-ctx.Done():
  199. return ctx.Err()
  200. case <-done:
  201. return nil
  202. }
  203. }
  204. // awaitRequestCancel waits for the user to cancel a request, its context to
  205. // expire, or for the request to be done (any way it might be removed from the
  206. // cc.streams map: peer reset, successful completion, TCP connection breakage,
  207. // etc). If the request is canceled, then cs will be canceled and closed.
  208. func (cs *clientStream) awaitRequestCancel(req *http.Request) {
  209. if err := awaitRequestCancel(req, cs.done); err != nil {
  210. cs.cancelStream()
  211. cs.bufPipe.CloseWithError(err)
  212. }
  213. }
  214. func (cs *clientStream) cancelStream() {
  215. cc := cs.cc
  216. cc.mu.Lock()
  217. didReset := cs.didReset
  218. cs.didReset = true
  219. cc.mu.Unlock()
  220. if !didReset {
  221. cc.writeStreamReset(cs.ID, ErrCodeCancel, nil)
  222. cc.forgetStreamID(cs.ID)
  223. }
  224. }
  225. // checkResetOrDone reports any error sent in a RST_STREAM frame by the
  226. // server, or errStreamClosed if the stream is complete.
  227. func (cs *clientStream) checkResetOrDone() error {
  228. select {
  229. case <-cs.peerReset:
  230. return cs.resetErr
  231. case <-cs.done:
  232. return errStreamClosed
  233. default:
  234. return nil
  235. }
  236. }
  237. func (cs *clientStream) abortRequestBodyWrite(err error) {
  238. if err == nil {
  239. panic("nil error")
  240. }
  241. cc := cs.cc
  242. cc.mu.Lock()
  243. cs.stopReqBody = err
  244. cc.cond.Broadcast()
  245. cc.mu.Unlock()
  246. }
  247. type stickyErrWriter struct {
  248. w io.Writer
  249. err *error
  250. }
  251. func (sew stickyErrWriter) Write(p []byte) (n int, err error) {
  252. if *sew.err != nil {
  253. return 0, *sew.err
  254. }
  255. n, err = sew.w.Write(p)
  256. *sew.err = err
  257. return
  258. }
  259. var ErrNoCachedConn = errors.New("http2: no cached connection was available")
  260. // RoundTripOpt are options for the Transport.RoundTripOpt method.
  261. type RoundTripOpt struct {
  262. // OnlyCachedConn controls whether RoundTripOpt may
  263. // create a new TCP connection. If set true and
  264. // no cached connection is available, RoundTripOpt
  265. // will return ErrNoCachedConn.
  266. OnlyCachedConn bool
  267. }
  268. func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error) {
  269. return t.RoundTripOpt(req, RoundTripOpt{})
  270. }
  271. // authorityAddr returns a given authority (a host/IP, or host:port / ip:port)
  272. // and returns a host:port. The port 443 is added if needed.
  273. func authorityAddr(scheme string, authority string) (addr string) {
  274. host, port, err := net.SplitHostPort(authority)
  275. if err != nil { // authority didn't have a port
  276. port = "443"
  277. if scheme == "http" {
  278. port = "80"
  279. }
  280. host = authority
  281. }
  282. if a, err := idna.ToASCII(host); err == nil {
  283. host = a
  284. }
  285. // IPv6 address literal, without a port:
  286. if strings.HasPrefix(host, "[") && strings.HasSuffix(host, "]") {
  287. return host + ":" + port
  288. }
  289. return net.JoinHostPort(host, port)
  290. }
  291. // RoundTripOpt is like RoundTrip, but takes options.
  292. func (t *Transport) RoundTripOpt(req *http.Request, opt RoundTripOpt) (*http.Response, error) {
  293. if !(req.URL.Scheme == "https" || (req.URL.Scheme == "http" && t.AllowHTTP)) {
  294. return nil, errors.New("http2: unsupported scheme")
  295. }
  296. addr := authorityAddr(req.URL.Scheme, req.URL.Host)
  297. for retry := 0; ; retry++ {
  298. cc, err := t.connPool().GetClientConn(req, addr)
  299. if err != nil {
  300. t.vlogf("http2: Transport failed to get client conn for %s: %v", addr, err)
  301. return nil, err
  302. }
  303. traceGotConn(req, cc)
  304. res, err := cc.RoundTrip(req)
  305. if err != nil && retry <= 6 {
  306. afterBodyWrite := false
  307. if e, ok := err.(afterReqBodyWriteError); ok {
  308. err = e
  309. afterBodyWrite = true
  310. }
  311. if req, err = shouldRetryRequest(req, err, afterBodyWrite); err == nil {
  312. // After the first retry, do exponential backoff with 10% jitter.
  313. if retry == 0 {
  314. continue
  315. }
  316. backoff := float64(uint(1) << (uint(retry) - 1))
  317. backoff += backoff * (0.1 * mathrand.Float64())
  318. select {
  319. case <-time.After(time.Second * time.Duration(backoff)):
  320. continue
  321. case <-reqContext(req).Done():
  322. return nil, reqContext(req).Err()
  323. }
  324. }
  325. }
  326. if err != nil {
  327. t.vlogf("RoundTrip failure: %v", err)
  328. return nil, err
  329. }
  330. return res, nil
  331. }
  332. }
  333. // CloseIdleConnections closes any connections which were previously
  334. // connected from previous requests but are now sitting idle.
  335. // It does not interrupt any connections currently in use.
  336. func (t *Transport) CloseIdleConnections() {
  337. if cp, ok := t.connPool().(clientConnPoolIdleCloser); ok {
  338. cp.closeIdleConnections()
  339. }
  340. }
  341. var (
  342. errClientConnClosed = errors.New("http2: client conn is closed")
  343. errClientConnUnusable = errors.New("http2: client conn not usable")
  344. errClientConnGotGoAway = errors.New("http2: Transport received Server's graceful shutdown GOAWAY")
  345. )
  346. // afterReqBodyWriteError is a wrapper around errors returned by ClientConn.RoundTrip.
  347. // It is used to signal that err happened after part of Request.Body was sent to the server.
  348. type afterReqBodyWriteError struct {
  349. err error
  350. }
  351. func (e afterReqBodyWriteError) Error() string {
  352. return e.err.Error() + "; some request body already written"
  353. }
  354. // shouldRetryRequest is called by RoundTrip when a request fails to get
  355. // response headers. It is always called with a non-nil error.
  356. // It returns either a request to retry (either the same request, or a
  357. // modified clone), or an error if the request can't be replayed.
  358. func shouldRetryRequest(req *http.Request, err error, afterBodyWrite bool) (*http.Request, error) {
  359. if !canRetryError(err) {
  360. return nil, err
  361. }
  362. if !afterBodyWrite {
  363. return req, nil
  364. }
  365. // If the Body is nil (or http.NoBody), it's safe to reuse
  366. // this request and its Body.
  367. if req.Body == nil || reqBodyIsNoBody(req.Body) {
  368. return req, nil
  369. }
  370. // Otherwise we depend on the Request having its GetBody
  371. // func defined.
  372. getBody := reqGetBody(req) // Go 1.8: getBody = req.GetBody
  373. if getBody == nil {
  374. return nil, fmt.Errorf("http2: Transport: cannot retry err [%v] after Request.Body was written; define Request.GetBody to avoid this error", err)
  375. }
  376. body, err := getBody()
  377. if err != nil {
  378. return nil, err
  379. }
  380. newReq := *req
  381. newReq.Body = body
  382. return &newReq, nil
  383. }
  384. func canRetryError(err error) bool {
  385. if err == errClientConnUnusable || err == errClientConnGotGoAway {
  386. return true
  387. }
  388. if se, ok := err.(StreamError); ok {
  389. return se.Code == ErrCodeRefusedStream
  390. }
  391. return false
  392. }
  393. func (t *Transport) dialClientConn(addr string, singleUse bool) (*ClientConn, error) {
  394. host, _, err := net.SplitHostPort(addr)
  395. if err != nil {
  396. return nil, err
  397. }
  398. tconn, err := t.dialTLS()("tcp", addr, t.newTLSConfig(host))
  399. if err != nil {
  400. return nil, err
  401. }
  402. return t.newClientConn(tconn, singleUse)
  403. }
  404. func (t *Transport) newTLSConfig(host string) *tls.Config {
  405. cfg := new(tls.Config)
  406. if t.TLSClientConfig != nil {
  407. *cfg = *cloneTLSConfig(t.TLSClientConfig)
  408. }
  409. if !strSliceContains(cfg.NextProtos, NextProtoTLS) {
  410. cfg.NextProtos = append([]string{NextProtoTLS}, cfg.NextProtos...)
  411. }
  412. if cfg.ServerName == "" {
  413. cfg.ServerName = host
  414. }
  415. return cfg
  416. }
  417. func (t *Transport) dialTLS() func(string, string, *tls.Config) (net.Conn, error) {
  418. if t.DialTLS != nil {
  419. return t.DialTLS
  420. }
  421. return t.dialTLSDefault
  422. }
  423. func (t *Transport) dialTLSDefault(network, addr string, cfg *tls.Config) (net.Conn, error) {
  424. cn, err := tls.Dial(network, addr, cfg)
  425. if err != nil {
  426. return nil, err
  427. }
  428. if err := cn.Handshake(); err != nil {
  429. return nil, err
  430. }
  431. if !cfg.InsecureSkipVerify {
  432. if err := cn.VerifyHostname(cfg.ServerName); err != nil {
  433. return nil, err
  434. }
  435. }
  436. state := cn.ConnectionState()
  437. if p := state.NegotiatedProtocol; p != NextProtoTLS {
  438. return nil, fmt.Errorf("http2: unexpected ALPN protocol %q; want %q", p, NextProtoTLS)
  439. }
  440. if !state.NegotiatedProtocolIsMutual {
  441. return nil, errors.New("http2: could not negotiate protocol mutually")
  442. }
  443. return cn, nil
  444. }
  445. // disableKeepAlives reports whether connections should be closed as
  446. // soon as possible after handling the first request.
  447. func (t *Transport) disableKeepAlives() bool {
  448. return t.t1 != nil && t.t1.DisableKeepAlives
  449. }
  450. func (t *Transport) expectContinueTimeout() time.Duration {
  451. if t.t1 == nil {
  452. return 0
  453. }
  454. return transportExpectContinueTimeout(t.t1)
  455. }
  456. func (t *Transport) NewClientConn(c net.Conn) (*ClientConn, error) {
  457. return t.newClientConn(c, false)
  458. }
  459. func (t *Transport) newClientConn(c net.Conn, singleUse bool) (*ClientConn, error) {
  460. cc := &ClientConn{
  461. t: t,
  462. tconn: c,
  463. readerDone: make(chan struct{}),
  464. nextStreamID: 1,
  465. maxFrameSize: 16 << 10, // spec default
  466. initialWindowSize: 65535, // spec default
  467. maxConcurrentStreams: 1000, // "infinite", per spec. 1000 seems good enough.
  468. peerMaxHeaderListSize: 0xffffffffffffffff, // "infinite", per spec. Use 2^64-1 instead.
  469. streams: make(map[uint32]*clientStream),
  470. singleUse: singleUse,
  471. wantSettingsAck: true,
  472. pings: make(map[[8]byte]chan struct{}),
  473. }
  474. if d := t.idleConnTimeout(); d != 0 {
  475. cc.idleTimeout = d
  476. cc.idleTimer = time.AfterFunc(d, cc.onIdleTimeout)
  477. }
  478. if VerboseLogs {
  479. t.vlogf("http2: Transport creating client conn %p to %v", cc, c.RemoteAddr())
  480. }
  481. cc.cond = sync.NewCond(&cc.mu)
  482. cc.flow.add(int32(initialWindowSize))
  483. // TODO: adjust this writer size to account for frame size +
  484. // MTU + crypto/tls record padding.
  485. cc.bw = bufio.NewWriter(stickyErrWriter{c, &cc.werr})
  486. cc.br = bufio.NewReader(c)
  487. cc.fr = NewFramer(cc.bw, cc.br)
  488. cc.fr.ReadMetaHeaders = hpack.NewDecoder(initialHeaderTableSize, nil)
  489. cc.fr.MaxHeaderListSize = t.maxHeaderListSize()
  490. // TODO: SetMaxDynamicTableSize, SetMaxDynamicTableSizeLimit on
  491. // henc in response to SETTINGS frames?
  492. cc.henc = hpack.NewEncoder(&cc.hbuf)
  493. if cs, ok := c.(connectionStater); ok {
  494. state := cs.ConnectionState()
  495. cc.tlsState = &state
  496. }
  497. initialSettings := []Setting{
  498. {ID: SettingEnablePush, Val: 0},
  499. {ID: SettingInitialWindowSize, Val: transportDefaultStreamFlow},
  500. }
  501. if max := t.maxHeaderListSize(); max != 0 {
  502. initialSettings = append(initialSettings, Setting{ID: SettingMaxHeaderListSize, Val: max})
  503. }
  504. cc.bw.Write(clientPreface)
  505. cc.fr.WriteSettings(initialSettings...)
  506. cc.fr.WriteWindowUpdate(0, transportDefaultConnFlow)
  507. cc.inflow.add(transportDefaultConnFlow + initialWindowSize)
  508. cc.bw.Flush()
  509. if cc.werr != nil {
  510. return nil, cc.werr
  511. }
  512. go cc.readLoop()
  513. return cc, nil
  514. }
  515. func (cc *ClientConn) setGoAway(f *GoAwayFrame) {
  516. cc.mu.Lock()
  517. defer cc.mu.Unlock()
  518. old := cc.goAway
  519. cc.goAway = f
  520. // Merge the previous and current GoAway error frames.
  521. if cc.goAwayDebug == "" {
  522. cc.goAwayDebug = string(f.DebugData())
  523. }
  524. if old != nil && old.ErrCode != ErrCodeNo {
  525. cc.goAway.ErrCode = old.ErrCode
  526. }
  527. last := f.LastStreamID
  528. for streamID, cs := range cc.streams {
  529. if streamID > last {
  530. select {
  531. case cs.resc <- resAndError{err: errClientConnGotGoAway}:
  532. default:
  533. }
  534. }
  535. }
  536. }
  537. // CanTakeNewRequest reports whether the connection can take a new request,
  538. // meaning it has not been closed or received or sent a GOAWAY.
  539. func (cc *ClientConn) CanTakeNewRequest() bool {
  540. cc.mu.Lock()
  541. defer cc.mu.Unlock()
  542. return cc.canTakeNewRequestLocked()
  543. }
  544. func (cc *ClientConn) canTakeNewRequestLocked() bool {
  545. if cc.singleUse && cc.nextStreamID > 1 {
  546. return false
  547. }
  548. return cc.goAway == nil && !cc.closed &&
  549. int64(cc.nextStreamID)+int64(cc.pendingRequests) < math.MaxInt32
  550. }
  551. // onIdleTimeout is called from a time.AfterFunc goroutine. It will
  552. // only be called when we're idle, but because we're coming from a new
  553. // goroutine, there could be a new request coming in at the same time,
  554. // so this simply calls the synchronized closeIfIdle to shut down this
  555. // connection. The timer could just call closeIfIdle, but this is more
  556. // clear.
  557. func (cc *ClientConn) onIdleTimeout() {
  558. cc.closeIfIdle()
  559. }
  560. func (cc *ClientConn) closeIfIdle() {
  561. cc.mu.Lock()
  562. if len(cc.streams) > 0 {
  563. cc.mu.Unlock()
  564. return
  565. }
  566. cc.closed = true
  567. nextID := cc.nextStreamID
  568. // TODO: do clients send GOAWAY too? maybe? Just Close:
  569. cc.mu.Unlock()
  570. if VerboseLogs {
  571. cc.vlogf("http2: Transport closing idle conn %p (forSingleUse=%v, maxStream=%v)", cc, cc.singleUse, nextID-2)
  572. }
  573. cc.tconn.Close()
  574. }
  575. const maxAllocFrameSize = 512 << 10
  576. // frameBuffer returns a scratch buffer suitable for writing DATA frames.
  577. // They're capped at the min of the peer's max frame size or 512KB
  578. // (kinda arbitrarily), but definitely capped so we don't allocate 4GB
  579. // bufers.
  580. func (cc *ClientConn) frameScratchBuffer() []byte {
  581. cc.mu.Lock()
  582. size := cc.maxFrameSize
  583. if size > maxAllocFrameSize {
  584. size = maxAllocFrameSize
  585. }
  586. for i, buf := range cc.freeBuf {
  587. if len(buf) >= int(size) {
  588. cc.freeBuf[i] = nil
  589. cc.mu.Unlock()
  590. return buf[:size]
  591. }
  592. }
  593. cc.mu.Unlock()
  594. return make([]byte, size)
  595. }
  596. func (cc *ClientConn) putFrameScratchBuffer(buf []byte) {
  597. cc.mu.Lock()
  598. defer cc.mu.Unlock()
  599. const maxBufs = 4 // arbitrary; 4 concurrent requests per conn? investigate.
  600. if len(cc.freeBuf) < maxBufs {
  601. cc.freeBuf = append(cc.freeBuf, buf)
  602. return
  603. }
  604. for i, old := range cc.freeBuf {
  605. if old == nil {
  606. cc.freeBuf[i] = buf
  607. return
  608. }
  609. }
  610. // forget about it.
  611. }
  612. // errRequestCanceled is a copy of net/http's errRequestCanceled because it's not
  613. // exported. At least they'll be DeepEqual for h1-vs-h2 comparisons tests.
  614. var errRequestCanceled = errors.New("net/http: request canceled")
  615. func commaSeparatedTrailers(req *http.Request) (string, error) {
  616. keys := make([]string, 0, len(req.Trailer))
  617. for k := range req.Trailer {
  618. k = http.CanonicalHeaderKey(k)
  619. switch k {
  620. case "Transfer-Encoding", "Trailer", "Content-Length":
  621. return "", &badStringError{"invalid Trailer key", k}
  622. }
  623. keys = append(keys, k)
  624. }
  625. if len(keys) > 0 {
  626. sort.Strings(keys)
  627. return strings.Join(keys, ","), nil
  628. }
  629. return "", nil
  630. }
  631. func (cc *ClientConn) responseHeaderTimeout() time.Duration {
  632. if cc.t.t1 != nil {
  633. return cc.t.t1.ResponseHeaderTimeout
  634. }
  635. // No way to do this (yet?) with just an http2.Transport. Probably
  636. // no need. Request.Cancel this is the new way. We only need to support
  637. // this for compatibility with the old http.Transport fields when
  638. // we're doing transparent http2.
  639. return 0
  640. }
  641. // checkConnHeaders checks whether req has any invalid connection-level headers.
  642. // per RFC 7540 section 8.1.2.2: Connection-Specific Header Fields.
  643. // Certain headers are special-cased as okay but not transmitted later.
  644. func checkConnHeaders(req *http.Request) error {
  645. if v := req.Header.Get("Upgrade"); v != "" {
  646. return fmt.Errorf("http2: invalid Upgrade request header: %q", req.Header["Upgrade"])
  647. }
  648. if vv := req.Header["Transfer-Encoding"]; len(vv) > 0 && (len(vv) > 1 || vv[0] != "" && vv[0] != "chunked") {
  649. return fmt.Errorf("http2: invalid Transfer-Encoding request header: %q", vv)
  650. }
  651. if vv := req.Header["Connection"]; len(vv) > 0 && (len(vv) > 1 || vv[0] != "" && vv[0] != "close" && vv[0] != "keep-alive") {
  652. return fmt.Errorf("http2: invalid Connection request header: %q", vv)
  653. }
  654. return nil
  655. }
  656. // actualContentLength returns a sanitized version of
  657. // req.ContentLength, where 0 actually means zero (not unknown) and -1
  658. // means unknown.
  659. func actualContentLength(req *http.Request) int64 {
  660. if req.Body == nil || reqBodyIsNoBody(req.Body) {
  661. return 0
  662. }
  663. if req.ContentLength != 0 {
  664. return req.ContentLength
  665. }
  666. return -1
  667. }
  668. func (cc *ClientConn) RoundTrip(req *http.Request) (*http.Response, error) {
  669. if err := checkConnHeaders(req); err != nil {
  670. return nil, err
  671. }
  672. if cc.idleTimer != nil {
  673. cc.idleTimer.Stop()
  674. }
  675. trailers, err := commaSeparatedTrailers(req)
  676. if err != nil {
  677. return nil, err
  678. }
  679. hasTrailers := trailers != ""
  680. cc.mu.Lock()
  681. if err := cc.awaitOpenSlotForRequest(req); err != nil {
  682. cc.mu.Unlock()
  683. return nil, err
  684. }
  685. body := req.Body
  686. contentLen := actualContentLength(req)
  687. hasBody := contentLen != 0
  688. // TODO(bradfitz): this is a copy of the logic in net/http. Unify somewhere?
  689. var requestedGzip bool
  690. if !cc.t.disableCompression() &&
  691. req.Header.Get("Accept-Encoding") == "" &&
  692. req.Header.Get("Range") == "" &&
  693. req.Method != "HEAD" {
  694. // Request gzip only, not deflate. Deflate is ambiguous and
  695. // not as universally supported anyway.
  696. // See: http://www.gzip.org/zlib/zlib_faq.html#faq38
  697. //
  698. // Note that we don't request this for HEAD requests,
  699. // due to a bug in nginx:
  700. // http://trac.nginx.org/nginx/ticket/358
  701. // https://golang.org/issue/5522
  702. //
  703. // We don't request gzip if the request is for a range, since
  704. // auto-decoding a portion of a gzipped document will just fail
  705. // anyway. See https://golang.org/issue/8923
  706. requestedGzip = true
  707. }
  708. // we send: HEADERS{1}, CONTINUATION{0,} + DATA{0,} (DATA is
  709. // sent by writeRequestBody below, along with any Trailers,
  710. // again in form HEADERS{1}, CONTINUATION{0,})
  711. hdrs, err := cc.encodeHeaders(req, requestedGzip, trailers, contentLen)
  712. if err != nil {
  713. cc.mu.Unlock()
  714. return nil, err
  715. }
  716. cs := cc.newStream()
  717. cs.req = req
  718. cs.trace = requestTrace(req)
  719. cs.requestedGzip = requestedGzip
  720. bodyWriter := cc.t.getBodyWriterState(cs, body)
  721. cs.on100 = bodyWriter.on100
  722. cc.wmu.Lock()
  723. endStream := !hasBody && !hasTrailers
  724. werr := cc.writeHeaders(cs.ID, endStream, hdrs)
  725. cc.wmu.Unlock()
  726. traceWroteHeaders(cs.trace)
  727. cc.mu.Unlock()
  728. if werr != nil {
  729. if hasBody {
  730. req.Body.Close() // per RoundTripper contract
  731. bodyWriter.cancel()
  732. }
  733. cc.forgetStreamID(cs.ID)
  734. // Don't bother sending a RST_STREAM (our write already failed;
  735. // no need to keep writing)
  736. traceWroteRequest(cs.trace, werr)
  737. return nil, werr
  738. }
  739. var respHeaderTimer <-chan time.Time
  740. if hasBody {
  741. bodyWriter.scheduleBodyWrite()
  742. } else {
  743. traceWroteRequest(cs.trace, nil)
  744. if d := cc.responseHeaderTimeout(); d != 0 {
  745. timer := time.NewTimer(d)
  746. defer timer.Stop()
  747. respHeaderTimer = timer.C
  748. }
  749. }
  750. readLoopResCh := cs.resc
  751. bodyWritten := false
  752. ctx := reqContext(req)
  753. handleReadLoopResponse := func(re resAndError) (*http.Response, error) {
  754. res := re.res
  755. if re.err != nil || res.StatusCode > 299 {
  756. // On error or status code 3xx, 4xx, 5xx, etc abort any
  757. // ongoing write, assuming that the server doesn't care
  758. // about our request body. If the server replied with 1xx or
  759. // 2xx, however, then assume the server DOES potentially
  760. // want our body (e.g. full-duplex streaming:
  761. // golang.org/issue/13444). If it turns out the server
  762. // doesn't, they'll RST_STREAM us soon enough. This is a
  763. // heuristic to avoid adding knobs to Transport. Hopefully
  764. // we can keep it.
  765. bodyWriter.cancel()
  766. cs.abortRequestBodyWrite(errStopReqBodyWrite)
  767. }
  768. if re.err != nil {
  769. cc.mu.Lock()
  770. afterBodyWrite := cs.startedWrite
  771. cc.mu.Unlock()
  772. cc.forgetStreamID(cs.ID)
  773. if afterBodyWrite {
  774. return nil, afterReqBodyWriteError{re.err}
  775. }
  776. return nil, re.err
  777. }
  778. res.Request = req
  779. res.TLS = cc.tlsState
  780. return res, nil
  781. }
  782. for {
  783. select {
  784. case re := <-readLoopResCh:
  785. return handleReadLoopResponse(re)
  786. case <-respHeaderTimer:
  787. if !hasBody || bodyWritten {
  788. cc.writeStreamReset(cs.ID, ErrCodeCancel, nil)
  789. } else {
  790. bodyWriter.cancel()
  791. cs.abortRequestBodyWrite(errStopReqBodyWriteAndCancel)
  792. }
  793. cc.forgetStreamID(cs.ID)
  794. return nil, errTimeout
  795. case <-ctx.Done():
  796. if !hasBody || bodyWritten {
  797. cc.writeStreamReset(cs.ID, ErrCodeCancel, nil)
  798. } else {
  799. bodyWriter.cancel()
  800. cs.abortRequestBodyWrite(errStopReqBodyWriteAndCancel)
  801. }
  802. cc.forgetStreamID(cs.ID)
  803. return nil, ctx.Err()
  804. case <-req.Cancel:
  805. if !hasBody || bodyWritten {
  806. cc.writeStreamReset(cs.ID, ErrCodeCancel, nil)
  807. } else {
  808. bodyWriter.cancel()
  809. cs.abortRequestBodyWrite(errStopReqBodyWriteAndCancel)
  810. }
  811. cc.forgetStreamID(cs.ID)
  812. return nil, errRequestCanceled
  813. case <-cs.peerReset:
  814. // processResetStream already removed the
  815. // stream from the streams map; no need for
  816. // forgetStreamID.
  817. return nil, cs.resetErr
  818. case err := <-bodyWriter.resc:
  819. // Prefer the read loop's response, if available. Issue 16102.
  820. select {
  821. case re := <-readLoopResCh:
  822. return handleReadLoopResponse(re)
  823. default:
  824. }
  825. if err != nil {
  826. return nil, err
  827. }
  828. bodyWritten = true
  829. if d := cc.responseHeaderTimeout(); d != 0 {
  830. timer := time.NewTimer(d)
  831. defer timer.Stop()
  832. respHeaderTimer = timer.C
  833. }
  834. }
  835. }
  836. }
  837. // awaitOpenSlotForRequest waits until len(streams) < maxConcurrentStreams.
  838. // Must hold cc.mu.
  839. func (cc *ClientConn) awaitOpenSlotForRequest(req *http.Request) error {
  840. var waitingForConn chan struct{}
  841. var waitingForConnErr error // guarded by cc.mu
  842. for {
  843. cc.lastActive = time.Now()
  844. if cc.closed || !cc.canTakeNewRequestLocked() {
  845. return errClientConnUnusable
  846. }
  847. if int64(len(cc.streams))+1 <= int64(cc.maxConcurrentStreams) {
  848. if waitingForConn != nil {
  849. close(waitingForConn)
  850. }
  851. return nil
  852. }
  853. // Unfortunately, we cannot wait on a condition variable and channel at
  854. // the same time, so instead, we spin up a goroutine to check if the
  855. // request is canceled while we wait for a slot to open in the connection.
  856. if waitingForConn == nil {
  857. waitingForConn = make(chan struct{})
  858. go func() {
  859. if err := awaitRequestCancel(req, waitingForConn); err != nil {
  860. cc.mu.Lock()
  861. waitingForConnErr = err
  862. cc.cond.Broadcast()
  863. cc.mu.Unlock()
  864. }
  865. }()
  866. }
  867. cc.pendingRequests++
  868. cc.cond.Wait()
  869. cc.pendingRequests--
  870. if waitingForConnErr != nil {
  871. return waitingForConnErr
  872. }
  873. }
  874. }
  875. // requires cc.wmu be held
  876. func (cc *ClientConn) writeHeaders(streamID uint32, endStream bool, hdrs []byte) error {
  877. first := true // first frame written (HEADERS is first, then CONTINUATION)
  878. frameSize := int(cc.maxFrameSize)
  879. for len(hdrs) > 0 && cc.werr == nil {
  880. chunk := hdrs
  881. if len(chunk) > frameSize {
  882. chunk = chunk[:frameSize]
  883. }
  884. hdrs = hdrs[len(chunk):]
  885. endHeaders := len(hdrs) == 0
  886. if first {
  887. cc.fr.WriteHeaders(HeadersFrameParam{
  888. StreamID: streamID,
  889. BlockFragment: chunk,
  890. EndStream: endStream,
  891. EndHeaders: endHeaders,
  892. })
  893. first = false
  894. } else {
  895. cc.fr.WriteContinuation(streamID, endHeaders, chunk)
  896. }
  897. }
  898. // TODO(bradfitz): this Flush could potentially block (as
  899. // could the WriteHeaders call(s) above), which means they
  900. // wouldn't respond to Request.Cancel being readable. That's
  901. // rare, but this should probably be in a goroutine.
  902. cc.bw.Flush()
  903. return cc.werr
  904. }
  905. // internal error values; they don't escape to callers
  906. var (
  907. // abort request body write; don't send cancel
  908. errStopReqBodyWrite = errors.New("http2: aborting request body write")
  909. // abort request body write, but send stream reset of cancel.
  910. errStopReqBodyWriteAndCancel = errors.New("http2: canceling request")
  911. )
  912. func (cs *clientStream) writeRequestBody(body io.Reader, bodyCloser io.Closer) (err error) {
  913. cc := cs.cc
  914. sentEnd := false // whether we sent the final DATA frame w/ END_STREAM
  915. buf := cc.frameScratchBuffer()
  916. defer cc.putFrameScratchBuffer(buf)
  917. defer func() {
  918. traceWroteRequest(cs.trace, err)
  919. // TODO: write h12Compare test showing whether
  920. // Request.Body is closed by the Transport,
  921. // and in multiple cases: server replies <=299 and >299
  922. // while still writing request body
  923. cerr := bodyCloser.Close()
  924. if err == nil {
  925. err = cerr
  926. }
  927. }()
  928. req := cs.req
  929. hasTrailers := req.Trailer != nil
  930. var sawEOF bool
  931. for !sawEOF {
  932. n, err := body.Read(buf)
  933. if err == io.EOF {
  934. sawEOF = true
  935. err = nil
  936. } else if err != nil {
  937. return err
  938. }
  939. remain := buf[:n]
  940. for len(remain) > 0 && err == nil {
  941. var allowed int32
  942. allowed, err = cs.awaitFlowControl(len(remain))
  943. switch {
  944. case err == errStopReqBodyWrite:
  945. return err
  946. case err == errStopReqBodyWriteAndCancel:
  947. cc.writeStreamReset(cs.ID, ErrCodeCancel, nil)
  948. return err
  949. case err != nil:
  950. return err
  951. }
  952. cc.wmu.Lock()
  953. data := remain[:allowed]
  954. remain = remain[allowed:]
  955. sentEnd = sawEOF && len(remain) == 0 && !hasTrailers
  956. err = cc.fr.WriteData(cs.ID, sentEnd, data)
  957. if err == nil {
  958. // TODO(bradfitz): this flush is for latency, not bandwidth.
  959. // Most requests won't need this. Make this opt-in or
  960. // opt-out? Use some heuristic on the body type? Nagel-like
  961. // timers? Based on 'n'? Only last chunk of this for loop,
  962. // unless flow control tokens are low? For now, always.
  963. // If we change this, see comment below.
  964. err = cc.bw.Flush()
  965. }
  966. cc.wmu.Unlock()
  967. }
  968. if err != nil {
  969. return err
  970. }
  971. }
  972. if sentEnd {
  973. // Already sent END_STREAM (which implies we have no
  974. // trailers) and flushed, because currently all
  975. // WriteData frames above get a flush. So we're done.
  976. return nil
  977. }
  978. var trls []byte
  979. if hasTrailers {
  980. cc.mu.Lock()
  981. trls, err = cc.encodeTrailers(req)
  982. cc.mu.Unlock()
  983. if err != nil {
  984. cc.writeStreamReset(cs.ID, ErrCodeInternal, err)
  985. cc.forgetStreamID(cs.ID)
  986. return err
  987. }
  988. }
  989. cc.wmu.Lock()
  990. defer cc.wmu.Unlock()
  991. // Two ways to send END_STREAM: either with trailers, or
  992. // with an empty DATA frame.
  993. if len(trls) > 0 {
  994. err = cc.writeHeaders(cs.ID, true, trls)
  995. } else {
  996. err = cc.fr.WriteData(cs.ID, true, nil)
  997. }
  998. if ferr := cc.bw.Flush(); ferr != nil && err == nil {
  999. err = ferr
  1000. }
  1001. return err
  1002. }
  1003. // awaitFlowControl waits for [1, min(maxBytes, cc.cs.maxFrameSize)] flow
  1004. // control tokens from the server.
  1005. // It returns either the non-zero number of tokens taken or an error
  1006. // if the stream is dead.
  1007. func (cs *clientStream) awaitFlowControl(maxBytes int) (taken int32, err error) {
  1008. cc := cs.cc
  1009. cc.mu.Lock()
  1010. defer cc.mu.Unlock()
  1011. for {
  1012. if cc.closed {
  1013. return 0, errClientConnClosed
  1014. }
  1015. if cs.stopReqBody != nil {
  1016. return 0, cs.stopReqBody
  1017. }
  1018. if err := cs.checkResetOrDone(); err != nil {
  1019. return 0, err
  1020. }
  1021. if a := cs.flow.available(); a > 0 {
  1022. take := a
  1023. if int(take) > maxBytes {
  1024. take = int32(maxBytes) // can't truncate int; take is int32
  1025. }
  1026. if take > int32(cc.maxFrameSize) {
  1027. take = int32(cc.maxFrameSize)
  1028. }
  1029. cs.flow.take(take)
  1030. return take, nil
  1031. }
  1032. cc.cond.Wait()
  1033. }
  1034. }
  1035. type badStringError struct {
  1036. what string
  1037. str string
  1038. }
  1039. func (e *badStringError) Error() string { return fmt.Sprintf("%s %q", e.what, e.str) }
  1040. // requires cc.mu be held.
  1041. func (cc *ClientConn) encodeHeaders(req *http.Request, addGzipHeader bool, trailers string, contentLength int64) ([]byte, error) {
  1042. cc.hbuf.Reset()
  1043. host := req.Host
  1044. if host == "" {
  1045. host = req.URL.Host
  1046. }
  1047. host, err := httplex.PunycodeHostPort(host)
  1048. if err != nil {
  1049. return nil, err
  1050. }
  1051. var path string
  1052. if req.Method != "CONNECT" {
  1053. path = req.URL.RequestURI()
  1054. if !validPseudoPath(path) {
  1055. orig := path
  1056. path = strings.TrimPrefix(path, req.URL.Scheme+"://"+host)
  1057. if !validPseudoPath(path) {
  1058. if req.URL.Opaque != "" {
  1059. return nil, fmt.Errorf("invalid request :path %q from URL.Opaque = %q", orig, req.URL.Opaque)
  1060. } else {
  1061. return nil, fmt.Errorf("invalid request :path %q", orig)
  1062. }
  1063. }
  1064. }
  1065. }
  1066. // Check for any invalid headers and return an error before we
  1067. // potentially pollute our hpack state. (We want to be able to
  1068. // continue to reuse the hpack encoder for future requests)
  1069. for k, vv := range req.Header {
  1070. if !httplex.ValidHeaderFieldName(k) {
  1071. return nil, fmt.Errorf("invalid HTTP header name %q", k)
  1072. }
  1073. for _, v := range vv {
  1074. if !httplex.ValidHeaderFieldValue(v) {
  1075. return nil, fmt.Errorf("invalid HTTP header value %q for header %q", v, k)
  1076. }
  1077. }
  1078. }
  1079. enumerateHeaders := func(f func(name, value string)) {
  1080. // 8.1.2.3 Request Pseudo-Header Fields
  1081. // The :path pseudo-header field includes the path and query parts of the
  1082. // target URI (the path-absolute production and optionally a '?' character
  1083. // followed by the query production (see Sections 3.3 and 3.4 of
  1084. // [RFC3986]).
  1085. f(":authority", host)
  1086. f(":method", req.Method)
  1087. if req.Method != "CONNECT" {
  1088. f(":path", path)
  1089. f(":scheme", req.URL.Scheme)
  1090. }
  1091. if trailers != "" {
  1092. f("trailer", trailers)
  1093. }
  1094. var didUA bool
  1095. for k, vv := range req.Header {
  1096. if strings.EqualFold(k, "host") || strings.EqualFold(k, "content-length") {
  1097. // Host is :authority, already sent.
  1098. // Content-Length is automatic, set below.
  1099. continue
  1100. } else if strings.EqualFold(k, "connection") || strings.EqualFold(k, "proxy-connection") ||
  1101. strings.EqualFold(k, "transfer-encoding") || strings.EqualFold(k, "upgrade") ||
  1102. strings.EqualFold(k, "keep-alive") {
  1103. // Per 8.1.2.2 Connection-Specific Header
  1104. // Fields, don't send connection-specific
  1105. // fields. We have already checked if any
  1106. // are error-worthy so just ignore the rest.
  1107. continue
  1108. } else if strings.EqualFold(k, "user-agent") {
  1109. // Match Go's http1 behavior: at most one
  1110. // User-Agent. If set to nil or empty string,
  1111. // then omit it. Otherwise if not mentioned,
  1112. // include the default (below).
  1113. didUA = true
  1114. if len(vv) < 1 {
  1115. continue
  1116. }
  1117. vv = vv[:1]
  1118. if vv[0] == "" {
  1119. continue
  1120. }
  1121. }
  1122. for _, v := range vv {
  1123. f(k, v)
  1124. }
  1125. }
  1126. if shouldSendReqContentLength(req.Method, contentLength) {
  1127. f("content-length", strconv.FormatInt(contentLength, 10))
  1128. }
  1129. if addGzipHeader {
  1130. f("accept-encoding", "gzip")
  1131. }
  1132. if !didUA {
  1133. f("user-agent", defaultUserAgent)
  1134. }
  1135. }
  1136. // Do a first pass over the headers counting bytes to ensure
  1137. // we don't exceed cc.peerMaxHeaderListSize. This is done as a
  1138. // separate pass before encoding the headers to prevent
  1139. // modifying the hpack state.
  1140. hlSize := uint64(0)
  1141. enumerateHeaders(func(name, value string) {
  1142. hf := hpack.HeaderField{Name: name, Value: value}
  1143. hlSize += uint64(hf.Size())
  1144. })
  1145. if hlSize > cc.peerMaxHeaderListSize {
  1146. return nil, errRequestHeaderListSize
  1147. }
  1148. // Header list size is ok. Write the headers.
  1149. enumerateHeaders(func(name, value string) {
  1150. cc.writeHeader(strings.ToLower(name), value)
  1151. })
  1152. return cc.hbuf.Bytes(), nil
  1153. }
  1154. // shouldSendReqContentLength reports whether the http2.Transport should send
  1155. // a "content-length" request header. This logic is basically a copy of the net/http
  1156. // transferWriter.shouldSendContentLength.
  1157. // The contentLength is the corrected contentLength (so 0 means actually 0, not unknown).
  1158. // -1 means unknown.
  1159. func shouldSendReqContentLength(method string, contentLength int64) bool {
  1160. if contentLength > 0 {
  1161. return true
  1162. }
  1163. if contentLength < 0 {
  1164. return false
  1165. }
  1166. // For zero bodies, whether we send a content-length depends on the method.
  1167. // It also kinda doesn't matter for http2 either way, with END_STREAM.
  1168. switch method {
  1169. case "POST", "PUT", "PATCH":
  1170. return true
  1171. default:
  1172. return false
  1173. }
  1174. }
  1175. // requires cc.mu be held.
  1176. func (cc *ClientConn) encodeTrailers(req *http.Request) ([]byte, error) {
  1177. cc.hbuf.Reset()
  1178. hlSize := uint64(0)
  1179. for k, vv := range req.Trailer {
  1180. for _, v := range vv {
  1181. hf := hpack.HeaderField{Name: k, Value: v}
  1182. hlSize += uint64(hf.Size())
  1183. }
  1184. }
  1185. if hlSize > cc.peerMaxHeaderListSize {
  1186. return nil, errRequestHeaderListSize
  1187. }
  1188. for k, vv := range req.Trailer {
  1189. // Transfer-Encoding, etc.. have already been filtered at the
  1190. // start of RoundTrip
  1191. lowKey := strings.ToLower(k)
  1192. for _, v := range vv {
  1193. cc.writeHeader(lowKey, v)
  1194. }
  1195. }
  1196. return cc.hbuf.Bytes(), nil
  1197. }
  1198. func (cc *ClientConn) writeHeader(name, value string) {
  1199. if VerboseLogs {
  1200. log.Printf("http2: Transport encoding header %q = %q", name, value)
  1201. }
  1202. cc.henc.WriteField(hpack.HeaderField{Name: name, Value: value})
  1203. }
  1204. type resAndError struct {
  1205. res *http.Response
  1206. err error
  1207. }
  1208. // requires cc.mu be held.
  1209. func (cc *ClientConn) newStream() *clientStream {
  1210. cs := &clientStream{
  1211. cc: cc,
  1212. ID: cc.nextStreamID,
  1213. resc: make(chan resAndError, 1),
  1214. peerReset: make(chan struct{}),
  1215. done: make(chan struct{}),
  1216. }
  1217. cs.flow.add(int32(cc.initialWindowSize))
  1218. cs.flow.setConnFlow(&cc.flow)
  1219. cs.inflow.add(transportDefaultStreamFlow)
  1220. cs.inflow.setConnFlow(&cc.inflow)
  1221. cc.nextStreamID += 2
  1222. cc.streams[cs.ID] = cs
  1223. return cs
  1224. }
  1225. func (cc *ClientConn) forgetStreamID(id uint32) {
  1226. cc.streamByID(id, true)
  1227. }
  1228. func (cc *ClientConn) streamByID(id uint32, andRemove bool) *clientStream {
  1229. cc.mu.Lock()
  1230. defer cc.mu.Unlock()
  1231. cs := cc.streams[id]
  1232. if andRemove && cs != nil && !cc.closed {
  1233. cc.lastActive = time.Now()
  1234. delete(cc.streams, id)
  1235. if len(cc.streams) == 0 && cc.idleTimer != nil {
  1236. cc.idleTimer.Reset(cc.idleTimeout)
  1237. }
  1238. close(cs.done)
  1239. // Wake up checkResetOrDone via clientStream.awaitFlowControl and
  1240. // wake up RoundTrip if there is a pending request.
  1241. cc.cond.Broadcast()
  1242. }
  1243. return cs
  1244. }
  1245. // clientConnReadLoop is the state owned by the clientConn's frame-reading readLoop.
  1246. type clientConnReadLoop struct {
  1247. cc *ClientConn
  1248. activeRes map[uint32]*clientStream // keyed by streamID
  1249. closeWhenIdle bool
  1250. }
  1251. // readLoop runs in its own goroutine and reads and dispatches frames.
  1252. func (cc *ClientConn) readLoop() {
  1253. rl := &clientConnReadLoop{
  1254. cc: cc,
  1255. activeRes: make(map[uint32]*clientStream),
  1256. }
  1257. defer rl.cleanup()
  1258. cc.readerErr = rl.run()
  1259. if ce, ok := cc.readerErr.(ConnectionError); ok {
  1260. cc.wmu.Lock()
  1261. cc.fr.WriteGoAway(0, ErrCode(ce), nil)
  1262. cc.wmu.Unlock()
  1263. }
  1264. }
  1265. // GoAwayError is returned by the Transport when the server closes the
  1266. // TCP connection after sending a GOAWAY frame.
  1267. type GoAwayError struct {
  1268. LastStreamID uint32
  1269. ErrCode ErrCode
  1270. DebugData string
  1271. }
  1272. func (e GoAwayError) Error() string {
  1273. return fmt.Sprintf("http2: server sent GOAWAY and closed the connection; LastStreamID=%v, ErrCode=%v, debug=%q",
  1274. e.LastStreamID, e.ErrCode, e.DebugData)
  1275. }
  1276. func isEOFOrNetReadError(err error) bool {
  1277. if err == io.EOF {
  1278. return true
  1279. }
  1280. ne, ok := err.(*net.OpError)
  1281. return ok && ne.Op == "read"
  1282. }
  1283. func (rl *clientConnReadLoop) cleanup() {
  1284. cc := rl.cc
  1285. defer cc.tconn.Close()
  1286. defer cc.t.connPool().MarkDead(cc)
  1287. defer close(cc.readerDone)
  1288. if cc.idleTimer != nil {
  1289. cc.idleTimer.Stop()
  1290. }
  1291. // Close any response bodies if the server closes prematurely.
  1292. // TODO: also do this if we've written the headers but not
  1293. // gotten a response yet.
  1294. err := cc.readerErr
  1295. cc.mu.Lock()
  1296. if cc.goAway != nil && isEOFOrNetReadError(err) {
  1297. err = GoAwayError{
  1298. LastStreamID: cc.goAway.LastStreamID,
  1299. ErrCode: cc.goAway.ErrCode,
  1300. DebugData: cc.goAwayDebug,
  1301. }
  1302. } else if err == io.EOF {
  1303. err = io.ErrUnexpectedEOF
  1304. }
  1305. for _, cs := range rl.activeRes {
  1306. cs.bufPipe.CloseWithError(err)
  1307. }
  1308. for _, cs := range cc.streams {
  1309. select {
  1310. case cs.resc <- resAndError{err: err}:
  1311. default:
  1312. }
  1313. close(cs.done)
  1314. }
  1315. cc.closed = true
  1316. cc.cond.Broadcast()
  1317. cc.mu.Unlock()
  1318. }
  1319. func (rl *clientConnReadLoop) run() error {
  1320. cc := rl.cc
  1321. rl.closeWhenIdle = cc.t.disableKeepAlives() || cc.singleUse
  1322. gotReply := false // ever saw a HEADERS reply
  1323. gotSettings := false
  1324. for {
  1325. f, err := cc.fr.ReadFrame()
  1326. if err != nil {
  1327. cc.vlogf("http2: Transport readFrame error on conn %p: (%T) %v", cc, err, err)
  1328. }
  1329. if se, ok := err.(StreamError); ok {
  1330. if cs := cc.streamByID(se.StreamID, false); cs != nil {
  1331. cs.cc.writeStreamReset(cs.ID, se.Code, err)
  1332. cs.cc.forgetStreamID(cs.ID)
  1333. if se.Cause == nil {
  1334. se.Cause = cc.fr.errDetail
  1335. }
  1336. rl.endStreamError(cs, se)
  1337. }
  1338. continue
  1339. } else if err != nil {
  1340. return err
  1341. }
  1342. if VerboseLogs {
  1343. cc.vlogf("http2: Transport received %s", summarizeFrame(f))
  1344. }
  1345. if !gotSettings {
  1346. if _, ok := f.(*SettingsFrame); !ok {
  1347. cc.logf("protocol error: received %T before a SETTINGS frame", f)
  1348. return ConnectionError(ErrCodeProtocol)
  1349. }
  1350. gotSettings = true
  1351. }
  1352. maybeIdle := false // whether frame might transition us to idle
  1353. switch f := f.(type) {
  1354. case *MetaHeadersFrame:
  1355. err = rl.processHeaders(f)
  1356. maybeIdle = true
  1357. gotReply = true
  1358. case *DataFrame:
  1359. err = rl.processData(f)
  1360. maybeIdle = true
  1361. case *GoAwayFrame:
  1362. err = rl.processGoAway(f)
  1363. maybeIdle = true
  1364. case *RSTStreamFrame:
  1365. err = rl.processResetStream(f)
  1366. maybeIdle = true
  1367. case *SettingsFrame:
  1368. err = rl.processSettings(f)
  1369. case *PushPromiseFrame:
  1370. err = rl.processPushPromise(f)
  1371. case *WindowUpdateFrame:
  1372. err = rl.processWindowUpdate(f)
  1373. case *PingFrame:
  1374. err = rl.processPing(f)
  1375. default:
  1376. cc.logf("Transport: unhandled response frame type %T", f)
  1377. }
  1378. if err != nil {
  1379. if VerboseLogs {
  1380. cc.vlogf("http2: Transport conn %p received error from processing frame %v: %v", cc, summarizeFrame(f), err)
  1381. }
  1382. return err
  1383. }
  1384. if rl.closeWhenIdle && gotReply && maybeIdle && len(rl.activeRes) == 0 {
  1385. cc.closeIfIdle()
  1386. }
  1387. }
  1388. }
  1389. func (rl *clientConnReadLoop) processHeaders(f *MetaHeadersFrame) error {
  1390. cc := rl.cc
  1391. cs := cc.streamByID(f.StreamID, f.StreamEnded())
  1392. if cs == nil {
  1393. // We'd get here if we canceled a request while the
  1394. // server had its response still in flight. So if this
  1395. // was just something we canceled, ignore it.
  1396. return nil
  1397. }
  1398. if !cs.firstByte {
  1399. if cs.trace != nil {
  1400. // TODO(bradfitz): move first response byte earlier,
  1401. // when we first read the 9 byte header, not waiting
  1402. // until all the HEADERS+CONTINUATION frames have been
  1403. // merged. This works for now.
  1404. traceFirstResponseByte(cs.trace)
  1405. }
  1406. cs.firstByte = true
  1407. }
  1408. if !cs.pastHeaders {
  1409. cs.pastHeaders = true
  1410. } else {
  1411. return rl.processTrailers(cs, f)
  1412. }
  1413. res, err := rl.handleResponse(cs, f)
  1414. if err != nil {
  1415. if _, ok := err.(ConnectionError); ok {
  1416. return err
  1417. }
  1418. // Any other error type is a stream error.
  1419. cs.cc.writeStreamReset(f.StreamID, ErrCodeProtocol, err)
  1420. cs.resc <- resAndError{err: err}
  1421. return nil // return nil from process* funcs to keep conn alive
  1422. }
  1423. if res == nil {
  1424. // (nil, nil) special case. See handleResponse docs.
  1425. return nil
  1426. }
  1427. if res.Body != noBody {
  1428. rl.activeRes[cs.ID] = cs
  1429. }
  1430. cs.resTrailer = &res.Trailer
  1431. cs.resc <- resAndError{res: res}
  1432. return nil
  1433. }
  1434. // may return error types nil, or ConnectionError. Any other error value
  1435. // is a StreamError of type ErrCodeProtocol. The returned error in that case
  1436. // is the detail.
  1437. //
  1438. // As a special case, handleResponse may return (nil, nil) to skip the
  1439. // frame (currently only used for 100 expect continue). This special
  1440. // case is going away after Issue 13851 is fixed.
  1441. func (rl *clientConnReadLoop) handleResponse(cs *clientStream, f *MetaHeadersFrame) (*http.Response, error) {
  1442. if f.Truncated {
  1443. return nil, errResponseHeaderListSize
  1444. }
  1445. status := f.PseudoValue("status")
  1446. if status == "" {
  1447. return nil, errors.New("missing status pseudo header")
  1448. }
  1449. statusCode, err := strconv.Atoi(status)
  1450. if err != nil {
  1451. return nil, errors.New("malformed non-numeric status pseudo header")
  1452. }
  1453. if statusCode == 100 {
  1454. traceGot100Continue(cs.trace)
  1455. if cs.on100 != nil {
  1456. cs.on100() // forces any write delay timer to fire
  1457. }
  1458. cs.pastHeaders = false // do it all again
  1459. return nil, nil
  1460. }
  1461. header := make(http.Header)
  1462. res := &http.Response{
  1463. Proto: "HTTP/2.0",
  1464. ProtoMajor: 2,
  1465. Header: header,
  1466. StatusCode: statusCode,
  1467. Status: status + " " + http.StatusText(statusCode),
  1468. }
  1469. for _, hf := range f.RegularFields() {
  1470. key := http.CanonicalHeaderKey(hf.Name)
  1471. if key == "Trailer" {
  1472. t := res.Trailer
  1473. if t == nil {
  1474. t = make(http.Header)
  1475. res.Trailer = t
  1476. }
  1477. foreachHeaderElement(hf.Value, func(v string) {
  1478. t[http.CanonicalHeaderKey(v)] = nil
  1479. })
  1480. } else {
  1481. header[key] = append(header[key], hf.Value)
  1482. }
  1483. }
  1484. streamEnded := f.StreamEnded()
  1485. isHead := cs.req.Method == "HEAD"
  1486. if !streamEnded || isHead {
  1487. res.ContentLength = -1
  1488. if clens := res.Header["Content-Length"]; len(clens) == 1 {
  1489. if clen64, err := strconv.ParseInt(clens[0], 10, 64); err == nil {
  1490. res.ContentLength = clen64
  1491. } else {
  1492. // TODO: care? unlike http/1, it won't mess up our framing, so it's
  1493. // more safe smuggling-wise to ignore.
  1494. }
  1495. } else if len(clens) > 1 {
  1496. // TODO: care? unlike http/1, it won't mess up our framing, so it's
  1497. // more safe smuggling-wise to ignore.
  1498. }
  1499. }
  1500. if streamEnded || isHead {
  1501. res.Body = noBody
  1502. return res, nil
  1503. }
  1504. cs.bufPipe = pipe{b: &dataBuffer{expected: res.ContentLength}}
  1505. cs.bytesRemain = res.ContentLength
  1506. res.Body = transportResponseBody{cs}
  1507. go cs.awaitRequestCancel(cs.req)
  1508. if cs.requestedGzip && res.Header.Get("Content-Encoding") == "gzip" {
  1509. res.Header.Del("Content-Encoding")
  1510. res.Header.Del("Content-Length")
  1511. res.ContentLength = -1
  1512. res.Body = &gzipReader{body: res.Body}
  1513. setResponseUncompressed(res)
  1514. }
  1515. return res, nil
  1516. }
  1517. func (rl *clientConnReadLoop) processTrailers(cs *clientStream, f *MetaHeadersFrame) error {
  1518. if cs.pastTrailers {
  1519. // Too many HEADERS frames for this stream.
  1520. return ConnectionError(ErrCodeProtocol)
  1521. }
  1522. cs.pastTrailers = true
  1523. if !f.StreamEnded() {
  1524. // We expect that any headers for trailers also
  1525. // has END_STREAM.
  1526. return ConnectionError(ErrCodeProtocol)
  1527. }
  1528. if len(f.PseudoFields()) > 0 {
  1529. // No pseudo header fields are defined for trailers.
  1530. // TODO: ConnectionError might be overly harsh? Check.
  1531. return ConnectionError(ErrCodeProtocol)
  1532. }
  1533. trailer := make(http.Header)
  1534. for _, hf := range f.RegularFields() {
  1535. key := http.CanonicalHeaderKey(hf.Name)
  1536. trailer[key] = append(trailer[key], hf.Value)
  1537. }
  1538. cs.trailer = trailer
  1539. rl.endStream(cs)
  1540. return nil
  1541. }
  1542. // transportResponseBody is the concrete type of Transport.RoundTrip's
  1543. // Response.Body. It is an io.ReadCloser. On Read, it reads from cs.body.
  1544. // On Close it sends RST_STREAM if EOF wasn't already seen.
  1545. type transportResponseBody struct {
  1546. cs *clientStream
  1547. }
  1548. func (b transportResponseBody) Read(p []byte) (n int, err error) {
  1549. cs := b.cs
  1550. cc := cs.cc
  1551. if cs.readErr != nil {
  1552. return 0, cs.readErr
  1553. }
  1554. n, err = b.cs.bufPipe.Read(p)
  1555. if cs.bytesRemain != -1 {
  1556. if int64(n) > cs.bytesRemain {
  1557. n = int(cs.bytesRemain)
  1558. if err == nil {
  1559. err = errors.New("net/http: server replied with more than declared Content-Length; truncated")
  1560. cc.writeStreamReset(cs.ID, ErrCodeProtocol, err)
  1561. }
  1562. cs.readErr = err
  1563. return int(cs.bytesRemain), err
  1564. }
  1565. cs.bytesRemain -= int64(n)
  1566. if err == io.EOF && cs.bytesRemain > 0 {
  1567. err = io.ErrUnexpectedEOF
  1568. cs.readErr = err
  1569. return n, err
  1570. }
  1571. }
  1572. if n == 0 {
  1573. // No flow control tokens to send back.
  1574. return
  1575. }
  1576. cc.mu.Lock()
  1577. defer cc.mu.Unlock()
  1578. var connAdd, streamAdd int32
  1579. // Check the conn-level first, before the stream-level.
  1580. if v := cc.inflow.available(); v < transportDefaultConnFlow/2 {
  1581. connAdd = transportDefaultConnFlow - v
  1582. cc.inflow.add(connAdd)
  1583. }
  1584. if err == nil { // No need to refresh if the stream is over or failed.
  1585. // Consider any buffered body data (read from the conn but not
  1586. // consumed by the client) when computing flow control for this
  1587. // stream.
  1588. v := int(cs.inflow.available()) + cs.bufPipe.Len()
  1589. if v < transportDefaultStreamFlow-transportDefaultStreamMinRefresh {
  1590. streamAdd = int32(transportDefaultStreamFlow - v)
  1591. cs.inflow.add(streamAdd)
  1592. }
  1593. }
  1594. if connAdd != 0 || streamAdd != 0 {
  1595. cc.wmu.Lock()
  1596. defer cc.wmu.Unlock()
  1597. if connAdd != 0 {
  1598. cc.fr.WriteWindowUpdate(0, mustUint31(connAdd))
  1599. }
  1600. if streamAdd != 0 {
  1601. cc.fr.WriteWindowUpdate(cs.ID, mustUint31(streamAdd))
  1602. }
  1603. cc.bw.Flush()
  1604. }
  1605. return
  1606. }
  1607. var errClosedResponseBody = errors.New("http2: response body closed")
  1608. func (b transportResponseBody) Close() error {
  1609. cs := b.cs
  1610. cc := cs.cc
  1611. serverSentStreamEnd := cs.bufPipe.Err() == io.EOF
  1612. unread := cs.bufPipe.Len()
  1613. if unread > 0 || !serverSentStreamEnd {
  1614. cc.mu.Lock()
  1615. cc.wmu.Lock()
  1616. if !serverSentStreamEnd {
  1617. cc.fr.WriteRSTStream(cs.ID, ErrCodeCancel)
  1618. cs.didReset = true
  1619. }
  1620. // Return connection-level flow control.
  1621. if unread > 0 {
  1622. cc.inflow.add(int32(unread))
  1623. cc.fr.WriteWindowUpdate(0, uint32(unread))
  1624. }
  1625. cc.bw.Flush()
  1626. cc.wmu.Unlock()
  1627. cc.mu.Unlock()
  1628. }
  1629. cs.bufPipe.BreakWithError(errClosedResponseBody)
  1630. cc.forgetStreamID(cs.ID)
  1631. return nil
  1632. }
  1633. func (rl *clientConnReadLoop) processData(f *DataFrame) error {
  1634. cc := rl.cc
  1635. cs := cc.streamByID(f.StreamID, f.StreamEnded())
  1636. data := f.Data()
  1637. if cs == nil {
  1638. cc.mu.Lock()
  1639. neverSent := cc.nextStreamID
  1640. cc.mu.Unlock()
  1641. if f.StreamID >= neverSent {
  1642. // We never asked for this.
  1643. cc.logf("http2: Transport received unsolicited DATA frame; closing connection")
  1644. return ConnectionError(ErrCodeProtocol)
  1645. }
  1646. // We probably did ask for this, but canceled. Just ignore it.
  1647. // TODO: be stricter here? only silently ignore things which
  1648. // we canceled, but not things which were closed normally
  1649. // by the peer? Tough without accumulating too much state.
  1650. // But at least return their flow control:
  1651. if f.Length > 0 {
  1652. cc.mu.Lock()
  1653. cc.inflow.add(int32(f.Length))
  1654. cc.mu.Unlock()
  1655. cc.wmu.Lock()
  1656. cc.fr.WriteWindowUpdate(0, uint32(f.Length))
  1657. cc.bw.Flush()
  1658. cc.wmu.Unlock()
  1659. }
  1660. return nil
  1661. }
  1662. if !cs.firstByte {
  1663. cc.logf("protocol error: received DATA before a HEADERS frame")
  1664. rl.endStreamError(cs, StreamError{
  1665. StreamID: f.StreamID,
  1666. Code: ErrCodeProtocol,
  1667. })
  1668. return nil
  1669. }
  1670. if f.Length > 0 {
  1671. // Check connection-level flow control.
  1672. cc.mu.Lock()
  1673. if cs.inflow.available() >= int32(f.Length) {
  1674. cs.inflow.take(int32(f.Length))
  1675. } else {
  1676. cc.mu.Unlock()
  1677. return ConnectionError(ErrCodeFlowControl)
  1678. }
  1679. // Return any padded flow control now, since we won't
  1680. // refund it later on body reads.
  1681. var refund int
  1682. if pad := int(f.Length) - len(data); pad > 0 {
  1683. refund += pad
  1684. }
  1685. // Return len(data) now if the stream is already closed,
  1686. // since data will never be read.
  1687. didReset := cs.didReset
  1688. if didReset {
  1689. refund += len(data)
  1690. }
  1691. if refund > 0 {
  1692. cc.inflow.add(int32(refund))
  1693. cc.wmu.Lock()
  1694. cc.fr.WriteWindowUpdate(0, uint32(refund))
  1695. if !didReset {
  1696. cs.inflow.add(int32(refund))
  1697. cc.fr.WriteWindowUpdate(cs.ID, uint32(refund))
  1698. }
  1699. cc.bw.Flush()
  1700. cc.wmu.Unlock()
  1701. }
  1702. cc.mu.Unlock()
  1703. if len(data) > 0 && !didReset {
  1704. if _, err := cs.bufPipe.Write(data); err != nil {
  1705. rl.endStreamError(cs, err)
  1706. return err
  1707. }
  1708. }
  1709. }
  1710. if f.StreamEnded() {
  1711. rl.endStream(cs)
  1712. }
  1713. return nil
  1714. }
  1715. var errInvalidTrailers = errors.New("http2: invalid trailers")
  1716. func (rl *clientConnReadLoop) endStream(cs *clientStream) {
  1717. // TODO: check that any declared content-length matches, like
  1718. // server.go's (*stream).endStream method.
  1719. rl.endStreamError(cs, nil)
  1720. }
  1721. func (rl *clientConnReadLoop) endStreamError(cs *clientStream, err error) {
  1722. var code func()
  1723. if err == nil {
  1724. err = io.EOF
  1725. code = cs.copyTrailers
  1726. }
  1727. cs.bufPipe.closeWithErrorAndCode(err, code)
  1728. delete(rl.activeRes, cs.ID)
  1729. if isConnectionCloseRequest(cs.req) {
  1730. rl.closeWhenIdle = true
  1731. }
  1732. select {
  1733. case cs.resc <- resAndError{err: err}:
  1734. default:
  1735. }
  1736. }
  1737. func (cs *clientStream) copyTrailers() {
  1738. for k, vv := range cs.trailer {
  1739. t := cs.resTrailer
  1740. if *t == nil {
  1741. *t = make(http.Header)
  1742. }
  1743. (*t)[k] = vv
  1744. }
  1745. }
  1746. func (rl *clientConnReadLoop) processGoAway(f *GoAwayFrame) error {
  1747. cc := rl.cc
  1748. cc.t.connPool().MarkDead(cc)
  1749. if f.ErrCode != 0 {
  1750. // TODO: deal with GOAWAY more. particularly the error code
  1751. cc.vlogf("transport got GOAWAY with error code = %v", f.ErrCode)
  1752. }
  1753. cc.setGoAway(f)
  1754. return nil
  1755. }
  1756. func (rl *clientConnReadLoop) processSettings(f *SettingsFrame) error {
  1757. cc := rl.cc
  1758. cc.mu.Lock()
  1759. defer cc.mu.Unlock()
  1760. if f.IsAck() {
  1761. if cc.wantSettingsAck {
  1762. cc.wantSettingsAck = false
  1763. return nil
  1764. }
  1765. return ConnectionError(ErrCodeProtocol)
  1766. }
  1767. err := f.ForeachSetting(func(s Setting) error {
  1768. switch s.ID {
  1769. case SettingMaxFrameSize:
  1770. cc.maxFrameSize = s.Val
  1771. case SettingMaxConcurrentStreams:
  1772. cc.maxConcurrentStreams = s.Val
  1773. case SettingMaxHeaderListSize:
  1774. cc.peerMaxHeaderListSize = uint64(s.Val)
  1775. case SettingInitialWindowSize:
  1776. // Values above the maximum flow-control
  1777. // window size of 2^31-1 MUST be treated as a
  1778. // connection error (Section 5.4.1) of type
  1779. // FLOW_CONTROL_ERROR.
  1780. if s.Val > math.MaxInt32 {
  1781. return ConnectionError(ErrCodeFlowControl)
  1782. }
  1783. // Adjust flow control of currently-open
  1784. // frames by the difference of the old initial
  1785. // window size and this one.
  1786. delta := int32(s.Val) - int32(cc.initialWindowSize)
  1787. for _, cs := range cc.streams {
  1788. cs.flow.add(delta)
  1789. }
  1790. cc.cond.Broadcast()
  1791. cc.initialWindowSize = s.Val
  1792. default:
  1793. // TODO(bradfitz): handle more settings? SETTINGS_HEADER_TABLE_SIZE probably.
  1794. cc.vlogf("Unhandled Setting: %v", s)
  1795. }
  1796. return nil
  1797. })
  1798. if err != nil {
  1799. return err
  1800. }
  1801. cc.wmu.Lock()
  1802. defer cc.wmu.Unlock()
  1803. cc.fr.WriteSettingsAck()
  1804. cc.bw.Flush()
  1805. return cc.werr
  1806. }
  1807. func (rl *clientConnReadLoop) processWindowUpdate(f *WindowUpdateFrame) error {
  1808. cc := rl.cc
  1809. cs := cc.streamByID(f.StreamID, false)
  1810. if f.StreamID != 0 && cs == nil {
  1811. return nil
  1812. }
  1813. cc.mu.Lock()
  1814. defer cc.mu.Unlock()
  1815. fl := &cc.flow
  1816. if cs != nil {
  1817. fl = &cs.flow
  1818. }
  1819. if !fl.add(int32(f.Increment)) {
  1820. return ConnectionError(ErrCodeFlowControl)
  1821. }
  1822. cc.cond.Broadcast()
  1823. return nil
  1824. }
  1825. func (rl *clientConnReadLoop) processResetStream(f *RSTStreamFrame) error {
  1826. cs := rl.cc.streamByID(f.StreamID, true)
  1827. if cs == nil {
  1828. // TODO: return error if server tries to RST_STEAM an idle stream
  1829. return nil
  1830. }
  1831. select {
  1832. case <-cs.peerReset:
  1833. // Already reset.
  1834. // This is the only goroutine
  1835. // which closes this, so there
  1836. // isn't a race.
  1837. default:
  1838. err := streamError(cs.ID, f.ErrCode)
  1839. cs.resetErr = err
  1840. close(cs.peerReset)
  1841. cs.bufPipe.CloseWithError(err)
  1842. cs.cc.cond.Broadcast() // wake up checkResetOrDone via clientStream.awaitFlowControl
  1843. }
  1844. delete(rl.activeRes, cs.ID)
  1845. return nil
  1846. }
  1847. // Ping sends a PING frame to the server and waits for the ack.
  1848. // Public implementation is in go17.go and not_go17.go
  1849. func (cc *ClientConn) ping(ctx contextContext) error {
  1850. c := make(chan struct{})
  1851. // Generate a random payload
  1852. var p [8]byte
  1853. for {
  1854. if _, err := rand.Read(p[:]); err != nil {
  1855. return err
  1856. }
  1857. cc.mu.Lock()
  1858. // check for dup before insert
  1859. if _, found := cc.pings[p]; !found {
  1860. cc.pings[p] = c
  1861. cc.mu.Unlock()
  1862. break
  1863. }
  1864. cc.mu.Unlock()
  1865. }
  1866. cc.wmu.Lock()
  1867. if err := cc.fr.WritePing(false, p); err != nil {
  1868. cc.wmu.Unlock()
  1869. return err
  1870. }
  1871. if err := cc.bw.Flush(); err != nil {
  1872. cc.wmu.Unlock()
  1873. return err
  1874. }
  1875. cc.wmu.Unlock()
  1876. select {
  1877. case <-c:
  1878. return nil
  1879. case <-ctx.Done():
  1880. return ctx.Err()
  1881. case <-cc.readerDone:
  1882. // connection closed
  1883. return cc.readerErr
  1884. }
  1885. }
  1886. func (rl *clientConnReadLoop) processPing(f *PingFrame) error {
  1887. if f.IsAck() {
  1888. cc := rl.cc
  1889. cc.mu.Lock()
  1890. defer cc.mu.Unlock()
  1891. // If ack, notify listener if any
  1892. if c, ok := cc.pings[f.Data]; ok {
  1893. close(c)
  1894. delete(cc.pings, f.Data)
  1895. }
  1896. return nil
  1897. }
  1898. cc := rl.cc
  1899. cc.wmu.Lock()
  1900. defer cc.wmu.Unlock()
  1901. if err := cc.fr.WritePing(true, f.Data); err != nil {
  1902. return err
  1903. }
  1904. return cc.bw.Flush()
  1905. }
  1906. func (rl *clientConnReadLoop) processPushPromise(f *PushPromiseFrame) error {
  1907. // We told the peer we don't want them.
  1908. // Spec says:
  1909. // "PUSH_PROMISE MUST NOT be sent if the SETTINGS_ENABLE_PUSH
  1910. // setting of the peer endpoint is set to 0. An endpoint that
  1911. // has set this setting and has received acknowledgement MUST
  1912. // treat the receipt of a PUSH_PROMISE frame as a connection
  1913. // error (Section 5.4.1) of type PROTOCOL_ERROR."
  1914. return ConnectionError(ErrCodeProtocol)
  1915. }
  1916. func (cc *ClientConn) writeStreamReset(streamID uint32, code ErrCode, err error) {
  1917. // TODO: map err to more interesting error codes, once the
  1918. // HTTP community comes up with some. But currently for
  1919. // RST_STREAM there's no equivalent to GOAWAY frame's debug
  1920. // data, and the error codes are all pretty vague ("cancel").
  1921. cc.wmu.Lock()
  1922. cc.fr.WriteRSTStream(streamID, code)
  1923. cc.bw.Flush()
  1924. cc.wmu.Unlock()
  1925. }
  1926. var (
  1927. errResponseHeaderListSize = errors.New("http2: response header list larger than advertised limit")
  1928. errRequestHeaderListSize = errors.New("http2: request header list larger than peer's advertised limit")
  1929. errPseudoTrailers = errors.New("http2: invalid pseudo header in trailers")
  1930. )
  1931. func (cc *ClientConn) logf(format string, args ...interface{}) {
  1932. cc.t.logf(format, args...)
  1933. }
  1934. func (cc *ClientConn) vlogf(format string, args ...interface{}) {
  1935. cc.t.vlogf(format, args...)
  1936. }
  1937. func (t *Transport) vlogf(format string, args ...interface{}) {
  1938. if VerboseLogs {
  1939. t.logf(format, args...)
  1940. }
  1941. }
  1942. func (t *Transport) logf(format string, args ...interface{}) {
  1943. log.Printf(format, args...)
  1944. }
  1945. var noBody io.ReadCloser = ioutil.NopCloser(bytes.NewReader(nil))
  1946. func strSliceContains(ss []string, s string) bool {
  1947. for _, v := range ss {
  1948. if v == s {
  1949. return true
  1950. }
  1951. }
  1952. return false
  1953. }
  1954. type erringRoundTripper struct{ err error }
  1955. func (rt erringRoundTripper) RoundTrip(*http.Request) (*http.Response, error) { return nil, rt.err }
  1956. // gzipReader wraps a response body so it can lazily
  1957. // call gzip.NewReader on the first call to Read
  1958. type gzipReader struct {
  1959. body io.ReadCloser // underlying Response.Body
  1960. zr *gzip.Reader // lazily-initialized gzip reader
  1961. zerr error // sticky error
  1962. }
  1963. func (gz *gzipReader) Read(p []byte) (n int, err error) {
  1964. if gz.zerr != nil {
  1965. return 0, gz.zerr
  1966. }
  1967. if gz.zr == nil {
  1968. gz.zr, err = gzip.NewReader(gz.body)
  1969. if err != nil {
  1970. gz.zerr = err
  1971. return 0, err
  1972. }
  1973. }
  1974. return gz.zr.Read(p)
  1975. }
  1976. func (gz *gzipReader) Close() error {
  1977. return gz.body.Close()
  1978. }
  1979. type errorReader struct{ err error }
  1980. func (r errorReader) Read(p []byte) (int, error) { return 0, r.err }
  1981. // bodyWriterState encapsulates various state around the Transport's writing
  1982. // of the request body, particularly regarding doing delayed writes of the body
  1983. // when the request contains "Expect: 100-continue".
  1984. type bodyWriterState struct {
  1985. cs *clientStream
  1986. timer *time.Timer // if non-nil, we're doing a delayed write
  1987. fnonce *sync.Once // to call fn with
  1988. fn func() // the code to run in the goroutine, writing the body
  1989. resc chan error // result of fn's execution
  1990. delay time.Duration // how long we should delay a delayed write for
  1991. }
  1992. func (t *Transport) getBodyWriterState(cs *clientStream, body io.Reader) (s bodyWriterState) {
  1993. s.cs = cs
  1994. if body == nil {
  1995. return
  1996. }
  1997. resc := make(chan error, 1)
  1998. s.resc = resc
  1999. s.fn = func() {
  2000. cs.cc.mu.Lock()
  2001. cs.startedWrite = true
  2002. cs.cc.mu.Unlock()
  2003. resc <- cs.writeRequestBody(body, cs.req.Body)
  2004. }
  2005. s.delay = t.expectContinueTimeout()
  2006. if s.delay == 0 ||
  2007. !httplex.HeaderValuesContainsToken(
  2008. cs.req.Header["Expect"],
  2009. "100-continue") {
  2010. return
  2011. }
  2012. s.fnonce = new(sync.Once)
  2013. // Arm the timer with a very large duration, which we'll
  2014. // intentionally lower later. It has to be large now because
  2015. // we need a handle to it before writing the headers, but the
  2016. // s.delay value is defined to not start until after the
  2017. // request headers were written.
  2018. const hugeDuration = 365 * 24 * time.Hour
  2019. s.timer = time.AfterFunc(hugeDuration, func() {
  2020. s.fnonce.Do(s.fn)
  2021. })
  2022. return
  2023. }
  2024. func (s bodyWriterState) cancel() {
  2025. if s.timer != nil {
  2026. s.timer.Stop()
  2027. }
  2028. }
  2029. func (s bodyWriterState) on100() {
  2030. if s.timer == nil {
  2031. // If we didn't do a delayed write, ignore the server's
  2032. // bogus 100 continue response.
  2033. return
  2034. }
  2035. s.timer.Stop()
  2036. go func() { s.fnonce.Do(s.fn) }()
  2037. }
  2038. // scheduleBodyWrite starts writing the body, either immediately (in
  2039. // the common case) or after the delay timeout. It should not be
  2040. // called until after the headers have been written.
  2041. func (s bodyWriterState) scheduleBodyWrite() {
  2042. if s.timer == nil {
  2043. // We're not doing a delayed write (see
  2044. // getBodyWriterState), so just start the writing
  2045. // goroutine immediately.
  2046. go s.fn()
  2047. return
  2048. }
  2049. traceWait100Continue(s.cs.trace)
  2050. if s.timer.Stop() {
  2051. s.timer.Reset(s.delay)
  2052. }
  2053. }
  2054. // isConnectionCloseRequest reports whether req should use its own
  2055. // connection for a single request and then close the connection.
  2056. func isConnectionCloseRequest(req *http.Request) bool {
  2057. return req.Close || httplex.HeaderValuesContainsToken(req.Header["Connection"], "close")
  2058. }