1 /* $OpenBSD: event.h,v 1.9 2004/01/12 04:47:01 tedu Exp $ */ 2 3 /*- 4 * Copyright (c) 1999,2000,2001 Jonathan Lemon <jlemon@FreeBSD.org> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD: src/sys/sys/event.h,v 1.11 2001/02/24 01:41:31 jlemon Exp $ 29 */ 30 31 #ifndef _SYS_EVENT_H_ 32 #define _SYS_EVENT_H_ 33 34 #define EVFILT_READ (-1) 35 #define EVFILT_WRITE (-2) 36 #define EVFILT_AIO (-3) /* attached to aio requests */ 37 #define EVFILT_VNODE (-4) /* attached to vnodes */ 38 #define EVFILT_PROC (-5) /* attached to struct proc */ 39 #define EVFILT_SIGNAL (-6) /* attached to struct proc */ 40 41 #define EVFILT_SYSCOUNT 6 42 43 #define EV_SET(kevp, a, b, c, d, e, f) do { \ 44 (kevp)->ident = (a); \ 45 (kevp)->filter = (b); \ 46 (kevp)->flags = (c); \ 47 (kevp)->fflags = (d); \ 48 (kevp)->data = (e); \ 49 (kevp)->udata = (f); \ 50 } while(0) 51 52 struct kevent { 53 u_int ident; /* identifier for this event */ 54 short filter; /* filter for event */ 55 u_short flags; 56 u_int fflags; 57 int data; 58 void *udata; /* opaque user data identifier */ 59 }; 60 61 /* actions */ 62 #define EV_ADD 0x0001 /* add event to kq (implies enable) */ 63 #define EV_DELETE 0x0002 /* delete event from kq */ 64 #define EV_ENABLE 0x0004 /* enable event */ 65 #define EV_DISABLE 0x0008 /* disable event (not reported) */ 66 67 /* flags */ 68 #define EV_ONESHOT 0x0010 /* only report one occurrence */ 69 #define EV_CLEAR 0x0020 /* clear event state after reporting */ 70 71 #define EV_SYSFLAGS 0xF000 /* reserved by system */ 72 #define EV_FLAG1 0x2000 /* filter-specific flag */ 73 74 /* returned values */ 75 #define EV_EOF 0x8000 /* EOF detected */ 76 #define EV_ERROR 0x4000 /* error, data contains errno */ 77 78 /* 79 * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace 80 */ 81 #define NOTE_LOWAT 0x0001 /* low water mark */ 82 #define NOTE_EOF 0x0002 /* return on EOF */ 83 84 /* 85 * data/hint flags for EVFILT_VNODE, shared with userspace 86 */ 87 #define NOTE_DELETE 0x0001 /* vnode was removed */ 88 #define NOTE_WRITE 0x0002 /* data contents changed */ 89 #define NOTE_EXTEND 0x0004 /* size increased */ 90 #define NOTE_ATTRIB 0x0008 /* attributes changed */ 91 #define NOTE_LINK 0x0010 /* link count changed */ 92 #define NOTE_RENAME 0x0020 /* vnode was renamed */ 93 #define NOTE_REVOKE 0x0040 /* vnode access was revoked */ 94 #define NOTE_TRUNCATE 0x0080 /* vnode was truncated */ 95 96 /* 97 * data/hint flags for EVFILT_PROC, shared with userspace 98 */ 99 #define NOTE_EXIT 0x80000000 /* process exited */ 100 #define NOTE_FORK 0x40000000 /* process forked */ 101 #define NOTE_EXEC 0x20000000 /* process exec'd */ 102 #define NOTE_PCTRLMASK 0xf0000000 /* mask for hint bits */ 103 #define NOTE_PDATAMASK 0x000fffff /* mask for pid */ 104 105 /* additional flags for EVFILT_PROC */ 106 #define NOTE_TRACK 0x00000001 /* follow across forks */ 107 #define NOTE_TRACKERR 0x00000002 /* could not track child */ 108 #define NOTE_CHILD 0x00000004 /* am a child process */ 109 110 /* 111 * This is currently visible to userland to work around broken 112 * programs which pull in <sys/proc.h> or <sys/select.h>. 113 */ 114 #include <sys/queue.h> 115 struct knote; 116 SLIST_HEAD(klist, knote); 117 118 #ifdef _KERNEL 119 120 #define KNOTE(list, hint) if ((list) != NULL) knote(list, hint) 121 122 /* 123 * Flag indicating hint is a signal. Used by EVFILT_SIGNAL, and also 124 * shared by EVFILT_PROC (all knotes attached to p->p_klist) 125 */ 126 #define NOTE_SIGNAL 0x08000000 127 128 struct filterops { 129 int f_isfd; /* true if ident == filedescriptor */ 130 int (*f_attach)(struct knote *kn); 131 void (*f_detach)(struct knote *kn); 132 int (*f_event)(struct knote *kn, long hint); 133 }; 134 135 struct knote { 136 SLIST_ENTRY(knote) kn_link; /* for fd */ 137 SLIST_ENTRY(knote) kn_selnext; /* for struct selinfo */ 138 TAILQ_ENTRY(knote) kn_tqe; 139 struct kqueue *kn_kq; /* which queue we are on */ 140 struct kevent kn_kevent; 141 int kn_status; 142 int kn_sfflags; /* saved filter flags */ 143 int kn_sdata; /* saved data field */ 144 union { 145 struct file *p_fp; /* file data pointer */ 146 struct proc *p_proc; /* proc pointer */ 147 } kn_ptr; 148 const struct filterops *kn_fop; 149 void *kn_hook; 150 #define KN_ACTIVE 0x01 /* event has been triggered */ 151 #define KN_QUEUED 0x02 /* event is on queue */ 152 #define KN_DISABLED 0x04 /* event is disabled */ 153 #define KN_DETACHED 0x08 /* knote is detached */ 154 155 #define kn_id kn_kevent.ident 156 #define kn_filter kn_kevent.filter 157 #define kn_flags kn_kevent.flags 158 #define kn_fflags kn_kevent.fflags 159 #define kn_data kn_kevent.data 160 #define kn_fp kn_ptr.p_fp 161 }; 162 163 struct proc; 164 165 extern void knote(struct klist *list, long hint); 166 extern void knote_remove(struct proc *p, struct klist *list); 167 extern void knote_fdclose(struct proc *p, int fd); 168 extern int kqueue_register(struct kqueue *kq, 169 struct kevent *kev, struct proc *p); 170 extern int filt_seltrue(struct knote *kn, long hint); 171 extern void klist_invalidate(struct klist *); 172 173 #else /* !_KERNEL */ 174 175 #include <sys/cdefs.h> 176 struct timespec; 177 178 __BEGIN_DECLS 179 int kqueue(void); 180 int kevent(int kq, const struct kevent *changelist, int nchanges, 181 struct kevent *eventlist, int nevents, 182 const struct timespec *timeout); 183 __END_DECLS 184 185 #endif /* !_KERNEL */ 186 187 #endif /* !_SYS_EVENT_H_ */ 188