]> git.saurik.com Git - apple/xnu.git/blame - bsd/kern/subr_log.c
xnu-792.13.8.tar.gz
[apple/xnu.git] / bsd / kern / subr_log.c
CommitLineData
1c79356b 1/*
5d5c5d0d
A
2 * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
3 *
8ad349bb 4 * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
1c79356b 5 *
8ad349bb
A
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the
10 * License may not be used to create, or enable the creation or
11 * redistribution of, unlawful or unlicensed copies of an Apple operating
12 * system, or to circumvent, violate, or enable the circumvention or
13 * violation of, any terms of an Apple operating system software license
14 * agreement.
15 *
16 * Please obtain a copy of the License at
17 * http://www.opensource.apple.com/apsl/ and read it before using this
18 * file.
19 *
20 * The Original Code and all software distributed under the License are
21 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
22 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
23 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
25 * Please see the License for the specific language governing rights and
26 * limitations under the License.
27 *
28 * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
1c79356b
A
29 */
30/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
31/*
32 * Copyright (c) 1982, 1986, 1993
33 * The Regents of the University of California. All rights reserved.
34 *
35 * Redistribution and use in source and binary forms, with or without
36 * modification, are permitted provided that the following conditions
37 * are met:
38 * 1. Redistributions of source code must retain the above copyright
39 * notice, this list of conditions and the following disclaimer.
40 * 2. Redistributions in binary form must reproduce the above copyright
41 * notice, this list of conditions and the following disclaimer in the
42 * documentation and/or other materials provided with the distribution.
43 * 3. All advertising materials mentioning features or use of this software
44 * must display the following acknowledgement:
45 * This product includes software developed by the University of
46 * California, Berkeley and its contributors.
47 * 4. Neither the name of the University nor the names of its contributors
48 * may be used to endorse or promote products derived from this software
49 * without specific prior written permission.
50 *
51 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
52 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
53 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
54 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
55 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
56 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
57 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
58 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
59 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
60 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
61 * SUCH DAMAGE.
62 *
63 * @(#)subr_log.c 8.3 (Berkeley) 2/14/95
64 */
65
66/*
67 * Error log buffer for kernel printf's.
68 */
69
70#include <sys/param.h>
71#include <sys/systm.h>
91447636 72#include <sys/proc_internal.h>
1c79356b
A
73#include <sys/vnode.h>
74#include <sys/ioctl.h>
75#include <sys/msgbuf.h>
91447636 76#include <sys/file_internal.h>
1c79356b
A
77#include <sys/errno.h>
78#include <sys/select.h>
91447636 79#include <sys/kernel.h>
1c79356b 80#include <kern/thread.h>
91447636 81#include <sys/lock.h>
1c79356b
A
82
83#define LOG_RDPRI (PZERO + 1)
84
85#define LOG_NBIO 0x02
86#define LOG_ASYNC 0x04
87#define LOG_RDWAIT 0x08
88
89struct logsoftc {
90 int sc_state; /* see above for possibilities */
91 struct selinfo sc_selp; /* thread waiting for select */
92 int sc_pgid; /* process/group for async I/O */
93} logsoftc;
94
95int log_open; /* also used in log() */
96struct msgbuf temp_msgbuf;
97struct msgbuf *msgbufp;
98static int _logentrypend = 0;
91447636
A
99static int log_inited = 0;
100void bsd_log_lock(void);
101/* the following two are implemented in osfmk/kern/printf.c */
102extern void bsd_log_unlock(void);
103extern void bsd_log_init(void);
1c79356b
A
104
105/*
106 * Serialize log access. Note that the log can be written at interrupt level,
107 * so any log manipulations that can be done from, or affect, another processor
108 * at interrupt level must be guarded with a spin lock.
109 */
91447636
A
110
111#define LOG_LOCK() bsd_log_lock()
112#define LOG_UNLOCK() bsd_log_unlock()
113
1c79356b
A
114
115/*ARGSUSED*/
116logopen(dev, flags, mode, p)
117 dev_t dev;
118 int flags, mode;
119 struct proc *p;
120{
1c79356b
A
121 LOG_LOCK();
122 if (log_open) {
123 LOG_UNLOCK();
1c79356b
A
124 return (EBUSY);
125 }
126 log_open = 1;
127 logsoftc.sc_pgid = p->p_pid; /* signal process only */
128 /*
129 * Potential race here with putchar() but since putchar should be
130 * called by autoconf, msg_magic should be initialized by the time
131 * we get here.
132 */
133 if (msgbufp->msg_magic != MSG_MAGIC) {
134 register int i;
135
136 msgbufp->msg_magic = MSG_MAGIC;
137 msgbufp->msg_bufx = msgbufp->msg_bufr = 0;
138 for (i=0; i < MSG_BSIZE; i++)
139 msgbufp->msg_bufc[i] = 0;
140 }
141 LOG_UNLOCK();
9bccf70c 142
1c79356b
A
143 return (0);
144}
145
146/*ARGSUSED*/
147int
148logclose(dev, flag)
149 dev_t dev;
150{
151 int oldpri;
152 LOG_LOCK();
153 log_open = 0;
154 selwakeup(&logsoftc.sc_selp);
1c79356b 155 selthreadclear(&logsoftc.sc_selp);
1c79356b
A
156 LOG_UNLOCK();
157 return (0);
158}
159
160/*ARGSUSED*/
161int
162logread(dev, uio, flag)
163 dev_t dev;
164 struct uio *uio;
165 int flag;
166{
167 register long l;
168 register int s;
169 int error = 0;
91447636
A
170 char localbuff[MSG_BSIZE];
171 int copybytes;
1c79356b 172
91447636 173 LOG_LOCK();
1c79356b
A
174 while (msgbufp->msg_bufr == msgbufp->msg_bufx) {
175 if (flag & IO_NDELAY) {
91447636
A
176 error = EWOULDBLOCK;
177 goto out;
1c79356b
A
178 }
179 if (logsoftc.sc_state & LOG_NBIO) {
91447636
A
180 error = EWOULDBLOCK;
181 goto out;
1c79356b
A
182 }
183 logsoftc.sc_state |= LOG_RDWAIT;
91447636
A
184 LOG_UNLOCK();
185 /*
186 * If the wakeup is missed the ligtening bolt will wake this up
187 * if there are any new characters. If that doesn't do it
188 * then wait for 5 sec and reevaluate
189 */
1c79356b 190 if (error = tsleep((caddr_t)msgbufp, LOG_RDPRI | PCATCH,
91447636
A
191 "klog", 5 * hz)) {
192 /* if it times out; ignore */
193 if (error != EWOULDBLOCK)
194 return (error);
1c79356b 195 }
91447636 196 LOG_LOCK();
1c79356b 197 }
1c79356b
A
198 logsoftc.sc_state &= ~LOG_RDWAIT;
199
91447636
A
200
201 while (uio_resid(uio) > 0) {
1c79356b
A
202 l = msgbufp->msg_bufx - msgbufp->msg_bufr;
203 if (l < 0)
204 l = MSG_BSIZE - msgbufp->msg_bufr;
91447636 205 l = min(l, uio_resid(uio));
1c79356b
A
206 if (l == 0)
207 break;
91447636
A
208 bcopy(&msgbufp->msg_bufc[msgbufp->msg_bufr], &localbuff[0], l);
209 LOG_UNLOCK();
210 error = uiomove((caddr_t)&localbuff[0],
1c79356b 211 (int)l, uio);
91447636 212 LOG_LOCK();
1c79356b
A
213 if (error)
214 break;
215 msgbufp->msg_bufr += l;
216 if (msgbufp->msg_bufr < 0 || msgbufp->msg_bufr >= MSG_BSIZE)
217 msgbufp->msg_bufr = 0;
218 }
91447636
A
219out:
220 LOG_UNLOCK();
1c79356b
A
221 return (error);
222}
223
224/*ARGSUSED*/
225int
0b4e3aa0 226logselect(dev, rw, wql, p)
1c79356b
A
227 dev_t dev;
228 int rw;
0b4e3aa0 229 void * wql;
1c79356b
A
230 struct proc *p;
231{
1c79356b
A
232
233 switch (rw) {
234
235 case FREAD:
91447636 236 LOG_LOCK();
1c79356b 237 if (msgbufp->msg_bufr != msgbufp->msg_bufx) {
91447636 238 LOG_UNLOCK();
1c79356b
A
239 return (1);
240 }
0b4e3aa0 241 selrecord(p, &logsoftc.sc_selp, wql);
91447636 242 LOG_UNLOCK();
1c79356b
A
243 break;
244 }
1c79356b
A
245 return (0);
246}
247
248void
249logwakeup()
250{
251 struct proc *p;
252 int pgid;
253 boolean_t funnel_state;
254
91447636
A
255 LOG_LOCK();
256 if (!log_open) {
257 LOG_UNLOCK();
1c79356b 258 return;
91447636 259 }
1c79356b
A
260 selwakeup(&logsoftc.sc_selp);
261 if (logsoftc.sc_state & LOG_ASYNC) {
1c79356b
A
262 pgid = logsoftc.sc_pgid;
263 LOG_UNLOCK();
264 if (pgid < 0)
265 gsignal(-pgid, SIGIO);
266 else if (p = pfind(pgid))
267 psignal(p, SIGIO);
91447636 268 LOG_LOCK();
1c79356b
A
269 }
270 if (logsoftc.sc_state & LOG_RDWAIT) {
271 wakeup((caddr_t)msgbufp);
272 logsoftc.sc_state &= ~LOG_RDWAIT;
273 }
91447636 274 LOG_UNLOCK();
1c79356b
A
275}
276
277void
278klogwakeup()
279{
280
281 if (_logentrypend) {
282 _logentrypend = 0;
283 logwakeup();
284 }
285}
286
287/*ARGSUSED*/
288int
55e303ae 289logioctl(dev, com, data, flag)
1c79356b
A
290 caddr_t data;
291{
292 long l;
293 int s;
294
91447636 295 LOG_LOCK();
1c79356b
A
296 switch (com) {
297
298 /* return number of characters immediately available */
299 case FIONREAD:
1c79356b 300 l = msgbufp->msg_bufx - msgbufp->msg_bufr;
1c79356b
A
301 if (l < 0)
302 l += MSG_BSIZE;
303 *(off_t *)data = l;
304 break;
305
306 case FIONBIO:
307 if (*(int *)data)
308 logsoftc.sc_state |= LOG_NBIO;
309 else
310 logsoftc.sc_state &= ~LOG_NBIO;
311 break;
312
313 case FIOASYNC:
314 if (*(int *)data)
315 logsoftc.sc_state |= LOG_ASYNC;
316 else
317 logsoftc.sc_state &= ~LOG_ASYNC;
318 break;
319
320 case TIOCSPGRP:
1c79356b 321 logsoftc.sc_pgid = *(int *)data;
1c79356b
A
322 break;
323
324 case TIOCGPGRP:
1c79356b 325 *(int *)data = logsoftc.sc_pgid;
1c79356b
A
326 break;
327
328 default:
91447636 329 LOG_UNLOCK();
1c79356b
A
330 return (-1);
331 }
91447636 332 LOG_UNLOCK();
1c79356b
A
333 return (0);
334}
335
336void
91447636 337bsd_log_init()
1c79356b 338{
91447636
A
339 if (!log_inited) {
340 msgbufp = &temp_msgbuf;
341 log_inited = 1;
342 }
1c79356b
A
343}
344
345void
346log_putc(char c)
347{
348 register struct msgbuf *mbp;
349
91447636
A
350 if (!log_inited) {
351 panic("bsd log is not inited");
352 }
353 LOG_LOCK();
1c79356b
A
354
355 mbp = msgbufp;
356 if (mbp-> msg_magic != MSG_MAGIC) {
357 register int i;
358
359 mbp->msg_magic = MSG_MAGIC;
360 mbp->msg_bufx = mbp->msg_bufr = 0;
361 for (i=0; i < MSG_BSIZE; i++)
362 mbp->msg_bufc[i] = 0;
363 }
364 mbp->msg_bufc[mbp->msg_bufx++] = c;
365 _logentrypend = 1;
366 if (mbp->msg_bufx < 0 || mbp->msg_bufx >= MSG_BSIZE)
367 mbp->msg_bufx = 0;
91447636 368 LOG_UNLOCK();
1c79356b 369}
91447636 370