xref: /dflybsd-src/contrib/lvm2/dist/lib/log/log.c (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
1*86d7f5d3SJohn Marino /*	$NetBSD: log.c,v 1.1.1.2 2009/12/02 00:26:22 haad Exp $	*/
2*86d7f5d3SJohn Marino 
3*86d7f5d3SJohn Marino /*
4*86d7f5d3SJohn Marino  * Copyright (C) 2001-2004 Sistina Software, Inc. All rights reserved.
5*86d7f5d3SJohn Marino  * Copyright (C) 2004-2007 Red Hat, Inc. All rights reserved.
6*86d7f5d3SJohn Marino  *
7*86d7f5d3SJohn Marino  * This file is part of LVM2.
8*86d7f5d3SJohn Marino  *
9*86d7f5d3SJohn Marino  * This copyrighted material is made available to anyone wishing to use,
10*86d7f5d3SJohn Marino  * modify, copy, or redistribute it subject to the terms and conditions
11*86d7f5d3SJohn Marino  * of the GNU Lesser General Public License v.2.1.
12*86d7f5d3SJohn Marino  *
13*86d7f5d3SJohn Marino  * You should have received a copy of the GNU Lesser General Public License
14*86d7f5d3SJohn Marino  * along with this program; if not, write to the Free Software Foundation,
15*86d7f5d3SJohn Marino  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16*86d7f5d3SJohn Marino  */
17*86d7f5d3SJohn Marino 
18*86d7f5d3SJohn Marino #include "lib.h"
19*86d7f5d3SJohn Marino #include "device.h"
20*86d7f5d3SJohn Marino #include "memlock.h"
21*86d7f5d3SJohn Marino #include "lvm-string.h"
22*86d7f5d3SJohn Marino #include "lvm-file.h"
23*86d7f5d3SJohn Marino #include "defaults.h"
24*86d7f5d3SJohn Marino 
25*86d7f5d3SJohn Marino #include <stdarg.h>
26*86d7f5d3SJohn Marino #include <syslog.h>
27*86d7f5d3SJohn Marino 
28*86d7f5d3SJohn Marino static FILE *_log_file;
29*86d7f5d3SJohn Marino static struct device _log_dev;
30*86d7f5d3SJohn Marino static struct str_list _log_dev_alias;
31*86d7f5d3SJohn Marino 
32*86d7f5d3SJohn Marino static int _syslog = 0;
33*86d7f5d3SJohn Marino static int _log_to_file = 0;
34*86d7f5d3SJohn Marino static int _log_direct = 0;
35*86d7f5d3SJohn Marino static int _log_while_suspended = 0;
36*86d7f5d3SJohn Marino static int _indent = 1;
37*86d7f5d3SJohn Marino static int _log_suppress = 0;
38*86d7f5d3SJohn Marino static char _msg_prefix[30] = "  ";
39*86d7f5d3SJohn Marino static int _already_logging = 0;
40*86d7f5d3SJohn Marino 
41*86d7f5d3SJohn Marino static lvm2_log_fn_t _lvm2_log_fn = NULL;
42*86d7f5d3SJohn Marino 
43*86d7f5d3SJohn Marino static int _lvm_errno = 0;
44*86d7f5d3SJohn Marino static int _store_errmsg = 0;
45*86d7f5d3SJohn Marino static char *_lvm_errmsg = NULL;
46*86d7f5d3SJohn Marino 
init_log_fn(lvm2_log_fn_t log_fn)47*86d7f5d3SJohn Marino void init_log_fn(lvm2_log_fn_t log_fn)
48*86d7f5d3SJohn Marino {
49*86d7f5d3SJohn Marino 	if (log_fn)
50*86d7f5d3SJohn Marino 		_lvm2_log_fn = log_fn;
51*86d7f5d3SJohn Marino 	else
52*86d7f5d3SJohn Marino 		_lvm2_log_fn = NULL;
53*86d7f5d3SJohn Marino }
54*86d7f5d3SJohn Marino 
init_log_file(const char * log_file,int append)55*86d7f5d3SJohn Marino void init_log_file(const char *log_file, int append)
56*86d7f5d3SJohn Marino {
57*86d7f5d3SJohn Marino 	const char *open_mode = append ? "a" : "w";
58*86d7f5d3SJohn Marino 
59*86d7f5d3SJohn Marino 	if (!(_log_file = fopen(log_file, open_mode))) {
60*86d7f5d3SJohn Marino 		log_sys_error("fopen", log_file);
61*86d7f5d3SJohn Marino 		return;
62*86d7f5d3SJohn Marino 	}
63*86d7f5d3SJohn Marino 
64*86d7f5d3SJohn Marino 	_log_to_file = 1;
65*86d7f5d3SJohn Marino }
66*86d7f5d3SJohn Marino 
init_log_direct(const char * log_file,int append)67*86d7f5d3SJohn Marino void init_log_direct(const char *log_file, int append)
68*86d7f5d3SJohn Marino {
69*86d7f5d3SJohn Marino 	int open_flags = append ? 0 : O_TRUNC;
70*86d7f5d3SJohn Marino 
71*86d7f5d3SJohn Marino 	dev_create_file(log_file, &_log_dev, &_log_dev_alias, 1);
72*86d7f5d3SJohn Marino 	if (!dev_open_flags(&_log_dev, O_RDWR | O_CREAT | open_flags, 1, 0))
73*86d7f5d3SJohn Marino 		return;
74*86d7f5d3SJohn Marino 
75*86d7f5d3SJohn Marino 	_log_direct = 1;
76*86d7f5d3SJohn Marino }
77*86d7f5d3SJohn Marino 
init_log_while_suspended(int log_while_suspended)78*86d7f5d3SJohn Marino void init_log_while_suspended(int log_while_suspended)
79*86d7f5d3SJohn Marino {
80*86d7f5d3SJohn Marino 	_log_while_suspended = log_while_suspended;
81*86d7f5d3SJohn Marino }
82*86d7f5d3SJohn Marino 
init_syslog(int facility)83*86d7f5d3SJohn Marino void init_syslog(int facility)
84*86d7f5d3SJohn Marino {
85*86d7f5d3SJohn Marino 	openlog("lvm", LOG_PID, facility);
86*86d7f5d3SJohn Marino 	_syslog = 1;
87*86d7f5d3SJohn Marino }
88*86d7f5d3SJohn Marino 
log_suppress(int suppress)89*86d7f5d3SJohn Marino int log_suppress(int suppress)
90*86d7f5d3SJohn Marino {
91*86d7f5d3SJohn Marino 	int old_suppress = _log_suppress;
92*86d7f5d3SJohn Marino 
93*86d7f5d3SJohn Marino 	_log_suppress = suppress;
94*86d7f5d3SJohn Marino 
95*86d7f5d3SJohn Marino 	return old_suppress;
96*86d7f5d3SJohn Marino }
97*86d7f5d3SJohn Marino 
release_log_memory(void)98*86d7f5d3SJohn Marino void release_log_memory(void)
99*86d7f5d3SJohn Marino {
100*86d7f5d3SJohn Marino 	if (!_log_direct)
101*86d7f5d3SJohn Marino 		return;
102*86d7f5d3SJohn Marino 
103*86d7f5d3SJohn Marino 	dm_free((char *) _log_dev_alias.str);
104*86d7f5d3SJohn Marino 	_log_dev_alias.str = "activate_log file";
105*86d7f5d3SJohn Marino }
106*86d7f5d3SJohn Marino 
fin_log(void)107*86d7f5d3SJohn Marino void fin_log(void)
108*86d7f5d3SJohn Marino {
109*86d7f5d3SJohn Marino 	if (_log_direct) {
110*86d7f5d3SJohn Marino 		dev_close(&_log_dev);
111*86d7f5d3SJohn Marino 		_log_direct = 0;
112*86d7f5d3SJohn Marino 	}
113*86d7f5d3SJohn Marino 
114*86d7f5d3SJohn Marino 	if (_log_to_file) {
115*86d7f5d3SJohn Marino 		if (dm_fclose(_log_file)) {
116*86d7f5d3SJohn Marino 			if (errno)
117*86d7f5d3SJohn Marino 			      fprintf(stderr, "failed to write log file: %s\n",
118*86d7f5d3SJohn Marino 				      strerror(errno));
119*86d7f5d3SJohn Marino 			else
120*86d7f5d3SJohn Marino 			      fprintf(stderr, "failed to write log file\n");
121*86d7f5d3SJohn Marino 
122*86d7f5d3SJohn Marino 		}
123*86d7f5d3SJohn Marino 		_log_to_file = 0;
124*86d7f5d3SJohn Marino 	}
125*86d7f5d3SJohn Marino }
126*86d7f5d3SJohn Marino 
fin_syslog()127*86d7f5d3SJohn Marino void fin_syslog()
128*86d7f5d3SJohn Marino {
129*86d7f5d3SJohn Marino 	if (_syslog)
130*86d7f5d3SJohn Marino 		closelog();
131*86d7f5d3SJohn Marino 	_syslog = 0;
132*86d7f5d3SJohn Marino }
133*86d7f5d3SJohn Marino 
init_msg_prefix(const char * prefix)134*86d7f5d3SJohn Marino void init_msg_prefix(const char *prefix)
135*86d7f5d3SJohn Marino {
136*86d7f5d3SJohn Marino 	strncpy(_msg_prefix, prefix, sizeof(_msg_prefix));
137*86d7f5d3SJohn Marino 	_msg_prefix[sizeof(_msg_prefix) - 1] = '\0';
138*86d7f5d3SJohn Marino }
139*86d7f5d3SJohn Marino 
init_indent(int indent)140*86d7f5d3SJohn Marino void init_indent(int indent)
141*86d7f5d3SJohn Marino {
142*86d7f5d3SJohn Marino 	_indent = indent;
143*86d7f5d3SJohn Marino }
144*86d7f5d3SJohn Marino 
reset_lvm_errno(int store_errmsg)145*86d7f5d3SJohn Marino void reset_lvm_errno(int store_errmsg)
146*86d7f5d3SJohn Marino {
147*86d7f5d3SJohn Marino 	_lvm_errno = 0;
148*86d7f5d3SJohn Marino 
149*86d7f5d3SJohn Marino 	if (_lvm_errmsg) {
150*86d7f5d3SJohn Marino 		dm_free(_lvm_errmsg);
151*86d7f5d3SJohn Marino 		_lvm_errmsg = NULL;
152*86d7f5d3SJohn Marino 	}
153*86d7f5d3SJohn Marino 
154*86d7f5d3SJohn Marino 	_store_errmsg = store_errmsg;
155*86d7f5d3SJohn Marino }
156*86d7f5d3SJohn Marino 
stored_errno(void)157*86d7f5d3SJohn Marino int stored_errno(void)
158*86d7f5d3SJohn Marino {
159*86d7f5d3SJohn Marino 	return _lvm_errno;
160*86d7f5d3SJohn Marino }
161*86d7f5d3SJohn Marino 
stored_errmsg(void)162*86d7f5d3SJohn Marino const char *stored_errmsg(void)
163*86d7f5d3SJohn Marino {
164*86d7f5d3SJohn Marino 	return _lvm_errmsg ? : "";
165*86d7f5d3SJohn Marino }
166*86d7f5d3SJohn Marino 
print_log(int level,const char * file,int line,int dm_errno,const char * format,...)167*86d7f5d3SJohn Marino void print_log(int level, const char *file, int line, int dm_errno,
168*86d7f5d3SJohn Marino 	       const char *format, ...)
169*86d7f5d3SJohn Marino {
170*86d7f5d3SJohn Marino 	va_list ap;
171*86d7f5d3SJohn Marino 	char buf[1024], buf2[4096], locn[4096];
172*86d7f5d3SJohn Marino 	int bufused, n;
173*86d7f5d3SJohn Marino 	const char *message;
174*86d7f5d3SJohn Marino 	const char *trformat;		/* Translated format string */
175*86d7f5d3SJohn Marino 	char *newbuf;
176*86d7f5d3SJohn Marino 	int use_stderr = level & _LOG_STDERR;
177*86d7f5d3SJohn Marino 
178*86d7f5d3SJohn Marino 	level &= ~_LOG_STDERR;
179*86d7f5d3SJohn Marino 
180*86d7f5d3SJohn Marino 	if (_log_suppress == 2)
181*86d7f5d3SJohn Marino 		return;
182*86d7f5d3SJohn Marino 
183*86d7f5d3SJohn Marino 	if (level <= _LOG_ERR)
184*86d7f5d3SJohn Marino 		init_error_message_produced(1);
185*86d7f5d3SJohn Marino 
186*86d7f5d3SJohn Marino 	trformat = _(format);
187*86d7f5d3SJohn Marino 
188*86d7f5d3SJohn Marino 	if (dm_errno && !_lvm_errno)
189*86d7f5d3SJohn Marino 		_lvm_errno = dm_errno;
190*86d7f5d3SJohn Marino 
191*86d7f5d3SJohn Marino 	if (_lvm2_log_fn || (_store_errmsg && (level <= _LOG_ERR))) {
192*86d7f5d3SJohn Marino 		va_start(ap, format);
193*86d7f5d3SJohn Marino 		n = vsnprintf(buf2, sizeof(buf2) - 1, trformat, ap);
194*86d7f5d3SJohn Marino 		va_end(ap);
195*86d7f5d3SJohn Marino 
196*86d7f5d3SJohn Marino 		if (n < 0) {
197*86d7f5d3SJohn Marino 			fprintf(stderr, _("vsnprintf failed: skipping external "
198*86d7f5d3SJohn Marino 					"logging function"));
199*86d7f5d3SJohn Marino 			goto log_it;
200*86d7f5d3SJohn Marino 		}
201*86d7f5d3SJohn Marino 
202*86d7f5d3SJohn Marino 		buf2[sizeof(buf2) - 1] = '\0';
203*86d7f5d3SJohn Marino 		message = &buf2[0];
204*86d7f5d3SJohn Marino 	}
205*86d7f5d3SJohn Marino 
206*86d7f5d3SJohn Marino 	if (_store_errmsg && (level <= _LOG_ERR)) {
207*86d7f5d3SJohn Marino 		if (!_lvm_errmsg)
208*86d7f5d3SJohn Marino 			_lvm_errmsg = dm_strdup(message);
209*86d7f5d3SJohn Marino 		else if ((newbuf = dm_realloc(_lvm_errmsg,
210*86d7f5d3SJohn Marino  					      strlen(_lvm_errmsg) +
211*86d7f5d3SJohn Marino 					      strlen(message) + 2))) {
212*86d7f5d3SJohn Marino 			_lvm_errmsg = strcat(newbuf, "\n");
213*86d7f5d3SJohn Marino 			_lvm_errmsg = strcat(newbuf, message);
214*86d7f5d3SJohn Marino 		}
215*86d7f5d3SJohn Marino 	}
216*86d7f5d3SJohn Marino 
217*86d7f5d3SJohn Marino 	if (_lvm2_log_fn) {
218*86d7f5d3SJohn Marino 		_lvm2_log_fn(level, file, line, 0, message);
219*86d7f5d3SJohn Marino 
220*86d7f5d3SJohn Marino 		return;
221*86d7f5d3SJohn Marino 	}
222*86d7f5d3SJohn Marino 
223*86d7f5d3SJohn Marino       log_it:
224*86d7f5d3SJohn Marino 	if (!_log_suppress) {
225*86d7f5d3SJohn Marino 		if (verbose_level() > _LOG_DEBUG)
226*86d7f5d3SJohn Marino 			dm_snprintf(locn, sizeof(locn), "#%s:%d ",
227*86d7f5d3SJohn Marino 				     file, line);
228*86d7f5d3SJohn Marino 		else
229*86d7f5d3SJohn Marino 			locn[0] = '\0';
230*86d7f5d3SJohn Marino 
231*86d7f5d3SJohn Marino 		va_start(ap, format);
232*86d7f5d3SJohn Marino 		switch (level) {
233*86d7f5d3SJohn Marino 		case _LOG_DEBUG:
234*86d7f5d3SJohn Marino 			if (!strcmp("<backtrace>", format) &&
235*86d7f5d3SJohn Marino 			    verbose_level() <= _LOG_DEBUG)
236*86d7f5d3SJohn Marino 				break;
237*86d7f5d3SJohn Marino 			if (verbose_level() >= _LOG_DEBUG) {
238*86d7f5d3SJohn Marino 				fprintf(stderr, "%s%s%s", locn, log_command_name(),
239*86d7f5d3SJohn Marino 					_msg_prefix);
240*86d7f5d3SJohn Marino 				if (_indent)
241*86d7f5d3SJohn Marino 					fprintf(stderr, "      ");
242*86d7f5d3SJohn Marino 				vfprintf(stderr, trformat, ap);
243*86d7f5d3SJohn Marino 				fputc('\n', stderr);
244*86d7f5d3SJohn Marino 			}
245*86d7f5d3SJohn Marino 			break;
246*86d7f5d3SJohn Marino 
247*86d7f5d3SJohn Marino 		case _LOG_INFO:
248*86d7f5d3SJohn Marino 			if (verbose_level() >= _LOG_INFO) {
249*86d7f5d3SJohn Marino 				fprintf(stderr, "%s%s%s", locn, log_command_name(),
250*86d7f5d3SJohn Marino 					_msg_prefix);
251*86d7f5d3SJohn Marino 				if (_indent)
252*86d7f5d3SJohn Marino 					fprintf(stderr, "    ");
253*86d7f5d3SJohn Marino 				vfprintf(stderr, trformat, ap);
254*86d7f5d3SJohn Marino 				fputc('\n', stderr);
255*86d7f5d3SJohn Marino 			}
256*86d7f5d3SJohn Marino 			break;
257*86d7f5d3SJohn Marino 		case _LOG_NOTICE:
258*86d7f5d3SJohn Marino 			if (verbose_level() >= _LOG_NOTICE) {
259*86d7f5d3SJohn Marino 				fprintf(stderr, "%s%s%s", locn, log_command_name(),
260*86d7f5d3SJohn Marino 					_msg_prefix);
261*86d7f5d3SJohn Marino 				if (_indent)
262*86d7f5d3SJohn Marino 					fprintf(stderr, "  ");
263*86d7f5d3SJohn Marino 				vfprintf(stderr, trformat, ap);
264*86d7f5d3SJohn Marino 				fputc('\n', stderr);
265*86d7f5d3SJohn Marino 			}
266*86d7f5d3SJohn Marino 			break;
267*86d7f5d3SJohn Marino 		case _LOG_WARN:
268*86d7f5d3SJohn Marino 			if (verbose_level() >= _LOG_WARN) {
269*86d7f5d3SJohn Marino 				fprintf(use_stderr ? stderr : stdout, "%s%s",
270*86d7f5d3SJohn Marino 					log_command_name(), _msg_prefix);
271*86d7f5d3SJohn Marino 				vfprintf(use_stderr ? stderr : stdout, trformat, ap);
272*86d7f5d3SJohn Marino 				fputc('\n', use_stderr ? stderr : stdout);
273*86d7f5d3SJohn Marino 			}
274*86d7f5d3SJohn Marino 			break;
275*86d7f5d3SJohn Marino 		case _LOG_ERR:
276*86d7f5d3SJohn Marino 			if (verbose_level() >= _LOG_ERR) {
277*86d7f5d3SJohn Marino 				fprintf(stderr, "%s%s%s", locn, log_command_name(),
278*86d7f5d3SJohn Marino 					_msg_prefix);
279*86d7f5d3SJohn Marino 				vfprintf(stderr, trformat, ap);
280*86d7f5d3SJohn Marino 				fputc('\n', stderr);
281*86d7f5d3SJohn Marino 			}
282*86d7f5d3SJohn Marino 			break;
283*86d7f5d3SJohn Marino 		case _LOG_FATAL:
284*86d7f5d3SJohn Marino 		default:
285*86d7f5d3SJohn Marino 			if (verbose_level() >= _LOG_FATAL) {
286*86d7f5d3SJohn Marino 				fprintf(stderr, "%s%s%s", locn, log_command_name(),
287*86d7f5d3SJohn Marino 					_msg_prefix);
288*86d7f5d3SJohn Marino 				vfprintf(stderr, trformat, ap);
289*86d7f5d3SJohn Marino 				fputc('\n', stderr);
290*86d7f5d3SJohn Marino 			}
291*86d7f5d3SJohn Marino 			break;
292*86d7f5d3SJohn Marino 		}
293*86d7f5d3SJohn Marino 		va_end(ap);
294*86d7f5d3SJohn Marino 	}
295*86d7f5d3SJohn Marino 
296*86d7f5d3SJohn Marino 	if (level > debug_level())
297*86d7f5d3SJohn Marino 		return;
298*86d7f5d3SJohn Marino 
299*86d7f5d3SJohn Marino 	if (_log_to_file && (_log_while_suspended || !memlock())) {
300*86d7f5d3SJohn Marino 		fprintf(_log_file, "%s:%d %s%s", file, line, log_command_name(),
301*86d7f5d3SJohn Marino 			_msg_prefix);
302*86d7f5d3SJohn Marino 
303*86d7f5d3SJohn Marino 		va_start(ap, format);
304*86d7f5d3SJohn Marino 		vfprintf(_log_file, trformat, ap);
305*86d7f5d3SJohn Marino 		va_end(ap);
306*86d7f5d3SJohn Marino 
307*86d7f5d3SJohn Marino 		fprintf(_log_file, "\n");
308*86d7f5d3SJohn Marino 		fflush(_log_file);
309*86d7f5d3SJohn Marino 	}
310*86d7f5d3SJohn Marino 
311*86d7f5d3SJohn Marino 	if (_syslog && (_log_while_suspended || !memlock())) {
312*86d7f5d3SJohn Marino 		va_start(ap, format);
313*86d7f5d3SJohn Marino 		vsyslog(level, trformat, ap);
314*86d7f5d3SJohn Marino 		va_end(ap);
315*86d7f5d3SJohn Marino 	}
316*86d7f5d3SJohn Marino 
317*86d7f5d3SJohn Marino 	/* FIXME This code is unfinished - pre-extend & condense. */
318*86d7f5d3SJohn Marino 	if (!_already_logging && _log_direct && memlock()) {
319*86d7f5d3SJohn Marino 		_already_logging = 1;
320*86d7f5d3SJohn Marino 		memset(&buf, ' ', sizeof(buf));
321*86d7f5d3SJohn Marino 		bufused = 0;
322*86d7f5d3SJohn Marino 		if ((n = dm_snprintf(buf, sizeof(buf) - bufused - 1,
323*86d7f5d3SJohn Marino 				      "%s:%d %s%s", file, line, log_command_name(),
324*86d7f5d3SJohn Marino 				      _msg_prefix)) == -1)
325*86d7f5d3SJohn Marino 			goto done;
326*86d7f5d3SJohn Marino 
327*86d7f5d3SJohn Marino 		bufused += n;
328*86d7f5d3SJohn Marino 
329*86d7f5d3SJohn Marino 		va_start(ap, format);
330*86d7f5d3SJohn Marino 		n = vsnprintf(buf + bufused - 1, sizeof(buf) - bufused - 1,
331*86d7f5d3SJohn Marino 			      trformat, ap);
332*86d7f5d3SJohn Marino 		va_end(ap);
333*86d7f5d3SJohn Marino 		bufused += n;
334*86d7f5d3SJohn Marino 
335*86d7f5d3SJohn Marino 	      done:
336*86d7f5d3SJohn Marino 		buf[bufused - 1] = '\n';
337*86d7f5d3SJohn Marino 		buf[bufused] = '\n';
338*86d7f5d3SJohn Marino 		buf[sizeof(buf) - 1] = '\n';
339*86d7f5d3SJohn Marino 		/* FIXME real size bufused */
340*86d7f5d3SJohn Marino 		dev_append(&_log_dev, sizeof(buf), buf);
341*86d7f5d3SJohn Marino 		_already_logging = 0;
342*86d7f5d3SJohn Marino 	}
343*86d7f5d3SJohn Marino }
344