One Level Up Top Level

src/http/v3/ngx_http_v3.h - nginx source code

Data types defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Roman Arutyunyan
  4. * Copyright (C) Nginx, Inc.
  5. */


  8. #ifndef _NGX_HTTP_V3_H_INCLUDED_
  9. ‌#define _NGX_HTTP_V3_H_INCLUDED_


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

  16. #include <ngx_http_v3_parse.h>
  17. #include <ngx_http_v3_encode.h>
  18. #include <ngx_http_v3_uni.h>
  19. #include <ngx_http_v3_table.h>


  22. ‌#define NGX_HTTP_V3_ALPN_PROTO                     "\x02h3"
  23. ‌#define NGX_HTTP_V3_HQ_ALPN_PROTO                  "\x0Ahq-interop"
  24. ‌#define NGX_HTTP_V3_HQ_PROTO                       "hq-interop"

  26. ‌#define NGX_HTTP_V3_VARLEN_INT_LEN                 4
  27. ‌#define NGX_HTTP_V3_PREFIX_INT_LEN                 11

  29. ‌#define NGX_HTTP_V3_STREAM_CONTROL                 0x00
  30. ‌#define NGX_HTTP_V3_STREAM_PUSH                    0x01
  31. ‌#define NGX_HTTP_V3_STREAM_ENCODER                 0x02
  32. ‌#define NGX_HTTP_V3_STREAM_DECODER                 0x03

  34. ‌#define NGX_HTTP_V3_FRAME_DATA                     0x00
  35. ‌#define NGX_HTTP_V3_FRAME_HEADERS                  0x01
  36. ‌#define NGX_HTTP_V3_FRAME_CANCEL_PUSH              0x03
  37. ‌#define NGX_HTTP_V3_FRAME_SETTINGS                 0x04
  38. ‌#define NGX_HTTP_V3_FRAME_PUSH_PROMISE             0x05
  39. ‌#define NGX_HTTP_V3_FRAME_GOAWAY                   0x07
  40. ‌#define NGX_HTTP_V3_FRAME_MAX_PUSH_ID              0x0d

  42. ‌#define NGX_HTTP_V3_PARAM_MAX_TABLE_CAPACITY       0x01
  43. ‌#define NGX_HTTP_V3_PARAM_MAX_FIELD_SECTION_SIZE   0x06
  44. ‌#define NGX_HTTP_V3_PARAM_BLOCKED_STREAMS          0x07

  46. ‌#define NGX_HTTP_V3_MAX_TABLE_CAPACITY             4096

  48. ‌#define NGX_HTTP_V3_STREAM_CLIENT_CONTROL          0
  49. ‌#define NGX_HTTP_V3_STREAM_SERVER_CONTROL          1
  50. ‌#define NGX_HTTP_V3_STREAM_CLIENT_ENCODER          2
  51. ‌#define NGX_HTTP_V3_STREAM_SERVER_ENCODER          3
  52. ‌#define NGX_HTTP_V3_STREAM_CLIENT_DECODER          4
  53. ‌#define NGX_HTTP_V3_STREAM_SERVER_DECODER          5
  54. ‌#define NGX_HTTP_V3_MAX_KNOWN_STREAM               6
  55. ‌#define NGX_HTTP_V3_MAX_UNI_STREAMS                3

  57. /* HTTP/3 errors */
  58. ‌#define NGX_HTTP_V3_ERR_NO_ERROR                   0x100
  59. ‌#define NGX_HTTP_V3_ERR_GENERAL_PROTOCOL_ERROR     0x101
  60. ‌#define NGX_HTTP_V3_ERR_INTERNAL_ERROR             0x102
  61. ‌#define NGX_HTTP_V3_ERR_STREAM_CREATION_ERROR      0x103
  62. ‌#define NGX_HTTP_V3_ERR_CLOSED_CRITICAL_STREAM     0x104
  63. ‌#define NGX_HTTP_V3_ERR_FRAME_UNEXPECTED           0x105
  64. ‌#define NGX_HTTP_V3_ERR_FRAME_ERROR                0x106
  65. ‌#define NGX_HTTP_V3_ERR_EXCESSIVE_LOAD             0x107
  66. ‌#define NGX_HTTP_V3_ERR_ID_ERROR                   0x108
  67. ‌#define NGX_HTTP_V3_ERR_SETTINGS_ERROR             0x109
  68. ‌#define NGX_HTTP_V3_ERR_MISSING_SETTINGS           0x10a
  69. ‌#define NGX_HTTP_V3_ERR_REQUEST_REJECTED           0x10b
  70. ‌#define NGX_HTTP_V3_ERR_REQUEST_CANCELLED          0x10c
  71. ‌#define NGX_HTTP_V3_ERR_REQUEST_INCOMPLETE         0x10d
  72. ‌#define NGX_HTTP_V3_ERR_CONNECT_ERROR              0x10f
  73. ‌#define NGX_HTTP_V3_ERR_VERSION_FALLBACK           0x110

  75. /* QPACK errors */
  76. ‌#define NGX_HTTP_V3_ERR_DECOMPRESSION_FAILED       0x200
  77. ‌#define NGX_HTTP_V3_ERR_ENCODER_STREAM_ERROR       0x201
  78. ‌#define NGX_HTTP_V3_ERR_DECODER_STREAM_ERROR       0x202


  81. ‌#define ngx_http_v3_get_session(c)                                            \
  82.     ((ngx_http_v3_session_t *) ((c)->quic ? (c)->quic->parent->data           \
  83.                                           : (c)->data))

  85. ‌#define ngx_http_quic_get_connection(c)                                       \
  86.     (ngx_http_v3_get_session(c)->http_connection)

  88. ‌#define ngx_http_v3_get_module_loc_conf(c, module)                            \
  89.     ngx_http_get_module_loc_conf(ngx_http_quic_get_connection(c)->conf_ctx,   \
  90.                                  module)

  92. ‌#define ngx_http_v3_get_module_srv_conf(c, module)                            \
  93.     ngx_http_get_module_srv_conf(ngx_http_quic_get_connection(c)->conf_ctx,   \
  94.                                  module)

  96. ‌#define ngx_http_v3_finalize_connection(c, code, reason)                      \
  97.     ngx_quic_finalize_connection((c)->quic ? (c)->quic->parent : (c),         \
  98.                                  code, reason)

  100. ‌#define ngx_http_v3_shutdown_connection(c, code, reason)                      \
  101.     ngx_quic_shutdown_connection((c)->quic ? (c)->quic->parent : (c),         \
  102.                                  code, reason)


  105. ‌typedef struct {
  106.     ngx_flag_t                    enable;
  107.     ngx_flag_t                    enable_hq;
  108.     size_t                        max_table_capacity;
  109.     ngx_uint_t                    max_blocked_streams;
  110.     ngx_uint_t                    max_concurrent_streams;
  111.     ngx_quic_conf_t               quic;
  112. ‌} ngx_http_v3_srv_conf_t;


  115. ‌struct ngx_http_v3_parse_s {
  116.     size_t                        header_limit;
  117.     ngx_http_v3_parse_headers_t   headers;
  118.     ngx_http_v3_parse_data_t      body;
  119.     ngx_array_t                  *cookies;
  120. };


  123. ‌struct ngx_http_v3_session_s {
  124.     ngx_http_connection_t        *http_connection;

  126.     ngx_http_v3_dynamic_table_t   table;

  128.     ngx_event_t                   keepalive;
  129.     ngx_uint_t                    nrequests;

  131.     ngx_queue_t                   blocked;
  132.     ngx_uint_t                    nblocked;

  134.     uint64_t                      next_request_id;

  136.     off_t                         total_bytes;
  137.     off_t                         payload_bytes;

  139.     unsigned                      goaway:1;
  140.     unsigned                      hq:1;

  142.     ngx_connection_t             *known_streams[NGX_HTTP_V3_MAX_KNOWN_STREAM];
  143. };


  146. void ngx_http_v3_init_stream(ngx_connection_t *c);
  147. void ngx_http_v3_reset_stream(ngx_connection_t *c);
  148. ngx_int_t ngx_http_v3_init_session(ngx_connection_t *c);
  149. ngx_int_t ngx_http_v3_check_flood(ngx_connection_t *c);
  150. ngx_int_t ngx_http_v3_init(ngx_connection_t *c);
  151. void ngx_http_v3_shutdown(ngx_connection_t *c);

  153. ngx_int_t ngx_http_v3_read_request_body(ngx_http_request_t *r);
  154. ngx_int_t ngx_http_v3_read_unbuffered_request_body(ngx_http_request_t *r);


  157. extern ngx_module_t  ngx_http_v3_module;


  160. #endif /* _NGX_HTTP_V3_H_INCLUDED_ */

One Level Up Top Level