wsevent.c revision 1.18
1/* $OpenBSD: wsevent.c,v 1.18 2018/11/19 19:19:24 anton Exp $ */
2/* $NetBSD: wsevent.c,v 1.16 2003/08/07 16:31:29 agc Exp $ */
3
4/*
5 * Copyright (c) 1996, 1997 Christopher G. Demetriou.  All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 *    must display the following acknowledgement:
17 *      This product includes software developed by Christopher G. Demetriou
18 *	for the NetBSD Project.
19 * 4. The name of the author may not be used to endorse or promote products
20 *    derived from this software without specific prior written permission
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34/*
35 * Copyright (c) 1992, 1993
36 *	The Regents of the University of California.  All rights reserved.
37 *
38 * This software was developed by the Computer Systems Engineering group
39 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
40 * contributed to Berkeley.
41 *
42 * All advertising materials mentioning features or use of this software
43 * must display the following acknowledgement:
44 *	This product includes software developed by the University of
45 *	California, Lawrence Berkeley Laboratory.
46 *
47 * Redistribution and use in source and binary forms, with or without
48 * modification, are permitted provided that the following conditions
49 * are met:
50 * 1. Redistributions of source code must retain the above copyright
51 *    notice, this list of conditions and the following disclaimer.
52 * 2. Redistributions in binary form must reproduce the above copyright
53 *    notice, this list of conditions and the following disclaimer in the
54 *    documentation and/or other materials provided with the distribution.
55 * 3. Neither the name of the University nor the names of its contributors
56 *    may be used to endorse or promote products derived from this software
57 *    without specific prior written permission.
58 *
59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69 * SUCH DAMAGE.
70 *
71 *	@(#)event.c	8.1 (Berkeley) 6/11/93
72 */
73
74/*
75 * Internal "wscons_event" queue interface for the keyboard and mouse drivers.
76 */
77
78#include <sys/param.h>
79#include <sys/malloc.h>
80#include <sys/systm.h>
81#include <sys/vnode.h>
82#include <sys/selinfo.h>
83#include <sys/poll.h>
84
85#include <dev/wscons/wsconsio.h>
86#include <dev/wscons/wseventvar.h>
87
88void	filt_wseventdetach(struct knote *);
89int	filt_wseventread(struct knote *, long);
90
91const struct filterops wsevent_filtops = {
92	1,
93	NULL,
94	filt_wseventdetach,
95	filt_wseventread
96};
97
98/*
99 * Initialize a wscons_event queue.
100 */
101void
102wsevent_init(struct wseventvar *ev)
103{
104
105	if (ev->q != NULL) {
106#ifdef DIAGNOSTIC
107		printf("wsevent_init: already initialized\n");
108#endif
109		return;
110	}
111	ev->get = ev->put = 0;
112	ev->q = malloc(WSEVENT_QSIZE * sizeof(struct wscons_event),
113	    M_DEVBUF, M_WAITOK | M_ZERO);
114
115	sigio_init(&ev->sigio);
116}
117
118/*
119 * Tear down a wscons_event queue.
120 */
121void
122wsevent_fini(struct wseventvar *ev)
123{
124	if (ev->q == NULL) {
125#ifdef DIAGNOSTIC
126		printf("wsevent_fini: already invoked\n");
127#endif
128		return;
129	}
130	free(ev->q, M_DEVBUF, 0);
131	ev->q = NULL;
132
133	sigio_free(&ev->sigio);
134}
135
136/*
137 * User-level interface: read, poll.
138 * (User cannot write an event queue.)
139 */
140int
141wsevent_read(struct wseventvar *ev, struct uio *uio, int flags)
142{
143	int s, error;
144	u_int cnt;
145	size_t n;
146
147	/*
148	 * Make sure we can return at least 1.
149	 */
150	if (uio->uio_resid < sizeof(struct wscons_event))
151		return (EMSGSIZE);	/* ??? */
152	s = splwsevent();
153	while (ev->get == ev->put) {
154		if (flags & IO_NDELAY) {
155			splx(s);
156			return (EWOULDBLOCK);
157		}
158		ev->wanted = 1;
159		error = tsleep(ev, PWSEVENT | PCATCH,
160		    "wsevent_read", 0);
161		if (error) {
162			splx(s);
163			return (error);
164		}
165	}
166	/*
167	 * Move wscons_event from tail end of queue (there is at least one
168	 * there).
169	 */
170	if (ev->put < ev->get)
171		cnt = WSEVENT_QSIZE - ev->get;	/* events in [get..QSIZE) */
172	else
173		cnt = ev->put - ev->get;	/* events in [get..put) */
174	splx(s);
175	n = howmany(uio->uio_resid, sizeof(struct wscons_event));
176	if (cnt > n)
177		cnt = n;
178	error = uiomove((caddr_t)&ev->q[ev->get],
179	    cnt * sizeof(struct wscons_event), uio);
180	n -= cnt;
181	/*
182	 * If we do not wrap to 0, used up all our space, or had an error,
183	 * stop.  Otherwise move from front of queue to put index, if there
184	 * is anything there to move.
185	 */
186	if ((ev->get = (ev->get + cnt) % WSEVENT_QSIZE) != 0 ||
187	    n == 0 || error || (cnt = ev->put) == 0)
188		return (error);
189	if (cnt > n)
190		cnt = n;
191	error = uiomove((caddr_t)&ev->q[0],
192	    cnt * sizeof(struct wscons_event), uio);
193	ev->get = cnt;
194	return (error);
195}
196
197int
198wsevent_poll(struct wseventvar *ev, int events, struct proc *p)
199{
200	int revents = 0;
201	int s = splwsevent();
202
203	if (events & (POLLIN | POLLRDNORM)) {
204		if (ev->get != ev->put)
205			revents |= events & (POLLIN | POLLRDNORM);
206		else
207			selrecord(p, &ev->sel);
208	}
209
210	splx(s);
211	return (revents);
212}
213
214int
215wsevent_kqfilter(struct wseventvar *ev, struct knote *kn)
216{
217	struct klist *klist;
218	int s;
219
220	klist = &ev->sel.si_note;
221
222	switch (kn->kn_filter) {
223	case EVFILT_READ:
224		kn->kn_fop = &wsevent_filtops;
225		break;
226	default:
227		return (EINVAL);
228	}
229
230	kn->kn_hook = ev;
231
232	s = splwsevent();
233	SLIST_INSERT_HEAD(klist, kn, kn_selnext);
234	splx(s);
235
236	return (0);
237}
238
239void
240filt_wseventdetach(struct knote *kn)
241{
242	struct wseventvar *ev = kn->kn_hook;
243	struct klist *klist = &ev->sel.si_note;
244	int s;
245
246	s = splwsevent();
247	SLIST_REMOVE(klist, kn, knote, kn_selnext);
248	splx(s);
249}
250
251int
252filt_wseventread(struct knote *kn, long hint)
253{
254	struct wseventvar *ev = kn->kn_hook;
255
256	if (ev->get == ev->put)
257		return (0);
258
259	if (ev->get < ev->put)
260		kn->kn_data = ev->put - ev->get;
261	else
262		kn->kn_data = (WSEVENT_QSIZE - ev->get) + ev->put;
263
264	return (1);
265}
266