misc/syslog.c

   1 /*
   2  * Copyright (c) 1983, 1988, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 #if defined(LIBC_SCCS) && !defined(lint)
  35 static char sccsid[] = "@(#)syslog.c    8.4 (Berkeley) 3/18/94";
  36 #endif /* LIBC_SCCS and not lint */
  37
  38 #include <sys/types.h>
  39 #include <sys/socket.h>
  40 #include <sys/syslog.h>
  41 #include <sys/uio.h>
  42 #include <netdb.h>
  43
  44 #include <errno.h>
  45 #include <fcntl.h>
  46 #include <paths.h>
  47 #include <stdio.h>
  48 #include <string.h>
  49 #include <time.h>
  50 #include <unistd.h>
  51 #include <stdlib.h>
  52 #include <bits/libc-lock.h>
  53 #include <signal.h>
  54
  55 #if __STDC__
  56 #include <stdarg.h>
  57 #else
  58 #include <varargs.h>
  59 #endif
  60
  61 #ifdef USE_IN_LIBIO
  62 # include <libio/iolibio.h>
  63 # define ftell(s) _IO_ftell (s)
  64 #endif
  65
  66 static int      LogType = SOCK_DGRAM;   /* type of socket connection */
  67 static int      LogFile = -1;           /* fd for log */
  68 static int      connected;              /* have done connect */
  69 static int      LogStat = 0;            /* status bits, set by openlog() */
  70 static const char *LogTag = NULL;       /* string to tag the entry with */
  71 static int      LogFacility = LOG_USER; /* default facility code */
  72 static int      LogMask = 0xff;         /* mask of priorities to be logged */
  73 extern char     *__progname;            /* Program name, from crt0. */
  74
  75 /* Define the lock.  */
  76 __libc_lock_define_initialized (static, syslog_lock)
  77
  78 static void openlog_internal(const char *, int, int) internal_function;
  79 static void closelog_internal(void);
  80 static void sigpipe_handler (int);
  81 #ifdef _LIBC_REENTRANT
  82 static void cancel_handler (void *);
  83 #endif
  84
  85 /*
  86  * syslog, vsyslog --
  87  *      print message on log file; output is intended for syslogd(8).
  88  */
  89 void
  90 #if __STDC__
  91 syslog(int pri, const char *fmt, ...)
  92 #else
  93 syslog(pri, fmt, va_alist)
  94         int pri;
  95         char *fmt;
  96         va_dcl
  97 #endif
  98 {
  99         va_list ap;
 100
 101 #if __STDC__
 102         va_start(ap, fmt);
 103 #else
 104         va_start(ap);
 105 #endif
 106         vsyslog(pri, fmt, ap);
 107         va_end(ap);
 108 }
 109
 110 void
 111 vsyslog(pri, fmt, ap)
 112         int pri;
 113         register const char *fmt;
 114         va_list ap;
 115 {
 116         struct tm now_tm;
 117         time_t now;
 118         int fd;
 119         FILE *f;
 120         char *buf = 0;
 121         size_t bufsize = 0;
 122         size_t prioff, msgoff;
 123         struct sigaction action, oldaction;
 124         struct sigaction *oldaction_ptr = NULL;
 125         int sigpipe;
 126
 127 #define INTERNALLOG     LOG_ERR|LOG_CONS|LOG_PERROR|LOG_PID
 128         /* Check for invalid bits. */
 129         if (pri & ~(LOG_PRIMASK|LOG_FACMASK)) {
 130                 syslog(INTERNALLOG,
 131                     "syslog: unknown facility/priority: %x", pri);
 132                 pri &= LOG_PRIMASK|LOG_FACMASK;
 133         }
 134
 135         /* Check priority against setlogmask values. */
 136         if (!LOG_MASK(LOG_PRI(pri)) & LogMask)
 137                 return;
 138
 139         /* Set default facility if none specified. */
 140         if ((pri & LOG_FACMASK) == 0)
 141                 pri |= LogFacility;
 142
 143         /* Build the message in a memory-buffer stream.  */
 144         f = open_memstream (&buf, &bufsize);
 145         prioff = fprintf (f, "<%d>", pri);
 146         (void) time (&now);
 147 #ifdef USE_IN_LIBIO
 148         f->_IO_write_ptr += strftime (f->_IO_write_ptr,
 149                                       f->_IO_write_end - f->_IO_write_ptr,
 150                                       "%h %e %T ",
 151                                       __localtime_r (&now, &now_tm));
 152 #else
 153         f->__bufp += strftime (f->__bufp, f->__put_limit - f->__bufp,
 154                                "%h %e %T ", __localtime_r (&now, &now_tm));
 155 #endif
 156         msgoff = ftell (f);
 157         if (LogTag == NULL)
 158           LogTag = __progname;
 159         if (LogTag != NULL)
 160           fputs_unlocked (LogTag, f);
 161         if (LogStat & LOG_PID)
 162           fprintf (f, "[%d]", __getpid ());
 163         if (LogTag != NULL)
 164           putc_unlocked (':', f), putc_unlocked (' ', f);
 165
 166         /* We have the header.  Print the user's format into the buffer.  */
 167         vfprintf (f, fmt, ap);
 168
 169         /* Close the memory stream; this will finalize the data
 170            into a malloc'd buffer in BUF.  */
 171         fclose (f);
 172
 173         /* Output to stderr if requested. */
 174         if (LogStat & LOG_PERROR) {
 175                 struct iovec iov[2];
 176                 register struct iovec *v = iov;
 177
 178                 v->iov_base = buf + msgoff;
 179                 v->iov_len = bufsize - msgoff;
 180                 ++v;
 181                 v->iov_base = (char *) "\n";
 182                 v->iov_len = 1;
 183                 (void)__writev(STDERR_FILENO, iov, 2);
 184         }
 185
 186         /* Prepare for multiple users.  We have to take care: open and
 187            write are cancellation points.  */
 188         __libc_cleanup_region_start ((void (*) (void *)) cancel_handler,
 189                                      &oldaction_ptr);
 190         __libc_lock_lock (syslog_lock);
 191
 192         /* Prepare for a broken connection.  */
 193         memset (&action, 0, sizeof (action));
 194         action.sa_handler = sigpipe_handler;
 195         sigemptyset (&action.sa_mask);
 196         sigpipe = __sigaction (SIGPIPE, &action, &oldaction);
 197         if (sigpipe == 0)
 198           oldaction_ptr = &oldaction;
 199
 200         /* Get connected, output the message to the local logger. */
 201         if (!connected)
 202                 openlog_internal(LogTag, LogStat | LOG_NDELAY, 0);
 203
 204         /* If we have a SOCK_STREAM connection, also send ASCII NUL as
 205            a record terminator.  */
 206         if (LogType == SOCK_STREAM)
 207           ++bufsize;
 208
 209         if (!connected || __send(LogFile, buf, bufsize, 0) < 0)
 210           {
 211             closelog_internal ();       /* attempt re-open next time */
 212             /*
 213              * Output the message to the console; don't worry about blocking,
 214              * if console blocks everything will.  Make sure the error reported
 215              * is the one from the syslogd failure.
 216              */
 217             if (LogStat & LOG_CONS &&
 218                 (fd = __open(_PATH_CONSOLE, O_WRONLY|O_NOCTTY, 0)) >= 0)
 219               {
 220                 dprintf (fd, "%s\r\n", buf + msgoff);
 221                 (void)__close(fd);
 222               }
 223           }
 224
 225         if (sigpipe == 0)
 226                 __sigaction (SIGPIPE, &oldaction, (struct sigaction *) NULL);
 227
 228         /* End of critical section.  */
 229         __libc_cleanup_region_end (0);
 230         __libc_lock_unlock (syslog_lock);
 231
 232         free (buf);
 233 }
 234
 235 static struct sockaddr SyslogAddr;      /* AF_UNIX address of local logger */
 236
 237 static void
 238 internal_function
 239 openlog_internal(const char *ident, int logstat, int logfac)
 240 {
 241         if (ident != NULL)
 242                 LogTag = ident;
 243         LogStat = logstat;
 244         if (logfac != 0 && (logfac &~ LOG_FACMASK) == 0)
 245                 LogFacility = logfac;
 246
 247         while (1) {
 248                 if (LogFile == -1) {
 249                         SyslogAddr.sa_family = AF_UNIX;
 250                         (void)strncpy(SyslogAddr.sa_data, _PATH_LOG,
 251                                       sizeof(SyslogAddr.sa_data));
 252                         if (LogStat & LOG_NDELAY) {
 253                                 if ((LogFile = __socket(AF_UNIX, LogType, 0))
 254                                     == -1)
 255                                         return;
 256                                 (void)__fcntl(LogFile, F_SETFD, 1);
 257                         }
 258                 }
 259                 if (LogFile != -1 && !connected)
 260                 {
 261                         int old_errno = errno;
 262                         if (__connect(LogFile, &SyslogAddr, sizeof(SyslogAddr))
 263                             == -1)
 264                         {
 265                                 int saved_errno = errno;
 266                                 (void)__close(LogFile);
 267                                 LogFile = -1;
 268                                 if (LogType == SOCK_DGRAM
 269                                     && saved_errno == EPROTOTYPE)
 270                                 {
 271                                         /* retry with next SOCK_STREAM: */
 272                                         LogType = SOCK_STREAM;
 273                                         __set_errno (old_errno);
 274                                         continue;
 275                                 }
 276                         } else
 277                                 connected = 1;
 278                 }
 279                 break;
 280         }
 281 }
 282
 283 void
 284 openlog (const char *ident, int logstat, int logfac)
 285 {
 286   /* Protect against multiple users.  */
 287   __libc_cleanup_region_start ((void (*) __P ((void *))) __libc_mutex_unlock,
 288                                &syslog_lock);
 289   __libc_lock_lock (syslog_lock);
 290
 291   openlog_internal (ident, logstat, logfac);
 292
 293   /* Free the lock.  */
 294   __libc_cleanup_region_end (1);
 295 }
 296
 297 static void
 298 sigpipe_handler (int signo)
 299 {
 300   closelog_internal ();
 301 }
 302
 303 static void
 304 closelog_internal()
 305 {
 306   if (!connected)
 307     return;
 308
 309   __close (LogFile);
 310   LogFile = -1;
 311   connected = 0;
 312   LogTag = NULL;
 313 }
 314
 315 void
 316 closelog ()
 317 {
 318   /* Protect against multiple users.  */
 319   __libc_cleanup_region_start ((void (*) __P ((void *))) __libc_mutex_unlock,
 320                                &syslog_lock);
 321   __libc_lock_lock (syslog_lock);
 322
 323   closelog_internal ();
 324
 325   /* Free the lock.  */
 326   __libc_cleanup_region_end (1);
 327 }
 328
 329 #ifdef _LIBC_REENTRANT
 330 static void
 331 cancel_handler (void *ptr)
 332 {
 333   /* Restore the old signal handler.  */
 334   struct sigaction *oldaction = *((struct sigaction **) ptr);
 335
 336   if (oldaction != (struct sigaction *) NULL)
 337     __sigaction (SIGPIPE, oldaction, (struct sigaction *) NULL);
 338
 339   /* Free the lock.  */
 340   __libc_lock_unlock (syslog_lock);
 341 }
 342 #endif
 343
 344 /* setlogmask -- set the log mask level */
 345 int
 346 setlogmask(pmask)
 347         int pmask;
 348 {
 349         int omask;
 350
 351         omask = LogMask;
 352         if (pmask != 0)
 353                 LogMask = pmask;
 354         return (omask);
 355 }