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/queue.h>
  33
  34 #define EVFILT_READ             (-1)
  35 #define EVFILT_WRITE            (-2)
  36 #define EVFILT_AIO              (-3)    /* attached to aio requests */
  37 #define EVFILT_VNODE            (-4)    /* attached to vnodes */
  38 #define EVFILT_PROC             (-5)    /* attached to struct proc */
  39 #define EVFILT_SIGNAL           (-6)    /* attached to struct proc */
  40 #define EVFILT_TIMER            (-7)    /* timers */
  41 #define EVFILT_NETDEV           (-8)    /* network devices */
  42 #define EVFILT_FS               (-9)    /* filesystem events */
  43 #define EVFILT_LIO              (-10)   /* attached to lio requests */
  44 #define EVFILT_SYSCOUNT         10
  45
  46 #define EV_SET(kevp_, a, b, c, d, e, f) do {    \
  47         struct kevent *kevp = (kevp_);          \
  48         (kevp)->ident = (a);                    \
  49         (kevp)->filter = (b);                   \
  50         (kevp)->flags = (c);                    \
  51         (kevp)->fflags = (d);                   \
  52         (kevp)->data = (e);                     \
  53         (kevp)->udata = (f);                    \
  54 } while(0)
  55
  56 struct kevent {
  57         uintptr_t       ident;          /* identifier for this event */
  58         short           filter;         /* filter for event */
  59         u_short         flags;
  60         u_int           fflags;
  61         intptr_t        data;
  62         void            *udata;         /* opaque user data identifier */
  63 };
  64
  65 /* actions */
  66 #define EV_ADD          0x0001          /* add event to kq (implies enable) */
  67 #define EV_DELETE       0x0002          /* delete event from kq */
  68 #define EV_ENABLE       0x0004          /* enable event */
  69 #define EV_DISABLE      0x0008          /* disable event (not reported) */
  70
  71 /* flags */
  72 #define EV_ONESHOT      0x0010          /* only report one occurrence */
  73 #define EV_CLEAR        0x0020          /* clear event state after reporting */
  74
  75 #define EV_SYSFLAGS     0xF000          /* reserved by system */
  76 #define EV_FLAG1        0x2000          /* filter-specific flag */
  77
  78 /* returned values */
  79 #define EV_EOF          0x8000          /* EOF detected */
  80 #define EV_ERROR        0x4000          /* error, data contains errno */
  81
  82 /*
  83  * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace
  84  */
  85 #define NOTE_LOWAT      0x0001                  /* low water mark */
  86
  87 /*
  88  * data/hint flags for EVFILT_VNODE, shared with userspace
  89  */
  90 #define NOTE_DELETE     0x0001                  /* vnode was removed */
  91 #define NOTE_WRITE      0x0002                  /* data contents changed */
  92 #define NOTE_EXTEND     0x0004                  /* size increased */
  93 #define NOTE_ATTRIB     0x0008                  /* attributes changed */
  94 #define NOTE_LINK       0x0010                  /* link count changed */
  95 #define NOTE_RENAME     0x0020                  /* vnode was renamed */
  96 #define NOTE_REVOKE     0x0040                  /* vnode access was revoked */
  97
  98 /*
  99  * data/hint flags for EVFILT_PROC, shared with userspace
 100  */
 101 #define NOTE_EXIT       0x80000000              /* process exited */
 102 #define NOTE_FORK       0x40000000              /* process forked */
 103 #define NOTE_EXEC       0x20000000              /* process exec'd */
 104 #define NOTE_PCTRLMASK  0xf0000000              /* mask for hint bits */
 105 #define NOTE_PDATAMASK  0x000fffff              /* mask for pid */
 106
 107 /* additional flags for EVFILT_PROC */
 108 #define NOTE_TRACK      0x00000001              /* follow across forks */
 109 #define NOTE_TRACKERR   0x00000002              /* could not track child */
 110 #define NOTE_CHILD      0x00000004              /* am a child process */
 111
 112 /*
 113  * data/hint flags for EVFILT_NETDEV, shared with userspace
 114  */
 115 #define NOTE_LINKUP     0x0001                  /* link is up */
 116 #define NOTE_LINKDOWN   0x0002                  /* link is down */
 117 #define NOTE_LINKINV    0x0004                  /* link state is invalid */
 118
 119 struct knote;
 120 SLIST_HEAD(klist, knote);
 121 struct kqueue;
 122 SLIST_HEAD(kqlist, kqueue);
 123 struct knlist {
 124         struct  klist   kl_list;
 125         void    (*kl_lock)(void *);     /* lock function */
 126         void    (*kl_unlock)(void *);
 127         void    (*kl_assert_locked)(void *);
 128         void    (*kl_assert_unlocked)(void *);
 129         void *kl_lockarg;               /* argument passed to kl_lockf() */
 130 };
 131
 132
 133 #ifdef _KERNEL
 134
 135 #ifdef MALLOC_DECLARE
 136 MALLOC_DECLARE(M_KQUEUE);
 137 #endif
 138
 139 /*
 140  * Flags for knote call
 141  */
 142 #define KNF_LISTLOCKED  0x0001                  /* knlist is locked */
 143 #define KNF_NOKQLOCK    0x0002                  /* do not keep KQ_LOCK */
 144
 145 #define KNOTE(list, hist, flags)        knote(list, hist, flags)
 146 #define KNOTE_LOCKED(list, hint)        knote(list, hint, KNF_LISTLOCKED)
 147 #define KNOTE_UNLOCKED(list, hint)      knote(list, hint, 0)
 148
 149 #define KNLIST_EMPTY(list)              SLIST_EMPTY(&(list)->kl_list)
 150
 151 /*
 152  * Flag indicating hint is a signal.  Used by EVFILT_SIGNAL, and also
 153  * shared by EVFILT_PROC  (all knotes attached to p->p_klist)
 154  */
 155 #define NOTE_SIGNAL     0x08000000
 156
 157 struct filterops {
 158         int     f_isfd;         /* true if ident == filedescriptor */
 159         int     (*f_attach)(struct knote *kn);
 160         void    (*f_detach)(struct knote *kn);
 161         int     (*f_event)(struct knote *kn, long hint);
 162 };
 163
 164 /*
 165  * Setting the KN_INFLUX flag enables you to unlock the kq that this knote
 166  * is on, and modify kn_status as if you had the KQ lock.
 167  *
 168  * kn_sfflags, kn_sdata, and kn_kevent are protected by the knlist lock.
 169  */
 170 struct knote {
 171         SLIST_ENTRY(knote)      kn_link;        /* for kq */
 172         SLIST_ENTRY(knote)      kn_selnext;     /* for struct selinfo */
 173         struct                  knlist *kn_knlist;      /* f_attach populated */
 174         TAILQ_ENTRY(knote)      kn_tqe;
 175         struct                  kqueue *kn_kq;  /* which queue we are on */
 176         struct                  kevent kn_kevent;
 177         int                     kn_status;      /* protected by kq lock */
 178 #define KN_ACTIVE       0x01                    /* event has been triggered */
 179 #define KN_QUEUED       0x02                    /* event is on queue */
 180 #define KN_DISABLED     0x04                    /* event is disabled */
 181 #define KN_DETACHED     0x08                    /* knote is detached */
 182 #define KN_INFLUX       0x10                    /* knote is in flux */
 183 #define KN_MARKER       0x20                    /* ignore this knote */
 184 #define KN_KQUEUE       0x40                    /* this knote belongs to a kq */
 185 #define KN_HASKQLOCK    0x80                    /* for _inevent */
 186         int                     kn_sfflags;     /* saved filter flags */
 187         intptr_t                kn_sdata;       /* saved data field */
 188         union {
 189                 struct          file *p_fp;     /* file data pointer */
 190                 struct          proc *p_proc;   /* proc pointer */
 191                 struct          aiocblist *p_aio;       /* AIO job pointer */
 192                 struct          aioliojob *p_lio;       /* LIO job pointer */
 193         } kn_ptr;
 194         struct                  filterops *kn_fop;
 195         void                    *kn_hook;
 196
 197 #define kn_id           kn_kevent.ident
 198 #define kn_filter       kn_kevent.filter
 199 #define kn_flags        kn_kevent.flags
 200 #define kn_fflags       kn_kevent.fflags
 201 #define kn_data         kn_kevent.data
 202 #define kn_fp           kn_ptr.p_fp
 203 };
 204 struct kevent_copyops {
 205         void    *arg;
 206         int     (*k_copyout)(void *arg, struct kevent *kevp, int count);
 207         int     (*k_copyin)(void *arg, struct kevent *kevp, int count);
 208 };
 209
 210 struct thread;
 211 struct proc;
 212 struct knlist;
 213 struct mtx;
 214
 215 extern void     knote(struct knlist *list, long hint, int lockflags);
 216 extern void     knote_fork(struct knlist *list, int pid);
 217 extern void     knlist_add(struct knlist *knl, struct knote *kn, int islocked);
 218 extern void     knlist_remove(struct knlist *knl, struct knote *kn, int islocked);
 219 extern void     knlist_remove_inevent(struct knlist *knl, struct knote *kn);
 220 extern int      knlist_empty(struct knlist *knl);
 221 extern void     knlist_init(struct knlist *knl, void *lock,
 222     void (*kl_lock)(void *), void (*kl_unlock)(void *),
 223     void (*kl_assert_locked)(void *), void (*kl_assert_unlocked)(void *));
 224 extern void     knlist_init_mtx(struct knlist *knl, struct mtx *lock);
 225 extern void     knlist_destroy(struct knlist *knl);
 226 extern void     knlist_cleardel(struct knlist *knl, struct thread *td,
 227         int islocked, int killkn);
 228 #define knlist_clear(knl, islocked)                             \
 229                 knlist_cleardel((knl), NULL, (islocked), 0)
 230 #define knlist_delete(knl, td, islocked)                        \
 231                 knlist_cleardel((knl), (td), (islocked), 1)
 232 extern void     knote_fdclose(struct thread *p, int fd);
 233 extern int      kqfd_register(int fd, struct kevent *kev, struct thread *p,
 234                     int waitok);
 235 extern int      kqueue_add_filteropts(int filt, struct filterops *filtops);
 236 extern int      kqueue_del_filteropts(int filt);
 237
 238 #else   /* !_KERNEL */
 239
 240 #include <sys/cdefs.h>
 241 struct timespec;
 242
 243 __BEGIN_DECLS
 244 int     kqueue(void);
 245 int     kevent(int kq, const struct kevent *changelist, int nchanges,
 246             struct kevent *eventlist, int nevents,
 247             const struct timespec *timeout);
 248 __END_DECLS
 249
 250 #endif /* !_KERNEL */
 251
 252 #endif /* !_SYS_EVENT_H_ */