log.c revision 1.7 1 1.4 christos /* $NetBSD: log.c,v 1.7 2022/09/23 12:15:33 christos Exp $ */
2 1.1 christos
3 1.1 christos /*
4 1.1 christos * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
5 1.1 christos *
6 1.7 christos * SPDX-License-Identifier: MPL-2.0
7 1.7 christos *
8 1.1 christos * This Source Code Form is subject to the terms of the Mozilla Public
9 1.1 christos * License, v. 2.0. If a copy of the MPL was not distributed with this
10 1.6 christos * file, you can obtain one at https://mozilla.org/MPL/2.0/.
11 1.1 christos *
12 1.1 christos * See the COPYRIGHT file distributed with this work for additional
13 1.1 christos * information regarding copyright ownership.
14 1.1 christos */
15 1.1 christos
16 1.1 christos /*! \file */
17 1.1 christos
18 1.1 christos #include <errno.h>
19 1.3 christos #include <inttypes.h>
20 1.5 christos #include <limits.h>
21 1.3 christos #include <stdbool.h>
22 1.1 christos #include <stdlib.h>
23 1.5 christos #include <sys/types.h> /* dev_t FreeBSD 2.1 */
24 1.1 christos #include <time.h>
25 1.1 christos
26 1.5 christos #include <isc/atomic.h>
27 1.1 christos #include <isc/dir.h>
28 1.1 christos #include <isc/file.h>
29 1.1 christos #include <isc/log.h>
30 1.1 christos #include <isc/magic.h>
31 1.1 christos #include <isc/mem.h>
32 1.5 christos #include <isc/platform.h>
33 1.1 christos #include <isc/print.h>
34 1.5 christos #include <isc/rwlock.h>
35 1.1 christos #include <isc/stat.h>
36 1.1 christos #include <isc/stdio.h>
37 1.1 christos #include <isc/string.h>
38 1.1 christos #include <isc/time.h>
39 1.1 christos #include <isc/util.h>
40 1.1 christos
41 1.5 christos #define LCTX_MAGIC ISC_MAGIC('L', 'c', 't', 'x')
42 1.5 christos #define VALID_CONTEXT(lctx) ISC_MAGIC_VALID(lctx, LCTX_MAGIC)
43 1.1 christos
44 1.5 christos #define LCFG_MAGIC ISC_MAGIC('L', 'c', 'f', 'g')
45 1.5 christos #define VALID_CONFIG(lcfg) ISC_MAGIC_VALID(lcfg, LCFG_MAGIC)
46 1.5 christos
47 1.5 christos #define RDLOCK(lp) RWLOCK(lp, isc_rwlocktype_read);
48 1.5 christos #define WRLOCK(lp) RWLOCK(lp, isc_rwlocktype_write);
49 1.5 christos #define RDUNLOCK(lp) RWUNLOCK(lp, isc_rwlocktype_read);
50 1.5 christos #define WRUNLOCK(lp) RWUNLOCK(lp, isc_rwlocktype_write);
51 1.1 christos
52 1.1 christos /*
53 1.1 christos * XXXDCL make dynamic?
54 1.1 christos */
55 1.5 christos #define LOG_BUFFER_SIZE (8 * 1024)
56 1.1 christos
57 1.1 christos /*!
58 1.1 christos * This is the structure that holds each named channel. A simple linked
59 1.1 christos * list chains all of the channels together, so an individual channel is
60 1.1 christos * found by doing strcmp()s with the names down the list. Their should
61 1.1 christos * be no performance penalty from this as it is expected that the number
62 1.1 christos * of named channels will be no more than a dozen or so, and name lookups
63 1.1 christos * from the head of the list are only done when isc_log_usechannel() is
64 1.1 christos * called, which should also be very infrequent.
65 1.1 christos */
66 1.1 christos typedef struct isc_logchannel isc_logchannel_t;
67 1.1 christos
68 1.1 christos struct isc_logchannel {
69 1.5 christos char *name;
70 1.5 christos unsigned int type;
71 1.5 christos int level;
72 1.5 christos unsigned int flags;
73 1.5 christos isc_logdestination_t destination;
74 1.5 christos ISC_LINK(isc_logchannel_t) link;
75 1.1 christos };
76 1.1 christos
77 1.1 christos /*!
78 1.1 christos * The logchannellist structure associates categories and modules with
79 1.1 christos * channels. First the appropriate channellist is found based on the
80 1.1 christos * category, and then each structure in the linked list is checked for
81 1.1 christos * a matching module. It is expected that the number of channels
82 1.1 christos * associated with any given category will be very short, no more than
83 1.1 christos * three or four in the more unusual cases.
84 1.1 christos */
85 1.1 christos typedef struct isc_logchannellist isc_logchannellist_t;
86 1.1 christos
87 1.1 christos struct isc_logchannellist {
88 1.5 christos const isc_logmodule_t *module;
89 1.5 christos isc_logchannel_t *channel;
90 1.5 christos ISC_LINK(isc_logchannellist_t) link;
91 1.1 christos };
92 1.1 christos
93 1.1 christos /*!
94 1.1 christos * This structure is used to remember messages for pruning via
95 1.1 christos * isc_log_[v]write1().
96 1.1 christos */
97 1.1 christos typedef struct isc_logmessage isc_logmessage_t;
98 1.1 christos
99 1.1 christos struct isc_logmessage {
100 1.5 christos char *text;
101 1.5 christos isc_time_t time;
102 1.5 christos ISC_LINK(isc_logmessage_t) link;
103 1.1 christos };
104 1.1 christos
105 1.1 christos /*!
106 1.1 christos * The isc_logconfig structure is used to store the configurable information
107 1.1 christos * about where messages are actually supposed to be sent -- the information
108 1.1 christos * that could changed based on some configuration file, as opposed to the
109 1.1 christos * the category/module specification of isc_log_[v]write[1] that is compiled
110 1.1 christos * into a program, or the debug_level which is dynamic state information.
111 1.1 christos */
112 1.1 christos struct isc_logconfig {
113 1.5 christos unsigned int magic;
114 1.5 christos isc_log_t *lctx;
115 1.5 christos ISC_LIST(isc_logchannel_t) channels;
116 1.5 christos ISC_LIST(isc_logchannellist_t) * channellists;
117 1.5 christos unsigned int channellist_count;
118 1.5 christos unsigned int duplicate_interval;
119 1.5 christos int_fast32_t highest_level;
120 1.5 christos char *tag;
121 1.5 christos bool dynamic;
122 1.1 christos };
123 1.1 christos
124 1.1 christos /*!
125 1.1 christos * This isc_log structure provides the context for the isc_log functions.
126 1.1 christos * The log context locks itself in isc_log_doit, the internal backend to
127 1.1 christos * isc_log_write. The locking is necessary both to provide exclusive access
128 1.1 christos * to the buffer into which the message is formatted and to guard against
129 1.1 christos * competing threads trying to write to the same syslog resource. (On
130 1.1 christos * some systems, such as BSD/OS, stdio is thread safe but syslog is not.)
131 1.1 christos * Unfortunately, the lock cannot guard against a _different_ logging
132 1.1 christos * context in the same program competing for syslog's attention. Thus
133 1.1 christos * There Can Be Only One, but this is not enforced.
134 1.1 christos * XXXDCL enforce it?
135 1.1 christos *
136 1.1 christos * Note that the category and module information is not locked.
137 1.1 christos * This is because in the usual case, only one isc_log_t is ever created
138 1.1 christos * in a program, and the category/module registration happens only once.
139 1.1 christos * XXXDCL it might be wise to add more locking overall.
140 1.1 christos */
141 1.1 christos struct isc_log {
142 1.1 christos /* Not locked. */
143 1.5 christos unsigned int magic;
144 1.5 christos isc_mem_t *mctx;
145 1.5 christos isc_logcategory_t *categories;
146 1.5 christos unsigned int category_count;
147 1.5 christos isc_logmodule_t *modules;
148 1.5 christos unsigned int module_count;
149 1.5 christos atomic_int_fast32_t debug_level;
150 1.5 christos isc_rwlock_t lcfg_rwl;
151 1.5 christos /* Locked by isc_log lcfg_rwl */
152 1.5 christos isc_logconfig_t *logconfig;
153 1.5 christos isc_mutex_t lock;
154 1.1 christos /* Locked by isc_log lock. */
155 1.5 christos char buffer[LOG_BUFFER_SIZE];
156 1.5 christos ISC_LIST(isc_logmessage_t) messages;
157 1.5 christos atomic_bool dynamic;
158 1.5 christos atomic_int_fast32_t highest_level;
159 1.1 christos };
160 1.1 christos
161 1.1 christos /*!
162 1.1 christos * Used when ISC_LOG_PRINTLEVEL is enabled for a channel.
163 1.1 christos */
164 1.5 christos static const char *log_level_strings[] = { "debug", "info", "notice",
165 1.5 christos "warning", "error", "critical" };
166 1.1 christos
167 1.1 christos /*!
168 1.1 christos * Used to convert ISC_LOG_* priorities into syslog priorities.
169 1.1 christos * XXXDCL This will need modification for NT.
170 1.1 christos */
171 1.5 christos static const int syslog_map[] = { LOG_DEBUG, LOG_INFO, LOG_NOTICE,
172 1.5 christos LOG_WARNING, LOG_ERR, LOG_CRIT };
173 1.1 christos
174 1.1 christos /*!
175 1.1 christos * When adding new categories, a corresponding ISC_LOGCATEGORY_foo
176 1.1 christos * definition needs to be added to <isc/log.h>.
177 1.1 christos *
178 1.1 christos * The default category is provided so that the internal default can
179 1.1 christos * be overridden. Since the default is always looked up as the first
180 1.1 christos * channellist in the log context, it must come first in isc_categories[].
181 1.1 christos */
182 1.5 christos LIBISC_EXTERNAL_DATA isc_logcategory_t isc_categories[] = { { "default",
183 1.5 christos 0 }, /* "default
184 1.5 christos must come
185 1.5 christos first. */
186 1.5 christos { "general", 0 },
187 1.5 christos { NULL, 0 } };
188 1.1 christos
189 1.1 christos /*!
190 1.5 christos * See above comment for categories on LIBISC_EXTERNAL_DATA, and apply it to
191 1.5 christos * modules.
192 1.1 christos */
193 1.1 christos LIBISC_EXTERNAL_DATA isc_logmodule_t isc_modules[] = {
194 1.5 christos { "socket", 0 }, { "time", 0 }, { "interface", 0 }, { "timer", 0 },
195 1.5 christos { "file", 0 }, { "netmgr", 0 }, { "other", 0 }, { NULL, 0 }
196 1.1 christos };
197 1.1 christos
198 1.1 christos /*!
199 1.1 christos * This essentially constant structure must be filled in at run time,
200 1.1 christos * because its channel member is pointed to a channel that is created
201 1.1 christos * dynamically with isc_log_createchannel.
202 1.1 christos */
203 1.1 christos static isc_logchannellist_t default_channel;
204 1.1 christos
205 1.1 christos /*!
206 1.1 christos * libisc logs to this context.
207 1.1 christos */
208 1.1 christos LIBISC_EXTERNAL_DATA isc_log_t *isc_lctx = NULL;
209 1.1 christos
210 1.1 christos /*!
211 1.1 christos * Forward declarations.
212 1.1 christos */
213 1.5 christos static void
214 1.1 christos assignchannel(isc_logconfig_t *lcfg, unsigned int category_id,
215 1.1 christos const isc_logmodule_t *module, isc_logchannel_t *channel);
216 1.1 christos
217 1.5 christos static void
218 1.1 christos sync_channellist(isc_logconfig_t *lcfg);
219 1.1 christos
220 1.5 christos static void
221 1.5 christos sync_highest_level(isc_log_t *lctx, isc_logconfig_t *lcfg);
222 1.5 christos
223 1.1 christos static isc_result_t
224 1.1 christos greatest_version(isc_logfile_t *file, int versions, int *greatest);
225 1.1 christos
226 1.1 christos static void
227 1.1 christos isc_log_doit(isc_log_t *lctx, isc_logcategory_t *category,
228 1.3 christos isc_logmodule_t *module, int level, bool write_once,
229 1.5 christos const char *format, va_list args) ISC_FORMAT_PRINTF(6, 0);
230 1.1 christos
231 1.1 christos /*@{*/
232 1.1 christos /*!
233 1.1 christos * Convenience macros.
234 1.1 christos */
235 1.1 christos
236 1.1 christos #define FACILITY(channel) (channel->destination.facility)
237 1.1 christos #define FILE_NAME(channel) (channel->destination.file.name)
238 1.1 christos #define FILE_STREAM(channel) (channel->destination.file.stream)
239 1.1 christos #define FILE_VERSIONS(channel) (channel->destination.file.versions)
240 1.1 christos #define FILE_SUFFIX(channel) (channel->destination.file.suffix)
241 1.1 christos #define FILE_MAXSIZE(channel) (channel->destination.file.maximum_size)
242 1.1 christos #define FILE_MAXREACHED(channel) (channel->destination.file.maximum_reached)
243 1.1 christos
244 1.1 christos /*@}*/
245 1.1 christos /****
246 1.5 christos **** Public interfaces.
247 1.5 christos ****/
248 1.1 christos
249 1.1 christos /*
250 1.1 christos * Establish a new logging context, with default channels.
251 1.1 christos */
252 1.5 christos void
253 1.1 christos isc_log_create(isc_mem_t *mctx, isc_log_t **lctxp, isc_logconfig_t **lcfgp) {
254 1.1 christos isc_log_t *lctx;
255 1.1 christos isc_logconfig_t *lcfg = NULL;
256 1.1 christos
257 1.1 christos REQUIRE(mctx != NULL);
258 1.1 christos REQUIRE(lctxp != NULL && *lctxp == NULL);
259 1.1 christos REQUIRE(lcfgp == NULL || *lcfgp == NULL);
260 1.1 christos
261 1.1 christos lctx = isc_mem_get(mctx, sizeof(*lctx));
262 1.5 christos lctx->mctx = NULL;
263 1.5 christos isc_mem_attach(mctx, &lctx->mctx);
264 1.5 christos lctx->categories = NULL;
265 1.5 christos lctx->category_count = 0;
266 1.5 christos lctx->modules = NULL;
267 1.5 christos lctx->module_count = 0;
268 1.5 christos atomic_init(&lctx->debug_level, 0);
269 1.1 christos
270 1.5 christos ISC_LIST_INIT(lctx->messages);
271 1.1 christos
272 1.5 christos isc_mutex_init(&lctx->lock);
273 1.5 christos isc_rwlock_init(&lctx->lcfg_rwl, 0, 0);
274 1.1 christos
275 1.5 christos /*
276 1.5 christos * Normally setting the magic number is the last step done
277 1.5 christos * in a creation function, but a valid log context is needed
278 1.5 christos * by isc_log_registercategories and isc_logconfig_create.
279 1.5 christos * If either fails, the lctx is destroyed and not returned
280 1.5 christos * to the caller.
281 1.5 christos */
282 1.5 christos lctx->magic = LCTX_MAGIC;
283 1.1 christos
284 1.5 christos isc_log_registercategories(lctx, isc_categories);
285 1.5 christos isc_log_registermodules(lctx, isc_modules);
286 1.5 christos isc_logconfig_create(lctx, &lcfg);
287 1.1 christos
288 1.5 christos sync_channellist(lcfg);
289 1.1 christos
290 1.5 christos lctx->logconfig = lcfg;
291 1.1 christos
292 1.5 christos atomic_init(&lctx->highest_level, lcfg->highest_level);
293 1.5 christos atomic_init(&lctx->dynamic, lcfg->dynamic);
294 1.1 christos
295 1.5 christos *lctxp = lctx;
296 1.5 christos if (lcfgp != NULL) {
297 1.5 christos *lcfgp = lcfg;
298 1.1 christos }
299 1.1 christos }
300 1.1 christos
301 1.5 christos void
302 1.1 christos isc_logconfig_create(isc_log_t *lctx, isc_logconfig_t **lcfgp) {
303 1.1 christos isc_logconfig_t *lcfg;
304 1.1 christos isc_logdestination_t destination;
305 1.1 christos int level = ISC_LOG_INFO;
306 1.1 christos
307 1.1 christos REQUIRE(lcfgp != NULL && *lcfgp == NULL);
308 1.1 christos REQUIRE(VALID_CONTEXT(lctx));
309 1.1 christos
310 1.1 christos lcfg = isc_mem_get(lctx->mctx, sizeof(*lcfg));
311 1.1 christos
312 1.5 christos lcfg->lctx = lctx;
313 1.5 christos lcfg->channellists = NULL;
314 1.5 christos lcfg->channellist_count = 0;
315 1.5 christos lcfg->duplicate_interval = 0;
316 1.5 christos lcfg->highest_level = level;
317 1.5 christos lcfg->tag = NULL;
318 1.5 christos lcfg->dynamic = false;
319 1.5 christos ISC_LIST_INIT(lcfg->channels);
320 1.5 christos lcfg->magic = LCFG_MAGIC;
321 1.1 christos
322 1.1 christos /*
323 1.1 christos * Create the default channels:
324 1.5 christos * default_syslog, default_stderr, default_debug and null.
325 1.1 christos */
326 1.5 christos destination.facility = LOG_DAEMON;
327 1.5 christos isc_log_createchannel(lcfg, "default_syslog", ISC_LOG_TOSYSLOG, level,
328 1.5 christos &destination, 0);
329 1.5 christos
330 1.5 christos destination.file.stream = stderr;
331 1.5 christos destination.file.name = NULL;
332 1.5 christos destination.file.versions = ISC_LOG_ROLLNEVER;
333 1.5 christos destination.file.suffix = isc_log_rollsuffix_increment;
334 1.5 christos destination.file.maximum_size = 0;
335 1.5 christos isc_log_createchannel(lcfg, "default_stderr", ISC_LOG_TOFILEDESC, level,
336 1.5 christos &destination, ISC_LOG_PRINTTIME);
337 1.5 christos
338 1.5 christos /*
339 1.5 christos * Set the default category's channel to default_stderr,
340 1.5 christos * which is at the head of the channels list because it was
341 1.5 christos * just created.
342 1.5 christos */
343 1.5 christos default_channel.channel = ISC_LIST_HEAD(lcfg->channels);
344 1.5 christos
345 1.5 christos destination.file.stream = stderr;
346 1.5 christos destination.file.name = NULL;
347 1.5 christos destination.file.versions = ISC_LOG_ROLLNEVER;
348 1.5 christos destination.file.suffix = isc_log_rollsuffix_increment;
349 1.5 christos destination.file.maximum_size = 0;
350 1.5 christos isc_log_createchannel(lcfg, "default_debug", ISC_LOG_TOFILEDESC,
351 1.5 christos ISC_LOG_DYNAMIC, &destination, ISC_LOG_PRINTTIME);
352 1.1 christos
353 1.5 christos isc_log_createchannel(lcfg, "null", ISC_LOG_TONULL, ISC_LOG_DYNAMIC,
354 1.5 christos NULL, 0);
355 1.1 christos
356 1.5 christos *lcfgp = lcfg;
357 1.1 christos }
358 1.1 christos
359 1.5 christos void
360 1.1 christos isc_logconfig_use(isc_log_t *lctx, isc_logconfig_t *lcfg) {
361 1.1 christos isc_logconfig_t *old_cfg;
362 1.1 christos
363 1.1 christos REQUIRE(VALID_CONTEXT(lctx));
364 1.1 christos REQUIRE(VALID_CONFIG(lcfg));
365 1.1 christos REQUIRE(lcfg->lctx == lctx);
366 1.1 christos
367 1.1 christos /*
368 1.1 christos * Ensure that lcfg->channellist_count == lctx->category_count.
369 1.1 christos * They won't be equal if isc_log_usechannel has not been called
370 1.1 christos * since any call to isc_log_registercategories.
371 1.1 christos */
372 1.5 christos sync_channellist(lcfg);
373 1.1 christos
374 1.5 christos WRLOCK(&lctx->lcfg_rwl);
375 1.1 christos old_cfg = lctx->logconfig;
376 1.1 christos lctx->logconfig = lcfg;
377 1.5 christos sync_highest_level(lctx, lcfg);
378 1.5 christos WRUNLOCK(&lctx->lcfg_rwl);
379 1.1 christos
380 1.1 christos isc_logconfig_destroy(&old_cfg);
381 1.1 christos }
382 1.1 christos
383 1.1 christos void
384 1.1 christos isc_log_destroy(isc_log_t **lctxp) {
385 1.1 christos isc_log_t *lctx;
386 1.1 christos isc_logconfig_t *lcfg;
387 1.1 christos isc_mem_t *mctx;
388 1.1 christos isc_logmessage_t *message;
389 1.1 christos
390 1.1 christos REQUIRE(lctxp != NULL && VALID_CONTEXT(*lctxp));
391 1.1 christos
392 1.1 christos lctx = *lctxp;
393 1.5 christos *lctxp = NULL;
394 1.1 christos mctx = lctx->mctx;
395 1.1 christos
396 1.5 christos /* Stop the logging as a first thing */
397 1.5 christos atomic_store_release(&lctx->debug_level, 0);
398 1.5 christos atomic_store_release(&lctx->highest_level, 0);
399 1.5 christos atomic_store_release(&lctx->dynamic, false);
400 1.5 christos
401 1.5 christos WRLOCK(&lctx->lcfg_rwl);
402 1.5 christos lcfg = lctx->logconfig;
403 1.5 christos lctx->logconfig = NULL;
404 1.5 christos WRUNLOCK(&lctx->lcfg_rwl);
405 1.5 christos
406 1.5 christos if (lcfg != NULL) {
407 1.1 christos isc_logconfig_destroy(&lcfg);
408 1.1 christos }
409 1.1 christos
410 1.5 christos isc_rwlock_destroy(&lctx->lcfg_rwl);
411 1.3 christos isc_mutex_destroy(&lctx->lock);
412 1.1 christos
413 1.1 christos while ((message = ISC_LIST_HEAD(lctx->messages)) != NULL) {
414 1.1 christos ISC_LIST_UNLINK(lctx->messages, message, link);
415 1.1 christos
416 1.1 christos isc_mem_put(mctx, message,
417 1.1 christos sizeof(*message) + strlen(message->text) + 1);
418 1.1 christos }
419 1.1 christos
420 1.1 christos lctx->buffer[0] = '\0';
421 1.1 christos lctx->categories = NULL;
422 1.1 christos lctx->category_count = 0;
423 1.1 christos lctx->modules = NULL;
424 1.1 christos lctx->module_count = 0;
425 1.1 christos lctx->mctx = NULL;
426 1.1 christos lctx->magic = 0;
427 1.1 christos
428 1.1 christos isc_mem_putanddetach(&mctx, lctx, sizeof(*lctx));
429 1.1 christos }
430 1.1 christos
431 1.1 christos void
432 1.1 christos isc_logconfig_destroy(isc_logconfig_t **lcfgp) {
433 1.1 christos isc_logconfig_t *lcfg;
434 1.1 christos isc_mem_t *mctx;
435 1.1 christos isc_logchannel_t *channel;
436 1.1 christos char *filename;
437 1.1 christos unsigned int i;
438 1.1 christos
439 1.1 christos REQUIRE(lcfgp != NULL && VALID_CONFIG(*lcfgp));
440 1.1 christos
441 1.1 christos lcfg = *lcfgp;
442 1.5 christos *lcfgp = NULL;
443 1.1 christos
444 1.1 christos /*
445 1.1 christos * This function cannot be called with a logconfig that is in
446 1.1 christos * use by a log context.
447 1.1 christos */
448 1.5 christos REQUIRE(lcfg->lctx != NULL);
449 1.5 christos
450 1.5 christos RDLOCK(&lcfg->lctx->lcfg_rwl);
451 1.5 christos REQUIRE(lcfg->lctx->logconfig != lcfg);
452 1.5 christos RDUNLOCK(&lcfg->lctx->lcfg_rwl);
453 1.1 christos
454 1.1 christos mctx = lcfg->lctx->mctx;
455 1.1 christos
456 1.1 christos while ((channel = ISC_LIST_HEAD(lcfg->channels)) != NULL) {
457 1.1 christos ISC_LIST_UNLINK(lcfg->channels, channel, link);
458 1.1 christos
459 1.1 christos if (channel->type == ISC_LOG_TOFILE) {
460 1.1 christos /*
461 1.1 christos * The filename for the channel may have ultimately
462 1.1 christos * started its life in user-land as a const string,
463 1.1 christos * but in isc_log_createchannel it gets copied
464 1.1 christos * into writable memory and is not longer truly const.
465 1.1 christos */
466 1.1 christos DE_CONST(FILE_NAME(channel), filename);
467 1.1 christos isc_mem_free(mctx, filename);
468 1.1 christos
469 1.5 christos if (FILE_STREAM(channel) != NULL) {
470 1.1 christos (void)fclose(FILE_STREAM(channel));
471 1.5 christos }
472 1.1 christos }
473 1.1 christos
474 1.1 christos isc_mem_free(mctx, channel->name);
475 1.1 christos isc_mem_put(mctx, channel, sizeof(*channel));
476 1.1 christos }
477 1.1 christos
478 1.5 christos for (i = 0; i < lcfg->channellist_count; i++) {
479 1.5 christos isc_logchannellist_t *item;
480 1.1 christos while ((item = ISC_LIST_HEAD(lcfg->channellists[i])) != NULL) {
481 1.1 christos ISC_LIST_UNLINK(lcfg->channellists[i], item, link);
482 1.1 christos isc_mem_put(mctx, item, sizeof(*item));
483 1.1 christos }
484 1.5 christos }
485 1.1 christos
486 1.5 christos if (lcfg->channellist_count > 0) {
487 1.1 christos isc_mem_put(mctx, lcfg->channellists,
488 1.1 christos lcfg->channellist_count *
489 1.5 christos sizeof(ISC_LIST(isc_logchannellist_t)));
490 1.5 christos }
491 1.1 christos
492 1.3 christos lcfg->dynamic = false;
493 1.5 christos if (lcfg->tag != NULL) {
494 1.1 christos isc_mem_free(lcfg->lctx->mctx, lcfg->tag);
495 1.5 christos }
496 1.1 christos lcfg->tag = NULL;
497 1.1 christos lcfg->highest_level = 0;
498 1.1 christos lcfg->duplicate_interval = 0;
499 1.1 christos lcfg->magic = 0;
500 1.1 christos
501 1.1 christos isc_mem_put(mctx, lcfg, sizeof(*lcfg));
502 1.1 christos }
503 1.1 christos
504 1.1 christos void
505 1.1 christos isc_log_registercategories(isc_log_t *lctx, isc_logcategory_t categories[]) {
506 1.1 christos isc_logcategory_t *catp;
507 1.1 christos
508 1.1 christos REQUIRE(VALID_CONTEXT(lctx));
509 1.1 christos REQUIRE(categories != NULL && categories[0].name != NULL);
510 1.1 christos
511 1.1 christos /*
512 1.1 christos * XXXDCL This somewhat sleazy situation of using the last pointer
513 1.1 christos * in one category array to point to the next array exists because
514 1.1 christos * this registration function returns void and I didn't want to have
515 1.1 christos * change everything that used it by making it return an isc_result_t.
516 1.1 christos * It would need to do that if it had to allocate memory to store
517 1.1 christos * pointers to each array passed in.
518 1.1 christos */
519 1.5 christos if (lctx->categories == NULL) {
520 1.1 christos lctx->categories = categories;
521 1.5 christos } else {
522 1.1 christos /*
523 1.1 christos * Adjust the last (NULL) pointer of the already registered
524 1.1 christos * categories to point to the incoming array.
525 1.1 christos */
526 1.5 christos for (catp = lctx->categories; catp->name != NULL;) {
527 1.5 christos if (catp->id == UINT_MAX) {
528 1.1 christos /*
529 1.1 christos * The name pointer points to the next array.
530 1.1 christos * Ick.
531 1.1 christos */
532 1.1 christos DE_CONST(catp->name, catp);
533 1.5 christos } else {
534 1.1 christos catp++;
535 1.5 christos }
536 1.5 christos }
537 1.1 christos
538 1.1 christos catp->name = (void *)categories;
539 1.1 christos catp->id = UINT_MAX;
540 1.1 christos }
541 1.1 christos
542 1.1 christos /*
543 1.1 christos * Update the id number of the category with its new global id.
544 1.1 christos */
545 1.5 christos for (catp = categories; catp->name != NULL; catp++) {
546 1.1 christos catp->id = lctx->category_count++;
547 1.5 christos }
548 1.1 christos }
549 1.1 christos
550 1.1 christos isc_logcategory_t *
551 1.1 christos isc_log_categorybyname(isc_log_t *lctx, const char *name) {
552 1.1 christos isc_logcategory_t *catp;
553 1.1 christos
554 1.1 christos REQUIRE(VALID_CONTEXT(lctx));
555 1.1 christos REQUIRE(name != NULL);
556 1.1 christos
557 1.5 christos for (catp = lctx->categories; catp->name != NULL;) {
558 1.5 christos if (catp->id == UINT_MAX) {
559 1.1 christos /*
560 1.1 christos * catp is neither modified nor returned to the
561 1.1 christos * caller, so removing its const qualifier is ok.
562 1.1 christos */
563 1.1 christos DE_CONST(catp->name, catp);
564 1.5 christos } else {
565 1.5 christos if (strcmp(catp->name, name) == 0) {
566 1.1 christos return (catp);
567 1.5 christos }
568 1.1 christos catp++;
569 1.1 christos }
570 1.5 christos }
571 1.1 christos
572 1.1 christos return (NULL);
573 1.1 christos }
574 1.1 christos
575 1.1 christos void
576 1.1 christos isc_log_registermodules(isc_log_t *lctx, isc_logmodule_t modules[]) {
577 1.1 christos isc_logmodule_t *modp;
578 1.1 christos
579 1.1 christos REQUIRE(VALID_CONTEXT(lctx));
580 1.1 christos REQUIRE(modules != NULL && modules[0].name != NULL);
581 1.1 christos
582 1.1 christos /*
583 1.1 christos * XXXDCL This somewhat sleazy situation of using the last pointer
584 1.1 christos * in one category array to point to the next array exists because
585 1.1 christos * this registration function returns void and I didn't want to have
586 1.1 christos * change everything that used it by making it return an isc_result_t.
587 1.1 christos * It would need to do that if it had to allocate memory to store
588 1.1 christos * pointers to each array passed in.
589 1.1 christos */
590 1.5 christos if (lctx->modules == NULL) {
591 1.1 christos lctx->modules = modules;
592 1.5 christos } else {
593 1.1 christos /*
594 1.1 christos * Adjust the last (NULL) pointer of the already registered
595 1.1 christos * modules to point to the incoming array.
596 1.1 christos */
597 1.5 christos for (modp = lctx->modules; modp->name != NULL;) {
598 1.5 christos if (modp->id == UINT_MAX) {
599 1.1 christos /*
600 1.1 christos * The name pointer points to the next array.
601 1.1 christos * Ick.
602 1.1 christos */
603 1.1 christos DE_CONST(modp->name, modp);
604 1.5 christos } else {
605 1.1 christos modp++;
606 1.5 christos }
607 1.5 christos }
608 1.1 christos
609 1.1 christos modp->name = (void *)modules;
610 1.1 christos modp->id = UINT_MAX;
611 1.1 christos }
612 1.1 christos
613 1.1 christos /*
614 1.1 christos * Update the id number of the module with its new global id.
615 1.1 christos */
616 1.5 christos for (modp = modules; modp->name != NULL; modp++) {
617 1.1 christos modp->id = lctx->module_count++;
618 1.5 christos }
619 1.1 christos }
620 1.1 christos
621 1.1 christos isc_logmodule_t *
622 1.1 christos isc_log_modulebyname(isc_log_t *lctx, const char *name) {
623 1.1 christos isc_logmodule_t *modp;
624 1.1 christos
625 1.1 christos REQUIRE(VALID_CONTEXT(lctx));
626 1.1 christos REQUIRE(name != NULL);
627 1.1 christos
628 1.5 christos for (modp = lctx->modules; modp->name != NULL;) {
629 1.5 christos if (modp->id == UINT_MAX) {
630 1.1 christos /*
631 1.1 christos * modp is neither modified nor returned to the
632 1.1 christos * caller, so removing its const qualifier is ok.
633 1.1 christos */
634 1.1 christos DE_CONST(modp->name, modp);
635 1.5 christos } else {
636 1.5 christos if (strcmp(modp->name, name) == 0) {
637 1.1 christos return (modp);
638 1.5 christos }
639 1.1 christos modp++;
640 1.1 christos }
641 1.5 christos }
642 1.1 christos
643 1.1 christos return (NULL);
644 1.1 christos }
645 1.1 christos
646 1.5 christos void
647 1.1 christos isc_log_createchannel(isc_logconfig_t *lcfg, const char *name,
648 1.1 christos unsigned int type, int level,
649 1.1 christos const isc_logdestination_t *destination,
650 1.5 christos unsigned int flags) {
651 1.1 christos isc_logchannel_t *channel;
652 1.1 christos isc_mem_t *mctx;
653 1.1 christos unsigned int permitted = ISC_LOG_PRINTALL | ISC_LOG_DEBUGONLY |
654 1.1 christos ISC_LOG_BUFFERED | ISC_LOG_ISO8601 |
655 1.1 christos ISC_LOG_UTC;
656 1.1 christos
657 1.1 christos REQUIRE(VALID_CONFIG(lcfg));
658 1.1 christos REQUIRE(name != NULL);
659 1.5 christos REQUIRE(type == ISC_LOG_TOSYSLOG || type == ISC_LOG_TOFILE ||
660 1.1 christos type == ISC_LOG_TOFILEDESC || type == ISC_LOG_TONULL);
661 1.1 christos REQUIRE(destination != NULL || type == ISC_LOG_TONULL);
662 1.1 christos REQUIRE(level >= ISC_LOG_CRITICAL);
663 1.1 christos REQUIRE((flags & ~permitted) == 0);
664 1.1 christos
665 1.1 christos /* XXXDCL find duplicate names? */
666 1.1 christos
667 1.1 christos mctx = lcfg->lctx->mctx;
668 1.1 christos
669 1.1 christos channel = isc_mem_get(mctx, sizeof(*channel));
670 1.1 christos
671 1.1 christos channel->name = isc_mem_strdup(mctx, name);
672 1.1 christos
673 1.1 christos channel->type = type;
674 1.1 christos channel->level = level;
675 1.1 christos channel->flags = flags;
676 1.1 christos ISC_LINK_INIT(channel, link);
677 1.1 christos
678 1.1 christos switch (type) {
679 1.1 christos case ISC_LOG_TOSYSLOG:
680 1.1 christos FACILITY(channel) = destination->facility;
681 1.1 christos break;
682 1.1 christos
683 1.1 christos case ISC_LOG_TOFILE:
684 1.1 christos /*
685 1.1 christos * The file name is copied because greatest_version wants
686 1.1 christos * to scribble on it, so it needs to be definitely in
687 1.1 christos * writable memory.
688 1.1 christos */
689 1.5 christos FILE_NAME(channel) = isc_mem_strdup(mctx,
690 1.5 christos destination->file.name);
691 1.1 christos FILE_STREAM(channel) = NULL;
692 1.1 christos FILE_VERSIONS(channel) = destination->file.versions;
693 1.1 christos FILE_SUFFIX(channel) = destination->file.suffix;
694 1.1 christos FILE_MAXSIZE(channel) = destination->file.maximum_size;
695 1.3 christos FILE_MAXREACHED(channel) = false;
696 1.1 christos break;
697 1.1 christos
698 1.1 christos case ISC_LOG_TOFILEDESC:
699 1.1 christos FILE_NAME(channel) = NULL;
700 1.1 christos FILE_STREAM(channel) = destination->file.stream;
701 1.1 christos FILE_MAXSIZE(channel) = 0;
702 1.1 christos FILE_VERSIONS(channel) = ISC_LOG_ROLLNEVER;
703 1.1 christos FILE_SUFFIX(channel) = isc_log_rollsuffix_increment;
704 1.1 christos break;
705 1.1 christos
706 1.1 christos case ISC_LOG_TONULL:
707 1.1 christos /* Nothing. */
708 1.1 christos break;
709 1.1 christos
710 1.1 christos default:
711 1.7 christos UNREACHABLE();
712 1.1 christos }
713 1.1 christos
714 1.1 christos ISC_LIST_PREPEND(lcfg->channels, channel, link);
715 1.1 christos
716 1.1 christos /*
717 1.1 christos * If default_stderr was redefined, make the default category
718 1.1 christos * point to the new default_stderr.
719 1.1 christos */
720 1.5 christos if (strcmp(name, "default_stderr") == 0) {
721 1.1 christos default_channel.channel = channel;
722 1.5 christos }
723 1.1 christos }
724 1.1 christos
725 1.1 christos isc_result_t
726 1.1 christos isc_log_usechannel(isc_logconfig_t *lcfg, const char *name,
727 1.1 christos const isc_logcategory_t *category,
728 1.5 christos const isc_logmodule_t *module) {
729 1.1 christos isc_log_t *lctx;
730 1.1 christos isc_logchannel_t *channel;
731 1.1 christos
732 1.1 christos REQUIRE(VALID_CONFIG(lcfg));
733 1.1 christos REQUIRE(name != NULL);
734 1.1 christos
735 1.1 christos lctx = lcfg->lctx;
736 1.1 christos
737 1.1 christos REQUIRE(category == NULL || category->id < lctx->category_count);
738 1.1 christos REQUIRE(module == NULL || module->id < lctx->module_count);
739 1.1 christos
740 1.1 christos for (channel = ISC_LIST_HEAD(lcfg->channels); channel != NULL;
741 1.1 christos channel = ISC_LIST_NEXT(channel, link))
742 1.5 christos {
743 1.5 christos if (strcmp(name, channel->name) == 0) {
744 1.1 christos break;
745 1.5 christos }
746 1.5 christos }
747 1.1 christos
748 1.5 christos if (channel == NULL) {
749 1.1 christos return (ISC_R_NOTFOUND);
750 1.5 christos }
751 1.1 christos
752 1.5 christos if (category != NULL) {
753 1.5 christos assignchannel(lcfg, category->id, module, channel);
754 1.5 christos } else {
755 1.1 christos /*
756 1.1 christos * Assign to all categories. Note that this includes
757 1.1 christos * the default channel.
758 1.1 christos */
759 1.5 christos for (size_t i = 0; i < lctx->category_count; i++) {
760 1.5 christos assignchannel(lcfg, i, module, channel);
761 1.1 christos }
762 1.5 christos }
763 1.1 christos
764 1.5 christos /*
765 1.5 christos * Update the highest logging level, if the current lcfg is in use.
766 1.5 christos */
767 1.5 christos if (lcfg->lctx->logconfig == lcfg) {
768 1.5 christos sync_highest_level(lctx, lcfg);
769 1.5 christos }
770 1.5 christos
771 1.5 christos return (ISC_R_SUCCESS);
772 1.1 christos }
773 1.1 christos
774 1.1 christos void
775 1.1 christos isc_log_write(isc_log_t *lctx, isc_logcategory_t *category,
776 1.5 christos isc_logmodule_t *module, int level, const char *format, ...) {
777 1.1 christos va_list args;
778 1.1 christos
779 1.1 christos /*
780 1.1 christos * Contract checking is done in isc_log_doit().
781 1.1 christos */
782 1.1 christos
783 1.1 christos va_start(args, format);
784 1.5 christos isc_log_doit(lctx, category, module, level, false, format, args);
785 1.1 christos va_end(args);
786 1.1 christos }
787 1.1 christos
788 1.1 christos void
789 1.1 christos isc_log_vwrite(isc_log_t *lctx, isc_logcategory_t *category,
790 1.5 christos isc_logmodule_t *module, int level, const char *format,
791 1.5 christos va_list args) {
792 1.1 christos /*
793 1.1 christos * Contract checking is done in isc_log_doit().
794 1.1 christos */
795 1.5 christos isc_log_doit(lctx, category, module, level, false, format, args);
796 1.1 christos }
797 1.1 christos
798 1.1 christos void
799 1.1 christos isc_log_write1(isc_log_t *lctx, isc_logcategory_t *category,
800 1.5 christos isc_logmodule_t *module, int level, const char *format, ...) {
801 1.1 christos va_list args;
802 1.1 christos
803 1.1 christos /*
804 1.1 christos * Contract checking is done in isc_log_doit().
805 1.1 christos */
806 1.1 christos
807 1.1 christos va_start(args, format);
808 1.5 christos isc_log_doit(lctx, category, module, level, true, format, args);
809 1.1 christos va_end(args);
810 1.1 christos }
811 1.1 christos
812 1.1 christos void
813 1.1 christos isc_log_vwrite1(isc_log_t *lctx, isc_logcategory_t *category,
814 1.5 christos isc_logmodule_t *module, int level, const char *format,
815 1.5 christos va_list args) {
816 1.1 christos /*
817 1.1 christos * Contract checking is done in isc_log_doit().
818 1.1 christos */
819 1.5 christos isc_log_doit(lctx, category, module, level, true, format, args);
820 1.1 christos }
821 1.1 christos
822 1.1 christos void
823 1.1 christos isc_log_setcontext(isc_log_t *lctx) {
824 1.1 christos isc_lctx = lctx;
825 1.1 christos }
826 1.1 christos
827 1.1 christos void
828 1.1 christos isc_log_setdebuglevel(isc_log_t *lctx, unsigned int level) {
829 1.1 christos REQUIRE(VALID_CONTEXT(lctx));
830 1.1 christos
831 1.5 christos atomic_store_release(&lctx->debug_level, level);
832 1.1 christos /*
833 1.1 christos * Close ISC_LOG_DEBUGONLY channels if level is zero.
834 1.1 christos */
835 1.5 christos if (level == 0) {
836 1.5 christos RDLOCK(&lctx->lcfg_rwl);
837 1.5 christos isc_logconfig_t *lcfg = lctx->logconfig;
838 1.5 christos if (lcfg != NULL) {
839 1.5 christos LOCK(&lctx->lock);
840 1.5 christos for (isc_logchannel_t *channel =
841 1.5 christos ISC_LIST_HEAD(lcfg->channels);
842 1.5 christos channel != NULL;
843 1.5 christos channel = ISC_LIST_NEXT(channel, link))
844 1.5 christos {
845 1.5 christos if (channel->type == ISC_LOG_TOFILE &&
846 1.5 christos (channel->flags & ISC_LOG_DEBUGONLY) != 0 &&
847 1.5 christos FILE_STREAM(channel) != NULL)
848 1.5 christos {
849 1.5 christos (void)fclose(FILE_STREAM(channel));
850 1.5 christos FILE_STREAM(channel) = NULL;
851 1.5 christos }
852 1.1 christos }
853 1.5 christos UNLOCK(&lctx->lock);
854 1.5 christos }
855 1.5 christos RDUNLOCK(&lctx->lcfg_rwl);
856 1.5 christos }
857 1.1 christos }
858 1.1 christos
859 1.1 christos unsigned int
860 1.1 christos isc_log_getdebuglevel(isc_log_t *lctx) {
861 1.1 christos REQUIRE(VALID_CONTEXT(lctx));
862 1.1 christos
863 1.5 christos return (atomic_load_acquire(&lctx->debug_level));
864 1.1 christos }
865 1.1 christos
866 1.1 christos void
867 1.1 christos isc_log_setduplicateinterval(isc_logconfig_t *lcfg, unsigned int interval) {
868 1.1 christos REQUIRE(VALID_CONFIG(lcfg));
869 1.1 christos
870 1.1 christos lcfg->duplicate_interval = interval;
871 1.1 christos }
872 1.1 christos
873 1.1 christos unsigned int
874 1.1 christos isc_log_getduplicateinterval(isc_logconfig_t *lcfg) {
875 1.1 christos REQUIRE(VALID_CONTEXT(lcfg));
876 1.1 christos
877 1.1 christos return (lcfg->duplicate_interval);
878 1.1 christos }
879 1.1 christos
880 1.5 christos void
881 1.1 christos isc_log_settag(isc_logconfig_t *lcfg, const char *tag) {
882 1.1 christos REQUIRE(VALID_CONFIG(lcfg));
883 1.1 christos
884 1.1 christos if (tag != NULL && *tag != '\0') {
885 1.5 christos if (lcfg->tag != NULL) {
886 1.1 christos isc_mem_free(lcfg->lctx->mctx, lcfg->tag);
887 1.5 christos }
888 1.1 christos lcfg->tag = isc_mem_strdup(lcfg->lctx->mctx, tag);
889 1.1 christos } else {
890 1.5 christos if (lcfg->tag != NULL) {
891 1.1 christos isc_mem_free(lcfg->lctx->mctx, lcfg->tag);
892 1.5 christos }
893 1.1 christos lcfg->tag = NULL;
894 1.1 christos }
895 1.1 christos }
896 1.1 christos
897 1.1 christos char *
898 1.1 christos isc_log_gettag(isc_logconfig_t *lcfg) {
899 1.1 christos REQUIRE(VALID_CONFIG(lcfg));
900 1.1 christos
901 1.1 christos return (lcfg->tag);
902 1.1 christos }
903 1.1 christos
904 1.1 christos /* XXXDCL NT -- This interface will assuredly be changing. */
905 1.1 christos void
906 1.1 christos isc_log_opensyslog(const char *tag, int options, int facility) {
907 1.1 christos (void)openlog(tag, options, facility);
908 1.1 christos }
909 1.1 christos
910 1.1 christos void
911 1.1 christos isc_log_closefilelogs(isc_log_t *lctx) {
912 1.1 christos REQUIRE(VALID_CONTEXT(lctx));
913 1.1 christos
914 1.5 christos RDLOCK(&lctx->lcfg_rwl);
915 1.5 christos isc_logconfig_t *lcfg = lctx->logconfig;
916 1.5 christos if (lcfg != NULL) {
917 1.5 christos LOCK(&lctx->lock);
918 1.5 christos for (isc_logchannel_t *channel = ISC_LIST_HEAD(lcfg->channels);
919 1.5 christos channel != NULL; channel = ISC_LIST_NEXT(channel, link))
920 1.5 christos {
921 1.5 christos if (channel->type == ISC_LOG_TOFILE &&
922 1.5 christos FILE_STREAM(channel) != NULL) {
923 1.5 christos (void)fclose(FILE_STREAM(channel));
924 1.5 christos FILE_STREAM(channel) = NULL;
925 1.5 christos }
926 1.1 christos }
927 1.5 christos UNLOCK(&lctx->lock);
928 1.5 christos }
929 1.5 christos RDUNLOCK(&lctx->lcfg_rwl);
930 1.1 christos }
931 1.1 christos
932 1.1 christos /****
933 1.5 christos **** Internal functions
934 1.5 christos ****/
935 1.1 christos
936 1.5 christos static void
937 1.1 christos assignchannel(isc_logconfig_t *lcfg, unsigned int category_id,
938 1.5 christos const isc_logmodule_t *module, isc_logchannel_t *channel) {
939 1.1 christos isc_logchannellist_t *new_item;
940 1.1 christos isc_log_t *lctx;
941 1.1 christos
942 1.1 christos REQUIRE(VALID_CONFIG(lcfg));
943 1.1 christos
944 1.1 christos lctx = lcfg->lctx;
945 1.1 christos
946 1.1 christos REQUIRE(category_id < lctx->category_count);
947 1.1 christos REQUIRE(module == NULL || module->id < lctx->module_count);
948 1.1 christos REQUIRE(channel != NULL);
949 1.1 christos
950 1.1 christos /*
951 1.1 christos * Ensure lcfg->channellist_count == lctx->category_count.
952 1.1 christos */
953 1.5 christos sync_channellist(lcfg);
954 1.1 christos
955 1.1 christos new_item = isc_mem_get(lctx->mctx, sizeof(*new_item));
956 1.1 christos
957 1.1 christos new_item->channel = channel;
958 1.1 christos new_item->module = module;
959 1.5 christos ISC_LIST_INITANDPREPEND(lcfg->channellists[category_id], new_item,
960 1.5 christos link);
961 1.1 christos
962 1.1 christos /*
963 1.1 christos * Remember the highest logging level set by any channel in the
964 1.1 christos * logging config, so isc_log_doit() can quickly return if the
965 1.1 christos * message is too high to be logged by any channel.
966 1.1 christos */
967 1.1 christos if (channel->type != ISC_LOG_TONULL) {
968 1.5 christos if (lcfg->highest_level < channel->level) {
969 1.1 christos lcfg->highest_level = channel->level;
970 1.5 christos }
971 1.5 christos if (channel->level == ISC_LOG_DYNAMIC) {
972 1.3 christos lcfg->dynamic = true;
973 1.5 christos }
974 1.1 christos }
975 1.1 christos }
976 1.1 christos
977 1.1 christos /*
978 1.1 christos * This would ideally be part of isc_log_registercategories(), except then
979 1.1 christos * that function would have to return isc_result_t instead of void.
980 1.1 christos */
981 1.5 christos static void
982 1.1 christos sync_channellist(isc_logconfig_t *lcfg) {
983 1.1 christos unsigned int bytes;
984 1.1 christos isc_log_t *lctx;
985 1.1 christos void *lists;
986 1.1 christos
987 1.1 christos REQUIRE(VALID_CONFIG(lcfg));
988 1.1 christos
989 1.1 christos lctx = lcfg->lctx;
990 1.1 christos
991 1.1 christos REQUIRE(lctx->category_count != 0);
992 1.1 christos
993 1.5 christos if (lctx->category_count == lcfg->channellist_count) {
994 1.5 christos return;
995 1.5 christos }
996 1.1 christos
997 1.1 christos bytes = lctx->category_count * sizeof(ISC_LIST(isc_logchannellist_t));
998 1.1 christos
999 1.1 christos lists = isc_mem_get(lctx->mctx, bytes);
1000 1.1 christos
1001 1.1 christos memset(lists, 0, bytes);
1002 1.1 christos
1003 1.1 christos if (lcfg->channellist_count != 0) {
1004 1.1 christos bytes = lcfg->channellist_count *
1005 1.1 christos sizeof(ISC_LIST(isc_logchannellist_t));
1006 1.1 christos memmove(lists, lcfg->channellists, bytes);
1007 1.1 christos isc_mem_put(lctx->mctx, lcfg->channellists, bytes);
1008 1.1 christos }
1009 1.1 christos
1010 1.1 christos lcfg->channellists = lists;
1011 1.1 christos lcfg->channellist_count = lctx->category_count;
1012 1.5 christos }
1013 1.1 christos
1014 1.5 christos static void
1015 1.5 christos sync_highest_level(isc_log_t *lctx, isc_logconfig_t *lcfg) {
1016 1.5 christos atomic_store(&lctx->highest_level, lcfg->highest_level);
1017 1.5 christos atomic_store(&lctx->dynamic, lcfg->dynamic);
1018 1.1 christos }
1019 1.1 christos
1020 1.1 christos static isc_result_t
1021 1.1 christos greatest_version(isc_logfile_t *file, int versions, int *greatestp) {
1022 1.1 christos char *bname, *digit_end;
1023 1.1 christos const char *dirname;
1024 1.1 christos int version, greatest = -1;
1025 1.1 christos size_t bnamelen;
1026 1.1 christos isc_dir_t dir;
1027 1.1 christos isc_result_t result;
1028 1.1 christos char sep = '/';
1029 1.1 christos #ifdef _WIN32
1030 1.1 christos char *bname2;
1031 1.5 christos #endif /* ifdef _WIN32 */
1032 1.1 christos
1033 1.1 christos /*
1034 1.1 christos * It is safe to DE_CONST the file.name because it was copied
1035 1.1 christos * with isc_mem_strdup().
1036 1.1 christos */
1037 1.1 christos bname = strrchr(file->name, sep);
1038 1.1 christos #ifdef _WIN32
1039 1.1 christos bname2 = strrchr(file->name, '\\');
1040 1.1 christos if ((bname != NULL && bname2 != NULL && bname2 > bname) ||
1041 1.5 christos (bname == NULL && bname2 != NULL))
1042 1.5 christos {
1043 1.1 christos bname = bname2;
1044 1.1 christos sep = '\\';
1045 1.1 christos }
1046 1.5 christos #endif /* ifdef _WIN32 */
1047 1.1 christos if (bname != NULL) {
1048 1.1 christos *bname++ = '\0';
1049 1.1 christos dirname = file->name;
1050 1.1 christos } else {
1051 1.1 christos DE_CONST(file->name, bname);
1052 1.1 christos dirname = ".";
1053 1.1 christos }
1054 1.1 christos bnamelen = strlen(bname);
1055 1.1 christos
1056 1.1 christos isc_dir_init(&dir);
1057 1.1 christos result = isc_dir_open(&dir, dirname);
1058 1.1 christos
1059 1.1 christos /*
1060 1.1 christos * Replace the file separator if it was taken out.
1061 1.1 christos */
1062 1.5 christos if (bname != file->name) {
1063 1.1 christos *(bname - 1) = sep;
1064 1.5 christos }
1065 1.1 christos
1066 1.1 christos /*
1067 1.1 christos * Return if the directory open failed.
1068 1.1 christos */
1069 1.5 christos if (result != ISC_R_SUCCESS) {
1070 1.1 christos return (result);
1071 1.5 christos }
1072 1.1 christos
1073 1.1 christos while (isc_dir_read(&dir) == ISC_R_SUCCESS) {
1074 1.1 christos if (dir.entry.length > bnamelen &&
1075 1.1 christos strncmp(dir.entry.name, bname, bnamelen) == 0 &&
1076 1.1 christos dir.entry.name[bnamelen] == '.')
1077 1.1 christos {
1078 1.1 christos version = strtol(&dir.entry.name[bnamelen + 1],
1079 1.1 christos &digit_end, 10);
1080 1.1 christos /*
1081 1.1 christos * Remove any backup files that exceed versions.
1082 1.1 christos */
1083 1.1 christos if (*digit_end == '\0' && version >= versions) {
1084 1.1 christos result = isc_file_remove(dir.entry.name);
1085 1.1 christos if (result != ISC_R_SUCCESS &&
1086 1.5 christos result != ISC_R_FILENOTFOUND) {
1087 1.5 christos syslog(LOG_ERR,
1088 1.5 christos "unable to remove "
1089 1.1 christos "log file '%s': %s",
1090 1.1 christos dir.entry.name,
1091 1.1 christos isc_result_totext(result));
1092 1.5 christos }
1093 1.5 christos } else if (*digit_end == '\0' && version > greatest) {
1094 1.1 christos greatest = version;
1095 1.5 christos }
1096 1.1 christos }
1097 1.1 christos }
1098 1.1 christos isc_dir_close(&dir);
1099 1.1 christos
1100 1.1 christos *greatestp = greatest;
1101 1.1 christos
1102 1.1 christos return (ISC_R_SUCCESS);
1103 1.1 christos }
1104 1.1 christos
1105 1.6 christos static void
1106 1.6 christos insert_sort(int64_t to_keep[], int64_t versions, int version) {
1107 1.6 christos int i = 0;
1108 1.6 christos while (i < versions && version < to_keep[i]) {
1109 1.6 christos i++;
1110 1.6 christos }
1111 1.6 christos if (i == versions) {
1112 1.6 christos return;
1113 1.6 christos }
1114 1.6 christos if (i < versions - 1) {
1115 1.6 christos memmove(&to_keep[i + 1], &to_keep[i],
1116 1.6 christos sizeof(to_keep[0]) * (versions - i - 1));
1117 1.6 christos }
1118 1.6 christos to_keep[i] = version;
1119 1.6 christos }
1120 1.6 christos
1121 1.6 christos static int64_t
1122 1.6 christos last_to_keep(int64_t versions, isc_dir_t *dirp, char *bname, size_t bnamelen) {
1123 1.6 christos if (versions <= 0) {
1124 1.6 christos return INT64_MAX;
1125 1.6 christos }
1126 1.6 christos
1127 1.6 christos int64_t to_keep[ISC_LOG_MAX_VERSIONS] = { 0 };
1128 1.6 christos int64_t version = 0;
1129 1.6 christos if (versions > ISC_LOG_MAX_VERSIONS) {
1130 1.6 christos versions = ISC_LOG_MAX_VERSIONS;
1131 1.6 christos }
1132 1.6 christos /*
1133 1.6 christos * First we fill 'to_keep' structure using insertion sort
1134 1.6 christos */
1135 1.6 christos memset(to_keep, 0, sizeof(to_keep));
1136 1.6 christos while (isc_dir_read(dirp) == ISC_R_SUCCESS) {
1137 1.6 christos if (dirp->entry.length <= bnamelen ||
1138 1.6 christos strncmp(dirp->entry.name, bname, bnamelen) != 0 ||
1139 1.6 christos dirp->entry.name[bnamelen] != '.')
1140 1.6 christos {
1141 1.6 christos continue;
1142 1.6 christos }
1143 1.6 christos
1144 1.6 christos char *digit_end;
1145 1.6 christos char *ename = &dirp->entry.name[bnamelen + 1];
1146 1.6 christos version = strtoull(ename, &digit_end, 10);
1147 1.6 christos if (*digit_end == '\0') {
1148 1.6 christos insert_sort(to_keep, versions, version);
1149 1.6 christos }
1150 1.6 christos }
1151 1.6 christos
1152 1.6 christos isc_dir_reset(dirp);
1153 1.6 christos
1154 1.6 christos /*
1155 1.6 christos * to_keep[versions - 1] is the last one we want to keep
1156 1.6 christos */
1157 1.6 christos return (to_keep[versions - 1]);
1158 1.6 christos }
1159 1.6 christos
1160 1.1 christos static isc_result_t
1161 1.1 christos remove_old_tsversions(isc_logfile_t *file, int versions) {
1162 1.1 christos isc_result_t result;
1163 1.1 christos char *bname, *digit_end;
1164 1.1 christos const char *dirname;
1165 1.3 christos int64_t version, last = INT64_MAX;
1166 1.1 christos size_t bnamelen;
1167 1.1 christos isc_dir_t dir;
1168 1.1 christos char sep = '/';
1169 1.1 christos #ifdef _WIN32
1170 1.1 christos char *bname2;
1171 1.5 christos #endif /* ifdef _WIN32 */
1172 1.1 christos /*
1173 1.1 christos * It is safe to DE_CONST the file.name because it was copied
1174 1.1 christos * with isc_mem_strdup().
1175 1.1 christos */
1176 1.1 christos bname = strrchr(file->name, sep);
1177 1.1 christos #ifdef _WIN32
1178 1.1 christos bname2 = strrchr(file->name, '\\');
1179 1.1 christos if ((bname != NULL && bname2 != NULL && bname2 > bname) ||
1180 1.5 christos (bname == NULL && bname2 != NULL))
1181 1.5 christos {
1182 1.1 christos bname = bname2;
1183 1.1 christos sep = '\\';
1184 1.1 christos }
1185 1.5 christos #endif /* ifdef _WIN32 */
1186 1.1 christos if (bname != NULL) {
1187 1.1 christos *bname++ = '\0';
1188 1.1 christos dirname = file->name;
1189 1.1 christos } else {
1190 1.1 christos DE_CONST(file->name, bname);
1191 1.1 christos dirname = ".";
1192 1.1 christos }
1193 1.1 christos bnamelen = strlen(bname);
1194 1.1 christos
1195 1.1 christos isc_dir_init(&dir);
1196 1.1 christos result = isc_dir_open(&dir, dirname);
1197 1.1 christos
1198 1.1 christos /*
1199 1.1 christos * Replace the file separator if it was taken out.
1200 1.1 christos */
1201 1.1 christos if (bname != file->name) {
1202 1.1 christos *(bname - 1) = sep;
1203 1.1 christos }
1204 1.1 christos
1205 1.1 christos /*
1206 1.1 christos * Return if the directory open failed.
1207 1.1 christos */
1208 1.5 christos if (result != ISC_R_SUCCESS) {
1209 1.1 christos return (result);
1210 1.5 christos }
1211 1.1 christos
1212 1.6 christos last = last_to_keep(versions, &dir, bname, bnamelen);
1213 1.1 christos
1214 1.1 christos /*
1215 1.1 christos * Then we remove all files that we don't want to_keep
1216 1.1 christos */
1217 1.1 christos while (isc_dir_read(&dir) == ISC_R_SUCCESS) {
1218 1.1 christos if (dir.entry.length > bnamelen &&
1219 1.1 christos strncmp(dir.entry.name, bname, bnamelen) == 0 &&
1220 1.1 christos dir.entry.name[bnamelen] == '.')
1221 1.1 christos {
1222 1.1 christos char *ename = &dir.entry.name[bnamelen + 1];
1223 1.3 christos version = strtoull(ename, &digit_end, 10);
1224 1.1 christos /*
1225 1.1 christos * Remove any backup files that exceed versions.
1226 1.1 christos */
1227 1.1 christos if (*digit_end == '\0' && version < last) {
1228 1.1 christos result = isc_file_remove(dir.entry.name);
1229 1.1 christos if (result != ISC_R_SUCCESS &&
1230 1.5 christos result != ISC_R_FILENOTFOUND) {
1231 1.5 christos syslog(LOG_ERR,
1232 1.5 christos "unable to remove "
1233 1.1 christos "log file '%s': %s",
1234 1.1 christos dir.entry.name,
1235 1.1 christos isc_result_totext(result));
1236 1.5 christos }
1237 1.1 christos }
1238 1.1 christos }
1239 1.1 christos }
1240 1.1 christos
1241 1.1 christos isc_dir_close(&dir);
1242 1.1 christos
1243 1.1 christos return (ISC_R_SUCCESS);
1244 1.1 christos }
1245 1.1 christos
1246 1.1 christos static isc_result_t
1247 1.1 christos roll_increment(isc_logfile_t *file) {
1248 1.1 christos int i, n, greatest;
1249 1.1 christos char current[PATH_MAX + 1];
1250 1.1 christos char newpath[PATH_MAX + 1];
1251 1.1 christos const char *path;
1252 1.1 christos isc_result_t result = ISC_R_SUCCESS;
1253 1.1 christos
1254 1.1 christos REQUIRE(file != NULL);
1255 1.1 christos REQUIRE(file->versions != 0);
1256 1.1 christos
1257 1.1 christos path = file->name;
1258 1.1 christos
1259 1.1 christos if (file->versions == ISC_LOG_ROLLINFINITE) {
1260 1.1 christos /*
1261 1.1 christos * Find the first missing entry in the log file sequence.
1262 1.1 christos */
1263 1.1 christos for (greatest = 0; greatest < INT_MAX; greatest++) {
1264 1.5 christos n = snprintf(current, sizeof(current), "%s.%u", path,
1265 1.5 christos (unsigned)greatest);
1266 1.1 christos if (n >= (int)sizeof(current) || n < 0 ||
1267 1.5 christos !isc_file_exists(current)) {
1268 1.1 christos break;
1269 1.1 christos }
1270 1.1 christos }
1271 1.1 christos } else {
1272 1.1 christos /*
1273 1.1 christos * Get the largest existing version and remove any
1274 1.1 christos * version greater than the permitted version.
1275 1.1 christos */
1276 1.1 christos result = greatest_version(file, file->versions, &greatest);
1277 1.1 christos if (result != ISC_R_SUCCESS) {
1278 1.1 christos return (result);
1279 1.1 christos }
1280 1.1 christos
1281 1.1 christos /*
1282 1.1 christos * Increment if greatest is not the actual maximum value.
1283 1.1 christos */
1284 1.1 christos if (greatest < file->versions - 1) {
1285 1.1 christos greatest++;
1286 1.1 christos }
1287 1.1 christos }
1288 1.1 christos
1289 1.1 christos for (i = greatest; i > 0; i--) {
1290 1.1 christos result = ISC_R_SUCCESS;
1291 1.1 christos n = snprintf(current, sizeof(current), "%s.%u", path,
1292 1.1 christos (unsigned)(i - 1));
1293 1.1 christos if (n >= (int)sizeof(current) || n < 0) {
1294 1.1 christos result = ISC_R_NOSPACE;
1295 1.1 christos }
1296 1.1 christos if (result == ISC_R_SUCCESS) {
1297 1.5 christos n = snprintf(newpath, sizeof(newpath), "%s.%u", path,
1298 1.5 christos (unsigned)i);
1299 1.1 christos if (n >= (int)sizeof(newpath) || n < 0) {
1300 1.1 christos result = ISC_R_NOSPACE;
1301 1.1 christos }
1302 1.1 christos }
1303 1.1 christos if (result == ISC_R_SUCCESS) {
1304 1.1 christos result = isc_file_rename(current, newpath);
1305 1.1 christos }
1306 1.1 christos if (result != ISC_R_SUCCESS && result != ISC_R_FILENOTFOUND) {
1307 1.1 christos syslog(LOG_ERR,
1308 1.1 christos "unable to rename log file '%s.%u' to "
1309 1.5 christos "'%s.%u': %s",
1310 1.5 christos path, i - 1, path, i, isc_result_totext(result));
1311 1.1 christos }
1312 1.1 christos }
1313 1.1 christos
1314 1.1 christos n = snprintf(newpath, sizeof(newpath), "%s.0", path);
1315 1.1 christos if (n >= (int)sizeof(newpath) || n < 0) {
1316 1.1 christos result = ISC_R_NOSPACE;
1317 1.1 christos } else {
1318 1.1 christos result = isc_file_rename(path, newpath);
1319 1.1 christos }
1320 1.1 christos if (result != ISC_R_SUCCESS && result != ISC_R_FILENOTFOUND) {
1321 1.5 christos syslog(LOG_ERR, "unable to rename log file '%s' to '%s.0': %s",
1322 1.1 christos path, path, isc_result_totext(result));
1323 1.1 christos }
1324 1.1 christos
1325 1.1 christos return (ISC_R_SUCCESS);
1326 1.1 christos }
1327 1.1 christos
1328 1.1 christos static isc_result_t
1329 1.1 christos roll_timestamp(isc_logfile_t *file) {
1330 1.1 christos int n;
1331 1.1 christos char newts[PATH_MAX + 1];
1332 1.1 christos char newpath[PATH_MAX + 1];
1333 1.1 christos const char *path;
1334 1.1 christos isc_time_t now;
1335 1.1 christos isc_result_t result = ISC_R_SUCCESS;
1336 1.1 christos
1337 1.1 christos REQUIRE(file != NULL);
1338 1.1 christos REQUIRE(file->versions != 0);
1339 1.1 christos
1340 1.1 christos path = file->name;
1341 1.1 christos
1342 1.1 christos /*
1343 1.1 christos * First find all the logfiles and remove the oldest ones
1344 1.1 christos * Save one fewer than file->versions because we'll be renaming
1345 1.1 christos * the existing file to a timestamped version after this.
1346 1.1 christos */
1347 1.1 christos if (file->versions != ISC_LOG_ROLLINFINITE) {
1348 1.1 christos remove_old_tsversions(file, file->versions - 1);
1349 1.1 christos }
1350 1.1 christos
1351 1.1 christos /* Then just rename the current logfile */
1352 1.1 christos isc_time_now(&now);
1353 1.1 christos isc_time_formatshorttimestamp(&now, newts, PATH_MAX + 1);
1354 1.1 christos n = snprintf(newpath, sizeof(newpath), "%s.%s", path, newts);
1355 1.1 christos if (n >= (int)sizeof(newpath) || n < 0) {
1356 1.1 christos result = ISC_R_NOSPACE;
1357 1.1 christos } else {
1358 1.1 christos result = isc_file_rename(path, newpath);
1359 1.1 christos }
1360 1.1 christos if (result != ISC_R_SUCCESS && result != ISC_R_FILENOTFOUND) {
1361 1.5 christos syslog(LOG_ERR, "unable to rename log file '%s' to '%s.0': %s",
1362 1.1 christos path, path, isc_result_totext(result));
1363 1.1 christos }
1364 1.1 christos
1365 1.1 christos return (ISC_R_SUCCESS);
1366 1.1 christos }
1367 1.1 christos
1368 1.1 christos isc_result_t
1369 1.1 christos isc_logfile_roll(isc_logfile_t *file) {
1370 1.1 christos isc_result_t result;
1371 1.1 christos
1372 1.1 christos REQUIRE(file != NULL);
1373 1.1 christos
1374 1.1 christos /*
1375 1.1 christos * Do nothing (not even excess version trimming) if ISC_LOG_ROLLNEVER
1376 1.1 christos * is specified. Apparently complete external control over the log
1377 1.1 christos * files is desired.
1378 1.1 christos */
1379 1.1 christos if (file->versions == ISC_LOG_ROLLNEVER) {
1380 1.1 christos return (ISC_R_SUCCESS);
1381 1.1 christos } else if (file->versions == 0) {
1382 1.1 christos result = isc_file_remove(file->name);
1383 1.5 christos if (result != ISC_R_SUCCESS && result != ISC_R_FILENOTFOUND) {
1384 1.1 christos syslog(LOG_ERR, "unable to remove log file '%s': %s",
1385 1.1 christos file->name, isc_result_totext(result));
1386 1.5 christos }
1387 1.1 christos return (ISC_R_SUCCESS);
1388 1.1 christos }
1389 1.1 christos
1390 1.1 christos switch (file->suffix) {
1391 1.1 christos case isc_log_rollsuffix_increment:
1392 1.1 christos return (roll_increment(file));
1393 1.1 christos case isc_log_rollsuffix_timestamp:
1394 1.1 christos return (roll_timestamp(file));
1395 1.1 christos default:
1396 1.1 christos return (ISC_R_UNEXPECTED);
1397 1.1 christos }
1398 1.1 christos }
1399 1.1 christos
1400 1.1 christos static isc_result_t
1401 1.1 christos isc_log_open(isc_logchannel_t *channel) {
1402 1.1 christos struct stat statbuf;
1403 1.3 christos bool regular_file;
1404 1.3 christos bool roll = false;
1405 1.1 christos isc_result_t result = ISC_R_SUCCESS;
1406 1.1 christos const char *path;
1407 1.1 christos
1408 1.1 christos REQUIRE(channel->type == ISC_LOG_TOFILE);
1409 1.1 christos REQUIRE(FILE_STREAM(channel) == NULL);
1410 1.1 christos
1411 1.1 christos path = FILE_NAME(channel);
1412 1.1 christos
1413 1.1 christos REQUIRE(path != NULL && *path != '\0');
1414 1.1 christos
1415 1.1 christos /*
1416 1.1 christos * Determine type of file; only regular files will be
1417 1.1 christos * version renamed, and only if the base file exists
1418 1.1 christos * and either has no size limit or has reached its size limit.
1419 1.1 christos */
1420 1.1 christos if (stat(path, &statbuf) == 0) {
1421 1.3 christos regular_file = S_ISREG(statbuf.st_mode) ? true : false;
1422 1.1 christos /* XXXDCL if not regular_file complain? */
1423 1.1 christos if ((FILE_MAXSIZE(channel) == 0 &&
1424 1.1 christos FILE_VERSIONS(channel) != ISC_LOG_ROLLNEVER) ||
1425 1.1 christos (FILE_MAXSIZE(channel) > 0 &&
1426 1.1 christos statbuf.st_size >= FILE_MAXSIZE(channel)))
1427 1.5 christos {
1428 1.1 christos roll = regular_file;
1429 1.5 christos }
1430 1.1 christos } else if (errno == ENOENT) {
1431 1.3 christos regular_file = true;
1432 1.1 christos POST(regular_file);
1433 1.5 christos } else {
1434 1.1 christos result = ISC_R_INVALIDFILE;
1435 1.5 christos }
1436 1.1 christos
1437 1.1 christos /*
1438 1.1 christos * Version control.
1439 1.1 christos */
1440 1.1 christos if (result == ISC_R_SUCCESS && roll) {
1441 1.5 christos if (FILE_VERSIONS(channel) == ISC_LOG_ROLLNEVER) {
1442 1.1 christos return (ISC_R_MAXSIZE);
1443 1.5 christos }
1444 1.1 christos result = isc_logfile_roll(&channel->destination.file);
1445 1.1 christos if (result != ISC_R_SUCCESS) {
1446 1.1 christos if ((channel->flags & ISC_LOG_OPENERR) == 0) {
1447 1.1 christos syslog(LOG_ERR,
1448 1.1 christos "isc_log_open: isc_logfile_roll '%s' "
1449 1.1 christos "failed: %s",
1450 1.1 christos FILE_NAME(channel),
1451 1.1 christos isc_result_totext(result));
1452 1.1 christos channel->flags |= ISC_LOG_OPENERR;
1453 1.1 christos }
1454 1.1 christos return (result);
1455 1.1 christos }
1456 1.1 christos }
1457 1.1 christos
1458 1.1 christos result = isc_stdio_open(path, "a", &FILE_STREAM(channel));
1459 1.1 christos
1460 1.1 christos return (result);
1461 1.1 christos }
1462 1.1 christos
1463 1.6 christos ISC_NO_SANITIZE_THREAD bool
1464 1.1 christos isc_log_wouldlog(isc_log_t *lctx, int level) {
1465 1.1 christos /*
1466 1.1 christos * Try to avoid locking the mutex for messages which can't
1467 1.1 christos * possibly be logged to any channels -- primarily debugging
1468 1.1 christos * messages that the debug level is not high enough to print.
1469 1.1 christos *
1470 1.1 christos * If the level is (mathematically) less than or equal to the
1471 1.1 christos * highest_level, or if there is a dynamic channel and the level is
1472 1.1 christos * less than or equal to the debug level, the main loop must be
1473 1.1 christos * entered to see if the message should really be output.
1474 1.1 christos */
1475 1.5 christos if (lctx == NULL) {
1476 1.5 christos return (false);
1477 1.5 christos }
1478 1.1 christos
1479 1.5 christos int highest_level = atomic_load_acquire(&lctx->highest_level);
1480 1.5 christos if (level <= highest_level) {
1481 1.5 christos return (true);
1482 1.5 christos }
1483 1.5 christos if (atomic_load_acquire(&lctx->dynamic)) {
1484 1.5 christos int debug_level = atomic_load_acquire(&lctx->debug_level);
1485 1.5 christos if (level <= debug_level) {
1486 1.5 christos return (true);
1487 1.5 christos }
1488 1.5 christos }
1489 1.1 christos
1490 1.5 christos return (false);
1491 1.1 christos }
1492 1.1 christos
1493 1.1 christos static void
1494 1.1 christos isc_log_doit(isc_log_t *lctx, isc_logcategory_t *category,
1495 1.3 christos isc_logmodule_t *module, int level, bool write_once,
1496 1.5 christos const char *format, va_list args) {
1497 1.1 christos int syslog_level;
1498 1.1 christos const char *time_string;
1499 1.1 christos char local_time[64];
1500 1.1 christos char iso8601z_string[64];
1501 1.1 christos char iso8601l_string[64];
1502 1.4 christos char level_string[24] = { 0 };
1503 1.1 christos struct stat statbuf;
1504 1.3 christos bool matched = false;
1505 1.3 christos bool printtime, iso8601, utc, printtag, printcolon;
1506 1.3 christos bool printcategory, printmodule, printlevel, buffered;
1507 1.1 christos isc_logchannel_t *channel;
1508 1.1 christos isc_logchannellist_t *category_channels;
1509 1.1 christos isc_result_t result;
1510 1.1 christos
1511 1.1 christos REQUIRE(lctx == NULL || VALID_CONTEXT(lctx));
1512 1.1 christos REQUIRE(category != NULL);
1513 1.1 christos REQUIRE(module != NULL);
1514 1.1 christos REQUIRE(level != ISC_LOG_DYNAMIC);
1515 1.1 christos REQUIRE(format != NULL);
1516 1.1 christos
1517 1.1 christos /*
1518 1.1 christos * Programs can use libraries that use this logging code without
1519 1.1 christos * wanting to do any logging, thus the log context is allowed to
1520 1.1 christos * be non-existent.
1521 1.1 christos */
1522 1.5 christos if (lctx == NULL) {
1523 1.1 christos return;
1524 1.5 christos }
1525 1.1 christos
1526 1.1 christos REQUIRE(category->id < lctx->category_count);
1527 1.1 christos REQUIRE(module->id < lctx->module_count);
1528 1.1 christos
1529 1.5 christos if (!isc_log_wouldlog(lctx, level)) {
1530 1.1 christos return;
1531 1.5 christos }
1532 1.1 christos
1533 1.1 christos local_time[0] = '\0';
1534 1.1 christos iso8601l_string[0] = '\0';
1535 1.1 christos iso8601z_string[0] = '\0';
1536 1.1 christos
1537 1.5 christos RDLOCK(&lctx->lcfg_rwl);
1538 1.1 christos LOCK(&lctx->lock);
1539 1.1 christos
1540 1.1 christos lctx->buffer[0] = '\0';
1541 1.1 christos
1542 1.5 christos isc_logconfig_t *lcfg = lctx->logconfig;
1543 1.1 christos
1544 1.1 christos category_channels = ISC_LIST_HEAD(lcfg->channellists[category->id]);
1545 1.1 christos
1546 1.1 christos /*
1547 1.5 christos * XXXDCL add duplicate filtering? (To not write multiple times
1548 1.5 christos * to the same source via various channels).
1549 1.1 christos */
1550 1.1 christos do {
1551 1.1 christos /*
1552 1.5 christos * If the channel list end was reached and a match was
1553 1.5 christos * made, everything is finished.
1554 1.1 christos */
1555 1.5 christos if (category_channels == NULL && matched) {
1556 1.1 christos break;
1557 1.5 christos }
1558 1.1 christos
1559 1.5 christos if (category_channels == NULL && !matched &&
1560 1.1 christos category_channels != ISC_LIST_HEAD(lcfg->channellists[0]))
1561 1.5 christos {
1562 1.1 christos /*
1563 1.5 christos * No category/module pair was explicitly
1564 1.5 christos * configured. Try the category named "default".
1565 1.1 christos */
1566 1.1 christos category_channels =
1567 1.1 christos ISC_LIST_HEAD(lcfg->channellists[0]);
1568 1.5 christos }
1569 1.1 christos
1570 1.5 christos if (category_channels == NULL && !matched) {
1571 1.1 christos /*
1572 1.1 christos * No matching module was explicitly configured
1573 1.5 christos * for the category named "default". Use the
1574 1.5 christos * internal default channel.
1575 1.1 christos */
1576 1.1 christos category_channels = &default_channel;
1577 1.5 christos }
1578 1.1 christos
1579 1.1 christos if (category_channels->module != NULL &&
1580 1.1 christos category_channels->module != module) {
1581 1.1 christos category_channels = ISC_LIST_NEXT(category_channels,
1582 1.1 christos link);
1583 1.1 christos continue;
1584 1.1 christos }
1585 1.1 christos
1586 1.3 christos matched = true;
1587 1.1 christos
1588 1.1 christos channel = category_channels->channel;
1589 1.1 christos category_channels = ISC_LIST_NEXT(category_channels, link);
1590 1.1 christos
1591 1.5 christos int_fast32_t dlevel = atomic_load_acquire(&lctx->debug_level);
1592 1.5 christos if (((channel->flags & ISC_LOG_DEBUGONLY) != 0) && dlevel == 0)
1593 1.5 christos {
1594 1.1 christos continue;
1595 1.5 christos }
1596 1.1 christos
1597 1.1 christos if (channel->level == ISC_LOG_DYNAMIC) {
1598 1.5 christos if (dlevel < level) {
1599 1.1 christos continue;
1600 1.5 christos }
1601 1.5 christos } else if (channel->level < level) {
1602 1.1 christos continue;
1603 1.5 christos }
1604 1.1 christos
1605 1.1 christos if ((channel->flags & ISC_LOG_PRINTTIME) != 0 &&
1606 1.5 christos local_time[0] == '\0') {
1607 1.1 christos isc_time_t isctime;
1608 1.1 christos
1609 1.1 christos TIME_NOW(&isctime);
1610 1.1 christos
1611 1.5 christos isc_time_formattimestamp(&isctime, local_time,
1612 1.1 christos sizeof(local_time));
1613 1.5 christos isc_time_formatISO8601ms(&isctime, iso8601z_string,
1614 1.1 christos sizeof(iso8601z_string));
1615 1.5 christos isc_time_formatISO8601Lms(&isctime, iso8601l_string,
1616 1.1 christos sizeof(iso8601l_string));
1617 1.1 christos }
1618 1.1 christos
1619 1.1 christos if ((channel->flags & ISC_LOG_PRINTLEVEL) != 0 &&
1620 1.1 christos level_string[0] == '\0') {
1621 1.4 christos if (level < ISC_LOG_CRITICAL) {
1622 1.1 christos snprintf(level_string, sizeof(level_string),
1623 1.4 christos "level %d: ", level);
1624 1.4 christos } else if (level > ISC_LOG_DYNAMIC) {
1625 1.1 christos snprintf(level_string, sizeof(level_string),
1626 1.1 christos "%s %d: ", log_level_strings[0],
1627 1.1 christos level);
1628 1.4 christos } else {
1629 1.1 christos snprintf(level_string, sizeof(level_string),
1630 1.1 christos "%s: ", log_level_strings[-level]);
1631 1.4 christos }
1632 1.1 christos }
1633 1.1 christos
1634 1.1 christos /*
1635 1.1 christos * Only format the message once.
1636 1.1 christos */
1637 1.1 christos if (lctx->buffer[0] == '\0') {
1638 1.1 christos (void)vsnprintf(lctx->buffer, sizeof(lctx->buffer),
1639 1.4 christos format, args);
1640 1.1 christos
1641 1.1 christos /*
1642 1.1 christos * Check for duplicates.
1643 1.1 christos */
1644 1.1 christos if (write_once) {
1645 1.1 christos isc_logmessage_t *message, *next;
1646 1.1 christos isc_time_t oldest;
1647 1.1 christos isc_interval_t interval;
1648 1.1 christos size_t size;
1649 1.1 christos
1650 1.1 christos isc_interval_set(&interval,
1651 1.1 christos lcfg->duplicate_interval, 0);
1652 1.1 christos
1653 1.1 christos /*
1654 1.5 christos * 'oldest' is the age of the oldest
1655 1.5 christos * messages which fall within the
1656 1.5 christos * duplicate_interval range.
1657 1.1 christos */
1658 1.1 christos TIME_NOW(&oldest);
1659 1.1 christos if (isc_time_subtract(&oldest, &interval,
1660 1.5 christos &oldest) != ISC_R_SUCCESS)
1661 1.5 christos {
1662 1.1 christos /*
1663 1.5 christos * Can't effectively do the
1664 1.5 christos * checking without having a
1665 1.5 christos * valid time.
1666 1.1 christos */
1667 1.1 christos message = NULL;
1668 1.5 christos } else {
1669 1.1 christos message = ISC_LIST_HEAD(lctx->messages);
1670 1.5 christos }
1671 1.1 christos
1672 1.1 christos while (message != NULL) {
1673 1.1 christos if (isc_time_compare(&message->time,
1674 1.1 christos &oldest) < 0) {
1675 1.1 christos /*
1676 1.1 christos * This message is older
1677 1.5 christos * than the
1678 1.5 christos * duplicate_interval,
1679 1.5 christos * so it should be
1680 1.5 christos * dropped from the
1681 1.5 christos * history.
1682 1.1 christos *
1683 1.5 christos * Setting the interval
1684 1.5 christos * to be to be longer
1685 1.5 christos * will obviously not
1686 1.5 christos * cause the expired
1687 1.5 christos * message to spring
1688 1.5 christos * back into existence.
1689 1.1 christos */
1690 1.1 christos next = ISC_LIST_NEXT(message,
1691 1.1 christos link);
1692 1.1 christos
1693 1.1 christos ISC_LIST_UNLINK(lctx->messages,
1694 1.1 christos message, link);
1695 1.1 christos
1696 1.5 christos isc_mem_put(
1697 1.5 christos lctx->mctx, message,
1698 1.1 christos sizeof(*message) + 1 +
1699 1.5 christos strlen(message->text));
1700 1.1 christos
1701 1.1 christos message = next;
1702 1.1 christos continue;
1703 1.1 christos }
1704 1.1 christos
1705 1.1 christos /*
1706 1.5 christos * This message is in the
1707 1.5 christos * duplicate filtering interval
1708 1.5 christos * ...
1709 1.1 christos */
1710 1.5 christos if (strcmp(lctx->buffer,
1711 1.5 christos message->text) == 0) {
1712 1.1 christos /*
1713 1.5 christos * ... and it is a
1714 1.5 christos * duplicate. Unlock the
1715 1.5 christos * mutex and get the
1716 1.5 christos * hell out of Dodge.
1717 1.1 christos */
1718 1.5 christos goto unlock;
1719 1.1 christos }
1720 1.1 christos
1721 1.1 christos message = ISC_LIST_NEXT(message, link);
1722 1.1 christos }
1723 1.1 christos
1724 1.1 christos /*
1725 1.1 christos * It wasn't in the duplicate interval,
1726 1.1 christos * so add it to the message list.
1727 1.1 christos */
1728 1.1 christos size = sizeof(isc_logmessage_t) +
1729 1.1 christos strlen(lctx->buffer) + 1;
1730 1.1 christos message = isc_mem_get(lctx->mctx, size);
1731 1.5 christos message->text = (char *)(message + 1);
1732 1.5 christos size -= sizeof(isc_logmessage_t);
1733 1.5 christos strlcpy(message->text, lctx->buffer, size);
1734 1.5 christos TIME_NOW(&message->time);
1735 1.5 christos ISC_LINK_INIT(message, link);
1736 1.5 christos ISC_LIST_APPEND(lctx->messages, message, link);
1737 1.1 christos }
1738 1.1 christos }
1739 1.1 christos
1740 1.5 christos utc = ((channel->flags & ISC_LOG_UTC) != 0);
1741 1.5 christos iso8601 = ((channel->flags & ISC_LOG_ISO8601) != 0);
1742 1.5 christos printtime = ((channel->flags & ISC_LOG_PRINTTIME) != 0);
1743 1.5 christos printtag = ((channel->flags &
1744 1.5 christos (ISC_LOG_PRINTTAG | ISC_LOG_PRINTPREFIX)) != 0 &&
1745 1.5 christos lcfg->tag != NULL);
1746 1.5 christos printcolon = ((channel->flags & ISC_LOG_PRINTTAG) != 0 &&
1747 1.5 christos lcfg->tag != NULL);
1748 1.3 christos printcategory = ((channel->flags & ISC_LOG_PRINTCATEGORY) != 0);
1749 1.5 christos printmodule = ((channel->flags & ISC_LOG_PRINTMODULE) != 0);
1750 1.5 christos printlevel = ((channel->flags & ISC_LOG_PRINTLEVEL) != 0);
1751 1.5 christos buffered = ((channel->flags & ISC_LOG_BUFFERED) != 0);
1752 1.1 christos
1753 1.1 christos if (printtime) {
1754 1.1 christos if (iso8601) {
1755 1.1 christos if (utc) {
1756 1.1 christos time_string = iso8601z_string;
1757 1.1 christos } else {
1758 1.1 christos time_string = iso8601l_string;
1759 1.1 christos }
1760 1.1 christos } else {
1761 1.1 christos time_string = local_time;
1762 1.1 christos }
1763 1.5 christos } else {
1764 1.1 christos time_string = "";
1765 1.5 christos }
1766 1.1 christos
1767 1.1 christos switch (channel->type) {
1768 1.1 christos case ISC_LOG_TOFILE:
1769 1.1 christos if (FILE_MAXREACHED(channel)) {
1770 1.1 christos /*
1771 1.1 christos * If the file can be rolled, OR
1772 1.1 christos * If the file no longer exists, OR
1773 1.5 christos * If the file is less than the maximum
1774 1.5 christos * size, (such as if it had been renamed
1775 1.5 christos * and a new one touched, or it was
1776 1.5 christos * truncated in place)
1777 1.5 christos * ... then close it to trigger
1778 1.5 christos * reopening.
1779 1.1 christos */
1780 1.1 christos if (FILE_VERSIONS(channel) !=
1781 1.5 christos ISC_LOG_ROLLNEVER ||
1782 1.1 christos (stat(FILE_NAME(channel), &statbuf) != 0 &&
1783 1.1 christos errno == ENOENT) ||
1784 1.5 christos statbuf.st_size < FILE_MAXSIZE(channel))
1785 1.5 christos {
1786 1.1 christos (void)fclose(FILE_STREAM(channel));
1787 1.1 christos FILE_STREAM(channel) = NULL;
1788 1.3 christos FILE_MAXREACHED(channel) = false;
1789 1.5 christos } else {
1790 1.1 christos /*
1791 1.1 christos * Eh, skip it.
1792 1.1 christos */
1793 1.1 christos break;
1794 1.5 christos }
1795 1.1 christos }
1796 1.1 christos
1797 1.1 christos if (FILE_STREAM(channel) == NULL) {
1798 1.1 christos result = isc_log_open(channel);
1799 1.1 christos if (result != ISC_R_SUCCESS &&
1800 1.1 christos result != ISC_R_MAXSIZE &&
1801 1.5 christos (channel->flags & ISC_LOG_OPENERR) == 0)
1802 1.5 christos {
1803 1.1 christos syslog(LOG_ERR,
1804 1.5 christos "isc_log_open '%s' "
1805 1.5 christos "failed: %s",
1806 1.1 christos FILE_NAME(channel),
1807 1.1 christos isc_result_totext(result));
1808 1.1 christos channel->flags |= ISC_LOG_OPENERR;
1809 1.1 christos }
1810 1.5 christos if (result != ISC_R_SUCCESS) {
1811 1.1 christos break;
1812 1.5 christos }
1813 1.1 christos channel->flags &= ~ISC_LOG_OPENERR;
1814 1.1 christos }
1815 1.7 christos FALLTHROUGH;
1816 1.1 christos
1817 1.1 christos case ISC_LOG_TOFILEDESC:
1818 1.5 christos fprintf(FILE_STREAM(channel), "%s%s%s%s%s%s%s%s%s%s\n",
1819 1.5 christos printtime ? time_string : "",
1820 1.5 christos printtime ? " " : "", printtag ? lcfg->tag : "",
1821 1.5 christos printcolon ? ": " : "",
1822 1.5 christos printcategory ? category->name : "",
1823 1.5 christos printcategory ? ": " : "",
1824 1.5 christos printmodule ? (module != NULL ? module->name
1825 1.5 christos : "no_module")
1826 1.5 christos : "",
1827 1.5 christos printmodule ? ": " : "",
1828 1.5 christos printlevel ? level_string : "", lctx->buffer);
1829 1.1 christos
1830 1.5 christos if (!buffered) {
1831 1.1 christos fflush(FILE_STREAM(channel));
1832 1.5 christos }
1833 1.1 christos
1834 1.1 christos /*
1835 1.1 christos * If the file now exceeds its maximum size
1836 1.5 christos * threshold, note it so that it will not be
1837 1.5 christos * logged to any more.
1838 1.1 christos */
1839 1.1 christos if (FILE_MAXSIZE(channel) > 0) {
1840 1.1 christos INSIST(channel->type == ISC_LOG_TOFILE);
1841 1.1 christos
1842 1.1 christos /* XXXDCL NT fstat/fileno */
1843 1.1 christos /* XXXDCL complain if fstat fails? */
1844 1.1 christos if (fstat(fileno(FILE_STREAM(channel)),
1845 1.1 christos &statbuf) >= 0 &&
1846 1.1 christos statbuf.st_size > FILE_MAXSIZE(channel))
1847 1.5 christos {
1848 1.3 christos FILE_MAXREACHED(channel) = true;
1849 1.5 christos }
1850 1.1 christos }
1851 1.1 christos
1852 1.1 christos break;
1853 1.1 christos
1854 1.1 christos case ISC_LOG_TOSYSLOG:
1855 1.5 christos if (level > 0) {
1856 1.1 christos syslog_level = LOG_DEBUG;
1857 1.5 christos } else if (level < ISC_LOG_CRITICAL) {
1858 1.1 christos syslog_level = LOG_CRIT;
1859 1.5 christos } else {
1860 1.1 christos syslog_level = syslog_map[-level];
1861 1.5 christos }
1862 1.1 christos
1863 1.5 christos (void)syslog(
1864 1.5 christos FACILITY(channel) | syslog_level,
1865 1.5 christos "%s%s%s%s%s%s%s%s%s%s",
1866 1.5 christos printtime ? time_string : "",
1867 1.5 christos printtime ? " " : "", printtag ? lcfg->tag : "",
1868 1.5 christos printcolon ? ": " : "",
1869 1.5 christos printcategory ? category->name : "",
1870 1.5 christos printcategory ? ": " : "",
1871 1.5 christos printmodule ? (module != NULL ? module->name
1872 1.5 christos : "no_module")
1873 1.5 christos : "",
1874 1.5 christos printmodule ? ": " : "",
1875 1.5 christos printlevel ? level_string : "", lctx->buffer);
1876 1.1 christos break;
1877 1.1 christos
1878 1.1 christos case ISC_LOG_TONULL:
1879 1.1 christos break;
1880 1.1 christos }
1881 1.1 christos } while (1);
1882 1.1 christos
1883 1.5 christos unlock:
1884 1.1 christos UNLOCK(&lctx->lock);
1885 1.5 christos RDUNLOCK(&lctx->lcfg_rwl);
1886 1.1 christos }
1887