contrib/bind9/lib/dns/include/dns/log.h

   1 /*
   2  * Copyright (C) 2004-2007, 2009, 2011-2015  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 /*! \file dns/log.h
  19  * \author  Principal Authors: DCL */
  20
  21 #ifndef DNS_LOG_H
  22 #define DNS_LOG_H 1
  23
  24 #include <isc/lang.h>
  25 #include <isc/log.h>
  26
  27 LIBDNS_EXTERNAL_DATA extern isc_log_t *dns_lctx;
  28 LIBDNS_EXTERNAL_DATA extern isc_logcategory_t dns_categories[];
  29 LIBDNS_EXTERNAL_DATA extern isc_logmodule_t dns_modules[];
  30
  31 #define DNS_LOGCATEGORY_NOTIFY          (&dns_categories[0])
  32 #define DNS_LOGCATEGORY_DATABASE        (&dns_categories[1])
  33 #define DNS_LOGCATEGORY_SECURITY        (&dns_categories[2])
  34 /* DNS_LOGCATEGORY_CONFIG superseded by CFG_LOGCATEGORY_CONFIG */
  35 #define DNS_LOGCATEGORY_DNSSEC          (&dns_categories[4])
  36 #define DNS_LOGCATEGORY_RESOLVER        (&dns_categories[5])
  37 #define DNS_LOGCATEGORY_XFER_IN         (&dns_categories[6])
  38 #define DNS_LOGCATEGORY_XFER_OUT        (&dns_categories[7])
  39 #define DNS_LOGCATEGORY_DISPATCH        (&dns_categories[8])
  40 #define DNS_LOGCATEGORY_LAME_SERVERS    (&dns_categories[9])
  41 #define DNS_LOGCATEGORY_DELEGATION_ONLY (&dns_categories[10])
  42 #define DNS_LOGCATEGORY_EDNS_DISABLED   (&dns_categories[11])
  43 #define DNS_LOGCATEGORY_RPZ             (&dns_categories[12])
  44 #define DNS_LOGCATEGORY_RRL             (&dns_categories[13])
  45 #define DNS_LOGCATEGORY_CNAME           (&dns_categories[14])
  46 #define DNS_LOGCATEGORY_SPILL           (&dns_categories[15])
  47
  48 /* Backwards compatibility. */
  49 #define DNS_LOGCATEGORY_GENERAL         ISC_LOGCATEGORY_GENERAL
  50
  51 #define DNS_LOGMODULE_DB                (&dns_modules[0])
  52 #define DNS_LOGMODULE_RBTDB             (&dns_modules[1])
  53 #define DNS_LOGMODULE_RBTDB64           (&dns_modules[2])
  54 #define DNS_LOGMODULE_RBT               (&dns_modules[3])
  55 #define DNS_LOGMODULE_RDATA             (&dns_modules[4])
  56 #define DNS_LOGMODULE_MASTER            (&dns_modules[5])
  57 #define DNS_LOGMODULE_MESSAGE           (&dns_modules[6])
  58 #define DNS_LOGMODULE_CACHE             (&dns_modules[7])
  59 #define DNS_LOGMODULE_CONFIG            (&dns_modules[8])
  60 #define DNS_LOGMODULE_RESOLVER          (&dns_modules[9])
  61 #define DNS_LOGMODULE_ZONE              (&dns_modules[10])
  62 #define DNS_LOGMODULE_JOURNAL           (&dns_modules[11])
  63 #define DNS_LOGMODULE_ADB               (&dns_modules[12])
  64 #define DNS_LOGMODULE_XFER_IN           (&dns_modules[13])
  65 #define DNS_LOGMODULE_XFER_OUT          (&dns_modules[14])
  66 #define DNS_LOGMODULE_ACL               (&dns_modules[15])
  67 #define DNS_LOGMODULE_VALIDATOR         (&dns_modules[16])
  68 #define DNS_LOGMODULE_DISPATCH          (&dns_modules[17])
  69 #define DNS_LOGMODULE_REQUEST           (&dns_modules[18])
  70 #define DNS_LOGMODULE_MASTERDUMP        (&dns_modules[19])
  71 #define DNS_LOGMODULE_TSIG              (&dns_modules[20])
  72 #define DNS_LOGMODULE_TKEY              (&dns_modules[21])
  73 #define DNS_LOGMODULE_SDB               (&dns_modules[22])
  74 #define DNS_LOGMODULE_DIFF              (&dns_modules[23])
  75 #define DNS_LOGMODULE_HINTS             (&dns_modules[24])
  76 #define DNS_LOGMODULE_ACACHE            (&dns_modules[25])
  77 #define DNS_LOGMODULE_DLZ               (&dns_modules[26])
  78 #define DNS_LOGMODULE_DNSSEC            (&dns_modules[27])
  79 #define DNS_LOGMODULE_CRYPTO            (&dns_modules[28])
  80
  81 ISC_LANG_BEGINDECLS
  82
  83 void
  84 dns_log_init(isc_log_t *lctx);
  85 /*%
  86  * Make the libdns categories and modules available for use with the
  87  * ISC logging library.
  88  *
  89  * Requires:
  90  *\li   lctx is a valid logging context.
  91  *
  92  *\li   dns_log_init() is called only once.
  93  *
  94  * Ensures:
  95  * \li  The categories and modules defined above are available for
  96  *      use by isc_log_usechannnel() and isc_log_write().
  97  */
  98
  99 void
 100 dns_log_setcontext(isc_log_t *lctx);
 101 /*%
 102  * Make the libdns library use the provided context for logging internal
 103  * messages.
 104  *
 105  * Requires:
 106  *\li   lctx is a valid logging context.
 107  */
 108
 109 ISC_LANG_ENDDECLS
 110
 111 #endif /* DNS_LOG_H */