margo.h 3.62 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
#include <mercury_bulk.h>
#include <mercury.h>
#include <mercury_macros.h>
#include <abt.h>
#include <ev.h>

20 21 22 23

struct margo_instance;
typedef struct margo_instance* margo_instance_id;

24 25 26
/**
 * Initializes margo library, including initializing underlying libevfibers
 *    and Mercury instances.
Philip Carns's avatar
Philip Carns committed
27 28 29 30
 * @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
 * @param [in] hg_class Mercury class
31
 * @returns margo instance id on success, NULL upon error
32
 */
33 34
margo_instance_id margo_init(ABT_pool progress_pool, ABT_pool handler_pool,
    hg_context_t *hg_context, hg_class_t *hg_class);
35 36 37

/**
 * Shuts down margo library and its underlying evfibers and mercury resources
Philip Carns's avatar
Philip Carns committed
38
 * @param [in] mid Margo instance
39
 */
40
void margo_finalize(margo_instance_id mid);
41 42

/**
Philip Carns's avatar
Philip Carns committed
43 44 45
 * Retrieve the abt_handler pool that was associated with the instance at 
 *    initialization time
 * @param [in] mid Margo instance
46
 */
47
ABT_pool* margo_get_handler_pool(margo_instance_id mid);
48 49 50

/**
 * Forward an RPC request to a remote host
Philip Carns's avatar
Philip Carns committed
51
 * @param [in] mid Margo instance
52 53 54 55 56
 * @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(
57
    margo_instance_id mid,
58 59 60 61 62
    hg_handle_t handle,
    void *in_struct);

/** 
 * Perform a bulk transfer
Philip Carns's avatar
Philip Carns committed
63
 * @param [in] mid Margo instance
64 65 66 67 68 69 70 71 72 73 74
 * @param [in] context Mercury bulk context
 * @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(
75
    margo_instance_id mid,
76 77 78 79 80 81 82 83 84
    hg_bulk_context_t *context,
    hg_bulk_op_t op,
    na_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);

Philip Carns's avatar
Philip Carns committed
85 86 87 88
/**
 * Retrive the Margo instance that has been associated with a Mercury class
 * @param [in] class Mercury class
 * @returns Margo instance on success, NULL on error
89 90 91
 */
margo_instance_id margo_hg_class_to_instance(hg_class_t *class);

92 93 94 95 96
/**
 * macro that defines a function to glue an RPC handler to a fiber
 * @param [in] __name name of handler function
 */
#define DEFINE_ARGO_RPC_HANDLER(__name) \
97
hg_return_t __name##_handler(hg_handle_t handle) { \
98 99
    int __ret; \
    ABT_pool* __pool; \
100 101
    margo_instance_id __mid; \
    struct hg_info *__hgi; \
102 103 104
    hg_handle_t* __handle = malloc(sizeof(*__handle)); \
    if(!__handle) return(HG_NOMEM_ERROR); \
    *__handle = handle; \
105 106
    __hgi = HG_Get_info(handle); \
    __mid = margo_hg_class_to_instance(__hgi->hg_class); \
107
    __pool = margo_get_handler_pool(__mid); \
108 109 110 111 112 113 114
    __ret = ABT_thread_create(*__pool, __name, __handle, ABT_THREAD_ATTR_NULL, NULL); \
    if(__ret != 0) { \
        return(HG_NOMEM_ERROR); \
    } \
    return(HG_SUCCESS); \
}

Philip Carns's avatar
Philip Carns committed
115 116 117 118 119
/**
 * macro that declares the prototype for a function to glue an RPC 
 * handler to a fiber
 * @param [in] __name name of handler function
 */
120 121
#define DECLARE_ARGO_RPC_HANDLER(__name) hg_return_t __name##_handler(hg_handle_t handle);

122 123 124 125
#ifdef __cplusplus
}
#endif

126
#endif /* __MARGO */