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