wsevent.c revision 1.37.2.4
1 /* $NetBSD: wsevent.c,v 1.37.2.4 2018/09/18 01:15:58 pgoyette Exp $ */ 2 3 /*- 4 * Copyright (c) 2006, 2008 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Julio M. Merino Vidal. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 /* 33 * Copyright (c) 1996, 1997 Christopher G. Demetriou. 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 Christopher G. Demetriou 46 * for the NetBSD Project. 47 * 4. The name of the author may not be used to endorse or promote products 48 * derived from this software without specific prior written permission 49 * 50 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 51 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 52 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 53 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 54 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 55 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 56 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 57 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 58 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 59 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 60 */ 61 62 /* 63 * Copyright (c) 1992, 1993 64 * The Regents of the University of California. All rights reserved. 65 * 66 * This software was developed by the Computer Systems Engineering group 67 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and 68 * contributed to Berkeley. 69 * 70 * All advertising materials mentioning features or use of this software 71 * must display the following acknowledgement: 72 * This product includes software developed by the University of 73 * California, Lawrence Berkeley Laboratory. 74 * 75 * Redistribution and use in source and binary forms, with or without 76 * modification, are permitted provided that the following conditions 77 * are met: 78 * 1. Redistributions of source code must retain the above copyright 79 * notice, this list of conditions and the following disclaimer. 80 * 2. Redistributions in binary form must reproduce the above copyright 81 * notice, this list of conditions and the following disclaimer in the 82 * documentation and/or other materials provided with the distribution. 83 * 3. Neither the name of the University nor the names of its contributors 84 * may be used to endorse or promote products derived from this software 85 * without specific prior written permission. 86 * 87 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 88 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 89 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 90 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 91 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 92 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 93 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 94 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 95 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 96 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 97 * SUCH DAMAGE. 98 * 99 * @(#)event.c 8.1 (Berkeley) 6/11/93 100 */ 101 102 /* 103 * Internal "wscons_event" queue interface for the keyboard and mouse drivers. 104 */ 105 106 #include <sys/cdefs.h> 107 __KERNEL_RCSID(0, "$NetBSD: wsevent.c,v 1.37.2.4 2018/09/18 01:15:58 pgoyette Exp $"); 108 109 #ifdef _KERNEL_OPT 110 #include "opt_compat_netbsd.h" 111 #include "opt_modular.h" 112 #endif 113 114 #include <sys/param.h> 115 #include <sys/kernel.h> 116 #include <sys/fcntl.h> 117 #include <sys/kmem.h> 118 #include <sys/proc.h> 119 #include <sys/systm.h> 120 #include <sys/vnode.h> 121 #include <sys/select.h> 122 #include <sys/poll.h> 123 #include <sys/compat_stub.h> 124 125 #include <dev/wscons/wsconsio.h> 126 #include <dev/wscons/wseventvar.h> 127 128 /* 129 * Size of a wsevent queue (measured in number of events). 130 * Should be a power of two so that `%' is fast. 131 * At the moment, the value below makes the queues use 2 Kbytes each; this 132 * value may need tuning. 133 */ 134 #define WSEVENT_QSIZE 256 135 136 #define EVSIZE(ver) ((ver) == WSEVENT_VERSION ? \ 137 sizeof(struct wscons_event) : \ 138 sizeof(struct owscons_event)) 139 #define EVARRAY(ev, idx) (&(ev)->q[(idx)]) 140 141 /* 142 * Priority of code managing wsevent queues. PWSEVENT is set just above 143 * PSOCK, which is just above TTIPRI, on the theory that mouse and keyboard 144 * `user' input should be quick. 145 */ 146 #define PWSEVENT 23 147 #define splwsevent() spltty() 148 149 static void wsevent_intr(void *); 150 151 /* 152 * Initialize a wscons_event queue. 153 */ 154 void 155 wsevent_init(struct wseventvar *ev, struct proc *p) 156 { 157 158 if (ev->q != NULL) { 159 #ifdef DIAGNOSTIC 160 printf("wsevent_init: already init\n"); 161 #endif 162 return; 163 } 164 /* For binary compat. New code must call WSxxxIO_SETVERSION */ 165 ev->version = 0; 166 ev->get = ev->put = 0; 167 ev->q = kmem_alloc(WSEVENT_QSIZE * sizeof(*ev->q), KM_SLEEP); 168 selinit(&ev->sel); 169 ev->io = p; 170 ev->sih = softint_establish(SOFTINT_MPSAFE | SOFTINT_CLOCK, 171 wsevent_intr, ev); 172 } 173 174 /* 175 * Tear down a wscons_event queue. 176 */ 177 void 178 wsevent_fini(struct wseventvar *ev) 179 { 180 if (ev->q == NULL) { 181 #ifdef DIAGNOSTIC 182 printf("wsevent_fini: already fini\n"); 183 #endif 184 return; 185 } 186 seldestroy(&ev->sel); 187 kmem_free(ev->q, WSEVENT_QSIZE * sizeof(*ev->q)); 188 ev->q = NULL; 189 softint_disestablish(ev->sih); 190 } 191 192 COMPAT_CALL_HOOK_DECL(wsevent_50_copyout_events_hook, f, 193 (const struct wscons_event *events, int cnt, struct uio *uio), 194 (events, cnt, uio), enosys()); 195 COMPAT_CALL_HOOK(wsevent_50_copyout_events_hook, f, 196 (const struct wscons_event *events, int cnt, struct uio *uio), 197 (events, cnt, uio), enosys()); 198 199 static int 200 wsevent_copyout_events(const struct wscons_event *events, int cnt, 201 struct uio *uio, int ver) 202 { 203 int error; 204 205 switch (ver) { 206 case 0: 207 error = wsevent_50_copyout_events_hook_f_call(events, cnt, uio); 208 if (error == ENOSYS) 209 error = EINVAL; 210 return error; 211 case WSEVENT_VERSION: 212 return uiomove(__UNCONST(events), cnt * sizeof(*events), uio); 213 default: 214 panic("%s: unknown version %d", __func__, ver); 215 } 216 } 217 218 /* 219 * User-level interface: read, poll. 220 * (User cannot write an event queue.) 221 */ 222 int 223 wsevent_read(struct wseventvar *ev, struct uio *uio, int flags) 224 { 225 int s, n, cnt, error; 226 const int ver = ev->version; 227 const size_t evsize = EVSIZE(ver); 228 229 /* 230 * Make sure we can return at least 1. 231 */ 232 if (uio->uio_resid < evsize) 233 return (EMSGSIZE); /* ??? */ 234 s = splwsevent(); 235 while (ev->get == ev->put) { 236 if (flags & IO_NDELAY) { 237 splx(s); 238 return (EWOULDBLOCK); 239 } 240 ev->wanted = 1; 241 error = tsleep(ev, PWSEVENT | PCATCH, "wsevent_read", 0); 242 if (error) { 243 splx(s); 244 return (error); 245 } 246 } 247 /* 248 * Move wscons_event from tail end of queue (there is at least one 249 * there). 250 */ 251 if (ev->put < ev->get) 252 cnt = WSEVENT_QSIZE - ev->get; /* events in [get..QSIZE) */ 253 else 254 cnt = ev->put - ev->get; /* events in [get..put) */ 255 splx(s); 256 n = howmany(uio->uio_resid, evsize); 257 if (cnt > n) 258 cnt = n; 259 error = wsevent_copyout_events(EVARRAY(ev, ev->get), cnt, uio, ver); 260 n -= cnt; 261 /* 262 * If we do not wrap to 0, used up all our space, or had an error, 263 * stop. Otherwise move from front of queue to put index, if there 264 * is anything there to move. 265 */ 266 if ((ev->get = (ev->get + cnt) % WSEVENT_QSIZE) != 0 || 267 n == 0 || error || (cnt = ev->put) == 0) 268 return (error); 269 if (cnt > n) 270 cnt = n; 271 error = wsevent_copyout_events(EVARRAY(ev, 0), cnt, uio, ver); 272 ev->get = cnt; 273 return (error); 274 } 275 276 int 277 wsevent_poll(struct wseventvar *ev, int events, struct lwp *l) 278 { 279 int revents = 0; 280 int s = splwsevent(); 281 282 if (events & (POLLIN | POLLRDNORM)) { 283 if (ev->get != ev->put) 284 revents |= events & (POLLIN | POLLRDNORM); 285 else 286 selrecord(l, &ev->sel); 287 } 288 289 splx(s); 290 return (revents); 291 } 292 293 static void 294 filt_wseventrdetach(struct knote *kn) 295 { 296 struct wseventvar *ev = kn->kn_hook; 297 int s; 298 299 s = splwsevent(); 300 SLIST_REMOVE(&ev->sel.sel_klist, kn, knote, kn_selnext); 301 splx(s); 302 } 303 304 static int 305 filt_wseventread(struct knote *kn, long hint) 306 { 307 struct wseventvar *ev = kn->kn_hook; 308 309 if (ev->get == ev->put) 310 return (0); 311 312 if (ev->get < ev->put) 313 kn->kn_data = ev->put - ev->get; 314 else 315 kn->kn_data = (WSEVENT_QSIZE - ev->get) + ev->put; 316 317 kn->kn_data *= EVSIZE(ev->version); 318 319 return (1); 320 } 321 322 static const struct filterops wsevent_filtops = { 323 .f_isfd = 1, 324 .f_attach = NULL, 325 .f_detach = filt_wseventrdetach, 326 .f_event = filt_wseventread, 327 }; 328 329 int 330 wsevent_kqfilter(struct wseventvar *ev, struct knote *kn) 331 { 332 struct klist *klist; 333 int s; 334 335 switch (kn->kn_filter) { 336 case EVFILT_READ: 337 klist = &ev->sel.sel_klist; 338 kn->kn_fop = &wsevent_filtops; 339 break; 340 341 default: 342 return (EINVAL); 343 } 344 345 kn->kn_hook = ev; 346 347 s = splwsevent(); 348 SLIST_INSERT_HEAD(klist, kn, kn_selnext); 349 splx(s); 350 351 return (0); 352 } 353 354 /* 355 * Wakes up all listener of the 'ev' queue. 356 */ 357 void 358 wsevent_wakeup(struct wseventvar *ev) 359 { 360 361 selnotify(&ev->sel, 0, 0); 362 363 if (ev->wanted) { 364 ev->wanted = 0; 365 wakeup(ev); 366 } 367 368 if (ev->async) { 369 softint_schedule(ev->sih); 370 } 371 } 372 373 /* 374 * Soft interrupt handler: sends signal to async proc. 375 */ 376 static void 377 wsevent_intr(void *cookie) 378 { 379 struct wseventvar *ev; 380 381 ev = cookie; 382 383 if (ev->async) { 384 mutex_enter(proc_lock); 385 psignal(ev->io, SIGIO); 386 mutex_exit(proc_lock); 387 } 388 } 389 390 /* 391 * Injects the set of events given in 'events', whose size is 'nevents', 392 * into the 'ev' queue. If there is not enough free space to inject them 393 * all, returns ENOSPC and the queue is left intact; otherwise returns 0 394 * and wakes up all listeners. 395 */ 396 int 397 wsevent_inject(struct wseventvar *ev, struct wscons_event *events, 398 size_t nevents) 399 { 400 size_t avail, i; 401 struct timespec t; 402 403 /* Calculate number of free slots in the queue. */ 404 if (ev->put < ev->get) 405 avail = ev->get - ev->put; 406 else 407 avail = WSEVENT_QSIZE - (ev->put - ev->get); 408 KASSERT(avail <= WSEVENT_QSIZE); 409 410 /* Fail if there is all events will not fit in the queue. */ 411 if (avail < nevents) 412 return ENOSPC; 413 414 /* Use the current time for all events. */ 415 getnanotime(&t); 416 417 /* Inject the events. */ 418 for (i = 0; i < nevents; i++) { 419 struct wscons_event *we; 420 421 we = EVARRAY(ev, ev->put); 422 we->type = events[i].type; 423 we->value = events[i].value; 424 we->time = t; 425 426 ev->put = (ev->put + 1) % WSEVENT_QSIZE; 427 } 428 wsevent_wakeup(ev); 429 430 return 0; 431 } 432 433 int 434 wsevent_setversion(struct wseventvar *ev, int vers) 435 { 436 if (ev == NULL) 437 return EINVAL; 438 439 switch (vers) { 440 case 0: 441 case WSEVENT_VERSION: 442 break; 443 default: 444 return EINVAL; 445 } 446 447 if (vers == ev->version) 448 return 0; 449 450 ev->get = ev->put = 0; 451 ev->version = vers; 452 return 0; 453 } 454
Indexes created Sun Oct 19 02:09:48 GMT 2025