master
1/* $NetBSD: syslog.h,v 1.41.44.1 2024/10/08 11:16:17 martin Exp $ */
2
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 */
33
34#ifndef _SYS_SYSLOG_H_
35#define _SYS_SYSLOG_H_
36
37#include <sys/cdefs.h>
38#include <sys/featuretest.h>
39#include <sys/ansi.h>
40#include <sys/stdarg.h>
41
42#define _PATH_LOG "/var/run/log"
43
44/*
45 * priorities/facilities are encoded into a single 32-bit quantity, where the
46 * bottom 3 bits are the priority (0-7) and the top 28 bits are the facility
47 * (0-big number). Both the priorities and the facilities map roughly
48 * one-to-one to strings in the syslogd(8) source code. This mapping is
49 * included in this file.
50 *
51 * priorities (these are ordered)
52 */
53#define LOG_EMERG 0 /* system is unusable */
54#define LOG_ALERT 1 /* action must be taken immediately */
55#define LOG_CRIT 2 /* critical conditions */
56#define LOG_ERR 3 /* error conditions */
57#define LOG_WARNING 4 /* warning conditions */
58#define LOG_NOTICE 5 /* normal but significant condition */
59#define LOG_INFO 6 /* informational */
60#define LOG_DEBUG 7 /* debug-level messages */
61
62#define LOG_PRIMASK 0x07 /* mask to extract priority part (internal) */
63 /* extract priority */
64#define LOG_PRI(p) ((p) & LOG_PRIMASK)
65#define LOG_MAKEPRI(fac, pri) (((fac) << 3) | (pri))
66
67#ifdef SYSLOG_NAMES
68#define INTERNAL_NOPRI 0x10 /* the "no priority" priority */
69 /* mark "facility" */
70#define INTERNAL_MARK LOG_MAKEPRI(LOG_NFACILITIES, 0)
71typedef struct _code {
72 const char *c_name;
73 int c_val;
74} CODE;
75
76CODE prioritynames[] = {
77 { "alert", LOG_ALERT },
78 { "crit", LOG_CRIT },
79 { "debug", LOG_DEBUG },
80 { "emerg", LOG_EMERG },
81 { "err", LOG_ERR },
82 { "error", LOG_ERR }, /* DEPRECATED */
83 { "info", LOG_INFO },
84 { "none", INTERNAL_NOPRI }, /* INTERNAL */
85 { "notice", LOG_NOTICE },
86 { "panic", LOG_EMERG }, /* DEPRECATED */
87 { "warn", LOG_WARNING }, /* DEPRECATED */
88 { "warning", LOG_WARNING },
89 { NULL, -1 }
90};
91#endif /* SYSLOG_NAMES */
92
93/* facility codes */
94#define LOG_KERN (0<<3) /* kernel messages */
95#define LOG_USER (1<<3) /* random user-level messages */
96#define LOG_MAIL (2<<3) /* mail system */
97#define LOG_DAEMON (3<<3) /* system daemons */
98#define LOG_AUTH (4<<3) /* security/authorization messages */
99#define LOG_SYSLOG (5<<3) /* messages generated internally by syslogd */
100#define LOG_LPR (6<<3) /* line printer subsystem */
101#define LOG_NEWS (7<<3) /* network news subsystem */
102#define LOG_UUCP (8<<3) /* UUCP subsystem */
103#define LOG_CRON (9<<3) /* clock daemon */
104#define LOG_AUTHPRIV (10<<3) /* security/authorization messages (private) */
105#define LOG_FTP (11<<3) /* ftp daemon */
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
123CODE facilitynames[] = {
124 { "auth", LOG_AUTH },
125 { "authpriv", LOG_AUTHPRIV },
126 { "cron", LOG_CRON },
127 { "daemon", LOG_DAEMON },
128 { "ftp", LOG_FTP },
129 { "kern", LOG_KERN },
130 { "lpr", LOG_LPR },
131 { "mail", LOG_MAIL },
132 { "mark", INTERNAL_MARK }, /* INTERNAL */
133 { "news", LOG_NEWS },
134 { "security", LOG_AUTH }, /* DEPRECATED */
135 { "syslog", LOG_SYSLOG },
136 { "user", LOG_USER },
137 { "uucp", LOG_UUCP },
138 { "local0", LOG_LOCAL0 },
139 { "local1", LOG_LOCAL1 },
140 { "local2", LOG_LOCAL2 },
141 { "local3", LOG_LOCAL3 },
142 { "local4", LOG_LOCAL4 },
143 { "local5", LOG_LOCAL5 },
144 { "local6", LOG_LOCAL6 },
145 { "local7", LOG_LOCAL7 },
146 { NULL, -1 }
147};
148#endif /* SYSLOG_NAMES */
149
150#ifdef _KERNEL
151#define LOG_PRINTF -1 /* pseudo-priority to indicate use of printf */
152#endif
153
154/*
155 * arguments to setlogmask.
156 */
157#define LOG_MASK(pri) (1 << (pri)) /* mask for one priority */
158#define LOG_UPTO(pri) ((1 << ((pri)+1)) - 1) /* all priorities through pri */
159
160/*
161 * Option flags for openlog.
162 *
163 * LOG_ODELAY no longer does anything.
164 * LOG_NDELAY is the inverse of what it used to be.
165 */
166#define LOG_PID 0x01 /* log the pid with each message */
167#define LOG_CONS 0x02 /* log on the console if errors in sending */
168#define LOG_ODELAY 0x04 /* delay open until first syslog() (default) */
169#define LOG_NDELAY 0x08 /* don't delay open */
170#define LOG_NOWAIT 0x10 /* don't wait for console forks: DEPRECATED */
171#define LOG_PERROR 0x20 /* log to stderr as well */
172#define LOG_PTRIM 0x40 /* trim tag and pid from messages to stderr */
173#define LOG_NLOG 0x80 /* don't write to the system log */
174
175#ifndef _KERNEL
176
177/* Used by reentrant functions */
178
179struct syslog_data {
180 int log_version;
181 int log_file;
182 int log_connected;
183 int log_opened;
184 int log_stat;
185 const char *log_tag;
186 char log_hostname[256]; /* MAXHOSTNAMELEN */
187 int log_fac;
188 int log_mask;
189};
190
191#define SYSLOG_DATA_INIT { \
192 .log_version = 1, \
193 .log_file = -1, \
194 .log_connected = 0, \
195 .log_opened = 0, \
196 .log_stat = 0, \
197 .log_tag = 0, \
198 .log_hostname = { '\0' }, \
199 .log_fac = LOG_USER, \
200 .log_mask = 0xff, \
201}
202
203__BEGIN_DECLS
204void closelog(void);
205void openlog(const char *, int, int);
206int setlogmask(int);
207void syslog(int, const char *, ...) __sysloglike(2, 3);
208#if defined(_NETBSD_SOURCE)
209void vsyslog(int, const char *, __va_list) __sysloglike(2, 0);
210#ifndef __LIBC12_SOURCE__
211void closelog_r(struct syslog_data *) __RENAME(__closelog_r60);
212void openlog_r(const char *, int, int, struct syslog_data *)
213 __RENAME(__openlog_r60);
214int setlogmask_r(int, struct syslog_data *) __RENAME(__setlogmask_r60);
215void syslog_r(int, struct syslog_data *, const char *, ...)
216 __RENAME(__syslog_r60) __sysloglike(3, 4);
217void vsyslog_r(int, struct syslog_data *, const char *, __va_list)
218 __RENAME(__vsyslog_r60) __sysloglike(3, 0);
219void syslogp_r(int, struct syslog_data *, const char *, const char *,
220 const char *, ...) __RENAME(__syslogp_r60) __sysloglike(5, 6);
221void vsyslogp_r(int, struct syslog_data *, const char *, const char *,
222 const char *, __va_list) __RENAME(__vsyslogp_r60) __sysloglike(5, 0);
223void syslog_ss(int, struct syslog_data *, const char *, ...)
224 __RENAME(__syslog_ss60) __sysloglike(3, 4);
225void vsyslog_ss(int, struct syslog_data *, const char *, va_list)
226 __RENAME(__vsyslog_ss60) __sysloglike(3, 0);
227void syslogp_ss(int, struct syslog_data *, const char *, const char *,
228 const char *, ...) __RENAME(__syslogp_ss60) __sysloglike(5, 0);
229void vsyslogp_ss(int, struct syslog_data *, const char *, const char *,
230 const char *, va_list) __RENAME(__vsyslogp_ss60) __sysloglike(5, 0);
231#endif
232void syslogp(int, const char *, const char *, const char *, ...)
233 __sysloglike(4, 5);
234void vsyslogp(int, const char *, const char *, const char *, __va_list)
235 __sysloglike(4, 0);
236#endif
237__END_DECLS
238
239#else /* !_KERNEL */
240
241void logpri(int);
242void log(int, const char *, ...) __printflike(2, 3);
243void vlog(int, const char *, __va_list) __printflike(2, 0);
244void addlog(const char *, ...) __printflike(1, 2);
245void logwakeup(void);
246
247#endif /* !_KERNEL */
248
249#endif /* !_SYS_SYSLOG_H_ */