sys/sys/event.h

   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$
  27  */
  28
  29 #ifndef _SYS_EVENT_H_
  30 #define _SYS_EVENT_H_
  31
  32 #include <sys/_types.h>
  33 #include <sys/queue.h>
  34
  35 #define EVFILT_READ             (-1)
  36 #define EVFILT_WRITE            (-2)
  37 #define EVFILT_AIO              (-3)    /* attached to aio requests */
  38 #define EVFILT_VNODE            (-4)    /* attached to vnodes */
  39 #define EVFILT_PROC             (-5)    /* attached to struct proc */
  40 #define EVFILT_SIGNAL           (-6)    /* attached to struct proc */
  41 #define EVFILT_TIMER            (-7)    /* timers */
  42 #define EVFILT_PROCDESC         (-8)    /* attached to process descriptors */
  43 #define EVFILT_FS               (-9)    /* filesystem events */
  44 #define EVFILT_LIO              (-10)   /* attached to lio requests */
  45 #define EVFILT_USER             (-11)   /* User events */
  46 #define EVFILT_SENDFILE         (-12)   /* attached to sendfile requests */
  47 #define EVFILT_EMPTY            (-13)   /* empty send socket buf */
  48 #define EVFILT_SYSCOUNT         13
  49
  50 #define EV_SET(kevp_, a, b, c, d, e, f) do {    \
  51         struct kevent *kevp = (kevp_);          \
  52         (kevp)->ident = (a);                    \
  53         (kevp)->filter = (b);                   \
  54         (kevp)->flags = (c);                    \
  55         (kevp)->fflags = (d);                   \
  56         (kevp)->data = (e);                     \
  57         (kevp)->udata = (f);                    \
  58 } while(0)
  59
  60 struct kevent {
  61         __uintptr_t     ident;          /* identifier for this event */
  62         short           filter;         /* filter for event */
  63         unsigned short  flags;
  64         unsigned int    fflags;
  65         __intptr_t      data;
  66         void            *udata;         /* opaque user data identifier */
  67 };
  68
  69 /* actions */
  70 #define EV_ADD          0x0001          /* add event to kq (implies enable) */
  71 #define EV_DELETE       0x0002          /* delete event from kq */
  72 #define EV_ENABLE       0x0004          /* enable event */
  73 #define EV_DISABLE      0x0008          /* disable event (not reported) */
  74 #define EV_FORCEONESHOT 0x0100          /* enable _ONESHOT and force trigger */
  75
  76 /* flags */
  77 #define EV_ONESHOT      0x0010          /* only report one occurrence */
  78 #define EV_CLEAR        0x0020          /* clear event state after reporting */
  79 #define EV_RECEIPT      0x0040          /* force EV_ERROR on success, data=0 */
  80 #define EV_DISPATCH     0x0080          /* disable event after reporting */
  81
  82 #define EV_SYSFLAGS     0xF000          /* reserved by system */
  83 #define EV_DROP         0x1000          /* note should be dropped */
  84 #define EV_FLAG1        0x2000          /* filter-specific flag */
  85 #define EV_FLAG2        0x4000          /* filter-specific flag */
  86
  87 /* returned values */
  88 #define EV_EOF          0x8000          /* EOF detected */
  89 #define EV_ERROR        0x4000          /* error, data contains errno */
  90
  91  /*
  92   * data/hint flags/masks for EVFILT_USER, shared with userspace
  93   *
  94   * On input, the top two bits of fflags specifies how the lower twenty four
  95   * bits should be applied to the stored value of fflags.
  96   *
  97   * On output, the top two bits will always be set to NOTE_FFNOP and the
  98   * remaining twenty four bits will contain the stored fflags value.
  99   */
 100 #define NOTE_FFNOP      0x00000000              /* ignore input fflags */
 101 #define NOTE_FFAND      0x40000000              /* AND fflags */
 102 #define NOTE_FFOR       0x80000000              /* OR fflags */
 103 #define NOTE_FFCOPY     0xc0000000              /* copy fflags */
 104 #define NOTE_FFCTRLMASK 0xc0000000              /* masks for operations */
 105 #define NOTE_FFLAGSMASK 0x00ffffff
 106
 107 #define NOTE_TRIGGER    0x01000000              /* Cause the event to be
 108                                                    triggered for output. */
 109
 110 /*
 111  * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace
 112  */
 113 #define NOTE_LOWAT      0x0001                  /* low water mark */
 114 #define NOTE_FILE_POLL  0x0002                  /* behave like poll() */
 115
 116 /*
 117  * data/hint flags for EVFILT_VNODE, shared with userspace
 118  */
 119 #define NOTE_DELETE     0x0001                  /* vnode was removed */
 120 #define NOTE_WRITE      0x0002                  /* data contents changed */
 121 #define NOTE_EXTEND     0x0004                  /* size increased */
 122 #define NOTE_ATTRIB     0x0008                  /* attributes changed */
 123 #define NOTE_LINK       0x0010                  /* link count changed */
 124 #define NOTE_RENAME     0x0020                  /* vnode was renamed */
 125 #define NOTE_REVOKE     0x0040                  /* vnode access was revoked */
 126 #define NOTE_OPEN       0x0080                  /* vnode was opened */
 127 #define NOTE_CLOSE      0x0100                  /* file closed, fd did not
 128                                                    allowed write */
 129 #define NOTE_CLOSE_WRITE 0x0200                 /* file closed, fd did allowed
 130                                                    write */
 131 #define NOTE_READ       0x0400                  /* file was read */
 132
 133 /*
 134  * data/hint flags for EVFILT_PROC and EVFILT_PROCDESC, shared with userspace
 135  */
 136 #define NOTE_EXIT       0x80000000              /* process exited */
 137 #define NOTE_FORK       0x40000000              /* process forked */
 138 #define NOTE_EXEC       0x20000000              /* process exec'd */
 139 #define NOTE_PCTRLMASK  0xf0000000              /* mask for hint bits */
 140 #define NOTE_PDATAMASK  0x000fffff              /* mask for pid */
 141
 142 /* additional flags for EVFILT_PROC */
 143 #define NOTE_TRACK      0x00000001              /* follow across forks */
 144 #define NOTE_TRACKERR   0x00000002              /* could not track child */
 145 #define NOTE_CHILD      0x00000004              /* am a child process */
 146
 147 /* additional flags for EVFILT_TIMER */
 148 #define NOTE_SECONDS            0x00000001      /* data is seconds */
 149 #define NOTE_MSECONDS           0x00000002      /* data is milliseconds */
 150 #define NOTE_USECONDS           0x00000004      /* data is microseconds */
 151 #define NOTE_NSECONDS           0x00000008      /* data is nanoseconds */
 152
 153 struct knote;
 154 SLIST_HEAD(klist, knote);
 155 struct kqueue;
 156 TAILQ_HEAD(kqlist, kqueue);
 157 struct knlist {
 158         struct  klist   kl_list;
 159         void    (*kl_lock)(void *);     /* lock function */
 160         void    (*kl_unlock)(void *);
 161         void    (*kl_assert_locked)(void *);
 162         void    (*kl_assert_unlocked)(void *);
 163         void    *kl_lockarg;            /* argument passed to lock functions */
 164         int     kl_autodestroy;
 165 };
 166
 167
 168 #ifdef _KERNEL
 169
 170 /*
 171  * Flags for knote call
 172  */
 173 #define KNF_LISTLOCKED  0x0001                  /* knlist is locked */
 174 #define KNF_NOKQLOCK    0x0002                  /* do not keep KQ_LOCK */
 175
 176 #define KNOTE(list, hint, flags)        knote(list, hint, flags)
 177 #define KNOTE_LOCKED(list, hint)        knote(list, hint, KNF_LISTLOCKED)
 178 #define KNOTE_UNLOCKED(list, hint)      knote(list, hint, 0)
 179
 180 #define KNLIST_EMPTY(list)              SLIST_EMPTY(&(list)->kl_list)
 181
 182 /*
 183  * Flag indicating hint is a signal.  Used by EVFILT_SIGNAL, and also
 184  * shared by EVFILT_PROC  (all knotes attached to p->p_klist)
 185  */
 186 #define NOTE_SIGNAL     0x08000000
 187
 188 /*
 189  * Hint values for the optional f_touch event filter.  If f_touch is not set
 190  * to NULL and f_isfd is zero the f_touch filter will be called with the type
 191  * argument set to EVENT_REGISTER during a kevent() system call.  It is also
 192  * called under the same conditions with the type argument set to EVENT_PROCESS
 193  * when the event has been triggered.
 194  */
 195 #define EVENT_REGISTER  1
 196 #define EVENT_PROCESS   2
 197
 198 struct filterops {
 199         int     f_isfd;         /* true if ident == filedescriptor */
 200         int     (*f_attach)(struct knote *kn);
 201         void    (*f_detach)(struct knote *kn);
 202         int     (*f_event)(struct knote *kn, long hint);
 203         void    (*f_touch)(struct knote *kn, struct kevent *kev, u_long type);
 204 };
 205
 206 /*
 207  * An in-flux knote cannot be dropped from its kq while the kq is
 208  * unlocked.  If the KN_SCAN flag is not set, a thread can only set
 209  * kn_influx when it is exclusive owner of the knote state, and can
 210  * modify kn_status as if it had the KQ lock.  KN_SCAN must not be set
 211  * on a knote which is already in flux.
 212  *
 213  * kn_sfflags, kn_sdata, and kn_kevent are protected by the knlist lock.
 214  */
 215 struct knote {
 216         SLIST_ENTRY(knote)      kn_link;        /* for kq */
 217         SLIST_ENTRY(knote)      kn_selnext;     /* for struct selinfo */
 218         struct                  knlist *kn_knlist;      /* f_attach populated */
 219         TAILQ_ENTRY(knote)      kn_tqe;
 220         struct                  kqueue *kn_kq;  /* which queue we are on */
 221         struct                  kevent kn_kevent;
 222         void                    *kn_hook;
 223         int                     kn_hookid;
 224         int                     kn_status;      /* protected by kq lock */
 225 #define KN_ACTIVE       0x01                    /* event has been triggered */
 226 #define KN_QUEUED       0x02                    /* event is on queue */
 227 #define KN_DISABLED     0x04                    /* event is disabled */
 228 #define KN_DETACHED     0x08                    /* knote is detached */
 229 #define KN_MARKER       0x20                    /* ignore this knote */
 230 #define KN_KQUEUE       0x40                    /* this knote belongs to a kq */
 231 #define KN_HASKQLOCK    0x80                    /* for _inevent */
 232 #define KN_SCAN         0x100                   /* flux set in kqueue_scan() */
 233         int                     kn_influx;
 234         int                     kn_sfflags;     /* saved filter flags */
 235         intptr_t                kn_sdata;       /* saved data field */
 236         union {
 237                 struct          file *p_fp;     /* file data pointer */
 238                 struct          proc *p_proc;   /* proc pointer */
 239                 struct          kaiocb *p_aio;  /* AIO job pointer */
 240                 struct          aioliojob *p_lio;       /* LIO job pointer */
 241                 void            *p_v;           /* generic other pointer */
 242         } kn_ptr;
 243         struct                  filterops *kn_fop;
 244
 245 #define kn_id           kn_kevent.ident
 246 #define kn_filter       kn_kevent.filter
 247 #define kn_flags        kn_kevent.flags
 248 #define kn_fflags       kn_kevent.fflags
 249 #define kn_data         kn_kevent.data
 250 #define kn_fp           kn_ptr.p_fp
 251 };
 252 struct kevent_copyops {
 253         void    *arg;
 254         int     (*k_copyout)(void *arg, struct kevent *kevp, int count);
 255         int     (*k_copyin)(void *arg, struct kevent *kevp, int count);
 256 };
 257
 258 struct thread;
 259 struct proc;
 260 struct knlist;
 261 struct mtx;
 262 struct rwlock;
 263
 264 void    knote(struct knlist *list, long hint, int lockflags);
 265 void    knote_fork(struct knlist *list, int pid);
 266 struct knlist *knlist_alloc(struct mtx *lock);
 267 void    knlist_detach(struct knlist *knl);
 268 void    knlist_add(struct knlist *knl, struct knote *kn, int islocked);
 269 void    knlist_remove(struct knlist *knl, struct knote *kn, int islocked);
 270 int     knlist_empty(struct knlist *knl);
 271 void    knlist_init(struct knlist *knl, void *lock, void (*kl_lock)(void *),
 272             void (*kl_unlock)(void *), void (*kl_assert_locked)(void *),
 273             void (*kl_assert_unlocked)(void *));
 274 void    knlist_init_mtx(struct knlist *knl, struct mtx *lock);
 275 void    knlist_init_rw_reader(struct knlist *knl, struct rwlock *lock);
 276 void    knlist_destroy(struct knlist *knl);
 277 void    knlist_cleardel(struct knlist *knl, struct thread *td,
 278             int islocked, int killkn);
 279 #define knlist_clear(knl, islocked)                             \
 280         knlist_cleardel((knl), NULL, (islocked), 0)
 281 #define knlist_delete(knl, td, islocked)                        \
 282         knlist_cleardel((knl), (td), (islocked), 1)
 283 void    knote_fdclose(struct thread *p, int fd);
 284 int     kqfd_register(int fd, struct kevent *kev, struct thread *p,
 285             int waitok);
 286 int     kqueue_add_filteropts(int filt, struct filterops *filtops);
 287 int     kqueue_del_filteropts(int filt);
 288
 289 #else   /* !_KERNEL */
 290
 291 #include <sys/cdefs.h>
 292 struct timespec;
 293
 294 __BEGIN_DECLS
 295 int     kqueue(void);
 296 int     kevent(int kq, const struct kevent *changelist, int nchanges,
 297             struct kevent *eventlist, int nevents,
 298             const struct timespec *timeout);
 299 __END_DECLS
 300
 301 #endif /* !_KERNEL */
 302
 303 #endif /* !_SYS_EVENT_H_ */