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-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
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: releng/11.2/sys/sys/event.h 331722 2018-03-29 02:50:57Z eadler $
   27  */
   28 
   29 #ifndef _SYS_EVENT_H_
   30 #define _SYS_EVENT_H_
   31 
   32 #include <sys/queue.h> 
   33 
   34 #define EVFILT_READ             (-1)
   35 #define EVFILT_WRITE            (-2)
   36 #define EVFILT_AIO              (-3)    /* attached to aio requests */
   37 #define EVFILT_VNODE            (-4)    /* attached to vnodes */
   38 #define EVFILT_PROC             (-5)    /* attached to struct proc */
   39 #define EVFILT_SIGNAL           (-6)    /* attached to struct proc */
   40 #define EVFILT_TIMER            (-7)    /* timers */
   41 #define EVFILT_PROCDESC         (-8)    /* attached to process descriptors */
   42 #define EVFILT_FS               (-9)    /* filesystem events */
   43 #define EVFILT_LIO              (-10)   /* attached to lio requests */
   44 #define EVFILT_USER             (-11)   /* User events */
   45 #define EVFILT_SENDFILE         (-12)   /* attached to sendfile requests */
   46 #define EVFILT_SYSCOUNT         12
   47 
   48 #define EV_SET(kevp_, a, b, c, d, e, f) do {    \
   49         struct kevent *kevp = (kevp_);          \
   50         (kevp)->ident = (a);                    \
   51         (kevp)->filter = (b);                   \
   52         (kevp)->flags = (c);                    \
   53         (kevp)->fflags = (d);                   \
   54         (kevp)->data = (e);                     \
   55         (kevp)->udata = (f);                    \
   56 } while(0)
   57 
   58 struct kevent {
   59         uintptr_t       ident;          /* identifier for this event */
   60         short           filter;         /* filter for event */
   61         u_short         flags;
   62         u_int           fflags;
   63         intptr_t        data;
   64         void            *udata;         /* opaque user data identifier */
   65 };
   66 
   67 #if defined(_WANT_KEVENT32) || (defined(_KERNEL) && defined(__LP64__))
   68 struct kevent32 {
   69         u_int32_t       ident;          /* identifier for this event */
   70         short           filter;         /* filter for event */
   71         u_short         flags;
   72         u_int           fflags;
   73         int32_t         data;
   74         u_int32_t       udata;          /* opaque user data identifier */
   75 };
   76 #endif
   77 
   78 /* actions */
   79 #define EV_ADD          0x0001          /* add event to kq (implies enable) */
   80 #define EV_DELETE       0x0002          /* delete event from kq */
   81 #define EV_ENABLE       0x0004          /* enable event */
   82 #define EV_DISABLE      0x0008          /* disable event (not reported) */
   83 #define EV_FORCEONESHOT 0x0100          /* enable _ONESHOT and force trigger */
   84 
   85 /* flags */
   86 #define EV_ONESHOT      0x0010          /* only report one occurrence */
   87 #define EV_CLEAR        0x0020          /* clear event state after reporting */
   88 #define EV_RECEIPT      0x0040          /* force EV_ERROR on success, data=0 */
   89 #define EV_DISPATCH     0x0080          /* disable event after reporting */
   90 
   91 #define EV_SYSFLAGS     0xF000          /* reserved by system */
   92 #define EV_DROP         0x1000          /* note should be dropped */
   93 #define EV_FLAG1        0x2000          /* filter-specific flag */
   94 #define EV_FLAG2        0x4000          /* filter-specific flag */
   95 
   96 /* returned values */
   97 #define EV_EOF          0x8000          /* EOF detected */
   98 #define EV_ERROR        0x4000          /* error, data contains errno */
   99 
  100  /*
  101   * data/hint flags/masks for EVFILT_USER, shared with userspace
  102   *
  103   * On input, the top two bits of fflags specifies how the lower twenty four
  104   * bits should be applied to the stored value of fflags.
  105   *
  106   * On output, the top two bits will always be set to NOTE_FFNOP and the
  107   * remaining twenty four bits will contain the stored fflags value.
  108   */
  109 #define NOTE_FFNOP      0x00000000              /* ignore input fflags */
  110 #define NOTE_FFAND      0x40000000              /* AND fflags */
  111 #define NOTE_FFOR       0x80000000              /* OR fflags */
  112 #define NOTE_FFCOPY     0xc0000000              /* copy fflags */
  113 #define NOTE_FFCTRLMASK 0xc0000000              /* masks for operations */
  114 #define NOTE_FFLAGSMASK 0x00ffffff
  115 
  116 #define NOTE_TRIGGER    0x01000000              /* Cause the event to be
  117                                                    triggered for output. */
  118 
  119 /*
  120  * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace
  121  */
  122 #define NOTE_LOWAT      0x0001                  /* low water mark */
  123 #define NOTE_FILE_POLL  0x0002                  /* behave like poll() */
  124 
  125 /*
  126  * data/hint flags for EVFILT_VNODE, shared with userspace
  127  */
  128 #define NOTE_DELETE     0x0001                  /* vnode was removed */
  129 #define NOTE_WRITE      0x0002                  /* data contents changed */
  130 #define NOTE_EXTEND     0x0004                  /* size increased */
  131 #define NOTE_ATTRIB     0x0008                  /* attributes changed */
  132 #define NOTE_LINK       0x0010                  /* link count changed */
  133 #define NOTE_RENAME     0x0020                  /* vnode was renamed */
  134 #define NOTE_REVOKE     0x0040                  /* vnode access was revoked */
  135 #define NOTE_OPEN       0x0080                  /* vnode was opened */
  136 #define NOTE_CLOSE      0x0100                  /* file closed, fd did not
  137                                                    allowed write */
  138 #define NOTE_CLOSE_WRITE 0x0200                 /* file closed, fd did allowed
  139                                                    write */
  140 #define NOTE_READ       0x0400                  /* file was read */
  141 
  142 /*
  143  * data/hint flags for EVFILT_PROC and EVFILT_PROCDESC, shared with userspace
  144  */
  145 #define NOTE_EXIT       0x80000000              /* process exited */
  146 #define NOTE_FORK       0x40000000              /* process forked */
  147 #define NOTE_EXEC       0x20000000              /* process exec'd */
  148 #define NOTE_PCTRLMASK  0xf0000000              /* mask for hint bits */
  149 #define NOTE_PDATAMASK  0x000fffff              /* mask for pid */
  150 
  151 /* additional flags for EVFILT_PROC */
  152 #define NOTE_TRACK      0x00000001              /* follow across forks */
  153 #define NOTE_TRACKERR   0x00000002              /* could not track child */
  154 #define NOTE_CHILD      0x00000004              /* am a child process */
  155 
  156 /* additional flags for EVFILT_TIMER */
  157 #define NOTE_SECONDS            0x00000001      /* data is seconds */
  158 #define NOTE_MSECONDS           0x00000002      /* data is milliseconds */
  159 #define NOTE_USECONDS           0x00000004      /* data is microseconds */
  160 #define NOTE_NSECONDS           0x00000008      /* data is nanoseconds */
  161 
  162 struct knote;
  163 SLIST_HEAD(klist, knote);
  164 struct kqueue;
  165 TAILQ_HEAD(kqlist, kqueue);
  166 struct knlist {
  167         struct  klist   kl_list;
  168         void    (*kl_lock)(void *);     /* lock function */
  169         void    (*kl_unlock)(void *);
  170         void    (*kl_assert_locked)(void *);
  171         void    (*kl_assert_unlocked)(void *);
  172         void    *kl_lockarg;            /* argument passed to lock functions */
  173         int     kl_autodestroy;
  174 };
  175 
  176 
  177 #ifdef _KERNEL
  178 
  179 /*
  180  * Flags for knote call
  181  */
  182 #define KNF_LISTLOCKED  0x0001                  /* knlist is locked */
  183 #define KNF_NOKQLOCK    0x0002                  /* do not keep KQ_LOCK */
  184 
  185 #define KNOTE(list, hint, flags)        knote(list, hint, flags)
  186 #define KNOTE_LOCKED(list, hint)        knote(list, hint, KNF_LISTLOCKED)
  187 #define KNOTE_UNLOCKED(list, hint)      knote(list, hint, 0)
  188 
  189 #define KNLIST_EMPTY(list)              SLIST_EMPTY(&(list)->kl_list)
  190 
  191 /*
  192  * Flag indicating hint is a signal.  Used by EVFILT_SIGNAL, and also
  193  * shared by EVFILT_PROC  (all knotes attached to p->p_klist)
  194  */
  195 #define NOTE_SIGNAL     0x08000000
  196 
  197 /*
  198  * Hint values for the optional f_touch event filter.  If f_touch is not set 
  199  * to NULL and f_isfd is zero the f_touch filter will be called with the type
  200  * argument set to EVENT_REGISTER during a kevent() system call.  It is also
  201  * called under the same conditions with the type argument set to EVENT_PROCESS
  202  * when the event has been triggered.
  203  */
  204 #define EVENT_REGISTER  1
  205 #define EVENT_PROCESS   2
  206 
  207 struct filterops {
  208         int     f_isfd;         /* true if ident == filedescriptor */
  209         int     (*f_attach)(struct knote *kn);
  210         void    (*f_detach)(struct knote *kn);
  211         int     (*f_event)(struct knote *kn, long hint);
  212         void    (*f_touch)(struct knote *kn, struct kevent *kev, u_long type);
  213 };
  214 
  215 /*
  216  * Setting the KN_INFLUX flag enables you to unlock the kq that this knote
  217  * is on, and modify kn_status as if you had the KQ lock.
  218  *
  219  * kn_sfflags, kn_sdata, and kn_kevent are protected by the knlist lock.
  220  */
  221 struct knote {
  222         SLIST_ENTRY(knote)      kn_link;        /* for kq */
  223         SLIST_ENTRY(knote)      kn_selnext;     /* for struct selinfo */
  224         struct                  knlist *kn_knlist;      /* f_attach populated */
  225         TAILQ_ENTRY(knote)      kn_tqe;
  226         struct                  kqueue *kn_kq;  /* which queue we are on */
  227         struct                  kevent kn_kevent;
  228         int                     kn_status;      /* protected by kq lock */
  229 #define KN_ACTIVE       0x01                    /* event has been triggered */
  230 #define KN_QUEUED       0x02                    /* event is on queue */
  231 #define KN_DISABLED     0x04                    /* event is disabled */
  232 #define KN_DETACHED     0x08                    /* knote is detached */
  233 #define KN_INFLUX       0x10                    /* knote is in flux */
  234 #define KN_MARKER       0x20                    /* ignore this knote */
  235 #define KN_KQUEUE       0x40                    /* this knote belongs to a kq */
  236 #define KN_HASKQLOCK    0x80                    /* for _inevent */
  237 #define KN_SCAN         0x100                   /* flux set in kqueue_scan() */
  238         int                     kn_sfflags;     /* saved filter flags */
  239         intptr_t                kn_sdata;       /* saved data field */
  240         union {
  241                 struct          file *p_fp;     /* file data pointer */
  242                 struct          proc *p_proc;   /* proc pointer */
  243                 struct          kaiocb *p_aio;  /* AIO job pointer */
  244                 struct          aioliojob *p_lio;       /* LIO job pointer */
  245                 sbintime_t      *p_nexttime;    /* next timer event fires at */
  246                 void            *p_v;           /* generic other pointer */
  247         } kn_ptr;
  248         struct                  filterops *kn_fop;
  249         void                    *kn_hook;
  250         int                     kn_hookid;
  251 
  252 #define kn_id           kn_kevent.ident
  253 #define kn_filter       kn_kevent.filter
  254 #define kn_flags        kn_kevent.flags
  255 #define kn_fflags       kn_kevent.fflags
  256 #define kn_data         kn_kevent.data
  257 #define kn_fp           kn_ptr.p_fp
  258 };
  259 struct kevent_copyops {
  260         void    *arg;
  261         int     (*k_copyout)(void *arg, struct kevent *kevp, int count);
  262         int     (*k_copyin)(void *arg, struct kevent *kevp, int count);
  263 };
  264 
  265 struct thread;
  266 struct proc;
  267 struct knlist;
  268 struct mtx;
  269 struct rwlock;
  270 
  271 void    knote(struct knlist *list, long hint, int lockflags);
  272 void    knote_fork(struct knlist *list, int pid);
  273 struct knlist *knlist_alloc(struct mtx *lock);
  274 void    knlist_detach(struct knlist *knl);
  275 void    knlist_add(struct knlist *knl, struct knote *kn, int islocked);
  276 void    knlist_remove(struct knlist *knl, struct knote *kn, int islocked);
  277 int     knlist_empty(struct knlist *knl);
  278 void    knlist_init(struct knlist *knl, void *lock, void (*kl_lock)(void *),
  279             void (*kl_unlock)(void *), void (*kl_assert_locked)(void *),
  280             void (*kl_assert_unlocked)(void *));
  281 void    knlist_init_mtx(struct knlist *knl, struct mtx *lock);
  282 void    knlist_init_rw_reader(struct knlist *knl, struct rwlock *lock);
  283 void    knlist_destroy(struct knlist *knl);
  284 void    knlist_cleardel(struct knlist *knl, struct thread *td,
  285             int islocked, int killkn);
  286 #define knlist_clear(knl, islocked)                             \
  287         knlist_cleardel((knl), NULL, (islocked), 0)
  288 #define knlist_delete(knl, td, islocked)                        \
  289         knlist_cleardel((knl), (td), (islocked), 1)
  290 void    knote_fdclose(struct thread *p, int fd);
  291 int     kqfd_register(int fd, struct kevent *kev, struct thread *p,
  292             int waitok);
  293 int     kqueue_add_filteropts(int filt, struct filterops *filtops);
  294 int     kqueue_del_filteropts(int filt);
  295 
  296 #else   /* !_KERNEL */
  297 
  298 #include <sys/cdefs.h>
  299 struct timespec;
  300 
  301 __BEGIN_DECLS
  302 int     kqueue(void);
  303 int     kevent(int kq, const struct kevent *changelist, int nchanges,
  304             struct kevent *eventlist, int nevents,
  305             const struct timespec *timeout);
  306 __END_DECLS
  307 
  308 #endif /* !_KERNEL */
  309 
  310 #endif /* !_SYS_EVENT_H_ */

Cache object: f05d1930b941367e19a071199804d0ff


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