1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * http_log.c: Dealing with the logs and errors
25 #include "apr_general.h" /* for signal stuff */
26 #include "apr_strings.h"
27 #include "apr_errno.h"
28 #include "apr_thread_proc.h"
30 #include "apr_signal.h"
32 #define APR_WANT_STDIO
33 #define APR_WANT_STRFUNC
43 #include "ap_config.h"
45 #include "http_config.h"
46 #include "http_core.h"
48 #include "http_main.h"
49 #include "util_time.h"
58 APR_HOOK_LINK(error_log)
61 int AP_DECLARE_DATA ap_default_loglevel = DEFAULT_LOGLEVEL;
65 static const TRANS facilities[] = {
68 {"authpriv",LOG_AUTHPRIV},
74 {"daemon", LOG_DAEMON},
92 {"syslog", LOG_SYSLOG},
101 {"local0", LOG_LOCAL0},
104 {"local1", LOG_LOCAL1},
107 {"local2", LOG_LOCAL2},
110 {"local3", LOG_LOCAL3},
113 {"local4", LOG_LOCAL4},
116 {"local5", LOG_LOCAL5},
119 {"local6", LOG_LOCAL6},
122 {"local7", LOG_LOCAL7},
128 static const TRANS priorities[] = {
129 {"emerg", APLOG_EMERG},
130 {"alert", APLOG_ALERT},
131 {"crit", APLOG_CRIT},
132 {"error", APLOG_ERR},
133 {"warn", APLOG_WARNING},
134 {"notice", APLOG_NOTICE},
135 {"info", APLOG_INFO},
136 {"debug", APLOG_DEBUG},
140 static apr_pool_t *stderr_pool = NULL;
142 static apr_file_t *stderr_log = NULL;
144 /* track pipe handles to close in child process */
145 typedef struct read_handle_t {
146 struct read_handle_t *next;
150 static read_handle_t *read_handles;
153 * @brief The piped logging structure.
155 * Piped logs are used to move functionality out of the main server.
156 * For example, log rotation is done with piped logs.
159 /** The pool to use for the piped log */
161 /** The pipe between the server and the logging process */
162 apr_file_t *read_fd, *write_fd;
163 #ifdef AP_HAVE_RELIABLE_PIPED_LOGS
164 /** The name of the program the logging process is running */
166 /** The pid of the logging process */
168 /** How to reinvoke program when it must be replaced */
169 apr_cmdtype_e cmdtype;
173 AP_DECLARE(apr_file_t *) ap_piped_log_read_fd(piped_log *pl)
178 AP_DECLARE(apr_file_t *) ap_piped_log_write_fd(piped_log *pl)
183 /* clear_handle_list() is called when plog is cleared; at that
184 * point we need to forget about our old list of pipe read
185 * handles. We let the plog cleanups close the actual pipes.
187 static apr_status_t clear_handle_list(void *v)
193 /* remember to close this handle in the child process
195 * On Win32 this makes zero sense, because we don't
196 * take the parent process's child procs.
197 * If the win32 parent instead passed each and every
198 * logger write handle from itself down to the child,
199 * and the parent manages all aspects of keeping the
200 * reliable pipe log children alive, this would still
201 * make no sense :) Cripple it on Win32.
203 static void close_handle_in_child(apr_pool_t *p, apr_file_t *f)
206 read_handle_t *new_handle;
208 new_handle = apr_pcalloc(p, sizeof(read_handle_t));
209 new_handle->next = read_handles;
210 new_handle->handle = f;
211 read_handles = new_handle;
215 void ap_logs_child_init(apr_pool_t *p, server_rec *s)
217 read_handle_t *cur = read_handles;
220 apr_file_close(cur->handle);
225 AP_DECLARE(void) ap_open_stderr_log(apr_pool_t *p)
227 apr_file_open_stderr(&stderr_log, p);
230 AP_DECLARE(apr_status_t) ap_replace_stderr_log(apr_pool_t *p,
233 apr_file_t *stderr_file;
235 char *filename = ap_server_root_relative(p, fname);
237 ap_log_error(APLOG_MARK, APLOG_STARTUP|APLOG_CRIT,
238 APR_EBADPATH, NULL, "Invalid -E error log file %s",
242 if ((rc = apr_file_open(&stderr_file, filename,
243 APR_APPEND | APR_WRITE | APR_CREATE | APR_LARGEFILE,
244 APR_OS_DEFAULT, p)) != APR_SUCCESS) {
245 ap_log_error(APLOG_MARK, APLOG_STARTUP, rc, NULL,
246 "%s: could not open error log file %s.",
247 ap_server_argv0, fname);
251 /* This is safe provided we revert it when we are finished.
252 * We don't manager the callers pool!
256 if ((rc = apr_file_open_stderr(&stderr_log, stderr_pool))
258 apr_file_flush(stderr_log);
259 if ((rc = apr_file_dup2(stderr_log, stderr_file, stderr_pool))
261 apr_file_close(stderr_file);
263 * You might ponder why stderr_pool should survive?
264 * The trouble is, stderr_pool may have s_main->error_log,
265 * so we aren't in a position to destory stderr_pool until
266 * the next recycle. There's also an apparent bug which
267 * is not; if some folk decided to call this function before
268 * the core open error logs hook, this pool won't survive.
269 * Neither does the stderr logger, so this isn't a problem.
273 /* Revert, see above */
274 if (stderr_pool == p)
277 if (rc != APR_SUCCESS) {
278 ap_log_error(APLOG_MARK, APLOG_CRIT, rc, NULL,
279 "unable to replace stderr with error log file");
284 static void log_child_errfn(apr_pool_t *pool, apr_status_t err,
285 const char *description)
287 ap_log_error(APLOG_MARK, APLOG_ERR, err, NULL,
291 /* Create a child process running PROGNAME with a pipe connected to
292 * the childs stdin. The write-end of the pipe will be placed in
293 * *FPIN on successful return. If dummy_stderr is non-zero, the
294 * stderr for the child will be the same as the stdout of the parent.
295 * Otherwise the child will inherit the stderr from the parent. */
296 static int log_child(apr_pool_t *p, const char *progname,
297 apr_file_t **fpin, apr_cmdtype_e cmdtype,
300 /* Child process code for 'ErrorLog "|..."';
301 * may want a common framework for this, since I expect it will
302 * be common for other foo-loggers to want this sort of thing...
305 apr_procattr_t *procattr;
309 if (((rc = apr_procattr_create(&procattr, p)) == APR_SUCCESS)
310 && ((rc = apr_procattr_dir_set(procattr,
311 ap_server_root)) == APR_SUCCESS)
312 && ((rc = apr_procattr_cmdtype_set(procattr, cmdtype)) == APR_SUCCESS)
313 && ((rc = apr_procattr_io_set(procattr,
316 APR_NO_PIPE)) == APR_SUCCESS)
317 && ((rc = apr_procattr_error_check_set(procattr, 1)) == APR_SUCCESS)
318 && ((rc = apr_procattr_child_errfn_set(procattr, log_child_errfn))
323 apr_tokenize_to_argv(progname, &args, p);
324 pname = apr_pstrdup(p, args[0]);
325 procnew = (apr_proc_t *)apr_pcalloc(p, sizeof(*procnew));
328 if ((rc = apr_file_open_stdout(&errfile, p)) == APR_SUCCESS)
329 rc = apr_procattr_child_err_set(procattr, errfile, NULL);
332 rc = apr_proc_create(procnew, pname, (const char * const *)args,
335 if (rc == APR_SUCCESS) {
336 apr_pool_note_subprocess(p, procnew, APR_KILL_AFTER_TIMEOUT);
337 (*fpin) = procnew->in;
338 /* read handle to pipe not kept open, so no need to call
339 * close_handle_in_child()
347 /* Open the error log for the given server_rec. If IS_MAIN is
348 * non-zero, s is the main server. */
349 static int open_error_log(server_rec *s, int is_main, apr_pool_t *p)
354 if (*s->error_fname == '|') {
355 apr_file_t *dummy = NULL;
356 apr_cmdtype_e cmdtype = APR_PROGRAM_ENV;
357 fname = s->error_fname + 1;
359 /* In 2.4 favor PROGRAM_ENV, accept "||prog" syntax for compatibility
360 * and "|$cmd" to override the default.
361 * Any 2.2 backport would continue to favor SHELLCMD_ENV so there
362 * accept "||prog" to override, and "|$cmd" to ease conversion.
367 cmdtype = APR_SHELLCMD_ENV;
371 /* Spawn a new child logger. If this is the main server_rec,
372 * the new child must use a dummy stderr since the current
373 * stderr might be a pipe to the old logger. Otherwise, the
374 * child inherits the parents stderr. */
375 rc = log_child(p, fname, &dummy, cmdtype, is_main);
376 if (rc != APR_SUCCESS) {
377 ap_log_error(APLOG_MARK, APLOG_STARTUP, rc, NULL,
378 "Couldn't start ErrorLog process '%s'.",
383 s->error_log = dummy;
387 else if (!strncasecmp(s->error_fname, "syslog", 6)) {
388 if ((fname = strchr(s->error_fname, ':'))) {
392 for (fac = facilities; fac->t_name; fac++) {
393 if (!strcasecmp(fname, fac->t_name)) {
394 openlog(ap_server_argv0, LOG_NDELAY|LOG_CONS|LOG_PID,
402 openlog(ap_server_argv0, LOG_NDELAY|LOG_CONS|LOG_PID, LOG_LOCAL7);
409 fname = ap_server_root_relative(p, s->error_fname);
411 ap_log_error(APLOG_MARK, APLOG_STARTUP, APR_EBADPATH, NULL,
412 "%s: Invalid error log path %s.",
413 ap_server_argv0, s->error_fname);
416 if ((rc = apr_file_open(&s->error_log, fname,
417 APR_APPEND | APR_WRITE | APR_CREATE | APR_LARGEFILE,
418 APR_OS_DEFAULT, p)) != APR_SUCCESS) {
419 ap_log_error(APLOG_MARK, APLOG_STARTUP, rc, NULL,
420 "%s: could not open error log file %s.",
421 ap_server_argv0, fname);
429 int ap_open_logs(apr_pool_t *pconf, apr_pool_t *p /* plog */,
430 apr_pool_t *ptemp, server_rec *s_main)
432 apr_pool_t *stderr_p;
433 server_rec *virt, *q;
437 /* Register to throw away the read_handles list when we
438 * cleanup plog. Upon fork() for the apache children,
439 * this read_handles list is closed so only the parent
440 * can relaunch a lost log child. These read handles
441 * are always closed on exec.
442 * We won't care what happens to our stderr log child
443 * between log phases, so we don't mind losing stderr's
444 * read_handle a little bit early.
446 apr_pool_cleanup_register(p, NULL, clear_handle_list,
447 apr_pool_cleanup_null);
449 /* HERE we need a stdout log that outlives plog.
450 * We *presume* the parent of plog is a process
451 * or global pool which spans server restarts.
452 * Create our stderr_pool as a child of the plog's
455 apr_pool_create(&stderr_p, apr_pool_parent_get(p));
456 apr_pool_tag(stderr_p, "stderr_pool");
458 if (open_error_log(s_main, 1, stderr_p) != OK) {
463 if (s_main->error_log) {
466 /* Replace existing stderr with new log. */
467 apr_file_flush(s_main->error_log);
468 rv = apr_file_dup2(stderr_log, s_main->error_log, stderr_p);
469 if (rv != APR_SUCCESS) {
470 ap_log_error(APLOG_MARK, APLOG_CRIT, rv, s_main,
471 "unable to replace stderr with error_log");
474 /* We are done with stderr_pool, close it, killing
475 * the previous generation's stderr logger
478 apr_pool_destroy(stderr_pool);
479 stderr_pool = stderr_p;
482 * Now that we have dup'ed s_main->error_log to stderr_log
483 * close it and set s_main->error_log to stderr_log. This avoids
484 * this fd being inherited by the next piped logger who would
485 * keep open the writing end of the pipe that this one uses
486 * as stdin. This in turn would prevent the piped logger from
489 apr_file_close(s_main->error_log);
490 s_main->error_log = stderr_log;
493 /* note that stderr may still need to be replaced with something
494 * because it points to the old error log, or back to the tty
496 * XXX: This is BS - /dev/null is non-portable
497 * errno-as-apr_status_t is also non-portable
499 if (replace_stderr && freopen("/dev/null", "w", stderr) == NULL) {
500 ap_log_error(APLOG_MARK, APLOG_CRIT, errno, s_main,
501 "unable to replace stderr with /dev/null");
504 for (virt = s_main->next; virt; virt = virt->next) {
505 if (virt->error_fname) {
506 for (q=s_main; q != virt; q = q->next) {
507 if (q->error_fname != NULL
508 && strcmp(q->error_fname, virt->error_fname) == 0) {
514 if (open_error_log(virt, 0, p) != OK) {
519 virt->error_log = q->error_log;
523 virt->error_log = s_main->error_log;
529 AP_DECLARE(void) ap_error_log2stderr(server_rec *s) {
530 apr_file_t *errfile = NULL;
532 apr_file_open_stderr(&errfile, s->process->pool);
533 if (s->error_log != NULL) {
534 apr_file_dup2(s->error_log, errfile, s->process->pool);
538 static void log_error_core(const char *file, int line, int level,
539 apr_status_t status, const server_rec *s,
541 const request_rec *r, apr_pool_t *pool,
542 const char *fmt, va_list args)
544 char errstr[MAX_STRING_LEN];
545 #ifndef AP_UNSAFE_ERROR_LOG_UNESCAPED
546 char scratch[MAX_STRING_LEN];
548 apr_size_t len, errstrlen;
549 apr_file_t *logf = NULL;
551 int level_and_mask = level & APLOG_LEVELMASK;
553 if (r && r->connection) {
559 * If we are doing stderr logging (startup), don't log messages that are
560 * above the default server log level unless it is a startup/shutdown
564 if ((level_and_mask != APLOG_NOTICE)
565 && (level_and_mask > ap_default_loglevel)) {
572 else if (s->error_log) {
574 * If we are doing normal logging, don't log messages that are
575 * above the server log level unless it is a startup/shutdown notice
577 if ((level_and_mask != APLOG_NOTICE)
578 && (level_and_mask > s->loglevel)) {
586 * If we are doing syslog logging, don't log messages that are
587 * above the server log level (including a startup/shutdown notice)
589 if (level_and_mask > s->loglevel) {
594 if (logf && ((level & APLOG_STARTUP) != APLOG_STARTUP)) {
596 ap_recent_ctime(errstr + 1, apr_time_now());
597 errstr[1 + APR_CTIME_LEN - 1] = ']';
598 errstr[1 + APR_CTIME_LEN ] = ' ';
599 len = 1 + APR_CTIME_LEN + 1;
604 if ((level & APLOG_STARTUP) != APLOG_STARTUP) {
605 len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
606 "[%s] ", priorities[level_and_mask].t_name);
609 if (file && level_and_mask == APLOG_DEBUG) {
610 #if defined(_OSD_POSIX) || defined(WIN32) || defined(__MVS__)
612 char *e = strrchr(file, '/');
615 e = strrchr(file, '\\');
619 /* In OSD/POSIX, the compiler returns for __FILE__
620 * a string like: __FILE__="*POSIX(/usr/include/stdio.h)"
621 * (it even returns an absolute path for sources in
622 * the current directory). Here we try to strip this
623 * down to the basename.
625 if (e != NULL && e[1] != '\0') {
626 apr_snprintf(tmp, sizeof(tmp), "%s", &e[1]);
627 e = &tmp[strlen(tmp)-1];
633 #else /* _OSD_POSIX || WIN32 */
635 /* On Unix, __FILE__ may be an absolute path in a
637 if (file[0] == '/' && (p = ap_strrchr_c(file, '/')) != NULL) {
640 #endif /*_OSD_POSIX || WIN32 */
641 len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
642 "%s(%d): ", file, line);
646 /* XXX: TODO: add a method of selecting whether logged client
647 * addresses are in dotted quad or resolved form... dotted
648 * quad is the most secure, which is why I'm implementing it
651 len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
652 "[client %s] ", c->remote_ip);
655 if (status < APR_OS_START_EAIERR) {
656 len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
659 else if (status < APR_OS_START_SYSERR) {
660 len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
661 "(EAI %d)", status - APR_OS_START_EAIERR);
663 else if (status < 100000 + APR_OS_START_SYSERR) {
664 len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
665 "(OS %d)", status - APR_OS_START_SYSERR);
668 len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
669 "(os 0x%08x)", status - APR_OS_START_SYSERR);
671 apr_strerror(status, errstr + len, MAX_STRING_LEN - len);
672 len += strlen(errstr + len);
673 if (MAX_STRING_LEN - len > 2) {
681 #ifndef AP_UNSAFE_ERROR_LOG_UNESCAPED
682 if (apr_vsnprintf(scratch, MAX_STRING_LEN - len, fmt, args)) {
683 len += ap_escape_errorlog_item(errstr + len, scratch,
684 MAX_STRING_LEN - len);
687 len += apr_vsnprintf(errstr + len, MAX_STRING_LEN - len, fmt, args);
690 if ( r && (referer = apr_table_get(r->headers_in, "Referer"))
691 #ifndef AP_UNSAFE_ERROR_LOG_UNESCAPED
692 && ap_escape_errorlog_item(scratch, referer, MAX_STRING_LEN - len)
695 len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
697 #ifndef AP_UNSAFE_ERROR_LOG_UNESCAPED
705 /* NULL if we are logging to syslog */
707 /* Truncate for the terminator (as apr_snprintf does) */
708 if (len > MAX_STRING_LEN - sizeof(APR_EOL_STR)) {
709 len = MAX_STRING_LEN - sizeof(APR_EOL_STR);
711 strcpy(errstr + len, APR_EOL_STR);
712 apr_file_puts(errstr, logf);
713 apr_file_flush(logf);
717 syslog(level_and_mask, "%s", errstr);
721 ap_run_error_log(file, line, level, status, s, r, pool, errstr + errstrlen);
724 AP_DECLARE(void) ap_log_error(const char *file, int line, int level,
725 apr_status_t status, const server_rec *s,
726 const char *fmt, ...)
731 log_error_core(file, line, level, status, s, NULL, NULL, NULL, fmt, args);
735 AP_DECLARE(void) ap_log_perror(const char *file, int line, int level,
736 apr_status_t status, apr_pool_t *p,
737 const char *fmt, ...)
742 log_error_core(file, line, level, status, NULL, NULL, NULL, p, fmt, args);
746 AP_DECLARE(void) ap_log_rerror(const char *file, int line, int level,
747 apr_status_t status, const request_rec *r,
748 const char *fmt, ...)
753 log_error_core(file, line, level, status, r->server, NULL, r, NULL, fmt,
757 * IF APLOG_TOCLIENT is set,
758 * AND the error level is 'warning' or more severe,
759 * AND there isn't already error text associated with this request,
760 * THEN make the message text available to ErrorDocument and
761 * other error processors.
765 if ((level & APLOG_TOCLIENT)
766 && ((level & APLOG_LEVELMASK) <= APLOG_WARNING)
767 && (apr_table_get(r->notes, "error-notes") == NULL)) {
768 apr_table_setn(r->notes, "error-notes",
769 ap_escape_html(r->pool, apr_pvsprintf(r->pool, fmt,
775 AP_DECLARE(void) ap_log_cerror(const char *file, int line, int level,
776 apr_status_t status, const conn_rec *c,
777 const char *fmt, ...)
782 log_error_core(file, line, level, status, c->base_server, c, NULL, NULL,
787 AP_DECLARE(void) ap_log_pid(apr_pool_t *p, const char *filename)
789 apr_file_t *pid_file = NULL;
791 static pid_t saved_pid = -1;
800 fname = ap_server_root_relative(p, filename);
802 ap_log_error(APLOG_MARK, APLOG_STARTUP|APLOG_CRIT, APR_EBADPATH,
803 NULL, "Invalid PID file path %s, ignoring.", filename);
808 if (mypid != saved_pid
809 && apr_stat(&finfo, fname, APR_FINFO_MTIME, p) == APR_SUCCESS) {
810 /* AP_SIG_GRACEFUL and HUP call this on each restart.
811 * Only warn on first time through for this pid.
813 * XXX: Could just write first time through too, although
814 * that may screw up scripts written to do something
815 * based on the last modification time of the pid file.
817 ap_log_perror(APLOG_MARK, APLOG_WARNING, 0, p,
818 "pid file %s overwritten -- Unclean "
819 "shutdown of previous Apache run?",
823 if ((rv = apr_file_open(&pid_file, fname,
824 APR_WRITE | APR_CREATE | APR_TRUNCATE,
825 APR_UREAD | APR_UWRITE | APR_GREAD | APR_WREAD, p))
827 ap_log_error(APLOG_MARK, APLOG_ERR, rv, NULL,
828 "could not create %s", fname);
829 ap_log_error(APLOG_MARK, APLOG_ERR, 0, NULL,
830 "%s: could not log pid to file %s",
831 ap_server_argv0, fname);
834 apr_file_printf(pid_file, "%ld" APR_EOL_STR, (long)mypid);
835 apr_file_close(pid_file);
839 AP_DECLARE(apr_status_t) ap_read_pid(apr_pool_t *p, const char *filename,
842 const apr_size_t BUFFER_SIZE = sizeof(long) * 3 + 2; /* see apr_ltoa */
843 apr_file_t *pid_file = NULL;
847 apr_size_t bytes_read;
853 fname = ap_server_root_relative(p, filename);
855 ap_log_error(APLOG_MARK, APLOG_STARTUP|APLOG_CRIT, APR_EBADPATH,
856 NULL, "Invalid PID file path %s, ignoring.", filename);
860 rv = apr_file_open(&pid_file, fname, APR_READ, APR_OS_DEFAULT, p);
861 if (rv != APR_SUCCESS) {
865 buf = apr_palloc(p, BUFFER_SIZE);
867 rv = apr_file_read_full(pid_file, buf, BUFFER_SIZE - 1, &bytes_read);
868 if (rv != APR_SUCCESS && rv != APR_EOF) {
872 /* If we fill the buffer, we're probably reading a corrupt pid file.
873 * To be nice, let's also ensure the first char is a digit. */
874 if (bytes_read == 0 || bytes_read == BUFFER_SIZE - 1 || !apr_isdigit(*buf)) {
878 buf[bytes_read] = '\0';
879 *mypid = strtol(buf, &endptr, 10);
881 apr_file_close(pid_file);
885 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile,
888 char time_str[APR_CTIME_LEN];
890 apr_ctime(time_str, apr_time_now());
891 ap_log_error(APLOG_MARK, APLOG_CRIT, 0, NULL,
892 "[%s] file %s, line %d, assertion \"%s\" failed",
893 time_str, szFile, nLine, szExp);
897 /* unix assert does an abort leading to a core dump */
902 /* piped log support */
904 #ifdef AP_HAVE_RELIABLE_PIPED_LOGS
905 /* forward declaration */
906 static void piped_log_maintenance(int reason, void *data, apr_wait_t status);
908 /* Spawn the piped logger process pl->program. */
909 static apr_status_t piped_log_spawn(piped_log *pl)
911 apr_procattr_t *procattr;
912 apr_proc_t *procnew = NULL;
915 if (((status = apr_procattr_create(&procattr, pl->p)) != APR_SUCCESS) ||
916 ((status = apr_procattr_dir_set(procattr, ap_server_root))
918 ((status = apr_procattr_cmdtype_set(procattr, pl->cmdtype))
920 ((status = apr_procattr_child_in_set(procattr,
924 ((status = apr_procattr_child_errfn_set(procattr, log_child_errfn))
926 ((status = apr_procattr_error_check_set(procattr, 1)) != APR_SUCCESS)) {
928 /* Something bad happened, give up and go away. */
929 ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
930 "piped_log_spawn: unable to setup child process '%s': %s",
931 pl->program, apr_strerror(status, buf, sizeof(buf)));
937 apr_tokenize_to_argv(pl->program, &args, pl->p);
938 pname = apr_pstrdup(pl->p, args[0]);
939 procnew = apr_pcalloc(pl->p, sizeof(apr_proc_t));
940 status = apr_proc_create(procnew, pname, (const char * const *) args,
941 NULL, procattr, pl->p);
943 if (status == APR_SUCCESS) {
945 /* procnew->in was dup2'd from pl->write_fd;
946 * since the original fd is still valid, close the copy to
948 apr_file_close(procnew->in);
950 apr_proc_other_child_register(procnew, piped_log_maintenance, pl,
951 pl->write_fd, pl->p);
952 close_handle_in_child(pl->p, pl->read_fd);
956 /* Something bad happened, give up and go away. */
957 ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
958 "unable to start piped log program '%s': %s",
959 pl->program, apr_strerror(status, buf, sizeof(buf)));
967 static void piped_log_maintenance(int reason, void *data, apr_wait_t status)
969 piped_log *pl = data;
974 case APR_OC_REASON_DEATH:
975 case APR_OC_REASON_LOST:
976 pl->pid = NULL; /* in case we don't get it going again, this
977 * tells other logic not to try to kill it
979 apr_proc_other_child_unregister(pl);
980 stats = ap_mpm_query(AP_MPMQ_MPM_STATE, &mpm_state);
981 if (stats != APR_SUCCESS) {
982 ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
983 "can't query MPM state; not restarting "
984 "piped log program '%s'",
987 else if (mpm_state != AP_MPMQ_STOPPING) {
988 ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
989 "piped log program '%s' failed unexpectedly",
991 if ((stats = piped_log_spawn(pl)) != APR_SUCCESS) {
992 /* what can we do? This could be the error log we're having
993 * problems opening up... */
995 ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
996 "piped_log_maintenance: unable to respawn '%s': %s",
997 pl->program, apr_strerror(stats, buf, sizeof(buf)));
1002 case APR_OC_REASON_UNWRITABLE:
1003 /* We should not kill off the pipe here, since it may only be full.
1004 * If it really is locked, we should kill it off manually. */
1007 case APR_OC_REASON_RESTART:
1008 if (pl->pid != NULL) {
1009 apr_proc_kill(pl->pid, SIGTERM);
1014 case APR_OC_REASON_UNREGISTER:
1020 static apr_status_t piped_log_cleanup_for_exec(void *data)
1022 piped_log *pl = data;
1024 apr_file_close(pl->read_fd);
1025 apr_file_close(pl->write_fd);
1030 static apr_status_t piped_log_cleanup(void *data)
1032 piped_log *pl = data;
1034 if (pl->pid != NULL) {
1035 apr_proc_kill(pl->pid, SIGTERM);
1037 return piped_log_cleanup_for_exec(data);
1041 AP_DECLARE(piped_log *) ap_open_piped_log_ex(apr_pool_t *p,
1042 const char *program,
1043 apr_cmdtype_e cmdtype)
1047 pl = apr_palloc(p, sizeof (*pl));
1049 pl->program = apr_pstrdup(p, program);
1051 pl->cmdtype = cmdtype;
1052 if (apr_file_pipe_create_ex(&pl->read_fd,
1054 APR_FULL_BLOCK, p) != APR_SUCCESS) {
1057 apr_pool_cleanup_register(p, pl, piped_log_cleanup,
1058 piped_log_cleanup_for_exec);
1059 if (piped_log_spawn(pl) != APR_SUCCESS) {
1060 apr_pool_cleanup_kill(p, pl, piped_log_cleanup);
1061 apr_file_close(pl->read_fd);
1062 apr_file_close(pl->write_fd);
1068 #else /* !AP_HAVE_RELIABLE_PIPED_LOGS */
1070 static apr_status_t piped_log_cleanup(void *data)
1072 piped_log *pl = data;
1074 apr_file_close(pl->write_fd);
1078 AP_DECLARE(piped_log *) ap_open_piped_log_ex(apr_pool_t *p,
1079 const char *program,
1080 apr_cmdtype_e cmdtype)
1083 apr_file_t *dummy = NULL;
1086 rc = log_child(p, program, &dummy, cmdtype, 0);
1087 if (rc != APR_SUCCESS) {
1088 ap_log_error(APLOG_MARK, APLOG_STARTUP, rc, NULL,
1089 "Couldn't start piped log process '%s'.",
1090 (program == NULL) ? "NULL" : program);
1094 pl = apr_palloc(p, sizeof (*pl));
1097 pl->write_fd = dummy;
1098 apr_pool_cleanup_register(p, pl, piped_log_cleanup, piped_log_cleanup);
1105 AP_DECLARE(piped_log *) ap_open_piped_log(apr_pool_t *p,
1106 const char *program)
1108 apr_cmdtype_e cmdtype = APR_PROGRAM_ENV;
1110 /* In 2.4 favor PROGRAM_ENV, accept "||prog" syntax for compatibility
1111 * and "|$cmd" to override the default.
1112 * Any 2.2 backport would continue to favor SHELLCMD_ENV so there
1113 * accept "||prog" to override, and "|$cmd" to ease conversion.
1115 if (*program == '|')
1117 if (*program == '$') {
1118 cmdtype = APR_SHELLCMD_ENV;
1122 return ap_open_piped_log_ex(p, program, cmdtype);
1125 AP_DECLARE(void) ap_close_piped_log(piped_log *pl)
1127 apr_pool_cleanup_run(pl->p, pl, piped_log_cleanup);
1130 AP_IMPLEMENT_HOOK_VOID(error_log,
1131 (const char *file, int line, int level,
1132 apr_status_t status, const server_rec *s,
1133 const request_rec *r, apr_pool_t *pool,
1134 const char *errstr), (file, line, level,
1135 status, s, r, pool, errstr))