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