margo.c 35.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11

/*
 * (C) 2015 The University of Chicago
 * 
 * See COPYRIGHT in top-level directory.
 */

#include <assert.h>
#include <unistd.h>
#include <errno.h>
#include <abt.h>
Matthieu Dorier's avatar
Matthieu Dorier committed
12 13 14

#include <margo-config.h>
#ifdef HAVE_ABT_SNOOZER
15
#include <abt-snoozer.h>
Matthieu Dorier's avatar
Matthieu Dorier committed
16
#endif
17
#include <time.h>
Philip Carns's avatar
bug fix  
Philip Carns committed
18
#include <math.h>
19 20

#include "margo.h"
21
#include "margo-timer.h"
Philip Carns's avatar
Philip Carns committed
22
#include "utlist.h"
Philip Carns's avatar
Philip Carns committed
23
#include "uthash.h"
24

25
#define DEFAULT_MERCURY_PROGRESS_TIMEOUT_UB 100 /* 100 milliseconds */
Shane Snyder's avatar
Shane Snyder committed
26
#define DEFAULT_MERCURY_HANDLE_CACHE_SIZE 32
27

Philip Carns's avatar
Philip Carns committed
28 29 30 31 32 33 34 35 36 37
struct mplex_key
{
    hg_id_t id;
    uint32_t mplex_id;
};

struct mplex_element
{
    struct mplex_key key;
    ABT_pool pool;
38 39
    void* user_data;
    void(*user_free_callback)(void*);
Philip Carns's avatar
Philip Carns committed
40 41 42
    UT_hash_handle hh;
};

Philip Carns's avatar
Philip Carns committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
struct diag_data
{
    double min;
    double max;
    double cumulative;
    int count;
};

#define __DIAG_UPDATE(__data, __time)\
do {\
    __data.count++; \
    __data.cumulative += (__time); \
    if((__time) > __data.max) __data.max = (__time); \
    if((__time) < __data.min) __data.min = (__time); \
} while(0)

Shane Snyder's avatar
Shane Snyder committed
59 60 61 62 63 64 65
struct margo_handle_cache_el
{
    hg_handle_t handle;
    UT_hash_handle hh; /* in-use hash link */
    struct margo_handle_cache_el *next; /* free list link */
};

66 67
struct margo_instance
{
Shane Snyder's avatar
Shane Snyder committed
68
    /* mercury/argobots state */
69 70
    hg_context_t *hg_context;
    hg_class_t *hg_class;
71 72 73
    ABT_pool handler_pool;
    ABT_pool progress_pool;

74
    /* internal to margo for this particular instance */
Shane Snyder's avatar
Shane Snyder committed
75
    int margo_init;
76
    int abt_init;
77 78
    ABT_thread hg_progress_tid;
    int hg_progress_shutdown_flag;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
79
    ABT_xstream progress_xstream;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
80 81 82
    int owns_progress_pool;
    ABT_xstream *rpc_xstreams;
    int num_handler_pool_threads;
83
    unsigned int hg_progress_timeout_ub;
84 85 86

    /* control logic for callers waiting on margo to be finalized */
    int finalize_flag;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
87
    int refcount;
88 89 90
    ABT_mutex finalize_mutex;
    ABT_cond finalize_cond;

Philip Carns's avatar
Philip Carns committed
91 92
    /* hash table to track multiplexed rpcs registered with margo */
    struct mplex_element *mplex_table;
Philip Carns's avatar
Philip Carns committed
93

Shane Snyder's avatar
Shane Snyder committed
94 95 96
    /* linked list of free hg handles and a hash of in-use handles */
    struct margo_handle_cache_el *free_handle_list;
    struct margo_handle_cache_el *used_handle_hash;
97
    ABT_mutex handle_cache_mtx; /* mutex protecting access to above caches */
Shane Snyder's avatar
Shane Snyder committed
98

Philip Carns's avatar
Philip Carns committed
99 100 101 102 103 104 105 106 107 108 109
    /* optional diagnostics data tracking */
    /* NOTE: technically the following fields are subject to races if they
     * are updated from more than one thread at a time.  We will be careful
     * to only update the counters from the progress_fn,
     * which will serialize access.
     */
    int diag_enabled;
    struct diag_data diag_trigger_elapsed;
    struct diag_data diag_progress_elapsed_zero_timeout;
    struct diag_data diag_progress_elapsed_nonzero_timeout;
    struct diag_data diag_progress_timeout_value;
110 111
};

112 113 114 115 116 117
struct margo_rpc_data
{
	margo_instance_id mid;
	void* user_data;
	void (*user_free_callback)(void *);
};
118

119
static void hg_progress_fn(void* foo);
120
static void margo_rpc_data_free(void* ptr);
121

Shane Snyder's avatar
Shane Snyder committed
122 123 124 125 126 127
static hg_return_t margo_handle_cache_init(margo_instance_id mid);
static void margo_handle_cache_destroy(margo_instance_id mid);
static hg_return_t margo_handle_cache_get(margo_instance_id mid,
    hg_addr_t addr, hg_id_t id, hg_handle_t *handle);
static hg_return_t margo_handle_cache_put(margo_instance_id mid,
    hg_handle_t handle);
128 129
static void delete_multiplexing_hash(margo_instance_id mid);

Shane Snyder's avatar
Shane Snyder committed
130

Shane Snyder's avatar
Shane Snyder committed
131
margo_instance_id margo_init(const char *addr_str, int mode,
Shane Snyder's avatar
Shane Snyder committed
132
    int use_progress_thread, int rpc_thread_count)
