Implement select(2) in terms of kevent
[dragonfly.git] / sys / kern / kern_event.c
1 /*-
2  * Copyright (c) 1999,2000,2001 Jonathan Lemon <jlemon@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/kern/kern_event.c,v 1.2.2.10 2004/04/04 07:03:14 cperciva Exp $
27  * $DragonFly: src/sys/kern/kern_event.c,v 1.33 2007/02/03 17:05:57 corecode Exp $
28  */
29
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/proc.h>
34 #include <sys/malloc.h> 
35 #include <sys/unistd.h>
36 #include <sys/file.h>
37 #include <sys/lock.h>
38 #include <sys/fcntl.h>
39 #include <sys/select.h>
40 #include <sys/queue.h>
41 #include <sys/event.h>
42 #include <sys/eventvar.h>
43 #include <sys/poll.h>
44 #include <sys/protosw.h>
45 #include <sys/socket.h>
46 #include <sys/socketvar.h>
47 #include <sys/stat.h>
48 #include <sys/sysctl.h>
49 #include <sys/sysproto.h>
50 #include <sys/uio.h>
51 #include <sys/signalvar.h>
52 #include <sys/filio.h>
53 #include <sys/ktr.h>
54
55 #include <sys/thread2.h>
56 #include <sys/file2.h>
57 #include <sys/mplock2.h>
58
59 #include <vm/vm_zone.h>
60
61 MALLOC_DEFINE(M_KQUEUE, "kqueue", "memory for kqueue system");
62
63 struct kevent_copyin_args {
64         struct kevent_args      *ka;
65         int                     pchanges;
66 };
67
68 static int      kqueue_scan(struct kqueue *kq, struct kevent *kevp, int count,
69                     struct timespec *tsp, int *errorp);
70 static int      kqueue_read(struct file *fp, struct uio *uio,
71                     struct ucred *cred, int flags);
72 static int      kqueue_write(struct file *fp, struct uio *uio,
73                     struct ucred *cred, int flags);
74 static int      kqueue_ioctl(struct file *fp, u_long com, caddr_t data,
75                     struct ucred *cred, struct sysmsg *msg);
76 static int      kqueue_poll(struct file *fp, int events, struct ucred *cred);
77 static int      kqueue_kqfilter(struct file *fp, struct knote *kn);
78 static int      kqueue_stat(struct file *fp, struct stat *st,
79                     struct ucred *cred);
80 static int      kqueue_close(struct file *fp);
81
82 /*
83  * MPSAFE
84  */
85 static struct fileops kqueueops = {
86         .fo_read = kqueue_read,
87         .fo_write = kqueue_write,
88         .fo_ioctl = kqueue_ioctl,
89         .fo_poll = kqueue_poll,
90         .fo_kqfilter = kqueue_kqfilter,
91         .fo_stat = kqueue_stat,
92         .fo_close = kqueue_close,
93         .fo_shutdown = nofo_shutdown
94 };
95
96 static void     knote_attach(struct knote *kn);
97 static void     knote_drop(struct knote *kn);
98 static void     knote_enqueue(struct knote *kn);
99 static void     knote_dequeue(struct knote *kn);
100 static void     knote_init(void);
101 static struct   knote *knote_alloc(void);
102 static void     knote_free(struct knote *kn);
103
104 static void     filt_kqdetach(struct knote *kn);
105 static int      filt_kqueue(struct knote *kn, long hint);
106 static int      filt_procattach(struct knote *kn);
107 static void     filt_procdetach(struct knote *kn);
108 static int      filt_proc(struct knote *kn, long hint);
109 static int      filt_fileattach(struct knote *kn);
110 static void     filt_timerexpire(void *knx);
111 static int      filt_timerattach(struct knote *kn);
112 static void     filt_timerdetach(struct knote *kn);
113 static int      filt_timer(struct knote *kn, long hint);
114
115 static struct filterops file_filtops =
116         { 1, filt_fileattach, NULL, NULL };
117 static struct filterops kqread_filtops =
118         { 1, NULL, filt_kqdetach, filt_kqueue };
119 static struct filterops proc_filtops =
120         { 0, filt_procattach, filt_procdetach, filt_proc };
121 static struct filterops timer_filtops =
122         { 0, filt_timerattach, filt_timerdetach, filt_timer };
123
124 static vm_zone_t        knote_zone;
125 static int              kq_ncallouts = 0;
126 static int              kq_calloutmax = (4 * 1024);
127 SYSCTL_INT(_kern, OID_AUTO, kq_calloutmax, CTLFLAG_RW,
128     &kq_calloutmax, 0, "Maximum number of callouts allocated for kqueue");
129
130 #define KNOTE_ACTIVATE(kn) do {                                         \
131         kn->kn_status |= KN_ACTIVE;                                     \
132         if ((kn->kn_status & (KN_QUEUED | KN_DISABLED)) == 0)           \
133                 knote_enqueue(kn);                                      \
134 } while(0)
135
136 #define KN_HASHSIZE             64              /* XXX should be tunable */
137 #define KN_HASH(val, mask)      (((val) ^ (val >> 8)) & (mask))
138
139 extern struct filterops aio_filtops;
140 extern struct filterops sig_filtops;
141
142 /*
143  * Table for for all system-defined filters.
144  */
145 static struct filterops *sysfilt_ops[] = {
146         &file_filtops,                  /* EVFILT_READ */
147         &file_filtops,                  /* EVFILT_WRITE */
148         &aio_filtops,                   /* EVFILT_AIO */
149         &file_filtops,                  /* EVFILT_VNODE */
150         &proc_filtops,                  /* EVFILT_PROC */
151         &sig_filtops,                   /* EVFILT_SIGNAL */
152         &timer_filtops,                 /* EVFILT_TIMER */
153 };
154
155 static int
156 filt_fileattach(struct knote *kn)
157 {
158         return (fo_kqfilter(kn->kn_fp, kn));
159 }
160
161 /*
162  * MPALMOSTSAFE - acquires mplock
163  */
164 static int
165 kqueue_kqfilter(struct file *fp, struct knote *kn)
166 {
167         struct kqueue *kq = (struct kqueue *)kn->kn_fp->f_data;
168
169         get_mplock();
170         if (kn->kn_filter != EVFILT_READ) {
171                 rel_mplock();
172                 return (1);
173         }
174
175         kn->kn_fop = &kqread_filtops;
176         SLIST_INSERT_HEAD(&kq->kq_sel.si_note, kn, kn_selnext);
177         rel_mplock();
178         return (0);
179 }
180
181 static void
182 filt_kqdetach(struct knote *kn)
183 {
184         struct kqueue *kq = (struct kqueue *)kn->kn_fp->f_data;
185
186         SLIST_REMOVE(&kq->kq_sel.si_note, kn, knote, kn_selnext);
187 }
188
189 /*ARGSUSED*/
190 static int
191 filt_kqueue(struct knote *kn, long hint)
192 {
193         struct kqueue *kq = (struct kqueue *)kn->kn_fp->f_data;
194
195         kn->kn_data = kq->kq_count;
196         return (kn->kn_data > 0);
197 }
198
199 static int
200 filt_procattach(struct knote *kn)
201 {
202         struct proc *p;
203         int immediate;
204
205         immediate = 0;
206         lwkt_gettoken(&proc_token);
207         p = pfind(kn->kn_id);
208         if (p == NULL && (kn->kn_sfflags & NOTE_EXIT)) {
209                 p = zpfind(kn->kn_id);
210                 immediate = 1;
211         }
212         if (p == NULL) {
213                 lwkt_reltoken(&proc_token);
214                 return (ESRCH);
215         }
216         if (!PRISON_CHECK(curthread->td_ucred, p->p_ucred)) {
217                 lwkt_reltoken(&proc_token);
218                 return (EACCES);
219         }
220
221         kn->kn_ptr.p_proc = p;
222         kn->kn_flags |= EV_CLEAR;               /* automatically set */
223
224         /*
225          * internal flag indicating registration done by kernel
226          */
227         if (kn->kn_flags & EV_FLAG1) {
228                 kn->kn_data = kn->kn_sdata;             /* ppid */
229                 kn->kn_fflags = NOTE_CHILD;
230                 kn->kn_flags &= ~EV_FLAG1;
231         }
232
233         /* XXX lock the proc here while adding to the list? */
234         SLIST_INSERT_HEAD(&p->p_klist, kn, kn_selnext);
235
236         /*
237          * Immediately activate any exit notes if the target process is a
238          * zombie.  This is necessary to handle the case where the target
239          * process, e.g. a child, dies before the kevent is registered.
240          */
241         if (immediate && filt_proc(kn, NOTE_EXIT))
242                 KNOTE_ACTIVATE(kn);
243         lwkt_reltoken(&proc_token);
244
245         return (0);
246 }
247
248 /*
249  * The knote may be attached to a different process, which may exit,
250  * leaving nothing for the knote to be attached to.  So when the process
251  * exits, the knote is marked as DETACHED and also flagged as ONESHOT so
252  * it will be deleted when read out.  However, as part of the knote deletion,
253  * this routine is called, so a check is needed to avoid actually performing
254  * a detach, because the original process does not exist any more.
255  */
256 static void
257 filt_procdetach(struct knote *kn)
258 {
259         struct proc *p;
260
261         if (kn->kn_status & KN_DETACHED)
262                 return;
263         /* XXX locking?  this might modify another process. */
264         p = kn->kn_ptr.p_proc;
265         SLIST_REMOVE(&p->p_klist, kn, knote, kn_selnext);
266 }
267
268 static int
269 filt_proc(struct knote *kn, long hint)
270 {
271         u_int event;
272
273         /*
274          * mask off extra data
275          */
276         event = (u_int)hint & NOTE_PCTRLMASK;
277
278         /*
279          * if the user is interested in this event, record it.
280          */
281         if (kn->kn_sfflags & event)
282                 kn->kn_fflags |= event;
283
284         /*
285          * Process is gone, so flag the event as finished.  Detach the
286          * knote from the process now because the process will be poof,
287          * gone later on.
288          */
289         if (event == NOTE_EXIT) {
290                 struct proc *p = kn->kn_ptr.p_proc;
291                 if ((kn->kn_status & KN_DETACHED) == 0) {
292                         SLIST_REMOVE(&p->p_klist, kn, knote, kn_selnext);
293                         kn->kn_status |= KN_DETACHED;
294                         kn->kn_data = p->p_xstat;
295                         kn->kn_ptr.p_proc = NULL;
296                 }
297                 kn->kn_flags |= (EV_EOF | EV_ONESHOT); 
298                 return (1);
299         }
300
301         /*
302          * process forked, and user wants to track the new process,
303          * so attach a new knote to it, and immediately report an
304          * event with the parent's pid.
305          */
306         if ((event == NOTE_FORK) && (kn->kn_sfflags & NOTE_TRACK)) {
307                 struct kevent kev;
308                 int error;
309
310                 /*
311                  * register knote with new process.
312                  */
313                 kev.ident = hint & NOTE_PDATAMASK;      /* pid */
314                 kev.filter = kn->kn_filter;
315                 kev.flags = kn->kn_flags | EV_ADD | EV_ENABLE | EV_FLAG1;
316                 kev.fflags = kn->kn_sfflags;
317                 kev.data = kn->kn_id;                   /* parent */
318                 kev.udata = kn->kn_kevent.udata;        /* preserve udata */
319                 error = kqueue_register(kn->kn_kq, &kev);
320                 if (error)
321                         kn->kn_fflags |= NOTE_TRACKERR;
322         }
323
324         return (kn->kn_fflags != 0);
325 }
326
327 static void
328 filt_timerexpire(void *knx)
329 {
330         struct knote *kn = knx;
331         struct callout *calloutp;
332         struct timeval tv;
333         int tticks;
334
335         kn->kn_data++;
336         KNOTE_ACTIVATE(kn);
337
338         if ((kn->kn_flags & EV_ONESHOT) == 0) {
339                 tv.tv_sec = kn->kn_sdata / 1000;
340                 tv.tv_usec = (kn->kn_sdata % 1000) * 1000;
341                 tticks = tvtohz_high(&tv);
342                 calloutp = (struct callout *)kn->kn_hook;
343                 callout_reset(calloutp, tticks, filt_timerexpire, kn);
344         }
345 }
346
347 /*
348  * data contains amount of time to sleep, in milliseconds
349  */ 
350 static int
351 filt_timerattach(struct knote *kn)
352 {
353         struct callout *calloutp;
354         struct timeval tv;
355         int tticks;
356
357         if (kq_ncallouts >= kq_calloutmax)
358                 return (ENOMEM);
359         kq_ncallouts++;
360
361         tv.tv_sec = kn->kn_sdata / 1000;
362         tv.tv_usec = (kn->kn_sdata % 1000) * 1000;
363         tticks = tvtohz_high(&tv);
364
365         kn->kn_flags |= EV_CLEAR;               /* automatically set */
366         MALLOC(calloutp, struct callout *, sizeof(*calloutp),
367             M_KQUEUE, M_WAITOK);
368         callout_init(calloutp);
369         kn->kn_hook = (caddr_t)calloutp;
370         callout_reset(calloutp, tticks, filt_timerexpire, kn);
371
372         return (0);
373 }
374
375 static void
376 filt_timerdetach(struct knote *kn)
377 {
378         struct callout *calloutp;
379
380         calloutp = (struct callout *)kn->kn_hook;
381         callout_stop(calloutp);
382         FREE(calloutp, M_KQUEUE);
383         kq_ncallouts--;
384 }
385
386 static int
387 filt_timer(struct knote *kn, long hint)
388 {
389
390         return (kn->kn_data != 0);
391 }
392
393 /*
394  * Initialize a kqueue.
395  *
396  * NOTE: The lwp/proc code initializes a kqueue for select/poll ops.
397  *
398  * MPSAFE
399  */
400 void
401 kqueue_init(struct kqueue *kq, struct filedesc *fdp)
402 {
403         TAILQ_INIT(&kq->kq_knpend);
404         TAILQ_INIT(&kq->kq_knlist);
405         kq->kq_fdp = fdp;
406 }
407
408 /*
409  * Terminate a kqueue.  Freeing the actual kq itself is left up to the
410  * caller (it might be embedded in a lwp so we don't do it here).
411  */
412 void
413 kqueue_terminate(struct kqueue *kq)
414 {
415         struct knote *kn;
416         struct klist *list;
417         int hv;
418
419         while ((kn = TAILQ_FIRST(&kq->kq_knlist)) != NULL) {
420                 kn->kn_fop->f_detach(kn);
421                 if (kn->kn_fop->f_isfd) {
422                         list = &kn->kn_fp->f_klist;
423                         SLIST_REMOVE(list, kn, knote, kn_link);
424                         fdrop(kn->kn_fp);
425                         kn->kn_fp = NULL;
426                 } else {
427                         hv = KN_HASH(kn->kn_id, kq->kq_knhashmask);
428                         list = &kq->kq_knhash[hv];
429                         SLIST_REMOVE(list, kn, knote, kn_link);
430                 }
431                 TAILQ_REMOVE(&kq->kq_knlist, kn, kn_kqlink);
432                 if (kn->kn_status & KN_QUEUED)
433                         knote_dequeue(kn);
434                 knote_free(kn);
435         }
436
437         if (kq->kq_knhash) {
438                 kfree(kq->kq_knhash, M_KQUEUE);
439                 kq->kq_knhash = NULL;
440                 kq->kq_knhashmask = 0;
441         }
442 }
443
444 /*
445  * MPSAFE
446  */
447 int
448 sys_kqueue(struct kqueue_args *uap)
449 {
450         struct thread *td = curthread;
451         struct kqueue *kq;
452         struct file *fp;
453         int fd, error;
454
455         error = falloc(td->td_lwp, &fp, &fd);
456         if (error)
457                 return (error);
458         fp->f_flag = FREAD | FWRITE;
459         fp->f_type = DTYPE_KQUEUE;
460         fp->f_ops = &kqueueops;
461
462         kq = kmalloc(sizeof(struct kqueue), M_KQUEUE, M_WAITOK | M_ZERO);
463         kqueue_init(kq, td->td_proc->p_fd);
464         fp->f_data = kq;
465
466         fsetfd(kq->kq_fdp, fp, fd);
467         uap->sysmsg_result = fd;
468         fdrop(fp);
469         return (error);
470 }
471
472 /*
473  * Copy 'count' items into the destination list pointed to by uap->eventlist.
474  */
475 static int
476 kevent_copyout(void *arg, struct kevent *kevp, int count, int *res)
477 {
478         struct kevent_copyin_args *kap;
479         int error;
480
481         kap = (struct kevent_copyin_args *)arg;
482
483         error = copyout(kevp, kap->ka->eventlist, count * sizeof *kevp);
484         if (error == 0) {
485                 kap->ka->eventlist += count;
486                 *res += count;
487         } else {
488                 *res = -1;
489         }
490
491         return (error);
492 }
493
494 /*
495  * Copy at most 'max' items from the list pointed to by kap->changelist,
496  * return number of items in 'events'.
497  */
498 static int
499 kevent_copyin(void *arg, struct kevent *kevp, int max, int *events)
500 {
501         struct kevent_copyin_args *kap;
502         int error, count;
503
504         kap = (struct kevent_copyin_args *)arg;
505
506         count = min(kap->ka->nchanges - kap->pchanges, max);
507         error = copyin(kap->ka->changelist, kevp, count * sizeof *kevp);
508         if (error == 0) {
509                 kap->ka->changelist += count;
510                 kap->pchanges += count;
511                 *events = count;
512         }
513
514         return (error);
515 }
516
517 /*
518  * MPALMOSTSAFE
519  */
520 int
521 kern_kevent(struct kqueue *kq, int nevents, int *res, void *uap,
522     k_copyin_fn kevent_copyinfn, k_copyout_fn kevent_copyoutfn,
523     struct timespec *tsp_in)
524 {
525         struct kevent *kevp;
526         struct timespec ts;
527         struct timespec *tsp;
528         int i, n, total, error, nerrors = 0;
529         struct kevent kev[KQ_NEVENTS];
530
531         tsp = tsp_in;
532         *res = 0;
533
534         get_mplock();
535         for ( ;; ) {
536                 n = 0;
537                 error = kevent_copyinfn(uap, kev, KQ_NEVENTS, &n);
538                 if (error)
539                         goto done;
540                 if (n == 0)
541                         break;
542                 for (i = 0; i < n; i++) {
543                         kevp = &kev[i];
544                         kevp->flags &= ~EV_SYSFLAGS;
545                         error = kqueue_register(kq, kevp);
546                         if (error) {
547                                 if (nevents != 0) {
548                                         kevp->flags = EV_ERROR;
549                                         kevp->data = error;
550                                         kevent_copyoutfn(uap, kevp, 1, res);
551                                         nevents--;
552                                         nerrors++;
553                                 } else {
554                                         goto done;
555                                 }
556                         }
557                 }
558         }
559         if (nerrors) {
560                 error = 0;
561                 goto done;
562         }
563
564         /*
565          * Acquire/wait for events - setup timeout
566          */
567         if (tsp != NULL) {
568                 struct timespec ats;
569
570                 if (tsp->tv_sec || tsp->tv_nsec) {
571                         nanouptime(&ats);
572                         timespecadd(tsp, &ats);         /* tsp = target time */
573                 }
574         }
575
576         /*
577          * Loop as required.
578          *
579          * Collect as many events as we can.  The timeout on successive
580          * loops is disabled (kqueue_scan() becomes non-blocking).
581          */
582         total = 0;
583         error = 0;
584         while ((n = nevents - total) > 0) {
585                 if (n > KQ_NEVENTS)
586                         n = KQ_NEVENTS;
587                 i = kqueue_scan(kq, kev, n, tsp, &error);
588                 if (i == 0)
589                         break;
590                 error = kevent_copyoutfn(uap, kev, i, res);
591                 total += i;
592                 if (error || i != n)
593                         break;
594                 tsp = &ts;              /* successive loops non-blocking */
595                 tsp->tv_sec = 0;
596                 tsp->tv_nsec = 0;
597         }
598
599 done:
600         rel_mplock();
601         return (error);
602 }
603
604 /*
605  * MPALMOSTSAFE
606  */
607 int
608 sys_kevent(struct kevent_args *uap)
609 {
610         struct thread *td = curthread;
611         struct proc *p = td->td_proc;
612         struct timespec ts, *tsp;
613         struct kqueue *kq;
614         struct file *fp = NULL;
615         struct kevent_copyin_args *kap, ka;
616         int error;
617
618         if (uap->timeout) {
619                 error = copyin(uap->timeout, &ts, sizeof(ts));
620                 if (error)
621                         return (error);
622                 tsp = &ts;
623         } else {
624                 tsp = NULL;
625         }
626
627         fp = holdfp(p->p_fd, uap->fd, -1);
628         if (fp == NULL)
629                 return (EBADF);
630         if (fp->f_type != DTYPE_KQUEUE) {
631                 fdrop(fp);
632                 return (EBADF);
633         }
634
635         kq = (struct kqueue *)fp->f_data;
636
637         kap = &ka;
638         kap->ka = uap;
639         kap->pchanges = 0;
640
641         error = kern_kevent(kq, uap->nevents, &uap->sysmsg_result, kap,
642             kevent_copyin, kevent_copyout, tsp);
643
644         fdrop(fp);
645
646         return (error);
647 }
648
649 int
650 kqueue_register(struct kqueue *kq, struct kevent *kev)
651 {
652         struct filedesc *fdp = kq->kq_fdp;
653         struct filterops *fops;
654         struct file *fp = NULL;
655         struct knote *kn = NULL;
656         int error = 0;
657
658         if (kev->filter < 0) {
659                 if (kev->filter + EVFILT_SYSCOUNT < 0)
660                         return (EINVAL);
661                 fops = sysfilt_ops[~kev->filter];       /* to 0-base index */
662         } else {
663                 /*
664                  * XXX
665                  * filter attach routine is responsible for insuring that
666                  * the identifier can be attached to it.
667                  */
668                 kprintf("unknown filter: %d\n", kev->filter);
669                 return (EINVAL);
670         }
671
672         if (fops->f_isfd) {
673                 /* validate descriptor */
674                 fp = holdfp(fdp, kev->ident, -1);
675                 if (fp == NULL)
676                         return (EBADF);
677
678                 SLIST_FOREACH(kn, &fp->f_klist, kn_link) {
679                         if (kn->kn_kq == kq &&
680                             kn->kn_filter == kev->filter &&
681                             kn->kn_id == kev->ident) {
682                                 break;
683                         }
684                 }
685         } else {
686                 if (kq->kq_knhashmask) {
687                         struct klist *list;
688                         
689                         list = &kq->kq_knhash[
690                             KN_HASH((u_long)kev->ident, kq->kq_knhashmask)];
691                         SLIST_FOREACH(kn, list, kn_link) {
692                                 if (kn->kn_id == kev->ident &&
693                                     kn->kn_filter == kev->filter)
694                                         break;
695                         }
696                 }
697         }
698
699         if (kn == NULL && ((kev->flags & EV_ADD) == 0)) {
700                 error = ENOENT;
701                 goto done;
702         }
703
704         /*
705          * kn now contains the matching knote, or NULL if no match
706          */
707         if (kev->flags & EV_ADD) {
708                 if (kn == NULL) {
709                         kn = knote_alloc();
710                         if (kn == NULL) {
711                                 error = ENOMEM;
712                                 goto done;
713                         }
714                         kn->kn_fp = fp;
715                         kn->kn_kq = kq;
716                         kn->kn_fop = fops;
717
718                         /*
719                          * apply reference count to knote structure, and
720                          * do not release it at the end of this routine.
721                          */
722                         fp = NULL;
723
724                         kn->kn_sfflags = kev->fflags;
725                         kn->kn_sdata = kev->data;
726                         kev->fflags = 0;
727                         kev->data = 0;
728                         kn->kn_kevent = *kev;
729
730                         knote_attach(kn);
731                         if ((error = fops->f_attach(kn)) != 0) {
732                                 knote_drop(kn);
733                                 goto done;
734                         }
735                 } else {
736                         /*
737                          * The user may change some filter values after the
738                          * initial EV_ADD, but doing so will not reset any 
739                          * filter which have already been triggered.
740                          */
741                         kn->kn_sfflags = kev->fflags;
742                         kn->kn_sdata = kev->data;
743                         kn->kn_kevent.udata = kev->udata;
744                 }
745
746                 crit_enter();
747                 if (kn->kn_fop->f_event(kn, 0))
748                         KNOTE_ACTIVATE(kn);
749                 crit_exit();
750         } else if (kev->flags & EV_DELETE) {
751                 kn->kn_fop->f_detach(kn);
752                 knote_drop(kn);
753                 goto done;
754         }
755
756         if ((kev->flags & EV_DISABLE) &&
757             ((kn->kn_status & KN_DISABLED) == 0)) {
758                 crit_enter();
759                 kn->kn_status |= KN_DISABLED;
760                 crit_exit();
761         }
762
763         if ((kev->flags & EV_ENABLE) && (kn->kn_status & KN_DISABLED)) {
764                 crit_enter();
765                 kn->kn_status &= ~KN_DISABLED;
766                 if ((kn->kn_status & KN_ACTIVE) &&
767                     ((kn->kn_status & KN_QUEUED) == 0))
768                         knote_enqueue(kn);
769                 crit_exit();
770         }
771
772 done:
773         if (fp != NULL)
774                 fdrop(fp);
775         return (error);
776 }
777
778 /*
779  * Scan the kqueue, blocking if necessary until the target time is reached.
780  * If tsp is NULL we block indefinitely.  If tsp->ts_secs/nsecs are both
781  * 0 we do not block at all.
782  */
783 static int
784 kqueue_scan(struct kqueue *kq, struct kevent *kevp, int count,
785             struct timespec *tsp, int *errorp)
786 {
787         struct knote *kn, marker;
788         int total;
789
790         total = 0;
791 again:
792         crit_enter();
793         if (kq->kq_count == 0) {
794                 if (tsp == NULL) {
795                         kq->kq_state |= KQ_SLEEP;
796                         *errorp = tsleep(kq, PCATCH, "kqread", 0);
797                 } else if (tsp->tv_sec == 0 && tsp->tv_nsec == 0) {
798                         *errorp = EWOULDBLOCK;
799                 } else {
800                         struct timespec ats;
801                         struct timespec atx = *tsp;
802                         int timeout;
803
804                         nanouptime(&ats);
805                         timespecsub(&atx, &ats);
806                         if (ats.tv_sec < 0) {
807                                 *errorp = EWOULDBLOCK;
808                         } else {
809                                 timeout = atx.tv_sec > 24 * 60 * 60 ?
810                                         24 * 60 * 60 * hz : tstohz_high(&atx);
811                                 kq->kq_state |= KQ_SLEEP;
812                                 *errorp = tsleep(kq, PCATCH, "kqread", timeout);
813                         }
814                 }
815                 crit_exit();
816                 if (*errorp == 0)
817                         goto again;
818                 /* don't restart after signals... */
819                 if (*errorp == ERESTART)
820                         *errorp = EINTR;
821                 else if (*errorp == EWOULDBLOCK)
822                         *errorp = 0;
823                 goto done;
824         }
825
826         /*
827          * Collect events.  Continuous mode events may get recycled
828          * past the marker so we stop when we hit it unless no events
829          * have been collected.
830          */
831         TAILQ_INSERT_TAIL(&kq->kq_knpend, &marker, kn_tqe);
832         while (count) {
833                 kn = TAILQ_FIRST(&kq->kq_knpend);
834                 if (kn == &marker)
835                         break;
836                 TAILQ_REMOVE(&kq->kq_knpend, kn, kn_tqe);
837                 if (kn->kn_status & KN_DISABLED) {
838                         kn->kn_status &= ~KN_QUEUED;
839                         kq->kq_count--;
840                         continue;
841                 }
842                 if ((kn->kn_flags & EV_ONESHOT) == 0 &&
843                     kn->kn_fop->f_event(kn, 0) == 0) {
844                         kn->kn_status &= ~(KN_QUEUED | KN_ACTIVE);
845                         kq->kq_count--;
846                         continue;
847                 }
848                 *kevp++ = kn->kn_kevent;
849                 ++total;
850                 --count;
851
852                 /*
853                  * Post-event action on the note
854                  */
855                 if (kn->kn_flags & EV_ONESHOT) {
856                         kn->kn_status &= ~KN_QUEUED;
857                         kq->kq_count--;
858                         crit_exit();
859                         kn->kn_fop->f_detach(kn);
860                         knote_drop(kn);
861                         crit_enter();
862                 } else if (kn->kn_flags & EV_CLEAR) {
863                         kn->kn_data = 0;
864                         kn->kn_fflags = 0;
865                         kn->kn_status &= ~(KN_QUEUED | KN_ACTIVE);
866                         kq->kq_count--;
867                 } else {
868                         TAILQ_INSERT_TAIL(&kq->kq_knpend, kn, kn_tqe);
869                 }
870         }
871         TAILQ_REMOVE(&kq->kq_knpend, &marker, kn_tqe);
872         crit_exit();
873         if (total == 0)
874                 goto again;
875 done:
876         return (total);
877 }
878
879 /*
880  * XXX
881  * This could be expanded to call kqueue_scan, if desired.
882  *
883  * MPSAFE
884  */
885 static int
886 kqueue_read(struct file *fp, struct uio *uio, struct ucred *cred, int flags)
887 {
888         return (ENXIO);
889 }
890
891 /*
892  * MPSAFE
893  */
894 static int
895 kqueue_write(struct file *fp, struct uio *uio, struct ucred *cred, int flags)
896 {
897         return (ENXIO);
898 }
899
900 /*
901  * MPALMOSTSAFE
902  */
903 static int
904 kqueue_ioctl(struct file *fp, u_long com, caddr_t data,
905              struct ucred *cred, struct sysmsg *msg)
906 {
907         struct kqueue *kq;
908         int error;
909
910         get_mplock();
911         kq = (struct kqueue *)fp->f_data;
912
913         switch(com) {
914         case FIOASYNC:
915                 if (*(int *)data)
916                         kq->kq_state |= KQ_ASYNC;
917                 else
918                         kq->kq_state &= ~KQ_ASYNC;
919                 error = 0;
920                 break;
921         case FIOSETOWN:
922                 error = fsetown(*(int *)data, &kq->kq_sigio);
923                 break;
924         default:
925                 error = ENOTTY;
926                 break;
927         }
928         rel_mplock();
929         return (error);
930 }
931
932 /*
933  * MPALMOSTSAFE - acquires mplock
934  */
935 static int
936 kqueue_poll(struct file *fp, int events, struct ucred *cred)
937 {
938         struct kqueue *kq = (struct kqueue *)fp->f_data;
939         int revents = 0;
940
941         get_mplock();
942         crit_enter();
943         if (events & (POLLIN | POLLRDNORM)) {
944                 if (kq->kq_count) {
945                         revents |= events & (POLLIN | POLLRDNORM);
946                 } else {
947                         selrecord(curthread, &kq->kq_sel);
948                         kq->kq_state |= KQ_SEL;
949                 }
950         }
951         crit_exit();
952         rel_mplock();
953         return (revents);
954 }
955
956 /*
957  * MPSAFE
958  */
959 static int
960 kqueue_stat(struct file *fp, struct stat *st, struct ucred *cred)
961 {
962         struct kqueue *kq = (struct kqueue *)fp->f_data;
963
964         bzero((void *)st, sizeof(*st));
965         st->st_size = kq->kq_count;
966         st->st_blksize = sizeof(struct kevent);
967         st->st_mode = S_IFIFO;
968         return (0);
969 }
970
971 /*
972  * MPALMOSTSAFE - acquires mplock
973  */
974 static int
975 kqueue_close(struct file *fp)
976 {
977         struct kqueue *kq = (struct kqueue *)fp->f_data;
978
979         get_mplock();
980
981         kqueue_terminate(kq);
982
983         fp->f_data = NULL;
984         funsetown(kq->kq_sigio);
985         rel_mplock();
986
987         kfree(kq, M_KQUEUE);
988         return (0);
989 }
990
991 void
992 kqueue_wakeup(struct kqueue *kq)
993 {
994         if (kq->kq_state & KQ_SLEEP) {
995                 kq->kq_state &= ~KQ_SLEEP;
996                 wakeup(kq);
997         }
998         if (kq->kq_state & KQ_SEL) {
999                 kq->kq_state &= ~KQ_SEL;
1000                 selwakeup(&kq->kq_sel);
1001         }
1002         KNOTE(&kq->kq_sel.si_note, 0);
1003 }
1004
1005 /*
1006  * walk down a list of knotes, activating them if their event has triggered.
1007  */
1008 void
1009 knote(struct klist *list, long hint)
1010 {
1011         struct knote *kn;
1012
1013         SLIST_FOREACH(kn, list, kn_selnext)
1014                 if (kn->kn_fop->f_event(kn, hint))
1015                         KNOTE_ACTIVATE(kn);
1016 }
1017
1018 /*
1019  * remove all knotes from a specified klist
1020  */
1021 void
1022 knote_remove(struct klist *list)
1023 {
1024         struct knote *kn;
1025
1026         while ((kn = SLIST_FIRST(list)) != NULL) {
1027                 kn->kn_fop->f_detach(kn);
1028                 knote_drop(kn);
1029         }
1030 }
1031
1032 /*
1033  * remove all knotes referencing a specified fd
1034  */
1035 void
1036 knote_fdclose(struct file *fp, struct filedesc *fdp, int fd)
1037 {
1038         struct knote *kn;
1039
1040 restart:
1041         SLIST_FOREACH(kn, &fp->f_klist, kn_link) {
1042                 if (kn->kn_kq->kq_fdp == fdp && kn->kn_id == fd) {
1043                         kn->kn_fop->f_detach(kn);
1044                         knote_drop(kn);
1045                         goto restart;
1046                 }
1047         }
1048 }
1049
1050 static void
1051 knote_attach(struct knote *kn)
1052 {
1053         struct klist *list;
1054         struct kqueue *kq = kn->kn_kq;
1055
1056         if (kn->kn_fop->f_isfd) {
1057                 KKASSERT(kn->kn_fp);
1058                 list = &kn->kn_fp->f_klist;
1059         } else {
1060                 if (kq->kq_knhashmask == 0)
1061                         kq->kq_knhash = hashinit(KN_HASHSIZE, M_KQUEUE,
1062                                                  &kq->kq_knhashmask);
1063                 list = &kq->kq_knhash[KN_HASH(kn->kn_id, kq->kq_knhashmask)];
1064         }
1065         SLIST_INSERT_HEAD(list, kn, kn_link);
1066         TAILQ_INSERT_HEAD(&kq->kq_knlist, kn, kn_kqlink);
1067         kn->kn_status = 0;
1068 }
1069
1070 /*
1071  * should be called outside of a critical section, since we don't want to
1072  * hold a critical section while calling fdrop and free.
1073  */
1074 static void
1075 knote_drop(struct knote *kn)
1076 {
1077         struct kqueue *kq;
1078         struct klist *list;
1079
1080         kq = kn->kn_kq;
1081
1082         if (kn->kn_fop->f_isfd)
1083                 list = &kn->kn_fp->f_klist;
1084         else
1085                 list = &kq->kq_knhash[KN_HASH(kn->kn_id, kq->kq_knhashmask)];
1086
1087         SLIST_REMOVE(list, kn, knote, kn_link);
1088         TAILQ_REMOVE(&kq->kq_knlist, kn, kn_kqlink);
1089         if (kn->kn_status & KN_QUEUED)
1090                 knote_dequeue(kn);
1091         if (kn->kn_fop->f_isfd)
1092                 fdrop(kn->kn_fp);
1093         knote_free(kn);
1094 }
1095
1096
1097 static void
1098 knote_enqueue(struct knote *kn)
1099 {
1100         struct kqueue *kq = kn->kn_kq;
1101
1102         crit_enter();
1103         KASSERT((kn->kn_status & KN_QUEUED) == 0, ("knote already queued"));
1104
1105         TAILQ_INSERT_TAIL(&kq->kq_knpend, kn, kn_tqe);
1106         kn->kn_status |= KN_QUEUED;
1107         ++kq->kq_count;
1108
1109         /*
1110          * Send SIGIO on request (typically set up as a mailbox signal)
1111          */
1112         if (kq->kq_sigio && (kq->kq_state & KQ_ASYNC) && kq->kq_count == 1)
1113                 pgsigio(kq->kq_sigio, SIGIO, 0);
1114         crit_exit();
1115         kqueue_wakeup(kq);
1116 }
1117
1118 static void
1119 knote_dequeue(struct knote *kn)
1120 {
1121         struct kqueue *kq = kn->kn_kq;
1122
1123         KASSERT(kn->kn_status & KN_QUEUED, ("knote not queued"));
1124         crit_enter();
1125
1126         TAILQ_REMOVE(&kq->kq_knpend, kn, kn_tqe);
1127         kn->kn_status &= ~KN_QUEUED;
1128         kq->kq_count--;
1129         crit_exit();
1130 }
1131
1132 static void
1133 knote_init(void)
1134 {
1135         knote_zone = zinit("KNOTE", sizeof(struct knote), 0, 0, 1);
1136 }
1137 SYSINIT(knote, SI_SUB_PSEUDO, SI_ORDER_ANY, knote_init, NULL)
1138
1139 static struct knote *
1140 knote_alloc(void)
1141 {
1142         return ((struct knote *)zalloc(knote_zone));
1143 }
1144
1145 static void
1146 knote_free(struct knote *kn)
1147 {
1148         zfree(knote_zone, kn);
1149 }