One Level Up Top Level

src/http/v2/ngx_http_v2.h - nginx-1.31.9 nginx/ @ 2a3a19c6f

Data types defined

Functions defined

Macros defined

Source code

  1. /*
  2. * Copyright (C) Nginx, Inc.
  3. * Copyright (C) Valentin V. Bartenev
  4. */


  7. #ifndef _NGX_HTTP_V2_H_INCLUDED_
  8. ‌#define _NGX_HTTP_V2_H_INCLUDED_


  11. #include <ngx_config.h>
  12. #include <ngx_core.h>
  13. #include <ngx_http.h>


  16. ‌#define NGX_HTTP_V2_ALPN_PROTO           "\x02h2"

  18. ‌#define NGX_HTTP_V2_STATE_BUFFER_SIZE    16

  20. ‌#define NGX_HTTP_V2_DEFAULT_FRAME_SIZE   (1 << 14)
  21. ‌#define NGX_HTTP_V2_MAX_FRAME_SIZE       ((1 << 24) - 1)

  23. ‌#define NGX_HTTP_V2_INT_OCTETS           4
  24. ‌#define NGX_HTTP_V2_MAX_FIELD                                                 \
  25.     (127 + (1 << (NGX_HTTP_V2_INT_OCTETS - 1) * 7) - 1)

  27. ‌#define NGX_HTTP_V2_FRAME_HEADER_SIZE    9

  29. /* frame types */
  30. ‌#define NGX_HTTP_V2_DATA_FRAME             0x00
  31. ‌#define NGX_HTTP_V2_HEADERS_FRAME          0x01
  32. ‌#define NGX_HTTP_V2_PRIORITY_FRAME         0x02
  33. ‌#define NGX_HTTP_V2_RST_STREAM_FRAME       0x03
  34. ‌#define NGX_HTTP_V2_SETTINGS_FRAME         0x04
  35. ‌#define NGX_HTTP_V2_PUSH_PROMISE_FRAME     0x05
  36. ‌#define NGX_HTTP_V2_PING_FRAME             0x06
  37. ‌#define NGX_HTTP_V2_GOAWAY_FRAME           0x07
  38. ‌#define NGX_HTTP_V2_WINDOW_UPDATE_FRAME    0x08
  39. ‌#define NGX_HTTP_V2_CONTINUATION_FRAME     0x09
  40. ‌#define NGX_HTTP_V2_PRIORITY_UPDATE_FRAME  0x10

  42. /* frame flags */
  43. ‌#define NGX_HTTP_V2_NO_FLAG              0x00
  44. ‌#define NGX_HTTP_V2_ACK_FLAG             0x01
  45. ‌#define NGX_HTTP_V2_END_STREAM_FLAG      0x01
  46. ‌#define NGX_HTTP_V2_END_HEADERS_FLAG     0x04
  47. ‌#define NGX_HTTP_V2_PADDED_FLAG          0x08
  48. ‌#define NGX_HTTP_V2_PRIORITY_FLAG        0x20

  50. ‌#define NGX_HTTP_V2_MAX_WINDOW           ((1U << 31) - 1)
  51. ‌#define NGX_HTTP_V2_DEFAULT_WINDOW       65535


  54. ‌typedef struct ngx_http_v2_connection_s   ngx_http_v2_connection_t;
  55. ‌typedef struct ngx_http_v2_node_s         ngx_http_v2_node_t;
  56. ‌typedef struct ngx_http_v2_out_frame_s    ngx_http_v2_out_frame_t;


  59. ‌typedef u_char *(*ngx_http_v2_handler_pt) (ngx_http_v2_connection_t *h2c,
  60.     u_char *pos, u_char *end);


  63. ‌typedef struct {
  64.     ngx_flag_t                       enable;
  65.     size_t                           pool_size;
  66.     ngx_uint_t                       concurrent_streams;
  67.     size_t                           preread_size;
  68.     ngx_uint_t                       streams_index_mask;
  69. ‌} ngx_http_v2_srv_conf_t;


  72. ‌typedef struct {
  73.     ngx_str_t                        name;
  74.     ngx_str_t                        value;
  75. ‌} ngx_http_v2_header_t;


  78. ‌typedef struct {
  79.     ngx_uint_t                       sid;
  80.     size_t                           length;
  81.     size_t                           padding;
  82.     ssize_t                          window_delta;
  83.     unsigned                         flags:8;

  85.     unsigned                         incomplete:1;
  86.     unsigned                         keep_pool:1;

  88.     /* HPACK */
  89.     unsigned                         parse_name:1;
  90.     unsigned                         parse_value:1;
  91.     unsigned                         index:1;
  92.     ngx_http_v2_header_t             header;
  93.     size_t                           header_limit;
  94.     u_char                           field_state;
  95.     u_char                          *field_start;
  96.     u_char                          *field_end;
  97.     size_t                           field_rest;
  98.     ngx_pool_t                      *pool;

  100.     ngx_http_v2_stream_t            *stream;

  102.     u_char                           buffer[NGX_HTTP_V2_STATE_BUFFER_SIZE];
  103.     size_t                           buffer_used;
  104.     ngx_http_v2_handler_pt           handler;
  105. ‌} ngx_http_v2_state_t;



  109. ‌typedef struct {
  110.     ngx_http_v2_header_t           **entries;

  112.     ngx_uint_t                       added;
  113.     ngx_uint_t                       deleted;
  114.     ngx_uint_t                       reused;
  115.     ngx_uint_t                       allocated;

  117.     size_t                           size;
  118.     size_t                           free;
  119.     u_char                          *storage;
  120.     u_char                          *pos;
  121. ‌} ngx_http_v2_hpack_t;


  124. ‌struct ngx_http_v2_connection_s {
  125.     ngx_connection_t                *connection;
  126.     ngx_http_connection_t           *http_connection;

  128.     off_t                            total_bytes;
  129.     off_t                            payload_bytes;

  131.     ngx_uint_t                       processing;
  132.     ngx_uint_t                       frames;
  133.     ngx_uint_t                       idle;
  134.     ngx_uint_t                       new_streams;
  135.     ngx_uint_t                       refused_streams;

  137.     size_t                           send_window;
  138.     size_t                           recv_window;
  139.     size_t                           init_window;

  141.     size_t                           frame_size;

  143.     ngx_queue_t                      waiting;

  145.     ngx_http_v2_state_t              state;

  147.     ngx_http_v2_hpack_t              hpack;

  149.     ngx_pool_t                      *pool;

  151.     ngx_http_v2_out_frame_t         *free_frames;
  152.     ngx_connection_t                *free_fake_connections;

  154.     ngx_http_v2_node_t             **streams_index;

  156.     ngx_http_v2_out_frame_t         *last_out;

  158.     ngx_queue_t                      closed;

  160.     ngx_uint_t                       closed_nodes;
  161.     ngx_uint_t                       last_sid;

  163.     time_t                           lingering_time;

  165.     unsigned                         settings_ack:1;
  166.     unsigned                         table_update:1;
  167.     unsigned                         blocked:1;
  168.     unsigned                         goaway:1;
  169. };


  172. ‌struct ngx_http_v2_node_s {
  173.     ngx_uint_t                       id;
  174.     ngx_http_v2_node_t              *index;
  175.     ngx_queue_t                      reuse;
  176.     ngx_http_v2_stream_t            *stream;
  177.     ngx_http_priority_t              priority;
  178.     ngx_uint_t                       priority_set; /* unsigned priority_set:1 */
  179. };


  182. ‌struct ngx_http_v2_stream_s {
  183.     ngx_http_request_t              *request;
  184.     ngx_http_v2_connection_t        *connection;
  185.     ngx_http_v2_node_t              *node;

  187.     ngx_uint_t                       queued;

  189.     /*
  190.      * A change to SETTINGS_INITIAL_WINDOW_SIZE could cause the
  191.      * send_window to become negative, hence it's signed.
  192.      */
  193.     ssize_t                          send_window;
  194.     size_t                           recv_window;

  196.     ngx_buf_t                       *preread;

  198.     ngx_uint_t                       frames;

  200.     ngx_http_v2_out_frame_t         *free_frames;
  201.     ngx_chain_t                     *free_frame_headers;
  202.     ngx_chain_t                     *free_bufs;

  204.     ngx_queue_t                      queue;

  206.     ngx_array_t                     *cookies;
  207.     ngx_array_t                     *priorities;

  209.     ngx_http_priority_state_t        priority;

  211.     ngx_pool_t                      *pool;

  213.     unsigned                         initialized:1;
  214.     unsigned                         waiting:1;
  215.     unsigned                         blocked:1;
  216.     unsigned                         exhausted:1;
  217.     unsigned                         in_closed:1;
  218.     unsigned                         out_closed:1;
  219.     unsigned                         rst_sent:1;
  220.     unsigned                         no_flow_control:1;
  221.     unsigned                         skip_data:1;
  222.     unsigned                         priority_update:1;
  223. };


  226. ‌struct ngx_http_v2_out_frame_s {
  227.     ngx_http_v2_out_frame_t         *next;
  228.     ngx_chain_t                     *first;
  229.     ngx_chain_t                     *last;
  230.     ngx_int_t                      (*handler)(ngx_http_v2_connection_t *h2c,
  231.                                         ngx_http_v2_out_frame_t *frame);

  233.     ngx_http_v2_stream_t            *stream;
  234.     size_t                           length;

  236.     unsigned                         blocked:1;
  237.     unsigned                         fin:1;
  238. };


  241. /* a non-incremental response completes sooner, equal priority is FIFO */

  243. static ngx_inline ngx_uint_t
  244. ‌ngx_http_v2_stream_precedes(ngx_http_v2_stream_t *s,
  245.     ngx_http_v2_stream_t *stream)
  246. {
  247.     ngx_http_priority_t  *a, *b;

  249.     a = &s->priority.effective;
  250.     b = &stream->priority.effective;

  252.     if (a->urgency != b->urgency) {
  253.         return a->urgency < b->urgency;
  254.     }

  256.     if (a->incremental != b->incremental) {
  257.         return !a->incremental;
  258.     }

  260.     return s->node->id <= stream->node->id;
  261. }


  264. /* all frames of a stream are queued at the same position */

  266. static ngx_inline ngx_http_v2_out_frame_t **
  267. ‌ngx_http_v2_queue_position(ngx_http_v2_connection_t *h2c,
  268.     ngx_http_v2_stream_t *stream)
  269. {
  270.     ngx_http_v2_out_frame_t  **out;

  272.     for (out = &h2c->last_out; *out; out = &(*out)->next) {

  274.         if ((*out)->blocked || (*out)->stream == NULL) {
  275.             break;
  276.         }

  278.         if (ngx_http_v2_stream_precedes((*out)->stream, stream)) {
  279.             break;
  280.         }
  281.     }

  283.     return out;
  284. }


  287. static ngx_inline void
  288. ‌ngx_http_v2_queue_frame(ngx_http_v2_out_frame_t **out,
  289.     ngx_http_v2_out_frame_t *frame)
  290. {
  291.     frame->next = *out;
  292.     *out = frame;
  293. }


  296. static ngx_inline void
  297. ‌ngx_http_v2_queue_blocked_frame(ngx_http_v2_connection_t *h2c,
  298.     ngx_http_v2_out_frame_t *frame)
  299. {
  300.     ngx_http_v2_out_frame_t  **out;

  302.     for (out = &h2c->last_out; *out; out = &(*out)->next) {

  304.         if ((*out)->blocked || (*out)->stream == NULL) {
  305.             break;
  306.         }
  307.     }

  309.     frame->next = *out;
  310.     *out = frame;
  311. }


  314. static ngx_inline void
  315. ‌ngx_http_v2_queue_ordered_frame(ngx_http_v2_connection_t *h2c,
  316.     ngx_http_v2_out_frame_t *frame)
  317. {
  318.     frame->next = h2c->last_out;
  319.     h2c->last_out = frame;
  320. }


  323. void ngx_http_v2_init(ngx_event_t *rev);

  325. ngx_int_t ngx_http_v2_read_request_body(ngx_http_request_t *r);
  326. ngx_int_t ngx_http_v2_read_unbuffered_request_body(ngx_http_request_t *r);

  328. void ngx_http_v2_close_stream(ngx_http_v2_stream_t *stream, ngx_int_t rc);

  330. ngx_int_t ngx_http_v2_send_output_queue(ngx_http_v2_connection_t *h2c);


  333. ngx_str_t *ngx_http_v2_get_static_name(ngx_uint_t index);
  334. ngx_str_t *ngx_http_v2_get_static_value(ngx_uint_t index);

  336. ngx_int_t ngx_http_v2_get_indexed_header(ngx_http_v2_connection_t *h2c,
  337.     ngx_uint_t index, ngx_uint_t name_only);
  338. ngx_int_t ngx_http_v2_add_header(ngx_http_v2_connection_t *h2c,
  339.     ngx_http_v2_header_t *header);
  340. ngx_int_t ngx_http_v2_table_size(ngx_http_v2_connection_t *h2c, size_t size);


  343. ‌#define ngx_http_v2_prefix(bits)  ((1 << (bits)) - 1)


  346. #if (NGX_HAVE_NONALIGNED)

  348. ‌#define ngx_http_v2_parse_uint16(p)  ntohs(*(uint16_t *) (p))
  349. ‌#define ngx_http_v2_parse_uint32(p)  ntohl(*(uint32_t *) (p))

  351. #else

  353. ‌#define ngx_http_v2_parse_uint16(p)  ((p)[0] << 8 | (p)[1])
  354. ‌#define ngx_http_v2_parse_uint32(p)                                           \
  355.     ((uint32_t) (p)[0] << 24 | (p)[1] << 16 | (p)[2] << 8 | (p)[3])

  357. #endif

  359. ‌#define ngx_http_v2_parse_length(p)  ((p) >> 8)
  360. ‌#define ngx_http_v2_parse_type(p)    ((p) & 0xff)
  361. ‌#define ngx_http_v2_parse_sid(p)     (ngx_http_v2_parse_uint32(p) & 0x7fffffff)
  362. ‌#define ngx_http_v2_parse_window(p)  (ngx_http_v2_parse_uint32(p) & 0x7fffffff)


  365. ‌#define ngx_http_v2_write_uint16_aligned(p, s)                                \
  366.     (*(uint16_t *) (p) = htons((uint16_t) (s)), (p) + sizeof(uint16_t))
  367. ‌#define ngx_http_v2_write_uint32_aligned(p, s)                                \
  368.     (*(uint32_t *) (p) = htonl((uint32_t) (s)), (p) + sizeof(uint32_t))

  370. #if (NGX_HAVE_NONALIGNED)

  372. ‌#define ngx_http_v2_write_uint16  ngx_http_v2_write_uint16_aligned
  373. ‌#define ngx_http_v2_write_uint32  ngx_http_v2_write_uint32_aligned

  375. #else

  377. ‌#define ngx_http_v2_write_uint16(p, s)                                        \
  378.     ((p)[0] = (u_char) ((s) >> 8),                                            \
  379.      (p)[1] = (u_char)  (s),                                                  \
  380.      (p) + sizeof(uint16_t))

  382. ‌#define ngx_http_v2_write_uint32(p, s)                                        \
  383.     ((p)[0] = (u_char) ((s) >> 24),                                           \
  384.      (p)[1] = (u_char) ((s) >> 16),                                           \
  385.      (p)[2] = (u_char) ((s) >> 8),                                            \
  386.      (p)[3] = (u_char)  (s),                                                  \
  387.      (p) + sizeof(uint32_t))

  389. #endif

  391. ‌#define ngx_http_v2_write_len_and_type(p, l, t)                               \
  392.     ngx_http_v2_write_uint32_aligned(p, (l) << 8 | (t))

  394. ‌#define ngx_http_v2_write_sid  ngx_http_v2_write_uint32


  397. ‌#define ngx_http_v2_indexed(i)      (128 + (i))
  398. ‌#define ngx_http_v2_inc_indexed(i)  (64 + (i))

  400. ‌#define ngx_http_v2_write_name(dst, src, len, tmp)                            \
  401.     ngx_http_v2_string_encode(dst, src, len, tmp, 1)
  402. ‌#define ngx_http_v2_write_value(dst, src, len, tmp)                           \
  403.     ngx_http_v2_string_encode(dst, src, len, tmp, 0)

  405. ‌#define NGX_HTTP_V2_ENCODE_RAW            0
  406. ‌#define NGX_HTTP_V2_ENCODE_HUFF           0x80

  408. ‌#define NGX_HTTP_V2_AUTHORITY_INDEX       1

  410. ‌#define NGX_HTTP_V2_METHOD_INDEX          2
  411. ‌#define NGX_HTTP_V2_METHOD_GET_INDEX      2
  412. ‌#define NGX_HTTP_V2_METHOD_POST_INDEX     3

  414. ‌#define NGX_HTTP_V2_PATH_INDEX            4
  415. ‌#define NGX_HTTP_V2_PATH_ROOT_INDEX       4

  417. ‌#define NGX_HTTP_V2_SCHEME_HTTP_INDEX     6
  418. ‌#define NGX_HTTP_V2_SCHEME_HTTPS_INDEX    7

  420. ‌#define NGX_HTTP_V2_STATUS_INDEX          8
  421. ‌#define NGX_HTTP_V2_STATUS_200_INDEX      8
  422. ‌#define NGX_HTTP_V2_STATUS_204_INDEX      9
  423. ‌#define NGX_HTTP_V2_STATUS_206_INDEX      10
  424. ‌#define NGX_HTTP_V2_STATUS_304_INDEX      11
  425. ‌#define NGX_HTTP_V2_STATUS_400_INDEX      12
  426. ‌#define NGX_HTTP_V2_STATUS_404_INDEX      13
  427. ‌#define NGX_HTTP_V2_STATUS_500_INDEX      14

  429. ‌#define NGX_HTTP_V2_CONTENT_LENGTH_INDEX  28
  430. ‌#define NGX_HTTP_V2_CONTENT_TYPE_INDEX    31
  431. ‌#define NGX_HTTP_V2_DATE_INDEX            33
  432. ‌#define NGX_HTTP_V2_LAST_MODIFIED_INDEX   44
  433. ‌#define NGX_HTTP_V2_LOCATION_INDEX        46
  434. ‌#define NGX_HTTP_V2_SERVER_INDEX          54
  435. ‌#define NGX_HTTP_V2_VARY_INDEX            59

  437. ‌#define NGX_HTTP_V2_PREFACE_START         "PRI * HTTP/2.0\r\n"
  438. ‌#define NGX_HTTP_V2_PREFACE_END           "\r\nSM\r\n\r\n"
  439. ‌#define NGX_HTTP_V2_PREFACE               NGX_HTTP_V2_PREFACE_START           \
  440.                                           NGX_HTTP_V2_PREFACE_END


  443. u_char *ngx_http_v2_string_encode(u_char *dst, u_char *src, size_t len,
  444.     u_char *tmp, ngx_uint_t lower);


  447. extern ngx_module_t  ngx_http_v2_module;


  450. #endif /* _NGX_HTTP_V2_H_INCLUDED_ */

One Level Up Top Level