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