annotate src/event/quic/ngx_event_quic.h @ 8862:c2f5d79cde64 quic

QUIC: separate UDP framework for QUIC. Previously, QUIC used the existing UDP framework, which was created for UDP in Stream. However the way QUIC connections are created and looked up is different from the way UDP connections in Stream are created and looked up. Now these two implementations are decoupled.
author Roman Arutyunyan <arut@nginx.com>
date Wed, 20 Apr 2022 16:01:17 +0400
parents 55b38514729b
children 37d5dddabaea
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7633
5d91389e0fd3 Initial QUIC support in http.
Sergey Kandaurov <pluknet@nginx.com>
parents:
diff changeset
1
5d91389e0fd3 Initial QUIC support in http.
Sergey Kandaurov <pluknet@nginx.com>
parents:
diff changeset
2 /*
7648
b28ea685a56e Moved all QUIC code into ngx_event_quic.c
Vladimir Homutov <vl@nginx.com>
parents: 7647
diff changeset
3 * Copyright (C) Nginx, Inc.
7633
5d91389e0fd3 Initial QUIC support in http.
Sergey Kandaurov <pluknet@nginx.com>
parents:
diff changeset
4 */
5d91389e0fd3 Initial QUIC support in http.
Sergey Kandaurov <pluknet@nginx.com>
parents:
diff changeset
5
5d91389e0fd3 Initial QUIC support in http.
Sergey Kandaurov <pluknet@nginx.com>
parents:
diff changeset
6
5d91389e0fd3 Initial QUIC support in http.
Sergey Kandaurov <pluknet@nginx.com>
parents:
diff changeset
7 #ifndef _NGX_EVENT_QUIC_H_INCLUDED_
5d91389e0fd3 Initial QUIC support in http.
Sergey Kandaurov <pluknet@nginx.com>
parents:
diff changeset
8 #define _NGX_EVENT_QUIC_H_INCLUDED_
5d91389e0fd3 Initial QUIC support in http.
Sergey Kandaurov <pluknet@nginx.com>
parents:
diff changeset
9
5d91389e0fd3 Initial QUIC support in http.
Sergey Kandaurov <pluknet@nginx.com>
parents:
diff changeset
10
7824
a5141e6b3214 Fixed includes in quic headers.
Roman Arutyunyan <arut@nginx.com>
parents: 7822
diff changeset
11 #include <ngx_config.h>
a5141e6b3214 Fixed includes in quic headers.
Roman Arutyunyan <arut@nginx.com>
parents: 7822
diff changeset
12 #include <ngx_core.h>
7636
53a5cdbe500c QUIC add_handshake_data callback, varint routines.
Sergey Kandaurov <pluknet@nginx.com>
parents: 7635
diff changeset
13
7687
69345a26ba69 Split transport and crypto parts into separate files.
Vladimir Homutov <vl@nginx.com>
parents: 7681
diff changeset
14
7910
125cbfa77013 Renamed max_packet_size to max_udp_payload_size, from draft-28.
Sergey Kandaurov <pluknet@nginx.com>
parents: 7860
diff changeset
15 #define NGX_QUIC_MAX_UDP_PAYLOAD_SIZE 65527
7927
391d06a51bc0 Limited max udp payload size for outgoing packets.
Vladimir Homutov <vl@nginx.com>
parents: 7913
diff changeset
16
7731
d45325e90221 Limit output QUIC packets with client max_packet_size.
Roman Arutyunyan <arut@nginx.com>
parents: 7729
diff changeset
17 #define NGX_QUIC_DEFAULT_ACK_DELAY_EXPONENT 3
d45325e90221 Limit output QUIC packets with client max_packet_size.
Roman Arutyunyan <arut@nginx.com>
parents: 7729
diff changeset
18 #define NGX_QUIC_DEFAULT_MAX_ACK_DELAY 25
8287
cef042935003 QUIC: the "quic_host_key" directive.
Vladimir Homutov <vl@nginx.com>
parents: 8279
diff changeset
19 #define NGX_QUIC_DEFAULT_HOST_KEY_LEN 32
cef042935003 QUIC: the "quic_host_key" directive.
Vladimir Homutov <vl@nginx.com>
parents: 8279
diff changeset
20 #define NGX_QUIC_SR_KEY_LEN 32
cef042935003 QUIC: the "quic_host_key" directive.
Vladimir Homutov <vl@nginx.com>
parents: 8279
diff changeset
21 #define NGX_QUIC_AV_KEY_LEN 32
7731
d45325e90221 Limit output QUIC packets with client max_packet_size.
Roman Arutyunyan <arut@nginx.com>
parents: 7729
diff changeset
22
8407
c8bda5e1e662 QUIC: headers cleanup.
Vladimir Homutov <vl@nginx.com>
parents: 8385
diff changeset
23 #define NGX_QUIC_SR_TOKEN_LEN 16
7832
ad3a6f069498 Added proper handling of connection close phases.
Vladimir Homutov <vl@nginx.com>
parents: 7829
diff changeset
24
7822
6481427ca3fc Respecting maximum packet size.
Vladimir Homutov <vl@nginx.com>
parents: 7811
diff changeset
25 #define NGX_QUIC_MIN_INITIAL_SIZE 1200
6481427ca3fc Respecting maximum packet size.
Vladimir Homutov <vl@nginx.com>
parents: 7811
diff changeset
26
7746
b364af7f9f3f Removed ngx_quic_stream_node_t.
Roman Arutyunyan <arut@nginx.com>
parents: 7739
diff changeset
27 #define NGX_QUIC_STREAM_SERVER_INITIATED 0x01
b364af7f9f3f Removed ngx_quic_stream_node_t.
Roman Arutyunyan <arut@nginx.com>
parents: 7739
diff changeset
28 #define NGX_QUIC_STREAM_UNIDIRECTIONAL 0x02
b364af7f9f3f Removed ngx_quic_stream_node_t.
Roman Arutyunyan <arut@nginx.com>
parents: 7739
diff changeset
29
7713
e9891e8ee975 Configurable transport parameters.
Vladimir Homutov <vl@nginx.com>
parents: 7690
diff changeset
30
8825
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
31 typedef enum {
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
32 NGX_QUIC_STREAM_SEND_READY = 0,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
33 NGX_QUIC_STREAM_SEND_SEND,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
34 NGX_QUIC_STREAM_SEND_DATA_SENT,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
35 NGX_QUIC_STREAM_SEND_DATA_RECVD,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
36 NGX_QUIC_STREAM_SEND_RESET_SENT,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
37 NGX_QUIC_STREAM_SEND_RESET_RECVD
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
38 } ngx_quic_stream_send_state_e;
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
39
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
40
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
41 typedef enum {
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
42 NGX_QUIC_STREAM_RECV_RECV = 0,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
43 NGX_QUIC_STREAM_RECV_SIZE_KNOWN,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
44 NGX_QUIC_STREAM_RECV_DATA_RECVD,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
45 NGX_QUIC_STREAM_RECV_DATA_READ,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
46 NGX_QUIC_STREAM_RECV_RESET_RECVD,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
47 NGX_QUIC_STREAM_RECV_RESET_READ
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
48 } ngx_quic_stream_recv_state_e;
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
49
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8814
diff changeset
50
7811
72d20158c814 Added reordering support for STREAM frames.
Vladimir Homutov <vl@nginx.com>
parents: 7748
diff changeset
51 typedef struct {
8856
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 8855
diff changeset
52 uint64_t size;
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 8855
diff changeset
53 uint64_t offset;
8859
8d11e2171697 QUIC: optimize insertion at the end of QUIC buffer.
Roman Arutyunyan <arut@nginx.com>
parents: 8856
diff changeset
54 uint64_t last_offset;
8856
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 8855
diff changeset
55 ngx_chain_t *chain;
8861
55b38514729b QUIC: fixed insertion at the end of buffer.
Roman Arutyunyan <arut@nginx.com>
parents: 8859
diff changeset
56 ngx_chain_t *last_chain;
8856
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 8855
diff changeset
57 } ngx_quic_buffer_t;
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 8855
diff changeset
58
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 8855
diff changeset
59
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 8855
diff changeset
60 typedef struct {
8827
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
61 ngx_ssl_t *ssl;
8713
d6ef13c5fd8e QUIC: simplified configuration.
Vladimir Homutov <vl@nginx.com>
parents: 8695
diff changeset
62
8827
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
63 ngx_flag_t retry;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
64 ngx_flag_t gso_enabled;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
65 ngx_flag_t disable_active_migration;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
66 ngx_msec_t timeout;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
67 ngx_str_t host_key;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
68 size_t mtu;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
69 size_t stream_buffer_size;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
70 ngx_uint_t max_concurrent_streams_bidi;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
71 ngx_uint_t max_concurrent_streams_uni;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
72 ngx_uint_t active_connection_id_limit;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
73 ngx_int_t stream_close_code;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
74 ngx_int_t stream_reject_code_uni;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
75 ngx_int_t stream_reject_code_bidi;
8713
d6ef13c5fd8e QUIC: simplified configuration.
Vladimir Homutov <vl@nginx.com>
parents: 8695
diff changeset
76
8827
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
77 u_char av_token_key[NGX_QUIC_AV_KEY_LEN];
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
78 u_char sr_token_key[NGX_QUIC_SR_KEY_LEN];
7999
0d2b2664b41c QUIC: added "quic" listen parameter.
Roman Arutyunyan <arut@nginx.com>
parents: 7998
diff changeset
79 } ngx_quic_conf_t;
0d2b2664b41c QUIC: added "quic" listen parameter.
Roman Arutyunyan <arut@nginx.com>
parents: 7998
diff changeset
80
0d2b2664b41c QUIC: added "quic" listen parameter.
Roman Arutyunyan <arut@nginx.com>
parents: 7998
diff changeset
81
7674
4ae9ac69ab93 HTTP/QUIC interface reworked.
Vladimir Homutov <vl@nginx.com>
parents: 7648
diff changeset
82 struct ngx_quic_stream_s {
8827
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
83 ngx_rbtree_node_t node;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
84 ngx_queue_t queue;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
85 ngx_connection_t *parent;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
86 ngx_connection_t *connection;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
87 uint64_t id;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
88 uint64_t acked;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
89 uint64_t send_max_data;
8855
a5aebd51e4c7 QUIC: stream lingering.
Roman Arutyunyan <arut@nginx.com>
parents: 8847
diff changeset
90 uint64_t send_offset;
a5aebd51e4c7 QUIC: stream lingering.
Roman Arutyunyan <arut@nginx.com>
parents: 8847
diff changeset
91 uint64_t send_final_size;
8827
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
92 uint64_t recv_max_data;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
93 uint64_t recv_offset;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
94 uint64_t recv_window;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
95 uint64_t recv_last;
8855
a5aebd51e4c7 QUIC: stream lingering.
Roman Arutyunyan <arut@nginx.com>
parents: 8847
diff changeset
96 uint64_t recv_final_size;
8856
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 8855
diff changeset
97 ngx_quic_buffer_t send;
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 8855
diff changeset
98 ngx_quic_buffer_t recv;
8827
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
99 ngx_quic_stream_send_state_e send_state;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8825
diff changeset
100 ngx_quic_stream_recv_state_e recv_state;
8856
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 8855
diff changeset
101 ngx_uint_t cancelable; /* unsigned cancelable:1; */
7674
4ae9ac69ab93 HTTP/QUIC interface reworked.
Vladimir Homutov <vl@nginx.com>
parents: 7648
diff changeset
102 };
4ae9ac69ab93 HTTP/QUIC interface reworked.
Vladimir Homutov <vl@nginx.com>
parents: 7648
diff changeset
103
7634
b507592c15a7 Server Initial Keys.
Sergey Kandaurov <pluknet@nginx.com>
parents: 7633
diff changeset
104
8862
c2f5d79cde64 QUIC: separate UDP framework for QUIC.
Roman Arutyunyan <arut@nginx.com>
parents: 8861
diff changeset
105 void ngx_quic_recvmsg(ngx_event_t *ev);
c2f5d79cde64 QUIC: separate UDP framework for QUIC.
Roman Arutyunyan <arut@nginx.com>
parents: 8861
diff changeset
106 void ngx_quic_rbtree_insert_value(ngx_rbtree_node_t *temp,
c2f5d79cde64 QUIC: separate UDP framework for QUIC.
Roman Arutyunyan <arut@nginx.com>
parents: 8861
diff changeset
107 ngx_rbtree_node_t *node, ngx_rbtree_node_t *sentinel);
8101
bed310672f39 QUIC: moved ssl configuration pointer to quic configuration.
Vladimir Homutov <vl@nginx.com>
parents: 8100
diff changeset
108 void ngx_quic_run(ngx_connection_t *c, ngx_quic_conf_t *conf);
8013
455a8536eaa7 QUIC: limited the number of server-initiated streams.
Roman Arutyunyan <arut@nginx.com>
parents: 8001
diff changeset
109 ngx_connection_t *ngx_quic_open_stream(ngx_connection_t *c, ngx_uint_t bidi);
7953
e0f92f68e018 QUIC: Introduced ngx_quic_finalize_connection().
Roman Arutyunyan <arut@nginx.com>
parents: 7933
diff changeset
110 void ngx_quic_finalize_connection(ngx_connection_t *c, ngx_uint_t err,
e0f92f68e018 QUIC: Introduced ngx_quic_finalize_connection().
Roman Arutyunyan <arut@nginx.com>
parents: 7933
diff changeset
111 const char *reason);
8359
fc64ab301bad QUIC: connection shutdown.
Roman Arutyunyan <arut@nginx.com>
parents: 8323
diff changeset
112 void ngx_quic_shutdown_connection(ngx_connection_t *c, ngx_uint_t err,
fc64ab301bad QUIC: connection shutdown.
Roman Arutyunyan <arut@nginx.com>
parents: 8323
diff changeset
113 const char *reason);
8296
d710c457171c QUIC: added ability to reset a stream.
Sergey Kandaurov <pluknet@nginx.com>
parents: 8287
diff changeset
114 ngx_int_t ngx_quic_reset_stream(ngx_connection_t *c, ngx_uint_t err);
8679
b4c7853b0488 QUIC: added shutdown support in stream proxy.
Vladimir Homutov <vl@nginx.com>
parents: 8617
diff changeset
115 ngx_int_t ngx_quic_shutdown_stream(ngx_connection_t *c, int how);
8617
9ae239d2547d QUIC: separate event handling functions.
Roman Arutyunyan <arut@nginx.com>
parents: 8552
diff changeset
116 ngx_int_t ngx_quic_handle_read_event(ngx_event_t *rev, ngx_uint_t flags);
9ae239d2547d QUIC: separate event handling functions.
Roman Arutyunyan <arut@nginx.com>
parents: 8552
diff changeset
117 ngx_int_t ngx_quic_handle_write_event(ngx_event_t *wev, size_t lowat);
8198
45db1b5c1706 QUIC: connection multiplexing per port.
Roman Arutyunyan <arut@nginx.com>
parents: 8196
diff changeset
118 ngx_int_t ngx_quic_get_packet_dcid(ngx_log_t *log, u_char *data, size_t len,
45db1b5c1706 QUIC: connection multiplexing per port.
Roman Arutyunyan <arut@nginx.com>
parents: 8196
diff changeset
119 ngx_str_t *dcid);
8415
b4e6b7049984 QUIC: normalize header inclusion.
Sergey Kandaurov <pluknet@nginx.com>
parents: 8414
diff changeset
120 ngx_int_t ngx_quic_derive_key(ngx_log_t *log, const char *label,
b4e6b7049984 QUIC: normalize header inclusion.
Sergey Kandaurov <pluknet@nginx.com>
parents: 8414
diff changeset
121 ngx_str_t *secret, ngx_str_t *salt, u_char *out, size_t len);
7633
5d91389e0fd3 Initial QUIC support in http.
Sergey Kandaurov <pluknet@nginx.com>
parents:
diff changeset
122
5d91389e0fd3 Initial QUIC support in http.
Sergey Kandaurov <pluknet@nginx.com>
parents:
diff changeset
123 #endif /* _NGX_EVENT_QUIC_H_INCLUDED_ */