lsquic_stream.h revision 747be414
1/* Copyright (c) 2017 - 2019 LiteSpeed Technologies Inc. See LICENSE. */ 2#ifndef LSQUIC_STREAM_H 3#define LSQUIC_STREAM_H 4 5#define LSQUIC_STREAM_DEFAULT_PRIO 16 /* RFC 7540, Section 5.3.5 */ 6 7 8struct lsquic_stream_if; 9struct lsquic_stream_ctx; 10struct lsquic_conn_public; 11struct stream_frame; 12struct uncompressed_headers; 13enum enc_level; 14enum swtp_status; 15struct frame_gen_ctx; 16struct data_frame; 17enum quic_frame_type; 18struct push_promise; 19 20TAILQ_HEAD(lsquic_streams_tailq, lsquic_stream); 21 22 23#ifndef LSQUIC_KEEP_STREAM_HISTORY 24# ifdef NDEBUG 25# define LSQUIC_KEEP_STREAM_HISTORY 0 26# else 27# define LSQUIC_KEEP_STREAM_HISTORY 1 28# endif 29#endif 30 31 32#if LSQUIC_KEEP_STREAM_HISTORY 33#define SM_HIST_BITS 6 34#define SM_HIST_IDX_MASK ((1 << SM_HIST_BITS) - 1) 35typedef unsigned char sm_hist_idx_t; 36#endif 37 38 39/* 40 * +----------+----------------------------------+ 41 * | Low Bits | Stream Type | 42 * +----------+----------------------------------+ 43 * | 0x0 | Client-Initiated, Bidirectional | 44 * | | | 45 * | 0x1 | Server-Initiated, Bidirectional | 46 * | | | 47 * | 0x2 | Client-Initiated, Unidirectional | 48 * | | | 49 * | 0x3 | Server-Initiated, Unidirectional | 50 * +----------+----------------------------------+ 51 */ 52 53enum stream_id_type 54{ 55 SIT_BIDI_CLIENT, 56 SIT_BIDI_SERVER, 57 SIT_UNI_CLIENT, 58 SIT_UNI_SERVER, 59 N_SITS 60}; 61 62#define SIT_MASK (N_SITS - 1) 63 64#define SIT_SHIFT 2 65#define SD_SHIFT 1 66 67enum stream_dir { SD_BIDI, SD_UNI, N_SDS }; 68 69 70struct stream_hq_frame 71{ 72 STAILQ_ENTRY(stream_hq_frame) 73 shf_next; 74 /* At which point in the stream (sm_payload) to insert the HQ frame. */ 75 uint64_t shf_off; 76 union { 77 /* Points to the frame if SHF_FIXED_SIZE is not set */ 78 unsigned char *frame_ptr; 79 /* If SHF_FIXED_SIZE is set, the size of the frame to follow. 80 * Non-fixed frame size gets calculated using sm_payload when they 81 * are closed. 82 */ 83 size_t frame_size; 84 } shf_u; 85#define shf_frame_ptr shf_u.frame_ptr 86#define shf_frame_size shf_u.frame_size 87 enum hq_frame_type shf_frame_type:8; 88 enum shf_flags { 89 SHF_TWO_BYTES = 1 << 0, /* Use two byte to encode frame length */ 90 SHF_FIXED_SIZE = 1 << 1, /* Payload size guaranteed */ 91 SHF_ACTIVE = 1 << 2, /* On sm_hq_frames list */ 92 SHF_WRITTEN = 1 << 3, /* Framing bytes have been packetized */ 93 SHF_CC_PAID = 1 << 4, /* Paid connection cap */ 94 SHF_PHANTOM = 1 << 5, /* Phantom frame headers are not written */ 95 } shf_flags:8; 96}; 97 98 99struct hq_filter 100{ 101 struct varint_read2_state hqfi_vint2_state; 102 /* No need to copy the values: use it directly */ 103#define hqfi_left hqfi_vint2_state.vr2s_two 104#define hqfi_type hqfi_vint2_state.vr2s_one 105 struct varint_read_state hqfi_vint1_state; 106#define hqfi_push_id hqfi_vint1_state.value 107 enum { 108 HQFI_FLAG_UNUSED_0 = 1 << 0, 109 HQFI_FLAG_ERROR = 1 << 1, 110 HQFI_FLAG_BEGIN = 1 << 2, 111 HQFI_FLAG_BLOCKED = 1 << 3, 112 } hqfi_flags:8; 113 enum { 114 HQFI_STATE_FRAME_HEADER_BEGIN, 115 HQFI_STATE_FRAME_HEADER_CONTINUE, 116 HQFI_STATE_READING_PAYLOAD, 117 HQFI_STATE_PUSH_ID_BEGIN, 118 HQFI_STATE_PUSH_ID_CONTINUE, 119 } hqfi_state:8; 120 unsigned char hqfi_hist_idx; 121#define MAX_HQFI_ENTRIES (sizeof(unsigned) * 8 / 3) 122 unsigned hqfi_hist_buf; 123}; 124 125 126struct stream_filter_if 127{ 128 int (*sfi_readable)(struct lsquic_stream *); 129 size_t (*sfi_filter_df)(struct lsquic_stream *, struct data_frame *); 130 void (*sfi_decr_left)(struct lsquic_stream *, size_t); 131}; 132 133 134/* These flags indicate which queues -- or other entities -- currently 135 * reference the stream. 136 */ 137enum stream_q_flags 138{ 139 /* read_streams: */ 140 SMQF_WANT_READ = 1 << 0, 141 142 /* write_streams: */ 143#define SMQF_WRITE_Q_FLAGS (SMQF_WANT_FLUSH|SMQF_WANT_WRITE) 144 SMQF_WANT_WRITE = 1 << 1, 145 SMQF_WANT_FLUSH = 1 << 2, /* Flush until sm_flush_to is hit */ 146 147 /* There are more than one reason that a stream may be put onto 148 * connections's sending_streams queue. Note that writing STREAM 149 * frames is done separately. 150 */ 151#define SMQF_SENDING_FLAGS (SMQF_SEND_WUF|SMQF_SEND_RST|SMQF_SEND_BLOCKED) 152 /* sending_streams: */ 153 SMQF_SEND_WUF = 1 << 3, /* WUF: Window Update Frame */ 154 SMQF_SEND_BLOCKED = 1 << 4, 155 SMQF_SEND_RST = 1 << 5, /* Error: want to send RST_STREAM */ 156 157 /* The equivalent of WINDOW_UPDATE frame for streams in IETF QUIC is 158 * the MAX_STREAM_DATA frame. Define an alias for use in the IETF 159 * QUIC code: 160 */ 161#define SMQF_SEND_MAX_STREAM_DATA SMQF_SEND_WUF 162 163#define SMQF_SERVICE_FLAGS (SMQF_CALL_ONCLOSE|SMQF_FREE_STREAM|SMQF_ABORT_CONN) 164 SMQF_CALL_ONCLOSE = 1 << 6, 165 SMQF_FREE_STREAM = 1 << 7, 166 SMQF_ABORT_CONN = 1 << 8, /* Unrecoverable error occurred */ 167 168 SMQF_QPACK_DEC = 1 << 9, /* QPACK decoder is holding a reference to this stream */ 169}; 170 171 172/* Stream behavior flags */ 173enum stream_b_flags 174{ 175 SMBF_SERVER = 1 << 0, 176 SMBF_IETF = 1 << 1, 177 SMBF_USE_HEADERS = 1 << 2, 178 SMBF_CRYPTO = 1 << 3, /* Crypto stream: applies to both gQUIC and IETF QUIC */ 179 SMBF_CRITICAL = 1 << 4, /* This is a critical stream */ 180 SMBF_AUTOSWITCH = 1 << 5, 181 SMBF_RW_ONCE = 1 << 6, /* When set, read/write events are dispatched once per call */ 182 SMBF_CONN_LIMITED = 1 << 7, 183 SMBF_HEADERS = 1 << 8, /* Headers stream */ 184 SMBF_VERIFY_CL = 1 << 9, /* Verify content-length (stored in sm_cont_len) */ 185#define N_SMBF_FLAGS 10 186}; 187 188 189enum stream_flags { 190 STREAM_FIN_RECVD = 1 << 0, /* Received STREAM frame with FIN bit set */ 191 STREAM_RST_RECVD = 1 << 1, /* Received RST frame */ 192 STREAM_LAST_WRITE_OK= 1 << 2, /* Used to break out of write event dispatch loop */ 193 STREAM_U_READ_DONE = 1 << 3, /* User is done reading (shutdown was called) */ 194 STREAM_U_WRITE_DONE = 1 << 4, /* User is done writing (shutdown was called) */ 195 STREAM_FIN_SENT = 1 << 5, /* FIN was written to network */ 196 STREAM_RST_SENT = 1 << 6, /* RST_STREAM was written to network */ 197 STREAM_FIN_REACHED = 1 << 7, /* User read data up to FIN */ 198 STREAM_FINISHED = 1 << 8, /* Stream is finished */ 199 STREAM_ONCLOSE_DONE = 1 << 9, /* on_close has been called */ 200 STREAM_CACHED_FRAME = 1 << 10, /* If set, sm_has_frame can be used */ 201 STREAM_HEADERS_SENT = 1 << 11, 202 STREAM_HAVE_UH = 1 << 12, /* Have uncompressed headers */ 203 STREAM_ENCODER_DEP = 1 << 13, /* Encoder dependency: flush (IETF only) */ 204 STREAM_HEAD_IN_FIN = 1 << 14, /* Incoming headers has FIN bit set */ 205 STREAM_FRAMES_ELIDED= 1 << 15, 206 STREAM_FORCE_FINISH = 1 << 16, /* Replaces FIN sent and received */ 207 STREAM_ONNEW_DONE = 1 << 17, /* on_new_stream has been called */ 208 STREAM_PUSHING = 1 << 18, 209 STREAM_NOPUSH = 1 << 19, /* Disallow further push promises */ 210 STREAM_UNUSED20 = 1 << 20, /* Unused */ 211 STREAM_UNUSED21 = 1 << 21, /* Unused */ 212 STREAM_RST_ACKED = 1 << 22, /* Packet containing RST has been acked */ 213 STREAM_BLOCKED_SENT = 1 << 23, /* Stays set once a STREAM_BLOCKED frame is sent */ 214 STREAM_RST_READ = 1 << 24, /* User code collected the error */ 215 STREAM_DATA_RECVD = 1 << 25, /* Cache stream state calculation */ 216 STREAM_UNUSED26 = 1 << 26, /* Unused */ 217 STREAM_HDRS_FLUSHED = 1 << 27, /* Only used in buffered packets mode */ 218 STREAM_SS_RECVD = 1 << 28, /* Received STOP_SENDING frame */ 219 STREAM_DELAYED_SW = 1 << 29, /* Delayed shutdown_write call */ 220}; 221 222 223/* By keeping this number low, we make sure that the code to allocate HQ 224 * frames dynamically gets exercised whenever push promises are sent. 225 */ 226#define NUM_ALLOCED_HQ_FRAMES 2 227 228 229struct lsquic_stream 230{ 231 struct lsquic_hash_elem sm_hash_el; 232 lsquic_stream_id_t id; 233 enum stream_flags stream_flags; 234 enum stream_b_flags sm_bflags; 235 enum stream_q_flags sm_qflags; 236 unsigned n_unacked; 237 238 const struct lsquic_stream_if *stream_if; 239 struct lsquic_stream_ctx *st_ctx; 240 struct lsquic_conn_public *conn_pub; 241 TAILQ_ENTRY(lsquic_stream) next_send_stream, next_read_stream, 242 next_write_stream, next_service_stream, 243 next_prio_stream; 244 245 uint64_t tosend_off; 246 uint64_t sm_payload; /* Not counting HQ frames */ 247 uint64_t max_send_off; 248 uint64_t sm_last_recv_off; 249 uint64_t error_code; 250 251 /* From the network, we get frames, which we keep on a list ordered 252 * by offset. 253 */ 254 struct data_in *data_in; 255 uint64_t read_offset; 256 lsquic_sfcw_t fc; 257 258 /* List of active HQ frames */ 259 STAILQ_HEAD(, stream_hq_frame) sm_hq_frames; 260 261 /* For efficiency, several frames are allocated as part of the stream 262 * itself. If more frames are needed, they are allocated. 263 */ 264 struct stream_hq_frame sm_hq_frame_arr[NUM_ALLOCED_HQ_FRAMES]; 265 266 struct hq_filter sm_hq_filter; 267 268 /* We can safely use sm_hq_filter */ 269#define sm_uni_type_state sm_hq_filter.hqfi_vint2_state.vr2s_varint_state 270 271 /** If @ref SMQF_WANT_FLUSH is set, flush until this offset. */ 272 uint64_t sm_flush_to; 273 274 /** 275 * If @ref SMQF_WANT_FLUSH is set, this indicates payload offset 276 * to flush to. Used to adjust @ref sm_flush_to when H3 frame 277 * size grows. 278 */ 279 uint64_t sm_flush_to_payload; 280 281 /* Last offset sent in BLOCKED frame */ 282 uint64_t blocked_off; 283 284 struct uncompressed_headers *uh, 285 *push_req; 286 287 unsigned char *sm_buf; 288 void *sm_onnew_arg; 289 290 unsigned char *sm_header_block; 291 uint64_t sm_hb_compl; 292 293 /* Valid if STREAM_FIN_RECVD is set: */ 294 uint64_t sm_fin_off; 295 296 /* A stream may be generating STREAM or CRYPTO frames */ 297 size_t (*sm_frame_header_sz)( 298 const struct lsquic_stream *, unsigned); 299 enum swtp_status (*sm_write_to_packet)(struct frame_gen_ctx *, 300 const size_t); 301 size_t (*sm_write_avail)(struct lsquic_stream *); 302 int (*sm_readable)(struct lsquic_stream *); 303 304 /* This element is optional */ 305 const struct stream_filter_if *sm_sfi; 306 307 /* sm_promise and sm_promises are never used at the same time and can 308 * be combined into a union should space in this struct become tight. 309 */ 310 /* Push promise that engendered this push stream */ 311 struct push_promise *sm_promise; 312 313 /* Push promises sent on this stream */ 314 SLIST_HEAD(, push_promise) sm_promises; 315 316 uint64_t sm_last_frame_off; 317 318 /* Content length specified in incoming `content-length' header field. 319 * Used to verify size of DATA frames. 320 */ 321 unsigned long long sm_cont_len; 322 /* Sum of bytes in all incoming DATA frames. Used for verification. */ 323 unsigned long long sm_data_in; 324 325 /* How much data there is in sm_header_block and how much of it has been 326 * sent: 327 */ 328 unsigned sm_hblock_sz, 329 sm_hblock_off; 330 331 unsigned short sm_n_buffered; /* Amount of data in sm_buf */ 332 unsigned short sm_n_allocated; /* Size of sm_buf */ 333 334 unsigned char sm_priority; /* 0: high; 255: low */ 335 unsigned char sm_enc_level; 336 enum { 337 SSHS_BEGIN, /* Nothing has happened yet */ 338 SSHS_ENC_SENDING, /* Sending encoder stream data */ 339 SSHS_HBLOCK_SENDING,/* Sending header block data */ 340 } sm_send_headers_state:8; 341 signed char sm_saved_want_write; 342 signed char sm_has_frame; 343 344 unsigned char sm_dup_push_off; 345 unsigned char sm_dup_push_len; 346 unsigned char sm_dup_push_buf[8]; 347 348#if LSQUIC_KEEP_STREAM_HISTORY 349 sm_hist_idx_t sm_hist_idx; 350#endif 351 352#if LSQUIC_KEEP_STREAM_HISTORY 353 /* Stream history: see enum stream_history_event */ 354 unsigned char sm_hist_buf[ 1 << SM_HIST_BITS ]; 355#endif 356}; 357 358 359enum stream_ctor_flags 360{ 361 SCF_CALL_ON_NEW = (1 << (N_SMBF_FLAGS + 0)), /* Call on_new_stream() immediately */ 362 SCF_USE_DI_HASH = (1 << (N_SMBF_FLAGS + 1)), /* Use hash-based data input. If not set, 363 * the nocopy data input is used. 364 */ 365 SCF_CRYPTO_FRAMES = (1 << (N_SMBF_FLAGS + 2)), /* Write CRYPTO frames */ 366 SCF_DI_AUTOSWITCH = SMBF_AUTOSWITCH, /* Automatically switch between nocopy 367 * and hash-based to data input for optimal 368 * performance. 369 */ 370 SCF_DISP_RW_ONCE = SMBF_RW_ONCE, 371 SCF_CRITICAL = SMBF_CRITICAL, /* This is a critical stream */ 372 SCF_IETF = SMBF_IETF, 373 SCF_HTTP = SMBF_USE_HEADERS, 374 SCF_CRYPTO = SMBF_CRYPTO, 375 SCF_HEADERS = SMBF_HEADERS, 376}; 377 378 379lsquic_stream_t * 380lsquic_stream_new (lsquic_stream_id_t id, struct lsquic_conn_public *, 381 const struct lsquic_stream_if *, void *stream_if_ctx, 382 unsigned initial_sfrw, uint64_t initial_send_off, 383 enum stream_ctor_flags); 384 385struct lsquic_stream * 386lsquic_stream_new_crypto (enum enc_level, 387 struct lsquic_conn_public *conn_pub, 388 const struct lsquic_stream_if *stream_if, void *stream_if_ctx, 389 enum stream_ctor_flags ctor_flags); 390 391void 392lsquic_stream_call_on_new (lsquic_stream_t *); 393 394void 395lsquic_stream_destroy (lsquic_stream_t *); 396 397/* Any of these flags will cause user-facing read and write and 398 * shutdown calls to return an error. They also make the stream 399 * both readable and writeable, as we want the user to collect 400 * the error. 401 */ 402#define lsquic_stream_is_reset(stream) \ 403 (((stream)->stream_flags & \ 404 (STREAM_RST_RECVD|STREAM_RST_SENT|STREAM_SS_RECVD)) \ 405 || ((stream)->sm_qflags & SMQF_SEND_RST)) 406 407/* Data that from the network gets inserted into the stream using 408 * lsquic_stream_frame_in() function. Returns 0 on success, -1 on 409 * failure. The latter may be caused by flow control violation or 410 * invalid stream frame data, e.g. overlapping segments. 411 * 412 * Note that the caller does gives up control of `frame' no matter 413 * what this function returns. 414 * 415 * This data is read by the user using lsquic_stream_read() function. 416 */ 417int 418lsquic_stream_frame_in (lsquic_stream_t *, struct stream_frame *frame); 419 420/* Only one (at least for now) uncompressed header structure is allowed to be 421 * passed in, and only in HTTP mode. 422 */ 423int 424lsquic_stream_uh_in (lsquic_stream_t *, struct uncompressed_headers *); 425 426void 427lsquic_stream_push_req (lsquic_stream_t *, 428 struct uncompressed_headers *push_req); 429 430int 431lsquic_stream_rst_in (lsquic_stream_t *, uint64_t offset, uint64_t error_code); 432 433void 434lsquic_stream_stop_sending_in (struct lsquic_stream *, uint64_t error_code); 435 436ssize_t 437lsquic_stream_read (lsquic_stream_t *stream, void *buf, size_t len); 438 439uint64_t 440lsquic_stream_read_offset (const lsquic_stream_t *stream); 441 442/* Return true if we sent all available data to the network and write 443 * end of the stream was closed. 444 */ 445int 446lsquic_stream_tosend_fin (const lsquic_stream_t *stream); 447 448/* Data to be sent out to the network is written using lsquic_stream_write(). 449 */ 450ssize_t 451lsquic_stream_write (lsquic_stream_t *stream, const void *buf, size_t len); 452 453void 454lsquic_stream_window_update (lsquic_stream_t *stream, uint64_t offset); 455 456int 457lsquic_stream_set_max_send_off (lsquic_stream_t *stream, uint64_t offset); 458 459/* The caller should only call this function if SMQF_SEND_WUF is set and 460 * it must generate a window update frame using this value. 461 */ 462uint64_t 463lsquic_stream_fc_recv_off (lsquic_stream_t *stream); 464 465void 466lsquic_stream_peer_blocked (struct lsquic_stream *, uint64_t); 467 468void 469lsquic_stream_peer_blocked_gquic (struct lsquic_stream *); 470 471void 472lsquic_stream_dispatch_read_events (lsquic_stream_t *); 473 474void 475lsquic_stream_dispatch_write_events (lsquic_stream_t *); 476 477void 478lsquic_stream_blocked_frame_sent (lsquic_stream_t *); 479 480void 481lsquic_stream_rst_frame_sent (lsquic_stream_t *); 482 483void 484lsquic_stream_stream_frame_sent (lsquic_stream_t *); 485 486void 487lsquic_stream_reset (lsquic_stream_t *, uint64_t error_code); 488 489void 490lsquic_stream_reset_ext (lsquic_stream_t *, uint64_t error_code, int close); 491 492void 493lsquic_stream_call_on_close (lsquic_stream_t *); 494 495void 496lsquic_stream_shutdown_internal (lsquic_stream_t *); 497 498void 499lsquic_stream_received_goaway (lsquic_stream_t *); 500 501void 502lsquic_stream_acked (struct lsquic_stream *, enum quic_frame_type); 503 504#define lsquic_stream_is_closed(s) \ 505 (((s)->stream_flags & (STREAM_U_READ_DONE|STREAM_U_WRITE_DONE)) \ 506 == (STREAM_U_READ_DONE|STREAM_U_WRITE_DONE)) 507int 508lsquic_stream_update_sfcw (lsquic_stream_t *, uint64_t max_off); 509 510int 511lsquic_stream_set_priority_internal (lsquic_stream_t *, unsigned priority); 512 513#define lsquic_stream_is_critical(s) ((s)->sm_bflags & SMBF_CRITICAL) 514 515#define lsquic_stream_is_crypto(s) ((s)->sm_bflags & SMBF_CRYPTO) 516 517size_t 518lsquic_stream_mem_used (const struct lsquic_stream *); 519 520const lsquic_cid_t * 521lsquic_stream_cid (const struct lsquic_stream *); 522 523#define lsquic_stream_has_data_to_flush(stream) ((stream)->sm_n_buffered > 0) 524 525int 526lsquic_stream_readable (struct lsquic_stream *); 527 528size_t 529lsquic_stream_write_avail (struct lsquic_stream *); 530 531void 532lsquic_stream_dump_state (const struct lsquic_stream *); 533 534#ifndef NDEBUG 535size_t 536lsquic_stream_flush_threshold (const struct lsquic_stream *, unsigned); 537#endif 538 539#define crypto_level(stream) (~0ULL - (stream)->id) 540 541void 542lsquic_stream_set_stream_if (struct lsquic_stream *, 543 const struct lsquic_stream_if *, void *stream_if_ctx); 544 545struct qpack_dec_hdl * 546lsquic_stream_get_qdh (const struct lsquic_stream *); 547 548uint64_t 549lsquic_stream_combined_send_off (const struct lsquic_stream *); 550 551/* [draft-ietf-quic-transport-16] Section 3.1 */ 552enum stream_state_sending 553{ 554 SSS_READY, 555 SSS_SEND, 556 SSS_DATA_SENT, 557 SSS_RESET_SENT, 558 SSS_DATA_RECVD, 559 SSS_RESET_RECVD, 560}; 561 562extern const char *const lsquic_sss2str[]; 563 564enum stream_state_sending 565lsquic_stream_sending_state (const struct lsquic_stream *); 566 567/* [draft-ietf-quic-transport-16] Section 3.2 */ 568enum stream_state_receiving 569{ 570 SSR_RECV, 571 SSR_SIZE_KNOWN, 572 SSR_DATA_RECVD, 573 SSR_RESET_RECVD, 574 SSR_DATA_READ, 575 SSR_RESET_READ, 576}; 577 578extern const char *const lsquic_ssr2str[]; 579 580enum stream_state_receiving 581lsquic_stream_receiving_state (struct lsquic_stream *); 582 583uint64_t 584lsquic_stream_fc_recv_off_const (const struct lsquic_stream *); 585 586void 587lsquic_stream_max_stream_data_sent (struct lsquic_stream *); 588 589void 590lsquic_stream_qdec_unblocked (struct lsquic_stream *); 591 592int 593lsquic_stream_can_push (const struct lsquic_stream *); 594 595int 596lsquic_stream_duplicate_push (struct lsquic_stream *, uint64_t push_id); 597 598int 599lsquic_stream_push_promise (struct lsquic_stream *, struct push_promise *); 600 601void 602lsquic_stream_force_finish (struct lsquic_stream *); 603 604int 605lsquic_stream_header_is_pp (const struct lsquic_stream *); 606 607int 608lsquic_stream_header_is_trailer (const struct lsquic_stream *); 609 610int 611lsquic_stream_verify_len (struct lsquic_stream *, unsigned long long); 612 613#endif 614