log.h revision 5fe5a0c02634eaadfcbc3528bf2c184557110a3b
ca41b452ede6feaa9d8739ec3cae19389a7b0d03Bob Halley * Copyright (C) 1999, 2000 Internet Software Consortium.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Permission to use, copy, modify, and distribute this software for any
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * purpose with or without fee is hereby granted, provided that the above
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * copyright notice and this permission notice appear in all copies.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
5fe5a0c02634eaadfcbc3528bf2c184557110a3bAndreas Gustafsson/* $Id: log.h,v 1.14 2000/03/23 00:53:05 gson Exp $ */
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Severity levels, patterned after Unix's syslog levels.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ISC_LOG_DYNAMIC can only be used for defining channels with
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * isc_log_createchannel(), not to specify a level in isc_log_write().
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Destinations.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Channel flags.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Other options.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * XXXDCL INFINITE doesn't yet work. Arguably it isn't needed, but
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * since I am intend to make large number of versions work efficiently,
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * INFINITE is going to be trivial to add to that.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * A logging context. Details are internal to the implementation.
edcd1247ad7e81bb8b430e610d9718f64c70f05dDavid Lawrence * Channel configuration. Details are internal to the implementation.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Used to name the categories used by a library. An array of isc_logcategory
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * structures names each category, and the id value is initialized by calling
d409ceeda41a256e8114423674d844d5f5035ee8Bob Halley * isc_log_registercategories.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence unsigned int id;
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Similar to isc_logcategory above, but for all the modules a library defines.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrencetypedef struct isc_logmodule {
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence unsigned int id;
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The isc_logfile structure is initialized as part of an isc_logdestination
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * before calling isc_log_createchannel(). When defining an ISC_LOG_TOFILE
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * channel the name, versions and maximum_size should be set before calling
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * isc_log_createchannel(). To define an ISC_LOG_TOFILEDESC channel set only
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * the stream before the call.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrencetypedef struct isc_logfile {
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence FILE *stream; /* Initialized to NULL for ISC_LOG_TOFILE. */
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence char *name; /* NULL for ISC_LOG_TOFILEDESC. */
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence int versions; /* >= 0, ISC_LOG_ROLLNEVER, ISC_LOG_ROLLINFINITE. */
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * stdio's ftell is standardized to return a long, which may well not
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * be big enough for the largest file supportable by the operating
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * system (though it is _probably_ big enough for the largest log
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * anyone would want). st_size returned by fstat should be typedef'd
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * to a size large enough for the largest possible file on a system.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence /* XXXDCL NT */
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Passed to isc_log_createchannel to define the attributes of either
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * a stdio or a syslog log.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The built-in categories of libisc.a. Currently only one is available,
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * the category named "default".
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Each library registering categories should provide library_LOGCATEGORY_name
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * definitions with indexes into its isc_logcategory structure corresponding to
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * the order of the names. This should also be done for modules, but currently
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * libisc.a has no defined modules.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence#define ISC_LOGCATEGORY_DEFAULT (&isc_categories[0])
5fe5a0c02634eaadfcbc3528bf2c184557110a3bAndreas Gustafsson#define ISC_LOGCATEGORY_GENERAL (&isc_categories[1])
edcd1247ad7e81bb8b430e610d9718f64c70f05dDavid Lawrenceisc_log_create(isc_mem_t *mctx, isc_log_t **lctxp, isc_logconfig_t **lcfgp);
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Establish a new logging context, with default channels.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * isc_log_create calls isc_logconfig_create, so see its comment
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * below for more information.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * mctx is a valid memory context.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * lctxp is not null and *lctxp is null.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * lctfg is not null and *lcfgp is null.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * *lctxp will point to a valid logging context if all of the necessary
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * memory was allocated, or NULL otherwise.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * *lcfgp will point to a valid logging context if all of the necessary
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * memory was allocated, or NULL otherwise.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * On failure, no additional memory is allocated.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * ISC_R_SUCCESS Success
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * ISC_R_NOMEMORY Resource limit: Out of memory
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrenceisc_logconfig_create(isc_log_t *lctx, isc_logconfig_t **lcfgp);
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * Create the data structure that holds all of the configurable information
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * about where messages are actually supposed to be sent -- the information
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * that could changed based on some configuration file, as opposed to the
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * the category/module specification of isc_log_[v]write[1] that is compiled
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * into a program, or the debug_level which is dynamic state information.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * It is necessary to specify the logging context the configuration
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * will be used with because the number of categories and modules
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * needs to be known in order to set the configuration. However,
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * the configuration is not used by the logging context until the
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * isc_logconfig_use function is called.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * The memory context used for operations that allocate memory for
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * the configuration is that of the logging context, as specified
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * in the isc_log_create call.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Four default channels are established:
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * default_syslog
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * - log to syslog's daemon facility LOG_INFO or higher
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * default_stderr
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * - log to stderr LOG_INFO or higher
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * default_debug
a8d34ca88c60ede52a8698cc56545b865380f1f5David Lawrence * - log to stderr LOG_DEBUG dynamically
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * - log nothing
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * lctx is a valid logging context.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * lcftp is not null and *lcfgp is null.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * *lcfgp will point to a valid logging context if all of the necessary
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * memory was allocated, or NULL otherwise.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * On failure, no additional memory is allocated.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ISC_R_SUCCESS Success
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ISC_R_NOMEMORY Resource limit: Out of memory
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * Returns a pointer to the configuration currently in use by the log context.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * lctx is a valid context.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * The configuration pointer is non-null.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * The configuration pointer.
edcd1247ad7e81bb8b430e610d9718f64c70f05dDavid Lawrenceisc_logconfig_use(isc_log_t *lctx, isc_logconfig_t *lcfg);
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * Associate a new configuration with a logging context.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * This is thread safe. The logging context will lock a mutex
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * before attempting to swap in the new configuration, and isc_log_doit
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * (the internal function used by all of isc_log_[v]write[1]) locks
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * the same lock for the duration of its use of the configuration.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * lctx is a valid logging context.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * lcfg is a valid logging configuration.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * lctx is the same configuration given to isc_logconfig_create
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * when the configuration was created.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * Future calls to isc_log_write will use the new configuration.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * ISC_R_SUCCESS Success
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * ISC_R_NOMEMORY Resource limit: Out of memory
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Deallocate the memory associated with a logging context.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * *lctx is a valid logging context.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * All of the memory associated with the logging context is returned
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * to the free memory pool.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Any open files are closed.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The logging context is marked as invalid.
edcd1247ad7e81bb8b430e610d9718f64c70f05dDavid Lawrenceisc_logconfig_destroy(isc_logconfig_t **lcfgp);
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * Destroy a logging configuration.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * This function cannot be used directly with the return value of
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * isc_logconfig_get, because a logging context must always have
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * a valid configuration associated with it.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * lcfgp is not null and *lcfgp is a valid logging configuration.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * The logging configuration is not in use by an existing logging context.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * All memory allocated for the configuration is freed.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * The configuration is marked as invalid.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrenceisc_log_registercategories(isc_log_t *lctx, isc_logcategory_t categories[]);
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Identify logging categories a library will use.
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * A category should only be registered once, but no mechanism enforces
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The end of the categories array is identified by a NULL name.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Because the name is used by ISC_LOG_PRINTCATEGORY, it should not
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * be altered or destroyed after isc_log_registercategories().
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * Because each element of the categories array is used by
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * isc_log_categorybyname, it should not be altered or destroyed
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * after registration.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The value of the id integer in each structure is overwritten
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * by this function, and so id need not be initalized to any particular
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * value prior to the function call.
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * A subsequent call to isc_log_registercategories with the same
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * logging context (but new categories) will cause the last
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * element of the categories array from the prior call to have
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * its "name" member changed from NULL to point to the new
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * categories array, and its "id" member set to UINT_MAX.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * lctx is a valid logging context.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * categories != NULL.
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * categories[0].name != NULL.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * There are references to each category in the logging context,
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * so they can be used with isc_log_usechannel() and isc_log_write().
fc80027fb54b501cdd88461bf879d078259e0226David Lawrenceisc_log_registermodules(isc_log_t *lctx, isc_logmodule_t modules[]);
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Identify logging categories a library will use.
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * A module should only be registered once, but no mechanism enforces
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The end of the modules array is identified by a NULL name.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Because the name is used by ISC_LOG_PRINTMODULE, it should not
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * be altered or destroyed after isc_log_registermodules().
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * Because each element of the modules array is used by
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * isc_log_modulebyname, it should not be altered or destroyed
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * after registration.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The value of the id integer in each structure is overwritten
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * by this function, and so id need not be initalized to any particular
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * value prior to the function call.
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * A subsequent call to isc_log_registermodules with the same
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * logging context (but new modules) will cause the last
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * element of the modules array from the prior call to have
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * its "name" member changed from NULL to point to the new
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * modules array, and its "id" member set to UINT_MAX.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * lctx is a valid logging context.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * modules != NULL.
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * modules[0].name != NULL;
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Each module has a reference in the logging context, so they can be
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * used with isc_log_usechannel() and isc_log_write().
edcd1247ad7e81bb8b430e610d9718f64c70f05dDavid Lawrenceisc_log_createchannel(isc_logconfig_t *lcfg, const char *name,
edcd1247ad7e81bb8b430e610d9718f64c70f05dDavid Lawrence isc_logdestination_t *destination, unsigned int flags);
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Specify the parameters of a logging channel.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The name argument is copied to memory in the logging context, so
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * it can be altered or destroyed after isc_log_createchannel().
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Defining a very large number of channels will have a performance
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * impact on isc_log_usechannel(), since the names are searched
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * linearly until a match is made. This same issue does not affect
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * isc_log_write, however.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Channel names can be redefined; this is primarily useful for programs
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * that want their own definition of default_syslog, default_debug
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * and default_stderr.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Any channel that is redefined will not affect logging that was
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * already directed to its original definition, _except_ for the
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * default_stderr channel. This case is handled specially so that
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * the default logging category can be changed by redefining
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * default_stderr. (XXXDCL Though now that I think of it, the default
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * logging category can be changed with only one additional function
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * call by defining a new channel and then calling isc_log_usechannel()
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * for ISC_LOGCATEGORY_DEFAULT.)
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Specifying ISC_LOG_PRINTTIME for syslog is allowed, but probably
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * not what you wanted to do.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * ISC_LOG_DEBUGONLY will mark the channel as usable only when the
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * debug level of the logging context (see isc_log_setdebuglevel)
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * is non-zero.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * lcfg is a valid logging configuration.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * name is not NULL.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * type is ISC_LOG_TOSYSLOG, ISC_LOG_TOFILE, ISC_LOG_TOFILEDESC or
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ISC_LOG_TONULL.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * destination is not NULL unless type is ISC_LOG_TONULL.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * level is >= ISC_LOG_CRITICAL (the most negative logging level).
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * flags does not include any bits aside from the ISC_LOG_PRINT* bits
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * or ISC_LOG_DEBUGONLY.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ISC_R_SUCCESS
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * A channel with the given name is usable with
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * isc_log_usechannel().
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ISC_R_NOMEMORY or ISC_R_UNEXPECTED
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * No additional memory is being used by the logging context.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Any channel that previously existed with the given name
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * is not redefined.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ISC_R_SUCCESS Success
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ISC_R_NOMEMORY Resource limit: Out of memory
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * ISC_R_UNEXPECTED type was out of range and REQUIRE()
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * was disabled.
edcd1247ad7e81bb8b430e610d9718f64c70f05dDavid Lawrenceisc_log_usechannel(isc_logconfig_t *lcfg, const char *name,
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence isc_logcategory_t *category, isc_logmodule_t *module);
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Associate a named logging channel with a category and module that
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * will use it.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The name is searched for linearly in the set of known channel names
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * until a match is found. (Note the performance impact of a very large
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * number of named channels.) When multiple channels of the same
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * name are defined, the most recent definition is found.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Specifing a very large number of channels for a category will have
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * a moderate impact on performance in isc_log_write(), as each
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * call looks up the category for the start of a linked list, which
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * it follows all the way to the end to find matching modules. The
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * test for matching modules is integral, though.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * If category is NULL, then the channel is associated with the indicated
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * module for all known categories (including the "default" category).
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * If module is NULL, then the channel is associated with every module
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * that uses that category.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Passing both category and module as NULL would make every log message
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * use the indicated channel.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Specifying a channel that is ISC_LOG_TONULL for a category/module pair
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * has no effect on any other channels associated with that pair,
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * regardless of ordering. Thus you cannot use it to "mask out" one
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * category/module pair when you have specified some other channel that
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * is also used by that category/module pair.
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * lcfg is a valid logging configuration.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * category is NULL or has an id that is in the range of known ids.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * module is NULL or has an id that is in the range of known ids.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ISC_R_SUCCESS
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The channel will be used by the indicated category/module
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ISC_R_NOMEMORY
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * If assignment for a specific category has been requested,
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * the channel has not been associated with the indicated
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * category/module arguments and no additional memory is
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * used by the logging context.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * If assignment for all categories has been requested
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * then _some_ may have succeeded (starting with category
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * "default" and progressing through the order of categories
863ac191b448a13ae1a3a8ee3458344e11602737David Lawrence * passed to isc_log_registercategories) and additional memory
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * is being used by whatever assignments succeeded.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ISC_R_SUCCESS Success
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ISC_R_NOMEMORY Resource limit: Out of memory
fc80027fb54b501cdd88461bf879d078259e0226David Lawrenceisc_log_write(isc_log_t *lctx, isc_logcategory_t *category,
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence isc_logmodule_t *module, int level, const char *format, ...);
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Write a message to the log channels.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * lctx can be NULL; this is allowed so that programs which use
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * libraries that use the ISC logging system are not required to
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * also use it.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The format argument is a printf(3) string, with additional arguments
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * as necessary.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * lctx is a valid logging context.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The category and module arguments must have ids that are in the
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * range of known ids, as estabished by isc_log_registercategories()
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * and isc_log_registermodules().
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * level != ISC_LOG_DYNAMiC. ISC_LOG_DYNAMIC is used only to define
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * channels, and explicit debugging level must be identified for
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * isc_log_write() via ISC_LOG_DEBUG(level).
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * format != NULL.
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * The log message is written to every channel associated with the
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * indicated category/module pair.
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * Nothing. Failure to log a message is not construed as a
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * meaningful error.
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrenceisc_log_vwrite(isc_log_t *lctx, isc_logcategory_t *category,
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence isc_logmodule_t *module, int level, const char *format,
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * Write a message to the log channels.
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * lctx can be NULL; this is allowed so that programs which use
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * libraries that use the ISC logging system are not required to
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * also use it.
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * The format argument is a printf(3) string, with additional arguments
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * as necessary.
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * lctx is a valid logging context.
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * The category and module arguments must have ids that are in the
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * range of known ids, as estabished by isc_log_registercategories()
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * and isc_log_registermodules().
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * level != ISC_LOG_DYNAMiC. ISC_LOG_DYNAMIC is used only to define
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * channels, and explicit debugging level must be identified for
00a1623a59b1540c28781e8ccd8341c8114dbc75David Lawrence * isc_log_write() via ISC_LOG_DEBUG(level).
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * format != NULL.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The log message is written to every channel associated with the
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * indicated category/module pair.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Nothing. Failure to log a message is not construed as a
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * meaningful error.
1b038dbf0659fce246485562601ee851a9841ba1David Lawrenceisc_log_write1(isc_log_t *lctx, isc_logcategory_t *category,
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence isc_logmodule_t *module, int level, const char *format, ...);
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * Write a message to the log channels, pruning duplicates that occur within
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * a configurable amount of seconds (see isc_log_[sg]etduplicateinterval).
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * This function is otherwise identical to isc_log_write().
1b038dbf0659fce246485562601ee851a9841ba1David Lawrenceisc_log_vwrite1(isc_log_t *lctx, isc_logcategory_t *category,
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence isc_logmodule_t *module, int level, const char *format,
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * Write a message to the log channels, pruning duplicates that occur within
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * a configurable amount of seconds (see isc_log_[sg]etduplicateinterval).
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * This function is otherwise identical to isc_log_vwrite().
fc80027fb54b501cdd88461bf879d078259e0226David Lawrenceisc_log_setdebuglevel(isc_log_t *lctx, unsigned int level);
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Set the debugging level used for logging.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Setting the debugging level to 0 disables debugging log messages.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * lctx is a valid logging context.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The debugging level is set to the requested value.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Get the current debugging level.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * This is provided so that a program can have a notion of
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * "increment debugging level" or "decrement debugging level"
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * without needing to keep track of what the current level is.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * A return value of 0 indicates that debugging messages are disabled.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * lctx is a valid logging context.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The current logging debugging level is returned.
edcd1247ad7e81bb8b430e610d9718f64c70f05dDavid Lawrenceisc_log_setduplicateinterval(isc_logconfig_t *lcfg, unsigned int interval);
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * Set the interval over which duplicate log messages will be ignored
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * by isc_log_[v]write1(), in seconds.
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * Increasing the duplicate interval from X to Y will not necessarily
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * filter out duplicates of messages logged in Y - X seconds since the
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * increase. (Example: Message1 is logged at midnight. Message2
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * is logged at 00:01:00, when the interval is only 30 seconds, causing
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * Message1 to be expired from the log message history. Then the interval
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * is increased to 3000 (five minutes) and at 00:04:00 Message1 is logged
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * again. It will appear the second time even though less than five
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * passed since the first occurrence.
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * lctx is a valid logging context.
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * The duplicate interval is set to the current
edcd1247ad7e81bb8b430e610d9718f64c70f05dDavid Lawrenceisc_log_getduplicateinterval(isc_logconfig_t *lcfg);
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * Get the current duplicate filtering interval.
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * lctx is a valid logging context.
1b038dbf0659fce246485562601ee851a9841ba1David Lawrence * The current duplicate filtering interval is returned.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrenceisc_log_opensyslog(const char *tag, int options, int facility);
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Initialize syslog logging.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * This is currently equivalent to openlog(), but is not going to remain
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * that way. In the meantime, the arguments are all identical to
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * those used by openlog(3), as follows:
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * tag: The string to use in the position of the program
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * name in syslog messages. Most (all?) syslogs
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * will use basename(argv[0]) if tag is NULL.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * options: LOG_CONS, LOG_PID, LOG_NDELAY ... whatever your
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * syslog supports.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * facility: The default syslog facility. This is irrelevant
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * since isc_log_write will ALWAYS use the channel's
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * declared facility.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Zero effort has been made (yet) to accomodate systems with openlog()
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * that only takes two arguments, or to identify valid syslog
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * facilities or options for any given architecture.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * It is necessary to call isc_log_opensyslog() to initialize
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * syslogging on machines which do not support network connections to
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * syslogd because they require a Unix domain socket to be used. Since
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * this is a chore to determine at run-time, it is suggested that it
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * always be called by programs using the ISC logging system.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * openlog() is called to initialize the syslog system.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * Close all open files used by ISC_LOG_TOFILE channels.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * This function is provided for programs that want to use their own
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * log rolling mechanism rather than the one provided internally.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * For example, a program that wanted to keep daily logs would define
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * a channel which used ISC_LOG_ROLLNEVER, then once a day would
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * rename the log file and call isc_log_closefilelogs().
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * ISC_LOG_TOFILEDESC channels are unaffected.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * lctx is a valid context.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * The open files are closed and will be reopened when they are
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence * next needed.
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrenceisc_log_categorybyname(isc_log_t *lctx, const char *name);
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * Find a category by its name.
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * The string name of a category is not required to be unique.
1be10d46cbdf77d1a59a2e7512b72daceea47058David Lawrence * lctx is a valid context.
1be10d46cbdf77d1a59a2e7512b72daceea47058David Lawrence * name is not NULL.
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * A pointer to the _first_ isc_logcategory_t structure used by "name".
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * NULL if no category exists by that name.
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrenceisc_log_modulebyname(isc_log_t *lctx, const char *name);
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * Find a module by its name.
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * The string name of a module is not required to be unique.
1be10d46cbdf77d1a59a2e7512b72daceea47058David Lawrence * lctx is a valid context.
1be10d46cbdf77d1a59a2e7512b72daceea47058David Lawrence * name is not NULL.
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * A pointer to the _first_ isc_logmodule_t structure used by "name".
ff30a206ecc63b6681716322ed7f017e3f51ea7fDavid Lawrence * NULL if no module exists by that name.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence#endif /* ISC_LOG_H */