margo.c 10.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>
12
#include <abt-snoozer.h>
13
#include <time.h>
Philip Carns's avatar
bug fix  
Philip Carns committed
14
#include <math.h>
15 16

#include "margo.h"
Philip Carns's avatar
Philip Carns committed
17
#include "utlist.h"
18

19 20 21 22 23
/* TODO: including core.h for cancel definition, presumably this will be 
 * available in top level later?
 */
#include <mercury_core.h>

24 25
struct margo_instance
{
26
    /* provided by caller */
27 28
    hg_context_t *hg_context;
    hg_class_t *hg_class;
29 30 31
    ABT_pool handler_pool;
    ABT_pool progress_pool;

32
    /* internal to margo for this particular instance */
33 34
    ABT_thread hg_progress_tid;
    int hg_progress_shutdown_flag;
35 36 37 38 39 40 41

    /* control logic for callers waiting on margo to be finalized */
    int finalize_flag;
    int finalize_waiters_in_progress_pool;
    ABT_mutex finalize_mutex;
    ABT_cond finalize_cond;

42 43 44 45 46 47 48 49 50 51 52 53
    int table_index;
};

struct margo_handler_mapping
{
    hg_class_t *class;
    margo_instance_id mid;
};

#define MAX_HANDLER_MAPPING 8
static int handler_mapping_table_size = 0;
static struct margo_handler_mapping handler_mapping_table[MAX_HANDLER_MAPPING] = {0};
54

55
static void hg_progress_fn(void* foo);
56 57 58 59 60 61 62 63 64


struct handler_entry
{
    void* fn;
    hg_handle_t handle;
    struct handler_entry *next; 
};

65 66
margo_instance_id margo_init(ABT_pool progress_pool, ABT_pool handler_pool,
    hg_context_t *hg_context, hg_class_t *hg_class)
67 68
{
    int ret;
69 70 71
    struct margo_instance *mid;

    if(handler_mapping_table_size >= MAX_HANDLER_MAPPING)
72
        return(MARGO_INSTANCE_NULL);
73 74 75

    mid = malloc(sizeof(*mid));
    if(!mid)
76
        return(MARGO_INSTANCE_NULL);
77
    memset(mid, 0, sizeof(*mid));
78

79 80 81
    ABT_mutex_create(&mid->finalize_mutex);
    ABT_cond_create(&mid->finalize_cond);

Shane Snyder's avatar
Shane Snyder committed
82
    margo_timer_sys_init();
83

84 85
    mid->progress_pool = progress_pool;
    mid->handler_pool = handler_pool;
86 87
    mid->hg_class = hg_class;
    mid->hg_context = hg_context;
88

89
    ret = ABT_thread_create(mid->progress_pool, hg_progress_fn, mid, 
90
        ABT_THREAD_ATTR_NULL, &mid->hg_progress_tid);
91 92 93
    if(ret != 0)
    {
        fprintf(stderr, "Error: ABT_thread_create()\n");
94
        free(mid);
95
        return(MARGO_INSTANCE_NULL);
96 97
    }

98 99 100 101 102 103
    handler_mapping_table[handler_mapping_table_size].mid = mid;
    handler_mapping_table[handler_mapping_table_size].class = mid->hg_class;
    mid->table_index = handler_mapping_table_size;
    handler_mapping_table_size++;

    return mid;
104 105
}

106
void margo_finalize(margo_instance_id mid)
107
{
108 109
    int i;

110
    /* tell progress thread to wrap things up */
111
    mid->hg_progress_shutdown_flag = 1;
112 113

    /* wait for it to shutdown cleanly */
114 115
    ABT_thread_join(mid->hg_progress_tid);
    ABT_thread_free(&mid->hg_progress_tid);
116

117 118 119 120 121
    for(i=mid->table_index; i<(handler_mapping_table_size-1); i++)
    {
        handler_mapping_table[i] = handler_mapping_table[i+1];
    }
    handler_mapping_table_size--;
122

123 124 125 126 127 128 129 130 131 132 133 134 135
    ABT_mutex_lock(mid->finalize_mutex);
    mid->finalize_flag = 1;
    ABT_cond_broadcast(mid->finalize_cond);
    ABT_mutex_unlock(mid->finalize_mutex);

    /* TODO: yuck, there is a race here if someone was really waiting for
     * finalize; we can't destroy the data structures out from under them.
     * We could fix this by reference counting so that the last caller
     * (whether a finalize() caller or wait_for_finalize() caller) knows it
     * is safe to turn off the lights on their way out.  For now we just leak 
     * a small amount of memory.
     */
#if 0
Shane Snyder's avatar
Shane Snyder committed
136
    margo_timer_sys_shutdown();
137

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
    ABT_mutex_free(&mid->finalize_mutex);
    ABT_cond_free(&mid->finalize_cond);
    free(mid);
#endif

    return;
}

