source3/lib/server_prefork.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Common server globals
   4
   5    Copyright (C) Simo Sorce <idra@samba.org> 2011
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "system/network.h"
  22 #include <tevent.h>
  23
  24 struct prefork_pool;
  25
  26 enum pf_worker_status {
  27         PF_WORKER_NONE = 0,
  28         PF_WORKER_IDLE,
  29         PF_WORKER_ACCEPTING,
  30         PF_WORKER_BUSY,
  31         PF_WORKER_EXITING
  32 };
  33
  34 enum pf_server_cmds {
  35         PF_SRV_MSG_NONE = 0,
  36         PF_SRV_MSG_EXIT
  37 };
  38
  39 /**
  40 * @brief This structure is shared betwee the controlling parent and the
  41 *        the child. The parent can only write to the 'cmds' and
  42 *        'allowed_clients' variables, while a child is running.
  43 *        The child can change 'status', and 'num_clients'.
  44 *        All other variables are initialized by the parent before forking the
  45 *        child.
  46 */
  47 struct pf_worker_data {
  48         pid_t pid;
  49         enum pf_worker_status status;
  50         time_t started;
  51         time_t last_used;
  52         int num_clients;
  53
  54         enum pf_server_cmds cmds;
  55         int allowed_clients;
  56 };
  57
  58 /**
  59 * @brief This is the 'main' function called by a child right after the fork.
  60 *        It is daemon specific and should initialize and perform whatever
  61 *        operation the child is meant to do. Returning from this function will
  62 *        cause the termination of the child.
  63 *
  64 * @param ev             The event context
  65 * @param msg_ctx        The messaging context
  66 * @param pf             The mmaped area used to communicate with parent
  67 * @param listen_fd_size The number of file descriptors to monitor
  68 * @param listen_fds     The array of file descriptors
  69 * @param lock_fd        The locking file descriptor
  70 * @param private_data   Private data that needs to be passed to the main
  71 *                       function from the calling parent.
  72 *
  73 * @return Returns the exit status to be reported to the parent via exit()
  74 */
  75 typedef int (prefork_main_fn_t)(struct tevent_context *ev,
  76                                 struct messaging_context *msg_ctx,
  77                                 struct pf_worker_data *pf,
  78                                 int listen_fd_size,
  79                                 int *listen_fds,
  80                                 int lock_fd,
  81                                 void *private_data);
  82
  83 /**
  84 * @brief Callback function for parents that also want to be called on sigchld
  85 *
  86 * @param ev_ctx         The event context
  87 * @param pool           The pool handler
  88 * @param private_data   Data private to the parent
  89 */
  90 typedef void (prefork_sigchld_fn_t)(struct tevent_context *ev_ctx,
  91                                     struct prefork_pool *pool,
  92                                     void *private_data);
  93
  94 /* ==== Functions used by controlling process ==== */
  95
  96 /**
  97 * @brief Creates the first pool of preforked processes
  98 *
  99 * @param mem_ctx        The memory context used to hold the pool structure
 100 * @param ev_ctx         The event context
 101 * @param msg_ctx        The messaging context
 102 * @param listen_fd_size The number of file descriptors to monitor
 103 * @param listen_fds     The array of file descriptors to monitor
 104 * @param min_children   Minimum number of children that must be available at
 105 *                       any given time
 106 * @param max_children   Maximum number of children that can be started. Also
 107 *                       determines the initial size of the pool.
 108 * @param main_fn        The children 'main' function to be called after fork
 109 * @param private_data   The children private data.
 110 * @param pf_pool        The allocated pool.
 111 *
 112 * @return True if it was successful, False otherwise.
 113 */
 114 bool prefork_create_pool(TALLOC_CTX *mem_ctx,
 115                          struct tevent_context *ev_ctx,
 116                          struct messaging_context *msg_ctx,
 117                          int listen_fd_size, int *listen_fds,
 118                          int min_children, int max_children,
 119                          prefork_main_fn_t *main_fn, void *private_data,
 120                          struct prefork_pool **pf_pool);
 121 /**
 122 * @brief Function used to attemp to expand the size of children.
 123 *
 124 * @param pfp            The pool structure.
 125 * @param new_max        The new max number of children.
 126 *
 127 * @return 0 if operation was successful
 128 *         ENOSPC if the mmap area could not be grown to the requested size
 129 *         EINVAL if the new max is invalid.
 130 *
 131 * NOTE: this funciton can easily fail if the mmap area cannot be enlarged.
 132 *       A well behaving parent MUST NOT error out if this happen.
 133 */
 134 int prefork_expand_pool(struct prefork_pool *pfp, int new_max);
 135
 136 /**
 137 * @brief Used to prefork a number of new children
 138 *
 139 * @param ev_ctx         The event context
 140 * @param msg_ctx        The messaging context
 141 * @param pfp            The pool structure
 142 * @param num_children   The number of children to be started
 143 *
 144 * @return The number of new children effectively forked.
 145 *
 146 * NOTE: This method does not expand the pool, if the max number of children
 147 *       has already been forked it will do nothing.
 148 */
 149 int prefork_add_children(struct tevent_context *ev_ctx,
 150                          struct messaging_context *msg_ctx,
 151                          struct prefork_pool *pfp,
 152                          int num_children);
 153 /**
 154 * @brief Commands a number fo children to stop and exit
 155 *
 156 * @param pfp            The pool.
 157 * @param num_children   The number of children we need to retire.
 158 * @param age_limit      The minimum age a child has been active to be
 159 *                       considered for retirement. (Compared against the
 160 *                       'started' value in the pf_worker_data structure of the
 161 *                       children.
 162 *
 163 * @return Number of children that were signaled to stop
 164 *
 165 * NOTE: Only children that has no attached clients can be stopped.
 166 *       If all the available children are too young or are busy than it
 167 *       is possible that none will be asked to stop.
 168 */
 169 int prefork_retire_children(struct prefork_pool *pfp,
 170                             int num_children, time_t age_limit);
 171 /**
 172 * @brief Count the number of active children
 173 *
 174 * @param pfp    The pool.
 175 * @param total  Returns the number of children currently alive
 176 *
 177 * @return The number of children actually serving clients
 178 */
 179 int prefork_count_active_children(struct prefork_pool *pfp, int *total);
 180
 181 /**
 182 * @brief Inform all children that they are allowed to accept 'max' clients
 183 *        now. Use this when all children are already busy and more clients
 184 *        are trying to connect. It will allow each child to handle more than
 185 *        one client at a time, up to 'max'.
 186 *
 187 * @param pfp    The pool.
 188 * @param max    Max number of clients per child.
 189 */
 190 void prefork_increase_allowed_clients(struct prefork_pool *pfp, int max);
 191
 192 /**
 193 * @brief Reset the maximum allowd clients per child to 1.
 194 *        Does not reduce the number of clients actually beeing served by
 195 *        any given child, but prevents children from overcommitting from
 196 *        now on.
 197 *
 198 * @param pfp    The pool.
 199 */
 200 void prefork_reset_allowed_clients(struct prefork_pool *pfp);
 201
 202 /**
 203 * @brief Send a specific signal to all children.
 204 *        Used to send SIGHUP when a reload of the configuration is needed
 205 *        for example.
 206 *
 207 * @param pfp            The pool.
 208 * @param signal_num     The signal number to be sent.
 209 */
 210 void prefork_send_signal_to_all(struct prefork_pool *pfp, int signal_num);
 211
 212 /**
 213 * @brief Sets the SIGCHLD callback
 214 *
 215 * @param pfp            The pool handler.
 216 * @param sigchld_fn     The callback function (pass NULL to unset).
 217 * @param private_data   Private data for the callback function.
 218 */
 219 void prefork_set_sigchld_callback(struct prefork_pool *pfp,
 220                                   prefork_sigchld_fn_t *sigchld_fn,
 221                                   void *private_data);
 222
 223 /* ==== Functions used by children ==== */
 224
 225 /**
 226 * @brief Try to listen and accept on one of the listening sockets.
 227 *        Asynchronusly tries to grab the lock and perform an accept.
 228 *        Will automatically updated the 'status' of the child and handle
 229 *        all the locking/unlocking/timingout as necessary.
 230 *        Changes behavior depending on whether the child already has other
 231 *        client connections. If not it blocks on the lock call for periods of
 232 *        time. Otherwise it loops on the lock using a timer in order to allow
 233 *        processing of the other clients requests.
 234 *
 235 * @param mem_ctx        The memory context on whic to allocate the request
 236 * @param ev             The event context
 237 * @param pf             The child/parent shared structure
 238 * @param listen_fd_size The number of listening file descriptors
 239 * @param listen_fds     The array of listening file descriptors
 240 * @param lock_fd        The locking file descriptor
 241 * @param addr           The structure that will hold the client address on
 242 *                       return
 243 * @param addrlen        The structure length on return.
 244 *
 245 * @return The tevent request pointer or NULL on allocation errors.
 246 */
 247 struct tevent_req *prefork_listen_send(TALLOC_CTX *mem_ctx,
 248                                         struct tevent_context *ev,
 249                                         struct pf_worker_data *pf,
 250                                         int listen_fd_size,
 251                                         int *listen_fds,
 252                                         int lock_fd,
 253                                         struct sockaddr *addr,
 254                                         socklen_t *addrlen);
 255 /**
 256 * @brief Returns the file descriptor after the new client connection has
 257 *        been accepted.
 258 *
 259 * @param req    The request
 260 * @param fd     The new file descriptor.
 261 *
 262 * @return       The error in case the operation failed.
 263 */
 264 int prefork_listen_recv(struct tevent_req *req, int *fd);