margo.h 11 KB
Newer Older
1 2 3 4 5 6 7 8 9
/*
 * (C) 2015 The University of Chicago
 * 
 * See COPYRIGHT in top-level directory.
 */

#ifndef __MARGO
#define __MARGO

10 11 12 13
#ifdef __cplusplus
extern "C" {
#endif

14 15 16 17 18 19
/* This is to prevent the user from usin HG_Register_data
 * and HG_Registered_data, which are replaced with
 * margo_register_data and margo_registered_data
 * respecively.
 */

20 21 22 23 24
#include <mercury_bulk.h>
#include <mercury.h>
#include <mercury_macros.h>
#include <abt.h>

25 26
#undef MERCURY_REGISTER

27 28
struct margo_instance;
typedef struct margo_instance* margo_instance_id;
29
typedef struct margo_data* margo_data_ptr;
30

31
#define MARGO_INSTANCE_NULL ((margo_instance_id)NULL)
32
#define MARGO_DEFAULT_MPLEX_ID 0
33
#define MARGO_RPC_ID_IGNORE ((hg_id_t*)NULL)
Jonathan Jenkins's avatar
Jonathan Jenkins committed
34 35 36

/**
 * Initializes margo library.
Shane Snyder's avatar
Shane Snyder committed
37 38
 * @param [in] addr_str            Mercury host address with port number
 * @param [in] listen_flag         Boolean flag to listen for incoming connections
Jonathan Jenkins's avatar
Jonathan Jenkins committed
39 40
 * @param [in] use_progress_thread Boolean flag to use a dedicated thread for
 *                                 running Mercury's progress loop. If false,
41
 *                                 it will run in the caller's thread context.
Jonathan Jenkins's avatar
Jonathan Jenkins committed
42 43
 * @param [in] rpc_thread_count    Number of threads to use for running RPC
 *                                 calls. A value of 0 directs Margo to execute
44 45 46 47 48 49
 *                                 RPCs in the caller's thread context.
 *                                 Clients (i.e processes that will *not* 
 *                                 service incoming RPCs) should use a value 
 *                                 of 0. A value of -1 directs Margo to use 
 *                                 the same execution context as that used 
 *                                 for Mercury progress.
Jonathan Jenkins's avatar
Jonathan Jenkins committed
50
 * @returns margo instance id on success, MARGO_INSTANCE_NULL upon error
51 52 53 54 55
 *
 * NOTE: Servers (processes expecting to service incoming RPC requests) must
 * specify non-zero values for use_progress_thread and rpc_thread_count *or*
 * call margo_wait_for_finalize() after margo_init() to relinguish control to 
 * Margo.
Jonathan Jenkins's avatar
Jonathan Jenkins committed
56
 */
Shane Snyder's avatar
Shane Snyder committed
57 58 59 60 61
margo_instance_id margo_init(
    const char *addr_str,
    int listen_flag,
    int use_progress_thread,
    int rpc_thread_count);
Jonathan Jenkins's avatar
Jonathan Jenkins committed
62

63
/**
Jonathan Jenkins's avatar
doc fix  
Jonathan Jenkins committed
64
 * Initializes margo library from given argobots and Mercury instances.
Philip Carns's avatar
Philip Carns committed
65 66 67
 * @param [in] progress_pool Argobots pool to drive communication
 * @param [in] handler_pool Argobots pool to service RPC handlers
 * @param [in] hg_context Mercury context
Jonathan Jenkins's avatar
fixupme  
Jonathan Jenkins committed
68
 * @returns margo instance id on success, MARGO_INSTANCE_NULL upon error
69
 */
Shane Snyder's avatar
Shane Snyder committed
70 71 72
margo_instance_id margo_init_pool(
    ABT_pool progress_pool,
    ABT_pool handler_pool,
Jonathan Jenkins's avatar
Jonathan Jenkins committed
73
    hg_context_t *hg_context);
74 75

/**
Philip Carns's avatar
Philip Carns committed
76
 * Shuts down margo library and its underlying abt and mercury resources
Philip Carns's avatar
Philip Carns committed
77
 * @param [in] mid Margo instance
78
 */
79
void margo_finalize(margo_instance_id mid);
80 81 82 83 84 85 86 87 88 89 90 91

/**
 * Suspends the caller until some other entity (e.g. an RPC, thread, or
 * signal handler) invokes margo_finalize().
 *
 * NOTE: This informs Margo that the calling thread no longer needs to be 
 * scheduled for execution if it is sharing an Argobots pool with the
 * progress engine.
 *
 * @param [in] mid Margo instance
 */
void margo_wait_for_finalize(margo_instance_id mid);
92 93

/**
Philip Carns's avatar
Philip Carns committed
94 95 96
 * Retrieve the abt_handler pool that was associated with the instance at 
 *    initialization time
 * @param [in] mid Margo instance
97
 */
98
ABT_pool* margo_get_handler_pool(margo_instance_id mid);
99

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
/**
 * Retrieve the Mercury context that was associated with this instance at
 *    initialization time
 * @param [in] mid Margo instance
 * @return the Mercury context used in margo_init
 */
hg_context_t* margo_get_context(margo_instance_id mid);

/**
 * Retrieve the Mercury class that was associated with this instance at
 *    initialization time
 * @param [in] mid Margo instance
 * @return the Mercury class used in margo_init
 */
hg_class_t* margo_get_class(margo_instance_id mid);

116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
/**
 * Register and associate user data to registered function.
 * When HG_Finalize() is called free_callback (if defined) is called 
 * to free the registered data.
 *
 * \param [in] mid            Margo instance
 * \param [in] id             registered function ID
 * \param [in] data           pointer to data
 * \param [in] free_callback  pointer to free function
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
hg_return_t margo_register_data(
    margo_instance_id mid,
    hg_id_t id,
    void *data,
    void (*free_callback)(void *));

/**
 * Indicate whether margo_register_data() has been called and return associated
 * data.
 *
 * \param [in] mid        Margo instance 
 * \param [in] id         registered function ID
 *
 * \return Pointer to data or NULL
 */
void* margo_registered_data(margo_instance_id mid, hg_id_t id);

/**
 * Get the margo_instance_id from a received RPC handle.
 *
 * \param [in] h          RPC handle
 * 
 * \return Margo instance
 */
margo_instance_id margo_hg_handle_get_instance(hg_handle_t h);

154 155
/**
 * Forward an RPC request to a remote host
Philip Carns's avatar
Philip Carns committed
156
 * @param [in] mid Margo instance
157 158 159 160 161
 * @param [in] handle identifier for the RPC to be sent
 * @param [in] in_struct input argument struct for RPC
 * @returns 0 on success, hg_return_t values on error
 */
hg_return_t margo_forward(
162
    margo_instance_id mid,
163 164 165
    hg_handle_t handle,
    void *in_struct);

166 167 168 169 170 171 172 173 174 175 176 177 178 179
/**
 * Forward an RPC request to a remote host with a user-defined timeout
 * @param [in] mid Margo instance
 * @param [in] handle identifier for the RPC to be sent
 * @param [in] in_struct input argument struct for RPC
 * @param [in] timeout_ms timeout in milliseconds
 * @returns 0 on success, hg_return_t values on error
 */
hg_return_t margo_forward_timed(
    margo_instance_id mid,
    hg_handle_t handle,
    void *in_struct,
    double timeout_ms);

Jonathan Jenkins's avatar
Jonathan Jenkins committed
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
/**
 * Send an RPC response, waiting for completion before returning
 * control to the calling ULT.
 * Note: this call is typically not needed as RPC listeners need not concern
 * themselves with what happens after an RPC finishes. However, there are cases
 * when this is useful (deferring resource cleanup, calling margo_finalize()
 * for e.g. a shutdown RPC).
 * @param [in] mid Margo instance
 * @param [in] handle identifier for the RPC for which a response is being
 * sent
 * @param [in] out_struct output argument struct for response
 * @return HG_SUCCESS on success, hg_return_t values on error. See HG_Respond.
 */
hg_return_t margo_respond(
    margo_instance_id mid,
    hg_handle_t handle,
    void *out_struct);

198 199
/** 
 * Perform a bulk transfer
Philip Carns's avatar
Philip Carns committed
200
 * @param [in] mid Margo instance
201 202 203 204 205 206 207 208 209 210
 * @param [in] op type of operation to perform
 * @param [in] origin_addr remote Mercury address
 * @param [in] origin_handle remote Mercury bulk memory handle
 * @param [in] origin_offset offset into remote bulk memory to access
 * @param [in] local_handle local bulk memory handle
 * @param [in] local_offset offset into local bulk memory to access
 * @param [in] size size (in bytes) of transfer
 * @returns 0 on success, hg_return_t values on error
 */
hg_return_t margo_bulk_transfer(
211
    margo_instance_id mid,
212
    hg_bulk_op_t op,
213
    hg_addr_t origin_addr,
214 215 216 217 218 219
    hg_bulk_t origin_handle,
    size_t origin_offset,
    hg_bulk_t local_handle,
    size_t local_offset,
    size_t size);

220 221 222
/**
 * address lookup
 * @param [in] name             lookup name
Jonathan Jenkins's avatar
fixupme  
Jonathan Jenkins committed
223 224
 * @param [out] addr            return address
 * @returns HG_SUCCESS on success
225
 */
226
hg_return_t margo_addr_lookup(
227
    margo_instance_id mid,
Philip Carns's avatar
Philip Carns committed
228
    const char   *name,
229
    hg_addr_t    *addr);
230

231 232
/**
 * Suspends the calling ULT for a specified time duration
233
 * @param [in] mid Margo instance
234 235 236
 * @param [in] timeout_ms timeout duration in milliseconds
 */
void margo_thread_sleep(
237
    margo_instance_id mid,
238 239
    double timeout_ms);

240 241 242 243
/** 
 * Registers an RPC with margo
 * @param [in] mid Margo instance
 * @param [in] id Mercury RPC identifier
244
 */
245
int margo_register(margo_instance_id mid, hg_id_t id);
246

Philip Carns's avatar
Philip Carns committed
247 248 249 250
/** 
 * Registers an RPC with margo that is associated with a multiplexed service
 * @param [in] mid Margo instance
 * @param [in] id Mercury RPC identifier
Philip Carns's avatar
Philip Carns committed
251
 * @param [in] mplex_id multiplexing identifier
Philip Carns's avatar
Philip Carns committed
252 253 254 255
 * @param [in] pool Argobots pool the handler will execute in
 */
int margo_register_mplex(margo_instance_id mid, hg_id_t id, uint32_t mplex_id, ABT_pool pool);

Philip Carns's avatar
Philip Carns committed
256 257 258 259 260 261 262 263 264
/**
 * Maps an RPC id and mplex id to the pool that it should execute on
 * @param [in] mid Margo instance
 * @param [in] id Mercury RPC identifier
 * @param [in] mplex_id multiplexing identifier
 * @param [out] pool Argobots pool the handler will execute in
 */
int margo_lookup_mplex(margo_instance_id mid, hg_id_t id, uint32_t mplex_id, ABT_pool *pool);

265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288

/**
 * macro that registers a function as an RPC.
 */
#define MARGO_REGISTER(__mid, __func_name, __in_t, __out_t, __handler, __rpc_id_ptr) do { \
    hg_return_t __hret; \
    hg_id_t __id; \
    hg_bool_t __flag; \
    int __ret; \
    __hret = HG_Registered_name(margo_get_class(__mid), __func_name, &__id, &__flag); \
    assert(__hret == HG_SUCCESS); \
    if(!__flag) \
        __id = HG_Register_name(margo_get_class(__mid), __func_name,\
                   BOOST_PP_CAT(hg_proc_, __in_t),\
                   BOOST_PP_CAT(hg_proc_, __out_t),\
                   __handler##_handler); \
    __ret = margo_register(__mid, __id); \
    assert(__ret == 0); \
    if(__rpc_id_ptr != MARGO_RPC_ID_IGNORE) { \
        *(__rpc_id_ptr) = __id; \
    } \
} while(0)

#define MARGO_REGISTER_MPLEX(__mid, __func_name, __in_t, __out_t, __handler, __mplex_id, __pool, __rpc_id_ptr) do { \
289 290 291 292 293 294 295
    hg_return_t __hret; \
    hg_id_t __id; \
    hg_bool_t __flag; \
    int __ret; \
    __hret = HG_Registered_name(margo_get_class(__mid), __func_name, &__id, &__flag); \
    assert(__hret == HG_SUCCESS); \
    if(!__flag) \
296 297 298 299
        __id = HG_Register_name(margo_get_class(__mid), __func_name,\
                   BOOST_PP_CAT(hg_proc_, __in_t),\
                   BOOST_PP_CAT(hg_proc_, __out_t),\
                   __handler##_handler); \
300
    __ret = margo_register_mplex(__mid, __id, __mplex_id, __pool); \
Philip Carns's avatar
typo  
Philip Carns committed
301
    assert(__ret == 0); \
302 303 304
    if(__rpc_id_ptr != MARGO_RPC_ID_IGNORE) { \
        *(__rpc_id_ptr) = __id; \
    } \
305 306
} while(0)

307 308
#define NULL_handler NULL

309
/**
Philip Carns's avatar
Philip Carns committed
310
 * macro that defines a function to glue an RPC handler to a ult handler
311 312
 * @param [in] __name name of handler function
 */
313
#define DEFINE_MARGO_RPC_HANDLER(__name) \
314
hg_return_t __name##_handler(hg_handle_t handle) { \
315
    int __ret; \
Philip Carns's avatar
Philip Carns committed
316
    ABT_pool __pool; \
317
    margo_instance_id __mid; \
Shane Snyder's avatar
Shane Snyder committed
318
    const struct hg_info *__hgi; \
319
    __hgi = HG_Get_info(handle); \
320 321 322 323
	__mid = margo_hg_handle_get_instance(handle); \
    if(__mid == MARGO_INSTANCE_NULL) { \
        return(HG_OTHER_ERROR); \
    } \
324
    __ret = margo_lookup_mplex(__mid, __hgi->id, __hgi->target_id, (&__pool)); \
Philip Carns's avatar
Philip Carns committed
325 326 327 328
    if(__ret != 0) { \
        return(HG_INVALID_PARAM); \
    }\
    __ret = ABT_thread_create(__pool, (void (*)(void *))__name, handle, ABT_THREAD_ATTR_NULL, NULL); \
329 330 331 332 333 334
    if(__ret != 0) { \
        return(HG_NOMEM_ERROR); \
    } \
    return(HG_SUCCESS); \
}

Philip Carns's avatar
Philip Carns committed
335 336
/**
 * macro that declares the prototype for a function to glue an RPC 
Philip Carns's avatar
Philip Carns committed
337
 * handler to a ult
Philip Carns's avatar
Philip Carns committed
338 339
 * @param [in] __name name of handler function
 */
340
#define DECLARE_MARGO_RPC_HANDLER(__name) hg_return_t __name##_handler(hg_handle_t handle);
341

342 343 344 345
#ifdef __cplusplus
}
#endif

346
#endif /* __MARGO */