8 #include "http_chunk.h"
10 #include "connections.h"
16 #include "inet_ntop_cache.h"
19 #include <sys/types.h>
31 #include "sys-socket.h"
33 #define data_proxy data_fastcgi
34 #define data_proxy_init data_fastcgi_init
36 #define PROXY_RETRY_TIMEOUT 60
40 * the proxy module is based on the fastcgi module
42 * 28.06.2004 Jan Kneschke The first release
43 * 01.07.2004 Evgeny Rodichev Several bugfixes and cleanups
44 * - co-ordinate up- and downstream flows correctly (proxy_demux_response
45 * and proxy_handle_fdevent)
46 * - correctly transfer upstream http_response_status;
47 * - some unused structures removed.
49 * TODO: - delay upstream read if write_queue is too large
50 * (to prevent memory eating, like in apache). Shoud be
52 * - persistent connection with upstream servers
66 proxy_balance_t balance
;
72 buffer
*parse_response
;
75 plugin_config
**config_storage
;
83 PROXY_STATE_PREPARE_WRITE
,
86 } proxy_connection_state_t
;
88 enum { PROXY_STDOUT
, PROXY_END_REQUEST
};
91 proxy_connection_state_t state
;
92 time_t state_timestamp
;
97 buffer
*response_header
;
102 int fd
; /* fd to the proxy process */
103 int fde_ndx
; /* index into the fd-event buffer */
105 size_t path_info_offset
; /* start of path_info in uri.path */
107 connection
*remote_conn
; /* dump pointer */
108 plugin_data
*plugin_data
; /* dump pointer */
112 /* ok, we need a prototype */
113 static handler_t
proxy_handle_fdevent(server
*srv
, void *ctx
, int revents
);
115 static handler_ctx
* handler_ctx_init(void) {
119 hctx
= calloc(1, sizeof(*hctx
));
121 hctx
->state
= PROXY_STATE_INIT
;
124 hctx
->response
= buffer_init();
125 hctx
->response_header
= buffer_init();
127 hctx
->wb
= chunkqueue_init();
136 static void handler_ctx_free(handler_ctx
*hctx
) {
137 buffer_free(hctx
->response
);
138 buffer_free(hctx
->response_header
);
139 chunkqueue_free(hctx
->wb
);
144 INIT_FUNC(mod_proxy_init
) {
147 p
= calloc(1, sizeof(*p
));
149 p
->parse_response
= buffer_init();
150 p
->balance_buf
= buffer_init();
156 FREE_FUNC(mod_proxy_free
) {
157 plugin_data
*p
= p_d
;
161 buffer_free(p
->parse_response
);
162 buffer_free(p
->balance_buf
);
164 if (p
->config_storage
) {
166 for (i
= 0; i
< srv
->config_context
->used
; i
++) {
167 plugin_config
*s
= p
->config_storage
[i
];
169 if (NULL
== s
) continue;
171 array_free(s
->extensions
);
175 free(p
->config_storage
);
180 return HANDLER_GO_ON
;
183 SETDEFAULTS_FUNC(mod_proxy_set_defaults
) {
184 plugin_data
*p
= p_d
;
188 config_values_t cv
[] = {
189 { "proxy.server", NULL
, T_CONFIG_LOCAL
, T_CONFIG_SCOPE_CONNECTION
}, /* 0 */
190 { "proxy.debug", NULL
, T_CONFIG_SHORT
, T_CONFIG_SCOPE_CONNECTION
}, /* 1 */
191 { "proxy.balance", NULL
, T_CONFIG_STRING
, T_CONFIG_SCOPE_CONNECTION
}, /* 2 */
192 { NULL
, NULL
, T_CONFIG_UNSET
, T_CONFIG_SCOPE_UNSET
}
195 p
->config_storage
= calloc(1, srv
->config_context
->used
* sizeof(plugin_config
*));
197 for (i
= 0; i
< srv
->config_context
->used
; i
++) {
198 data_config
const* config
= (data_config
const*)srv
->config_context
->data
[i
];
201 s
= malloc(sizeof(plugin_config
));
202 s
->extensions
= array_init();
205 cv
[0].destination
= s
->extensions
;
206 cv
[1].destination
= &(s
->debug
);
207 cv
[2].destination
= p
->balance_buf
;
209 buffer_reset(p
->balance_buf
);
211 p
->config_storage
[i
] = s
;
213 if (0 != config_insert_values_global(srv
, config
->value
, cv
, i
== 0 ? T_CONFIG_SCOPE_SERVER
: T_CONFIG_SCOPE_CONNECTION
)) {
214 return HANDLER_ERROR
;
217 if (buffer_string_is_empty(p
->balance_buf
)) {
218 s
->balance
= PROXY_BALANCE_FAIR
;
219 } else if (buffer_is_equal_string(p
->balance_buf
, CONST_STR_LEN("fair"))) {
220 s
->balance
= PROXY_BALANCE_FAIR
;
221 } else if (buffer_is_equal_string(p
->balance_buf
, CONST_STR_LEN("round-robin"))) {
222 s
->balance
= PROXY_BALANCE_RR
;
223 } else if (buffer_is_equal_string(p
->balance_buf
, CONST_STR_LEN("hash"))) {
224 s
->balance
= PROXY_BALANCE_HASH
;
226 log_error_write(srv
, __FILE__
, __LINE__
, "sb",
227 "proxy.balance has to be one of: fair, round-robin, hash, but not:", p
->balance_buf
);
228 return HANDLER_ERROR
;
231 if (NULL
!= (du
= array_get_element(config
->value
, "proxy.server"))) {
233 data_array
*da
= (data_array
*)du
;
235 if (du
->type
!= TYPE_ARRAY
) {
236 log_error_write(srv
, __FILE__
, __LINE__
, "sss",
237 "unexpected type for key: ", "proxy.server", "expected ( \"ext\" => ( \"backend-label\" => ( \"key\" => \"value\" )))");
239 return HANDLER_ERROR
;
243 * proxy.server = ( "<ext>" => ...,
247 for (j
= 0; j
< da
->value
->used
; j
++) {
248 data_array
*da_ext
= (data_array
*)da
->value
->data
[j
];
251 if (da_ext
->type
!= TYPE_ARRAY
) {
252 log_error_write(srv
, __FILE__
, __LINE__
, "sssbs",
253 "unexpected type for key: ", "proxy.server",
254 "[", da
->value
->data
[j
]->key
, "](string); expected ( \"ext\" => ( \"backend-label\" => ( \"key\" => \"value\" )))");
256 return HANDLER_ERROR
;
260 * proxy.server = ( "<ext>" =>
261 * ( "<host>" => ( ... ),
262 * "<host>" => ( ... )
267 for (n
= 0; n
< da_ext
->value
->used
; n
++) {
268 data_array
*da_host
= (data_array
*)da_ext
->value
->data
[n
];
273 config_values_t pcv
[] = {
274 { "host", NULL
, T_CONFIG_STRING
, T_CONFIG_SCOPE_CONNECTION
}, /* 0 */
275 { "port", NULL
, T_CONFIG_SHORT
, T_CONFIG_SCOPE_CONNECTION
}, /* 1 */
276 { NULL
, NULL
, T_CONFIG_UNSET
, T_CONFIG_SCOPE_UNSET
}
279 if (da_host
->type
!= TYPE_ARRAY
) {
280 log_error_write(srv
, __FILE__
, __LINE__
, "ssSBS",
281 "unexpected type for key:",
283 "[", da_ext
->value
->data
[n
]->key
, "](string); expected ( \"ext\" => ( \"backend-label\" => ( \"key\" => \"value\" )))");
285 return HANDLER_ERROR
;
288 df
= data_proxy_init();
292 buffer_copy_buffer(df
->key
, da_host
->key
);
294 pcv
[0].destination
= df
->host
;
295 pcv
[1].destination
= &(df
->port
);
297 if (0 != config_insert_values_internal(srv
, da_host
->value
, pcv
, T_CONFIG_SCOPE_CONNECTION
)) {
298 df
->free((data_unset
*) df
);
299 return HANDLER_ERROR
;
302 if (buffer_string_is_empty(df
->host
)) {
303 log_error_write(srv
, __FILE__
, __LINE__
, "sbbbs",
304 "missing key (string):",
310 df
->free((data_unset
*) df
);
311 return HANDLER_ERROR
;
314 /* if extension already exists, take it */
316 if (NULL
== (dfa
= (data_array
*)array_get_element(s
->extensions
, da_ext
->key
->ptr
))) {
317 dfa
= data_array_init();
319 buffer_copy_buffer(dfa
->key
, da_ext
->key
);
321 array_insert_unique(dfa
->value
, (data_unset
*)df
);
322 array_insert_unique(s
->extensions
, (data_unset
*)dfa
);
324 array_insert_unique(dfa
->value
, (data_unset
*)df
);
331 return HANDLER_GO_ON
;
334 static void proxy_connection_close(server
*srv
, handler_ctx
*hctx
) {
338 p
= hctx
->plugin_data
;
339 con
= hctx
->remote_conn
;
341 if (hctx
->fd
!= -1) {
342 fdevent_event_del(srv
->ev
, &(hctx
->fde_ndx
), hctx
->fd
);
343 fdevent_unregister(srv
->ev
, hctx
->fd
);
353 handler_ctx_free(hctx
);
354 con
->plugin_ctx
[p
->id
] = NULL
;
356 /* finish response (if not already con->file_started, con->file_finished) */
357 if (con
->mode
== p
->id
) {
358 http_response_backend_done(srv
, con
);
362 static int proxy_establish_connection(server
*srv
, handler_ctx
*hctx
) {
363 struct sockaddr
*proxy_addr
;
364 struct sockaddr_in proxy_addr_in
;
365 #if defined(HAVE_SYS_UN_H)
366 struct sockaddr_un proxy_addr_un
;
368 #if defined(HAVE_IPV6) && defined(HAVE_INET_PTON)
369 struct sockaddr_in6 proxy_addr_in6
;
373 plugin_data
*p
= hctx
->plugin_data
;
374 data_proxy
*host
= hctx
->host
;
375 int proxy_fd
= hctx
->fd
;
378 #if defined(HAVE_SYS_UN_H)
379 if (strstr(host
->host
->ptr
, "/")) {
380 if (buffer_string_length(host
->host
) + 1 > sizeof(proxy_addr_un
.sun_path
)) {
381 log_error_write(srv
, __FILE__
, __LINE__
, "sB",
382 "ERROR: Unix Domain socket filename too long:",
387 memset(&proxy_addr_un
, 0, sizeof(proxy_addr_un
));
388 proxy_addr_un
.sun_family
= AF_UNIX
;
389 memcpy(proxy_addr_un
.sun_path
, host
->host
->ptr
, buffer_string_length(host
->host
) + 1);
390 servlen
= sizeof(proxy_addr_un
);
391 proxy_addr
= (struct sockaddr
*) &proxy_addr_un
;
394 #if defined(HAVE_IPV6) && defined(HAVE_INET_PTON)
395 if (strstr(host
->host
->ptr
, ":")) {
396 memset(&proxy_addr_in6
, 0, sizeof(proxy_addr_in6
));
397 proxy_addr_in6
.sin6_family
= AF_INET6
;
398 inet_pton(AF_INET6
, host
->host
->ptr
, (char *) &proxy_addr_in6
.sin6_addr
);
399 proxy_addr_in6
.sin6_port
= htons(host
->port
);
400 servlen
= sizeof(proxy_addr_in6
);
401 proxy_addr
= (struct sockaddr
*) &proxy_addr_in6
;
405 memset(&proxy_addr_in
, 0, sizeof(proxy_addr_in
));
406 proxy_addr_in
.sin_family
= AF_INET
;
407 proxy_addr_in
.sin_addr
.s_addr
= inet_addr(host
->host
->ptr
);
408 proxy_addr_in
.sin_port
= htons(host
->port
);
409 servlen
= sizeof(proxy_addr_in
);
410 proxy_addr
= (struct sockaddr
*) &proxy_addr_in
;
414 if (-1 == connect(proxy_fd
, proxy_addr
, servlen
)) {
415 if (errno
== EINPROGRESS
|| errno
== EALREADY
) {
417 log_error_write(srv
, __FILE__
, __LINE__
, "sd",
418 "connect delayed:", proxy_fd
);
424 log_error_write(srv
, __FILE__
, __LINE__
, "sdsd",
425 "connect failed:", proxy_fd
, strerror(errno
), errno
);
431 log_error_write(srv
, __FILE__
, __LINE__
, "sd",
432 "connect succeeded: ", proxy_fd
);
438 static void proxy_set_header(connection
*con
, const char *key
, const char *value
) {
441 if (NULL
== (ds_dst
= (data_string
*)array_get_unused_element(con
->request
.headers
, TYPE_STRING
))) {
442 ds_dst
= data_string_init();
445 buffer_copy_string(ds_dst
->key
, key
);
446 buffer_copy_string(ds_dst
->value
, value
);
447 array_insert_unique(con
->request
.headers
, (data_unset
*)ds_dst
);
450 static void proxy_append_header(connection
*con
, const char *key
, const char *value
) {
453 if (NULL
== (ds_dst
= (data_string
*)array_get_unused_element(con
->request
.headers
, TYPE_STRING
))) {
454 ds_dst
= data_string_init();
457 buffer_copy_string(ds_dst
->key
, key
);
458 buffer_append_string(ds_dst
->value
, value
);
459 array_insert_unique(con
->request
.headers
, (data_unset
*)ds_dst
);
463 static int proxy_create_env(server
*srv
, handler_ctx
*hctx
) {
466 connection
*con
= hctx
->remote_conn
;
474 buffer_copy_string(b
, get_http_method_name(con
->request
.http_method
));
475 buffer_append_string_len(b
, CONST_STR_LEN(" "));
477 buffer_append_string_buffer(b
, con
->request
.uri
);
478 buffer_append_string_len(b
, CONST_STR_LEN(" HTTP/1.0\r\n"));
480 proxy_append_header(con
, "X-Forwarded-For", (char *)inet_ntop_cache_get_ip(srv
, &(con
->dst_addr
)));
481 /* http_host is NOT is just a pointer to a buffer
482 * which is NULL if it is not set */
483 if (!buffer_string_is_empty(con
->request
.http_host
)) {
484 proxy_set_header(con
, "X-Host", con
->request
.http_host
->ptr
);
486 proxy_set_header(con
, "X-Forwarded-Proto", con
->uri
.scheme
->ptr
);
489 for (i
= 0; i
< con
->request
.headers
->used
; i
++) {
492 ds
= (data_string
*)con
->request
.headers
->data
[i
];
494 if (!buffer_is_empty(ds
->value
) && !buffer_is_empty(ds
->key
)) {
495 if (buffer_is_equal_caseless_string(ds
->key
, CONST_STR_LEN("Connection"))) continue;
496 if (buffer_is_equal_caseless_string(ds
->key
, CONST_STR_LEN("Proxy-Connection"))) continue;
498 buffer_append_string_buffer(b
, ds
->key
);
499 buffer_append_string_len(b
, CONST_STR_LEN(": "));
500 buffer_append_string_buffer(b
, ds
->value
);
501 buffer_append_string_len(b
, CONST_STR_LEN("\r\n"));
505 buffer_append_string_len(b
, CONST_STR_LEN("Connection: close\r\n\r\n"));
507 hctx
->wb_reqlen
= buffer_string_length(b
);
508 chunkqueue_append_buffer(hctx
->wb
, b
);
513 if (con
->request
.content_length
) {
514 chunkqueue_append_chunkqueue(hctx
->wb
, con
->request_content_queue
);
515 hctx
->wb_reqlen
+= con
->request
.content_length
;/* (eventual) total request size */
521 static int proxy_set_state(server
*srv
, handler_ctx
*hctx
, proxy_connection_state_t state
) {
523 hctx
->state_timestamp
= srv
->cur_ts
;
529 static int proxy_response_parse(server
*srv
, connection
*con
, plugin_data
*p
, buffer
*in
) {
531 int http_response_status
= -1;
535 /* [\r]\n -> [\0]\0 */
537 buffer_copy_buffer(p
->parse_response
, in
);
539 for (s
= p
->parse_response
->ptr
; NULL
!= (ns
= strchr(s
, '\n')); s
= ns
+ 1) {
546 if (s
!= ns
&& ns
[-1] == '\r') ns
[-1] = '\0';
548 if (-1 == http_response_status
) {
549 /* The first line of a Response message is the Status-Line */
551 for (key
=s
; *key
&& *key
!= ' '; key
++);
554 http_response_status
= (int) strtol(key
, NULL
, 10);
555 if (http_response_status
< 100 || http_response_status
>= 1000) http_response_status
= 502;
557 http_response_status
= 502;
560 con
->http_status
= http_response_status
;
561 con
->parsed_response
|= HTTP_STATUS
;
565 if (NULL
== (value
= strchr(s
, ':'))) {
566 /* now we expect: "<key>: <value>\n" */
572 key_len
= value
- key
;
576 while (*value
== ' ' || *value
== '\t') value
++;
582 if (0 == strncasecmp(key
, "Date", key_len
)) {
583 con
->parsed_response
|= HTTP_DATE
;
587 if (0 == strncasecmp(key
, "Location", key_len
)) {
588 con
->parsed_response
|= HTTP_LOCATION
;
592 if (0 == strncasecmp(key
, "Connection", key_len
)) {
597 if (0 == strncasecmp(key
, "Content-Length", key_len
)) {
598 con
->response
.content_length
= strtoul(value
, NULL
, 10);
599 con
->parsed_response
|= HTTP_CONTENT_LENGTH
;
607 if (NULL
== (ds
= (data_string
*)array_get_unused_element(con
->response
.headers
, TYPE_STRING
))) {
608 ds
= data_response_init();
610 buffer_copy_string_len(ds
->key
, key
, key_len
);
611 buffer_copy_string(ds
->value
, value
);
613 array_insert_unique(con
->response
.headers
, (data_unset
*)ds
);
621 static int proxy_demux_response(server
*srv
, handler_ctx
*hctx
) {
626 plugin_data
*p
= hctx
->plugin_data
;
627 connection
*con
= hctx
->remote_conn
;
628 int proxy_fd
= hctx
->fd
;
630 /* check how much we have to read */
631 #if !defined(_WIN32) && !defined(__CYGWIN__)
632 if (ioctl(hctx
->fd
, FIONREAD
, &b
)) {
633 if (errno
== EAGAIN
) {
634 fdevent_event_add(srv
->ev
, &(hctx
->fde_ndx
), hctx
->fd
, FDEVENT_IN
);
637 log_error_write(srv
, __FILE__
, __LINE__
, "sd",
648 log_error_write(srv
, __FILE__
, __LINE__
, "sd",
649 "proxy - have to read:", b
);
653 if ((con
->conf
.stream_response_body
& FDEVENT_STREAM_RESPONSE_BUFMIN
)) {
654 off_t cqlen
= chunkqueue_length(con
->write_queue
);
655 if (cqlen
+ b
> 65536 - 4096) {
656 if (!con
->is_writable
) {
657 /*(defer removal of FDEVENT_IN interest since
658 * connection_state_machine() might be able to send data
659 * immediately, unless !con->is_writable, where
660 * connection_state_machine() might not loop back to call
661 * mod_proxy_handle_subrequest())*/
662 fdevent_event_clr(srv
->ev
, &(hctx
->fde_ndx
), hctx
->fd
, FDEVENT_IN
);
664 if (cqlen
>= 65536-1) return 0;
665 b
= 65536 - 1 - (int)cqlen
;
669 buffer_string_prepare_append(hctx
->response
, b
);
671 if (-1 == (r
= read(hctx
->fd
, hctx
->response
->ptr
+ buffer_string_length(hctx
->response
), buffer_string_space(hctx
->response
)))) {
672 if (errno
== EAGAIN
) {
673 fdevent_event_add(srv
->ev
, &(hctx
->fde_ndx
), hctx
->fd
, FDEVENT_IN
);
676 log_error_write(srv
, __FILE__
, __LINE__
, "sds",
677 "unexpected end-of-file (perhaps the proxy process died):",
678 proxy_fd
, strerror(errno
));
682 #if defined(_WIN32) || defined(__CYGWIN__)
683 if (0 == r
) return 1; /* fin */
686 /* this should be catched by the b > 0 above */
689 buffer_commit(hctx
->response
, r
);
692 log_error_write(srv
, __FILE__
, __LINE__
, "sdsbs",
693 "demux: Response buffer len", hctx
->response
->used
, ":", hctx
->response
, ":");
696 if (0 == con
->got_response
) {
697 con
->got_response
= 1;
698 buffer_string_prepare_copy(hctx
->response_header
, 1023);
701 if (0 == con
->file_started
) {
704 /* search for the \r\n\r\n in the string */
705 if (NULL
!= (c
= buffer_search_string_len(hctx
->response
, CONST_STR_LEN("\r\n\r\n")))) {
706 size_t hlen
= c
- hctx
->response
->ptr
+ 4;
707 size_t blen
= buffer_string_length(hctx
->response
) - hlen
;
710 buffer_append_string_len(hctx
->response_header
, hctx
->response
->ptr
, hlen
);
712 log_error_write(srv
, __FILE__
, __LINE__
, "sb", "Header:", hctx
->response_header
);
714 /* parse the response header */
715 proxy_response_parse(srv
, con
, p
, hctx
->response_header
);
717 con
->file_started
= 1;
719 if (0 != http_chunk_append_mem(srv
, con
, c
+ 4, blen
)) {
720 /* error writing to tempfile;
721 * truncate response or send 500 if nothing sent yet */
723 con
->file_started
= 0;
726 buffer_reset(hctx
->response
);
728 /* no luck, no header found */
729 /*(reuse MAX_HTTP_REQUEST_HEADER as max size for response headers from backends)*/
730 if (buffer_string_length(hctx
->response
) > MAX_HTTP_REQUEST_HEADER
) {
731 log_error_write(srv
, __FILE__
, __LINE__
, "sb", "response headers too large for", con
->uri
.path
);
732 con
->http_status
= 502; /* Bad Gateway */
738 if (0 != http_chunk_append_buffer(srv
, con
, hctx
->response
)) {
739 /* error writing to tempfile;
740 * truncate response or send 500 if nothing sent yet */
743 buffer_reset(hctx
->response
);
746 /* reading from upstream done */
754 static handler_t
proxy_write_request(server
*srv
, handler_ctx
*hctx
) {
755 data_proxy
*host
= hctx
->host
;
756 connection
*con
= hctx
->remote_conn
;
760 if (!host
|| buffer_string_is_empty(host
->host
) || !host
->port
) return HANDLER_ERROR
;
762 switch(hctx
->state
) {
763 case PROXY_STATE_CONNECT
:
764 /* wait for the connect() to finish */
766 /* connect failed ? */
767 if (-1 == hctx
->fde_ndx
) return HANDLER_ERROR
;
770 return HANDLER_WAIT_FOR_EVENT
;
772 case PROXY_STATE_INIT
:
773 #if defined(HAVE_SYS_UN_H)
774 if (strstr(host
->host
->ptr
,"/")) {
775 if (-1 == (hctx
->fd
= socket(AF_UNIX
, SOCK_STREAM
, 0))) {
776 log_error_write(srv
, __FILE__
, __LINE__
, "ss", "socket failed: ", strerror(errno
));
777 return HANDLER_ERROR
;
781 #if defined(HAVE_IPV6) && defined(HAVE_INET_PTON)
782 if (strstr(host
->host
->ptr
,":")) {
783 if (-1 == (hctx
->fd
= socket(AF_INET6
, SOCK_STREAM
, 0))) {
784 log_error_write(srv
, __FILE__
, __LINE__
, "ss", "socket failed: ", strerror(errno
));
785 return HANDLER_ERROR
;
790 if (-1 == (hctx
->fd
= socket(AF_INET
, SOCK_STREAM
, 0))) {
791 log_error_write(srv
, __FILE__
, __LINE__
, "ss", "socket failed: ", strerror(errno
));
792 return HANDLER_ERROR
;
799 fdevent_register(srv
->ev
, hctx
->fd
, proxy_handle_fdevent
, hctx
);
801 if (-1 == fdevent_fcntl_set(srv
->ev
, hctx
->fd
)) {
802 log_error_write(srv
, __FILE__
, __LINE__
, "ss", "fcntl failed: ", strerror(errno
));
804 return HANDLER_ERROR
;
807 switch (proxy_establish_connection(srv
, hctx
)) {
809 proxy_set_state(srv
, hctx
, PROXY_STATE_CONNECT
);
811 /* connection is in progress, wait for an event and call getsockopt() below */
813 fdevent_event_set(srv
->ev
, &(hctx
->fde_ndx
), hctx
->fd
, FDEVENT_OUT
);
815 return HANDLER_WAIT_FOR_EVENT
;
817 /* if ECONNREFUSED choose another connection -> FIXME */
820 return HANDLER_ERROR
;
822 /* everything is ok, go on */
823 proxy_set_state(srv
, hctx
, PROXY_STATE_PREPARE_WRITE
);
829 case PROXY_STATE_PREPARE_WRITE
:
830 proxy_create_env(srv
, hctx
);
832 fdevent_event_add(srv
->ev
, &(hctx
->fde_ndx
), hctx
->fd
, FDEVENT_IN
);
833 proxy_set_state(srv
, hctx
, PROXY_STATE_WRITE
);
836 case PROXY_STATE_WRITE
:;
837 ret
= srv
->network_backend_write(srv
, con
, hctx
->fd
, hctx
->wb
, MAX_WRITE_LIMIT
);
839 chunkqueue_remove_finished_chunks(hctx
->wb
);
841 if (-1 == ret
) { /* error on our side */
842 log_error_write(srv
, __FILE__
, __LINE__
, "ssd", "write failed:", strerror(errno
), errno
);
844 return HANDLER_ERROR
;
845 } else if (-2 == ret
) { /* remote close */
846 log_error_write(srv
, __FILE__
, __LINE__
, "ssd", "write failed, remote connection close:", strerror(errno
), errno
);
848 return HANDLER_ERROR
;
851 if (hctx
->wb
->bytes_out
== hctx
->wb_reqlen
) {
852 fdevent_event_clr(srv
->ev
, &(hctx
->fde_ndx
), hctx
->fd
, FDEVENT_OUT
);
853 shutdown(hctx
->fd
, SHUT_WR
);/* future: remove if HTTP/1.1 request */
854 proxy_set_state(srv
, hctx
, PROXY_STATE_READ
);
856 off_t wblen
= hctx
->wb
->bytes_in
- hctx
->wb
->bytes_out
;
857 if (hctx
->wb
->bytes_in
< hctx
->wb_reqlen
&& wblen
< 65536 - 16384) {
858 /*(con->conf.stream_request_body & FDEVENT_STREAM_REQUEST)*/
859 if (!(con
->conf
.stream_request_body
& FDEVENT_STREAM_REQUEST_POLLIN
)) {
860 con
->conf
.stream_request_body
|= FDEVENT_STREAM_REQUEST_POLLIN
;
861 con
->is_readable
= 1; /* trigger optimistic read from client */
865 fdevent_event_clr(srv
->ev
, &(hctx
->fde_ndx
), hctx
->fd
, FDEVENT_OUT
);
867 fdevent_event_add(srv
->ev
, &(hctx
->fde_ndx
), hctx
->fd
, FDEVENT_OUT
);
871 return HANDLER_WAIT_FOR_EVENT
;
872 case PROXY_STATE_READ
:
873 /* waiting for a response */
874 return HANDLER_WAIT_FOR_EVENT
;
876 log_error_write(srv
, __FILE__
, __LINE__
, "s", "(debug) unknown state");
877 return HANDLER_ERROR
;
883 static int mod_proxy_patch_connection(server
*srv
, connection
*con
, plugin_data
*p
) {
885 plugin_config
*s
= p
->config_storage
[0];
891 /* skip the first, the global context */
892 for (i
= 1; i
< srv
->config_context
->used
; i
++) {
893 data_config
*dc
= (data_config
*)srv
->config_context
->data
[i
];
894 s
= p
->config_storage
[i
];
896 /* condition didn't match */
897 if (!config_check_cond(srv
, con
, dc
)) continue;
900 for (j
= 0; j
< dc
->value
->used
; j
++) {
901 data_unset
*du
= dc
->value
->data
[j
];
903 if (buffer_is_equal_string(du
->key
, CONST_STR_LEN("proxy.server"))) {
905 } else if (buffer_is_equal_string(du
->key
, CONST_STR_LEN("proxy.debug"))) {
907 } else if (buffer_is_equal_string(du
->key
, CONST_STR_LEN("proxy.balance"))) {
917 static handler_t
proxy_send_request(server
*srv
, handler_ctx
*hctx
) {
918 /* ok, create the request */
919 handler_t rc
= proxy_write_request(srv
, hctx
);
920 if (HANDLER_ERROR
!= rc
) {
923 data_proxy
*host
= hctx
->host
;
924 connection
*con
= hctx
->remote_conn
;
925 plugin_data
*p
= hctx
->plugin_data
;
926 log_error_write(srv
, __FILE__
, __LINE__
, "sbdd", "proxy-server disabled:",
931 /* disable this server */
932 host
->is_disabled
= 1;
933 host
->disable_ts
= srv
->cur_ts
;
935 /* reset the enviroment and restart the sub-request */
936 con
->mode
= DIRECT
;/*(avoid changing con->state, con->http_status)*/
937 proxy_connection_close(srv
, hctx
);
940 return HANDLER_COMEBACK
;
945 static handler_t
proxy_recv_response(server
*srv
, handler_ctx
*hctx
);
948 SUBREQUEST_FUNC(mod_proxy_handle_subrequest
) {
949 plugin_data
*p
= p_d
;
951 handler_ctx
*hctx
= con
->plugin_ctx
[p
->id
];
953 if (NULL
== hctx
) return HANDLER_GO_ON
;
956 if (con
->mode
!= p
->id
) return HANDLER_GO_ON
;
958 if ((con
->conf
.stream_response_body
& FDEVENT_STREAM_RESPONSE_BUFMIN
)
959 && con
->file_started
) {
960 if (chunkqueue_length(con
->write_queue
) > 65536 - 4096) {
961 fdevent_event_clr(srv
->ev
, &(hctx
->fde_ndx
), hctx
->fd
, FDEVENT_IN
);
962 } else if (!(fdevent_event_get_interest(srv
->ev
, hctx
->fd
) & FDEVENT_IN
)) {
963 /* optimistic read from backend, which might re-enable FDEVENT_IN */
964 handler_t rc
= proxy_recv_response(srv
, hctx
); /*(might invalidate hctx)*/
965 if (rc
!= HANDLER_GO_ON
) return rc
; /*(unless HANDLER_GO_ON)*/
969 if (0 == hctx
->wb
->bytes_in
970 ? con
->state
== CON_STATE_READ_POST
971 : hctx
->wb
->bytes_in
< hctx
->wb_reqlen
) {
972 /*(64k - 4k to attempt to avoid temporary files
973 * in conjunction with FDEVENT_STREAM_REQUEST_BUFMIN)*/
974 if (hctx
->wb
->bytes_in
- hctx
->wb
->bytes_out
> 65536 - 4096
975 && (con
->conf
.stream_request_body
& FDEVENT_STREAM_REQUEST_BUFMIN
)){
976 con
->conf
.stream_request_body
&= ~FDEVENT_STREAM_REQUEST_POLLIN
;
977 if (0 != hctx
->wb
->bytes_in
) return HANDLER_WAIT_FOR_EVENT
;
979 handler_t r
= connection_handle_read_post_state(srv
, con
);
980 chunkqueue
*req_cq
= con
->request_content_queue
;
981 if (0 != hctx
->wb
->bytes_in
&& !chunkqueue_is_empty(req_cq
)) {
982 chunkqueue_append_chunkqueue(hctx
->wb
, req_cq
);
983 if (fdevent_event_get_interest(srv
->ev
, hctx
->fd
) & FDEVENT_OUT
) {
984 return (r
== HANDLER_GO_ON
) ? HANDLER_WAIT_FOR_EVENT
: r
;
987 if (r
!= HANDLER_GO_ON
) return r
;
991 return (0 == hctx
->wb
->bytes_in
|| !chunkqueue_is_empty(hctx
->wb
))
992 ? proxy_send_request(srv
, hctx
)
993 : HANDLER_WAIT_FOR_EVENT
;
997 static handler_t
proxy_recv_response(server
*srv
, handler_ctx
*hctx
) {
999 switch (proxy_demux_response(srv
, hctx
)) {
1003 http_response_backend_error(srv
, hctx
->remote_conn
);
1007 proxy_connection_close(srv
, hctx
);
1009 return HANDLER_FINISHED
;
1012 return HANDLER_GO_ON
;
1016 static handler_t
proxy_handle_fdevent(server
*srv
, void *ctx
, int revents
) {
1017 handler_ctx
*hctx
= ctx
;
1018 connection
*con
= hctx
->remote_conn
;
1019 plugin_data
*p
= hctx
->plugin_data
;
1021 joblist_append(srv
, con
);
1023 if (revents
& FDEVENT_IN
) {
1025 if (p
->conf
.debug
) {
1026 log_error_write(srv
, __FILE__
, __LINE__
, "sd",
1027 "proxy: fdevent-in", hctx
->state
);
1031 handler_t rc
= proxy_recv_response(srv
,hctx
);/*(might invalidate hctx)*/
1032 if (rc
!= HANDLER_GO_ON
) return rc
; /*(unless HANDLER_GO_ON)*/
1036 if (revents
& FDEVENT_OUT
) {
1037 if (p
->conf
.debug
) {
1038 log_error_write(srv
, __FILE__
, __LINE__
, "sd",
1039 "proxy: fdevent-out", hctx
->state
);
1042 if (hctx
->state
== PROXY_STATE_CONNECT
) {
1044 socklen_t socket_error_len
= sizeof(socket_error
);
1046 /* try to finish the connect() */
1047 if (0 != getsockopt(hctx
->fd
, SOL_SOCKET
, SO_ERROR
, &socket_error
, &socket_error_len
)) {
1048 log_error_write(srv
, __FILE__
, __LINE__
, "ss",
1049 "getsockopt failed:", strerror(errno
));
1051 return HANDLER_FINISHED
;
1053 if (socket_error
!= 0) {
1054 log_error_write(srv
, __FILE__
, __LINE__
, "ss",
1055 "establishing connection failed:", strerror(socket_error
),
1056 "port:", hctx
->host
->port
);
1058 return HANDLER_FINISHED
;
1060 if (p
->conf
.debug
) {
1061 log_error_write(srv
, __FILE__
, __LINE__
, "s", "proxy - connect - delayed success");
1064 proxy_set_state(srv
, hctx
, PROXY_STATE_PREPARE_WRITE
);
1067 return proxy_send_request(srv
, hctx
); /*(might invalidate hctx)*/
1070 /* perhaps this issue is already handled */
1071 if (revents
& FDEVENT_HUP
) {
1072 if (p
->conf
.debug
) {
1073 log_error_write(srv
, __FILE__
, __LINE__
, "sd",
1074 "proxy: fdevent-hup", hctx
->state
);
1077 if (hctx
->state
== PROXY_STATE_CONNECT
) {
1078 /* connect() -> EINPROGRESS -> HUP */
1081 * what is proxy is doing if it can't reach the next hop ?
1086 hctx
->host
->is_disabled
= 1;
1087 hctx
->host
->disable_ts
= srv
->cur_ts
;
1088 log_error_write(srv
, __FILE__
, __LINE__
, "sbdd", "proxy-server disabled:",
1093 /* disable this server */
1094 hctx
->host
->is_disabled
= 1;
1095 hctx
->host
->disable_ts
= srv
->cur_ts
;
1097 /* reset the environment and restart the sub-request */
1098 con
->mode
= DIRECT
;/*(avoid changing con->state, con->http_status)*/
1099 proxy_connection_close(srv
, hctx
);
1102 proxy_connection_close(srv
, hctx
);
1103 con
->http_status
= 503;
1105 } else if (con
->file_started
) {
1106 /* drain any remaining data from kernel pipe buffers
1107 * even if (con->conf.stream_response_body
1108 * & FDEVENT_STREAM_RESPONSE_BUFMIN)
1109 * since event loop will spin on fd FDEVENT_HUP event
1110 * until unregistered. */
1113 rc
= proxy_recv_response(srv
,hctx
);/*(might invalidate hctx)*/
1114 } while (rc
== HANDLER_GO_ON
); /*(unless HANDLER_GO_ON)*/
1115 return rc
; /* HANDLER_FINISHED or HANDLER_ERROR */
1117 proxy_connection_close(srv
, hctx
);
1119 } else if (revents
& FDEVENT_ERR
) {
1120 log_error_write(srv
, __FILE__
, __LINE__
, "sd", "proxy-FDEVENT_ERR, but no HUP", revents
);
1122 http_response_backend_error(srv
, con
);
1123 proxy_connection_close(srv
, hctx
);
1126 return HANDLER_FINISHED
;
1129 static handler_t
mod_proxy_check_extension(server
*srv
, connection
*con
, void *p_d
) {
1130 plugin_data
*p
= p_d
;
1132 unsigned long last_max
= ULONG_MAX
;
1133 int max_usage
= INT_MAX
;
1137 data_array
*extension
= NULL
;
1138 size_t path_info_offset
;
1140 if (con
->mode
!= DIRECT
) return HANDLER_GO_ON
;
1142 /* Possibly, we processed already this request */
1143 if (con
->file_started
== 1) return HANDLER_GO_ON
;
1145 mod_proxy_patch_connection(srv
, con
, p
);
1148 if (buffer_string_is_empty(fn
)) return HANDLER_ERROR
;
1149 s_len
= buffer_string_length(fn
);
1151 path_info_offset
= 0;
1153 if (p
->conf
.debug
) {
1154 log_error_write(srv
, __FILE__
, __LINE__
, "s", "proxy - start");
1157 /* check if extension matches */
1158 for (k
= 0; k
< p
->conf
.extensions
->used
; k
++) {
1159 data_array
*ext
= NULL
;
1162 ext
= (data_array
*)p
->conf
.extensions
->data
[k
];
1164 if (buffer_is_empty(ext
->key
)) continue;
1166 ct_len
= buffer_string_length(ext
->key
);
1168 if (s_len
< ct_len
) continue;
1170 /* check extension in the form "/proxy_pattern" */
1171 if (*(ext
->key
->ptr
) == '/') {
1172 if (strncmp(fn
->ptr
, ext
->key
->ptr
, ct_len
) == 0) {
1173 if (s_len
> ct_len
+ 1) {
1176 if (NULL
!= (pi_offset
= strchr(fn
->ptr
+ ct_len
+ 1, '/'))) {
1177 path_info_offset
= pi_offset
- fn
->ptr
;
1183 } else if (0 == strncmp(fn
->ptr
+ s_len
- ct_len
, ext
->key
->ptr
, ct_len
)) {
1184 /* check extension in the form ".fcg" */
1190 if (NULL
== extension
) {
1191 return HANDLER_GO_ON
;
1194 if (p
->conf
.debug
) {
1195 log_error_write(srv
, __FILE__
, __LINE__
, "s", "proxy - ext found");
1198 if (extension
->value
->used
== 1) {
1199 if ( ((data_proxy
*)extension
->value
->data
[0])->is_disabled
) {
1204 } else if (extension
->value
->used
!= 0) switch(p
->conf
.balance
) {
1205 case PROXY_BALANCE_HASH
:
1206 /* hash balancing */
1208 if (p
->conf
.debug
) {
1209 log_error_write(srv
, __FILE__
, __LINE__
, "sd",
1210 "proxy - used hash balancing, hosts:", extension
->value
->used
);
1213 for (k
= 0, ndx
= -1, last_max
= ULONG_MAX
; k
< extension
->value
->used
; k
++) {
1214 data_proxy
*host
= (data_proxy
*)extension
->value
->data
[k
];
1215 unsigned long cur_max
;
1217 if (host
->is_disabled
) continue;
1219 cur_max
= generate_crc32c(CONST_BUF_LEN(con
->uri
.path
)) +
1220 generate_crc32c(CONST_BUF_LEN(host
->host
)) + /* we can cache this */
1221 generate_crc32c(CONST_BUF_LEN(con
->uri
.authority
));
1223 if (p
->conf
.debug
) {
1224 log_error_write(srv
, __FILE__
, __LINE__
, "sbbbd",
1225 "proxy - election:",
1232 if ((last_max
== ULONG_MAX
) || /* first round */
1233 (cur_max
> last_max
)) {
1241 case PROXY_BALANCE_FAIR
:
1242 /* fair balancing */
1243 if (p
->conf
.debug
) {
1244 log_error_write(srv
, __FILE__
, __LINE__
, "s",
1245 "proxy - used fair balancing");
1248 for (k
= 0, ndx
= -1, max_usage
= INT_MAX
; k
< extension
->value
->used
; k
++) {
1249 data_proxy
*host
= (data_proxy
*)extension
->value
->data
[k
];
1251 if (host
->is_disabled
) continue;
1253 if (host
->usage
< max_usage
) {
1254 max_usage
= host
->usage
;
1261 case PROXY_BALANCE_RR
: {
1265 if (p
->conf
.debug
) {
1266 log_error_write(srv
, __FILE__
, __LINE__
, "s",
1267 "proxy - used round-robin balancing");
1270 /* just to be sure */
1271 force_assert(extension
->value
->used
< INT_MAX
);
1273 host
= (data_proxy
*)extension
->value
->data
[0];
1275 /* Use last_used_ndx from first host in list */
1276 k
= host
->last_used_ndx
;
1277 ndx
= k
+ 1; /* use next host after the last one */
1278 if (ndx
< 0) ndx
= 0;
1280 /* Search first active host after last_used_ndx */
1281 while ( ndx
< (int) extension
->value
->used
1282 && (host
= (data_proxy
*)extension
->value
->data
[ndx
])->is_disabled
) ndx
++;
1284 if (ndx
>= (int) extension
->value
->used
) {
1285 /* didn't found a higher id, wrap to the start */
1286 for (ndx
= 0; ndx
<= (int) k
; ndx
++) {
1287 host
= (data_proxy
*)extension
->value
->data
[ndx
];
1288 if (!host
->is_disabled
) break;
1291 /* No active host found */
1292 if (host
->is_disabled
) ndx
= -1;
1295 /* Save new index for next round */
1296 ((data_proxy
*)extension
->value
->data
[0])->last_used_ndx
= ndx
;
1304 /* found a server */
1306 data_proxy
*host
= (data_proxy
*)extension
->value
->data
[ndx
];
1309 * if check-local is disabled, use the uri.path handler
1313 /* init handler-context */
1315 hctx
= handler_ctx_init();
1317 hctx
->path_info_offset
= path_info_offset
;
1318 hctx
->remote_conn
= con
;
1319 hctx
->plugin_data
= p
;
1322 con
->plugin_ctx
[p
->id
] = hctx
;
1328 if (p
->conf
.debug
) {
1329 log_error_write(srv
, __FILE__
, __LINE__
, "sbd",
1330 "proxy - found a host",
1331 host
->host
, host
->port
);
1334 return HANDLER_GO_ON
;
1336 /* no handler found */
1337 con
->http_status
= 500;
1339 log_error_write(srv
, __FILE__
, __LINE__
, "sb",
1340 "no proxy-handler found for:",
1343 return HANDLER_FINISHED
;
1345 return HANDLER_GO_ON
;
1348 static handler_t
mod_proxy_connection_reset(server
*srv
, connection
*con
, void *p_d
) {
1349 plugin_data
*p
= p_d
;
1350 handler_ctx
*hctx
= con
->plugin_ctx
[p
->id
];
1351 if (hctx
) proxy_connection_close(srv
, hctx
);
1353 return HANDLER_GO_ON
;
1358 * the trigger re-enables the disabled connections after the timeout is over
1362 TRIGGER_FUNC(mod_proxy_trigger
) {
1363 plugin_data
*p
= p_d
;
1365 if (p
->config_storage
) {
1367 for (i
= 0; i
< srv
->config_context
->used
; i
++) {
1368 plugin_config
*s
= p
->config_storage
[i
];
1372 /* get the extensions for all configs */
1374 for (k
= 0; k
< s
->extensions
->used
; k
++) {
1375 data_array
*extension
= (data_array
*)s
->extensions
->data
[k
];
1378 for (n
= 0; n
< extension
->value
->used
; n
++) {
1379 data_proxy
*host
= (data_proxy
*)extension
->value
->data
[n
];
1381 if (!host
->is_disabled
||
1382 srv
->cur_ts
- host
->disable_ts
< 5) continue;
1384 log_error_write(srv
, __FILE__
, __LINE__
, "sbd",
1385 "proxy - re-enabled:",
1386 host
->host
, host
->port
);
1388 host
->is_disabled
= 0;
1394 return HANDLER_GO_ON
;
1398 int mod_proxy_plugin_init(plugin
*p
);
1399 int mod_proxy_plugin_init(plugin
*p
) {
1400 p
->version
= LIGHTTPD_VERSION_ID
;
1401 p
->name
= buffer_init_string("proxy");
1403 p
->init
= mod_proxy_init
;
1404 p
->cleanup
= mod_proxy_free
;
1405 p
->set_defaults
= mod_proxy_set_defaults
;
1406 p
->connection_reset
= mod_proxy_connection_reset
; /* end of req-resp cycle */
1407 p
->handle_connection_close
= mod_proxy_connection_reset
; /* end of client connection */
1408 p
->handle_uri_clean
= mod_proxy_check_extension
;
1409 p
->handle_subrequest
= mod_proxy_handle_subrequest
;
1410 p
->handle_trigger
= mod_proxy_trigger
;