xref: /minix3/external/bsd/bind/dist/bin/named/log.c (revision 00b67f09dd46474d133c95011a48590a8e8f94c7)
1*00b67f09SDavid van Moolenbroek /*	$NetBSD: log.c,v 1.5 2014/12/10 04:37:51 christos Exp $	*/
2*00b67f09SDavid van Moolenbroek 
3*00b67f09SDavid van Moolenbroek /*
4*00b67f09SDavid van Moolenbroek  * Copyright (C) 2004-2007, 2009, 2013  Internet Systems Consortium, Inc. ("ISC")
5*00b67f09SDavid van Moolenbroek  * Copyright (C) 1999-2002  Internet Software Consortium.
6*00b67f09SDavid van Moolenbroek  *
7*00b67f09SDavid van Moolenbroek  * Permission to use, copy, modify, and/or distribute this software for any
8*00b67f09SDavid van Moolenbroek  * purpose with or without fee is hereby granted, provided that the above
9*00b67f09SDavid van Moolenbroek  * copyright notice and this permission notice appear in all copies.
10*00b67f09SDavid van Moolenbroek  *
11*00b67f09SDavid van Moolenbroek  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
12*00b67f09SDavid van Moolenbroek  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
13*00b67f09SDavid van Moolenbroek  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14*00b67f09SDavid van Moolenbroek  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15*00b67f09SDavid van Moolenbroek  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
16*00b67f09SDavid van Moolenbroek  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*00b67f09SDavid van Moolenbroek  * PERFORMANCE OF THIS SOFTWARE.
18*00b67f09SDavid van Moolenbroek  */
19*00b67f09SDavid van Moolenbroek 
20*00b67f09SDavid van Moolenbroek /* Id: log.c,v 1.49 2009/01/07 01:46:40 jinmei Exp  */
21*00b67f09SDavid van Moolenbroek 
22*00b67f09SDavid van Moolenbroek /*! \file */
23*00b67f09SDavid van Moolenbroek 
24*00b67f09SDavid van Moolenbroek #include <config.h>
25*00b67f09SDavid van Moolenbroek 
26*00b67f09SDavid van Moolenbroek #include <isc/result.h>
27*00b67f09SDavid van Moolenbroek 
28*00b67f09SDavid van Moolenbroek #include <isccfg/log.h>
29*00b67f09SDavid van Moolenbroek 
30*00b67f09SDavid van Moolenbroek #include <named/log.h>
31*00b67f09SDavid van Moolenbroek 
32*00b67f09SDavid van Moolenbroek #ifndef ISC_FACILITY
33*00b67f09SDavid van Moolenbroek #define ISC_FACILITY LOG_DAEMON
34*00b67f09SDavid van Moolenbroek #endif
35*00b67f09SDavid van Moolenbroek 
36*00b67f09SDavid van Moolenbroek /*%
37*00b67f09SDavid van Moolenbroek  * When adding a new category, be sure to add the appropriate
38*00b67f09SDavid van Moolenbroek  * \#define to <named/log.h> and to update the list in
39*00b67f09SDavid van Moolenbroek  * bin/check/check-tool.c.
40*00b67f09SDavid van Moolenbroek  */
41*00b67f09SDavid van Moolenbroek static isc_logcategory_t categories[] = {
42*00b67f09SDavid van Moolenbroek 	{ "",		 		0 },
43*00b67f09SDavid van Moolenbroek 	{ "client",	 		0 },
44*00b67f09SDavid van Moolenbroek 	{ "network",	 		0 },
45*00b67f09SDavid van Moolenbroek 	{ "update",	 		0 },
46*00b67f09SDavid van Moolenbroek 	{ "queries",	 		0 },
47*00b67f09SDavid van Moolenbroek 	{ "unmatched",	 		0 },
48*00b67f09SDavid van Moolenbroek 	{ "update-security",		0 },
49*00b67f09SDavid van Moolenbroek 	{ "query-errors",		0 },
50*00b67f09SDavid van Moolenbroek 	{ NULL, 			0 }
51*00b67f09SDavid van Moolenbroek };
52*00b67f09SDavid van Moolenbroek 
53*00b67f09SDavid van Moolenbroek /*%
54*00b67f09SDavid van Moolenbroek  * When adding a new module, be sure to add the appropriate
55*00b67f09SDavid van Moolenbroek  * \#define to <dns/log.h>.
56*00b67f09SDavid van Moolenbroek  */
57*00b67f09SDavid van Moolenbroek static isc_logmodule_t modules[] = {
58*00b67f09SDavid van Moolenbroek 	{ "main",	 		0 },
59*00b67f09SDavid van Moolenbroek 	{ "client",	 		0 },
60*00b67f09SDavid van Moolenbroek 	{ "server",		 	0 },
61*00b67f09SDavid van Moolenbroek 	{ "query",		 	0 },
62*00b67f09SDavid van Moolenbroek 	{ "interfacemgr",	 	0 },
63*00b67f09SDavid van Moolenbroek 	{ "update",	 		0 },
64*00b67f09SDavid van Moolenbroek 	{ "xfer-in",	 		0 },
65*00b67f09SDavid van Moolenbroek 	{ "xfer-out",	 		0 },
66*00b67f09SDavid van Moolenbroek 	{ "notify",	 		0 },
67*00b67f09SDavid van Moolenbroek 	{ "control",	 		0 },
68*00b67f09SDavid van Moolenbroek 	{ "lwresd",	 		0 },
69*00b67f09SDavid van Moolenbroek 	{ NULL, 			0 }
70*00b67f09SDavid van Moolenbroek };
71*00b67f09SDavid van Moolenbroek 
72*00b67f09SDavid van Moolenbroek isc_result_t
ns_log_init(isc_boolean_t safe)73*00b67f09SDavid van Moolenbroek ns_log_init(isc_boolean_t safe) {
74*00b67f09SDavid van Moolenbroek 	isc_result_t result;
75*00b67f09SDavid van Moolenbroek 	isc_logconfig_t *lcfg = NULL;
76*00b67f09SDavid van Moolenbroek 
77*00b67f09SDavid van Moolenbroek 	ns_g_categories = categories;
78*00b67f09SDavid van Moolenbroek 	ns_g_modules = modules;
79*00b67f09SDavid van Moolenbroek 
80*00b67f09SDavid van Moolenbroek 	/*
81*00b67f09SDavid van Moolenbroek 	 * Setup a logging context.
82*00b67f09SDavid van Moolenbroek 	 */
83*00b67f09SDavid van Moolenbroek 	result = isc_log_create(ns_g_mctx, &ns_g_lctx, &lcfg);
84*00b67f09SDavid van Moolenbroek 	if (result != ISC_R_SUCCESS)
85*00b67f09SDavid van Moolenbroek 		return (result);
86*00b67f09SDavid van Moolenbroek 
87*00b67f09SDavid van Moolenbroek 	/*
88*00b67f09SDavid van Moolenbroek 	 * named-checktool.c:setup_logging() needs to be kept in sync.
89*00b67f09SDavid van Moolenbroek 	 */
90*00b67f09SDavid van Moolenbroek 	isc_log_registercategories(ns_g_lctx, ns_g_categories);
91*00b67f09SDavid van Moolenbroek 	isc_log_registermodules(ns_g_lctx, ns_g_modules);
92*00b67f09SDavid van Moolenbroek 	isc_log_setcontext(ns_g_lctx);
93*00b67f09SDavid van Moolenbroek 	dns_log_init(ns_g_lctx);
94*00b67f09SDavid van Moolenbroek 	dns_log_setcontext(ns_g_lctx);
95*00b67f09SDavid van Moolenbroek 	cfg_log_init(ns_g_lctx);
96*00b67f09SDavid van Moolenbroek 
97*00b67f09SDavid van Moolenbroek 	if (safe)
98*00b67f09SDavid van Moolenbroek 		result = ns_log_setsafechannels(lcfg);
99*00b67f09SDavid van Moolenbroek 	else
100*00b67f09SDavid van Moolenbroek 		result = ns_log_setdefaultchannels(lcfg);
101*00b67f09SDavid van Moolenbroek 	if (result != ISC_R_SUCCESS)
102*00b67f09SDavid van Moolenbroek 		goto cleanup;
103*00b67f09SDavid van Moolenbroek 
104*00b67f09SDavid van Moolenbroek 	result = ns_log_setdefaultcategory(lcfg);
105*00b67f09SDavid van Moolenbroek 	if (result != ISC_R_SUCCESS)
106*00b67f09SDavid van Moolenbroek 		goto cleanup;
107*00b67f09SDavid van Moolenbroek 
108*00b67f09SDavid van Moolenbroek 	return (ISC_R_SUCCESS);
109*00b67f09SDavid van Moolenbroek 
110*00b67f09SDavid van Moolenbroek  cleanup:
111*00b67f09SDavid van Moolenbroek 	isc_log_destroy(&ns_g_lctx);
112*00b67f09SDavid van Moolenbroek 	isc_log_setcontext(NULL);
113*00b67f09SDavid van Moolenbroek 	dns_log_setcontext(NULL);
114*00b67f09SDavid van Moolenbroek 
115*00b67f09SDavid van Moolenbroek 	return (result);
116*00b67f09SDavid van Moolenbroek }
117*00b67f09SDavid van Moolenbroek 
118*00b67f09SDavid van Moolenbroek isc_result_t
ns_log_setdefaultchannels(isc_logconfig_t * lcfg)119*00b67f09SDavid van Moolenbroek ns_log_setdefaultchannels(isc_logconfig_t *lcfg) {
120*00b67f09SDavid van Moolenbroek 	isc_result_t result;
121*00b67f09SDavid van Moolenbroek 	isc_logdestination_t destination;
122*00b67f09SDavid van Moolenbroek 
123*00b67f09SDavid van Moolenbroek 	/*
124*00b67f09SDavid van Moolenbroek 	 * By default, the logging library makes "default_debug" log to
125*00b67f09SDavid van Moolenbroek 	 * stderr.  In BIND, we want to override this and log to named.run
126*00b67f09SDavid van Moolenbroek 	 * instead, unless the -g option was given.
127*00b67f09SDavid van Moolenbroek 	 */
128*00b67f09SDavid van Moolenbroek 	if (! ns_g_logstderr) {
129*00b67f09SDavid van Moolenbroek 		destination.file.stream = NULL;
130*00b67f09SDavid van Moolenbroek 		destination.file.name = "named.run";
131*00b67f09SDavid van Moolenbroek 		destination.file.versions = ISC_LOG_ROLLNEVER;
132*00b67f09SDavid van Moolenbroek 		destination.file.maximum_size = 0;
133*00b67f09SDavid van Moolenbroek 		result = isc_log_createchannel(lcfg, "default_debug",
134*00b67f09SDavid van Moolenbroek 					       ISC_LOG_TOFILE,
135*00b67f09SDavid van Moolenbroek 					       ISC_LOG_DYNAMIC,
136*00b67f09SDavid van Moolenbroek 					       &destination,
137*00b67f09SDavid van Moolenbroek 					       ISC_LOG_PRINTTIME|
138*00b67f09SDavid van Moolenbroek 					       ISC_LOG_DEBUGONLY);
139*00b67f09SDavid van Moolenbroek 		if (result != ISC_R_SUCCESS)
140*00b67f09SDavid van Moolenbroek 			goto cleanup;
141*00b67f09SDavid van Moolenbroek 	}
142*00b67f09SDavid van Moolenbroek 
143*00b67f09SDavid van Moolenbroek #if ISC_FACILITY != LOG_DAEMON
144*00b67f09SDavid van Moolenbroek 	destination.facility = ISC_FACILITY;
145*00b67f09SDavid van Moolenbroek 	result = isc_log_createchannel(lcfg, "default_syslog",
146*00b67f09SDavid van Moolenbroek 				       ISC_LOG_TOSYSLOG, ISC_LOG_INFO,
147*00b67f09SDavid van Moolenbroek 				       &destination, 0);
148*00b67f09SDavid van Moolenbroek 	if (result != ISC_R_SUCCESS)
149*00b67f09SDavid van Moolenbroek 		goto cleanup;
150*00b67f09SDavid van Moolenbroek #endif
151*00b67f09SDavid van Moolenbroek 
152*00b67f09SDavid van Moolenbroek 	/*
153*00b67f09SDavid van Moolenbroek 	 * Set the initial debug level.
154*00b67f09SDavid van Moolenbroek 	 */
155*00b67f09SDavid van Moolenbroek 	isc_log_setdebuglevel(ns_g_lctx, ns_g_debuglevel);
156*00b67f09SDavid van Moolenbroek 
157*00b67f09SDavid van Moolenbroek 	result = ISC_R_SUCCESS;
158*00b67f09SDavid van Moolenbroek 
159*00b67f09SDavid van Moolenbroek  cleanup:
160*00b67f09SDavid van Moolenbroek 	return (result);
161*00b67f09SDavid van Moolenbroek }
162*00b67f09SDavid van Moolenbroek 
163*00b67f09SDavid van Moolenbroek isc_result_t
ns_log_setsafechannels(isc_logconfig_t * lcfg)164*00b67f09SDavid van Moolenbroek ns_log_setsafechannels(isc_logconfig_t *lcfg) {
165*00b67f09SDavid van Moolenbroek 	isc_result_t result;
166*00b67f09SDavid van Moolenbroek #if ISC_FACILITY != LOG_DAEMON
167*00b67f09SDavid van Moolenbroek 	isc_logdestination_t destination;
168*00b67f09SDavid van Moolenbroek #endif
169*00b67f09SDavid van Moolenbroek 
170*00b67f09SDavid van Moolenbroek 	if (! ns_g_logstderr) {
171*00b67f09SDavid van Moolenbroek 		result = isc_log_createchannel(lcfg, "default_debug",
172*00b67f09SDavid van Moolenbroek 					       ISC_LOG_TONULL,
173*00b67f09SDavid van Moolenbroek 					       ISC_LOG_DYNAMIC,
174*00b67f09SDavid van Moolenbroek 					       NULL, 0);
175*00b67f09SDavid van Moolenbroek 		if (result != ISC_R_SUCCESS)
176*00b67f09SDavid van Moolenbroek 			goto cleanup;
177*00b67f09SDavid van Moolenbroek 
178*00b67f09SDavid van Moolenbroek 		/*
179*00b67f09SDavid van Moolenbroek 		 * Setting the debug level to zero should get the output
180*00b67f09SDavid van Moolenbroek 		 * discarded a bit faster.
181*00b67f09SDavid van Moolenbroek 		 */
182*00b67f09SDavid van Moolenbroek 		isc_log_setdebuglevel(ns_g_lctx, 0);
183*00b67f09SDavid van Moolenbroek 	} else {
184*00b67f09SDavid van Moolenbroek 		isc_log_setdebuglevel(ns_g_lctx, ns_g_debuglevel);
185*00b67f09SDavid van Moolenbroek 	}
186*00b67f09SDavid van Moolenbroek 
187*00b67f09SDavid van Moolenbroek #if ISC_FACILITY != LOG_DAEMON
188*00b67f09SDavid van Moolenbroek 	destination.facility = ISC_FACILITY;
189*00b67f09SDavid van Moolenbroek 	result = isc_log_createchannel(lcfg, "default_syslog",
190*00b67f09SDavid van Moolenbroek 				       ISC_LOG_TOSYSLOG, ISC_LOG_INFO,
191*00b67f09SDavid van Moolenbroek 				       &destination, 0);
192*00b67f09SDavid van Moolenbroek 	if (result != ISC_R_SUCCESS)
193*00b67f09SDavid van Moolenbroek 		goto cleanup;
194*00b67f09SDavid van Moolenbroek #endif
195*00b67f09SDavid van Moolenbroek 
196*00b67f09SDavid van Moolenbroek 	result = ISC_R_SUCCESS;
197*00b67f09SDavid van Moolenbroek 
198*00b67f09SDavid van Moolenbroek  cleanup:
199*00b67f09SDavid van Moolenbroek 	return (result);
200*00b67f09SDavid van Moolenbroek }
201*00b67f09SDavid van Moolenbroek 
202*00b67f09SDavid van Moolenbroek isc_result_t
ns_log_setdefaultcategory(isc_logconfig_t * lcfg)203*00b67f09SDavid van Moolenbroek ns_log_setdefaultcategory(isc_logconfig_t *lcfg) {
204*00b67f09SDavid van Moolenbroek 	isc_result_t result;
205*00b67f09SDavid van Moolenbroek 
206*00b67f09SDavid van Moolenbroek 	if (! ns_g_logstderr && ! ns_g_nosyslog) {
207*00b67f09SDavid van Moolenbroek 		result = isc_log_usechannel(lcfg, "default_syslog",
208*00b67f09SDavid van Moolenbroek 					    ISC_LOGCATEGORY_DEFAULT, NULL);
209*00b67f09SDavid van Moolenbroek 		if (result != ISC_R_SUCCESS)
210*00b67f09SDavid van Moolenbroek 			goto cleanup;
211*00b67f09SDavid van Moolenbroek 	}
212*00b67f09SDavid van Moolenbroek 
213*00b67f09SDavid van Moolenbroek 	result = isc_log_usechannel(lcfg, "default_debug",
214*00b67f09SDavid van Moolenbroek 				    ISC_LOGCATEGORY_DEFAULT, NULL);
215*00b67f09SDavid van Moolenbroek 	if (result != ISC_R_SUCCESS)
216*00b67f09SDavid van Moolenbroek 		goto cleanup;
217*00b67f09SDavid van Moolenbroek 
218*00b67f09SDavid van Moolenbroek 	result = ISC_R_SUCCESS;
219*00b67f09SDavid van Moolenbroek 
220*00b67f09SDavid van Moolenbroek  cleanup:
221*00b67f09SDavid van Moolenbroek 	return (result);
222*00b67f09SDavid van Moolenbroek }
223*00b67f09SDavid van Moolenbroek 
224*00b67f09SDavid van Moolenbroek isc_result_t
ns_log_setunmatchedcategory(isc_logconfig_t * lcfg)225*00b67f09SDavid van Moolenbroek ns_log_setunmatchedcategory(isc_logconfig_t *lcfg) {
226*00b67f09SDavid van Moolenbroek 	isc_result_t result;
227*00b67f09SDavid van Moolenbroek 
228*00b67f09SDavid van Moolenbroek 	result = isc_log_usechannel(lcfg, "null",
229*00b67f09SDavid van Moolenbroek 				    NS_LOGCATEGORY_UNMATCHED, NULL);
230*00b67f09SDavid van Moolenbroek 	return (result);
231*00b67f09SDavid van Moolenbroek }
232*00b67f09SDavid van Moolenbroek 
233*00b67f09SDavid van Moolenbroek void
ns_log_shutdown(void)234*00b67f09SDavid van Moolenbroek ns_log_shutdown(void) {
235*00b67f09SDavid van Moolenbroek 	isc_log_destroy(&ns_g_lctx);
236*00b67f09SDavid van Moolenbroek 	isc_log_setcontext(NULL);
237*00b67f09SDavid van Moolenbroek 	dns_log_setcontext(NULL);
238*00b67f09SDavid van Moolenbroek }
239