margo.c 38.8 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
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"
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

28 29 30
struct mplex_key
{
    hg_id_t id;
31
    uint8_t mplex_id;
32 33 34 35 36 37
};

struct mplex_element
{
    struct mplex_key key;
    ABT_pool pool;
38 39
    void* user_data;
    void(*user_free_callback)(void*);
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 68 69 70 71 72
struct margo_finalize_cb
{
    void(*callback)(void*);
    void* uargs;
    struct margo_finalize_cb* next;
};

73 74
struct margo_timer_list; /* defined in margo-timer.c */

75 76
struct margo_instance
{
Shane Snyder's avatar
Shane Snyder committed
77
    /* mercury/argobots state */
78 79
    hg_context_t *hg_context;
    hg_class_t *hg_class;
80 81 82
    ABT_pool handler_pool;
    ABT_pool progress_pool;

83
    /* internal to margo for this particular instance */
84
    int margo_init;
85
    int abt_init;
86 87
    ABT_thread hg_progress_tid;
    int hg_progress_shutdown_flag;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
88
    ABT_xstream progress_xstream;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
89 90 91
    int owns_progress_pool;
    ABT_xstream *rpc_xstreams;
    int num_handler_pool_threads;
92
    unsigned int hg_progress_timeout_ub;
93 94 95

    /* control logic for callers waiting on margo to be finalized */
    int finalize_flag;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
96
    int refcount;
97 98
    ABT_mutex finalize_mutex;
    ABT_cond finalize_cond;
99
    struct margo_finalize_cb* finalize_cb;
100

Matthieu Dorier's avatar
Matthieu Dorier committed
101 102 103 104
    /* control logic for shutting down */
    hg_id_t shutdown_rpc_id;
    int enable_remote_shutdown;

105 106 107
    /* timer data */
    struct margo_timer_list* timer_list;

108 109
    /* hash table to track multiplexed rpcs registered with margo */
    struct mplex_element *mplex_table;
Philip Carns's avatar
Philip Carns committed
110

Shane Snyder's avatar
Shane Snyder committed
111 112 113
    /* 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;
114
    ABT_mutex handle_cache_mtx; /* mutex protecting access to above caches */
Shane Snyder's avatar
Shane Snyder committed
115

Philip Carns's avatar
Philip Carns committed
116 117 118 119 120 121 122 123 124 125 126
    /* 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;
127 128
};

129 130 131 132 133 134
struct margo_rpc_data
{
	margo_instance_id mid;
	void* user_data;
	void (*user_free_callback)(void *);
};
135

Matthieu Dorier's avatar
Matthieu Dorier committed
136 137
MERCURY_GEN_PROC(margo_shutdown_out_t, ((int32_t)(ret)))

138
static void hg_progress_fn(void* foo);
139
static void margo_rpc_data_free(void* ptr);
Matthieu Dorier's avatar
Matthieu Dorier committed
140 141
static void remote_shutdown_ult(hg_handle_t handle);
DECLARE_MARGO_RPC_HANDLER(remote_shutdown_ult);
142

Shane Snyder's avatar
Shane Snyder committed
143 144 145 146 147 148
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);
149 150
static void delete_multiplexing_hash(margo_instance_id mid);

Shane Snyder's avatar
Shane Snyder committed
151

152
margo_instance_id margo_init(const char *addr_str, int mode,
153
    int use_progress_thread, int rpc_thread_count)
154
{
Jonathan Jenkins's avatar
Jonathan Jenkins committed
155 156 157 158 159
    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;
160 161
    hg_class_t *hg_class = NULL;
    hg_context_t *hg_context = NULL;
162
    int listen_flag = (mode == MARGO_CLIENT_MODE) ? HG_FALSE : HG_TRUE;
163
    int abt_init = 0;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
164
    int i;
165 166 167
    int ret;
    struct margo_instance *mid = MARGO_INSTANCE_NULL;

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

170 171 172 173 174 175
    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;
    }
176

177
    /* set caller (self) ES to idle without polling */
Matthieu Dorier's avatar
Matthieu Dorier committed
178
#ifdef HAVE_ABT_SNOOZER
179 180
    ret = ABT_snoozer_xstream_self_set();
    if(ret != 0) goto err;
Matthieu Dorier's avatar
Matthieu Dorier committed
181
#endif
Jonathan Jenkins's avatar
Jonathan Jenkins committed
182 183 184

