/* * Copyright (c) 2014 DeNA Co., Ltd. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to * deal in the Software without restriction, including without limitation the * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or * sell copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS * IN THE SOFTWARE. */ #include "h2o.h" #include "h2o/http2.h" #include "h2o/http2_internal.h" static void finalostream_start_pull(h2o_ostream_t *self, h2o_ostream_pull_cb cb); static void finalostream_send(h2o_ostream_t *self, h2o_req_t *req, h2o_iovec_t *bufs, size_t bufcnt, h2o_send_state_t state); static size_t sz_min(size_t x, size_t y) { return x < y ? x : y; } h2o_http2_stream_t *h2o_http2_stream_open(h2o_http2_conn_t *conn, uint32_t stream_id, h2o_req_t *src_req, const h2o_http2_priority_t *received_priority) { h2o_http2_stream_t *stream = h2o_mem_alloc(sizeof(*stream)); /* init properties (other than req) */ memset(stream, 0, offsetof(h2o_http2_stream_t, req)); stream->stream_id = stream_id; stream->_ostr_final.do_send = finalostream_send; stream->_ostr_final.start_pull = finalostream_start_pull; stream->state = H2O_HTTP2_STREAM_STATE_IDLE; h2o_http2_window_init(&stream->output_window, &conn->peer_settings); h2o_http2_window_init(&stream->input_window, &H2O_HTTP2_SETTINGS_HOST); stream->received_priority = *received_priority; stream->_expected_content_length = SIZE_MAX; /* init request */ h2o_init_request(&stream->req, &conn->super, src_req); stream->req.version = 0x200; if (src_req != NULL) memset(&stream->req.upgrade, 0, sizeof(stream->req.upgrade)); stream->req._ostr_top = &stream->_ostr_final; h2o_http2_conn_register_stream(conn, stream); ++conn->num_streams.priority.open; stream->_num_streams_slot = &conn->num_streams.priority; return stream; } void h2o_http2_stream_close(h2o_http2_conn_t *conn, h2o_http2_stream_t *stream) { h2o_http2_conn_unregister_stream(conn, stream); if (stream->_req_body != NULL) h2o_buffer_dispose(&stream->_req_body); if (stream->cache_digests != NULL) h2o_cache_digests_destroy(stream->cache_digests); h2o_dispose_request(&stream->req); if (stream->stream_id == 1 && conn->_http1_req_input != NULL) h2o_buffer_dispose(&conn->_http1_req_input); free(stream); } void h2o_http2_stream_reset(h2o_http2_conn_t *conn, h2o_http2_stream_t *stream) { switch (stream->state) { case H2O_HTTP2_STREAM_STATE_IDLE: case H2O_HTTP2_STREAM_STATE_RECV_HEADERS: case H2O_HTTP2_STREAM_STATE_RECV_BODY: case H2O_HTTP2_STREAM_STATE_REQ_PENDING: h2o_http2_stream_close(conn, stream); break; case H2O_HTTP2_STREAM_STATE_SEND_HEADERS: case H2O_HTTP2_STREAM_STATE_SEND_BODY: case H2O_HTTP2_STREAM_STATE_SEND_BODY_IS_FINAL: h2o_http2_stream_set_state(conn, stream, H2O_HTTP2_STREAM_STATE_END_STREAM); /* continues */ case H2O_HTTP2_STREAM_STATE_END_STREAM: /* clear all the queued bufs, and close the connection in the callback */ stream->_data.size = 0; if (h2o_linklist_is_linked(&stream->_refs.link)) { /* will be closed in the callback */ } else { h2o_http2_stream_close(conn, stream); } break; } } static size_t calc_max_payload_size(h2o_http2_conn_t *conn, h2o_http2_stream_t *stream) { ssize_t conn_max, stream_max; if ((conn_max = h2o_http2_conn_get_buffer_window(conn)) <= 0) return 0; if ((stream_max = h2o_http2_window_get_window(&stream->output_window)) <= 0) return 0; return sz_min(sz_min(conn_max, stream_max), conn->peer_settings.max_frame_size); } static void commit_data_header(h2o_http2_conn_t *conn, h2o_http2_stream_t *stream, h2o_buffer_t **outbuf, size_t length, h2o_send_state_t send_state) { assert(outbuf != NULL); /* send a DATA frame if there's data or the END_STREAM flag to send */ if (length || send_state == H2O_SEND_STATE_FINAL) { h2o_http2_encode_frame_header((void *)((*outbuf)->bytes + (*outbuf)->size), length, H2O_HTTP2_FRAME_TYPE_DATA, send_state == H2O_SEND_STATE_FINAL ? H2O_HTTP2_FRAME_FLAG_END_STREAM : 0, stream->stream_id); h2o_http2_window_consume_window(&conn->_write.window, length); h2o_http2_window_consume_window(&stream->output_window, length); (*outbuf)->size += length + H2O_HTTP2_FRAME_HEADER_SIZE; stream->req.bytes_sent += length; } /* send a RST_STREAM if there's an error */ if (send_state == H2O_SEND_STATE_ERROR) { h2o_http2_encode_rst_stream_frame(outbuf, stream->stream_id, -H2O_HTTP2_ERROR_PROTOCOL); } } static h2o_send_state_t send_data_pull(h2o_http2_conn_t *conn, h2o_http2_stream_t *stream) { size_t max_payload_size; h2o_iovec_t cbuf; h2o_send_state_t send_state = H2O_SEND_STATE_IN_PROGRESS; if ((max_payload_size = calc_max_payload_size(conn, stream)) == 0) goto Exit; /* reserve buffer */ h2o_buffer_reserve(&conn->_write.buf, H2O_HTTP2_FRAME_HEADER_SIZE + max_payload_size); /* obtain content */ cbuf.base = conn->_write.buf->bytes + conn->_write.buf->size + H2O_HTTP2_FRAME_HEADER_SIZE; cbuf.len = max_payload_size; send_state = h2o_pull(&stream->req, stream->_pull_cb, &cbuf); /* write the header */ commit_data_header(conn, stream, &conn->_write.buf, cbuf.len, send_state); Exit: return send_state; } static h2o_iovec_t *send_data_push(h2o_http2_conn_t *conn, h2o_http2_stream_t *stream, h2o_iovec_t *bufs, size_t bufcnt, h2o_send_state_t send_state) { h2o_iovec_t dst; size_t max_payload_size; if ((max_payload_size = calc_max_payload_size(conn, stream)) == 0) goto Exit; /* reserve buffer and point dst to the payload */ dst.base = h2o_buffer_reserve(&conn->_write.buf, H2O_HTTP2_FRAME_HEADER_SIZE + max_payload_size).base + H2O_HTTP2_FRAME_HEADER_SIZE; dst.len = max_payload_size; /* emit data */ while (bufcnt != 0) { if (bufs->len != 0) break; ++bufs; --bufcnt; } while (bufcnt != 0) { size_t fill_size = sz_min(dst.len, bufs->len); memcpy(dst.base, bufs->base, fill_size); dst.base += fill_size; dst.len -= fill_size; bufs->base += fill_size; bufs->len -= fill_size; while (bufs->len == 0) { ++bufs; --bufcnt; if (bufcnt == 0) break; } if (dst.len == 0) break; } /* commit the DATA frame if we have actually emitted payload */ if (dst.len != max_payload_size || !h2o_send_state_is_in_progress(send_state)) { size_t payload_len = max_payload_size - dst.len; if (bufcnt != 0) { send_state = H2O_SEND_STATE_IN_PROGRESS; } commit_data_header(conn, stream, &conn->_write.buf, payload_len, send_state); } Exit: return bufs; } static int is_blocking_asset(h2o_req_t *req) { if (req->res.mime_attr == NULL) h2o_req_fill_mime_attributes(req); return req->res.mime_attr->priority == H2O_MIME_ATTRIBUTE_PRIORITY_HIGHEST; } static int send_headers(h2o_http2_conn_t *conn, h2o_http2_stream_t *stream) { h2o_timestamp_t ts; h2o_get_timestamp(conn->super.ctx, &stream->req.pool, &ts); /* cancel push with an error response */ if (h2o_http2_stream_is_push(stream->stream_id)) { if (400 <= stream->req.res.status) goto CancelPush; if (stream->cache_digests != NULL) { ssize_t etag_index = h2o_find_header(&stream->req.headers, H2O_TOKEN_ETAG, -1); if (etag_index != -1) { h2o_iovec_t url = h2o_concat(&stream->req.pool, stream->req.input.scheme->name, h2o_iovec_init(H2O_STRLIT("://")), stream->req.input.authority, stream->req.input.path); h2o_iovec_t *etag = &stream->req.headers.entries[etag_index].value; if (h2o_cache_digests_lookup_by_url_and_etag(stream->cache_digests, url.base, url.len, etag->base, etag->len) == H2O_CACHE_DIGESTS_STATE_FRESH) goto CancelPush; } } } /* reset casper cookie in case cache-digests exist */ if (stream->cache_digests != NULL && stream->req.hostconf->http2.casper.capacity_bits != 0) { h2o_add_header(&stream->req.pool, &stream->req.res.headers, H2O_TOKEN_SET_COOKIE, NULL, H2O_STRLIT("h2o_casper=; Path=/; Expires=Sat, 01 Jan 2000 00:00:00 GMT")); } /* CASPER */ if (conn->casper != NULL) { /* update casper if necessary */ if (stream->req.hostconf->http2.casper.track_all_types || is_blocking_asset(&stream->req)) { if (h2o_http2_casper_lookup(conn->casper, stream->req.path.base, stream->req.path.len, 1)) { /* cancel if the pushed resource is already marked as cached */ if (h2o_http2_stream_is_push(stream->stream_id)) goto CancelPush; } } if (stream->cache_digests != NULL) goto SkipCookie; /* browsers might ignore push responses, or they may process the responses in a different order than they were pushed. * Therefore H2O tries to include casper cookie only in the last stream that may be received by the client, or when the * value become stable; see also: https://github.com/h2o/h2o/issues/421 */ if (h2o_http2_stream_is_push(stream->stream_id)) { if (!(conn->num_streams.pull.open == 0 && (conn->num_streams.push.half_closed - conn->num_streams.push.send_body) == 1)) goto SkipCookie; } else { if (conn->num_streams.push.half_closed - conn->num_streams.push.send_body != 0) goto SkipCookie; } h2o_iovec_t cookie = h2o_http2_casper_get_cookie(conn->casper); h2o_add_header(&stream->req.pool, &stream->req.res.headers, H2O_TOKEN_SET_COOKIE, NULL, cookie.base, cookie.len); SkipCookie:; } if (h2o_http2_stream_is_push(stream->stream_id)) { /* for push, send the push promise */ if (!stream->push.promise_sent) h2o_http2_stream_send_push_promise(conn, stream); /* send ASAP if it is a blocking asset (even in case of Firefox we can't wait 1RTT for it to reprioritize the asset) */ if (is_blocking_asset(&stream->req)) h2o_http2_scheduler_rebind(&stream->_refs.scheduler, &conn->scheduler, 257, 0); } else { /* raise the priority of asset files that block rendering to highest if the user-agent is _not_ using dependency-based * prioritization (e.g. that of Firefox) */ if (conn->num_streams.priority.open == 0 && stream->req.hostconf->http2.reprioritize_blocking_assets && h2o_http2_scheduler_get_parent(&stream->_refs.scheduler) == &conn->scheduler && is_blocking_asset(&stream->req)) h2o_http2_scheduler_rebind(&stream->_refs.scheduler, &conn->scheduler, 257, 0); } /* send HEADERS, as well as start sending body */ if (h2o_http2_stream_is_push(stream->stream_id)) h2o_add_header_by_str(&stream->req.pool, &stream->req.res.headers, H2O_STRLIT("x-http2-push"), 0, NULL, H2O_STRLIT("pushed")); h2o_hpack_flatten_response(&conn->_write.buf, &conn->_output_header_table, stream->stream_id, conn->peer_settings.max_frame_size, &stream->req.res, &ts, &conn->super.ctx->globalconf->server_name, stream->req.res.content_length); h2o_http2_conn_request_write(conn); h2o_http2_stream_set_state(conn, stream, H2O_HTTP2_STREAM_STATE_SEND_BODY); return 0; CancelPush: h2o_add_header_by_str(&stream->req.pool, &stream->req.res.headers, H2O_STRLIT("x-http2-push"), 0, NULL, H2O_STRLIT("cancelled")); h2o_http2_stream_set_state(conn, stream, H2O_HTTP2_STREAM_STATE_END_STREAM); h2o_linklist_insert(&conn->_write.streams_to_proceed, &stream->_refs.link); if (stream->push.promise_sent) { h2o_http2_encode_rst_stream_frame(&conn->_write.buf, stream->stream_id, -H2O_HTTP2_ERROR_INTERNAL); h2o_http2_conn_request_write(conn); } return -1; } void finalostream_start_pull(h2o_ostream_t *self, h2o_ostream_pull_cb cb) { h2o_http2_stream_t *stream = H2O_STRUCT_FROM_MEMBER(h2o_http2_stream_t, _ostr_final, self); h2o_http2_conn_t *conn = (void *)stream->req.conn; assert(stream->req._ostr_top == &stream->_ostr_final); assert(stream->state == H2O_HTTP2_STREAM_STATE_SEND_HEADERS); /* register the pull callback */ stream->_pull_cb = cb; /* send headers */ if (send_headers(conn, stream) != 0) return; /* set dummy data in the send buffer */ h2o_vector_reserve(&stream->req.pool, &stream->_data, 1); stream->_data.entries[0].base = ""; stream->_data.entries[0].len = 1; stream->_data.size = 1; h2o_http2_conn_register_for_proceed_callback(conn, stream); } void finalostream_send(h2o_ostream_t *self, h2o_req_t *req, h2o_iovec_t *bufs, size_t bufcnt, h2o_send_state_t state) { h2o_http2_stream_t *stream = H2O_STRUCT_FROM_MEMBER(h2o_http2_stream_t, _ostr_final, self); h2o_http2_conn_t *conn = (h2o_http2_conn_t *)req->conn; assert(stream->_data.size == 0); stream->send_state = state; /* send headers */ switch (stream->state) { case H2O_HTTP2_STREAM_STATE_SEND_HEADERS: if (send_headers(conn, stream) != 0) return; /* fallthru */ case H2O_HTTP2_STREAM_STATE_SEND_BODY: if (state != H2O_SEND_STATE_IN_PROGRESS) { h2o_http2_stream_set_state(conn, stream, H2O_HTTP2_STREAM_STATE_SEND_BODY_IS_FINAL); } break; case H2O_HTTP2_STREAM_STATE_END_STREAM: /* might get set by h2o_http2_stream_reset */ return; default: assert(!"cannot be in a receiving state"); } /* save the contents in queue */ if (bufcnt != 0) { h2o_vector_reserve(&req->pool, &stream->_data, bufcnt); memcpy(stream->_data.entries, bufs, sizeof(h2o_iovec_t) * bufcnt); stream->_data.size = bufcnt; } h2o_http2_conn_register_for_proceed_callback(conn, stream); } void h2o_http2_stream_send_pending_data(h2o_http2_conn_t *conn, h2o_http2_stream_t *stream) { if (h2o_http2_window_get_window(&stream->output_window) <= 0) return; if (stream->_pull_cb != NULL) { h2o_send_state_t send_state; /* pull mode */ assert(stream->state != H2O_HTTP2_STREAM_STATE_END_STREAM); send_state = send_data_pull(conn, stream); if (send_state != H2O_SEND_STATE_IN_PROGRESS) { /* sent all data */ stream->_data.size = 0; h2o_http2_stream_set_state(conn, stream, H2O_HTTP2_STREAM_STATE_END_STREAM); } } else { /* push mode */ h2o_iovec_t *nextbuf = send_data_push(conn, stream, stream->_data.entries, stream->_data.size, stream->send_state); if (nextbuf == stream->_data.entries + stream->_data.size) { /* sent all data */ stream->_data.size = 0; if (stream->state == H2O_HTTP2_STREAM_STATE_SEND_BODY_IS_FINAL) h2o_http2_stream_set_state(conn, stream, H2O_HTTP2_STREAM_STATE_END_STREAM); } else if (nextbuf != stream->_data.entries) { /* adjust the buffer */ size_t newsize = stream->_data.size - (nextbuf - stream->_data.entries); memmove(stream->_data.entries, nextbuf, sizeof(h2o_iovec_t) * newsize); stream->_data.size = newsize; } } } void h2o_http2_stream_proceed(h2o_http2_conn_t *conn, h2o_http2_stream_t *stream) { if (stream->state == H2O_HTTP2_STREAM_STATE_END_STREAM) { h2o_http2_stream_close(conn, stream); } else { h2o_proceed_response(&stream->req); } }