2 * Copyright (c) 2003-2015 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 * Copyright (c) 1999,2000,2001 Jonathan Lemon <jlemon@FreeBSD.org>
30 * All rights reserved.
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
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.
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
53 * $FreeBSD: src/sys/sys/event.h,v 1.5.2.5 2001/12/14 19:21:22 jlemon Exp $
59 #include <machine/types.h>
60 #include <sys/cdefs.h>
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 portsets */
71 #define EVFILT_FS (-9) /* Filesystem events */
72 #define EVFILT_USER (-10) /* User events */
74 #define EVFILT_VM (-12) /* Virtual memory events */
77 #define EVFILT_SOCK (-13) /* Socket events */
78 #define EVFILT_MEMORYSTATUS (-14) /* Memorystatus events */
81 #define EVFILT_SYSCOUNT 14
82 #define EVFILT_THREADMARKER EVFILT_SYSCOUNT /* Internal use only */
87 uintptr_t ident
; /* identifier for this event */
88 int16_t filter
; /* filter for event */
89 uint16_t flags
; /* general flags */
90 uint32_t fflags
; /* filter-specific flags */
91 intptr_t data
; /* filter-specific data */
92 void *udata
; /* opaque user data identifier */
97 struct user64_kevent
{
98 uint64_t ident
; /* identifier for this event */
99 int16_t filter
; /* filter for event */
100 uint16_t flags
; /* general flags */
101 uint32_t fflags
; /* filter-specific flags */
102 int64_t data
; /* filter-specific data */
103 user_addr_t udata
; /* opaque user data identifier */
106 struct user32_kevent
{
107 uint32_t ident
; /* identifier for this event */
108 int16_t filter
; /* filter for event */
109 uint16_t flags
; /* general flags */
110 uint32_t fflags
; /* filter-specific flags */
111 int32_t data
; /* filter-specific data */
112 user32_addr_t udata
; /* opaque user data identifier */
120 uint64_t ident
; /* identifier for this event */
121 int16_t filter
; /* filter for event */
122 uint16_t flags
; /* general flags */
123 uint32_t fflags
; /* filter-specific flags */
124 int64_t data
; /* filter-specific data */
125 uint64_t udata
; /* opaque user data identifier */
126 uint64_t ext
[2]; /* filter-specific extensions */
129 #define EV_SET(kevp, a, b, c, d, e, f) do { \
130 struct kevent *__kevp__ = (kevp); \
131 __kevp__->ident = (a); \
132 __kevp__->filter = (b); \
133 __kevp__->flags = (c); \
134 __kevp__->fflags = (d); \
135 __kevp__->data = (e); \
136 __kevp__->udata = (f); \
139 #define EV_SET64(kevp, a, b, c, d, e, f, g, h) do { \
140 struct kevent64_s *__kevp__ = (kevp); \
141 __kevp__->ident = (a); \
142 __kevp__->filter = (b); \
143 __kevp__->flags = (c); \
144 __kevp__->fflags = (d); \
145 __kevp__->data = (e); \
146 __kevp__->udata = (f); \
147 __kevp__->ext[0] = (g); \
148 __kevp__->ext[1] = (h); \
152 #define EV_ADD 0x0001 /* add event to kq (implies enable) */
153 #define EV_DELETE 0x0002 /* delete event from kq */
154 #define EV_ENABLE 0x0004 /* enable event */
155 #define EV_DISABLE 0x0008 /* disable event (not reported) */
156 #define EV_RECEIPT 0x0040 /* force EV_ERROR on success, data == 0 */
159 #define EV_ONESHOT 0x0010 /* only report one occurrence */
160 #define EV_CLEAR 0x0020 /* clear event state after reporting */
161 #define EV_DISPATCH 0x0080 /* disable event after reporting */
163 #define EV_SYSFLAGS 0xF000 /* reserved by system */
164 #define EV_FLAG0 0x1000 /* filter-specific flag */
165 #define EV_FLAG1 0x2000 /* filter-specific flag */
167 /* returned values */
168 #define EV_EOF 0x8000 /* EOF detected */
169 #define EV_ERROR 0x4000 /* error, data contains errno */
172 * Filter specific flags for EVFILT_READ
174 * The default behavior for EVFILT_READ is to make the "read" determination
175 * relative to the current file descriptor read pointer. The EV_POLL
176 * flag indicates the determination should be made via poll(2) semantics
177 * (which always returns true for regular files - regardless of the amount
178 * of unread data in the file).
180 * On input, EV_OOBAND specifies that filter should actively return in the
181 * presence of OOB on the descriptor. It implies that filter will return
182 * if there is OOB data available to read OR when any other condition
183 * for the read are met (for example number of bytes regular data becomes >=
185 * If EV_OOBAND is not set on input, it implies that the filter should not actively
186 * return for out of band data on the descriptor. The filter will then only return
187 * when some other condition for read is met (ex: when number of regular data bytes
188 * >=low-watermark OR when socket can't receive more data (SS_CANTRCVMORE)).
190 * On output, EV_OOBAND indicates the presence of OOB data on the descriptor.
191 * If it was not specified as an input parameter, then the data count is the
192 * number of bytes before the current OOB marker, else data count is the number
193 * of bytes beyond OOB marker.
195 #define EV_POLL EV_FLAG0
196 #define EV_OOBAND EV_FLAG1
199 * data/hint fflags for EVFILT_USER, shared with userspace
203 * On input, NOTE_TRIGGER causes the event to be triggered for output.
205 #define NOTE_TRIGGER 0x01000000
208 * On input, the top two bits of fflags specifies how the lower twenty four
209 * bits should be applied to the stored value of fflags.
211 * On output, the top two bits will always be set to NOTE_FFNOP and the
212 * remaining twenty four bits will contain the stored fflags value.
214 #define NOTE_FFNOP 0x00000000 /* ignore input fflags */
215 #define NOTE_FFAND 0x40000000 /* and fflags */
216 #define NOTE_FFOR 0x80000000 /* or fflags */
217 #define NOTE_FFCOPY 0xc0000000 /* copy fflags */
218 #define NOTE_FFCTRLMASK 0xc0000000 /* mask for operations */
219 #define NOTE_FFLAGSMASK 0x00ffffff
222 * data/hint fflags for EVFILT_{READ|WRITE}, shared with userspace
224 * The default behavior for EVFILT_READ is to make the determination
225 * realtive to the current file descriptor read pointer.
227 #define NOTE_LOWAT 0x00000001 /* low water mark */
229 * data/hint fflags for EVFILT_VNODE, shared with userspace
231 #define NOTE_DELETE 0x00000001 /* vnode was removed */
232 #define NOTE_WRITE 0x00000002 /* data contents changed */
233 #define NOTE_EXTEND 0x00000004 /* size increased */
234 #define NOTE_ATTRIB 0x00000008 /* attributes changed */
235 #define NOTE_LINK 0x00000010 /* link count changed */
236 #define NOTE_RENAME 0x00000020 /* vnode was renamed */
237 #define NOTE_REVOKE 0x00000040 /* vnode access was revoked */
238 #define NOTE_NONE 0x00000080 /* No specific vnode event: to test for EVFILT_READ activation*/
241 * data/hint fflags for EVFILT_PROC, shared with userspace
243 * Please note that EVFILT_PROC and EVFILT_SIGNAL share the same knote list
244 * that hangs off the proc structure. They also both play games with the hint
245 * passed to KNOTE(). If NOTE_SIGNAL is passed as a hint, then the lower bits
246 * of the hint contain the signal. IF NOTE_FORK is passed, then the lower bits
247 * contain the PID of the child (but the pid does not get passed through in
248 * the actual kevent).
251 eNoteReapDeprecated
__deprecated_enum_msg("This kqueue(2) EVFILT_PROC flag is deprecated") = 0x10000000
254 #define NOTE_EXIT 0x80000000 /* process exited */
255 #define NOTE_FORK 0x40000000 /* process forked */
256 #define NOTE_EXEC 0x20000000 /* process exec'd */
257 #define NOTE_REAP ((unsigned int)eNoteReapDeprecated /* 0x10000000 */) /* process reaped */
258 #define NOTE_SIGNAL 0x08000000 /* shared with EVFILT_SIGNAL */
259 #define NOTE_EXITSTATUS 0x04000000 /* exit status to be returned, valid for child process only */
260 #define NOTE_EXIT_DETAIL 0x02000000 /* provide details on reasons for exit */
262 #define NOTE_PDATAMASK 0x000fffff /* mask for signal & exit status */
263 #define NOTE_PCTRLMASK (~NOTE_PDATAMASK)
266 * If NOTE_EXITSTATUS is present, provide additional info about exiting process.
269 eNoteExitReparentedDeprecated
__deprecated_enum_msg("This kqueue(2) EVFILT_PROC flag is no longer sent") = 0x00080000
271 #define NOTE_EXIT_REPARENTED ((unsigned int)eNoteExitReparentedDeprecated) /* exited while reparented */
274 * If NOTE_EXIT_DETAIL is present, these bits indicate specific reasons for exiting.
276 #define NOTE_EXIT_DETAIL_MASK 0x00070000
277 #define NOTE_EXIT_DECRYPTFAIL 0x00010000
278 #define NOTE_EXIT_MEMORY 0x00020000
279 #define NOTE_EXIT_CSERROR 0x00040000
284 * If NOTE_EXIT_MEMORY is present, these bits indicate specific jetsam condition.
286 #define NOTE_EXIT_MEMORY_DETAIL_MASK 0xfe000000
287 #define NOTE_EXIT_MEMORY_VMPAGESHORTAGE 0x80000000 /* jetsam condition: lowest jetsam priority proc killed due to vm page shortage */
288 #define NOTE_EXIT_MEMORY_VMTHRASHING 0x40000000 /* jetsam condition: lowest jetsam priority proc killed due to vm thrashing */
289 #define NOTE_EXIT_MEMORY_HIWAT 0x20000000 /* jetsam condition: process reached its high water mark */
290 #define NOTE_EXIT_MEMORY_PID 0x10000000 /* jetsam condition: special pid kill requested */
291 #define NOTE_EXIT_MEMORY_IDLE 0x08000000 /* jetsam condition: idle process cleaned up */
292 #define NOTE_EXIT_MEMORY_VNODE 0X04000000 /* jetsam condition: virtual node kill */
293 #define NOTE_EXIT_MEMORY_FCTHRASHING 0x02000000 /* jetsam condition: lowest jetsam priority proc killed due to filecache thrashing */
298 * data/hint fflags for EVFILT_VM, shared with userspace.
300 #define NOTE_VM_PRESSURE 0x80000000 /* will react on memory pressure */
301 #define NOTE_VM_PRESSURE_TERMINATE 0x40000000 /* will quit on memory pressure, possibly after cleaning up dirty state */
302 #define NOTE_VM_PRESSURE_SUDDEN_TERMINATE 0x20000000 /* will quit immediately on memory pressure */
303 #define NOTE_VM_ERROR 0x10000000 /* there was an error */
308 * data/hint fflags for EVFILT_MEMORYSTATUS, shared with userspace.
310 #define NOTE_MEMORYSTATUS_PRESSURE_NORMAL 0x00000001 /* system memory pressure has returned to normal */
311 #define NOTE_MEMORYSTATUS_PRESSURE_WARN 0x00000002 /* system memory pressure has changed to the warning state */
312 #define NOTE_MEMORYSTATUS_PRESSURE_CRITICAL 0x00000004 /* system memory pressure has changed to the critical state */
313 #define NOTE_MEMORYSTATUS_LOW_SWAP 0x00000008 /* system is in a low-swap state */
315 typedef enum vm_pressure_level
{
316 kVMPressureNormal
= 0,
317 kVMPressureWarning
= 1,
318 kVMPressureUrgent
= 2,
319 kVMPressureCritical
= 3,
320 } vm_pressure_level_t
;
325 * data/hint fflags for EVFILT_TIMER, shared with userspace.
326 * The default is a (repeating) interval timer with the data
327 * specifying the timeout interval in milliseconds.
329 * All timeouts are implicitly EV_CLEAR events.
331 #define NOTE_SECONDS 0x00000001 /* data is seconds */
332 #define NOTE_USECONDS 0x00000002 /* data is microseconds */
333 #define NOTE_NSECONDS 0x00000004 /* data is nanoseconds */
334 #define NOTE_ABSOLUTE 0x00000008 /* absolute timeout */
335 /* ... implicit EV_ONESHOT */
336 #define NOTE_LEEWAY 0x00000010 /* ext[1] holds leeway for power aware timers */
337 #define NOTE_CRITICAL 0x00000020 /* system does minimal timer coalescing */
338 #define NOTE_BACKGROUND 0x00000040 /* system does maximum timer coalescing */
341 * data/hint fflags for EVFILT_SOCK, shared with userspace.
344 #define NOTE_CONNRESET 0x00000001 /* Received RST */
345 #define NOTE_READCLOSED 0x00000002 /* Read side is shutdown */
346 #define NOTE_WRITECLOSED 0x00000004 /* Write side is shutdown */
347 #define NOTE_TIMEOUT 0x00000008 /* timeout: rexmt, keep-alive or persist */
348 #define NOTE_NOSRCADDR 0x00000010 /* source address not available */
349 #define NOTE_IFDENIED 0x00000020 /* interface denied connection */
350 #define NOTE_SUSPEND 0x00000040 /* output queue suspended */
351 #define NOTE_RESUME 0x00000080 /* output queue resumed */
352 #define NOTE_KEEPALIVE 0x00000100 /* TCP Keepalive received */
353 #define NOTE_ADAPTIVE_WTIMO 0x00000200 /* TCP adaptive write timeout */
354 #define NOTE_ADAPTIVE_RTIMO 0x00000400 /* TCP adaptive read timeout */
355 #define NOTE_CONNECTED 0x00000800 /* socket is connected */
356 #define NOTE_DISCONNECTED 0x00001000 /* socket is disconnected */
357 #define NOTE_CONNINFO_UPDATED 0x00002000 /* connection info was updated */
362 * data/hint fflags for EVFILT_MACHPORT, shared with userspace.
364 * Only portsets are supported at this time.
366 * The fflags field can optionally contain the MACH_RCV_MSG, MACH_RCV_LARGE,
367 * and related trailer receive options as defined in <mach/message.h>.
368 * The presence of these flags directs the kevent64() call to attempt to receive
369 * the message during kevent delivery, rather than just indicate that a message exists.
370 * On setup, The ext[0] field contains the receive buffer pointer and ext[1] contains
371 * the receive buffer length. Upon event delivery, the actual received message size
372 * is returned in ext[1]. As with mach_msg(), the buffer must be large enough to
373 * receive the message and the requested (or default) message trailers. In addition,
374 * the fflags field contains the return code normally returned by mach_msg().
376 * If no message receipt options were provided in the fflags field on setup, no
377 * message is received by this call. Instead, on output, the data field simply
378 * contains the name of the actual port detected with a message waiting.
382 * DEPRECATED!!!!!!!!!
383 * NOTE_TRACK, NOTE_TRACKERR, and NOTE_CHILD are no longer supported as of 10.5
385 /* additional flags for EVFILT_PROC */
386 #define NOTE_TRACK 0x00000001 /* follow across forks */
387 #define NOTE_TRACKERR 0x00000002 /* could not track child */
388 #define NOTE_CHILD 0x00000004 /* am a child process */
393 /* Temporay solution for BootX to use inode.h till kqueue moves to vfs layer */
394 #include <sys/queue.h>
396 SLIST_HEAD(klist
, knote
);
401 #ifdef KERNEL_PRIVATE
402 #include <sys/queue.h>
403 #include <kern/kern_types.h>
405 #ifdef MALLOC_DECLARE
406 MALLOC_DECLARE(M_KQUEUE
);
409 TAILQ_HEAD(kqtailq
, knote
); /* a list of "queued" events */
412 int kn_inuse
; /* inuse count */
413 struct kqtailq
*kn_tq
; /* pointer to tail queue */
414 TAILQ_ENTRY(knote
) kn_tqe
; /* linkage for tail queue */
415 struct kqueue
*kn_kq
; /* which kqueue we are on */
416 SLIST_ENTRY(knote
) kn_link
; /* linkage for search list */
417 SLIST_ENTRY(knote
) kn_selnext
; /* klist element chain */
419 struct fileproc
*p_fp
; /* file data pointer */
420 struct proc
*p_proc
; /* proc pointer */
421 struct ipc_pset
*p_pset
; /* pset pointer */
423 struct filterops
*kn_fop
;
424 int kn_status
; /* status bits */
425 int kn_sfflags
; /* saved filter flags */
426 struct kevent64_s kn_kevent
;
429 int64_t kn_sdata
; /* saved data field */
431 #define KN_ACTIVE 0x01 /* event has been triggered */
432 #define KN_QUEUED 0x02 /* event is on queue */
433 #define KN_DISABLED 0x04 /* event is disabled */
434 #define KN_DROPPING 0x08 /* knote is being dropped */
435 #define KN_USEWAIT 0x10 /* wait for knote use */
436 #define KN_ATTACHING 0x20 /* event is pending attach */
437 #define KN_STAYQUEUED 0x40 /* force event to stay on queue */
439 #define kn_id kn_kevent.ident
440 #define kn_filter kn_kevent.filter
441 #define kn_flags kn_kevent.flags
442 #define kn_fflags kn_kevent.fflags
443 #define kn_data kn_kevent.data
444 #define kn_udata kn_kevent.udata
445 #define kn_ext kn_kevent.ext
446 #define kn_fp kn_ptr.p_fp
449 /* Hint values for f_touch filter operation */
450 #define EVENT_REGISTER 1
451 #define EVENT_PROCESS 2
454 int f_isfd
; /* true if ident == filedescriptor */
455 int (*f_attach
)(struct knote
*kn
);
456 void (*f_detach
)(struct knote
*kn
);
457 int (*f_event
)(struct knote
*kn
, long hint
);
458 /* Optional f_touch operation, called only if !f_isfd && non-NULL */
459 void (*f_touch
)(struct knote
*kn
, struct kevent64_s
*kev
, long type
);
460 /* Optional f_peek operation, called only if KN_STAYQUEUED is set */
461 unsigned (*f_peek
)(struct knote
*kn
);
467 SLIST_HEAD(klist
, knote
);
468 extern void knote_init(void);
469 extern void klist_init(struct klist
*list
);
471 #define KNOTE(list, hint) knote(list, hint)
472 #define KNOTE_ATTACH(list, kn) knote_attach(list, kn)
473 #define KNOTE_DETACH(list, kn) knote_detach(list, kn)
476 extern void knote(struct klist
*list
, long hint
);
477 extern int knote_attach(struct klist
*list
, struct knote
*kn
);
478 extern int knote_detach(struct klist
*list
, struct knote
*kn
);
479 extern int knote_link_wait_queue(struct knote
*kn
, struct wait_queue
*wq
, wait_queue_link_t wql
);
480 extern int knote_unlink_wait_queue(struct knote
*kn
, struct wait_queue
*wq
, wait_queue_link_t
*wqlp
);
481 extern void knote_fdclose(struct proc
*p
, int fd
);
482 extern void knote_markstayqueued(struct knote
*kn
);
483 extern void knote_clearstayqueued(struct knote
*kn
);
484 #endif /* !KERNEL_PRIVATE */
493 int kevent(int kq
, const struct kevent
*changelist
, int nchanges
,
494 struct kevent
*eventlist
, int nevents
,
495 const struct timespec
*timeout
);
496 int kevent64(int kq
, const struct kevent64_s
*changelist
,
497 int nchanges
, struct kevent64_s
*eventlist
,
498 int nevents
, unsigned int flags
,
499 const struct timespec
*timeout
);
506 #endif /* !_SYS_EVENT_H_ */