The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/event.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: d1e08ba37365b14cd2ea66c6cc0dda63


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.