    if (use_progress_thread)
    {
Matthieu Dorier's avatar
Matthieu Dorier committed
185
#ifdef HAVE_ABT_SNOOZER
Jonathan Jenkins's avatar
Jonathan Jenkins committed
186
        ret = ABT_snoozer_xstream_create(1, &progress_pool, &progress_xstream);
Matthieu Dorier's avatar
Matthieu Dorier committed
187 188 189 190 191 192 193
		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
194 195 196 197 198 199 200 201 202
    }
    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;
    }

203
    if (rpc_thread_count > 0)
Jonathan Jenkins's avatar
Jonathan Jenkins committed
204
    {
205 206
        rpc_xstreams = calloc(rpc_thread_count, sizeof(*rpc_xstreams));
        if (rpc_xstreams == NULL) goto err;
Matthieu Dorier's avatar
Matthieu Dorier committed
207
#ifdef HAVE_ABT_SNOOZER
208 209 210
        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
211
#else
212 213 214 215 216
        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);
217 218
            if (ret != ABT_SUCCESS) goto err;
        }
219 220 221 222 223 224 225 226 227 228 229 230
#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
231 232
    }

233 234 235 236 237 238
    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
239 240 241
    mid = margo_init_pool(progress_pool, rpc_pool, hg_context);
    if (mid == MARGO_INSTANCE_NULL) goto err;

242
    mid->margo_init = 1;
243
    mid->abt_init = abt_init;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
244 245 246
    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
247
    mid->rpc_xstreams = rpc_xstreams;
248

Jonathan Jenkins's avatar
Jonathan Jenkins committed
249 250 251
    return mid;

err:
252 253
    if(mid)
    {
254
        margo_timer_list_free(mid->timer_list);
255 256 257 258
        ABT_mutex_free(&mid->finalize_mutex);
        ABT_cond_free(&mid->finalize_cond);
        free(mid);
    }
Jonathan Jenkins's avatar
Jonathan Jenkins committed
259 260 261 262 263 264 265 266 267 268 269 270 271 272
    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);
    }
273 274 275 276
    if(hg_context)
        HG_Context_destroy(hg_context);
    if(hg_class)
        HG_Finalize(hg_class);
277 278
    if(abt_init)
        ABT_finalize();
Jonathan Jenkins's avatar
Jonathan Jenkins committed
279 280 281 282
    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
283
    hg_context_t *hg_context)
284 285
{
    int ret;
Shane Snyder's avatar
Shane Snyder committed
286
    hg_return_t hret;
287 288
    struct margo_instance *mid;

Matthieu Dorier's avatar
Matthieu Dorier committed
289
    mid = calloc(1,sizeof(*mid));
290
    if(!mid) goto err;
291
    memset(mid, 0, sizeof(*mid));
292

293 294 295
    ABT_mutex_create(&mid->finalize_mutex);
    ABT_cond_create(&mid->finalize_cond);

296 297
    mid->progress_pool = progress_pool;
    mid->handler_pool = handler_pool;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
298
    mid->hg_class = HG_Context_get_class(hg_context);
299
    mid->hg_context = hg_context;
300
    mid->hg_progress_timeout_ub = DEFAULT_MERCURY_PROGRESS_TIMEOUT_UB;
301
    mid->mplex_table = NULL;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
302
    mid->refcount = 1;
303
    mid->finalize_cb = NULL;
Matthieu Dorier's avatar
Matthieu Dorier committed
304
    mid->enable_remote_shutdown = 0;
305

306 307
    mid->timer_list = margo_timer_list_create();
    if(mid->timer_list == NULL) goto err;
308

Shane Snyder's avatar
Shane Snyder committed
309 310 311 312
    /* initialize the handle cache */
    hret = margo_handle_cache_init(mid);
    if(hret != HG_SUCCESS) goto err;

313
    ret = ABT_thread_create(mid->progress_pool, hg_progress_fn, mid, 
314
        ABT_THREAD_ATTR_NULL, &mid->hg_progress_tid);
315 316
    if(ret != 0) goto err;

Matthieu Dorier's avatar
Matthieu Dorier committed
317 318 319
    mid->shutdown_rpc_id = MARGO_REGISTER(mid, "__shutdown__", 
            void, margo_shutdown_out_t, remote_shutdown_ult);

320 321
    return mid;

322 323
err:
    if(mid)
324
    {
Shane Snyder's avatar
Shane Snyder committed
325
        margo_handle_cache_destroy(mid);
326
        margo_timer_list_free(mid->timer_list);
327 328
        ABT_mutex_free(&mid->finalize_mutex);
        ABT_cond_free(&mid->finalize_cond);
329
        free(mid);
330
    }
331
    return MARGO_INSTANCE_NULL;
332 333
}

