]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/sys/syslog.h
ident(1): Normalizing date format
[FreeBSD/FreeBSD.git] / sys / sys / syslog.h
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 1986, 1988, 1993
5  *      The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *      @(#)syslog.h    8.1 (Berkeley) 6/2/93
32  * $FreeBSD$
33  */
34
35 #ifndef _SYS_SYSLOG_H_
36 #define _SYS_SYSLOG_H_
37
38 #define _PATH_LOG       "/var/run/log"
39 #define _PATH_LOG_PRIV  "/var/run/logpriv"
40 #define _PATH_OLDLOG    "/dev/log"      /* backward compatibility */
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) | (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<<3), 0)
69 typedef struct _code {
70         const char      *c_name;
71         int             c_val;
72 } CODE;
73
74 static const CODE prioritynames[] = {
75         { "alert",      LOG_ALERT,      },
76         { "crit",       LOG_CRIT,       },
77         { "debug",      LOG_DEBUG,      },
78         { "emerg",      LOG_EMERG,      },
79         { "err",        LOG_ERR,        },
80         { "error",      LOG_ERR,        },      /* DEPRECATED */
81         { "info",       LOG_INFO,       },
82         { "none",       INTERNAL_NOPRI, },      /* INTERNAL */
83         { "notice",     LOG_NOTICE,     },
84         { "panic",      LOG_EMERG,      },      /* DEPRECATED */
85         { "warn",       LOG_WARNING,    },      /* DEPRECATED */
86         { "warning",    LOG_WARNING,    },
87         { NULL,         -1,             }
88 };
89 #endif
90
91 /* facility codes */
92 #define LOG_KERN        (0<<3)  /* kernel messages */
93 #define LOG_USER        (1<<3)  /* random user-level messages */
94 #define LOG_MAIL        (2<<3)  /* mail system */
95 #define LOG_DAEMON      (3<<3)  /* system daemons */
96 #define LOG_AUTH        (4<<3)  /* authorization messages */
97 #define LOG_SYSLOG      (5<<3)  /* messages generated internally by syslogd */
98 #define LOG_LPR         (6<<3)  /* line printer subsystem */
99 #define LOG_NEWS        (7<<3)  /* network news subsystem */
100 #define LOG_UUCP        (8<<3)  /* UUCP subsystem */
101 #define LOG_CRON        (9<<3)  /* clock daemon */
102 #define LOG_AUTHPRIV    (10<<3) /* authorization messages (private) */
103                                 /* Facility #10 clashes in DEC UNIX, where */
104                                 /* it's defined as LOG_MEGASAFE for AdvFS  */
105                                 /* event logging.                          */
106 #define LOG_FTP         (11<<3) /* ftp daemon */
107 #define LOG_NTP         (12<<3) /* NTP subsystem */
108 #define LOG_SECURITY    (13<<3) /* security subsystems (firewalling, etc.) */
109 #define LOG_CONSOLE     (14<<3) /* /dev/console output */
110
111         /* other codes through 15 reserved for system use */
112 #define LOG_LOCAL0      (16<<3) /* reserved for local use */
113 #define LOG_LOCAL1      (17<<3) /* reserved for local use */
114 #define LOG_LOCAL2      (18<<3) /* reserved for local use */
115 #define LOG_LOCAL3      (19<<3) /* reserved for local use */
116 #define LOG_LOCAL4      (20<<3) /* reserved for local use */
117 #define LOG_LOCAL5      (21<<3) /* reserved for local use */
118 #define LOG_LOCAL6      (22<<3) /* reserved for local use */
119 #define LOG_LOCAL7      (23<<3) /* reserved for local use */
120
121 #define LOG_NFACILITIES 24      /* current number of facilities */
122 #define LOG_FACMASK     0x03f8  /* mask to extract facility part */
123                                 /* facility of pri */
124 #define LOG_FAC(p)      (((p) & LOG_FACMASK) >> 3)
125
126 #ifdef SYSLOG_NAMES
127 static const CODE facilitynames[] = {
128         { "auth",       LOG_AUTH,       },
129         { "authpriv",   LOG_AUTHPRIV,   },
130         { "console",    LOG_CONSOLE,    },
131         { "cron",       LOG_CRON,       },
132         { "daemon",     LOG_DAEMON,     },
133         { "ftp",        LOG_FTP,        },
134         { "kern",       LOG_KERN,       },
135         { "lpr",        LOG_LPR,        },
136         { "mail",       LOG_MAIL,       },
137         { "mark",       INTERNAL_MARK,  },      /* INTERNAL */
138         { "news",       LOG_NEWS,       },
139         { "ntp",        LOG_NTP,        },
140         { "security",   LOG_SECURITY,   },
141         { "syslog",     LOG_SYSLOG,     },
142         { "user",       LOG_USER,       },
143         { "uucp",       LOG_UUCP,       },
144         { "local0",     LOG_LOCAL0,     },
145         { "local1",     LOG_LOCAL1,     },
146         { "local2",     LOG_LOCAL2,     },
147         { "local3",     LOG_LOCAL3,     },
148         { "local4",     LOG_LOCAL4,     },
149         { "local5",     LOG_LOCAL5,     },
150         { "local6",     LOG_LOCAL6,     },
151         { "local7",     LOG_LOCAL7,     },
152         { NULL,         -1,             }
153 };
154 #endif
155
156 #ifdef _KERNEL
157 #define LOG_PRINTF      -1      /* pseudo-priority to indicate use of printf */
158 #endif
159
160 /*
161  * arguments to setlogmask.
162  */
163 #define LOG_MASK(pri)   (1 << (pri))            /* mask for one priority */
164 #define LOG_UPTO(pri)   ((1 << ((pri)+1)) - 1)  /* all priorities through pri */
165
166 /*
167  * Option flags for openlog.
168  *
169  * LOG_ODELAY no longer does anything.
170  * LOG_NDELAY is the inverse of what it used to be.
171  */
172 #define LOG_PID         0x01    /* log the pid with each message */
173 #define LOG_CONS        0x02    /* log on the console if errors in sending */
174 #define LOG_ODELAY      0x04    /* delay open until first syslog() (default) */
175 #define LOG_NDELAY      0x08    /* don't delay open */
176 #define LOG_NOWAIT      0x10    /* don't wait for console forks: DEPRECATED */
177 #define LOG_PERROR      0x20    /* log to stderr as well */
178
179 #ifdef _KERNEL
180
181 #else /* not _KERNEL */
182
183 /*
184  * Don't use va_list in the vsyslog() prototype.   Va_list is typedef'd in two
185  * places (<machine/varargs.h> and <machine/stdarg.h>), so if we include one
186  * of them here we may collide with the utility's includes.  It's unreasonable
187  * for utilities to have to include one of them to include syslog.h, so we get
188  * __va_list from <sys/_types.h> and use it.
189  */
190 #include <sys/cdefs.h>
191 #include <sys/_types.h>
192
193 __BEGIN_DECLS
194 void    closelog(void);
195 void    openlog(const char *, int, int);
196 int     setlogmask(int);
197 void    syslog(int, const char *, ...) __printflike(2, 3);
198 #if __BSD_VISIBLE
199 void    vsyslog(int, const char *, __va_list) __printflike(2, 0);
200 #endif
201 __END_DECLS
202
203 #endif /* !_KERNEL */
204
205 #endif