133
{
Jonathan Jenkins's avatar
Jonathan Jenkins committed
134 135 136 137 138
    ABT_xstream progress_xstream = ABT_XSTREAM_NULL;
    ABT_pool progress_pool = ABT_POOL_NULL;
    ABT_xstream *rpc_xstreams = NULL;
    ABT_xstream rpc_xstream = ABT_XSTREAM_NULL;
    ABT_pool rpc_pool = ABT_POOL_NULL;
Shane Snyder's avatar
Shane Snyder committed
139 140
    hg_class_t *hg_class = NULL;
    hg_context_t *hg_context = NULL;
Shane Snyder's avatar
Shane Snyder committed
141
    int listen_flag = (mode == MARGO_CLIENT_MODE) ? HG_FALSE : HG_TRUE;
142
    int abt_init = 0;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
143
    int i;
Shane Snyder's avatar
Shane Snyder committed
144 145 146
    int ret;
    struct margo_instance *mid = MARGO_INSTANCE_NULL;

Shane Snyder's avatar
Shane Snyder committed
147
    if(mode != MARGO_CLIENT_MODE && mode != MARGO_SERVER_MODE) goto err;
Shane Snyder's avatar
Shane Snyder committed
148

149 150 151 152 153 154
    if (ABT_initialized() == ABT_ERR_UNINITIALIZED)
    {
        ret = ABT_init(0, NULL); /* XXX: argc/argv not currently used by ABT ... */
        if(ret != 0) goto err;
        abt_init = 1;
    }
Shane Snyder's avatar
Shane Snyder committed
155

156
    /* set caller (self) ES to idle without polling */
Matthieu Dorier's avatar
Matthieu Dorier committed
157
#ifdef HAVE_ABT_SNOOZER
Shane Snyder's avatar
Shane Snyder committed
158 159
    ret = ABT_snoozer_xstream_self_set();
    if(ret != 0) goto err;
Matthieu Dorier's avatar
Matthieu Dorier committed
160
#endif
Jonathan Jenkins's avatar
Jonathan Jenkins committed
161 162 163

    if (use_progress_thread)
    {
Matthieu Dorier's avatar
Matthieu Dorier committed
164
#ifdef HAVE_ABT_SNOOZER
Jonathan Jenkins's avatar
Jonathan Jenkins committed
165
        ret = ABT_snoozer_xstream_create(1, &progress_pool, &progress_xstream);
Matthieu Dorier's avatar
Matthieu Dorier committed
166 167 168 169 170 171 172
		if (ret != ABT_SUCCESS) goto err;
#else
		ret = ABT_xstream_create(ABT_SCHED_NULL, &progress_xstream);
		if (ret != ABT_SUCCESS) goto err;
		ret = ABT_xstream_get_main_pools(progress_xstream, 1, &progress_pool);
		if (ret != ABT_SUCCESS) goto err;
#endif
Jonathan Jenkins's avatar
Jonathan Jenkins committed
173 174 175 176 177 178 179 180 181
    }
    else
    {
        ret = ABT_xstream_self(&progress_xstream);
        if (ret != ABT_SUCCESS) goto err;
        ret = ABT_xstream_get_main_pools(progress_xstream, 1, &progress_pool);
        if (ret != ABT_SUCCESS) goto err;
    }

182
    if (rpc_thread_count > 0)
Jonathan Jenkins's avatar
Jonathan Jenkins committed
183
    {
184 185
        rpc_xstreams = calloc(rpc_thread_count, sizeof(*rpc_xstreams));
        if (rpc_xstreams == NULL) goto err;
Matthieu Dorier's avatar
Matthieu Dorier committed
186
#ifdef HAVE_ABT_SNOOZER
187 188 189
        ret = ABT_snoozer_xstream_create(rpc_thread_count, &rpc_pool,
                rpc_xstreams);
        if (ret != ABT_SUCCESS) goto err;
Matthieu Dorier's avatar
Matthieu Dorier committed
190
#else
191 192 193 194 195
        int j;
        ret = ABT_pool_create_basic(ABT_POOL_FIFO, ABT_POOL_ACCESS_MPMC, ABT_TRUE, &rpc_pool);
        if (ret != ABT_SUCCESS) goto err;
        for(j=0; j<rpc_thread_count; j++) {
            ret = ABT_xstream_create(ABT_SCHED_NULL, rpc_xstreams+j);
Shane Snyder's avatar
Shane Snyder committed
196 197
            if (ret != ABT_SUCCESS) goto err;
        }
198 199 200 201 202 203 204 205 206 207 208 209
#endif
    }
    else if (rpc_thread_count == 0)
    {
        ret = ABT_xstream_self(&rpc_xstream);
        if (ret != ABT_SUCCESS) goto err;
        ret = ABT_xstream_get_main_pools(rpc_xstream, 1, &rpc_pool);
        if (ret != ABT_SUCCESS) goto err;
    }
    else
    {
        rpc_pool = progress_pool;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
210 211
    }

Shane Snyder's avatar
Shane Snyder committed
212 213 214 215 216 217
    hg_class = HG_Init(addr_str, listen_flag);
    if(!hg_class) goto err;

    hg_context = HG_Context_create(hg_class);
    if(!hg_context) goto err;

Jonathan Jenkins's avatar
Jonathan Jenkins committed
218 219 220
    mid = margo_init_pool(progress_pool, rpc_pool, hg_context);
    if (mid == MARGO_INSTANCE_NULL) goto err;

Shane Snyder's avatar
Shane Snyder committed
221
    mid->margo_init = 1;
222
    mid->abt_init = abt_init;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
223 224 225
    mid->owns_progress_pool = use_progress_thread;
    mid->progress_xstream = progress_xstream;
    mid->num_handler_pool_threads = rpc_thread_count < 0 ? 0 : rpc_thread_count;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
226
    mid->rpc_xstreams = rpc_xstreams;
227

Jonathan Jenkins's avatar
Jonathan Jenkins committed
228 229 230
    return mid;

err:
Shane Snyder's avatar
Shane Snyder committed
231 232 233 234 235 236 237
    if(mid)
    {
        margo_timer_instance_finalize(mid);
        ABT_mutex_free(&mid->finalize_mutex);
        ABT_cond_free(&mid->finalize_cond);
        free(mid);
    }
Jonathan Jenkins's avatar
Jonathan Jenkins committed
238 239 240 241 242 243 244 245 246 247 248 249 250 251
    if (use_progress_thread && progress_xstream != ABT_XSTREAM_NULL)
    {
        ABT_xstream_join(progress_xstream);
        ABT_xstream_free(&progress_xstream);
    }
    if (rpc_thread_count > 0 && rpc_xstreams != NULL)
    {
        for (i = 0; i < rpc_thread_count; i++)
        {
            ABT_xstream_join(rpc_xstreams[i]);
            ABT_xstream_free(&rpc_xstreams[i]);
        }
        free(rpc_xstreams);
    }
Shane Snyder's avatar
Shane Snyder committed
252 253 254 255
    if(hg_context)
        HG_Context_destroy(hg_context);
    if(hg_class)
        HG_Finalize(hg_class);
256 257
    if(abt_init)
        ABT_finalize();
Jonathan Jenkins's avatar
Jonathan Jenkins committed
258 259 260 261
    return MARGO_INSTANCE_NULL;
}