Jonathan Jenkins's avatar
Jonathan Jenkins committed
334 335 336 337
static void margo_cleanup(margo_instance_id mid)
{
    int i;

338 339 340 341 342 343 344 345 346
    /* call finalize callbacks */
    struct margo_finalize_cb* fcb = mid->finalize_cb;
    while(fcb) {
        (fcb->callback)(fcb->uargs);
        struct margo_finalize_cb* tmp = fcb;
        fcb = fcb->next;
        free(tmp);
    }

347
    margo_timer_list_free(mid->timer_list);
Jonathan Jenkins's avatar
Jonathan Jenkins committed
348

349 350 351
    /* delete the hash used for multiplexing */
    delete_multiplexing_hash(mid);

Jonathan Jenkins's avatar
Jonathan Jenkins committed
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
    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
371 372
    margo_handle_cache_destroy(mid);

373 374 375 376 377 378
    if (mid->margo_init)
    {
        if (mid->hg_context)
            HG_Context_destroy(mid->hg_context);
        if (mid->hg_class)
            HG_Finalize(mid->hg_class);
379 380
        if (mid->abt_init)
            ABT_finalize();
381 382
    }

Jonathan Jenkins's avatar
Jonathan Jenkins committed
383 384 385
    free(mid);
}

386
void margo_finalize(margo_instance_id mid)
387
{
Jonathan Jenkins's avatar
Jonathan Jenkins committed
388
    int do_cleanup;
389

390
    /* tell progress thread to wrap things up */
391
    mid->hg_progress_shutdown_flag = 1;
392 393

    /* wait for it to shutdown cleanly */
394 395
    ABT_thread_join(mid->hg_progress_tid);
    ABT_thread_free(&mid->hg_progress_tid);
396

397 398 399 400
    ABT_mutex_lock(mid->finalize_mutex);
    mid->finalize_flag = 1;
    ABT_cond_broadcast(mid->finalize_cond);

Jonathan Jenkins's avatar
Jonathan Jenkins committed
401 402
    mid->refcount--;
    do_cleanup = mid->refcount == 0;
403

Jonathan Jenkins's avatar
Jonathan Jenkins committed
404 405 406 407 408 409 410
    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);
411 412 413 414 415 416

    return;
}

void margo_wait_for_finalize(margo_instance_id mid)
{
Jonathan Jenkins's avatar
Jonathan Jenkins committed
417
    int do_cleanup;
418 419 420

    ABT_mutex_lock(mid->finalize_mutex);

Jonathan Jenkins's avatar
Jonathan Jenkins committed
421
        mid->refcount++;
422 423 424 425
            
        while(!mid->finalize_flag)
            ABT_cond_wait(mid->finalize_cond, mid->finalize_mutex);

Jonathan Jenkins's avatar
Jonathan Jenkins committed
426 427 428
        mid->refcount--;
        do_cleanup = mid->refcount == 0;

429
    ABT_mutex_unlock(mid->finalize_mutex);
Jonathan Jenkins's avatar
Jonathan Jenkins committed
430 431 432 433

    if (do_cleanup)
        margo_cleanup(mid);

434 435 436
    return;
}

437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
void margo_push_finalize_callback(
            margo_instance_id mid,
            void(*cb)(void*),                  
            void* uargs)
{
    if(cb == NULL) return;

    struct margo_finalize_cb* fcb = 
        (struct margo_finalize_cb*)malloc(sizeof(*fcb));
    fcb->callback = cb;
    fcb->uargs = uargs;

    struct margo_finalize_cb* next = mid->finalize_cb;
    fcb->next = next;
    mid->finalize_cb = fcb;
}

