-const char gateway_rcs[] = "$Id: gateway.c,v 1.29 2008/10/11 16:59:41 fabiankeil Exp $";
+const char gateway_rcs[] = "$Id: gateway.c,v 1.46 2008/12/13 11:07:23 fabiankeil Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/gateway.c,v $
*
* Revisions :
* $Log: gateway.c,v $
+ * 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.
+ *
+ * Revision 1.42 2008/11/13 09:08:42 fabiankeil
+ * Add new config option: keep-alive-timeout.
+ *
+ * Revision 1.41 2008/11/08 15:29:58 fabiankeil
+ * Unify two debug messages.
+ *
+ * Revision 1.40 2008/11/08 15:14:05 fabiankeil
+ * Fix duplicated debugging check.
+ *
+ * Revision 1.39 2008/10/25 11:33:01 fabiankeil
+ * Remove already out-commented line left over from debugging.
+ *
+ * Revision 1.38 2008/10/24 17:33:00 fabiankeil
+ * - Tone the "keep-alive support is experimental" warning
+ * down a bit as hackish 0-chunk detection has been
+ * implemented recently.
+ * - Only show the "ndef HAVE_POLL" warning once on start-up.
+ *
+ * Revision 1.37 2008/10/23 17:40:53 fabiankeil
+ * Fix forget_connection() and mark_connection_unused(),
+ * which would both under certain circumstances access
+ * reusable_connection[MAX_REUSABLE_CONNECTIONS]. Oops.
+ *
+ * Revision 1.36 2008/10/18 19:49:15 fabiankeil
+ * - Factor close_unusable_connections() out of
+ * get_reusable_connection() to make sure we really check
+ * all the remembered connections, not just the ones before
+ * the next reusable one.
+ * - Plug two file descriptor leaks. Internally marking
+ * connections as closed doesn't cut it.
+ *
+ * Revision 1.35 2008/10/17 17:12:01 fabiankeil
+ * In socket_is_still_usable(), use select()
+ * and FD_ISSET() if poll() isn't available.
+ *
+ * Revision 1.34 2008/10/17 17:07:13 fabiankeil
+ * Add preliminary timeout support.
+ *
+ * Revision 1.33 2008/10/16 16:34:21 fabiankeil
+ * Fix two gcc44 warnings.
+ *
+ * Revision 1.32 2008/10/16 16:27:22 fabiankeil
+ * Fix compiler warning.
+ *
+ * Revision 1.31 2008/10/16 07:31:11 fabiankeil
+ * - Factor socket_is_still_usable() out of get_reusable_connection().
+ * - If poll() isn't available, show a warning and assume the socket
+ * is still usable.
+ *
+ * Revision 1.30 2008/10/13 17:31:03 fabiankeil
+ * If a remembered connection is no longer usable and
+ * has been marked closed, don't bother checking if the
+ * destination matches.
+ *
* Revision 1.29 2008/10/11 16:59:41 fabiankeil
* Add missing dots for two log messages.
*
#include "gateway.h"
#include "miscutil.h"
#ifdef FEATURE_CONNECTION_KEEP_ALIVE
-#ifdef __GLIBC__
+#ifdef HAVE_POLL
+#ifdef __GLIBC__
#include <sys/poll.h>
-#endif /* __GLIBC__ */
+#else
#include <poll.h>
+#endif /* def __GLIBC__ */
+#endif /* HAVE_POLL */
#endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
const char gateway_h_rcs[] = GATEWAY_H_VERSION;
#ifdef FEATURE_CONNECTION_KEEP_ALIVE
#define MAX_REUSABLE_CONNECTIONS 100
+static int keep_alive_timeout = DEFAULT_KEEP_ALIVE_TIMEOUT;
struct reusable_connection
{
int in_use;
char *host;
int port;
+ time_t timestamp;
int forwarder_type;
char *gateway_host;
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);
+
/*********************************************************************
*
unsigned int slot = 0;
log_error(LOG_LEVEL_INFO,
- "Support for 'Connection: keep-alive' is experimental, "
- "incomplete and known not to work properly in some situations.");
+ "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 */
+ );
for (slot = 0; slot < SZ(reusable_connection); slot++)
{
reusable_connection[slot].sfd = sfd;
reusable_connection[slot].port = http->port;
reusable_connection[slot].in_use = 0;
+ reusable_connection[slot].timestamp = time(NULL);
assert(NULL != fwd);
assert(reusable_connection[slot].gateway_host == NULL);
closed_connection->sfd = JB_INVALID_SOCKET;
freez(closed_connection->host);
closed_connection->port = 0;
+ closed_connection->timestamp = 0;
closed_connection->forwarder_type = SOCKS_NONE;
freez(closed_connection->gateway_host);
closed_connection->gateway_port = 0;
if (reusable_connection[slot].sfd == sfd)
{
assert(reusable_connection[slot].in_use);
- break;
- }
- }
- if (reusable_connection[slot].sfd != sfd)
- {
- log_error(LOG_LEVEL_CONNECT,
- "Socket %d already forgotten or never remembered.", sfd);
- privoxy_mutex_unlock(&connection_reuse_mutex);
- return;
+ log_error(LOG_LEVEL_CONNECT,
+ "Forgetting socket %d for %s:%d in slot %d.",
+ sfd, reusable_connection[slot].host,
+ reusable_connection[slot].port, slot);
+ mark_connection_closed(&reusable_connection[slot]);
+ privoxy_mutex_unlock(&connection_reuse_mutex);
+
+ return;
+ }
}
log_error(LOG_LEVEL_CONNECT,
- "Forgetting socket %d for %s:%d in slot %d.",
- sfd, reusable_connection[slot].host, reusable_connection[slot].port, slot);
-
- mark_connection_closed(&reusable_connection[slot]);
+ "Socket %d already forgotten or never remembered.", sfd);
privoxy_mutex_unlock(&connection_reuse_mutex);
}
* 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 :
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->forward_port != fwd->forward_port)
- {
- log_error(LOG_LEVEL_CONNECT, "Server port mismatch: %d %d (%s)",
- connection->forward_port, fwd->forward_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)
}
+
+/*********************************************************************
+ *
+ * Function : close_unusable_connections
+ *
+ * Description : Closes remembered connections that have timed
+ * out or have been closed on the other side.
+ *
+ * Parameters : none
+ *
+ * Returns : Number of connections that are still alive.
+ *
+ *********************************************************************/
+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++)
+ {
+ if (!reusable_connection[slot].in_use
+ && (JB_INVALID_SOCKET != reusable_connection[slot].sfd))
+ {
+ time_t time_open = time(NULL) - reusable_connection[slot].timestamp;
+
+ if (keep_alive_timeout < time_open)
+ {
+ log_error(LOG_LEVEL_CONNECT,
+ "The connection to %s:%d in slot %d timed out. "
+ "Closing socket %d. Timeout is: %d.",
+ reusable_connection[slot].host,
+ reusable_connection[slot].port, slot,
+ reusable_connection[slot].sfd, keep_alive_timeout);
+ close_socket(reusable_connection[slot].sfd);
+ mark_connection_closed(&reusable_connection[slot]);
+ }
+ 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. "
+ "Closing socket %d.", reusable_connection[slot].host,
+ reusable_connection[slot].port, slot,
+ reusable_connection[slot].sfd);
+ close_socket(reusable_connection[slot].sfd);
+ mark_connection_closed(&reusable_connection[slot]);
+ }
+ else
+ {
+ connections_alive++;
+ }
+ }
+ }
+
+ privoxy_mutex_unlock(&connection_reuse_mutex);
+
+ return 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");
+ }
+
+ /*
+ * XXX: I'm not sure why !FD_ISSET() works,
+ * but apparently it does.
+ */
+ socket_is_alive = !FD_ISSET(sfd, &readable_fds);
+
+ return socket_is_alive;
+#endif /* def HAVE_POLL */
+}
+
+
/*********************************************************************
*
* Function : get_reusable_connection
jb_socket sfd = JB_INVALID_SOCKET;
unsigned int slot = 0;
+ close_unusable_connections();
+
privoxy_mutex_lock(&connection_reuse_mutex);
for (slot = 0; slot < SZ(reusable_connection); slot++)
if (!reusable_connection[slot].in_use
&& (JB_INVALID_SOCKET != reusable_connection[slot].sfd))
{
- int poll_result;
- struct pollfd poll_fd[1];
- memset(poll_fd, 0, sizeof(poll_fd));
- poll_fd[0].fd = reusable_connection[slot].sfd;
- poll_fd[0].events = POLLIN;
-
- poll_result = poll(poll_fd, 1, 0);
-
- if (-1 != poll_result)
- {
- if ((poll_fd[0].revents & POLLIN))
- {
- log_error(LOG_LEVEL_CONNECT,
- "Socket %d for %s:%d in slot %d is no longer usable. Closing.",
- reusable_connection[slot].sfd, reusable_connection[slot].host,
- reusable_connection[slot].port, slot);
- mark_connection_closed(&reusable_connection[slot]);
- continue;
- }
- }
- else
- {
- log_error(LOG_LEVEL_CONNECT,
- "Failed to poll socket %d for %s:%d in slot %d.",
- reusable_connection[slot].sfd, reusable_connection[slot].host,
- reusable_connection[slot].port, slot);
- }
-
if (connection_destination_matches(&reusable_connection[slot], http, fwd))
{
reusable_connection[slot].in_use = TRUE;
static int mark_connection_unused(jb_socket sfd)
{
unsigned int slot = 0;
- unsigned int socket_found = FALSE;
+ int socket_found = FALSE;
assert(sfd != JB_INVALID_SOCKET);
if (reusable_connection[slot].sfd == sfd)
{
assert(reusable_connection[slot].in_use);
+ socket_found = TRUE;
+ log_error(LOG_LEVEL_CONNECT,
+ "Marking open socket %d for %s:%d in slot %d as unused.",
+ sfd, reusable_connection[slot].host,
+ reusable_connection[slot].port, slot);
+ reusable_connection[slot].in_use = 0;
+ reusable_connection[slot].timestamp = time(NULL);
break;
}
}
- if (reusable_connection[slot].sfd == sfd)
- {
- socket_found = TRUE;
- log_error(LOG_LEVEL_CONNECT,
- "Marking open socket %d for %s:%d in slot %d as unused.",
- sfd, reusable_connection[slot].host, reusable_connection[slot].port, slot);
- reusable_connection[slot].in_use = 0;
- }
-
privoxy_mutex_unlock(&connection_reuse_mutex);
return socket_found;
}
+
+
+/*********************************************************************
+ *
+ * Function : set_keep_alive_timeout
+ *
+ * Description : Sets the timeout after which open
+ * connections will no longer be reused.
+ *
+ * Parameters :
+ * 1 : timeout = The timeout in seconds.
+ *
+ * Returns : void
+ *
+ *********************************************************************/
+void set_keep_alive_timeout(int timeout)
+{
+ keep_alive_timeout = timeout;
+}
#endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
#ifdef FEATURE_CONNECTION_KEEP_ALIVE
sfd = get_reusable_connection(http, fwd);
- if (JB_INVALID_SOCKET == sfd)
- {
- log_error(LOG_LEVEL_CONNECT,
- "No reusable socket for %s:%d found. Opening a new one.",
- http->host, http->port);
- }
- else
+ if (JB_INVALID_SOCKET != sfd)
{
return sfd;
}
"SOCKS4 impossible internal error - bad SOCKS type.");
}
+ if (JB_INVALID_SOCKET != sfd)
+ {
+ log_error(LOG_LEVEL_CONNECT,
+ "Created new connection to %s:%d on socket %d.",
+ http->host, http->port, sfd);
+ }
+
return sfd;
}
{
case SOCKS_REQUEST_GRANTED:
return(sfd);
- break;
case SOCKS_REQUEST_REJECT:
errstr = "SOCKS request rejected or failed.";
errno = EINVAL;
}
hostlen = strlen(target_host);
- if (hostlen > 255)
+ if (hostlen > (size_t)255)
{
errstr = "target host name is longer than 255 characters";
err = 1;
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);
- cbuf[client_pos++] = (char)((target_port >> 8) & 0xffu);
- cbuf[client_pos++] = (char)((target_port ) & 0xffu);
+ cbuf[client_pos++] = (char)((target_port >> 8) & 0xff);
+ cbuf[client_pos++] = (char)((target_port ) & 0xff);
if (write_socket(sfd, cbuf, client_pos))
{