One Level Up Top Level

src/event/quic/ngx_event_quic.h - nginx source code

Data types defined

Macros defined

Source code


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


  7. #ifndef _NGX_EVENT_QUIC_H_INCLUDED_
  8. ‌#define _NGX_EVENT_QUIC_H_INCLUDED_


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


  15. ‌#define NGX_QUIC_MAX_UDP_PAYLOAD_SIZE        65527

  17. ‌#define NGX_QUIC_DEFAULT_ACK_DELAY_EXPONENT  3
  18. ‌#define NGX_QUIC_DEFAULT_MAX_ACK_DELAY       25
  19. ‌#define NGX_QUIC_DEFAULT_HOST_KEY_LEN        32
  20. ‌#define NGX_QUIC_SR_KEY_LEN                  32
  21. ‌#define NGX_QUIC_AV_KEY_LEN                  32

  23. ‌#define NGX_QUIC_SR_TOKEN_LEN                16

  25. ‌#define NGX_QUIC_MIN_INITIAL_SIZE            1200

  27. ‌#define NGX_QUIC_STREAM_SERVER_INITIATED     0x01
  28. ‌#define NGX_QUIC_STREAM_UNIDIRECTIONAL       0x02


  31. ‌typedef ngx_int_t (*ngx_quic_init_pt)(ngx_connection_t *c);
  32. ‌typedef void (*ngx_quic_shutdown_pt)(ngx_connection_t *c);


  35. ‌typedef enum {
  36.     NGX_QUIC_STREAM_SEND_READY = 0,
  37.     NGX_QUIC_STREAM_SEND_SEND,
  38.     NGX_QUIC_STREAM_SEND_DATA_SENT,
  39.     NGX_QUIC_STREAM_SEND_DATA_RECVD,
  40.     NGX_QUIC_STREAM_SEND_RESET_SENT,
  41.     NGX_QUIC_STREAM_SEND_RESET_RECVD
  42. ‌} ngx_quic_stream_send_state_e;


  45. ‌typedef enum {
  46.     NGX_QUIC_STREAM_RECV_RECV = 0,
  47.     NGX_QUIC_STREAM_RECV_SIZE_KNOWN,
  48.     NGX_QUIC_STREAM_RECV_DATA_RECVD,
  49.     NGX_QUIC_STREAM_RECV_DATA_READ,
  50.     NGX_QUIC_STREAM_RECV_RESET_RECVD,
  51.     NGX_QUIC_STREAM_RECV_RESET_READ
  52. ‌} ngx_quic_stream_recv_state_e;


  55. ‌typedef struct {
  56.     uint64_t                       size;
  57.     uint64_t                       offset;
  58.     uint64_t                       last_offset;
  59.     ngx_chain_t                   *chain;
  60.     ngx_chain_t                   *last_chain;
  61. ‌} ngx_quic_buffer_t;


  64. ‌typedef struct {
  65.     ngx_ssl_t                     *ssl;

  67.     ngx_flag_t                     retry;
  68.     ngx_flag_t                     gso_enabled;
  69.     ngx_flag_t                     disable_active_migration;
  70.     ngx_msec_t                     handshake_timeout;
  71.     ngx_msec_t                     idle_timeout;
  72.     ngx_str_t                      host_key;
  73.     size_t                         stream_buffer_size;
  74.     ngx_uint_t                     max_concurrent_streams_bidi;
  75.     ngx_uint_t                     max_concurrent_streams_uni;
  76.     ngx_uint_t                     active_connection_id_limit;
  77.     ngx_int_t                      stream_close_code;
  78.     ngx_int_t                      stream_reject_code_uni;
  79.     ngx_int_t                      stream_reject_code_bidi;

  81.     ngx_quic_init_pt               init;
  82.     ngx_quic_shutdown_pt           shutdown;

  84.     u_char                         av_token_key[NGX_QUIC_AV_KEY_LEN];
  85.     u_char                         sr_token_key[NGX_QUIC_SR_KEY_LEN];
  86. ‌} ngx_quic_conf_t;


  89. ‌struct ngx_quic_stream_s {
  90.     ngx_rbtree_node_t              node;
  91.     ngx_queue_t                    queue;
  92.     ngx_connection_t              *parent;
  93.     ngx_connection_t              *connection;
  94.     uint64_t                       id;
  95.     uint64_t                       sent;
  96.     uint64_t                       acked;
  97.     uint64_t                       send_max_data;
  98.     uint64_t                       send_offset;
  99.     uint64_t                       send_final_size;
  100.     uint64_t                       recv_max_data;
  101.     uint64_t                       recv_offset;
  102.     uint64_t                       recv_window;
  103.     uint64_t                       recv_last;
  104.     uint64_t                       recv_final_size;
  105.     ngx_quic_buffer_t              send;
  106.     ngx_quic_buffer_t              recv;
  107.     ngx_quic_stream_send_state_e   send_state;
  108.     ngx_quic_stream_recv_state_e   recv_state;
  109.     unsigned                       cancelable:1;
  110.     unsigned                       fin_acked:1;
  111. };


  114. void ngx_quic_recvmsg(ngx_event_t *ev);
  115. void ngx_quic_run(ngx_connection_t *c, ngx_quic_conf_t *conf);
  116. ngx_connection_t *ngx_quic_open_stream(ngx_connection_t *c, ngx_uint_t bidi);
  117. void ngx_quic_finalize_connection(ngx_connection_t *c, ngx_uint_t err,
  118.     const char *reason);
  119. void ngx_quic_shutdown_connection(ngx_connection_t *c, ngx_uint_t err,
  120.     const char *reason);
  121. ngx_int_t ngx_quic_reset_stream(ngx_connection_t *c, ngx_uint_t err);
  122. ngx_int_t ngx_quic_shutdown_stream(ngx_connection_t *c, int how);
  123. void ngx_quic_cancelable_stream(ngx_connection_t *c);
  124. ngx_int_t ngx_quic_get_packet_dcid(ngx_log_t *log, u_char *data, size_t len,
  125.     ngx_str_t *dcid);
  126. ngx_int_t ngx_quic_derive_key(ngx_log_t *log, const char *label,
  127.     ngx_str_t *secret, ngx_str_t *salt, u_char *out, size_t len);

  129. #endif /* _NGX_EVENT_QUIC_H_INCLUDED_ */

One Level Up Top Level