1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000 The Apache Software Foundation. All rights
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. The end-user documentation included with the redistribution,
20 * if any, must include the following acknowledgment:
21 * "This product includes software developed by the
22 * Apache Software Foundation (http://www.apache.org/)."
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
26 * 4. The names "Apache" and "Apache Software Foundation" must
27 * not be used to endorse or promote products derived from this
28 * software without prior written permission. For written
29 * permission, please contact apache@apache.org.
31 * 5. Products derived from this software may not be called "Apache",
32 * nor may "Apache" appear in their name, without prior written
33 * permission of the Apache Software Foundation.
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47 * ====================================================================
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation. For more
51 * information on the Apache Software Foundation, please see
52 * <http://www.apache.org/>.
54 * Portions of this software are based upon public domain software
55 * originally written at the National Center for Supercomputing Applications,
56 * University of Illinois, Urbana-Champaign.
61 #include "apr_portable.h"
62 #include "apr_strings.h"
63 #include "apr_file_io.h"
64 #include "apr_thread_proc.h"
65 #include "ap_config.h"
67 #include "http_main.h"
69 #include "http_config.h" /* for read_config */
70 #include "http_core.h" /* for get_remote_host */
71 #include "http_connection.h"
74 #include "mpm_common.h"
75 #include "iol_socket.h"
76 #include "ap_listen.h"
77 #include "scoreboard.h"
79 #ifdef HAVE_NETINET_TCP_H
80 #include <netinet/tcp.h>
82 #ifdef HAVE_SYS_SOCKET_H
83 #include <sys/socket.h>
85 #ifdef HAVE_SYS_WAIT_H
92 * Actual definitions of config globals
95 int ap_threads_per_child=0; /* Worker threads per child */
96 int ap_max_requests_per_child=0;
97 static const char *ap_pid_fname=NULL;
98 API_VAR_EXPORT const char *ap_scoreboard_fname=NULL;
99 static int ap_daemons_to_start=0;
100 static int min_spare_threads=0;
101 static int max_spare_threads=0;
102 static int ap_daemons_limit=0;
103 static time_t ap_restart_time=0;
104 API_VAR_EXPORT int ap_extended_status = 0;
105 static int workers_may_exit = 0;
106 static int requests_this_child;
107 static int num_listensocks = 0;
108 static ap_socket_t **listensocks;
110 /* The structure used to pass unique initialization info to each thread */
115 ap_pool_t *tpool; /* "pthread" would be confusing */
119 * The max child slot ever assigned, preserved across restarts. Necessary
120 * to deal with MaxClients changes across SIGWINCH restarts. We use this
121 * value to optimize routines that have to scan the entire scoreboard.
123 int ap_max_daemons_limit = -1;
125 char ap_coredump_dir[MAX_STRING_LEN];
127 static ap_file_t *pipe_of_death_in = NULL;
128 static ap_file_t *pipe_of_death_out = NULL;
129 static pthread_mutex_t pipe_of_death_mutex;
131 /* *Non*-shared http_main globals... */
133 server_rec *ap_server_conf;
135 /* one_process --- debugging mode variable; can be set from the command line
136 * with the -X flag. If set, this gets you the child_main loop running
137 * in the process which originally started up (no detach, no make_child),
138 * which is a pretty nice debugging environment. (You'll get a SIGHUP
139 * early in standalone_main; just continue through. This is the server
140 * trying to kill off any child processes which it might have lying
141 * around --- Apache doesn't keep track of their pids, it just sends
142 * SIGHUP to the process group, ignoring it in the root process.
143 * Continue through and you'll be fine.).
146 static int one_process = 0;
149 int raise_sigstop_flags;
152 static ap_pool_t *pconf; /* Pool for config stuff */
153 static ap_pool_t *pchild; /* Pool for httpd child stuff */
155 unsigned int ap_my_pid; /* Linux getpid() doesn't work except in main
156 thread. Use this instead */
157 /* Keep track of the number of worker threads currently active */
158 static int worker_thread_count;
159 static pthread_mutex_t worker_thread_count_mutex;
161 /* Locks for accept serialization */
162 static pthread_mutex_t thread_accept_mutex = PTHREAD_MUTEX_INITIALIZER;
163 static ap_lock_t *process_accept_mutex;
164 static const char *lock_fname;
166 #ifdef NO_SERIALIZED_ACCEPT
167 #define SAFE_ACCEPT(stmt) APR_SUCCESS
169 #define SAFE_ACCEPT(stmt) (stmt)
172 API_EXPORT(int) ap_get_max_daemons(void)
174 return ap_max_daemons_limit;
177 /* a clean exit from a child with proper cleanup */
178 static void clean_child_exit(int code) __attribute__ ((noreturn));
179 void clean_child_exit(int code)
182 ap_destroy_pool(pchild);
187 /* handle all varieties of core dumping signals */
188 static void sig_coredump(int sig)
190 chdir(ap_coredump_dir);
191 ap_signal(sig, SIG_DFL);
192 kill(ap_my_pid, sig);
193 /* At this point we've got sig blocked, because we're still inside
194 * the signal handler. When we leave the signal handler it will
195 * be unblocked, and we'll take the signal... and coredump or whatever
196 * is appropriate for this particular Unix. In addition the parent
197 * will see the real signal we received -- whereas if we called
198 * abort() here, the parent would only see SIGABRT.
202 static void just_die(int sig)
207 /*****************************************************************
208 * Connection structures and accounting...
211 /* volatile just in case */
212 static int volatile shutdown_pending;
213 static int volatile restart_pending;
214 static int volatile is_graceful;
215 ap_generation_t volatile ap_my_generation;
218 * ap_start_shutdown() and ap_start_restart(), below, are a first stab at
219 * functions to initiate shutdown or restart without relying on signals.
220 * Previously this was initiated in sig_term() and restart() signal handlers,
221 * but we want to be able to start a shutdown/restart from other sources --
222 * e.g. on Win32, from the service manager. Now the service manager can
223 * call ap_start_shutdown() or ap_start_restart() as appropiate. Note that
224 * these functions can also be called by the child processes, since global
225 * variables are no longer used to pass on the required action to the parent.
227 * These should only be called from the parent process itself, since the
228 * parent process will use the shutdown_pending and restart_pending variables
229 * to determine whether to shutdown or restart. The child process should
230 * call signal_parent() directly to tell the parent to die -- this will
231 * cause neither of those variable to be set, which the parent will
232 * assume means something serious is wrong (which it will be, for the
233 * child to force an exit) and so do an exit anyway.
236 void ap_start_shutdown(void)
238 if (shutdown_pending == 1) {
239 /* Um, is this _probably_ not an error, if the user has
240 * tried to do a shutdown twice quickly, so we won't
241 * worry about reporting it.
245 shutdown_pending = 1;
248 /* do a graceful restart if graceful == 1 */
249 void ap_start_restart(int graceful)
252 if (restart_pending == 1) {
253 /* Probably not an error - don't bother reporting it */
257 is_graceful = graceful;
260 static void sig_term(int sig)
265 static void restart(int sig)
268 ap_start_restart(sig == SIGWINCH);
274 static void set_signals(void)
276 #ifndef NO_USE_SIGACTION
279 sigemptyset(&sa.sa_mask);
283 sa.sa_handler = sig_coredump;
284 #if defined(SA_ONESHOT)
285 sa.sa_flags = SA_ONESHOT;
286 #elif defined(SA_RESETHAND)
287 sa.sa_flags = SA_RESETHAND;
289 if (sigaction(SIGSEGV, &sa, NULL) < 0)
290 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGSEGV)");
292 if (sigaction(SIGBUS, &sa, NULL) < 0)
293 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGBUS)");
296 if (sigaction(SIGABORT, &sa, NULL) < 0)
297 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGABORT)");
300 if (sigaction(SIGABRT, &sa, NULL) < 0)
301 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGABRT)");
304 if (sigaction(SIGILL, &sa, NULL) < 0)
305 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGILL)");
309 sa.sa_handler = sig_term;
310 if (sigaction(SIGTERM, &sa, NULL) < 0)
311 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGTERM)");
313 if (sigaction(SIGINT, &sa, NULL) < 0)
314 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGINT)");
317 sa.sa_handler = SIG_DFL;
318 if (sigaction(SIGXCPU, &sa, NULL) < 0)
319 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGXCPU)");
322 sa.sa_handler = SIG_DFL;
323 if (sigaction(SIGXFSZ, &sa, NULL) < 0)
324 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGXFSZ)");
327 sa.sa_handler = SIG_IGN;
328 if (sigaction(SIGPIPE, &sa, NULL) < 0)
329 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGPIPE)");
332 /* we want to ignore HUPs and WINCH while we're busy processing one */
333 sigaddset(&sa.sa_mask, SIGHUP);
334 sigaddset(&sa.sa_mask, SIGWINCH);
335 sa.sa_handler = restart;
336 if (sigaction(SIGHUP, &sa, NULL) < 0)
337 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGHUP)");
338 if (sigaction(SIGWINCH, &sa, NULL) < 0)
339 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGWINCH)");
342 ap_signal(SIGSEGV, sig_coredump);
344 ap_signal(SIGBUS, sig_coredump);
347 ap_signal(SIGABORT, sig_coredump);
348 #endif /* SIGABORT */
350 ap_signal(SIGABRT, sig_coredump);
353 ap_signal(SIGILL, sig_coredump);
356 ap_signal(SIGXCPU, SIG_DFL);
359 ap_signal(SIGXFSZ, SIG_DFL);
363 ap_signal(SIGTERM, sig_term);
365 ap_signal(SIGHUP, restart);
368 ap_signal(SIGWINCH, restart);
369 #endif /* SIGWINCH */
371 ap_signal(SIGPIPE, SIG_IGN);
377 /*****************************************************************
378 * Here follows a long bunch of generic server bookkeeping stuff...
381 int ap_graceful_stop_signalled(void)
383 /* XXX - Does this really work? - Manoj */
387 /*****************************************************************
388 * Child process main loop.
391 static void process_socket(ap_pool_t *p, ap_socket_t *sock, int my_child_num, int my_thread_num)
394 conn_rec *current_conn;
396 long conn_id = my_child_num * HARD_THREAD_LIMIT + my_thread_num;
399 (void) ap_get_os_sock(&csd, sock);
401 if (csd >= FD_SETSIZE) {
402 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, NULL,
403 "new file descriptor %d is too large; you probably need "
404 "to rebuild Apache with a larger FD_SETSIZE "
407 ap_close_socket(sock);
411 ap_sock_disable_nagle(csd);
413 iol = ap_iol_attach_socket(p, sock);
415 (void) ap_update_child_status(my_child_num, my_thread_num,
416 SERVER_BUSY_READ, (request_rec *) NULL);
417 conn_io = ap_bcreate(p, B_RDWR);
418 ap_bpush_iol(conn_io, iol);
420 current_conn = ap_new_apr_connection(p, ap_server_conf, conn_io, sock,
423 ap_process_connection(current_conn);
424 ap_lingering_close(current_conn);
426 /* Sets workers_may_exit if we received a character on the pipe_of_death */
427 static void check_pipe_of_death(void)
429 pthread_mutex_lock(&pipe_of_death_mutex);
430 if (!workers_may_exit) {
435 ret = ap_recv(listensocks[0], &pipe_read_char, &n);
436 if (ap_canonical_error(ret) == APR_EAGAIN) {
437 /* It lost the lottery. It must continue to suffer
438 * through a life of servitude. */
441 /* It won the lottery (or something else is very
442 * wrong). Embrace death with open arms. */
443 workers_may_exit = 1;
446 pthread_mutex_unlock(&pipe_of_death_mutex);
449 static void * worker_thread(void * dummy)
451 proc_info * ti = dummy;
452 int process_slot = ti->pid;
453 int thread_slot = ti->tid;
454 ap_pool_t *tpool = ti->tpool;
455 ap_socket_t *csd = NULL;
456 ap_pool_t *ptrans; /* Pool for per-transaction stuff */
457 ap_socket_t *sd = NULL;
459 int curr_pollfd, last_pollfd = 0;
460 ap_pollfd_t *pollset;
465 ap_create_pool(&ptrans, tpool);
467 pthread_mutex_lock(&worker_thread_count_mutex);
468 worker_thread_count++;
469 pthread_mutex_unlock(&worker_thread_count_mutex);
471 ap_setup_poll(&pollset, num_listensocks+1, tpool);
472 for(n=0 ; n <= num_listensocks ; ++n)
473 ap_add_poll_socket(pollset, listensocks[n], APR_POLLIN);
475 /* TODO: Switch to a system where threads reuse the results from earlier
476 poll calls - manoj */
477 while (!workers_may_exit) {
478 workers_may_exit |= (ap_max_requests_per_child != 0) && (requests_this_child <= 0);
479 if (workers_may_exit) break;
481 (void) ap_update_child_status(process_slot, thread_slot, SERVER_READY,
482 (request_rec *) NULL);
483 pthread_mutex_lock(&thread_accept_mutex);
484 if (workers_may_exit) {
485 pthread_mutex_unlock(&thread_accept_mutex);
488 if ((rv = SAFE_ACCEPT(ap_lock(process_accept_mutex)))
490 ap_log_error(APLOG_MARK, APLOG_EMERG, rv, ap_server_conf,
491 "ap_lock failed. Attempting to shutdown "
492 "process gracefully.");
493 workers_may_exit = 1;
496 while (!workers_may_exit) {
500 ret = ap_poll(pollset, &n, -1);
501 if (ret != APR_SUCCESS) {
502 if (ap_canonical_error(ret) == APR_EINTR) {
506 /* ap_poll() will only return errors in catastrophic
507 * circumstances. Let's try exiting gracefully, for now. */
508 ap_log_error(APLOG_MARK, APLOG_ERR, ret, (const server_rec *)
509 ap_server_conf, "ap_poll: (listen)");
510 workers_may_exit = 1;
513 if (workers_may_exit) break;
515 ap_get_revents(&event, listensocks[0], pollset);
516 if (event & APR_POLLIN) {
517 /* A process got a signal on the shutdown pipe. Check if we're
518 * the lucky process to die. */
519 check_pipe_of_death();
523 if (num_listensocks == 1) {
524 sd = ap_listeners->sd;
528 /* find a listener */
529 curr_pollfd = last_pollfd;
532 if (curr_pollfd > num_listensocks) {
535 /* XXX: Should we check for POLLERR? */
536 ap_get_revents(&event, listensocks[curr_pollfd], pollset);
537 if (event & APR_POLLIN) {
538 last_pollfd = curr_pollfd;
539 sd=listensocks[curr_pollfd];
542 } while (curr_pollfd != last_pollfd);
546 if (!workers_may_exit) {
547 if ((rv = ap_accept(&csd, sd, ptrans)) != APR_SUCCESS) {
548 ap_log_error(APLOG_MARK, APLOG_ERR, rv, ap_server_conf,
551 if ((rv = SAFE_ACCEPT(ap_unlock(process_accept_mutex)))
553 ap_log_error(APLOG_MARK, APLOG_EMERG, rv, ap_server_conf,
554 "ap_unlock failed. Attempting to shutdown "
555 "process gracefully.");
556 workers_may_exit = 1;
558 pthread_mutex_unlock(&thread_accept_mutex);
559 process_socket(ptrans, csd, process_slot, thread_slot);
560 requests_this_child--;
563 if ((rv = SAFE_ACCEPT(ap_unlock(process_accept_mutex)))
565 ap_log_error(APLOG_MARK, APLOG_EMERG, rv, ap_server_conf,
566 "ap_unlock failed. Attempting to shutdown "
567 "process gracefully.");
568 workers_may_exit = 1;
570 pthread_mutex_unlock(&thread_accept_mutex);
573 ap_clear_pool(ptrans);
576 ap_destroy_pool(tpool);
577 ap_update_child_status(process_slot, thread_slot, SERVER_DEAD,
578 (request_rec *) NULL);
579 pthread_mutex_lock(&worker_thread_count_mutex);
580 worker_thread_count--;
581 if (worker_thread_count == 0) {
582 /* All the threads have exited, now finish the shutdown process
583 * by signalling the sigwait thread */
584 kill(ap_my_pid, SIGTERM);
586 pthread_mutex_unlock(&worker_thread_count_mutex);
592 static void child_main(int child_num_arg)
597 pthread_attr_t thread_attr;
599 int my_child_num = child_num_arg;
600 proc_info *my_info = NULL;
605 ap_my_pid = getpid();
606 ap_create_pool(&pchild, pconf);
608 /*stuff to do before we switch id's, so we have permissions.*/
609 reopen_scoreboard(pchild);
611 rv = SAFE_ACCEPT(ap_child_init_lock(&process_accept_mutex, lock_fname,
613 if (rv != APR_SUCCESS) {
614 ap_log_error(APLOG_MARK, APLOG_EMERG, rv, ap_server_conf,
615 "Couldn't initialize cross-process lock in child");
616 clean_child_exit(APEXIT_CHILDFATAL);
619 if (unixd_setup_child()) {
620 clean_child_exit(APEXIT_CHILDFATAL);
623 ap_child_init_hook(pchild, ap_server_conf);
625 /*done with init critical section */
627 /* All threads should mask signals out, accoring to sigwait(2) man page */
628 sigfillset(&sig_mask);
630 #ifdef SIGPROCMASK_SETS_THREAD_MASK
631 if (sigprocmask(SIG_SETMASK, &sig_mask, NULL) != 0) {
632 ap_log_error(APLOG_MARK, APLOG_ALERT, errno, ap_server_conf, "sigprocmask");
635 if (pthread_sigmask(SIG_SETMASK, &sig_mask, NULL) != 0) {
636 ap_log_error(APLOG_MARK, APLOG_ALERT, errno, ap_server_conf, "pthread_sigmask");
640 requests_this_child = ap_max_requests_per_child;
642 /* Set up the pollfd array */
643 listensocks = ap_pcalloc(pchild,
644 sizeof(*listensocks) * (num_listensocks + 1));
645 #if APR_FILES_AS_SOCKETS
646 ap_socket_from_file(&listensocks[0], pipe_of_death_in);
648 for (lr = ap_listeners, i = 1; i <= num_listensocks; lr = lr->next, ++i)
649 listensocks[i]=lr->sd;
651 /* Setup worker threads */
653 worker_thread_count = 0;
654 pthread_mutex_init(&worker_thread_count_mutex, NULL);
655 pthread_mutex_init(&pipe_of_death_mutex, NULL);
656 pthread_attr_init(&thread_attr);
657 #ifdef PTHREAD_ATTR_SETDETACHSTATE_ARG2_ADDR
661 pthread_attr_setdetachstate(&thread_attr, &on);
664 pthread_attr_setdetachstate(&thread_attr, PTHREAD_CREATE_DETACHED);
666 for (i=0; i < ap_threads_per_child; i++) {
668 my_info = (proc_info *)malloc(sizeof(proc_info));
669 if (my_info == NULL) {
670 ap_log_error(APLOG_MARK, APLOG_ALERT, errno, ap_server_conf,
671 "malloc: out of memory");
672 clean_child_exit(APEXIT_CHILDFATAL);
674 my_info->pid = my_child_num;
677 ap_create_pool(&my_info->tpool, pchild);
679 /* We are creating threads right now */
680 (void) ap_update_child_status(my_child_num, i, SERVER_STARTING,
681 (request_rec *) NULL);
683 if (pthread_create(&thread, &thread_attr, worker_thread, my_info)) {
684 ap_log_error(APLOG_MARK, APLOG_ALERT, errno, ap_server_conf,
685 "pthread_create: unable to create worker thread");
686 /* In case system resources are maxxed out, we don't want
687 Apache running away with the CPU trying to fork over and
688 over and over again if we exit. */
690 clean_child_exit(APEXIT_CHILDFATAL);
693 worker_thread(my_info);
694 /* The SIGTERM shouldn't let us reach this point, but just in case... */
695 clean_child_exit(APEXIT_OK);
698 /* We let each thread update it's own scoreboard entry. This is done
699 * because it let's us deal with tid better.
703 pthread_attr_destroy(&thread_attr);
705 /* This thread will be the one responsible for handling signals */
706 sigemptyset(&sig_mask);
707 sigaddset(&sig_mask, SIGTERM);
708 sigaddset(&sig_mask, SIGINT);
709 ap_sigwait(&sig_mask, &signal_received);
710 switch (signal_received) {
713 just_die(signal_received);
716 ap_log_error(APLOG_MARK, APLOG_ALERT, errno, ap_server_conf,
717 "received impossible signal: %d", signal_received);
722 static int make_child(server_rec *s, int slot, time_t now)
726 if (slot + 1 > ap_max_daemons_limit) {
727 ap_max_daemons_limit = slot + 1;
732 ap_scoreboard_image->parent[slot].pid = getpid();
736 /* Tag this slot as occupied so that perform_idle_server_maintenance
737 * doesn't try to steal it */
738 (void) ap_update_child_status(slot, 0, SERVER_STARTING, (request_rec *) NULL);
740 if ((pid = fork()) == -1) {
741 ap_log_error(APLOG_MARK, APLOG_ERR, errno, s, "fork: Unable to fork new process");
743 /* fork didn't succeed. Fix the scoreboard or else
744 * it will say SERVER_STARTING forever and ever
746 (void) ap_update_child_status(slot, 0, SERVER_DEAD, (request_rec *) NULL);
748 /* In case system resources are maxxed out, we don't want
749 Apache running away with the CPU trying to fork over and
750 over and over again. */
757 #ifdef AIX_BIND_PROCESSOR
758 /* By default, AIX binds to a single processor. This bit unbinds
759 children which will then bind to another CPU.
761 #include <sys/processor.h>
762 int status = bindprocessor(BINDPROCESS, (int)getpid(),
763 PROCESSOR_CLASS_ANY);
765 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, errno, ap_server_conf,
766 "processor unbind failed %d", status);
769 RAISE_SIGSTOP(MAKE_CHILD);
771 ap_signal(SIGTERM, just_die);
777 ap_scoreboard_image->parent[slot].pid = pid;
781 /* start up a bunch of children */
782 static void startup_children(int number_to_start)
786 for (i = 0; number_to_start && i < ap_daemons_limit; ++i) {
787 if (ap_scoreboard_image->parent[i].pid != 0) {
790 if (make_child(ap_server_conf, i, 0) < 0) {
799 * idle_spawn_rate is the number of children that will be spawned on the
800 * next maintenance cycle if there aren't enough idle servers. It is
801 * doubled up to MAX_SPAWN_RATE, and reset only when a cycle goes by
802 * without the need to spawn.
804 static int idle_spawn_rate = 1;
805 #ifndef MAX_SPAWN_RATE
806 #define MAX_SPAWN_RATE (32)
808 static int hold_off_on_exponential_spawning;
810 static void perform_idle_server_maintenance(void)
813 int idle_thread_count;
817 int free_slots[MAX_SPAWN_RATE];
823 /* initialize the free_list */
826 idle_thread_count = 0;
830 ap_sync_scoreboard_image();
831 for (i = 0; i < ap_daemons_limit; ++i) {
832 /* Initialization to satisfy the compiler. It doesn't know
833 * that ap_threads_per_child is always > 0 */
834 int status = SERVER_DEAD;
835 int any_dying_threads = 0;
836 int all_dead_threads = 1;
837 int idle_thread_addition = 0;
839 if (i >= ap_max_daemons_limit && free_length == idle_spawn_rate)
841 for (j = 0; j < ap_threads_per_child; j++) {
842 ss = &ap_scoreboard_image->servers[i][j];
845 any_dying_threads = any_dying_threads || (status == SERVER_DEAD)
846 || (status == SERVER_GRACEFUL);
847 all_dead_threads = all_dead_threads && (status == SERVER_DEAD);
849 /* We consider a starting server as idle because we started it
850 * at least a cycle ago, and if it still hasn't finished starting
851 * then we're just going to swamp things worse by forking more.
852 * So we hopefully won't need to fork more if we count it.
853 * This depends on the ordering of SERVER_READY and SERVER_STARTING.
855 if (status <= SERVER_READY) {
856 ++idle_thread_addition;
859 if (all_dead_threads && free_length < idle_spawn_rate) {
860 free_slots[free_length] = i;
863 if (!all_dead_threads) {
866 if (!any_dying_threads) {
868 idle_thread_count += idle_thread_addition;
871 ap_max_daemons_limit = last_non_dead + 1;
873 if (idle_thread_count > max_spare_threads) {
874 /* Kill off one child */
875 char char_of_death = '!';
876 if ((rv = ap_write(pipe_of_death_out, &char_of_death, &one)) != APR_SUCCESS) {
877 ap_log_error(APLOG_MARK, APLOG_WARNING, rv, ap_server_conf, "write pipe_of_death");
881 else if (idle_thread_count < min_spare_threads) {
882 /* terminate the free list */
883 if (free_length == 0) {
884 /* only report this condition once */
885 static int reported = 0;
888 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, ap_server_conf,
889 "server reached MaxClients setting, consider"
890 " raising the MaxClients setting");
897 if (idle_spawn_rate >= 8) {
898 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, ap_server_conf,
899 "server seems busy, (you may need "
900 "to increase StartServers, ThreadsPerChild "
901 "or Min/MaxSparetThreads), "
902 "spawning %d children, there are around %d idle "
903 "threads, and %d total children", idle_spawn_rate,
904 idle_thread_count, total_non_dead);
906 for (i = 0; i < free_length; ++i) {
907 make_child(ap_server_conf, free_slots[i], now);
909 /* the next time around we want to spawn twice as many if this
910 * wasn't good enough, but not if we've just done a graceful
912 if (hold_off_on_exponential_spawning) {
913 --hold_off_on_exponential_spawning;
915 else if (idle_spawn_rate < MAX_SPAWN_RATE) {
916 idle_spawn_rate *= 2;
925 static void server_main_loop(int remaining_children_to_start)
932 while (!restart_pending && !shutdown_pending) {
933 ap_wait_or_timeout(&status, &pid, pconf);
936 ap_process_child_status(&pid, status);
937 /* non-fatal death... note that it's gone in the scoreboard. */
938 child_slot = find_child_by_pid(&pid);
939 if (child_slot >= 0) {
940 ap_mpmt_pthread_force_reset_connection_status(child_slot);
941 for (i = 0; i < ap_threads_per_child; i++)
942 ap_update_child_status(child_slot, i, SERVER_DEAD, (request_rec *) NULL);
944 if (remaining_children_to_start
945 && child_slot < ap_daemons_limit) {
946 /* we're still doing a 1-for-1 replacement of dead
947 * children with new children
949 make_child(ap_server_conf, child_slot, time(NULL));
950 --remaining_children_to_start;
952 #if APR_HAS_OTHER_CHILD
954 else if (ap_reap_other_child(&pid, status) == 0) {
958 else if (is_graceful) {
959 /* Great, we've probably just lost a slot in the
960 * scoreboard. Somehow we don't know about this child.
962 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0,
964 "long lost child came home! (pid %ld)",
967 /* Don't perform idle maintenance when a child dies,
968 * only do it when there's a timeout. Remember only a
969 * finite number of children can die, and it's pretty
970 * pathological for a lot to die suddenly.
974 else if (remaining_children_to_start) {
975 /* we hit a 1 second timeout in which none of the previous
976 * generation of children needed to be reaped... so assume
977 * they're all done, and pick up the slack if any is left.
979 startup_children(remaining_children_to_start);
980 remaining_children_to_start = 0;
981 /* In any event we really shouldn't do the code below because
982 * few of the servers we just started are in the IDLE state
983 * yet, so we'd mistakenly create an extra server.
988 perform_idle_server_maintenance();
992 int ap_mpm_run(ap_pool_t *_pconf, ap_pool_t *plog, server_rec *s)
994 int remaining_children_to_start;
1000 rv = ap_create_pipe(&pipe_of_death_in, &pipe_of_death_out, pconf);
1001 if (rv != APR_SUCCESS) {
1002 ap_log_error(APLOG_MARK, APLOG_ERR, rv,
1003 (const server_rec*) ap_server_conf,
1004 "ap_create_pipe (pipe_of_death)");
1008 if ((rv = ap_set_pipe_timeout(pipe_of_death_in, 0)) != APR_SUCCESS) {
1009 ap_log_error(APLOG_MARK, APLOG_ERR, rv,
1010 (const server_rec*) ap_server_conf,
1011 "ap_set_pipe_timeout (pipe_of_death)");
1015 if ((num_listensocks = ap_setup_listeners(ap_server_conf)) < 1) {
1016 /* XXX: hey, what's the right way for the mpm to indicate a fatal error? */
1017 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_ALERT, 0, s,
1018 "no listening sockets available, shutting down");
1021 ap_log_pid(pconf, ap_pid_fname);
1023 /* Initialize cross-process accept lock */
1024 lock_fname = ap_psprintf(_pconf, "%s.%u",
1025 ap_server_root_relative(_pconf, lock_fname),
1027 rv = ap_create_lock(&process_accept_mutex, APR_MUTEX, APR_CROSS_PROCESS,
1028 lock_fname, _pconf);
1029 if (rv != APR_SUCCESS) {
1030 ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
1031 "Couldn't create cross-process lock");
1037 reinit_scoreboard(pconf);
1041 /* Don't thrash... */
1042 if (max_spare_threads < min_spare_threads + ap_threads_per_child)
1043 max_spare_threads = min_spare_threads + ap_threads_per_child;
1045 /* If we're doing a graceful_restart then we're going to see a lot
1046 * of children exiting immediately when we get into the main loop
1047 * below (because we just sent them SIGWINCH). This happens pretty
1048 * rapidly... and for each one that exits we'll start a new one until
1049 * we reach at least daemons_min_free. But we may be permitted to
1050 * start more than that, so we'll just keep track of how many we're
1051 * supposed to start up without the 1 second penalty between each fork.
1053 remaining_children_to_start = ap_daemons_to_start;
1054 if (remaining_children_to_start > ap_daemons_limit) {
1055 remaining_children_to_start = ap_daemons_limit;
1058 startup_children(remaining_children_to_start);
1059 remaining_children_to_start = 0;
1062 /* give the system some time to recover before kicking into
1063 * exponential mode */
1064 hold_off_on_exponential_spawning = 10;
1067 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_NOTICE, 0, ap_server_conf,
1068 "%s configured -- resuming normal operations",
1069 ap_get_server_version());
1070 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, ap_server_conf,
1071 "Server built: %s", ap_get_server_built());
1072 restart_pending = shutdown_pending = 0;
1074 server_main_loop(remaining_children_to_start);
1076 if (shutdown_pending) {
1077 /* Time to gracefully shut down:
1078 * Kill child processes, tell them to call child_exit, etc...
1080 if (unixd_killpg(getpgrp(), SIGTERM) < 0) {
1081 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "killpg SIGTERM");
1083 ap_reclaim_child_processes(1); /* Start with SIGTERM */
1085 /* cleanup pid file on normal shutdown */
1087 const char *pidfile = NULL;
1088 pidfile = ap_server_root_relative (pconf, ap_pid_fname);
1089 if ( pidfile != NULL && unlink(pidfile) == 0)
1090 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0,
1092 "removed PID file %s (pid=%ld)",
1093 pidfile, (long)getpid());
1096 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_NOTICE, 0, ap_server_conf,
1097 "caught SIGTERM, shutting down");
1102 /* we've been told to restart */
1103 ap_signal(SIGHUP, SIG_IGN);
1106 /* not worth thinking about */
1110 /* advance to the next generation */
1111 /* XXX: we really need to make sure this new generation number isn't in
1112 * use by any of the children.
1115 ap_scoreboard_image->global.running_generation = ap_my_generation;
1116 update_scoreboard_global();
1120 char char_of_death = '!';
1122 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_NOTICE, 0, ap_server_conf,
1123 "SIGWINCH received. Doing graceful restart");
1125 /* give the children the signal to die */
1126 for (i = 0; i < ap_daemons_limit;) {
1127 if ((rv = ap_write(pipe_of_death_in, &char_of_death, &one)) != APR_SUCCESS) {
1128 if (ap_canonical_error(rv) == APR_EINTR) continue;
1129 ap_log_error(APLOG_MARK, APLOG_WARNING, rv, ap_server_conf, "write pipe_of_death");
1134 /* This is mostly for debugging... so that we know what is still
1135 * gracefully dealing with existing request.
1138 for (i = 0; i < ap_daemons_limit; ++i) {
1139 for (j = 0; j < ap_threads_per_child; j++) {
1140 if (ap_scoreboard_image->servers[i][j].status != SERVER_DEAD) {
1141 ap_scoreboard_image->servers[i][j].status = SERVER_GRACEFUL;
1147 /* Kill 'em all. Since the child acts the same on the parents SIGTERM
1148 * and a SIGHUP, we may as well use the same signal, because some user
1149 * pthreads are stealing signals from us left and right.
1151 if (unixd_killpg(getpgrp(), SIGTERM) < 0) {
1152 ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "killpg SIGTERM");
1154 ap_reclaim_child_processes(1); /* Start with SIGTERM */
1155 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_NOTICE, 0, ap_server_conf,
1156 "SIGHUP received. Attempting to restart");
1159 ap_restart_time = time(NULL);
1164 static void mpmt_pthread_pre_config(ap_pool_t *pconf, ap_pool_t *plog, ap_pool_t *ptemp)
1166 static int restart_num = 0;
1168 one_process = !!getenv("ONE_PROCESS");
1170 /* sigh, want this only the second time around */
1171 if (restart_num++ == 1) {
1177 ap_my_pid = getpid();
1181 ap_listen_pre_config();
1182 ap_daemons_to_start = DEFAULT_START_DAEMON;
1183 min_spare_threads = DEFAULT_MIN_FREE_DAEMON * DEFAULT_THREADS_PER_CHILD;
1184 max_spare_threads = DEFAULT_MAX_FREE_DAEMON * DEFAULT_THREADS_PER_CHILD;
1185 ap_daemons_limit = HARD_SERVER_LIMIT;
1186 ap_threads_per_child = DEFAULT_THREADS_PER_CHILD;
1187 ap_pid_fname = DEFAULT_PIDLOG;
1188 ap_scoreboard_fname = DEFAULT_SCOREBOARD;
1189 lock_fname = DEFAULT_LOCKFILE;
1190 ap_max_requests_per_child = DEFAULT_MAX_REQUESTS_PER_CHILD;
1191 ap_extended_status = 0;
1193 ap_cpystrn(ap_coredump_dir, ap_server_root, sizeof(ap_coredump_dir));
1196 static void mpmt_pthread_hooks(void)
1201 ap_hook_pre_config(mpmt_pthread_pre_config, NULL, NULL, AP_HOOK_MIDDLE);
1205 static const char *set_pidfile(cmd_parms *cmd, void *dummy, const char *arg)
1207 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1212 if (cmd->server->is_virtual) {
1213 return "PidFile directive not allowed in <VirtualHost>";
1219 static const char *set_scoreboard(cmd_parms *cmd, void *dummy,
1222 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1227 ap_scoreboard_fname = arg;
1231 static const char *set_lockfile(cmd_parms *cmd, void *dummy, const char *arg)
1233 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1242 static const char *set_daemons_to_start(cmd_parms *cmd, void *dummy,
1245 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1250 ap_daemons_to_start = atoi(arg);
1254 static const char *set_min_spare_threads(cmd_parms *cmd, void *dummy,
1257 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1262 min_spare_threads = atoi(arg);
1263 if (min_spare_threads <= 0) {
1264 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
1265 "WARNING: detected MinSpareThreads set to non-positive.");
1266 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
1267 "Resetting to 1 to avoid almost certain Apache failure.");
1268 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
1269 "Please read the documentation.");
1270 min_spare_threads = 1;
1276 static const char *set_max_spare_threads(cmd_parms *cmd, void *dummy,
1279 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1284 max_spare_threads = atoi(arg);
1288 static const char *set_server_limit (cmd_parms *cmd, void *dummy,
1291 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1296 ap_daemons_limit = atoi(arg);
1297 if (ap_daemons_limit > HARD_SERVER_LIMIT) {
1298 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
1299 "WARNING: MaxClients of %d exceeds compile time limit "
1300 "of %d servers,", ap_daemons_limit, HARD_SERVER_LIMIT);
1301 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
1302 " lowering MaxClients to %d. To increase, please "
1303 "see the", HARD_SERVER_LIMIT);
1304 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
1305 " HARD_SERVER_LIMIT define in %s.",
1306 AP_MPM_HARD_LIMITS_FILE);
1307 ap_daemons_limit = HARD_SERVER_LIMIT;
1309 else if (ap_daemons_limit < 1) {
1310 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, "WARNING: Require MaxClients > 0, setting to 1\n");
1311 ap_daemons_limit = 1;
1316 static const char *set_threads_per_child (cmd_parms *cmd, void *dummy,
1319 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1324 ap_threads_per_child = atoi(arg);
1325 if (ap_threads_per_child > HARD_THREAD_LIMIT) {
1326 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
1327 "WARNING: ThreadsPerChild of %d exceeds compile time"
1328 "limit of %d threads,", ap_threads_per_child,
1330 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
1331 " lowering ThreadsPerChild to %d. To increase, please"
1332 " see the", HARD_THREAD_LIMIT);
1333 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
1334 " HARD_THREAD_LIMIT define in %s.",
1335 AP_MPM_HARD_LIMITS_FILE);
1337 else if (ap_threads_per_child < 1) {
1338 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
1339 "WARNING: Require ThreadsPerChild > 0, setting to 1");
1340 ap_threads_per_child = 1;
1345 static const char *set_max_requests(cmd_parms *cmd, void *dummy,
1348 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1353 ap_max_requests_per_child = atoi(arg);
1358 static const char *set_coredumpdir (cmd_parms *cmd, void *dummy,
1363 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1368 fname = ap_server_root_relative(cmd->pool, arg);
1369 if ((ap_stat(&finfo, fname, cmd->pool) != APR_SUCCESS) ||
1370 (finfo.filetype != APR_DIR)) {
1371 return ap_pstrcat(cmd->pool, "CoreDumpDirectory ", fname,
1372 " does not exist or is not a directory", NULL);
1374 ap_cpystrn(ap_coredump_dir, fname, sizeof(ap_coredump_dir));
1378 static const command_rec mpmt_pthread_cmds[] = {
1379 UNIX_DAEMON_COMMANDS
1381 AP_INIT_TAKE1("PidFile", set_pidfile, NULL, RSRC_CONF,
1382 "A file for logging the server process ID"),
1383 AP_INIT_TAKE1("ScoreBoardFile", set_scoreboard, NULL, RSRC_CONF,
1384 "A file for Apache to maintain runtime process management information"),
1385 AP_INIT_TAKE1("LockFile", set_lockfile, NULL, RSRC_CONF,
1386 "The lockfile used when Apache needs to lock the accept() call"),
1387 AP_INIT_TAKE1("StartServers", set_daemons_to_start, NULL, RSRC_CONF,
1388 "Number of child processes launched at server startup"),
1389 AP_INIT_TAKE1("MinSpareThreads", set_min_spare_threads, NULL, RSRC_CONF,
1390 "Minimum number of idle children, to handle request spikes"),
1391 AP_INIT_TAKE1("MaxSpareThreads", set_max_spare_threads, NULL, RSRC_CONF,
1392 "Maximum number of idle children"),
1393 AP_INIT_TAKE1("MaxClients", set_server_limit, NULL, RSRC_CONF,
1394 "Maximum number of children alive at the same time"),
1395 AP_INIT_TAKE1("ThreadsPerChild", set_threads_per_child, NULL, RSRC_CONF,
1396 "Number of threads each child creates"),
1397 AP_INIT_TAKE1("MaxRequestsPerChild", set_max_requests, NULL, RSRC_CONF,
1398 "Maximum number of requests a particular child serves before dying."),
1399 AP_INIT_TAKE1("CoreDumpDirectory", set_coredumpdir, NULL, RSRC_CONF,
1400 "The location of the directory Apache changes to before dumping core"),
1404 module MODULE_VAR_EXPORT mpm_mpmt_pthread_module = {
1406 NULL, /* hook to run before apache parses args */
1407 NULL, /* create per-directory config structure */
1408 NULL, /* merge per-directory config structures */
1409 NULL, /* create per-server config structure */
1410 NULL, /* merge per-server config structures */
1411 mpmt_pthread_cmds, /* command ap_table_t */
1412 NULL, /* handlers */
1413 mpmt_pthread_hooks /* register_hooks */