One Level Up Top Level

src/http/v2/ngx_http_v2.h - nginx source code

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           0x0
  31. ‌#define NGX_HTTP_V2_HEADERS_FRAME        0x1
  32. ‌#define NGX_HTTP_V2_PRIORITY_FRAME       0x2
  33. ‌#define NGX_HTTP_V2_RST_STREAM_FRAME     0x3
  34. ‌#define NGX_HTTP_V2_SETTINGS_FRAME       0x4
  35. ‌#define NGX_HTTP_V2_PUSH_PROMISE_FRAME   0x5
  36. ‌#define NGX_HTTP_V2_PING_FRAME           0x6
  37. ‌#define NGX_HTTP_V2_GOAWAY_FRAME         0x7
  38. ‌#define NGX_HTTP_V2_WINDOW_UPDATE_FRAME  0x8
  39. ‌#define NGX_HTTP_V2_CONTINUATION_FRAME   0x9

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

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

  52. ‌#define NGX_HTTP_V2_DEFAULT_WEIGHT       16


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


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


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


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


  79. ‌typedef struct {
  80.     ngx_uint_t                       sid;
  81.     size_t                           length;
  82.     size_t                           padding;
  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;
  136.     ngx_uint_t                       priority_limit;

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

  142.     size_t                           frame_size;

  144.     ngx_queue_t                      waiting;

  146.     ngx_http_v2_state_t              state;

  148.     ngx_http_v2_hpack_t              hpack;

  150.     ngx_pool_t                      *pool;

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

  155.     ngx_http_v2_node_t             **streams_index;

  157.     ngx_http_v2_out_frame_t         *last_out;

  159.     ngx_queue_t                      dependencies;
  160.     ngx_queue_t                      closed;

  162.     ngx_uint_t                       closed_nodes;
  163.     ngx_uint_t                       last_sid;

  165.     time_t                           lingering_time;

  167.     unsigned                         settings_ack:1;
  168.     unsigned                         table_update:1;
  169.     unsigned                         blocked:1;
  170.     unsigned                         goaway:1;
  171. };


  174. ‌struct ngx_http_v2_node_s {
  175.     ngx_uint_t                       id;
  176.     ngx_http_v2_node_t              *index;
  177.     ngx_http_v2_node_t              *parent;
  178.     ngx_queue_t                      queue;
  179.     ngx_queue_t                      children;
  180.     ngx_queue_t                      reuse;
  181.     ngx_uint_t                       rank;
  182.     ngx_uint_t                       weight;
  183.     double                           rel_weight;
  184.     ngx_http_v2_stream_t            *stream;
  185. };


  188. ‌struct ngx_http_v2_stream_s {
  189.     ngx_http_request_t              *request;
  190.     ngx_http_v2_connection_t        *connection;
  191.     ngx_http_v2_node_t              *node;

  193.     ngx_uint_t                       queued;

  195.     /*
  196.      * A change to SETTINGS_INITIAL_WINDOW_SIZE could cause the
  197.      * send_window to become negative, hence it's signed.
  198.      */
  199.     ssize_t                          send_window;
  200.     size_t                           recv_window;

  202.     ngx_buf_t                       *preread;

  204.     ngx_uint_t                       frames;

  206.     ngx_http_v2_out_frame_t         *free_frames;
  207.     ngx_chain_t                     *free_frame_headers;
  208.     ngx_chain_t                     *free_bufs;

  210.     ngx_queue_t                      queue;

  212.     ngx_array_t                     *cookies;

  214.     ngx_pool_t                      *pool;

  216.     unsigned                         waiting:1;
  217.     unsigned                         blocked:1;
  218.     unsigned                         exhausted:1;
  219.     unsigned                         in_closed:1;
  220.     unsigned                         out_closed:1;
  221.     unsigned                         rst_sent:1;
  222.     unsigned                         no_flow_control:1;
  223.     unsigned                         skip_data:1;
  224. };


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

  234.     ngx_http_v2_stream_t            *stream;
  235.     size_t                           length;

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


  242. static ngx_inline void
  243. ‌ngx_http_v2_queue_frame(ngx_http_v2_connection_t *h2c,
  244.     ngx_http_v2_out_frame_t *frame)
  245. {
  246.     ngx_http_v2_out_frame_t  **out;

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

  250.         if ((*out)->blocked || (*out)->stream == NULL) {
  251.             break;
  252.         }

  254.         if ((*out)->stream->node->rank < frame->stream->node->rank
  255.             || ((*out)->stream->node->rank == frame->stream->node->rank
  256.                 && (*out)->stream->node->rel_weight
  257.                    >= frame->stream->node->rel_weight))
  258.         {
  259.             break;
  260.         }
  261.     }

  263.     frame->next = *out;
  264.     *out = frame;
  265. }


  268. static ngx_inline void
  269. ‌ngx_http_v2_queue_blocked_frame(ngx_http_v2_connection_t *h2c,
  270.     ngx_http_v2_out_frame_t *frame)
  271. {
  272.     ngx_http_v2_out_frame_t  **out;

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

  276.         if ((*out)->blocked || (*out)->stream == NULL) {
  277.             break;
  278.         }
  279.     }

  281.     frame->next = *out;
  282.     *out = frame;
  283. }


  286. static ngx_inline void
  287. ‌ngx_http_v2_queue_ordered_frame(ngx_http_v2_connection_t *h2c,
  288.     ngx_http_v2_out_frame_t *frame)
  289. {
  290.     frame->next = h2c->last_out;
  291.     h2c->last_out = frame;
  292. }


  295. void ngx_http_v2_init(ngx_event_t *rev);

  297. ngx_int_t ngx_http_v2_read_request_body(ngx_http_request_t *r);
  298. ngx_int_t ngx_http_v2_read_unbuffered_request_body(ngx_http_request_t *r);

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

  302. ngx_int_t ngx_http_v2_send_output_queue(ngx_http_v2_connection_t *h2c);


  305. ngx_str_t *ngx_http_v2_get_static_name(ngx_uint_t index);
  306. ngx_str_t *ngx_http_v2_get_static_value(ngx_uint_t index);

  308. ngx_int_t ngx_http_v2_get_indexed_header(ngx_http_v2_connection_t *h2c,
  309.     ngx_uint_t index, ngx_uint_t name_only);
  310. ngx_int_t ngx_http_v2_add_header(ngx_http_v2_connection_t *h2c,
  311.     ngx_http_v2_header_t *header);
  312. ngx_int_t ngx_http_v2_table_size(ngx_http_v2_connection_t *h2c, size_t size);


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


  318. #if (NGX_HAVE_NONALIGNED)

  320. ‌#define ngx_http_v2_parse_uint16(p)  ntohs(*(uint16_t *) (p))
  321. ‌#define ngx_http_v2_parse_uint32(p)  ntohl(*(uint32_t *) (p))

  323. #else

  325. ‌#define ngx_http_v2_parse_uint16(p)  ((p)[0] << 8 | (p)[1])
  326. ‌#define ngx_http_v2_parse_uint32(p)                                           \
  327.     ((uint32_t) (p)[0] << 24 | (p)[1] << 16 | (p)[2] << 8 | (p)[3])

  329. #endif

  331. ‌#define ngx_http_v2_parse_length(p)  ((p) >> 8)
  332. ‌#define ngx_http_v2_parse_type(p)    ((p) & 0xff)
  333. ‌#define ngx_http_v2_parse_sid(p)     (ngx_http_v2_parse_uint32(p) & 0x7fffffff)
  334. ‌#define ngx_http_v2_parse_window(p)  (ngx_http_v2_parse_uint32(p) & 0x7fffffff)


  337. ‌#define ngx_http_v2_write_uint16_aligned(p, s)                                \
  338.     (*(uint16_t *) (p) = htons((uint16_t) (s)), (p) + sizeof(uint16_t))
  339. ‌#define ngx_http_v2_write_uint32_aligned(p, s)                                \
  340.     (*(uint32_t *) (p) = htonl((uint32_t) (s)), (p) + sizeof(uint32_t))

  342. #if (NGX_HAVE_NONALIGNED)

  344. ‌#define ngx_http_v2_write_uint16  ngx_http_v2_write_uint16_aligned
  345. ‌#define ngx_http_v2_write_uint32  ngx_http_v2_write_uint32_aligned

  347. #else

  349. ‌#define ngx_http_v2_write_uint16(p, s)                                        \
  350.     ((p)[0] = (u_char) ((s) >> 8),                                            \
  351.      (p)[1] = (u_char)  (s),                                                  \
  352.      (p) + sizeof(uint16_t))

  354. ‌#define ngx_http_v2_write_uint32(p, s)                                        \
  355.     ((p)[0] = (u_char) ((s) >> 24),                                           \
  356.      (p)[1] = (u_char) ((s) >> 16),                                           \
  357.      (p)[2] = (u_char) ((s) >> 8),                                            \
  358.      (p)[3] = (u_char)  (s),                                                  \
  359.      (p) + sizeof(uint32_t))

  361. #endif

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

  366. ‌#define ngx_http_v2_write_sid  ngx_http_v2_write_uint32


  369. ‌#define ngx_http_v2_indexed(i)      (128 + (i))
  370. ‌#define ngx_http_v2_inc_indexed(i)  (64 + (i))

  372. ‌#define ngx_http_v2_write_name(dst, src, len, tmp)                            \
  373.     ngx_http_v2_string_encode(dst, src, len, tmp, 1)
  374. ‌#define ngx_http_v2_write_value(dst, src, len, tmp)                           \
  375.     ngx_http_v2_string_encode(dst, src, len, tmp, 0)

  377. ‌#define NGX_HTTP_V2_ENCODE_RAW            0
  378. ‌#define NGX_HTTP_V2_ENCODE_HUFF           0x80

  380. ‌#define NGX_HTTP_V2_AUTHORITY_INDEX       1

  382. ‌#define NGX_HTTP_V2_METHOD_INDEX          2
  383. ‌#define NGX_HTTP_V2_METHOD_GET_INDEX      2
  384. ‌#define NGX_HTTP_V2_METHOD_POST_INDEX     3

  386. ‌#define NGX_HTTP_V2_PATH_INDEX            4
  387. ‌#define NGX_HTTP_V2_PATH_ROOT_INDEX       4

  389. ‌#define NGX_HTTP_V2_SCHEME_HTTP_INDEX     6
  390. ‌#define NGX_HTTP_V2_SCHEME_HTTPS_INDEX    7

  392. ‌#define NGX_HTTP_V2_STATUS_INDEX          8
  393. ‌#define NGX_HTTP_V2_STATUS_200_INDEX      8
  394. ‌#define NGX_HTTP_V2_STATUS_204_INDEX      9
  395. ‌#define NGX_HTTP_V2_STATUS_206_INDEX      10
  396. ‌#define NGX_HTTP_V2_STATUS_304_INDEX      11
  397. ‌#define NGX_HTTP_V2_STATUS_400_INDEX      12
  398. ‌#define NGX_HTTP_V2_STATUS_404_INDEX      13
  399. ‌#define NGX_HTTP_V2_STATUS_500_INDEX      14

  401. ‌#define NGX_HTTP_V2_CONTENT_LENGTH_INDEX  28
  402. ‌#define NGX_HTTP_V2_CONTENT_TYPE_INDEX    31
  403. ‌#define NGX_HTTP_V2_DATE_INDEX            33
  404. ‌#define NGX_HTTP_V2_LAST_MODIFIED_INDEX   44
  405. ‌#define NGX_HTTP_V2_LOCATION_INDEX        46
  406. ‌#define NGX_HTTP_V2_SERVER_INDEX          54
  407. ‌#define NGX_HTTP_V2_VARY_INDEX            59

  409. ‌#define NGX_HTTP_V2_PREFACE_START         "PRI * HTTP/2.0\r\n"
  410. ‌#define NGX_HTTP_V2_PREFACE_END           "\r\nSM\r\n\r\n"
  411. ‌#define NGX_HTTP_V2_PREFACE               NGX_HTTP_V2_PREFACE_START           \
  412.                                           NGX_HTTP_V2_PREFACE_END


  415. u_char *ngx_http_v2_string_encode(u_char *dst, u_char *src, size_t len,
  416.     u_char *tmp, ngx_uint_t lower);


  419. extern ngx_module_t  ngx_http_v2_module;


  422. #endif /* _NGX_HTTP_V2_H_INCLUDED_ */

One Level Up Top Level