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 #ifndef _NET_NETISR_H_
  37 #include <net/netisr.h>                 /* struct notifymsglist */
  38 #endif
  39
  40 #define EVFILT_READ             (-1)
  41 #define EVFILT_WRITE            (-2)
  42 #define EVFILT_AIO              (-3)    /* attached to aio requests */
  43 #define EVFILT_VNODE            (-4)    /* attached to vnodes */
  44 #define EVFILT_PROC             (-5)    /* attached to struct proc */
  45 #define EVFILT_SIGNAL           (-6)    /* attached to struct proc */
  46 #define EVFILT_TIMER            (-7)    /* timers */
  47 #define EVFILT_EXCEPT           (-8)    /* exceptional conditions */
  48
  49 #define EVFILT_MARKER           0xF     /* placemarker for tailq */
  50
  51 #define EVFILT_SYSCOUNT         8
  52
  53 #define EV_SET(kevp_, a, b, c, d, e, f) do {    \
  54         struct kevent *kevp = (kevp_);          \
  55         (kevp)->ident = (a);                    \
  56         (kevp)->filter = (b);                   \
  57         (kevp)->flags = (c);                    \
  58         (kevp)->fflags = (d);                   \
  59         (kevp)->data = (e);                     \
  60         (kevp)->udata = (f);                    \
  61 } while(0)
  62
  63 struct kevent {
  64         uintptr_t       ident;          /* identifier for this event */
  65         short           filter;         /* filter for event */
  66         u_short         flags;
  67         u_int           fflags;
  68         intptr_t        data;
  69         void            *udata;         /* opaque user data identifier */
  70 };
  71
  72 /* actions */
  73 #define EV_ADD          0x0001          /* add event to kq (implies enable) */
  74 #define EV_DELETE       0x0002          /* delete event from kq */
  75 #define EV_ENABLE       0x0004          /* enable event */
  76 #define EV_DISABLE      0x0008          /* disable event (not reported) */
  77
  78 /* flags */
  79 #define EV_ONESHOT      0x0010          /* only report one occurrence */
  80 #define EV_CLEAR        0x0020          /* clear event state after reporting */
  81
  82 #define EV_SYSFLAGS     0xF000          /* reserved by system */
  83 #define EV_FLAG1        0x2000          /* filter-specific flag */
  84
  85 /* returned values */
  86 #define EV_EOF          0x8000          /* EOF detected */
  87 #define EV_ERROR        0x4000          /* error, data contains errno */
  88
  89 /*
  90  * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace
  91  */
  92 #define NOTE_LOWAT      0x0001                  /* low water mark */
  93
  94 /*
  95  * data/hint flags for EVFILT_EXCEPT, shared with userspace and with
  96  * EVFILT_{READ|WRITE}
  97  */
  98 #define NOTE_OOB        0x0002                  /* OOB data on a socket */
  99
 100 /*
 101  * data/hint flags for EVFILT_VNODE, shared with userspace
 102  */
 103 #define NOTE_DELETE     0x0001                  /* vnode was removed */
 104 #define NOTE_WRITE      0x0002                  /* data contents changed */
 105 #define NOTE_EXTEND     0x0004                  /* size increased */
 106 #define NOTE_ATTRIB     0x0008                  /* attributes changed */
 107 #define NOTE_LINK       0x0010                  /* link count changed */
 108 #define NOTE_RENAME     0x0020                  /* vnode was renamed */
 109 #define NOTE_REVOKE     0x0040                  /* vnode access was revoked */
 110
 111 /*
 112  * data/hint flags for EVFILT_PROC, shared with userspace
 113  */
 114 #define NOTE_EXIT       0x80000000              /* process exited */
 115 #define NOTE_FORK       0x40000000              /* process forked */
 116 #define NOTE_EXEC       0x20000000              /* process exec'd */
 117 #define NOTE_PCTRLMASK  0xf0000000              /* mask for hint bits */
 118 #define NOTE_PDATAMASK  0x000fffff              /* mask for pid */
 119
 120 /* additional flags for EVFILT_PROC */
 121 #define NOTE_TRACK      0x00000001              /* follow across forks */
 122 #define NOTE_TRACKERR   0x00000002              /* could not track child */
 123 #define NOTE_CHILD      0x00000004              /* am a child process */
 124
 125 /*
 126  * This is currently visible to userland to work around broken
 127  * programs which pull in <sys/proc.h> or <sys/select.h>.
 128  */
 129 #include <sys/queue.h>
 130 struct knote;
 131 SLIST_HEAD(klist, knote);
 132
 133 #ifdef _KERNEL
 134
 135 /*
 136  * Global token for kqueue subsystem
 137  */
 138 extern struct lwkt_token kq_token;
 139
 140 #ifdef MALLOC_DECLARE
 141 MALLOC_DECLARE(M_KQUEUE);
 142 #endif
 143
 144 #define KNOTE(list, hint)       if ((list) != NULL) knote(list, hint)
 145
 146 /*
 147  * Flag indicating hint is a signal.  Used by EVFILT_SIGNAL, and also
 148  * shared by EVFILT_PROC  (all knotes attached to p->p_klist)
 149  */
 150 #define NOTE_SIGNAL     0x08000000
 151
 152 #define FILTEROP_ISFD   0x0001          /* if ident == filedescriptor */
 153 #define FILTEROP_MPSAFE 0x0002
 154
 155 struct filterops {
 156         u_short f_flags;
 157
 158         /* f_attach returns 0 on success or valid error code on failure */
 159         int     (*f_attach)     (struct knote *kn);
 160         void    (*f_detach)     (struct knote *kn);
 161
 162         /* f_event returns boolean truth */
 163         int     (*f_event)      (struct knote *kn, long hint);
 164 };
 165
 166 struct knote {
 167         SLIST_ENTRY(knote)      kn_link;        /* for fd */
 168         TAILQ_ENTRY(knote)      kn_kqlink;      /* for kq_knlist */
 169         SLIST_ENTRY(knote)      kn_next;        /* for struct kqinfo */
 170         TAILQ_ENTRY(knote)      kn_tqe;         /* for kq_head */
 171         struct                  kqueue *kn_kq;  /* which queue we are on */
 172         struct                  kevent kn_kevent;
 173         int                     kn_status;
 174         int                     kn_sfflags;     /* saved filter flags */
 175         intptr_t                kn_sdata;       /* saved data field */
 176         union {
 177                 struct          file *p_fp;     /* file data pointer */
 178                 struct          proc *p_proc;   /* proc pointer */
 179         } kn_ptr;
 180         struct                  filterops *kn_fop;
 181         caddr_t                 kn_hook;
 182 #define KN_ACTIVE       0x01                    /* event has been triggered */
 183 #define KN_QUEUED       0x02                    /* event is on queue */
 184 #define KN_DISABLED     0x04                    /* event is disabled */
 185 #define KN_DETACHED     0x08                    /* knote is detached */
 186
 187 #define kn_id           kn_kevent.ident
 188 #define kn_filter       kn_kevent.filter
 189 #define kn_flags        kn_kevent.flags
 190 #define kn_fflags       kn_kevent.fflags
 191 #define kn_data         kn_kevent.data
 192 #define kn_fp           kn_ptr.p_fp
 193 };
 194
 195 /*
 196  * Used to maintain information about processes that wish to be
 197  * notified when I/O becomes possible.
 198  */
 199 struct kqinfo {
 200         struct  klist ki_note;          /* kernel note list */
 201         struct  notifymsglist ki_mlist; /* list of pending predicate messages */
 202 };
 203
 204 struct proc;
 205 struct thread;
 206 struct filedesc;
 207 struct kevent_args;
 208
 209 typedef int     (*k_copyout_fn)(void *arg, struct kevent *kevp, int count,
 210     int *res);
 211 typedef int     (*k_copyin_fn)(void *arg, struct kevent *kevp, int max,
 212     int *events);
 213 int kern_kevent(struct kqueue *kq, int nevents, int *res, void *uap,
 214     k_copyin_fn kevent_copyin, k_copyout_fn kevent_copyout,
 215     struct timespec *tsp);
 216
 217 extern void     knote(struct klist *list, long hint);
 218 extern void     knote_insert(struct klist *klist, struct knote *kn);
 219 extern void     knote_remove(struct klist *klist, struct knote *kn);
 220 extern void     knote_empty(struct klist *list);
 221 extern void     knote_fdclose(struct file *fp, struct filedesc *fdp, int fd);
 222 extern void     kqueue_init(struct kqueue *kq, struct filedesc *fdp);
 223 extern void     kqueue_terminate(struct kqueue *kq);
 224 extern int      kqueue_register(struct kqueue *kq, struct kevent *kev);
 225
 226 #endif  /* _KERNEL */
 227
 228 #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)
 229
 230 #include <sys/cdefs.h>
 231 struct timespec;
 232
 233 __BEGIN_DECLS
 234 int     kqueue (void);
 235 int     kevent (int, const struct kevent *, int, struct kevent *,
 236                 int, const struct timespec *);
 237 __END_DECLS
 238 #endif /* !_KERNEL */
 239
 240 #endif /* !_SYS_EVENT_H_ */