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 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 45 #define EVFILT_SYSCOUNT 7 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 57 struct 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 76 #define EV_SYSFLAGS 0xF000 /* reserved by system */ 77 #define EV_FLAG1 0x2000 /* filter-specific flag */ 78 79 /* returned values */ 80 #define EV_EOF 0x8000 /* EOF detected */ 81 #define EV_ERROR 0x4000 /* error, data contains errno */ 82 83 /* 84 * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace 85 */ 86 #define NOTE_LOWAT 0x0001 /* low water mark */ 87 88 /* 89 * data/hint flags for EVFILT_VNODE, shared with userspace 90 */ 91 #define NOTE_DELETE 0x0001 /* vnode was removed */ 92 #define NOTE_WRITE 0x0002 /* data contents changed */ 93 #define NOTE_EXTEND 0x0004 /* size increased */ 94 #define NOTE_ATTRIB 0x0008 /* attributes changed */ 95 #define NOTE_LINK 0x0010 /* link count changed */ 96 #define NOTE_RENAME 0x0020 /* vnode was renamed */ 97 #define NOTE_REVOKE 0x0040 /* vnode access was revoked */ 98 99 /* 100 * data/hint flags for EVFILT_PROC, shared with userspace 101 */ 102 #define NOTE_EXIT 0x80000000 /* process exited */ 103 #define NOTE_FORK 0x40000000 /* process forked */ 104 #define NOTE_EXEC 0x20000000 /* process exec'd */ 105 #define NOTE_PCTRLMASK 0xf0000000 /* mask for hint bits */ 106 #define NOTE_PDATAMASK 0x000fffff /* mask for pid */ 107 108 /* additional flags for EVFILT_PROC */ 109 #define NOTE_TRACK 0x00000001 /* follow across forks */ 110 #define NOTE_TRACKERR 0x00000002 /* could not track child */ 111 #define NOTE_CHILD 0x00000004 /* am a child process */ 112 113 /* 114 * This is currently visible to userland to work around broken 115 * programs which pull in <sys/proc.h> or <sys/select.h>. 116 */ 117 #include <sys/queue.h> 118 struct knote; 119 SLIST_HEAD(klist, knote); 120 121 #ifdef _KERNEL 122 123 #ifdef MALLOC_DECLARE 124 MALLOC_DECLARE(M_KQUEUE); 125 #endif 126 127 #define KNOTE(list, hint) if ((list) != NULL) knote(list, hint) 128 129 /* 130 * Flag indicating hint is a signal. Used by EVFILT_SIGNAL, and also 131 * shared by EVFILT_PROC (all knotes attached to p->p_klist) 132 */ 133 #define NOTE_SIGNAL 0x08000000 134 135 struct filterops { 136 int f_isfd; /* true if ident == filedescriptor */ 137 int (*f_attach) (struct knote *kn); 138 void (*f_detach) (struct knote *kn); 139 int (*f_event) (struct knote *kn, long hint); 140 }; 141 142 struct knote { 143 SLIST_ENTRY(knote) kn_link; /* for fd */ 144 TAILQ_ENTRY(knote) kn_kqlink; /* for kq_knlist */ 145 SLIST_ENTRY(knote) kn_selnext; /* for struct selinfo */ 146 TAILQ_ENTRY(knote) kn_tqe; /* for kq_head */ 147 struct kqueue *kn_kq; /* which queue we are on */ 148 struct kevent kn_kevent; 149 int kn_status; 150 int kn_sfflags; /* saved filter flags */ 151 intptr_t kn_sdata; /* saved data field */ 152 union { 153 struct file *p_fp; /* file data pointer */ 154 struct proc *p_proc; /* proc pointer */ 155 } kn_ptr; 156 struct filterops *kn_fop; 157 caddr_t kn_hook; 158 #define KN_ACTIVE 0x01 /* event has been triggered */ 159 #define KN_QUEUED 0x02 /* event is on queue */ 160 #define KN_DISABLED 0x04 /* event is disabled */ 161 #define KN_DETACHED 0x08 /* knote is detached */ 162 163 #define kn_id kn_kevent.ident 164 #define kn_filter kn_kevent.filter 165 #define kn_flags kn_kevent.flags 166 #define kn_fflags kn_kevent.fflags 167 #define kn_data kn_kevent.data 168 #define kn_fp kn_ptr.p_fp 169 }; 170 171 struct proc; 172 struct thread; 173 struct filedesc; 174 struct kevent_args; 175 176 typedef int (*k_copyout_fn)(void *arg, struct kevent *kevp, int count); 177 typedef int (*k_copyin_fn)(void *arg, struct kevent *kevp, int count); 178 int kern_kevent(int fd, int nchanges, int nevents, struct kevent_args *uap, 179 k_copyin_fn kevent_copyin, k_copyout_fn kevent_copyout, 180 struct timespec *tsp); 181 182 extern void knote(struct klist *list, long hint); 183 extern void knote_remove(struct klist *list); 184 extern void knote_fdclose(struct file *fp, struct filedesc *fdp, int fd); 185 extern void kqueue_init(struct kqueue *kq, struct filedesc *fdp); 186 extern void kqueue_terminate(struct kqueue *kq); 187 extern int kqueue_register(struct kqueue *kq, struct kevent *kev); 188 189 #endif /* _KERNEL */ 190 191 #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL) 192 193 #include <sys/cdefs.h> 194 struct timespec; 195 196 __BEGIN_DECLS 197 int kqueue (void); 198 int kevent (int, const struct kevent *, int, struct kevent *, 199 int, const struct timespec *); 200 __END_DECLS 201 #endif /* !_KERNEL */ 202 203 #endif /* !_SYS_EVENT_H_ */ 204