xnu-2050.24.15.tar.gz

[apple/xnu.git] / bsd / sys / event.h

diff --git a/bsd/sys/event.h b/bsd/sys/event.h
index 72d71cecae819e7cb01da163923cceeb3f23db06..47fb6dafe8fb2fe7d8b6829fd6a662287064fbd0 100644 (file)
--- a/bsd/sys/event.h
+++ b/bsd/sys/event.h
@@ -1,23 +1,29 @@
 /*
 /*

- * Copyright (c) 2003-2005 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2003-2012 Apple Inc. All rights reserved.

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER

  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.

  * 
  * 

- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*-
  * Copyright (c) 1999,2000,2001 Jonathan Lemon <jlemon@FreeBSD.org>
  */
 /*-
  * Copyright (c) 1999,2000,2001 Jonathan Lemon <jlemon@FreeBSD.org>


@@ -61,42 +67,64 @@
 #define EVFILT_PROC            (-5)    /* attached to struct proc */
 #define EVFILT_SIGNAL          (-6)    /* attached to struct proc */
 #define EVFILT_TIMER           (-7)    /* timers */
 #define EVFILT_PROC            (-5)    /* attached to struct proc */
 #define EVFILT_SIGNAL          (-6)    /* attached to struct proc */
 #define EVFILT_TIMER           (-7)    /* timers */

-#define EVFILT_MACHPORT                (-8)    /* Mach ports */
+#define EVFILT_MACHPORT         (-8)   /* Mach portsets */

 #define EVFILT_FS              (-9)    /* Filesystem events */
 #define EVFILT_FS              (-9)    /* Filesystem events */

+#define EVFILT_USER             (-10)   /* User events */
+                                       /* (-11) unused */
+#define EVFILT_VM              (-12)   /* Virtual memory events */
+
+#ifdef PRIVATE
+#define EVFILT_SOCK            (-13)   /* Socket events */
+#endif /* PRIVATE */

 
 

-#define EVFILT_SYSCOUNT                9
+#define EVFILT_SYSCOUNT                13

 #define EVFILT_THREADMARKER    EVFILT_SYSCOUNT /* Internal use only */
 
 #pragma pack(4)
 
 struct kevent {
        uintptr_t       ident;          /* identifier for this event */
 #define EVFILT_THREADMARKER    EVFILT_SYSCOUNT /* Internal use only */
 
 #pragma pack(4)
 
 struct kevent {
        uintptr_t       ident;          /* identifier for this event */

-       short           filter;         /* filter for event */
-       unsigned short  flags;          /* general flags */
-       unsigned int    fflags;         /* filter-specific flags */
+       int16_t         filter;         /* filter for event */
+       uint16_t        flags;          /* general flags */
+       uint32_t        fflags;         /* filter-specific flags */

        intptr_t        data;           /* filter-specific data */
        intptr_t        data;           /* filter-specific data */

-#ifdef KERNEL_PRIVATE
-       user_addr_t     udata;          /* opaque user data identifier */
-#else

        void            *udata;         /* opaque user data identifier */
        void            *udata;         /* opaque user data identifier */

-#endif

 };
 
 #ifdef KERNEL_PRIVATE
 
 };
 
 #ifdef KERNEL_PRIVATE
 

-struct user_kevent {
+struct user64_kevent {

        uint64_t        ident;          /* identifier for this event */
        uint64_t        ident;          /* identifier for this event */

-       short           filter;         /* filter for event */
-       unsigned short  flags;          /* general flags */
-       unsigned int    fflags;         /* filter-specific flags */
+       int16_t         filter;         /* filter for event */
+       uint16_t        flags;          /* general flags */
+       uint32_t        fflags;         /* filter-specific flags */

        int64_t         data;           /* filter-specific data */
        user_addr_t     udata;          /* opaque user data identifier */
 };
 
        int64_t         data;           /* filter-specific data */
        user_addr_t     udata;          /* opaque user data identifier */
 };
 

+struct user32_kevent {
+       uint32_t        ident;          /* identifier for this event */
+       int16_t         filter;         /* filter for event */
+       uint16_t        flags;          /* general flags */
+       uint32_t        fflags;         /* filter-specific flags */
+       int32_t         data;           /* filter-specific data */
+       user32_addr_t   udata;          /* opaque user data identifier */
+};
+

 #endif
 
 #pragma pack()
 
 #endif
 
 #pragma pack()
 

