chiark / gitweb /
logfile: Log to stderr by default (`filename' key now optional)
[secnet.git] / log.c
diff --git a/log.c b/log.c
index 4aa12e753d47abaa8e5ef0a6979a13d275e15c6c..4043ab0c6a0b99fd4220c81b01f84e4d70b0babc 100644 (file)
--- a/log.c
+++ b/log.c
@@ -1,3 +1,21 @@
+/*
+ * This file is part of secnet.
+ * See README for full list of copyright holders.
+ *
+ * secnet is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * secnet is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * version 3 along with secnet; if not, see
+ * https://www.gnu.org/licenses/gpl.html.
+ */
 #include "secnet.h"
 #include <stdio.h>
 #include <string.h>
@@ -14,8 +32,7 @@ bool_t secnet_is_daemon=False;
 uint32_t message_level=M_WARNING|M_ERR|M_SECURITY|M_FATAL;
 struct log_if *system_log=NULL;
 
-static void vMessageFallback(uint32_t class, const char *message, va_list args)
-    FORMAT(printf,2,0);
+FORMAT(printf,2,0)
 static void vMessageFallback(uint32_t class, const char *message, va_list args)
 {
     FILE *dest=stdout;
@@ -28,6 +45,7 @@ static void vMessageFallback(uint32_t class, const char *message, va_list args)
     }
 }
 
+FORMAT(printf,2,0)
 static void vMessage(uint32_t class, const char *message, va_list args)
 {
 
@@ -48,8 +66,7 @@ void Message(uint32_t class, const char *message, ...)
     va_end(ap);
 }
 
-static void MessageFallback(uint32_t class, const char *message, ...)
-    FORMAT(printf,2,3);
+FORMAT(printf,2,3)
 static void MessageFallback(uint32_t class, const char *message, ...)
 {
     va_list ap;
@@ -62,6 +79,7 @@ static void MessageFallback(uint32_t class, const char *message, ...)
 static NORETURN(vfatal(int status, bool_t perror, const char *message,
                       va_list args));
 
+FORMAT(printf,3,0)
 static void vfatal(int status, bool_t perror, const char *message,
                   va_list args)
 {
@@ -175,6 +193,7 @@ struct loglist {
     struct loglist *next;
 };
 
+FORMAT(printf, 3, 0)
 static void log_vmulti(void *sst, int class, const char *message, va_list args)
 {
     struct loglist *st=sst, *i;
@@ -189,15 +208,58 @@ static void log_vmulti(void *sst, int class, const char *message, va_list args)
     }
 }
 
-static void log_multi(void *st, int priority, const char *message, ...)
-    FORMAT(printf,3,4);
-static void log_multi(void *st, int priority, const char *message, ...)
+FORMAT(printf, 6, 0)
+void lg_vperror(struct log_if *lg, const char *desc, struct cloc *loc,
+               int class, int errnoval, const char *fmt, va_list al)
 {
-    va_list ap;
+    int status=current_phase;
+    int esave=errno;
 
-    va_start(ap,message);
-    log_vmulti(st,priority,message,ap);
-    va_end(ap);
+    if (!lg)
+       lg=system_log;
+
+    if (class & M_FATAL)
+       enter_phase(PHASE_SHUTDOWN);
+
+    slilog_part(lg,class,"%s",desc);
+    if (loc)
+       slilog_part(lg,class," (%s:%d)",loc->file,loc->line);
+    slilog_part(lg,class,": ");
+    vslilog_part(lg,class,fmt,al);
+    if (errnoval)
+       slilog_part(lg,class,": %s",strerror(errnoval));
+    slilog_part(lg,class,"\n");
+
+    if (class & M_FATAL)
+       exit(status);
+
+    errno=esave;
+}
+
+void lg_perror(struct log_if *lg, const char *desc, struct cloc *loc,
+              int class, int errnoval, const char *fmt, ...)
+{
+    va_list al;
+    va_start(al,fmt);
+    lg_vperror(lg,desc,loc,class,errnoval,fmt,al);
+    va_end(al);
+}
+
+void lg_exitstatus(struct log_if *lg, const char *desc, struct cloc *loc,
+                  int class, int status, const char *progname)
+{
+    if (!status)
+       lg_perror(lg,desc,loc,class,0,"%s exited",progname);
+    else if (WIFEXITED(status))
+       lg_perror(lg,desc,loc,class,0,"%s exited with error exit status %d",
+                 progname,WEXITSTATUS(status));
+    else if (WIFSIGNALED(status))
+       lg_perror(lg,desc,loc,class,0,"%s died due to fatal signal %s (%d)%s",
+                 progname,strsignal(WTERMSIG(status)),WTERMSIG(status),
+                 WCOREDUMP(status)?" (core dumped)":"");
+    else
+       lg_perror(lg,desc,loc,class,0,"%s died with unknown wait status %d",
+                 progname,status);
 }
 
 struct log_if *init_log(list_t *ll)
@@ -224,7 +286,7 @@ struct log_if *init_log(list_t *ll)
        if (cl->type!=CL_LOG) {
            cfgfatal(item->loc,"init_log","closure is not a logger");
        }
-       n=safe_malloc(sizeof(*n),"init_log");
+       NEW(n);
        n->l=cl->interface;
        n->next=l;
        l=n;
@@ -232,7 +294,7 @@ struct log_if *init_log(list_t *ll)
     if (!l) {
        fatal("init_log: no log");
     }
-    r=safe_malloc(sizeof(*r), "init_log");
+    NEW(r);
     r->st=l;
     r->vlogfn=log_vmulti;
     r->buff[0]=0;
@@ -246,37 +308,48 @@ struct logfile {
     string_t logfile;
     uint32_t level;
     FILE *f;
+    bool_t forked;
 };
 
 static cstring_t months[]={
     "Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"};
 
+FORMAT(printf, 3, 0)
 static void logfile_vlog(void *sst, int class, const char *message,
                         va_list args)
 {
     struct logfile *st=sst;
     time_t t;
     struct tm *tm;
+    char pidbuf[20];
+
+    if (st->forked) {
+       pid_t us=getpid();
+       snprintf(pidbuf,sizeof(pidbuf),"[%ld] ",(long)us);
+    } else {
+       pidbuf[0]=0;
+    }
 
     if (secnet_is_daemon && st->f) {
        if (class&st->level) {
            t=time(NULL);
            tm=localtime(&t);
-           fprintf(st->f,"%s %2d %02d:%02d:%02d ",
+           fprintf(st->f,"%s %2d %02d:%02d:%02d %s",
                    months[tm->tm_mon],tm->tm_mday,tm->tm_hour,tm->tm_min,
-                   tm->tm_sec);
+                   tm->tm_sec,
+                   pidbuf);
            vfprintf(st->f,message,args);
            fprintf(st->f,"\n");
            fflush(st->f);
        }
     } else {
+       if (pidbuf[0]) MessageFallback(class,"%s",pidbuf);
        vMessageFallback(class,message,args);
        MessageFallback(class,"\n");
     }
 }
 
-static void logfile_log(void *state, int class, const char *message, ...)
-    FORMAT(printf,3,4);
+FORMAT(printf,3,4)
 static void logfile_log(void *state, int class, const char *message, ...)
 {
     va_list ap;
@@ -290,6 +363,7 @@ static void logfile_hup_notify(void *sst, int signum)
 {
     struct logfile *st=sst;
     FILE *f;
+    if (!st->logfile) return;
     f=fopen(st->logfile,"a");
     if (!f) {
        logfile_log(st,M_FATAL,"received SIGHUP, but could not reopen "
@@ -306,7 +380,7 @@ static void logfile_phase_hook(void *sst, uint32_t new_phase)
     struct logfile *st=sst;
     FILE *f;
 
-    if (background) {
+    if (background && st->logfile) {
        f=fopen(st->logfile,"a");
        if (!f) fatal_perror("logfile (%s:%d): cannot open \"%s\"",
                             st->loc.file,st->loc.line,st->logfile);
@@ -315,6 +389,12 @@ static void logfile_phase_hook(void *sst, uint32_t new_phase)
     }
 }
 
+static void logfile_childpersist_hook(void *sst, uint32_t new_phase)
+{
+    struct logfile *st=sst;
+    st->forked=1;
+}
+
 static struct flagstr message_class_table[]={
     { "debug-config", M_DEBUG_CONFIG },
     { "debug-phase", M_DEBUG_PHASE },
@@ -343,7 +423,7 @@ static list_t *logfile_apply(closure_t *self, struct cloc loc, dict_t *context,
        phase.  We should defer writing into the logfile until after we
        become a daemon. */
     
-    st=safe_malloc(sizeof(*st),"logfile_apply");
+    NEW(st);
     st->cl.description="logfile";
     st->cl.type=CL_LOG;
     st->cl.apply=NULL;
@@ -352,7 +432,8 @@ static list_t *logfile_apply(closure_t *self, struct cloc loc, dict_t *context,
     st->ops.vlogfn=logfile_vlog;
     st->ops.buff[0]=0;
     st->loc=loc;
-    st->f=NULL;
+    st->f=stderr;
+    st->forked=0;
 
     item=list_elem(args,0);
     if (!item || item->type!=t_dict) {
@@ -360,11 +441,12 @@ static list_t *logfile_apply(closure_t *self, struct cloc loc, dict_t *context,
     }
     dict=item->data.dict;
 
-    st->logfile=dict_read_string(dict,"filename",True,"logfile",loc);
+    st->logfile=dict_read_string(dict,"filename",False,"logfile",loc);
     st->level=string_list_to_word(dict_lookup(dict,"class"),
                                       message_class_table,"logfile");
 
     add_hook(PHASE_GETRESOURCES,logfile_phase_hook,st);
+    add_hook(PHASE_CHILDPERSIST,logfile_childpersist_hook,st);
 
     return new_closure(&st->cl);
 }
@@ -409,17 +491,6 @@ static void syslog_vlog(void *sst, int class, const char *message,
     }
 }
 
-static void syslog_log(void *sst, int priority, const char *message, ...)
-    FORMAT(printf,3,4);
-static void syslog_log(void *sst, int priority, const char *message, ...)
-{
-    va_list ap;
-
-    va_start(ap,message);
-    syslog_vlog(sst,priority,message,ap);
-    va_end(ap);
-}
-
 static struct flagstr syslog_facility_table[]={
 #ifdef LOG_AUTH
     { "auth", LOG_AUTH },
@@ -452,7 +523,9 @@ static void syslog_phase_hook(void *sst, uint32_t newphase)
     struct syslog *st=sst;
 
     if (background) {
-       openlog(st->ident,0,st->facility);
+       openlog(st->ident,
+               newphase==PHASE_CHILDPERSIST ? LOG_PID : 0,
+               st->facility);
        st->open=True;
     }
 }
@@ -465,7 +538,7 @@ static list_t *syslog_apply(closure_t *self, struct cloc loc, dict_t *context,
     item_t *item;
     string_t facstr;
 
-    st=safe_malloc(sizeof(*st),"syslog_apply");
+    NEW(st);
     st->cl.description="syslog";
     st->cl.type=CL_LOG;
     st->cl.apply=NULL;
@@ -485,6 +558,7 @@ static list_t *syslog_apply(closure_t *self, struct cloc loc, dict_t *context,
                                syslog_facility_table,"syslog");
     st->open=False;
     add_hook(PHASE_GETRESOURCES,syslog_phase_hook,st);
+    add_hook(PHASE_CHILDPERSIST,syslog_phase_hook,st);
 
     return new_closure(&st->cl);
 }    
@@ -507,9 +581,11 @@ static int log_from_fd_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
 {
     struct fdlog *st=sst;
     if (!st->finished) {
-       *nfds_io=1;
+       BEFOREPOLL_WANT_FDS(1);
        fds[0].fd=st->fd;
        fds[0].events=POLLIN;
+    } else {
+       BEFOREPOLL_WANT_FDS(0);
     }
     return 0;
 }
@@ -546,6 +622,7 @@ static void log_from_fd_afterpoll(void *sst, struct pollfd *fds, int nfds)
                    i=-1;
                }
            }
+       } else if (errno==EINTR || iswouldblock(errno)) {
        } else {
            Message(M_WARNING,"log_from_fd: %s\n",strerror(errno));
            st->finished=True;
@@ -557,7 +634,7 @@ void log_from_fd(int fd, cstring_t prefix, struct log_if *log)
 {
     struct fdlog *st;
 
-    st=safe_malloc(sizeof(*st),"log_from_fd");
+    NEW(st);
     st->log=log;
     st->fd=fd;
     st->prefix=prefix;
@@ -565,12 +642,16 @@ void log_from_fd(int fd, cstring_t prefix, struct log_if *log)
     st->i=0;
     st->finished=False;
 
-    register_for_poll(st,log_from_fd_beforepoll,log_from_fd_afterpoll,1,
+    setnonblock(st->fd);
+
+    register_for_poll(st,log_from_fd_beforepoll,log_from_fd_afterpoll,
                      prefix);
 }
 
 void log_module(dict_t *dict)
 {
+    setlinebuf(stderr);
+
     add_closure(dict,"logfile",logfile_apply);
     add_closure(dict,"syslog",syslog_apply);
 }