margo.h 24.5 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
#undef MERCURY_REGISTER

28 29
struct margo_instance;
typedef struct margo_instance* margo_instance_id;
30
typedef struct margo_data* margo_data_ptr;
Matthieu Dorier's avatar
Matthieu Dorier committed
31
typedef ABT_eventual margo_request;
32

33
#define MARGO_INSTANCE_NULL ((margo_instance_id)NULL)
Matthieu Dorier's avatar
Matthieu Dorier committed
34
#define MARGO_REQUEST_NULL ABT_EVENTUAL_NULL
Shane Snyder's avatar
Shane Snyder committed
35 36
#define MARGO_CLIENT_MODE 0
#define MARGO_SERVER_MODE 1
37
#define MARGO_DEFAULT_MPLEX_ID 0
Jonathan Jenkins's avatar
Jonathan Jenkins committed
38

Shane Snyder's avatar
Shane Snyder committed
39
#define MARGO_PARAM_PROGRESS_TIMEOUT_UB 1
40

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

71
/**
Jonathan Jenkins's avatar
doc fix  
Jonathan Jenkins committed
72
 * Initializes margo library from given argobots and Mercury instances.
Philip Carns's avatar
Philip Carns committed
73 74 75
 * @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
76
 * @returns margo instance id on success, MARGO_INSTANCE_NULL upon error
77
 */
Shane Snyder's avatar
Shane Snyder committed
78 79 80
margo_instance_id margo_init_pool(
    ABT_pool progress_pool,
    ABT_pool handler_pool,
Jonathan Jenkins's avatar
Jonathan Jenkins committed
81
    hg_context_t *hg_context);
82 83

/**
Philip Carns's avatar
Philip Carns committed
84
 * Shuts down margo library and its underlying abt and mercury resources
Philip Carns's avatar
Philip Carns committed
85
 * @param [in] mid Margo instance
86
 */
87 88
void margo_finalize(
    margo_instance_id mid);
89 90 91 92 93 94 95 96 97 98 99

/**
 * 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
 */
100 101
void margo_wait_for_finalize(
    margo_instance_id mid);
102

103 104
/** 
 * Registers an RPC with margo
105 106 107 108 109 110 111 112
 *
 * \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
113
 */
114 115 116 117 118 119
hg_id_t margo_register_name(
    margo_instance_id mid,
    const char *func_name,
    hg_proc_cb_t in_proc_cb,
    hg_proc_cb_t out_proc_cb,
    hg_rpc_cb_t rpc_cb);
120

121 122
/** 
 * Registers an RPC with margo that is associated with a multiplexed service
123 124 125 126 127 128 129 130 131 132
 *
 * \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
 * \param [in] mplex_id multiplexing identifier
 * \param [in] pool Argobots pool the handler will execute in
 *
 * \return unique ID associated to the registered function
133
 */
134 135 136 137 138 139 140 141
hg_id_t margo_register_name_mplex(
    margo_instance_id mid,
    const char *func_name,
    hg_proc_cb_t in_proc_cb,
    hg_proc_cb_t out_proc_cb,
    hg_rpc_cb_t rpc_cb,
    uint32_t mplex_id,
    ABT_pool pool);
142

143
/*
144
 * Indicate whether margo_register_name() has been called for the RPC specified by
145 146
 * func_name.
 *
147 148 149 150
 * \param [in] mid Margo instance
 * \param [in] func_name function name
 * \param [out] id registered RPC ID
 * \param [out] flag pointer to boolean
151 152
 *
 * \return HG_SUCCESS or corresponding HG error code
153
 */
154 155 156 157 158
hg_return_t margo_registered_name(
    margo_instance_id mid,
    const char *func_name,
    hg_id_t *id,
    hg_bool_t *flag);
159

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
/**
 * 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
 */
187 188 189
void* margo_registered_data(
    margo_instance_id mid,
    hg_id_t id);
190

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
/**
 * Register and associate user data to registered function for
 * a given multiplex id.
 * 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] mplex_id       Margo multiplex ID
 * \param [in] data           pointer to data
 * \param [in] free_callback  pointer to free function
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
int margo_register_data_mplex(
    margo_instance_id mid,
    hg_id_t id,
    uint32_t mplex_id,
    void* data,
    void (*free_callback)(void *));

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

227
/**
228
 * Disable response for a given RPC ID.
229
 *
230 231 232
 * \param [in] mid          Margo instance 
 * \param [in] id           registered function ID
 * \param [in] disable_flag flag to disable (1) or re-enable (0) responses
233 234
 *
 * \return HG_SUCCESS or corresponding HG error code
235
 */
236 237 238 239
hg_return_t margo_registered_disable_response(
    margo_instance_id mid,
    hg_id_t id,
    int disable_flag);
240 241 242

/**
 * Lookup an addr from a peer address/name.
243 244 245 246
 * \param [in] name     lookup name
 * \param [out] addr    return address
 *
 * \return HG_SUCCESS or corresponding HG error code
247 248 249
 */
hg_return_t margo_addr_lookup(
    margo_instance_id mid,
250 251
    const char *name,
    hg_addr_t *addr);
252 253

/**
254
 * Free the given Mercury addr.
255
 *
256 257
 * \param [in] mid  Margo instance 
 * \param [in] addr Mercury address
258 259 260
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
261 262 263
hg_return_t margo_addr_free(
    margo_instance_id mid,
    hg_addr_t addr);
264 265

/**
266
 * Access self address. Address must be freed with margo_addr_free().
267
 *
268 269
 * \param [in] mid  Margo instance 
 * \param [in] addr pointer to abstract Mercury address
270 271 272
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
273 274 275
hg_return_t margo_addr_self(
    margo_instance_id mid,
    hg_addr_t *addr);
276 277

/**
278
 * Duplicate an existing Mercury address. 
279
 *
280 281 282
 * \param [in] mid      Margo instance 
 * \param [in] addr     abstract Mercury address to duplicate
 * \param [in] new_addr pointer to newly allocated abstract Mercury address
283 284 285
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
286 287 288 289
hg_return_t margo_addr_dup(
    margo_instance_id mid,
    hg_addr_t addr,
    hg_addr_t *new_addr);
290 291

/**
292 293 294 295 296
 * 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.
297
 *
298 299 300 301
 * \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
302 303 304
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
305 306 307 308 309
hg_return_t margo_addr_to_string(
    margo_instance_id mid,
    char *buf,
    hg_size_t *buf_size,
    hg_addr_t addr);
310 311

/**
312 313 314 315
 * 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().
316
 *
317 318 319 320
 * \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
321 322 323
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
324 325 326 327 328
hg_return_t margo_create(
    margo_instance_id mid,
    hg_addr_t addr,
    hg_id_t id,
    hg_handle_t *handle);
329 330

/**
331
 * Destroy Mercury handle.
332
 *
Shane Snyder's avatar
Shane Snyder committed
333
 * \param [in] handle   Mercury handle
334 335 336
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
337 338
hg_return_t margo_destroy(
    hg_handle_t handle);
339 340

/**
341
 * Increment ref count on a Mercury handle.
342
 *
343
 * \param [in] handle Mercury handle
344 345 346
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
347
#define margo_ref_incr HG_Ref_incr
348 349 350 351

/**
 * Get info from handle.
 *
352
 * \param [in] handle Mercury handle
353 354 355
 *
 * \return Pointer to info or NULL in case of failure
 */
356
#define margo_get_info HG_Get_info
357 358 359

