1 /* 2 * Copyright (c) 2003-2021 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 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 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 /*- 29 * Copyright (c) 1999,2000,2001 Jonathan Lemon <[email protected]> 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 59 #include <machine/types.h> 60 #include <sys/cdefs.h> 61 #include <sys/queue.h> 62 #include <stdint.h> 63 #ifndef KERNEL 64 #include <sys/types.h> 65 #endif 66 67 /* 68 * Filter types 69 */ 70 #define EVFILT_READ (-1) 71 #define EVFILT_WRITE (-2) 72 #define EVFILT_AIO (-3) /* attached to aio requests */ 73 #define EVFILT_VNODE (-4) /* attached to vnodes */ 74 #define EVFILT_PROC (-5) /* attached to struct proc */ 75 #define EVFILT_SIGNAL (-6) /* attached to struct proc */ 76 #define EVFILT_TIMER (-7) /* timers */ 77 #define EVFILT_MACHPORT (-8) /* Mach portsets */ 78 #define EVFILT_FS (-9) /* Filesystem events */ 79 #define EVFILT_USER (-10) /* User events */ 80 #ifdef PRIVATE 81 /* Additional filter types in event_private.h */ 82 #endif 83 #define EVFILT_VM (-12) /* Virtual memory events */ 84 #define EVFILT_EXCEPT (-15) /* Exception events */ 85 86 #ifdef PRIVATE 87 /* Make sure to count the filter types in event_private.h! */ 88 #endif 89 #define EVFILT_SYSCOUNT 17 90 #define EVFILT_THREADMARKER EVFILT_SYSCOUNT /* Internal use only */ 91 92 #pragma pack(4) 93 94 struct kevent { 95 uintptr_t ident; /* identifier for this event */ 96 int16_t filter; /* filter for event */ 97 uint16_t flags; /* general flags */ 98 uint32_t fflags; /* filter-specific flags */ 99 intptr_t data; /* filter-specific data */ 100 void *udata; /* opaque user data identifier */ 101 }; 102 103 #pragma pack() 104 105 struct kevent64_s { 106 uint64_t ident; /* identifier for this event */ 107 int16_t filter; /* filter for event */ 108 uint16_t flags; /* general flags */ 109 uint32_t fflags; /* filter-specific flags */ 110 int64_t data; /* filter-specific data */ 111 uint64_t udata; /* opaque user data identifier */ 112 uint64_t ext[2]; /* filter-specific extensions */ 113 }; 114 115 #define EV_SET(kevp, a, b, c, d, e, f) do { \ 116 struct kevent *__kevp__ = (kevp); \ 117 __kevp__->ident = (a); \ 118 __kevp__->filter = (b); \ 119 __kevp__->flags = (c); \ 120 __kevp__->fflags = (d); \ 121 __kevp__->data = (e); \ 122 __kevp__->udata = (f); \ 123 } while(0) 124 125 #define EV_SET64(kevp, a, b, c, d, e, f, g, h) do { \ 126 struct kevent64_s *__kevp__ = (kevp); \ 127 __kevp__->ident = (a); \ 128 __kevp__->filter = (b); \ 129 __kevp__->flags = (c); \ 130 __kevp__->fflags = (d); \ 131 __kevp__->data = (e); \ 132 __kevp__->udata = (f); \ 133 __kevp__->ext[0] = (g); \ 134 __kevp__->ext[1] = (h); \ 135 } while(0) 136 137 138 /* kevent system call flags */ 139 #define KEVENT_FLAG_NONE 0x000000 /* no flag value */ 140 #define KEVENT_FLAG_IMMEDIATE 0x000001 /* immediate timeout */ 141 #define KEVENT_FLAG_ERROR_EVENTS 0x000002 /* output events only include change errors */ 142 143 /* actions */ 144 #define EV_ADD 0x0001 /* add event to kq (implies enable) */ 145 #define EV_DELETE 0x0002 /* delete event from kq */ 146 #define EV_ENABLE 0x0004 /* enable event */ 147 #define EV_DISABLE 0x0008 /* disable event (not reported) */ 148 149 /* flags */ 150 #define EV_ONESHOT 0x0010 /* only report one occurrence */ 151 #define EV_CLEAR 0x0020 /* clear event state after reporting */ 152 #define EV_RECEIPT 0x0040 /* force immediate event output */ 153 /* ... with or without EV_ERROR */ 154 /* ... use KEVENT_FLAG_ERROR_EVENTS */ 155 /* on syscalls supporting flags */ 156 157 #define EV_DISPATCH 0x0080 /* disable event after reporting */ 158 #define EV_UDATA_SPECIFIC 0x0100 /* unique kevent per udata value */ 159 160 #define EV_DISPATCH2 (EV_DISPATCH | EV_UDATA_SPECIFIC) 161 /* ... in combination with EV_DELETE */ 162 /* will defer delete until udata-specific */ 163 /* event enabled. EINPROGRESS will be */ 164 /* returned to indicate the deferral */ 165 166 #define EV_VANISHED 0x0200 /* report that source has vanished */ 167 /* ... only valid with EV_DISPATCH2 */ 168 169 #define EV_SYSFLAGS 0xF000 /* reserved by system */ 170 #define EV_FLAG0 0x1000 /* filter-specific flag */ 171 #define EV_FLAG1 0x2000 /* filter-specific flag */ 172 173 /* returned values */ 174 #define EV_EOF 0x8000 /* EOF detected */ 175 #define EV_ERROR 0x4000 /* error, data contains errno */ 176 177 /* 178 * Filter specific flags for EVFILT_READ 179 * 180 * The default behavior for EVFILT_READ is to make the "read" determination 181 * relative to the current file descriptor read pointer. 182 * 183 * The EV_POLL flag indicates the determination should be made via poll(2) 184 * semantics. These semantics dictate always returning true for regular files, 185 * regardless of the amount of unread data in the file. 186 * 187 * On input, EV_OOBAND specifies that filter should actively return in the 188 * presence of OOB on the descriptor. It implies that filter will return 189 * if there is OOB data available to read OR when any other condition 190 * for the read are met (for example number of bytes regular data becomes >= 191 * low-watermark). 192 * If EV_OOBAND is not set on input, it implies that the filter should not actively 193 * return for out of band data on the descriptor. The filter will then only return 194 * when some other condition for read is met (ex: when number of regular data bytes 195 * >=low-watermark OR when socket can't receive more data (SS_CANTRCVMORE)). 196 * 197 * On output, EV_OOBAND indicates the presence of OOB data on the descriptor. 198 * If it was not specified as an input parameter, then the data count is the 199 * number of bytes before the current OOB marker, else data count is the number 200 * of bytes beyond OOB marker. 201 */ 202 #define EV_POLL EV_FLAG0 203 #define EV_OOBAND EV_FLAG1 204 205 /* 206 * data/hint fflags for EVFILT_USER, shared with userspace 207 */ 208 209 /* 210 * On input, NOTE_TRIGGER causes the event to be triggered for output. 211 */ 212 #define NOTE_TRIGGER 0x01000000 213 214 /* 215 * On input, the top two bits of fflags specifies how the lower twenty four 216 * bits should be applied to the stored value of fflags. 217 * 218 * On output, the top two bits will always be set to NOTE_FFNOP and the 219 * remaining twenty four bits will contain the stored fflags value. 220 */ 221 #define NOTE_FFNOP 0x00000000 /* ignore input fflags */ 222 #define NOTE_FFAND 0x40000000 /* and fflags */ 223 #define NOTE_FFOR 0x80000000 /* or fflags */ 224 #define NOTE_FFCOPY 0xc0000000 /* copy fflags */ 225 #define NOTE_FFCTRLMASK 0xc0000000 /* mask for operations */ 226 #define NOTE_FFLAGSMASK 0x00ffffff 227 228 /* 229 * data/hint fflags for EVFILT_{READ|WRITE}, shared with userspace 230 * 231 * The default behavior for EVFILT_READ is to make the determination 232 * realtive to the current file descriptor read pointer. 233 */ 234 #define NOTE_LOWAT 0x00000001 /* low water mark */ 235 236 /* data/hint flags for EVFILT_EXCEPT, shared with userspace */ 237 #define NOTE_OOB 0x00000002 /* OOB data */ 238 239 /* 240 * data/hint fflags for EVFILT_VNODE, shared with userspace 241 */ 242 #define NOTE_DELETE 0x00000001 /* vnode was removed */ 243 #define NOTE_WRITE 0x00000002 /* data contents changed */ 244 #define NOTE_EXTEND 0x00000004 /* size increased */ 245 #define NOTE_ATTRIB 0x00000008 /* attributes changed */ 246 #define NOTE_LINK 0x00000010 /* link count changed */ 247 #define NOTE_RENAME 0x00000020 /* vnode was renamed */ 248 #define NOTE_REVOKE 0x00000040 /* vnode access was revoked */ 249 #define NOTE_NONE 0x00000080 /* No specific vnode event: to test for EVFILT_READ activation*/ 250 #define NOTE_FUNLOCK 0x00000100 /* vnode was unlocked by flock(2) */ 251 #define NOTE_LEASE_DOWNGRADE 0x00000200 /* lease downgrade requested */ 252 #define NOTE_LEASE_RELEASE 0x00000400 /* lease release requested */ 253 254 /* 255 * data/hint fflags for EVFILT_PROC, shared with userspace 256 * 257 * Please note that EVFILT_PROC and EVFILT_SIGNAL share the same knote list 258 * that hangs off the proc structure. They also both play games with the hint 259 * passed to KNOTE(). If NOTE_SIGNAL is passed as a hint, then the lower bits 260 * of the hint contain the signal. IF NOTE_FORK is passed, then the lower bits 261 * contain the PID of the child (but the pid does not get passed through in 262 * the actual kevent). 263 */ 264 enum { 265 eNoteReapDeprecated __deprecated_enum_msg("This kqueue(2) EVFILT_PROC flag is deprecated") = 0x10000000 266 }; 267 268 #define NOTE_EXIT 0x80000000 /* process exited */ 269 #define NOTE_FORK 0x40000000 /* process forked */ 270 #define NOTE_EXEC 0x20000000 /* process exec'd */ 271 #define NOTE_REAP ((unsigned int)eNoteReapDeprecated /* 0x10000000 */ ) /* process reaped */ 272 #define NOTE_SIGNAL 0x08000000 /* shared with EVFILT_SIGNAL */ 273 #define NOTE_EXITSTATUS 0x04000000 /* exit status to be returned, valid for child process or when allowed to signal target pid */ 274 #define NOTE_EXIT_DETAIL 0x02000000 /* provide details on reasons for exit */ 275 276 #define NOTE_PDATAMASK 0x000fffff /* mask for signal & exit status */ 277 #define NOTE_PCTRLMASK (~NOTE_PDATAMASK) 278 279 /* 280 * If NOTE_EXITSTATUS is present, provide additional info about exiting process. 281 */ 282 enum { 283 eNoteExitReparentedDeprecated __deprecated_enum_msg("This kqueue(2) EVFILT_PROC flag is no longer sent") = 0x00080000 284 }; 285 #define NOTE_EXIT_REPARENTED ((unsigned int)eNoteExitReparentedDeprecated) /* exited while reparented */ 286 287 /* 288 * If NOTE_EXIT_DETAIL is present, these bits indicate specific reasons for exiting. 289 */ 290 #define NOTE_EXIT_DETAIL_MASK 0x00070000 291 #define NOTE_EXIT_DECRYPTFAIL 0x00010000 292 #define NOTE_EXIT_MEMORY 0x00020000 293 #define NOTE_EXIT_CSERROR 0x00040000 294 295 /* 296 * data/hint fflags for EVFILT_VM, shared with userspace. 297 */ 298 #define NOTE_VM_PRESSURE 0x80000000 /* will react on memory pressure */ 299 #define NOTE_VM_PRESSURE_TERMINATE 0x40000000 /* will quit on memory pressure, possibly after cleaning up dirty state */ 300 #define NOTE_VM_PRESSURE_SUDDEN_TERMINATE 0x20000000 /* will quit immediately on memory pressure */ 301 #define NOTE_VM_ERROR 0x10000000 /* there was an error */ 302 303 /* 304 * data/hint fflags for EVFILT_TIMER, shared with userspace. 305 * The default is a (repeating) interval timer with the data 306 * specifying the timeout interval in milliseconds. 307 * 308 * All timeouts are implicitly EV_CLEAR events. 309 */ 310 #define NOTE_SECONDS 0x00000001 /* data is seconds */ 311 #define NOTE_USECONDS 0x00000002 /* data is microseconds */ 312 #define NOTE_NSECONDS 0x00000004 /* data is nanoseconds */ 313 #define NOTE_ABSOLUTE 0x00000008 /* absolute timeout */ 314 /* ... implicit EV_ONESHOT, timeout uses the gettimeofday epoch */ 315 #define NOTE_LEEWAY 0x00000010 /* ext[1] holds leeway for power aware timers */ 316 #define NOTE_CRITICAL 0x00000020 /* system does minimal timer coalescing */ 317 #define NOTE_BACKGROUND 0x00000040 /* system does maximum timer coalescing */ 318 #define NOTE_MACH_CONTINUOUS_TIME 0x00000080 319 /* 320 * NOTE_MACH_CONTINUOUS_TIME: 321 * with NOTE_ABSOLUTE: causes the timer to continue to tick across sleep, 322 * still uses gettimeofday epoch 323 * with NOTE_MACHTIME and NOTE_ABSOLUTE: uses mach continuous time epoch 324 * without NOTE_ABSOLUTE (interval timer mode): continues to tick across sleep 325 */ 326 #define NOTE_MACHTIME 0x00000100 /* data is mach absolute time units */ 327 /* timeout uses the mach absolute time epoch */ 328 329 /* 330 * data/hint fflags for EVFILT_MACHPORT, shared with userspace. 331 * 332 * Only portsets are supported at this time. 333 * 334 * The fflags field can optionally contain the MACH_RCV_MSG, MACH_RCV_LARGE, 335 * and related trailer receive options as defined in <mach/message.h>. 336 * The presence of these flags directs the kevent64() call to attempt to receive 337 * the message during kevent delivery, rather than just indicate that a message exists. 338 * On setup, The ext[0] field contains the receive buffer pointer and ext[1] contains 339 * the receive buffer length. Upon event delivery, the actual received message size 340 * is returned in ext[1]. As with mach_msg(), the buffer must be large enough to 341 * receive the message and the requested (or default) message trailers. In addition, 342 * the fflags field contains the return code normally returned by mach_msg(). 343 * 344 * If MACH_RCV_MSG is specified, and the ext[1] field specifies a zero length, the 345 * system call argument specifying an ouput area (kevent_qos) will be consulted. If 346 * the system call specified an output data area, the user-space address 347 * of the received message is carved from that provided output data area (if enough 348 * space remains there). The address and length of each received message is 349 * returned in the ext[0] and ext[1] fields (respectively) of the corresponding kevent. 350 * 351 * IF_MACH_RCV_VOUCHER_CONTENT is specified, the contents of the message voucher is 352 * extracted (as specified in the xflags field) and stored in ext[2] up to ext[3] 353 * length. If the input length is zero, and the system call provided a data area, 354 * the space for the voucher content is carved from the provided space and its 355 * address and length is returned in ext[2] and ext[3] respectively. 356 * 357 * If no message receipt options were provided in the fflags field on setup, no 358 * message is received by this call. Instead, on output, the data field simply 359 * contains the name of the actual port detected with a message waiting. 360 */ 361 362 /* 363 * DEPRECATED!!!!!!!!! 364 * NOTE_TRACK, NOTE_TRACKERR, and NOTE_CHILD are no longer supported as of 10.5 365 */ 366 /* additional flags for EVFILT_PROC */ 367 #define NOTE_TRACK 0x00000001 /* follow across forks */ 368 #define NOTE_TRACKERR 0x00000002 /* could not track child */ 369 #define NOTE_CHILD 0x00000004 /* am a child process */ 370 371 372 #ifndef KERNEL 373 /* Temporary solution for BootX to use inode.h till kqueue moves to vfs layer */ 374 struct knote; 375 SLIST_HEAD(klist, knote); 376 377 struct timespec; 378 379 __BEGIN_DECLS 380 int kqueue(void); 381 int kevent(int kq, 382 const struct kevent *changelist, int nchanges, 383 struct kevent *eventlist, int nevents, 384 const struct timespec *timeout); 385 int kevent64(int kq, 386 const struct kevent64_s *changelist, int nchanges, 387 struct kevent64_s *eventlist, int nevents, 388 unsigned int flags, 389 const struct timespec *timeout); 390 391 __END_DECLS 392 393 394 #endif /* KERNEL */ 395 396 #ifdef PRIVATE 397 #include <sys/event_private.h> 398 #endif /* PRIVATE */ 399 400 #endif /* !_SYS_EVENT_H_ */ 401