]>
Commit | Line | Data |
---|---|---|
55e303ae | 1 | /* |
91447636 | 2 | * Copyright (c) 2003-2005 Apple Computer, Inc. All rights reserved. |
55e303ae | 3 | * |
8f6c56a5 | 4 | * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ |
55e303ae | 5 | * |
8f6c56a5 A |
6 | * This file contains Original Code and/or Modifications of Original Code |
7 | * as defined in and that are subject to the Apple Public Source License | |
8 | * Version 2.0 (the 'License'). You may not use this file except in | |
9 | * compliance with the License. The rights granted to you under the License | |
10 | * may not be used to create, or enable the creation or redistribution of, | |
11 | * unlawful or unlicensed copies of an Apple operating system, or to | |
12 | * circumvent, violate, or enable the circumvention or violation of, any | |
13 | * terms of an Apple operating system software license agreement. | |
14 | * | |
15 | * Please obtain a copy of the License at | |
16 | * http://www.opensource.apple.com/apsl/ and read it before using this file. | |
17 | * | |
18 | * The Original Code and all software distributed under the License are | |
19 | * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER | |
20 | * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, | |
21 | * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. | |
23 | * Please see the License for the specific language governing rights and | |
8ad349bb | 24 | * limitations under the License. |
8f6c56a5 A |
25 | * |
26 | * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ | |
55e303ae A |
27 | */ |
28 | /*- | |
29 | * Copyright (c) 1999,2000,2001 Jonathan Lemon <jlemon@FreeBSD.org> | |
30 | * All rights reserved. | |
31 | * | |
32 | * Redistribution and use in source and binary forms, with or without | |
33 | * modification, are permitted provided that the following conditions | |
34 | * are met: | |
35 | * 1. Redistributions of source code must retain the above copyright | |
36 | * notice, this list of conditions and the following disclaimer. | |
37 | * 2. Redistributions in binary form must reproduce the above copyright | |
38 | * notice, this list of conditions and the following disclaimer in the | |
39 | * documentation and/or other materials provided with the distribution. | |
40 | * | |
41 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | |
42 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
43 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
44 | * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | |
45 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
46 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
47 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
48 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
49 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
50 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
51 | * SUCH DAMAGE. | |
52 | * | |
53 | * $FreeBSD: src/sys/sys/event.h,v 1.5.2.5 2001/12/14 19:21:22 jlemon Exp $ | |
54 | */ | |
55 | ||
56 | #ifndef _SYS_EVENT_H_ | |
57 | #define _SYS_EVENT_H_ | |
58 | ||
91447636 A |
59 | #include <machine/types.h> |
60 | #include <sys/cdefs.h> | |
61 | #include <stdint.h> | |
62 | ||
55e303ae A |
63 | #define EVFILT_READ (-1) |
64 | #define EVFILT_WRITE (-2) | |
65 | #define EVFILT_AIO (-3) /* attached to aio requests */ | |
66 | #define EVFILT_VNODE (-4) /* attached to vnodes */ | |
67 | #define EVFILT_PROC (-5) /* attached to struct proc */ | |
68 | #define EVFILT_SIGNAL (-6) /* attached to struct proc */ | |
69 | #define EVFILT_TIMER (-7) /* timers */ | |
70 | #define EVFILT_MACHPORT (-8) /* Mach ports */ | |
71 | #define EVFILT_FS (-9) /* Filesystem events */ | |
72 | ||
73 | #define EVFILT_SYSCOUNT 9 | |
91447636 A |
74 | #define EVFILT_THREADMARKER EVFILT_SYSCOUNT /* Internal use only */ |
75 | ||
4452a7af | 76 | #pragma pack(4) |
55e303ae A |
77 | |
78 | struct kevent { | |
79 | uintptr_t ident; /* identifier for this event */ | |
80 | short filter; /* filter for event */ | |
91447636 A |
81 | unsigned short flags; /* general flags */ |
82 | unsigned int fflags; /* filter-specific flags */ | |
83 | intptr_t data; /* filter-specific data */ | |
84 | #ifdef KERNEL_PRIVATE | |
85 | user_addr_t udata; /* opaque user data identifier */ | |
86 | #else | |
55e303ae | 87 | void *udata; /* opaque user data identifier */ |
91447636 A |
88 | #endif |
89 | }; | |
90 | ||
91 | #ifdef KERNEL_PRIVATE | |
92 | ||
93 | struct user_kevent { | |
94 | uint64_t ident; /* identifier for this event */ | |
95 | short filter; /* filter for event */ | |
96 | unsigned short flags; /* general flags */ | |
97 | unsigned int fflags; /* filter-specific flags */ | |
98 | int64_t data; /* filter-specific data */ | |
99 | user_addr_t udata; /* opaque user data identifier */ | |
55e303ae A |
100 | }; |
101 | ||
91447636 A |
102 | #endif |
103 | ||
4452a7af | 104 | #pragma pack() |
91447636 | 105 | |
55e303ae A |
106 | #define EV_SET(kevp, a, b, c, d, e, f) do { \ |
107 | struct kevent *__kevp__ = (kevp); \ | |
108 | __kevp__->ident = (a); \ | |
109 | __kevp__->filter = (b); \ | |
110 | __kevp__->flags = (c); \ | |
111 | __kevp__->fflags = (d); \ | |
112 | __kevp__->data = (e); \ | |
113 | __kevp__->udata = (f); \ | |
114 | } while(0) | |
115 | ||
116 | /* actions */ | |
117 | #define EV_ADD 0x0001 /* add event to kq (implies enable) */ | |
118 | #define EV_DELETE 0x0002 /* delete event from kq */ | |
119 | #define EV_ENABLE 0x0004 /* enable event */ | |
120 | #define EV_DISABLE 0x0008 /* disable event (not reported) */ | |
121 | ||
122 | /* flags */ | |
123 | #define EV_ONESHOT 0x0010 /* only report one occurrence */ | |
124 | #define EV_CLEAR 0x0020 /* clear event state after reporting */ | |
125 | ||
126 | #define EV_SYSFLAGS 0xF000 /* reserved by system */ | |
91447636 | 127 | #define EV_FLAG0 0x1000 /* filter-specific flag */ |
55e303ae A |
128 | #define EV_FLAG1 0x2000 /* filter-specific flag */ |
129 | ||
130 | /* returned values */ | |
131 | #define EV_EOF 0x8000 /* EOF detected */ | |
132 | #define EV_ERROR 0x4000 /* error, data contains errno */ | |
133 | ||
134 | /* | |
91447636 A |
135 | * Filter specific flags for EVFILT_READ |
136 | * | |
137 | * The default behavior for EVFILT_READ is to make the "read" determination | |
138 | * relative to the current file descriptor read pointer. The EV_POLL | |
139 | * flag indicates the determination should be made via poll(2) semantics | |
140 | * (which always returns true for regular files - regardless of the amount | |
141 | * of unread data in the file). | |
142 | * | |
143 | * On input, EV_OOBAND specifies that only OOB data should be looked for. | |
144 | * The returned data count is the number of bytes beyond the current OOB marker. | |
145 | * | |
146 | * On output, EV_OOBAND indicates that OOB data is present | |
147 | * If it was not specified as an input parameter, then the data count is the | |
148 | * number of bytes before the current OOB marker. If at the marker, the | |
149 | * data count indicates the number of bytes available after it. In either | |
150 | * case, it's the amount of data one could expect to receive next. | |
55e303ae | 151 | */ |
91447636 A |
152 | #define EV_POLL EV_FLAG0 |
153 | #define EV_OOBAND EV_FLAG1 | |
55e303ae A |
154 | |
155 | /* | |
91447636 A |
156 | * data/hint fflags for EVFILT_{READ|WRITE}, shared with userspace |
157 | * | |
158 | * The default behavior for EVFILT_READ is to make the determination | |
159 | * realtive to the current file descriptor read pointer. | |
160 | */ | |
161 | #define NOTE_LOWAT 0x00000001 /* low water mark */ | |
162 | /* | |
163 | * data/hint fflags for EVFILT_VNODE, shared with userspace | |
55e303ae | 164 | */ |
91447636 A |
165 | #define NOTE_DELETE 0x00000001 /* vnode was removed */ |
166 | #define NOTE_WRITE 0x00000002 /* data contents changed */ | |
167 | #define NOTE_EXTEND 0x00000004 /* size increased */ | |
168 | #define NOTE_ATTRIB 0x00000008 /* attributes changed */ | |
169 | #define NOTE_LINK 0x00000010 /* link count changed */ | |
170 | #define NOTE_RENAME 0x00000020 /* vnode was renamed */ | |
171 | #define NOTE_REVOKE 0x00000040 /* vnode access was revoked */ | |
55e303ae A |
172 | |
173 | /* | |
91447636 | 174 | * data/hint fflags for EVFILT_PROC, shared with userspace |
55e303ae A |
175 | */ |
176 | #define NOTE_EXIT 0x80000000 /* process exited */ | |
177 | #define NOTE_FORK 0x40000000 /* process forked */ | |
178 | #define NOTE_EXEC 0x20000000 /* process exec'd */ | |
179 | #define NOTE_PCTRLMASK 0xf0000000 /* mask for hint bits */ | |
180 | #define NOTE_PDATAMASK 0x000fffff /* mask for pid */ | |
181 | ||
91447636 A |
182 | /* |
183 | * data/hint fflags for EVFILT_TIMER, shared with userspace. | |
184 | * The default is a (repeating) interval timer with the data | |
185 | * specifying the timeout interval in milliseconds. | |
186 | * | |
187 | * All timeouts are implicitly EV_CLEAR events. | |
188 | */ | |
189 | #define NOTE_SECONDS 0x00000001 /* data is seconds */ | |
190 | #define NOTE_USECONDS 0x00000002 /* data is microseconds */ | |
191 | #define NOTE_NSECONDS 0x00000004 /* data is nanoseconds */ | |
192 | #define NOTE_ABSOLUTE 0x00000008 /* absolute timeout */ | |
193 | /* ... implicit EV_ONESHOT */ | |
194 | ||
55e303ae A |
195 | /* additional flags for EVFILT_PROC */ |
196 | #define NOTE_TRACK 0x00000001 /* follow across forks */ | |
197 | #define NOTE_TRACKERR 0x00000002 /* could not track child */ | |
198 | #define NOTE_CHILD 0x00000004 /* am a child process */ | |
199 | ||
200 | ||
55e303ae | 201 | |
91447636 A |
202 | #ifndef KERNEL |
203 | /* Temporay solution for BootX to use inode.h till kqueue moves to vfs layer */ | |
204 | #include <sys/queue.h> | |
205 | struct knote; | |
206 | SLIST_HEAD(klist, knote); | |
207 | #endif | |
208 | ||
209 | #ifdef KERNEL | |
210 | ||
211 | #ifdef KERNEL_PRIVATE | |
55e303ae A |
212 | #include <sys/queue.h> |
213 | ||
214 | #ifdef MALLOC_DECLARE | |
215 | MALLOC_DECLARE(M_KQUEUE); | |
216 | #endif | |
217 | ||
218 | /* | |
219 | * Flag indicating hint is a signal. Used by EVFILT_SIGNAL, and also | |
220 | * shared by EVFILT_PROC (all knotes attached to p->p_klist) | |
221 | */ | |
222 | #define NOTE_SIGNAL 0x08000000 | |
223 | ||
91447636 A |
224 | TAILQ_HEAD(kqtailq, knote); /* a list of "queued" events */ |
225 | ||
55e303ae | 226 | struct knote { |
91447636 A |
227 | int kn_inuse; /* inuse count */ |
228 | struct kqtailq *kn_tq; /* pointer to tail queue */ | |
229 | TAILQ_ENTRY(knote) kn_tqe; /* linkage for tail queue */ | |
230 | struct kqueue *kn_kq; /* which kqueue we are on */ | |
231 | SLIST_ENTRY(knote) kn_link; /* linkage for search list */ | |
55e303ae | 232 | SLIST_ENTRY(knote) kn_selnext; /* klist element chain */ |
55e303ae | 233 | union { |
91447636 | 234 | struct fileproc *p_fp; /* file data pointer */ |
55e303ae A |
235 | struct proc *p_proc; /* proc pointer */ |
236 | } kn_ptr; | |
237 | struct filterops *kn_fop; | |
91447636 | 238 | int kn_status; /* status bits */ |
55e303ae A |
239 | int kn_sfflags; /* saved filter flags */ |
240 | struct kevent kn_kevent; | |
55e303ae | 241 | caddr_t kn_hook; |
91447636 A |
242 | int kn_hookid; |
243 | int64_t kn_sdata; /* saved data field */ | |
244 | ||
55e303ae A |
245 | #define KN_ACTIVE 0x01 /* event has been triggered */ |
246 | #define KN_QUEUED 0x02 /* event is on queue */ | |
247 | #define KN_DISABLED 0x04 /* event is disabled */ | |
91447636 A |
248 | #define KN_DROPPING 0x08 /* knote is being dropped */ |
249 | #define KN_USEWAIT 0x10 /* wait for knote use */ | |
250 | #define KN_DROPWAIT 0x20 /* wait for knote drop */ | |
55e303ae A |
251 | |
252 | #define kn_id kn_kevent.ident | |
253 | #define kn_filter kn_kevent.filter | |
254 | #define kn_flags kn_kevent.flags | |
255 | #define kn_fflags kn_kevent.fflags | |
256 | #define kn_data kn_kevent.data | |
257 | #define kn_fp kn_ptr.p_fp | |
258 | }; | |
259 | ||
260 | struct filterops { | |
261 | int f_isfd; /* true if ident == filedescriptor */ | |
91447636 A |
262 | int (*f_attach)(struct knote *kn); |
263 | void (*f_detach)(struct knote *kn); | |
264 | int (*f_event)(struct knote *kn, long hint); | |
55e303ae A |
265 | }; |
266 | ||
267 | struct proc; | |
268 | ||
269 | SLIST_HEAD(klist, knote); | |
270 | extern void klist_init(struct klist *list); | |
271 | ||
272 | #define KNOTE(list, hint) knote(list, hint) | |
273 | #define KNOTE_ATTACH(list, kn) knote_attach(list, kn) | |
274 | #define KNOTE_DETACH(list, kn) knote_detach(list, kn) | |
275 | ||
276 | ||
277 | extern void knote(struct klist *list, long hint); | |
278 | extern int knote_attach(struct klist *list, struct knote *kn); | |
279 | extern int knote_detach(struct klist *list, struct knote *kn); | |
55e303ae | 280 | extern void knote_fdclose(struct proc *p, int fd); |
55e303ae | 281 | |
91447636 A |
282 | #endif /* !KERNEL_PRIVATE */ |
283 | ||
284 | #else /* KERNEL */ | |
55e303ae | 285 | |
55e303ae | 286 | |
55e303ae A |
287 | struct timespec; |
288 | ||
289 | __BEGIN_DECLS | |
91447636 A |
290 | int kqueue(void); |
291 | int kevent(int kq, const struct kevent *changelist, int nchanges, | |
55e303ae | 292 | struct kevent *eventlist, int nevents, |
91447636 | 293 | const struct timespec *timeout); |
55e303ae A |
294 | __END_DECLS |
295 | ||
55e303ae | 296 | |
91447636 A |
297 | #ifdef PRIVATE |
298 | #include <mach/port.h> | |
55e303ae A |
299 | |
300 | __BEGIN_DECLS | |
91447636 A |
301 | mach_port_t kqueue_portset_np(int kq); |
302 | int kqueue_from_portset_np(mach_port_t portset); | |
55e303ae | 303 | __END_DECLS |
91447636 A |
304 | #endif /* PRIVATE */ |
305 | ||
306 | #endif /* KERNEL */ | |
55e303ae | 307 | |
55e303ae A |
308 | |
309 | #endif /* !_SYS_EVENT_H_ */ |