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

   1 /* Copyright 1999-2005 The Apache Software Foundation or its licensors, as
   2  * applicable.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include "apr.h"
  18 #include "apr_strings.h"
  19
  20 #define CORE_PRIVATE
  21 #include "ap_config.h"
  22 #include "httpd.h"
  23 #include "http_connection.h"
  24 #include "http_request.h"
  25 #include "http_protocol.h"
  26 #include "ap_mpm.h"
  27 #include "mpm_default.h"
  28 #include "http_config.h"
  29 #include "http_core.h"
  30 #include "http_vhost.h"
  31 #include "scoreboard.h"
  32 #include "http_log.h"
  33 #include "util_filter.h"
  34
  35 APR_HOOK_STRUCT(
  36             APR_HOOK_LINK(create_connection)
  37             APR_HOOK_LINK(process_connection)
  38             APR_HOOK_LINK(pre_connection)
  39 )
  40 AP_IMPLEMENT_HOOK_RUN_FIRST(conn_rec *,create_connection,
  41                             (apr_pool_t *p, server_rec *server, apr_socket_t *csd, long conn_id, void *sbh, apr_bucket_alloc_t *alloc),
  42                             (p, server, csd, conn_id, sbh, alloc), NULL)
  43 AP_IMPLEMENT_HOOK_RUN_FIRST(int,process_connection,(conn_rec *c),(c),DECLINED)
  44 AP_IMPLEMENT_HOOK_RUN_ALL(int,pre_connection,(conn_rec *c, void *csd),(c, csd),OK,DECLINED)
  45 /*
  46  * More machine-dependent networking gooo... on some systems,
  47  * you've got to be *really* sure that all the packets are acknowledged
  48  * before closing the connection, since the client will not be able
  49  * to see the last response if their TCP buffer is flushed by a RST
  50  * packet from us, which is what the server's TCP stack will send
  51  * if it receives any request data after closing the connection.
  52  *
  53  * In an ideal world, this function would be accomplished by simply
  54  * setting the socket option SO_LINGER and handling it within the
  55  * server's TCP stack while the process continues on to the next request.
  56  * Unfortunately, it seems that most (if not all) operating systems
  57  * block the server process on close() when SO_LINGER is used.
  58  * For those that don't, see USE_SO_LINGER below.  For the rest,
  59  * we have created a home-brew lingering_close.
  60  *
  61  * Many operating systems tend to block, puke, or otherwise mishandle
  62  * calls to shutdown only half of the connection.  You should define
  63  * NO_LINGCLOSE in ap_config.h if such is the case for your system.
  64  */
  65 #ifndef MAX_SECS_TO_LINGER
  66 #define MAX_SECS_TO_LINGER 30
  67 #endif
  68
  69 AP_CORE_DECLARE(void) ap_flush_conn(conn_rec *c)
  70 {
  71     apr_bucket_brigade *bb;
  72     apr_bucket *b;
  73
  74     bb = apr_brigade_create(c->pool, c->bucket_alloc);
  75
  76     /* FLUSH bucket */
  77     b = apr_bucket_flush_create(c->bucket_alloc);
  78     APR_BRIGADE_INSERT_TAIL(bb, b);
  79
  80     /* End Of Connection bucket */
  81     b = ap_bucket_eoc_create(c->bucket_alloc);
  82     APR_BRIGADE_INSERT_TAIL(bb, b);
  83
  84     ap_pass_brigade(c->output_filters, bb);
  85 }
  86
  87 /* we now proceed to read from the client until we get EOF, or until
  88  * MAX_SECS_TO_LINGER has passed.  the reasons for doing this are
  89  * documented in a draft:
  90  *
  91  * http://www.ics.uci.edu/pub/ietf/http/draft-ietf-http-connection-00.txt
  92  *
  93  * in a nutshell -- if we don't make this effort we risk causing
  94  * TCP RST packets to be sent which can tear down a connection before
  95  * all the response data has been sent to the client.
  96  */
  97 #define SECONDS_TO_LINGER  2
  98 AP_DECLARE(void) ap_lingering_close(conn_rec *c)
  99 {
 100     char dummybuf[512];
 101     apr_size_t nbytes;
 102     apr_time_t timeup = 0;
 103     apr_socket_t *csd = ap_get_module_config(c->conn_config, &core_module);
 104
 105     if (!csd) {
 106         return;
 107     }
 108
 109     ap_update_child_status(c->sbh, SERVER_CLOSING, NULL);
 110
 111 #ifdef NO_LINGCLOSE
 112     ap_flush_conn(c); /* just close it */
 113     apr_socket_close(csd);
 114     return;
 115 #endif
 116
 117     /* Close the connection, being careful to send out whatever is still
 118      * in our buffers.  If possible, try to avoid a hard close until the
 119      * client has ACKed our FIN and/or has stopped sending us data.
 120      */
 121
 122     /* Send any leftover data to the client, but never try to again */
 123     ap_flush_conn(c);
 124
 125     if (c->aborted) {
 126         apr_socket_close(csd);
 127         return;
 128     }
 129
 130     /* Shut down the socket for write, which will send a FIN
 131      * to the peer.
 132      */
 133     if (apr_socket_shutdown(csd, APR_SHUTDOWN_WRITE) != APR_SUCCESS
 134         || c->aborted) {
 135         apr_socket_close(csd);
 136         return;
 137     }
 138
 139     /* Read available data from the client whilst it continues sending
 140      * it, for a maximum time of MAX_SECS_TO_LINGER.  If the client
 141      * does not send any data within 2 seconds (a value pulled from
 142      * Apache 1.3 which seems to work well), give up.
 143      */
 144     apr_socket_timeout_set(csd, apr_time_from_sec(SECONDS_TO_LINGER));
 145     apr_socket_opt_set(csd, APR_INCOMPLETE_READ, 1);
 146
 147     /* The common path here is that the initial apr_socket_recv() call
 148      * will return 0 bytes read; so that case must avoid the expensive
 149      * apr_time_now() call and time arithmetic. */
 150
 151     do {
 152         nbytes = sizeof(dummybuf);
 153         if (apr_socket_recv(csd, dummybuf, &nbytes) || nbytes == 0)
 154             break;
 155
 156         if (timeup == 0) {
 157             /* First time through; calculate now + 30 seconds. */
 158             timeup = apr_time_now() + apr_time_from_sec(MAX_SECS_TO_LINGER);
 159             continue;
 160         }
 161     } while (apr_time_now() < timeup);
 162
 163     apr_socket_close(csd);
 164     return;
 165 }
 166
 167 AP_CORE_DECLARE(void) ap_process_connection(conn_rec *c, void *csd)
 168 {
 169     int rc;
 170     ap_update_vhost_given_ip(c);
 171
 172     rc = ap_run_pre_connection(c, csd);
 173     if (rc != OK && rc != DONE) {
 174         c->aborted = 1;
 175     }
 176
 177     if (!c->aborted) {
 178         ap_run_process_connection(c);
 179     }
 180 }
 181