]> granicus.if.org Git - apache/blobdiff - server/listen.c
switch to APR 1.0 API (which is still in flux)
[apache] / server / listen.c
index b360f265073f62078f4c6eb5adca6affa1f83967..778894e5a9dda03a54a0de8cf1d5e299b2599dfb 100644 (file)
@@ -1,7 +1,7 @@
 /* ====================================================================
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 2000-2001 The Apache Software Foundation.  All rights
+ * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
 #include "mpm.h"
 #include "mpm_common.h"
 
+ap_listen_rec *ap_listeners = NULL;
 
-ap_listen_rec *ap_listeners;
-#if APR_HAVE_IPV6
-static int default_family = APR_UNSPEC;
-#else
-static int default_family = APR_INET;
-#endif
 static ap_listen_rec *old_listeners;
 static int ap_listenbacklog;
 static int send_buffer_size;
@@ -87,25 +82,48 @@ static apr_status_t make_sock(apr_pool_t *p, ap_listen_rec *server)
 {
     apr_socket_t *s = server->sd;
     int one = 1;
+#if APR_HAVE_IPV6
+#ifdef AP_ENABLE_V4_MAPPED
+    int v6only_setting = 0;
+#else
+    int v6only_setting = 1;
+#endif
+#endif
     apr_status_t stat;
 
-    stat = apr_setsocketopt(s, APR_SO_REUSEADDR, one);
+#ifndef WIN32
+    stat = apr_socket_opt_set(s, APR_SO_REUSEADDR, one);
     if (stat != APR_SUCCESS && stat != APR_ENOTIMPL) {
-       ap_log_perror(APLOG_MARK, APLOG_CRIT, stat, p,
-                   "make_sock: for address %pI, setsockopt: (SO_REUSEADDR)", 
-                     server->bind_addr);
-       apr_socket_close(s);
-       return stat;
+        ap_log_perror(APLOG_MARK, APLOG_CRIT, stat, p,
+                      "make_sock: for address %pI, apr_socket_opt_set: (SO_REUSEADDR)",
+                      server->bind_addr);
+        apr_socket_close(s);
+        return stat;
     }
-    
-    stat = apr_setsocketopt(s, APR_SO_KEEPALIVE, one);
+#endif
+
+    stat = apr_socket_opt_set(s, APR_SO_KEEPALIVE, one);
     if (stat != APR_SUCCESS && stat != APR_ENOTIMPL) {
-       ap_log_perror(APLOG_MARK, APLOG_CRIT, stat, p,
-                   "make_sock: for address %pI, setsockopt: (SO_KEEPALIVE)", 
-                     server->bind_addr);
-       apr_socket_close(s);
-       return stat;
+        ap_log_perror(APLOG_MARK, APLOG_CRIT, stat, p,
+                      "make_sock: for address %pI, apr_socket_opt_set: (SO_KEEPALIVE)",
+                      server->bind_addr);
+        apr_socket_close(s);
+        return stat;
+    }
+
+#if APR_HAVE_IPV6
+    if (server->bind_addr->family == APR_INET6) {
+        stat = apr_socket_opt_set(s, APR_IPV6_V6ONLY, v6only_setting);
+        if (stat != APR_SUCCESS && stat != APR_ENOTIMPL) {
+            ap_log_perror(APLOG_MARK, APLOG_CRIT, stat, p,
+                          "make_sock: for address %pI, apr_socket_opt_set: "
+                          "(IPV6_V6ONLY)",
+                          server->bind_addr);
+            apr_socket_close(s);
+            return stat;
+        }
     }
+#endif
 
     /*
      * To send data over high bandwidth-delay connections at full
@@ -127,174 +145,287 @@ static apr_status_t make_sock(apr_pool_t *p, ap_listen_rec *server)
      * If no size is specified, use the kernel default.
      */
     if (send_buffer_size) {
-       stat = apr_setsocketopt(s, APR_SO_SNDBUF,  send_buffer_size);
+        stat = apr_socket_opt_set(s, APR_SO_SNDBUF,  send_buffer_size);
         if (stat != APR_SUCCESS && stat != APR_ENOTIMPL) {
             ap_log_perror(APLOG_MARK, APLOG_WARNING, stat, p,
-                       "make_sock: failed to set SendBufferSize for "
-                         "address %pI, using default", 
-                         server->bind_addr);
-           /* not a fatal error */
-       }
+                          "make_sock: failed to set SendBufferSize for "
+                          "address %pI, using default",
+                          server->bind_addr);
+            /* not a fatal error */
+        }
     }
 
