xref: /freebsd/sys/sys/syslog.h (revision 29363fb4)
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 
32 #ifndef _SYS_SYSLOG_H_
33 #define _SYS_SYSLOG_H_
34 
35 #define	_PATH_LOG	"/var/run/log"
36 #define	_PATH_LOG_PRIV	"/var/run/logpriv"
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) | (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<<3), 0)
65 typedef struct _code {
66 	const char	*c_name;
67 	int		c_val;
68 } CODE;
69 
70 static const 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)	/* 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)	/* authorization messages (private) */
99 				/* Facility #10 clashes in DEC UNIX, where */
100 				/* it's defined as LOG_MEGASAFE for AdvFS  */
101 				/* event logging.                          */
102 #define	LOG_FTP		(11<<3)	/* ftp daemon */
103 #define	LOG_NTP		(12<<3)	/* NTP subsystem */
104 #define	LOG_SECURITY	(13<<3) /* security subsystems (firewalling, etc.) */
105 #define	LOG_CONSOLE	(14<<3) /* /dev/console output */
106 
107 	/* other codes through 15 reserved for system use */
108 #define	LOG_LOCAL0	(16<<3)	/* reserved for local use */
109 #define	LOG_LOCAL1	(17<<3)	/* reserved for local use */
110 #define	LOG_LOCAL2	(18<<3)	/* reserved for local use */
111 #define	LOG_LOCAL3	(19<<3)	/* reserved for local use */
112 #define	LOG_LOCAL4	(20<<3)	/* reserved for local use */
113 #define	LOG_LOCAL5	(21<<3)	/* reserved for local use */
114 #define	LOG_LOCAL6	(22<<3)	/* reserved for local use */
115 #define	LOG_LOCAL7	(23<<3)	/* reserved for local use */
116 
117 #define	LOG_NFACILITIES	24	/* current number of facilities */
118 #define	LOG_FACMASK	0x03f8	/* mask to extract facility part */
119 				/* facility of pri */
120 #define	LOG_FAC(p)	(((p) & LOG_FACMASK) >> 3)
121 
122 #ifdef SYSLOG_NAMES
123 static const CODE facilitynames[] = {
124 	{ "auth",	LOG_AUTH,	},
125 	{ "authpriv",	LOG_AUTHPRIV,	},
126 	{ "console", 	LOG_CONSOLE,	},
127 	{ "cron", 	LOG_CRON,	},
128 	{ "daemon",	LOG_DAEMON,	},
129 	{ "ftp",	LOG_FTP,	},
130 	{ "kern",	LOG_KERN,	},
131 	{ "lpr",	LOG_LPR,	},
132 	{ "mail",	LOG_MAIL,	},
133 	{ "mark", 	INTERNAL_MARK,	},	/* INTERNAL */
134 	{ "news",	LOG_NEWS,	},
135 	{ "ntp",	LOG_NTP,	},
136 	{ "security",	LOG_SECURITY,	},
137 	{ "syslog",	LOG_SYSLOG,	},
138 	{ "user",	LOG_USER,	},
139 	{ "uucp",	LOG_UUCP,	},
140 	{ "local0",	LOG_LOCAL0,	},
141 	{ "local1",	LOG_LOCAL1,	},
142 	{ "local2",	LOG_LOCAL2,	},
143 	{ "local3",	LOG_LOCAL3,	},
144 	{ "local4",	LOG_LOCAL4,	},
145 	{ "local5",	LOG_LOCAL5,	},
146 	{ "local6",	LOG_LOCAL6,	},
147 	{ "local7",	LOG_LOCAL7,	},
148 	{ NULL,		-1,		}
149 };
150 #endif
151 
152 #ifdef _KERNEL
153 #define	LOG_PRINTF	-1	/* pseudo-priority to indicate use of printf */
154 #endif
155 
156 /*
157  * arguments to setlogmask.
158  */
159 #define	LOG_MASK(pri)	(1 << (pri))		/* mask for one priority */
160 #define	LOG_UPTO(pri)	((1 << ((pri)+1)) - 1)	/* all priorities through pri */
161 
162 /*
163  * Option flags for openlog.
164  *
165  * LOG_ODELAY no longer does anything.
166  * LOG_NDELAY is the inverse of what it used to be.
167  */
168 #define	LOG_PID		0x01	/* log the pid with each message */
169 #define	LOG_CONS	0x02	/* log on the console if errors in sending */
170 #define	LOG_ODELAY	0x04	/* delay open until first syslog() (default) */
171 #define	LOG_NDELAY	0x08	/* don't delay open */
172 #define	LOG_NOWAIT	0x10	/* don't wait for console forks: DEPRECATED */
173 #define	LOG_PERROR	0x20	/* log to stderr as well */
174 
175 #ifdef _KERNEL
176 
177 #else /* not _KERNEL */
178 
179 /*
180  * Don't use va_list in the vsyslog() prototype.   Va_list is typedef'd in two
181  * places (<machine/varargs.h> and <machine/stdarg.h>), so if we include one
182  * of them here we may collide with the utility's includes.  It's unreasonable
183  * for utilities to have to include one of them to include syslog.h, so we get
184  * __va_list from <sys/_types.h> and use it.
185  */
186 #include <sys/cdefs.h>
187 #include <sys/_types.h>
188 
189 __BEGIN_DECLS
190 void	closelog(void);
191 void	openlog(const char *, int, int);
192 int	setlogmask(int);
193 void	syslog(int, const char *, ...) __printflike(2, 3);
194 #if __BSD_VISIBLE
195 void	vsyslog(int, const char *, __va_list) __printflike(2, 0);
196 #endif
197 __END_DECLS
198 
199 #endif /* !_KERNEL */
200 
201 #endif
202