annotate src/event/quic/ngx_event_quic.h @ 9011:f9c788f3f5cc quic

QUIC: ngx_quic_buffer_t object. The object is used instead of ngx_chain_t pointer for buffer operations like ngx_quic_write_chain() and ngx_quic_read_chain(). These functions are renamed to ngx_quic_write_buffer() and ngx_quic_read_buffer().
author Roman Arutyunyan <arut@nginx.com>
date Mon, 14 Feb 2022 15:27:59 +0300
parents a5aebd51e4c7
children 8d11e2171697
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8167
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 /*
8182
b28ea685a56e Moved all QUIC code into ngx_event_quic.c
Vladimir Homutov <vl@nginx.com>
parents: 8181
diff changeset
3 * Copyright (C) Nginx, Inc.
8167
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
8347
a5141e6b3214 Fixed includes in quic headers.
Roman Arutyunyan <arut@nginx.com>
parents: 8345
diff changeset
11 #include <ngx_config.h>
a5141e6b3214 Fixed includes in quic headers.
Roman Arutyunyan <arut@nginx.com>
parents: 8345
diff changeset
12 #include <ngx_core.h>
8170
53a5cdbe500c QUIC add_handshake_data callback, varint routines.
Sergey Kandaurov <pluknet@nginx.com>
parents: 8169
diff changeset
13
8221
69345a26ba69 Split transport and crypto parts into separate files.
Vladimir Homutov <vl@nginx.com>
parents: 8215
diff changeset
14
8415
125cbfa77013 Renamed max_packet_size to max_udp_payload_size, from draft-28.
Sergey Kandaurov <pluknet@nginx.com>
parents: 8383
diff changeset
15 #define NGX_QUIC_MAX_UDP_PAYLOAD_SIZE 65527
8432
391d06a51bc0 Limited max udp payload size for outgoing packets.
Vladimir Homutov <vl@nginx.com>
parents: 8418
diff changeset
16
8265
d45325e90221 Limit output QUIC packets with client max_packet_size.
Roman Arutyunyan <arut@nginx.com>
parents: 8263
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: 8263
diff changeset
18 #define NGX_QUIC_DEFAULT_MAX_ACK_DELAY 25
8694
cef042935003 QUIC: the "quic_host_key" directive.
Vladimir Homutov <vl@nginx.com>
parents: 8686
diff changeset
19 #define NGX_QUIC_DEFAULT_HOST_KEY_LEN 32
cef042935003 QUIC: the "quic_host_key" directive.
Vladimir Homutov <vl@nginx.com>
parents: 8686
diff changeset
20 #define NGX_QUIC_SR_KEY_LEN 32
cef042935003 QUIC: the "quic_host_key" directive.
Vladimir Homutov <vl@nginx.com>
parents: 8686
diff changeset
21 #define NGX_QUIC_AV_KEY_LEN 32
8265
d45325e90221 Limit output QUIC packets with client max_packet_size.
Roman Arutyunyan <arut@nginx.com>
parents: 8263
diff changeset
22
8747
c8bda5e1e662 QUIC: headers cleanup.
Vladimir Homutov <vl@nginx.com>
parents: 8735
diff changeset
23 #define NGX_QUIC_SR_TOKEN_LEN 16
8355
ad3a6f069498 Added proper handling of connection close phases.
Vladimir Homutov <vl@nginx.com>
parents: 8352
diff changeset
24
8345
6481427ca3fc Respecting maximum packet size.
Vladimir Homutov <vl@nginx.com>
parents: 8334
diff changeset
25 #define NGX_QUIC_MIN_INITIAL_SIZE 1200
6481427ca3fc Respecting maximum packet size.
Vladimir Homutov <vl@nginx.com>
parents: 8334
diff changeset
26
8280
b364af7f9f3f Removed ngx_quic_stream_node_t.
Roman Arutyunyan <arut@nginx.com>
parents: 8273
diff changeset
27 #define NGX_QUIC_STREAM_SERVER_INITIATED 0x01
b364af7f9f3f Removed ngx_quic_stream_node_t.
Roman Arutyunyan <arut@nginx.com>
parents: 8273
diff changeset
28 #define NGX_QUIC_STREAM_UNIDIRECTIONAL 0x02
b364af7f9f3f Removed ngx_quic_stream_node_t.
Roman Arutyunyan <arut@nginx.com>
parents: 8273
diff changeset
29
8247
e9891e8ee975 Configurable transport parameters.
Vladimir Homutov <vl@nginx.com>
parents: 8224
diff changeset
30
8990
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
31 typedef enum {
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
32 NGX_QUIC_STREAM_SEND_READY = 0,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
33 NGX_QUIC_STREAM_SEND_SEND,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
34 NGX_QUIC_STREAM_SEND_DATA_SENT,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
35 NGX_QUIC_STREAM_SEND_DATA_RECVD,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
36 NGX_QUIC_STREAM_SEND_RESET_SENT,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
37 NGX_QUIC_STREAM_SEND_RESET_RECVD
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
38 } ngx_quic_stream_send_state_e;
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
39
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
40
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
41 typedef enum {
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
42 NGX_QUIC_STREAM_RECV_RECV = 0,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
43 NGX_QUIC_STREAM_RECV_SIZE_KNOWN,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
44 NGX_QUIC_STREAM_RECV_DATA_RECVD,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
45 NGX_QUIC_STREAM_RECV_DATA_READ,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
46 NGX_QUIC_STREAM_RECV_RESET_RECVD,
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
47 NGX_QUIC_STREAM_RECV_RESET_READ
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
48 } ngx_quic_stream_recv_state_e;
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
49
b42a041d23a2 QUIC: introduced explicit stream states.
Roman Arutyunyan <arut@nginx.com>
parents: 8979
diff changeset
50
8334
72d20158c814 Added reordering support for STREAM frames.
Vladimir Homutov <vl@nginx.com>
parents: 8282
diff changeset
51 typedef struct {
9011
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 9010
diff changeset
52 uint64_t size;
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 9010
diff changeset
53 uint64_t offset;
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 9010
diff changeset
54 ngx_chain_t *chain;
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 9010
diff changeset
55 } ngx_quic_buffer_t;
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 9010
diff changeset
56
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 9010
diff changeset
57
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 9010
diff changeset
58 typedef struct {
8992
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
59 ngx_ssl_t *ssl;
8924
d6ef13c5fd8e QUIC: simplified configuration.
Vladimir Homutov <vl@nginx.com>
parents: 8906
diff changeset
60
8992
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
61 ngx_flag_t retry;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
62 ngx_flag_t gso_enabled;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
63 ngx_flag_t disable_active_migration;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
64 ngx_msec_t timeout;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
65 ngx_str_t host_key;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
66 size_t mtu;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
67 size_t stream_buffer_size;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
68 ngx_uint_t max_concurrent_streams_bidi;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
69 ngx_uint_t max_concurrent_streams_uni;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
70 ngx_uint_t active_connection_id_limit;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
71 ngx_int_t stream_close_code;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
72 ngx_int_t stream_reject_code_uni;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
73 ngx_int_t stream_reject_code_bidi;
8924
d6ef13c5fd8e QUIC: simplified configuration.
Vladimir Homutov <vl@nginx.com>
parents: 8906
diff changeset
74
8992
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
75 u_char av_token_key[NGX_QUIC_AV_KEY_LEN];
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
76 u_char sr_token_key[NGX_QUIC_SR_KEY_LEN];
8481
0d2b2664b41c QUIC: added "quic" listen parameter.
Roman Arutyunyan <arut@nginx.com>
parents: 8480
diff changeset
77 } ngx_quic_conf_t;
0d2b2664b41c QUIC: added "quic" listen parameter.
Roman Arutyunyan <arut@nginx.com>
parents: 8480
diff changeset
78
0d2b2664b41c QUIC: added "quic" listen parameter.
Roman Arutyunyan <arut@nginx.com>
parents: 8480
diff changeset
79
8208
4ae9ac69ab93 HTTP/QUIC interface reworked.
Vladimir Homutov <vl@nginx.com>
parents: 8182
diff changeset
80 struct ngx_quic_stream_s {
8992
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
81 ngx_rbtree_node_t node;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
82 ngx_queue_t queue;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
83 ngx_connection_t *parent;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
84 ngx_connection_t *connection;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
85 uint64_t id;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
86 uint64_t acked;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
87 uint64_t send_max_data;
9010
a5aebd51e4c7 QUIC: stream lingering.
Roman Arutyunyan <arut@nginx.com>
parents: 9003
diff changeset
88 uint64_t send_offset;
a5aebd51e4c7 QUIC: stream lingering.
Roman Arutyunyan <arut@nginx.com>
parents: 9003
diff changeset
89 uint64_t send_final_size;
8992
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
90 uint64_t recv_max_data;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
91 uint64_t recv_offset;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
92 uint64_t recv_window;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
93 uint64_t recv_last;
9010
a5aebd51e4c7 QUIC: stream lingering.
Roman Arutyunyan <arut@nginx.com>
parents: 9003
diff changeset
94 uint64_t recv_final_size;
9011
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 9010
diff changeset
95 ngx_quic_buffer_t send;
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 9010
diff changeset
96 ngx_quic_buffer_t recv;
8992
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
97 ngx_quic_stream_send_state_e send_state;
cba58cb06b3a QUIC: style.
Roman Arutyunyan <arut@nginx.com>
parents: 8990
diff changeset
98 ngx_quic_stream_recv_state_e recv_state;
9011
f9c788f3f5cc QUIC: ngx_quic_buffer_t object.
Roman Arutyunyan <arut@nginx.com>
parents: 9010
diff changeset
99 ngx_uint_t cancelable; /* unsigned cancelable:1; */
8208
4ae9ac69ab93 HTTP/QUIC interface reworked.
Vladimir Homutov <vl@nginx.com>
parents: 8182
diff changeset
100 };
4ae9ac69ab93 HTTP/QUIC interface reworked.
Vladimir Homutov <vl@nginx.com>
parents: 8182
diff changeset
101
8168
b507592c15a7 Server Initial Keys.
Sergey Kandaurov <pluknet@nginx.com>
parents: 8167
diff changeset
102
8563
bed310672f39 QUIC: moved ssl configuration pointer to quic configuration.
Vladimir Homutov <vl@nginx.com>
parents: 8562
diff changeset
103 void ngx_quic_run(ngx_connection_t *c, ngx_quic_conf_t *conf);
8495
455a8536eaa7 QUIC: limited the number of server-initiated streams.
Roman Arutyunyan <arut@nginx.com>
parents: 8483
diff changeset
104 ngx_connection_t *ngx_quic_open_stream(ngx_connection_t *c, ngx_uint_t bidi);
8458
e0f92f68e018 QUIC: Introduced ngx_quic_finalize_connection().
Roman Arutyunyan <arut@nginx.com>
parents: 8438
diff changeset
105 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: 8438
diff changeset
106 const char *reason);
8724
fc64ab301bad QUIC: connection shutdown.
Roman Arutyunyan <arut@nginx.com>
parents: 8711
diff changeset
107 void ngx_quic_shutdown_connection(ngx_connection_t *c, ngx_uint_t err,
fc64ab301bad QUIC: connection shutdown.
Roman Arutyunyan <arut@nginx.com>
parents: 8711
diff changeset
108 const char *reason);
8703
d710c457171c QUIC: added ability to reset a stream.
Sergey Kandaurov <pluknet@nginx.com>
parents: 8694
diff changeset
109 ngx_int_t ngx_quic_reset_stream(ngx_connection_t *c, ngx_uint_t err);
8890
b4c7853b0488 QUIC: added shutdown support in stream proxy.
Vladimir Homutov <vl@nginx.com>
parents: 8855
diff changeset
110 ngx_int_t ngx_quic_shutdown_stream(ngx_connection_t *c, int how);
8855
9ae239d2547d QUIC: separate event handling functions.
Roman Arutyunyan <arut@nginx.com>
parents: 8827
diff changeset
111 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: 8827
diff changeset
112 ngx_int_t ngx_quic_handle_write_event(ngx_event_t *wev, size_t lowat);
8628
45db1b5c1706 QUIC: connection multiplexing per port.
Roman Arutyunyan <arut@nginx.com>
parents: 8626
diff changeset
113 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: 8626
diff changeset
114 ngx_str_t *dcid);
8755
b4e6b7049984 QUIC: normalize header inclusion.
Sergey Kandaurov <pluknet@nginx.com>
parents: 8754
diff changeset
115 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: 8754
diff changeset
116 ngx_str_t *secret, ngx_str_t *salt, u_char *out, size_t len);
8167
5d91389e0fd3 Initial QUIC support in http.
Sergey Kandaurov <pluknet@nginx.com>
parents:
diff changeset
117
5d91389e0fd3 Initial QUIC support in http.
Sergey Kandaurov <pluknet@nginx.com>
parents:
diff changeset
118 #endif /* _NGX_EVENT_QUIC_H_INCLUDED_ */