void margo_wait_for_finalize(margo_instance_id mid)
{
    ABT_xstream xstream;
    ABT_pool pool;
    int ret;
    int in_pool = 0;

    ret = ABT_xstream_self(&xstream);
    if(ret != 0)
        return;
    ret = ABT_xstream_get_main_pools(xstream, 1, &pool);
    if(ret != 0)
        return;

    /* Is this waiter in the same pool as the pool running the progress
     * thread?
     */
    if(pool == mid->progress_pool)
        in_pool = 1;

    ABT_mutex_lock(mid->finalize_mutex);

        mid->finalize_waiters_in_progress_pool += in_pool;
            
        while(!mid->finalize_flag)
            ABT_cond_wait(mid->finalize_cond, mid->finalize_mutex);

    ABT_mutex_unlock(mid->finalize_mutex);
    
175 176 177 178
    return;
}

/* dedicated thread function to drive Mercury progress */
179
static void hg_progress_fn(void* foo)
180 181 182
{
    int ret;
    unsigned int actual_count;
183
    struct margo_instance *mid = (struct margo_instance *)foo;
184
    size_t size;
185

186
    while(!mid->hg_progress_shutdown_flag)
187 188
    {
        do {
189
            ret = HG_Trigger(mid->hg_context, 0, 1, &actual_count);
190
        } while((ret == HG_SUCCESS) && actual_count && !mid->hg_progress_shutdown_flag);
191

192
        if(!mid->hg_progress_shutdown_flag)
193
        {
194
            ABT_pool_get_total_size(mid->progress_pool, &size);
195 196 197 198 199 200
            /* Are there any other threads executing in this pool that are *not*
             * blocked on margo_wait_for_finalize()?  If so then, we can't
             * sleep here or else those threads will not get a chance to
             * execute.
             */
            if(size > mid->finalize_waiters_in_progress_pool)
201
            {
202
                HG_Progress(mid->hg_context, 0);
203 204 205 206
                ABT_thread_yield();
            }
            else
            {
207
                HG_Progress(mid->hg_context, 100);
208 209
            }
        }
210

211 212
        /* check for any expired timers */
        margo_check_timers();
213 214
    }

215
    return;
216 217
}

218
ABT_pool* margo_get_handler_pool(margo_instance_id mid)
219
{
220
    return(&mid->handler_pool);
221 222
}

223 224 225 226 227 228 229 230 231 232 233
hg_context_t* margo_get_context(margo_instance_id mid)
{
    return(mid->hg_context);
}

hg_class_t* margo_get_class(margo_instance_id mid)
{
    return(mid->hg_class);
}


Jonathan Jenkins's avatar
Jonathan Jenkins committed
234
static hg_return_t margo_cb(const struct hg_cb_info *info)
235 236 237 238 239 240 241 242 243 244
{
    hg_return_t hret = info->ret;

    ABT_eventual *eventual = info->arg;
    /* propagate return code out through eventual */
    ABT_eventual_set(*eventual, &hret, sizeof(hret));
    
    return(HG_SUCCESS);
}

245 246 247
typedef struct
{
    hg_handle_t handle;
Shane Snyder's avatar
Shane Snyder committed
248
} margo_forward_timeout_cb_dat;
249 250 251

static void margo_forward_timeout_cb(void *arg)
{
Shane Snyder's avatar
Shane Snyder committed
252 253
    margo_forward_timeout_cb_dat *timeout_cb_dat =
        (margo_forward_timeout_cb_dat *)arg;
254 255

    /* cancel the Mercury op if the forward timed out */
Shane Snyder's avatar
Shane Snyder committed
256
    HG_Core_cancel(timeout_cb_dat->handle);
257 258 259
    return;
}

260 261 262 263 264 265
hg_return_t margo_forward_timed(
    margo_instance_id mid,
    hg_handle_t handle,
    void *in_struct,
    double timeout_ms)
{
Shane Snyder's avatar
Shane Snyder committed
266
    int ret;
267 268 269
    hg_return_t hret = HG_TIMEOUT;
    ABT_eventual eventual;
    hg_return_t* waited_hret;
Shane Snyder's avatar
Shane Snyder committed
270 271
    margo_timer_t forward_timer;
    margo_forward_timeout_cb_dat timeout_cb_dat;
272 273 274 275 276 277 278

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

Shane Snyder's avatar
Shane Snyder committed
279 280 281 282
    /* set a timer object to expire when this forward times out */
    timeout_cb_dat.handle = handle;
    margo_timer_init(&forward_timer, margo_forward_timeout_cb,
        &timeout_cb_dat, timeout_ms);
283 284 285 286 287 288 289 290

    hret = HG_Forward(handle, margo_cb, &eventual, in_struct);
    if(hret == 0)
    {
        ABT_eventual_wait(eventual, (void**)&waited_hret);
        hret = *waited_hret;
    }

291 292
    /* remove timer if it is still in place (i.e., not timed out) */
    if(hret != HG_TIMEOUT)
Shane Snyder's avatar
Shane Snyder committed
293
        margo_timer_destroy(&forward_timer);
294 295 296 297

    ABT_eventual_free(&eventual);

    return(hret);
298 299 300 301

}


