3 * Copyright (C) Igor Sysoev
7 #include <ngx_config.h>
13 ngx_http_upstream_conf_t upstream;
15 } ngx_http_memcached_loc_conf_t;
20 ngx_http_request_t *request;
22 } ngx_http_memcached_ctx_t;
25 static ngx_int_t ngx_http_memcached_create_request(ngx_http_request_t *r);
26 static ngx_int_t ngx_http_memcached_reinit_request(ngx_http_request_t *r);
27 static ngx_int_t ngx_http_memcached_process_header(ngx_http_request_t *r);
28 static ngx_int_t ngx_http_memcached_filter_init(void *data);
29 static ngx_int_t ngx_http_memcached_filter(void *data, ssize_t bytes);
30 static void ngx_http_memcached_abort_request(ngx_http_request_t *r);
31 static void ngx_http_memcached_finalize_request(ngx_http_request_t *r,
34 static void *ngx_http_memcached_create_loc_conf(ngx_conf_t *cf);
35 static char *ngx_http_memcached_merge_loc_conf(ngx_conf_t *cf,
36 void *parent, void *child);
38 static char *ngx_http_memcached_pass(ngx_conf_t *cf, ngx_command_t *cmd,
41 static char *ngx_http_memcached_upstream_max_fails_unsupported(ngx_conf_t *cf,
42 ngx_command_t *cmd, void *conf);
43 static char *ngx_http_memcached_upstream_fail_timeout_unsupported(ngx_conf_t *cf,
44 ngx_command_t *cmd, void *conf);
47 static ngx_conf_bitmask_t ngx_http_memcached_next_upstream_masks[] = {
48 { ngx_string("error"), NGX_HTTP_UPSTREAM_FT_ERROR },
49 { ngx_string("timeout"), NGX_HTTP_UPSTREAM_FT_TIMEOUT },
50 { ngx_string("invalid_response"), NGX_HTTP_UPSTREAM_FT_INVALID_HEADER },
51 { ngx_string("not_found"), NGX_HTTP_UPSTREAM_FT_HTTP_404 },
52 { ngx_string("off"), NGX_HTTP_UPSTREAM_FT_OFF },
53 { ngx_null_string, 0 }
57 static ngx_command_t ngx_http_memcached_commands[] = {
59 { ngx_string("memcached_pass"),
60 NGX_HTTP_LOC_CONF|NGX_HTTP_LIF_CONF|NGX_CONF_TAKE1,
61 ngx_http_memcached_pass,
62 NGX_HTTP_LOC_CONF_OFFSET,
66 { ngx_string("memcached_connect_timeout"),
67 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
68 ngx_conf_set_msec_slot,
69 NGX_HTTP_LOC_CONF_OFFSET,
70 offsetof(ngx_http_memcached_loc_conf_t, upstream.connect_timeout),
73 { ngx_string("memcached_send_timeout"),
74 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
75 ngx_conf_set_msec_slot,
76 NGX_HTTP_LOC_CONF_OFFSET,
77 offsetof(ngx_http_memcached_loc_conf_t, upstream.send_timeout),
80 { ngx_string("memcached_buffer_size"),
81 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
82 ngx_conf_set_size_slot,
83 NGX_HTTP_LOC_CONF_OFFSET,
84 offsetof(ngx_http_memcached_loc_conf_t, upstream.buffer_size),
87 { ngx_string("memcached_read_timeout"),
88 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
89 ngx_conf_set_msec_slot,
90 NGX_HTTP_LOC_CONF_OFFSET,
91 offsetof(ngx_http_memcached_loc_conf_t, upstream.read_timeout),
94 { ngx_string("memcached_next_upstream"),
95 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_1MORE,
96 ngx_conf_set_bitmask_slot,
97 NGX_HTTP_LOC_CONF_OFFSET,
98 offsetof(ngx_http_memcached_loc_conf_t, upstream.next_upstream),
99 &ngx_http_memcached_next_upstream_masks },
101 { ngx_string("memcached_upstream_max_fails"),
102 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
103 ngx_http_memcached_upstream_max_fails_unsupported,
108 { ngx_string("memcached_upstream_fail_timeout"),
109 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
110 ngx_http_memcached_upstream_fail_timeout_unsupported,
119 static ngx_http_module_t ngx_http_memcached_module_ctx = {
120 NULL, /* preconfiguration */
121 NULL, /* postconfiguration */
123 NULL, /* create main configuration */
124 NULL, /* init main configuration */
126 NULL, /* create server configuration */
127 NULL, /* merge server configuration */
129 ngx_http_memcached_create_loc_conf, /* create location configration */
130 ngx_http_memcached_merge_loc_conf /* merge location configration */
134 ngx_module_t ngx_http_memcached_module = {
136 &ngx_http_memcached_module_ctx, /* module context */
137 ngx_http_memcached_commands, /* module directives */
138 NGX_HTTP_MODULE, /* module type */
139 NULL, /* init master */
140 NULL, /* init module */
141 NULL, /* init process */
142 NULL, /* init thread */
143 NULL, /* exit thread */
144 NULL, /* exit process */
145 NULL, /* exit master */
146 NGX_MODULE_V1_PADDING
150 static ngx_str_t ngx_http_memcached_key = ngx_string("memcached_key");
153 #define NGX_HTTP_MEMCACHED_END (sizeof(ngx_http_memcached_end) - 1)
154 static u_char ngx_http_memcached_end[] = CRLF "END" CRLF;
158 ngx_http_memcached_handler(ngx_http_request_t *r)
161 ngx_http_upstream_t *u;
162 ngx_http_memcached_ctx_t *ctx;
163 ngx_http_memcached_loc_conf_t *mlcf;
165 if (!(r->method & (NGX_HTTP_GET|NGX_HTTP_HEAD))) {
166 return NGX_HTTP_NOT_ALLOWED;
169 rc = ngx_http_discard_request_body(r);
175 if (ngx_http_set_content_type(r) != NGX_OK) {
176 return NGX_HTTP_INTERNAL_SERVER_ERROR;
179 mlcf = ngx_http_get_module_loc_conf(r, ngx_http_memcached_module);
181 u = ngx_pcalloc(r->pool, sizeof(ngx_http_upstream_t));
183 return NGX_HTTP_INTERNAL_SERVER_ERROR;
186 u->schema.len = sizeof("memcached://") - 1;
187 u->schema.data = (u_char *) "memcached://";
189 u->peer.log = r->connection->log;
190 u->peer.log_error = NGX_ERROR_ERR;
192 u->peer.lock = &r->connection->lock;
195 u->output.tag = (ngx_buf_tag_t) &ngx_http_memcached_module;
197 u->conf = &mlcf->upstream;
199 u->create_request = ngx_http_memcached_create_request;
200 u->reinit_request = ngx_http_memcached_reinit_request;
201 u->process_header = ngx_http_memcached_process_header;
202 u->abort_request = ngx_http_memcached_abort_request;
203 u->finalize_request = ngx_http_memcached_finalize_request;
207 ctx = ngx_palloc(r->pool, sizeof(ngx_http_memcached_ctx_t));
209 return NGX_HTTP_INTERNAL_SERVER_ERROR;
212 ctx->rest = NGX_HTTP_MEMCACHED_END;
215 ngx_http_set_ctx(r, ctx, ngx_http_memcached_module);
217 u->input_filter_init = ngx_http_memcached_filter_init;
218 u->input_filter = ngx_http_memcached_filter;
219 u->input_filter_ctx = ctx;
221 ngx_http_upstream_init(r);
228 ngx_http_memcached_create_request(ngx_http_request_t *r)
234 ngx_http_memcached_ctx_t *ctx;
235 ngx_http_variable_value_t *vv;
236 ngx_http_memcached_loc_conf_t *mlcf;
238 mlcf = ngx_http_get_module_loc_conf(r, ngx_http_memcached_module);
240 vv = ngx_http_get_indexed_variable(r, mlcf->index);
242 if (vv == NULL || vv->not_found || vv->len == 0) {
243 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
244 "the \"$memcached_key\" variable is not set");
248 escape = 2 * ngx_escape_uri(NULL, vv->data, vv->len, NGX_ESCAPE_MEMCACHED);
250 len = sizeof("get ") - 1 + vv->len + escape + sizeof(CRLF) - 1;
252 b = ngx_create_temp_buf(r->pool, len);
257 cl = ngx_alloc_chain_link(r->pool);
265 r->upstream->request_bufs = cl;
267 *b->last++ = 'g'; *b->last++ = 'e'; *b->last++ = 't'; *b->last++ = ' ';
269 ctx = ngx_http_get_module_ctx(r, ngx_http_memcached_module);
271 ctx->key.data = b->last;
274 b->last = ngx_copy(b->last, vv->data, vv->len);
277 b->last = (u_char *) ngx_escape_uri(b->last, vv->data, vv->len,
278 NGX_ESCAPE_MEMCACHED);
281 ctx->key.len = b->last - ctx->key.data;
283 ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
284 "http memcached request: \"%V\"", &ctx->key);
286 *b->last++ = CR; *b->last++ = LF;
293 ngx_http_memcached_reinit_request(ngx_http_request_t *r)
300 ngx_http_memcached_process_header(ngx_http_request_t *r)
304 ngx_http_upstream_t *u;
305 ngx_http_memcached_ctx_t *ctx;
309 for (p = u->buffer.pos; p < u->buffer.last; p++) {
321 line.len = p - u->buffer.pos - 1;
322 line.data = u->buffer.pos;
324 ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
325 "memcached: \"%V\"", &line);
329 ctx = ngx_http_get_module_ctx(r, ngx_http_memcached_module);
331 if (ngx_strncmp(p, "VALUE ", sizeof("VALUE ") - 1) == 0) {
333 p += sizeof("VALUE ") - 1;
335 if (ngx_strncmp(p, ctx->key.data, ctx->key.len) != 0) {
336 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
337 "memcached sent invalid key in response \"%V\" "
341 return NGX_HTTP_UPSTREAM_INVALID_HEADER;
364 while (*p && *p++ != CR) { /* void */ }
366 r->headers_out.content_length_n = ngx_atoof(len, p - len - 1);
367 if (r->headers_out.content_length_n == -1) {
368 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
369 "memcached sent invalid length in response \"%V\" "
372 return NGX_HTTP_UPSTREAM_INVALID_HEADER;
375 u->headers_in.status_n = 200;
376 u->state->status = 200;
377 u->buffer.pos = p + 1;
382 if (ngx_strcmp(p, "END\x0d") == 0) {
383 ngx_log_error(NGX_LOG_INFO, r->connection->log, 0,
384 "key: \"%V\" was not found by memcached", &ctx->key);
386 u->headers_in.status_n = 404;
387 u->state->status = 404;
394 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
395 "memcached sent invalid response: \"%V\"", &line);
397 return NGX_HTTP_UPSTREAM_INVALID_HEADER;
402 ngx_http_memcached_filter_init(void *data)
404 ngx_http_memcached_ctx_t *ctx = data;
406 ngx_http_upstream_t *u;
408 u = ctx->request->upstream;
410 u->length += NGX_HTTP_MEMCACHED_END;
417 ngx_http_memcached_filter(void *data, ssize_t bytes)
419 ngx_http_memcached_ctx_t *ctx = data;
423 ngx_chain_t *cl, **ll;
424 ngx_http_upstream_t *u;
426 u = ctx->request->upstream;
429 if (u->length == ctx->rest) {
431 if (ngx_strncmp(b->last,
432 ngx_http_memcached_end + NGX_HTTP_MEMCACHED_END - ctx->rest,
436 ngx_log_error(NGX_LOG_ERR, ctx->request->connection->log, 0,
437 "memcached sent invalid trailer");
446 for (cl = u->out_bufs, ll = &u->out_bufs; cl; cl = cl->next) {
450 cl = ngx_chain_get_free_buf(ctx->request->pool, &u->free_bufs);
463 cl->buf->last = b->last;
464 cl->buf->tag = u->output.tag;
466 ngx_log_debug4(NGX_LOG_DEBUG_HTTP, ctx->request->connection->log, 0,
467 "memcached filter bytes:%z size:%z length:%z rest:%z",
468 bytes, b->last - b->pos, u->length, ctx->rest);
470 if (bytes <= (ssize_t) (u->length - NGX_HTTP_MEMCACHED_END)) {
475 last += u->length - NGX_HTTP_MEMCACHED_END;
477 if (ngx_strncmp(last, ngx_http_memcached_end, b->last - last) != 0) {
478 ngx_log_error(NGX_LOG_ERR, ctx->request->connection->log, 0,
479 "memcached sent invalid trailer");
482 ctx->rest -= b->last - last;
484 cl->buf->last = last;
485 u->length = ctx->rest;
492 ngx_http_memcached_abort_request(ngx_http_request_t *r)
494 ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
495 "abort http memcached request");
501 ngx_http_memcached_finalize_request(ngx_http_request_t *r, ngx_int_t rc)
503 ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
504 "finalize http memcached request");
510 ngx_http_memcached_create_loc_conf(ngx_conf_t *cf)
512 ngx_http_memcached_loc_conf_t *conf;
514 conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_memcached_loc_conf_t));
516 return NGX_CONF_ERROR;
520 * set by ngx_pcalloc():
522 * conf->upstream.bufs.num = 0;
523 * conf->upstream.next_upstream = 0;
524 * conf->upstream.temp_path = NULL;
525 * conf->upstream.uri = { 0, NULL };
526 * conf->upstream.location = NULL;
529 conf->upstream.connect_timeout = NGX_CONF_UNSET_MSEC;
530 conf->upstream.send_timeout = NGX_CONF_UNSET_MSEC;
531 conf->upstream.read_timeout = NGX_CONF_UNSET_MSEC;
533 conf->upstream.buffer_size = NGX_CONF_UNSET_SIZE;
535 /* the hardcoded values */
536 conf->upstream.cyclic_temp_file = 0;
537 conf->upstream.buffering = 0;
538 conf->upstream.ignore_client_abort = 0;
539 conf->upstream.send_lowat = 0;
540 conf->upstream.bufs.num = 0;
541 conf->upstream.busy_buffers_size = 0;
542 conf->upstream.max_temp_file_size = 0;
543 conf->upstream.temp_file_write_size = 0;
544 conf->upstream.intercept_errors = 1;
545 conf->upstream.intercept_404 = 1;
546 conf->upstream.pass_request_headers = 0;
547 conf->upstream.pass_request_body = 0;
549 conf->index = NGX_CONF_UNSET;
556 ngx_http_memcached_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
558 ngx_http_memcached_loc_conf_t *prev = parent;
559 ngx_http_memcached_loc_conf_t *conf = child;
561 ngx_conf_merge_msec_value(conf->upstream.connect_timeout,
562 prev->upstream.connect_timeout, 60000);
564 ngx_conf_merge_msec_value(conf->upstream.send_timeout,
565 prev->upstream.send_timeout, 60000);
567 ngx_conf_merge_msec_value(conf->upstream.read_timeout,
568 prev->upstream.read_timeout, 60000);
570 ngx_conf_merge_size_value(conf->upstream.buffer_size,
571 prev->upstream.buffer_size,
572 (size_t) ngx_pagesize);
574 ngx_conf_merge_bitmask_value(conf->upstream.next_upstream,
575 prev->upstream.next_upstream,
576 (NGX_CONF_BITMASK_SET
577 |NGX_HTTP_UPSTREAM_FT_ERROR
578 |NGX_HTTP_UPSTREAM_FT_TIMEOUT));
580 if (conf->upstream.next_upstream & NGX_HTTP_UPSTREAM_FT_OFF) {
581 conf->upstream.next_upstream = NGX_CONF_BITMASK_SET
582 |NGX_HTTP_UPSTREAM_FT_OFF;
585 if (conf->upstream.upstream == NULL) {
586 conf->upstream.upstream = prev->upstream.upstream;
589 if (conf->index == NGX_CONF_UNSET) {
590 conf->index = prev->index;
598 ngx_http_memcached_pass(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
600 ngx_http_memcached_loc_conf_t *mlcf = conf;
604 ngx_http_core_loc_conf_t *clcf;
606 if (mlcf->upstream.upstream) {
607 return "is duplicate";
610 value = cf->args->elts;
612 ngx_memzero(&u, sizeof(ngx_url_t));
617 mlcf->upstream.upstream = ngx_http_upstream_add(cf, &u, 0);
618 if (mlcf->upstream.upstream == NULL) {
619 return NGX_CONF_ERROR;
622 clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
624 clcf->handler = ngx_http_memcached_handler;
626 if (clcf->name.data[clcf->name.len - 1] == '/') {
627 clcf->auto_redirect = 1;
630 mlcf->index = ngx_http_get_variable_index(cf, &ngx_http_memcached_key);
632 if (mlcf->index == NGX_ERROR) {
633 return NGX_CONF_ERROR;
641 ngx_http_memcached_upstream_max_fails_unsupported(ngx_conf_t *cf,
642 ngx_command_t *cmd, void *conf)
644 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
645 "\"memcached_upstream_max_fails\" is not supported, "
646 "use the \"max_fails\" parameter of the \"server\" directive ",
647 "inside the \"upstream\" block");
649 return NGX_CONF_ERROR;
654 ngx_http_memcached_upstream_fail_timeout_unsupported(ngx_conf_t *cf,
655 ngx_command_t *cmd, void *conf)
657 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
658 "\"memcached_upstream_fail_timeout\" is not supported, "
659 "use the \"fail_timeout\" parameter of the \"server\" directive ",
660 "inside the \"upstream\" block");
662 return NGX_CONF_ERROR;