One Level Up Top Level

src/http/ngx_http_spdy.h - nginx-1.7.10

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_SPDY_H_INCLUDED_
  8. ‌#define _NGX_HTTP_SPDY_H_INCLUDED_


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

  15. #include <zlib.h>


  18. ‌#define NGX_SPDY_VERSION              3

  20. ‌#define NGX_SPDY_NPN_ADVERTISE        "\x08spdy/3.1"
  21. ‌#define NGX_SPDY_NPN_NEGOTIATED       "spdy/3.1"

  23. ‌#define NGX_SPDY_STATE_BUFFER_SIZE    16

  25. ‌#define NGX_SPDY_CTL_BIT              1

  27. ‌#define NGX_SPDY_SYN_STREAM           1
  28. ‌#define NGX_SPDY_SYN_REPLY            2
  29. ‌#define NGX_SPDY_RST_STREAM           3
  30. ‌#define NGX_SPDY_SETTINGS             4
  31. ‌#define NGX_SPDY_PING                 6
  32. ‌#define NGX_SPDY_GOAWAY               7
  33. ‌#define NGX_SPDY_HEADERS              8
  34. ‌#define NGX_SPDY_WINDOW_UPDATE        9

  36. ‌#define NGX_SPDY_FRAME_HEADER_SIZE    8

  38. ‌#define NGX_SPDY_SID_SIZE             4
  39. ‌#define NGX_SPDY_DELTA_SIZE           4

  41. ‌#define NGX_SPDY_SYN_STREAM_SIZE      10
  42. ‌#define NGX_SPDY_SYN_REPLY_SIZE       4
  43. ‌#define NGX_SPDY_RST_STREAM_SIZE      8
  44. ‌#define NGX_SPDY_PING_SIZE            4
  45. ‌#define NGX_SPDY_GOAWAY_SIZE          8
  46. ‌#define NGX_SPDY_WINDOW_UPDATE_SIZE   8
  47. ‌#define NGX_SPDY_NV_NUM_SIZE          4
  48. ‌#define NGX_SPDY_NV_NLEN_SIZE         4
  49. ‌#define NGX_SPDY_NV_VLEN_SIZE         4
  50. ‌#define NGX_SPDY_SETTINGS_NUM_SIZE    4
  51. ‌#define NGX_SPDY_SETTINGS_FID_SIZE    4
  52. ‌#define NGX_SPDY_SETTINGS_VAL_SIZE    4

  54. ‌#define NGX_SPDY_SETTINGS_PAIR_SIZE                                           \
  55.     (NGX_SPDY_SETTINGS_FID_SIZE + NGX_SPDY_SETTINGS_VAL_SIZE)

  57. ‌#define NGX_SPDY_HIGHEST_PRIORITY     0
  58. ‌#define NGX_SPDY_LOWEST_PRIORITY      7

  60. ‌#define NGX_SPDY_FLAG_FIN             0x01
  61. ‌#define NGX_SPDY_FLAG_UNIDIRECTIONAL  0x02
  62. ‌#define NGX_SPDY_FLAG_CLEAR_SETTINGS  0x01

  64. ‌#define NGX_SPDY_MAX_FRAME_SIZE       ((1 << 24) - 1)

  66. ‌#define NGX_SPDY_DATA_DISCARD         1
  67. ‌#define NGX_SPDY_DATA_ERROR           2
  68. ‌#define NGX_SPDY_DATA_INTERNAL_ERROR  3


  71. ‌typedef struct ngx_http_spdy_connection_s   ngx_http_spdy_connection_t;
  72. ‌typedef struct ngx_http_spdy_out_frame_s    ngx_http_spdy_out_frame_t;


  75. ‌typedef u_char *(*ngx_http_spdy_handler_pt) (ngx_http_spdy_connection_t *sc,
  76.     u_char *pos, u_char *end);

  78. ‌struct ngx_http_spdy_connection_s {
  79.     ngx_connection_t                *connection;
  80.     ngx_http_connection_t           *http_connection;

  82.     ngx_uint_t                       processing;

  84.     size_t                           send_window;
  85.     size_t                           recv_window;
  86.     size_t                           init_window;

  88.     ngx_queue_t                      waiting;

  90.     u_char                           buffer[NGX_SPDY_STATE_BUFFER_SIZE];
  91.     size_t                           buffer_used;
  92.     ngx_http_spdy_handler_pt         handler;

  94.     z_stream                         zstream_in;
  95.     z_stream                         zstream_out;

  97.     ngx_pool_t                      *pool;

  99.     ngx_http_spdy_out_frame_t       *free_ctl_frames;
  100.     ngx_connection_t                *free_fake_connections;

  102.     ngx_http_spdy_stream_t         **streams_index;

  104.     ngx_http_spdy_out_frame_t       *last_out;

  106.     ngx_queue_t                      posted;

  108.     ngx_http_spdy_stream_t          *stream;

  110.     ngx_uint_t                       entries;
  111.     size_t                           length;
  112.     u_char                           flags;

  114.     ngx_uint_t                       last_sid;

  116.     unsigned                         blocked:1;
  117.     unsigned                         incomplete:1;
  118. };


  121. ‌struct ngx_http_spdy_stream_s {
  122.     ngx_uint_t                       id;
  123.     ngx_http_request_t              *request;
  124.     ngx_http_spdy_connection_t      *connection;
  125.     ngx_http_spdy_stream_t          *index;

  127.     ngx_uint_t                       header_buffers;
  128.     ngx_uint_t                       queued;

  130.     /*
  131.      * A change to SETTINGS_INITIAL_WINDOW_SIZE could cause the
  132.      * send_window to become negative, hence it's signed.
  133.      */
  134.     ssize_t                          send_window;
  135.     size_t                           recv_window;

  137.     ngx_http_spdy_out_frame_t       *free_frames;
  138.     ngx_chain_t                     *free_data_headers;
  139.     ngx_chain_t                     *free_bufs;

  141.     ngx_queue_t                      queue;

  143.     unsigned                         priority:3;
  144.     unsigned                         handled:1;
  145.     unsigned                         blocked:1;
  146.     unsigned                         exhausted:1;
  147.     unsigned                         in_closed:1;
  148.     unsigned                         out_closed:1;
  149.     unsigned                         skip_data:2;
  150. };


  153. ‌struct ngx_http_spdy_out_frame_s {
  154.     ngx_http_spdy_out_frame_t       *next;
  155.     ngx_chain_t                     *first;
  156.     ngx_chain_t                     *last;
  157.     ngx_int_t                      (*handler)(ngx_http_spdy_connection_t *sc,
  158.                                         ngx_http_spdy_out_frame_t *frame);

  160.     ngx_http_spdy_stream_t          *stream;
  161.     size_t                           length;

  163.     ngx_uint_t                       priority;
  164.     unsigned                         blocked:1;
  165.     unsigned                         fin:1;
  166. };


  169. static ngx_inline void
  170. ‌ngx_http_spdy_queue_frame(ngx_http_spdy_connection_t *sc,
  171.     ngx_http_spdy_out_frame_t *frame)
  172. {
  173.     ngx_http_spdy_out_frame_t  **out;

  175.     for (out = &sc->last_out; *out; out = &(*out)->next)
  176.     {
  177.         /*
  178.          * NB: higher values represent lower priorities.
  179.          */
  180.         if (frame->priority >= (*out)->priority) {
  181.             break;
  182.         }
  183.     }

  185.     frame->next = *out;
  186.     *out = frame;
  187. }


  190. static ngx_inline void
  191. ‌ngx_http_spdy_queue_blocked_frame(ngx_http_spdy_connection_t *sc,
  192.     ngx_http_spdy_out_frame_t *frame)
  193. {
  194.     ngx_http_spdy_out_frame_t  **out;

  196.     for (out = &sc->last_out; *out; out = &(*out)->next)
  197.     {
  198.         if ((*out)->blocked) {
  199.             break;
  200.         }
  201.     }

  203.     frame->next = *out;
  204.     *out = frame;
  205. }


  208. void ngx_http_spdy_init(ngx_event_t *rev);
  209. void ngx_http_spdy_request_headers_init(void);

  211. ngx_int_t ngx_http_spdy_read_request_body(ngx_http_request_t *r,
  212.     ngx_http_client_body_handler_pt post_handler);

  214. void ngx_http_spdy_close_stream(ngx_http_spdy_stream_t *stream, ngx_int_t rc);

  216. ngx_int_t ngx_http_spdy_send_output_queue(ngx_http_spdy_connection_t *sc);


  219. ‌#define ngx_spdy_frame_aligned_write_uint16(p, s)                             \
  220.     (*(uint16_t *) (p) = htons((uint16_t) (s)), (p) + sizeof(uint16_t))

  222. ‌#define ngx_spdy_frame_aligned_write_uint32(p, s)                             \
  223.     (*(uint32_t *) (p) = htonl((uint32_t) (s)), (p) + sizeof(uint32_t))

  225. #if (NGX_HAVE_NONALIGNED)

  227. ‌#define ngx_spdy_frame_write_uint16  ngx_spdy_frame_aligned_write_uint16
  228. ‌#define ngx_spdy_frame_write_uint32  ngx_spdy_frame_aligned_write_uint32

  230. #else

  232. ‌#define ngx_spdy_frame_write_uint16(p, s)                                     \
  233.     ((p)[0] = (u_char) ((s) >> 8),                                            \
  234.      (p)[1] = (u_char)  (s),                                                  \
  235.      (p) + sizeof(uint16_t))

  237. ‌#define ngx_spdy_frame_write_uint32(p, s)                                     \
  238.     ((p)[0] = (u_char) ((s) >> 24),                                           \
  239.      (p)[1] = (u_char) ((s) >> 16),                                           \
  240.      (p)[2] = (u_char) ((s) >> 8),                                            \
  241.      (p)[3] = (u_char)  (s),                                                  \
  242.      (p) + sizeof(uint32_t))

  244. #endif


  247. ‌#define ngx_spdy_ctl_frame_head(t)                                            \
  248.     ((uint32_t) NGX_SPDY_CTL_BIT << 31 | NGX_SPDY_VERSION << 16 | (t))

  250. ‌#define ngx_spdy_frame_write_head(p, t)                                       \
  251.     ngx_spdy_frame_aligned_write_uint32(p, ngx_spdy_ctl_frame_head(t))

  253. ‌#define ngx_spdy_frame_write_flags_and_len(p, f, l)                           \
  254.     ngx_spdy_frame_aligned_write_uint32(p, (f) << 24 | (l))
  255. ‌#define ngx_spdy_frame_write_flags_and_id(p, f, i)                            \
  256.     ngx_spdy_frame_aligned_write_uint32(p, (f) << 24 | (i))

  258. ‌#define ngx_spdy_frame_write_sid     ngx_spdy_frame_aligned_write_uint32
  259. ‌#define ngx_spdy_frame_write_window  ngx_spdy_frame_aligned_write_uint32

  261. #endif /* _NGX_HTTP_SPDY_H_INCLUDED_ */

One Level Up Top Level