Initial keep-alive support for the client socket.
[privoxy.git] / gateway.c
index 2d3a491..3181609 100644 (file)
--- a/gateway.c
+++ b/gateway.c
@@ -1,13 +1,13 @@
-const char gateway_rcs[] = "$Id: gateway.c,v 1.43 2008/11/13 09:15:51 fabiankeil Exp $";
+const char gateway_rcs[] = "$Id: gateway.c,v 1.48 2009/02/13 17:20:36 fabiankeil Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/gateway.c,v $
  *
  * Purpose     :  Contains functions to connect to a server, possibly
  *                using a "forwarder" (i.e. HTTP proxy and/or a SOCKS4
- *                proxy).
+ *                or SOCKS5 proxy).
  *
- * Copyright   :  Written by and Copyright (C) 2001-2008 the SourceForge
+ * Copyright   :  Written by and Copyright (C) 2001-2009 the SourceForge
  *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
@@ -34,6 +34,24 @@ const char gateway_rcs[] = "$Id: gateway.c,v 1.43 2008/11/13 09:15:51 fabiankeil
  *
  * Revisions   :
  *    $Log: gateway.c,v $
+ *    Revision 1.48  2009/02/13 17:20:36  fabiankeil
+ *    Reword keep-alive support warning and only show
+ *    it #if !defined(HAVE_POLL) && !defined(_WIN32).
+ *
+ *    Revision 1.47  2008/12/24 17:06:19  fabiankeil
+ *    Keep a thread around to timeout alive connections
+ *    even if no new requests are coming in.
+ *
+ *    Revision 1.46  2008/12/13 11:07:23  fabiankeil
+ *    Remove duplicated debugging checks
+ *    in connection_destination_matches().
+ *
+ *    Revision 1.45  2008/12/04 18:17:07  fabiankeil
+ *    Fix some cparser warnings.
+ *
+ *    Revision 1.44  2008/11/22 11:54:04  fabiankeil
+ *    Move log message around to include the socket number.
+ *
  *    Revision 1.43  2008/11/13 09:15:51  fabiankeil
  *    Make keep_alive_timeout static.
  *
@@ -321,27 +339,8 @@ static const char socks_userid[] = "anonymous";
 #define MAX_REUSABLE_CONNECTIONS 100
 static int keep_alive_timeout = DEFAULT_KEEP_ALIVE_TIMEOUT;
 
-struct reusable_connection
-{
-   jb_socket sfd;
-   int       in_use;
-   char      *host;
-   int       port;
-   time_t    timestamp;
-
-   int       forwarder_type;
-   char      *gateway_host;
-   int       gateway_port;
-   char      *forward_host;
-   int       forward_port;
-};
-
 static struct reusable_connection reusable_connection[MAX_REUSABLE_CONNECTIONS];
-
 static int mark_connection_unused(jb_socket sfd);
