| 1 |
/* $MidnightBSD$ */ |
| 2 |
/*- |
| 3 |
* Copyright (c) 1999,2000,2001 Jonathan Lemon <jlemon@FreeBSD.org> |
| 4 |
* All rights reserved. |
| 5 |
* |
| 6 |
* Redistribution and use in source and binary forms, with or without |
| 7 |
* modification, are permitted provided that the following conditions |
| 8 |
* are met: |
| 9 |
* 1. Redistributions of source code must retain the above copyright |
| 10 |
* notice, this list of conditions and the following disclaimer. |
| 11 |
* 2. Redistributions in binary form must reproduce the above copyright |
| 12 |
* notice, this list of conditions and the following disclaimer in the |
| 13 |
* documentation and/or other materials provided with the distribution. |
| 14 |
* |
| 15 |
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
| 16 |
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 17 |
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 18 |
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
| 19 |
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 20 |
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 21 |
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 22 |
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| 23 |
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| 24 |
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 25 |
* SUCH DAMAGE. |
| 26 |
* |
| 27 |
* $FreeBSD: stable/10/sys/sys/event.h 336200 2018-07-11 14:56:38Z dab $ |
| 28 |
*/ |
| 29 |
|
| 30 |
#ifndef _SYS_EVENT_H_ |
| 31 |
#define _SYS_EVENT_H_ |
| 32 |
|
| 33 |
#include <sys/queue.h> |
| 34 |
|
| 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 |
/* EVFILT_NETDEV (-8) no longer supported */ |
| 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_SYSCOUNT 11 |
| 47 |
|
| 48 |
#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L |
| 49 |
#define EV_SET(kevp_, a, b, c, d, e, f) do { \ |
| 50 |
*(kevp_) = (struct kevent){ \ |
| 51 |
.ident = (a), \ |
| 52 |
.filter = (b), \ |
| 53 |
.flags = (c), \ |
| 54 |
.fflags = (d), \ |
| 55 |
.data = (e), \ |
| 56 |
.udata = (f), \ |
| 57 |
}; \ |
| 58 |
} while(0) |
| 59 |
#else /* Pre-C99 or not STDC (e.g., C++) */ |
| 60 |
/* The definition of the local variable kevp could possibly conflict |
| 61 |
* with a user-defined value passed in parameters a-f. |
| 62 |
*/ |
| 63 |
#define EV_SET(kevp_, a, b, c, d, e, f) do { \ |
| 64 |
struct kevent *kevp = (kevp_); \ |
| 65 |
(kevp)->ident = (a); \ |
| 66 |
(kevp)->filter = (b); \ |
| 67 |
(kevp)->flags = (c); \ |
| 68 |
(kevp)->fflags = (d); \ |
| 69 |
(kevp)->data = (e); \ |
| 70 |
(kevp)->udata = (f); \ |
| 71 |
} while(0) |
| 72 |
#endif |
| 73 |
|
| 74 |
struct kevent { |
| 75 |
uintptr_t ident; /* identifier for this event */ |
| 76 |
short filter; /* filter for event */ |
| 77 |
u_short flags; |
| 78 |
u_int fflags; |
| 79 |
intptr_t data; |
| 80 |
void *udata; /* opaque user data identifier */ |
| 81 |
}; |
| 82 |
|
| 83 |
/* actions */ |
| 84 |
#define EV_ADD 0x0001 /* add event to kq (implies enable) */ |
| 85 |
#define EV_DELETE 0x0002 /* delete event from kq */ |
| 86 |
#define EV_ENABLE 0x0004 /* enable event */ |
| 87 |
#define EV_DISABLE 0x0008 /* disable event (not reported) */ |
| 88 |
|
| 89 |
/* flags */ |
| 90 |
#define EV_ONESHOT 0x0010 /* only report one occurrence */ |
| 91 |
#define EV_CLEAR 0x0020 /* clear event state after reporting */ |
| 92 |
#define EV_RECEIPT 0x0040 /* force EV_ERROR on success, data=0 */ |
| 93 |
#define EV_DISPATCH 0x0080 /* disable event after reporting */ |
| 94 |
|
| 95 |
#define EV_SYSFLAGS 0xF000 /* reserved by system */ |
| 96 |
#define EV_DROP 0x1000 /* note should be dropped */ |
| 97 |
#define EV_FLAG1 0x2000 /* filter-specific flag */ |
| 98 |
#define EV_FLAG2 0x4000 /* filter-specific flag */ |
| 99 |
|
| 100 |
/* returned values */ |
| 101 |
#define EV_EOF 0x8000 /* EOF detected */ |
| 102 |
#define EV_ERROR 0x4000 /* error, data contains errno */ |
| 103 |
|
| 104 |
/* |
| 105 |
* data/hint flags/masks for EVFILT_USER, shared with userspace |
| 106 |
* |
| 107 |
* On input, the top two bits of fflags specifies how the lower twenty four |
| 108 |
* bits should be applied to the stored value of fflags. |
| 109 |
* |
| 110 |
* On output, the top two bits will always be set to NOTE_FFNOP and the |
| 111 |
* remaining twenty four bits will contain the stored fflags value. |
| 112 |
*/ |
| 113 |
#define NOTE_FFNOP 0x00000000 /* ignore input fflags */ |
| 114 |
#define NOTE_FFAND 0x40000000 /* AND fflags */ |
| 115 |
#define NOTE_FFOR 0x80000000 /* OR fflags */ |
| 116 |
#define NOTE_FFCOPY 0xc0000000 /* copy fflags */ |
| 117 |
#define NOTE_FFCTRLMASK 0xc0000000 /* masks for operations */ |
| 118 |
#define NOTE_FFLAGSMASK 0x00ffffff |
| 119 |
|
| 120 |
#define NOTE_TRIGGER 0x01000000 /* Cause the event to be |
| 121 |
triggered for output. */ |
| 122 |
|
| 123 |
/* |
| 124 |
* data/hint flags for EVFILT_{READ|WRITE}, shared with userspace |
| 125 |
*/ |
| 126 |
#define NOTE_LOWAT 0x0001 /* low water mark */ |
| 127 |
|
| 128 |
/* |
| 129 |
* data/hint flags for EVFILT_VNODE, shared with userspace |
| 130 |
*/ |
| 131 |
#define NOTE_DELETE 0x0001 /* vnode was removed */ |
| 132 |
#define NOTE_WRITE 0x0002 /* data contents changed */ |
| 133 |
#define NOTE_EXTEND 0x0004 /* size increased */ |
| 134 |
#define NOTE_ATTRIB 0x0008 /* attributes changed */ |
| 135 |
#define NOTE_LINK 0x0010 /* link count changed */ |
| 136 |
#define NOTE_RENAME 0x0020 /* vnode was renamed */ |
| 137 |
#define NOTE_REVOKE 0x0040 /* vnode access was revoked */ |
| 138 |
#define NOTE_OPEN 0x0080 /* vnode was opened */ |
| 139 |
#define NOTE_CLOSE 0x0100 /* file closed, fd did not |
| 140 |
allowed write */ |
| 141 |
#define NOTE_CLOSE_WRITE 0x0200 /* file closed, fd did allowed |
| 142 |
write */ |
| 143 |
#define NOTE_READ 0x0400 /* file was read */ |
| 144 |
|
| 145 |
/* |
| 146 |
* data/hint flags for EVFILT_PROC, shared with userspace |
| 147 |
*/ |
| 148 |
#define NOTE_EXIT 0x80000000 /* process exited */ |
| 149 |
#define NOTE_FORK 0x40000000 /* process forked */ |
| 150 |
#define NOTE_EXEC 0x20000000 /* process exec'd */ |
| 151 |
#define NOTE_PCTRLMASK 0xf0000000 /* mask for hint bits */ |
| 152 |
#define NOTE_PDATAMASK 0x000fffff /* mask for pid */ |
| 153 |
|
| 154 |
/* additional flags for EVFILT_PROC */ |
| 155 |
#define NOTE_TRACK 0x00000001 /* follow across forks */ |
| 156 |
#define NOTE_TRACKERR 0x00000002 /* could not track child */ |
| 157 |
#define NOTE_CHILD 0x00000004 /* am a child process */ |
| 158 |
|
| 159 |
/* additional flags for EVFILE_TIMER */ |
| 160 |
#define NOTE_SECONDS 0x00000001 /* data is seconds */ |
| 161 |
#define NOTE_MSECONDS 0x00000002 /* data is milliseconds */ |
| 162 |
#define NOTE_USECONDS 0x00000004 /* data is microseconds */ |
| 163 |
#define NOTE_NSECONDS 0x00000008 /* data is nanoseconds */ |
| 164 |
|
| 165 |
struct knote; |
| 166 |
SLIST_HEAD(klist, knote); |
| 167 |
struct kqueue; |
| 168 |
TAILQ_HEAD(kqlist, kqueue); |
| 169 |
struct knlist { |
| 170 |
struct klist kl_list; |
| 171 |
void (*kl_lock)(void *); /* lock function */ |
| 172 |
void (*kl_unlock)(void *); |
| 173 |
void (*kl_assert_locked)(void *); |
| 174 |
void (*kl_assert_unlocked)(void *); |
| 175 |
void *kl_lockarg; /* argument passed to kl_lockf() */ |
| 176 |
}; |
| 177 |
|
| 178 |
|
| 179 |
#ifdef _KERNEL |
| 180 |
|
| 181 |
/* |
| 182 |
* Flags for knote call |
| 183 |
*/ |
| 184 |
#define KNF_LISTLOCKED 0x0001 /* knlist is locked */ |
| 185 |
#define KNF_NOKQLOCK 0x0002 /* do not keep KQ_LOCK */ |
| 186 |
|
| 187 |
#define KNOTE(list, hist, flags) knote(list, hist, flags) |
| 188 |
#define KNOTE_LOCKED(list, hint) knote(list, hint, KNF_LISTLOCKED) |
| 189 |
#define KNOTE_UNLOCKED(list, hint) knote(list, hint, 0) |
| 190 |
|
| 191 |
#define KNLIST_EMPTY(list) SLIST_EMPTY(&(list)->kl_list) |
| 192 |
|
| 193 |
/* |
| 194 |
* Flag indicating hint is a signal. Used by EVFILT_SIGNAL, and also |
| 195 |
* shared by EVFILT_PROC (all knotes attached to p->p_klist) |
| 196 |
*/ |
| 197 |
#define NOTE_SIGNAL 0x08000000 |
| 198 |
|
| 199 |
/* |
| 200 |
* Hint values for the optional f_touch event filter. If f_touch is not set |
| 201 |
* to NULL and f_isfd is zero the f_touch filter will be called with the type |
| 202 |
* argument set to EVENT_REGISTER during a kevent() system call. It is also |
| 203 |
* called under the same conditions with the type argument set to EVENT_PROCESS |
| 204 |
* when the event has been triggered. |
| 205 |
*/ |
| 206 |
#define EVENT_REGISTER 1 |
| 207 |
#define EVENT_PROCESS 2 |
| 208 |
|
| 209 |
struct filterops { |
| 210 |
int f_isfd; /* true if ident == filedescriptor */ |
| 211 |
int (*f_attach)(struct knote *kn); |
| 212 |
void (*f_detach)(struct knote *kn); |
| 213 |
int (*f_event)(struct knote *kn, long hint); |
| 214 |
void (*f_touch)(struct knote *kn, struct kevent *kev, u_long type); |
| 215 |
}; |
| 216 |
|
| 217 |
/* |
| 218 |
* Setting the KN_INFLUX flag enables you to unlock the kq that this knote |
| 219 |
* is on, and modify kn_status as if you had the KQ lock. |
| 220 |
* |
| 221 |
* kn_sfflags, kn_sdata, and kn_kevent are protected by the knlist lock. |
| 222 |
*/ |
| 223 |
struct knote { |
| 224 |
SLIST_ENTRY(knote) kn_link; /* for kq */ |
| 225 |
SLIST_ENTRY(knote) kn_selnext; /* for struct selinfo */ |
| 226 |
struct knlist *kn_knlist; /* f_attach populated */ |
| 227 |
TAILQ_ENTRY(knote) kn_tqe; |
| 228 |
struct kqueue *kn_kq; /* which queue we are on */ |
| 229 |
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_INFLUX 0x10 /* knote is in flux */ |
| 236 |
#define KN_MARKER 0x20 /* ignore this knote */ |
| 237 |
#define KN_KQUEUE 0x40 /* this knote belongs to a kq */ |
| 238 |
#define KN_HASKQLOCK 0x80 /* for _inevent */ |
| 239 |
#define KN_SCAN 0x100 /* flux set in kqueue_scan() */ |
| 240 |
int kn_sfflags; /* saved filter flags */ |
| 241 |
intptr_t kn_sdata; /* saved data field */ |
| 242 |
union { |
| 243 |
struct file *p_fp; /* file data pointer */ |
| 244 |
struct proc *p_proc; /* proc pointer */ |
| 245 |
struct aiocblist *p_aio; /* AIO job pointer */ |
| 246 |
struct aioliojob *p_lio; /* LIO job pointer */ |
| 247 |
sbintime_t *p_nexttime; /* next timer event fires at */ |
| 248 |
void *p_v; /* generic other pointer */ |
| 249 |
} kn_ptr; |
| 250 |
struct filterops *kn_fop; |
| 251 |
void *kn_hook; |
| 252 |
int kn_hookid; |
| 253 |
|
| 254 |
#define kn_id kn_kevent.ident |
| 255 |
#define kn_filter kn_kevent.filter |
| 256 |
#define kn_flags kn_kevent.flags |
| 257 |
#define kn_fflags kn_kevent.fflags |
| 258 |
#define kn_data kn_kevent.data |
| 259 |
#define kn_fp kn_ptr.p_fp |
| 260 |
}; |
| 261 |
struct kevent_copyops { |
| 262 |
void *arg; |
| 263 |
int (*k_copyout)(void *arg, struct kevent *kevp, int count); |
| 264 |
int (*k_copyin)(void *arg, struct kevent *kevp, int count); |
| 265 |
}; |
| 266 |
|
| 267 |
struct thread; |
| 268 |
struct proc; |
| 269 |
struct knlist; |
| 270 |
struct mtx; |
| 271 |
struct rwlock; |
| 272 |
|
| 273 |
void knote(struct knlist *list, long hint, int lockflags); |
| 274 |
void knote_fork(struct knlist *list, int pid); |
| 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 |
void knlist_remove_inevent(struct knlist *knl, struct knote *kn); |
| 278 |
int knlist_empty(struct knlist *knl); |
| 279 |
void knlist_init(struct knlist *knl, void *lock, void (*kl_lock)(void *), |
| 280 |
void (*kl_unlock)(void *), void (*kl_assert_locked)(void *), |
| 281 |
void (*kl_assert_unlocked)(void *)); |
| 282 |
void knlist_init_mtx(struct knlist *knl, struct mtx *lock); |
| 283 |
void knlist_init_rw_reader(struct knlist *knl, struct rwlock *lock); |
| 284 |
void knlist_destroy(struct knlist *knl); |
| 285 |
void knlist_cleardel(struct knlist *knl, struct thread *td, |
| 286 |
int islocked, int killkn); |
| 287 |
#define knlist_clear(knl, islocked) \ |
| 288 |
knlist_cleardel((knl), NULL, (islocked), 0) |
| 289 |
#define knlist_delete(knl, td, islocked) \ |
| 290 |
knlist_cleardel((knl), (td), (islocked), 1) |
| 291 |
void knote_fdclose(struct thread *p, int fd); |
| 292 |
int kqfd_register(int fd, struct kevent *kev, struct thread *p, |
| 293 |
int waitok); |
| 294 |
int kqueue_add_filteropts(int filt, struct filterops *filtops); |
| 295 |
int kqueue_del_filteropts(int filt); |
| 296 |
|
| 297 |
#else /* !_KERNEL */ |
| 298 |
|
| 299 |
#include <sys/cdefs.h> |
| 300 |
struct timespec; |
| 301 |
|
| 302 |
__BEGIN_DECLS |
| 303 |
int kqueue(void); |
| 304 |
int kevent(int kq, const struct kevent *changelist, int nchanges, |
| 305 |
struct kevent *eventlist, int nevents, |
| 306 |
const struct timespec *timeout); |
| 307 |
__END_DECLS |
| 308 |
|
| 309 |
#endif /* !_KERNEL */ |
| 310 |
|
| 311 |
#endif /* !_SYS_EVENT_H_ */ |
