1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. The end-user documentation included with the redistribution,
20 * if any, must include the following acknowledgment:
21 * "This product includes software developed by the
22 * Apache Software Foundation (http://www.apache.org/)."
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
26 * 4. The names "Apache" and "Apache Software Foundation" must
27 * not be used to endorse or promote products derived from this
28 * software without prior written permission. For written
29 * permission, please contact apache@apache.org.
31 * 5. Products derived from this software may not be called "Apache",
32 * nor may "Apache" appear in their name, without prior written
33 * permission of the Apache Software Foundation.
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47 * ====================================================================
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation. For more
51 * information on the Apache Software Foundation, please see
52 * <http://www.apache.org/>.
54 * Portions of this software are based upon public domain software
55 * originally written at the National Center for Supercomputing Applications,
56 * University of Illinois, Urbana-Champaign.
60 #include "apr_strings.h"
63 #include "ap_config.h"
65 #include "http_connection.h"
66 #include "http_request.h"
67 #include "http_protocol.h"
69 #include "mpm_default.h"
70 #include "http_config.h"
71 #include "http_vhost.h"
72 #include "scoreboard.h"
74 #include "util_filter.h"
77 APR_HOOK_LINK(pre_connection)
78 APR_HOOK_LINK(process_connection)
79 APR_HOOK_LINK(create_connection)
82 AP_IMPLEMENT_HOOK_RUN_ALL(int,pre_connection,(conn_rec *c),(c),OK,DECLINED)
83 AP_IMPLEMENT_HOOK_RUN_FIRST(int,process_connection,(conn_rec *c),(c),DECLINED)
84 AP_IMPLEMENT_HOOK_RUN_FIRST(conn_rec *,create_connection,
85 (apr_pool_t *p, apr_socket_t *csd, int conn_id),
86 (p, csd, conn_id), NULL)
89 * More machine-dependent networking gooo... on some systems,
90 * you've got to be *really* sure that all the packets are acknowledged
91 * before closing the connection, since the client will not be able
92 * to see the last response if their TCP buffer is flushed by a RST
93 * packet from us, which is what the server's TCP stack will send
94 * if it receives any request data after closing the connection.
96 * In an ideal world, this function would be accomplished by simply
97 * setting the socket option SO_LINGER and handling it within the
98 * server's TCP stack while the process continues on to the next request.
99 * Unfortunately, it seems that most (if not all) operating systems
100 * block the server process on close() when SO_LINGER is used.
101 * For those that don't, see USE_SO_LINGER below. For the rest,
102 * we have created a home-brew lingering_close.
104 * Many operating systems tend to block, puke, or otherwise mishandle
105 * calls to shutdown only half of the connection. You should define
106 * NO_LINGCLOSE in ap_config.h if such is the case for your system.
108 #ifndef MAX_SECS_TO_LINGER
109 #define MAX_SECS_TO_LINGER 30
113 #define NO_LINGCLOSE /* The two lingering options are exclusive */
115 static void sock_enable_linger(int s)
120 li.l_linger = MAX_SECS_TO_LINGER;
122 if (setsockopt(s, SOL_SOCKET, SO_LINGER,
123 (char *) &li, sizeof(struct linger)) < 0) {
124 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, server_conf,
125 "setsockopt: (SO_LINGER)");
126 /* not a fatal error */
131 #define sock_enable_linger(s) /* NOOP */
132 #endif /* USE_SO_LINGER */
134 AP_CORE_DECLARE(void) ap_flush_conn(conn_rec *c)
136 apr_bucket_brigade *bb;
139 bb = apr_brigade_create(c->pool);
140 b = apr_bucket_flush_create();
141 APR_BRIGADE_INSERT_TAIL(bb, b);
142 ap_pass_brigade(c->output_filters, bb);
145 /* we now proceed to read from the client until we get EOF, or until
146 * MAX_SECS_TO_LINGER has passed. the reasons for doing this are
147 * documented in a draft:
149 * http://www.ics.uci.edu/pub/ietf/http/draft-ietf-http-connection-00.txt
151 * in a nutshell -- if we don't make this effort we risk causing
152 * TCP RST packets to be sent which can tear down a connection before
153 * all the response data has been sent to the client.
155 #define SECONDS_TO_LINGER 2
156 apr_status_t ap_lingering_close(void *dummy)
159 apr_size_t nbytes = sizeof(dummybuf);
162 apr_int32_t total_linger_time = 0;
163 core_net_rec *net = dummy;
165 ap_update_child_status(AP_CHILD_THREAD_FROM_ID(net->c->id), SERVER_CLOSING, NULL);
168 ap_flush_conn(net->c); /* just close it */
169 apr_socket_close(net->client_socket);
173 /* Close the connection, being careful to send out whatever is still
174 * in our buffers. If possible, try to avoid a hard close until the
175 * client has ACKed our FIN and/or has stopped sending us data.
178 /* Send any leftover data to the client, but never try to again */
179 ap_flush_conn(net->c);
181 if (net->c->aborted) {
182 apr_socket_close(net->client_socket);
186 /* Shut down the socket for write, which will send a FIN
189 if (apr_shutdown(net->client_socket, APR_SHUTDOWN_WRITE) != APR_SUCCESS ||
193 /* Read all data from the peer until we reach "end-of-file" (FIN
194 * from peer) or we've exceeded our overall timeout. If the client does
195 * not send us bytes within 2 seconds (a value pulled from Apache 1.3
196 * which seems to work well), close the connection.
198 timeout = SECONDS_TO_LINGER * APR_USEC_PER_SEC;
199 apr_setsocketopt(net->client_socket, APR_SO_TIMEOUT, timeout);
200 apr_setsocketopt(net->client_socket, APR_INCOMPLETE_READ, 1);
202 nbytes = sizeof(dummybuf);
203 rc = apr_recv(net->client_socket, dummybuf, &nbytes);
204 if (rc != APR_SUCCESS || nbytes == 0) break;
206 total_linger_time += SECONDS_TO_LINGER;
207 if (total_linger_time >= MAX_SECS_TO_LINGER) {
212 apr_socket_close(net->client_socket);
216 AP_CORE_DECLARE(void) ap_process_connection(conn_rec *c)
218 ap_update_vhost_given_ip(c);
220 ap_run_pre_connection(c);
222 ap_run_process_connection(c);