granicus.if.org Git - apache/blob - server/connection.c

   1 /* ====================================================================
   2  * The Apache Software License, Version 1.1
   3  *
   4  * Copyright (c) 2000-2001 The Apache Software Foundation.  All rights
   5  * reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  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
  17  *    distribution.
  18  *
  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.
  25  *
  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.
  30  *
  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.
  34  *
  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
  46  * SUCH DAMAGE.
  47  * ====================================================================
  48  *
  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/>.
  53  *
  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.
  57  */
  58
  59 #include "apr.h"
  60 #include "apr_strings.h"
  61
  62 #define CORE_PRIVATE
  63 #include "ap_config.h"
  64 #include "httpd.h"
  65 #include "http_connection.h"
  66 #include "http_request.h"
  67 #include "http_protocol.h"
  68 #include "ap_mpm.h"
  69 #include "mpm_default.h"
  70 #include "http_config.h"
  71 #include "http_vhost.h"
  72 #include "scoreboard.h"
  73 #include "http_log.h"
  74 #include "util_filter.h"
  75
  76 APR_HOOK_STRUCT(
  77             APR_HOOK_LINK(pre_connection)
  78             APR_HOOK_LINK(process_connection)
  79 )
  80
  81 AP_IMPLEMENT_HOOK_RUN_ALL(int,pre_connection,(conn_rec *c),(c),OK,DECLINED)
  82 AP_IMPLEMENT_HOOK_RUN_FIRST(int,process_connection,(conn_rec *c),(c),DECLINED)
  83
  84 /*
  85  * More machine-dependent networking gooo... on some systems,
  86  * you've got to be *really* sure that all the packets are acknowledged
  87  * before closing the connection, since the client will not be able
  88  * to see the last response if their TCP buffer is flushed by a RST
  89  * packet from us, which is what the server's TCP stack will send
  90  * if it receives any request data after closing the connection.
  91  *
  92  * In an ideal world, this function would be accomplished by simply
  93  * setting the socket option SO_LINGER and handling it within the
  94  * server's TCP stack while the process continues on to the next request.
  95  * Unfortunately, it seems that most (if not all) operating systems
  96  * block the server process on close() when SO_LINGER is used.
  97  * For those that don't, see USE_SO_LINGER below.  For the rest,
  98  * we have created a home-brew lingering_close.
  99  *
 100  * Many operating systems tend to block, puke, or otherwise mishandle
 101  * calls to shutdown only half of the connection.  You should define
 102  * NO_LINGCLOSE in ap_config.h if such is the case for your system.
 103  */
 104 #ifndef MAX_SECS_TO_LINGER
 105 #define MAX_SECS_TO_LINGER 30
 106 #endif
 107
 108 #ifdef USE_SO_LINGER
 109 #define NO_LINGCLOSE            /* The two lingering options are exclusive */
 110
 111 static void sock_enable_linger(int s)
 112 {
 113     struct linger li;
 114
 115     li.l_onoff = 1;
 116     li.l_linger = MAX_SECS_TO_LINGER;
 117
 118     if (setsockopt(s, SOL_SOCKET, SO_LINGER,
 119                    (char *) &li, sizeof(struct linger)) < 0) {
 120         ap_log_error(APLOG_MARK, APLOG_WARNING, errno, server_conf,
 121                     "setsockopt: (SO_LINGER)");
 122         /* not a fatal error */
 123     }
 124 }
 125
 126 #else
 127 #define sock_enable_linger(s)   /* NOOP */
 128 #endif /* USE_SO_LINGER */
 129
 130 AP_CORE_DECLARE(void) ap_flush_conn(conn_rec *c)
 131 {
 132     apr_bucket_brigade *bb;
 133     apr_bucket *b;
 134
 135     bb = apr_brigade_create(c->pool);
 136     b = apr_bucket_flush_create();
 137     APR_BRIGADE_INSERT_TAIL(bb, b);
 138     ap_pass_brigade(c->output_filters, bb);
 139 }
 140
 141 /* we now proceed to read from the client until we get EOF, or until
 142  * MAX_SECS_TO_LINGER has passed.  the reasons for doing this are
 143  * documented in a draft:
 144  *
 145  * http://www.ics.uci.edu/pub/ietf/http/draft-ietf-http-connection-00.txt
 146  *
 147  * in a nutshell -- if we don't make this effort we risk causing
 148  * TCP RST packets to be sent which can tear down a connection before
 149  * all the response data has been sent to the client.
 150  */
 151 #define SECONDS_TO_LINGER  2
 152 void ap_lingering_close(conn_rec *c)
 153 {
 154     char dummybuf[512];
 155     apr_size_t nbytes = sizeof(dummybuf);
 156     apr_status_t rc;
 157     apr_int32_t timeout;
 158     apr_int32_t total_linger_time = 0;
 159
 160     ap_update_child_status(AP_CHILD_THREAD_FROM_ID(c->id), SERVER_CLOSING, NULL);
 161
 162 #ifdef NO_LINGCLOSE
 163     ap_flush_conn(c);   /* just close it */
 164     apr_socket_close(c->client_socket);
 165     return;
 166 #endif
 167
 168     /* Close the connection, being careful to send out whatever is still
 169      * in our buffers.  If possible, try to avoid a hard close until the
 170      * client has ACKed our FIN and/or has stopped sending us data.
 171      */
 172
 173     /* Send any leftover data to the client, but never try to again */
 174     ap_flush_conn(c);
 175
 176     if (c->aborted) {
 177         apr_socket_close(c->client_socket);
 178         return;
 179     }
 180
 181     /* Shut down the socket for write, which will send a FIN
 182      * to the peer.
 183      */
 184
 185     if (apr_shutdown(c->client_socket, APR_SHUTDOWN_WRITE) != APR_SUCCESS ||
 186         c->aborted) {
 187         apr_socket_close(c->client_socket);
 188         return;
 189     }
 190
 191     /* Read all data from the peer until we reach "end-of-file" (FIN
 192      * from peer) or we've exceeded our overall timeout. If the client does
 193      * not send us bytes within 2 seconds (a value pulled from Apache 1.3
 194      * which seems to work well), close the connection.
 195      */
 196     timeout = SECONDS_TO_LINGER * APR_USEC_PER_SEC;
 197     apr_setsocketopt(c->client_socket, APR_SO_TIMEOUT, timeout);
 198     apr_setsocketopt(c->client_socket, APR_INCOMPLETE_READ, 1);
 199     for (;;) {
 200         nbytes = sizeof(dummybuf);
 201         rc = apr_recv(c->client_socket, dummybuf, &nbytes);
 202         if (rc != APR_SUCCESS || nbytes == 0) break;
 203
 204         total_linger_time += SECONDS_TO_LINGER;
 205         if (total_linger_time >= MAX_SECS_TO_LINGER) {
 206             break;
 207         }
 208     }
 209
 210     apr_socket_close(c->client_socket);
 211 }
 212
 213 AP_CORE_DECLARE(void) ap_process_connection(conn_rec *c)
 214 {
 215     ap_update_vhost_given_ip(c);
 216
 217     ap_run_pre_connection(c);
 218
 219     ap_run_process_connection(c);
 220
 221 }
 222
 223 /* Clearly some of this stuff doesn't belong in a generalised connection
 224    structure, but for now...
 225 */
 226
 227 AP_CORE_DECLARE(conn_rec *)ap_new_connection(apr_pool_t *p, server_rec *server,
 228                             apr_socket_t *inout, long id)
 229 {
 230     conn_rec *conn = (conn_rec *) apr_pcalloc(p, sizeof(conn_rec));
 231     apr_status_t rv;
 232
 233     (void) ap_update_child_status(AP_CHILD_THREAD_FROM_ID(id),
 234                                   SERVER_BUSY_READ, (request_rec *) NULL);
 235
 236     /* Got a connection structure, so initialize what fields we can
 237      * (the rest are zeroed out by pcalloc).
 238      */
 239
 240     conn->conn_config=ap_create_conn_config(p);
 241     conn->notes = apr_table_make(p, 5);
 242
 243     conn->pool = p;
 244     if ((rv = apr_socket_addr_get(&conn->local_addr, APR_LOCAL, inout))
 245         != APR_SUCCESS) {
 246         ap_log_error(APLOG_MARK, APLOG_INFO, rv, server,
 247                      "apr_socket_addr_get(APR_LOCAL)");
 248         apr_socket_close(inout);
 249         return NULL;
 250     }
 251     apr_sockaddr_ip_get(&conn->local_ip, conn->local_addr);
 252     if ((rv = apr_socket_addr_get(&conn->remote_addr, APR_REMOTE, inout))
 253         != APR_SUCCESS) {
 254         ap_log_error(APLOG_MARK, APLOG_INFO, rv, server,
 255                      "apr_socket_addr_get(APR_REMOTE)");
 256         apr_socket_close(inout);
 257         return NULL;
 258     }
 259     apr_sockaddr_ip_get(&conn->remote_ip, conn->remote_addr);
 260     conn->base_server = server;
 261     conn->client_socket = inout;
 262
 263     conn->id = id;
 264
 265     return conn;
 266 }