+struct kevent64_s {
+       uint64_t        ident;          /* identifier for this event */
+       int16_t         filter;         /* filter for event */
+       uint16_t        flags;          /* general flags */
+       uint32_t        fflags;         /* filter-specific flags */
+       int64_t         data;           /* filter-specific data */
+       uint64_t        udata;          /* opaque user data identifier */
+       uint64_t        ext[2];         /* filter-specific extensions */
+};
+

 #define EV_SET(kevp, a, b, c, d, e, f) do {    \
        struct kevent *__kevp__ = (kevp);       \
        __kevp__->ident = (a);                  \
 #define EV_SET(kevp, a, b, c, d, e, f) do {    \
        struct kevent *__kevp__ = (kevp);       \
        __kevp__->ident = (a);                  \


@@ -107,15 +135,29 @@ struct user_kevent {
        __kevp__->udata = (f);                  \
 } while(0)
 
        __kevp__->udata = (f);                  \
 } while(0)
 

+#define EV_SET64(kevp, a, b, c, d, e, f, g, h) do {    \
+       struct kevent64_s *__kevp__ = (kevp);           \
+       __kevp__->ident = (a);                          \
+       __kevp__->filter = (b);                         \
+       __kevp__->flags = (c);                          \
+       __kevp__->fflags = (d);                         \
+       __kevp__->data = (e);                           \
+       __kevp__->udata = (f);                          \
+       __kevp__->ext[0] = (g);                         \
+       __kevp__->ext[1] = (h);                         \
+} while(0)
+

 /* actions */
 #define EV_ADD         0x0001          /* add event to kq (implies enable) */
 #define EV_DELETE      0x0002          /* delete event from kq */
 #define EV_ENABLE      0x0004          /* enable event */
 #define EV_DISABLE     0x0008          /* disable event (not reported) */
 /* actions */
 #define EV_ADD         0x0001          /* add event to kq (implies enable) */
 #define EV_DELETE      0x0002          /* delete event from kq */
 #define EV_ENABLE      0x0004          /* enable event */
 #define EV_DISABLE     0x0008          /* disable event (not reported) */

+#define EV_RECEIPT     0x0040          /* force EV_ERROR on success, data == 0 */

 
 /* flags */
 #define EV_ONESHOT     0x0010          /* only report one occurrence */
 #define EV_CLEAR       0x0020          /* clear event state after reporting */
 
 /* flags */
 #define EV_ONESHOT     0x0010          /* only report one occurrence */
 #define EV_CLEAR       0x0020          /* clear event state after reporting */

+#define EV_DISPATCH     0x0080          /* disable event after reporting */

 
 #define EV_SYSFLAGS    0xF000          /* reserved by system */
 #define EV_FLAG0       0x1000          /* filter-specific flag */
 
 #define EV_SYSFLAGS    0xF000          /* reserved by system */
 #define EV_FLAG0       0x1000          /* filter-specific flag */


