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(struct cloc loc, cstring_t facility, const char *message, ...)
169 va_start(args,message);
170 vcfgfatal_maybefile(0,loc,facility,message,args,"");
174 void cfgfile_log__vmsg(void *sst, int class, const char *message, va_list args)
176 struct cfgfile_log *st=sst;
177 vcfgfatal_maybefile(0,st->loc,st->facility,message,args,"\n");
180 void cfgfile_postreadcheck(struct cloc loc, FILE *f)
184 Message(M_FATAL, "error reading config file (%s): %s\n",
185 loc.file, strerror(errno));
187 } else if (feof(f)) {
188 Message(M_FATAL, "unexpected end of config file (%s)\n", loc.file);
193 /* Take a list of log closures and merge them */
196 struct loglist *next;
200 static void log_vmulti(void *sst, int class, const char *message, va_list args)
202 struct loglist *st=sst, *i;
204 if (secnet_is_daemon) {
205 for (i=st; i; i=i->next) {
206 vslilog(i->l,class,message,args);
209 vMessage(class,message,args);
215 void lg_vperror(struct log_if *lg, const char *desc, struct cloc *loc,
216 int class, int errnoval, const char *fmt, va_list al)
218 int status=current_phase;
225 enter_phase(PHASE_SHUTDOWN);
227 slilog_part(lg,class,"%s",desc);
229 slilog_part(lg,class," (%s:%d)",loc->file,loc->line);
230 slilog_part(lg,class,": ");
231 vslilog_part(lg,class,fmt,al);
233 slilog_part(lg,class,": %s",strerror(errnoval));
234 slilog_part(lg,class,"\n");
242 void lg_perror(struct log_if *lg, const char *desc, struct cloc *loc,
243 int class, int errnoval, const char *fmt, ...)
247 lg_vperror(lg,desc,loc,class,errnoval,fmt,al);
251 void lg_exitstatus(struct log_if *lg, const char *desc, struct cloc *loc,
252 int class, int status, const char *progname)
255 lg_perror(lg,desc,loc,class,0,"%s exited",progname);
256 else if (WIFEXITED(status))
257 lg_perror(lg,desc,loc,class,0,"%s exited with error exit status %d",
258 progname,WEXITSTATUS(status));
259 else if (WIFSIGNALED(status))
260 lg_perror(lg,desc,loc,class,0,"%s died due to fatal signal %s (%d)%s",
261 progname,strsignal(WTERMSIG(status)),WTERMSIG(status),
262 WCOREDUMP(status)?" (core dumped)":"");
264 lg_perror(lg,desc,loc,class,0,"%s died with unknown wait status %d",
268 struct log_if *init_log(list_t *ll)
273 struct loglist *l=NULL, *n;
276 if (list_length(ll)==1) {
277 item=list_elem(ll,0);
278 cl=item->data.closure;
279 if (cl->type!=CL_LOG) {
280 cfgfatal(item->loc,"init_log","closure is not a logger");
282 return cl->interface;
284 while ((item=list_elem(ll,i++))) {
285 if (item->type!=t_closure) {
286 cfgfatal(item->loc,"init_log","item is not a closure");
288 cl=item->data.closure;
289 if (cl->type!=CL_LOG) {
290 cfgfatal(item->loc,"init_log","closure is not a logger");
298 fatal("init_log: no log");
302 r->vlogfn=log_vmulti;
318 static cstring_t months[]={
319 "Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"};
322 static void logfile_vlog(void *sst, int class, const char *message,
325 struct logfile *st=sst;
332 snprintf(pidbuf,sizeof(pidbuf),"[%ld] ",(long)us);
337 if (class&st->level) {
340 fprintf(st->f,"%s %2d %02d:%02d:%02d %s%s%s",
341 months[tm->tm_mon],tm->tm_mday,tm->tm_hour,tm->tm_min,
343 st->prefix, st->prefix[0] ? " " : "",
345 vfprintf(st->f,message,args);
352 static void logfile_log(void *state, int class, const char *message, ...)
356 va_start(ap,message);
357 logfile_vlog(state,class,message,ap);
361 static void logfile_hup_notify(void *sst, int signum)
363 struct logfile *st=sst;
365 if (!st->logfile) return;
366 f=fopen(st->logfile,"a");
368 logfile_log(st,M_FATAL,"received SIGHUP, but could not reopen "
369 "logfile: %s",strerror(errno));
373 logfile_log(st,M_INFO,"received SIGHUP");
377 static void logfile_phase_hook(void *sst, uint32_t new_phase)
379 struct logfile *st=sst;
382 if (background && st->logfile) {
383 f=fopen(st->logfile,"a");
384 if (!f) fatal_perror("logfile (%s:%d): cannot open \"%s\"",
385 st->loc.file,st->loc.line,st->logfile);
387 request_signal_notification(SIGHUP, logfile_hup_notify,st);
391 static void logfile_childpersist_hook(void *sst, uint32_t new_phase)
393 struct logfile *st=sst;
397 static struct flagstr message_class_table[]={
398 { "debug-config", M_DEBUG_CONFIG },
399 { "debug-phase", M_DEBUG_PHASE },
400 { "debug", M_DEBUG },
401 { "all-debug", M_DEBUG|M_DEBUG_PHASE|M_DEBUG_CONFIG },
403 { "notice", M_NOTICE },
404 { "warning", M_WARNING },
406 { "security", M_SECURITY },
407 { "fatal", M_FATAL },
408 { "default", M_WARNING|M_ERR|M_SECURITY|M_FATAL },
409 { "verbose", M_INFO|M_NOTICE|M_WARNING|M_ERR|M_SECURITY|M_FATAL },
410 { "quiet", M_FATAL },
414 static void logfile_file_init(struct logfile *st, FILE *f, const char *desc)
416 st->cl.description=desc;
419 st->cl.interface=&st->ops;
421 st->ops.vlogfn=logfile_vlog;
431 static list_t *logfile_apply(closure_t *self, struct cloc loc, dict_t *context,
438 /* We should defer opening the logfile until the getresources
439 phase. We should defer writing into the logfile until after we
444 logfile_file_init(st,stderr,"logfile");
446 item=list_elem(args,0);
447 if (!item || item->type!=t_dict) {
448 cfgfatal(loc,"logfile","argument must be a dictionary\n");
450 dict=item->data.dict;
452 st->logfile=dict_read_string(dict,"filename",False,"logfile",loc);
453 st->prefix=dict_read_string(dict,"prefix",False,"logfile",loc);
454 if (!st->prefix) st->prefix="";
455 st->level=string_list_to_word(dict_lookup(dict,"class"),
456 message_class_table,"logfile");
458 add_hook(PHASE_GETRESOURCES,logfile_phase_hook,st);
459 add_hook(PHASE_CHILDPERSIST,logfile_childpersist_hook,st);
461 return new_closure(&st->cl);
472 static int msgclass_to_syslogpriority(uint32_t m)
475 case M_DEBUG_CONFIG: return LOG_DEBUG;
476 case M_DEBUG_PHASE: return LOG_DEBUG;
477 case M_DEBUG: return LOG_DEBUG;
478 case M_INFO: return LOG_INFO;
479 case M_NOTICE: return LOG_NOTICE;
480 case M_WARNING: return LOG_WARNING;
481 case M_ERR: return LOG_ERR;
482 case M_SECURITY: return LOG_CRIT;
483 case M_FATAL: return LOG_EMERG;
484 default: return LOG_NOTICE;
488 static void syslog_vlog(void *sst, int class, const char *message,
491 static void syslog_vlog(void *sst, int class, const char *message,
494 struct syslog *st=sst;
497 vsyslog(msgclass_to_syslogpriority(class),message,args);
499 vMessageFallback(class,message,args);
500 MessageFallback(class,"\n");
504 static struct flagstr syslog_facility_table[]={
506 { "auth", LOG_AUTH },
509 { "authpriv", LOG_AUTHPRIV },
511 { "cron", LOG_CRON },
512 { "daemon", LOG_DAEMON },
513 { "kern", LOG_KERN },
514 { "local0", LOG_LOCAL0 },
515 { "local1", LOG_LOCAL1 },
516 { "local2", LOG_LOCAL2 },
517 { "local3", LOG_LOCAL3 },
518 { "local4", LOG_LOCAL4 },
519 { "local5", LOG_LOCAL5 },
520 { "local6", LOG_LOCAL6 },
521 { "local7", LOG_LOCAL7 },
523 { "mail", LOG_MAIL },
524 { "news", LOG_NEWS },
525 { "syslog", LOG_SYSLOG },
526 { "user", LOG_USER },
527 { "uucp", LOG_UUCP },
531 static void syslog_phase_hook(void *sst, uint32_t newphase)
533 struct syslog *st=sst;
537 newphase==PHASE_CHILDPERSIST ? LOG_PID : 0,
543 static list_t *syslog_apply(closure_t *self, struct cloc loc, dict_t *context,
552 st->cl.description="syslog";
555 st->cl.interface=&st->ops;
557 st->ops.vlogfn=syslog_vlog;
560 item=list_elem(args,0);
561 if (!item || item->type!=t_dict)
562 cfgfatal(loc,"syslog","parameter must be a dictionary\n");
565 st->ident=dict_read_string(d, "ident", False, "syslog", loc);
566 facstr=dict_read_string(d, "facility", True, "syslog", loc);
567 st->facility=string_to_word(facstr,loc,
568 syslog_facility_table,"syslog");
570 add_hook(PHASE_GETRESOURCES,syslog_phase_hook,st);
571 add_hook(PHASE_CHILDPERSIST,syslog_phase_hook,st);
573 return new_closure(&st->cl);
576 /* Read from a fd and output to a log. This is a quick hack to
577 support logging stderr, and needs code adding to tidy up before it
578 can be used for anything else. */
579 #define FDLOG_BUFSIZE 1024
589 static int log_from_fd_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
592 struct fdlog *st=sst;
594 BEFOREPOLL_WANT_FDS(1);
596 fds[0].events=POLLIN;
598 BEFOREPOLL_WANT_FDS(0);
603 static void log_from_fd_afterpoll(void *sst, struct pollfd *fds, int nfds)
605 struct fdlog *st=sst;
609 if (fds[0].revents&POLLERR) {
612 if (fds[0].revents&POLLIN) {
613 remain=FDLOG_BUFSIZE-st->i-1;
615 st->buffer[FDLOG_BUFSIZE-1]=0;
616 slilog(st->log,M_WARNING,"%s: overlong line: %s",
617 st->prefix,st->buffer);
619 remain=FDLOG_BUFSIZE-1;
621 r=read(st->fd,st->buffer+st->i,remain);
624 for (i=0; i<st->i; i++) {
625 if (st->buffer[i]=='\n') {
627 slilog(st->log,M_INFO,"%s: %s",
628 st->prefix,st->buffer);
630 memmove(st->buffer,st->buffer+i,st->i-i);
635 } else if (errno==EINTR || iswouldblock(errno)) {
637 Message(M_WARNING,"log_from_fd: %s\n",strerror(errno));
643 void log_from_fd(int fd, cstring_t prefix, struct log_if *log)
651 st->buffer=safe_malloc(FDLOG_BUFSIZE,"log_from_fd");
657 register_for_poll(st,log_from_fd_beforepoll,log_from_fd_afterpoll,
661 static struct logfile startup_log;
662 void log_early_init(void)
664 logfile_file_init(&startup_log,stderr,"startup");
665 system_log=&startup_log.ops;;
668 /* for the benefit of main, really */
669 void logfile_init_file(struct logfile *st, FILE *f);
671 void log_module(dict_t *dict)
675 add_closure(dict,"logfile",logfile_apply);
676 add_closure(dict,"syslog",syslog_apply);