kqueue: Mark user filter MPSAFE
[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  */
28
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/kernel.h>
32 #include <sys/proc.h>
33 #include <sys/malloc.h> 
34 #include <sys/unistd.h>
35 #include <sys/file.h>
36 #include <sys/lock.h>
37 #include <sys/fcntl.h>
38 #include <sys/queue.h>
39 #include <sys/event.h>
40 #include <sys/eventvar.h>
41 #include <sys/protosw.h>
42 #include <sys/socket.h>
43 #include <sys/socketvar.h>
44 #include <sys/stat.h>
45 #include <sys/sysctl.h>
46 #include <sys/sysproto.h>
47 #include <sys/thread.h>
48 #include <sys/uio.h>
49 #include <sys/signalvar.h>
50 #include <sys/filio.h>
51 #include <sys/ktr.h>
52
53 #include <sys/thread2.h>
54 #include <sys/file2.h>
55 #include <sys/mplock2.h>
56
57 #define EVENT_REGISTER  1
58 #define EVENT_PROCESS   2
59
60 /*
61  * Global token for kqueue subsystem
62  */
63 #if 0
64 struct lwkt_token kq_token = LWKT_TOKEN_INITIALIZER(kq_token);
65 SYSCTL_LONG(_lwkt, OID_AUTO, kq_collisions,
66     CTLFLAG_RW, &kq_token.t_collisions, 0,
67     "Collision counter of kq_token");
68 #endif
69
70 MALLOC_DEFINE(M_KQUEUE, "kqueue", "memory for kqueue system");
71
72 struct kevent_copyin_args {
73         struct kevent_args      *ka;
74         int                     pchanges;
75 };
76
77 static int      kqueue_scan(struct kqueue *kq, struct kevent *kevp, int count,
78                     struct knote *marker);
79 static int      kqueue_read(struct file *fp, struct uio *uio,
80                     struct ucred *cred, int flags);
81 static int      kqueue_write(struct file *fp, struct uio *uio,
82                     struct ucred *cred, int flags);
83 static int      kqueue_ioctl(struct file *fp, u_long com, caddr_t data,
84                     struct ucred *cred, struct sysmsg *msg);
85 static int      kqueue_kqfilter(struct file *fp, struct knote *kn);
86 static int      kqueue_stat(struct file *fp, struct stat *st,
87                     struct ucred *cred);
88 static int      kqueue_close(struct file *fp);
89 static void     kqueue_wakeup(struct kqueue *kq);
90 static int      filter_attach(struct knote *kn);
91 static int      filter_event(struct knote *kn, long hint);
92
93 /*
94  * MPSAFE
95  */
96 static struct fileops kqueueops = {
97         .fo_read = kqueue_read,
98         .fo_write = kqueue_write,
99         .fo_ioctl = kqueue_ioctl,
100         .fo_kqfilter = kqueue_kqfilter,
101         .fo_stat = kqueue_stat,
102         .fo_close = kqueue_close,
103         .fo_shutdown = nofo_shutdown
104 };
105
106 static void     knote_attach(struct knote *kn);
107 static void     knote_drop(struct knote *kn);
108 static void     knote_detach_and_drop(struct knote *kn);
109 static void     knote_enqueue(struct knote *kn);
110 static void     knote_dequeue(struct knote *kn);
111 static struct   knote *knote_alloc(void);
112 static void     knote_free(struct knote *kn);
113
114 static void     filt_kqdetach(struct knote *kn);
115 static int      filt_kqueue(struct knote *kn, long hint);
116 static int      filt_procattach(struct knote *kn);
117 static void     filt_procdetach(struct knote *kn);
118 static int      filt_proc(struct knote *kn, long hint);
119 static int      filt_fileattach(struct knote *kn);
120 static void     filt_timerexpire(void *knx);
121 static int      filt_timerattach(struct knote *kn);
122 static void     filt_timerdetach(struct knote *kn);
123 static int      filt_timer(struct knote *kn, long hint);
124 static int      filt_userattach(struct knote *kn);
125 static void     filt_userdetach(struct knote *kn);
126 static int      filt_user(struct knote *kn, long hint);
127 static void     filt_usertouch(struct knote *kn, struct kevent *kev,
128                                 u_long type);
129
130 static struct filterops file_filtops =
131         { FILTEROP_ISFD | FILTEROP_MPSAFE, filt_fileattach, NULL, NULL };
132 static struct filterops kqread_filtops =
133         { FILTEROP_ISFD | FILTEROP_MPSAFE, NULL, filt_kqdetach, filt_kqueue };
134 static struct filterops proc_filtops =
135         { 0, filt_procattach, filt_procdetach, filt_proc };
136 static struct filterops timer_filtops =
137         { FILTEROP_MPSAFE, filt_timerattach, filt_timerdetach, filt_timer };
138 static struct filterops user_filtops =
139         { FILTEROP_MPSAFE, filt_userattach, filt_userdetach, filt_user };
140
141 static int              kq_ncallouts = 0;
142 static int              kq_calloutmax = (4 * 1024);
143 SYSCTL_INT(_kern, OID_AUTO, kq_calloutmax, CTLFLAG_RW,
144     &kq_calloutmax, 0, "Maximum number of callouts allocated for kqueue");
145 static int              kq_checkloop = 1000000;
146 SYSCTL_INT(_kern, OID_AUTO, kq_checkloop, CTLFLAG_RW,
147     &kq_checkloop, 0, "Maximum number of loops for kqueue scan");
148
149 #define KNOTE_ACTIVATE(kn) do {                                         \
150         kn->kn_status |= KN_ACTIVE;                                     \
151         if ((kn->kn_status & (KN_QUEUED | KN_DISABLED)) == 0)           \
152                 knote_enqueue(kn);                                      \
153 } while(0)
154
155 #define KN_HASHSIZE             64              /* XXX should be tunable */
156 #define KN_HASH(val, mask)      (((val) ^ (val >> 8)) & (mask))
157
158 extern struct filterops aio_filtops;
159 extern struct filterops sig_filtops;
160
161 /*
162  * Table for for all system-defined filters.
163  */
164 static struct filterops *sysfilt_ops[] = {
165         &file_filtops,                  /* EVFILT_READ */
166         &file_filtops,                  /* EVFILT_WRITE */
167         &aio_filtops,                   /* EVFILT_AIO */
168         &file_filtops,                  /* EVFILT_VNODE */
169         &proc_filtops,                  /* EVFILT_PROC */
170         &sig_filtops,                   /* EVFILT_SIGNAL */
171         &timer_filtops,                 /* EVFILT_TIMER */
172         &file_filtops,                  /* EVFILT_EXCEPT */
173         &user_filtops,                  /* EVFILT_USER */
174 };
175
176 static int
177 filt_fileattach(struct knote *kn)
178 {
179         return (fo_kqfilter(kn->kn_fp, kn));
180 }
181
182 /*
183  * MPSAFE
184  */
185 static int
186 kqueue_kqfilter(struct file *fp, struct knote *kn)
187 {
188         struct kqueue *kq = (struct kqueue *)kn->kn_fp->f_data;
189
190         if (kn->kn_filter != EVFILT_READ)
191                 return (EOPNOTSUPP);
192
193         kn->kn_fop = &kqread_filtops;
194         knote_insert(&kq->kq_kqinfo.ki_note, kn);
195         return (0);
196 }
197
198 static void
199 filt_kqdetach(struct knote *kn)
200 {
201         struct kqueue *kq = (struct kqueue *)kn->kn_fp->f_data;
202
203         knote_remove(&kq->kq_kqinfo.ki_note, kn);
204 }
205
206 /*ARGSUSED*/
207 static int
208 filt_kqueue(struct knote *kn, long hint)
209 {
210         struct kqueue *kq = (struct kqueue *)kn->kn_fp->f_data;
211
212         kn->kn_data = kq->kq_count;
213         return (kn->kn_data > 0);
214 }
215
216 static int
217 filt_procattach(struct knote *kn)
218 {
219         struct proc *p;
220         int immediate;
221
222         immediate = 0;
223         p = pfind(kn->kn_id);
224         if (p == NULL && (kn->kn_sfflags & NOTE_EXIT)) {
225                 p = zpfind(kn->kn_id);
226                 immediate = 1;
227         }
228         if (p == NULL) {
229                 return (ESRCH);
230         }
231         if (!PRISON_CHECK(curthread->td_ucred, p->p_ucred)) {
232                 if (p)
233                         PRELE(p);
234                 return (EACCES);
235         }
236
237         lwkt_gettoken(&p->p_token);
238         kn->kn_ptr.p_proc = p;
239         kn->kn_flags |= EV_CLEAR;               /* automatically set */
240
241         /*
242          * internal flag indicating registration done by kernel
243          */
244         if (kn->kn_flags & EV_FLAG1) {
245                 kn->kn_data = kn->kn_sdata;             /* ppid */
246                 kn->kn_fflags = NOTE_CHILD;
247                 kn->kn_flags &= ~EV_FLAG1;
248         }
249
250         knote_insert(&p->p_klist, kn);
251
252         /*
253          * Immediately activate any exit notes if the target process is a
254          * zombie.  This is necessary to handle the case where the target
255          * process, e.g. a child, dies before the kevent is negistered.
256          */
257         if (immediate && filt_proc(kn, NOTE_EXIT))
258                 KNOTE_ACTIVATE(kn);
259         lwkt_reltoken(&p->p_token);
260         PRELE(p);
261
262         return (0);
263 }
264
265 /*
266  * The knote may be attached to a different process, which may exit,
267  * leaving nothing for the knote to be attached to.  So when the process
268  * exits, the knote is marked as DETACHED and also flagged as ONESHOT so
269  * it will be deleted when read out.  However, as part of the knote deletion,
270  * this routine is called, so a check is needed to avoid actually performing
271  * a detach, because the original process does not exist any more.
272  */
273 static void
274 filt_procdetach(struct knote *kn)
275 {
276         struct proc *p;
277
278         if (kn->kn_status & KN_DETACHED)
279                 return;
280         p = kn->kn_ptr.p_proc;
281         knote_remove(&p->p_klist, kn);
282 }
283
284 static int
285 filt_proc(struct knote *kn, long hint)
286 {
287         u_int event;
288
289         /*
290          * mask off extra data
291          */
292         event = (u_int)hint & NOTE_PCTRLMASK;
293
294         /*
295          * if the user is interested in this event, record it.
296          */
297         if (kn->kn_sfflags & event)
298                 kn->kn_fflags |= event;
299
300         /*
301          * Process is gone, so flag the event as finished.  Detach the
302          * knote from the process now because the process will be poof,
303          * gone later on.
304          */
305         if (event == NOTE_EXIT) {
306                 struct proc *p = kn->kn_ptr.p_proc;
307                 if ((kn->kn_status & KN_DETACHED) == 0) {
308                         PHOLD(p);
309                         knote_remove(&p->p_klist, kn);
310                         kn->kn_status |= KN_DETACHED;
311                         kn->kn_data = p->p_xstat;
312                         kn->kn_ptr.p_proc = NULL;
313                         PRELE(p);
314                 }
315                 kn->kn_flags |= (EV_EOF | EV_NODATA | EV_ONESHOT); 
316                 return (1);
317         }
318
319         /*
320          * process forked, and user wants to track the new process,
321          * so attach a new knote to it, and immediately report an
322          * event with the parent's pid.
323          */
324         if ((event == NOTE_FORK) && (kn->kn_sfflags & NOTE_TRACK)) {
325                 struct kevent kev;
326                 int error;
327
328                 /*
329                  * register knote with new process.
330                  */
331                 kev.ident = hint & NOTE_PDATAMASK;      /* pid */
332                 kev.filter = kn->kn_filter;
333                 kev.flags = kn->kn_flags | EV_ADD | EV_ENABLE | EV_FLAG1;
334                 kev.fflags = kn->kn_sfflags;
335                 kev.data = kn->kn_id;                   /* parent */
336                 kev.udata = kn->kn_kevent.udata;        /* preserve udata */
337                 error = kqueue_register(kn->kn_kq, &kev);
338                 if (error)
339                         kn->kn_fflags |= NOTE_TRACKERR;
340         }
341
342         return (kn->kn_fflags != 0);
343 }
344
345 /*
346  * The callout interlocks with callout_terminate() but can still
347  * race a deletion so if KN_DELETING is set we just don't touch
348  * the knote.
349  */
350 static void
351 filt_timerexpire(void *knx)
352 {
353         struct lwkt_token *tok;
354         struct knote *kn = knx;
355         struct callout *calloutp;
356         struct timeval tv;
357         int tticks;
358
359         tok = lwkt_token_pool_lookup(kn->kn_kq);
360         lwkt_gettoken(tok);
361         if ((kn->kn_status & KN_DELETING) == 0) {
362                 kn->kn_data++;
363                 KNOTE_ACTIVATE(kn);
364
365                 if ((kn->kn_flags & EV_ONESHOT) == 0) {
366                         tv.tv_sec = kn->kn_sdata / 1000;
367                         tv.tv_usec = (kn->kn_sdata % 1000) * 1000;
368                         tticks = tvtohz_high(&tv);
369                         calloutp = (struct callout *)kn->kn_hook;
370                         callout_reset(calloutp, tticks, filt_timerexpire, kn);
371                 }
372         }
373         lwkt_reltoken(tok);
374 }
375
376 /*
377  * data contains amount of time to sleep, in milliseconds
378  */ 
379 static int
380 filt_timerattach(struct knote *kn)
381 {
382         struct callout *calloutp;
383         struct timeval tv;
384         int tticks;
385         int prev_ncallouts;
386
387         prev_ncallouts = atomic_fetchadd_int(&kq_ncallouts, 1);
388         if (prev_ncallouts >= kq_calloutmax) {
389                 atomic_subtract_int(&kq_ncallouts, 1);
390                 kn->kn_hook = NULL;
391                 return (ENOMEM);
392         }
393
394         tv.tv_sec = kn->kn_sdata / 1000;
395         tv.tv_usec = (kn->kn_sdata % 1000) * 1000;
396         tticks = tvtohz_high(&tv);
397
398         kn->kn_flags |= EV_CLEAR;               /* automatically set */
399         calloutp = kmalloc(sizeof(*calloutp), M_KQUEUE, M_WAITOK);
400         callout_init_mp(calloutp);
401         kn->kn_hook = (caddr_t)calloutp;
402         callout_reset(calloutp, tticks, filt_timerexpire, kn);
403
404         return (0);
405 }
406
407 /*
408  * This function is called with the knote flagged locked but it is
409  * still possible to race a callout event due to the callback blocking.
410  * We must call callout_terminate() instead of callout_stop() to deal
411  * with the race.
412  */
413 static void
414 filt_timerdetach(struct knote *kn)
415 {
416         struct callout *calloutp;
417
418         calloutp = (struct callout *)kn->kn_hook;
419         callout_terminate(calloutp);
420         kfree(calloutp, M_KQUEUE);
421         atomic_subtract_int(&kq_ncallouts, 1);
422 }
423
424 static int
425 filt_timer(struct knote *kn, long hint)
426 {
427
428         return (kn->kn_data != 0);
429 }
430
431 /*
432  * EVFILT_USER
433  */
434 static int
435 filt_userattach(struct knote *kn)
436 {
437         kn->kn_hook = NULL;
438         if (kn->kn_fflags & NOTE_TRIGGER)
439                 kn->kn_ptr.hookid = 1;
440         else
441                 kn->kn_ptr.hookid = 0;
442         return 0;
443 }
444
445 static void
446 filt_userdetach(struct knote *kn)
447 {
448         /* nothing to do */
449 }
450
451 static int
452 filt_user(struct knote *kn, long hint)
453 {
454         return (kn->kn_ptr.hookid);
455 }
456
457 static void
458 filt_usertouch(struct knote *kn, struct kevent *kev, u_long type)
459 {
460         u_int ffctrl;
461
462         switch (type) {
463         case EVENT_REGISTER:
464                 if (kev->fflags & NOTE_TRIGGER)
465                         kn->kn_ptr.hookid = 1;
466
467                 ffctrl = kev->fflags & NOTE_FFCTRLMASK;
468                 kev->fflags &= NOTE_FFLAGSMASK;
469                 switch (ffctrl) {
470                 case NOTE_FFNOP:
471                         break;
472
473                 case NOTE_FFAND:
474                         kn->kn_sfflags &= kev->fflags;
475                         break;
476
477                 case NOTE_FFOR:
478                         kn->kn_sfflags |= kev->fflags;
479                         break;
480
481                 case NOTE_FFCOPY:
482                         kn->kn_sfflags = kev->fflags;
483                         break;
484
485                 default:
486                         /* XXX Return error? */
487                         break;
488                 }
489                 kn->kn_sdata = kev->data;
490
491                 /*
492                  * This is not the correct use of EV_CLEAR in an event
493                  * modification, it should have been passed as a NOTE instead.
494                  * But we need to maintain compatibility with Apple & FreeBSD.
495                  *
496                  * Note however that EV_CLEAR can still be used when doing
497                  * the initial registration of the event and works as expected
498                  * (clears the event on reception).
499                  */
500                 if (kev->flags & EV_CLEAR) {
501                         kn->kn_ptr.hookid = 0;
502                         kn->kn_data = 0;
503                         kn->kn_fflags = 0;
504                 }
505                 break;
506
507         case EVENT_PROCESS:
508                 *kev = kn->kn_kevent;
509                 kev->fflags = kn->kn_sfflags;
510                 kev->data = kn->kn_sdata;
511                 if (kn->kn_flags & EV_CLEAR) {
512                         kn->kn_ptr.hookid = 0;
513                         /* kn_data, kn_fflags handled by parent */
514                 }
515                 break;
516
517         default:
518                 panic("filt_usertouch() - invalid type (%ld)", type);
519                 break;
520         }
521 }
522
523 /*
524  * Acquire a knote, return non-zero on success, 0 on failure.
525  *
526  * If we cannot acquire the knote we sleep and return 0.  The knote
527  * may be stale on return in this case and the caller must restart
528  * whatever loop they are in.
529  *
530  * Related kq token must be held.
531  */
532 static __inline int
533 knote_acquire(struct knote *kn)
534 {
535         if (kn->kn_status & KN_PROCESSING) {
536                 kn->kn_status |= KN_WAITING | KN_REPROCESS;
537                 tsleep(kn, 0, "kqepts", hz);
538                 /* knote may be stale now */
539                 return(0);
540         }
541         kn->kn_status |= KN_PROCESSING;
542         return(1);
543 }
544
545 /*
546  * Release an acquired knote, clearing KN_PROCESSING and handling any
547  * KN_REPROCESS events.
548  *
549  * Caller must be holding the related kq token
550  *
551  * Non-zero is returned if the knote is destroyed or detached.
552  */
553 static __inline int
554 knote_release(struct knote *kn)
555 {
556         while (kn->kn_status & KN_REPROCESS) {
557                 kn->kn_status &= ~KN_REPROCESS;
558                 if (kn->kn_status & KN_WAITING) {
559                         kn->kn_status &= ~KN_WAITING;
560                         wakeup(kn);
561                 }
562                 if (kn->kn_status & KN_DELETING) {
563                         knote_detach_and_drop(kn);
564                         return(1);
565                         /* NOT REACHED */
566                 }
567                 if (filter_event(kn, 0))
568                         KNOTE_ACTIVATE(kn);
569         }
570         kn->kn_status &= ~KN_PROCESSING;
571         if (kn->kn_status & KN_DETACHED)
572                 return(1);
573         else
574                 return(0);
575 }
576
577 /*
578  * Initialize a kqueue.
579  *
580  * NOTE: The lwp/proc code initializes a kqueue for select/poll ops.
581  *
582  * MPSAFE
583  */
584 void
585 kqueue_init(struct kqueue *kq, struct filedesc *fdp)
586 {
587         TAILQ_INIT(&kq->kq_knpend);
588         TAILQ_INIT(&kq->kq_knlist);
589         kq->kq_count = 0;
590         kq->kq_fdp = fdp;
591         SLIST_INIT(&kq->kq_kqinfo.ki_note);
592 }
593
594 /*
595  * Terminate a kqueue.  Freeing the actual kq itself is left up to the
596  * caller (it might be embedded in a lwp so we don't do it here).
597  *
598  * The kq's knlist must be completely eradicated so block on any
599  * processing races.
600  */
601 void
602 kqueue_terminate(struct kqueue *kq)
603 {
604         struct lwkt_token *tok;
605         struct knote *kn;
606
607         tok = lwkt_token_pool_lookup(kq);
608         lwkt_gettoken(tok);
609         while ((kn = TAILQ_FIRST(&kq->kq_knlist)) != NULL) {
610                 if (knote_acquire(kn))
611                         knote_detach_and_drop(kn);
612         }
613         if (kq->kq_knhash) {
614                 hashdestroy(kq->kq_knhash, M_KQUEUE, kq->kq_knhashmask);
615                 kq->kq_knhash = NULL;
616                 kq->kq_knhashmask = 0;
617         }
618         lwkt_reltoken(tok);
619 }
620
621 /*
622  * MPSAFE
623  */
624 int
625 sys_kqueue(struct kqueue_args *uap)
626 {
627         struct thread *td = curthread;
628         struct kqueue *kq;
629         struct file *fp;
630         int fd, error;
631
632         error = falloc(td->td_lwp, &fp, &fd);
633         if (error)
634                 return (error);
635         fp->f_flag = FREAD | FWRITE;
636         fp->f_type = DTYPE_KQUEUE;
637         fp->f_ops = &kqueueops;
638
639         kq = kmalloc(sizeof(struct kqueue), M_KQUEUE, M_WAITOK | M_ZERO);
640         kqueue_init(kq, td->td_proc->p_fd);
641         fp->f_data = kq;
642
643         fsetfd(kq->kq_fdp, fp, fd);
644         uap->sysmsg_result = fd;
645         fdrop(fp);
646         return (error);
647 }
648
649 /*
650  * Copy 'count' items into the destination list pointed to by uap->eventlist.
651  */
652 static int
653 kevent_copyout(void *arg, struct kevent *kevp, int count, int *res)
654 {
655         struct kevent_copyin_args *kap;
656         int error;
657
658         kap = (struct kevent_copyin_args *)arg;
659
660         error = copyout(kevp, kap->ka->eventlist, count * sizeof(*kevp));
661         if (error == 0) {
662                 kap->ka->eventlist += count;
663                 *res += count;
664         } else {
665                 *res = -1;
666         }
667
668         return (error);
669 }
670
671 /*
672  * Copy at most 'max' items from the list pointed to by kap->changelist,
673  * return number of items in 'events'.
674  */
675 static int
676 kevent_copyin(void *arg, struct kevent *kevp, int max, int *events)
677 {
678         struct kevent_copyin_args *kap;
679         int error, count;
680
681         kap = (struct kevent_copyin_args *)arg;
682
683         count = min(kap->ka->nchanges - kap->pchanges, max);
684         error = copyin(kap->ka->changelist, kevp, count * sizeof *kevp);
685         if (error == 0) {
686                 kap->ka->changelist += count;
687                 kap->pchanges += count;
688                 *events = count;
689         }
690
691         return (error);
692 }
693
694 /*
695  * MPSAFE
696  */
697 int
698 kern_kevent(struct kqueue *kq, int nevents, int *res, void *uap,
699             k_copyin_fn kevent_copyinfn, k_copyout_fn kevent_copyoutfn,
700             struct timespec *tsp_in)
701 {
702         struct kevent *kevp;
703         struct timespec *tsp, ats;
704         int i, n, total, error, nerrors = 0;
705         int lres;
706         int limit = kq_checkloop;
707         struct kevent kev[KQ_NEVENTS];
708         struct knote marker;
709         struct lwkt_token *tok;
710
711         if (tsp_in == NULL || tsp_in->tv_sec || tsp_in->tv_nsec)
712                 atomic_set_int(&curthread->td_mpflags, TDF_MP_BATCH_DEMARC);
713
714         tsp = tsp_in;
715         *res = 0;
716
717         for (;;) {
718                 n = 0;
719                 error = kevent_copyinfn(uap, kev, KQ_NEVENTS, &n);
720                 if (error)
721                         return error;
722                 if (n == 0)
723                         break;
724                 for (i = 0; i < n; i++) {
725                         kevp = &kev[i];
726                         kevp->flags &= ~EV_SYSFLAGS;
727                         error = kqueue_register(kq, kevp);
728
729                         /*
730                          * If a registration returns an error we
731                          * immediately post the error.  The kevent()
732                          * call itself will fail with the error if
733                          * no space is available for posting.
734                          *
735                          * Such errors normally bypass the timeout/blocking
736                          * code.  However, if the copyoutfn function refuses
737                          * to post the error (see sys_poll()), then we
738                          * ignore it too.
739                          */
740                         if (error || (kevp->flags & EV_RECEIPT)) {
741                                 kevp->flags = EV_ERROR;
742                                 kevp->data = error;
743                                 lres = *res;
744                                 kevent_copyoutfn(uap, kevp, 1, res);
745                                 if (*res < 0) {
746                                         return error;
747                                 } else if (lres != *res) {
748                                         nevents--;
749                                         nerrors++;
750                                 }
751                         }
752                 }
753         }
754         if (nerrors)
755                 return 0;
756
757         /*
758          * Acquire/wait for events - setup timeout
759          */
760         if (tsp != NULL) {
761                 if (tsp->tv_sec || tsp->tv_nsec) {
762                         getnanouptime(&ats);
763                         timespecadd(tsp, &ats);         /* tsp = target time */
764                 }
765         }
766
767         /*
768          * Loop as required.
769          *
770          * Collect as many events as we can. Sleeping on successive
771          * loops is disabled if copyoutfn has incremented (*res).
772          *
773          * The loop stops if an error occurs, all events have been
774          * scanned (the marker has been reached), or fewer than the
775          * maximum number of events is found.
776          *
777          * The copyoutfn function does not have to increment (*res) in
778          * order for the loop to continue.
779          *
780          * NOTE: doselect() usually passes 0x7FFFFFFF for nevents.
781          */
782         total = 0;
783         error = 0;
784         marker.kn_filter = EVFILT_MARKER;
785         marker.kn_status = KN_PROCESSING;
786         tok = lwkt_token_pool_lookup(kq);
787         lwkt_gettoken(tok);
788         TAILQ_INSERT_TAIL(&kq->kq_knpend, &marker, kn_tqe);
789         lwkt_reltoken(tok);
790         while ((n = nevents - total) > 0) {
791                 if (n > KQ_NEVENTS)
792                         n = KQ_NEVENTS;
793
794                 /*
795                  * If no events are pending sleep until timeout (if any)
796                  * or an event occurs.
797                  *
798                  * After the sleep completes the marker is moved to the
799                  * end of the list, making any received events available
800                  * to our scan.
801                  */
802                 if (kq->kq_count == 0 && *res == 0) {
803                         int timeout;
804
805                         if (tsp == NULL) {
806                                 timeout = 0;
807                         } else if (tsp->tv_sec == 0 && tsp->tv_nsec == 0) {
808                                 error = EWOULDBLOCK;
809                                 break;
810                         } else {
811                                 struct timespec atx = *tsp;
812
813                                 getnanouptime(&ats);
814                                 timespecsub(&atx, &ats);
815                                 if (atx.tv_sec < 0) {
816                                         error = EWOULDBLOCK;
817                                         break;
818                                 } else {
819                                         timeout = atx.tv_sec > 24 * 60 * 60 ?
820                                             24 * 60 * 60 * hz :
821                                             tstohz_high(&atx);
822                                 }
823                         }
824
825                         lwkt_gettoken(tok);
826                         if (kq->kq_count == 0) {
827                                 kq->kq_state |= KQ_SLEEP;
828                                 error = tsleep(kq, PCATCH, "kqread", timeout);
829
830                                 /* don't restart after signals... */
831                                 if (error == ERESTART)
832                                         error = EINTR;
833                                 if (error) {
834                                         lwkt_reltoken(tok);
835                                         break;
836                                 }
837
838                                 TAILQ_REMOVE(&kq->kq_knpend, &marker, kn_tqe);
839                                 TAILQ_INSERT_TAIL(&kq->kq_knpend, &marker,
840                                     kn_tqe);
841                         }
842                         lwkt_reltoken(tok);
843                 }
844
845                 /*
846                  * Process all received events
847                  * Account for all non-spurious events in our total
848                  */
849                 i = kqueue_scan(kq, kev, n, &marker);
850                 if (i) {
851                         lres = *res;
852                         error = kevent_copyoutfn(uap, kev, i, res);
853                         total += *res - lres;
854                         if (error)
855                                 break;
856                 }
857                 if (limit && --limit == 0)
858                         panic("kqueue: checkloop failed i=%d", i);
859
860                 /*
861                  * Normally when fewer events are returned than requested
862                  * we can stop.  However, if only spurious events were
863                  * collected the copyout will not bump (*res) and we have
864                  * to continue.
865                  */
866                 if (i < n && *res)
867                         break;
868
869                 /*
870                  * Deal with an edge case where spurious events can cause
871                  * a loop to occur without moving the marker.  This can
872                  * prevent kqueue_scan() from picking up new events which
873                  * race us.  We must be sure to move the marker for this
874                  * case.
875                  *
876                  * NOTE: We do not want to move the marker if events
877                  *       were scanned because normal kqueue operations
878                  *       may reactivate events.  Moving the marker in
879                  *       that case could result in duplicates for the
880                  *       same event.
881                  */
882                 if (i == 0) {
883                         lwkt_gettoken(tok);
884                         TAILQ_REMOVE(&kq->kq_knpend, &marker, kn_tqe);
885                         TAILQ_INSERT_TAIL(&kq->kq_knpend, &marker, kn_tqe);
886                         lwkt_reltoken(tok);
887                 }
888         }
889         lwkt_gettoken(tok);
890         TAILQ_REMOVE(&kq->kq_knpend, &marker, kn_tqe);
891         lwkt_reltoken(tok);
892
893         /* Timeouts do not return EWOULDBLOCK. */
894         if (error == EWOULDBLOCK)
895                 error = 0;
896         return error;
897 }
898
899 /*
900  * MPALMOSTSAFE
901  */
902 int
903 sys_kevent(struct kevent_args *uap)
904 {
905         struct thread *td = curthread;
906         struct proc *p = td->td_proc;
907         struct timespec ts, *tsp;
908         struct kqueue *kq;
909         struct file *fp = NULL;
910         struct kevent_copyin_args *kap, ka;
911         int error;
912
913         if (uap->timeout) {
914                 error = copyin(uap->timeout, &ts, sizeof(ts));
915                 if (error)
916                         return (error);
917                 tsp = &ts;
918         } else {
919                 tsp = NULL;
920         }
921         fp = holdfp(p->p_fd, uap->fd, -1);
922         if (fp == NULL)
923                 return (EBADF);
924         if (fp->f_type != DTYPE_KQUEUE) {
925                 fdrop(fp);
926                 return (EBADF);
927         }
928
929         kq = (struct kqueue *)fp->f_data;
930
931         kap = &ka;
932         kap->ka = uap;
933         kap->pchanges = 0;
934
935         error = kern_kevent(kq, uap->nevents, &uap->sysmsg_result, kap,
936                             kevent_copyin, kevent_copyout, tsp);
937
938         fdrop(fp);
939
940         return (error);
941 }
942
943 int
944 kqueue_register(struct kqueue *kq, struct kevent *kev)
945 {
946         struct lwkt_token *tok;
947         struct filedesc *fdp = kq->kq_fdp;
948         struct filterops *fops;
949         struct file *fp = NULL;
950         struct knote *kn = NULL;
951         int error = 0;
952
953         if (kev->filter < 0) {
954                 if (kev->filter + EVFILT_SYSCOUNT < 0)
955                         return (EINVAL);
956                 fops = sysfilt_ops[~kev->filter];       /* to 0-base index */
957         } else {
958                 /*
959                  * XXX
960                  * filter attach routine is responsible for insuring that
961                  * the identifier can be attached to it.
962                  */
963                 return (EINVAL);
964         }
965
966         tok = lwkt_token_pool_lookup(kq);
967         lwkt_gettoken(tok);
968         if (fops->f_flags & FILTEROP_ISFD) {
969                 /* validate descriptor */
970                 fp = holdfp(fdp, kev->ident, -1);
971                 if (fp == NULL) {
972                         lwkt_reltoken(tok);
973                         return (EBADF);
974                 }
975                 lwkt_getpooltoken(&fp->f_klist);
976 again1:
977                 SLIST_FOREACH(kn, &fp->f_klist, kn_link) {
978                         if (kn->kn_kq == kq &&
979                             kn->kn_filter == kev->filter &&
980                             kn->kn_id == kev->ident) {
981                                 if (knote_acquire(kn) == 0)
982                                         goto again1;
983                                 break;
984                         }
985                 }
986                 lwkt_relpooltoken(&fp->f_klist);
987         } else {
988                 if (kq->kq_knhashmask) {
989                         struct klist *list;
990                         
991                         list = &kq->kq_knhash[
992                             KN_HASH((u_long)kev->ident, kq->kq_knhashmask)];
993                         lwkt_getpooltoken(list);
994 again2:
995                         SLIST_FOREACH(kn, list, kn_link) {
996                                 if (kn->kn_id == kev->ident &&
997                                     kn->kn_filter == kev->filter) {
998                                         if (knote_acquire(kn) == 0)
999                                                 goto again2;
1000                                         break;
1001                                 }
1002                         }
1003                         lwkt_relpooltoken(list);
1004                 }
1005         }
1006
1007         /*
1008          * NOTE: At this point if kn is non-NULL we will have acquired
1009          *       it and set KN_PROCESSING.
1010          */
1011         if (kn == NULL && ((kev->flags & EV_ADD) == 0)) {
1012                 error = ENOENT;
1013                 goto done;
1014         }
1015
1016         /*
1017          * kn now contains the matching knote, or NULL if no match
1018          */
1019         if (kev->flags & EV_ADD) {
1020                 if (kn == NULL) {
1021                         kn = knote_alloc();
1022                         kn->kn_fp = fp;
1023                         kn->kn_kq = kq;
1024                         kn->kn_fop = fops;
1025
1026                         /*
1027                          * apply reference count to knote structure, and
1028                          * do not release it at the end of this routine.
1029                          */
1030                         fp = NULL;
1031
1032                         kn->kn_sfflags = kev->fflags;
1033                         kn->kn_sdata = kev->data;
1034                         kev->fflags = 0;
1035                         kev->data = 0;
1036                         kn->kn_kevent = *kev;
1037
1038                         /*
1039                          * KN_PROCESSING prevents the knote from getting
1040                          * ripped out from under us while we are trying
1041                          * to attach it, in case the attach blocks.
1042                          */
1043                         kn->kn_status = KN_PROCESSING;
1044                         knote_attach(kn);
1045                         if ((error = filter_attach(kn)) != 0) {
1046                                 kn->kn_status |= KN_DELETING | KN_REPROCESS;
1047                                 knote_drop(kn);
1048                                 goto done;
1049                         }
1050
1051                         /*
1052                          * Interlock against close races which either tried
1053                          * to remove our knote while we were blocked or missed
1054                          * it entirely prior to our attachment.  We do not
1055                          * want to end up with a knote on a closed descriptor.
1056                          */
1057                         if ((fops->f_flags & FILTEROP_ISFD) &&
1058                             checkfdclosed(fdp, kev->ident, kn->kn_fp)) {
1059                                 kn->kn_status |= KN_DELETING | KN_REPROCESS;
1060                         }
1061                 } else {
1062                         /*
1063                          * The user may change some filter values after the
1064                          * initial EV_ADD, but doing so will not reset any 
1065                          * filter which have already been triggered.
1066                          */
1067                         KKASSERT(kn->kn_status & KN_PROCESSING);
1068                         if (fops == &user_filtops) {
1069                                 filt_usertouch(kn, kev, EVENT_REGISTER);
1070                         } else {
1071                                 kn->kn_sfflags = kev->fflags;
1072                                 kn->kn_sdata = kev->data;
1073                                 kn->kn_kevent.udata = kev->udata;
1074                         }
1075                 }
1076
1077                 /*
1078                  * Execute the filter event to immediately activate the
1079                  * knote if necessary.  If reprocessing events are pending
1080                  * due to blocking above we do not run the filter here
1081                  * but instead let knote_release() do it.  Otherwise we
1082                  * might run the filter on a deleted event.
1083                  */
1084                 if ((kn->kn_status & KN_REPROCESS) == 0) {
1085                         if (filter_event(kn, 0))
1086                                 KNOTE_ACTIVATE(kn);
1087                 }
1088         } else if (kev->flags & EV_DELETE) {
1089                 /*
1090                  * Delete the existing knote
1091                  */
1092                 knote_detach_and_drop(kn);
1093                 goto done;
1094         } else {
1095                 /*
1096                  * Modify an existing event.
1097                  *
1098                  * The user may change some filter values after the
1099                  * initial EV_ADD, but doing so will not reset any
1100                  * filter which have already been triggered.
1101                  */
1102                 KKASSERT(kn->kn_status & KN_PROCESSING);
1103                 if (fops == &user_filtops) {
1104                         filt_usertouch(kn, kev, EVENT_REGISTER);
1105                 } else {
1106                         kn->kn_sfflags = kev->fflags;
1107                         kn->kn_sdata = kev->data;
1108                         kn->kn_kevent.udata = kev->udata;
1109                 }
1110
1111                 /*
1112                  * Execute the filter event to immediately activate the
1113                  * knote if necessary.  If reprocessing events are pending
1114                  * due to blocking above we do not run the filter here
1115                  * but instead let knote_release() do it.  Otherwise we
1116                  * might run the filter on a deleted event.
1117                  */
1118                 if ((kn->kn_status & KN_REPROCESS) == 0) {
1119                         if (filter_event(kn, 0))
1120                                 KNOTE_ACTIVATE(kn);
1121                 }
1122         }
1123
1124         /*
1125          * Disablement does not deactivate a knote here.
1126          */
1127         if ((kev->flags & EV_DISABLE) &&
1128             ((kn->kn_status & KN_DISABLED) == 0)) {
1129                 kn->kn_status |= KN_DISABLED;
1130         }
1131
1132         /*
1133          * Re-enablement may have to immediately enqueue an active knote.
1134          */
1135         if ((kev->flags & EV_ENABLE) && (kn->kn_status & KN_DISABLED)) {
1136                 kn->kn_status &= ~KN_DISABLED;
1137                 if ((kn->kn_status & KN_ACTIVE) &&
1138                     ((kn->kn_status & KN_QUEUED) == 0)) {
1139                         knote_enqueue(kn);
1140                 }
1141         }
1142
1143         /*
1144          * Handle any required reprocessing
1145          */
1146         knote_release(kn);
1147         /* kn may be invalid now */
1148
1149 done:
1150         lwkt_reltoken(tok);
1151         if (fp != NULL)
1152                 fdrop(fp);
1153         return (error);
1154 }
1155
1156 /*
1157  * Scan the kqueue, return the number of active events placed in kevp up
1158  * to count.
1159  *
1160  * Continuous mode events may get recycled, do not continue scanning past
1161  * marker unless no events have been collected.
1162  */
1163 static int
1164 kqueue_scan(struct kqueue *kq, struct kevent *kevp, int count,
1165             struct knote *marker)
1166 {
1167         struct knote *kn, local_marker;
1168         int total;
1169
1170         total = 0;
1171         local_marker.kn_filter = EVFILT_MARKER;
1172         local_marker.kn_status = KN_PROCESSING;
1173
1174         lwkt_getpooltoken(kq);
1175
1176         /*
1177          * Collect events.
1178          */
1179         TAILQ_INSERT_HEAD(&kq->kq_knpend, &local_marker, kn_tqe);
1180         while (count) {
1181                 kn = TAILQ_NEXT(&local_marker, kn_tqe);
1182                 if (kn->kn_filter == EVFILT_MARKER) {
1183                         /* Marker reached, we are done */
1184                         if (kn == marker)
1185                                 break;
1186
1187                         /* Move local marker past some other threads marker */
1188                         kn = TAILQ_NEXT(kn, kn_tqe);
1189                         TAILQ_REMOVE(&kq->kq_knpend, &local_marker, kn_tqe);
1190                         TAILQ_INSERT_BEFORE(kn, &local_marker, kn_tqe);
1191                         continue;
1192                 }
1193
1194                 /*
1195                  * We can't skip a knote undergoing processing, otherwise
1196                  * we risk not returning it when the user process expects
1197                  * it should be returned.  Sleep and retry.
1198                  */
1199                 if (knote_acquire(kn) == 0)
1200                         continue;
1201
1202                 /*
1203                  * Remove the event for processing.
1204                  *
1205                  * WARNING!  We must leave KN_QUEUED set to prevent the
1206                  *           event from being KNOTE_ACTIVATE()d while
1207                  *           the queue state is in limbo, in case we
1208                  *           block.
1209                  */
1210                 TAILQ_REMOVE(&kq->kq_knpend, kn, kn_tqe);
1211                 kq->kq_count--;
1212
1213                 /*
1214                  * We have to deal with an extremely important race against
1215                  * file descriptor close()s here.  The file descriptor can
1216                  * disappear MPSAFE, and there is a small window of
1217                  * opportunity between that and the call to knote_fdclose().
1218                  *
1219                  * If we hit that window here while doselect or dopoll is
1220                  * trying to delete a spurious event they will not be able
1221                  * to match up the event against a knote and will go haywire.
1222                  */
1223                 if ((kn->kn_fop->f_flags & FILTEROP_ISFD) &&
1224                     checkfdclosed(kq->kq_fdp, kn->kn_kevent.ident, kn->kn_fp)) {
1225                         kn->kn_status |= KN_DELETING | KN_REPROCESS;
1226                 }
1227
1228                 if (kn->kn_status & KN_DISABLED) {
1229                         /*
1230                          * If disabled we ensure the event is not queued
1231                          * but leave its active bit set.  On re-enablement
1232                          * the event may be immediately triggered.
1233                          */
1234                         kn->kn_status &= ~KN_QUEUED;
1235                 } else if ((kn->kn_flags & EV_ONESHOT) == 0 &&
1236                            (kn->kn_status & KN_DELETING) == 0 &&
1237                            filter_event(kn, 0) == 0) {
1238                         /*
1239                          * If not running in one-shot mode and the event
1240                          * is no longer present we ensure it is removed
1241                          * from the queue and ignore it.
1242                          */
1243                         kn->kn_status &= ~(KN_QUEUED | KN_ACTIVE);
1244                 } else {
1245                         /*
1246                          * Post the event
1247                          */
1248                         if (kn->kn_fop == &user_filtops)
1249                                 filt_usertouch(kn, kevp, EVENT_PROCESS);
1250                         else
1251                                 *kevp = kn->kn_kevent;
1252                         ++kevp;
1253                         ++total;
1254                         --count;
1255
1256                         if (kn->kn_flags & EV_ONESHOT) {
1257                                 kn->kn_status &= ~KN_QUEUED;
1258                                 kn->kn_status |= KN_DELETING | KN_REPROCESS;
1259                         } else {
1260                                 if (kn->kn_flags & (EV_CLEAR | EV_DISPATCH)) {
1261                                         if (kn->kn_flags & EV_CLEAR) {
1262                                                 kn->kn_data = 0;
1263                                                 kn->kn_fflags = 0;
1264                                         }
1265                                         if (kn->kn_flags & EV_DISPATCH) {
1266                                                 kn->kn_status |= KN_DISABLED;
1267                                         }
1268                                         kn->kn_status &= ~(KN_QUEUED |
1269                                                            KN_ACTIVE);
1270                                 } else {
1271                                         TAILQ_INSERT_TAIL(&kq->kq_knpend, kn, kn_tqe);
1272                                         kq->kq_count++;
1273                                 }
1274                         }
1275                 }
1276
1277                 /*
1278                  * Handle any post-processing states
1279                  */
1280                 knote_release(kn);
1281         }
1282         TAILQ_REMOVE(&kq->kq_knpend, &local_marker, kn_tqe);
1283
1284         lwkt_relpooltoken(kq);
1285         return (total);
1286 }
1287
1288 /*
1289  * XXX
1290  * This could be expanded to call kqueue_scan, if desired.
1291  *
1292  * MPSAFE
1293  */
1294 static int
1295 kqueue_read(struct file *fp, struct uio *uio, struct ucred *cred, int flags)
1296 {
1297         return (ENXIO);
1298 }
1299
1300 /*
1301  * MPSAFE
1302  */
1303 static int
1304 kqueue_write(struct file *fp, struct uio *uio, struct ucred *cred, int flags)
1305 {
1306         return (ENXIO);
1307 }
1308
1309 /*
1310  * MPALMOSTSAFE
1311  */
1312 static int
1313 kqueue_ioctl(struct file *fp, u_long com, caddr_t data,
1314              struct ucred *cred, struct sysmsg *msg)
1315 {
1316         struct lwkt_token *tok;
1317         struct kqueue *kq;
1318         int error;
1319
1320         kq = (struct kqueue *)fp->f_data;
1321         tok = lwkt_token_pool_lookup(kq);
1322         lwkt_gettoken(tok);
1323
1324         switch(com) {
1325         case FIOASYNC:
1326                 if (*(int *)data)
1327                         kq->kq_state |= KQ_ASYNC;
1328                 else
1329                         kq->kq_state &= ~KQ_ASYNC;
1330                 error = 0;
1331                 break;
1332         case FIOSETOWN:
1333                 error = fsetown(*(int *)data, &kq->kq_sigio);
1334                 break;
1335         default:
1336                 error = ENOTTY;
1337                 break;
1338         }
1339         lwkt_reltoken(tok);
1340         return (error);
1341 }
1342
1343 /*
1344  * MPSAFE
1345  */
1346 static int
1347 kqueue_stat(struct file *fp, struct stat *st, struct ucred *cred)
1348 {
1349         struct kqueue *kq = (struct kqueue *)fp->f_data;
1350
1351         bzero((void *)st, sizeof(*st));
1352         st->st_size = kq->kq_count;
1353         st->st_blksize = sizeof(struct kevent);
1354         st->st_mode = S_IFIFO;
1355         return (0);
1356 }
1357
1358 /*
1359  * MPSAFE
1360  */
1361 static int
1362 kqueue_close(struct file *fp)
1363 {
1364         struct kqueue *kq = (struct kqueue *)fp->f_data;
1365
1366         kqueue_terminate(kq);
1367
1368         fp->f_data = NULL;
1369         funsetown(&kq->kq_sigio);
1370
1371         kfree(kq, M_KQUEUE);
1372         return (0);
1373 }
1374
1375 static void
1376 kqueue_wakeup(struct kqueue *kq)
1377 {
1378         if (kq->kq_state & KQ_SLEEP) {
1379                 kq->kq_state &= ~KQ_SLEEP;
1380                 wakeup(kq);
1381         }
1382         KNOTE(&kq->kq_kqinfo.ki_note, 0);
1383 }
1384
1385 /*
1386  * Calls filterops f_attach function, acquiring mplock if filter is not
1387  * marked as FILTEROP_MPSAFE.
1388  *
1389  * Caller must be holding the related kq token
1390  */
1391 static int
1392 filter_attach(struct knote *kn)
1393 {
1394         int ret;
1395
1396         if (kn->kn_fop->f_flags & FILTEROP_MPSAFE) {
1397                 ret = kn->kn_fop->f_attach(kn);
1398         } else {
1399                 get_mplock();
1400                 ret = kn->kn_fop->f_attach(kn);
1401                 rel_mplock();
1402         }
1403         return (ret);
1404 }
1405
1406 /*
1407  * Detach the knote and drop it, destroying the knote.
1408  *
1409  * Calls filterops f_detach function, acquiring mplock if filter is not
1410  * marked as FILTEROP_MPSAFE.
1411  *
1412  * Caller must be holding the related kq token
1413  */
1414 static void
1415 knote_detach_and_drop(struct knote *kn)
1416 {
1417         kn->kn_status |= KN_DELETING | KN_REPROCESS;
1418         if (kn->kn_fop->f_flags & FILTEROP_MPSAFE) {
1419                 kn->kn_fop->f_detach(kn);
1420         } else {
1421                 get_mplock();
1422                 kn->kn_fop->f_detach(kn);
1423                 rel_mplock();
1424         }
1425         knote_drop(kn);
1426 }
1427
1428 /*
1429  * Calls filterops f_event function, acquiring mplock if filter is not
1430  * marked as FILTEROP_MPSAFE.
1431  *
1432  * If the knote is in the middle of being created or deleted we cannot
1433  * safely call the filter op.
1434  *
1435  * Caller must be holding the related kq token
1436  */
1437 static int
1438 filter_event(struct knote *kn, long hint)
1439 {
1440         int ret;
1441
1442         if (kn->kn_fop->f_flags & FILTEROP_MPSAFE) {
1443                 ret = kn->kn_fop->f_event(kn, hint);
1444         } else {
1445                 get_mplock();
1446                 ret = kn->kn_fop->f_event(kn, hint);
1447                 rel_mplock();
1448         }
1449         return (ret);
1450 }
1451
1452 /*
1453  * Walk down a list of knotes, activating them if their event has triggered.
1454  *
1455  * If we encounter any knotes which are undergoing processing we just mark
1456  * them for reprocessing and do not try to [re]activate the knote.  However,
1457  * if a hint is being passed we have to wait and that makes things a bit
1458  * sticky.
1459  */
1460 void
1461 knote(struct klist *list, long hint)
1462 {
1463         struct kqueue *kq;
1464         struct knote *kn;
1465         struct knote *kntmp;
1466
1467         lwkt_getpooltoken(list);
1468 restart:
1469         SLIST_FOREACH(kn, list, kn_next) {
1470                 kq = kn->kn_kq;
1471                 lwkt_getpooltoken(kq);
1472
1473                 /* temporary verification hack */
1474                 SLIST_FOREACH(kntmp, list, kn_next) {
1475                         if (kn == kntmp)
1476                                 break;
1477                 }
1478                 if (kn != kntmp || kn->kn_kq != kq) {
1479                         lwkt_relpooltoken(kq);
1480                         goto restart;
1481                 }
1482
1483                 if (kn->kn_status & KN_PROCESSING) {
1484                         /*
1485                          * Someone else is processing the knote, ask the
1486                          * other thread to reprocess it and don't mess
1487                          * with it otherwise.
1488                          */
1489                         if (hint == 0) {
1490                                 kn->kn_status |= KN_REPROCESS;
1491                                 lwkt_relpooltoken(kq);
1492                                 continue;
1493                         }
1494
1495                         /*
1496                          * If the hint is non-zero we have to wait or risk
1497                          * losing the state the caller is trying to update.
1498                          *
1499                          * XXX This is a real problem, certain process
1500                          *     and signal filters will bump kn_data for
1501                          *     already-processed notes more than once if
1502                          *     we restart the list scan.  FIXME.
1503                          */
1504                         kn->kn_status |= KN_WAITING | KN_REPROCESS;
1505                         tsleep(kn, 0, "knotec", hz);
1506                         lwkt_relpooltoken(kq);
1507                         goto restart;
1508                 }
1509
1510                 /*
1511                  * Become the reprocessing master ourselves.
1512                  *
1513                  * If hint is non-zero running the event is mandatory
1514                  * when not deleting so do it whether reprocessing is
1515                  * set or not.
1516                  */
1517                 kn->kn_status |= KN_PROCESSING;
1518                 if ((kn->kn_status & KN_DELETING) == 0) {
1519                         if (filter_event(kn, hint))
1520                                 KNOTE_ACTIVATE(kn);
1521                 }
1522                 if (knote_release(kn)) {
1523                         lwkt_relpooltoken(kq);
1524                         goto restart;
1525                 }
1526                 lwkt_relpooltoken(kq);
1527         }
1528         lwkt_relpooltoken(list);
1529 }
1530
1531 /*
1532  * Insert knote at head of klist.
1533  *
1534  * This function may only be called via a filter function and thus
1535  * kq_token should already be held and marked for processing.
1536  */
1537 void
1538 knote_insert(struct klist *klist, struct knote *kn)
1539 {
1540         lwkt_getpooltoken(klist);
1541         KKASSERT(kn->kn_status & KN_PROCESSING);
1542         SLIST_INSERT_HEAD(klist, kn, kn_next);
1543         lwkt_relpooltoken(klist);
1544 }
1545
1546 /*
1547  * Remove knote from a klist
1548  *
1549  * This function may only be called via a filter function and thus
1550  * kq_token should already be held and marked for processing.
1551  */
1552 void
1553 knote_remove(struct klist *klist, struct knote *kn)
1554 {
1555         lwkt_getpooltoken(klist);
1556         KKASSERT(kn->kn_status & KN_PROCESSING);
1557         SLIST_REMOVE(klist, kn, knote, kn_next);
1558         lwkt_relpooltoken(klist);
1559 }
1560
1561 #if 0
1562 /*
1563  * Remove all knotes from a specified klist
1564  *
1565  * Only called from aio.
1566  */
1567 void
1568 knote_empty(struct klist *list)
1569 {
1570         struct knote *kn;
1571
1572         lwkt_gettoken(&kq_token);
1573         while ((kn = SLIST_FIRST(list)) != NULL) {
1574                 if (knote_acquire(kn))
1575                         knote_detach_and_drop(kn);
1576         }
1577         lwkt_reltoken(&kq_token);
1578 }
1579 #endif
1580
1581 void
1582 knote_assume_knotes(struct kqinfo *src, struct kqinfo *dst,
1583                     struct filterops *ops, void *hook)
1584 {
1585         struct kqueue *kq;
1586         struct knote *kn;
1587
1588         lwkt_getpooltoken(&src->ki_note);
1589         lwkt_getpooltoken(&dst->ki_note);
1590         while ((kn = SLIST_FIRST(&src->ki_note)) != NULL) {
1591                 kq = kn->kn_kq;
1592                 lwkt_getpooltoken(kq);
1593                 if (SLIST_FIRST(&src->ki_note) != kn || kn->kn_kq != kq) {
1594                         lwkt_relpooltoken(kq);
1595                         continue;
1596                 }
1597                 if (knote_acquire(kn)) {
1598                         knote_remove(&src->ki_note, kn);
1599                         kn->kn_fop = ops;
1600                         kn->kn_hook = hook;
1601                         knote_insert(&dst->ki_note, kn);
1602                         knote_release(kn);
1603                         /* kn may be invalid now */
1604                 }
1605                 lwkt_relpooltoken(kq);
1606         }
1607         lwkt_relpooltoken(&dst->ki_note);
1608         lwkt_relpooltoken(&src->ki_note);
1609 }
1610
1611 /*
1612  * Remove all knotes referencing a specified fd
1613  */
1614 void
1615 knote_fdclose(struct file *fp, struct filedesc *fdp, int fd)
1616 {
1617         struct kqueue *kq;
1618         struct knote *kn;
1619         struct knote *kntmp;
1620
1621         lwkt_getpooltoken(&fp->f_klist);
1622 restart:
1623         SLIST_FOREACH(kn, &fp->f_klist, kn_link) {
1624                 if (kn->kn_kq->kq_fdp == fdp && kn->kn_id == fd) {
1625                         kq = kn->kn_kq;
1626                         lwkt_getpooltoken(kq);
1627
1628                         /* temporary verification hack */
1629                         SLIST_FOREACH(kntmp, &fp->f_klist, kn_link) {
1630                                 if (kn == kntmp)
1631                                         break;
1632                         }
1633                         if (kn != kntmp || kn->kn_kq->kq_fdp != fdp ||
1634                             kn->kn_id != fd || kn->kn_kq != kq) {
1635                                 lwkt_relpooltoken(kq);
1636                                 goto restart;
1637                         }
1638                         if (knote_acquire(kn))
1639                                 knote_detach_and_drop(kn);
1640                         lwkt_relpooltoken(kq);
1641                         goto restart;
1642                 }
1643         }
1644         lwkt_relpooltoken(&fp->f_klist);
1645 }
1646
1647 /*
1648  * Low level attach function.
1649  *
1650  * The knote should already be marked for processing.
1651  * Caller must hold the related kq token.
1652  */
1653 static void
1654 knote_attach(struct knote *kn)
1655 {
1656         struct klist *list;
1657         struct kqueue *kq = kn->kn_kq;
1658
1659         if (kn->kn_fop->f_flags & FILTEROP_ISFD) {
1660                 KKASSERT(kn->kn_fp);
1661                 list = &kn->kn_fp->f_klist;
1662         } else {
1663                 if (kq->kq_knhashmask == 0)
1664                         kq->kq_knhash = hashinit(KN_HASHSIZE, M_KQUEUE,
1665                                                  &kq->kq_knhashmask);
1666                 list = &kq->kq_knhash[KN_HASH(kn->kn_id, kq->kq_knhashmask)];
1667         }
1668         lwkt_getpooltoken(list);
1669         SLIST_INSERT_HEAD(list, kn, kn_link);
1670         TAILQ_INSERT_HEAD(&kq->kq_knlist, kn, kn_kqlink);
1671         lwkt_relpooltoken(list);
1672 }
1673
1674 /*
1675  * Low level drop function.
1676  *
1677  * The knote should already be marked for processing.
1678  * Caller must hold the related kq token.
1679  */
1680 static void
1681 knote_drop(struct knote *kn)
1682 {
1683         struct kqueue *kq;
1684         struct klist *list;
1685
1686         kq = kn->kn_kq;
1687
1688         if (kn->kn_fop->f_flags & FILTEROP_ISFD)
1689                 list = &kn->kn_fp->f_klist;
1690         else
1691                 list = &kq->kq_knhash[KN_HASH(kn->kn_id, kq->kq_knhashmask)];
1692
1693         lwkt_getpooltoken(list);
1694         SLIST_REMOVE(list, kn, knote, kn_link);
1695         TAILQ_REMOVE(&kq->kq_knlist, kn, kn_kqlink);
1696         if (kn->kn_status & KN_QUEUED)
1697                 knote_dequeue(kn);
1698         if (kn->kn_fop->f_flags & FILTEROP_ISFD) {
1699                 fdrop(kn->kn_fp);
1700                 kn->kn_fp = NULL;
1701         }
1702         knote_free(kn);
1703         lwkt_relpooltoken(list);
1704 }
1705
1706 /*
1707  * Low level enqueue function.
1708  *
1709  * The knote should already be marked for processing.
1710  * Caller must be holding the kq token
1711  */
1712 static void
1713 knote_enqueue(struct knote *kn)
1714 {
1715         struct kqueue *kq = kn->kn_kq;
1716
1717         KASSERT((kn->kn_status & KN_QUEUED) == 0, ("knote already queued"));
1718         TAILQ_INSERT_TAIL(&kq->kq_knpend, kn, kn_tqe);
1719         kn->kn_status |= KN_QUEUED;
1720         ++kq->kq_count;
1721
1722         /*
1723          * Send SIGIO on request (typically set up as a mailbox signal)
1724          */
1725         if (kq->kq_sigio && (kq->kq_state & KQ_ASYNC) && kq->kq_count == 1)
1726                 pgsigio(kq->kq_sigio, SIGIO, 0);
1727
1728         kqueue_wakeup(kq);
1729 }
1730
1731 /*
1732  * Low level dequeue function.
1733  *
1734  * The knote should already be marked for processing.
1735  * Caller must be holding the kq token
1736  */
1737 static void
1738 knote_dequeue(struct knote *kn)
1739 {
1740         struct kqueue *kq = kn->kn_kq;
1741
1742         KASSERT(kn->kn_status & KN_QUEUED, ("knote not queued"));
1743         TAILQ_REMOVE(&kq->kq_knpend, kn, kn_tqe);
1744         kn->kn_status &= ~KN_QUEUED;
1745         kq->kq_count--;
1746 }
1747
1748 static struct knote *
1749 knote_alloc(void)
1750 {
1751         return kmalloc(sizeof(struct knote), M_KQUEUE, M_WAITOK);
1752 }
1753
1754 static void
1755 knote_free(struct knote *kn)
1756 {
1757         kfree(kn, M_KQUEUE);
1758 }