bsd/sys/event.h

   1 /*
   2  * Copyright (c) 2003-2012 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 <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
  59 #include <machine/types.h>
  60 #include <sys/cdefs.h>
  61 #include <stdint.h>
  62
  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 */
  73                                         /* (-11) unused */
  74 #define EVFILT_VM               (-12)   /* Virtual memory events */
  75
  76 #ifdef PRIVATE
  77 #define EVFILT_SOCK             (-13)   /* Socket events */
  78 #endif /* PRIVATE */
  79
  80 #define EVFILT_SYSCOUNT         13
  81 #define EVFILT_THREADMARKER     EVFILT_SYSCOUNT /* Internal use only */
  82
  83 #pragma pack(4)
  84
  85 struct kevent {
  86         uintptr_t       ident;          /* identifier for this event */
  87         int16_t         filter;         /* filter for event */
  88         uint16_t        flags;          /* general flags */
  89         uint32_t        fflags;         /* filter-specific flags */
  90         intptr_t        data;           /* filter-specific data */
  91         void            *udata;         /* opaque user data identifier */
  92 };
  93
  94 #ifdef KERNEL_PRIVATE
  95
  96 struct user64_kevent {
  97         uint64_t        ident;          /* identifier for this event */
  98         int16_t         filter;         /* filter for event */
  99         uint16_t        flags;          /* general flags */
 100         uint32_t        fflags;         /* filter-specific flags */
 101         int64_t         data;           /* filter-specific data */
 102         user_addr_t     udata;          /* opaque user data identifier */
 103 };
 104
 105 struct user32_kevent {
 106         uint32_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         int32_t         data;           /* filter-specific data */
 111         user32_addr_t   udata;          /* opaque user data identifier */
 112 };
 113
 114 #endif
 115
 116 #pragma pack()
 117
 118 struct kevent64_s {
 119         uint64_t        ident;          /* identifier for this event */
 120         int16_t         filter;         /* filter for event */
 121         uint16_t        flags;          /* general flags */
 122         uint32_t        fflags;         /* filter-specific flags */
 123         int64_t         data;           /* filter-specific data */
 124         uint64_t        udata;          /* opaque user data identifier */
 125         uint64_t        ext[2];         /* filter-specific extensions */
 126 };
 127
 128 #define EV_SET(kevp, a, b, c, d, e, f) do {     \
 129         struct kevent *__kevp__ = (kevp);       \
 130         __kevp__->ident = (a);                  \
 131         __kevp__->filter = (b);                 \
 132         __kevp__->flags = (c);                  \
 133         __kevp__->fflags = (d);                 \
 134         __kevp__->data = (e);                   \
 135         __kevp__->udata = (f);                  \
 136 } while(0)
 137
 138 #define EV_SET64(kevp, a, b, c, d, e, f, g, h) do {     \
 139         struct kevent64_s *__kevp__ = (kevp);           \
 140         __kevp__->ident = (a);                          \
 141         __kevp__->filter = (b);                         \
 142         __kevp__->flags = (c);                          \
 143         __kevp__->fflags = (d);                         \
 144         __kevp__->data = (e);                           \
 145         __kevp__->udata = (f);                          \
 146         __kevp__->ext[0] = (g);                         \
 147         __kevp__->ext[1] = (h);                         \
 148 } while(0)
 149
 150 /* actions */
 151 #define EV_ADD          0x0001          /* add event to kq (implies enable) */
 152 #define EV_DELETE       0x0002          /* delete event from kq */
 153 #define EV_ENABLE       0x0004          /* enable event */
 154 #define EV_DISABLE      0x0008          /* disable event (not reported) */
 155 #define EV_RECEIPT      0x0040          /* force EV_ERROR on success, data == 0 */
 156
 157 /* flags */
 158 #define EV_ONESHOT      0x0010          /* only report one occurrence */
 159 #define EV_CLEAR        0x0020          /* clear event state after reporting */
 160 #define EV_DISPATCH     0x0080          /* disable event after reporting */
 161
 162 #define EV_SYSFLAGS     0xF000          /* reserved by system */
 163 #define EV_FLAG0        0x1000          /* filter-specific flag */
 164 #define EV_FLAG1        0x2000          /* filter-specific flag */
 165
 166 /* returned values */
 167 #define EV_EOF          0x8000          /* EOF detected */
 168 #define EV_ERROR        0x4000          /* error, data contains errno */
 169
 170 /*
 171  * Filter specific flags for EVFILT_READ
 172  *
 173  * The default behavior for EVFILT_READ is to make the "read" determination
 174  * relative to the current file descriptor read pointer. The EV_POLL
 175  * flag indicates the determination should be made via poll(2) semantics
 176  * (which always returns true for regular files - regardless of the amount
 177  * of unread data in the file).
 178  *
 179  * On input, EV_OOBAND specifies that only OOB data should be looked for.
 180  * The returned data count is the number of bytes beyond the current OOB marker.
 181  *
 182  * On output, EV_OOBAND indicates that OOB data is present
 183  * If it was not specified as an input parameter, then the data count is the
 184  * number of bytes before the current OOB marker. If at the marker, the
 185  * data count indicates the number of bytes available after it.  In either
 186  * case, it's the amount of data one could expect to receive next.
 187  */
 188 #define EV_POLL EV_FLAG0
 189 #define EV_OOBAND       EV_FLAG1
 190
 191 /*
 192  * data/hint fflags for EVFILT_USER, shared with userspace
 193  */
 194
 195 /*
 196  * On input, NOTE_TRIGGER causes the event to be triggered for output.
 197  */
 198 #define NOTE_TRIGGER    0x01000000
 199
 200 /*
 201  * On input, the top two bits of fflags specifies how the lower twenty four
 202  * bits should be applied to the stored value of fflags.
 203  *
 204  * On output, the top two bits will always be set to NOTE_FFNOP and the
 205  * remaining twenty four bits will contain the stored fflags value.
 206  */
 207 #define NOTE_FFNOP      0x00000000              /* ignore input fflags */
 208 #define NOTE_FFAND      0x40000000              /* and fflags */
 209 #define NOTE_FFOR       0x80000000              /* or fflags */
 210 #define NOTE_FFCOPY     0xc0000000              /* copy fflags */
 211 #define NOTE_FFCTRLMASK 0xc0000000              /* mask for operations */
 212 #define NOTE_FFLAGSMASK 0x00ffffff
 213
 214 /*
 215  * data/hint fflags for EVFILT_{READ|WRITE}, shared with userspace
 216  *
 217  * The default behavior for EVFILT_READ is to make the determination
 218  * realtive to the current file descriptor read pointer.
 219  */
 220 #define NOTE_LOWAT      0x00000001              /* low water mark */
 221 /*
 222  * data/hint fflags for EVFILT_VNODE, shared with userspace
 223  */
 224 #define NOTE_DELETE     0x00000001              /* vnode was removed */
 225 #define NOTE_WRITE      0x00000002              /* data contents changed */
 226 #define NOTE_EXTEND     0x00000004              /* size increased */
 227 #define NOTE_ATTRIB     0x00000008              /* attributes changed */
 228 #define NOTE_LINK       0x00000010              /* link count changed */
 229 #define NOTE_RENAME     0x00000020              /* vnode was renamed */
 230 #define NOTE_REVOKE     0x00000040              /* vnode access was revoked */
 231 #define NOTE_NONE       0x00000080              /* No specific vnode event: to test for EVFILT_READ activation*/
 232
 233 /*
 234  * data/hint fflags for EVFILT_PROC, shared with userspace
 235  *
 236  * Please note that EVFILT_PROC and EVFILT_SIGNAL share the same knote list
 237  * that hangs off the proc structure. They also both play games with the hint
 238  * passed to KNOTE(). If NOTE_SIGNAL is passed as a hint, then the lower bits
 239  * of the hint contain the signal. IF NOTE_FORK is passed, then the lower bits
 240  * contain the PID of the child.
 241  */
 242 #define NOTE_EXIT       0x80000000              /* process exited */
 243 #define NOTE_FORK       0x40000000              /* process forked */
 244 #define NOTE_EXEC       0x20000000              /* process exec'd */
 245 #define NOTE_REAP       0x10000000              /* process reaped */
 246 #define NOTE_SIGNAL     0x08000000              /* shared with EVFILT_SIGNAL */
 247 #define NOTE_EXITSTATUS 0x04000000              /* exit status to be returned, valid for child process only */
 248 #define NOTE_RESOURCEEND 0x02000000             /* resource limit reached, resource type returned */
 249
 250 #if CONFIG_EMBEDDED
 251 /* 0x01000000  is reserved for future use */
 252
 253 /* App states notification */
 254 #define NOTE_APPACTIVE          0x00800000      /* app went to active state */
 255 #define NOTE_APPBACKGROUND      0x00400000      /* app went to background */
 256 #define NOTE_APPNONUI           0x00200000      /* app went to active with no UI */
 257 #define NOTE_APPINACTIVE        0x00100000      /* app went to inactive state */
 258 #define NOTE_APPALLSTATES       0x00f00000
 259 #endif /* CONFIG_EMBEDDED */
 260
 261 #define NOTE_PDATAMASK  0x000fffff              /* mask for pid/signal */
 262 #define NOTE_PCTRLMASK  (~NOTE_PDATAMASK)
 263
 264 /*
 265  * If NOTE_EXITSTATUS is present, provide additional info about exiting process.
 266  */
 267 #define NOTE_EXIT_REPARENTED    0x00080000      /* exited while reparented */
 268
 269 /*
 270  * data/hint fflags for EVFILT_VM, shared with userspace.
 271  */
 272 #define NOTE_VM_PRESSURE                        0x80000000              /* will react on memory pressure */
 273 #define NOTE_VM_PRESSURE_TERMINATE              0x40000000              /* will quit on memory pressure, possibly after cleaning up dirty state */
 274 #define NOTE_VM_PRESSURE_SUDDEN_TERMINATE       0x20000000              /* will quit immediately on memory pressure */
 275 #define NOTE_VM_ERROR                           0x10000000              /* there was an error */
 276
 277 /*
 278  * data/hint fflags for EVFILT_TIMER, shared with userspace.
 279  * The default is a (repeating) interval timer with the data
 280  * specifying the timeout interval in milliseconds.
 281  *
 282  * All timeouts are implicitly EV_CLEAR events.
 283  */
 284 #define NOTE_SECONDS    0x00000001              /* data is seconds         */
 285 #define NOTE_USECONDS   0x00000002              /* data is microseconds    */
 286 #define NOTE_NSECONDS   0x00000004              /* data is nanoseconds     */
 287 #define NOTE_ABSOLUTE   0x00000008              /* absolute timeout        */
 288                                                 /* ... implicit EV_ONESHOT */
 289 #ifdef PRIVATE
 290 /*
 291  * data/hint fflags for EVFILT_SOCK, shared with userspace.
 292  *
 293  */
 294 #define NOTE_CONNRESET          0x00000001 /* Received RST */
 295 #define NOTE_READCLOSED         0x00000002 /* Read side is shutdown */
 296 #define NOTE_WRITECLOSED        0x00000004 /* Write side is shutdown */
 297 #define NOTE_TIMEOUT            0x00000008 /* timeout: rexmt, keep-alive or persist */
 298 #define NOTE_NOSRCADDR          0x00000010 /* source address not available */
 299 #define NOTE_IFDENIED           0x00000020 /* interface denied connection */
 300 #define NOTE_SUSPEND            0x00000040 /* output queue suspended */
 301 #define NOTE_RESUME             0x00000080 /* output queue resumed */
 302 #define NOTE_KEEPALIVE          0x00000100 /* TCP Keepalive received */
 303
 304 #endif /* PRIVATE */
 305
 306 /*
 307  * data/hint fflags for EVFILT_MACHPORT, shared with userspace.
 308  *
 309  * Only portsets are supported at this time.
 310  *
 311  * The fflags field can optionally contain the MACH_RCV_MSG, MACH_RCV_LARGE,
 312  * and related trailer receive options as defined in <mach/message.h>.
 313  * The presence of these flags directs the kevent64() call to attempt to receive
 314  * the message during kevent delivery, rather than just indicate that a message exists.
 315  * On setup, The ext[0] field contains the receive buffer pointer and ext[1] contains
 316  * the receive buffer length.  Upon event delivery, the actual received message size
 317  * is returned in ext[1].  As with mach_msg(), the buffer must be large enough to
 318  * receive the message and the requested (or default) message trailers.  In addition,
 319  * the fflags field contains the return code normally returned by mach_msg().
 320  *
 321  * If no message receipt options were provided in the fflags field on setup, no
 322  * message is received by this call. Instead, on output, the data field simply
 323  * contains the name of the actual port detected with a message waiting.
 324  */
 325
 326 /*
 327  * DEPRECATED!!!!!!!!!
 328  * NOTE_TRACK, NOTE_TRACKERR, and NOTE_CHILD are no longer supported as of 10.5
 329  */
 330 /* additional flags for EVFILT_PROC */
 331 #define NOTE_TRACK      0x00000001              /* follow across forks */
 332 #define NOTE_TRACKERR   0x00000002              /* could not track child */
 333 #define NOTE_CHILD      0x00000004              /* am a child process */
 334
 335
 336
 337 #ifndef KERNEL
 338 /* Temporay solution for BootX to use inode.h till kqueue moves to vfs layer */
 339 #include <sys/queue.h>
 340 struct knote;
 341 SLIST_HEAD(klist, knote);
 342 #endif
 343
 344 #ifdef KERNEL
 345
 346 #ifdef KERNEL_PRIVATE
 347 #include <sys/queue.h>
 348
 349 #ifdef MALLOC_DECLARE
 350 MALLOC_DECLARE(M_KQUEUE);
 351 #endif
 352
 353 TAILQ_HEAD(kqtailq, knote);     /* a list of "queued" events */
 354
 355 struct knote {
 356         int             kn_inuse;       /* inuse count */
 357         struct kqtailq  *kn_tq;         /* pointer to tail queue */
 358         TAILQ_ENTRY(knote)      kn_tqe;         /* linkage for tail queue */
 359         struct kqueue   *kn_kq; /* which kqueue we are on */
 360         SLIST_ENTRY(knote)      kn_link;        /* linkage for search list */
 361         SLIST_ENTRY(knote)      kn_selnext;     /* klist element chain */
 362         union {
 363                 struct          fileproc *p_fp; /* file data pointer */
 364                 struct          proc *p_proc;   /* proc pointer */
 365                 struct          ipc_pset *p_pset;       /* pset pointer */
 366         } kn_ptr;
 367         struct                  filterops *kn_fop;
 368         int                     kn_status;      /* status bits */
 369         int                     kn_sfflags;     /* saved filter flags */
 370         struct                  kevent64_s kn_kevent;
 371         void                    *kn_hook;
 372         int                     kn_hookid;
 373         int64_t                 kn_sdata;       /* saved data field */
 374
 375 #define KN_ACTIVE       0x01                    /* event has been triggered */
 376 #define KN_QUEUED       0x02                    /* event is on queue */
 377 #define KN_DISABLED     0x04                    /* event is disabled */
 378 #define KN_DROPPING     0x08                    /* knote is being dropped */
 379 #define KN_USEWAIT      0x10                    /* wait for knote use */
 380 #define KN_ATTACHING    0x20                    /* event is pending attach */
 381 #define KN_STAYQUEUED   0x40                    /* force event to stay on queue */
 382
 383 #define kn_id           kn_kevent.ident
 384 #define kn_filter       kn_kevent.filter
 385 #define kn_flags        kn_kevent.flags
 386 #define kn_fflags       kn_kevent.fflags
 387 #define kn_data         kn_kevent.data
 388 #define kn_udata        kn_kevent.udata
 389 #define kn_ext          kn_kevent.ext
 390 #define kn_fp           kn_ptr.p_fp
 391 };
 392
 393 /* Hint values for f_touch filter operation */
 394 #define EVENT_REGISTER  1
 395 #define EVENT_PROCESS   2
 396
 397 struct filterops {
 398         int     f_isfd;         /* true if ident == filedescriptor */
 399         int     (*f_attach)(struct knote *kn);
 400         void    (*f_detach)(struct knote *kn);
 401         int     (*f_event)(struct knote *kn, long hint);
 402         /* Optional f_touch operation, called only if !f_isfd && non-NULL */
 403         void    (*f_touch)(struct knote *kn, struct kevent64_s *kev, long type);
 404         /* Optional f_peek operation, called only if KN_STAYQUEUED is set */
 405         unsigned (*f_peek)(struct knote *kn);
 406 };
 407
 408 struct proc;
 409 struct wait_queue;
 410
 411 SLIST_HEAD(klist, knote);
 412 extern void     knote_init(void) __attribute__((section("__TEXT, initcode")));
 413 extern void     klist_init(struct klist *list);
 414
 415 #define KNOTE(list, hint)       knote(list, hint)
 416 #define KNOTE_ATTACH(list, kn)  knote_attach(list, kn)
 417 #define KNOTE_DETACH(list, kn)  knote_detach(list, kn)
 418
 419
 420 extern void     knote(struct klist *list, long hint);
 421 extern int      knote_attach(struct klist *list, struct knote *kn);
 422 extern int      knote_detach(struct klist *list, struct knote *kn);
 423 extern int      knote_link_wait_queue(struct knote *kn, struct wait_queue *wq, wait_queue_link_t wql);
 424 extern int      knote_unlink_wait_queue(struct knote *kn, struct wait_queue *wq, wait_queue_link_t *wqlp);
 425 extern void     knote_fdclose(struct proc *p, int fd);
 426 extern void     knote_markstayqueued(struct knote *kn);
 427
 428 #endif /* !KERNEL_PRIVATE */
 429
 430 #else   /* KERNEL */
 431
 432
 433 struct timespec;
 434
 435 __BEGIN_DECLS
 436 int     kqueue(void);
 437 int     kevent(int kq, const struct kevent *changelist, int nchanges,
 438                     struct kevent *eventlist, int nevents,
 439                     const struct timespec *timeout);
 440 int     kevent64(int kq, const struct kevent64_s *changelist,
 441                     int nchanges, struct kevent64_s *eventlist,
 442                     int nevents, unsigned int flags,
 443                     const struct timespec *timeout);
 444 __END_DECLS
 445
 446
 447 #endif /* KERNEL */
 448
 449
 450 #endif /* !_SYS_EVENT_H_ */