margo_instance_id margo_init_pool(ABT_pool progress_pool, ABT_pool handler_pool,
Jonathan Jenkins's avatar
Jonathan Jenkins committed
262
    hg_context_t *hg_context)
263 264
{
    int ret;
Shane Snyder's avatar
Shane Snyder committed
265
    hg_return_t hret;
266 267 268
    struct margo_instance *mid;

    mid = malloc(sizeof(*mid));
Shane Snyder's avatar
Shane Snyder committed
269
    if(!mid) goto err;
270
    memset(mid, 0, sizeof(*mid));
271

272 273 274
    ABT_mutex_create(&mid->finalize_mutex);
    ABT_cond_create(&mid->finalize_cond);

275 276
    mid->progress_pool = progress_pool;
    mid->handler_pool = handler_pool;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
277
    mid->hg_class = HG_Context_get_class(hg_context);
278
    mid->hg_context = hg_context;
279
    mid->hg_progress_timeout_ub = DEFAULT_MERCURY_PROGRESS_TIMEOUT_UB;
280
    mid->mplex_table = NULL;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
281
    mid->refcount = 1;
282

283
    ret = margo_timer_instance_init(mid);
Shane Snyder's avatar
Shane Snyder committed
284
    if(ret != 0) goto err;
285

Shane Snyder's avatar
Shane Snyder committed
286 287 288 289
    /* initialize the handle cache */
    hret = margo_handle_cache_init(mid);
    if(hret != HG_SUCCESS) goto err;

290
    ret = ABT_thread_create(mid->progress_pool, hg_progress_fn, mid, 
291
        ABT_THREAD_ATTR_NULL, &mid->hg_progress_tid);
Shane Snyder's avatar
Shane Snyder committed
292 293
    if(ret != 0) goto err;

Shane Snyder's avatar
Shane Snyder committed
294 295
    return mid;

Shane Snyder's avatar
Shane Snyder committed
296 297
err:
    if(mid)
298
    {
Shane Snyder's avatar
Shane Snyder committed
299
        margo_handle_cache_destroy(mid);
Shane Snyder's avatar
Shane Snyder committed
300 301 302
        margo_timer_instance_finalize(mid);
        ABT_mutex_free(&mid->finalize_mutex);
        ABT_cond_free(&mid->finalize_cond);
303
        free(mid);
304
    }
Shane Snyder's avatar
Shane Snyder committed
305
    return MARGO_INSTANCE_NULL;
306 307
}

Jonathan Jenkins's avatar
Jonathan Jenkins committed
308 309 310 311 312 313
static void margo_cleanup(margo_instance_id mid)
{
    int i;

    margo_timer_instance_finalize(mid);

314 315 316
    /* delete the hash used for multiplexing */
    delete_multiplexing_hash(mid);

Jonathan Jenkins's avatar
Jonathan Jenkins committed
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
    ABT_mutex_free(&mid->finalize_mutex);
    ABT_cond_free(&mid->finalize_cond);

    if (mid->owns_progress_pool)
    {
        ABT_xstream_join(mid->progress_xstream);
        ABT_xstream_free(&mid->progress_xstream);
    }

    if (mid->num_handler_pool_threads > 0)
    {
        for (i = 0; i < mid->num_handler_pool_threads; i++)
        {
            ABT_xstream_join(mid->rpc_xstreams[i]);
            ABT_xstream_free(&mid->rpc_xstreams[i]);
        }
        free(mid->rpc_xstreams);
    }

Shane Snyder's avatar
Shane Snyder committed
336 337
    margo_handle_cache_destroy(mid);

Shane Snyder's avatar
Shane Snyder committed
338 339 340 341 342 343
    if (mid->margo_init)
    {
        if (mid->hg_context)
            HG_Context_destroy(mid->hg_context);
        if (mid->hg_class)
            HG_Finalize(mid->hg_class);
344 345
        if (mid->abt_init)
            ABT_finalize();
Shane Snyder's avatar
Shane Snyder committed
346 347
    }

Jonathan Jenkins's avatar
Jonathan Jenkins committed
348 349 350
    free(mid);
}

