sys/sys/event.h

   1 /*-
   2  * Copyright (c) 1999,2000,2001 Jonathan Lemon <jlemon@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  *      $FreeBSD: src/sys/sys/event.h,v 1.5.2.6 2003/02/09 15:28:13 nectar Exp $
  27  *      $DragonFly: src/sys/sys/event.h,v 1.7 2007/01/15 01:26:56 dillon Exp $
  28  */
  29
  30 #ifndef _SYS_EVENT_H_
  31 #define _SYS_EVENT_H_
  32
  33 #ifndef _SYS_TYPES_H_
  34 #include <sys/types.h>
  35 #endif
  36
  37 #define EVFILT_READ             (-1)
  38 #define EVFILT_WRITE            (-2)
  39 #define EVFILT_AIO              (-3)    /* attached to aio requests */
  40 #define EVFILT_VNODE            (-4)    /* attached to vnodes */
  41 #define EVFILT_PROC             (-5)    /* attached to struct proc */
  42 #define EVFILT_SIGNAL           (-6)    /* attached to struct proc */
  43 #define EVFILT_TIMER            (-7)    /* timers */
  44 #define EVFILT_EXCEPT           (-8)    /* exceptional conditions */
  45
  46 #define EVFILT_MARKER           0xF     /* placemarker for tailq */
  47
  48 #define EVFILT_SYSCOUNT         8
  49
  50 #define EV_SET(kevp_, a, b, c, d, e, f) do {    \
  51         struct kevent *kevp = (kevp_);          \
  52         (kevp)->ident = (a);                    \
  53         (kevp)->filter = (b);                   \
  54         (kevp)->flags = (c);                    \
  55         (kevp)->fflags = (d);                   \
  56         (kevp)->data = (e);                     \
  57         (kevp)->udata = (f);                    \
  58 } while(0)
  59
  60 struct kevent {
  61         uintptr_t       ident;          /* identifier for this event */
  62         short           filter;         /* filter for event */
  63         u_short         flags;
  64         u_int           fflags;
  65         intptr_t        data;
  66         void            *udata;         /* opaque user data identifier */
  67 };
  68
  69 /* actions */
  70 #define EV_ADD          0x0001          /* add event to kq (implies enable) */
  71 #define EV_DELETE       0x0002          /* delete event from kq */
  72 #define EV_ENABLE       0x0004          /* enable event */
  73 #define EV_DISABLE      0x0008          /* disable event (not reported) */
  74
  75 /* flags */
  76 #define EV_ONESHOT      0x0010          /* only report one occurrence */
  77 #define EV_CLEAR        0x0020          /* clear event state after reporting */
  78
  79 #define EV_SYSFLAGS     0xF000          /* reserved by system */
  80 #define EV_FLAG1        0x2000          /* filter-specific flag */
  81
  82 /* returned values */
  83 #define EV_EOF          0x8000          /* EOF detected */
  84 #define EV_ERROR        0x4000          /* error, data contains errno */
  85
  86 /*
  87  * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace
  88  */
  89 #define NOTE_LOWAT      0x0001                  /* low water mark */
  90
  91 /*
  92  * data/hint flags for EVFILT_EXCEPT, shared with userspace
  93  */
  94 #define NOTE_OOB        0x0002                  /* OOB data on a socket */
  95
  96 /*
  97  * data/hint flags for EVFILT_VNODE, shared with userspace
  98  */
  99 #define NOTE_DELETE     0x0001                  /* vnode was removed */
 100 #define NOTE_WRITE      0x0002                  /* data contents changed */
 101 #define NOTE_EXTEND     0x0004                  /* size increased */
 102 #define NOTE_ATTRIB     0x0008                  /* attributes changed */
 103 #define NOTE_LINK       0x0010                  /* link count changed */
 104 #define NOTE_RENAME     0x0020                  /* vnode was renamed */
 105 #define NOTE_REVOKE     0x0040                  /* vnode access was revoked */
 106
 107 /*
 108  * data/hint flags for EVFILT_PROC, shared with userspace
 109  */
 110 #define NOTE_EXIT       0x80000000              /* process exited */
 111 #define NOTE_FORK       0x40000000              /* process forked */
 112 #define NOTE_EXEC       0x20000000              /* process exec'd */
 113 #define NOTE_PCTRLMASK  0xf0000000              /* mask for hint bits */
 114 #define NOTE_PDATAMASK  0x000fffff              /* mask for pid */
 115
 116 /* additional flags for EVFILT_PROC */
 117 #define NOTE_TRACK      0x00000001              /* follow across forks */
 118 #define NOTE_TRACKERR   0x00000002              /* could not track child */
 119 #define NOTE_CHILD      0x00000004              /* am a child process */
 120
 121 /*
 122  * This is currently visible to userland to work around broken
 123  * programs which pull in <sys/proc.h> or <sys/select.h>.
 124  */
 125 #include <sys/queue.h>
 126 struct knote;
 127 SLIST_HEAD(klist, knote);
 128
 129 #ifdef _KERNEL
 130
 131 #ifdef MALLOC_DECLARE
 132 MALLOC_DECLARE(M_KQUEUE);
 133 #endif
 134
 135 #define KNOTE(list, hint)       if ((list) != NULL) knote(list, hint)
 136
 137 /*
 138  * Flag indicating hint is a signal.  Used by EVFILT_SIGNAL, and also
 139  * shared by EVFILT_PROC  (all knotes attached to p->p_klist)
 140  */
 141 #define NOTE_SIGNAL     0x08000000
 142
 143 struct filterops {
 144         int     f_isfd;         /* true if ident == filedescriptor */
 145
 146         /* f_attach returns 0 on success or valid error code on failure */
 147         int     (*f_attach)     (struct knote *kn);
 148         void    (*f_detach)     (struct knote *kn);
 149
 150         /* f_event returns boolean truth */
 151         int     (*f_event)      (struct knote *kn, long hint);
 152 };
 153
 154 struct knote {
 155         SLIST_ENTRY(knote)      kn_link;        /* for fd */
 156         TAILQ_ENTRY(knote)      kn_kqlink;      /* for kq_knlist */
 157         SLIST_ENTRY(knote)      kn_selnext;     /* for struct selinfo */
 158         TAILQ_ENTRY(knote)      kn_tqe;         /* for kq_head */
 159         struct                  kqueue *kn_kq;  /* which queue we are on */
 160         struct                  kevent kn_kevent;
 161         int                     kn_status;
 162         int                     kn_sfflags;     /* saved filter flags */
 163         intptr_t                kn_sdata;       /* saved data field */
 164         union {
 165                 struct          file *p_fp;     /* file data pointer */
 166                 struct          proc *p_proc;   /* proc pointer */
 167         } kn_ptr;
 168         struct                  filterops *kn_fop;
 169         caddr_t                 kn_hook;
 170 #define KN_ACTIVE       0x01                    /* event has been triggered */
 171 #define KN_QUEUED       0x02                    /* event is on queue */
 172 #define KN_DISABLED     0x04                    /* event is disabled */
 173 #define KN_DETACHED     0x08                    /* knote is detached */
 174
 175 #define kn_id           kn_kevent.ident
 176 #define kn_filter       kn_kevent.filter
 177 #define kn_flags        kn_kevent.flags
 178 #define kn_fflags       kn_kevent.fflags
 179 #define kn_data         kn_kevent.data
 180 #define kn_fp           kn_ptr.p_fp
 181 };
 182
 183 struct proc;
 184 struct thread;
 185 struct filedesc;
 186 struct kevent_args;
 187
 188 typedef int     (*k_copyout_fn)(void *arg, struct kevent *kevp, int count,
 189     int *res);
 190 typedef int     (*k_copyin_fn)(void *arg, struct kevent *kevp, int max,
 191     int *events);
 192 int kern_kevent(struct kqueue *kq, int nevents, int *res, void *uap,
 193     k_copyin_fn kevent_copyin, k_copyout_fn kevent_copyout,
 194     struct timespec *tsp);
 195
 196 extern void     knote(struct klist *list, long hint);
 197 extern void     knote_remove(struct klist *list);
 198 extern void     knote_fdclose(struct file *fp, struct filedesc *fdp, int fd);
 199 extern void     kqueue_init(struct kqueue *kq, struct filedesc *fdp);
 200 extern void     kqueue_terminate(struct kqueue *kq);
 201 extern int      kqueue_register(struct kqueue *kq, struct kevent *kev);
 202 extern void     kqueue_wakeup(struct kqueue *kq);
 203
 204 #endif  /* _KERNEL */
 205
 206 #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)
 207
 208 #include <sys/cdefs.h>
 209 struct timespec;
 210
 211 __BEGIN_DECLS
 212 int     kqueue (void);
 213 int     kevent (int, const struct kevent *, int, struct kevent *,
 214                 int, const struct timespec *);
 215 __END_DECLS
 216 #endif /* !_KERNEL */
 217
 218 #endif /* !_SYS_EVENT_H_ */