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.5 2004/02/25 17:38:51 joerg Exp $ 28 */ 29 30 #ifndef _SYS_EVENT_H_ 31 #define _SYS_EVENT_H_ 32 33 #define EVFILT_READ (-1) 34 #define EVFILT_WRITE (-2) 35 #define EVFILT_AIO (-3) /* attached to aio requests */ 36 #define EVFILT_VNODE (-4) /* attached to vnodes */ 37 #define EVFILT_PROC (-5) /* attached to struct proc */ 38 #define EVFILT_SIGNAL (-6) /* attached to struct proc */ 39 #define EVFILT_TIMER (-7) /* timers */ 40 41 #define EVFILT_SYSCOUNT 7 42 43 #define EV_SET(kevp_, a, b, c, d, e, f) do { \ 44 struct kevent *kevp = (kevp_); \ 45 (kevp)->ident = (a); \ 46 (kevp)->filter = (b); \ 47 (kevp)->flags = (c); \ 48 (kevp)->fflags = (d); \ 49 (kevp)->data = (e); \ 50 (kevp)->udata = (f); \ 51 } while(0) 52 53 struct kevent { 54 uintptr_t ident; /* identifier for this event */ 55 short filter; /* filter for event */ 56 u_short flags; 57 u_int fflags; 58 intptr_t data; 59 void *udata; /* opaque user data identifier */ 60 }; 61 62 /* actions */ 63 #define EV_ADD 0x0001 /* add event to kq (implies enable) */ 64 #define EV_DELETE 0x0002 /* delete event from kq */ 65 #define EV_ENABLE 0x0004 /* enable event */ 66 #define EV_DISABLE 0x0008 /* disable event (not reported) */ 67 68 /* flags */ 69 #define EV_ONESHOT 0x0010 /* only report one occurrence */ 70 #define EV_CLEAR 0x0020 /* clear event state after reporting */ 71 72 #define EV_SYSFLAGS 0xF000 /* reserved by system */ 73 #define EV_FLAG1 0x2000 /* filter-specific flag */ 74 75 /* returned values */ 76 #define EV_EOF 0x8000 /* EOF detected */ 77 #define EV_ERROR 0x4000 /* error, data contains errno */ 78 79 /* 80 * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace 81 */ 82 #define NOTE_LOWAT 0x0001 /* low water mark */ 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 95 /* 96 * data/hint flags for EVFILT_PROC, shared with userspace 97 */ 98 #define NOTE_EXIT 0x80000000 /* process exited */ 99 #define NOTE_FORK 0x40000000 /* process forked */ 100 #define NOTE_EXEC 0x20000000 /* process exec'd */ 101 #define NOTE_PCTRLMASK 0xf0000000 /* mask for hint bits */ 102 #define NOTE_PDATAMASK 0x000fffff /* mask for pid */ 103 104 /* additional flags for EVFILT_PROC */ 105 #define NOTE_TRACK 0x00000001 /* follow across forks */ 106 #define NOTE_TRACKERR 0x00000002 /* could not track child */ 107 #define NOTE_CHILD 0x00000004 /* am a child process */ 108 109 /* 110 * This is currently visible to userland to work around broken 111 * programs which pull in <sys/proc.h> or <sys/select.h>. 112 */ 113 #include <sys/queue.h> 114 struct knote; 115 SLIST_HEAD(klist, knote); 116 117 #ifdef _KERNEL 118 119 #ifdef MALLOC_DECLARE 120 MALLOC_DECLARE(M_KQUEUE); 121 #endif 122 123 #define KNOTE(list, hint) if ((list) != NULL) knote(list, hint) 124 125 /* 126 * Flag indicating hint is a signal. Used by EVFILT_SIGNAL, and also 127 * shared by EVFILT_PROC (all knotes attached to p->p_klist) 128 */ 129 #define NOTE_SIGNAL 0x08000000 130 131 struct filterops { 132 int f_isfd; /* true if ident == filedescriptor */ 133 int (*f_attach) (struct knote *kn); 134 void (*f_detach) (struct knote *kn); 135 int (*f_event) (struct knote *kn, long hint); 136 }; 137 138 struct knote { 139 SLIST_ENTRY(knote) kn_link; /* for fd */ 140 SLIST_ENTRY(knote) kn_selnext; /* for struct selinfo */ 141 TAILQ_ENTRY(knote) kn_tqe; 142 struct kqueue *kn_kq; /* which queue we are on */ 143 struct kevent kn_kevent; 144 int kn_status; 145 int kn_sfflags; /* saved filter flags */ 146 intptr_t kn_sdata; /* saved data field */ 147 union { 148 struct file *p_fp; /* file data pointer */ 149 struct proc *p_proc; /* proc pointer */ 150 } kn_ptr; 151 struct filterops *kn_fop; 152 caddr_t kn_hook; 153 #define KN_ACTIVE 0x01 /* event has been triggered */ 154 #define KN_QUEUED 0x02 /* event is on queue */ 155 #define KN_DISABLED 0x04 /* event is disabled */ 156 #define KN_DETACHED 0x08 /* knote is detached */ 157 158 #define kn_id kn_kevent.ident 159 #define kn_filter kn_kevent.filter 160 #define kn_flags kn_kevent.flags 161 #define kn_fflags kn_kevent.fflags 162 #define kn_data kn_kevent.data 163 #define kn_fp kn_ptr.p_fp 164 }; 165 166 struct proc; 167 struct thread; 168 169 extern void knote(struct klist *list, long hint); 170 extern void knote_remove(struct thread *td, struct klist *list); 171 extern void knote_fdclose(struct proc *p, int fd); 172 extern int kqueue_register(struct kqueue *kq, 173 struct kevent *kev, struct thread *td); 174 175 #else /* !_KERNEL */ 176 177 #include <sys/cdefs.h> 178 struct timespec; 179 180 __BEGIN_DECLS 181 int kqueue (void); 182 int kevent (int, const struct kevent *, int, struct kevent *, 183 int, const struct timespec *); 184 __END_DECLS 185 186 #endif /* !_KERNEL */ 187 188 #endif /* !_SYS_EVENT_H_ */ 189