granicus.if.org Git - apache/blob - include/ap_listen.h

   1 /* Licensed to the Apache Software Foundation (ASF) under one or more
   2  * contributor license agreements.  See the NOTICE file distributed with
   3  * this work for additional information regarding copyright ownership.
   4  * The ASF licenses this file to You under the Apache License, Version 2.0
   5  * (the "License"); you may not use this file except in compliance with
   6  * the License.  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 /**
  18  * @file  ap_listen.h
  19  * @brief Apache Listeners Library
  20  *
  21  * @defgroup APACHE_CORE_LISTEN Apache Listeners Library
  22  * @ingroup  APACHE_CORE
  23  * @{
  24  */
  25
  26 #ifndef AP_LISTEN_H
  27 #define AP_LISTEN_H
  28
  29 #include "apr_network_io.h"
  30 #include "httpd.h"
  31 #include "http_config.h"
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 typedef struct ap_slave_t ap_slave_t;
  38 typedef struct ap_listen_rec ap_listen_rec;
  39 typedef apr_status_t (*accept_function)(void **csd, ap_listen_rec *lr, apr_pool_t *ptrans);
  40
  41 /**
  42  * @brief Apache's listeners record.
  43  *
  44  * These are used in the Multi-Processing Modules
  45  * to setup all of the sockets for the MPM to listen to and accept on.
  46  */
  47 struct ap_listen_rec {
  48     /**
  49      * The next listener in the list
  50      */
  51     ap_listen_rec *next;
  52     /**
  53      * The actual socket
  54      */
  55     apr_socket_t *sd;
  56     /**
  57      * The sockaddr the socket should bind to
  58      */
  59     apr_sockaddr_t *bind_addr;
  60     /**
  61      * The accept function for this socket
  62      */
  63     accept_function accept_func;
  64     /**
  65      * Is this socket currently active
  66      */
  67     int active;
  68     /**
  69      * The default protocol for this listening socket.
  70      */
  71     const char* protocol;
  72
  73     ap_slave_t *slave;
  74 };
  75
  76 /**
  77  * The global list of ap_listen_rec structures
  78  */
  79 AP_DECLARE_DATA extern ap_listen_rec *ap_listeners;
  80 AP_DECLARE_DATA extern int ap_num_listen_buckets;
  81 AP_DECLARE_DATA extern int ap_have_so_reuseport;
  82
  83 /**
  84  * Setup all of the defaults for the listener list
  85  */
  86 AP_DECLARE(void) ap_listen_pre_config(void);
  87
  88 /**
  89  * Loop through the global ap_listen_rec list and create all of the required
  90  * sockets.  This executes the listen and bind on the sockets.
  91  * @param s The global server_rec
  92  * @return The number of open sockets.
  93  */
  94 AP_DECLARE(int) ap_setup_listeners(server_rec *s);
  95
  96 /**
  97  * This function duplicates ap_listeners into multiple buckets when configured
  98  * to (see ListenCoresBucketsRatio) and the platform supports it (eg. number of
  99  * online CPU cores and SO_REUSEPORT available).
 100  * @param p The config pool
 101  * @param s The global server_rec
 102  * @param buckets The array of listeners buckets.
 103  * @param num_buckets The total number of listeners buckets (array size).
 104  * @remark If the given *num_buckets is 0 (input), it will be computed
 105  *         according to the platform capacities, otherwise (positive) it
 106  *         will be preserved. The number of listeners duplicated will
 107  *         always match *num_buckets, be it computed or given.
 108  */
 109 AP_DECLARE(apr_status_t) ap_duplicate_listeners(apr_pool_t *p, server_rec *s,
 110                                                 ap_listen_rec ***buckets,
 111                                                 int *num_buckets);
 112
 113 /**
 114  * Loop through the global ap_listen_rec list and close each of the sockets.
 115  */
 116 AP_DECLARE_NONSTD(void) ap_close_listeners(void);
 117
 118 /**
 119  * Loop through the given ap_listen_rec list and close each of the sockets.
 120  * @param listener The listener to close.
 121  */
 122 AP_DECLARE_NONSTD(void) ap_close_listeners_ex(ap_listen_rec *listeners);
 123
 124 /**
 125  * FIXMEDOC
 126  */
 127 AP_DECLARE_NONSTD(int) ap_close_selected_listeners(ap_slave_t *);
 128
 129 /* Although these functions are exported from libmain, they are not really
 130  * public functions.  These functions are actually called while parsing the
 131  * config file, when one of the LISTEN_COMMANDS directives is read.  These
 132  * should not ever be called by external modules.  ALL MPMs should include
 133  * LISTEN_COMMANDS in their command_rec table so that these functions are
 134  * called.
 135  */
 136 AP_DECLARE_NONSTD(const char *) ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg);
 137 AP_DECLARE_NONSTD(const char *) ap_set_listencbratio(cmd_parms *cmd, void *dummy, const char *arg);
 138 AP_DECLARE_NONSTD(const char *) ap_set_listener(cmd_parms *cmd, void *dummy,
 139                                                 int argc, char *const argv[]);
 140 AP_DECLARE_NONSTD(const char *) ap_set_send_buffer_size(cmd_parms *cmd, void *dummy,
 141                                                         const char *arg);
 142 AP_DECLARE_NONSTD(const char *) ap_set_receive_buffer_size(cmd_parms *cmd,
 143                                                            void *dummy,
 144                                                            const char *arg);
 145
 146 #define LISTEN_COMMANDS \
 147 AP_INIT_TAKE1("ListenBacklog", ap_set_listenbacklog, NULL, RSRC_CONF, \
 148   "Maximum length of the queue of pending connections, as used by listen(2)"), \
 149 AP_INIT_TAKE1("ListenCoresBucketsRatio", ap_set_listencbratio, NULL, RSRC_CONF, \
 150   "Ratio between the number of CPU cores (online) and the number of listeners buckets"), \
 151 AP_INIT_TAKE_ARGV("Listen", ap_set_listener, NULL, RSRC_CONF, \
 152   "A port number or a numeric IP address and a port number, and an optional protocol"), \
 153 AP_INIT_TAKE1("SendBufferSize", ap_set_send_buffer_size, NULL, RSRC_CONF, \
 154   "Send buffer size in bytes"), \
 155 AP_INIT_TAKE1("ReceiveBufferSize", ap_set_receive_buffer_size, NULL, \
 156               RSRC_CONF, "Receive buffer size in bytes")
 157
 158 #ifdef __cplusplus
 159 }
 160 #endif
 161
 162 #endif
 163 /** @} */