blob: 7f98a5bd711590590270f3defd9f7e2b06323e02 [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 Tiller17be5dc2015-07-01 10:36:27 -070066 GRPC_CHTTP2_LIST_CANCELLED_WAITING_FOR_WRITING,
Craig Tillercf1e3192015-06-16 14:28:22 -070067 GRPC_CHTTP2_LIST_INCOMING_WINDOW_UPDATED,
Craig Tiller5dc3b302015-06-15 16:06:50 -070068 /** streams that are waiting to start because there are too many concurrent
69 streams on the connection */
70 GRPC_CHTTP2_LIST_WAITING_FOR_CONCURRENCY,
Craig Tiller9b8671c2015-06-12 07:41:54 -070071 STREAM_LIST_COUNT /* must be last */
Craig Tillerb084d902015-06-12 07:50:02 -070072} grpc_chttp2_stream_list_id;
Craig Tiller9b8671c2015-06-12 07:41:54 -070073
74/* deframer state for the overall http2 stream of bytes */
75typedef enum {
76 /* prefix: one entry per http2 connection prefix byte */
Craig Tillerab630732015-06-25 11:20:01 -070077 GRPC_DTS_CLIENT_PREFIX_0 = 0,
78 GRPC_DTS_CLIENT_PREFIX_1,
79 GRPC_DTS_CLIENT_PREFIX_2,
80 GRPC_DTS_CLIENT_PREFIX_3,
81 GRPC_DTS_CLIENT_PREFIX_4,
82 GRPC_DTS_CLIENT_PREFIX_5,
83 GRPC_DTS_CLIENT_PREFIX_6,
84 GRPC_DTS_CLIENT_PREFIX_7,
85 GRPC_DTS_CLIENT_PREFIX_8,
86 GRPC_DTS_CLIENT_PREFIX_9,
87 GRPC_DTS_CLIENT_PREFIX_10,
88 GRPC_DTS_CLIENT_PREFIX_11,
89 GRPC_DTS_CLIENT_PREFIX_12,
90 GRPC_DTS_CLIENT_PREFIX_13,
91 GRPC_DTS_CLIENT_PREFIX_14,
92 GRPC_DTS_CLIENT_PREFIX_15,
93 GRPC_DTS_CLIENT_PREFIX_16,
94 GRPC_DTS_CLIENT_PREFIX_17,
95 GRPC_DTS_CLIENT_PREFIX_18,
96 GRPC_DTS_CLIENT_PREFIX_19,
97 GRPC_DTS_CLIENT_PREFIX_20,
98 GRPC_DTS_CLIENT_PREFIX_21,
99 GRPC_DTS_CLIENT_PREFIX_22,
100 GRPC_DTS_CLIENT_PREFIX_23,
Craig Tiller9b8671c2015-06-12 07:41:54 -0700101 /* frame header byte 0... */
102 /* must follow from the prefix states */
Craig Tillerab630732015-06-25 11:20:01 -0700103 GRPC_DTS_FH_0,
104 GRPC_DTS_FH_1,
105 GRPC_DTS_FH_2,
106 GRPC_DTS_FH_3,
107 GRPC_DTS_FH_4,
108 GRPC_DTS_FH_5,
109 GRPC_DTS_FH_6,
110 GRPC_DTS_FH_7,
Craig Tiller9b8671c2015-06-12 07:41:54 -0700111 /* ... frame header byte 8 */
Craig Tillerab630732015-06-25 11:20:01 -0700112 GRPC_DTS_FH_8,
Craig Tiller9b8671c2015-06-12 07:41:54 -0700113 /* inside a http2 frame */
Craig Tillerab630732015-06-25 11:20:01 -0700114 GRPC_DTS_FRAME
Craig Tillerb084d902015-06-12 07:50:02 -0700115} grpc_chttp2_deframe_transport_state;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700116
117typedef enum {
Craig Tillerab630732015-06-25 11:20:01 -0700118 GRPC_WRITE_STATE_OPEN,
119 GRPC_WRITE_STATE_QUEUED_CLOSE,
120 GRPC_WRITE_STATE_SENT_CLOSE
Craig Tillerb084d902015-06-12 07:50:02 -0700121} grpc_chttp2_write_state;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700122
123typedef enum {
Craig Tillerab630732015-06-25 11:20:01 -0700124 GRPC_DONT_SEND_CLOSED = 0,
125 GRPC_SEND_CLOSED,
126 GRPC_SEND_CLOSED_WITH_RST_STREAM
Craig Tillerb084d902015-06-12 07:50:02 -0700127} grpc_chttp2_send_closed;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700128
129typedef struct {
Craig Tillerb084d902015-06-12 07:50:02 -0700130 grpc_chttp2_stream *head;
131 grpc_chttp2_stream *tail;
132} grpc_chttp2_stream_list;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700133
134typedef struct {
Craig Tillerb084d902015-06-12 07:50:02 -0700135 grpc_chttp2_stream *next;
136 grpc_chttp2_stream *prev;
137} grpc_chttp2_stream_link;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700138
Craig Tiller9b8671c2015-06-12 07:41:54 -0700139/* We keep several sets of connection wide parameters */
140typedef enum {
141 /* The settings our peer has asked for (and we have acked) */
Craig Tillerab630732015-06-25 11:20:01 -0700142 GRPC_PEER_SETTINGS = 0,
Craig Tiller9b8671c2015-06-12 07:41:54 -0700143 /* The settings we'd like to have */
Craig Tillerab630732015-06-25 11:20:01 -0700144 GRPC_LOCAL_SETTINGS,
Craig Tiller9b8671c2015-06-12 07:41:54 -0700145 /* The settings we've published to our peer */
Craig Tillerab630732015-06-25 11:20:01 -0700146 GRPC_SENT_SETTINGS,
Craig Tiller9b8671c2015-06-12 07:41:54 -0700147 /* The settings the peer has acked */
Craig Tillerab630732015-06-25 11:20:01 -0700148 GRPC_ACKED_SETTINGS,
149 GRPC_NUM_SETTING_SETS
Craig Tillerb084d902015-06-12 07:50:02 -0700150} grpc_chttp2_setting_set;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700151
152/* Outstanding ping request data */
Craig Tiller3719f072015-06-12 17:19:51 -0700153typedef struct grpc_chttp2_outstanding_ping {
Craig Tiller9b8671c2015-06-12 07:41:54 -0700154 gpr_uint8 id[8];
Craig Tiller3719f072015-06-12 17:19:51 -0700155 grpc_iomgr_closure *on_recv;
156 struct grpc_chttp2_outstanding_ping *next;
157 struct grpc_chttp2_outstanding_ping *prev;
Craig Tillerb084d902015-06-12 07:50:02 -0700158} grpc_chttp2_outstanding_ping;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700159
160typedef struct {
Craig Tillerd20efd22015-06-12 16:17:09 -0700161 /** data to write next write */
162 gpr_slice_buffer qbuf;
163 /** queued callbacks */
Craig Tillerff3ae682015-06-29 17:44:04 -0700164 grpc_iomgr_closure *pending_closures_head;
165 grpc_iomgr_closure *pending_closures_tail;
Craig Tillerd20efd22015-06-12 16:17:09 -0700166
167 /** window available for us to send to peer */
168 gpr_uint32 outgoing_window;
Craig Tiller3719f072015-06-12 17:19:51 -0700169 /** window available for peer to send to us - updated after parse */
170 gpr_uint32 incoming_window;
Craig Tillerd20efd22015-06-12 16:17:09 -0700171 /** how much window would we like to have for incoming_window */
172 gpr_uint32 connection_window_target;
173
Craig Tiller1064f8b2015-06-25 13:52:57 -0700174 /** have we seen a goaway */
175 gpr_uint8 seen_goaway;
176
Craig Tiller3719f072015-06-12 17:19:51 -0700177 /** is this transport a client? */
178 gpr_uint8 is_client;
Craig Tillerd20efd22015-06-12 16:17:09 -0700179 /** are the local settings dirty and need to be sent? */
180 gpr_uint8 dirtied_local_settings;
181 /** have local settings been sent? */
182 gpr_uint8 sent_local_settings;
183 /** bitmask of setting indexes to send out */
Craig Tiller4aa71a12015-06-15 13:00:55 -0700184 gpr_uint32 force_send_settings;
Craig Tillerd20efd22015-06-12 16:17:09 -0700185 /** settings values */
Craig Tillerab630732015-06-25 11:20:01 -0700186 gpr_uint32 settings[GRPC_NUM_SETTING_SETS][GRPC_CHTTP2_NUM_SETTINGS];
Craig Tillerd20efd22015-06-12 16:17:09 -0700187
Craig Tiller606d8742015-06-15 06:58:50 -0700188 /** what is the next stream id to be allocated by this peer?
189 copied to next_stream_id in parsing when parsing commences */
190 gpr_uint32 next_stream_id;
191
Craig Tillerd20efd22015-06-12 16:17:09 -0700192 /** last received stream id */
193 gpr_uint32 last_incoming_stream_id;
Craig Tiller3719f072015-06-12 17:19:51 -0700194
195 /** pings awaiting responses */
196 grpc_chttp2_outstanding_ping pings;
Craig Tiller606d8742015-06-15 06:58:50 -0700197 /** next payload for an outgoing ping */
198 gpr_uint64 ping_counter;
199
200 /** concurrent stream count: updated when not parsing,
201 so this is a strict over-estimation on the client */
202 gpr_uint32 concurrent_stream_count;
Craig Tillerd20efd22015-06-12 16:17:09 -0700203} grpc_chttp2_transport_global;
204
205typedef struct {
206 /** data to write now */
207 gpr_slice_buffer outbuf;
208 /** hpack encoding */
209 grpc_chttp2_hpack_compressor hpack_compressor;
Craig Tiller285b8822015-06-17 15:58:13 -0700210 /** is this a client? */
211 gpr_uint8 is_client;
Craig Tillerd20efd22015-06-12 16:17:09 -0700212} grpc_chttp2_transport_writing;
213
214struct grpc_chttp2_transport_parsing {
215 /** is this transport a client? (boolean) */
216 gpr_uint8 is_client;
217
218 /** were settings updated? */
219 gpr_uint8 settings_updated;
220 /** was a settings ack received? */
221 gpr_uint8 settings_ack_received;
222 /** was a goaway frame received? */
223 gpr_uint8 goaway_received;
224
Craig Tiller3719f072015-06-12 17:19:51 -0700225 /** initial window change */
226 gpr_int64 initial_window_update;
227
Craig Tillerd20efd22015-06-12 16:17:09 -0700228 /** data to write later - after parsing */
229 gpr_slice_buffer qbuf;
230 /* metadata object cache */
231 grpc_mdstr *str_grpc_timeout;
232 /** parser for headers */
233 grpc_chttp2_hpack_parser hpack_parser;
234 /** simple one shot parsers */
235 union {
236 grpc_chttp2_window_update_parser window_update;
237 grpc_chttp2_settings_parser settings;
238 grpc_chttp2_ping_parser ping;
239 grpc_chttp2_rst_stream_parser rst_stream;
240 } simple;
241 /** parser for goaway frames */
242 grpc_chttp2_goaway_parser goaway_parser;
243
244 /** window available for peer to send to us */
245 gpr_uint32 incoming_window;
Craig Tiller285b8822015-06-17 15:58:13 -0700246 gpr_uint32 incoming_window_delta;
Craig Tillerd20efd22015-06-12 16:17:09 -0700247
248 /** next stream id available at the time of beginning parsing */
249 gpr_uint32 next_stream_id;
250 gpr_uint32 last_incoming_stream_id;
251
252 /* deframing */
253 grpc_chttp2_deframe_transport_state deframe_state;
254 gpr_uint8 incoming_frame_type;
255 gpr_uint8 incoming_frame_flags;
256 gpr_uint8 header_eof;
257 gpr_uint32 expect_continuation_stream_id;
258 gpr_uint32 incoming_frame_size;
259 gpr_uint32 incoming_stream_id;
260
261 /* active parser */
262 void *parser_data;
263 grpc_chttp2_stream_parsing *incoming_stream;
Craig Tiller4aa71a12015-06-15 13:00:55 -0700264 grpc_chttp2_parse_error (*parser)(
265 void *parser_user_data, grpc_chttp2_transport_parsing *transport_parsing,
266 grpc_chttp2_stream_parsing *stream_parsing, gpr_slice slice, int is_last);
Craig Tillerd20efd22015-06-12 16:17:09 -0700267
268 /* received settings */
269 gpr_uint32 settings[GRPC_CHTTP2_NUM_SETTINGS];
270
271 /* goaway data */
272 grpc_status_code goaway_error;
273 gpr_uint32 goaway_last_stream_index;
274 gpr_slice goaway_text;
Craig Tiller3719f072015-06-12 17:19:51 -0700275
276 gpr_uint64 outgoing_window_update;
277
278 /** pings awaiting responses */
279 grpc_chttp2_outstanding_ping pings;
Craig Tillerd20efd22015-06-12 16:17:09 -0700280};
281
Craig Tillerb084d902015-06-12 07:50:02 -0700282struct grpc_chttp2_transport {
Craig Tiller9b8671c2015-06-12 07:41:54 -0700283 grpc_transport base; /* must be first */
284 grpc_endpoint *ep;
285 grpc_mdctx *metadata_context;
286 gpr_refcount refs;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700287
288 gpr_mu mu;
Craig Tiller606d8742015-06-15 06:58:50 -0700289
290 /** is the transport destroying itself? */
291 gpr_uint8 destroying;
292 /** has the upper layer closed the transport? */
293 gpr_uint8 closed;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700294
Craig Tillerd20efd22015-06-12 16:17:09 -0700295 /** is a thread currently writing */
296 gpr_uint8 writing_active;
Craig Tiller606d8742015-06-15 06:58:50 -0700297 /** is a thread currently parsing */
298 gpr_uint8 parsing_active;
Craig Tillerd20efd22015-06-12 16:17:09 -0700299
Craig Tiller606d8742015-06-15 06:58:50 -0700300 /** is there a read request to the endpoint outstanding? */
301 gpr_uint8 endpoint_reading;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700302
Craig Tiller606d8742015-06-15 06:58:50 -0700303 /** various lists of streams */
Craig Tillerb084d902015-06-12 07:50:02 -0700304 grpc_chttp2_stream_list lists[STREAM_LIST_COUNT];
Craig Tiller9b8671c2015-06-12 07:41:54 -0700305
Craig Tiller606d8742015-06-15 06:58:50 -0700306 /** global state for reading/writing */
Craig Tillerd20efd22015-06-12 16:17:09 -0700307 grpc_chttp2_transport_global global;
Craig Tiller606d8742015-06-15 06:58:50 -0700308 /** state only accessible by the chain of execution that
309 set writing_active=1 */
Craig Tillerd20efd22015-06-12 16:17:09 -0700310 grpc_chttp2_transport_writing writing;
Craig Tiller606d8742015-06-15 06:58:50 -0700311 /** state only accessible by the chain of execution that
312 set parsing_active=1 */
Craig Tillerd20efd22015-06-12 16:17:09 -0700313 grpc_chttp2_transport_parsing parsing;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700314
Craig Tiller606d8742015-06-15 06:58:50 -0700315 /** maps stream id to grpc_chttp2_stream objects;
316 owned by the parsing thread when parsing */
317 grpc_chttp2_stream_map parsing_stream_map;
318
319 /** streams created by the client (possibly during parsing);
320 merged with parsing_stream_map during unlock when no
321 parsing is occurring */
322 grpc_chttp2_stream_map new_stream_map;
323
Craig Tillerd20efd22015-06-12 16:17:09 -0700324 /** closure to execute writing */
325 grpc_iomgr_closure writing_action;
Craig Tiller8b2f1d72015-06-18 13:38:38 -0700326 /** closure to start reading from the endpoint */
327 grpc_iomgr_closure reading_action;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700328
Craig Tiller4aa71a12015-06-15 13:00:55 -0700329 /** address to place a newly accepted stream - set and unset by
Craig Tiller606d8742015-06-15 06:58:50 -0700330 grpc_chttp2_parsing_accept_stream; used by init_stream to
331 publish the accepted server stream */
332 grpc_chttp2_stream **accepting_stream;
333
Craig Tiller9b8671c2015-06-12 07:41:54 -0700334 struct {
Craig Tiller1064f8b2015-06-25 13:52:57 -0700335 /* accept stream callback */
336 void (*accept_stream)(void *user_data, grpc_transport *transport,
337 const void *server_data);
338 void *accept_stream_user_data;
339
340 /** connectivity tracking */
Craig Tiller08a1cf82015-06-29 09:37:52 -0700341 grpc_connectivity_state_tracker state_tracker;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700342 } channel_callback;
343};
344
Craig Tillerd20efd22015-06-12 16:17:09 -0700345typedef struct {
346 /** HTTP2 stream id for this stream, or zero if one has not been assigned */
Craig Tiller9b8671c2015-06-12 07:41:54 -0700347 gpr_uint32 id;
348
Craig Tillerd20efd22015-06-12 16:17:09 -0700349 grpc_iomgr_closure *send_done_closure;
350 grpc_iomgr_closure *recv_done_closure;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700351
Craig Tillerd20efd22015-06-12 16:17:09 -0700352 /** window available for us to send to peer */
353 gpr_int64 outgoing_window;
Craig Tiller3719f072015-06-12 17:19:51 -0700354 /** window available for peer to send to us - updated after parse */
355 gpr_uint32 incoming_window;
Craig Tillerd20efd22015-06-12 16:17:09 -0700356 /** stream ops the transport user would like to send */
357 grpc_stream_op_buffer *outgoing_sopb;
358 /** when the application requests writes be closed, the write_closed is
359 'queued'; when the close is flow controlled into the send path, we are
360 'sending' it; when the write has been performed it is 'sent' */
361 grpc_chttp2_write_state write_state;
362 /** is this stream closed (boolean) */
363 gpr_uint8 read_closed;
Craig Tiller5dc3b302015-06-15 16:06:50 -0700364 /** has this stream been cancelled? (boolean) */
365 gpr_uint8 cancelled;
Craig Tillercec9eb92015-06-17 17:16:48 -0700366 grpc_status_code cancelled_status;
367 /** have we told the upper layer that this stream is cancelled? */
368 gpr_uint8 published_cancelled;
Craig Tiller5dc3b302015-06-15 16:06:50 -0700369 /** is this stream in the stream map? (boolean) */
370 gpr_uint8 in_stream_map;
Craig Tiller606d8742015-06-15 06:58:50 -0700371
372 /** stream state already published to the upper layer */
373 grpc_stream_state published_state;
374 /** address to publish next stream state to */
375 grpc_stream_state *publish_state;
376 /** pointer to sop buffer to fill in with new stream ops */
Craig Tiller6905b7c2015-06-16 15:33:33 -0700377 grpc_stream_op_buffer *publish_sopb;
378 grpc_stream_op_buffer incoming_sopb;
Craig Tiller5dc3b302015-06-15 16:06:50 -0700379
380 /** incoming metadata */
381 grpc_chttp2_incoming_metadata_buffer incoming_metadata;
Craig Tillerb787c502015-06-15 16:14:52 -0700382 grpc_chttp2_incoming_metadata_live_op_buffer outstanding_metadata;
Craig Tillerd20efd22015-06-12 16:17:09 -0700383} grpc_chttp2_stream_global;
384
385typedef struct {
386 /** HTTP2 stream id for this stream, or zero if one has not been assigned */
387 gpr_uint32 id;
388 /** sops that have passed flow control to be written */
389 grpc_stream_op_buffer sopb;
390 /** how strongly should we indicate closure with the next write */
391 grpc_chttp2_send_closed send_closed;
392} grpc_chttp2_stream_writing;
393
394struct grpc_chttp2_stream_parsing {
395 /** HTTP2 stream id for this stream, or zero if one has not been assigned */
396 gpr_uint32 id;
397 /** has this stream received a close */
398 gpr_uint8 received_close;
Craig Tiller3719f072015-06-12 17:19:51 -0700399 /** saw a rst_stream */
400 gpr_uint8 saw_rst_stream;
Craig Tiller606d8742015-06-15 06:58:50 -0700401 /** incoming_window has been reduced by this much during parsing */
402 gpr_uint32 incoming_window_delta;
Craig Tillerd20efd22015-06-12 16:17:09 -0700403 /** window available for peer to send to us */
404 gpr_uint32 incoming_window;
405 /** parsing state for data frames */
406 grpc_chttp2_data_parser data_parser;
Craig Tiller3719f072015-06-12 17:19:51 -0700407 /** reason give to rst_stream */
408 gpr_uint32 rst_stream_reason;
409 /* amount of window given */
410 gpr_uint64 outgoing_window_update;
Craig Tiller9b8671c2015-06-12 07:41:54 -0700411
Craig Tiller5dc3b302015-06-15 16:06:50 -0700412 /** incoming metadata */
413 grpc_chttp2_incoming_metadata_buffer incoming_metadata;
Craig Tillerd20efd22015-06-12 16:17:09 -0700414};
415
416struct grpc_chttp2_stream {
417 grpc_chttp2_stream_global global;
418 grpc_chttp2_stream_writing writing;
Craig Tiller606d8742015-06-15 06:58:50 -0700419 grpc_chttp2_stream_parsing parsing;
Craig Tillerd20efd22015-06-12 16:17:09 -0700420
421 grpc_chttp2_stream_link links[STREAM_LIST_COUNT];
422 gpr_uint8 included[STREAM_LIST_COUNT];
Craig Tiller9b8671c2015-06-12 07:41:54 -0700423};
424
Craig Tillerd20efd22015-06-12 16:17:09 -0700425/** Transport writing call flow:
Craig Tiller4aa71a12015-06-15 13:00:55 -0700426 chttp2_transport.c calls grpc_chttp2_unlocking_check_writes to see if writes
427 are required;
428 if they are, chttp2_transport.c calls grpc_chttp2_perform_writes to do the
429 writes.
430 Once writes have been completed (meaning another write could potentially be
431 started),
432 grpc_chttp2_terminate_writing is called. This will call
433 grpc_chttp2_cleanup_writing, at which
Craig Tillerd20efd22015-06-12 16:17:09 -0700434 point the write phase is complete. */
435
Craig Tiller3208e392015-06-12 08:17:02 -0700436/** Someone is unlocking the transport mutex: check to see if writes
437 are required, and schedule them if so */
Craig Tiller4aa71a12015-06-15 13:00:55 -0700438int grpc_chttp2_unlocking_check_writes(grpc_chttp2_transport_global *global,
439 grpc_chttp2_transport_writing *writing);
440void grpc_chttp2_perform_writes(
441 grpc_chttp2_transport_writing *transport_writing, grpc_endpoint *endpoint);
442void grpc_chttp2_terminate_writing(
443 grpc_chttp2_transport_writing *transport_writing, int success);
444void grpc_chttp2_cleanup_writing(grpc_chttp2_transport_global *global,
445 grpc_chttp2_transport_writing *writing);
Craig Tillerd20efd22015-06-12 16:17:09 -0700446
Craig Tiller4aa71a12015-06-15 13:00:55 -0700447void grpc_chttp2_prepare_to_read(grpc_chttp2_transport_global *global,
448 grpc_chttp2_transport_parsing *parsing);
Craig Tillerab630732015-06-25 11:20:01 -0700449/** Process one slice of incoming data; return 1 if the connection is still
450 viable after reading, or 0 if the connection should be torn down */
Craig Tiller4aa71a12015-06-15 13:00:55 -0700451int grpc_chttp2_perform_read(grpc_chttp2_transport_parsing *transport_parsing,
452 gpr_slice slice);
453void grpc_chttp2_publish_reads(grpc_chttp2_transport_global *global,
454 grpc_chttp2_transport_parsing *parsing);
Craig Tillerd20efd22015-06-12 16:17:09 -0700455
456/** Get a writable stream
Craig Tillerab630732015-06-25 11:20:01 -0700457 returns non-zero if there was a stream available */
Craig Tiller4aa71a12015-06-15 13:00:55 -0700458void grpc_chttp2_list_add_writable_stream(
459 grpc_chttp2_transport_global *transport_global,
460 grpc_chttp2_stream_global *stream_global);
461int grpc_chttp2_list_pop_writable_stream(
462 grpc_chttp2_transport_global *transport_global,
463 grpc_chttp2_transport_writing *transport_writing,
464 grpc_chttp2_stream_global **stream_global,
465 grpc_chttp2_stream_writing **stream_writing);
Craig Tillerd20efd22015-06-12 16:17:09 -0700466
Craig Tillercf1e3192015-06-16 14:28:22 -0700467void grpc_chttp2_list_add_incoming_window_updated(
468 grpc_chttp2_transport_global *transport_global,
469 grpc_chttp2_stream_global *stream_global);
470int grpc_chttp2_list_pop_incoming_window_updated(
471 grpc_chttp2_transport_global *transport_global,
472 grpc_chttp2_transport_parsing *transport_parsing,
473 grpc_chttp2_stream_global **stream_global,
474 grpc_chttp2_stream_parsing **stream_parsing);
Craig Tiller759eb322015-06-16 22:41:18 -0700475void grpc_chttp2_list_remove_incoming_window_updated(
476 grpc_chttp2_transport_global *transport_global,
477 grpc_chttp2_stream_global *stream_global);
Craig Tillercf1e3192015-06-16 14:28:22 -0700478
Craig Tiller4aa71a12015-06-15 13:00:55 -0700479void grpc_chttp2_list_add_writing_stream(
480 grpc_chttp2_transport_writing *transport_writing,
481 grpc_chttp2_stream_writing *stream_writing);
482int grpc_chttp2_list_have_writing_streams(
483 grpc_chttp2_transport_writing *transport_writing);
484int grpc_chttp2_list_pop_writing_stream(
485 grpc_chttp2_transport_writing *transport_writing,
486 grpc_chttp2_stream_writing **stream_writing);
Craig Tillerd20efd22015-06-12 16:17:09 -0700487
Craig Tiller4aa71a12015-06-15 13:00:55 -0700488void grpc_chttp2_list_add_written_stream(
489 grpc_chttp2_transport_writing *transport_writing,
490 grpc_chttp2_stream_writing *stream_writing);
491int grpc_chttp2_list_pop_written_stream(
492 grpc_chttp2_transport_global *transport_global,
493 grpc_chttp2_transport_writing *transport_writing,
494 grpc_chttp2_stream_global **stream_global,
495 grpc_chttp2_stream_writing **stream_writing);
Craig Tillerd20efd22015-06-12 16:17:09 -0700496
Craig Tiller4aa71a12015-06-15 13:00:55 -0700497void grpc_chttp2_list_add_writable_window_update_stream(
498 grpc_chttp2_transport_global *transport_global,
499 grpc_chttp2_stream_global *stream_global);
500int grpc_chttp2_list_pop_writable_window_update_stream(
501 grpc_chttp2_transport_global *transport_global,
502 grpc_chttp2_stream_global **stream_global);
Craig Tillerb951df12015-06-18 15:46:58 -0700503void grpc_chttp2_list_remove_writable_window_update_stream(
504 grpc_chttp2_transport_global *transport_global,
505 grpc_chttp2_stream_global *stream_global);
Craig Tillerd20efd22015-06-12 16:17:09 -0700506
Craig Tiller4aa71a12015-06-15 13:00:55 -0700507void grpc_chttp2_list_add_parsing_seen_stream(
508 grpc_chttp2_transport_parsing *transport_parsing,
509 grpc_chttp2_stream_parsing *stream_parsing);
510int grpc_chttp2_list_pop_parsing_seen_stream(
511 grpc_chttp2_transport_global *transport_global,
512 grpc_chttp2_transport_parsing *transport_parsing,
513 grpc_chttp2_stream_global **stream_global,
514 grpc_chttp2_stream_parsing **stream_parsing);
Craig Tillerd20efd22015-06-12 16:17:09 -0700515
Craig Tiller5dc3b302015-06-15 16:06:50 -0700516void grpc_chttp2_list_add_waiting_for_concurrency(
517 grpc_chttp2_transport_global *transport_global,
518 grpc_chttp2_stream_global *stream_global);
519int grpc_chttp2_list_pop_waiting_for_concurrency(
520 grpc_chttp2_transport_global *transport_global,
521 grpc_chttp2_stream_global **stream_global);
522
Craig Tiller83fb0702015-06-16 21:13:07 -0700523void grpc_chttp2_list_add_closed_waiting_for_parsing(
Craig Tiller5dc3b302015-06-15 16:06:50 -0700524 grpc_chttp2_transport_global *transport_global,
525 grpc_chttp2_stream_global *stream_global);
Craig Tiller83fb0702015-06-16 21:13:07 -0700526int grpc_chttp2_list_pop_closed_waiting_for_parsing(
Craig Tiller5dc3b302015-06-15 16:06:50 -0700527 grpc_chttp2_transport_global *transport_global,
528 grpc_chttp2_stream_global **stream_global);
529
Craig Tiller17be5dc2015-07-01 10:36:27 -0700530void grpc_chttp2_list_add_cancelled_waiting_for_writing(
531 grpc_chttp2_transport_global *transport_global,
532 grpc_chttp2_stream_global *stream_global);
533int grpc_chttp2_list_pop_cancelled_waiting_for_writing(
534 grpc_chttp2_transport_global *transport_global,
535 grpc_chttp2_stream_global **stream_global);
536
Craig Tiller6459db42015-06-15 17:11:45 -0700537void grpc_chttp2_list_add_read_write_state_changed(
538 grpc_chttp2_transport_global *transport_global,
539 grpc_chttp2_stream_global *stream_global);
Craig Tillerf73fcd12015-06-16 16:25:26 -0700540int grpc_chttp2_list_pop_read_write_state_changed(
541 grpc_chttp2_transport_global *transport_global,
542 grpc_chttp2_stream_global **stream_global);
Craig Tiller6459db42015-06-15 17:11:45 -0700543
Craig Tiller1937b062015-06-16 08:47:38 -0700544/** schedule a closure to run without the transport lock taken */
Craig Tiller4aa71a12015-06-15 13:00:55 -0700545void grpc_chttp2_schedule_closure(
546 grpc_chttp2_transport_global *transport_global, grpc_iomgr_closure *closure,
547 int success);
Craig Tillerd20efd22015-06-12 16:17:09 -0700548
Craig Tiller4aa71a12015-06-15 13:00:55 -0700549grpc_chttp2_stream_parsing *grpc_chttp2_parsing_lookup_stream(
550 grpc_chttp2_transport_parsing *transport_parsing, gpr_uint32 id);
551grpc_chttp2_stream_parsing *grpc_chttp2_parsing_accept_stream(
552 grpc_chttp2_transport_parsing *transport_parsing, gpr_uint32 id);
Craig Tillerd20efd22015-06-12 16:17:09 -0700553
Craig Tiller98505102015-06-16 11:33:15 -0700554void grpc_chttp2_add_incoming_goaway(
555 grpc_chttp2_transport_global *transport_global, gpr_uint32 goaway_error,
556 gpr_slice goaway_text);
Craig Tiller4aa71a12015-06-15 13:00:55 -0700557
Craig Tiller98505102015-06-16 11:33:15 -0700558void grpc_chttp2_register_stream(grpc_chttp2_transport *t,
559 grpc_chttp2_stream *s);
560void grpc_chttp2_unregister_stream(grpc_chttp2_transport *t,
561 grpc_chttp2_stream *s);
562void grpc_chttp2_for_all_streams(
563 grpc_chttp2_transport_global *transport_global, void *user_data,
564 void (*cb)(grpc_chttp2_transport_global *transport_global, void *user_data,
565 grpc_chttp2_stream_global *stream_global));
Craig Tiller5dc3b302015-06-15 16:06:50 -0700566
Craig Tiller285b8822015-06-17 15:58:13 -0700567void grpc_chttp2_parsing_become_skip_parser(
568 grpc_chttp2_transport_parsing *transport_parsing);
Craig Tiller66abdaa2015-06-17 08:00:39 -0700569
Craig Tillerd20efd22015-06-12 16:17:09 -0700570#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 -0700571#define GRPC_CHTTP2_CLIENT_CONNECT_STRLEN \
572 (sizeof(GRPC_CHTTP2_CLIENT_CONNECT_STRING) - 1)
Craig Tillerd20efd22015-06-12 16:17:09 -0700573
574extern int grpc_http_trace;
Craig Tiller285b8822015-06-17 15:58:13 -0700575extern int grpc_flowctl_trace;
Craig Tillerd20efd22015-06-12 16:17:09 -0700576
Craig Tillerab630732015-06-25 11:20:01 -0700577#define GRPC_CHTTP2_IF_TRACING(stmt) \
578 if (!(grpc_http_trace)) \
579 ; \
580 else \
Craig Tillerd20efd22015-06-12 16:17:09 -0700581 stmt
Craig Tiller3208e392015-06-12 08:17:02 -0700582
Craig Tiller285b8822015-06-17 15:58:13 -0700583#define GRPC_CHTTP2_FLOWCTL_TRACE_STREAM(reason, transport, context, var, \
584 delta) \
585 if (!(grpc_flowctl_trace)) { \
586 } else { \
587 grpc_chttp2_flowctl_trace(__FILE__, __LINE__, reason, #context, #var, \
588 transport->is_client, context->id, context->var, \
589 delta); \
590 }
591
592#define GRPC_CHTTP2_FLOWCTL_TRACE_TRANSPORT(reason, context, var, delta) \
593 if (!(grpc_flowctl_trace)) { \
594 } else { \
595 grpc_chttp2_flowctl_trace(__FILE__, __LINE__, reason, #context, #var, \
596 context->is_client, 0, context->var, delta); \
597 }
598
599void grpc_chttp2_flowctl_trace(const char *file, int line, const char *reason,
600 const char *context, const char *var,
601 int is_client, gpr_uint32 stream_id,
602 gpr_int64 current_value, gpr_int64 delta);
603
Craig Tiller9b8671c2015-06-12 07:41:54 -0700604#endif