351
void margo_finalize(margo_instance_id mid)
352
{
Jonathan Jenkins's avatar
Jonathan Jenkins committed
353
    int do_cleanup;
354

355
    /* tell progress thread to wrap things up */
356
    mid->hg_progress_shutdown_flag = 1;
357 358

    /* wait for it to shutdown cleanly */
359 360
    ABT_thread_join(mid->hg_progress_tid);
    ABT_thread_free(&mid->hg_progress_tid);
361

362 363 364 365
    ABT_mutex_lock(mid->finalize_mutex);
    mid->finalize_flag = 1;
    ABT_cond_broadcast(mid->finalize_cond);

Jonathan Jenkins's avatar
Jonathan Jenkins committed
366 367
    mid->refcount--;
    do_cleanup = mid->refcount == 0;
368

Jonathan Jenkins's avatar
Jonathan Jenkins committed
369 370 371 372 373 374 375
    ABT_mutex_unlock(mid->finalize_mutex);

    /* if there was noone waiting on the finalize at the time of the finalize
     * broadcast, then we're safe to clean up. Otherwise, let the finalizer do
     * it */
    if (do_cleanup)
        margo_cleanup(mid);
376 377 378 379 380 381

    return;
}

void margo_wait_for_finalize(margo_instance_id mid)
{
Jonathan Jenkins's avatar
Jonathan Jenkins committed
382
    int do_cleanup;
383 384 385

    ABT_mutex_lock(mid->finalize_mutex);

Jonathan Jenkins's avatar
Jonathan Jenkins committed
386
        mid->refcount++;
387 388 389 390
            
        while(!mid->finalize_flag)
            ABT_cond_wait(mid->finalize_cond, mid->finalize_mutex);

Jonathan Jenkins's avatar
Jonathan Jenkins committed
391 392 393
        mid->refcount--;
        do_cleanup = mid->refcount == 0;

394
    ABT_mutex_unlock(mid->finalize_mutex);
Jonathan Jenkins's avatar
Jonathan Jenkins committed
395 396 397 398

    if (do_cleanup)
        margo_cleanup(mid);

399 400 401
    return;
}

402 403
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)
404
{
405 406 407
	struct margo_rpc_data* margo_data;
    hg_return_t hret;
    hg_id_t id;
408

409 410 411
    id = HG_Register_name(mid->hg_class, func_name, in_proc_cb, out_proc_cb, rpc_cb);
    if(id <= 0)
        return(0);
412

413 414 415 416 417 418 419 420 421 422 423 424
	/* register the margo data with the RPC */
    margo_data = (struct margo_rpc_data*)HG_Registered_data(mid->hg_class, id);
    if(!margo_data)
    {
        margo_data = (struct margo_rpc_data*)malloc(sizeof(struct margo_rpc_data));
        if(!margo_data)
            return(0);
        margo_data->mid = mid;
        margo_data->user_data = NULL;
        margo_data->user_free_callback = NULL;
        hret = HG_Register_data(mid->hg_class, id, margo_data, margo_rpc_data_free);
        if(hret != HG_SUCCESS)
425
        {
426 427
            free(margo_data);
            return(0);
428
        }
429 430
    }

431
	return(id);
432 433
}

434 435 436
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)
437
{
438 439 440
    struct mplex_key key;
    struct mplex_element *element;
    hg_id_t id;
441

442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
    id = margo_register_name(mid, func_name, in_proc_cb, out_proc_cb, rpc_cb);
    if(id <= 0)
        return(0);

    /* nothing to do, we'll let the handler pool take this directly */
    if(mplex_id == MARGO_DEFAULT_MPLEX_ID)
        return(id);

    memset(&key, 0, sizeof(key));
    key.id = id;
    key.mplex_id = mplex_id;

    HASH_FIND(hh, mid->mplex_table, &key, sizeof(key), element);
    if(element)
        return(id);

    element = malloc(sizeof(*element));
    if(!element)
        return(0);
    element->key = key;
    element->pool = pool;

    HASH_ADD(hh, mid->mplex_table, key, sizeof(key), element);

    return(id);
467 468
}

469 470
hg_return_t margo_registered_name(margo_instance_id mid, const char *func_name,
    hg_id_t *id, hg_bool_t *flag)
471
{
472
    return(HG_Registered_name(mid->hg_class, func_name, id, flag));
473 474
}

475 476 477 478 479 480 481
hg_return_t margo_register_data(
    margo_instance_id mid,
    hg_id_t id,
    void *data,
    void (*free_callback)(void *)) 
{
	struct margo_rpc_data* margo_data 
482
		= (struct margo_rpc_data*) HG_Registered_data(mid->hg_class, id);
483
	if(!margo_data) return HG_OTHER_ERROR;
484 485 486
    if(margo_data->user_data && margo_data->user_free_callback) {
        (margo_data->user_free_callback)(margo_data->user_data);
    }
487 488 489 490 491 492 493 494 495 496 497 498 499
	margo_data->user_data = data;
	margo_data->user_free_callback = free_callback;
	return HG_SUCCESS;
}

