[BASE] Spelling fixes by Josh Soref. CORE-12286
[reactos.git] / reactos / base / services / telnetd / 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 */
31
32 #pragma once
33
34 #include <stdarg.h>
35
36 /*
37 * priorities/facilities are encoded into a single 32-bit quantity, where the
38 * bottom 3 bits are the priority (0-7) and the top 28 bits are the facility
39 * (0-big number). Both the priorities and the facilities map roughly
40 * one-to-one to strings in the syslogd(8) source code. This mapping is
41 * included in this file.
42 *
43 * priorities (these are ordered)
44 */
45 #define LOG_EMERG 0 /* system is unusable */
46 #define LOG_ALERT 1 /* action must be taken immediately */
47 #define LOG_CRIT 2 /* critical conditions */
48 #define LOG_ERR 3 /* error conditions */
49 #define LOG_WARNING 4 /* warning conditions */
50 #define LOG_NOTICE 5 /* normal but significant condition */
51 #define LOG_INFO 6 /* informational */
52 #define LOG_DEBUG 7 /* debug-level messages */
53
54 #define LOG_PRIMASK 0x07 /* mask to extract priority part (internal) */
55 /* extract priority */
56 #define LOG_PRI(p) ((p) & LOG_PRIMASK)
57 #define LOG_MAKEPRI(fac, pri) (((fac) << 3) | (pri))
58
59 #ifdef SYSLOG_NAMES
60 #define INTERNAL_NOPRI 0x10 /* the "no priority" priority */
61 /* mark "facility" */
62 #define INTERNAL_MARK LOG_MAKEPRI(LOG_NFACILITIES, 0)
63 typedef struct _code {
64 char *c_name;
65 int c_val;
66 } CODE;
67
68 CODE prioritynames[] =
69 {
70 { "alert", LOG_ALERT },
71 { "crit", LOG_CRIT },
72 { "debug", LOG_DEBUG },
73 { "emerg", LOG_EMERG },
74 { "err", LOG_ERR },
75 { "error", LOG_ERR }, /* DEPRECATED */
76 { "info", LOG_INFO },
77 { "none", INTERNAL_NOPRI }, /* INTERNAL */
78 { "notice", LOG_NOTICE },
79 { "panic", LOG_EMERG }, /* DEPRECATED */
80 { "warn", LOG_WARNING }, /* DEPRECATED */
81 { "warning", LOG_WARNING },
82 { NULL, -1 }
83 };
84 #endif
85
86 /* facility codes */
87 #define LOG_KERN (0<<3) /* kernel messages */
88 #define LOG_USER (1<<3) /* random user-level messages */
89 #define LOG_MAIL (2<<3) /* mail system */
90 #define LOG_DAEMON (3<<3) /* system daemons */
91 #define LOG_AUTH (4<<3) /* security/authorization messages */
92 #define LOG_SYSLOG (5<<3) /* messages generated internally by syslogd */
93 #define LOG_LPR (6<<3) /* line printer subsystem */
94 #define LOG_NEWS (7<<3) /* network news subsystem */
95 #define LOG_UUCP (8<<3) /* UUCP subsystem */
96 #define LOG_CRON (9<<3) /* clock daemon */
97 #define LOG_AUTHPRIV (10<<3) /* security/authorization messages (private) */
98 #define LOG_FTP (11<<3) /* ftp daemon */
99
100 /* other codes through 15 reserved for system use */
101 #define LOG_LOCAL0 (16<<3) /* reserved for local use */
102 #define LOG_LOCAL1 (17<<3) /* reserved for local use */
103 #define LOG_LOCAL2 (18<<3) /* reserved for local use */
104 #define LOG_LOCAL3 (19<<3) /* reserved for local use */
105 #define LOG_LOCAL4 (20<<3) /* reserved for local use */
106 #define LOG_LOCAL5 (21<<3) /* reserved for local use */
107 #define LOG_LOCAL6 (22<<3) /* reserved for local use */
108 #define LOG_LOCAL7 (23<<3) /* reserved for local use */
109
110 #define LOG_NFACILITIES 24 /* current number of facilities */
111 #define LOG_FACMASK 0x03f8 /* mask to extract facility part */
112 /* facility of pri */
113 #define LOG_FAC(p) (((p) & LOG_FACMASK) >> 3)
114
115 #ifdef SYSLOG_NAMES
116 CODE facilitynames[] =
117 {
118 { "auth", LOG_AUTH },
119 { "authpriv", LOG_AUTHPRIV },
120 { "cron", LOG_CRON },
121 { "daemon", LOG_DAEMON },
122 { "ftp", LOG_FTP },
123 { "kern", LOG_KERN },
124 { "lpr", LOG_LPR },
125 { "mail", LOG_MAIL },
126 { "mark", INTERNAL_MARK }, /* INTERNAL */
127 { "news", LOG_NEWS },
128 { "security", LOG_AUTH }, /* DEPRECATED */
129 { "syslog", LOG_SYSLOG },
130 { "user", LOG_USER },
131 { "uucp", LOG_UUCP },
132 { "local0", LOG_LOCAL0 },
133 { "local1", LOG_LOCAL1 },
134 { "local2", LOG_LOCAL2 },
135 { "local3", LOG_LOCAL3 },
136 { "local4", LOG_LOCAL4 },
137 { "local5", LOG_LOCAL5 },
138 { "local6", LOG_LOCAL6 },
139 { "local7", LOG_LOCAL7 },
140 { NULL, -1 }
141 };
142 #endif
143
144 /*
145 * arguments to setlogmask.
146 */
147 #define LOG_MASK(pri) (1 << (pri)) /* mask for one priority */
148 #define LOG_UPTO(pri) ((1 << ((pri)+1)) - 1) /* all priorities through pri */
149
150 /*
151 * Option flags for openlog.
152 *
153 * LOG_ODELAY no longer does anything.
154 * LOG_NDELAY is the inverse of what it used to be.
155 */
156 #define LOG_PID 0x01 /* log the pid with each message */
157 #define LOG_CONS 0x02 /* log on the console if errors in sending */
158 #define LOG_ODELAY 0x04 /* delay open until first syslog() (default) */
159 #define LOG_NDELAY 0x08 /* don't delay open */
160 #define LOG_NOWAIT 0x10 /* don't wait for console forks: DEPRECATED */
161 #define LOG_PERROR 0x20 /* log to stderr as well */
162
163 #define SYSLOG_PORT 514
164
165 #ifdef __cplusplus
166 extern "C" {
167 #endif
168
169 /* Close descriptor used to write to system logger. */
170 extern void closelog (void);
171
172 /* Open connection to system logger. */
173 extern void openlog (char *__ident, int __option, int __facility);
174
175 /* Set the log mask level. */
176 extern int setlogmask (int __mask);
177
178 /* Generate a log message using FMT string and option arguments. */
179 extern void syslog (int __pri, char *__fmt, ...);
180
181 /* Generate a log message using FMT and using arguments pointed to by AP. */
182 extern void vsyslog (int __pri, char *__fmt, va_list __ap);
183
184 /* windows-specific;
185 set directory from where syslog.host must be read;
186 this file contains a single line with hostname and port of syslog daemon;
187 default is localhost:514
188 */
189 extern const char* set_syslog_conf_dir( const char* dir );
190
191
192 #ifdef __cplusplus
193 }
194 #endif