2 * Copyright (c) 1999,2000,2001 Jonathan Lemon <jlemon@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
32 #include <sys/_types.h>
33 #include <sys/queue.h>
35 #define EVFILT_READ (-1)
36 #define EVFILT_WRITE (-2)
37 #define EVFILT_AIO (-3) /* attached to aio requests */
38 #define EVFILT_VNODE (-4) /* attached to vnodes */
39 #define EVFILT_PROC (-5) /* attached to struct proc */
40 #define EVFILT_SIGNAL (-6) /* attached to struct proc */
41 #define EVFILT_TIMER (-7) /* timers */
42 #define EVFILT_PROCDESC (-8) /* attached to process descriptors */
43 #define EVFILT_FS (-9) /* filesystem events */
44 #define EVFILT_LIO (-10) /* attached to lio requests */
45 #define EVFILT_USER (-11) /* User events */
46 #define EVFILT_SENDFILE (-12) /* attached to sendfile requests */
47 #define EVFILT_EMPTY (-13) /* empty send socket buf */
48 #define EVFILT_SYSCOUNT 13
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); \
57 (kevp)->udata = (f); \
65 __uintptr_t ident; /* identifier for this event */
66 short filter; /* filter for event */
70 void *udata; /* opaque user data identifier */
75 #define EV_ADD 0x0001 /* add event to kq (implies enable) */
76 #define EV_DELETE 0x0002 /* delete event from kq */
77 #define EV_ENABLE 0x0004 /* enable event */
78 #define EV_DISABLE 0x0008 /* disable event (not reported) */
79 #define EV_FORCEONESHOT 0x0100 /* enable _ONESHOT and force trigger */
82 #define EV_ONESHOT 0x0010 /* only report one occurrence */
83 #define EV_CLEAR 0x0020 /* clear event state after reporting */
84 #define EV_RECEIPT 0x0040 /* force EV_ERROR on success, data=0 */
85 #define EV_DISPATCH 0x0080 /* disable event after reporting */
87 #define EV_SYSFLAGS 0xF000 /* reserved by system */
88 #define EV_DROP 0x1000 /* note should be dropped */
89 #define EV_FLAG1 0x2000 /* filter-specific flag */
90 #define EV_FLAG2 0x4000 /* filter-specific flag */
93 #define EV_EOF 0x8000 /* EOF detected */
94 #define EV_ERROR 0x4000 /* error, data contains errno */
97 * data/hint flags/masks for EVFILT_USER, shared with userspace
99 * On input, the top two bits of fflags specifies how the lower twenty four
100 * bits should be applied to the stored value of fflags.
102 * On output, the top two bits will always be set to NOTE_FFNOP and the
103 * remaining twenty four bits will contain the stored fflags value.
105 #define NOTE_FFNOP 0x00000000 /* ignore input fflags */
106 #define NOTE_FFAND 0x40000000 /* AND fflags */
107 #define NOTE_FFOR 0x80000000 /* OR fflags */
108 #define NOTE_FFCOPY 0xc0000000 /* copy fflags */
109 #define NOTE_FFCTRLMASK 0xc0000000 /* masks for operations */
110 #define NOTE_FFLAGSMASK 0x00ffffff
112 #define NOTE_TRIGGER 0x01000000 /* Cause the event to be
113 triggered for output. */
116 * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace
118 #define NOTE_LOWAT 0x0001 /* low water mark */
119 #define NOTE_FILE_POLL 0x0002 /* behave like poll() */
122 * data/hint flags for EVFILT_VNODE, shared with userspace
124 #define NOTE_DELETE 0x0001 /* vnode was removed */
125 #define NOTE_WRITE 0x0002 /* data contents changed */
126 #define NOTE_EXTEND 0x0004 /* size increased */
127 #define NOTE_ATTRIB 0x0008 /* attributes changed */
128 #define NOTE_LINK 0x0010 /* link count changed */
129 #define NOTE_RENAME 0x0020 /* vnode was renamed */
130 #define NOTE_REVOKE 0x0040 /* vnode access was revoked */
131 #define NOTE_OPEN 0x0080 /* vnode was opened */
132 #define NOTE_CLOSE 0x0100 /* file closed, fd did not
134 #define NOTE_CLOSE_WRITE 0x0200 /* file closed, fd did allowed
136 #define NOTE_READ 0x0400 /* file was read */
139 * data/hint flags for EVFILT_PROC and EVFILT_PROCDESC, shared with userspace
141 #define NOTE_EXIT 0x80000000 /* process exited */
142 #define NOTE_FORK 0x40000000 /* process forked */
143 #define NOTE_EXEC 0x20000000 /* process exec'd */
144 #define NOTE_PCTRLMASK 0xf0000000 /* mask for hint bits */
145 #define NOTE_PDATAMASK 0x000fffff /* mask for pid */
147 /* additional flags for EVFILT_PROC */
148 #define NOTE_TRACK 0x00000001 /* follow across forks */
149 #define NOTE_TRACKERR 0x00000002 /* could not track child */
150 #define NOTE_CHILD 0x00000004 /* am a child process */
152 /* additional flags for EVFILT_TIMER */
153 #define NOTE_SECONDS 0x00000001 /* data is seconds */
154 #define NOTE_MSECONDS 0x00000002 /* data is milliseconds */
155 #define NOTE_USECONDS 0x00000004 /* data is microseconds */
156 #define NOTE_NSECONDS 0x00000008 /* data is nanoseconds */
157 #define NOTE_ABSTIME 0x00000010 /* timeout is absolute */
160 SLIST_HEAD(klist, knote);
162 TAILQ_HEAD(kqlist, kqueue);
164 struct klist kl_list;
165 void (*kl_lock)(void *); /* lock function */
166 void (*kl_unlock)(void *);
167 void (*kl_assert_locked)(void *);
168 void (*kl_assert_unlocked)(void *);
169 void *kl_lockarg; /* argument passed to lock functions */
177 * Flags for knote call
179 #define KNF_LISTLOCKED 0x0001 /* knlist is locked */
180 #define KNF_NOKQLOCK 0x0002 /* do not keep KQ_LOCK */
182 #define KNOTE(list, hint, flags) knote(list, hint, flags)
183 #define KNOTE_LOCKED(list, hint) knote(list, hint, KNF_LISTLOCKED)
184 #define KNOTE_UNLOCKED(list, hint) knote(list, hint, 0)
186 #define KNLIST_EMPTY(list) SLIST_EMPTY(&(list)->kl_list)
189 * Flag indicating hint is a signal. Used by EVFILT_SIGNAL, and also
190 * shared by EVFILT_PROC (all knotes attached to p->p_klist)
192 #define NOTE_SIGNAL 0x08000000
195 * Hint values for the optional f_touch event filter. If f_touch is not set
196 * to NULL and f_isfd is zero the f_touch filter will be called with the type
197 * argument set to EVENT_REGISTER during a kevent() system call. It is also
198 * called under the same conditions with the type argument set to EVENT_PROCESS
199 * when the event has been triggered.
201 #define EVENT_REGISTER 1
202 #define EVENT_PROCESS 2
205 int f_isfd; /* true if ident == filedescriptor */
206 int (*f_attach)(struct knote *kn);
207 void (*f_detach)(struct knote *kn);
208 int (*f_event)(struct knote *kn, long hint);
209 void (*f_touch)(struct knote *kn, struct kevent *kev, u_long type);
213 * An in-flux knote cannot be dropped from its kq while the kq is
214 * unlocked. If the KN_SCAN flag is not set, a thread can only set
215 * kn_influx when it is exclusive owner of the knote state, and can
216 * modify kn_status as if it had the KQ lock. KN_SCAN must not be set
217 * on a knote which is already in flux.
219 * kn_sfflags, kn_sdata, and kn_kevent are protected by the knlist lock.
222 SLIST_ENTRY(knote) kn_link; /* for kq */
223 SLIST_ENTRY(knote) kn_selnext; /* for struct selinfo */
224 struct knlist *kn_knlist; /* f_attach populated */
225 TAILQ_ENTRY(knote) kn_tqe;
226 struct kqueue *kn_kq; /* which queue we are on */
227 struct kevent kn_kevent;
230 int kn_status; /* protected by kq lock */
231 #define KN_ACTIVE 0x01 /* event has been triggered */
232 #define KN_QUEUED 0x02 /* event is on queue */
233 #define KN_DISABLED 0x04 /* event is disabled */
234 #define KN_DETACHED 0x08 /* knote is detached */
235 #define KN_MARKER 0x20 /* ignore this knote */
236 #define KN_KQUEUE 0x40 /* this knote belongs to a kq */
237 #define KN_HASKQLOCK 0x80 /* for _inevent */
238 #define KN_SCAN 0x100 /* flux set in kqueue_scan() */
240 int kn_sfflags; /* saved filter flags */
241 int64_t kn_sdata; /* saved data field */
243 struct file *p_fp; /* file data pointer */
244 struct proc *p_proc; /* proc pointer */
245 struct kaiocb *p_aio; /* AIO job pointer */
246 struct aioliojob *p_lio; /* LIO job pointer */
247 void *p_v; /* generic other pointer */
249 struct filterops *kn_fop;
251 #define kn_id kn_kevent.ident
252 #define kn_filter kn_kevent.filter
253 #define kn_flags kn_kevent.flags
254 #define kn_fflags kn_kevent.fflags
255 #define kn_data kn_kevent.data
256 #define kn_fp kn_ptr.p_fp
258 struct kevent_copyops {
260 int (*k_copyout)(void *arg, struct kevent *kevp, int count);
261 int (*k_copyin)(void *arg, struct kevent *kevp, int count);
271 void knote(struct knlist *list, long hint, int lockflags);
272 void knote_fork(struct knlist *list, int pid);
273 struct knlist *knlist_alloc(struct mtx *lock);
274 void knlist_detach(struct knlist *knl);
275 void knlist_add(struct knlist *knl, struct knote *kn, int islocked);
276 void knlist_remove(struct knlist *knl, struct knote *kn, int islocked);
277 int knlist_empty(struct knlist *knl);
278 void knlist_init(struct knlist *knl, void *lock, void (*kl_lock)(void *),
279 void (*kl_unlock)(void *), void (*kl_assert_locked)(void *),
280 void (*kl_assert_unlocked)(void *));
281 void knlist_init_mtx(struct knlist *knl, struct mtx *lock);
282 void knlist_init_rw_reader(struct knlist *knl, struct rwlock *lock);
283 void knlist_destroy(struct knlist *knl);
284 void knlist_cleardel(struct knlist *knl, struct thread *td,
285 int islocked, int killkn);
286 #define knlist_clear(knl, islocked) \
287 knlist_cleardel((knl), NULL, (islocked), 0)
288 #define knlist_delete(knl, td, islocked) \
289 knlist_cleardel((knl), (td), (islocked), 1)
290 void knote_fdclose(struct thread *p, int fd);
291 int kqfd_register(int fd, struct kevent *kev, struct thread *p,
293 int kqueue_add_filteropts(int filt, struct filterops *filtops);
294 int kqueue_del_filteropts(int filt);
298 #include <sys/cdefs.h>
303 int kevent(int kq, const struct kevent *changelist, int nchanges,
304 struct kevent *eventlist, int nevents,
305 const struct timespec *timeout);
308 #endif /* !_KERNEL */
310 #endif /* !_SYS_EVENT_H_ */