1 /* $NetBSD: event.h,v 1.3 2002/10/23 09:14:55 jdolecek Exp $ */ 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: src/sys/sys/event.h,v 1.12 2001/02/24 01:44:03 jlemon Exp $ 28 */ 29 30 #ifndef _SYS_EVENT_H_ 31 #define _SYS_EVENT_H_ 32 33 #include <sys/inttypes.h> /* for uintptr_t */ 34 #include <sys/null.h> /* for NULL */ 35 36 #define EVFILT_READ 0 37 #define EVFILT_WRITE 1 38 #define EVFILT_AIO 2 /* attached to aio requests */ 39 #define EVFILT_VNODE 3 /* attached to vnodes */ 40 #define EVFILT_PROC 4 /* attached to struct proc */ 41 #define EVFILT_SIGNAL 5 /* attached to struct proc */ 42 #define EVFILT_SYSCOUNT 6 /* number of filters */ 43 44 #define EV_SET(kevp, a, b, c, d, e, f) \ 45 do { \ 46 (kevp)->ident = (a); \ 47 (kevp)->filter = (b); \ 48 (kevp)->flags = (c); \ 49 (kevp)->fflags = (d); \ 50 (kevp)->data = (e); \ 51 (kevp)->udata = (f); \ 52 } while (/* CONSTCOND */ 0) 53 54 55 struct kevent { 56 uintptr_t ident; /* identifier for this event */ 57 uint32_t filter; /* filter for event */ 58 uint32_t flags; /* action flags for kqueue */ 59 uint32_t fflags; /* filter flag value */ 60 int64_t data; /* filter data value */ 61 intptr_t udata; /* opaque user data identifier */ 62 }; 63 64 /* actions */ 65 #define EV_ADD 0x0001 /* add event to kq (implies ENABLE) */ 66 #define EV_DELETE 0x0002 /* delete event from kq */ 67 #define EV_ENABLE 0x0004 /* enable event */ 68 #define EV_DISABLE 0x0008 /* disable event (not reported) */ 69 70 /* flags */ 71 #define EV_ONESHOT 0x0010 /* only report one occurrence */ 72 #define EV_CLEAR 0x0020 /* clear event state after reporting */ 73 74 #define EV_SYSFLAGS 0xF000 /* reserved by system */ 75 #define EV_FLAG1 0x2000 /* filter-specific flag */ 76 77 /* returned values */ 78 #define EV_EOF 0x8000 /* EOF detected */ 79 #define EV_ERROR 0x4000 /* error, data contains errno */ 80 81 /* 82 * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace 83 */ 84 #define NOTE_LOWAT 0x0001 /* low water mark */ 85 86 /* 87 * data/hint flags for EVFILT_VNODE, shared with userspace 88 */ 89 #define NOTE_DELETE 0x0001 /* vnode was removed */ 90 #define NOTE_WRITE 0x0002 /* data contents changed */ 91 #define NOTE_EXTEND 0x0004 /* size increased */ 92 #define NOTE_ATTRIB 0x0008 /* attributes changed */ 93 #define NOTE_LINK 0x0010 /* link count changed */ 94 #define NOTE_RENAME 0x0020 /* vnode was renamed */ 95 #define NOTE_REVOKE 0x0040 /* vnode access was revoked */ 96 97 /* 98 * data/hint flags for EVFILT_PROC, shared with userspace 99 */ 100 #define NOTE_EXIT 0x80000000 /* process exited */ 101 #define NOTE_FORK 0x40000000 /* process forked */ 102 #define NOTE_EXEC 0x20000000 /* process exec'd */ 103 #define NOTE_PCTRLMASK 0xf0000000 /* mask for hint bits */ 104 #define NOTE_PDATAMASK 0x000fffff /* mask for pid */ 105 106 /* additional flags for EVFILT_PROC */ 107 #define NOTE_TRACK 0x00000001 /* follow across forks */ 108 #define NOTE_TRACKERR 0x00000002 /* could not track child */ 109 #define NOTE_CHILD 0x00000004 /* am a child process */ 110 111 /* 112 * This is currently visible to userland to work around broken 113 * programs which pull in <sys/proc.h> or <sys/select.h>. 114 */ 115 #include <sys/queue.h> 116 struct knote; 117 SLIST_HEAD(klist, knote); 118 119 120 /* 121 * ioctl(2)s supported on kqueue descriptors. 122 */ 123 #include <sys/ioctl.h> 124 125 struct kfilter_mapping { 126 char *name; /* name to lookup or return */ 127 size_t len; /* length of name */ 128 uint32_t filter; /* filter to lookup or return */ 129 }; 130 131 /* map filter to name (max size len) */ 132 #define KFILTER_BYFILTER _IOWR('k', 0, struct kfilter_mapping) 133 /* map name to filter (len ignored) */ 134 #define KFILTER_BYNAME _IOWR('k', 1, struct kfilter_mapping) 135 136 #ifdef _KERNEL 137 138 #define KNOTE(list, hint) if (!SLIST_EMPTY(list)) knote(list, hint) 139 140 /* 141 * Flag indicating hint is a signal. Used by EVFILT_SIGNAL, and also 142 * shared by EVFILT_PROC (all knotes attached to p->p_klist) 143 */ 144 #define NOTE_SIGNAL 0x08000000 145 146 /* 147 * Callback methods for each filter type. 148 */ 149 struct filterops { 150 int f_isfd; /* true if ident == filedescriptor */ 151 int (*f_attach) __P((struct knote *kn)); 152 /* called when knote is ADDed */ 153 void (*f_detach) __P((struct knote *kn)); 154 /* called when knote is DELETEd */ 155 int (*f_event) __P((struct knote *kn, long hint)); 156 /* called when event is triggered */ 157 }; 158 159 struct knote { 160 SLIST_ENTRY(knote) kn_link; /* for fd */ 161 SLIST_ENTRY(knote) kn_selnext; /* for struct selinfo */ 162 TAILQ_ENTRY(knote) kn_tqe; 163 struct kqueue *kn_kq; /* which queue we are on */ 164 struct kevent kn_kevent; 165 uint32_t kn_status; 166 uint32_t kn_sfflags; /* saved filter flags */ 167 uintptr_t kn_sdata; /* saved data field */ 168 union { 169 struct file *p_fp; /* file data pointer */ 170 struct proc *p_proc; /* proc pointer */ 171 void *p_opaque; /* opaque/misc pointer */ 172 } kn_ptr; 173 const struct filterops *kn_fop; 174 void *kn_hook; 175 176 #define KN_ACTIVE 0x01 /* event has been triggered */ 177 #define KN_QUEUED 0x02 /* event is on queue */ 178 #define KN_DISABLED 0x04 /* event is disabled */ 179 #define KN_DETACHED 0x08 /* knote is detached */ 180 181 #define kn_id kn_kevent.ident 182 #define kn_filter kn_kevent.filter 183 #define kn_flags kn_kevent.flags 184 #define kn_fflags kn_kevent.fflags 185 #define kn_data kn_kevent.data 186 #define kn_fp kn_ptr.p_fp 187 }; 188 189 struct proc; 190 191 void kqueue_init(void); 192 193 void knote(struct klist *list, long hint); 194 void knote_remove(struct proc *p, struct klist *list); 195 void knote_fdclose(struct proc *p, int fd); 196 int kqueue_register(struct kqueue *kq, 197 struct kevent *kev, struct proc *p); 198 199 int kfilter_register(const char *name, 200 const struct filterops *filtops, int *retfilter); 201 int kfilter_unregister(const char *name); 202 203 int filt_seltrue(struct knote *kn, long hint); 204 int seltrue_kqfilter(dev_t dev, struct knote *kn); 205 206 #else /* !_KERNEL */ 207 208 #include <sys/cdefs.h> 209 struct timespec; 210 211 __BEGIN_DECLS 212 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE) 213 int kqueue __P((void)); 214 int kevent __P((int kq, const struct kevent *changelist, size_t nchanges, 215 struct kevent *eventlist, size_t nevents, 216 const struct timespec *timeout)); 217 #endif /* !_POSIX_C_SOURCE */ 218 __END_DECLS 219 220 #endif /* !_KERNEL */ 221 222 #endif /* !_SYS_EVENT_H_ */ 223