freebsd-dev/sys/kern/subr_log.c
Ed Schouten ca1d2f657a Make /dev/klog and kern.msgbuf* MPSAFE.
Normally msgbufp is locked using Giant. Switch it to use the
msgbuf_lock. Instead of changing the tsleep() calls to msleep(), just
convert it to condvar(9).

In my opinion the locking around msgbuf_peekbytes() still remains
questionable. It looks like locks are dropped while performing copies of
multiple blocks to userspace, which may cause the msgbuf to be reset in
the mean time. At least getting it underneath from Giant should make it
a little easier for us to figure out how to solve that.

Reminded by:	rdivacky
2009-11-03 21:06:19 +00:00

263 lines
6.6 KiB
C

/*-
* Copyright (c) 1982, 1986, 1993
* The Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* @(#)subr_log.c 8.1 (Berkeley) 6/10/93
*/
/*
* Error log buffer for kernel printf's.
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/conf.h>
#include <sys/proc.h>
#include <sys/vnode.h>
#include <sys/filio.h>
#include <sys/ttycom.h>
#include <sys/msgbuf.h>
#include <sys/signalvar.h>
#include <sys/kernel.h>
#include <sys/poll.h>
#include <sys/filedesc.h>
#include <sys/sysctl.h>
#define LOG_RDPRI (PZERO + 1)
#define LOG_ASYNC 0x04
static d_open_t logopen;
static d_close_t logclose;
static d_read_t logread;
static d_ioctl_t logioctl;
static d_poll_t logpoll;
static void logtimeout(void *arg);
static struct cdevsw log_cdevsw = {
.d_version = D_VERSION,
.d_open = logopen,
.d_close = logclose,
.d_read = logread,
.d_ioctl = logioctl,
.d_poll = logpoll,
.d_name = "log",
};
static struct logsoftc {
int sc_state; /* see above for possibilities */
struct selinfo sc_selp; /* process waiting on select call */
struct sigio *sc_sigio; /* information for async I/O */
struct callout sc_callout; /* callout to wakeup syslog */
} logsoftc;
int log_open; /* also used in log() */
static struct cv log_wakeup;
struct mtx msgbuf_lock;
MTX_SYSINIT(msgbuf_lock, &msgbuf_lock, "msgbuf lock", MTX_DEF);
/* Times per second to check for a pending syslog wakeup. */
static int log_wakeups_per_second = 5;
SYSCTL_INT(_kern, OID_AUTO, log_wakeups_per_second, CTLFLAG_RW,
&log_wakeups_per_second, 0, "");
/*ARGSUSED*/
static int
logopen(struct cdev *dev, int flags, int mode, struct thread *td)
{
if (log_wakeups_per_second < 1) {
printf("syslog wakeup is less than one. Adjusting to 1.\n");
log_wakeups_per_second = 1;
}
mtx_lock(&msgbuf_lock);
if (log_open) {
mtx_unlock(&msgbuf_lock);
return (EBUSY);
}
log_open = 1;
callout_reset(&logsoftc.sc_callout, hz / log_wakeups_per_second,
logtimeout, NULL);
mtx_unlock(&msgbuf_lock);
fsetown(td->td_proc->p_pid, &logsoftc.sc_sigio); /* signal process only */
return (0);
}
/*ARGSUSED*/
static int
logclose(struct cdev *dev, int flag, int mode, struct thread *td)
{
funsetown(&logsoftc.sc_sigio);
mtx_lock(&msgbuf_lock);
callout_stop(&logsoftc.sc_callout);
logsoftc.sc_state = 0;
log_open = 0;
mtx_unlock(&msgbuf_lock);
return (0);
}
/*ARGSUSED*/
static int
logread(struct cdev *dev, struct uio *uio, int flag)
{
char buf[128];
struct msgbuf *mbp = msgbufp;
int error = 0, l;
mtx_lock(&msgbuf_lock);
while (msgbuf_getcount(mbp) == 0) {
if (flag & IO_NDELAY) {
mtx_unlock(&msgbuf_lock);
return (EWOULDBLOCK);
}
if ((error = cv_wait_sig(&log_wakeup, &msgbuf_lock)) != 0) {
mtx_unlock(&msgbuf_lock);
return (error);
}
}
while (uio->uio_resid > 0) {
l = imin(sizeof(buf), uio->uio_resid);
l = msgbuf_getbytes(mbp, buf, l);
if (l == 0)
break;
mtx_unlock(&msgbuf_lock);
error = uiomove(buf, l, uio);
if (error || uio->uio_resid == 0)
return (error);
mtx_lock(&msgbuf_lock);
}
mtx_unlock(&msgbuf_lock);
return (error);
}
/*ARGSUSED*/
static int
logpoll(struct cdev *dev, int events, struct thread *td)
{
int revents = 0;
if (events & (POLLIN | POLLRDNORM)) {
mtx_lock(&msgbuf_lock);
if (msgbuf_getcount(msgbufp) > 0)
revents |= events & (POLLIN | POLLRDNORM);
else
selrecord(td, &logsoftc.sc_selp);
mtx_unlock(&msgbuf_lock);
}
return (revents);
}
static void
logtimeout(void *arg)
{
if (!log_open)
return;
if (log_wakeups_per_second < 1) {
printf("syslog wakeup is less than one. Adjusting to 1.\n");
log_wakeups_per_second = 1;
}
if (msgbuftrigger == 0) {
callout_schedule(&logsoftc.sc_callout,
hz / log_wakeups_per_second);
return;
}
msgbuftrigger = 0;
selwakeuppri(&logsoftc.sc_selp, LOG_RDPRI);
if ((logsoftc.sc_state & LOG_ASYNC) && logsoftc.sc_sigio != NULL)
pgsigio(&logsoftc.sc_sigio, SIGIO, 0);
cv_broadcastpri(&log_wakeup, LOG_RDPRI);
callout_schedule(&logsoftc.sc_callout, hz / log_wakeups_per_second);
}
/*ARGSUSED*/
static int
logioctl(struct cdev *dev, u_long com, caddr_t data, int flag, struct thread *td)
{
switch (com) {
/* return number of characters immediately available */
case FIONREAD:
*(int *)data = msgbuf_getcount(msgbufp);
break;
case FIONBIO:
break;
case FIOASYNC:
mtx_lock(&msgbuf_lock);
if (*(int *)data)
logsoftc.sc_state |= LOG_ASYNC;
else
logsoftc.sc_state &= ~LOG_ASYNC;
mtx_unlock(&msgbuf_lock);
break;
case FIOSETOWN:
return (fsetown(*(int *)data, &logsoftc.sc_sigio));
case FIOGETOWN:
*(int *)data = fgetown(&logsoftc.sc_sigio);
break;
/* This is deprecated, FIOSETOWN should be used instead. */
case TIOCSPGRP:
return (fsetown(-(*(int *)data), &logsoftc.sc_sigio));
/* This is deprecated, FIOGETOWN should be used instead */
case TIOCGPGRP:
*(int *)data = -fgetown(&logsoftc.sc_sigio);
break;
default:
return (ENOTTY);
}
return (0);
}
static void
log_drvinit(void *unused)
{
cv_init(&log_wakeup, "klog");
callout_init_mtx(&logsoftc.sc_callout, &msgbuf_lock, 0);
make_dev(&log_cdevsw, 0, UID_ROOT, GID_WHEEL, 0600, "klog");
}
SYSINIT(logdev,SI_SUB_DRIVERS,SI_ORDER_MIDDLE,log_drvinit,NULL);