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