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

   1 /* ====================================================================
   2  * The Apache Software License, Version 1.1
   3  *
   4  * Copyright (c) 2000 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 #define CORE_PRIVATE
  60 #include "ap_config.h"
  61 #include "httpd.h"
  62 #include "http_connection.h"
  63 #include "http_request.h"
  64 #include "http_protocol.h"
  65 #include "ap_mpm.h"
  66 #include "mpm_status.h"
  67 #include "http_config.h"
  68 #include "http_vhost.h"
  69
  70 AP_HOOK_STRUCT(
  71             AP_HOOK_LINK(pre_connection)
  72             AP_HOOK_LINK(process_connection)
  73 )
  74
  75 AP_IMPLEMENT_HOOK_RUN_ALL(int,pre_connection,(conn_rec *c),(c),OK,DECLINED)
  76 AP_IMPLEMENT_HOOK_RUN_FIRST(int,process_connection,(conn_rec *c),(c),DECLINED)
  77
  78 /*
  79  * More machine-dependent networking gooo... on some systems,
  80  * you've got to be *really* sure that all the packets are acknowledged
  81  * before closing the connection, since the client will not be able
  82  * to see the last response if their TCP buffer is flushed by a RST
  83  * packet from us, which is what the server's TCP stack will send
  84  * if it receives any request data after closing the connection.
  85  *
  86  * In an ideal world, this function would be accomplished by simply
  87  * setting the socket option SO_LINGER and handling it within the
  88  * server's TCP stack while the process continues on to the next request.
  89  * Unfortunately, it seems that most (if not all) operating systems
  90  * block the server process on close() when SO_LINGER is used.
  91  * For those that don't, see USE_SO_LINGER below.  For the rest,
  92  * we have created a home-brew lingering_close.
  93  *
  94  * Many operating systems tend to block, puke, or otherwise mishandle
  95  * calls to shutdown only half of the connection.  You should define
  96  * NO_LINGCLOSE in ap_config.h if such is the case for your system.
  97  */
  98 #ifndef MAX_SECS_TO_LINGER
  99 #define MAX_SECS_TO_LINGER 30
 100 #endif
 101
 102 #ifdef USE_SO_LINGER
 103 #define NO_LINGCLOSE            /* The two lingering options are exclusive */
 104
 105 static void sock_enable_linger(int s)
 106 {
 107     struct linger li;
 108
 109     li.l_onoff = 1;
 110     li.l_linger = MAX_SECS_TO_LINGER;
 111
 112     if (setsockopt(s, SOL_SOCKET, SO_LINGER,
 113                    (char *) &li, sizeof(struct linger)) < 0) {
 114         ap_log_error(APLOG_MARK, APLOG_WARNING, server_conf,
 115                     "setsockopt: (SO_LINGER)");
 116         /* not a fatal error */
 117     }
 118 }
 119
 120 #else
 121 #define sock_enable_linger(s)   /* NOOP */
 122 #endif /* USE_SO_LINGER */
 123
 124 #ifndef NO_LINGCLOSE
 125
 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:
 129  *
 130  * http://www.ics.uci.edu/pub/ietf/http/draft-ietf-http-connection-00.txt
 131  *
 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.
 135  */
 136
 137 static void lingering_close(conn_rec *c)
 138 {
 139     char dummybuf[512];
 140     ap_time_t start;
 141     ap_ssize_t nbytes;
 142     ap_status_t rc;
 143     int timeout;
 144
 145     /* Send any leftover data to the client, but never try to again */
 146
 147     if (ap_bflush(c->client) != APR_SUCCESS) {
 148         ap_bclose(c->client);
 149         return;
 150     }
 151
 152     /* Shut down the socket for write, which will send a FIN
 153      * to the peer.
 154      */
 155
 156     if (ap_bshutdown(c->client, 1) != APR_SUCCESS
 157         || ap_is_aborted(c)) {
 158         ap_bclose(c->client);
 159         return;
 160     }
 161
 162     /* Read all data from the peer until we reach "end-of-file" (FIN
 163      * from peer) or we've exceeded our overall timeout.
 164      */
 165
 166     start = ap_now();
 167     timeout = MAX_SECS_TO_LINGER;
 168     for (;;) {
 169         ap_bsetopt(c->client, BO_TIMEOUT, &timeout);
 170         rc = ap_bread(c->client, dummybuf, sizeof(dummybuf),
 171                       &nbytes);
 172         if (rc != APR_SUCCESS || nbytes == 0) break;
 173
 174         /* how much time has elapsed? */
 175         timeout = (int)((ap_now() - start) / AP_USEC_PER_SEC);
 176         if (timeout >= MAX_SECS_TO_LINGER) break;
 177
 178         /* figure out the new timeout */
 179         timeout = MAX_SECS_TO_LINGER - timeout;
 180     }
 181
 182     ap_bclose(c->client);
 183 }
 184
 185 #endif /* ndef NO_LINGCLOSE */
 186
 187 CORE_EXPORT(void) ap_process_connection(conn_rec *c)
 188 {
 189     ap_update_vhost_given_ip(c);
 190
 191     ap_run_pre_connection(c);
 192
 193     ap_run_process_connection(c);
 194
 195     /*
 196      * Close the connection, being careful to send out whatever is still
 197      * in our buffers.  If possible, try to avoid a hard close until the
 198      * client has ACKed our FIN and/or has stopped sending us data.
 199      */
 200
 201 #ifdef NO_LINGCLOSE
 202     ap_bclose(c->client);       /* just close it */
 203 #else
 204     if (!c->aborted
 205         && c->client
 206         /* && (c->client->fd >= 0) */ ) {
 207
 208         lingering_close(c);
 209     }
 210     else {
 211         ap_bsetflag(c->client, B_EOUT, 1);
 212         ap_bclose(c->client);
 213     }
 214 #endif
 215 }
 216
 217 int ap_process_http_connection(conn_rec *c)
 218 {
 219     request_rec *r;
 220
 221     /*
 222      * Read and process each request found on our connection
 223      * until no requests are left or we decide to close.
 224      */
 225
 226     ap_update_connection_status(c->id, "Status", "Reading");
 227     while ((r = ap_read_request(c)) != NULL) {
 228
 229         /* process the request if it was read without error */
 230
 231         ap_update_connection_status(c->id, "Status", "Writing");
 232         if (r->status == HTTP_OK)
 233             ap_process_request(r);
 234
 235         if (!c->keepalive || c->aborted)
 236             break;
 237
 238         ap_update_connection_status(c->id, "Status", "Keepalive");
 239         ap_destroy_pool(r->pool);
 240
 241         if (ap_graceful_stop_signalled())
 242             break;
 243     }
 244
 245     ap_reset_connection_status(c->id);
 246     return OK;
 247 }
 248
 249 /* Clearly some of this stuff doesn't belong in a generalised connection
 250    structure, but for now...
 251 */
 252
 253 conn_rec *ap_new_connection(ap_pool_t *p, server_rec *server, BUFF *inout,
 254                             const struct sockaddr_in *remaddr,
 255                             const struct sockaddr_in *saddr, long id)
 256 {
 257     conn_rec *conn = (conn_rec *) ap_pcalloc(p, sizeof(conn_rec));
 258
 259     /* Got a connection structure, so initialize what fields we can
 260      * (the rest are zeroed out by pcalloc).
 261      */
 262
 263     conn->conn_config=ap_create_conn_config(p);
 264
 265     conn->pool = p;
 266     conn->local_addr = *saddr;
 267     conn->local_ip = ap_pstrdup(conn->pool,
 268                                 inet_ntoa(conn->local_addr.sin_addr));
 269     conn->base_server = server;
 270     conn->client = inout;
 271
 272     conn->remote_addr = *remaddr;
 273     conn->remote_ip = ap_pstrdup(conn->pool,
 274                               inet_ntoa(conn->remote_addr.sin_addr));
 275
 276     conn->id = id;
 277
 278     return conn;
 279 }
 280
 281
 282
 283 conn_rec *ap_new_apr_connection(ap_pool_t *p, server_rec *server, BUFF *inout,
 284                             const ap_socket_t *conn_socket, long id)
 285 {
 286     struct sockaddr_in *sa_local, *sa_remote;
 287
 288     ap_get_local_name(&sa_local, conn_socket);
 289     ap_get_remote_name(&sa_remote, conn_socket);
 290     return ap_new_connection(p, server, inout, sa_remote, sa_local, id);
 291 }