454 455
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)
456
{
457 458 459
	struct margo_rpc_data* margo_data;
    hg_return_t hret;
    hg_id_t id;
460

461 462 463
    id = HG_Register_name(mid->hg_class, func_name, in_proc_cb, out_proc_cb, rpc_cb);
    if(id <= 0)
        return(0);
464

465 466 467 468 469 470 471 472 473 474 475 476
	/* 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)
477
        {
478 479
            free(margo_data);
            return(0);
480
        }
481 482
    }

483
	return(id);
484 485
}

Matthieu Dorier's avatar
Matthieu Dorier committed
486 487 488 489 490 491 492 493 494 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
void margo_enable_remote_shutdown(margo_instance_id mid)
{
    mid->enable_remote_shutdown = 1;
}

int margo_shutdown_remote_instance(
        margo_instance_id mid,
        hg_addr_t remote_addr)
{
    hg_return_t hret;
    hg_handle_t handle;

    hret = margo_create(mid, remote_addr,
                        mid->shutdown_rpc_id, &handle);
    if(hret != HG_SUCCESS) return -1;

    hret = margo_forward(handle, NULL);
    if(hret != HG_SUCCESS)
    {
        margo_destroy(handle);
        return -1;
    }

    margo_shutdown_out_t out;
    hret = margo_get_output(handle, &out);
    if(hret != HG_SUCCESS)
    {
        margo_destroy(handle);
        return -1;
    }

    margo_destroy(handle);

    return out.ret;
}

522 523
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,
524
    uint8_t mplex_id, ABT_pool pool)
525
{
526 527 528
    struct mplex_key key;
    struct mplex_element *element;
    hg_id_t id;
529

530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
    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);
555 556
}

557 558
hg_return_t margo_registered_name(margo_instance_id mid, const char *func_name,
    hg_id_t *id, hg_bool_t *flag)
559
{
560
    return(HG_Registered_name(mid->hg_class, func_name, id, flag));
561 562
}

563
hg_return_t margo_registered_name_mplex(margo_instance_id mid, const char *func_name,
564
    uint8_t mplex_id, hg_id_t *id, hg_bool_t *flag)
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
{
    hg_bool_t b;
    hg_return_t ret = margo_registered_name(mid, func_name, id, &b);
    if(ret != HG_SUCCESS) 
        return ret;
    if((!b) || (!mplex_id)) {
        *flag = b;
        return ret;
    }

    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) {
        *flag = 0;
        return HG_SUCCESS;
    }

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

    *flag = 1;
    return HG_SUCCESS;
}

594 595 596 597 598 599 600
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 
601
		= (struct margo_rpc_data*) HG_Registered_data(mid->hg_class, id);
602
	if(!margo_data) return HG_OTHER_ERROR;
603 604 605
    if(margo_data->user_data && margo_data->user_free_callback) {
        (margo_data->user_free_callback)(margo_data->user_data);
    }
606 607 608 609 610 611 612 613 614 615 616 617 618
	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;
}

619 620 621 622
hg_return_t margo_registered_disable_response(
    margo_instance_id mid,
    hg_id_t id,
    int disable_flag)
623
{
624
    return(HG_Registered_disable_response(mid->hg_class, id, disable_flag));
625
}
626

627
struct lookup_cb_evt
628
{
629
    hg_return_t hret;
630 631 632 633 634 635
    hg_addr_t addr;
};

static hg_return_t margo_addr_lookup_cb(const struct hg_cb_info *info)
{
    struct lookup_cb_evt evt;
636
    evt.hret = info->ret;
637
    evt.addr = info->info.lookup.addr;
Matthieu Dorier's avatar
Matthieu Dorier committed
638
    ABT_eventual eventual = (ABT_eventual)(info->arg);
639 640

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

643 644 645
    return(HG_SUCCESS);
}

646 647 648 649
hg_return_t margo_addr_lookup(
    margo_instance_id mid,
    const char   *name,
    hg_addr_t    *addr)
650
{
651
    hg_return_t hret;
652 653 654
    struct lookup_cb_evt *evt;
    ABT_eventual eventual;
    int ret;
655

656 657 658 659 660 661
    ret = ABT_eventual_create(sizeof(*evt), &eventual);
    if(ret != 0)
    {
        return(HG_NOMEM_ERROR);        
    }

662
    hret = HG_Addr_lookup(mid->hg_context, margo_addr_lookup_cb,
Matthieu Dorier's avatar
Matthieu Dorier committed
663
        (void*)eventual, name, HG_OP_ID_IGNORE);
664
    if(hret == HG_SUCCESS)
665 666 667
    {
        ABT_eventual_wait(eventual, (void**)&evt);
        *addr = evt->addr;
668
        hret = evt->hret;
669 670 671 672
    }

    ABT_eventual_free(&eventual);

673
    return(hret);
674 675 676 677 678
}

hg_return_t margo_addr_free(
    margo_instance_id mid,
    hg_addr_t addr)
679
{
680 681
    return(HG_Addr_free(mid->hg_class, addr));
}
682

683 684 685 686 687
hg_return_t margo_addr_self(
    margo_instance_id mid,
    hg_addr_t *addr)
{
    return(HG_Addr_self(mid->hg_class, addr));
688 689
}

690 691 692 693 694 695 696 697 698
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(
699
    margo_instance_id mid,
700 701 702 703 704 705 706 707 708 709
    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)
{
710
    hg_return_t hret = HG_OTHER_ERROR;
Shane Snyder's avatar
Shane Snyder committed
711 712 713 714 715 716 717 718

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

Shane Snyder's avatar
Shane Snyder committed
720
    return hret;
721 722
}

723
hg_return_t margo_destroy(hg_handle_t handle)
724
{
725
    margo_instance_id mid;
726
    hg_return_t hret = HG_OTHER_ERROR;
Shane Snyder's avatar
Shane Snyder committed
727

728 729 730
    /* use the handle to get the associated mid */
    mid = margo_hg_handle_get_instance(handle);

Shane Snyder's avatar
Shane Snyder committed
731 732 733 734 735 736 737
    /* 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);
    }
738

Shane Snyder's avatar
Shane Snyder committed
739
    return hret;
740 741 742 743 744
}

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
745
    ABT_eventual eventual = (ABT_eventual)(info->arg);
746 747

    /* propagate return code out through eventual */
Matthieu Dorier's avatar
Matthieu Dorier committed
748
    ABT_eventual_set(eventual, &hret, sizeof(hret));
749 750 751 752 753 754 755
    
    return(HG_SUCCESS);
}

hg_return_t margo_forward(
    hg_handle_t handle,
    void *in_struct)
756 757 758 759 760 761 762 763 764 765 766 767 768
{
	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)
769 770
{
    hg_return_t hret = HG_TIMEOUT;
771
    ABT_eventual eventual;
772
    int ret;
773 774 775 776 777 778 779

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

780
    *req = eventual;
781

Matthieu Dorier's avatar
Matthieu Dorier committed
782
    return HG_Forward(handle, margo_cb, (void*)eventual, in_struct);
783
}
784

785 786 787 788
hg_return_t margo_wait(margo_request req)
{
	hg_return_t* waited_hret;
	hg_return_t  hret;
789

790 791 792 793
    ABT_eventual_wait(req, (void**)&waited_hret);
	hret = *waited_hret;
    ABT_eventual_free(&req);
	
794
    return(hret);
795 796
}

Matthieu Dorier's avatar
Matthieu Dorier committed
797 798 799 800 801
int margo_test(margo_request req, int* flag)
{
    return ABT_eventual_test(req, NULL, flag);
}

802 803 804 805
typedef struct
{
    hg_handle_t handle;
} margo_forward_timeout_cb_dat;
806

807 808 809 810 811 812 813 814 815 816 817
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(
818
    hg_handle_t handle,
819 820
    void *in_struct,
    double timeout_ms)
