include/dns/log.h

	log.h revision 9fee08f655527a5dd849b171daeeee1dbbccca76
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley/*
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * Copyright (C) 2004-2007, 2009  Internet Systems Consortium, Inc. ("ISC")
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * Copyright (C) 1999-2001, 2003  Internet Software Consortium.
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley *
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * Permission to use, copy, modify, and/or distribute this software for any
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * purpose with or without fee is hereby granted, provided that the above
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * copyright notice and this permission notice appear in all copies.
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley *
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * PERFORMANCE OF THIS SOFTWARE.
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley */
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley/* $Id: log.h,v 1.46 2011/10/13 01:32:34 vjs Exp $ */
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley/*! \file dns/log.h
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * \author  Principal Authors: DCL */
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#ifndef DNS_LOG_H
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOG_H 1
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#include <isc/lang.h>
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#include <isc/log.h>
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob HalleyLIBDNS_EXTERNAL_DATA extern isc_log_t *dns_lctx;
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob HalleyLIBDNS_EXTERNAL_DATA extern isc_logcategory_t dns_categories[];
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob HalleyLIBDNS_EXTERNAL_DATA extern isc_logmodule_t dns_modules[];
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGCATEGORY_NOTIFY      (&dns_categories[0])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGCATEGORY_DATABASE    (&dns_categories[1])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGCATEGORY_SECURITY    (&dns_categories[2])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley/* DNS_LOGCATEGORY_CONFIG superseded by CFG_LOGCATEGORY_CONFIG */
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGCATEGORY_DNSSEC      (&dns_categories[4])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGCATEGORY_RESOLVER    (&dns_categories[5])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGCATEGORY_XFER_IN     (&dns_categories[6])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGCATEGORY_XFER_OUT    (&dns_categories[7])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGCATEGORY_DISPATCH    (&dns_categories[8])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGCATEGORY_LAME_SERVERS    (&dns_categories[9])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGCATEGORY_DELEGATION_ONLY (&dns_categories[10])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGCATEGORY_EDNS_DISABLED   (&dns_categories[11])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGCATEGORY_RPZ     (&dns_categories[12])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley/* Backwards compatibility. */
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGCATEGORY_GENERAL     ISC_LOGCATEGORY_GENERAL
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_DB        (&dns_modules[0])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_RBTDB     (&dns_modules[1])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_RBTDB64       (&dns_modules[2])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_RBT       (&dns_modules[3])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_RDATA     (&dns_modules[4])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_MASTER        (&dns_modules[5])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_MESSAGE       (&dns_modules[6])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_CACHE     (&dns_modules[7])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_CONFIG        (&dns_modules[8])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_RESOLVER      (&dns_modules[9])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_ZONE      (&dns_modules[10])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_JOURNAL       (&dns_modules[11])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_ADB       (&dns_modules[12])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_XFER_IN       (&dns_modules[13])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_XFER_OUT      (&dns_modules[14])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_ACL       (&dns_modules[15])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_VALIDATOR     (&dns_modules[16])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_DISPATCH      (&dns_modules[17])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_REQUEST       (&dns_modules[18])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_MASTERDUMP    (&dns_modules[19])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_TSIG      (&dns_modules[20])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_TKEY      (&dns_modules[21])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_SDB       (&dns_modules[22])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_DIFF      (&dns_modules[23])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_HINTS     (&dns_modules[24])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_ACACHE        (&dns_modules[25])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_DLZ       (&dns_modules[26])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#define DNS_LOGMODULE_DNSSEC        (&dns_modules[27])
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob HalleyISC_LANG_BEGINDECLS
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halleyvoid
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halleydns_log_init(isc_log_t *lctx);
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley/*%
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * Make the libdns categories and modules available for use with the
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * ISC logging library.
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley *
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * Requires:
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley *\li   lctx is a valid logging context.
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley *
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley *\li   dns_log_init() is called only once.
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley *
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * Ensures:
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * \li  The categories and modules defined above are available for
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley *  use by isc_log_usechannnel() and isc_log_write().
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley */
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halleyvoid
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halleydns_log_setcontext(isc_log_t *lctx);
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley/*%
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * Make the libdns library use the provided context for logging internal
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * messages.
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley *
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley * Requires:
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley *\li   lctx is a valid logging context.
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley */
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob HalleyISC_LANG_ENDDECLS
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley#endif /* DNS_LOG_H */
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley