margo.h 26.1 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
#include <mercury.h>
21 22
#include <mercury_types.h>
#include <mercury_bulk.h>
23 24 25
#include <mercury_macros.h>
#include <abt.h>

26 27 28 29
/* determine how much of the Mercury ID space to use for Margo provider IDs */
#define __MARGO_PROVIDER_ID_SIZE (sizeof(hg_id_t)/4)
#define __MARGO_RPC_HASH_SIZE (__MARGO_PROVIDER_ID_SIZE * 3)

30 31
#undef MERCURY_REGISTER

32 33
struct margo_instance;
typedef struct margo_instance* margo_instance_id;
34
typedef struct margo_data* margo_data_ptr;
35
typedef ABT_eventual margo_request;
36

37
#define MARGO_INSTANCE_NULL ((margo_instance_id)NULL)
38
#define MARGO_REQUEST_NULL ABT_EVENTUAL_NULL
39 40
#define MARGO_CLIENT_MODE 0
#define MARGO_SERVER_MODE 1
41
#define MARGO_DEFAULT_PROVIDER_ID 0
42
#define MARGO_MAX_PROVIDER_ID ((1 << (8*__MARGO_PROVIDER_ID_SIZE))-1)
43

44
#define MARGO_PARAM_PROGRESS_TIMEOUT_UB 1
45

46 47
/**
 * Initializes margo library.
48
 * @param [in] addr_str            Mercury host address with port number
49 50 51
 * @param [in] mode                Mode to run Margo in:
 *                                     - MARGO_CLIENT_MODE
 *                                     - MARGO_SERVER_MODE
52 53
 * @param [in] use_progress_thread Boolean flag to use a dedicated thread for
 *                                 running Mercury's progress loop. If false,
54
 *                                 it will run in the caller's thread context.
55 56
 * @param [in] rpc_thread_count    Number of threads to use for running RPC
 *                                 calls. A value of 0 directs Margo to execute
57 58 59 60 61 62
 *                                 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.
63
 * @returns margo instance id on success, MARGO_INSTANCE_NULL upon error
64 65 66 67 68
 *
 * 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.
69
 */
70 71
margo_instance_id margo_init(
    const char *addr_str,
72
    int mode,
73 74
    int use_progress_thread,
    int rpc_thread_count);
75

76
/**
Jonathan Jenkins's avatar
Jonathan Jenkins committed
77
 * Initializes margo library from given argobots and Mercury instances.
Philip Carns's avatar
Philip Carns committed
78 79 80
 * @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
Jonathan Jenkins committed
81
 * @returns margo instance id on success, MARGO_INSTANCE_NULL upon error
82 83 84 85 86 87 88 89 90 91
 *
 * NOTE: if you are configuring Argobots pools yourself before
 * passing them into this function, please consider setting
 * ABT_MEM_MAX_NUM_STACKS to a low value (like 8) either in your
 * environment or programmatically with putenv() in your code before
 * creating the pools to prevent excess memory consumption under
 * load from producer/consumer patterns across execution streams that
 * fail to utilize per-execution stream stack caches.  See
 * https://xgitlab.cels.anl.gov/sds/margo/issues/40 for details.
 * The margo_init() function does this automatically.
92
 */
93 94 95
margo_instance_id margo_init_pool(
    ABT_pool progress_pool,
    ABT_pool handler_pool,
96
    hg_context_t *hg_context);
97 98

/**
Philip Carns's avatar
Philip Carns committed
99
 * Shuts down margo library and its underlying abt and mercury resources
Philip Carns's avatar
Philip Carns committed
100
 * @param [in] mid Margo instance
101
 */
102 103
void margo_finalize(
    margo_instance_id mid);
104 105 106 107 108 109 110 111 112 113 114

/**
 * 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
 */
115 116
void margo_wait_for_finalize(
    margo_instance_id mid);
117

118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
/**
 * Installs a callback to be called before the margo instance is finalize.
 * Callbacks installed will be called in reverse ordered than they have been
 * pushed, and with the user-provider pointer as argument.
 *
 * Note that callbacks may not be called within margo_finalize. They are called
 * when the margo instance is cleaned up, which may happen in margo_wait_for_finalize.
 *
 * @param mid The margo instance
 * @param cb Callback to install
 * @param uargs User-provider argument to pass to the callback when called
 */
void margo_push_finalize_callback(
    margo_instance_id mid,
    void(*cb)(void*), 
    void* uargs);

Matthieu Dorier's avatar
Matthieu Dorier committed
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
/**
 * Allows the passed Margo instance to be shut down remotely
 * using margo_shutdown_remote_instance().
 * 
 * @param mid Margo instance
 */
void margo_enable_remote_shutdown(margo_instance_id mid);

/**
 * Trigger the shutdown of the Margo instance running
 * at remote_addr.
 *
 * @param mid Local Margo instance
 * @param remote_addr Address of the Margo instance to shut down.
 *
 * @return 0 on success, -1 on failure.
 */
int margo_shutdown_remote_instance(
        margo_instance_id mid, 
        hg_addr_t remote_addr);

Matthieu Dorier's avatar
Matthieu Dorier committed
156

157
/** 
Matthieu Dorier's avatar
Matthieu Dorier committed
158
 * Registers an RPC with margo that is associated with a provider instance
159 160 161 162 163 164
 *
 * \param [in] mid Margo instance
 * \param [in] func_name unique function name for RPC
 * \param [in] in_proc_cb pointer to input proc callback
 * \param [in] out_proc_cb pointer to output proc callback
 * \param [in] rpc_cb RPC callback
Matthieu Dorier's avatar
Matthieu Dorier committed
165 166
 * \param [in] provider_id provider identifier
 * \param [in] pool Argobots pool the handler will execute in
167 168
 *
 * \return unique ID associated to the registered function
169
 */
Matthieu Dorier's avatar
Matthieu Dorier committed
170
hg_id_t margo_provider_register_name(
171 172 173 174
    margo_instance_id mid,
    const char *func_name,
    hg_proc_cb_t in_proc_cb,
    hg_proc_cb_t out_proc_cb,
Matthieu Dorier's avatar
Matthieu Dorier committed
175 176 177
    hg_rpc_cb_t rpc_cb,
    uint16_t provider_id,
    ABT_pool pool);
178

179
/** 
Matthieu Dorier's avatar
Matthieu Dorier committed
180
 * Registers an RPC with margo
181 182 183 184 185 186 187 188
 *
 * \param [in] mid Margo instance
 * \param [in] func_name unique function name for RPC
 * \param [in] in_proc_cb pointer to input proc callback
 * \param [in] out_proc_cb pointer to output proc callback
 * \param [in] rpc_cb RPC callback
 *
 * \return unique ID associated to the registered function
189
 */
Matthieu Dorier's avatar
Matthieu Dorier committed
190
inline hg_id_t margo_register_name(
191 192 193 194
    margo_instance_id mid,
    const char *func_name,
    hg_proc_cb_t in_proc_cb,
    hg_proc_cb_t out_proc_cb,
Matthieu Dorier's avatar
Matthieu Dorier committed
195 196 197 198 199
    hg_rpc_cb_t rpc_cb)
{
    return margo_provider_register_name(mid, func_name,
            in_proc_cb, out_proc_cb, rpc_cb, 0, ABT_POOL_NULL);
}
200

201
/*
202
 * Indicate whether margo_register_name() has been called for the RPC specified by
203 204
 * func_name.
 *
205 206 207 208
 * \param [in] mid Margo instance
 * \param [in] func_name function name
 * \param [out] id registered RPC ID
 * \param [out] flag pointer to boolean
209 210
 *
 * \return HG_SUCCESS or corresponding HG error code
211
 */
212 213 214 215 216
hg_return_t margo_registered_name(
    margo_instance_id mid,
    const char *func_name,
    hg_id_t *id,
    hg_bool_t *flag);
217

218
/**
219
 * Indicate whether the given RPC name has been registered with the given provider id.
220 221 222
 *
 * @param [in] mid Margo instance
 * @param [in] func_name function name
223
 * @param [in] provider_id provider id
224 225 226 227 228
 * @param [out] id registered RPC ID
 * @param [out] flag pointer to boolean
 *
 * @return HG_SUCCESS or corresponding HG error code
 */
229
hg_return_t margo_provider_registered_name(
230 231
    margo_instance_id mid,
    const char *func_name,
232
    uint16_t provider_id,
233 234 235
    hg_id_t *id,
    hg_bool_t *flag);

236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
/**
 * 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
 */
263 264 265
void* margo_registered_data(
    margo_instance_id mid,
    hg_id_t id);
266

267

268
/**
269
 * Disable response for a given RPC ID.
270
 *
271 272 273
 * \param [in] mid          Margo instance 
 * \param [in] id           registered function ID
 * \param [in] disable_flag flag to disable (1) or re-enable (0) responses
274 275
 *
 * \return HG_SUCCESS or corresponding HG error code
276
 */
277 278 279 280
hg_return_t margo_registered_disable_response(
    margo_instance_id mid,
    hg_id_t id,
    int disable_flag);
281 282 283

/**
 * Lookup an addr from a peer address/name.
284 285 286 287
 * \param [in] name     lookup name
 * \param [out] addr    return address
 *
 * \return HG_SUCCESS or corresponding HG error code
288 289 290
 */
hg_return_t margo_addr_lookup(
    margo_instance_id mid,
291 292
    const char *name,
    hg_addr_t *addr);
293 294

/**
295
 * Free the given Mercury addr.
296
 *
297 298
 * \param [in] mid  Margo instance 
 * \param [in] addr Mercury address
299 300 301
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
302 303 304
hg_return_t margo_addr_free(
    margo_instance_id mid,
    hg_addr_t addr);
305 306

/**
307
 * Access self address. Address must be freed with margo_addr_free().
308
 *
309 310
 * \param [in] mid  Margo instance 
 * \param [in] addr pointer to abstract Mercury address
311 312 313
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
314 315 316
hg_return_t margo_addr_self(
    margo_instance_id mid,
    hg_addr_t *addr);
317 318

/**
319
 * Duplicate an existing Mercury address. 
320
 *
321 322 323
 * \param [in] mid      Margo instance 
 * \param [in] addr     abstract Mercury address to duplicate
 * \param [in] new_addr pointer to newly allocated abstract Mercury address
324 325 326
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
327 328 329 330
hg_return_t margo_addr_dup(
    margo_instance_id mid,
    hg_addr_t addr,
    hg_addr_t *new_addr);
331 332

/**
333 334 335 336 337
 * Convert a Mercury addr to a string (returned string includes the
 * terminating null byte '\0'). If buf is NULL, the address is not
 * converted and only the required size of the buffer is returned.
 * If the input value passed through buf_size is too small, HG_SIZE_ERROR
 * is returned and the buf_size output is set to the minimum size required.
338
 *
339 340 341 342
 * \param [in] mid          Margo instance 
 * \param [in/out] buf      pointer to destination buffer
 * \param [in/out] buf_size pointer to buffer size
 * \param [in] addr         abstract Mercury address
343 344 345
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
346 347 348 349 350
hg_return_t margo_addr_to_string(
    margo_instance_id mid,
    char *buf,
    hg_size_t *buf_size,
    hg_addr_t addr);
351 352

/**
353 354 355 356
 * Initiate a new Mercury RPC using the specified function ID and the
 * local/remote target defined by addr. The handle created can be used to
 * query input and output, as well as issuing the RPC by calling
 * HG_Forward(). After completion the handle must be freed using HG_Destroy().
357
 *
358 359 360 361
 * \param [in] mid      Margo instance 
 * \param [in] addr     abstract Mercury address of destination
 * \param [in] id       registered function ID
 * \param [out] handle  pointer to HG handle
362 363 364
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
365 366 367 368 369
hg_return_t margo_create(
    margo_instance_id mid,
    hg_addr_t addr,
    hg_id_t id,
    hg_handle_t *handle);
370 371

/**
372
 * Destroy Mercury handle.
373
 *
Shane Snyder's avatar
Shane Snyder committed
374
 * \param [in] handle   Mercury handle
375 376 377
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
378 379
hg_return_t margo_destroy(
    hg_handle_t handle);
380 381

/**
382
 * Increment ref count on a Mercury handle.
383
 *
384
 * \param [in] handle Mercury handle
385 386 387
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
388
#define margo_ref_incr HG_Ref_incr
389 390 391 392

/**
 * Get info from handle.
 *
393
 * \param [in] handle Mercury handle
394 395 396
 *
 * \return Pointer to info or NULL in case of failure
 */
397
#define margo_get_info HG_Get_info
398 399 400

/**
 * Get input from handle (requires registration of input proc to deserialize
401
 * parameters). Input must be freed using margo_free_input().
402
 *
403 404
 * \param [in] handle           Mercury handle
 * \param [in/out] in_struct    pointer to input structure
405 406 407
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
408
#define margo_get_input HG_Get_input
409 410 411 412

/**
 * Free resources allocated when deserializing the input.
 *
413 414
 * \param [in] handle           Mercury handle
 * \param [in/out] in_struct    pointer to input structure
415 416 417
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
418
#define margo_free_input HG_Free_input
419 420 421

/**
 * Get output from handle (requires registration of output proc to deserialize
422
 * parameters). Output must be freed using margo_free_output().
423
 *
424 425
 * \param [in] handle           Mercury handle
 * \param [in/out] out_struct   pointer to output structure
426 427 428
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
429
#define margo_get_output HG_Get_output
430 431 432 433

/**
 * Free resources allocated when deserializing the output.
 *
434 435
 * \param [in] handle           Mercury handle
 * \param [in/out] out_struct   pointer to output structure
436 437 438
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
439
#define margo_free_output HG_Free_output
440

441 442
/**
 * Forward an RPC request to a remote host
443
 * @param [in] provider ID (may be MARGO_DEFAULT_PROVIDER_ID)
444 445 446 447
 * @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
 */
448
hg_return_t margo_provider_forward(
449
    uint16_t provider_id,
450 451 452
    hg_handle_t handle,
    void *in_struct);

453
#define margo_forward(__handle, __in_struct)\
454
    margo_provider_forward(MARGO_DEFAULT_PROVIDER_ID, __handle, __in_struct)
455

456 457
/**
 * Forward (without blocking) an RPC request to a remote host
458
 * @param [in] provider ID (may be MARGO_DEFAULT_PROVIDER_ID)
459 460 461 462 463
 * @param [in] handle identifier for the RPC to be sent
 * @param [in] in_struct input argument struct for RPC
 * @param [out] req request to wait on using margo_wait
 * @returns 0 on success, hg_return_t values on error
 */
464
hg_return_t margo_provider_iforward(
465
    uint16_t provider_id,
466 467 468 469
    hg_handle_t handle,
    void* in_struct,
    margo_request* req);

470
#define margo_iforward(__handle, __in_struct, __req)\
471
    margo_provider_iforward(MARGO_DEFAULT_PROVIDER_ID, __handle, __in_struct, __req)
472

473 474 475 476 477 478 479 480 481
/**
 * Wait for an operation initiated by a non-blocking
 * margo function (margo_iforward, margo_irespond, etc.)
 * @param [in] req request to wait on
 * @returns 0 on success, hg_return_t values on error
 */
hg_return_t margo_wait(
    margo_request req);

Matthieu Dorier's avatar
Matthieu Dorier committed
482 483 484 485 486 487 488 489 490 491 492 493 494

/**
 * Test if an operation initiated by a non-blocking
 * margo function (margo_iforward, margo_irespond, etc.)
 * has completed.
 *
 * @param [in] req request created by the non-blocking call
 * @param [out] flag 1 if request is completed, 0 otherwise
 *
 * @return 0 on success, ABT error code otherwise
 */
int margo_test(margo_request req, int* flag);

495 496 497 498 499 500 501 502 503 504 505 506
/**
 * Forward an RPC request to a remote host with a user-defined timeout
 * @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(
    hg_handle_t handle,
    void *in_struct,
    double timeout_ms);

Jonathan Jenkins's avatar
Jonathan Jenkins committed
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
/**
 * 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] 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(
    hg_handle_t handle,
    void *out_struct);

523 524 525 526 527 528 529 530 531 532 533 534 535
/**
 * Send an RPC response without blocking.
 * @param [in] handle identifier for the RPC for which a response is being
 * sent
 * @param [in] out_struct output argument struct for response
 * @param [out] req request on which to wait using margo_wait
 * @return HG_SUCCESS on success, hg_return_t values on error. See HG_Respond.
 */
hg_return_t margo_irespond(
    hg_handle_t handle,
    void *out_struct,
    margo_request* req);

536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
/**
 * Create an abstract bulk handle from specified memory segments.
 * Memory allocated is then freed when margo_bulk_free() is called.
 * \remark If NULL is passed to buf_ptrs, i.e.,
 * \verbatim margo_bulk_create(mid, count, NULL, buf_sizes, flags, &handle) \endverbatim
 * memory for the missing buf_ptrs array will be internally allocated.
 *
 * \param [in] mid          Margo instance 
 * \param [in] count        number of segments
 * \param [in] buf_ptrs     array of pointers
 * \param [in] buf_sizes    array of sizes
 * \param [in] flags        permission flag:
 *                             - HG_BULK_READWRITE
 *                             - HG_BULK_READ_ONLY
 *                             - HG_BULK_WRITE_ONLY
 * \param [out] handle      pointer to returned abstract bulk handle
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
hg_return_t margo_bulk_create(
    margo_instance_id mid,
    hg_uint32_t count,
    void **buf_ptrs,
    const hg_size_t *buf_sizes,
    hg_uint8_t flags,
    hg_bulk_t *handle);

/**
 * Free bulk handle.
 *
 * \param [in/out] handle   abstract bulk handle
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
hg_return_t margo_bulk_free(
    hg_bulk_t handle);

/**
 * Increment ref count on bulk handle.
 *
 * \param handle [IN]           abstract bulk handle
577 578 579
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
580
#define margo_bulk_ref_incr HG_Bulk_ref_incr
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597

/**
 * Access bulk handle to retrieve memory segments abstracted by handle.
 *
 * \param [in] handle           abstract bulk handle
 * \param [in] offset           bulk offset
 * \param [in] size             bulk size
 * \param [in] flags            permission flag:
 *                                 - HG_BULK_READWRITE
 *                                 - HG_BULK_READ_ONLY
 * \param [in] max_count        maximum number of segments to be returned
 * \param [in/out] buf_ptrs     array of buffer pointers
 * \param [in/out] buf_sizes    array of buffer sizes
 * \param [out] actual_count    actual number of segments returned
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
598
#define margo_bulk_access HG_Bulk_access
599 600 601 602 603 604 605 606

/**
 * Get total size of data abstracted by bulk handle.
 *
 * \param [in] handle   abstract bulk handle
 *
 * \return Non-negative value
 */
607
#define margo_bulk_get_size HG_Bulk_get_size
608 609 610 611 612 613 614 615

/**
 * Get total number of segments abstracted by bulk handle.
 *
 * \param [in] handle   abstract bulk handle
 *
 * \return Non-negative value
 */
616
#define margo_bulk_get_segment_count HG_Bulk_get_segment_count
617 618 619 620 621 622 623 624 625 626 627

/**
 * Get size required to serialize bulk handle.
 *
 * \param [in] handle           abstract bulk handle
 * \param [in] request_eager    boolean (passing HG_TRUE adds size of encoding
 *                              actual data along the handle if handle meets
 *                              HG_BULK_READ_ONLY flag condition)
 *
 * \return Non-negative value
 */
628
#define margo_bulk_get_serialize_size HG_Bulk_get_serialize_size
629 630 631 632 633 634 635 636 637 638 639 640 641 642

/**
 * Serialize bulk handle into a buffer.
 *
 * \param [in/out] buf          pointer to buffer
 * \param [in] buf_size         buffer size
 * \param [in] request_eager    boolean (passing HG_TRUE encodes actual data
 *                              along the handle, which is more efficient for
 *                              small data, this is only valid if bulk handle
 *                              has HG_BULK_READ_ONLY permission)
 * \param [in] handle           abstract bulk handle
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
643
#define margo_bulk_serialize HG_Bulk_serialize
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659

/**
 * Deserialize bulk handle from an existing buffer.
 *
 * \param [in] mid      Margo instance 
 * \param [out] handle  abstract bulk handle
 * \param [in] buf      pointer to buffer
 * \param [in] buf_size buffer size
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
hg_return_t margo_bulk_deserialize(
    margo_instance_id mid,
    hg_bulk_t *handle,
    const void *buf,
    hg_size_t buf_size);
660

661 662
/** 
 * Perform a bulk transfer
Philip Carns's avatar
Philip Carns committed
663
 * @param [in] mid Margo instance
664 665 666 667 668 669 670 671 672 673
 * @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(
674
    margo_instance_id mid,
675
    hg_bulk_op_t op,
676
    hg_addr_t origin_addr,
677 678 679 680
    hg_bulk_t origin_handle,
    size_t origin_offset,
    hg_bulk_t local_handle,
    size_t local_offset,
681
    size_t size);
682

683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
/** 
 * Asynchronously performs a bulk transfer
 * @param [in] mid Margo instance
 * @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
 * @param [out] req request to wait on using margo_wait
 * @returns 0 on success, hg_return_t values on error
 */
hg_return_t margo_bulk_itransfer(
    margo_instance_id mid,
    hg_bulk_op_t op,
    hg_addr_t origin_addr,
    hg_bulk_t origin_handle,
    size_t origin_offset,
    hg_bulk_t local_handle,
    size_t local_offset,
    size_t size,
    margo_request* req);

707 708 709 710 711 712 713 714
/**
 * Suspends the calling ULT for a specified time duration
 * @param [in] mid Margo instance
 * @param [in] timeout_ms timeout duration in milliseconds
 */
void margo_thread_sleep(
    margo_instance_id mid,
    double timeout_ms);
715

716
/**
717 718 719
 * Retrieve the abt_handler pool that was associated with the instance at 
 *    initialization time
 * @param [in] mid Margo instance
720 721
 * @param [out] pool handler pool
 * @return 0 on success, error code on failure
722
 */
723
int margo_get_handler_pool(margo_instance_id mid, ABT_pool* pool);
724

725 726 727 728 729 730 731
/**
 * Retrieve the rpc handler abt pool that is associated with this handle
 * @param [in] h handle
 * @return pool
 */
ABT_pool margo_hg_handle_get_handler_pool(hg_handle_t h);

732
/**
733 734
 * Retrieve the Mercury context that was associated with this instance at
 *    initialization time
735
 * @param [in] mid Margo instance
736
 * @return the Mercury context used in margo_init
737
 */
738
hg_context_t* margo_get_context(margo_instance_id mid);
739

740 741 742
/**
 * Retrieve the Mercury class that was associated with this instance at
 *    initialization time
743
 * @param [in] mid Margo instance
744
 * @return the Mercury class used in margo_init
745
 */
746
hg_class_t* margo_get_class(margo_instance_id mid);
747

748 749 750 751 752 753 754 755 756
/**
 * 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);

757 758 759 760 761 762 763 764 765
/**
 * Get the margo_instance_id from an hg_info struct 
 *
 * \param [in] info       hg_info struct 
 * 
 * \return Margo instance
 */
margo_instance_id margo_hg_info_get_instance(const struct hg_info *info);

