One Level Up Top Level

src/http/v2/ngx_http_v2_module.c - nginx source code

Global variables defined

Functions defined

Source code


  2. /*
  3. * Copyright (C) Nginx, Inc.
  4. * Copyright (C) Valentin V. Bartenev
  5. */


  8. #include <ngx_config.h>
  9. #include <ngx_core.h>
  10. #include <ngx_http.h>
  11. #include <ngx_http_v2_module.h>


  14. static ngx_int_t ngx_http_v2_add_variables(ngx_conf_t *cf);

  16. static ngx_int_t ngx_http_v2_variable(ngx_http_request_t *r,
  17.     ngx_http_variable_value_t *v, uintptr_t data);

  19. static ngx_int_t ngx_http_v2_module_init(ngx_cycle_t *cycle);

  21. static void *ngx_http_v2_create_main_conf(ngx_conf_t *cf);
  22. static char *ngx_http_v2_init_main_conf(ngx_conf_t *cf, void *conf);
  23. static void *ngx_http_v2_create_srv_conf(ngx_conf_t *cf);
  24. static char *ngx_http_v2_merge_srv_conf(ngx_conf_t *cf, void *parent,
  25.     void *child);
  26. static void *ngx_http_v2_create_loc_conf(ngx_conf_t *cf);
  27. static char *ngx_http_v2_merge_loc_conf(ngx_conf_t *cf, void *parent,
  28.     void *child);

  30. static char *ngx_http_v2_recv_buffer_size(ngx_conf_t *cf, void *post,
  31.     void *data);
  32. static char *ngx_http_v2_pool_size(ngx_conf_t *cf, void *post, void *data);
  33. static char *ngx_http_v2_preread_size(ngx_conf_t *cf, void *post, void *data);
  34. static char *ngx_http_v2_streams_index_mask(ngx_conf_t *cf, void *post,
  35.     void *data);
  36. static char *ngx_http_v2_chunk_size(ngx_conf_t *cf, void *post, void *data);
  37. static char *ngx_http_v2_obsolete(ngx_conf_t *cf, ngx_command_t *cmd,
  38.     void *conf);


  41. ‌static ngx_conf_deprecated_t  ngx_http_v2_recv_timeout_deprecated = {
  42.     ngx_conf_deprecated, "http2_recv_timeout", "client_header_timeout"
  43. };

  45. ‌static ngx_conf_deprecated_t  ngx_http_v2_idle_timeout_deprecated = {
  46.     ngx_conf_deprecated, "http2_idle_timeout", "keepalive_timeout"
  47. };

  49. ‌static ngx_conf_deprecated_t  ngx_http_v2_max_requests_deprecated = {
  50.     ngx_conf_deprecated, "http2_max_requests", "keepalive_requests"
  51. };

  53. ‌static ngx_conf_deprecated_t  ngx_http_v2_max_field_size_deprecated = {
  54.     ngx_conf_deprecated, "http2_max_field_size", "large_client_header_buffers"
  55. };

  57. ‌static ngx_conf_deprecated_t  ngx_http_v2_max_header_size_deprecated = {
  58.     ngx_conf_deprecated, "http2_max_header_size", "large_client_header_buffers"
  59. };


  62. ‌static ngx_conf_post_t  ngx_http_v2_recv_buffer_size_post =
  63.     { ngx_http_v2_recv_buffer_size };
  64. ‌static ngx_conf_post_t  ngx_http_v2_pool_size_post =
  65.     { ngx_http_v2_pool_size };
  66. ‌static ngx_conf_post_t  ngx_http_v2_preread_size_post =
  67.     { ngx_http_v2_preread_size };
  68. ‌static ngx_conf_post_t  ngx_http_v2_streams_index_mask_post =
  69.     { ngx_http_v2_streams_index_mask };
  70. ‌static ngx_conf_post_t  ngx_http_v2_chunk_size_post =
  71.     { ngx_http_v2_chunk_size };


  74. ‌static ngx_command_t  ngx_http_v2_commands[] = {

  76.     { ngx_string("http2"),
  77.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
  78.       ngx_conf_set_flag_slot,
  79.       NGX_HTTP_SRV_CONF_OFFSET,
  80.       offsetof(ngx_http_v2_srv_conf_t, enable),
  81.       NULL },

  83.     { ngx_string("http2_recv_buffer_size"),
  84.       NGX_HTTP_MAIN_CONF|NGX_CONF_TAKE1,
  85.       ngx_conf_set_size_slot,
  86.       NGX_HTTP_MAIN_CONF_OFFSET,
  87.       offsetof(ngx_http_v2_main_conf_t, recv_buffer_size),
  88.       &ngx_http_v2_recv_buffer_size_post },

  90.     { ngx_string("http2_pool_size"),
  91.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  92.       ngx_conf_set_size_slot,
  93.       NGX_HTTP_SRV_CONF_OFFSET,
  94.       offsetof(ngx_http_v2_srv_conf_t, pool_size),
  95.       &ngx_http_v2_pool_size_post },

  97.     { ngx_string("http2_max_concurrent_streams"),
  98.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  99.       ngx_conf_set_num_slot,
  100.       NGX_HTTP_SRV_CONF_OFFSET,
  101.       offsetof(ngx_http_v2_srv_conf_t, concurrent_streams),
  102.       NULL },

  104.     { ngx_string("http2_max_concurrent_pushes"),
  105.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  106.       ngx_http_v2_obsolete,
  107.       0,
  108.       0,
  109.       NULL },

  111.     { ngx_string("http2_max_requests"),
  112.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  113.       ngx_http_v2_obsolete,
  114.       0,
  115.       0,
  116.       &ngx_http_v2_max_requests_deprecated },

  118.     { ngx_string("http2_max_field_size"),
  119.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  120.       ngx_http_v2_obsolete,
  121.       0,
  122.       0,
  123.       &ngx_http_v2_max_field_size_deprecated },

  125.     { ngx_string("http2_max_header_size"),
  126.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  127.       ngx_http_v2_obsolete,
  128.       0,
  129.       0,
  130.       &ngx_http_v2_max_header_size_deprecated },

  132.     { ngx_string("http2_body_preread_size"),
  133.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  134.       ngx_conf_set_size_slot,
  135.       NGX_HTTP_SRV_CONF_OFFSET,
  136.       offsetof(ngx_http_v2_srv_conf_t, preread_size),
  137.       &ngx_http_v2_preread_size_post },

  139.     { ngx_string("http2_streams_index_size"),
  140.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  141.       ngx_conf_set_num_slot,
  142.       NGX_HTTP_SRV_CONF_OFFSET,
  143.       offsetof(ngx_http_v2_srv_conf_t, streams_index_mask),
  144.       &ngx_http_v2_streams_index_mask_post },

  146.     { ngx_string("http2_recv_timeout"),
  147.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  148.       ngx_http_v2_obsolete,
  149.       0,
  150.       0,
  151.       &ngx_http_v2_recv_timeout_deprecated },

  153.     { ngx_string("http2_idle_timeout"),
  154.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
  155.       ngx_http_v2_obsolete,
  156.       0,
  157.       0,
  158.       &ngx_http_v2_idle_timeout_deprecated },

  160.     { ngx_string("http2_chunk_size"),
  161.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
  162.       ngx_conf_set_size_slot,
  163.       NGX_HTTP_LOC_CONF_OFFSET,
  164.       offsetof(ngx_http_v2_loc_conf_t, chunk_size),
  165.       &ngx_http_v2_chunk_size_post },

  167.     { ngx_string("http2_push_preload"),
  168.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_FLAG,
  169.       ngx_http_v2_obsolete,
  170.       0,
  171.       0,
  172.       NULL },

  174.     { ngx_string("http2_push"),
  175.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
  176.       ngx_http_v2_obsolete,
  177.       0,
  178.       0,
  179.       NULL },

  181.       ngx_null_command
  182. };


  185. ‌static ngx_http_module_t  ngx_http_v2_module_ctx = {
  186.     ngx_http_v2_add_variables,             /* preconfiguration */
  187.     NULL,                                  /* postconfiguration */

  189.     ngx_http_v2_create_main_conf,          /* create main configuration */
  190.     ngx_http_v2_init_main_conf,            /* init main configuration */

  192.     ngx_http_v2_create_srv_conf,           /* create server configuration */
  193.     ngx_http_v2_merge_srv_conf,            /* merge server configuration */

  195.     ngx_http_v2_create_loc_conf,           /* create location configuration */
  196.     ngx_http_v2_merge_loc_conf             /* merge location configuration */
  197. };


  200. ‌ngx_module_t  ngx_http_v2_module = {
  201.     NGX_MODULE_V1,
  202.     &ngx_http_v2_module_ctx,               /* module context */
  203.     ngx_http_v2_commands,                  /* module directives */
  204.     NGX_HTTP_MODULE,                       /* module type */
  205.     NULL,                                  /* init master */
  206.     ngx_http_v2_module_init,               /* init module */
  207.     NULL,                                  /* init process */
  208.     NULL,                                  /* init thread */
  209.     NULL,                                  /* exit thread */
  210.     NULL,                                  /* exit process */
  211.     NULL,                                  /* exit master */
  212.     NGX_MODULE_V1_PADDING
  213. };


  216. ‌static ngx_http_variable_t  ngx_http_v2_vars[] = {

  218.     { ngx_string("http2"), NULL,
  219.       ngx_http_v2_variable, 0, 0, 0 },

  221.       ngx_http_null_variable
  222. };


  225. static ngx_int_t
  226. ‌ngx_http_v2_add_variables(ngx_conf_t *cf)
  227. {
  228.     ngx_http_variable_t  *var, *v;

  230.     for (v = ngx_http_v2_vars; v->name.len; v++) {
  231.         var = ngx_http_add_variable(cf, &v->name, v->flags);
  232.         if (var == NULL) {
  233.             return NGX_ERROR;
  234.         }

  236.         var->get_handler = v->get_handler;
  237.         var->data = v->data;
  238.     }

  240.     return NGX_OK;
  241. }


  244. static ngx_int_t
  245. ‌ngx_http_v2_variable(ngx_http_request_t *r,
  246.     ngx_http_variable_value_t *v, uintptr_t data)
  247. {

  249.     if (r->stream) {
  250. #if (NGX_HTTP_SSL)

  252.         if (r->connection->ssl) {
  253.             v->len = sizeof("h2") - 1;
  254.             v->valid = 1;
  255.             v->no_cacheable = 0;
  256.             v->not_found = 0;
  257.             v->data = (u_char *) "h2";

  259.             return NGX_OK;
  260.         }

  262. #endif
  263.         v->len = sizeof("h2c") - 1;
  264.         v->valid = 1;
  265.         v->no_cacheable = 0;
  266.         v->not_found = 0;
  267.         v->data = (u_char *) "h2c";

  269.         return NGX_OK;
  270.     }

  272.     *v = ngx_http_variable_null_value;

  274.     return NGX_OK;
  275. }


  278. static ngx_int_t
  279. ‌ngx_http_v2_module_init(ngx_cycle_t *cycle)
  280. {
  281.     return NGX_OK;
  282. }


  285. static void *
  286. ‌ngx_http_v2_create_main_conf(ngx_conf_t *cf)
  287. {
  288.     ngx_http_v2_main_conf_t  *h2mcf;

  290.     h2mcf = ngx_pcalloc(cf->pool, sizeof(ngx_http_v2_main_conf_t));
  291.     if (h2mcf == NULL) {
  292.         return NULL;
  293.     }

  295.     h2mcf->recv_buffer_size = NGX_CONF_UNSET_SIZE;

  297.     return h2mcf;
  298. }


  301. static char *
  302. ‌ngx_http_v2_init_main_conf(ngx_conf_t *cf, void *conf)
  303. {
  304.     ngx_http_v2_main_conf_t *h2mcf = conf;

  306.     ngx_conf_init_size_value(h2mcf->recv_buffer_size, 256 * 1024);

  308.     return NGX_CONF_OK;
  309. }


  312. static void *
  313. ‌ngx_http_v2_create_srv_conf(ngx_conf_t *cf)
  314. {
  315.     ngx_http_v2_srv_conf_t  *h2scf;

  317.     h2scf = ngx_pcalloc(cf->pool, sizeof(ngx_http_v2_srv_conf_t));
  318.     if (h2scf == NULL) {
  319.         return NULL;
  320.     }

  322.     h2scf->enable = NGX_CONF_UNSET;

  324.     h2scf->pool_size = NGX_CONF_UNSET_SIZE;

  326.     h2scf->concurrent_streams = NGX_CONF_UNSET_UINT;

  328.     h2scf->preread_size = NGX_CONF_UNSET_SIZE;

  330.     h2scf->streams_index_mask = NGX_CONF_UNSET_UINT;

  332.     return h2scf;
  333. }


  336. static char *
  337. ‌ngx_http_v2_merge_srv_conf(ngx_conf_t *cf, void *parent, void *child)
  338. {
  339.     ngx_http_v2_srv_conf_t *prev = parent;
  340.     ngx_http_v2_srv_conf_t *conf = child;

  342.     ngx_conf_merge_value(conf->enable, prev->enable, 0);

  344.     ngx_conf_merge_size_value(conf->pool_size, prev->pool_size, 4096);

  346.     ngx_conf_merge_uint_value(conf->concurrent_streams,
  347.                               prev->concurrent_streams, 128);

  349.     ngx_conf_merge_size_value(conf->preread_size, prev->preread_size, 65536);

  351.     ngx_conf_merge_uint_value(conf->streams_index_mask,
  352.                               prev->streams_index_mask, 32 - 1);

  354.     return NGX_CONF_OK;
  355. }


  358. static void *
  359. ‌ngx_http_v2_create_loc_conf(ngx_conf_t *cf)
  360. {
  361.     ngx_http_v2_loc_conf_t  *h2lcf;

  363.     h2lcf = ngx_pcalloc(cf->pool, sizeof(ngx_http_v2_loc_conf_t));
  364.     if (h2lcf == NULL) {
  365.         return NULL;
  366.     }

  368.     h2lcf->chunk_size = NGX_CONF_UNSET_SIZE;

  370.     return h2lcf;
  371. }


  374. static char *
  375. ‌ngx_http_v2_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
  376. {
  377.     ngx_http_v2_loc_conf_t *prev = parent;
  378.     ngx_http_v2_loc_conf_t *conf = child;

  380.     ngx_conf_merge_size_value(conf->chunk_size, prev->chunk_size, 8 * 1024);

  382.     return NGX_CONF_OK;
  383. }


  386. static char *
  387. ‌ngx_http_v2_recv_buffer_size(ngx_conf_t *cf, void *post, void *data)
  388. {
  389.     size_t *sp = data;

  391.     if (*sp <= NGX_HTTP_V2_STATE_BUFFER_SIZE) {
  392.         return "value is too small";
  393.     }

  395.     return NGX_CONF_OK;
  396. }


  399. static char *
  400. ‌ngx_http_v2_pool_size(ngx_conf_t *cf, void *post, void *data)
  401. {
  402.     size_t *sp = data;

  404.     if (*sp < NGX_MIN_POOL_SIZE) {
  405.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  406.                            "the pool size must be no less than %uz",
  407.                            NGX_MIN_POOL_SIZE);

  409.         return NGX_CONF_ERROR;
  410.     }

  412.     if (*sp % NGX_POOL_ALIGNMENT) {
  413.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  414.                            "the pool size must be a multiple of %uz",
  415.                            NGX_POOL_ALIGNMENT);

  417.         return NGX_CONF_ERROR;
  418.     }

  420.     return NGX_CONF_OK;
  421. }


  424. static char *
  425. ‌ngx_http_v2_preread_size(ngx_conf_t *cf, void *post, void *data)
  426. {
  427.     size_t *sp = data;

  429.     if (*sp > NGX_HTTP_V2_MAX_WINDOW) {
  430.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  431.                            "the maximum body preread buffer size is %uz",
  432.                            NGX_HTTP_V2_MAX_WINDOW);

  434.         return NGX_CONF_ERROR;
  435.     }

  437.     return NGX_CONF_OK;
  438. }


  441. static char *
  442. ‌ngx_http_v2_streams_index_mask(ngx_conf_t *cf, void *post, void *data)
  443. {
  444.     ngx_uint_t *np = data;

  446.     ngx_uint_t  mask;

  448.     mask = *np - 1;

  450.     if (*np == 0 || (*np & mask)) {
  451.         return "must be a power of two";
  452.     }

  454.     *np = mask;

  456.     return NGX_CONF_OK;
  457. }


  460. static char *
  461. ‌ngx_http_v2_chunk_size(ngx_conf_t *cf, void *post, void *data)
  462. {
  463.     size_t *sp = data;

  465.     if (*sp == 0) {
  466.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  467.                            "the http2 chunk size cannot be zero");

  469.         return NGX_CONF_ERROR;
  470.     }

  472.     if (*sp > NGX_HTTP_V2_MAX_FRAME_SIZE) {
  473.         *sp = NGX_HTTP_V2_MAX_FRAME_SIZE;
  474.     }

  476.     return NGX_CONF_OK;
  477. }


  480. static char *
  481. ‌ngx_http_v2_obsolete(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  482. {
  483.     ngx_conf_deprecated_t  *d = cmd->post;

  485.     if (d) {
  486.         ngx_conf_log_error(NGX_LOG_WARN, cf, 0,
  487.                            "the \"%s\" directive is obsolete, "
  488.                            "use the \"%s\" directive instead",
  489.                            d->old_name, d->new_name);

  491.     } else {
  492.         ngx_conf_log_error(NGX_LOG_WARN, cf, 0,
  493.                            "the \"%V\" directive is obsolete, ignored",
  494.                            &cmd->name);
  495.     }

  497.     return NGX_CONF_OK;
  498. }

One Level Up Top Level