272
|
1
|
|
2 /*
|
|
3 * Copyright (C) Igor Sysoev
|
644
|
4 * Copyright (C) Nginx, Inc.
|
272
|
5 */
|
|
6
|
|
7
|
|
8 #include <ngx_config.h>
|
|
9 #include <ngx_core.h>
|
|
10 #include <ngx_http.h>
|
|
11
|
|
12
|
|
13 typedef struct {
|
|
14 u_char color;
|
|
15 u_char len;
|
|
16 u_short conn;
|
|
17 u_char data[1];
|
|
18 } ngx_http_limit_zone_node_t;
|
|
19
|
|
20
|
|
21 typedef struct {
|
|
22 ngx_shm_zone_t *shm_zone;
|
|
23 ngx_rbtree_node_t *node;
|
|
24 } ngx_http_limit_zone_cleanup_t;
|
|
25
|
|
26
|
|
27 typedef struct {
|
|
28 ngx_rbtree_t *rbtree;
|
|
29 ngx_int_t index;
|
|
30 ngx_str_t var;
|
|
31 } ngx_http_limit_zone_ctx_t;
|
|
32
|
|
33
|
|
34 typedef struct {
|
|
35 ngx_shm_zone_t *shm_zone;
|
|
36 ngx_uint_t conn;
|
532
|
37 ngx_uint_t log_level;
|
272
|
38 } ngx_http_limit_zone_conf_t;
|
|
39
|
|
40
|
|
41 static void ngx_http_limit_zone_cleanup(void *data);
|
|
42
|
|
43 static void *ngx_http_limit_zone_create_conf(ngx_conf_t *cf);
|
|
44 static char *ngx_http_limit_zone_merge_conf(ngx_conf_t *cf, void *parent,
|
|
45 void *child);
|
|
46 static char *ngx_http_limit_zone(ngx_conf_t *cf, ngx_command_t *cmd,
|
|
47 void *conf);
|
|
48 static char *ngx_http_limit_conn(ngx_conf_t *cf, ngx_command_t *cmd,
|
|
49 void *conf);
|
|
50 static ngx_int_t ngx_http_limit_zone_init(ngx_conf_t *cf);
|
|
51
|
|
52
|
532
|
53 static ngx_conf_enum_t ngx_http_limit_conn_log_levels[] = {
|
|
54 { ngx_string("info"), NGX_LOG_INFO },
|
|
55 { ngx_string("notice"), NGX_LOG_NOTICE },
|
|
56 { ngx_string("warn"), NGX_LOG_WARN },
|
|
57 { ngx_string("error"), NGX_LOG_ERR },
|
|
58 { ngx_null_string, 0 }
|
|
59 };
|
|
60
|
|
61
|
272
|
62 static ngx_command_t ngx_http_limit_zone_commands[] = {
|
|
63
|
|
64 { ngx_string("limit_zone"),
|
|
65 NGX_HTTP_MAIN_CONF|NGX_CONF_TAKE3,
|
|
66 ngx_http_limit_zone,
|
|
67 0,
|
|
68 0,
|
|
69 NULL },
|
|
70
|
|
71 { ngx_string("limit_conn"),
|
|
72 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE2,
|
|
73 ngx_http_limit_conn,
|
|
74 NGX_HTTP_LOC_CONF_OFFSET,
|
|
75 0,
|
|
76 NULL },
|
|
77
|
532
|
78 { ngx_string("limit_conn_log_level"),
|
|
79 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
|
|
80 ngx_conf_set_enum_slot,
|
|
81 NGX_HTTP_LOC_CONF_OFFSET,
|
|
82 offsetof(ngx_http_limit_zone_conf_t, log_level),
|
|
83 &ngx_http_limit_conn_log_levels },
|
|
84
|
272
|
85 ngx_null_command
|
|
86 };
|
|
87
|
|
88
|
|
89 static ngx_http_module_t ngx_http_limit_zone_module_ctx = {
|
|
90 NULL, /* preconfiguration */
|
|
91 ngx_http_limit_zone_init, /* postconfiguration */
|
|
92
|
|
93 NULL, /* create main configuration */
|
|
94 NULL, /* init main configuration */
|
|
95
|
|
96 NULL, /* create server configuration */
|
|
97 NULL, /* merge server configuration */
|
|
98
|
|
99 ngx_http_limit_zone_create_conf, /* create location configration */
|
|
100 ngx_http_limit_zone_merge_conf /* merge location configration */
|
|
101 };
|
|
102
|
|
103
|
|
104 ngx_module_t ngx_http_limit_zone_module = {
|
|
105 NGX_MODULE_V1,
|
|
106 &ngx_http_limit_zone_module_ctx, /* module context */
|
|
107 ngx_http_limit_zone_commands, /* module directives */
|
|
108 NGX_HTTP_MODULE, /* module type */
|
|
109 NULL, /* init master */
|
|
110 NULL, /* init module */
|
|
111 NULL, /* init process */
|
|
112 NULL, /* init thread */
|
|
113 NULL, /* exit thread */
|
|
114 NULL, /* exit process */
|
|
115 NULL, /* exit master */
|
|
116 NGX_MODULE_V1_PADDING
|
|
117 };
|
|
118
|
|
119
|
|
120 static ngx_int_t
|
|
121 ngx_http_limit_zone_handler(ngx_http_request_t *r)
|
|
122 {
|
|
123 size_t len, n;
|
|
124 uint32_t hash;
|
274
|
125 ngx_int_t rc;
|
272
|
126 ngx_slab_pool_t *shpool;
|
|
127 ngx_rbtree_node_t *node, *sentinel;
|
|
128 ngx_pool_cleanup_t *cln;
|
|
129 ngx_http_variable_value_t *vv;
|
|
130 ngx_http_limit_zone_ctx_t *ctx;
|
|
131 ngx_http_limit_zone_node_t *lz;
|
|
132 ngx_http_limit_zone_conf_t *lzcf;
|
|
133 ngx_http_limit_zone_cleanup_t *lzcln;
|
|
134
|
|
135 if (r->main->limit_zone_set) {
|
|
136 return NGX_DECLINED;
|
|
137 }
|
|
138
|
|
139 lzcf = ngx_http_get_module_loc_conf(r, ngx_http_limit_zone_module);
|
|
140
|
|
141 if (lzcf->shm_zone == NULL) {
|
|
142 return NGX_DECLINED;
|
|
143 }
|
|
144
|
|
145 ctx = lzcf->shm_zone->data;
|
|
146
|
|
147 vv = ngx_http_get_indexed_variable(r, ctx->index);
|
|
148
|
|
149 if (vv == NULL || vv->not_found) {
|
|
150 return NGX_DECLINED;
|
|
151 }
|
|
152
|
274
|
153 len = vv->len;
|
|
154
|
|
155 if (len == 0) {
|
|
156 return NGX_DECLINED;
|
|
157 }
|
272
|
158
|
274
|
159 if (len > 255) {
|
|
160 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
|
|
161 "the value of the \"%V\" variable "
|
328
|
162 "is more than 255 bytes: \"%v\"",
|
274
|
163 &ctx->var, vv);
|
|
164 return NGX_DECLINED;
|
|
165 }
|
|
166
|
|
167 r->main->limit_zone_set = 1;
|
272
|
168
|
|
169 hash = ngx_crc32_short(vv->data, len);
|
|
170
|
|
171 cln = ngx_pool_cleanup_add(r->pool, sizeof(ngx_http_limit_zone_cleanup_t));
|
|
172 if (cln == NULL) {
|
|
173 return NGX_HTTP_INTERNAL_SERVER_ERROR;
|
|
174 }
|
|
175
|
|
176 shpool = (ngx_slab_pool_t *) lzcf->shm_zone->shm.addr;
|
|
177
|
|
178 ngx_shmtx_lock(&shpool->mutex);
|
|
179
|
|
180 node = ctx->rbtree->root;
|
|
181 sentinel = ctx->rbtree->sentinel;
|
|
182
|
|
183 while (node != sentinel) {
|
|
184
|
|
185 if (hash < node->key) {
|
|
186 node = node->left;
|
|
187 continue;
|
|
188 }
|
|
189
|
|
190 if (hash > node->key) {
|
|
191 node = node->right;
|
|
192 continue;
|
|
193 }
|
|
194
|
274
|
195 /* hash == node->key */
|
|
196
|
|
197 do {
|
272
|
198 lz = (ngx_http_limit_zone_node_t *) &node->color;
|
|
199
|
276
|
200 rc = ngx_memn2cmp(vv->data, lz->data, len, (size_t) lz->len);
|
274
|
201
|
|
202 if (rc == 0) {
|
272
|
203 if ((ngx_uint_t) lz->conn < lzcf->conn) {
|
|
204 lz->conn++;
|
|
205 goto done;
|
|
206 }
|
|
207
|
|
208 ngx_shmtx_unlock(&shpool->mutex);
|
|
209
|
532
|
210 ngx_log_error(lzcf->log_level, r->connection->log, 0,
|
426
|
211 "limiting connections by zone \"%V\"",
|
480
|
212 &lzcf->shm_zone->shm.name);
|
426
|
213
|
272
|
214 return NGX_HTTP_SERVICE_UNAVAILABLE;
|
|
215 }
|
274
|
216
|
|
217 node = (rc < 0) ? node->left : node->right;
|
|
218
|
|
219 } while (node != sentinel && hash == node->key);
|
|
220
|
|
221 break;
|
272
|
222 }
|
|
223
|
|
224 n = offsetof(ngx_rbtree_node_t, color)
|
|
225 + offsetof(ngx_http_limit_zone_node_t, data)
|
|
226 + len;
|
|
227
|
|
228 node = ngx_slab_alloc_locked(shpool, n);
|
|
229 if (node == NULL) {
|
|
230 ngx_shmtx_unlock(&shpool->mutex);
|
|
231 return NGX_HTTP_SERVICE_UNAVAILABLE;
|
|
232 }
|
|
233
|
|
234 lz = (ngx_http_limit_zone_node_t *) &node->color;
|
|
235
|
|
236 node->key = hash;
|
|
237 lz->len = (u_char) len;
|
|
238 lz->conn = 1;
|
|
239 ngx_memcpy(lz->data, vv->data, len);
|
|
240
|
|
241 ngx_rbtree_insert(ctx->rbtree, node);
|
|
242
|
|
243 done:
|
|
244
|
|
245 ngx_log_debug2(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
|
|
246 "limit zone: %08XD %d", node->key, lz->conn);
|
|
247
|
|
248 ngx_shmtx_unlock(&shpool->mutex);
|
|
249
|
|
250 cln->handler = ngx_http_limit_zone_cleanup;
|
|
251 lzcln = cln->data;
|
|
252
|
|
253 lzcln->shm_zone = lzcf->shm_zone;
|
|
254 lzcln->node = node;
|
|
255
|
|
256 return NGX_DECLINED;
|
|
257 }
|
|
258
|
|
259
|
|
260 static void
|
274
|
261 ngx_http_limit_zone_rbtree_insert_value(ngx_rbtree_node_t *temp,
|
|
262 ngx_rbtree_node_t *node, ngx_rbtree_node_t *sentinel)
|
|
263 {
|
356
|
264 ngx_rbtree_node_t **p;
|
|
265 ngx_http_limit_zone_node_t *lzn, *lznt;
|
274
|
266
|
|
267 for ( ;; ) {
|
|
268
|
|
269 if (node->key < temp->key) {
|
|
270
|
356
|
271 p = &temp->left;
|
274
|
272
|
|
273 } else if (node->key > temp->key) {
|
|
274
|
356
|
275 p = &temp->right;
|
274
|
276
|
|
277 } else { /* node->key == temp->key */
|
|
278
|
|
279 lzn = (ngx_http_limit_zone_node_t *) &node->color;
|
|
280 lznt = (ngx_http_limit_zone_node_t *) &temp->color;
|
|
281
|
356
|
282 p = (ngx_memn2cmp(lzn->data, lznt->data, lzn->len, lznt->len) < 0)
|
|
283 ? &temp->left : &temp->right;
|
|
284 }
|
274
|
285
|
356
|
286 if (*p == sentinel) {
|
|
287 break;
|
|
288 }
|
274
|
289
|
356
|
290 temp = *p;
|
274
|
291 }
|
|
292
|
356
|
293 *p = node;
|
274
|
294 node->parent = temp;
|
|
295 node->left = sentinel;
|
|
296 node->right = sentinel;
|
|
297 ngx_rbt_red(node);
|
|
298 }
|
|
299
|
|
300
|
|
301 static void
|
272
|
302 ngx_http_limit_zone_cleanup(void *data)
|
|
303 {
|
|
304 ngx_http_limit_zone_cleanup_t *lzcln = data;
|
|
305
|
|
306 ngx_slab_pool_t *shpool;
|
|
307 ngx_rbtree_node_t *node;
|
|
308 ngx_http_limit_zone_ctx_t *ctx;
|
|
309 ngx_http_limit_zone_node_t *lz;
|
|
310
|
|
311 ctx = lzcln->shm_zone->data;
|
|
312 shpool = (ngx_slab_pool_t *) lzcln->shm_zone->shm.addr;
|
|
313 node = lzcln->node;
|
|
314 lz = (ngx_http_limit_zone_node_t *) &node->color;
|
|
315
|
|
316 ngx_shmtx_lock(&shpool->mutex);
|
|
317
|
|
318 ngx_log_debug2(NGX_LOG_DEBUG_HTTP, lzcln->shm_zone->shm.log, 0,
|
|
319 "limit zone cleanup: %08XD %d", node->key, lz->conn);
|
|
320
|
|
321 lz->conn--;
|
|
322
|
|
323 if (lz->conn == 0) {
|
|
324 ngx_rbtree_delete(ctx->rbtree, node);
|
|
325 ngx_slab_free_locked(shpool, node);
|
|
326 }
|
|
327
|
|
328 ngx_shmtx_unlock(&shpool->mutex);
|
|
329 }
|
|
330
|
|
331
|
|
332 static ngx_int_t
|
|
333 ngx_http_limit_zone_init_zone(ngx_shm_zone_t *shm_zone, void *data)
|
|
334 {
|
|
335 ngx_http_limit_zone_ctx_t *octx = data;
|
|
336
|
468
|
337 size_t len;
|
272
|
338 ngx_slab_pool_t *shpool;
|
|
339 ngx_rbtree_node_t *sentinel;
|
|
340 ngx_http_limit_zone_ctx_t *ctx;
|
|
341
|
|
342 ctx = shm_zone->data;
|
|
343
|
|
344 if (octx) {
|
|
345 if (ngx_strcmp(ctx->var.data, octx->var.data) != 0) {
|
|
346 ngx_log_error(NGX_LOG_EMERG, shm_zone->shm.log, 0,
|
274
|
347 "limit_zone \"%V\" uses the \"%V\" variable "
|
272
|
348 "while previously it used the \"%V\" variable",
|
480
|
349 &shm_zone->shm.name, &ctx->var, &octx->var);
|
272
|
350 return NGX_ERROR;
|
|
351 }
|
|
352
|
|
353 ctx->rbtree = octx->rbtree;
|
|
354
|
|
355 return NGX_OK;
|
|
356 }
|
|
357
|
|
358 shpool = (ngx_slab_pool_t *) shm_zone->shm.addr;
|
|
359
|
480
|
360 if (shm_zone->shm.exists) {
|
|
361 ctx->rbtree = shpool->data;
|
|
362
|
|
363 return NGX_OK;
|
|
364 }
|
|
365
|
272
|
366 ctx->rbtree = ngx_slab_alloc(shpool, sizeof(ngx_rbtree_t));
|
|
367 if (ctx->rbtree == NULL) {
|
|
368 return NGX_ERROR;
|
|
369 }
|
|
370
|
480
|
371 shpool->data = ctx->rbtree;
|
|
372
|
272
|
373 sentinel = ngx_slab_alloc(shpool, sizeof(ngx_rbtree_node_t));
|
|
374 if (sentinel == NULL) {
|
|
375 return NGX_ERROR;
|
|
376 }
|
|
377
|
356
|
378 ngx_rbtree_init(ctx->rbtree, sentinel,
|
|
379 ngx_http_limit_zone_rbtree_insert_value);
|
272
|
380
|
480
|
381 len = sizeof(" in limit_zone \"\"") + shm_zone->shm.name.len;
|
468
|
382
|
|
383 shpool->log_ctx = ngx_slab_alloc(shpool, len);
|
|
384 if (shpool->log_ctx == NULL) {
|
|
385 return NGX_ERROR;
|
|
386 }
|
|
387
|
480
|
388 ngx_sprintf(shpool->log_ctx, " in limit_zone \"%V\"%Z",
|
|
389 &shm_zone->shm.name);
|
468
|
390
|
272
|
391 return NGX_OK;
|
|
392 }
|
|
393
|
|
394
|
|
395 static void *
|
|
396 ngx_http_limit_zone_create_conf(ngx_conf_t *cf)
|
|
397 {
|
|
398 ngx_http_limit_zone_conf_t *conf;
|
|
399
|
|
400 conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_limit_zone_conf_t));
|
|
401 if (conf == NULL) {
|
496
|
402 return NULL;
|
272
|
403 }
|
|
404
|
|
405 /*
|
|
406 * set by ngx_pcalloc():
|
|
407 *
|
|
408 * conf->shm_zone = NULL;
|
|
409 * conf->conn = 0;
|
|
410 */
|
|
411
|
532
|
412 conf->log_level = NGX_CONF_UNSET_UINT;
|
|
413
|
272
|
414 return conf;
|
|
415 }
|
|
416
|
|
417
|
|
418 static char *
|
|
419 ngx_http_limit_zone_merge_conf(ngx_conf_t *cf, void *parent, void *child)
|
|
420 {
|
|
421 ngx_http_limit_zone_conf_t *prev = parent;
|
|
422 ngx_http_limit_zone_conf_t *conf = child;
|
|
423
|
|
424 if (conf->shm_zone == NULL) {
|
644
|
425 conf->shm_zone = prev->shm_zone;
|
|
426 conf->conn = prev->conn;
|
272
|
427 }
|
|
428
|
532
|
429 ngx_conf_merge_uint_value(conf->log_level, prev->log_level, NGX_LOG_ERR);
|
|
430
|
272
|
431 return NGX_CONF_OK;
|
|
432 }
|
|
433
|
|
434
|
|
435 static char *
|
|
436 ngx_http_limit_zone(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
|
|
437 {
|
|
438 ssize_t n;
|
|
439 ngx_str_t *value;
|
|
440 ngx_shm_zone_t *shm_zone;
|
|
441 ngx_http_limit_zone_ctx_t *ctx;
|
|
442
|
|
443 value = cf->args->elts;
|
|
444
|
|
445 if (value[2].data[0] != '$') {
|
|
446 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
|
|
447 "invalid variable name \"%V\"", &value[2]);
|
|
448 return NGX_CONF_ERROR;
|
|
449 }
|
|
450
|
|
451 value[2].len--;
|
|
452 value[2].data++;
|
|
453
|
|
454 ctx = ngx_pcalloc(cf->pool, sizeof(ngx_http_limit_zone_ctx_t));
|
|
455 if (ctx == NULL) {
|
|
456 return NGX_CONF_ERROR;
|
|
457 }
|
|
458
|
|
459 ctx->index = ngx_http_get_variable_index(cf, &value[2]);
|
|
460 if (ctx->index == NGX_ERROR) {
|
|
461 return NGX_CONF_ERROR;
|
|
462 }
|
|
463
|
|
464 ctx->var = value[2];
|
|
465
|
|
466 n = ngx_parse_size(&value[3]);
|
|
467
|
|
468 if (n == NGX_ERROR) {
|
|
469 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
|
|
470 "invalid size of limit_zone \"%V\"", &value[3]);
|
|
471 return NGX_CONF_ERROR;
|
|
472 }
|
|
473
|
|
474 if (n < (ngx_int_t) (8 * ngx_pagesize)) {
|
|
475 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
|
|
476 "limit_zone \"%V\" is too small", &value[1]);
|
|
477 return NGX_CONF_ERROR;
|
|
478 }
|
|
479
|
|
480
|
|
481 shm_zone = ngx_shared_memory_add(cf, &value[1], n,
|
|
482 &ngx_http_limit_zone_module);
|
|
483 if (shm_zone == NULL) {
|
|
484 return NGX_CONF_ERROR;
|
|
485 }
|
|
486
|
|
487 if (shm_zone->data) {
|
|
488 ctx = shm_zone->data;
|
|
489
|
|
490 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
|
|
491 "limit_zone \"%V\" is already bound to variable \"%V\"",
|
|
492 &value[1], &ctx->var);
|
|
493 return NGX_CONF_ERROR;
|
|
494 }
|
|
495
|
|
496 shm_zone->init = ngx_http_limit_zone_init_zone;
|
|
497 shm_zone->data = ctx;
|
|
498
|
|
499 return NGX_CONF_OK;
|
|
500 }
|
|
501
|
|
502
|
|
503 static char *
|
|
504 ngx_http_limit_conn(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
|
|
505 {
|
|
506 ngx_http_limit_zone_conf_t *lzcf = conf;
|
|
507
|
|
508 ngx_int_t n;
|
|
509 ngx_str_t *value;
|
|
510
|
426
|
511 if (lzcf->shm_zone) {
|
|
512 return "is duplicate";
|
|
513 }
|
|
514
|
272
|
515 value = cf->args->elts;
|
|
516
|
|
517 lzcf->shm_zone = ngx_shared_memory_add(cf, &value[1], 0,
|
|
518 &ngx_http_limit_zone_module);
|
|
519 if (lzcf->shm_zone == NULL) {
|
|
520 return NGX_CONF_ERROR;
|
|
521 }
|
|
522
|
|
523 n = ngx_atoi(value[2].data, value[2].len);
|
|
524 if (n <= 0) {
|
|
525 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
|
|
526 "invalid number of connections \"%V\"", &value[2]);
|
|
527 return NGX_CONF_ERROR;
|
|
528 }
|
|
529
|
274
|
530 if (n > 65535) {
|
|
531 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
|
|
532 "connection limit must be less 65536");
|
|
533 return NGX_CONF_ERROR;
|
|
534 }
|
|
535
|
272
|
536 lzcf->conn = n;
|
|
537
|
|
538 return NGX_CONF_OK;
|
|
539 }
|
|
540
|
|
541
|
|
542 static ngx_int_t
|
|
543 ngx_http_limit_zone_init(ngx_conf_t *cf)
|
|
544 {
|
|
545 ngx_http_handler_pt *h;
|
|
546 ngx_http_core_main_conf_t *cmcf;
|
|
547
|
|
548 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
|
|
549
|
|
550 h = ngx_array_push(&cmcf->phases[NGX_HTTP_PREACCESS_PHASE].handlers);
|
|
551 if (h == NULL) {
|
|
552 return NGX_ERROR;
|
|
553 }
|
|
554
|
|
555 *h = ngx_http_limit_zone_handler;
|
|
556
|
|
557 return NGX_OK;
|
|
558 }
|