2 * This file is part of secnet.
3 * See README for full list of copyright holders.
5 * secnet is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
10 * secnet is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * version 3 along with secnet; if not, see
17 * https://www.gnu.org/licenses/gpl.html.
31 bool_t secnet_is_daemon=False;
32 uint32_t message_level=M_WARNING|M_ERR|M_SECURITY|M_FATAL;
33 struct log_if *system_log=NULL;
36 static void vMessageFallback(uint32_t class, const char *message, va_list args)
39 /* Messages go to stdout/stderr */
40 if (class & message_level) {
41 if (class&M_FATAL || class&M_ERR || class&M_WARNING) {
44 vfprintf(dest,message,args);
49 static void vMessage(uint32_t class, const char *message, va_list args)
52 vslilog_part(system_log, class, message, args);
55 void Message(uint32_t class, const char *message, ...)
60 vMessage(class,message,ap);
65 static void MessageFallback(uint32_t class, const char *message, ...)
70 vMessageFallback(class,message,ap);
74 static NORETURN(vfatal(int status, bool_t perror, const char *message,
78 static void vfatal(int status, bool_t perror, const char *message,
85 enter_phase(PHASE_SHUTDOWN);
86 Message(M_FATAL, "secnet fatal error: ");
87 vMessage(M_FATAL, message, args);
89 Message(M_FATAL, ": %s\n",strerror(err));
91 Message(M_FATAL, "\n");
95 void fatal(const char *message, ...)
98 va_start(args,message);
99 vfatal(current_phase,False,message,args);
103 void fatal_status(int status, const char *message, ...)
106 va_start(args,message);
107 vfatal(status,False,message,args);
111 void fatal_perror(const char *message, ...)
114 va_start(args,message);
115 vfatal(current_phase,True,message,args);
119 void fatal_perror_status(int status, const char *message, ...)
122 va_start(args,message);
123 vfatal(status,True,message,args);
127 void vcfgfatal_maybefile(FILE *maybe_f /* or 0 */, struct cloc loc,
128 cstring_t facility, const char *message, va_list args,
131 enter_phase(PHASE_SHUTDOWN);
133 if (maybe_f && ferror(maybe_f)) {
135 Message(M_FATAL, "error reading config file (%s, %s): %s",
136 facility, loc.file, strerror(errno));
137 } else if (maybe_f && feof(maybe_f)) {
139 Message(M_FATAL, "unexpected end of config file (%s, %s)",
141 } else if (loc.file && loc.line) {
142 Message(M_FATAL, "config error (%s, %s:%d): ",facility,loc.file,
144 } else if (!loc.file && loc.line) {
145 Message(M_FATAL, "config error (%s, line %d): ",facility,loc.line);
147 Message(M_FATAL, "config error (%s): ",facility);
150 vMessage(M_FATAL,message,args);
151 Message(M_FATAL,"%s",suffix);
155 void cfgfatal_maybefile(FILE *maybe_f, struct cloc loc, cstring_t facility,
156 const char *message, ...)
160 va_start(args,message);
161 vcfgfatal_maybefile(maybe_f,loc,facility,message,args,0);
165 void cfgfatal_cl_type(struct cloc loc, const char *facility,
166 closure_t *cl, uint32_t exp_type, const char *name)
168 char expbuf[10], gotbuf[10];
169 assert(cl->type != exp_type);
170 const char *exp = closure_type_name(exp_type, expbuf);
171 const char *got = closure_type_name(cl->type, gotbuf);
172 cfgfatal(loc,facility,
173 "\"%s\" is the wrong type of closure (expected %s, got %s)\n",
177 void cfgfatal(struct cloc loc, cstring_t facility, const char *message, ...)
181 va_start(args,message);
182 vcfgfatal_maybefile(0,loc,facility,message,args,"");
186 void cfgfile_log__vmsg(void *sst, int class, const char *message, va_list args)
188 struct cfgfile_log *st=sst;
189 vcfgfatal_maybefile(0,st->loc,st->facility,message,args,"\n");
192 void cfgfile_postreadcheck(struct cloc loc, FILE *f)
196 Message(M_FATAL, "error reading config file (%s): %s\n",
197 loc.file, strerror(errno));
199 } else if (feof(f)) {
200 Message(M_FATAL, "unexpected end of config file (%s)\n", loc.file);
205 /* Take a list of log closures and merge them */
208 struct loglist *next;
212 static void log_vmulti(void *sst, int class, const char *message, va_list args)
214 struct loglist *st=sst, *i;
216 if (secnet_is_daemon) {
217 for (i=st; i; i=i->next) {
218 vslilog(i->l,class,message,args);
221 vMessage(class,message,args);
227 void lg_vperror(struct log_if *lg, const char *desc, struct cloc *loc,
228 int class, int errnoval, const char *fmt, va_list al)
230 int status=current_phase;
237 enter_phase(PHASE_SHUTDOWN);
239 slilog_part(lg,class,"%s",desc);
241 slilog_part(lg,class," (%s:%d)",loc->file,loc->line);
242 slilog_part(lg,class,": ");
243 vslilog_part(lg,class,fmt,al);
245 slilog_part(lg,class,": %s",strerror(errnoval));
246 slilog_part(lg,class,"\n");
254 void lg_perror(struct log_if *lg, const char *desc, struct cloc *loc,
255 int class, int errnoval, const char *fmt, ...)
259 lg_vperror(lg,desc,loc,class,errnoval,fmt,al);
263 void lg_exitstatus(struct log_if *lg, const char *desc, struct cloc *loc,
264 int class, int status, const char *progname)
267 lg_perror(lg,desc,loc,class,0,"%s exited",progname);
268 else if (WIFEXITED(status))
269 lg_perror(lg,desc,loc,class,0,"%s exited with error exit status %d",
270 progname,WEXITSTATUS(status));
271 else if (WIFSIGNALED(status))
272 lg_perror(lg,desc,loc,class,0,"%s died due to fatal signal %s (%d)%s",
273 progname,strsignal(WTERMSIG(status)),WTERMSIG(status),
274 WCOREDUMP(status)?" (core dumped)":"");
276 lg_perror(lg,desc,loc,class,0,"%s died with unknown wait status %d",
280 struct log_if *init_log(list_t *ll)
285 struct loglist *l=NULL, *n;
288 if (list_length(ll)==1) {
289 item=list_elem(ll,0);
290 cl=item->data.closure;
291 if (cl->type!=CL_LOG) {
292 cfgfatal(item->loc,"init_log","closure is not a logger");
294 return cl->interface;
296 while ((item=list_elem(ll,i++))) {
297 if (item->type!=t_closure) {
298 cfgfatal(item->loc,"init_log","item is not a closure");
300 cl=item->data.closure;
301 if (cl->type!=CL_LOG) {
302 cfgfatal(item->loc,"init_log","closure is not a logger");
310 fatal("init_log: no log");
314 r->vlogfn=log_vmulti;
330 static cstring_t months[]={
331 "Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"};
334 static void logfile_vlog(void *sst, int class, const char *message,
337 struct logfile *st=sst;
344 snprintf(pidbuf,sizeof(pidbuf),"[%ld] ",(long)us);
349 if (class&st->level) {
352 fprintf(st->f,"%s %2d %02d:%02d:%02d %s%s%s",
353 months[tm->tm_mon],tm->tm_mday,tm->tm_hour,tm->tm_min,
355 st->prefix, st->prefix[0] ? " " : "",
357 vfprintf(st->f,message,args);
364 static void logfile_log(void *state, int class, const char *message, ...)
368 va_start(ap,message);
369 logfile_vlog(state,class,message,ap);
373 static void logfile_hup_notify(void *sst, int signum)
375 struct logfile *st=sst;
377 if (!st->logfile) return;
378 f=fopen(st->logfile,"a");
380 logfile_log(st,M_FATAL,"received SIGHUP, but could not reopen "
381 "logfile: %s",strerror(errno));
385 logfile_log(st,M_INFO,"received SIGHUP");
389 static void logfile_phase_hook(void *sst, uint32_t new_phase)
391 struct logfile *st=sst;
394 if (background && st->logfile) {
395 f=fopen(st->logfile,"a");
396 if (!f) fatal_perror("logfile (%s:%d): cannot open \"%s\"",
397 st->loc.file,st->loc.line,st->logfile);
399 request_signal_notification(SIGHUP, logfile_hup_notify,st);
403 static void logfile_childpersist_hook(void *sst, uint32_t new_phase)
405 struct logfile *st=sst;
409 static struct flagstr message_class_table[]={
410 { "debug-config", M_DEBUG_CONFIG },
411 { "debug-phase", M_DEBUG_PHASE },
412 { "debug", M_DEBUG },
413 { "all-debug", M_DEBUG|M_DEBUG_PHASE|M_DEBUG_CONFIG },
415 { "notice", M_NOTICE },
416 { "warning", M_WARNING },
418 { "security", M_SECURITY },
419 { "fatal", M_FATAL },
420 { "default", M_WARNING|M_ERR|M_SECURITY|M_FATAL },
421 { "verbose", M_INFO|M_NOTICE|M_WARNING|M_ERR|M_SECURITY|M_FATAL },
422 { "quiet", M_FATAL },
426 static void logfile_file_init(struct logfile *st, FILE *f, const char *desc)
428 st->cl.description=desc;
431 st->cl.interface=&st->ops;
433 st->ops.vlogfn=logfile_vlog;
443 static list_t *logfile_apply(closure_t *self, struct cloc loc, dict_t *context,
450 /* We should defer opening the logfile until the getresources
451 phase. We should defer writing into the logfile until after we
456 logfile_file_init(st,stderr,"logfile");
458 item=list_elem(args,0);
459 if (!item || item->type!=t_dict) {
460 cfgfatal(loc,"logfile","argument must be a dictionary\n");
462 dict=item->data.dict;
464 st->logfile=dict_read_string(dict,"filename",False,"logfile",loc);
465 st->prefix=dict_read_string(dict,"prefix",False,"logfile",loc);
466 if (!st->prefix) st->prefix="";
467 st->level=string_list_to_word(dict_lookup(dict,"class"),
468 message_class_table,"logfile");
470 add_hook(PHASE_DAEMONIZE,logfile_phase_hook,st);
471 add_hook(PHASE_CHILDPERSIST,logfile_childpersist_hook,st);
473 return new_closure(&st->cl);
484 static int msgclass_to_syslogpriority(uint32_t m)
487 case M_DEBUG_CONFIG: return LOG_DEBUG;
488 case M_DEBUG_PHASE: return LOG_DEBUG;
489 case M_DEBUG: return LOG_DEBUG;
490 case M_INFO: return LOG_INFO;
491 case M_NOTICE: return LOG_NOTICE;
492 case M_WARNING: return LOG_WARNING;
493 case M_ERR: return LOG_ERR;
494 case M_SECURITY: return LOG_CRIT;
495 case M_FATAL: return LOG_EMERG;
496 default: return LOG_NOTICE;
500 static void syslog_vlog(void *sst, int class, const char *message,
503 static void syslog_vlog(void *sst, int class, const char *message,
506 struct syslog *st=sst;
509 vsyslog(msgclass_to_syslogpriority(class),message,args);
511 vMessageFallback(class,message,args);
512 MessageFallback(class,"\n");
516 static struct flagstr syslog_facility_table[]={
518 { "auth", LOG_AUTH },
521 { "authpriv", LOG_AUTHPRIV },
523 { "cron", LOG_CRON },
524 { "daemon", LOG_DAEMON },
525 { "kern", LOG_KERN },
526 { "local0", LOG_LOCAL0 },
527 { "local1", LOG_LOCAL1 },
528 { "local2", LOG_LOCAL2 },
529 { "local3", LOG_LOCAL3 },
530 { "local4", LOG_LOCAL4 },
531 { "local5", LOG_LOCAL5 },
532 { "local6", LOG_LOCAL6 },
533 { "local7", LOG_LOCAL7 },
535 { "mail", LOG_MAIL },
536 { "news", LOG_NEWS },
537 { "syslog", LOG_SYSLOG },
538 { "user", LOG_USER },
539 { "uucp", LOG_UUCP },
543 static void syslog_phase_hook(void *sst, uint32_t newphase)
545 struct syslog *st=sst;
549 newphase==PHASE_CHILDPERSIST ? LOG_PID : 0,
555 static list_t *syslog_apply(closure_t *self, struct cloc loc, dict_t *context,
564 st->cl.description="syslog";
567 st->cl.interface=&st->ops;
569 st->ops.vlogfn=syslog_vlog;
572 item=list_elem(args,0);
573 if (!item || item->type!=t_dict)
574 cfgfatal(loc,"syslog","parameter must be a dictionary\n");
577 st->ident=dict_read_string(d, "ident", False, "syslog", loc);
578 facstr=dict_read_string(d, "facility", True, "syslog", loc);
579 st->facility=string_to_word(facstr,loc,
580 syslog_facility_table,"syslog");
582 add_hook(PHASE_DAEMONIZE,syslog_phase_hook,st);
583 add_hook(PHASE_CHILDPERSIST,syslog_phase_hook,st);
585 return new_closure(&st->cl);
588 /* Read from a fd and output to a log. This is a quick hack to
589 support logging stderr, and needs code adding to tidy up before it
590 can be used for anything else. */
591 #define FDLOG_BUFSIZE 1024
601 static int log_from_fd_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
604 struct fdlog *st=sst;
606 BEFOREPOLL_WANT_FDS(1);
608 fds[0].events=POLLIN;
610 BEFOREPOLL_WANT_FDS(0);
615 static void log_from_fd_afterpoll(void *sst, struct pollfd *fds, int nfds)
617 struct fdlog *st=sst;
621 if (fds[0].revents&POLLERR) {
624 if (fds[0].revents&POLLIN) {
625 remain=FDLOG_BUFSIZE-st->i-1;
627 st->buffer[FDLOG_BUFSIZE-1]=0;
628 slilog(st->log,M_WARNING,"%s: overlong line: %s",
629 st->prefix,st->buffer);
631 remain=FDLOG_BUFSIZE-1;
633 r=read(st->fd,st->buffer+st->i,remain);
636 for (i=0; i<st->i; i++) {
637 if (st->buffer[i]=='\n') {
639 slilog(st->log,M_INFO,"%s: %s",
640 st->prefix,st->buffer);
642 memmove(st->buffer,st->buffer+i,st->i-i);
647 } else if (errno==EINTR || iswouldblock(errno)) {
649 Message(M_WARNING,"log_from_fd: %s\n",strerror(errno));
655 void log_from_fd(int fd, cstring_t prefix, struct log_if *log)
663 st->buffer=safe_malloc(FDLOG_BUFSIZE,"log_from_fd");
669 register_for_poll(st,log_from_fd_beforepoll,log_from_fd_afterpoll,
673 static struct logfile startup_log;
674 void log_early_setlevel(void)
676 startup_log.level=message_level;
678 void log_early_init(void)
680 logfile_file_init(&startup_log,stderr,"startup");
681 log_early_setlevel();
682 system_log=&startup_log.ops;;
685 /* for the benefit of main, really */
686 void logfile_init_file(struct logfile *st, FILE *f);
688 void log_module(dict_t *dict)
692 add_closure(dict,"logfile",logfile_apply);
693 add_closure(dict,"syslog",syslog_apply);