event.h

Go to the documentation of this file.

/*-
 * Copyright (c) 1999,2000,2001 Jonathan Lemon <jlemon@FreeBSD.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD: src/sys/sys/event.h,v 1.22 2003/02/02 19:39:51 nectar Exp $
 */
 
#ifndef _TIRPC_EVENT_H_
#define _TIRPC_EVENT_H_
 
#define EVFILT_READ     (-1)
#define EVFILT_WRITE        (-2)
#define EVFILT_AIO      (-3)    /* attached to aio requests */
#define EVFILT_VNODE        (-4)    /* attached to vnodes */
#define EVFILT_PROC     (-5)    /* attached to struct proc */
#define EVFILT_SIGNAL       (-6)    /* attached to struct proc */
#define EVFILT_TIMER        (-7)    /* timers */
#define EVFILT_NETDEV       (-8)    /* network devices */
 
#define EVFILT_SYSCOUNT     8
 
#define EV_SET(kevp_, a, b, c, d, e, f) do {    \
    struct kevent *kevp = (kevp_);      \
    (kevp)->ident = (a);            \
    (kevp)->filter = (b);           \
    (kevp)->flags = (c);            \
    (kevp)->fflags = (d);           \
    (kevp)->data = (e);         \
    (kevp)->udata = (f);            \
} while(0)
 
#include <stdint.h>
 
struct kevent {
    uintptr_t   ident;      /* identifier for this event */
    short       filter;     /* filter for event */
    u_short     flags;
    u_int       fflags;
    intptr_t    data;
    void        *udata;     /* opaque user data identifier */
};
 
/* actions */
#define EV_ADD      0x0001      /* add event to kq (implies enable) */
#define EV_DELETE   0x0002      /* delete event from kq */
#define EV_ENABLE   0x0004      /* enable event */
#define EV_DISABLE  0x0008      /* disable event (not reported) */
 
/* flags */
#define EV_ONESHOT  0x0010      /* only report one occurrence */
#define EV_CLEAR    0x0020      /* clear event state after reporting */
 
#define EV_SYSFLAGS 0xF000      /* reserved by system */
#define EV_FLAG1    0x2000      /* filter-specific flag */
 
/* returned values */
#define EV_EOF      0x8000      /* EOF detected */
#define EV_ERROR    0x4000      /* error, data contains errno */
 
/*
 * data/hint flags for EVFILT_{READ|WRITE}, shared with userspace
 */
#define NOTE_LOWAT  0x0001          /* low water mark */
 
/*
 * data/hint flags for EVFILT_VNODE, shared with userspace
 */
#define NOTE_DELETE 0x0001          /* vnode was removed */
#define NOTE_WRITE  0x0002          /* data contents changed */
#define NOTE_EXTEND 0x0004          /* size increased */
#define NOTE_ATTRIB 0x0008          /* attributes changed */
#define NOTE_LINK   0x0010          /* link count changed */
#define NOTE_RENAME 0x0020          /* vnode was renamed */
#define NOTE_REVOKE 0x0040          /* vnode access was revoked */
 
/*
 * data/hint flags for EVFILT_PROC, shared with userspace
 */
#define NOTE_EXIT   0x80000000      /* process exited */
#define NOTE_FORK   0x40000000      /* process forked */
#define NOTE_EXEC   0x20000000      /* process exec'd */
#define NOTE_PCTRLMASK  0xf0000000      /* mask for hint bits */
#define NOTE_PDATAMASK  0x000fffff      /* mask for pid */
 
/* additional flags for EVFILT_PROC */
#define NOTE_TRACK  0x00000001      /* follow across forks */
#define NOTE_TRACKERR   0x00000002      /* could not track child */
#define NOTE_CHILD  0x00000004      /* am a child process */
 
/*
 * data/hint flags for EVFILT_NETDEV, shared with userspace
 */
#define NOTE_LINKUP 0x0001          /* link is up */
#define NOTE_LINKDOWN   0x0002          /* link is down */
#define NOTE_LINKINV    0x0004          /* link state is invalid */
 
/*
 * This is currently visible to userland to work around broken
 * programs which pull in <sys/proc.h>.
 */
#include <sys/queue.h> 
 
struct knote;
SLIST_HEAD(klist, knote);
 
#ifdef _KERNEL
 
#ifdef MALLOC_DECLARE
MALLOC_DECLARE(M_KQUEUE);
#endif
 
#define KNOTE(list, hint)   if ((list) != NULL) knote(list, hint)
 
/*
 * Flag indicating hint is a signal.  Used by EVFILT_SIGNAL, and also
 * shared by EVFILT_PROC  (all knotes attached to p->p_klist)
 */
#define NOTE_SIGNAL 0x08000000
 
struct filterops {
    int f_isfd;     /* true if ident == filedescriptor */
    int (*f_attach)(struct knote *kn);
    void    (*f_detach)(struct knote *kn);
    int (*f_event)(struct knote *kn, long hint);
};
 
struct knote {
    SLIST_ENTRY(knote)  kn_link;    /* for fd */
    SLIST_ENTRY(knote)  kn_selnext; /* for struct selinfo */
    TAILQ_ENTRY(knote)  kn_tqe;
    struct          kqueue *kn_kq;  /* which queue we are on */
    struct          kevent kn_kevent;
    int         kn_status;
    int         kn_sfflags; /* saved filter flags */
    intptr_t        kn_sdata;   /* saved data field */
    union {
        struct      file *p_fp; /* file data pointer */
        struct      proc *p_proc;   /* proc pointer */
    } kn_ptr;
    struct          filterops *kn_fop;
    void            *kn_hook;
#define KN_ACTIVE   0x01            /* event has been triggered */
#define KN_QUEUED   0x02            /* event is on queue */
#define KN_DISABLED 0x04            /* event is disabled */
#define KN_DETACHED 0x08            /* knote is detached */
 
#define kn_id       kn_kevent.ident
#define kn_filter   kn_kevent.filter
#define kn_flags    kn_kevent.flags
#define kn_fflags   kn_kevent.fflags
#define kn_data     kn_kevent.data
#define kn_fp       kn_ptr.p_fp
};
 
struct thread;
struct proc;
 
extern void knote(struct klist *list, long hint);
extern void knote_remove(struct thread *p, struct klist *list);
extern void knote_fdclose(struct thread *p, int fd);
extern int  kqueue_register(struct kqueue *kq,
            struct kevent *kev, struct thread *p);
extern int  kqueue_add_filteropts(int filt, struct filterops *filtops);
extern int  kqueue_del_filteropts(int filt);
 
#else   /* !_KERNEL */
 
//#include <sys/cdefs.h>
struct timespec;
 
__BEGIN_DECLS
int     kqueue(void);
int     kevent(int kq, const struct kevent *changelist, int nchanges,
        struct kevent *eventlist, int nevents,
        const struct timespec *timeout);
__END_DECLS
 
#endif /* !_KERNEL */
 
#endif /* !_TIRPC_EVENT_H_ */