-static void mark_connection_closed(struct reusable_connection *closed_connection);
-static int socket_is_still_usable(jb_socket sfd);
-
 
 /*********************************************************************
  *
@@ -359,13 +358,12 @@ extern void initialize_reusable_connections(void)
 {
    unsigned int slot = 0;
 
+#if !defined(HAVE_POLL) && !defined(_WIN32)
    log_error(LOG_LEVEL_INFO,
-      "Support for 'Connection: keep-alive' is experimental."
-#ifndef HAVE_POLL
-      " Detecting already dead connections might not work"
-      " correctly on your platform."
-#endif /* ndef HAVE_POLL */
-   );
+      "Detecting already dead connections might not work "
+      "correctly on your platform. In case of problems, "
+      "unset the keep-alive-timeout option.");
+#endif
 
    for (slot = 0; slot < SZ(reusable_connection); slot++)
    {
@@ -485,7 +483,6 @@ void remember_connection(jb_socket sfd, const struct http_request *http,
  * Function    :  mark_connection_closed
  *
  * Description : Marks a reused connection closed.
- *               Must be called with connection_reuse_mutex locked.
  *
  * Parameters  :
  *          1  :  closed_connection = The connection to mark as closed.
@@ -493,7 +490,7 @@ void remember_connection(jb_socket sfd, const struct http_request *http,
  * Returns     : void
  *
  *********************************************************************/
-static void mark_connection_closed(struct reusable_connection *closed_connection)
+void mark_connection_closed(struct reusable_connection *closed_connection)
 {
    closed_connection->in_use = FALSE;
    closed_connection->sfd = JB_INVALID_SOCKET;
@@ -558,7 +555,7 @@ void forget_connection(jb_socket sfd)
  * Function    :  connection_destination_matches
  *
  * Description :  Determines whether a remembered connection can
- *                be reused. That is whether the destination and
+ *                be reused. That is, whether the destination and
  *                the forwarding settings match.
  *
  * Parameters  :
@@ -569,43 +566,10 @@ void forget_connection(jb_socket sfd)
  * Returns     :  TRUE for yes, FALSE otherwise.
  *
  *********************************************************************/
-static int connection_destination_matches(const struct reusable_connection *connection,
-                                          const struct http_request *http,
-                                          const struct forward_spec *fwd)
+int connection_destination_matches(const struct reusable_connection *connection,
+                                   const struct http_request *http,
+                                   const struct forward_spec *fwd)
 {
-   /* XXX: Start of duplicated checks for debugging purposes. */
-   if (strcmpic(connection->host, http->host))
-   {
-      return FALSE;
-   }
-
-   if (connection->forwarder_type != fwd->type)
-   {
-      log_error(LOG_LEVEL_CONNECT, "Type mismatch: %d %d (%s)",
-         connection->forwarder_type, fwd->type, http->host);
-      return FALSE;
-   }
-   if (connection->gateway_port   != fwd->gateway_port)
-   {
-      log_error(LOG_LEVEL_CONNECT, "Gateway port mismatch: %d %d (%s)",
-         connection->gateway_port, fwd->gateway_port, http->host);
-      return FALSE;
-   }
-   if (connection->forward_port   != fwd->forward_port)
-   {
-      log_error(LOG_LEVEL_CONNECT, "Forward port mismatch: %d %d (%s)",
-         connection->forward_port, fwd->forward_port, http->host);
-      return FALSE;
-   }
-   if (connection->port != http->port)
-   {
-      log_error(LOG_LEVEL_CONNECT, "Server port mismatch: %d %d (%s)",
-         connection->port, http->port, http->host);
-      return FALSE;
-   }
-
-   /* XXX: End of duplicated checks for debugging purposes. */
-
    if ((connection->forwarder_type != fwd->type)
     || (connection->gateway_port   != fwd->gateway_port)
     || (connection->forward_port   != fwd->forward_port)
@@ -646,12 +610,15 @@ static int connection_destination_matches(const struct reusable_connection *conn
  *
  * Parameters  :  none
  *
- * Returns     :  void
+ * Returns     :  Number of connections that are still alive.
  *
  *********************************************************************/
-static void close_unusable_connections(void)
+int close_unusable_connections(void)
 {
    unsigned int slot = 0;
+   int connections_alive = 0;
+
+   privoxy_mutex_lock(&connection_reuse_mutex);
 
    for (slot = 0; slot < SZ(reusable_connection); slot++)
    {
@@ -670,10 +637,8 @@ static void close_unusable_connections(void)
                reusable_connection[slot].sfd, keep_alive_timeout);
             close_socket(reusable_connection[slot].sfd);
             mark_connection_closed(&reusable_connection[slot]);
-            continue;
          }
-
-         if (!socket_is_still_usable(reusable_connection[slot].sfd))
+         else if (!socket_is_still_usable(reusable_connection[slot].sfd))
          {
             log_error(LOG_LEVEL_CONNECT,
                "The connection to %s:%d in slot %d is no longer usable. "
@@ -682,70 +647,18 @@ static void close_unusable_connections(void)
                reusable_connection[slot].sfd);
             close_socket(reusable_connection[slot].sfd);
             mark_connection_closed(&reusable_connection[slot]);
-            continue;
+         }
+         else
+         {
+            connections_alive++;
          }
       }
    }
-}
-
-
-/*********************************************************************
- *
- * Function    :  socket_is_still_usable
- *
- * Description :  Decides whether or not an open socket is still usable.
- *
- * Parameters  :
- *          1  :  sfd = The socket to check.
- *
- * Returns     :  TRUE for yes, otherwise FALSE.
- *
- *********************************************************************/
-static int socket_is_still_usable(jb_socket sfd)
-{
-#ifdef HAVE_POLL
-   int poll_result;
-   struct pollfd poll_fd[1];
-
-   memset(poll_fd, 0, sizeof(poll_fd));
-   poll_fd[0].fd = sfd;
-   poll_fd[0].events = POLLIN;
-
-   poll_result = poll(poll_fd, 1, 0);
-
-   if (-1 != poll_result)
-   {
-      return !(poll_fd[0].revents & POLLIN);
-   }
-   else
-   {
-      log_error(LOG_LEVEL_CONNECT, "Polling socket %d failed.", sfd);
-      return FALSE;
-   }
-#else
-   fd_set readable_fds;
-   struct timeval timeout;
-   int ret;
-   int socket_is_alive = 0;
-
-   memset(&timeout, '\0', sizeof(timeout));
-   FD_ZERO(&readable_fds);
-   FD_SET(sfd, &readable_fds);
 
-   ret = select((int)sfd+1, &readable_fds, NULL, NULL, &timeout);
-   if (ret < 0)
-   {
-      log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
-   }
+   privoxy_mutex_unlock(&connection_reuse_mutex);
 
-   /*
-    * XXX: I'm not sure why !FD_ISSET() works,
-    * but apparently it does.
-    */
-   socket_is_alive = !FD_ISSET(sfd, &readable_fds);
+   return connections_alive;
 
-   return socket_is_alive;
-#endif /* def HAVE_POLL */
 }
 
 
@@ -770,10 +683,10 @@ static jb_socket get_reusable_connection(const struct http_request *http,
    jb_socket sfd = JB_INVALID_SOCKET;
    unsigned int slot = 0;
 
-   privoxy_mutex_lock(&connection_reuse_mutex);
-
    close_unusable_connections();
 
+   privoxy_mutex_lock(&connection_reuse_mutex);
+
    for (slot = 0; slot < SZ(reusable_connection); slot++)
    {
       if (!reusable_connection[slot].in_use
@@ -1106,7 +1019,6 @@ static jb_socket socks4_connect(const struct forward_spec * fwd,
    {
       case SOCKS_REQUEST_GRANTED:
          return(sfd);
-         break;
       case SOCKS_REQUEST_REJECT:
          errstr = "SOCKS request rejected or failed.";
          errno = EINVAL;
@@ -1229,7 +1141,7 @@ static jb_socket socks5_connect(const struct forward_spec *fwd,
    }
 
    hostlen = strlen(target_host);
-   if (hostlen > 255)
+   if (hostlen > (size_t)255)
    {
       errstr = "target host name is longer than 255 characters";
       err = 1;
@@ -1317,7 +1229,7 @@ static jb_socket socks5_connect(const struct forward_spec *fwd,
    cbuf[client_pos++] = '\x00'; /* Reserved, must be 0x00 */
    cbuf[client_pos++] = '\x03'; /* Address is domain name */
    cbuf[client_pos++] = (char)(hostlen & 0xffu);
-   assert(sizeof(cbuf) - client_pos > 255);
+   assert(sizeof(cbuf) - client_pos > (size_t)255);
    /* Using strncpy because we really want the nul byte padding. */
    strncpy(cbuf + client_pos, target_host, sizeof(cbuf) - client_pos);
    client_pos += (hostlen & 0xffu);