821 822
{
    int ret;
823
    hg_return_t hret;
824
    margo_instance_id mid;
825
    ABT_eventual eventual;
826
    hg_return_t* waited_hret;
827 828
    margo_timer_t forward_timer;
    margo_forward_timeout_cb_dat timeout_cb_dat;
829 830 831 832 833 834 835

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

836 837 838
    /* use the handle to get the associated mid */
    mid = margo_hg_handle_get_instance(handle);

839 840 841 842 843
    /* 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
844
    hret = HG_Forward(handle, margo_cb, (void*)eventual, in_struct);
845
    if(hret == HG_SUCCESS)
Jonathan Jenkins's avatar
Jonathan Jenkins committed
846 847 848 849 850
    {
        ABT_eventual_wait(eventual, (void**)&waited_hret);
        hret = *waited_hret;
    }

851 852 853 854 855 856 857 858
    /* 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
859 860 861 862 863 864 865 866
    ABT_eventual_free(&eventual);

    return(hret);
}

hg_return_t margo_respond(
    hg_handle_t handle,
    void *out_struct)
867 868 869 870 871 872 873 874 875 876 877 878 879
{
    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
880 881 882 883
{
    ABT_eventual eventual;
    int ret;

Matthieu Dorier's avatar
Matthieu Dorier committed
884
    ret = ABT_eventual_create(sizeof(hg_return_t), &eventual);
Jonathan Jenkins's avatar
Jonathan Jenkins committed
885 886 887 888 889
    if(ret != 0)
    {
        return(HG_NOMEM_ERROR);
    }

890
    *req = eventual;
891

Matthieu Dorier's avatar
Matthieu Dorier committed
892
    return HG_Respond(handle, margo_cb, (void*)eventual, out_struct);
893 894
}

895 896 897 898 899 900 901
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)
902
{
903 904 905
    return(HG_Bulk_create(mid->hg_class, count,
        buf_ptrs, buf_sizes, flags, handle));
}
906

907 908 909 910
hg_return_t margo_bulk_free(
    hg_bulk_t handle)
{
    return(HG_Bulk_free(handle));
911 912
}

913 914 915 916 917 918 919 920
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));
}
921

922
hg_return_t margo_bulk_transfer(
923
    margo_instance_id mid,
924
    hg_bulk_op_t op,
925
    hg_addr_t origin_addr,
926 927 928 929
    hg_bulk_t origin_handle,
    size_t origin_offset,
    hg_bulk_t local_handle,
    size_t local_offset,
930
    size_t size)
931 932 933 934
{  
    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
935
                          local_offset, size, &req);
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
    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)
951 952 953 954 955 956 957 958 959 960 961
{
    hg_return_t hret = HG_TIMEOUT;
    ABT_eventual eventual;
    int ret;

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

962
    *req = eventual;
963

Matthieu Dorier's avatar
Matthieu Dorier committed
964 965
    hret = HG_Bulk_transfer(mid->hg_context, margo_cb,
        (void*)eventual, op, origin_addr, origin_handle, origin_offset, local_handle,
966
        local_offset, size, HG_OP_ID_IGNORE);
967 968 969 970

    return(hret);
}

971 972 973 974
typedef struct
{
    ABT_mutex mutex;
    ABT_cond cond;
Shane Snyder's avatar
Shane Snyder committed
975
    char is_asleep;
976 977 978 979 980 981 982 983 984
} 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);
985
    sleep_cb_dat->is_asleep = 0;
986 987 988 989 990 991 992
    ABT_cond_signal(sleep_cb_dat->cond);
    ABT_mutex_unlock(sleep_cb_dat->mutex);

    return;
}

void margo_thread_sleep(
993
    margo_instance_id mid,
994 995 996 997 998 999 1000 1001
    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));
1002
    sleep_cb_dat.is_asleep = 1;
1003 1004

    /* initialize the sleep timer */
1005
    margo_timer_init(mid, &sleep_timer, margo_thread_sleep_cb,
1006 1007 1008 1009
        &sleep_cb_dat, timeout_ms);

    /* yield thread for specified timeout */
    ABT_mutex_lock(sleep_cb_dat.mutex);
1010 1011
    while(sleep_cb_dat.is_asleep)
        ABT_cond_wait(sleep_cb_dat.cond, sleep_cb_dat.mutex);
1012 1013
    ABT_mutex_unlock(sleep_cb_dat.mutex);

1014 1015 1016 1017
    /* clean up */
    ABT_mutex_free(&sleep_cb_dat.mutex);
    ABT_cond_free(&sleep_cb_dat.cond);

1018 1019 1020
    return;
}

1021
int margo_get_handler_pool(margo_instance_id mid, ABT_pool* pool)
1022
{
1023 1024 1025 1026 1027 1028
    if(mid) {
        *pool = mid->handler_pool;
        return 0;
    } else {
        return -1;
    }
1029
}
1030

1031 1032 1033 1034
hg_context_t* margo_get_context(margo_instance_id mid)
{
    return(mid->hg_context);
}
1035

1036 1037 1038
hg_class_t* margo_get_class(margo_instance_id mid)
{
    return(mid->hg_class);
1039
}
Philip Carns's avatar
Philip Carns committed
1040

1041
margo_instance_id margo_hg_handle_get_instance(hg_handle_t h)
1042
{
1043 1044
	const struct hg_info* info = HG_Get_info(h);
	if(!info) return MARGO_INSTANCE_NULL;
1045 1046 1047 1048 1049
    return margo_hg_info_get_instance(info);
}

margo_instance_id margo_hg_info_get_instance(const struct hg_info *info)
{
1050 1051 1052 1053
	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;
1054 1055
}

1056
int margo_lookup_mplex(margo_instance_id mid, hg_id_t id, uint8_t mplex_id, ABT_pool *pool)
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
{
    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);
1072 1073 1074 1075 1076 1077
    if(!element) {
        if(mplex_id == 0) // element does not exist and mplex is 0, return default handler
            *pool = mid->handler_pool;
        else // otherwise it is an error
            return(-1);
    }
