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