xref: /openbsd-src/usr.bin/dig/lib/dns/include/dns/log.h (revision 1a012e203fda2c556b94cb3ca131645df05c4951)
1 /*
2  * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
10  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
11  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
12  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
13  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14  * PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 /*! \file dns/log.h
18  * \author  Principal Authors: DCL */
19 
20 #ifndef DNS_LOG_H
21 #define DNS_LOG_H 1
22 
23 #include <isc/log.h>
24 
25 extern isc_log_t *dns_lctx;
26 extern isc_logcategory_t dns_categories[];
27 extern isc_logmodule_t dns_modules[];
28 
29 #define DNS_LOGCATEGORY_NOTIFY		(&dns_categories[0])
30 #define DNS_LOGCATEGORY_DATABASE	(&dns_categories[1])
31 #define DNS_LOGCATEGORY_SECURITY	(&dns_categories[2])
32 /* DNS_LOGCATEGORY_CONFIG superseded by CFG_LOGCATEGORY_CONFIG */
33 #define DNS_LOGCATEGORY_DNSSEC		(&dns_categories[4])
34 #define DNS_LOGCATEGORY_RESOLVER	(&dns_categories[5])
35 #define DNS_LOGCATEGORY_XFER_IN		(&dns_categories[6])
36 #define DNS_LOGCATEGORY_XFER_OUT	(&dns_categories[7])
37 #define DNS_LOGCATEGORY_DISPATCH	(&dns_categories[8])
38 #define DNS_LOGCATEGORY_LAME_SERVERS	(&dns_categories[9])
39 #define DNS_LOGCATEGORY_DELEGATION_ONLY	(&dns_categories[10])
40 #define DNS_LOGCATEGORY_EDNS_DISABLED	(&dns_categories[11])
41 #define DNS_LOGCATEGORY_RPZ		(&dns_categories[12])
42 #define DNS_LOGCATEGORY_RRL		(&dns_categories[13])
43 #define DNS_LOGCATEGORY_CNAME		(&dns_categories[14])
44 #define DNS_LOGCATEGORY_SPILL		(&dns_categories[15])
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 #define DNS_LOGMODULE_CRYPTO		(&dns_modules[28])
78 #define DNS_LOGMODULE_PACKETS		(&dns_modules[29])
79 #define DNS_LOGMODULE_SSU		(&dns_modules[30])
80 
81 void
82 dns_log_init(isc_log_t *lctx);
83 /*%
84  * Make the libdns categories and modules available for use with the
85  * ISC logging library.
86  *
87  * Requires:
88  *\li	lctx is a valid logging context.
89  *
90  *\li	dns_log_init() is called only once.
91  *
92  * Ensures:
93  * \li	The categories and modules defined above are available for
94  * 	use by isc_log_usechannnel() and isc_log_write().
95  */
96 
97 void
98 dns_log_setcontext(isc_log_t *lctx);
99 /*%
100  * Make the libdns library use the provided context for logging internal
101  * messages.
102  *
103  * Requires:
104  *\li	lctx is a valid logging context.
105  */
106 
107 #endif /* DNS_LOG_H */
108