Philip Carns's avatar
Philip Carns committed
766 767 768 769 770 771 772 773 774 775 776 777 778 779
/**
 * Enables diagnostic collection on specified Margo instance
 *
 * @param [in] mid Margo instance
 * @returns void
 */
void margo_diag_start(margo_instance_id mid);

/**
 * Appends diagnostic statistics (enabled via margo_diag_start()) to specified 
 * output file.
 *
 * @param [in] mid Margo instance
 * @param [in] file output file ("-" for stdout)
780 781
 * @param [in] uniquify flag indicating if file name should have additional
 *   information added to it to make output from different processes unique
Philip Carns's avatar
Philip Carns committed
782 783
 * @returns void
 */
784
void margo_diag_dump(margo_instance_id mid, const char* file, int uniquify);
785

786 787 788 789 790 791 792 793
/**
 * Sets configurable parameters/hints
 *
 * @param [in] mid Margo instance
 * @param [in] option numerical option number
 * @param [out] inout_param used to pass in values
 * @returns void
 */
794
void margo_set_param(margo_instance_id mid, int option, const void *param);
795 796 797 798 799 800 801 802 803

/**
 * Retrieves configurable parameters/hints
 *
 * @param [in] mid Margo instance
 * @param [in] option numerical option number
 * @param [out] param used to pass out values
 * @returns void
 */
804
void margo_get_param(margo_instance_id mid, int option, void *param);
805 806


807 808 809
/**
 * macro that registers a function as an RPC.
 */
810
#define MARGO_REGISTER(__mid, __func_name, __in_t, __out_t, __handler) \
811
    margo_provider_register_name(__mid, __func_name, \
812 813
        BOOST_PP_CAT(hg_proc_, __in_t), \
        BOOST_PP_CAT(hg_proc_, __out_t), \
814 815
        __handler##_handler, \
        MARGO_DEFAULT_PROVIDER_ID, ABT_POOL_NULL);
816

817
#define MARGO_REGISTER_PROVIDER(__mid, __func_name, __in_t, __out_t, __handler, __provider_id, __pool) \
818
    margo_provider_register_name(__mid, __func_name, \
819 820 821
        BOOST_PP_CAT(hg_proc_, __in_t), \
        BOOST_PP_CAT(hg_proc_, __out_t), \
        __handler##_handler, \
822
        __provider_id, __pool);
823

824 825
#define NULL_handler NULL

826
/**
Philip Carns's avatar
Philip Carns committed
827
 * macro that defines a function to glue an RPC handler to a ult handler
828 829
 * @param [in] __name name of handler function
 */
830
#define DEFINE_MARGO_RPC_HANDLER(__name) \
831
hg_return_t __name##_handler(hg_handle_t handle) { \
832
    int __ret; \
833
    ABT_pool __pool; \
834
    margo_instance_id __mid; \
835
    __mid = margo_hg_handle_get_instance(handle); \
836 837 838
    if(__mid == MARGO_INSTANCE_NULL) { \
        return(HG_OTHER_ERROR); \
    } \
839
    __pool = margo_hg_handle_get_handler_pool(handle); \
840
    __ret = ABT_thread_create(__pool, (void (*)(void *))__name, handle, ABT_THREAD_ATTR_NULL, NULL); \
841 842 843 844 845 846
    if(__ret != 0) { \
        return(HG_NOMEM_ERROR); \
    } \
    return(HG_SUCCESS); \
}

Philip Carns's avatar
Philip Carns committed
847 848
/**
 * macro that declares the prototype for a function to glue an RPC 
Philip Carns's avatar
Philip Carns committed
849
 * handler to a ult
Philip Carns's avatar
Philip Carns committed
850 851
 * @param [in] __name name of handler function
 */
852
#define DECLARE_MARGO_RPC_HANDLER(__name) hg_return_t __name##_handler(hg_handle_t handle);
853

854 855 856 857
#ifdef __cplusplus
}
#endif

858
#endif /* __MARGO */