302
hg_return_t margo_forward(
303
    margo_instance_id mid,
304 305 306 307 308 309 310 311 312 313 314 315 316 317
    hg_handle_t handle,
    void *in_struct)
{
    hg_return_t hret = HG_TIMEOUT;
    ABT_eventual eventual;
    int ret;
    hg_return_t* waited_hret;

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

Jonathan Jenkins's avatar
Jonathan Jenkins committed
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
    hret = HG_Forward(handle, margo_cb, &eventual, in_struct);
    if(hret == 0)
    {
        ABT_eventual_wait(eventual, (void**)&waited_hret);
        hret = *waited_hret;
    }

    ABT_eventual_free(&eventual);

    return(hret);
}

hg_return_t margo_respond(
    margo_instance_id mid,
    hg_handle_t handle,
    void *out_struct)
{
    hg_return_t hret = HG_TIMEOUT;
    ABT_eventual eventual;
    int ret;
    hg_return_t* waited_hret;

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

    hret = HG_Respond(handle, margo_cb, &eventual, out_struct);
347 348 349 350 351 352 353 354 355 356 357
    if(hret == 0)
    {
        ABT_eventual_wait(eventual, (void**)&waited_hret);
        hret = *waited_hret;
    }

    ABT_eventual_free(&eventual);

    return(hret);
}

358

359
static hg_return_t margo_bulk_transfer_cb(const struct hg_cb_info *info)
360
{
361 362
    hg_return_t hret = info->ret;
    ABT_eventual *eventual = info->arg;
363 364 365 366 367 368 369

    /* propagate return code out through eventual */
    ABT_eventual_set(*eventual, &hret, sizeof(hret));
    
    return(HG_SUCCESS);
}

Philip Carns's avatar
Philip Carns committed
370 371
struct lookup_cb_evt
{
372 373
    hg_return_t nret;
    hg_addr_t addr;
Philip Carns's avatar
Philip Carns committed
374 375
};

376
static hg_return_t margo_addr_lookup_cb(const struct hg_cb_info *info)
Philip Carns's avatar
Philip Carns committed
377 378
{
    struct lookup_cb_evt evt;
379 380
    evt.nret = info->ret;
    evt.addr = info->info.lookup.addr;
Philip Carns's avatar
Philip Carns committed
381

382
    ABT_eventual *eventual = info->arg;
Philip Carns's avatar
Philip Carns committed
383 384 385 386

    /* propagate return code out through eventual */
    ABT_eventual_set(*eventual, &evt, sizeof(evt));
    
387
    return(HG_SUCCESS);
Philip Carns's avatar
Philip Carns committed
388 389 390
}


391
hg_return_t margo_addr_lookup(
392
    margo_instance_id mid,
393
    hg_context_t *context,
Philip Carns's avatar
Philip Carns committed
394
    const char   *name,
395
    hg_addr_t    *addr)
396
{
397
    hg_return_t nret;
Philip Carns's avatar
Philip Carns committed
398
    struct lookup_cb_evt *evt;
399 400 401
    ABT_eventual eventual;
    int ret;

Philip Carns's avatar
Philip Carns committed
402
    ret = ABT_eventual_create(sizeof(*evt), &eventual);
403 404 405 406 407
    if(ret != 0)
    {
        return(HG_NOMEM_ERROR);        
    }

408 409
    nret = HG_Addr_lookup(context, margo_addr_lookup_cb,
        &eventual, name, HG_OP_ID_IGNORE);
410 411
    if(nret == 0)
    {
Philip Carns's avatar
Philip Carns committed
412 413 414
        ABT_eventual_wait(eventual, (void**)&evt);
        *addr = evt->addr;
        nret = evt->nret;
415 416 417 418 419 420 421
    }

    ABT_eventual_free(&eventual);

    return(nret);
}

422
hg_return_t margo_bulk_transfer(
423
    margo_instance_id mid,
424
    hg_context_t *context,
425
    hg_bulk_op_t op,
426
    hg_addr_t origin_addr,
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
    hg_bulk_t origin_handle,
    size_t origin_offset,
    hg_bulk_t local_handle,
    size_t local_offset,
    size_t size)
{
    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);        
    }

    hret = HG_Bulk_transfer(context, margo_bulk_transfer_cb, &eventual, op, 
        origin_addr, origin_handle, origin_offset, local_handle, local_offset,
        size, HG_OP_ID_IGNORE);
    if(hret == 0)
    {
        ABT_eventual_wait(eventual, (void**)&waited_hret);
        hret = *waited_hret;
    }

    ABT_eventual_free(&eventual);

    return(hret);
}

458
margo_instance_id margo_hg_class_to_instance(hg_class_t *cl)
459 460 461 462 463
{
    int i;

    for(i=0; i<handler_mapping_table_size; i++)
    {
464
        if(handler_mapping_table[i].class == cl)
465 466 467 468
            return(handler_mapping_table[i].mid);
    }
    return(NULL);
}