/**
 * Get input from handle (requires registration of input proc to deserialize
360
 * parameters). Input must be freed using margo_free_input().
361
 *
362 363
 * \param [in] handle           Mercury handle
 * \param [in/out] in_struct    pointer to input structure
364 365 366
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
367
#define margo_get_input HG_Get_input
368 369 370 371

/**
 * Free resources allocated when deserializing the input.
 *
372 373
 * \param [in] handle           Mercury handle
 * \param [in/out] in_struct    pointer to input structure
374 375 376
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
377
#define margo_free_input HG_Free_input
378 379 380

/**
 * Get output from handle (requires registration of output proc to deserialize
381
 * parameters). Output must be freed using margo_free_output().
382
 *
383 384
 * \param [in] handle           Mercury handle
 * \param [in/out] out_struct   pointer to output structure
385 386 387
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
388
#define margo_get_output HG_Get_output
389 390 391 392

/**
 * Free resources allocated when deserializing the output.
 *
393 394
 * \param [in] handle           Mercury handle
 * \param [in/out] out_struct   pointer to output structure
395 396 397
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
398
#define margo_free_output HG_Free_output
399

Shane Snyder's avatar
Shane Snyder committed
400 401 402 403 404 405 406 407
/**
 * Set target ID that will receive and process RPC request.
 *
 * \param [in] handle       Mercury handle
 * \param [in] target_id    user-defined target ID
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
408
#define margo_set_target_id HG_Set_target_id
Shane Snyder's avatar
Shane Snyder committed
409

410 411 412 413 414 415 416 417 418 419
/**
 * Forward an RPC request to a remote host
 * @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(
    hg_handle_t handle,
    void *in_struct);

Matthieu Dorier's avatar
Matthieu Dorier committed
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
/**
 * Forward (without blocking) an RPC request to a remote host
 * @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
 */
hg_return_t margo_iforward(
    hg_handle_t handle,
    void* in_struct,
    margo_request* req);

/**
 * 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
441 442 443 444 445 446 447 448 449 450 451 452 453

/**
 * 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);

454 455 456 457 458 459 460 461 462 463 464 465
/**
 * 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
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
/**
 * 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);

Matthieu Dorier's avatar
Matthieu Dorier committed
482 483 484 485 486 487 488 489 490 491 492 493 494
/**
 * 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);

495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
/**
 * 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
536 537 538
 *
 * \return HG_SUCCESS or corresponding HG error code
 */
539
#define margo_bulk_ref_incr HG_Bulk_ref_incr
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556

/**
 * 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
 */
557
#define margo_bulk_access HG_Bulk_access
558 559 560 561 562 563 564 565

/**
 * Get total size of data abstracted by bulk handle.
 *
 * \param [in] handle   abstract bulk handle
 *
 * \return Non-negative value
 */
566
#define margo_bulk_get_size HG_Bulk_get_size
567 568 569 570 571 572 573 574

/**
 * Get total number of segments abstracted by bulk handle.
 *
 * \param [in] handle   abstract bulk handle
 *
 * \return Non-negative value
 */
575
#define margo_bulk_get_segment_count HG_Bulk_get_segment_count
576 577 578 579 580 581 582 583 584 585 586

/**
 * 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
 */
587
#define margo_bulk_get_serialize_size HG_Bulk_get_serialize_size
588 589 590 591 592 593 594 595 596 597 598 599 600 601

/**
 * 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
 */
602
#define margo_bulk_serialize HG_Bulk_serialize
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618

/**
 * 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);
619

620 621
/** 
 * Perform a bulk transfer
Philip Carns's avatar
Philip Carns committed
622
 * @param [in] mid Margo instance
623 624 625 626 627 628 629 630 631 632
 * @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(
633
    margo_instance_id mid,
634
    hg_bulk_op_t op,
635
    hg_addr_t origin_addr,
636 637 638 639
    hg_bulk_t origin_handle,
    size_t origin_offset,
    hg_bulk_t local_handle,
    size_t local_offset,
640
    size_t size);
641

Matthieu Dorier's avatar
Matthieu Dorier committed
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
/** 
 * 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);

666 667 668 669 670 671 672 673
/**
 * 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);
674

675
/**
676 677 678
 * Retrieve the abt_handler pool that was associated with the instance at 
 *    initialization time
 * @param [in] mid Margo instance
679
 */
680
ABT_pool* margo_get_handler_pool(margo_instance_id mid);
681

682
/**
683 684
 * Retrieve the Mercury context that was associated with this instance at
 *    initialization time
685
 * @param [in] mid Margo instance
686
 * @return the Mercury context used in margo_init
687
 */
688
hg_context_t* margo_get_context(margo_instance_id mid);
689

690 691 692
/**
 * Retrieve the Mercury class that was associated with this instance at
 *    initialization time
693
 * @param [in] mid Margo instance
694
 * @return the Mercury class used in margo_init
695
 */
696
hg_class_t* margo_get_class(margo_instance_id mid);
697

698 699 700 701 702 703 704 705 706
/**
 * 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);

707 708 709 710 711 712 713 714 715
/**
 * Get the margo_instance_id from a received RPC handle.
 *
 * \param [in] info      RPC info structure pointer
 * 
 * \return Margo instance
 */
margo_instance_id margo_hg_info_get_instance(const struct hg_info *info);

Philip Carns's avatar
Philip Carns committed
716 717 718 719 720 721 722 723 724
/**
 * 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);

Philip Carns's avatar
Philip Carns committed
725 726 727 728 729 730 731 732 733 734 735 736 737 738
/**
 * 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)
739 740
 * @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
741 742
 * @returns void
 */
743
void margo_diag_dump(margo_instance_id mid, const char* file, int uniquify);
744

745 746 747 748 749 750 751 752
/**
 * 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
 */
753
void margo_set_param(margo_instance_id mid, int option, const void *param);
754 755 756 757 758 759 760 761 762

/**
 * 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
 */
763
void margo_get_param(margo_instance_id mid, int option, void *param);
764 765


766 767 768
/**
 * macro that registers a function as an RPC.
 */
769 770 771 772 773 774 775 776 777 778 779 780
#define MARGO_REGISTER(__mid, __func_name, __in_t, __out_t, __handler) \
    margo_register_name(__mid, __func_name, \
        BOOST_PP_CAT(hg_proc_, __in_t), \
        BOOST_PP_CAT(hg_proc_, __out_t), \
        __handler##_handler);

#define MARGO_REGISTER_MPLEX(__mid, __func_name, __in_t, __out_t, __handler, __mplex_id, __pool) \
    margo_register_name_mplex(__mid, __func_name, \
        BOOST_PP_CAT(hg_proc_, __in_t), \
        BOOST_PP_CAT(hg_proc_, __out_t), \
        __handler##_handler, \
        __mplex_id, __pool);
781

782 783
#define NULL_handler NULL

784
/**
Philip Carns's avatar
Philip Carns committed
785
 * macro that defines a function to glue an RPC handler to a ult handler
786 787
 * @param [in] __name name of handler function
 */
788
#define DEFINE_MARGO_RPC_HANDLER(__name) \
789
hg_return_t __name##_handler(hg_handle_t handle) { \
790
    int __ret; \
Philip Carns's avatar
Philip Carns committed
791
    ABT_pool __pool; \
792
    margo_instance_id __mid; \
Shane Snyder's avatar
Shane Snyder committed
793
    const struct hg_info *__hgi; \
794
    __hgi = HG_Get_info(handle); \
795 796 797 798
	__mid = margo_hg_handle_get_instance(handle); \
    if(__mid == MARGO_INSTANCE_NULL) { \
        return(HG_OTHER_ERROR); \
    } \
799
    __ret = margo_lookup_mplex(__mid, __hgi->id, __hgi->target_id, (&__pool)); \
Philip Carns's avatar
Philip Carns committed
800 801 802 803
    if(__ret != 0) { \
        return(HG_INVALID_PARAM); \
    }\
    __ret = ABT_thread_create(__pool, (void (*)(void *))__name, handle, ABT_THREAD_ATTR_NULL, NULL); \
804 805 806 807 808 809
    if(__ret != 0) { \
        return(HG_NOMEM_ERROR); \
    } \
    return(HG_SUCCESS); \
}

Philip Carns's avatar
Philip Carns committed
810 811
/**
 * macro that declares the prototype for a function to glue an RPC 
Philip Carns's avatar
Philip Carns committed
812
 * handler to a ult
Philip Carns's avatar
Philip Carns committed
813 814
 * @param [in] __name name of handler function
 */
815
#define DECLARE_MARGO_RPC_HANDLER(__name) hg_return_t __name##_handler(hg_handle_t handle);
816

817 818 819 820
#ifdef __cplusplus
}
#endif

821
#endif /* __MARGO */