log.h revision 224092 
1/*
2 * Copyright (C) 2004-2007, 2009  Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2001, 2003  Internet Software Consortium.
4 *
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
8 *
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
16 */
17
18/* $Id: log.h,v 1.45 2009-12-18 22:16:49 each Exp $ */
19
20/*! \file dns/log.h
21 * \author  Principal Authors: DCL */
22
23#ifndef DNS_LOG_H
24#define DNS_LOG_H 1
25
26#include <isc/lang.h>
27#include <isc/log.h>
28
29LIBDNS_EXTERNAL_DATA extern isc_log_t *dns_lctx;
30LIBDNS_EXTERNAL_DATA extern isc_logcategory_t dns_categories[];
31LIBDNS_EXTERNAL_DATA extern isc_logmodule_t dns_modules[];
32
33#define DNS_LOGCATEGORY_NOTIFY		(&dns_categories[0])
34#define DNS_LOGCATEGORY_DATABASE	(&dns_categories[1])
35#define DNS_LOGCATEGORY_SECURITY	(&dns_categories[2])
36/* DNS_LOGCATEGORY_CONFIG superseded by CFG_LOGCATEGORY_CONFIG */
37#define DNS_LOGCATEGORY_DNSSEC		(&dns_categories[4])
38#define DNS_LOGCATEGORY_RESOLVER	(&dns_categories[5])
39#define DNS_LOGCATEGORY_XFER_IN		(&dns_categories[6])
40#define DNS_LOGCATEGORY_XFER_OUT	(&dns_categories[7])
41#define DNS_LOGCATEGORY_DISPATCH	(&dns_categories[8])
42#define DNS_LOGCATEGORY_LAME_SERVERS	(&dns_categories[9])
43#define DNS_LOGCATEGORY_DELEGATION_ONLY	(&dns_categories[10])
44#define DNS_LOGCATEGORY_EDNS_DISABLED	(&dns_categories[11])
45
46/* Backwards compatibility. */
47#define DNS_LOGCATEGORY_GENERAL		ISC_LOGCATEGORY_GENERAL
48
49#define DNS_LOGMODULE_DB		(&dns_modules[0])
50#define DNS_LOGMODULE_RBTDB		(&dns_modules[1])
51#define DNS_LOGMODULE_RBTDB64		(&dns_modules[2])
52#define DNS_LOGMODULE_RBT		(&dns_modules[3])
53#define DNS_LOGMODULE_RDATA		(&dns_modules[4])
54#define DNS_LOGMODULE_MASTER		(&dns_modules[5])
55#define DNS_LOGMODULE_MESSAGE		(&dns_modules[6])
56#define DNS_LOGMODULE_CACHE		(&dns_modules[7])
57#define DNS_LOGMODULE_CONFIG		(&dns_modules[8])
58#define DNS_LOGMODULE_RESOLVER		(&dns_modules[9])
59#define DNS_LOGMODULE_ZONE		(&dns_modules[10])
60#define DNS_LOGMODULE_JOURNAL		(&dns_modules[11])
61#define DNS_LOGMODULE_ADB		(&dns_modules[12])
62#define DNS_LOGMODULE_XFER_IN		(&dns_modules[13])
63#define DNS_LOGMODULE_XFER_OUT		(&dns_modules[14])
64#define DNS_LOGMODULE_ACL		(&dns_modules[15])
65#define DNS_LOGMODULE_VALIDATOR		(&dns_modules[16])
66#define DNS_LOGMODULE_DISPATCH		(&dns_modules[17])
67#define DNS_LOGMODULE_REQUEST		(&dns_modules[18])
68#define DNS_LOGMODULE_MASTERDUMP	(&dns_modules[19])
69#define DNS_LOGMODULE_TSIG		(&dns_modules[20])
70#define DNS_LOGMODULE_TKEY		(&dns_modules[21])
71#define DNS_LOGMODULE_SDB		(&dns_modules[22])
72#define DNS_LOGMODULE_DIFF		(&dns_modules[23])
73#define DNS_LOGMODULE_HINTS		(&dns_modules[24])
74#define DNS_LOGMODULE_ACACHE		(&dns_modules[25])
75#define DNS_LOGMODULE_DLZ		(&dns_modules[26])
76#define DNS_LOGMODULE_DNSSEC		(&dns_modules[27])
77
78ISC_LANG_BEGINDECLS
79
80void
81dns_log_init(isc_log_t *lctx);
82/*%
83 * Make the libdns categories and modules available for use with the
84 * ISC logging library.
85 *
86 * Requires:
87 *\li	lctx is a valid logging context.
88 *
89 *\li	dns_log_init() is called only once.
90 *
91 * Ensures:
92 * \li	The categories and modules defined above are available for
93 * 	use by isc_log_usechannnel() and isc_log_write().
94 */
95
96void
97dns_log_setcontext(isc_log_t *lctx);
98/*%
99 * Make the libdns library use the provided context for logging internal
100 * messages.
101 *
102 * Requires:
103 *\li	lctx is a valid logging context.
104 */
105
106ISC_LANG_ENDDECLS
107
108#endif /* DNS_LOG_H */
109