void* margo_registered_data(margo_instance_id mid, hg_id_t id)
{
	struct margo_rpc_data* data
		= (struct margo_rpc_data*) HG_Registered_data(margo_get_class(mid), id);
	if(!data) return NULL;
	else return data->user_data;
}

500 501 502 503
hg_return_t margo_registered_disable_response(
    margo_instance_id mid,
    hg_id_t id,
    int disable_flag)
504
{
505
    return(HG_Registered_disable_response(mid->hg_class, id, disable_flag));
506
}
507

508
struct lookup_cb_evt
509
{
510
    hg_return_t hret;
511 512 513 514 515 516
    hg_addr_t addr;
};

static hg_return_t margo_addr_lookup_cb(const struct hg_cb_info *info)
{
    struct lookup_cb_evt evt;
517
    evt.hret = info->ret;
518
    evt.addr = info->info.lookup.addr;
Matthieu Dorier's avatar
Matthieu Dorier committed
519
    ABT_eventual eventual = (ABT_eventual)(info->arg);
520 521

    /* propagate return code out through eventual */
Matthieu Dorier's avatar
Matthieu Dorier committed
522
    ABT_eventual_set(eventual, &evt, sizeof(evt));
523

524 525 526
    return(HG_SUCCESS);
}

527 528 529 530
hg_return_t margo_addr_lookup(
    margo_instance_id mid,
    const char   *name,
    hg_addr_t    *addr)
531
{
532
    hg_return_t hret;
533 534 535
    struct lookup_cb_evt *evt;
    ABT_eventual eventual;
    int ret;
536

537 538 539 540 541 542
    ret = ABT_eventual_create(sizeof(*evt), &eventual);
    if(ret != 0)
    {
        return(HG_NOMEM_ERROR);        
    }

543
    hret = HG_Addr_lookup(mid->hg_context, margo_addr_lookup_cb,
Matthieu Dorier's avatar
Matthieu Dorier committed
544
        (void*)eventual, name, HG_OP_ID_IGNORE);
545
    if(hret == HG_SUCCESS)
546 547 548
    {
        ABT_eventual_wait(eventual, (void**)&evt);
        *addr = evt->addr;
549
        hret = evt->hret;
550 551 552 553
    }

    ABT_eventual_free(&eventual);

554
    return(hret);
555 556 557 558 559
}

hg_return_t margo_addr_free(
    margo_instance_id mid,
    hg_addr_t addr)
560
{
561 562
    return(HG_Addr_free(mid->hg_class, addr));
}
563

564 565 566 567 568
hg_return_t margo_addr_self(
    margo_instance_id mid,
    hg_addr_t *addr)
{
    return(HG_Addr_self(mid->hg_class, addr));
569 570
}

571 572 573 574 575 576 577 578 579
hg_return_t margo_addr_dup(
    margo_instance_id mid,
    hg_addr_t addr,
    hg_addr_t *new_addr)
{
    return(HG_Addr_dup(mid->hg_class, addr, new_addr));
}

hg_return_t margo_addr_to_string(
580
    margo_instance_id mid,
581 582 583 584 585 586 587 588 589 590
    char *buf,
    hg_size_t *buf_size,
    hg_addr_t addr)
{
    return(HG_Addr_to_string(mid->hg_class, buf, buf_size, addr));
}

hg_return_t margo_create(margo_instance_id mid, hg_addr_t addr,
    hg_id_t id, hg_handle_t *handle)
{
591
    hg_return_t hret = HG_OTHER_ERROR;
Shane Snyder's avatar
Shane Snyder committed
592 593 594 595 596 597 598 599

    /* look for a handle to reuse */
    hret = margo_handle_cache_get(mid, addr, id, handle);
    if(hret != HG_SUCCESS)
    {
        /* else try creating a new handle */
        hret = HG_Create(mid->hg_context, addr, id, handle);
    }
600

Shane Snyder's avatar
Shane Snyder committed
601
    return hret;
602 603
}

604
hg_return_t margo_destroy(hg_handle_t handle)
605
{
606
    margo_instance_id mid;
607
    hg_return_t hret = HG_OTHER_ERROR;
Shane Snyder's avatar
Shane Snyder committed
608

609 610 611
    /* use the handle to get the associated mid */
    mid = margo_hg_handle_get_instance(handle);

Shane Snyder's avatar
Shane Snyder committed
612 613 614 615 616 617 618
    /* recycle this handle if it came from the handle cache */
    hret = margo_handle_cache_put(mid, handle);
    if(hret != HG_SUCCESS)
    {
        /* else destroy the handle manually */
        hret = HG_Destroy(handle);
    }
619

Shane Snyder's avatar
Shane Snyder committed
620
    return hret;
621 622 623 624 625
}

static hg_return_t margo_cb(const struct hg_cb_info *info)
{
    hg_return_t hret = info->ret;
Matthieu Dorier's avatar
Matthieu Dorier committed
626
    ABT_eventual eventual = (ABT_eventual)(info->arg);
627 628

    /* propagate return code out through eventual */
Matthieu Dorier's avatar
Matthieu Dorier committed
629
    ABT_eventual_set(eventual, &hret, sizeof(hret));
630 631 632 633 634 635 636
    
    return(HG_SUCCESS);
}

