openmpi/src/event/event.h

/*	$OpenBSD: event.h,v 1.4 2002/07/12 18:50:48 provos Exp $	*/

/*
 * Copyright 2000-2002 Niels Provos <provos@citi.umich.edu>
 * 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.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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.
 */
#ifndef _EVENT_H_
#define _EVENT_H_

#ifdef __cplusplus
extern "C" {
#endif

#ifdef HAVE_CONFIG_H
  /* OMPI: Conform to OMPI's header file scheme -- specify the full
     include path from "src/".  Also, config.h is a terrible
     unqualified name for a header file.  :-) */
#include "ompi_config.h"
#endif
#include "threads/mutex.h"

#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif

#ifdef WIN32
#include <windows.h>
#endif

#define OMPI_EVLIST_TIMEOUT	0x01
#define OMPI_EVLIST_INSERTED	0x02
#define OMPI_EVLIST_SIGNAL	0x04
#define OMPI_EVLIST_ACTIVE	0x08
#define OMPI_EVLIST_INIT		0x80

/* EVLIST_X_ Private space: 0x1000-0xf000 */
#define OMPI_EVLIST_ALL	(0xf000 | 0x8f)

#define OMPI_EV_TIMEOUT	0x01
#define OMPI_EV_READ	0x02
#define OMPI_EV_WRITE	0x04
#define OMPI_EV_SIGNAL	0x08
#define OMPI_EV_PERSIST	0x10	/* Persistant event */

#if 0
#ifndef OMPI_EVENT_USE_SIGNALS
#define OMPI_EVENT_USE_SIGNALS 0
#endif
#endif

/* Fix so that ppl dont have to run with <sys/queue.h> */
#ifndef TAILQ_ENTRY
#define _EVENT_DEFINED_TQENTRY
#define TAILQ_ENTRY(type)						\
struct {								\
	struct type *tqe_next;	/* next element */			\
	struct type **tqe_prev;	/* address of previous next element */	\
}
#endif /* !TAILQ_ENTRY */
#ifndef RB_ENTRY
#define _EVENT_DEFINED_RBENTRY
#define RB_ENTRY(type)							\
struct {								\
	struct type *rbe_left;		/* left element */		\
	struct type *rbe_right;		/* right element */		\
	struct type *rbe_parent;	/* parent element */		\
	int rbe_color;			/* node color */		\
}
#endif /* !RB_ENTRY */

struct ompi_event {
	TAILQ_ENTRY (ompi_event) ev_next;
	TAILQ_ENTRY (ompi_event) ev_active_next;
	TAILQ_ENTRY (ompi_event) ev_signal_next;
	RB_ENTRY (ompi_event) ev_timeout_node;

#ifdef WIN32
	HANDLE ev_fd;
	OVERLAPPED overlap;
#else
	int ev_fd;
#endif
	short ev_events;
	short ev_ncalls;
	short *ev_pncalls;	/* Allows deletes in callback */

	struct timeval ev_timeout;

	void (*ev_callback)(int, short, void *arg);
	void *ev_arg;

	int ev_res;		/* result passed to event callback */
	int ev_flags;
};
typedef struct ompi_event ompi_event_t;

#define OMPI_EVENT_SIGNAL(ev)	(int)ev->ev_fd
#define OMPI_EVENT_FD(ev)	(int)ev->ev_fd

#ifdef _EVENT_DEFINED_TQENTRY
#undef TAILQ_ENTRY
#undef _EVENT_DEFINED_TQENTRY
#else
TAILQ_HEAD (ompi_event_list, ompi_event);
#endif /* _EVENT_DEFINED_TQENTRY */
#ifdef _EVENT_DEFINED_RBENTRY
#undef RB_ENTRY
#undef _EVENT_DEFINED_RBENTRY
#endif /* _EVENT_DEFINED_RBENTRY */

struct ompi_eventop {
	char *name;
	void *(*init)(void);
	int (*add)(void *, struct ompi_event *);
	int (*del)(void *, struct ompi_event *);
	int (*recalc)(void *, int);
	int (*dispatch)(void *, struct timeval *);
};

#define OMPI_TIMEOUT_DEFAULT	{10, 0}
#define OMPI_EVLOOP_ONCE		0x01
#define OMPI_EVLOOP_NONBLOCK	0x02


int ompi_event_init(void);
int ompi_event_fini(void);
int ompi_event_dispatch(void);
int ompi_event_loop(int);
int ompi_event_enable(void);
int ompi_event_disable(void);
bool ompi_event_progress_thread(void);

#define ompi_evtimer_add(ev, tv)		ompi_event_add(ev, tv)
#define ompi_evtimer_set(ev, cb, arg)	ompi_event_set(ev, -1, 0, cb, arg)
#define ompi_evtimer_del(ev)		ompi_event_del(ev)
#define ompi_evtimer_pending(ev, tv)	ompi_event_pending(ev, OMPI_EV_TIMEOUT, tv)
#define ompi_evtimer_initialized(ev)	(ev)->ev_flags & OMPI_EVLIST_INIT)

#define ompi_timeout_add(ev, tv)		ompi_event_add(ev, tv)
#define ompi_timeout_set(ev, cb, arg)	ompi_event_set(ev, -1, 0, cb, arg)
#define ompi_timeout_del(ev)		ompi_event_del(ev)
#define ompi_timeout_pending(ev, tv)	ompi_event_pending(ev, OMPI_EV_TIMEOUT, tv)
#define ompi_timeout_initialized(ev)	((ev)->ev_flags & OMPI_EVLIST_INIT)

#define ompi_signal_add(ev, tv)		ompi_event_add(ev, tv)
#define ompi_signal_set(ev, x, cb, arg)	\
	ompi_event_set(ev, x, OMPI_EV_SIGNAL|OMPI_EV_PERSIST, cb, arg)
#define ompi_signal_del(ev)		ompi_event_del(ev)
#define ompi_signal_pending(ev, tv)	ompi_event_pending(ev, OMPI_EV_SIGNAL, tv)
#define ompi_signal_initialized(ev)	((ev)->ev_flags & OMPI_EVLIST_INIT)

/* for internal use only */
int   ompi_event_add_i(struct ompi_event *, struct timeval *);
int   ompi_event_del_i(struct ompi_event *);
void  ompi_event_active_i(struct ompi_event*, int, short);

/* public functions */
static inline void
ompi_event_set(struct ompi_event *ev, int fd, short events,
      void (*callback)(int, short, void *), void *arg)
{
    ev->ev_callback = callback;
    ev->ev_arg = arg;
#ifdef WIN32
    ev->ev_fd = (HANDLE)fd;
    ev->overlap.hEvent = ev;
#else
    ev->ev_fd = fd;
#endif
    ev->ev_events = events;
    ev->ev_flags = OMPI_EVLIST_INIT;
    ev->ev_ncalls = 0;
    ev->ev_pncalls = NULL;
}

static inline int
ompi_event_add(struct ompi_event *ev, struct timeval *tv)
{
    extern ompi_mutex_t ompi_event_lock;
    int rc;
    if(ompi_using_threads()) {
        ompi_mutex_lock(&ompi_event_lock);
        rc = ompi_event_add_i(ev, tv);
        ompi_mutex_unlock(&ompi_event_lock);
    } else {
        rc = ompi_event_add_i(ev, tv);
    }
    return rc;
}

static inline int 
ompi_event_del(struct ompi_event *ev)
{
    extern ompi_mutex_t ompi_event_lock;
    int rc;
    if(ompi_using_threads()) {
        ompi_mutex_lock(&ompi_event_lock);
        rc = ompi_event_del_i(ev);
        ompi_mutex_unlock(&ompi_event_lock);
    } else {
        rc = ompi_event_del_i(ev);
    }
    return rc;
}
                                                                                          
static inline void 
ompi_event_active(struct ompi_event* ev, int res, short ncalls)
{
    extern ompi_mutex_t ompi_event_lock;
    if(ompi_using_threads()) {
        ompi_mutex_lock(&ompi_event_lock);
        ompi_event_active_i(ev, res, ncalls);
        ompi_mutex_unlock(&ompi_event_lock);
    } else {
        ompi_event_active_i(ev, res, ncalls);
    }
}
                                                                                          
static inline int
ompi_event_pending(struct ompi_event *ev, short event, struct timeval *tv)
{
    int flags = 0;
                                                                                          
    if (ev->ev_flags & OMPI_EVLIST_INSERTED)
        flags |= (ev->ev_events & (OMPI_EV_READ|OMPI_EV_WRITE));
    if (ev->ev_flags & OMPI_EVLIST_ACTIVE)
        flags |= ev->ev_res;
    if (ev->ev_flags & OMPI_EVLIST_TIMEOUT)
        flags |= OMPI_EV_TIMEOUT;
                                                                                          
    event &= (OMPI_EV_TIMEOUT|OMPI_EV_READ|OMPI_EV_WRITE);
                                                                                          
    /* See if there is a timeout that we should report */
    if (tv != NULL && (flags & event & OMPI_EV_TIMEOUT))
        *tv = ev->ev_timeout;
                                                                                          
    return (flags & event);
}


#ifdef WIN32
#define ompi_event_initialized(ev)	((ev)->ev_flags & OMPI_EVLIST_INIT && (ev)->ev_fd != INVALID_HANDLE_VALUE)
#else
#define ompi_event_initialized(ev)	((ev)->ev_flags & OMPI_EVLIST_INIT)
#endif

#ifdef __cplusplus
}
#endif

#endif /* _EVENT_H_ */