1078

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

1081 1082 1083 1084 1085
    *pool = element->pool;

    return(0);
}

1086
int margo_register_data_mplex(margo_instance_id mid, hg_id_t id, uint8_t mplex_id, void* data, void (*free_callback)(void *))
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
{
    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);
}

1110
void* margo_registered_data_mplex(margo_instance_id mid, hg_id_t id, uint8_t mplex_id)
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
{
    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;
}
1127
static void margo_rpc_data_free(void* ptr)
Philip Carns's avatar
Philip Carns committed
1128
{
1129 1130 1131 1132 1133 1134
	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);
}
1135

1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
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);
    }
}

1148 1149 1150 1151 1152 1153 1154
/* 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;
1155
    unsigned int hg_progress_timeout = mid->hg_progress_timeout_ub;
1156 1157
    double next_timer_exp;
    int trigger_happened;
1158 1159
    double tm1, tm2;
    int diag_enabled = 0;
1160

1161 1162 1163 1164
    while(!mid->hg_progress_shutdown_flag)
    {
        trigger_happened = 0;
        do {
1165 1166 1167 1168
            /* save value of instance diag variable, in case it is modified
             * while we are in loop 
             */
            diag_enabled = mid->diag_enabled;
1169

1170
            if(diag_enabled) tm1 = ABT_get_wtime();
1171
            ret = HG_Trigger(mid->hg_context, 0, 1, &actual_count);
1172 1173 1174 1175 1176
            if(diag_enabled)
            {
                tm2 = ABT_get_wtime();
                __DIAG_UPDATE(mid->diag_trigger_elapsed, (tm2-tm1));
            }
1177

1178 1179 1180
            if(ret == HG_SUCCESS && actual_count > 0)
                trigger_happened = 1;
        } while((ret == HG_SUCCESS) && actual_count && !mid->hg_progress_shutdown_flag);
1181

1182 1183
        if(trigger_happened)
            ABT_thread_yield();
1184

1185
        ABT_pool_get_size(mid->progress_pool, &size);
1186
        /* Are there any other threads executing in this pool that are *not*
1187 1188 1189 1190
         * 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.
1191
         */
1192
        if(size > 0)
1193 1194 1195 1196 1197 1198 1199 1200
        {
            /* 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
             * to make sure that this ULT is the lowest priority in that
             * scenario.
             */
1201
            if(diag_enabled) tm1 = ABT_get_wtime();
1202
            ret = HG_Progress(mid->hg_context, 0);
1203 1204 1205 1206 1207 1208
            if(diag_enabled)
            {
                tm2 = ABT_get_wtime();
                __DIAG_UPDATE(mid->diag_progress_elapsed_zero_timeout, (tm2-tm1));
                __DIAG_UPDATE(mid->diag_progress_timeout_value, 0);
            }
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
            if(ret == HG_SUCCESS)
            {
                /* Mercury completed something; loop around to trigger
                 * callbacks 
                 */
            }
            else if(ret == HG_TIMEOUT)
            {
                /* No completion; yield here to allow other ULTs to run */
                ABT_thread_yield();
            }
            else
            {
                /* TODO: error handling */
                fprintf(stderr, "WARNING: unexpected return code (%d) from HG_Progress()\n", ret);
            }
        }
        else
        {
1228
            hg_progress_timeout = mid->hg_progress_timeout_ub;
1229 1230 1231 1232 1233 1234 1235 1236 1237
            ret = margo_timer_get_next_expiration(mid, &next_timer_exp);
            if(ret == 0)
            {
                /* there is a queued timer, don't block long enough
                 * to keep this timer waiting
                 */
                if(next_timer_exp >= 0.0)
                {
                    next_timer_exp *= 1000; /* convert to milliseconds */
1238
                    if(next_timer_exp < mid->hg_progress_timeout_ub)
1239 1240 1241 1242 1243 1244 1245
                        hg_progress_timeout = (unsigned int)next_timer_exp;
                }
                else
                {
                    hg_progress_timeout = 0;
                }
            }
1246
            if(diag_enabled) tm1 = ABT_get_wtime();
1247
            ret = HG_Progress(mid->hg_context, hg_progress_timeout);
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
            if(diag_enabled)
            {
                tm2 = ABT_get_wtime();
                if(hg_progress_timeout == 0)
                    __DIAG_UPDATE(mid->diag_progress_elapsed_zero_timeout, (tm2-tm1));
                else
                    __DIAG_UPDATE(mid->diag_progress_elapsed_nonzero_timeout, (tm2-tm1));
                    
                __DIAG_UPDATE(mid->diag_progress_timeout_value, hg_progress_timeout);
            }
1258 1259 1260 1261 1262 1263
            if(ret != HG_SUCCESS && ret != HG_TIMEOUT)
            {
                /* TODO: error handling */
                fprintf(stderr, "WARNING: unexpected return code (%d) from HG_Progress()\n", ret);
            }
        }
