]> granicus.if.org Git - apache/blob - include/mpm_common.h
*) include/httpd.h: Add a brigade for temporary uses in the core input filter context.
[apache] / include / mpm_common.h
1 /* Copyright 2000-2005 The Apache Software Foundation or its licensors, as
2  * applicable.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 /* The purpose of this file is to store the code that MOST mpm's will need
18  * this does not mean a function only goes into this file if every MPM needs
19  * it.  It means that if a function is needed by more than one MPM, and
20  * future maintenance would be served by making the code common, then the
21  * function belongs here.
22  *
23  * This is going in src/main because it is not platform specific, it is
24  * specific to multi-process servers, but NOT to Unix.  Which is why it
25  * does not belong in src/os/unix
26  */
27
28 #ifndef APACHE_MPM_COMMON_H
29 #define APACHE_MPM_COMMON_H
30
31 #include "ap_config.h"
32
33 #if APR_HAVE_NETINET_TCP_H
34 #include <netinet/tcp.h>    /* for TCP_NODELAY */
35 #endif
36
37 #include "mpm.h"
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 /**
44  * @package Multi-Processing Modules functions
45  */
46
47 /* The maximum length of the queue of pending connections, as defined
48  * by listen(2).  Under some systems, it should be increased if you
49  * are experiencing a heavy TCP SYN flood attack.
50  *
51  * It defaults to 511 instead of 512 because some systems store it 
52  * as an 8-bit datatype; 512 truncated to 8-bits is 0, while 511 is 
53  * 255 when truncated.
54  */
55 #ifndef DEFAULT_LISTENBACKLOG
56 #define DEFAULT_LISTENBACKLOG 511
57 #endif
58         
59 /**
60  * Make sure all child processes that have been spawned by the parent process
61  * have died.  This includes process registered as "other_children".
62  * @warning This is only defined if the MPM defines 
63  *          AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
64  * @param terminate Either 1 or 0.  If 1, send the child processes SIGTERM
65  *        each time through the loop.  If 0, give the process time to die
66  *        on its own before signalling it.
67  * @tip This function requires that some macros are defined by the MPM: <pre>
68  *  MPM_CHILD_PID -- Get the pid from the specified spot in the scoreboard
69  *  MPM_NOTE_CHILD_KILLED -- Note the child died in the scoreboard
70  * </pre>
71  * @tip The MPM child processes which are reclaimed are those listed
72  * in the scoreboard as well as those currently registered via
73  * ap_register_extra_mpm_process().
74  */
75 #ifdef AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
76 void ap_reclaim_child_processes(int terminate);
77 #endif
78
79 /**
80  * Tell ap_reclaim_child_processes() about an MPM child process which has no
81  * entry in the scoreboard.
82  * @warning This is only defined if the MPM defines
83  *          AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
84  * @param pid The process id of an MPM child process which should be
85  * reclaimed when ap_reclaim_child_processes() is called.
86  * @tip If an extra MPM child process terminates prior to calling
87  * ap_reclaim_child_processes(), remove it from the list of such processes
88  * by calling ap_unregister_extra_mpm_process().
89  */
90 #ifdef AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
91 void ap_register_extra_mpm_process(pid_t pid);
92 #endif
93
94 /**
95  * Unregister an MPM child process which was previously registered by a
96  * call to ap_register_extra_mpm_process().
97  * @warning This is only defined if the MPM defines
98  *          AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
99  * @param pid The process id of an MPM child process which no longer needs to
100  * be reclaimed.
101  * @return 1 if the process was found and removed, 0 otherwise
102  */
103 #ifdef AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
104 int ap_unregister_extra_mpm_process(pid_t pid);
105 #endif
106
107 /**
108  * Determine if any child process has died.  If no child process died, then
109  * this process sleeps for the amount of time specified by the MPM defined
110  * macro SCOREBOARD_MAINTENANCE_INTERVAL.
111  * @param status The return code if a process has died
112  * @param ret The process id of the process that died
113  * @param p The pool to allocate out of
114  */
115 #ifdef AP_MPM_WANT_WAIT_OR_TIMEOUT
116 void ap_wait_or_timeout(apr_exit_why_e *status, int *exitcode, apr_proc_t *ret, 
117                         apr_pool_t *p);
118 #endif
119
120 /**
121  * Log why a child died to the error log, if the child died without the
122  * parent signalling it.
123  * @param pid The child that has died
124  * @param status The status returned from ap_wait_or_timeout
125  * @return 0 on success, APEXIT_CHILDFATAL if MPM should terminate
126  */
127 #ifdef AP_MPM_WANT_PROCESS_CHILD_STATUS
128 int ap_process_child_status(apr_proc_t *pid, apr_exit_why_e why, int status);
129 #endif
130
131 #if defined(TCP_NODELAY) && !defined(MPE) && !defined(TPF)
132 /**
133  * Turn off the nagle algorithm for the specified socket.  The nagle algorithm
134  * says that we should delay sending partial packets in the hopes of getting
135  * more data.  There are bad interactions between persistent connections and
136  * Nagle's algorithm that have severe performance penalties.
137  * @param s The socket to disable nagle for.
138  */
139 void ap_sock_disable_nagle(apr_socket_t *s);
140 #else
141 #define ap_sock_disable_nagle(s)        /* NOOP */
142 #endif
143
144 #ifdef HAVE_GETPWNAM
145 /**
146  * Convert a username to a numeric ID
147  * @param name The name to convert
148  * @return The user id corresponding to a name
149  * @deffunc uid_t ap_uname2id(const char *name)
150  */
151 AP_DECLARE(uid_t) ap_uname2id(const char *name);
152 #endif
153
154 #ifdef HAVE_GETGRNAM
155 /**
156  * Convert a group name to a numeric ID
157  * @param name The name to convert
158  * @return The group id corresponding to a name
159  * @deffunc gid_t ap_gname2id(const char *name)
160  */
161 AP_DECLARE(gid_t) ap_gname2id(const char *name);
162 #endif
163
164 #define AP_MPM_HARD_LIMITS_FILE APACHE_MPM_DIR "/mpm_default.h"
165
166 #ifdef AP_MPM_USES_POD
167
168 typedef struct ap_pod_t ap_pod_t;
169
170 struct ap_pod_t {
171     apr_file_t *pod_in;
172     apr_file_t *pod_out;
173     apr_pool_t *p;
174 };
175
176 /**
177  * Open the pipe-of-death.  The pipe of death is used to tell all child
178  * processes that it is time to die gracefully.
179  * @param p The pool to use for allocating the pipe
180  */
181 AP_DECLARE(apr_status_t) ap_mpm_pod_open(apr_pool_t *p, ap_pod_t **pod);
182
183 /**
184  * Check the pipe to determine if the process has been signalled to die.
185  */
186 AP_DECLARE(apr_status_t) ap_mpm_pod_check(ap_pod_t *pod);
187
188 /**
189  * Close the pipe-of-death
190  */
191 AP_DECLARE(apr_status_t) ap_mpm_pod_close(ap_pod_t *pod);
192
193 /**
194  * Write data to the pipe-of-death, signalling that one child process
195  * should die.
196  * @param p The pool to use when allocating any required structures.
197  */
198 AP_DECLARE(apr_status_t) ap_mpm_pod_signal(ap_pod_t *pod);
199
200 /**
201  * Write data to the pipe-of-death, signalling that all child process
202  * should die.
203  * @param p The pool to use when allocating any required structures.
204  * @param num The number of child processes to kill
205  */
206 AP_DECLARE(void) ap_mpm_pod_killpg(ap_pod_t *pod, int num);
207 #endif
208
209 /*
210  * These data members are common to all mpms. Each new mpm
211  * should either use the appropriate ap_mpm_set_* function
212  * in their command table or create their own for custom or
213  * OS specific needs. These should work for most.
214  */
215
216 /**
217  * The maximum number of requests each child thread or
218  * process handles before dying off
219  */
220 #ifdef AP_MPM_WANT_SET_MAX_REQUESTS
221 extern int ap_max_requests_per_child;
222 const char *ap_mpm_set_max_requests(cmd_parms *cmd, void *dummy,
223                                     const char *arg);
224 #endif
225
226 /**
227  * The filename used to store the process id.
228  */
229 #ifdef AP_MPM_WANT_SET_PIDFILE
230 extern const char *ap_pid_fname;
231 const char *ap_mpm_set_pidfile(cmd_parms *cmd, void *dummy,
232                                const char *arg);
233 #endif
234
235 /**
236  * The name of lockfile used when Apache needs to lock the accept() call.
237  */
238 #ifdef AP_MPM_WANT_SET_LOCKFILE
239 extern const char *ap_lock_fname;
240 const char *ap_mpm_set_lockfile(cmd_parms *cmd, void *dummy,
241                                 const char *arg);
242 #endif
243
244 /**
245  * The system mutex implementation to use for the accept mutex.
246  */
247 #ifdef AP_MPM_WANT_SET_ACCEPT_LOCK_MECH
248 extern apr_lockmech_e ap_accept_lock_mech;
249 extern const char ap_valid_accept_mutex_string[];
250 const char *ap_mpm_set_accept_lock_mech(cmd_parms *cmd, void *dummy,
251                                         const char *arg);
252 #endif
253
254 /*
255  * Set the scorboard file.
256  */
257 #ifdef AP_MPM_WANT_SET_SCOREBOARD
258 const char *ap_mpm_set_scoreboard(cmd_parms *cmd, void *dummy,
259                                   const char *arg);
260 #endif
261
262 /*
263  * The directory that the server changes directory to dump core.
264  */
265 #ifdef AP_MPM_WANT_SET_COREDUMPDIR
266 extern char ap_coredump_dir[MAX_STRING_LEN];
267 extern int ap_coredumpdir_configured;
268 const char *ap_mpm_set_coredumpdir(cmd_parms *cmd, void *dummy,
269                                    const char *arg);
270 #endif
271
272 #ifdef AP_MPM_WANT_SIGNAL_SERVER
273 int ap_signal_server(int *, apr_pool_t *);
274 void ap_mpm_rewrite_args(process_rec *);
275 #endif
276
277 #ifdef AP_MPM_WANT_SET_MAX_MEM_FREE
278 extern apr_uint32_t ap_max_mem_free;
279 extern const char *ap_mpm_set_max_mem_free(cmd_parms *cmd, void *dummy,
280                                            const char *arg);
281 #endif
282
283 #ifdef AP_MPM_WANT_SET_STACKSIZE
284 extern apr_size_t ap_thread_stacksize;
285 extern const char *ap_mpm_set_thread_stacksize(cmd_parms *cmd, void *dummy,
286                                                const char *arg);
287 #endif
288
289 #ifdef AP_MPM_WANT_FATAL_SIGNAL_HANDLER
290 extern apr_status_t ap_fatal_signal_setup(server_rec *s, apr_pool_t *pconf);
291 extern apr_status_t ap_fatal_signal_child_setup(server_rec *s);
292 #endif
293
294 #if AP_ENABLE_EXCEPTION_HOOK
295 extern const char *ap_mpm_set_exception_hook(cmd_parms *cmd, void *dummy,
296                                              const char *arg);
297 #endif
298
299 #ifdef __cplusplus
300 }
301 #endif
302
303 #endif /* !APACHE_MPM_COMMON_H */