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   {
  72     { "alert", LOG_ALERT },
  73     { "crit", LOG_CRIT },
  74     { "debug", LOG_DEBUG },
  75     { "emerg", LOG_EMERG },
  76     { "err", LOG_ERR },
  77     { "error", LOG_ERR },               /* DEPRECATED */
  78     { "info", LOG_INFO },
  79     { "none", INTERNAL_NOPRI },         /* INTERNAL */
  80     { "notice", LOG_NOTICE },
  81     { "panic", LOG_EMERG },             /* DEPRECATED */
  82     { "warn", LOG_WARNING },            /* DEPRECATED */
  83     { "warning", LOG_WARNING },
  84     { NULL, -1 }
  85   };
  86 #endif
  87
  88 /* facility codes */
  89 #define LOG_KERN        (0<<3)  /* kernel messages */
  90 #define LOG_USER        (1<<3)  /* random user-level messages */
  91 #define LOG_MAIL        (2<<3)  /* mail system */
  92 #define LOG_DAEMON      (3<<3)  /* system daemons */
  93 #define LOG_AUTH        (4<<3)  /* security/authorization messages */
  94 #define LOG_SYSLOG      (5<<3)  /* messages generated internally by syslogd */
  95 #define LOG_LPR         (6<<3)  /* line printer subsystem */
  96 #define LOG_NEWS        (7<<3)  /* network news subsystem */
  97 #define LOG_UUCP        (8<<3)  /* UUCP subsystem */
  98 #define LOG_CRON        (9<<3)  /* clock daemon */
  99 #define LOG_AUTHPRIV    (10<<3) /* security/authorization messages (private) */
 100 #define LOG_FTP         (11<<3) /* ftp daemon */
 101
 102         /* other codes through 15 reserved for system use */
 103 #define LOG_LOCAL0      (16<<3) /* reserved for local use */
 104 #define LOG_LOCAL1      (17<<3) /* reserved for local use */
 105 #define LOG_LOCAL2      (18<<3) /* reserved for local use */
 106 #define LOG_LOCAL3      (19<<3) /* reserved for local use */
 107 #define LOG_LOCAL4      (20<<3) /* reserved for local use */
 108 #define LOG_LOCAL5      (21<<3) /* reserved for local use */
 109 #define LOG_LOCAL6      (22<<3) /* reserved for local use */
 110 #define LOG_LOCAL7      (23<<3) /* reserved for local use */
 111
 112 #define LOG_NFACILITIES 24      /* current number of facilities */
 113 #define LOG_FACMASK     0x03f8  /* mask to extract facility part */
 114                                 /* facility of pri */
 115 #define LOG_FAC(p)      (((p) & LOG_FACMASK) >> 3)
 116
 117 #ifdef SYSLOG_NAMES
 118 CODE facilitynames[] =
 119   {
 120     { "auth", LOG_AUTH },
 121     { "authpriv", LOG_AUTHPRIV },
 122     { "cron", LOG_CRON },
 123     { "daemon", LOG_DAEMON },
 124     { "ftp", LOG_FTP },
 125     { "kern", LOG_KERN },
 126     { "lpr", LOG_LPR },
 127     { "mail", LOG_MAIL },
 128     { "mark", INTERNAL_MARK },          /* INTERNAL */
 129     { "news", LOG_NEWS },
 130     { "security", LOG_AUTH },           /* DEPRECATED */
 131     { "syslog", LOG_SYSLOG },
 132     { "user", LOG_USER },
 133     { "uucp", LOG_UUCP },
 134     { "local0", LOG_LOCAL0 },
 135     { "local1", LOG_LOCAL1 },
 136     { "local2", LOG_LOCAL2 },
 137     { "local3", LOG_LOCAL3 },
 138     { "local4", LOG_LOCAL4 },
 139     { "local5", LOG_LOCAL5 },
 140     { "local6", LOG_LOCAL6 },
 141     { "local7", LOG_LOCAL7 },
 142     { NULL, -1 }
 143   };
 144 #endif
 145
 146 #ifdef KERNEL
 147 #define LOG_PRINTF      -1      /* pseudo-priority to indicate use of printf */
 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 #ifndef KERNEL
 170
 171 #if 0
 172 /*
 173  * Don't use va_list in the vsyslog() prototype.   Va_list is typedef'd in two
 174  * places (<machine/varargs.h> and <machine/stdarg.h>), so if we include one
 175  * of them here we may collide with the utility's includes.  It's unreasonable
 176  * for utilities to have to include one of them to include syslog.h, so we get
 177  * _BSD_VA_LIST_ from <machine/ansi.h> and use it.
 178  */
 179 #include <machine/ansi.h>
 180 #elif !defined (_BSD_VA_LIST_)
 181 /* In GNU we don't have a <machine/ansi.h> and it would be too painful to
 182    emulate one.  */
 183 #define __need___va_list
 184 #include <stdarg.h>
 185 #define _BSD_VA_LIST_ __gnuc_va_list
 186 #endif
 187
 188 #include <sys/cdefs.h>
 189
 190 __BEGIN_DECLS
 191
 192 /* Close desriptor used to write to system logger.  */
 193 extern void closelog __P ((void));
 194
 195 /* Open connection to system logger.  */
 196 extern void openlog __P ((__const char *__ident, int __option,
 197                           int __facility));
 198
 199 /* Set the log mask level.  */
 200 extern int setlogmask __P ((int __mask));
 201
 202 /* Generate a log message using FMT string and option arguments.  */
 203 extern void syslog __P ((int __pri, __const char *__fmt, ...));
 204
 205 /* Generate a log message using FMT and using arguments pointed to by AP.  */
 206 extern void vsyslog __P ((int __pri, __const char *__fmt, _BSD_VA_LIST_ __ap));
 207
 208 __END_DECLS
 209
 210 #endif /* !KERNEL */