4127
|
1
|
|
2 /*
|
|
3 * Copyright (C) Maxim Dounin
|
4412
|
4 * Copyright (C) Nginx, Inc.
|
4127
|
5 */
|
|
6
|
|
7
|
|
8 #include <ngx_config.h>
|
|
9 #include <ngx_core.h>
|
|
10 #include <ngx_http.h>
|
|
11
|
|
12
|
|
13 typedef struct {
|
|
14 ngx_uint_t max_cached;
|
|
15 ngx_uint_t single; /* unsigned:1 */
|
|
16
|
|
17 ngx_queue_t cache;
|
|
18 ngx_queue_t free;
|
|
19
|
|
20 ngx_http_upstream_init_pt original_init_upstream;
|
|
21 ngx_http_upstream_init_peer_pt original_init_peer;
|
|
22
|
|
23 } ngx_http_upstream_keepalive_srv_conf_t;
|
|
24
|
|
25
|
|
26 typedef struct {
|
|
27 ngx_http_upstream_keepalive_srv_conf_t *conf;
|
|
28
|
|
29 ngx_http_upstream_t *upstream;
|
|
30
|
|
31 void *data;
|
|
32
|
|
33 ngx_event_get_peer_pt original_get_peer;
|
|
34 ngx_event_free_peer_pt original_free_peer;
|
|
35
|
|
36 #if (NGX_HTTP_SSL)
|
|
37 ngx_event_set_peer_session_pt original_set_session;
|
|
38 ngx_event_save_peer_session_pt original_save_session;
|
|
39 #endif
|
|
40
|
|
41 ngx_uint_t failed; /* unsigned:1 */
|
|
42
|
|
43 } ngx_http_upstream_keepalive_peer_data_t;
|
|
44
|
|
45
|
|
46 typedef struct {
|
|
47 ngx_http_upstream_keepalive_srv_conf_t *conf;
|
|
48
|
|
49 ngx_queue_t queue;
|
|
50 ngx_connection_t *connection;
|
|
51
|
|
52 socklen_t socklen;
|
|
53 u_char sockaddr[NGX_SOCKADDRLEN];
|
|
54
|
|
55 } ngx_http_upstream_keepalive_cache_t;
|
|
56
|
|
57
|
|
58 static ngx_int_t ngx_http_upstream_init_keepalive_peer(ngx_http_request_t *r,
|
|
59 ngx_http_upstream_srv_conf_t *us);
|
|
60 static ngx_int_t ngx_http_upstream_get_keepalive_peer(ngx_peer_connection_t *pc,
|
|
61 void *data);
|
|
62 static void ngx_http_upstream_free_keepalive_peer(ngx_peer_connection_t *pc,
|
|
63 void *data, ngx_uint_t state);
|
|
64
|
|
65 static void ngx_http_upstream_keepalive_dummy_handler(ngx_event_t *ev);
|
|
66 static void ngx_http_upstream_keepalive_close_handler(ngx_event_t *ev);
|
|
67 static void ngx_http_upstream_keepalive_close(ngx_connection_t *c);
|
|
68
|
|
69
|
|
70 #if (NGX_HTTP_SSL)
|
|
71 static ngx_int_t ngx_http_upstream_keepalive_set_session(
|
|
72 ngx_peer_connection_t *pc, void *data);
|
|
73 static void ngx_http_upstream_keepalive_save_session(ngx_peer_connection_t *pc,
|
|
74 void *data);
|
|
75 #endif
|
|
76
|
|
77 static void *ngx_http_upstream_keepalive_create_conf(ngx_conf_t *cf);
|
|
78 static char *ngx_http_upstream_keepalive(ngx_conf_t *cf, ngx_command_t *cmd,
|
|
79 void *conf);
|
|
80
|
|
81
|
|
82 static ngx_command_t ngx_http_upstream_keepalive_commands[] = {
|
|
83
|
|
84 { ngx_string("keepalive"),
|
|
85 NGX_HTTP_UPS_CONF|NGX_CONF_TAKE12,
|
|
86 ngx_http_upstream_keepalive,
|
|
87 0,
|
|
88 0,
|
|
89 NULL },
|
|
90
|
|
91 ngx_null_command
|
|
92 };
|
|
93
|
|
94
|
|
95 static ngx_http_module_t ngx_http_upstream_keepalive_module_ctx = {
|
|
96 NULL, /* preconfiguration */
|
|
97 NULL, /* postconfiguration */
|
|
98
|
|
99 NULL, /* create main configuration */
|
|
100 NULL, /* init main configuration */
|
|
101
|
|
102 ngx_http_upstream_keepalive_create_conf, /* create server configuration */
|
|
103 NULL, /* merge server configuration */
|
|
104
|
|
105 NULL, /* create location configuration */
|
|
106 NULL /* merge location configuration */
|
|
107 };
|
|
108
|
|
109
|
|
110 ngx_module_t ngx_http_upstream_keepalive_module = {
|
|
111 NGX_MODULE_V1,
|
|
112 &ngx_http_upstream_keepalive_module_ctx, /* module context */
|
|
113 ngx_http_upstream_keepalive_commands, /* module directives */
|
|
114 NGX_HTTP_MODULE, /* module type */
|
|
115 NULL, /* init master */
|
|
116 NULL, /* init module */
|
|
117 NULL, /* init process */
|
|
118 NULL, /* init thread */
|
|
119 NULL, /* exit thread */
|
|
120 NULL, /* exit process */
|
|
121 NULL, /* exit master */
|
|
122 NGX_MODULE_V1_PADDING
|
|
123 };
|
|
124
|
|
125
|
|
126 static ngx_int_t
|
|
127 ngx_http_upstream_init_keepalive(ngx_conf_t *cf,
|
|
128 ngx_http_upstream_srv_conf_t *us)
|
|
129 {
|
|
130 ngx_uint_t i;
|
|
131 ngx_http_upstream_keepalive_srv_conf_t *kcf;
|
|
132 ngx_http_upstream_keepalive_cache_t *cached;
|
|
133
|
|
134 ngx_log_debug0(NGX_LOG_DEBUG_HTTP, cf->log, 0,
|
|
135 "init keepalive");
|
|
136
|
|
137 kcf = ngx_http_conf_upstream_srv_conf(us,
|
|
138 ngx_http_upstream_keepalive_module);
|
|
139
|
|
140 if (kcf->original_init_upstream(cf, us) != NGX_OK) {
|
|
141 return NGX_ERROR;
|
|
142 }
|
|
143
|
|
144 kcf->original_init_peer = us->peer.init;
|
|
145
|
|
146 us->peer.init = ngx_http_upstream_init_keepalive_peer;
|
|
147
|
|
148 /* allocate cache items and add to free queue */
|
|
149
|
|
150 cached = ngx_pcalloc(cf->pool,
|
|
151 sizeof(ngx_http_upstream_keepalive_cache_t) * kcf->max_cached);
|
|
152 if (cached == NULL) {
|
|
153 return NGX_ERROR;
|
|
154 }
|
|
155
|
|
156 ngx_queue_init(&kcf->cache);
|
|
157 ngx_queue_init(&kcf->free);
|
|
158
|
|
159 for (i = 0; i < kcf->max_cached; i++) {
|
|
160 ngx_queue_insert_head(&kcf->free, &cached[i].queue);
|
|
161 cached[i].conf = kcf;
|
|
162 }
|
|
163
|
|
164 return NGX_OK;
|
|
165 }
|
|
166
|
|
167
|
|
168 static ngx_int_t
|
|
169 ngx_http_upstream_init_keepalive_peer(ngx_http_request_t *r,
|
|
170 ngx_http_upstream_srv_conf_t *us)
|
|
171 {
|
|
172 ngx_http_upstream_keepalive_peer_data_t *kp;
|
|
173 ngx_http_upstream_keepalive_srv_conf_t *kcf;
|
|
174
|
|
175 ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
|
|
176 "init keepalive peer");
|
|
177
|
|
178 kcf = ngx_http_conf_upstream_srv_conf(us,
|
|
179 ngx_http_upstream_keepalive_module);
|
|
180
|
|
181 kp = ngx_palloc(r->pool, sizeof(ngx_http_upstream_keepalive_peer_data_t));
|
|
182 if (kp == NULL) {
|
|
183 return NGX_ERROR;
|
|
184 }
|
|
185
|
|
186 if (kcf->original_init_peer(r, us) != NGX_OK) {
|
|
187 return NGX_ERROR;
|
|
188 }
|
|
189
|
|
190 kp->conf = kcf;
|
|
191 kp->upstream = r->upstream;
|
|
192 kp->data = r->upstream->peer.data;
|
|
193 kp->original_get_peer = r->upstream->peer.get;
|
|
194 kp->original_free_peer = r->upstream->peer.free;
|
|
195
|
|
196 r->upstream->peer.data = kp;
|
|
197 r->upstream->peer.get = ngx_http_upstream_get_keepalive_peer;
|
|
198 r->upstream->peer.free = ngx_http_upstream_free_keepalive_peer;
|
|
199
|
|
200 #if (NGX_HTTP_SSL)
|
|
201 kp->original_set_session = r->upstream->peer.set_session;
|
|
202 kp->original_save_session = r->upstream->peer.save_session;
|
|
203 r->upstream->peer.set_session = ngx_http_upstream_keepalive_set_session;
|
|
204 r->upstream->peer.save_session = ngx_http_upstream_keepalive_save_session;
|
|
205 #endif
|
|
206
|
|
207 return NGX_OK;
|
|
208 }
|
|
209
|
|
210
|
|
211 static ngx_int_t
|
|
212 ngx_http_upstream_get_keepalive_peer(ngx_peer_connection_t *pc, void *data)
|
|
213 {
|
|
214 ngx_http_upstream_keepalive_peer_data_t *kp = data;
|
|
215 ngx_http_upstream_keepalive_cache_t *item;
|
|
216
|
|
217 ngx_int_t rc;
|
|
218 ngx_queue_t *q, *cache;
|
|
219 ngx_connection_t *c;
|
|
220
|
|
221 ngx_log_debug0(NGX_LOG_DEBUG_HTTP, pc->log, 0,
|
|
222 "get keepalive peer");
|
|
223
|
|
224 kp->failed = 0;
|
|
225
|
|
226 /* single pool of cached connections */
|
|
227
|
|
228 if (kp->conf->single && !ngx_queue_empty(&kp->conf->cache)) {
|
|
229
|
|
230 q = ngx_queue_head(&kp->conf->cache);
|
|
231
|
|
232 item = ngx_queue_data(q, ngx_http_upstream_keepalive_cache_t, queue);
|
|
233 c = item->connection;
|
|
234
|
|
235 ngx_queue_remove(q);
|
|
236 ngx_queue_insert_head(&kp->conf->free, q);
|
|
237
|
|
238 ngx_log_debug1(NGX_LOG_DEBUG_HTTP, pc->log, 0,
|
|
239 "get keepalive peer: using connection %p", c);
|
|
240
|
|
241 c->idle = 0;
|
|
242 c->log = pc->log;
|
|
243 c->read->log = pc->log;
|
|
244 c->write->log = pc->log;
|
|
245 c->pool->log = pc->log;
|
|
246
|
|
247 pc->connection = c;
|
|
248 pc->cached = 1;
|
|
249
|
|
250 return NGX_DONE;
|
|
251 }
|
|
252
|
|
253 rc = kp->original_get_peer(pc, kp->data);
|
|
254
|
|
255 if (kp->conf->single || rc != NGX_OK) {
|
|
256 return rc;
|
|
257 }
|
|
258
|
|
259 /* search cache for suitable connection */
|
|
260
|
|
261 cache = &kp->conf->cache;
|
|
262
|
|
263 for (q = ngx_queue_head(cache);
|
|
264 q != ngx_queue_sentinel(cache);
|
|
265 q = ngx_queue_next(q))
|
|
266 {
|
|
267 item = ngx_queue_data(q, ngx_http_upstream_keepalive_cache_t, queue);
|
|
268 c = item->connection;
|
|
269
|
|
270 if (ngx_memn2cmp((u_char *) &item->sockaddr, (u_char *) pc->sockaddr,
|
|
271 item->socklen, pc->socklen)
|
|
272 == 0)
|
|
273 {
|
|
274 ngx_queue_remove(q);
|
|
275 ngx_queue_insert_head(&kp->conf->free, q);
|
|
276
|
|
277 ngx_log_debug1(NGX_LOG_DEBUG_HTTP, pc->log, 0,
|
|
278 "get keepalive peer: using connection %p", c);
|
|
279
|
|
280 c->idle = 0;
|
|
281 c->log = pc->log;
|
|
282 c->read->log = pc->log;
|
|
283 c->write->log = pc->log;
|
|
284 c->pool->log = pc->log;
|
|
285
|
|
286 pc->connection = c;
|
|
287 pc->cached = 1;
|
|
288
|
|
289 return NGX_DONE;
|
|
290 }
|
|
291 }
|
|
292
|
|
293 return NGX_OK;
|
|
294 }
|
|
295
|
|
296
|
|
297 static void
|
|
298 ngx_http_upstream_free_keepalive_peer(ngx_peer_connection_t *pc, void *data,
|
|
299 ngx_uint_t state)
|
|
300 {
|
|
301 ngx_http_upstream_keepalive_peer_data_t *kp = data;
|
|
302 ngx_http_upstream_keepalive_cache_t *item;
|
|
303
|
|
304 ngx_queue_t *q;
|
|
305 ngx_connection_t *c;
|
|
306 ngx_http_upstream_t *u;
|
|
307
|
|
308 ngx_log_debug0(NGX_LOG_DEBUG_HTTP, pc->log, 0,
|
|
309 "free keepalive peer");
|
|
310
|
|
311 /* remember failed state - peer.free() may be called more than once */
|
|
312
|
|
313 if (state & NGX_PEER_FAILED) {
|
|
314 kp->failed = 1;
|
|
315 }
|
|
316
|
|
317 /* cache valid connections */
|
|
318
|
|
319 u = kp->upstream;
|
|
320 c = pc->connection;
|
|
321
|
|
322 if (kp->failed
|
|
323 || c == NULL
|
|
324 || c->read->eof
|
|
325 || c->read->error
|
|
326 || c->read->timedout
|
|
327 || c->write->error
|
|
328 || c->write->timedout)
|
|
329 {
|
|
330 goto invalid;
|
|
331 }
|
|
332
|
|
333 if (!u->keepalive) {
|
|
334 goto invalid;
|
|
335 }
|
|
336
|
|
337 if (ngx_handle_read_event(c->read, 0) != NGX_OK) {
|
|
338 goto invalid;
|
|
339 }
|
|
340
|
|
341 ngx_log_debug1(NGX_LOG_DEBUG_HTTP, pc->log, 0,
|
|
342 "free keepalive peer: saving connection %p", c);
|
|
343
|
|
344 if (ngx_queue_empty(&kp->conf->free)) {
|
|
345
|
|
346 q = ngx_queue_last(&kp->conf->cache);
|
|
347 ngx_queue_remove(q);
|
|
348
|
|
349 item = ngx_queue_data(q, ngx_http_upstream_keepalive_cache_t, queue);
|
|
350
|
|
351 ngx_http_upstream_keepalive_close(item->connection);
|
|
352
|
|
353 } else {
|
|
354 q = ngx_queue_head(&kp->conf->free);
|
|
355 ngx_queue_remove(q);
|
|
356
|
|
357 item = ngx_queue_data(q, ngx_http_upstream_keepalive_cache_t, queue);
|
|
358 }
|
|
359
|
|
360 item->connection = c;
|
|
361 ngx_queue_insert_head(&kp->conf->cache, q);
|
|
362
|
|
363 pc->connection = NULL;
|
|
364
|
|
365 if (c->read->timer_set) {
|
|
366 ngx_del_timer(c->read);
|
|
367 }
|
|
368 if (c->write->timer_set) {
|
|
369 ngx_del_timer(c->write);
|
|
370 }
|
|
371
|
|
372 c->write->handler = ngx_http_upstream_keepalive_dummy_handler;
|
|
373 c->read->handler = ngx_http_upstream_keepalive_close_handler;
|
|
374
|
|
375 c->data = item;
|
|
376 c->idle = 1;
|
|
377 c->log = ngx_cycle->log;
|
|
378 c->read->log = ngx_cycle->log;
|
|
379 c->write->log = ngx_cycle->log;
|
|
380 c->pool->log = ngx_cycle->log;
|
|
381
|
|
382 item->socklen = pc->socklen;
|
|
383 ngx_memcpy(&item->sockaddr, pc->sockaddr, pc->socklen);
|
|
384
|
|
385 if (c->read->ready) {
|
|
386 ngx_http_upstream_keepalive_close_handler(c->read);
|
|
387 }
|
|
388
|
|
389 invalid:
|
|
390
|
|
391 kp->original_free_peer(pc, kp->data, state);
|
|
392 }
|
|
393
|
|
394
|
|
395 static void
|
|
396 ngx_http_upstream_keepalive_dummy_handler(ngx_event_t *ev)
|
|
397 {
|
|
398 ngx_log_debug0(NGX_LOG_DEBUG_HTTP, ev->log, 0,
|
|
399 "keepalive dummy handler");
|
|
400 }
|
|
401
|
|
402
|
|
403 static void
|
|
404 ngx_http_upstream_keepalive_close_handler(ngx_event_t *ev)
|
|
405 {
|
|
406 ngx_http_upstream_keepalive_srv_conf_t *conf;
|
|
407 ngx_http_upstream_keepalive_cache_t *item;
|
|
408
|
|
409 int n;
|
|
410 char buf[1];
|
|
411 ngx_connection_t *c;
|
|
412
|
|
413 ngx_log_debug0(NGX_LOG_DEBUG_HTTP, ev->log, 0,
|
|
414 "keepalive close handler");
|
|
415
|
|
416 c = ev->data;
|
|
417
|
|
418 if (c->close) {
|
|
419 goto close;
|
|
420 }
|
|
421
|
|
422 n = recv(c->fd, buf, 1, MSG_PEEK);
|
|
423
|
|
424 if (n == -1 && ngx_socket_errno == NGX_EAGAIN) {
|
|
425 /* stale event */
|
|
426
|
|
427 if (ngx_handle_read_event(c->read, 0) != NGX_OK) {
|
|
428 goto close;
|
|
429 }
|
|
430
|
|
431 return;
|
|
432 }
|
|
433
|
|
434 close:
|
|
435
|
|
436 item = c->data;
|
|
437 conf = item->conf;
|
|
438
|
|
439 ngx_http_upstream_keepalive_close(c);
|
|
440
|
|
441 ngx_queue_remove(&item->queue);
|
|
442 ngx_queue_insert_head(&conf->free, &item->queue);
|
|
443 }
|
|
444
|
|
445
|
|
446 static void
|
|
447 ngx_http_upstream_keepalive_close(ngx_connection_t *c)
|
|
448 {
|
|
449
|
|
450 #if (NGX_HTTP_SSL)
|
|
451
|
|
452 if (c->ssl) {
|
|
453 c->ssl->no_wait_shutdown = 1;
|
|
454 c->ssl->no_send_shutdown = 1;
|
|
455
|
|
456 if (ngx_ssl_shutdown(c) == NGX_AGAIN) {
|
|
457 c->ssl->handler = ngx_http_upstream_keepalive_close;
|
|
458 return;
|
|
459 }
|
|
460 }
|
|
461
|
|
462 #endif
|
|
463
|
|
464 ngx_destroy_pool(c->pool);
|
|
465 ngx_close_connection(c);
|
|
466 }
|
|
467
|
|
468
|
|
469 #if (NGX_HTTP_SSL)
|
|
470
|
|
471 static ngx_int_t
|
|
472 ngx_http_upstream_keepalive_set_session(ngx_peer_connection_t *pc, void *data)
|
|
473 {
|
|
474 ngx_http_upstream_keepalive_peer_data_t *kp = data;
|
|
475
|
|
476 return kp->original_set_session(pc, kp->data);
|
|
477 }
|
|
478
|
|
479
|
|
480 static void
|
|
481 ngx_http_upstream_keepalive_save_session(ngx_peer_connection_t *pc, void *data)
|
|
482 {
|
|
483 ngx_http_upstream_keepalive_peer_data_t *kp = data;
|
|
484
|
|
485 kp->original_save_session(pc, kp->data);
|
|
486 return;
|
|
487 }
|
|
488
|
|
489 #endif
|
|
490
|
|
491
|
|
492 static void *
|
|
493 ngx_http_upstream_keepalive_create_conf(ngx_conf_t *cf)
|
|
494 {
|
|
495 ngx_http_upstream_keepalive_srv_conf_t *conf;
|
|
496
|
|
497 conf = ngx_pcalloc(cf->pool,
|
|
498 sizeof(ngx_http_upstream_keepalive_srv_conf_t));
|
|
499 if (conf == NULL) {
|
|
500 return NULL;
|
|
501 }
|
|
502
|
|
503 /*
|
|
504 * set by ngx_pcalloc():
|
|
505 *
|
|
506 * conf->original_init_upstream = NULL;
|
|
507 * conf->original_init_peer = NULL;
|
|
508 */
|
|
509
|
|
510 conf->max_cached = 1;
|
|
511
|
|
512 return conf;
|
|
513 }
|
|
514
|
|
515
|
|
516 static char *
|
|
517 ngx_http_upstream_keepalive(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
|
|
518 {
|
|
519 ngx_http_upstream_srv_conf_t *uscf;
|
|
520 ngx_http_upstream_keepalive_srv_conf_t *kcf;
|
|
521
|
|
522 ngx_int_t n;
|
|
523 ngx_str_t *value;
|
|
524 ngx_uint_t i;
|
|
525
|
|
526 uscf = ngx_http_conf_get_module_srv_conf(cf, ngx_http_upstream_module);
|
|
527
|
|
528 kcf = ngx_http_conf_upstream_srv_conf(uscf,
|
|
529 ngx_http_upstream_keepalive_module);
|
|
530
|
|
531 kcf->original_init_upstream = uscf->peer.init_upstream
|
|
532 ? uscf->peer.init_upstream
|
|
533 : ngx_http_upstream_init_round_robin;
|
|
534
|
|
535 uscf->peer.init_upstream = ngx_http_upstream_init_keepalive;
|
|
536
|
|
537 /* read options */
|
|
538
|
|
539 value = cf->args->elts;
|
|
540
|
|
541 n = ngx_atoi(value[1].data, value[1].len);
|
|
542
|
|
543 if (n == NGX_ERROR || n == 0) {
|
|
544 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
|
|
545 "invalid value \"%V\" in \"%V\" directive",
|
|
546 &value[1], &cmd->name);
|
|
547 return NGX_CONF_ERROR;
|
|
548 }
|
|
549
|
|
550 kcf->max_cached = n;
|
|
551
|
|
552 for (i = 2; i < cf->args->nelts; i++) {
|
|
553
|
|
554 if (ngx_strcmp(value[i].data, "single") == 0) {
|
|
555 kcf->single = 1;
|
|
556 continue;
|
|
557 }
|
|
558
|
|
559 goto invalid;
|
|
560 }
|
|
561
|
|
562 return NGX_CONF_OK;
|
|
563
|
|
564 invalid:
|
|
565
|
|
566 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
|
|
567 "invalid parameter \"%V\"", &value[i]);
|
|
568
|
|
569 return NGX_CONF_ERROR;
|
|
570 }
|