1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 1999,2000,2001 Jonathan Lemon <jlemon@FreeBSD.org> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _SYS_EVENT_H_ 32 #define _SYS_EVENT_H_ 33 34 #include <sys/_types.h> 35 #include <sys/queue.h> 36 37 #define EVFILT_READ (-1) 38 #define EVFILT_WRITE (-2) 39 #define EVFILT_AIO (-3) /* attached to aio requests */ 40 #define EVFILT_VNODE (-4) /* attached to vnodes */ 41 #define EVFILT_PROC (-5) /* attached to struct proc */ 42 #define EVFILT_SIGNAL (-6) /* attached to struct proc */ 43 #define EVFILT_TIMER (-7) /* timers */ 44 #define EVFILT_PROCDESC (-8) /* attached to process descriptors */ 45 #define EVFILT_FS (-9) /* filesystem events */ 46 #define EVFILT_LIO (-10) /* attached to lio requests */ 47 #define EVFILT_USER (-11) /* User events */ 48 #define EVFILT_SENDFILE (-12) /* attached to sendfile requests */ 49 #define EVFILT_EMPTY (-13) /* empty send socket buf */ 50 #define EVFILT_SYSCOUNT 13 51 52 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L 53 #define EV_SET(kevp_, a, b, c, d, e, f) do { \ 54 *(kevp_) = (struct kevent){ \ 55 .ident = (a), \ 56 .filter = (b), \ 57 .flags = (c), \ 58 .fflags = (d), \ 59 .data = (e), \ 60 .udata = (f), \ 61 .ext = {0}, \ 62 }; \ 63 } while (0) 64 #else /* Pre-C99 or not STDC (e.g., C++) */ 65 /* 66 * The definition of the local variable kevp could possibly conflict 67 * with a user-defined value passed in parameters a-f. 68 */ 69 #define EV_SET(kevp_, a, b, c, d, e, f) do { \ 70 struct kevent *kevp = (kevp_); \ 71 (kevp)->ident = (a); \ 72 (kevp)->filter = (b); \ 73 (kevp)->flags = (c); \ 74 (kevp)->fflags = (d); \ 75 (kevp)->data = (e); \ 76 (kevp)->udata = (f); \ 77 (kevp)->ext[0] = 0; \ 78 (kevp)->ext[1] = 0; \ 79 (kevp)->ext[2] = 0; \ 80 (kevp)->ext[3] = 0; \ 81 } while (0) 82 #endif 83 84 struct kevent { 85 __uintptr_t ident; /* identifier for this event */ 86 short filter; /* filter for event */ 87 unsigned short flags; /* action flags for kqueue */ 88 unsigned int fflags; /* filter flag value */ 89 __int64_t data; /* filter data value */ 90 void *udata; /* opaque user data identifier */ 91 __uint64_t ext[4]; /* extensions */ 92 }; 93 94 #if defined(_WANT_FREEBSD11_KEVENT) 95 /* Older structure used in FreeBSD 11.x and older. */ 96 struct kevent_freebsd11 { 97 __uintptr_t ident; /* identifier for this event */ 98 short filter; /* filter for event */ 99 unsigned short flags; 100 unsigned int fflags; 101 __intptr_t data; 102 void *udata; /* opaque user data identifier */ 103 }; 104 #endif 105 106 #if defined(_WANT_KEVENT32) || (defined(_KERNEL) && defined(__LP64__)) 107 struct kevent32 { 108 uint32_t ident; /* identifier for this event */ 109 short filter; /* filter for event */ 110 u_short flags; 111 u_int fflags; 112 #ifndef __amd64__ 113 uint32_t pad0; 114 #endif 115 uint32_t data1, data2; 116 uint32_t udata; /* opaque user data identifier */ 117 #ifndef __amd64__ 118 uint32_t pad1; 119 #endif 120 uint32_t ext64[8]; 121 }; 122 123 #ifdef _WANT_FREEBSD11_KEVENT 124 struct kevent32_freebsd11 { 125 u_int32_t ident; /* identifier for this event */ 126 short filter; /* filter for event */ 127 u_short flags; 128 u_int fflags; 129 int32_t data; 130 u_int32_t udata; /* opaque user data identifier */ 131 }; 132 #endif 133 #endif 134 135 /* actions */ 136 #define EV_ADD 0x0001 /* add event to kq (implies enable) */ 137 #define EV_DELETE 0x0002 /* delete event from kq */ 138 #define EV_ENABLE 0x0004 /* enable event */ 139 #define EV_DISABLE 0x0008 /* disable event (not reported) */ 140 #define EV_FORCEONESHOT 0x0100 /* enable _ONESHOT and force trigger */ 141 142 /* flags */ 143 #define EV_ONESHOT 0x0010 /* only report one occurrence */ 144 #define EV_CLEAR 0x0020 /* clear event state after reporting */ 145 #define EV_RECEIPT 0x0040 /* force EV_ERROR on success, data=0 */ 146 #define EV_DISPATCH 0x0080 /* disable event after reporting */ 147 148 #define EV_SYSFLAGS 0xF000 /* reserved by system */ 149 #define EV_DROP 0x1000 /* note should be dropped */ 150 #define EV_FLAG1 0x2000 /* filter-specific flag */ 151 #define EV_FLAG2 0x4000 /* filter-specific flag */ 152 153 /* returned values */ 154 #define EV_EOF 0x8000 /* EOF detected */ 155 #define EV_ERROR 0x4000 /* error, data contains errno */ 156 157 /* 158 * data/hint flags/masks for EVFILT_USER, shared with userspace 159 * 160 * On input, the top two bits of fflags specifies how the lower twenty four 161 * bits should be applied to the stored value of fflags. 162 * 163 * On output, the top two bits will always be set to NOTE_FFNOP and the 164 * remaining twenty four bits will contain the stored fflags value. 165 */ 166 #define NOTE_FFNOP 0x00000000 /* ignore input fflags */ 167 #define NOTE_FFAND 0x40000000 /* AND fflags */ 168 #define NOTE_FFOR 0x80000000 /* OR fflags */ 169 #define NOTE_FFCOPY 0xc0000000 /* copy fflags */ 170 #define NOTE_FFCTRLMASK 0xc0000000 /* masks for operations */ 171 #define NOTE_FFLAGSMASK 0x00ffffff 172 173 #define NOTE_TRIGGER 0x01000000 /* Cause the event to be 174 triggered for output. */ 175 176 /* 177 * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace 178 */ 179 #define NOTE_LOWAT 0x0001 /* low water mark */ 180 #define NOTE_FILE_POLL 0x0002 /* behave like poll() */ 181 182 /* 183 * data/hint flags for EVFILT_VNODE, shared with userspace 184 */ 185 #define NOTE_DELETE 0x0001 /* vnode was removed */ 186 #define NOTE_WRITE 0x0002 /* data contents changed */ 187 #define NOTE_EXTEND 0x0004 /* size increased */ 188 #define NOTE_ATTRIB 0x0008 /* attributes changed */ 189 #define NOTE_LINK 0x0010 /* link count changed */ 190 #define NOTE_RENAME 0x0020 /* vnode was renamed */ 191 #define NOTE_REVOKE 0x0040 /* vnode access was revoked */ 192 #define NOTE_OPEN 0x0080 /* vnode was opened */ 193 #define NOTE_CLOSE 0x0100 /* file closed, fd did not 194 allowed write */ 195 #define NOTE_CLOSE_WRITE 0x0200 /* file closed, fd did allowed 196 write */ 197 #define NOTE_READ 0x0400 /* file was read */ 198 199 /* 200 * data/hint flags for EVFILT_PROC and EVFILT_PROCDESC, shared with userspace 201 */ 202 #define NOTE_EXIT 0x80000000 /* process exited */ 203 #define NOTE_FORK 0x40000000 /* process forked */ 204 #define NOTE_EXEC 0x20000000 /* process exec'd */ 205 #define NOTE_PCTRLMASK 0xf0000000 /* mask for hint bits */ 206 #define NOTE_PDATAMASK 0x000fffff /* mask for pid */ 207 208 /* additional flags for EVFILT_PROC */ 209 #define NOTE_TRACK 0x00000001 /* follow across forks */ 210 #define NOTE_TRACKERR 0x00000002 /* could not track child */ 211 #define NOTE_CHILD 0x00000004 /* am a child process */ 212 213 /* additional flags for EVFILT_TIMER */ 214 #define NOTE_SECONDS 0x00000001 /* data is seconds */ 215 #define NOTE_MSECONDS 0x00000002 /* data is milliseconds */ 216 #define NOTE_USECONDS 0x00000004 /* data is microseconds */ 217 #define NOTE_NSECONDS 0x00000008 /* data is nanoseconds */ 218 #define NOTE_ABSTIME 0x00000010 /* timeout is absolute */ 219 220 struct knote; 221 SLIST_HEAD(klist, knote); 222 struct kqueue; 223 TAILQ_HEAD(kqlist, kqueue); 224 struct knlist { 225 struct klist kl_list; 226 void (*kl_lock)(void *); /* lock function */ 227 void (*kl_unlock)(void *); 228 void (*kl_assert_lock)(void *, int); 229 void *kl_lockarg; /* argument passed to lock functions */ 230 int kl_autodestroy; 231 }; 232 233 #ifdef _KERNEL 234 235 /* 236 * Flags for knote call 237 */ 238 #define KNF_LISTLOCKED 0x0001 /* knlist is locked */ 239 #define KNF_NOKQLOCK 0x0002 /* do not keep KQ_LOCK */ 240 241 #define KNOTE(list, hint, flags) knote(list, hint, flags) 242 #define KNOTE_LOCKED(list, hint) knote(list, hint, KNF_LISTLOCKED) 243 #define KNOTE_UNLOCKED(list, hint) knote(list, hint, 0) 244 245 #define KNLIST_EMPTY(list) SLIST_EMPTY(&(list)->kl_list) 246 247 /* 248 * Flag indicating hint is a signal. Used by EVFILT_SIGNAL, and also 249 * shared by EVFILT_PROC (all knotes attached to p->p_klist) 250 */ 251 #define NOTE_SIGNAL 0x08000000 252 253 /* 254 * Hint values for the optional f_touch event filter. If f_touch is not set 255 * to NULL and f_isfd is zero the f_touch filter will be called with the type 256 * argument set to EVENT_REGISTER during a kevent() system call. It is also 257 * called under the same conditions with the type argument set to EVENT_PROCESS 258 * when the event has been triggered. 259 */ 260 #define EVENT_REGISTER 1 261 #define EVENT_PROCESS 2 262 263 struct filterops { 264 int f_isfd; /* true if ident == filedescriptor */ 265 int (*f_attach)(struct knote *kn); 266 void (*f_detach)(struct knote *kn); 267 int (*f_event)(struct knote *kn, long hint); 268 void (*f_touch)(struct knote *kn, struct kevent *kev, u_long type); 269 }; 270 271 /* 272 * An in-flux knote cannot be dropped from its kq while the kq is 273 * unlocked. If the KN_SCAN flag is not set, a thread can only set 274 * kn_influx when it is exclusive owner of the knote state, and can 275 * modify kn_status as if it had the KQ lock. KN_SCAN must not be set 276 * on a knote which is already in flux. 277 * 278 * kn_sfflags, kn_sdata, and kn_kevent are protected by the knlist lock. 279 */ 280 struct knote { 281 SLIST_ENTRY(knote) kn_link; /* for kq */ 282 SLIST_ENTRY(knote) kn_selnext; /* for struct selinfo */ 283 struct knlist *kn_knlist; /* f_attach populated */ 284 TAILQ_ENTRY(knote) kn_tqe; 285 struct kqueue *kn_kq; /* which queue we are on */ 286 struct kevent kn_kevent; 287 void *kn_hook; 288 int kn_hookid; 289 int kn_status; /* protected by kq lock */ 290 #define KN_ACTIVE 0x01 /* event has been triggered */ 291 #define KN_QUEUED 0x02 /* event is on queue */ 292 #define KN_DISABLED 0x04 /* event is disabled */ 293 #define KN_DETACHED 0x08 /* knote is detached */ 294 #define KN_MARKER 0x20 /* ignore this knote */ 295 #define KN_KQUEUE 0x40 /* this knote belongs to a kq */ 296 #define KN_SCAN 0x100 /* flux set in kqueue_scan() */ 297 int kn_influx; 298 int kn_sfflags; /* saved filter flags */ 299 int64_t kn_sdata; /* saved data field */ 300 union { 301 struct file *p_fp; /* file data pointer */ 302 struct proc *p_proc; /* proc pointer */ 303 struct kaiocb *p_aio; /* AIO job pointer */ 304 struct aioliojob *p_lio; /* LIO job pointer */ 305 void *p_v; /* generic other pointer */ 306 } kn_ptr; 307 struct filterops *kn_fop; 308 309 #define kn_id kn_kevent.ident 310 #define kn_filter kn_kevent.filter 311 #define kn_flags kn_kevent.flags 312 #define kn_fflags kn_kevent.fflags 313 #define kn_data kn_kevent.data 314 #define kn_fp kn_ptr.p_fp 315 }; 316 struct kevent_copyops { 317 void *arg; 318 int (*k_copyout)(void *arg, struct kevent *kevp, int count); 319 int (*k_copyin)(void *arg, struct kevent *kevp, int count); 320 size_t kevent_size; 321 }; 322 323 struct thread; 324 struct proc; 325 struct knlist; 326 struct mtx; 327 struct rwlock; 328 329 void knote(struct knlist *list, long hint, int lockflags); 330 void knote_fork(struct knlist *list, int pid); 331 struct knlist *knlist_alloc(struct mtx *lock); 332 void knlist_detach(struct knlist *knl); 333 void knlist_add(struct knlist *knl, struct knote *kn, int islocked); 334 void knlist_remove(struct knlist *knl, struct knote *kn, int islocked); 335 int knlist_empty(struct knlist *knl); 336 void knlist_init(struct knlist *knl, void *lock, void (*kl_lock)(void *), 337 void (*kl_unlock)(void *), void (*kl_assert_lock)(void *, int)); 338 void knlist_init_mtx(struct knlist *knl, struct mtx *lock); 339 void knlist_init_rw_reader(struct knlist *knl, struct rwlock *lock); 340 void knlist_destroy(struct knlist *knl); 341 void knlist_cleardel(struct knlist *knl, struct thread *td, 342 int islocked, int killkn); 343 #define knlist_clear(knl, islocked) \ 344 knlist_cleardel((knl), NULL, (islocked), 0) 345 #define knlist_delete(knl, td, islocked) \ 346 knlist_cleardel((knl), (td), (islocked), 1) 347 void knote_fdclose(struct thread *p, int fd); 348 int kqfd_register(int fd, struct kevent *kev, struct thread *p, 349 int mflag); 350 int kqueue_add_filteropts(int filt, struct filterops *filtops); 351 int kqueue_del_filteropts(int filt); 352 353 #else /* !_KERNEL */ 354 355 #include <sys/cdefs.h> 356 struct timespec; 357 358 __BEGIN_DECLS 359 int kqueue(void); 360 int kevent(int kq, const struct kevent *changelist, int nchanges, 361 struct kevent *eventlist, int nevents, 362 const struct timespec *timeout); 363 __END_DECLS 364 365 #endif /* !_KERNEL */ 366 367 #endif /* !_SYS_EVENT_H_ */ 368