-#if DISABLE_NAGLE_INHERITED
+#if APR_TCP_NODELAY_INHERITED
     ap_sock_disable_nagle(s);
 #endif
 
-    if ((stat = apr_bind(s, server->bind_addr)) != APR_SUCCESS) {
-       ap_log_perror(APLOG_MARK, APLOG_CRIT, stat, p,
-                     "make_sock: could not bind to address %pI", 
-                     server->bind_addr);
-       apr_socket_close(s);
-       return stat;
+    if ((stat = apr_socket_bind(s, server->bind_addr)) != APR_SUCCESS) {
+        ap_log_perror(APLOG_MARK, APLOG_STARTUP|APLOG_CRIT, stat, p,
+                      "make_sock: could not bind to address %pI",
+                      server->bind_addr);
+        apr_socket_close(s);
+        return stat;
+    }
+
+    if ((stat = apr_socket_listen(s, ap_listenbacklog)) != APR_SUCCESS) {
+        ap_log_perror(APLOG_MARK, APLOG_STARTUP|APLOG_ERR, stat, p,
+                      "make_sock: unable to listen for connections "
+                      "on address %pI",
+                      server->bind_addr);
+        apr_socket_close(s);
+        return stat;
     }
 
-    if ((stat = apr_listen(s, ap_listenbacklog)) != APR_SUCCESS) {
-       ap_log_perror(APLOG_MARK, APLOG_ERR, stat, p,
-           "make_sock: unable to listen for connections on address %pI", 
+#ifdef WIN32
+    /* I seriously doubt that this would work on Unix; I have doubts that
+     * it entirely solves the problem on Win32.  However, since setting
+     * reuseaddr on the listener -prior- to binding the socket has allowed
+     * us to attach to the same port as an already running instance of
+     * Apache, or even another web server, we cannot identify that this
+     * port was exclusively granted to this instance of Apache.
+     *
+     * So set reuseaddr, but do not attempt to do so until we have the
+     * parent listeners successfully bound.
+     */
+    stat = apr_socket_opt_set(s, APR_SO_REUSEADDR, one);
+    if (stat != APR_SUCCESS && stat != APR_ENOTIMPL) {
+        ap_log_perror(APLOG_MARK, APLOG_CRIT, stat, p,
+                    "make_sock: for address %pI, apr_socket_opt_set: (SO_REUSEADDR)", 
                      server->bind_addr);
-       apr_socket_close(s);
-       return stat;
+        apr_socket_close(s);
+        return stat;
     }
+#endif
+
+#if APR_HAS_SO_ACCEPTFILTER
+#ifndef ACCEPT_FILTER_NAME
+#define ACCEPT_FILTER_NAME "dataready"
+#endif
+    apr_socket_accept_filter(s, ACCEPT_FILTER_NAME, "");
+#endif
 
     server->sd = s;
     server->active = 1;
+
+#ifdef MPM_ACCEPT_FUNC
+    server->accept_func = MPM_ACCEPT_FUNC;
+#else
+    server->accept_func = NULL;
+#endif
+
     return APR_SUCCESS;
 }
 
-
 static apr_status_t close_listeners_on_exec(void *v)
 {
     ap_listen_rec *lr;
 
     for (lr = ap_listeners; lr; lr = lr->next) {
-       apr_socket_close(lr->sd);
-       lr->active = 0;
+        apr_socket_close(lr->sd);
+        lr->active = 0;
     }
+
     return APR_SUCCESS;
 }
 
 
-static void find_default_family(apr_pool_t *p)
+static const char *alloc_listener(process_rec *process, char *addr, apr_port_t port)
 {
-#if APR_HAVE_IPV6
-    /* We know the platform supports IPv6, but this particular
-     * system may not have IPv6 enabled.  See if we can get an
-     * AF_INET6 socket.
-     */
-    if (default_family == APR_UNSPEC) {
-        apr_socket_t *tmp_sock;
+    ap_listen_rec **walk, *last;
+    apr_status_t status;
+    apr_sockaddr_t *sa;
+    int found_listener = 0;
 
-        if (apr_socket_create(&tmp_sock, APR_INET6, SOCK_STREAM, 
-                              p) == APR_SUCCESS) {
-            apr_socket_close(tmp_sock);
-            default_family = APR_INET6;
-        }
-        else {
-            default_family = APR_INET;
+    /* see if we've got an old listener for this address:port */
+    for (walk = &old_listeners; *walk;) {
+        sa = (*walk)->bind_addr;
+        /* Some listeners are not real so they will not have a bind_addr. */
+        if (sa) {
+            ap_listen_rec *new;
+            apr_port_t oldport;
+
+            apr_sockaddr_port_get(&oldport, sa);
+            /* If both ports are equivalent, then if their names are equivalent,
+             * then we will re-use the existing record.
+             */
+            if (port == oldport &&
+                ((!addr && !sa->hostname) ||
+                 ((addr && sa->hostname) && !strcmp(sa->hostname, addr)))) {
+                new = *walk;
+                *walk = new->next;
+                new->next = ap_listeners;
+                ap_listeners = new;
+                found_listener = 1;
+                continue;
+            }
         }
+
+        walk = &(*walk)->next;
     }
-#endif
-}
 
+    if (found_listener) {
+        return NULL;
+    }
 
-static void alloc_listener(process_rec *process, char *addr, apr_port_t port)
-{
-    ap_listen_rec **walk;
-    ap_listen_rec *new;
-    apr_status_t status;
-    char *oldaddr;
-    apr_port_t oldport;
-    apr_sockaddr_t *sa;
+    if ((status = apr_sockaddr_info_get(&sa, addr, APR_UNSPEC, port, 0,
+                                        process->pool))
+        != APR_SUCCESS) {
+        ap_log_perror(APLOG_MARK, APLOG_CRIT, status, process->pool,
+                      "alloc_listener: failed to set up sockaddr for %s",
+                      addr);
+        return "Listen setup failed";
+    }
+
+    /* Initialize to our last configured ap_listener. */
+    last = ap_listeners;
+    while (last && last->next) {
+        last = last->next;
+    }
+
+    while (sa) {
+        ap_listen_rec *new;
+
+        /* this has to survive restarts */
+        new = apr_palloc(process->pool, sizeof(ap_listen_rec));
+        new->active = 0;
+        new->next = 0;
+        new->bind_addr = sa;
+
+        /* Go to the next sockaddr. */
+        sa = sa->next;
+
+        status = apr_socket_create(&new->sd, new->bind_addr->family,
+                                    SOCK_STREAM, 0, process->pool);
 
-    if (!addr) { /* don't bind to specific interface */
-        find_default_family(process->pool);
-        switch(default_family) {
-        case APR_INET:
-            addr = "0.0.0.0";
-            break;
 #if APR_HAVE_IPV6
-        case APR_INET6:
-            addr = "::";
-            break;
+        /* What could happen is that we got an IPv6 address, but this system
+         * doesn't actually support IPv6.  Try the next address.
+         */
+        if (status != APR_SUCCESS && !addr &&
+            new->bind_addr->family == APR_INET6) {
+            continue;
+        }
 #endif
-        default:
-            ap_assert(1 != 1); /* should not occur */
+        if (status != APR_SUCCESS) {
+            ap_log_perror(APLOG_MARK, APLOG_CRIT, status, process->pool,
+                          "alloc_listener: failed to get a socket for %s",
+                          addr);
+            return "Listen setup failed";
         }
-    }
 
-    /* see if we've got an old listener for this address:port */
-    for (walk = &old_listeners; *walk; walk = &(*walk)->next) {
-        sa = (*walk)->bind_addr;
-        apr_sockaddr_port_get(&oldport, sa);
-       apr_sockaddr_ip_get(&oldaddr, sa);
-       if (!strcmp(oldaddr, addr) && port == oldport) {
-           /* re-use existing record */
-           new = *walk;
-           *walk = new->next;
-           new->next = ap_listeners;
-           ap_listeners = new;
-           return;
-       }
+        /* We need to preserve the order returned by getaddrinfo() */
+        if (last == NULL) {
+            ap_listeners = last = new;
+        } else {
+            last->next = new;
+            last = new;
+        }
     }
 
-    /* this has to survive restarts */
-    new = apr_palloc(process->pool, sizeof(ap_listen_rec));
-    new->active = 0;
-    if ((status = apr_sockaddr_info_get(&new->bind_addr, addr, APR_UNSPEC, port, 0, 
-                                  process->pool)) != APR_SUCCESS) {
-        ap_log_perror(APLOG_MARK, APLOG_CRIT, status, process->pool,
-                     "alloc_listener: failed to set up sockaddr for %s", addr);
-        return;
-    }
-    if ((status = apr_socket_create(&new->sd, new->bind_addr->sa.sin.sin_family, 
-                                    SOCK_STREAM, process->pool)) != APR_SUCCESS) {
-        ap_log_perror(APLOG_MARK, APLOG_CRIT, status, process->pool,
-                     "alloc_listener: failed to get a socket for %s", addr);
-        return;
-    }
-    new->next = ap_listeners;
-    ap_listeners = new;
+    return NULL;
 }
 
-#if !defined(SPMT_OS2_MPM)
-static
-#endif
-int ap_listen_open(process_rec *process, apr_port_t port)
+static int ap_listen_open(apr_pool_t *pool, apr_port_t port)
 {
-    apr_pool_t *pconf = process->pconf;
     ap_listen_rec *lr;
     ap_listen_rec *next;
+    ap_listen_rec *previous;
     int num_open;
+    const char *userdata_key = "ap_listen_open";
+    void *data;
 
-    /* allocate a default listener if necessary */
-    if (ap_listeners == NULL) {
-       alloc_listener(process, NULL, port ? port : DEFAULT_HTTP_PORT);
-    }
-
+    /* Don't allocate a default listener.  If we need to listen to a
+     * port, then the user needs to have a Listen directive in their
+     * config file.
+     */
     num_open = 0;
-    for (lr = ap_listeners; lr; lr = lr->next) {
-       if (lr->active) {
-           ++num_open;
-       }
-       else {
-           if (make_sock(pconf, lr) == APR_SUCCESS) {
-               ++num_open;
-               lr->active = 1;
-           }
-       }
+    previous = NULL;
+    for (lr = ap_listeners; lr; previous = lr, lr = lr->next) {
+        if (lr->active) {
+            ++num_open;
+        }
+        else {
+#if APR_HAVE_IPV6
+            int v6only_setting;
+            /* If we are trying to bind to 0.0.0.0 and the previous listener
+             * was :: on the same port and in turn that socket does not have
+             * the IPV6_V6ONLY flag set; we must skip the current attempt to
+             * listen (which would generate an error). IPv4 will be handled
+             * on the established IPv6 socket.
+             */
+            if (previous != NULL &&
+                lr->bind_addr->family == APR_INET &&
+                lr->bind_addr->sa.sin.sin_addr.s_addr == INADDR_ANY &&
+                lr->bind_addr->port == previous->bind_addr->port &&
+                previous->bind_addr->family == APR_INET6 &&
+                IN6_IS_ADDR_UNSPECIFIED(
+                    &previous->bind_addr->sa.sin6.sin6_addr) &&
+                apr_socket_opt_get(previous->sd, APR_IPV6_V6ONLY,
+                                   &v6only_setting) == APR_SUCCESS &&
+                v6only_setting == 0) {
+
+                /* Remove the current listener from the list */
+                previous->next = lr->next;
+                continue;
+            }
+#endif
+            if (make_sock(pool, lr) == APR_SUCCESS) {
+                ++num_open;
+                lr->active = 1;
+            }
+            else {
+#if APR_HAVE_IPV6
+                /* If we tried to bind to ::, and the next listener is
+                 * on 0.0.0.0 with the same port, don't give a fatal
+                 * error. The user will still get a warning from make_sock
+                 * though.
+                 */
+                if (lr->next != NULL && lr->bind_addr->family == APR_INET6 &&
+                    IN6_IS_ADDR_UNSPECIFIED(
+                        &lr->bind_addr->sa.sin6.sin6_addr) &&
+                    lr->bind_addr->port == lr->next->bind_addr->port &&
+                    lr->next->bind_addr->family == APR_INET && 
+                    lr->next->bind_addr->sa.sin.sin_addr.s_addr == INADDR_ANY) {
+
+                    /* Remove the current listener from the list */
+                    if (previous) {
+                        previous->next = lr->next;
+                    }
+                    else {
+                        ap_listeners = lr->next;
+                    }
+
+                    /* So that previous becomes NULL in the next iteration */
+                    lr = NULL;
+
+                    continue;
+                }
+#endif
+                /* fatal error */
+                return -1;
+            }
+        }
     }
 
     /* close the old listeners */
     for (lr = old_listeners; lr; lr = next) {
-       apr_socket_close(lr->sd);
-       lr->active = 0;
-       next = lr->next;
-/*     free(lr);*/
+        apr_socket_close(lr->sd);
+        lr->active = 0;
+        next = lr->next;
     }
     old_listeners = NULL;
 
-    apr_pool_cleanup_register(pconf, NULL, apr_pool_cleanup_null, close_listeners_on_exec);
+    /* we come through here on both passes of the open logs phase
+     * only register the cleanup once... otherwise we try to close
+     * listening sockets twice when cleaning up prior to exec
+     */
+    apr_pool_userdata_get(&data, userdata_key, pool);
+    if (!data) {
+        apr_pool_userdata_set((const void *)1, userdata_key,
+                              apr_pool_cleanup_null, pool);
+        apr_pool_cleanup_register(pool, NULL, apr_pool_cleanup_null,
+                                  close_listeners_on_exec);
+    }
 
     return num_open ? 0 : -1;
 }
@@ -303,12 +434,15 @@ int ap_setup_listeners(server_rec *s)
 {
     ap_listen_rec *lr;
     int num_listeners = 0;
-    if (ap_listen_open(s->process, s->port)) {
+
+    if (ap_listen_open(s->process->pool, s->port)) {
        return 0;
     }
+
     for (lr = ap_listeners; lr; lr = lr->next) {
         num_listeners++;
     }
+
     return num_listeners;
 }
 
@@ -325,8 +459,8 @@ const char *ap_set_listener(cmd_parms *cmd, void *dummy, const char *ips)
     char *host, *scope_id;
     apr_port_t port;
     apr_status_t rv;
-
     const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
+
     if (err != NULL) {
         return err;
     }
@@ -335,27 +469,28 @@ const char *ap_set_listener(cmd_parms *cmd, void *dummy, const char *ips)
     if (rv != APR_SUCCESS) {
         return "Invalid address or port";
     }
+
     if (host && !strcmp(host, "*")) {
         host = NULL;
     }
+
     if (scope_id) {
         /* XXX scope id support is useful with link-local IPv6 addresses */
         return "Scope id is not supported";
     }
+
     if (!port) {
         return "Port must be specified";
     }
 
-    alloc_listener(cmd->server->process, host, port);
-
-    return NULL;
+    return alloc_listener(cmd->server->process, host, port);
 }
 
-const char *ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg) 
+const char *ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg)
 {
     int b;
-
     const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
+
     if (err != NULL) {
         return err;
     }
@@ -364,14 +499,17 @@ const char *ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg)
     if (b < 1) {
         return "ListenBacklog must be > 0";
     }
+
     ap_listenbacklog = b;
     return NULL;
 }
 
-const char *ap_set_send_buffer_size(cmd_parms *cmd, void *dummy, const char *arg)
+const char *ap_set_send_buffer_size(cmd_parms *cmd, void *dummy,
+                                    const char *arg)
 {
     int s = atoi(arg);
     const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
+
     if (err != NULL) {
         return err;
     }
@@ -379,6 +517,7 @@ const char *ap_set_send_buffer_size(cmd_parms *cmd, void *dummy, const char *arg
     if (s < 512 && s != 0) {
         return "SendBufferSize must be >= 512 bytes, or 0 for system default.";
     }
+
     send_buffer_size = s;
     return NULL;
 }