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