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