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: src/sys/sys/event.h,v 1.5.2.6 2003/02/09 15:28:13 nectar Exp $ 27 * $DragonFly: src/sys/sys/event.h,v 1.7 2007/01/15 01:26:56 dillon Exp $ 28 */ 29 30 #ifndef _SYS_EVENT_H_ 31 #define _SYS_EVENT_H_ 32 33 #ifndef _SYS_TYPES_H_ 34 #include <sys/types.h> 35 #endif 36 #ifndef _NET_NETISR_H_ 37 #include <net/netisr.h> /* struct notifymsglist */ 38 #endif 39 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 40 #include <sys/queue.h> 41 #endif 42 43 #define EVFILT_READ (-1) 44 #define EVFILT_WRITE (-2) 45 #define EVFILT_AIO (-3) /* attached to aio requests */ 46 #define EVFILT_VNODE (-4) /* attached to vnodes */ 47 #define EVFILT_PROC (-5) /* attached to struct proc */ 48 #define EVFILT_SIGNAL (-6) /* attached to struct proc */ 49 #define EVFILT_TIMER (-7) /* timers */ 50 #define EVFILT_EXCEPT (-8) /* exceptional conditions */ 51 52 #define EVFILT_MARKER 0xF /* placemarker for tailq */ 53 54 #define EVFILT_SYSCOUNT 8 55 56 #define EV_SET(kevp_, a, b, c, d, e, f) do { \ 57 struct kevent *kevp = (kevp_); \ 58 (kevp)->ident = (a); \ 59 (kevp)->filter = (b); \ 60 (kevp)->flags = (c); \ 61 (kevp)->fflags = (d); \ 62 (kevp)->data = (e); \ 63 (kevp)->udata = (f); \ 64 } while(0) 65 66 struct kevent { 67 uintptr_t ident; /* identifier for this event */ 68 short filter; /* filter for event */ 69 u_short flags; 70 u_int fflags; 71 intptr_t data; 72 void *udata; /* opaque user data identifier */ 73 }; 74 75 /* actions */ 76 #define EV_ADD 0x0001 /* add event to kq (implies enable) */ 77 #define EV_DELETE 0x0002 /* delete event from kq */ 78 #define EV_ENABLE 0x0004 /* enable event */ 79 #define EV_DISABLE 0x0008 /* disable event (not reported) */ 80 81 /* flags */ 82 #define EV_ONESHOT 0x0010 /* only report one occurrence */ 83 #define EV_CLEAR 0x0020 /* clear event state after reporting */ 84 85 #define EV_SYSFLAGS 0xF000 /* reserved by system */ 86 #define EV_FLAG1 0x2000 /* filter-specific flag */ 87 88 /* returned values */ 89 #define EV_EOF 0x8000 /* EOF detected */ 90 #define EV_ERROR 0x4000 /* error, data contains errno */ 91 92 /* 93 * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace 94 */ 95 #define NOTE_LOWAT 0x0001 /* low water mark */ 96 97 /* 98 * data/hint flags for EVFILT_EXCEPT, shared with userspace and with 99 * EVFILT_{READ|WRITE} 100 */ 101 #define NOTE_OOB 0x0002 /* OOB data on a socket */ 102 103 /* 104 * data/hint flags for EVFILT_VNODE, shared with userspace 105 */ 106 #define NOTE_DELETE 0x0001 /* vnode was removed */ 107 #define NOTE_WRITE 0x0002 /* data contents changed */ 108 #define NOTE_EXTEND 0x0004 /* size increased */ 109 #define NOTE_ATTRIB 0x0008 /* attributes changed */ 110 #define NOTE_LINK 0x0010 /* link count changed */ 111 #define NOTE_RENAME 0x0020 /* vnode was renamed */ 112 #define NOTE_REVOKE 0x0040 /* vnode access was revoked */ 113 114 /* 115 * data/hint flags for EVFILT_PROC, shared with userspace 116 */ 117 #define NOTE_EXIT 0x80000000 /* process exited */ 118 #define NOTE_FORK 0x40000000 /* process forked */ 119 #define NOTE_EXEC 0x20000000 /* process exec'd */ 120 #define NOTE_PCTRLMASK 0xf0000000 /* mask for hint bits */ 121 #define NOTE_PDATAMASK 0x000fffff /* mask for pid */ 122 123 /* additional flags for EVFILT_PROC */ 124 #define NOTE_TRACK 0x00000001 /* follow across forks */ 125 #define NOTE_TRACKERR 0x00000002 /* could not track child */ 126 #define NOTE_CHILD 0x00000004 /* am a child process */ 127 128 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 129 130 struct knote; 131 SLIST_HEAD(klist, knote); 132 133 /* 134 * Used to maintain information about processes that wish to be 135 * notified when I/O becomes possible. 136 */ 137 struct kqinfo { 138 struct klist ki_note; /* kernel note list */ 139 struct notifymsglist ki_mlist; /* list of pending predicate messages */ 140 }; 141 142 #endif 143 144 #ifdef _KERNEL 145 146 /* 147 * Global token for kqueue subsystem 148 */ 149 extern struct lwkt_token kq_token; 150 151 #ifdef MALLOC_DECLARE 152 MALLOC_DECLARE(M_KQUEUE); 153 #endif 154 155 #define KNOTE(list, hint) if ((list) != NULL) knote(list, hint) 156 157 /* 158 * Flag indicating hint is a signal. Used by EVFILT_SIGNAL, and also 159 * shared by EVFILT_PROC (all knotes attached to p->p_klist) 160 * 161 * NOTE_OLDAPI is used to signal that standard filters are being called 162 * from the select/poll wrapper. 163 */ 164 #define NOTE_SIGNAL 0x08000000 165 #define NOTE_OLDAPI 0x04000000 /* select/poll note */ 166 167 #define FILTEROP_ISFD 0x0001 /* if ident == filedescriptor */ 168 #define FILTEROP_MPSAFE 0x0002 169 170 struct filterops { 171 u_short f_flags; 172 173 /* f_attach returns 0 on success or valid error code on failure */ 174 int (*f_attach) (struct knote *kn); 175 void (*f_detach) (struct knote *kn); 176 177 /* f_event returns boolean truth */ 178 int (*f_event) (struct knote *kn, long hint); 179 }; 180 181 struct knote { 182 SLIST_ENTRY(knote) kn_link; /* for fd */ 183 TAILQ_ENTRY(knote) kn_kqlink; /* for kq_knlist */ 184 SLIST_ENTRY(knote) kn_next; /* for struct kqinfo */ 185 TAILQ_ENTRY(knote) kn_tqe; /* for kq_head */ 186 struct kqueue *kn_kq; /* which queue we are on */ 187 struct kevent kn_kevent; 188 int kn_status; 189 int kn_sfflags; /* saved filter flags */ 190 intptr_t kn_sdata; /* saved data field */ 191 union { 192 struct file *p_fp; /* file data pointer */ 193 struct proc *p_proc; /* proc pointer */ 194 } kn_ptr; 195 struct filterops *kn_fop; 196 caddr_t kn_hook; 197 }; 198 199 #define KN_ACTIVE 0x0001 /* event has been triggered */ 200 #define KN_QUEUED 0x0002 /* event is on queue */ 201 #define KN_DISABLED 0x0004 /* event is disabled */ 202 #define KN_DETACHED 0x0008 /* knote is detached */ 203 #define KN_REPROCESS 0x0010 /* force reprocessing race */ 204 #define KN_DELETING 0x0020 /* deletion in progress */ 205 #define KN_PROCESSING 0x0040 /* event processing in prog */ 206 #define KN_WAITING 0x0080 /* waiting on processing */ 207 208 #define kn_id kn_kevent.ident 209 #define kn_filter kn_kevent.filter 210 #define kn_flags kn_kevent.flags 211 #define kn_fflags kn_kevent.fflags 212 #define kn_data kn_kevent.data 213 #define kn_fp kn_ptr.p_fp 214 215 struct proc; 216 struct thread; 217 struct filedesc; 218 struct kevent_args; 219 220 typedef int (*k_copyout_fn)(void *arg, struct kevent *kevp, int count, 221 int *res); 222 typedef int (*k_copyin_fn)(void *arg, struct kevent *kevp, int max, 223 int *events); 224 int kern_kevent(struct kqueue *kq, int nevents, int *res, void *uap, 225 k_copyin_fn kevent_copyin, k_copyout_fn kevent_copyout, 226 struct timespec *tsp); 227 228 extern void knote(struct klist *list, long hint); 229 extern void knote_insert(struct klist *klist, struct knote *kn); 230 extern void knote_remove(struct klist *klist, struct knote *kn); 231 extern void knote_empty(struct klist *list); 232 extern void knote_fdclose(struct file *fp, struct filedesc *fdp, int fd); 233 extern void kqueue_init(struct kqueue *kq, struct filedesc *fdp); 234 extern void kqueue_terminate(struct kqueue *kq); 235 extern int kqueue_register(struct kqueue *kq, struct kevent *kev); 236 237 #endif /* _KERNEL */ 238 239 #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL) 240 241 #include <sys/cdefs.h> 242 struct timespec; 243 244 __BEGIN_DECLS 245 int kqueue (void); 246 int kevent (int, const struct kevent *, int, struct kevent *, 247 int, const struct timespec *); 248 __END_DECLS 249 #endif /* !_KERNEL */ 250 251 #endif /* !_SYS_EVENT_H_ */ 252