bsd/sys/event.h

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