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.26.2.4 2005/06/29 18:08:31 ps Exp $
   27  */
   28 
   29 #ifndef _SYS_EVENT_H_
   30 #define _SYS_EVENT_H_
   31 
   32 #define EVFILT_READ             (-1)
   33 #define EVFILT_WRITE            (-2)
   34 #define EVFILT_AIO              (-3)    /* attached to aio requests */
   35 #define EVFILT_VNODE            (-4)    /* attached to vnodes */
   36 #define EVFILT_PROC             (-5)    /* attached to struct proc */
   37 #define EVFILT_SIGNAL           (-6)    /* attached to struct proc */
   38 #define EVFILT_TIMER            (-7)    /* timers */
   39 #define EVFILT_NETDEV           (-8)    /* network devices */
   40 #define EVFILT_FS               (-9)    /* filesystem events */
   41 
   42 #define EVFILT_SYSCOUNT         9
   43 
   44 #define EV_SET(kevp_, a, b, c, d, e, f) do {    \
   45         struct kevent *kevp = (kevp_);          \
   46         (kevp)->ident = (a);                    \
   47         (kevp)->filter = (b);                   \
   48         (kevp)->flags = (c);                    \
   49         (kevp)->fflags = (d);                   \
   50         (kevp)->data = (e);                     \
   51         (kevp)->udata = (f);                    \
   52 } while(0)
   53 
   54 struct kevent {
   55         uintptr_t       ident;          /* identifier for this event */
   56         short           filter;         /* filter for event */
   57         u_short         flags;
   58         u_int           fflags;
   59         intptr_t        data;
   60         void            *udata;         /* opaque user data identifier */
   61 };
   62 
   63 /* actions */
   64 #define EV_ADD          0x0001          /* add event to kq (implies enable) */
   65 #define EV_DELETE       0x0002          /* delete event from kq */
   66 #define EV_ENABLE       0x0004          /* enable event */
   67 #define EV_DISABLE      0x0008          /* disable event (not reported) */
   68 
   69 /* flags */
   70 #define EV_ONESHOT      0x0010          /* only report one occurrence */
   71 #define EV_CLEAR        0x0020          /* clear event state after reporting */
   72 
   73 #define EV_SYSFLAGS     0xF000          /* reserved by system */
   74 #define EV_FLAG1        0x2000          /* filter-specific flag */
   75 
   76 /* returned values */
   77 #define EV_EOF          0x8000          /* EOF detected */
   78 #define EV_ERROR        0x4000          /* error, data contains errno */
   79 
   80 /*
   81  * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace
   82  */
   83 #define NOTE_LOWAT      0x0001                  /* low water mark */
   84 
   85 /*
   86  * data/hint flags for EVFILT_VNODE, shared with userspace
   87  */
   88 #define NOTE_DELETE     0x0001                  /* vnode was removed */
   89 #define NOTE_WRITE      0x0002                  /* data contents changed */
   90 #define NOTE_EXTEND     0x0004                  /* size increased */
   91 #define NOTE_ATTRIB     0x0008                  /* attributes changed */
   92 #define NOTE_LINK       0x0010                  /* link count changed */
   93 #define NOTE_RENAME     0x0020                  /* vnode was renamed */
   94 #define NOTE_REVOKE     0x0040                  /* vnode access was revoked */
   95 
   96 /*
   97  * data/hint flags for EVFILT_PROC, shared with userspace
   98  */
   99 #define NOTE_EXIT       0x80000000              /* process exited */
  100 #define NOTE_FORK       0x40000000              /* process forked */
  101 #define NOTE_EXEC       0x20000000              /* process exec'd */
  102 #define NOTE_PCTRLMASK  0xf0000000              /* mask for hint bits */
  103 #define NOTE_PDATAMASK  0x000fffff              /* mask for pid */
  104 
  105 /* additional flags for EVFILT_PROC */
  106 #define NOTE_TRACK      0x00000001              /* follow across forks */
  107 #define NOTE_TRACKERR   0x00000002              /* could not track child */
  108 #define NOTE_CHILD      0x00000004              /* am a child process */
  109 
  110 /*
  111  * data/hint flags for EVFILT_NETDEV, shared with userspace
  112  */
  113 #define NOTE_LINKUP     0x0001                  /* link is up */
  114 #define NOTE_LINKDOWN   0x0002                  /* link is down */
  115 #define NOTE_LINKINV    0x0004                  /* link state is invalid */
  116 
  117 /*
  118  * This is currently visible to userland to work around broken
  119  * programs which pull in <sys/proc.h>.
  120  */
  121 #include <sys/queue.h> 
  122 #include <sys/_lock.h>
  123 #include <sys/_mutex.h>
  124 struct knote;
  125 SLIST_HEAD(klist, knote);
  126 struct kqueue;
  127 SLIST_HEAD(kqlist, kqueue);
  128 struct knlist {
  129         struct  mtx     *kl_lock;       /* lock to protect kll_list */
  130         struct  klist   kl_list;
  131 };
  132 
  133 
  134 #ifdef _KERNEL
  135 
  136 #ifdef MALLOC_DECLARE
  137 MALLOC_DECLARE(M_KQUEUE);
  138 #endif
  139 
  140 #define KNOTE(list, hist, lock)         knote(list, hist, lock)
  141 #define KNOTE_LOCKED(list, hint)        knote(list, hint, 1)
  142 #define KNOTE_UNLOCKED(list, hint)      knote(list, hint, 0)
  143 
  144 /*
  145  * Flag indicating hint is a signal.  Used by EVFILT_SIGNAL, and also
  146  * shared by EVFILT_PROC  (all knotes attached to p->p_klist)
  147  */
  148 #define NOTE_SIGNAL     0x08000000
  149 
  150 struct filterops {
  151         int     f_isfd;         /* true if ident == filedescriptor */
  152         int     (*f_attach)(struct knote *kn);
  153         void    (*f_detach)(struct knote *kn);
  154         int     (*f_event)(struct knote *kn, long hint);
  155 };
  156 
  157 /*
  158  * Setting the KN_INFLUX flag enables you to unlock the kq that this knote
  159  * is on, and modify kn_status as if you had the KQ lock.
  160  *
  161  * kn_sfflags, kn_sdata, and kn_kevent are protected by the knlist lock.
  162  */
  163 struct knote {
  164         SLIST_ENTRY(knote)      kn_link;        /* for kq */
  165         SLIST_ENTRY(knote)      kn_selnext;     /* for struct selinfo */
  166         struct                  knlist *kn_knlist;      /* f_attach populated */
  167         TAILQ_ENTRY(knote)      kn_tqe;
  168         struct                  kqueue *kn_kq;  /* which queue we are on */
  169         struct                  kevent kn_kevent;
  170         int                     kn_status;      /* protected by kq lock */
  171 #define KN_ACTIVE       0x01                    /* event has been triggered */
  172 #define KN_QUEUED       0x02                    /* event is on queue */
  173 #define KN_DISABLED     0x04                    /* event is disabled */
  174 #define KN_DETACHED     0x08                    /* knote is detached */
  175 #define KN_INFLUX       0x10                    /* knote is in flux */
  176 #define KN_MARKER       0x20                    /* ignore this knote */
  177 #define KN_KQUEUE       0x40                    /* this knote belongs to a kq */
  178 #define KN_HASKQLOCK    0x80                    /* for _inevent */
  179         int                     kn_sfflags;     /* saved filter flags */
  180         intptr_t                kn_sdata;       /* saved data field */
  181         union {
  182                 struct          file *p_fp;     /* file data pointer */
  183                 struct          proc *p_proc;   /* proc pointer */
  184         } kn_ptr;
  185         struct                  filterops *kn_fop;
  186         void                    *kn_hook;
  187 
  188 #define kn_id           kn_kevent.ident
  189 #define kn_filter       kn_kevent.filter
  190 #define kn_flags        kn_kevent.flags
  191 #define kn_fflags       kn_kevent.fflags
  192 #define kn_data         kn_kevent.data
  193 #define kn_fp           kn_ptr.p_fp
  194 };
  195 struct kevent_copyops {
  196         void    *arg;
  197         int     (*k_copyout)(void *arg, struct kevent *kevp, int count);
  198         int     (*k_copyin)(void *arg, struct kevent *kevp, int count);
  199 };
  200 
  201 struct thread;
  202 struct proc;
  203 struct knlist;
  204 
  205 extern void     knote(struct knlist *list, long hint, int islocked);
  206 extern void     knlist_add(struct knlist *knl, struct knote *kn, int islocked);
  207 extern void     knlist_remove(struct knlist *knl, struct knote *kn, int islocked);
  208 extern void     knlist_remove_inevent(struct knlist *knl, struct knote *kn);
  209 extern int      knlist_empty(struct knlist *knl);
  210 extern void     knlist_init(struct knlist *knl, struct mtx *mtx);
  211 extern void     knlist_destroy(struct knlist *knl);
  212 extern void     knlist_cleardel(struct knlist *knl, struct thread *td,
  213         int islocked, int killkn);
  214 #define knlist_clear(knl, islocked)                             \
  215                 knlist_cleardel((knl), NULL, (islocked), 0)
  216 #define knlist_delete(knl, td, islocked)                        \
  217                 knlist_cleardel((knl), (td), (islocked), 1)
  218 extern void     knote_fdclose(struct thread *p, int fd);
  219 extern int      kqueue_register(struct kqueue *kq,
  220                     struct kevent *kev, struct thread *p, int waitok);
  221 extern int      kqueue_add_filteropts(int filt, struct filterops *filtops);
  222 extern int      kqueue_del_filteropts(int filt);
  223 
  224 #else   /* !_KERNEL */
  225 
  226 #include <sys/cdefs.h>
  227 struct timespec;
  228 
  229 __BEGIN_DECLS
  230 int     kqueue(void);
  231 int     kevent(int kq, struct kevent *changelist, int nchanges,
  232             struct kevent *eventlist, int nevents,
  233             const struct timespec *timeout);
  234 __END_DECLS
  235 
  236 #endif /* !_KERNEL */
  237 
  238 #endif /* !_SYS_EVENT_H_ */

Cache object: 68c28394f39e3ec1cc810941e1adc9a7


[ 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.