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