misc/sys/syslog.h

   1 /*
   2  * Copyright (c) 1982, 1986, 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  *      @(#)syslog.h    8.1 (Berkeley) 6/2/93
  30  */
  31
  32 #ifndef _SYS_SYSLOG_H
  33 #define _SYS_SYSLOG_H 1
  34
  35 #include <features.h>
  36 #define __need___va_list
  37 #include <stdarg.h>
  38
  39
  40 #define _PATH_LOG       "/dev/log"
  41
  42 /*
  43  * priorities/facilities are encoded into a single 32-bit quantity, where the
  44  * bottom 3 bits are the priority (0-7) and the top 28 bits are the facility
  45  * (0-big number).  Both the priorities and the facilities map roughly
  46  * one-to-one to strings in the syslogd(8) source code.  This mapping is
  47  * included in this file.
  48  *
  49  * priorities (these are ordered)
  50  */
  51 #define LOG_EMERG       0       /* system is unusable */
  52 #define LOG_ALERT       1       /* action must be taken immediately */
  53 #define LOG_CRIT        2       /* critical conditions */
  54 #define LOG_ERR         3       /* error conditions */
  55 #define LOG_WARNING     4       /* warning conditions */
  56 #define LOG_NOTICE      5       /* normal but significant condition */
  57 #define LOG_INFO        6       /* informational */
  58 #define LOG_DEBUG       7       /* debug-level messages */
  59
  60 #define LOG_PRIMASK     0x07    /* mask to extract priority part (internal) */
  61                                 /* extract priority */
  62 #define LOG_PRI(p)      ((p) & LOG_PRIMASK)
  63 #define LOG_MAKEPRI(fac, pri)   (((fac) << 3) | (pri))
  64
  65 #ifdef SYSLOG_NAMES
  66 #define INTERNAL_NOPRI  0x10    /* the "no priority" priority */
  67                                 /* mark "facility" */
  68 #define INTERNAL_MARK   LOG_MAKEPRI(LOG_NFACILITIES, 0)
  69 typedef struct _code {
  70         char    *c_name;
  71         int     c_val;
  72 } CODE;
  73
  74 CODE prioritynames[] =
  75   {
  76     { "alert", LOG_ALERT },
  77     { "crit", LOG_CRIT },
  78     { "debug", LOG_DEBUG },
  79     { "emerg", LOG_EMERG },
  80     { "err", LOG_ERR },
  81     { "error", LOG_ERR },               /* DEPRECATED */
  82     { "info", LOG_INFO },
  83     { "none", INTERNAL_NOPRI },         /* INTERNAL */
  84     { "notice", LOG_NOTICE },
  85     { "panic", LOG_EMERG },             /* DEPRECATED */
  86     { "warn", LOG_WARNING },            /* DEPRECATED */
  87     { "warning", LOG_WARNING },
  88     { NULL, -1 }
  89   };
  90 #endif
  91
  92 /* facility codes */
  93 #define LOG_KERN        (0<<3)  /* kernel messages */
  94 #define LOG_USER        (1<<3)  /* random user-level messages */
  95 #define LOG_MAIL        (2<<3)  /* mail system */
  96 #define LOG_DAEMON      (3<<3)  /* system daemons */
  97 #define LOG_AUTH        (4<<3)  /* security/authorization messages */
  98 #define LOG_SYSLOG      (5<<3)  /* messages generated internally by syslogd */
  99 #define LOG_LPR         (6<<3)  /* line printer subsystem */
 100 #define LOG_NEWS        (7<<3)  /* network news subsystem */
 101 #define LOG_UUCP        (8<<3)  /* UUCP subsystem */
 102 #define LOG_CRON        (9<<3)  /* clock daemon */
 103 #define LOG_AUTHPRIV    (10<<3) /* security/authorization messages (private) */
 104 #define LOG_FTP         (11<<3) /* ftp daemon */
 105
 106         /* other codes through 15 reserved for system use */
 107 #define LOG_LOCAL0      (16<<3) /* reserved for local use */
 108 #define LOG_LOCAL1      (17<<3) /* reserved for local use */
 109 #define LOG_LOCAL2      (18<<3) /* reserved for local use */
 110 #define LOG_LOCAL3      (19<<3) /* reserved for local use */
 111 #define LOG_LOCAL4      (20<<3) /* reserved for local use */
 112 #define LOG_LOCAL5      (21<<3) /* reserved for local use */
 113 #define LOG_LOCAL6      (22<<3) /* reserved for local use */
 114 #define LOG_LOCAL7      (23<<3) /* reserved for local use */
 115
 116 #define LOG_NFACILITIES 24      /* current number of facilities */
 117 #define LOG_FACMASK     0x03f8  /* mask to extract facility part */
 118                                 /* facility of pri */
 119 #define LOG_FAC(p)      (((p) & LOG_FACMASK) >> 3)
 120
 121 #ifdef SYSLOG_NAMES
 122 CODE facilitynames[] =
 123   {
 124     { "auth", LOG_AUTH },
 125     { "authpriv", LOG_AUTHPRIV },
 126     { "cron", LOG_CRON },
 127     { "daemon", LOG_DAEMON },
 128     { "ftp", LOG_FTP },
 129     { "kern", LOG_KERN },
 130     { "lpr", LOG_LPR },
 131     { "mail", LOG_MAIL },
 132     { "mark", INTERNAL_MARK },          /* INTERNAL */
 133     { "news", LOG_NEWS },
 134     { "security", LOG_AUTH },           /* DEPRECATED */
 135     { "syslog", LOG_SYSLOG },
 136     { "user", LOG_USER },
 137     { "uucp", LOG_UUCP },
 138     { "local0", LOG_LOCAL0 },
 139     { "local1", LOG_LOCAL1 },
 140     { "local2", LOG_LOCAL2 },
 141     { "local3", LOG_LOCAL3 },
 142     { "local4", LOG_LOCAL4 },
 143     { "local5", LOG_LOCAL5 },
 144     { "local6", LOG_LOCAL6 },
 145     { "local7", LOG_LOCAL7 },
 146     { NULL, -1 }
 147   };
 148 #endif
 149
 150 /*
 151  * arguments to setlogmask.
 152  */
 153 #define LOG_MASK(pri)   (1 << (pri))            /* mask for one priority */
 154 #define LOG_UPTO(pri)   ((1 << ((pri)+1)) - 1)  /* all priorities through pri */
 155
 156 /*
 157  * Option flags for openlog.
 158  *
 159  * LOG_ODELAY no longer does anything.
 160  * LOG_NDELAY is the inverse of what it used to be.
 161  */
 162 #define LOG_PID         0x01    /* log the pid with each message */
 163 #define LOG_CONS        0x02    /* log on the console if errors in sending */
 164 #define LOG_ODELAY      0x04    /* delay open until first syslog() (default) */
 165 #define LOG_NDELAY      0x08    /* don't delay open */
 166 #define LOG_NOWAIT      0x10    /* don't wait for console forks: DEPRECATED */
 167 #define LOG_PERROR      0x20    /* log to stderr as well */
 168
 169 __BEGIN_DECLS
 170
 171 /* Close desriptor used to write to system logger.  */
 172 extern void closelog (void) __THROW;
 173
 174 /* Open connection to system logger.  */
 175 extern void openlog (__const char *__ident, int __option, int __facility)
 176      __THROW;
 177
 178 /* Set the log mask level.  */
 179 extern int setlogmask (int __mask) __THROW;
 180
 181 /* Generate a log message using FMT string and option arguments.  */
 182 extern void syslog (int __pri, __const char *__fmt, ...) __THROW
 183      __attribute__ ((__format__(__printf__, 2, 3)));
 184
 185 #ifdef __USE_BSD
 186 /* Generate a log message using FMT and using arguments pointed to by AP.  */
 187 extern void vsyslog (int __pri, __const char *__fmt, __gnuc_va_list __ap)
 188      __THROW __attribute__ ((__format__(__printf__, 2, 0)));
 189 #endif
 190
 191 __END_DECLS
 192
 193 #endif /* sys/syslog.h */