1 /* 2 * Copyright (c) 2011-2018 Cisco Systems, Inc. All rights reserved 3 * Copyright (c) 2013 Los Alamos National Security, LLC. All rights reserved. 4 * Copyright (c) 2015-2017 Intel, Inc. All rights reserved. 5 * Copyright (c) 2015-2017 Research Organization for Information Science 6 * and Technology (RIST). All rights reserved. 7 * Copyright (c) 2017 IBM Corporation. All rights reserved. 8 * 9 * $COPYRIGHT$ 10 * 11 * Additional copyrights may follow 12 * 13 * $HEADER$ 14 * 15 * When this component is used, this file is included in the rest of 16 * the code base via opal/mca/event/event.h. As such, 17 * this header represents the public interface to this static component. 18 */ 19 20 #ifndef MCA_OPAL_EVENT_EXTERNAL_H 21 #define MCA_OPAL_EVENT_EXTERNAL_H 22 23 #include "opal_config.h" 24 25 #if defined(__CYGWIN__) && defined(WIN32) 26 #undef WIN32 27 #endif 28 29 #include "event.h" 30 #include "event2/event.h" 31 #include "event2/thread.h" 32 33 typedef event_callback_fn opal_event_cbfunc_t; 34 35 BEGIN_C_DECLS 36 37 typedef struct event_base opal_event_base_t; 38 typedef struct event opal_event_t; 39 40 OPAL_DECLSPEC extern opal_event_base_t *opal_sync_event_base; 41 42 #define OPAL_EV_TIMEOUT EV_TIMEOUT 43 #define OPAL_EV_READ EV_READ 44 #define OPAL_EV_WRITE EV_WRITE 45 #define OPAL_EV_SIGNAL EV_SIGNAL 46 /* Persistent event: won't get removed automatically when activated. */ 47 #define OPAL_EV_PERSIST EV_PERSIST 48 49 #define OPAL_EVLOOP_ONCE EVLOOP_ONCE /**< Block at most once. */ 50 #define OPAL_EVLOOP_NONBLOCK EVLOOP_NONBLOCK /**< Do not block. */ 51 52 /* Global function to create and release an event base */ 53 OPAL_DECLSPEC opal_event_base_t* opal_event_base_create(void); 54 55 #define opal_event_base_free(x) event_base_free(x) 56 57 OPAL_DECLSPEC int opal_event_init(void); 58 59 OPAL_DECLSPEC int opal_event_finalize(void); 60 61 #define opal_event_reinit(b) event_reinit((b)) 62 63 #define opal_event_base_init_common_timeout (b, t) event_base_init_common_timeout((b), (t)) 64 65 #define opal_event_base_loopbreak(b) event_base_loopbreak(b) 66 67 #define opal_event_base_loopexit(b) event_base_loopexit(b, NULL) 68 69 /* Event priority APIs */ 70 #define opal_event_base_priority_init(b, n) event_base_priority_init((b), (n)) 71 72 #define opal_event_set_priority(x, n) event_priority_set((x), (n)) 73 74 /* thread support APIs */ 75 #define opal_event_use_threads() evthread_use_pthreads() 76 77 /* Basic event APIs */ 78 #define opal_event_enable_debug_mode() event_enable_debug_mode() 79 80 #define opal_event_set(b, x, fd, fg, cb, arg) event_assign((x), (b), (fd), (fg), (event_callback_fn) (cb), (arg)) 81 82 #define opal_event_assign(x, b, fd, fg, cb, arg) event_assign((x), (b), (fd), (fg), (event_callback_fn) (cb), (arg)) 83 84 #define opal_event_add(ev, tv) event_add((ev), (tv)) 85 86 #define opal_event_del(ev) event_del((ev)) 87 88 #define opal_event_active(x, y, z) event_active((x), (y), (z)) 89 90 #define opal_event_new(b, fd, fg, cb, arg) event_new((b), (fd), (fg), (event_callback_fn) (cb), (arg)) 91 92 OPAL_DECLSPEC opal_event_t* opal_event_alloc(void); 93 94 #define opal_event_free(x) event_free((x)) 95 96 /* Timer APIs */ 97 #define opal_event_evtimer_new(b, cb, arg) opal_event_new((b), -1, 0, (cb), (arg)) 98 99 #define opal_event_evtimer_add(x, tv) opal_event_add((x), (tv)) 100 101 #define opal_event_evtimer_set(b, x, cb, arg) event_assign((x), (b), -1, 0, (event_callback_fn) (cb), (arg)) 102 103 #define opal_event_evtimer_del(x) opal_event_del((x)) 104 105 #define opal_event_evtimer_pending(x, tv) event_pending((x), EV_TIMEOUT, (tv)) 106 107 #define opal_event_evtimer_initialized(x) event_initialized((x)) 108 109 /* Signal APIs */ 110 #define opal_event_signal_add(x, tv) event_add((x), (tv)) 111 112 #define opal_event_signal_set(b, x, fd, cb, arg) event_assign((x), (b), (fd), EV_SIGNAL|EV_PERSIST, (event_callback_fn) (cb), (arg)) 113 114 #define opal_event_signal_del(x) event_del((x)) 115 116 #define opal_event_signal_pending(x, tv) event_pending((x), EV_SIGNAL, (tv)) 117 118 #define opal_event_signal_initalized(x) event_initialized((x)) 119 120 #define opal_event_get_signal(x) event_get_signal((x)) 121 122 #define opal_event_loop(b, fg) event_base_loop((b), (fg)) 123 124 END_C_DECLS 125 126 #endif /* MCA_OPAL_EVENT_EXTERNAL_H */ 127