blob: 7e2e75f97d2f739f0e0925cdf477a1326fbfb81d [file] [log] [blame]
Craig Tiller640d3bd2015-06-12 07:51:51 -07001/*
2 *
3 * Copyright 2015, Google Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following disclaimer
14 * in the documentation and/or other materials provided with the
15 * distribution.
16 * * Neither the name of Google Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
33
Craig Tiller9b8671c2015-06-12 07:41:54 -070034#ifndef GRPC_INTERNAL_CORE_CHTTP2_INTERNAL_H
35#define GRPC_INTERNAL_CORE_CHTTP2_INTERNAL_H
36
Craig Tiller3208e392015-06-12 08:17:02 -070037#include "src/core/iomgr/endpoint.h"
Craig Tillerd20efd22015-06-12 16:17:09 -070038#include "src/core/transport/chttp2/frame.h"
Craig Tiller3208e392015-06-12 08:17:02 -070039#include "src/core/transport/chttp2/frame_data.h"
40#include "src/core/transport/chttp2/frame_goaway.h"
41#include "src/core/transport/chttp2/frame_ping.h"
42#include "src/core/transport/chttp2/frame_rst_stream.h"
43#include "src/core/transport/chttp2/frame_settings.h"
44#include "src/core/transport/chttp2/frame_window_update.h"
Craig Tiller3208e392015-06-12 08:17:02 -070045#include "src/core/transport/chttp2/hpack_parser.h"
Craig Tiller5dc3b302015-06-15 16:06:50 -070046#include "src/core/transport/chttp2/incoming_metadata.h"
Craig Tiller3208e392015-06-12 08:17:02 -070047#include "src/core/transport/chttp2/stream_encoder.h"
Craig Tiller5dc3b302015-06-15 16:06:50 -070048#include "src/core/transport/chttp2/stream_map.h"
Craig Tiller08a1cf82015-06-29 09:37:52 -070049#include "src/core/transport/connectivity_state.h"
50#include "src/core/transport/transport_impl.h"
Craig Tiller9b8671c2015-06-12 07:41:54 -070051
Craig Tillerb084d902015-06-12 07:50:02 -070052typedef struct grpc_chttp2_transport grpc_chttp2_transport;
53typedef struct grpc_chttp2_stream grpc_chttp2_stream;
Craig Tiller9b8671c2015-06-12 07:41:54 -070054
55/* streams are kept in various linked lists depending on what things need to
56 happen to them... this enum labels each list */
57typedef enum {
Craig Tiller5dc3b302015-06-15 16:06:50 -070058 GRPC_CHTTP2_LIST_ALL_STREAMS,
Craig Tiller6459db42015-06-15 17:11:45 -070059 GRPC_CHTTP2_LIST_READ_WRITE_STATE_CHANGED,
Craig Tiller5dc3b302015-06-15 16:06:50 -070060 GRPC_CHTTP2_LIST_WRITABLE,
Craig Tiller6459db42015-06-15 17:11:45 -070061 GRPC_CHTTP2_LIST_WRITING,
62 GRPC_CHTTP2_LIST_WRITTEN,
63 GRPC_CHTTP2_LIST_WRITABLE_WINDOW_UPDATE,
64 GRPC_CHTTP2_LIST_PARSING_SEEN,
Craig Tiller83fb0702015-06-16 21:13:07 -070065 GRPC_CHTTP2_LIST_CLOSED_WAITING_FOR_PARSING,
Craig Tillercf1e3192015-06-16 14:28:22 -070066 GRPC_CHTTP2_LIST_INCOMING_WINDOW_UPDATED,
Craig Tiller5dc3b302015-06-15 16:06:50 -070067 /** streams that are waiting to start because there are too many concurrent
68 streams on the connection */
69 GRPC_CHTTP2_LIST_WAITING_FOR_CONCURRENCY,
Craig Tiller9b8671c2015-06-12 07:41:54 -070070 STREAM_LIST_COUNT /* must be last */
Craig Tillerb084d902015-06-12 07:50:02 -070071} grpc_chttp2_stream_list_id;
Craig Tiller9b8671c2015-06-12 07:41:54 -070072
73/* deframer state for the overall http2 stream of bytes */
74typedef enum {
75 /* prefix: one entry per http2 connection prefix byte */
Craig Tillerab630732015-06-25 11:20:01 -070076 GRPC_DTS_CLIENT_PREFIX_0 = 0,
77 GRPC_DTS_CLIENT_PREFIX_1,
78 GRPC_DTS_CLIENT_PREFIX_2,
79 GRPC_DTS_CLIENT_PREFIX_3,
80 GRPC_DTS_CLIENT_PREFIX_4,
81 GRPC_DTS_CLIENT_PREFIX_5,
82 GRPC_DTS_CLIENT_PREFIX_6,
83 GRPC_DTS_CLIENT_PREFIX_7,
84 GRPC_DTS_CLIENT_PREFIX_8,
85 GRPC_DTS_CLIENT_PREFIX_9,
86 GRPC_DTS_CLIENT_PREFIX_10,
87 GRPC_DTS_CLIENT_PREFIX_11,
88 GRPC_DTS_CLIENT_PREFIX_12,
89 GRPC_DTS_CLIENT_PREFIX_13,
90 GRPC_DTS_CLIENT_PREFIX_14,
91 GRPC_DTS_CLIENT_PREFIX_15,
92 GRPC_DTS_CLIENT_PREFIX_16,
93 GRPC_DTS_CLIENT_PREFIX_17,
94 GRPC_DTS_CLIENT_PREFIX_18,
95 GRPC_DTS_CLIENT_PREFIX_19,
96 GRPC_DTS_CLIENT_PREFIX_20,
97 GRPC_DTS_CLIENT_PREFIX_21,
98 GRPC_DTS_CLIENT_PREFIX_22,
99 GRPC_DTS_CLIENT_PREFIX_23,
Craig Tiller9b8671c2015-06-12 07:41:54 -0700100 /* frame header byte 0... */
101 /* must follow from the prefix states */
Craig Tillerab630732015-06-25 11:20:01 -0700102 GRPC_DTS_FH_0,
103 GRPC_DTS_FH_1,
104 GRPC_DTS_FH_2,
105 GRPC_DTS_FH_3,
106 GRPC_DTS_FH_4,
107 GRPC_DTS_FH_5,
108 GRPC_DTS_FH_6,
109 GRPC_DTS_FH_7,
Craig Tiller9b8671c2015-06-12 07:41:54 -0700110 /* ... frame header byte 8 */
Craig Tillerab630732015-06-25 11:20:01 -0700111 GRPC_DTS_FH_8,
Craig Tiller9b8671c2015-06-12 07:41:54 -0700112 /* inside a http2 frame */
Craig Tillerab630732015-06-25 11:20:01 -0700113 GRPC_DTS_FRAME
Craig Tillerb084d902015-06-12 07:50:02 -0700114} grpc_chttp2_deframe_transport_state;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700115
116typedef enum {
Craig Tillerab630732015-06-25 11:20:01 -0700117 GRPC_WRITE_STATE_OPEN,
118 GRPC_WRITE_STATE_QUEUED_CLOSE,
119 GRPC_WRITE_STATE_SENT_CLOSE
Craig Tillerb084d902015-06-12 07:50:02 -0700120} grpc_chttp2_write_state;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700121
122typedef enum {
Craig Tillerab630732015-06-25 11:20:01 -0700123 GRPC_DONT_SEND_CLOSED = 0,
124 GRPC_SEND_CLOSED,
125 GRPC_SEND_CLOSED_WITH_RST_STREAM
Craig Tillerb084d902015-06-12 07:50:02 -0700126} grpc_chttp2_send_closed;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700127
128typedef struct {
Craig Tillerb084d902015-06-12 07:50:02 -0700129 grpc_chttp2_stream *head;
130 grpc_chttp2_stream *tail;
131} grpc_chttp2_stream_list;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700132
133typedef struct {
Craig Tillerb084d902015-06-12 07:50:02 -0700134 grpc_chttp2_stream *next;
135 grpc_chttp2_stream *prev;
136} grpc_chttp2_stream_link;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700137
Craig Tiller9b8671c2015-06-12 07:41:54 -0700138/* We keep several sets of connection wide parameters */
139typedef enum {
140 /* The settings our peer has asked for (and we have acked) */
Craig Tillerab630732015-06-25 11:20:01 -0700141 GRPC_PEER_SETTINGS = 0,
Craig Tiller9b8671c2015-06-12 07:41:54 -0700142 /* The settings we'd like to have */
Craig Tillerab630732015-06-25 11:20:01 -0700143 GRPC_LOCAL_SETTINGS,
Craig Tiller9b8671c2015-06-12 07:41:54 -0700144 /* The settings we've published to our peer */
Craig Tillerab630732015-06-25 11:20:01 -0700145 GRPC_SENT_SETTINGS,
Craig Tiller9b8671c2015-06-12 07:41:54 -0700146 /* The settings the peer has acked */
Craig Tillerab630732015-06-25 11:20:01 -0700147 GRPC_ACKED_SETTINGS,
148 GRPC_NUM_SETTING_SETS
Craig Tillerb084d902015-06-12 07:50:02 -0700149} grpc_chttp2_setting_set;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700150
151/* Outstanding ping request data */
Craig Tiller3719f072015-06-12 17:19:51 -0700152typedef struct grpc_chttp2_outstanding_ping {
Craig Tiller9b8671c2015-06-12 07:41:54 -0700153 gpr_uint8 id[8];
Craig Tiller3719f072015-06-12 17:19:51 -0700154 grpc_iomgr_closure *on_recv;
155 struct grpc_chttp2_outstanding_ping *next;
156 struct grpc_chttp2_outstanding_ping *prev;
Craig Tillerb084d902015-06-12 07:50:02 -0700157} grpc_chttp2_outstanding_ping;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700158
159typedef struct {
Craig Tillerd20efd22015-06-12 16:17:09 -0700160 /** data to write next write */
161 gpr_slice_buffer qbuf;
162 /** queued callbacks */
163 grpc_iomgr_closure *pending_closures;
164
165 /** window available for us to send to peer */
166 gpr_uint32 outgoing_window;
Craig Tiller3719f072015-06-12 17:19:51 -0700167 /** window available for peer to send to us - updated after parse */
168 gpr_uint32 incoming_window;
Craig Tillerd20efd22015-06-12 16:17:09 -0700169 /** how much window would we like to have for incoming_window */
170 gpr_uint32 connection_window_target;
171
Craig Tiller1064f8b2015-06-25 13:52:57 -0700172 /** have we seen a goaway */
173 gpr_uint8 seen_goaway;
174
Craig Tiller3719f072015-06-12 17:19:51 -0700175 /** is this transport a client? */
176 gpr_uint8 is_client;
Craig Tillerd20efd22015-06-12 16:17:09 -0700177 /** are the local settings dirty and need to be sent? */
178 gpr_uint8 dirtied_local_settings;
179 /** have local settings been sent? */
180 gpr_uint8 sent_local_settings;
181 /** bitmask of setting indexes to send out */
Craig Tiller4aa71a12015-06-15 13:00:55 -0700182 gpr_uint32 force_send_settings;
Craig Tillerd20efd22015-06-12 16:17:09 -0700183 /** settings values */
Craig Tillerab630732015-06-25 11:20:01 -0700184 gpr_uint32 settings[GRPC_NUM_SETTING_SETS][GRPC_CHTTP2_NUM_SETTINGS];
Craig Tillerd20efd22015-06-12 16:17:09 -0700185
Craig Tiller606d8742015-06-15 06:58:50 -0700186 /** what is the next stream id to be allocated by this peer?
187 copied to next_stream_id in parsing when parsing commences */
188 gpr_uint32 next_stream_id;
189
Craig Tillerd20efd22015-06-12 16:17:09 -0700190 /** last received stream id */
191 gpr_uint32 last_incoming_stream_id;
Craig Tiller3719f072015-06-12 17:19:51 -0700192
193 /** pings awaiting responses */
194 grpc_chttp2_outstanding_ping pings;
Craig Tiller606d8742015-06-15 06:58:50 -0700195 /** next payload for an outgoing ping */
196 gpr_uint64 ping_counter;
197
198 /** concurrent stream count: updated when not parsing,
199 so this is a strict over-estimation on the client */
200 gpr_uint32 concurrent_stream_count;
Craig Tillerd20efd22015-06-12 16:17:09 -0700201} grpc_chttp2_transport_global;
202
203typedef struct {
204 /** data to write now */
205 gpr_slice_buffer outbuf;
206 /** hpack encoding */
207 grpc_chttp2_hpack_compressor hpack_compressor;
Craig Tiller285b8822015-06-17 15:58:13 -0700208 /** is this a client? */
209 gpr_uint8 is_client;
Craig Tillerd20efd22015-06-12 16:17:09 -0700210} grpc_chttp2_transport_writing;
211
212struct grpc_chttp2_transport_parsing {
213 /** is this transport a client? (boolean) */
214 gpr_uint8 is_client;
215
216 /** were settings updated? */
217 gpr_uint8 settings_updated;
218 /** was a settings ack received? */
219 gpr_uint8 settings_ack_received;
220 /** was a goaway frame received? */
221 gpr_uint8 goaway_received;
222
Craig Tiller3719f072015-06-12 17:19:51 -0700223 /** initial window change */
224 gpr_int64 initial_window_update;
225
Craig Tillerd20efd22015-06-12 16:17:09 -0700226 /** data to write later - after parsing */
227 gpr_slice_buffer qbuf;
228 /* metadata object cache */
229 grpc_mdstr *str_grpc_timeout;
230 /** parser for headers */
231 grpc_chttp2_hpack_parser hpack_parser;
232 /** simple one shot parsers */
233 union {
234 grpc_chttp2_window_update_parser window_update;
235 grpc_chttp2_settings_parser settings;
236 grpc_chttp2_ping_parser ping;
237 grpc_chttp2_rst_stream_parser rst_stream;
238 } simple;
239 /** parser for goaway frames */
240 grpc_chttp2_goaway_parser goaway_parser;
241
242 /** window available for peer to send to us */
243 gpr_uint32 incoming_window;
Craig Tiller285b8822015-06-17 15:58:13 -0700244 gpr_uint32 incoming_window_delta;
Craig Tillerd20efd22015-06-12 16:17:09 -0700245
246 /** next stream id available at the time of beginning parsing */
247 gpr_uint32 next_stream_id;
248 gpr_uint32 last_incoming_stream_id;
249
250 /* deframing */
251 grpc_chttp2_deframe_transport_state deframe_state;
252 gpr_uint8 incoming_frame_type;
253 gpr_uint8 incoming_frame_flags;
254 gpr_uint8 header_eof;
255 gpr_uint32 expect_continuation_stream_id;
256 gpr_uint32 incoming_frame_size;
257 gpr_uint32 incoming_stream_id;
258
259 /* active parser */
260 void *parser_data;
261 grpc_chttp2_stream_parsing *incoming_stream;
Craig Tiller4aa71a12015-06-15 13:00:55 -0700262 grpc_chttp2_parse_error (*parser)(
263 void *parser_user_data, grpc_chttp2_transport_parsing *transport_parsing,
264 grpc_chttp2_stream_parsing *stream_parsing, gpr_slice slice, int is_last);
Craig Tillerd20efd22015-06-12 16:17:09 -0700265
266 /* received settings */
267 gpr_uint32 settings[GRPC_CHTTP2_NUM_SETTINGS];
268
269 /* goaway data */
270 grpc_status_code goaway_error;
271 gpr_uint32 goaway_last_stream_index;
272 gpr_slice goaway_text;
Craig Tiller3719f072015-06-12 17:19:51 -0700273
274 gpr_uint64 outgoing_window_update;
275
276 /** pings awaiting responses */
277 grpc_chttp2_outstanding_ping pings;
Craig Tillerd20efd22015-06-12 16:17:09 -0700278};
279
Craig Tillerb084d902015-06-12 07:50:02 -0700280struct grpc_chttp2_transport {
Craig Tiller9b8671c2015-06-12 07:41:54 -0700281 grpc_transport base; /* must be first */
282 grpc_endpoint *ep;
283 grpc_mdctx *metadata_context;
284 gpr_refcount refs;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700285
286 gpr_mu mu;
Craig Tiller606d8742015-06-15 06:58:50 -0700287
288 /** is the transport destroying itself? */
289 gpr_uint8 destroying;
290 /** has the upper layer closed the transport? */
291 gpr_uint8 closed;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700292
Craig Tillerd20efd22015-06-12 16:17:09 -0700293 /** is a thread currently writing */
294 gpr_uint8 writing_active;
Craig Tiller606d8742015-06-15 06:58:50 -0700295 /** is a thread currently parsing */
296 gpr_uint8 parsing_active;
Craig Tillerd20efd22015-06-12 16:17:09 -0700297
Craig Tiller606d8742015-06-15 06:58:50 -0700298 /** is there a read request to the endpoint outstanding? */
299 gpr_uint8 endpoint_reading;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700300
Craig Tiller606d8742015-06-15 06:58:50 -0700301 /** various lists of streams */
Craig Tillerb084d902015-06-12 07:50:02 -0700302 grpc_chttp2_stream_list lists[STREAM_LIST_COUNT];
Craig Tiller9b8671c2015-06-12 07:41:54 -0700303
Craig Tiller606d8742015-06-15 06:58:50 -0700304 /** global state for reading/writing */
Craig Tillerd20efd22015-06-12 16:17:09 -0700305 grpc_chttp2_transport_global global;
Craig Tiller606d8742015-06-15 06:58:50 -0700306 /** state only accessible by the chain of execution that
307 set writing_active=1 */
Craig Tillerd20efd22015-06-12 16:17:09 -0700308 grpc_chttp2_transport_writing writing;
Craig Tiller606d8742015-06-15 06:58:50 -0700309 /** state only accessible by the chain of execution that
310 set parsing_active=1 */
Craig Tillerd20efd22015-06-12 16:17:09 -0700311 grpc_chttp2_transport_parsing parsing;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700312
Craig Tiller606d8742015-06-15 06:58:50 -0700313 /** maps stream id to grpc_chttp2_stream objects;
314 owned by the parsing thread when parsing */
315 grpc_chttp2_stream_map parsing_stream_map;
316
317 /** streams created by the client (possibly during parsing);
318 merged with parsing_stream_map during unlock when no
319 parsing is occurring */
320 grpc_chttp2_stream_map new_stream_map;
321
Craig Tillerd20efd22015-06-12 16:17:09 -0700322 /** closure to execute writing */
323 grpc_iomgr_closure writing_action;
Craig Tiller8b2f1d72015-06-18 13:38:38 -0700324 /** closure to start reading from the endpoint */
325 grpc_iomgr_closure reading_action;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700326
Craig Tiller4aa71a12015-06-15 13:00:55 -0700327 /** address to place a newly accepted stream - set and unset by
Craig Tiller606d8742015-06-15 06:58:50 -0700328 grpc_chttp2_parsing_accept_stream; used by init_stream to
329 publish the accepted server stream */
330 grpc_chttp2_stream **accepting_stream;
331
Craig Tiller9b8671c2015-06-12 07:41:54 -0700332 struct {
Craig Tiller1064f8b2015-06-25 13:52:57 -0700333 /* accept stream callback */
334 void (*accept_stream)(void *user_data, grpc_transport *transport,
335 const void *server_data);
336 void *accept_stream_user_data;
337
338 /** connectivity tracking */
Craig Tiller08a1cf82015-06-29 09:37:52 -0700339 grpc_connectivity_state_tracker state_tracker;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700340 } channel_callback;
341};
342
Craig Tillerd20efd22015-06-12 16:17:09 -0700343typedef struct {
344 /** HTTP2 stream id for this stream, or zero if one has not been assigned */
Craig Tiller9b8671c2015-06-12 07:41:54 -0700345 gpr_uint32 id;
346
Craig Tillerd20efd22015-06-12 16:17:09 -0700347 grpc_iomgr_closure *send_done_closure;
348 grpc_iomgr_closure *recv_done_closure;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700349
Craig Tillerd20efd22015-06-12 16:17:09 -0700350 /** window available for us to send to peer */
351 gpr_int64 outgoing_window;
Craig Tiller3719f072015-06-12 17:19:51 -0700352 /** window available for peer to send to us - updated after parse */
353 gpr_uint32 incoming_window;
Craig Tillerd20efd22015-06-12 16:17:09 -0700354 /** stream ops the transport user would like to send */
355 grpc_stream_op_buffer *outgoing_sopb;
356 /** when the application requests writes be closed, the write_closed is
357 'queued'; when the close is flow controlled into the send path, we are
358 'sending' it; when the write has been performed it is 'sent' */
359 grpc_chttp2_write_state write_state;
360 /** is this stream closed (boolean) */
361 gpr_uint8 read_closed;
Craig Tiller5dc3b302015-06-15 16:06:50 -0700362 /** has this stream been cancelled? (boolean) */
363 gpr_uint8 cancelled;
Craig Tillercec9eb92015-06-17 17:16:48 -0700364 grpc_status_code cancelled_status;
365 /** have we told the upper layer that this stream is cancelled? */
366 gpr_uint8 published_cancelled;
Craig Tiller5dc3b302015-06-15 16:06:50 -0700367 /** is this stream in the stream map? (boolean) */
368 gpr_uint8 in_stream_map;
Craig Tiller606d8742015-06-15 06:58:50 -0700369
370 /** stream state already published to the upper layer */
371 grpc_stream_state published_state;
372 /** address to publish next stream state to */
373 grpc_stream_state *publish_state;
374 /** pointer to sop buffer to fill in with new stream ops */
Craig Tiller6905b7c2015-06-16 15:33:33 -0700375 grpc_stream_op_buffer *publish_sopb;
376 grpc_stream_op_buffer incoming_sopb;
Craig Tiller5dc3b302015-06-15 16:06:50 -0700377
378 /** incoming metadata */
379 grpc_chttp2_incoming_metadata_buffer incoming_metadata;
Craig Tillerb787c502015-06-15 16:14:52 -0700380 grpc_chttp2_incoming_metadata_live_op_buffer outstanding_metadata;
Craig Tillerd20efd22015-06-12 16:17:09 -0700381} grpc_chttp2_stream_global;
382
383typedef struct {
384 /** HTTP2 stream id for this stream, or zero if one has not been assigned */
385 gpr_uint32 id;
386 /** sops that have passed flow control to be written */
387 grpc_stream_op_buffer sopb;
388 /** how strongly should we indicate closure with the next write */
389 grpc_chttp2_send_closed send_closed;
390} grpc_chttp2_stream_writing;
391
392struct grpc_chttp2_stream_parsing {
393 /** HTTP2 stream id for this stream, or zero if one has not been assigned */
394 gpr_uint32 id;
395 /** has this stream received a close */
396 gpr_uint8 received_close;
Craig Tiller3719f072015-06-12 17:19:51 -0700397 /** saw a rst_stream */
398 gpr_uint8 saw_rst_stream;
Craig Tiller606d8742015-06-15 06:58:50 -0700399 /** incoming_window has been reduced by this much during parsing */
400 gpr_uint32 incoming_window_delta;
Craig Tillerd20efd22015-06-12 16:17:09 -0700401 /** window available for peer to send to us */
402 gpr_uint32 incoming_window;
403 /** parsing state for data frames */
404 grpc_chttp2_data_parser data_parser;
Craig Tiller3719f072015-06-12 17:19:51 -0700405 /** reason give to rst_stream */
406 gpr_uint32 rst_stream_reason;
407 /* amount of window given */
408 gpr_uint64 outgoing_window_update;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700409
Craig Tiller5dc3b302015-06-15 16:06:50 -0700410 /** incoming metadata */
411 grpc_chttp2_incoming_metadata_buffer incoming_metadata;
Craig Tillerd20efd22015-06-12 16:17:09 -0700412};
413
414struct grpc_chttp2_stream {
415 grpc_chttp2_stream_global global;
416 grpc_chttp2_stream_writing writing;
Craig Tiller606d8742015-06-15 06:58:50 -0700417 grpc_chttp2_stream_parsing parsing;
Craig Tillerd20efd22015-06-12 16:17:09 -0700418
419 grpc_chttp2_stream_link links[STREAM_LIST_COUNT];
420 gpr_uint8 included[STREAM_LIST_COUNT];
Craig Tiller9b8671c2015-06-12 07:41:54 -0700421};
422
Craig Tillerd20efd22015-06-12 16:17:09 -0700423/** Transport writing call flow:
Craig Tiller4aa71a12015-06-15 13:00:55 -0700424 chttp2_transport.c calls grpc_chttp2_unlocking_check_writes to see if writes
425 are required;
426 if they are, chttp2_transport.c calls grpc_chttp2_perform_writes to do the
427 writes.
428 Once writes have been completed (meaning another write could potentially be
429 started),
430 grpc_chttp2_terminate_writing is called. This will call
431 grpc_chttp2_cleanup_writing, at which
Craig Tillerd20efd22015-06-12 16:17:09 -0700432 point the write phase is complete. */
433
Craig Tiller3208e392015-06-12 08:17:02 -0700434/** Someone is unlocking the transport mutex: check to see if writes
435 are required, and schedule them if so */
Craig Tiller4aa71a12015-06-15 13:00:55 -0700436int grpc_chttp2_unlocking_check_writes(grpc_chttp2_transport_global *global,
437 grpc_chttp2_transport_writing *writing);
438void grpc_chttp2_perform_writes(
439 grpc_chttp2_transport_writing *transport_writing, grpc_endpoint *endpoint);
440void grpc_chttp2_terminate_writing(
441 grpc_chttp2_transport_writing *transport_writing, int success);
442void grpc_chttp2_cleanup_writing(grpc_chttp2_transport_global *global,
443 grpc_chttp2_transport_writing *writing);
Craig Tillerd20efd22015-06-12 16:17:09 -0700444
Craig Tiller4aa71a12015-06-15 13:00:55 -0700445void grpc_chttp2_prepare_to_read(grpc_chttp2_transport_global *global,
446 grpc_chttp2_transport_parsing *parsing);
Craig Tillerab630732015-06-25 11:20:01 -0700447/** Process one slice of incoming data; return 1 if the connection is still
448 viable after reading, or 0 if the connection should be torn down */
Craig Tiller4aa71a12015-06-15 13:00:55 -0700449int grpc_chttp2_perform_read(grpc_chttp2_transport_parsing *transport_parsing,
450 gpr_slice slice);
451void grpc_chttp2_publish_reads(grpc_chttp2_transport_global *global,
452 grpc_chttp2_transport_parsing *parsing);
Craig Tillerd20efd22015-06-12 16:17:09 -0700453
454/** Get a writable stream
Craig Tillerab630732015-06-25 11:20:01 -0700455 returns non-zero if there was a stream available */
Craig Tiller4aa71a12015-06-15 13:00:55 -0700456void grpc_chttp2_list_add_writable_stream(
457 grpc_chttp2_transport_global *transport_global,
458 grpc_chttp2_stream_global *stream_global);
459int grpc_chttp2_list_pop_writable_stream(
460 grpc_chttp2_transport_global *transport_global,
461 grpc_chttp2_transport_writing *transport_writing,
462 grpc_chttp2_stream_global **stream_global,
463 grpc_chttp2_stream_writing **stream_writing);
Craig Tillerd20efd22015-06-12 16:17:09 -0700464
Craig Tillercf1e3192015-06-16 14:28:22 -0700465void grpc_chttp2_list_add_incoming_window_updated(
466 grpc_chttp2_transport_global *transport_global,
467 grpc_chttp2_stream_global *stream_global);
468int grpc_chttp2_list_pop_incoming_window_updated(
469 grpc_chttp2_transport_global *transport_global,
470 grpc_chttp2_transport_parsing *transport_parsing,
471 grpc_chttp2_stream_global **stream_global,
472 grpc_chttp2_stream_parsing **stream_parsing);
Craig Tiller759eb322015-06-16 22:41:18 -0700473void grpc_chttp2_list_remove_incoming_window_updated(
474 grpc_chttp2_transport_global *transport_global,
475 grpc_chttp2_stream_global *stream_global);
Craig Tillercf1e3192015-06-16 14:28:22 -0700476
Craig Tiller4aa71a12015-06-15 13:00:55 -0700477void grpc_chttp2_list_add_writing_stream(
478 grpc_chttp2_transport_writing *transport_writing,
479 grpc_chttp2_stream_writing *stream_writing);
480int grpc_chttp2_list_have_writing_streams(
481 grpc_chttp2_transport_writing *transport_writing);
482int grpc_chttp2_list_pop_writing_stream(
483 grpc_chttp2_transport_writing *transport_writing,
484 grpc_chttp2_stream_writing **stream_writing);
Craig Tillerd20efd22015-06-12 16:17:09 -0700485
Craig Tiller4aa71a12015-06-15 13:00:55 -0700486void grpc_chttp2_list_add_written_stream(
487 grpc_chttp2_transport_writing *transport_writing,
488 grpc_chttp2_stream_writing *stream_writing);
489int grpc_chttp2_list_pop_written_stream(
490 grpc_chttp2_transport_global *transport_global,
491 grpc_chttp2_transport_writing *transport_writing,
492 grpc_chttp2_stream_global **stream_global,
493 grpc_chttp2_stream_writing **stream_writing);
Craig Tillerd20efd22015-06-12 16:17:09 -0700494
Craig Tiller4aa71a12015-06-15 13:00:55 -0700495void grpc_chttp2_list_add_writable_window_update_stream(
496 grpc_chttp2_transport_global *transport_global,
497 grpc_chttp2_stream_global *stream_global);
498int grpc_chttp2_list_pop_writable_window_update_stream(
499 grpc_chttp2_transport_global *transport_global,
500 grpc_chttp2_stream_global **stream_global);
Craig Tillerb951df12015-06-18 15:46:58 -0700501void grpc_chttp2_list_remove_writable_window_update_stream(
502 grpc_chttp2_transport_global *transport_global,
503 grpc_chttp2_stream_global *stream_global);
Craig Tillerd20efd22015-06-12 16:17:09 -0700504
Craig Tiller4aa71a12015-06-15 13:00:55 -0700505void grpc_chttp2_list_add_parsing_seen_stream(
506 grpc_chttp2_transport_parsing *transport_parsing,
507 grpc_chttp2_stream_parsing *stream_parsing);
508int grpc_chttp2_list_pop_parsing_seen_stream(
509 grpc_chttp2_transport_global *transport_global,
510 grpc_chttp2_transport_parsing *transport_parsing,
511 grpc_chttp2_stream_global **stream_global,
512 grpc_chttp2_stream_parsing **stream_parsing);
Craig Tillerd20efd22015-06-12 16:17:09 -0700513
Craig Tiller5dc3b302015-06-15 16:06:50 -0700514void grpc_chttp2_list_add_waiting_for_concurrency(
515 grpc_chttp2_transport_global *transport_global,
516 grpc_chttp2_stream_global *stream_global);
517int grpc_chttp2_list_pop_waiting_for_concurrency(
518 grpc_chttp2_transport_global *transport_global,
519 grpc_chttp2_stream_global **stream_global);
520
Craig Tiller83fb0702015-06-16 21:13:07 -0700521void grpc_chttp2_list_add_closed_waiting_for_parsing(
Craig Tiller5dc3b302015-06-15 16:06:50 -0700522 grpc_chttp2_transport_global *transport_global,
523 grpc_chttp2_stream_global *stream_global);
Craig Tiller83fb0702015-06-16 21:13:07 -0700524int grpc_chttp2_list_pop_closed_waiting_for_parsing(
Craig Tiller5dc3b302015-06-15 16:06:50 -0700525 grpc_chttp2_transport_global *transport_global,
526 grpc_chttp2_stream_global **stream_global);
527
Craig Tiller6459db42015-06-15 17:11:45 -0700528void grpc_chttp2_list_add_read_write_state_changed(
529 grpc_chttp2_transport_global *transport_global,
530 grpc_chttp2_stream_global *stream_global);
Craig Tillerf73fcd12015-06-16 16:25:26 -0700531int grpc_chttp2_list_pop_read_write_state_changed(
532 grpc_chttp2_transport_global *transport_global,
533 grpc_chttp2_stream_global **stream_global);
Craig Tiller6459db42015-06-15 17:11:45 -0700534
Craig Tiller1937b062015-06-16 08:47:38 -0700535/** schedule a closure to run without the transport lock taken */
Craig Tiller4aa71a12015-06-15 13:00:55 -0700536void grpc_chttp2_schedule_closure(
537 grpc_chttp2_transport_global *transport_global, grpc_iomgr_closure *closure,
538 int success);
Craig Tillerd20efd22015-06-12 16:17:09 -0700539
Craig Tiller4aa71a12015-06-15 13:00:55 -0700540grpc_chttp2_stream_parsing *grpc_chttp2_parsing_lookup_stream(
541 grpc_chttp2_transport_parsing *transport_parsing, gpr_uint32 id);
542grpc_chttp2_stream_parsing *grpc_chttp2_parsing_accept_stream(
543 grpc_chttp2_transport_parsing *transport_parsing, gpr_uint32 id);
Craig Tillerd20efd22015-06-12 16:17:09 -0700544
Craig Tiller98505102015-06-16 11:33:15 -0700545void grpc_chttp2_add_incoming_goaway(
546 grpc_chttp2_transport_global *transport_global, gpr_uint32 goaway_error,
547 gpr_slice goaway_text);
Craig Tiller4aa71a12015-06-15 13:00:55 -0700548
Craig Tiller98505102015-06-16 11:33:15 -0700549void grpc_chttp2_register_stream(grpc_chttp2_transport *t,
550 grpc_chttp2_stream *s);
551void grpc_chttp2_unregister_stream(grpc_chttp2_transport *t,
552 grpc_chttp2_stream *s);
553void grpc_chttp2_for_all_streams(
554 grpc_chttp2_transport_global *transport_global, void *user_data,
555 void (*cb)(grpc_chttp2_transport_global *transport_global, void *user_data,
556 grpc_chttp2_stream_global *stream_global));
Craig Tiller5dc3b302015-06-15 16:06:50 -0700557
Craig Tiller285b8822015-06-17 15:58:13 -0700558void grpc_chttp2_parsing_become_skip_parser(
559 grpc_chttp2_transport_parsing *transport_parsing);
Craig Tiller66abdaa2015-06-17 08:00:39 -0700560
Craig Tillerd20efd22015-06-12 16:17:09 -0700561#define GRPC_CHTTP2_CLIENT_CONNECT_STRING "PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n"
Craig Tiller4aa71a12015-06-15 13:00:55 -0700562#define GRPC_CHTTP2_CLIENT_CONNECT_STRLEN \
563 (sizeof(GRPC_CHTTP2_CLIENT_CONNECT_STRING) - 1)
Craig Tillerd20efd22015-06-12 16:17:09 -0700564
565extern int grpc_http_trace;
Craig Tiller285b8822015-06-17 15:58:13 -0700566extern int grpc_flowctl_trace;
Craig Tillerd20efd22015-06-12 16:17:09 -0700567
Craig Tillerab630732015-06-25 11:20:01 -0700568#define GRPC_CHTTP2_IF_TRACING(stmt) \
569 if (!(grpc_http_trace)) \
570 ; \
571 else \
Craig Tillerd20efd22015-06-12 16:17:09 -0700572 stmt
Craig Tiller3208e392015-06-12 08:17:02 -0700573
Craig Tiller285b8822015-06-17 15:58:13 -0700574#define GRPC_CHTTP2_FLOWCTL_TRACE_STREAM(reason, transport, context, var, \
575 delta) \
576 if (!(grpc_flowctl_trace)) { \
577 } else { \
578 grpc_chttp2_flowctl_trace(__FILE__, __LINE__, reason, #context, #var, \
579 transport->is_client, context->id, context->var, \
580 delta); \
581 }
582
583#define GRPC_CHTTP2_FLOWCTL_TRACE_TRANSPORT(reason, context, var, delta) \
584 if (!(grpc_flowctl_trace)) { \
585 } else { \
586 grpc_chttp2_flowctl_trace(__FILE__, __LINE__, reason, #context, #var, \
587 context->is_client, 0, context->var, delta); \
588 }
589
590void grpc_chttp2_flowctl_trace(const char *file, int line, const char *reason,
591 const char *context, const char *var,
592 int is_client, gpr_uint32 stream_id,
593 gpr_int64 current_value, gpr_int64 delta);
594
Craig Tiller9b8671c2015-06-12 07:41:54 -0700595#endif