1264

1265 1266 1267
        /* check for any expired timers */
        margo_check_timers(mid);
    }
1268

1269
    return;
Philip Carns's avatar
Philip Carns committed
1270
}
Philip Carns's avatar
Philip Carns committed
1271 1272 1273 1274 1275 1276 1277


void margo_diag_start(margo_instance_id mid)
{
    mid->diag_enabled = 1;
}

1278
static void print_diag_data(FILE *file, const char* name, const char *description, struct diag_data *data)
Philip Carns's avatar
Philip Carns committed
1279
{
1280 1281 1282 1283 1284 1285 1286 1287
    double avg;

    fprintf(file, "# %s\n", description);
    if(data->count != 0)
        avg = data->cumulative/data->count;
    else
        avg = 0;
    fprintf(file, "%s\t%.9f\t%.9f\t%.9f\t%d\n", name, avg, data->min, data->max, data->count);
Philip Carns's avatar
Philip Carns committed
1288 1289 1290
    return;
}

1291
void margo_diag_dump(margo_instance_id mid, const char* file, int uniquify)
Philip Carns's avatar
Philip Carns committed
1292 1293 1294
{
    FILE *outfile;
    time_t ltime;
1295
    char revised_file_name[256] = {0};
Philip Carns's avatar
Philip Carns committed
1296 1297 1298

    assert(mid->diag_enabled);

1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
    if(uniquify)
    {
        char hostname[128] = {0};
        int pid;

        gethostname(hostname, 128);
        pid = getpid();

        sprintf(revised_file_name, "%s-%s-%d", file, hostname, pid);
    }
    else
    {
        sprintf(revised_file_name, "%s", file);
    }

Philip Carns's avatar
Philip Carns committed
1314 1315 1316 1317 1318 1319
    if(strcmp("-", file) == 0)
    {
        outfile = stdout;
    }
    else
    {
1320
        outfile = fopen(revised_file_name, "a");
Philip Carns's avatar
Philip Carns committed
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
        if(!outfile)
        {
            perror("fopen");
            return;
        }
    }

    /* TODO: retrieve self addr and include in output */
    /* TODO: support pattern substitution in file name to create unique
     * output files per process
     */

    time(&ltime);
    fprintf(outfile, "# Margo diagnostics\n");
    fprintf(outfile, "# %s\n", ctime(&ltime));
    fprintf(outfile, "# <stat>\t<avg>\t<min>\t<max>\t<count>\n");
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
    print_diag_data(outfile, "trigger_elapsed", 
        "Time consumed by HG_Trigger()", 
        &mid->diag_trigger_elapsed);
    print_diag_data(outfile, "progress_elapsed_zero_timeout", 
        "Time consumed by HG_Progress() when called with timeout==0", 
        &mid->diag_progress_elapsed_zero_timeout);
    print_diag_data(outfile, "progress_elapsed_nonzero_timeout", 
        "Time consumed by HG_Progress() when called with timeout!=0", 
        &mid->diag_progress_elapsed_nonzero_timeout);
    print_diag_data(outfile, "progress_timeout_value", 
        "Timeout values passed to HG_Progress()", 
        &mid->diag_progress_timeout_value);
Philip Carns's avatar
Philip Carns committed
1349 1350 1351 1352 1353 1354

    if(outfile != stdout)
        fclose(outfile);
    
    return;
}
1355

1356
void margo_set_param(margo_instance_id mid, int option, const void *param)
1357 1358 1359
{
    switch(option)
    {
1360
        case MARGO_PARAM_PROGRESS_TIMEOUT_UB:
1361 1362 1363 1364 1365 1366 1367
            mid->hg_progress_timeout_ub = (*((const unsigned int*)param));
            break;
    }

    return;
}

1368
void margo_get_param(margo_instance_id mid, int option, void *param)
1369 1370 1371 1372
{

    switch(option)
    {
1373
        case MARGO_PARAM_PROGRESS_TIMEOUT_UB: