margo.c 9.4 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 14

#include "margo.h"
Philip Carns's avatar
Philip Carns committed
15
#include "utlist.h"
16

17 18
struct margo_instance
{
19
    /* provided by caller */
20 21
    hg_context_t *hg_context;
    hg_class_t *hg_class;
22 23 24
    ABT_pool handler_pool;
    ABT_pool progress_pool;

25
    /* internal to margo for this particular instance */
26 27
    ABT_thread hg_progress_tid;
    int hg_progress_shutdown_flag;
28 29 30 31 32 33 34

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

35 36 37 38 39 40 41 42 43 44 45 46
    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};
47

48
static void hg_progress_fn(void* foo);
49 50 51 52 53 54 55 56 57


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

58 59
margo_instance_id margo_init(ABT_pool progress_pool, ABT_pool handler_pool,
    hg_context_t *hg_context, hg_class_t *hg_class)
60 61
{
    int ret;
62 63 64
    struct margo_instance *mid;

    if(handler_mapping_table_size >= MAX_HANDLER_MAPPING)
65
        return(MARGO_INSTANCE_NULL);
66 67 68

    mid = malloc(sizeof(*mid));
    if(!mid)
69
        return(MARGO_INSTANCE_NULL);
70
    memset(mid, 0, sizeof(*mid));
71

72 73 74
    ABT_mutex_create(&mid->finalize_mutex);
    ABT_cond_create(&mid->finalize_cond);

75 76
    mid->progress_pool = progress_pool;
    mid->handler_pool = handler_pool;
77 78
    mid->hg_class = hg_class;
    mid->hg_context = hg_context;
79

80
    ret = ABT_thread_create(mid->progress_pool, hg_progress_fn, mid, 
81
        ABT_THREAD_ATTR_NULL, &mid->hg_progress_tid);
82 83 84
    if(ret != 0)
    {
        fprintf(stderr, "Error: ABT_thread_create()\n");
85
        free(mid);
86
        return(MARGO_INSTANCE_NULL);
87 88
    }

89 90 91 92 93 94
    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;
95 96
}

97
void margo_finalize(margo_instance_id mid)
98
{
99 100
    int i;

101
    /* tell progress thread to wrap things up */
102
    mid->hg_progress_shutdown_flag = 1;
103 104

    /* wait for it to shutdown cleanly */
105 106
    ABT_thread_join(mid->hg_progress_tid);
    ABT_thread_free(&mid->hg_progress_tid);
107

108 109 110 111 112
    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--;
113

114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 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
    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
    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);
    
164 165 166 167
    return;
}

/* dedicated thread function to drive Mercury progress */
168
static void hg_progress_fn(void* foo)
169 170 171
{
    int ret;
    unsigned int actual_count;
172
    struct margo_instance *mid = (struct margo_instance *)foo;
173
    size_t size;
174

175
    while(!mid->hg_progress_shutdown_flag)
176 177
    {
        do {
178
            ret = HG_Trigger(mid->hg_context, 0, 1, &actual_count);
179
        } while((ret == HG_SUCCESS) && actual_count && !mid->hg_progress_shutdown_flag);
180

181
        if(!mid->hg_progress_shutdown_flag)
182
        {
183
            ABT_pool_get_total_size(mid->progress_pool, &size);
184 185 186 187 188 189
            /* 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)
190
            {
191
                HG_Progress(mid->hg_context, 0);
192 193 194 195
                ABT_thread_yield();
            }
            else
            {
196
                HG_Progress(mid->hg_context, 100);
197 198
            }
        }
199 200
    }

201
    return;
202 203
}

204
ABT_pool* margo_get_handler_pool(margo_instance_id mid)
205
{
206
    return(&mid->handler_pool);
207 208
}

Jonathan Jenkins's avatar
Jonathan Jenkins committed
209
static hg_return_t margo_cb(const struct hg_cb_info *info)
210 211 212 213 214 215 216 217 218 219
{
    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);
}

220 221 222 223 224 225 226 227 228 229 230 231
hg_return_t margo_forward_timed(
    margo_instance_id mid,
    hg_handle_t handle,
    void *in_struct,
    double timeout_ms)
{
    /* TODO: implement; for now just wraps regular forward with no timeout */

    return(margo_forward(mid, handle, in_struct));
}


232
hg_return_t margo_forward(
233
    margo_instance_id mid,
234 235 236 237 238 239 240 241 242 243 244 245 246 247
    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
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
    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);
277 278 279 280 281 282 283 284 285 286 287
    if(hret == 0)
    {
        ABT_eventual_wait(eventual, (void**)&waited_hret);
        hret = *waited_hret;
    }

    ABT_eventual_free(&eventual);

    return(hret);
}

288

289 290 291 292 293 294 295 296 297 298 299
static hg_return_t margo_bulk_transfer_cb(const struct hg_bulk_cb_info *hg_bulk_cb_info)
{
    hg_return_t hret = hg_bulk_cb_info->ret;
    ABT_eventual *eventual = hg_bulk_cb_info->arg;

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

Philip Carns's avatar
Philip Carns committed
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
struct lookup_cb_evt
{
    na_return_t nret;
    na_addr_t addr;
};

static na_return_t margo_na_addr_lookup_cb(const struct na_cb_info *callback_info)
{
    struct lookup_cb_evt evt;
    evt.nret = callback_info->ret;
    evt.addr = callback_info->info.lookup.addr;

    ABT_eventual *eventual = callback_info->arg;

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


321
na_return_t margo_na_addr_lookup(
322
    margo_instance_id mid,
323 324
    na_class_t   *na_class,
    na_context_t *context,
Philip Carns's avatar
Philip Carns committed
325 326
    const char   *name,
    na_addr_t    *addr)
327 328
{
    na_return_t nret;
Philip Carns's avatar
Philip Carns committed
329
    struct lookup_cb_evt *evt;
330 331 332
    ABT_eventual eventual;
    int ret;

Philip Carns's avatar
Philip Carns committed
333
    ret = ABT_eventual_create(sizeof(*evt), &eventual);
334 335 336 337 338 339 340 341 342
    if(ret != 0)
    {
        return(HG_NOMEM_ERROR);        
    }

    nret = NA_Addr_lookup(na_class, context, margo_na_addr_lookup_cb,
        &eventual, name, NA_OP_ID_IGNORE);
    if(nret == 0)
    {
Philip Carns's avatar
Philip Carns committed
343 344 345
        ABT_eventual_wait(eventual, (void**)&evt);
        *addr = evt->addr;
        nret = evt->nret;
346 347 348 349 350 351 352
    }

    ABT_eventual_free(&eventual);

    return(nret);
}

353
hg_return_t margo_bulk_transfer(
354
    margo_instance_id mid,
355
    hg_context_t *context,
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
    hg_bulk_op_t op,
    na_addr_t origin_addr,
    hg_bulk_t origin_handle,
    size_t origin_offset,
    hg_bulk_t local_handle,
    size_t local_offset,
    size_t size)
{
    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);
}

389
margo_instance_id margo_hg_class_to_instance(hg_class_t *cl)
390 391 392 393 394
{
    int i;

    for(i=0; i<handler_mapping_table_size; i++)
    {
395
        if(handler_mapping_table[i].class == cl)
396 397 398 399
            return(handler_mapping_table[i].mid);
    }
    return(NULL);
}