1/*
2 * Copyright (C) 2004, 2005, 2007, 2009  Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2002  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.27 2009/01/07 23:47:46 tbox Exp $ */
19
20#ifndef NAMED_LOG_H
21#define NAMED_LOG_H 1
22
23/*! \file */
24
25#include <isc/log.h>
26#include <isc/types.h>
27
28#include <dns/log.h>
29
30#include <named/globals.h>	/* Required for ns_g_(categories|modules). */
31
32/* Unused slot 0. */
33#define NS_LOGCATEGORY_CLIENT		(&ns_g_categories[1])
34#define NS_LOGCATEGORY_NETWORK		(&ns_g_categories[2])
35#define NS_LOGCATEGORY_UPDATE		(&ns_g_categories[3])
36#define NS_LOGCATEGORY_QUERIES		(&ns_g_categories[4])
37#define NS_LOGCATEGORY_UNMATCHED	(&ns_g_categories[5])
38#define NS_LOGCATEGORY_UPDATE_SECURITY	(&ns_g_categories[6])
39#define NS_LOGCATEGORY_QUERY_EERRORS	(&ns_g_categories[7])
40
41/*
42 * Backwards compatibility.
43 */
44#define NS_LOGCATEGORY_GENERAL		ISC_LOGCATEGORY_GENERAL
45
46#define NS_LOGMODULE_MAIN		(&ns_g_modules[0])
47#define NS_LOGMODULE_CLIENT		(&ns_g_modules[1])
48#define NS_LOGMODULE_SERVER		(&ns_g_modules[2])
49#define NS_LOGMODULE_QUERY		(&ns_g_modules[3])
50#define NS_LOGMODULE_INTERFACEMGR	(&ns_g_modules[4])
51#define NS_LOGMODULE_UPDATE		(&ns_g_modules[5])
52#define NS_LOGMODULE_XFER_IN		(&ns_g_modules[6])
53#define NS_LOGMODULE_XFER_OUT		(&ns_g_modules[7])
54#define NS_LOGMODULE_NOTIFY		(&ns_g_modules[8])
55#define NS_LOGMODULE_CONTROL		(&ns_g_modules[9])
56#define NS_LOGMODULE_LWRESD		(&ns_g_modules[10])
57
58isc_result_t
59ns_log_init(isc_boolean_t safe);
60/*%
61 * Initialize the logging system and set up an initial default
62 * logging default configuration that will be used until the
63 * config file has been read.
64 *
65 * If 'safe' is true, use a default configuration that refrains
66 * from opening files.  This is to avoid creating log files
67 * as root.
68 */
69
70isc_result_t
71ns_log_setdefaultchannels(isc_logconfig_t *lcfg);
72/*%
73 * Set up logging channels according to the named defaults, which
74 * may differ from the logging library defaults.  Currently,
75 * this just means setting up default_debug.
76 */
77
78isc_result_t
79ns_log_setsafechannels(isc_logconfig_t *lcfg);
80/*%
81 * Like ns_log_setdefaultchannels(), but omits any logging to files.
82 */
83
84isc_result_t
85ns_log_setdefaultcategory(isc_logconfig_t *lcfg);
86/*%
87 * Set up "category default" to go to the right places.
88 */
89
90isc_result_t
91ns_log_setunmatchedcategory(isc_logconfig_t *lcfg);
92/*%
93 * Set up "category unmatched" to go to the right places.
94 */
95
96void
97ns_log_shutdown(void);
98
99#endif /* NAMED_LOG_H */
100