hg_return_t margo_forward(
    hg_handle_t handle,
    void *in_struct)
Matthieu Dorier's avatar
Matthieu Dorier committed
637 638 639 640 641 642 643 644 645 646 647 648 649
{
	hg_return_t hret;
	margo_request req;
	hret = margo_iforward(handle, in_struct, &req);
	if(hret != HG_SUCCESS) 
		return hret;
	return margo_wait(req);
}

hg_return_t margo_iforward(
    hg_handle_t handle,
    void *in_struct,
    margo_request* req)
650 651
{
    hg_return_t hret = HG_TIMEOUT;
652
    ABT_eventual eventual;
653
    int ret;
654 655 656 657 658 659 660

    ret = ABT_eventual_create(sizeof(hret), &eventual);
    if(ret != 0)
    {
        return(HG_NOMEM_ERROR);        
    }

Matthieu Dorier's avatar
Matthieu Dorier committed
661
    *req = eventual;
662

Matthieu Dorier's avatar
Matthieu Dorier committed
663
    return HG_Forward(handle, margo_cb, (void*)eventual, in_struct);
Matthieu Dorier's avatar
Matthieu Dorier committed
664
}
665

Matthieu Dorier's avatar
Matthieu Dorier committed
666 667 668 669
hg_return_t margo_wait(margo_request req)
{
	hg_return_t* waited_hret;
	hg_return_t  hret;
670

Matthieu Dorier's avatar
Matthieu Dorier committed
671 672 673 674
    ABT_eventual_wait(req, (void**)&waited_hret);
	hret = *waited_hret;
    ABT_eventual_free(&req);
	
675
    return(hret);
676 677
}

Matthieu Dorier's avatar
Matthieu Dorier committed
678 679 680 681 682
int margo_test(margo_request req, int* flag)
{
    return ABT_eventual_test(req, NULL, flag);
}

683 684 685 686
typedef struct
{
    hg_handle_t handle;
} margo_forward_timeout_cb_dat;
687

688 689 690 691 692 693 694 695 696 697 698
static void margo_forward_timeout_cb(void *arg)
{
    margo_forward_timeout_cb_dat *timeout_cb_dat =
        (margo_forward_timeout_cb_dat *)arg;

    /* cancel the Mercury op if the forward timed out */
    HG_Cancel(timeout_cb_dat->handle);
    return;
}

hg_return_t margo_forward_timed(
699
    hg_handle_t handle,
700 701
    void *in_struct,
    double timeout_ms)
702 703
{
    int ret;
704
    hg_return_t hret;
705
    margo_instance_id mid;
706
    ABT_eventual eventual;
707
    hg_return_t* waited_hret;
708 709
    margo_timer_t forward_timer;
    margo_forward_timeout_cb_dat timeout_cb_dat;
710 711 712 713 714 715 716

    ret = ABT_eventual_create(sizeof(hret), &eventual);
    if(ret != 0)
    {
        return(HG_NOMEM_ERROR);        
    }

717 718 719
    /* use the handle to get the associated mid */
    mid = margo_hg_handle_get_instance(handle);

720 721 722 723 724
    /* set a timer object to expire when this forward times out */
    timeout_cb_dat.handle = handle;
    margo_timer_init(mid, &forward_timer, margo_forward_timeout_cb,
        &timeout_cb_dat, timeout_ms);

Matthieu Dorier's avatar
Matthieu Dorier committed
725
    hret = HG_Forward(handle, margo_cb, (void*)eventual, in_struct);
726
    if(hret == HG_SUCCESS)
Jonathan Jenkins's avatar
Jonathan Jenkins committed
727 728 729 730 731
    {
        ABT_eventual_wait(eventual, (void**)&waited_hret);
        hret = *waited_hret;
    }

732 733 734 735 736 737 738 739
    /* convert HG_CANCELED to HG_TIMEOUT to indicate op timed out */
    if(hret == HG_CANCELED)
        hret = HG_TIMEOUT;

    /* remove timer if it is still in place (i.e., not timed out) */
    if(hret != HG_TIMEOUT)
        margo_timer_destroy(mid, &forward_timer);

Jonathan Jenkins's avatar
Jonathan Jenkins committed
740 741 742 743 744 745 746 747
    ABT_eventual_free(&eventual);

    return(hret);
}

hg_return_t margo_respond(
    hg_handle_t handle,
    void *out_struct)
Matthieu Dorier's avatar
Matthieu Dorier committed
748 749 750 751 752 753 754 755 756 757 758 759 760
{
    hg_return_t hret;
    margo_request req;
    hret = margo_irespond(handle,out_struct,&req);
    if(hret != HG_SUCCESS)
        return hret;
    return margo_wait(req);
}

hg_return_t margo_irespond(
    hg_handle_t handle,
    void *out_struct,
    margo_request* req)
Jonathan Jenkins's avatar
Jonathan Jenkins committed
761 762 763 764
{
    ABT_eventual eventual;
    int ret;

Matthieu Dorier's avatar
Matthieu Dorier committed
765
    ret = ABT_eventual_create(sizeof(hg_return_t), &eventual);
Jonathan Jenkins's avatar
Jonathan Jenkins committed
766 767 768 769 770
    if(ret != 0)
    {
        return(HG_NOMEM_ERROR);
    }

Matthieu Dorier's avatar
Matthieu Dorier committed
771
    *req = eventual;
772

Matthieu Dorier's avatar
Matthieu Dorier committed
773
    return HG_Respond(handle, margo_cb, (void*)eventual, out_struct);
774 775
}

