tirpc/misc/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.22 2003/02/02 19:39:51 nectar Exp $
  27  */
  28
  29 #ifndef _TIRPC_EVENT_H_
  30 #define _TIRPC_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
  41 #define EVFILT_SYSCOUNT         8
  42
  43 #define EV_SET(kevp_, a, b, c, d, e, f) do {    \
  44         struct kevent *kevp = (kevp_);          \
  45         (kevp)->ident = (a);                    \
  46         (kevp)->filter = (b);                   \
  47         (kevp)->flags = (c);                    \
  48         (kevp)->fflags = (d);                   \
  49         (kevp)->data = (e);                     \
  50         (kevp)->udata = (f);                    \
  51 } while(0)
  52
  53 #include <stdint.h>
  54
  55 struct kevent {
  56         uintptr_t       ident;          /* identifier for this event */
  57         short           filter;         /* filter for event */
  58         u_short         flags;
  59         u_int           fflags;
  60         intptr_t        data;
  61         void            *udata;         /* opaque user data identifier */
  62 };
  63
  64 /* actions */
  65 #define EV_ADD          0x0001          /* add event to kq (implies enable) */
  66 #define EV_DELETE       0x0002          /* delete event from kq */
  67 #define EV_ENABLE       0x0004          /* enable event */
  68 #define EV_DISABLE      0x0008          /* disable event (not reported) */
  69
  70 /* flags */
  71 #define EV_ONESHOT      0x0010          /* only report one occurrence */
  72 #define EV_CLEAR        0x0020          /* clear event state after reporting */
  73
  74 #define EV_SYSFLAGS     0xF000          /* reserved by system */
  75 #define EV_FLAG1        0x2000          /* filter-specific flag */
  76
  77 /* returned values */
  78 #define EV_EOF          0x8000          /* EOF detected */
  79 #define EV_ERROR        0x4000          /* error, data contains errno */
  80
  81 /*
  82  * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace
  83  */
  84 #define NOTE_LOWAT      0x0001                  /* low water mark */
  85
  86 /*
  87  * data/hint flags for EVFILT_VNODE, shared with userspace
  88  */
  89 #define NOTE_DELETE     0x0001                  /* vnode was removed */
  90 #define NOTE_WRITE      0x0002                  /* data contents changed */
  91 #define NOTE_EXTEND     0x0004                  /* size increased */
  92 #define NOTE_ATTRIB     0x0008                  /* attributes changed */
  93 #define NOTE_LINK       0x0010                  /* link count changed */
  94 #define NOTE_RENAME     0x0020                  /* vnode was renamed */
  95 #define NOTE_REVOKE     0x0040                  /* vnode access was revoked */
  96
  97 /*
  98  * data/hint flags for EVFILT_PROC, shared with userspace
  99  */
 100 #define NOTE_EXIT       0x80000000              /* process exited */
 101 #define NOTE_FORK       0x40000000              /* process forked */
 102 #define NOTE_EXEC       0x20000000              /* process exec'd */
 103 #define NOTE_PCTRLMASK  0xf0000000              /* mask for hint bits */
 104 #define NOTE_PDATAMASK  0x000fffff              /* mask for pid */
 105
 106 /* additional flags for EVFILT_PROC */
 107 #define NOTE_TRACK      0x00000001              /* follow across forks */
 108 #define NOTE_TRACKERR   0x00000002              /* could not track child */
 109 #define NOTE_CHILD      0x00000004              /* am a child process */
 110
 111 /*
 112  * data/hint flags for EVFILT_NETDEV, shared with userspace
 113  */
 114 #define NOTE_LINKUP     0x0001                  /* link is up */
 115 #define NOTE_LINKDOWN   0x0002                  /* link is down */
 116 #define NOTE_LINKINV    0x0004                  /* link state is invalid */
 117
 118 /*
 119  * This is currently visible to userland to work around broken
 120  * programs which pull in <sys/proc.h>.
 121  */
 122 #include <sys/queue.h>
 123
 124 struct knote;
 125 SLIST_HEAD(klist, knote);
 126
 127 #ifdef _KERNEL
 128
 129 #ifdef MALLOC_DECLARE
 130 MALLOC_DECLARE(M_KQUEUE);
 131 #endif
 132
 133 #define KNOTE(list, hint)       if ((list) != NULL) knote(list, hint)
 134
 135 /*
 136  * Flag indicating hint is a signal.  Used by EVFILT_SIGNAL, and also
 137  * shared by EVFILT_PROC  (all knotes attached to p->p_klist)
 138  */
 139 #define NOTE_SIGNAL     0x08000000
 140
 141 struct filterops {
 142         int     f_isfd;         /* true if ident == filedescriptor */
 143         int     (*f_attach)(struct knote *kn);
 144         void    (*f_detach)(struct knote *kn);
 145         int     (*f_event)(struct knote *kn, long hint);
 146 };
 147
 148 struct knote {
 149         SLIST_ENTRY(knote)      kn_link;        /* for fd */
 150         SLIST_ENTRY(knote)      kn_selnext;     /* for struct selinfo */
 151         TAILQ_ENTRY(knote)      kn_tqe;
 152         struct                  kqueue *kn_kq;  /* which queue we are on */
 153         struct                  kevent kn_kevent;
 154         int                     kn_status;
 155         int                     kn_sfflags;     /* saved filter flags */
 156         intptr_t                kn_sdata;       /* saved data field */
 157         union {
 158                 struct          file *p_fp;     /* file data pointer */
 159                 struct          proc *p_proc;   /* proc pointer */
 160         } kn_ptr;
 161         struct                  filterops *kn_fop;
 162         void                    *kn_hook;
 163 #define KN_ACTIVE       0x01                    /* event has been triggered */
 164 #define KN_QUEUED       0x02                    /* event is on queue */
 165 #define KN_DISABLED     0x04                    /* event is disabled */
 166 #define KN_DETACHED     0x08                    /* knote is detached */
 167
 168 #define kn_id           kn_kevent.ident
 169 #define kn_filter       kn_kevent.filter
 170 #define kn_flags        kn_kevent.flags
 171 #define kn_fflags       kn_kevent.fflags
 172 #define kn_data         kn_kevent.data
 173 #define kn_fp           kn_ptr.p_fp
 174 };
 175
 176 struct thread;
 177 struct proc;
 178
 179 extern void     knote(struct klist *list, long hint);
 180 extern void     knote_remove(struct thread *p, struct klist *list);
 181 extern void     knote_fdclose(struct thread *p, int fd);
 182 extern int      kqueue_register(struct kqueue *kq,
 183                     struct kevent *kev, struct thread *p);
 184 extern int      kqueue_add_filteropts(int filt, struct filterops *filtops);
 185 extern int      kqueue_del_filteropts(int filt);
 186
 187 #else   /* !_KERNEL */
 188
 189 #include <sys/cdefs.h>
 190 struct timespec;
 191
 192 __BEGIN_DECLS
 193 int     kqueue(void);
 194 int     kevent(int kq, const struct kevent *changelist, int nchanges,
 195             struct kevent *eventlist, int nevents,
 196             const struct timespec *timeout);
 197 __END_DECLS
 198
 199 #endif /* !_KERNEL */
 200
 201 #endif /* !_TIRPC_EVENT_H_ */