]> granicus.if.org Git - apache/blob - server/mpm/winnt/mpm_winnt.c
Get Apache on Windows working again after Ryan's first commit to remove
[apache] / server / mpm / winnt / mpm_winnt.c
1 /* ====================================================================
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 2000 The Apache Software Foundation.  All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  *
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
17  *    distribution.
18  *
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.
25  *
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.
30  *
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.
34  *
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
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
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/>.
53  *
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.
57  */
58
59 #define CORE_PRIVATE 
60 #include "httpd.h" 
61 #include "http_main.h" 
62 #include "http_log.h" 
63 #include "http_config.h"        /* for read_config */ 
64 #include "http_core.h"          /* for get_remote_host */ 
65 #include "http_connection.h"
66 #include "apr_portable.h"
67 #include "apr_getopt.h"
68 #include "apr_strings.h"
69 #include "ap_mpm.h"
70 #include "ap_config.h"
71 #include "ap_listen.h"
72 #include "mpm_default.h"
73 #include "mpm_winnt.h"
74 #include "mpm_common.h"
75
76 /*
77  * Definitions of WINNT MPM specific config globals
78  */
79 static int workers_may_exit = 0;
80 static int shutdown_in_progress = 0;
81 static unsigned int g_blocked_threads = 0;
82
83 static char *ap_pid_fname = NULL;
84 static int ap_threads_per_child = 0;
85
86 static int max_requests_per_child = 0;
87 static HANDLE shutdown_event;   /* used to signal shutdown to parent */
88 static HANDLE restart_event;    /* used to signal a restart to parent */
89
90 #define MAX_SIGNAL_NAME 30  /* Long enough for apPID_shutdown, where PID is an int */
91 char signal_name_prefix[MAX_SIGNAL_NAME];
92 char signal_restart_name[MAX_SIGNAL_NAME]; 
93 char signal_shutdown_name[MAX_SIGNAL_NAME];
94
95 static struct fd_set listenfds;
96 static int num_listenfds = 0;
97 static SOCKET listenmaxfd = INVALID_SOCKET;
98
99 static apr_pool_t *pconf;               /* Pool for config stuff */
100
101 static char ap_coredump_dir[MAX_STRING_LEN];
102
103 static server_rec *server_conf;
104 static HANDLE AcceptExCompPort = NULL;
105
106 static int one_process = 0;
107 static char const* signal_arg;
108
109 OSVERSIONINFO osver; /* VER_PLATFORM_WIN32_NT */
110
111 int ap_max_requests_per_child=0;
112 int ap_daemons_to_start=0;
113
114 static event *exit_event;
115 HANDLE maintenance_event;
116 apr_lock_t *start_mutex;
117 DWORD my_pid;
118 DWORD parent_pid;
119
120 /* This is the helper code to resolve late bound entry points 
121  * missing from one or more releases of the Win32 API...
122  * but it sure would be nice if we didn't duplicate this code
123  * from the APR ;-)
124  */
125
126 static const char* const lateDllName[DLL_defined] = {
127     "kernel32", "advapi32", "mswsock",  "ws2_32"  };
128 static HMODULE lateDllHandle[DLL_defined] = {
129     NULL,       NULL,       NULL,       NULL      };
130
131 FARPROC ap_load_dll_func(ap_dlltoken_e fnLib, char* fnName, int ordinal)
132 {
133     if (!lateDllHandle[fnLib]) { 
134         lateDllHandle[fnLib] = LoadLibrary(lateDllName[fnLib]);
135         if (!lateDllHandle[fnLib])
136             return NULL;
137     }
138     if (ordinal)
139         return GetProcAddress(lateDllHandle[fnLib], (char *) ordinal);
140     else
141         return GetProcAddress(lateDllHandle[fnLib], fnName);
142 }
143
144 static apr_status_t socket_cleanup(void *sock)
145 {
146     apr_socket_t *thesocket = sock;
147     SOCKET sd;
148     if (apr_get_os_sock(&sd, thesocket) == APR_SUCCESS) {
149         closesocket(sd);
150     }
151     return APR_SUCCESS;
152 }
153
154 /* A bunch or routines from os/win32/multithread.c that need to be merged into APR
155  * or thrown out entirely...
156  */
157
158 typedef void semaphore;
159 typedef void event;
160
161 static semaphore *
162 create_semaphore(int initial)
163 {
164     return(CreateSemaphore(NULL, initial, 1000000, NULL));
165 }
166
167 static void acquire_semaphore(semaphore *semaphore_id)
168 {
169     int rv;
170     
171     rv = WaitForSingleObject(semaphore_id, INFINITE);
172     
173     return;
174 }
175
176 static int release_semaphore(semaphore *semaphore_id)
177 {
178     return(ReleaseSemaphore(semaphore_id, 1, NULL));
179 }
180
181 static void destroy_semaphore(semaphore *semaphore_id)
182 {
183     CloseHandle(semaphore_id);
184 }
185
186
187 /* To share the semaphores with other processes, we need a NULL ACL
188  * Code from MS KB Q106387
189  */
190 static PSECURITY_ATTRIBUTES GetNullACL()
191 {
192     PSECURITY_DESCRIPTOR pSD;
193     PSECURITY_ATTRIBUTES sa;
194
195     sa  = (PSECURITY_ATTRIBUTES) LocalAlloc(LPTR, sizeof(SECURITY_ATTRIBUTES));
196     pSD = (PSECURITY_DESCRIPTOR) LocalAlloc(LPTR,
197                                             SECURITY_DESCRIPTOR_MIN_LENGTH);
198     if (pSD == NULL || sa == NULL) {
199         return NULL;
200     }
201     apr_set_os_error(0);
202     if (!InitializeSecurityDescriptor(pSD, SECURITY_DESCRIPTOR_REVISION)
203         || apr_get_os_error()) {
204         LocalFree( pSD );
205         LocalFree( sa );
206         return NULL;
207     }
208     if (!SetSecurityDescriptorDacl(pSD, TRUE, (PACL) NULL, FALSE)
209         || apr_get_os_error()) {
210         LocalFree( pSD );
211         LocalFree( sa );
212         return NULL;
213     }
214     sa->nLength = sizeof(sa);
215     sa->lpSecurityDescriptor = pSD;
216     sa->bInheritHandle = TRUE;
217     return sa;
218 }
219
220 static void CleanNullACL( void *sa ) {
221     if( sa ) {
222         LocalFree( ((PSECURITY_ATTRIBUTES)sa)->lpSecurityDescriptor);
223         LocalFree( sa );
224     }
225 }
226
227 /*
228  * The Win32 call WaitForMultipleObjects will only allow you to wait for 
229  * a maximum of MAXIMUM_WAIT_OBJECTS (current 64).  Since the threading 
230  * model in the multithreaded version of apache wants to use this call, 
231  * we are restricted to a maximum of 64 threads.  This is a simplistic 
232  * routine that will increase this size.
233  */
234 static DWORD wait_for_many_objects(DWORD nCount, CONST HANDLE *lpHandles, 
235                                    DWORD dwSeconds)
236 {
237     time_t tStopTime;
238     DWORD dwRet = WAIT_TIMEOUT;
239     DWORD dwIndex=0;
240     BOOL bFirst = TRUE;
241   
242     tStopTime = time(NULL) + dwSeconds;
243   
244     do {
245         if (!bFirst)
246             Sleep(1000);
247         else
248             bFirst = FALSE;
249           
250         for (dwIndex = 0; dwIndex * MAXIMUM_WAIT_OBJECTS < nCount; dwIndex++) {
251             dwRet = WaitForMultipleObjects( 
252                 min(MAXIMUM_WAIT_OBJECTS, nCount - (dwIndex * MAXIMUM_WAIT_OBJECTS)),
253                 lpHandles + (dwIndex * MAXIMUM_WAIT_OBJECTS), 
254                 0, 0);
255                                            
256             if (dwRet != WAIT_TIMEOUT) {                                          
257               break;
258             }
259         }
260     } while((time(NULL) < tStopTime) && (dwRet == WAIT_TIMEOUT));
261     
262     return dwRet;
263 }
264
265 /*
266  * Signalling Apache on NT.
267  *
268  * Under Unix, Apache can be told to shutdown or restart by sending various
269  * signals (HUP, USR, TERM). On NT we don't have easy access to signals, so
270  * we use "events" instead. The parent apache process goes into a loop
271  * where it waits forever for a set of events. Two of those events are
272  * called
273  *
274  *    apPID_shutdown
275  *    apPID_restart
276  *
277  * (where PID is the PID of the apache parent process). When one of these
278  * is signalled, the Apache parent performs the appropriate action. The events
279  * can become signalled through internal Apache methods (e.g. if the child
280  * finds a fatal error and needs to kill its parent), via the service
281  * control manager (the control thread will signal the shutdown event when
282  * requested to stop the Apache service), from the -k Apache command line,
283  * or from any external program which finds the Apache PID from the
284  * httpd.pid file.
285  *
286  * The signal_parent() function, below, is used to signal one of these events.
287  * It can be called by any child or parent process, since it does not
288  * rely on global variables.
289  *
290  * On entry, type gives the event to signal. 0 means shutdown, 1 means 
291  * graceful restart.
292  */
293 void signal_parent(int type)
294 {
295     HANDLE e;
296     char *signal_name;
297     
298     /* after updating the shutdown_pending or restart flags, we need
299      * to wake up the parent process so it can see the changes. The
300      * parent will normally be waiting for either a child process
301      * to die, or for a signal on the "spache-signal" event. So set the
302      * "apache-signal" event here.
303      */
304     if (one_process) {
305         return;
306     }
307
308     switch(type) {
309     case 0: signal_name = signal_shutdown_name; break;
310     case 1: signal_name = signal_restart_name; break;
311     default: return;
312     }
313     e = OpenEvent(EVENT_ALL_ACCESS, FALSE, signal_name);
314     if (!e) {
315         /* Um, problem, can't signal the parent, which means we can't
316          * signal ourselves to die. Ignore for now...
317          */
318         ap_log_error(APLOG_MARK, APLOG_EMERG, apr_get_os_error(), server_conf,
319                      "OpenEvent on %s event", signal_name);
320         return;
321     }
322     if (SetEvent(e) == 0) {
323         /* Same problem as above */
324         ap_log_error(APLOG_MARK, APLOG_EMERG, apr_get_os_error(), server_conf,
325                      "SetEvent on %s event", signal_name);
326         CloseHandle(e);
327         return;
328     }
329     CloseHandle(e);
330 }
331
332 static int volatile is_graceful = 0;
333
334 AP_DECLARE(int) ap_graceful_stop_signalled(void)
335 {
336     return is_graceful;
337 }
338
339 AP_DECLARE(void) ap_start_shutdown(void)
340 {
341     signal_parent(0);
342 }
343
344 AP_DECLARE(void) ap_start_restart(int gracefully)
345 {
346     is_graceful = gracefully;
347     signal_parent(1);
348 }
349
350 /*
351  * Initialise the signal names, in the global variables signal_name_prefix, 
352  * signal_restart_name and signal_shutdown_name.
353  */
354
355 void setup_signal_names(char *prefix)
356 {
357     apr_snprintf(signal_name_prefix, sizeof(signal_name_prefix), prefix);    
358     apr_snprintf(signal_shutdown_name, sizeof(signal_shutdown_name), 
359         "%s_shutdown", signal_name_prefix);    
360     apr_snprintf(signal_restart_name, sizeof(signal_restart_name), 
361         "%s_restart", signal_name_prefix);    
362 }
363
364 /*
365  * Routines that deal with sockets, some are WIN32 specific...
366  */
367
368 static void sock_disable_nagle(int s) 
369 {
370     /* The Nagle algorithm says that we should delay sending partial
371      * packets in hopes of getting more data.  We don't want to do
372      * this; we are not telnet.  There are bad interactions between
373      * persistent connections and Nagle's algorithm that have very severe
374      * performance penalties.  (Failing to disable Nagle is not much of a
375      * problem with simple HTTP.)
376      *
377      * In spite of these problems, failure here is not a shooting offense.
378      */
379     int just_say_no = 1;
380
381     if (setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (char *) &just_say_no,
382                    sizeof(int)) < 0) {
383         ap_log_error(APLOG_MARK, APLOG_WARNING, APR_SUCCESS, server_conf,
384                     "setsockopt: (TCP_NODELAY)");
385     }
386 }
387
388 /*
389  * Routines to deal with managing the list of listening sockets.
390  */
391 static ap_listen_rec *head_listener;
392
393 static apr_inline ap_listen_rec *find_ready_listener(fd_set * main_fds)
394 {
395     ap_listen_rec *lr;
396     SOCKET nsd;
397
398     for (lr = head_listener; lr ; lr = lr->next) {
399         apr_get_os_sock(&nsd, lr->sd);
400         if (FD_ISSET(nsd, main_fds)) {
401             head_listener = lr->next;
402             if (head_listener == NULL)
403                 head_listener = ap_listeners;
404
405             return (lr);
406         }
407     }
408     return NULL;
409 }
410
411 static int setup_listeners(server_rec *s)
412 {
413     ap_listen_rec *lr;
414     int num_listeners = 0;
415     SOCKET nsd;
416
417     /* Setup the listeners */
418     FD_ZERO(&listenfds);
419
420     if (ap_listen_open(s->process, s->port)) {
421        return 0;
422     }
423     for (lr = ap_listeners; lr; lr = lr->next) {
424         num_listeners++;
425         if (lr->sd != NULL) {
426             apr_get_os_sock(&nsd, lr->sd);
427             FD_SET(nsd, &listenfds);
428             if (listenmaxfd == INVALID_SOCKET || nsd > listenmaxfd) {
429                 listenmaxfd = nsd;
430             }
431         }
432         lr->count = 0;
433     }
434
435     head_listener = ap_listeners;
436
437     return num_listeners;
438 }
439
440 static int setup_inherited_listeners(server_rec *s)
441 {
442     WSAPROTOCOL_INFO WSAProtocolInfo;
443     HANDLE pipe;
444     ap_listen_rec *lr;
445     DWORD BytesRead;
446     int num_listeners = 0;
447     SOCKET nsd;
448
449     /* Setup the listeners */
450     FD_ZERO(&listenfds);
451
452     /* Set up a default listener if necessary */
453
454     if (ap_listeners == NULL) {
455         ap_listen_rec *lr;
456         lr = apr_palloc(s->process->pool, sizeof(ap_listen_rec));
457         if (!lr)
458             return 0;
459         lr->sd = NULL;
460         lr->next = ap_listeners;
461         ap_listeners = lr;
462     }
463
464     /* Open the pipe to the parent process to receive the inherited socket
465      * data. The sockets have been set to listening in the parent process.
466      */
467     pipe = GetStdHandle(STD_INPUT_HANDLE);
468     for (lr = ap_listeners; lr; lr = lr->next) {
469         if (!ReadFile(pipe, &WSAProtocolInfo, sizeof(WSAPROTOCOL_INFO), 
470                       &BytesRead, (LPOVERLAPPED) NULL)) {
471             ap_log_error(APLOG_MARK, APLOG_CRIT, apr_get_os_error(), server_conf,
472                          "setup_inherited_listeners: Unable to read socket data from parent");
473             signal_parent(0);   /* tell parent to die */
474             exit(1);
475         }
476         ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, APR_SUCCESS, server_conf,
477                      "Child %d: setup_inherited_listener() read = %d bytes of WSAProtocolInfo.", my_pid);
478         nsd = WSASocket(FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO,
479                         &WSAProtocolInfo, 0, 0);
480         if (nsd == INVALID_SOCKET) {
481             ap_log_error(APLOG_MARK, APLOG_CRIT, apr_get_netos_error(), server_conf,
482                          "Child %d: setup_inherited_listeners(), WSASocket failed to open the inherited socket.", my_pid);
483             signal_parent(0);   /* tell parent to die */
484             exit(1);
485         }
486         if (nsd >= 0) {
487             FD_SET(nsd, &listenfds);
488             if (listenmaxfd == INVALID_SOCKET || nsd > listenmaxfd) {
489                 listenmaxfd = nsd;
490             }
491         }
492         apr_put_os_sock(&lr->sd, &nsd, pconf);
493         lr->count = 0;
494     }
495     /* Now, read the AcceptExCompPort from the parent */
496     ReadFile(pipe, &AcceptExCompPort, sizeof(AcceptExCompPort), &BytesRead, (LPOVERLAPPED) NULL);
497     CloseHandle(pipe);
498
499     for (lr = ap_listeners; lr; lr = lr->next) {
500         num_listeners++;
501     }
502
503     head_listener = ap_listeners;
504     return num_listeners;
505 }
506
507 static void bind_listeners_to_completion_port()
508 {
509     /* Associate the open listeners with the completion port.
510      * Bypass the operation for Windows 95/98
511      */
512     ap_listen_rec *lr;
513
514     if (osver.dwPlatformId != VER_PLATFORM_WIN32_WINDOWS) {
515         for (lr = ap_listeners; lr; lr = lr->next) {
516             int nsd;
517             apr_get_os_sock(&nsd,lr->sd);
518             CreateIoCompletionPort((HANDLE) nsd, AcceptExCompPort, 0, 0);
519         }
520     }
521 }
522
523 /**********************************************************************
524  * Multithreaded implementation
525  *
526  * This code is fairly specific to Win32.
527  *
528  * The model used to handle requests is a set of threads. One "main"
529  * thread listens for new requests. When something becomes
530  * available, it does a select and places the newly available socket
531  * onto a list of "jobs" (add_job()). Then any one of a fixed number
532  * of "worker" threads takes the top job off the job list with
533  * remove_job() and handles that connection to completion. After
534  * the connection has finished the thread is free to take another
535  * job from the job list.
536  *
537  * In the code, the "main" thread is running within the child_main()
538  * function. The first thing this function does is create the
539  * worker threads, which operate in the child_sub_main() function. The
540  * main thread then goes into a loop within child_main() where they
541  * do a select() on the listening sockets. The select times out once
542  * per second so that the thread can check for an "exit" signal
543  * from the parent process (see below). If this signal is set, the 
544  * thread can exit, but only after it has accepted all incoming
545  * connections already in the listen queue (since Win32 appears
546  * to through away listened but unaccepted connections when a 
547  * process dies).
548  *
549  * Because the main and worker threads exist within a single process
550  * they are vulnerable to crashes or memory leaks (crashes can also
551  * be caused within modules, of course). There also needs to be a 
552  * mechanism to perform restarts and shutdowns. This is done by
553  * creating the main & worker threads within a subprocess. A
554  * main process (the "parent process") creates one (or more) 
555  * processes to do the work, then the parent sits around waiting
556  * for the working process to die, in which case it starts a new
557  * one. The parent process also handles restarts (by creating
558  * a new working process then signalling the previous working process 
559  * exit ) and shutdowns (by signalling the working process to exit).
560  * The parent process operates within the master_main() function. This
561  * process also handles requests from the service manager (NT only).
562  *
563  * Signalling between the parent and working process uses a Win32
564  * event. Each child has a unique name for the event, which is
565  * passed to it with the -Z argument when the child is spawned. The
566  * parent sets (signals) this event to tell the child to die.
567  * At present all children do a graceful die - they finish all
568  * current jobs _and_ empty the listen queue before they exit.
569  * A non-graceful die would need a second event. The -Z argument in
570  * the child is also used to create the shutdown and restart events,
571  * since the prefix (apPID) contains the parent process PID.
572  *
573  * The code below starts with functions at the lowest level -
574  * worker threads, and works up to the top level - the main()
575  * function of the parent process.
576  *
577  * The scoreboard (in process memory) contains details of the worker
578  * threads (within the active working process). There is no shared
579  * "scoreboard" between processes, since only one is ever active
580  * at once (or at most, two, when one has been told to shutdown but
581  * is processes outstanding requests, and a new one has been started).
582  * This is controlled by a "start_mutex" which ensures only one working
583  * process is active at once.
584  **********************************************************************/
585
586
587 /*
588  * Definition of jobs, shared by main and worker threads.
589  */
590
591 typedef struct joblist_s {
592     struct joblist_s *next;
593     int sock;
594 } joblist;
595
596 /*
597  * Globals common to main and worker threads. This structure is not
598  * used by the parent process.
599  */
600
601 typedef struct globals_s {
602     semaphore *jobsemaphore;
603     joblist *jobhead;
604     joblist *jobtail;
605     apr_lock_t *jobmutex;
606     int jobcount;
607
608 } globals;
609
610 globals allowed_globals =
611 {NULL, NULL, NULL, NULL, 0};
612 #define MAX_SELECT_ERRORS 100
613 #define PADDED_ADDR_SIZE sizeof(SOCKADDR_IN)+16
614
615 /* Windows 9x specific code...
616  * Accept processing for on Windows 95/98 uses a producer/consumer queue 
617  * model. A single thread accepts connections and queues the accepted socket 
618  * to the accept queue for consumption by a pool of worker threads.
619  *
620  * win9x_get_connection()
621  *    Calls remove_job() to pull a job from the accept queue. All the worker 
622  *    threads block on remove_job.
623  * accept_and_queue_connections()
624  *    The accept threads runs this function, which accepts connections off 
625  *    the network and calls add_job() to queue jobs to the accept_queue.
626  * add_job()/remove_job()
627  *    Add or remove an accepted socket from the list of sockets 
628  *    connected to clients. allowed_globals.jobmutex protects
629  *    against multiple concurrent access to the linked list of jobs.
630  */
631 static void add_job(int sock)
632 {
633     joblist *new_job;
634
635     new_job = (joblist *) malloc(sizeof(joblist));
636     if (new_job == NULL) {
637         ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, 
638                      "Ouch!  Out of memory in add_job()!");
639         return;
640     }
641     new_job->next = NULL;
642     new_job->sock = sock;
643
644     apr_lock(allowed_globals.jobmutex);
645
646     if (allowed_globals.jobtail != NULL)
647         allowed_globals.jobtail->next = new_job;
648     allowed_globals.jobtail = new_job;
649     if (!allowed_globals.jobhead)
650         allowed_globals.jobhead = new_job;
651     allowed_globals.jobcount++;
652     release_semaphore(allowed_globals.jobsemaphore);
653
654     apr_unlock(allowed_globals.jobmutex);
655 }
656
657 static int remove_job(void)
658 {
659     joblist *job;
660     int sock;
661
662     acquire_semaphore(allowed_globals.jobsemaphore);
663     apr_lock(allowed_globals.jobmutex);
664
665     if (shutdown_in_progress && !allowed_globals.jobhead) {
666         apr_unlock(allowed_globals.jobmutex);
667         return (-1);
668     }
669     job = allowed_globals.jobhead;
670     ap_assert(job);
671     allowed_globals.jobhead = job->next;
672     if (allowed_globals.jobhead == NULL)
673         allowed_globals.jobtail = NULL;
674     apr_unlock(allowed_globals.jobmutex);
675     sock = job->sock;
676     free(job);
677
678     return (sock);
679 }
680
681 static void accept_and_queue_connections(void * dummy)
682 {
683     int requests_this_child = 0;
684     struct timeval tv;
685     fd_set main_fds;
686     int wait_time = 1;
687     int csd;
688     int nsd = INVALID_SOCKET;
689     struct sockaddr_in sa_client;
690     int count_select_errors = 0;
691     int rc;
692     int clen;
693
694     while (!shutdown_in_progress) {
695         if (ap_max_requests_per_child && (requests_this_child > ap_max_requests_per_child)) {
696             break;
697         }
698
699         tv.tv_sec = wait_time;
700         tv.tv_usec = 0;
701         memcpy(&main_fds, &listenfds, sizeof(fd_set));
702
703         rc = select(listenmaxfd + 1, &main_fds, NULL, NULL, &tv);
704
705         if (rc == 0 || (rc == SOCKET_ERROR && APR_STATUS_IS_EINTR(apr_get_netos_error()))) {
706             count_select_errors = 0;    /* reset count of errors */            
707             continue;
708         }
709         else if (rc == SOCKET_ERROR) {
710             /* A "real" error occurred, log it and increment the count of
711              * select errors. This count is used to ensure we don't go into
712              * a busy loop of continuous errors.
713              */
714             ap_log_error(APLOG_MARK, APLOG_INFO, apr_get_netos_error(), server_conf, 
715                          "select failed with error %d", apr_get_netos_error());
716             count_select_errors++;
717             if (count_select_errors > MAX_SELECT_ERRORS) {
718                 shutdown_in_progress = 1;
719                 ap_log_error(APLOG_MARK, APLOG_ERR, apr_get_netos_error(), server_conf,
720                              "Too many errors in select loop. Child process exiting.");
721                 break;
722             }
723         } else {
724             ap_listen_rec *lr;
725
726             lr = find_ready_listener(&main_fds);
727             if (lr != NULL) {
728                 /* fetch the native socket descriptor */
729                 apr_get_os_sock(&nsd, lr->sd);
730             }
731         }
732
733         do {
734             clen = sizeof(sa_client);
735             csd = accept(nsd, (struct sockaddr *) &sa_client, &clen);
736             if (csd == INVALID_SOCKET) {
737                 csd = -1;
738             }
739         } while (csd < 0 && APR_STATUS_IS_EINTR(apr_get_netos_error()));
740
741         if (csd < 0) {
742             if (apr_get_netos_error() == APR_FROM_OS_ERROR(WSAECONNABORTED)) {
743                 ap_log_error(APLOG_MARK, APLOG_ERR, apr_get_netos_error(), server_conf,
744                             "accept: (client socket)");
745             }
746         }
747         else {
748             add_job(csd);
749             requests_this_child++;
750         }
751     }
752     SetEvent(exit_event);
753 }
754 static PCOMP_CONTEXT win9x_get_connection(PCOMP_CONTEXT context)
755 {
756     int len;
757
758     if (context == NULL) {
759         /* allocate the completion context and the transaction pool */
760         context = apr_pcalloc(pconf, sizeof(COMP_CONTEXT));
761         if (!context) {
762             ap_log_error(APLOG_MARK,APLOG_ERR, apr_get_os_error(), server_conf,
763                          "win9x_get_connection: apr_pcalloc() failed. Process will exit.");
764             return NULL;
765         }
766         apr_create_pool(&context->ptrans, pconf);
767     }
768     
769
770     while (1) {
771         apr_clear_pool(context->ptrans);        
772         context->accept_socket = remove_job();
773         if (context->accept_socket == -1) {
774             return NULL;
775         }
776         len = sizeof(struct sockaddr);
777         context->sa_server = apr_palloc(context->ptrans, len);
778         if (getsockname(context->accept_socket, 
779                         context->sa_server, &len)== SOCKET_ERROR) {
780             ap_log_error(APLOG_MARK, APLOG_WARNING, apr_get_netos_error(), server_conf, 
781                          "getsockname failed");
782             continue;
783         }
784         len = sizeof(struct sockaddr);
785         context->sa_client = apr_palloc(context->ptrans, len);
786         if ((getpeername(context->accept_socket,
787                          context->sa_client, &len)) == SOCKET_ERROR) {
788             ap_log_error(APLOG_MARK, APLOG_WARNING, apr_get_netos_error(), server_conf, 
789                          "getpeername failed");
790             memset(&context->sa_client, '\0', sizeof(context->sa_client));
791         }
792
793         context->conn_io = ap_bcreate(context->ptrans, B_RDWR);
794
795         /* do we NEED_DUPPED_CSD ?? */
796         
797         return context;
798     }
799 }
800
801 /* 
802  * Windows 2000/NT specific code...
803  * create_acceptex_context()
804  * reset_acceptex_context()
805  * drain_acceptex_complport()
806  * winnt_get_connection()
807  *
808  * TODO: Insert a discussion of 'completion contexts' and what these function do here...
809  */
810 static void drain_acceptex_complport(HANDLE hComplPort, BOOLEAN bCleanUp) 
811 {
812     LPOVERLAPPED pol;
813     PCOMP_CONTEXT context;
814     int rc;
815     DWORD BytesRead;
816     DWORD CompKey;
817
818     while (1) {
819         context = NULL;
820         rc = GetQueuedCompletionStatus(hComplPort, &BytesRead, &CompKey,
821                                        &pol, 1000);
822         if (!rc) {
823             rc = apr_get_os_error();
824             if (rc == APR_FROM_OS_ERROR(ERROR_OPERATION_ABORTED)) {
825                 ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, server_conf,
826                              "Child %d: - Draining an ABORTED packet off "
827                              "the AcceptEx completion port.", my_pid);
828                 continue;
829             }
830             break;
831         }
832         ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, server_conf,
833                      "Child %d: - Draining and discarding an active connection "
834                      "off the AcceptEx completion port.", my_pid);
835         context = (PCOMP_CONTEXT) pol;
836         if (context && bCleanUp) {
837             /* It is only valid to clean-up in the process that initiated the I/O */
838             closesocket(context->accept_socket);
839             CloseHandle(context->Overlapped.hEvent);
840         }
841     }
842 }
843 static int create_acceptex_context(apr_pool_t *_pconf, ap_listen_rec *lr) 
844 {
845     PCOMP_CONTEXT context;
846     DWORD BytesRead;
847     SOCKET nsd;
848     int lasterror;
849
850     /* allocate the completion context */
851     context = apr_pcalloc(_pconf, sizeof(COMP_CONTEXT));
852     if (!context) {
853         ap_log_error(APLOG_MARK,APLOG_ERR, apr_get_os_error(), server_conf,
854                      "create_acceptex_context: apr_pcalloc() failed. Process will exit.");
855         return -1;
856     }
857
858     /* initialize the completion context */
859     context->lr = lr;
860     context->Overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL); 
861     if (context->Overlapped.hEvent == NULL) {
862         ap_log_error(APLOG_MARK,APLOG_ERR, apr_get_os_error(), server_conf,
863                      "create_acceptex_context: CreateEvent() failed. Process will exit.");
864         return -1;
865     }
866
867     /* create and initialize the accept socket */
868     apr_get_os_sock(&nsd, context->lr->sd);
869     context->accept_socket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
870     if (context->accept_socket == INVALID_SOCKET) {
871         ap_log_error(APLOG_MARK,APLOG_ERR, apr_get_netos_error(), server_conf,
872                      "create_acceptex_context: socket() failed. Process will exit.");
873         return -1;
874     }
875
876     /* SO_UPDATE_ACCEPT_CONTEXT is required for shutdown() to work */
877     if (setsockopt(context->accept_socket, SOL_SOCKET,
878                    SO_UPDATE_ACCEPT_CONTEXT, (char *)&nsd,
879                    sizeof(nsd))) {
880         ap_log_error(APLOG_MARK, APLOG_ERR, apr_get_netos_error(), server_conf,
881                      "setsockopt(SO_UPDATE_ACCEPT_CONTEXT) failed.");
882         /* Not a failure condition. Keep running. */
883     }
884
885     apr_create_pool(&context->ptrans, _pconf);
886     context->conn_io = ap_bcreate(context->ptrans, B_RDWR);
887     context->recv_buf = context->conn_io->inbase;
888     context->recv_buf_size = context->conn_io->bufsiz - 2*PADDED_ADDR_SIZE;
889
890
891     /* AcceptEx on the completion context. The completion context will be signaled
892      * when a connection is accepted. */
893     if (!AcceptEx(nsd, context->accept_socket,
894                   context->recv_buf, 
895                   0, //context->recv_buf_size,
896                   PADDED_ADDR_SIZE, PADDED_ADDR_SIZE,
897                   &BytesRead,
898                   (LPOVERLAPPED) context)) {
899         lasterror = apr_get_netos_error();
900         if (lasterror != APR_FROM_OS_ERROR(ERROR_IO_PENDING)) {
901             ap_log_error(APLOG_MARK,APLOG_ERR, lasterror, server_conf,
902                          "create_acceptex_context: AcceptEx failed. Process will exit.");
903             return -1;
904         }
905
906     }
907     lr->count++;
908
909     return 0;
910 }
911 static apr_inline apr_status_t reset_acceptex_context(PCOMP_CONTEXT context) 
912 {
913     DWORD BytesRead;
914     SOCKET nsd;
915     int rc, i;
916
917     /* reset the buffer pools */
918     apr_clear_pool(context->ptrans);
919     context->sock = NULL;
920     context->conn_io = ap_bcreate(context->ptrans, B_RDWR);
921     context->recv_buf = context->conn_io->inbase;
922     context->recv_buf_size = context->conn_io->bufsiz - 2*PADDED_ADDR_SIZE;
923
924     /* recreate and initialize the accept socket if it is not being reused */
925     apr_get_os_sock(&nsd, context->lr->sd);
926
927     /* AcceptEx on the completion context. The completion context will be signaled
928      * when a connection is accepted. Hack Alert: TransmitFile, under certain 
929      * circumstances, can 'recycle' accept sockets, saving the overhead of calling 
930      * socket(). Occasionally this fails (usually when the client closes his end 
931      * of the connection early). When this occurs, AcceptEx will fail with 10022, 
932      * Invalid Parameter. When this occurs, just open a fresh accept socket and 
933      * retry the call.
934      */
935     for (i=0; i<2; i++) {
936         if (context->accept_socket == INVALID_SOCKET) {
937             context->accept_socket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
938             if (context->accept_socket == INVALID_SOCKET) {
939                 rc = apr_get_netos_error();
940                 ap_log_error(APLOG_MARK,APLOG_ERR, rc, server_conf,
941                              "reset_acceptex_context: socket() failed. Process will exit.");
942                 return rc;
943             }
944
945             /* SO_UPDATE_ACCEPT_CONTEXT is required for shutdown() to work */
946             if (setsockopt(context->accept_socket, SOL_SOCKET,
947                            SO_UPDATE_ACCEPT_CONTEXT, (char *)&nsd, sizeof(nsd))) {
948                 ap_log_error(APLOG_MARK, APLOG_WARNING, apr_get_netos_error(),
949                              server_conf,
950                              "setsockopt(SO_UPDATE_ACCEPT_CONTEXT) failed.");
951             }
952         }
953
954         if (!AcceptEx(nsd, context->accept_socket, context->recv_buf, 0,
955                       PADDED_ADDR_SIZE, PADDED_ADDR_SIZE, &BytesRead, 
956                       (LPOVERLAPPED) context)) {
957             rc = apr_get_netos_error();
958             if (rc != APR_FROM_OS_ERROR(ERROR_IO_PENDING)) {
959                 ap_log_error(APLOG_MARK, APLOG_INFO, rc, server_conf,
960                              "reset_acceptex_context: AcceptEx failed for "
961                              "listening socket: %d and accept socket: %d", 
962                              nsd, context->accept_socket);
963                 closesocket(context->accept_socket);
964                 context->accept_socket = INVALID_SOCKET;
965                 continue;
966             }
967         }
968         break;
969     }
970
971     context->lr->count++;
972
973     return APR_SUCCESS;
974 }
975 static PCOMP_CONTEXT winnt_get_connection(PCOMP_CONTEXT context)
976 {
977     int requests_this_child = 0;
978     int rc;
979     LPOVERLAPPED pol;
980     DWORD CompKey;
981     DWORD BytesRead;
982
983
984     if (context != NULL) {
985         if (shutdown_in_progress) {
986             /* Clean-up the AcceptEx completion context */
987             CloseHandle(context->Overlapped.hEvent);
988             if (context->accept_socket != INVALID_SOCKET)
989                 closesocket(context->accept_socket);
990         }
991         else {
992             /* Prepare the completion context for reuse */
993             if ((rc = reset_acceptex_context(context)) != APR_SUCCESS) {
994                 ap_log_error(APLOG_MARK, APLOG_CRIT, rc, server_conf,
995                              "Child %d: winnt_get_connection: reset_acceptex_context failed.",
996                              my_pid); 
997                 if (context->accept_socket != INVALID_SOCKET)
998                     closesocket(context->accept_socket);
999                 CloseHandle(context->Overlapped.hEvent);
1000                 /* Probably should just die now... */
1001             }
1002         }
1003     }
1004
1005     /* May need to atomize the workers_may_exit check with the 
1006      * g_blocked_threads++ */
1007     if (workers_may_exit) {
1008         return NULL;
1009     }
1010     g_blocked_threads++;
1011         
1012     while (1) {
1013         rc = GetQueuedCompletionStatus(AcceptExCompPort, &BytesRead, &CompKey,
1014                                        &pol, INFINITE);
1015         if (!rc) {
1016             rc = apr_get_os_error();
1017             if (rc != APR_FROM_OS_ERROR(ERROR_OPERATION_ABORTED)) {
1018                 /* Is this a deadly condition? 
1019                  * We sometimes get ERROR_NETNAME_DELETED when a client
1020                  * disconnects when attempting to reuse sockets. Not sure why 
1021                  * we see this now and not during AcceptEx(). Reset the
1022                  * AcceptEx context and continue...
1023                  */
1024                 ap_log_error(APLOG_MARK,APLOG_INFO, rc, server_conf,
1025                              "Child %d: - GetQueuedCompletionStatus() failed", 
1026                              my_pid);
1027                 /* Reset the completion context */
1028                 if (pol) {
1029                     context = (PCOMP_CONTEXT) pol;
1030                     if (context->accept_socket != INVALID_SOCKET)
1031                         closesocket(context->accept_socket);
1032                     if ((rc = reset_acceptex_context(context)) != APR_SUCCESS) {
1033                         ap_log_error(APLOG_MARK, APLOG_CRIT, rc, server_conf,
1034                                      "Child %d: winnt_get_connection: reset_acceptex_context failed.",
1035                                      my_pid); 
1036                         if (context->accept_socket != INVALID_SOCKET)
1037                             closesocket(context->accept_socket);
1038                         CloseHandle(context->Overlapped.hEvent);
1039                         /* Probably should just die now... */
1040                     }
1041                 }
1042             }
1043             else {
1044                 /* Sometimes we catch ERROR_OPERATION_ABORTED completion packets
1045                  * from the old child process (during a restart). Ignore them.
1046                  */
1047                 ap_log_error(APLOG_MARK,APLOG_INFO, rc, server_conf,
1048                              "Child %d: - Draining ERROR_OPERATION_ABORTED packet off "
1049                              "the completion port.", my_pid);
1050             }
1051             continue;
1052         }
1053
1054         if (CompKey != 0) {
1055             /* CompKey == my_pid means this thread was unblocked by
1056              * the shutdown code (not by io completion).
1057              */
1058             if (CompKey == my_pid) {
1059                 g_blocked_threads--;
1060                 return NULL;
1061             }
1062             /* Sometimes we catch shutdown io completion packets
1063              * posted by the old child process (during a restart). Ignore them.
1064              */
1065             continue;
1066         }
1067
1068         context = (PCOMP_CONTEXT) pol;
1069         break;
1070     }
1071
1072     g_blocked_threads--;
1073
1074     /* Check to see if we need to create more completion contexts,
1075      * but only if we are not in the process of shutting down
1076      */
1077     if (!shutdown_in_progress) {
1078         apr_lock(allowed_globals.jobmutex);
1079         context->lr->count--;
1080         if (context->lr->count < 2) {
1081             SetEvent(maintenance_event);
1082         }
1083         apr_unlock(allowed_globals.jobmutex);
1084     }
1085
1086     /* Received a connection */
1087     context->conn_io->incnt = BytesRead;
1088     GetAcceptExSockaddrs(context->recv_buf, 
1089                          0, //context->recv_buf_size,
1090                          PADDED_ADDR_SIZE,
1091                          PADDED_ADDR_SIZE,
1092                          &context->sa_server,
1093                          &context->sa_server_len,
1094                          &context->sa_client,
1095                          &context->sa_client_len);
1096
1097     return context;
1098
1099 }
1100 /*
1101  * worker_main() - this is the main loop for the worker threads
1102  *
1103  * Windows 95/98
1104  * Each thread runs within this function. They wait within remove_job()
1105  * for a job to become available, then handle all the requests on that
1106  * connection until it is closed, then return to remove_job().
1107  *
1108  * The worker thread will exit when it removes a job which contains
1109  * socket number -1. This provides a graceful thread exit, since
1110  * it will never exit during a connection.
1111  *
1112  * This code in this function is basically equivalent to the child_main()
1113  * from the multi-process (Unix) environment, except that we
1114  *
1115  *  - do not call child_init_modules (child init API phase)
1116  *  - block in remove_job, and when unblocked we have an already
1117  *    accepted socket, instead of blocking on a mutex or select().
1118  */
1119
1120 static void worker_main(int child_num)
1121 {
1122     PCOMP_CONTEXT context = NULL;
1123
1124     while (1) {
1125         conn_rec *c;
1126         apr_int32_t disconnected;
1127
1128         /* Grab a connection off the network */
1129         if (osver.dwPlatformId == VER_PLATFORM_WIN32_WINDOWS) {
1130             context = win9x_get_connection(context);
1131         }
1132         else {
1133             context = winnt_get_connection(context);
1134         }
1135
1136         if (!context)
1137             break;
1138         sock_disable_nagle(context->accept_socket);
1139         apr_put_os_sock(&context->sock, &context->accept_socket, context->ptrans);
1140
1141         c = ap_new_connection(context->ptrans, server_conf, context->sock,
1142                               (struct sockaddr_in *) context->sa_client,
1143                               (struct sockaddr_in *) context->sa_server,
1144                               child_num);
1145
1146         ap_process_connection(c);
1147
1148
1149         apr_getsocketopt(context->sock, APR_SO_DISCONNECTED, &disconnected);
1150         if (disconnected) {
1151             /* I have no idea if we should do anything here, so I leave this
1152              * for a windows guy
1153              */
1154             /* Kill the clean-up registered by the iol. We want to leave 
1155              * the accept socket open because we are about to try to 
1156              * reuse it
1157              */
1158         }
1159         else {
1160             context->accept_socket = INVALID_SOCKET;
1161             ap_lingering_close(c);
1162         }
1163     }
1164
1165     ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, server_conf,
1166                  "Child %d: Thread exiting.", my_pid);
1167 #if 0
1168
1169     SetEvent(exit_event);
1170 #endif
1171     /* TODO: Add code to clean-up completion contexts here */
1172 }
1173
1174 static void cleanup_thread(thread **handles, int *thread_cnt, int thread_to_clean)
1175 {
1176     int i;
1177
1178     CloseHandle(handles[thread_to_clean]);
1179     for (i = thread_to_clean; i < ((*thread_cnt) - 1); i++)
1180         handles[i] = handles[i + 1];
1181     (*thread_cnt)--;
1182 }
1183
1184 static void create_listeners() 
1185 {
1186 #define NUM_LISTENERS 5
1187     ap_listen_rec *lr;
1188     for (lr = ap_listeners; lr != NULL; lr = lr->next) {
1189         while (lr->count < NUM_LISTENERS) {
1190             if (create_acceptex_context(pconf, lr) == -1) {
1191                 ap_log_error(APLOG_MARK,APLOG_ERR, apr_get_os_error(), server_conf,
1192                              "Unable to create an AcceptEx completion context -- process will exit");
1193                 signal_parent(0);       /* tell parent to die */
1194             }
1195         }
1196     }
1197 }
1198 /*
1199  * child_main() runs the main control thread for the child process. 
1200  *
1201  * The control thread:
1202  * - sets up the worker thread pool
1203  * - starts the accept thread (Win 9x)
1204  * - creates AcceptEx contexts (Win NT)
1205  * - waits for exit_event, maintenance_event or maintenance timeout
1206  *   and does the right thing depending on which event is received.
1207  */
1208 static void child_main()
1209 {
1210     apr_status_t status;
1211     HANDLE child_events[2];
1212     char* exit_event_name;
1213     int nthreads = ap_threads_per_child;
1214     int tid;
1215     thread **child_handles;
1216     int rv;
1217     time_t end_time;
1218     int i;
1219     int cld;
1220     apr_pool_t *pchild;
1221
1222
1223     /* This is the child process or we are running in single process
1224      * mode.
1225      */
1226     exit_event_name = apr_psprintf(pconf, "apC%d", my_pid);
1227     setup_signal_names(apr_psprintf(pconf,"ap%d", parent_pid));
1228
1229     if (one_process) {
1230         /* Single process mode */
1231         apr_create_lock(&start_mutex,APR_MUTEX, APR_CROSS_PROCESS,signal_name_prefix,pconf);
1232         exit_event = CreateEvent(NULL, TRUE, FALSE, exit_event_name);
1233
1234         setup_listeners(server_conf);
1235         bind_listeners_to_completion_port();
1236     }
1237     else {
1238         /* Child process mode */
1239         apr_child_init_lock(&start_mutex, signal_name_prefix, pconf);
1240         exit_event = OpenEvent(EVENT_ALL_ACCESS, FALSE, exit_event_name);
1241         ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, server_conf,
1242                      "Child %d: exit_event_name = %s", my_pid, exit_event_name);
1243
1244         setup_inherited_listeners(server_conf);
1245     }
1246
1247     /* Initialize the child_events */
1248     maintenance_event = CreateEvent(NULL, TRUE, FALSE, NULL);
1249     child_events[0] = exit_event;
1250     child_events[1] = maintenance_event;
1251
1252     ap_assert(start_mutex);
1253     ap_assert(exit_event);
1254     ap_assert(maintenance_event);
1255
1256     apr_create_pool(&pchild, pconf);
1257     allowed_globals.jobsemaphore = create_semaphore(0);
1258     apr_create_lock(&allowed_globals.jobmutex, APR_MUTEX, APR_INTRAPROCESS, NULL, pchild);
1259
1260     /*
1261      * Wait until we have permission to start accepting connections.
1262      * start_mutex is used to ensure that only one child ever
1263      * goes into the listen/accept loop at once.
1264      */
1265     status = apr_lock(start_mutex);
1266     if (status != APR_SUCCESS) {
1267         ap_log_error(APLOG_MARK,APLOG_ERR, status, server_conf,
1268                      "Child %d: Failed to acquire the start_mutex. Process will exit.", my_pid);
1269         signal_parent(0);       /* tell parent to die */
1270         exit(0);
1271     }
1272     ap_log_error(APLOG_MARK,APLOG_INFO, APR_SUCCESS, server_conf, 
1273                  "Child %d: Acquired the start mutex.", my_pid);
1274
1275     /* Create the worker thread pool */
1276     ap_log_error(APLOG_MARK,APLOG_INFO, APR_SUCCESS, server_conf, 
1277                  "Child %d: Starting %d worker threads.", my_pid, nthreads);
1278     child_handles = (thread *) alloca(nthreads * sizeof(int));
1279     for (i = 0; i < nthreads; i++) {
1280         child_handles[i] = (thread *) _beginthreadex(NULL, 0, (LPTHREAD_START_ROUTINE) worker_main,
1281                                                      NULL, 0, &tid);
1282     }
1283
1284     /* Begin accepting connections */
1285     if (osver.dwPlatformId == VER_PLATFORM_WIN32_WINDOWS) {
1286         /* Win95/98: Start the accept thread */
1287         _beginthreadex(NULL, 0, (LPTHREAD_START_ROUTINE) accept_and_queue_connections,
1288                        (void *) i, 0, &tid);
1289     } else {
1290         /* Windows NT/2000: Create AcceptEx completion contexts */
1291         create_listeners();
1292     }
1293
1294     /* Wait for one of three events:
1295      * exit_event: 
1296      *    The exit_event is signaled by the parent process to notify 
1297      *    the child that it is time to exit.
1298      *
1299      * maintenance_event: 
1300      *    This event is signaled by the worker thread pool to direct 
1301      *    this thread to create more completion contexts.
1302      *
1303      * TIMEOUT:
1304      *    To do periodic maintenance on the server (check for thread exits,
1305      *    number of completion contexts, etc.)
1306      */
1307     while (1) {
1308         rv = WaitForMultipleObjects(2, (HANDLE *) child_events, FALSE, INFINITE);
1309         cld = rv - WAIT_OBJECT_0;
1310         if (rv == WAIT_FAILED) {
1311             /* Something serious is wrong */
1312             ap_log_error(APLOG_MARK, APLOG_CRIT, apr_get_os_error(), server_conf,
1313                          "Child %d: WAIT_FAILED -- shutting down server");
1314             break;
1315         }
1316         else if (rv == WAIT_TIMEOUT) {
1317             /* Hey, this cannot happen */
1318             ap_log_error(APLOG_MARK, APLOG_CRIT, APR_SUCCESS, server_conf,
1319                          "Child %d: WAIT_TIMEOUT -- shutting down server", my_pid);
1320             break;
1321         }
1322         else if (cld == 0) {
1323             /* Exit event was signaled */
1324             ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, server_conf,
1325                          "Child %d: Exit event signaled. Child process is ending.", my_pid);
1326             break;
1327         }
1328         else {
1329             /* Child maintenance event signaled */
1330             if (osver.dwPlatformId != VER_PLATFORM_WIN32_WINDOWS) {
1331                 create_listeners();
1332             }
1333             ResetEvent(maintenance_event);
1334             ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, server_conf,
1335                          "Child %d: Child maintenance event signaled.", my_pid);
1336         }
1337     }
1338
1339     /* Setting is_graceful will close keep-alive connections */
1340     is_graceful = 1;
1341
1342     /* Shutdown the worker threads */
1343     if (osver.dwPlatformId == VER_PLATFORM_WIN32_WINDOWS) {
1344         /* workers_may_exit = 1; Not used on Win9x */
1345         shutdown_in_progress = 1;
1346         for (i = 0; i < nthreads; i++) {
1347             add_job(-1);
1348         }
1349     }
1350     else { /* Windows NT/2000 */
1351         SOCKET nsd;
1352         ap_listen_rec *lr;
1353         /*
1354          * Setting shutdown_in_progress prevents new AcceptEx completion 
1355          * contexts from being queued to the port but allows threads to 
1356          * continue consuming from the port. This gives the server a 
1357          * chance to handle any accepted connections.
1358          */
1359         shutdown_in_progress = 1;
1360         Sleep(1000);
1361         
1362         /* Setting workers_may_exit prevents threads from consumimg from the 
1363          * completion port (especially threads that unblock off of keep-alive
1364          * connections later on).
1365          */
1366         workers_may_exit = 1;
1367
1368         /* Unblock threads blocked on the completion port */
1369         apr_lock(allowed_globals.jobmutex);
1370         while (g_blocked_threads > 0) {
1371             ap_log_error(APLOG_MARK,APLOG_INFO, APR_SUCCESS, server_conf, 
1372                          "Child %d: %d threads blocked on the completion port", my_pid, g_blocked_threads);
1373             for (i=g_blocked_threads; i > 0; i--) {
1374                 PostQueuedCompletionStatus(AcceptExCompPort, 0, my_pid, NULL);
1375             }
1376             Sleep(1000);
1377         }
1378         apr_unlock(allowed_globals.jobmutex);
1379
1380         /* Cancel any remaining pending AcceptEx completion contexts */
1381         for (lr = ap_listeners; lr != NULL; lr = lr->next) {
1382             apr_get_os_sock(&nsd,lr->sd);
1383             CancelIo((HANDLE) nsd);
1384         }
1385
1386         /* Drain the canceled contexts off the port */
1387         drain_acceptex_complport(AcceptExCompPort, TRUE);
1388     }
1389
1390     /* Release the start_mutex to let the new process (in the restart
1391      * scenario) a chance to begin servicing requests 
1392      */
1393     ap_log_error(APLOG_MARK,APLOG_INFO, APR_SUCCESS, server_conf, 
1394                  "Child %d: Releasing the start mutex", my_pid);
1395     apr_unlock(start_mutex);
1396
1397     /* Give busy worker threads a chance to service their connections.
1398      * Kill them off if they take too long
1399      */
1400     ap_log_error(APLOG_MARK,APLOG_INFO, APR_SUCCESS, server_conf, 
1401                  "Child %d: Waiting for %d threads to die.", my_pid, nthreads);
1402     end_time = time(NULL) + 180;
1403     while (nthreads) {
1404         rv = wait_for_many_objects(nthreads, child_handles, end_time - time(NULL));
1405         if (rv != WAIT_TIMEOUT) {
1406             rv = rv - WAIT_OBJECT_0;
1407             ap_assert((rv >= 0) && (rv < nthreads));
1408             cleanup_thread(child_handles, &nthreads, rv);
1409             continue;
1410         }
1411         break;
1412     }
1413     for (i = 0; i < nthreads; i++) {
1414         TerminateThread(child_handles[i], 1);
1415         CloseHandle(child_handles[i]);
1416     }
1417     ap_log_error(APLOG_MARK,APLOG_INFO, APR_SUCCESS, server_conf, 
1418                  "Child %d: All worker threads have ended.", my_pid);
1419
1420     CloseHandle(AcceptExCompPort);
1421     destroy_semaphore(allowed_globals.jobsemaphore);
1422     apr_destroy_lock(allowed_globals.jobmutex);
1423
1424     apr_destroy_pool(pchild);
1425     CloseHandle(exit_event);
1426 }
1427
1428 /*
1429  * Spawn a child Apache process. The child process has the command line arguments from
1430  * argc and argv[], plus a -Z argument giving the name of an event. The child should
1431  * open and poll or wait on this event. When it is signalled, the child should die.
1432  * prefix is a prefix string for the event name.
1433  * 
1434  * The child_num argument on entry contains a serial number for this child (used to create
1435  * a unique event name). On exit, this number will have been incremented by one, ready
1436  * for the next call. 
1437  *
1438  * On exit, the value pointed to be *ev will contain the event created
1439  * to signal the new child process.
1440  *
1441  * The return value is the handle to the child process if successful, else -1. If -1 is
1442  * returned the error will already have been logged by ap_log_error().
1443  */
1444
1445 /**********************************************************************
1446  * master_main - this is the parent (main) process. We create a
1447  * child process to do the work, then sit around waiting for either
1448  * the child to exit, or a restart or exit signal. If the child dies,
1449  * we just respawn a new one. If we have a shutdown or graceful restart,
1450  * tell the child to die when it is ready. If it is a non-graceful
1451  * restart, force the child to die immediately.
1452  **********************************************************************/
1453
1454 #define MAX_PROCESSES 50 /* must be < MAX_WAIT_OBJECTS-1 */
1455
1456 static void cleanup_process(HANDLE *handles, HANDLE *events, int position, int *processes)
1457 {
1458     int i;
1459     int handle = 0;
1460
1461     CloseHandle(handles[position]);
1462     CloseHandle(events[position]);
1463
1464     handle = (int)handles[position];
1465
1466     for (i = position; i < (*processes)-1; i++) {
1467         handles[i] = handles[i + 1];
1468         events[i] = events[i + 1];
1469     }
1470     (*processes)--;
1471 }
1472
1473 static int create_process(apr_pool_t *p, HANDLE *handles, HANDLE *events, int *processes)
1474 {
1475     int rv;
1476     char buf[1024];
1477     char *pCommand;
1478     char *pEnvVar;
1479     char *pEnvBlock;
1480     int i;
1481     int iEnvBlockLen;
1482     STARTUPINFO si;           /* Filled in prior to call to CreateProcess */
1483     PROCESS_INFORMATION pi;   /* filled in on call to CreateProcess */
1484
1485     ap_listen_rec *lr;
1486     DWORD BytesWritten;
1487     HANDLE hPipeRead = NULL;
1488     HANDLE hPipeWrite = NULL;
1489     SECURITY_ATTRIBUTES sa = {0};  
1490
1491     HANDLE kill_event;
1492     LPWSAPROTOCOL_INFO  lpWSAProtocolInfo;
1493     HANDLE hDupedCompPort;
1494
1495     sa.nLength = sizeof(sa);
1496     sa.bInheritHandle = TRUE;
1497     sa.lpSecurityDescriptor = NULL;
1498
1499     /* Build the command line. Should look something like this:
1500      * C:/apache/bin/apache.exe -f ap_server_confname 
1501      * First, get the path to the executable...
1502      */
1503     rv = GetModuleFileName(NULL, buf, sizeof(buf));
1504     if (rv == sizeof(buf)) {
1505         ap_log_error(APLOG_MARK, APLOG_CRIT, ERROR_BAD_PATHNAME, server_conf,
1506                      "Parent: Path to Apache process too long");
1507         return -1;
1508     } else if (rv == 0) {
1509         ap_log_error(APLOG_MARK, APLOG_CRIT, apr_get_os_error(), server_conf,
1510                      "Parent: GetModuleFileName() returned NULL for current process.");
1511         return -1;
1512     }
1513
1514     /* Build the command line */
1515     pCommand = apr_psprintf(p, "\"%s\"", buf);  
1516     for (i = 1; i < server_conf->process->argc; i++) {
1517         pCommand = apr_pstrcat(p, pCommand, " \"", server_conf->process->argv[i], "\"", NULL);
1518     }
1519
1520     /* Build the environment, since Win9x disrespects the active env */
1521     pEnvVar = apr_psprintf(p, "AP_PARENT_PID=%i", parent_pid);
1522     /*
1523      * Win32's CreateProcess call requires that the environment
1524      * be passed in an environment block, a null terminated block of
1525      * null terminated strings.
1526      */  
1527     i = 0;
1528     iEnvBlockLen = 1;
1529     while (_environ[i]) {
1530         iEnvBlockLen += strlen(_environ[i]) + 1;
1531         i++;
1532     }
1533
1534     pEnvBlock = (char *)apr_pcalloc(p, iEnvBlockLen + strlen(pEnvVar) + 1);
1535     strcpy(pEnvBlock, pEnvVar);
1536     pEnvVar = strchr(pEnvBlock, '\0') + 1;
1537
1538     i = 0;
1539     while (_environ[i]) {
1540         strcpy(pEnvVar, _environ[i]);
1541         pEnvVar = strchr(pEnvVar, '\0') + 1;
1542         i++;
1543     }
1544     pEnvVar = '\0';
1545     /* Create a pipe to send socket info to the child */
1546     if (!CreatePipe(&hPipeRead, &hPipeWrite, &sa, 0)) {
1547         ap_log_error(APLOG_MARK, APLOG_CRIT, apr_get_os_error(), server_conf,
1548                      "Parent: Unable to create pipe to child process.");
1549         return -1;
1550     }
1551
1552     /* Give the read end of the pipe (hPipeRead) to the child as stdin. The 
1553      * parent will write the socket data to the child on this pipe.
1554      */
1555     memset(&si, 0, sizeof(si));
1556     memset(&pi, 0, sizeof(pi));
1557     si.cb = sizeof(si);
1558     si.dwFlags     = STARTF_USESHOWWINDOW | STARTF_USESTDHANDLES;
1559     si.wShowWindow = SW_HIDE;
1560     si.hStdInput   = hPipeRead;
1561
1562     if (!CreateProcess(NULL, pCommand, NULL, NULL, 
1563                        TRUE,               /* Inherit handles */
1564                        CREATE_SUSPENDED,   /* Creation flags */
1565                        pEnvBlock,          /* Environment block */
1566                        NULL,
1567                        &si, &pi)) {
1568         ap_log_error(APLOG_MARK, APLOG_CRIT, apr_get_os_error(), server_conf,
1569                      "Parent: Not able to create the child process.");
1570         /*
1571          * We must close the handles to the new process and its main thread
1572          * to prevent handle and memory leaks.
1573          */ 
1574         CloseHandle(pi.hProcess);
1575         CloseHandle(pi.hThread);
1576         return -1;
1577     }
1578     
1579     ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, server_conf,
1580                  "Parent: Created child process %d", pi.dwProcessId);
1581
1582     SetEnvironmentVariable("AP_PARENT_PID",NULL);
1583
1584     /* Create the exit_event, apCchild_pid */
1585     sa.nLength = sizeof(sa);
1586     sa.bInheritHandle = TRUE;
1587     sa.lpSecurityDescriptor = NULL;        
1588     kill_event = CreateEvent(&sa, TRUE, FALSE, apr_psprintf(pconf,"apC%d", pi.dwProcessId));
1589     if (!kill_event) {
1590         ap_log_error(APLOG_MARK, APLOG_CRIT, apr_get_os_error(), server_conf,
1591                      "Parent: Could not create exit event for child process");
1592         CloseHandle(pi.hProcess);
1593         CloseHandle(pi.hThread);
1594         return -1;
1595     }
1596     
1597     /* Assume the child process lives. Update the process and event tables */
1598     handles[*processes] = pi.hProcess;
1599     events[*processes] = kill_event;
1600     (*processes)++;
1601
1602     /* We never store the thread's handle, so close it now. */
1603     ResumeThread(pi.hThread);
1604     CloseHandle(pi.hThread);
1605  
1606     /* Run the chain of open sockets. For each socket, duplicate it 
1607      * for the target process then send the WSAPROTOCOL_INFO 
1608      * (returned by dup socket) to the child */
1609     for (lr = ap_listeners; lr; lr = lr->next) {
1610         int nsd;
1611         lpWSAProtocolInfo = apr_pcalloc(p, sizeof(WSAPROTOCOL_INFO));
1612         apr_get_os_sock(&nsd,lr->sd);
1613         ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, server_conf,
1614                      "Parent: Duplicating socket %d and sending it to child process %d", nsd, pi.dwProcessId);
1615         if (WSADuplicateSocket(nsd, pi.dwProcessId,
1616                                lpWSAProtocolInfo) == SOCKET_ERROR) {
1617             ap_log_error(APLOG_MARK, APLOG_CRIT, apr_get_netos_error(), server_conf,
1618                          "Parent: WSADuplicateSocket failed for socket %d.", lr->sd );
1619             return -1;
1620         }
1621
1622         if (!WriteFile(hPipeWrite, lpWSAProtocolInfo, (DWORD) sizeof(WSAPROTOCOL_INFO),
1623                        &BytesWritten,
1624                        (LPOVERLAPPED) NULL)) {
1625             ap_log_error(APLOG_MARK, APLOG_CRIT, apr_get_os_error(), server_conf,
1626                          "Parent: Unable to write duplicated socket %d to the child.", lr->sd );
1627             return -1;
1628         }
1629         ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, APR_SUCCESS, server_conf,
1630                      "Parent: BytesWritten = %d WSAProtocolInfo = %x20", BytesWritten, *lpWSAProtocolInfo);
1631     }
1632     if (osver.dwPlatformId != VER_PLATFORM_WIN32_WINDOWS) {
1633         /* Now, send the AcceptEx completion port to the child */
1634         if (!DuplicateHandle(GetCurrentProcess(), AcceptExCompPort, 
1635                              pi.hProcess, &hDupedCompPort,  0,
1636                              TRUE, DUPLICATE_SAME_ACCESS)) {
1637             ap_log_error(APLOG_MARK, APLOG_CRIT, apr_get_os_error(), server_conf,
1638                          "Parent: Unable to duplicate AcceptEx completion port. Shutting down.");
1639             return -1;
1640         }
1641
1642         WriteFile(hPipeWrite, &hDupedCompPort, (DWORD) sizeof(hDupedCompPort), &BytesWritten, (LPOVERLAPPED) NULL);
1643     }
1644     
1645     CloseHandle(hPipeRead);
1646     CloseHandle(hPipeWrite);        
1647
1648     return 0;
1649 }
1650
1651 static int master_main(server_rec *s, HANDLE shutdown_event, HANDLE restart_event)
1652 {
1653     int remaining_children_to_start = ap_daemons_to_start;
1654     int i;
1655     int rv, cld;
1656     int child_num = 0;
1657     int restart_pending = 0;
1658     int shutdown_pending = 0;
1659     int current_live_processes = 0; /* number of child process we know about */
1660
1661     HANDLE process_handles[MAX_PROCESSES];
1662     HANDLE process_kill_events[MAX_PROCESSES];
1663
1664     setup_listeners(s);
1665     bind_listeners_to_completion_port();
1666
1667     /* Create child process 
1668      * Should only be one in this version of Apache for WIN32 
1669      */
1670     while (remaining_children_to_start--) {
1671         if (create_process(pconf, process_handles, process_kill_events, 
1672                            &current_live_processes) < 0) {
1673             ap_log_error(APLOG_MARK, APLOG_CRIT, apr_get_os_error(), server_conf,
1674                          "master_main: create child process failed. Exiting.");
1675             shutdown_pending = 1;
1676             goto die_now;
1677         }
1678     }
1679     
1680     restart_pending = shutdown_pending = 0;
1681
1682     if (!strcasecmp(signal_arg, "runservice"))
1683         mpm_service_started();
1684
1685     /* Wait for shutdown or restart events or for child death */
1686     process_handles[current_live_processes] = shutdown_event;
1687     process_handles[current_live_processes+1] = restart_event;
1688
1689     rv = WaitForMultipleObjects(current_live_processes+2, (HANDLE *)process_handles, 
1690                                 FALSE, INFINITE);
1691     cld = rv - WAIT_OBJECT_0;
1692     if (rv == WAIT_FAILED) {
1693         /* Something serious is wrong */
1694         ap_log_error(APLOG_MARK,APLOG_CRIT, apr_get_os_error(), server_conf,
1695                      "master_main: WaitForMultipeObjects WAIT_FAILED -- doing server shutdown");
1696         shutdown_pending = 1;
1697     }
1698     else if (rv == WAIT_TIMEOUT) {
1699         /* Hey, this cannot happen */
1700         ap_log_error(APLOG_MARK, APLOG_ERR, apr_get_os_error(), s,
1701                      "master_main: WaitForMultipeObjects with INFINITE wait exited with WAIT_TIMEOUT");
1702         shutdown_pending = 1;
1703     }
1704     else if (cld == current_live_processes) {
1705         /* shutdown_event signalled */
1706         shutdown_pending = 1;
1707         printf("shutdown event signaled\n");
1708         ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, APR_SUCCESS, s, 
1709                      "master_main: Shutdown event signaled -- doing server shutdown.");
1710         if (ResetEvent(shutdown_event) == 0) {
1711             ap_log_error(APLOG_MARK, APLOG_ERR, apr_get_os_error(), s,
1712                          "ResetEvent(shutdown_event)");
1713         }
1714
1715     }
1716     else if (cld == current_live_processes+1) {
1717         /* restart_event signalled */
1718         int children_to_kill = current_live_processes;
1719         restart_pending = 1;
1720         ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, s, 
1721                      "master_main: Restart event signaled. Doing a graceful restart.");
1722         if (ResetEvent(restart_event) == 0) {
1723             ap_log_error(APLOG_MARK, APLOG_ERR, apr_get_os_error(), s,
1724                          "master_main: ResetEvent(restart_event) failed.");
1725         }
1726         /* Signal each child process to die 
1727          * We are making a big assumption here that the child process, once signaled,
1728          * will REALLY go away. Since this is a restart, we do not want to hold the 
1729          * new child process up waiting for the old child to die. Remove the old 
1730          * child out of the process_handles apr_table_t and hope for the best...
1731          */
1732         for (i = 0; i < children_to_kill; i++) {
1733             if (SetEvent(process_kill_events[i]) == 0)
1734                 ap_log_error(APLOG_MARK, APLOG_ERR, apr_get_os_error(), s,
1735                              "master_main: SetEvent for child process in slot #%d failed", i);
1736             cleanup_process(process_handles, process_kill_events, i, &current_live_processes);
1737         }
1738     } 
1739     else {
1740         /* A child process must have exited because of a fatal error condition (seg fault, etc.). 
1741          * Remove the dead process 
1742          * from the process_handles and process_kill_events apr_table_t and create a new
1743          * child process.
1744          * TODO: Consider restarting the child immediately without looping through http_main
1745          * and without rereading the configuration. Will need this if we ever support multiple 
1746          * children. One option, create a parent thread which waits on child death and restarts it.
1747          * Consider, however, that if the user makes httpd.conf invalid, we want to die before
1748          * our child tries it... otherwise we have a nasty loop.
1749          */
1750         restart_pending = 1;
1751         ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, APR_SUCCESS, server_conf, 
1752                      "master_main: Child process failed. Restarting the child process.");
1753         ap_assert(cld < current_live_processes);
1754         cleanup_process(process_handles, process_kill_events, cld, &current_live_processes);
1755         /* APD2("main_process: child in slot %d died", rv); */
1756         /* restart_child(process_hancles, process_kill_events, cld, &current_live_processes); */
1757
1758         /* Drain the AcceptEx completion port of any outstanding I/O pending for the dead 
1759          * process. */
1760         drain_acceptex_complport(AcceptExCompPort, FALSE);
1761     }
1762
1763 die_now:
1764     if (shutdown_pending) 
1765     {
1766         int tmstart = time(NULL);
1767         
1768         if (strcasecmp(signal_arg, "runservice")) {
1769             mpm_service_stopping();
1770         }
1771         /* Signal each child processes to die */
1772         for (i = 0; i < current_live_processes; i++) {
1773             printf("SetEvent handle = %d\n", process_kill_events[i]);
1774             if (SetEvent(process_kill_events[i]) == 0)
1775                 ap_log_error(APLOG_MARK,APLOG_ERR, apr_get_os_error(), server_conf,
1776                              "master_main: SetEvent for child process in slot #%d failed", i);
1777         }
1778
1779         while (current_live_processes && ((tmstart+60) > time(NULL))) {
1780             rv = WaitForMultipleObjects(current_live_processes, (HANDLE *)process_handles, FALSE, 2000);
1781             if (rv == WAIT_TIMEOUT)
1782                 continue;
1783             ap_assert(rv != WAIT_FAILED);
1784             cld = rv - WAIT_OBJECT_0;
1785             ap_assert(rv < current_live_processes);
1786             cleanup_process(process_handles, process_kill_events, cld, &current_live_processes);
1787         }
1788         for (i = 0; i < current_live_processes; i++) {
1789             ap_log_error(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO, APR_SUCCESS, server_conf,
1790                          "forcing termination of child #%d (handle %d)", i, process_handles[i]);
1791             TerminateProcess((HANDLE) process_handles[i], 1);
1792         }
1793         return 0;  /* Tell the caller we do not want to restart */
1794     }
1795
1796     return 1;      /* Tell the caller we want a restart */
1797 }
1798
1799
1800 #define SERVICE_UNNAMED -1
1801
1802 /* service_nt_main_fn needs to append the StartService() args 
1803  * outside of our call stack and thread as the service starts...
1804  */
1805 apr_array_header_t *mpm_new_argv;
1806
1807 /* Remember service_to_start failures to log and fail in pre_config.
1808  * Remember inst_argc and inst_argv for installing or starting the
1809  * service after we preflight the config.
1810  */
1811
1812 static apr_status_t service_to_start_success;
1813 static int inst_argc;
1814 static char **inst_argv;
1815     
1816 void winnt_rewrite_args(process_rec *process) 
1817 {
1818     /* Handle the following SCM aspects in this phase:
1819      *
1820      *   -k runservice [transition for WinNT, nothing for Win9x]
1821      *   -k (!)install [error out if name is not installed]
1822      *
1823      * We can't leave this phase until we know our identity
1824      * and modify the command arguments appropriately.
1825      */
1826     apr_status_t service_named = SERVICE_UNNAMED;
1827     apr_status_t rv;
1828     char *def_server_root;
1829     char fnbuf[MAX_PATH];
1830     char optbuf[3];
1831     const char *optarg;
1832     const char **new_arg;
1833     int fixed_args;
1834     char *pid;
1835     apr_getopt_t *opt;
1836
1837     osver.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
1838     GetVersionEx(&osver);
1839
1840     /* AP_PARENT_PID is only valid in the child */
1841     pid = getenv("AP_PARENT_PID");
1842     if (pid) 
1843     {
1844         /* This is the child */
1845         parent_pid = (DWORD) atol(pid);
1846         my_pid = GetCurrentProcessId();
1847
1848         /* The parent is responsible for providing the
1849          * COMPLETE ARGUMENTS REQUIRED to the child.
1850          *
1851          * No further argument parsing is needed, but
1852          * for good measure we will provide a simple
1853          * signal string for later testing.
1854          */
1855         signal_arg = "runchild";
1856         return;
1857     }
1858     
1859     /* This is the parent, we have a long way to go :-) */
1860     parent_pid = my_pid = GetCurrentProcessId();
1861     
1862     /* Rewrite process->argv[]; 
1863      *
1864      * strip out -k signal into signal_arg
1865      * strip out -n servicename into service_name & display_name
1866      * add default -d serverroot from the path of this executable
1867      * 
1868      * The end result will look like:
1869      *
1870      * The invocation command (%0)
1871      *     The -d serverroot default from the running executable
1872      *         The requested service's (-n) registry ConfigArgs
1873      *             The WinNT SCM's StartService() args
1874      */
1875
1876     if (!GetModuleFileName(NULL, fnbuf, sizeof(fnbuf))) {
1877         /* WARNING: There is an implict assumption here that the
1878          * executable resides in the ServerRoot!
1879          */
1880         rv = apr_get_os_error();
1881         ap_log_error(APLOG_MARK,APLOG_ERR, rv, NULL, 
1882                      "Failed to get the running module's file name");
1883         exit(1);
1884     }
1885     def_server_root = (char *) apr_filename_of_pathname(fnbuf);
1886     if (def_server_root > fnbuf) {
1887         *(def_server_root - 1) = '\0';
1888         def_server_root = ap_os_canonical_filename(process->pool, fnbuf);
1889     }
1890
1891     /* Use process->pool so that the rewritten argv
1892      * lasts for the lifetime of the server process,
1893      * because pconf will be destroyed after the 
1894      * initial pre-flight of the config parser.
1895      */
1896
1897     mpm_new_argv = apr_make_array(process->pool, process->argc + 2, sizeof(char *));
1898     new_arg = (char**) apr_push_array(mpm_new_argv);
1899     *new_arg = (char *) process->argv[0];
1900     
1901     new_arg = (char**) apr_push_array(mpm_new_argv);
1902     *new_arg = "-d";
1903     new_arg = (char**) apr_push_array(mpm_new_argv);
1904     *new_arg = def_server_root;
1905
1906     fixed_args = mpm_new_argv->nelts;
1907
1908     optbuf[0] = '-'; optbuf[2] = '\0';
1909     apr_initopt(&opt, process->pool, process->argc, (char**) process->argv);
1910     while (apr_getopt(opt, "n:k:iu" AP_SERVER_BASEARGS, 
1911                       optbuf + 1, &optarg) == APR_SUCCESS) {
1912         switch (optbuf[1]) {
1913         case 'n':
1914             service_named = mpm_service_set_name(process->pool, optarg);
1915             break;
1916         case 'k':
1917             signal_arg = optarg;
1918             break;
1919         case 'i':
1920             /* TODO: warn of depreciated syntax, "use -k install instead" */
1921             signal_arg = "install";
1922             break;
1923         case 'u':
1924             /* TODO: warn of depreciated syntax, "use -k uninstall instead" */
1925             signal_arg = "uninstall";
1926             break;
1927         case 'X':
1928             one_process = -1;
1929             break;
1930         default:
1931             new_arg = (char**) apr_push_array(mpm_new_argv);
1932             *new_arg = apr_pstrdup(process->pool, optbuf);
1933             if (optarg) {
1934                 new_arg = (char**) apr_push_array(mpm_new_argv);
1935                 *new_arg = optarg;
1936             }
1937             break;
1938         }
1939     }
1940     
1941     /* Track the number of args actually entered by the user */
1942     inst_argc = mpm_new_argv->nelts - fixed_args;
1943
1944     /* Provide a default 'run' -k arg to simplify signal_arg tests */
1945     if (!signal_arg)
1946         signal_arg = "run";
1947
1948     if (!strcasecmp(signal_arg, "runservice")) 
1949     {
1950         /* Start the NT Service _NOW_ because the WinNT SCM is 
1951          * expecting us to rapidly assume control of our own 
1952          * process, the SCM will tell us our service name, and
1953          * may have extra StartService() command arguments to
1954          * add for us.
1955          *
1956          * Any other process has a console, so we don't to begin
1957          * a Win9x service until the configuration is parsed and
1958          * any command line errors are reported.
1959          *
1960          * We hold the return value so that we can die in pre_config
1961          * after logging begins, and the failure can land in the log.
1962          */
1963         if (osver.dwPlatformId == VER_PLATFORM_WIN32_NT) {
1964             service_to_start_success = mpm_service_to_start();
1965             if (service_to_start_success == APR_SUCCESS)
1966                 service_named = APR_SUCCESS;
1967         }
1968     }
1969
1970     if (service_named == SERVICE_UNNAMED) {
1971         service_named = mpm_service_set_name(process->pool, 
1972                                              DEFAULT_SERVICE_NAME);
1973     }
1974
1975     if (!strcasecmp(signal_arg, "install")) /* -k install */
1976     {
1977         if (service_named == APR_SUCCESS) 
1978         {
1979             ap_log_error(APLOG_MARK,APLOG_ERR, 0, NULL,
1980                  "%s: Service is already installed.", display_name);
1981             exit(1);
1982         }
1983     }
1984     else
1985     {
1986         if (service_named == APR_SUCCESS) 
1987         {
1988             rv = mpm_merge_service_args(process->pool, mpm_new_argv, 
1989                                         fixed_args);
1990             if (rv != APR_SUCCESS) {
1991                 ap_log_error(APLOG_MARK,APLOG_ERR, rv, NULL,
1992                              "%s: ConfigArgs are missing from the registry.",
1993                              display_name);
1994             }
1995         }
1996         else
1997         {
1998             ap_log_error(APLOG_MARK,APLOG_ERR, 0, NULL,
1999                  "%s: No installed service by that name.", display_name);
2000             exit(1);
2001         }
2002     }
2003     
2004     /* Track the args actually entered by the user.
2005      * These will be used for the -k install parameters, as well as
2006      * for the -k start service override arguments.
2007      */
2008     inst_argv = (char**) mpm_new_argv->elts + mpm_new_argv->nelts - inst_argc;
2009
2010     process->argc = mpm_new_argv->nelts; 
2011     process->argv = (char**) mpm_new_argv->elts;
2012 }
2013
2014
2015 static void winnt_pre_config(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp) 
2016 {
2017     /* Handle the following SCM aspects in this phase:
2018      *
2019      *   -k runservice [WinNT errors logged from rewrite_args]
2020      *   -k uninstall
2021      *   -k stop
2022      *
2023      * in these cases we -don't- care if httpd.conf has config errors!
2024      */
2025     apr_status_t rv;
2026
2027     if (getenv("ONE_PROCESS"))
2028         one_process = -1;
2029
2030     if (ap_exists_config_define("ONE_PROCESS"))
2031         one_process = -1;
2032
2033     if (!strcasecmp(signal_arg, "runservice")
2034             && (osver.dwPlatformId == VER_PLATFORM_WIN32_NT)
2035             && (service_to_start_success != APR_SUCCESS)) {
2036         ap_log_error(APLOG_MARK,APLOG_ERR, service_to_start_success, NULL, 
2037                      "%s: Unable to start the service manager.",
2038                      display_name);
2039         exit(1);
2040     }
2041
2042     if (!strcasecmp(signal_arg, "uninstall")) {
2043         rv = mpm_service_uninstall();
2044         exit(rv);
2045     }
2046
2047     if (!strcasecmp(signal_arg, "stop")) {
2048         mpm_signal_service(ptemp, 0);
2049         exit(0);
2050     }
2051
2052     ap_listen_pre_config();
2053     ap_daemons_to_start = DEFAULT_NUM_DAEMON;
2054     ap_threads_per_child = DEFAULT_START_THREAD;
2055     ap_pid_fname = DEFAULT_PIDLOG;
2056     max_requests_per_child = DEFAULT_MAX_REQUESTS_PER_CHILD;
2057
2058     apr_cpystrn(ap_coredump_dir, ap_server_root, sizeof(ap_coredump_dir));
2059 }
2060
2061 static void winnt_post_config(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec* server)
2062 {
2063     static int restart_num = 0;
2064     apr_status_t rv = 0;
2065
2066     server_conf = server;
2067     
2068     /* Handle the following SCM aspects in this phase:
2069      *
2070      *   -k install
2071      *   -k start
2072      *   -k restart
2073      *   -k runservice [Win95, only once - after we parsed the config]
2074      *
2075      * because all of these signals are useful _only_ if there
2076      * is a valid conf\httpd.conf environment to start.
2077      *
2078      * We reached this phase by avoiding errors that would cause
2079      * these options to fail unexpectedly in another process.
2080      */
2081
2082     if (!strcasecmp(signal_arg, "install")) {
2083         rv = mpm_service_install(ptemp, inst_argc, inst_argv);
2084         exit (rv);
2085     }
2086
2087     if (!strcasecmp(signal_arg, "start")) {
2088         rv = mpm_service_start(ptemp, inst_argc, inst_argv);
2089         exit (rv);
2090     }
2091
2092     if (!strcasecmp(signal_arg, "restart")) {
2093         mpm_signal_service(ptemp, 1);
2094         exit (rv);
2095     }
2096
2097     if (parent_pid == my_pid) 
2098     {
2099         if (restart_num++ == 1) 
2100         {
2101             /* This code should be run once in the parent and not run
2102              * across a restart
2103              */
2104             PSECURITY_ATTRIBUTES sa = GetNullACL();  /* returns NULL if invalid (Win95?) */
2105             setup_signal_names(apr_psprintf(pconf,"ap%d", parent_pid));
2106             if (osver.dwPlatformId != VER_PLATFORM_WIN32_WINDOWS) {
2107                 /* Create the AcceptEx IoCompletionPort once in the parent.
2108                  * The completion port persists across restarts. 
2109                  */
2110                 AcceptExCompPort = CreateIoCompletionPort(INVALID_HANDLE_VALUE,
2111                                                           NULL,
2112                                                           0,
2113                                                           0); /* CONCURRENT ACTIVE THREADS */
2114                 if (AcceptExCompPort == NULL) {
2115                     ap_log_error(APLOG_MARK,APLOG_ERR, apr_get_os_error(), server_conf,
2116                                  "Parent: Unable to create the AcceptExCompletionPort -- process will exit");
2117                     exit(1);
2118                 }
2119             }
2120
2121             ap_log_pid(pconf, ap_pid_fname);
2122             
2123             /* Create shutdown event, apPID_shutdown, where PID is the parent 
2124              * Apache process ID. Shutdown is signaled by 'apache -k shutdown'.
2125              */
2126             shutdown_event = CreateEvent(sa, FALSE, FALSE, signal_shutdown_name);
2127             if (!shutdown_event) {
2128                 ap_log_error(APLOG_MARK, APLOG_EMERG, apr_get_os_error(), server_conf,
2129                              "Parent: Cannot create shutdown event %s", signal_shutdown_name);
2130                 CleanNullACL((void *)sa);
2131                 exit(1);
2132             }
2133
2134             /* Create restart event, apPID_restart, where PID is the parent 
2135              * Apache process ID. Restart is signaled by 'apache -k restart'.
2136              */
2137             restart_event = CreateEvent(sa, FALSE, FALSE, signal_restart_name);
2138             if (!restart_event) {
2139                 CloseHandle(shutdown_event);
2140                 ap_log_error(APLOG_MARK, APLOG_EMERG, apr_get_os_error(), server_conf,
2141                              "Parent: Cannot create restart event %s", signal_restart_name);
2142                 CleanNullACL((void *)sa);
2143                 exit(1);
2144             }
2145             CleanNullACL((void *)sa);
2146
2147             /* Now that we are flying at 15000 feet... 
2148              * wipe out the Win95 service console,
2149              * signal the SCM the WinNT service started, or
2150              * if not a service, setup console handlers instead.
2151              */
2152             if (!strcasecmp(signal_arg, "runservice"))
2153             {
2154                 if (osver.dwPlatformId != VER_PLATFORM_WIN32_NT) 
2155                 {
2156                     rv = mpm_service_to_start();
2157                     if (rv != APR_SUCCESS) {
2158                         ap_log_error(APLOG_MARK,APLOG_ERR, rv, server_conf,
2159                                      "%s: Unable to start the service manager.",
2160                                      display_name);
2161                         exit(1);
2162                     }            
2163                 }
2164             }
2165             else /* ! -k runservice */
2166             {
2167                 mpm_start_console_handler();
2168             }
2169
2170             /* Create the start mutex, apPID, where PID is the parent Apache process ID.
2171              * Ths start mutex is used during a restart to prevent more than one 
2172              * child process from entering the accept loop at once.
2173              */
2174             apr_create_lock(&start_mutex,APR_MUTEX, APR_CROSS_PROCESS, signal_name_prefix,
2175                                server_conf->process->pool);
2176         }
2177     }
2178     else /* parent_pid != my_pid */
2179     {
2180         mpm_start_child_console_handler();
2181     }
2182 }
2183
2184 AP_DECLARE(int) ap_mpm_run(apr_pool_t *_pconf, apr_pool_t *plog, server_rec *s )
2185 {
2186     static int restart = 0;            /* Default is "not a restart" */
2187
2188     pconf = _pconf;
2189     server_conf = s;
2190
2191     if ((parent_pid != my_pid) || one_process) {
2192         /* Running as Child process or in one_process (debug) mode */
2193         ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, server_conf,
2194                      "Child %d: Child process is running", my_pid);
2195         child_main();
2196         ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, server_conf,
2197                      "Child %d: Child process is exiting", my_pid);        
2198
2199         return 1;
2200     }  /* Child or single process */
2201     else { /* Parent process */
2202         restart = master_main(server_conf, shutdown_event, restart_event);
2203
2204         if (!restart) {
2205             /* Shutting down. Clean up... */
2206             const char *pidfile = ap_server_root_relative (pconf, ap_pid_fname);
2207
2208             if (pidfile != NULL && unlink(pidfile) == 0) {
2209                 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, APR_SUCCESS,
2210                              server_conf, "removed PID file %s (pid=%ld)",
2211                              pidfile, GetCurrentProcessId());
2212             }
2213             apr_destroy_lock(start_mutex);
2214
2215             CloseHandle(restart_event);
2216             CloseHandle(shutdown_event);
2217
2218             return 1;
2219         }
2220     }  /* Parent process */
2221
2222     return 0; /* Restart */
2223 }
2224
2225 static void winnt_hooks(void)
2226 {
2227     ap_hook_pre_config(winnt_pre_config, NULL, NULL, AP_HOOK_MIDDLE);
2228     ap_hook_post_config(winnt_post_config, NULL, NULL, 0);
2229 }
2230
2231 /* 
2232  * Command processors 
2233  */
2234 static const char *set_pidfile(cmd_parms *cmd, void *dummy, char *arg) 
2235 {
2236     const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
2237     if (err != NULL) {
2238         return err;
2239     }
2240
2241     if (cmd->server->is_virtual) {
2242         return "PidFile directive not allowed in <VirtualHost>";
2243     }
2244     ap_pid_fname = arg;
2245     return NULL;
2246 }
2247
2248 static const char *set_threads_per_child (cmd_parms *cmd, void *dummy, char *arg) 
2249 {
2250     const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
2251     if (err != NULL) {
2252         return err;
2253     }
2254
2255     ap_threads_per_child = atoi(arg);
2256     if (ap_threads_per_child > HARD_THREAD_LIMIT) {
2257         ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, 
2258                      "WARNING: ThreadsPerChild of %d exceeds compile time"
2259                      " limit of %d threads,", ap_threads_per_child, 
2260                      HARD_THREAD_LIMIT);
2261         ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
2262                      " lowering ThreadsPerChild to %d. To increase, please"
2263                      " see the  HARD_THREAD_LIMIT define in %s.", 
2264                      HARD_THREAD_LIMIT, AP_MPM_HARD_LIMITS_FILE);
2265         ap_threads_per_child = HARD_THREAD_LIMIT;
2266     }
2267     else if (ap_threads_per_child < 1) {
2268         ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, 
2269                      "WARNING: Require ThreadsPerChild > 0, setting to 1");
2270         ap_threads_per_child = 1;
2271     }
2272     return NULL;
2273 }
2274
2275
2276 static const char *set_max_requests(cmd_parms *cmd, void *dummy, char *arg) 
2277 {
2278     const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
2279     if (err != NULL) {
2280         return err;
2281     }
2282
2283     max_requests_per_child = atoi(arg);
2284
2285     return NULL;
2286 }
2287
2288 static const char *set_coredumpdir (cmd_parms *cmd, void *dummy, char *arg) 
2289 {
2290     apr_finfo_t finfo;
2291     const char *fname;
2292     const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
2293     if (err != NULL) {
2294         return err;
2295     }
2296
2297     fname = ap_server_root_relative(cmd->pool, arg);
2298     if ((apr_stat(&finfo, fname, cmd->pool) != APR_SUCCESS) || 
2299         (finfo.filetype != APR_DIR)) {
2300         return apr_pstrcat(cmd->pool, "CoreDumpDirectory ", fname, 
2301                           " does not exist or is not a directory", NULL);
2302     }
2303     apr_cpystrn(ap_coredump_dir, fname, sizeof(ap_coredump_dir));
2304     return NULL;
2305 }
2306
2307 /* Stub functions until this MPM supports the connection status API */
2308
2309 AP_DECLARE(void) ap_update_connection_status(long conn_id, const char *key, \
2310                                              const char *value)
2311 {
2312     /* NOP */
2313 }
2314
2315 AP_DECLARE(void) ap_reset_connection_status(long conn_id)
2316 {
2317     /* NOP */
2318 }
2319
2320 AP_DECLARE(apr_array_header_t *) ap_get_status_table(apr_pool_t *p)
2321 {
2322     /* NOP */
2323     return NULL;
2324 }
2325
2326 static const command_rec winnt_cmds[] = {
2327 LISTEN_COMMANDS
2328 { "PidFile", set_pidfile, NULL, RSRC_CONF, TAKE1,
2329     "A file for logging the server process ID"},
2330 { "ThreadsPerChild", set_threads_per_child, NULL, RSRC_CONF, TAKE1,
2331   "Number of threads each child creates" },
2332 { "MaxRequestsPerChild", set_max_requests, NULL, RSRC_CONF, TAKE1,
2333   "Maximum number of requests a particular child serves before dying." },
2334 { "CoreDumpDirectory", set_coredumpdir, NULL, RSRC_CONF, TAKE1,
2335   "The location of the directory Apache changes to before dumping core" },
2336 { NULL }
2337 };
2338
2339 AP_MODULE_DECLARE_DATA module mpm_winnt_module = {
2340     MPM20_MODULE_STUFF,
2341     winnt_rewrite_args,         /* hook to run before apache parses args */
2342     NULL,                       /* create per-directory config structure */
2343     NULL,                       /* merge per-directory config structures */
2344     NULL,                       /* create per-server config structure */
2345     NULL,                       /* merge per-server config structures */
2346     winnt_cmds,                 /* command apr_table_t */
2347     NULL,                       /* handlers */
2348     winnt_hooks                 /* register_hooks */
2349 };