@@ -146,6 +188,29 @@ struct user_kevent {
 #define EV_POLL        EV_FLAG0
 #define EV_OOBAND      EV_FLAG1
 
 #define EV_POLL        EV_FLAG0
 #define EV_OOBAND      EV_FLAG1
 

+/*
+ * data/hint fflags for EVFILT_USER, shared with userspace
+ */
+
+/*
+ * On input, NOTE_TRIGGER causes the event to be triggered for output.
+ */
+#define NOTE_TRIGGER   0x01000000
+
+/*
+ * On input, the top two bits of fflags specifies how the lower twenty four 
+ * bits should be applied to the stored value of fflags.
+ *
+ * On output, the top two bits will always be set to NOTE_FFNOP and the
+ * remaining twenty four bits will contain the stored fflags value.
+ */
+#define NOTE_FFNOP      0x00000000              /* ignore input fflags */
+#define NOTE_FFAND      0x40000000              /* and fflags */
+#define NOTE_FFOR       0x80000000              /* or fflags */
+#define NOTE_FFCOPY     0xc0000000              /* copy fflags */
+#define NOTE_FFCTRLMASK 0xc0000000              /* mask for operations */
+#define NOTE_FFLAGSMASK        0x00ffffff 
+

 /*
  * data/hint fflags for EVFILT_{READ|WRITE}, shared with userspace
  *
 /*
  * data/hint fflags for EVFILT_{READ|WRITE}, shared with userspace
  *


@@ -163,15 +228,51 @@ struct user_kevent {
 #define        NOTE_LINK       0x00000010              /* link count changed */
 #define        NOTE_RENAME     0x00000020              /* vnode was renamed */
 #define        NOTE_REVOKE     0x00000040              /* vnode access was revoked */
 #define        NOTE_LINK       0x00000010              /* link count changed */
 #define        NOTE_RENAME     0x00000020              /* vnode was renamed */
 #define        NOTE_REVOKE     0x00000040              /* vnode access was revoked */

+#define NOTE_NONE      0x00000080              /* No specific vnode event: to test for EVFILT_READ activation*/

 
 /*
  * data/hint fflags for EVFILT_PROC, shared with userspace
 
 /*
  * data/hint fflags for EVFILT_PROC, shared with userspace

+ *
+ * Please note that EVFILT_PROC and EVFILT_SIGNAL share the same knote list
+ * that hangs off the proc structure. They also both play games with the hint
+ * passed to KNOTE(). If NOTE_SIGNAL is passed as a hint, then the lower bits
+ * of the hint contain the signal. IF NOTE_FORK is passed, then the lower bits
+ * contain the PID of the child. 

  */
 #define        NOTE_EXIT       0x80000000              /* process exited */
 #define        NOTE_FORK       0x40000000              /* process forked */
 #define        NOTE_EXEC       0x20000000              /* process exec'd */
  */
 #define        NOTE_EXIT       0x80000000              /* process exited */
 #define        NOTE_FORK       0x40000000              /* process forked */
 #define        NOTE_EXEC       0x20000000              /* process exec'd */

-#define        NOTE_PCTRLMASK  0xf0000000              /* mask for hint bits */
-#define        NOTE_PDATAMASK  0x000fffff              /* mask for pid */
+#define        NOTE_REAP       0x10000000              /* process reaped */
+#define        NOTE_SIGNAL     0x08000000              /* shared with EVFILT_SIGNAL */
+#define        NOTE_EXITSTATUS 0x04000000              /* exit status to be returned, valid for child process only */
+#define        NOTE_RESOURCEEND 0x02000000             /* resource limit reached, resource type returned */
+
+#if CONFIG_EMBEDDED
+/* 0x01000000  is reserved for future use */
+
+/* App states notification */
+#define        NOTE_APPACTIVE          0x00800000      /* app went to active state */
+#define        NOTE_APPBACKGROUND      0x00400000      /* app went to background */
+#define        NOTE_APPNONUI           0x00200000      /* app went to active with no UI */
+#define        NOTE_APPINACTIVE        0x00100000      /* app went to inactive state */
+#define NOTE_APPALLSTATES      0x00f00000
+#endif /* CONFIG_EMBEDDED */
+
+#define        NOTE_PDATAMASK  0x000fffff              /* mask for pid/signal */
+#define        NOTE_PCTRLMASK  (~NOTE_PDATAMASK)
+
+/*
+ * If NOTE_EXITSTATUS is present, provide additional info about exiting process.
+ */
+#define NOTE_EXIT_REPARENTED   0x00080000      /* exited while reparented */
+
+/*
+ * data/hint fflags for EVFILT_VM, shared with userspace.
+ */
+#define NOTE_VM_PRESSURE                       0x80000000              /* will react on memory pressure */
+#define NOTE_VM_PRESSURE_TERMINATE             0x40000000              /* will quit on memory pressure, possibly after cleaning up dirty state */
+#define NOTE_VM_PRESSURE_SUDDEN_TERMINATE      0x20000000              /* will quit immediately on memory pressure */
+#define NOTE_VM_ERROR                          0x10000000              /* there was an error */

 
 /*
  * data/hint fflags for EVFILT_TIMER, shared with userspace.
 
 /*
  * data/hint fflags for EVFILT_TIMER, shared with userspace.


@@ -185,7 +286,47 @@ struct user_kevent {
 #define NOTE_NSECONDS  0x00000004              /* data is nanoseconds     */
 #define NOTE_ABSOLUTE  0x00000008              /* absolute timeout        */
                                                /* ... implicit EV_ONESHOT */
 #define NOTE_NSECONDS  0x00000004              /* data is nanoseconds     */
 #define NOTE_ABSOLUTE  0x00000008              /* absolute timeout        */
                                                /* ... implicit EV_ONESHOT */

- 
+#ifdef PRIVATE
+/*
+ * data/hint fflags for EVFILT_SOCK, shared with userspace.
+ *
+ */
+#define        NOTE_CONNRESET          0x00000001 /* Received RST */
+#define        NOTE_READCLOSED         0x00000002 /* Read side is shutdown */
+#define        NOTE_WRITECLOSED        0x00000004 /* Write side is shutdown */
+#define        NOTE_TIMEOUT            0x00000008 /* timeout: rexmt, keep-alive or persist */
+#define        NOTE_NOSRCADDR          0x00000010 /* source address not available */
+#define        NOTE_IFDENIED           0x00000020 /* interface denied connection */
+#define        NOTE_SUSPEND            0x00000040 /* output queue suspended */
+#define        NOTE_RESUME             0x00000080 /* output queue resumed */
+#define NOTE_KEEPALIVE         0x00000100 /* TCP Keepalive received */
+
+#endif /* PRIVATE */
+
+/*
+ * data/hint fflags for EVFILT_MACHPORT, shared with userspace.
+ *
+ * Only portsets are supported at this time.
+ *
+ * The fflags field can optionally contain the MACH_RCV_MSG, MACH_RCV_LARGE,
+ * and related trailer receive options as defined in <mach/message.h>.
+ * The presence of these flags directs the kevent64() call to attempt to receive
+ * the message during kevent delivery, rather than just indicate that a message exists.
+ * On setup, The ext[0] field contains the receive buffer pointer and ext[1] contains
+ * the receive buffer length.  Upon event delivery, the actual received message size
+ * is returned in ext[1].  As with mach_msg(), the buffer must be large enough to
+ * receive the message and the requested (or default) message trailers.  In addition,
+ * the fflags field contains the return code normally returned by mach_msg().
+ *
+ * If no message receipt options were provided in the fflags field on setup, no
+ * message is received by this call. Instead, on output, the data field simply
+ * contains the name of the actual port detected with a message waiting.
+ */
+
+/*
+ * DEPRECATED!!!!!!!!!
+ * NOTE_TRACK, NOTE_TRACKERR, and NOTE_CHILD are no longer supported as of 10.5
+ */

 /* additional flags for EVFILT_PROC */
 #define        NOTE_TRACK      0x00000001              /* follow across forks */
 #define        NOTE_TRACKERR   0x00000002              /* could not track child */
 /* additional flags for EVFILT_PROC */
 #define        NOTE_TRACK      0x00000001              /* follow across forks */
 #define        NOTE_TRACKERR   0x00000002              /* could not track child */


@@ -209,12 +350,6 @@ SLIST_HEAD(klist, knote);
 MALLOC_DECLARE(M_KQUEUE);
 #endif
 
 MALLOC_DECLARE(M_KQUEUE);
 #endif
 

-/*
- * Flag indicating hint is a signal.  Used by EVFILT_SIGNAL, and also
- * shared by EVFILT_PROC  (all knotes attached to p->p_klist)
- */
-#define NOTE_SIGNAL    0x08000000
-

 TAILQ_HEAD(kqtailq, knote);    /* a list of "queued" events */
 
 struct knote {
 TAILQ_HEAD(kqtailq, knote);    /* a list of "queued" events */
 
 struct knote {


@@ -227,12 +362,13 @@ struct knote {
        union {
                struct          fileproc *p_fp; /* file data pointer */
                struct          proc *p_proc;   /* proc pointer */
        union {
                struct          fileproc *p_fp; /* file data pointer */
                struct          proc *p_proc;   /* proc pointer */

+               struct          ipc_pset *p_pset;       /* pset pointer */

        } kn_ptr;
        struct                  filterops *kn_fop;
        int                     kn_status;      /* status bits */
        int                     kn_sfflags;     /* saved filter flags */
        } kn_ptr;
        struct                  filterops *kn_fop;
        int                     kn_status;      /* status bits */
        int                     kn_sfflags;     /* saved filter flags */

-       struct                  kevent kn_kevent;
-       caddr_t                 kn_hook;
+       struct                  kevent64_s kn_kevent;
+       void                    *kn_hook;

        int                     kn_hookid;
        int64_t                 kn_sdata;       /* saved data field */
 
        int                     kn_hookid;
        int64_t                 kn_sdata;       /* saved data field */
 


@@ -241,26 +377,39 @@ struct knote {
 #define KN_DISABLED    0x04                    /* event is disabled */
 #define KN_DROPPING    0x08                    /* knote is being dropped */
 #define KN_USEWAIT     0x10                    /* wait for knote use */
 #define KN_DISABLED    0x04                    /* event is disabled */
 #define KN_DROPPING    0x08                    /* knote is being dropped */
 #define KN_USEWAIT     0x10                    /* wait for knote use */

-#define KN_DROPWAIT    0x20                    /* wait for knote drop */
+#define KN_ATTACHING   0x20                    /* event is pending attach */
+#define KN_STAYQUEUED  0x40                    /* force event to stay on queue */

 
 #define kn_id          kn_kevent.ident
 #define kn_filter      kn_kevent.filter
 #define kn_flags       kn_kevent.flags
 #define kn_fflags      kn_kevent.fflags
 #define kn_data                kn_kevent.data
 
 #define kn_id          kn_kevent.ident
 #define kn_filter      kn_kevent.filter
 #define kn_flags       kn_kevent.flags
 #define kn_fflags      kn_kevent.fflags
 #define kn_data                kn_kevent.data

+#define kn_udata       kn_kevent.udata
+#define kn_ext         kn_kevent.ext

 #define kn_fp          kn_ptr.p_fp
 };
 
 #define kn_fp          kn_ptr.p_fp
 };
 

+/* Hint values for f_touch filter operation */
+#define EVENT_REGISTER  1
+#define EVENT_PROCESS   2
+

 struct filterops {
        int     f_isfd;         /* true if ident == filedescriptor */
        int     (*f_attach)(struct knote *kn);
        void    (*f_detach)(struct knote *kn);
        int     (*f_event)(struct knote *kn, long hint);
 struct filterops {
        int     f_isfd;         /* true if ident == filedescriptor */
        int     (*f_attach)(struct knote *kn);
        void    (*f_detach)(struct knote *kn);
        int     (*f_event)(struct knote *kn, long hint);

+       /* Optional f_touch operation, called only if !f_isfd && non-NULL */
+       void    (*f_touch)(struct knote *kn, struct kevent64_s *kev, long type);
+       /* Optional f_peek operation, called only if KN_STAYQUEUED is set */
+       unsigned (*f_peek)(struct knote *kn);

 };
 
 struct proc;
 };
 
 struct proc;

+struct wait_queue;

 
 SLIST_HEAD(klist, knote);
 
 SLIST_HEAD(klist, knote);

+extern void    knote_init(void) __attribute__((section("__TEXT, initcode")));

 extern void    klist_init(struct klist *list);
 
 #define KNOTE(list, hint)      knote(list, hint)
 extern void    klist_init(struct klist *list);
 
 #define KNOTE(list, hint)      knote(list, hint)


@@ -271,7 +420,10 @@ extern void        klist_init(struct klist *list);
 extern void    knote(struct klist *list, long hint);
 extern int     knote_attach(struct klist *list, struct knote *kn);
 extern int     knote_detach(struct klist *list, struct knote *kn);
 extern void    knote(struct klist *list, long hint);
 extern int     knote_attach(struct klist *list, struct knote *kn);
 extern int     knote_detach(struct klist *list, struct knote *kn);

+extern int     knote_link_wait_queue(struct knote *kn, struct wait_queue *wq, wait_queue_link_t wql);  
+extern int     knote_unlink_wait_queue(struct knote *kn, struct wait_queue *wq, wait_queue_link_t *wqlp);

 extern void    knote_fdclose(struct proc *p, int fd);
 extern void    knote_fdclose(struct proc *p, int fd);

+extern void    knote_markstayqueued(struct knote *kn);

 
 #endif /* !KERNEL_PRIVATE */
 
 
 #endif /* !KERNEL_PRIVATE */
 


@@ -285,18 +437,13 @@ int     kqueue(void);
 int     kevent(int kq, const struct kevent *changelist, int nchanges,
                    struct kevent *eventlist, int nevents,
                    const struct timespec *timeout);
 int     kevent(int kq, const struct kevent *changelist, int nchanges,
                    struct kevent *eventlist, int nevents,
                    const struct timespec *timeout);

+int     kevent64(int kq, const struct kevent64_s *changelist, 
+                   int nchanges, struct kevent64_s *eventlist, 
+                   int nevents, unsigned int flags, 
+                   const struct timespec *timeout);

 __END_DECLS
 
 
 __END_DECLS
 
 

-#ifdef PRIVATE
-#include <mach/port.h>
-
-__BEGIN_DECLS
-mach_port_t    kqueue_portset_np(int kq);
-int    kqueue_from_portset_np(mach_port_t portset);
-__END_DECLS
-#endif /* PRIVATE */
-

 #endif /* KERNEL */
 
 
 #endif /* KERNEL */