1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000 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 "ap_config.h"
62 #include "http_connection.h"
63 #include "http_request.h"
64 #include "http_protocol.h"
66 #include "mpm_status.h"
67 #include "http_config.h"
68 #include "http_vhost.h"
71 AP_HOOK_LINK(pre_connection)
72 AP_HOOK_LINK(process_connection)
75 AP_IMPLEMENT_HOOK_RUN_ALL(API_EXPORT,int,pre_connection,
76 (conn_rec *c),(c),OK,DECLINED)
77 AP_IMPLEMENT_HOOK_RUN_FIRST(API_EXPORT,int,process_connection,
78 (conn_rec *c),(c),DECLINED)
81 * More machine-dependent networking gooo... on some systems,
82 * you've got to be *really* sure that all the packets are acknowledged
83 * before closing the connection, since the client will not be able
84 * to see the last response if their TCP buffer is flushed by a RST
85 * packet from us, which is what the server's TCP stack will send
86 * if it receives any request data after closing the connection.
88 * In an ideal world, this function would be accomplished by simply
89 * setting the socket option SO_LINGER and handling it within the
90 * server's TCP stack while the process continues on to the next request.
91 * Unfortunately, it seems that most (if not all) operating systems
92 * block the server process on close() when SO_LINGER is used.
93 * For those that don't, see USE_SO_LINGER below. For the rest,
94 * we have created a home-brew lingering_close.
96 * Many operating systems tend to block, puke, or otherwise mishandle
97 * calls to shutdown only half of the connection. You should define
98 * NO_LINGCLOSE in ap_config.h if such is the case for your system.
100 #ifndef MAX_SECS_TO_LINGER
101 #define MAX_SECS_TO_LINGER 30
105 #define NO_LINGCLOSE /* The two lingering options are exclusive */
107 static void sock_enable_linger(int s)
112 li.l_linger = MAX_SECS_TO_LINGER;
114 if (setsockopt(s, SOL_SOCKET, SO_LINGER,
115 (char *) &li, sizeof(struct linger)) < 0) {
116 ap_log_error(APLOG_MARK, APLOG_WARNING, server_conf,
117 "setsockopt: (SO_LINGER)");
118 /* not a fatal error */
123 #define sock_enable_linger(s) /* NOOP */
124 #endif /* USE_SO_LINGER */
126 /* we now proceed to read from the client until we get EOF, or until
127 * MAX_SECS_TO_LINGER has passed. the reasons for doing this are
128 * documented in a draft:
130 * http://www.ics.uci.edu/pub/ietf/http/draft-ietf-http-connection-00.txt
132 * in a nutshell -- if we don't make this effort we risk causing
133 * TCP RST packets to be sent which can tear down a connection before
134 * all the response data has been sent to the client.
137 void ap_lingering_close(conn_rec *c)
146 ap_bclose(c->client); /* just close it */
150 /* Close the connection, being careful to send out whatever is still
151 * in our buffers. If possible, try to avoid a hard close until the
152 * client has ACKed our FIN and/or has stopped sending us data.
155 if (c->aborted || !(c->client)) {
156 ap_bsetflag(c->client, B_EOUT, 1);
157 ap_bclose(c->client);
161 /* Send any leftover data to the client, but never try to again */
163 if (ap_bflush(c->client) != APR_SUCCESS) {
164 ap_bclose(c->client);
168 /* Shut down the socket for write, which will send a FIN
172 if (ap_bshutdown(c->client, 1) != APR_SUCCESS
173 || ap_is_aborted(c)) {
174 ap_bclose(c->client);
178 /* Read all data from the peer until we reach "end-of-file" (FIN
179 * from peer) or we've exceeded our overall timeout.
183 timeout = MAX_SECS_TO_LINGER;
185 ap_bsetopt(c->client, BO_TIMEOUT, &timeout);
186 rc = ap_bread(c->client, dummybuf, sizeof(dummybuf),
188 if (rc != APR_SUCCESS || nbytes == 0) break;
190 /* how much time has elapsed? */
191 timeout = (int)((ap_now() - start) / AP_USEC_PER_SEC);
192 if (timeout >= MAX_SECS_TO_LINGER) break;
194 /* figure out the new timeout */
195 timeout = MAX_SECS_TO_LINGER - timeout;
198 ap_bclose(c->client);
201 CORE_EXPORT(void) ap_process_connection(conn_rec *c)
203 ap_update_vhost_given_ip(c);
205 ap_run_pre_connection(c);
207 ap_run_process_connection(c);
211 int ap_process_http_connection(conn_rec *c)
216 * Read and process each request found on our connection
217 * until no requests are left or we decide to close.
220 ap_update_connection_status(c->id, "Status", "Reading");
221 while ((r = ap_read_request(c)) != NULL) {
223 /* process the request if it was read without error */
225 ap_update_connection_status(c->id, "Status", "Writing");
226 if (r->status == HTTP_OK)
227 ap_process_request(r);
229 if (!c->keepalive || c->aborted)
232 ap_update_connection_status(c->id, "Status", "Keepalive");
233 ap_destroy_pool(r->pool);
235 if (ap_graceful_stop_signalled())
239 ap_reset_connection_status(c->id);
243 /* Clearly some of this stuff doesn't belong in a generalised connection
244 structure, but for now...
247 conn_rec *ap_new_connection(ap_pool_t *p, server_rec *server, BUFF *inout,
248 const struct sockaddr_in *remaddr,
249 const struct sockaddr_in *saddr, long id)
251 conn_rec *conn = (conn_rec *) ap_pcalloc(p, sizeof(conn_rec));
253 /* Got a connection structure, so initialize what fields we can
254 * (the rest are zeroed out by pcalloc).
257 conn->conn_config=ap_create_conn_config(p);
260 conn->local_addr = *saddr;
261 conn->local_ip = ap_pstrdup(conn->pool,
262 inet_ntoa(conn->local_addr.sin_addr));
263 conn->base_server = server;
264 conn->client = inout;
266 conn->remote_addr = *remaddr;
267 conn->remote_ip = ap_pstrdup(conn->pool,
268 inet_ntoa(conn->remote_addr.sin_addr));
277 conn_rec *ap_new_apr_connection(ap_pool_t *p, server_rec *server, BUFF *inout,
278 const ap_socket_t *conn_socket, long id)
280 struct sockaddr_in *sa_local, *sa_remote;
282 ap_get_local_name(&sa_local, conn_socket);
283 ap_get_remote_name(&sa_remote, conn_socket);
284 return ap_new_connection(p, server, inout, sa_remote, sa_local, id);