wsevent.c revision 1.42
1 /* $NetBSD: wsevent.c,v 1.42 2019/03/01 11:06:57 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.42 2019/03/01 11:06:57 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 static int 193 wsevent_copyout_events(const struct wscons_event *events, int cnt, 194 struct uio *uio, int ver) 195 { 196 int error; 197 198 switch (ver) { 199 case 0: 200 MODULE_HOOK_CALL(wscons_copyout_events_50_hook, 201 (events, cnt, uio), enosys(), error); 202 if (error == ENOSYS) 203 error = EINVAL; 204 return error; 205 case WSEVENT_VERSION: 206 return uiomove(__UNCONST(events), cnt * sizeof(*events), uio); 207 default: 208 panic("%s: unknown version %d", __func__, ver); 209 } 210 } 211 212 /* 213 * User-level interface: read, poll. 214 * (User cannot write an event queue.) 215 */ 216 int 217 wsevent_read(struct wseventvar *ev, struct uio *uio, int flags) 218 { 219 int s, n, cnt, error; 220 const int ver = ev->version; 221 const size_t evsize = EVSIZE(ver); 222 223 /* 224 * Make sure we can return at least 1. 225 */ 226 if (uio->uio_resid < evsize) 227 return (EMSGSIZE); /* ??? */ 228 s = splwsevent(); 229 while (ev->get == ev->put) { 230 if (flags & IO_NDELAY) { 231 splx(s); 232 return (EWOULDBLOCK); 233 } 234 ev->wanted = 1; 235 error = tsleep(ev, PWSEVENT | PCATCH, "wsevent_read", 0); 236 if (error) { 237 splx(s); 238 return (error); 239 } 240 } 241 /* 242 * Move wscons_event from tail end of queue (there is at least one 243 * there). 244 */ 245 if (ev->put < ev->get) 246 cnt = WSEVENT_QSIZE - ev->get; /* events in [get..QSIZE) */ 247 else 248 cnt = ev->put - ev->get; /* events in [get..put) */ 249 splx(s); 250 n = howmany(uio->uio_resid, evsize); 251 if (cnt > n) 252 cnt = n; 253 error = wsevent_copyout_events(EVARRAY(ev, ev->get), cnt, uio, ver); 254 n -= cnt; 255 /* 256 * If we do not wrap to 0, used up all our space, or had an error, 257 * stop. Otherwise move from front of queue to put index, if there 258 * is anything there to move. 259 */ 260 if ((ev->get = (ev->get + cnt) % WSEVENT_QSIZE) != 0 || 261 n == 0 || error || (cnt = ev->put) == 0) 262 return (error); 263 if (cnt > n) 264 cnt = n; 265 error = wsevent_copyout_events(EVARRAY(ev, 0), cnt, uio, ver); 266 ev->get = cnt; 267 return (error); 268 } 269 270 int 271 wsevent_poll(struct wseventvar *ev, int events, struct lwp *l) 272 { 273 int revents = 0; 274 int s = splwsevent(); 275 276 if (events & (POLLIN | POLLRDNORM)) { 277 if (ev->get != ev->put) 278 revents |= events & (POLLIN | POLLRDNORM); 279 else 280 selrecord(l, &ev->sel); 281 } 282 283 splx(s); 284 return (revents); 285 } 286 287 static void 288 filt_wseventrdetach(struct knote *kn) 289 { 290 struct wseventvar *ev = kn->kn_hook; 291 int s; 292 293 s = splwsevent(); 294 SLIST_REMOVE(&ev->sel.sel_klist, kn, knote, kn_selnext); 295 splx(s); 296 } 297 298 static int 299 filt_wseventread(struct knote *kn, long hint) 300 { 301 struct wseventvar *ev = kn->kn_hook; 302 303 if (ev->get == ev->put) 304 return (0); 305 306 if (ev->get < ev->put) 307 kn->kn_data = ev->put - ev->get; 308 else 309 kn->kn_data = (WSEVENT_QSIZE - ev->get) + ev->put; 310 311 kn->kn_data *= EVSIZE(ev->version); 312 313 return (1); 314 } 315 316 static const struct filterops wsevent_filtops = { 317 .f_isfd = 1, 318 .f_attach = NULL, 319 .f_detach = filt_wseventrdetach, 320 .f_event = filt_wseventread, 321 }; 322 323 int 324 wsevent_kqfilter(struct wseventvar *ev, struct knote *kn) 325 { 326 struct klist *klist; 327 int s; 328 329 switch (kn->kn_filter) { 330 case EVFILT_READ: 331 klist = &ev->sel.sel_klist; 332 kn->kn_fop = &wsevent_filtops; 333 break; 334 335 default: 336 return (EINVAL); 337 } 338 339 kn->kn_hook = ev; 340 341 s = splwsevent(); 342 SLIST_INSERT_HEAD(klist, kn, kn_selnext); 343 splx(s); 344 345 return (0); 346 } 347 348 /* 349 * Wakes up all listener of the 'ev' queue. 350 */ 351 void 352 wsevent_wakeup(struct wseventvar *ev) 353 { 354 355 selnotify(&ev->sel, 0, 0); 356 357 if (ev->wanted) { 358 ev->wanted = 0; 359 wakeup(ev); 360 } 361 362 if (ev->async) { 363 softint_schedule(ev->sih); 364 } 365 } 366 367 /* 368 * Soft interrupt handler: sends signal to async proc. 369 */ 370 static void 371 wsevent_intr(void *cookie) 372 { 373 struct wseventvar *ev; 374 375 ev = cookie; 376 377 if (ev->async) { 378 mutex_enter(proc_lock); 379 psignal(ev->io, SIGIO); 380 mutex_exit(proc_lock); 381 } 382 } 383 384 /* 385 * Injects the set of events given in 'events', whose size is 'nevents', 386 * into the 'ev' queue. If there is not enough free space to inject them 387 * all, returns ENOSPC and the queue is left intact; otherwise returns 0 388 * and wakes up all listeners. 389 */ 390 int 391 wsevent_inject(struct wseventvar *ev, struct wscons_event *events, 392 size_t nevents) 393 { 394 size_t avail, i; 395 struct timespec t; 396 397 /* Calculate number of free slots in the queue. */ 398 if (ev->put < ev->get) 399 avail = ev->get - ev->put; 400 else 401 avail = WSEVENT_QSIZE - (ev->put - ev->get); 402 KASSERT(avail <= WSEVENT_QSIZE); 403 404 /* Fail if there is all events will not fit in the queue. */ 405 if (avail < nevents) 406 return ENOSPC; 407 408 /* Use the current time for all events. */ 409 getnanotime(&t); 410 411 /* Inject the events. */ 412 for (i = 0; i < nevents; i++) { 413 struct wscons_event *we; 414 415 we = EVARRAY(ev, ev->put); 416 we->type = events[i].type; 417 we->value = events[i].value; 418 we->time = t; 419 420 ev->put = (ev->put + 1) % WSEVENT_QSIZE; 421 } 422 wsevent_wakeup(ev); 423 424 return 0; 425 } 426 427 int 428 wsevent_setversion(struct wseventvar *ev, int vers) 429 { 430 if (ev == NULL) 431 return EINVAL; 432 433 switch (vers) { 434 case 0: 435 case WSEVENT_VERSION: 436 break; 437 default: 438 return EINVAL; 439 } 440 441 if (vers == ev->version) 442 return 0; 443 444 ev->get = ev->put = 0; 445 ev->version = vers; 446 return 0; 447 } 448
Indexes created Mon Sep 29 13:09:55 GMT 2025