subr_log.c revision 1.9 
1/*	$OpenBSD: subr_log.c,v 1.9 2003/06/02 23:28:06 millert Exp $	*/
2/*	$NetBSD: subr_log.c,v 1.11 1996/03/30 22:24:44 christos Exp $	*/
3
4/*
5 * Copyright (c) 1982, 1986, 1993
6 *	The Regents of the University of California.  All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the University nor the names of its contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 *	@(#)subr_log.c	8.1 (Berkeley) 6/10/93
33 */
34
35/*
36 * Error log buffer for kernel printf's.
37 */
38
39#include <sys/param.h>
40#include <sys/systm.h>
41#include <sys/proc.h>
42#include <sys/vnode.h>
43#include <sys/ioctl.h>
44#include <sys/msgbuf.h>
45#include <sys/file.h>
46#include <sys/signalvar.h>
47#include <sys/syslog.h>
48#include <sys/conf.h>
49
50#define LOG_RDPRI	(PZERO + 1)
51
52#define LOG_ASYNC	0x04
53#define LOG_RDWAIT	0x08
54
55struct logsoftc {
56	int	sc_state;		/* see above for possibilities */
57	struct	selinfo sc_selp;	/* process waiting on select call */
58	int	sc_pgid;		/* process/group for async I/O */
59	uid_t	sc_siguid;		/* uid for process that set sc_pgid */
60	uid_t	sc_sigeuid;		/* euid for process that set sc_pgid */
61} logsoftc;
62
63int	log_open;			/* also used in log() */
64int	msgbufmapped;			/* is the message buffer mapped */
65int	msgbufenabled;			/* is logging to the buffer enabled */
66struct	msgbuf *msgbufp;		/* the mapped buffer, itself. */
67
68void filt_logrdetach(struct knote *kn);
69int filt_logread(struct knote *kn, long hint);
70
71struct filterops logread_filtops =
72	{ 1, NULL, filt_logrdetach, filt_logread};
73
74void
75initmsgbuf(buf, bufsize)
76	caddr_t buf;
77	size_t bufsize;
78{
79	register struct msgbuf *mbp;
80	long new_bufs;
81
82	/* Sanity-check the given size. */
83	if (bufsize < sizeof(struct msgbuf))
84		return;
85
86	mbp = msgbufp = (struct msgbuf *)buf;
87
88	new_bufs = bufsize - offsetof(struct msgbuf, msg_bufc);
89	if ((mbp->msg_magic != MSG_MAGIC) || (mbp->msg_bufs != new_bufs) ||
90	    (mbp->msg_bufr < 0) || (mbp->msg_bufr >= mbp->msg_bufs) ||
91	    (mbp->msg_bufx < 0) || (mbp->msg_bufx >= mbp->msg_bufs)) {
92		/*
93		 * If the buffer magic number is wrong, has changed
94		 * size (which shouldn't happen often), or is
95		 * internally inconsistent, initialize it.
96		 */
97
98		bzero(buf, bufsize);
99		mbp->msg_magic = MSG_MAGIC;
100		mbp->msg_bufs = new_bufs;
101	}
102
103	/* mark it as ready for use. */
104	msgbufmapped = msgbufenabled = 1;
105}
106
107/*ARGSUSED*/
108int
109logopen(dev, flags, mode, p)
110	dev_t dev;
111	int flags, mode;
112	struct proc *p;
113{
114	if (log_open)
115		return (EBUSY);
116	log_open = 1;
117	return (0);
118}
119
120/*ARGSUSED*/
121int
122logclose(dev, flag, mode, p)
123	dev_t dev;
124	int flag, mode;
125	struct proc *p;
126{
127
128	log_open = 0;
129	logsoftc.sc_state = 0;
130	return (0);
131}
132
133/*ARGSUSED*/
134int
135logread(dev, uio, flag)
136	dev_t dev;
137	struct uio *uio;
138	int flag;
139{
140	register struct msgbuf *mbp = msgbufp;
141	register long l;
142	register int s;
143	int error = 0;
144
145	s = splhigh();
146	while (mbp->msg_bufr == mbp->msg_bufx) {
147		if (flag & IO_NDELAY) {
148			splx(s);
149			return (EWOULDBLOCK);
150		}
151		logsoftc.sc_state |= LOG_RDWAIT;
152		error = tsleep((caddr_t)mbp, LOG_RDPRI | PCATCH,
153			       "klog", 0);
154		if (error) {
155			splx(s);
156			return (error);
157		}
158	}
159	splx(s);
160	logsoftc.sc_state &= ~LOG_RDWAIT;
161
162	while (uio->uio_resid > 0) {
163		l = mbp->msg_bufx - mbp->msg_bufr;
164		if (l < 0)
165			l = mbp->msg_bufs - mbp->msg_bufr;
166		l = min(l, uio->uio_resid);
167		if (l == 0)
168			break;
169		error = uiomove((caddr_t)&mbp->msg_bufc[mbp->msg_bufr],
170			(int)l, uio);
171		if (error)
172			break;
173		mbp->msg_bufr += l;
174		if (mbp->msg_bufr < 0 || mbp->msg_bufr >= mbp->msg_bufs)
175			mbp->msg_bufr = 0;
176	}
177	return (error);
178}
179
180/*ARGSUSED*/
181int
182logselect(dev, rw, p)
183	dev_t dev;
184	int rw;
185	struct proc *p;
186{
187	int s = splhigh();
188
189	switch (rw) {
190
191	case FREAD:
192		if (msgbufp->msg_bufr != msgbufp->msg_bufx) {
193			splx(s);
194			return (1);
195		}
196		selrecord(p, &logsoftc.sc_selp);
197		break;
198	}
199	splx(s);
200	return (0);
201}
202
203int
204logkqfilter(dev_t dev, struct knote *kn)
205{
206	struct klist *klist;
207	int s;
208
209	switch (kn->kn_filter) {
210	case EVFILT_READ:
211		klist = &logsoftc.sc_selp.si_note;
212		kn->kn_fop = &logread_filtops;
213		break;
214	default:
215		return (1);
216	}
217
218	kn->kn_hook = (void *)msgbufp;
219
220	s = splhigh();
221	SLIST_INSERT_HEAD(klist, kn, kn_selnext);
222	splx(s);
223
224	return (0);
225}
226
227void
228filt_logrdetach(struct knote *kn)
229{
230	int s = splhigh();
231
232	SLIST_REMOVE(&logsoftc.sc_selp.si_note, kn, knote, kn_selnext);
233	splx(s);
234}
235
236int
237filt_logread(struct knote *kn, long hint)
238{
239	struct  msgbuf *p = (struct  msgbuf *)kn->kn_hook;
240
241	kn->kn_data = (int)(p->msg_bufx - p->msg_bufr);
242
243	return (p->msg_bufx != p->msg_bufr);
244}
245
246void
247logwakeup()
248{
249	if (!log_open)
250		return;
251	selwakeup(&logsoftc.sc_selp);
252	if (logsoftc.sc_state & LOG_ASYNC)
253		csignal(logsoftc.sc_pgid, SIGIO,
254		    logsoftc.sc_siguid, logsoftc.sc_sigeuid);
255	if (logsoftc.sc_state & LOG_RDWAIT) {
256		wakeup((caddr_t)msgbufp);
257		logsoftc.sc_state &= ~LOG_RDWAIT;
258	}
259	KNOTE(&logsoftc.sc_selp.si_note, 0);
260}
261
262/*ARGSUSED*/
263int
264logioctl(dev, com, data, flag, p)
265	dev_t dev;
266	u_long com;
267	caddr_t data;
268	int flag;
269	struct proc *p;
270{
271	long l;
272	int s;
273
274	switch (com) {
275
276	/* return number of characters immediately available */
277	case FIONREAD:
278		s = splhigh();
279		l = msgbufp->msg_bufx - msgbufp->msg_bufr;
280		splx(s);
281		if (l < 0)
282			l += msgbufp->msg_bufs;
283		*(int *)data = l;
284		break;
285
286	case FIONBIO:
287		break;
288
289	case FIOASYNC:
290		if (*(int *)data)
291			logsoftc.sc_state |= LOG_ASYNC;
292		else
293			logsoftc.sc_state &= ~LOG_ASYNC;
294		break;
295
296	case TIOCSPGRP:
297		logsoftc.sc_pgid = *(int *)data;
298		logsoftc.sc_siguid = p->p_cred->p_ruid;
299		logsoftc.sc_sigeuid = p->p_ucred->cr_uid;
300		break;
301
302	case TIOCGPGRP:
303		*(int *)data = logsoftc.sc_pgid;
304		break;
305
306	default:
307		return (-1);
308	}
309	return (0);
310}
311