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