776 777 778 779 780 781 782
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)
783
{
784 785 786
    return(HG_Bulk_create(mid->hg_class, count,
        buf_ptrs, buf_sizes, flags, handle));
}
787

788 789 790 791
hg_return_t margo_bulk_free(
    hg_bulk_t handle)
{
    return(HG_Bulk_free(handle));
792 793
}

794 795 796 797 798 799 800 801
hg_return_t margo_bulk_deserialize(
    margo_instance_id mid,
    hg_bulk_t *handle,
    const void *buf,
    hg_size_t buf_size)
{
    return(HG_Bulk_deserialize(mid->hg_class, handle, buf, buf_size));
}
802

803
hg_return_t margo_bulk_transfer(
804
    margo_instance_id mid,
805
    hg_bulk_op_t op,
806
    hg_addr_t origin_addr,
807 808 809 810
    hg_bulk_t origin_handle,
    size_t origin_offset,
    hg_bulk_t local_handle,
    size_t local_offset,
811
    size_t size)
Matthieu Dorier's avatar
Matthieu Dorier committed
812 813 814 815
{  
    margo_request req;
    hg_return_t hret = margo_bulk_itransfer(mid,op,origin_addr,
                          origin_handle, origin_offset, local_handle,
Matthieu Dorier's avatar
Matthieu Dorier committed
816
                          local_offset, size, &req);
Matthieu Dorier's avatar
Matthieu Dorier committed
817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
    if(hret != HG_SUCCESS)
        return hret;
    return margo_wait(req);
}

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)
832 833 834 835 836 837 838 839 840 841 842 843
{
    hg_return_t hret = HG_TIMEOUT;
    hg_return_t *waited_hret;
    ABT_eventual eventual;
    int ret;

    ret = ABT_eventual_create(sizeof(hret), &eventual);
    if(ret != 0)
    {
        return(HG_NOMEM_ERROR);        
    }

Matthieu Dorier's avatar
Matthieu Dorier committed
844
    *req = eventual;
845

Matthieu Dorier's avatar
Matthieu Dorier committed
846 847
    hret = HG_Bulk_transfer(mid->hg_context, margo_cb,
        (void*)eventual, op, origin_addr, origin_handle, origin_offset, local_handle,
848
        local_offset, size, HG_OP_ID_IGNORE);
849 850 851 852

    return(hret);
}

853 854 855 856
typedef struct
{
    ABT_mutex mutex;
    ABT_cond cond;
Shane Snyder's avatar
Shane Snyder committed
857
    char is_asleep;
858 859 860 861 862 863 864 865 866
} margo_thread_sleep_cb_dat;

static void margo_thread_sleep_cb(void *arg)
{
    margo_thread_sleep_cb_dat *sleep_cb_dat =
        (margo_thread_sleep_cb_dat *)arg;

    /* wake up the sleeping thread */
    ABT_mutex_lock(sleep_cb_dat->mutex);
867
    sleep_cb_dat->is_asleep = 0;
868 869 870 871 872 873 874
    ABT_cond_signal(sleep_cb_dat->cond);
    ABT_mutex_unlock(sleep_cb_dat->mutex);

    return;
}

void margo_thread_sleep(
875
    margo_instance_id mid,
876 877 878 879 880 881 882 883
    double timeout_ms)
{
    margo_timer_t sleep_timer;
    margo_thread_sleep_cb_dat sleep_cb_dat;

    /* set data needed for sleep callback */
    ABT_mutex_create(&(sleep_cb_dat.mutex));
    ABT_cond_create(&(sleep_cb_dat.cond));
884
    sleep_cb_dat.is_asleep = 1;
885 886

    /* initialize the sleep timer */
887
    margo_timer_init(mid, &sleep_timer, margo_thread_sleep_cb,
888 889 890 891
        &sleep_cb_dat, timeout_ms);

    /* yield thread for specified timeout */
    ABT_mutex_lock(sleep_cb_dat.mutex);
892 893
    while(sleep_cb_dat.is_asleep)
        ABT_cond_wait(sleep_cb_dat.cond, sleep_cb_dat.mutex);
894 895
    ABT_mutex_unlock(sleep_cb_dat.mutex);

Jonathan Jenkins's avatar
Jonathan Jenkins committed
896 897 898 899
    /* clean up */
    ABT_mutex_free(&sleep_cb_dat.mutex);
    ABT_cond_free(&sleep_cb_dat.cond);

900 901 902
    return;
}

903
ABT_pool* margo_get_handler_pool(margo_instance_id mid)
904
{
905 906
    return(&mid->handler_pool);
}
907

908 909 910 911
hg_context_t* margo_get_context(margo_instance_id mid)
{
    return(mid->hg_context);
}
912

913 914 915
hg_class_t* margo_get_class(margo_instance_id mid)
{
    return(mid->hg_class);
916
}
Philip Carns's avatar
Philip Carns committed
917

918
margo_instance_id margo_hg_handle_get_instance(hg_handle_t h)
919
{
920 921
	const struct hg_info* info = HG_Get_info(h);
	if(!info) return MARGO_INSTANCE_NULL;
922 923 924 925 926
    return margo_hg_info_get_instance(info);
}

margo_instance_id margo_hg_info_get_instance(const struct hg_info *info)
{
927 928 929 930
	struct margo_rpc_data* data = 
		(struct margo_rpc_data*) HG_Registered_data(info->hg_class, info->id);
	if(!data) return MARGO_INSTANCE_NULL;
	return data->mid;
931 932
}

Philip Carns's avatar
Philip Carns committed
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
int margo_lookup_mplex(margo_instance_id mid, hg_id_t id, uint32_t mplex_id, ABT_pool *pool)
{
    struct mplex_key key;
    struct mplex_element *element;

    if(!mplex_id)
    {
        *pool = mid->handler_pool;
        return(0);
    }

    memset(&key, 0, sizeof(key));
    key.id = id;
    key.mplex_id = mplex_id;

    HASH_FIND(hh, mid->mplex_table, &key, sizeof(key), element);
    if(!element)
        return(-1);

Philip Carns's avatar
Philip Carns committed
952 953
    assert(element->key.id == id && element->key.mplex_id == mplex_id);

Philip Carns's avatar
Philip Carns committed
954 955 956 957 958
    *pool = element->pool;

    return(0);
}

959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
int margo_register_data_mplex(margo_instance_id mid, hg_id_t id, uint32_t mplex_id, void* data, void (*free_callback)(void *))
{
    struct mplex_key key;
    struct mplex_element *element;

    memset(&key, 0, sizeof(key));
    key.id = id;
    key.mplex_id = mplex_id;

    HASH_FIND(hh, mid->mplex_table, &key, sizeof(key), element);
    if(!element)
        return -1;

    assert(element->key.id == id && element->key.mplex_id == mplex_id);

    if(element->user_data && element->user_free_callback)
        (element->user_free_callback)(element->user_data);

    element->user_data = data;
    element->user_free_callback = free_callback;

    return(0);
}

void* margo_registered_data_mplex(margo_instance_id mid, hg_id_t id, uint32_t mplex_id)
{
    struct mplex_key key;
    struct mplex_element *element;

    memset(&key, 0, sizeof(key));
    key.id = id;
    key.mplex_id = mplex_id;

    HASH_FIND(hh, mid->mplex_table, &key, sizeof(key), element);
    if(!element)
        return NULL;

    assert(element->key.id == id && element->key.mplex_id == mplex_id);

    return element->user_data;
}
1000
static void margo_rpc_data_free(void* ptr)
Philip Carns's avatar
Philip Carns committed
1001
{
1002 1003 1004 1005 1006 1007
	struct margo_rpc_data* data = (struct margo_rpc_data*) ptr;
	if(data->user_data && data->user_free_callback) {
		data->user_free_callback(data->user_data);
	}
	free(ptr);
}
Philip Carns's avatar
Philip Carns committed
1008

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
static void delete_multiplexing_hash(margo_instance_id mid)
{
    struct mplex_element *current_element, *tmp;

    HASH_ITER(hh, mid->mplex_table, current_element, tmp) {
        if(current_element->user_data && current_element->user_free_callback)
            (current_element->user_free_callback)(current_element->user_data);
        HASH_DEL(mid->mplex_table, current_element);
        free(current_element);
    }
}

1021 1022 1023 1024 1025 1026 1027
/* dedicated thread function to drive Mercury progress */
static void hg_progress_fn(void* foo)
{
    int ret;
    unsigned int actual_count;
    struct margo_instance *mid = (struct margo_instance *)foo;
    size_t size;
1028
    unsigned int hg_progress_timeout = mid->hg_progress_timeout_ub;
1029 1030
    double next_timer_exp;
    int trigger_happened;
1031 1032
    double tm1, tm2;
    int diag_enabled = 0;
1033

1034 1035 1036 1037
    while(!mid->hg_progress_shutdown_flag)
    {
        trigger_happened = 0;
        do {
1038 1039 1040 1041
            /* save value of instance diag variable, in case it is modified
             * while we are in loop 
             */
            diag_enabled = mid->diag_enabled;
1042

1043
            if(diag_enabled) tm1 = ABT_get_wtime();
1044
            ret = HG_Trigger(mid->hg_context, 0, 1, &actual_count);
1045 1046 1047 1048 1049
            if(diag_enabled)
            {
                tm2 = ABT_get_wtime();
                __DIAG_UPDATE(mid->diag_trigger_elapsed, (tm2-tm1));
            }
Philip Carns's avatar
Philip Carns committed
1050

1051 1052 1053
            if(ret == HG_SUCCESS && actual_count > 0)
                trigger_happened = 1;
        } while((ret == HG_SUCCESS) && actual_count && !mid->hg_progress_shutdown_flag);
Philip Carns's avatar
Philip Carns committed
1054

1055 1056
        if(trigger_happened)
            ABT_thread_yield();
Philip Carns's avatar
Philip Carns committed
1057

1058
        ABT_pool_get_size(mid->progress_pool, &size);
1059
        /* Are there any other threads executing in this pool that are *not*
1060 1061 1062 1063
         * blocked ?  If so then, we can't sleep here or else those threads 
         * will not get a chance to execute.
         * TODO: check is ABT_pool_get_size returns the number of ULT/tasks
         * that can be executed including this one, or not including this one.
1064
         */
1065
        if(size > 0)
1066 1067 1068 1069 1070 1071 1072 1073
        {
            /* TODO: this is being executed more than is necessary (i.e.
             * in cases where there are other legitimate ULTs eligible
             * for execution that are not blocking on any events, Margo
             * or otherwise). Maybe we need an abt scheduling tweak here