darshan-hdf5.c 13.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
/*
 * Copyright (C) 2015 University of Chicago.
 * See COPYRIGHT notice in top-level directory.
 *
 */

#include "darshan-runtime-config.h"
#include <stdio.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <stdarg.h>
#include <string.h>
#include <time.h>
#include <stdlib.h>
#include <errno.h>
#include <search.h>
#include <assert.h>
#define __USE_GNU
#include <pthread.h>

#include "darshan.h"
#include "darshan-dynamic.h"

/* hope this doesn't change any time soon */
typedef int hid_t;
typedef int herr_t;

DARSHAN_FORWARD_DECL(H5Fcreate, hid_t, (const char *filename, unsigned flags, hid_t create_plist, hid_t access_plist));
DARSHAN_FORWARD_DECL(H5Fopen, hid_t, (const char *filename, unsigned flags, hid_t access_plist));
DARSHAN_FORWARD_DECL(H5Fclose, herr_t, (hid_t file_id));

33 34
/* structure that can track i/o stats for a given HDF5 file record at runtime */
struct hdf5_file_record_ref
Shane Snyder's avatar
Shane Snyder committed
35
{
36
    struct darshan_hdf5_file* file_rec;
Shane Snyder's avatar
Shane Snyder committed
37 38
};

39
/* struct to encapsulate runtime state for the HDF5 module */
40 41
struct hdf5_runtime
{
42 43 44
    void *rec_id_hash;
    void *hid_hash;
    int file_rec_count;
45 46
};

47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
static void hdf5_runtime_initialize(
    void);
static struct hdf5_file_record_ref *hdf5_track_new_file_record(
    darshan_record_id rec_id, const char *path);
static int hdf5_record_compare(
    const void* a, const void* b);
static void hdf5_record_reduction_op(
    void* infile_v, void* inoutfile_v, int *len, MPI_Datatype *datatype);
static void hdf5_cleanup_runtime(
    void);

static void hdf5_shutdown(
    MPI_Comm mod_comm, darshan_record_id *shared_recs,
    int shared_rec_count, void **hdf5_buf, int *hdf5_buf_sz);

62 63 64 65 66 67 68 69
static struct hdf5_runtime *hdf5_runtime = NULL;
static pthread_mutex_t hdf5_runtime_mutex = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP;
static int instrumentation_disabled = 0;
static int my_rank = -1;

#define HDF5_LOCK() pthread_mutex_lock(&hdf5_runtime_mutex)
#define HDF5_UNLOCK() pthread_mutex_unlock(&hdf5_runtime_mutex)

70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
#define HDF5_PRE_RECORD() do { \
    HDF5_LOCK(); \
    if(!hdf5_runtime && !instrumentation_disabled) hdf5_runtime_initialize(); \
    if(!hdf5_runtime) { \
        HDF5_UNLOCK(); \
        return(ret); \
    } \
} while(0)

#define HDF5_POST_RECORD() do { \
    HDF5_UNLOCK(); \
} while(0)

#define HDF5_RECORD_OPEN(__ret, __path, __tm1) do { \
    darshan_record_id rec_id; \
    struct hdf5_file_record_ref *rec_ref; \
    char *newpath; \
    newpath = darshan_clean_file_path(__path); \
    if(!newpath) newpath = (char *)__path; \
    if(darshan_core_excluded_path(newpath)) { \
        if(newpath != __path) free(newpath); \
        break; \
    } \
    rec_id = darshan_core_gen_record_id(newpath); \
    rec_ref = darshan_lookup_record_ref(hdf5_runtime->rec_id_hash, &rec_id, sizeof(darshan_record_id)); \
    if(!rec_ref) rec_ref = hdf5_track_new_file_record(rec_id, newpath); \
    if(!rec_ref) { \
        if(newpath != __path) free(newpath); \
        break; \
    } \
    if(rec_ref->file_rec->fcounters[HDF5_F_OPEN_TIMESTAMP] == 0) \
        rec_ref->file_rec->fcounters[HDF5_F_OPEN_TIMESTAMP] = __tm1; \
    rec_ref->file_rec->counters[HDF5_OPENS] += 1; \
    darshan_add_record_ref(&(hdf5_runtime->hid_hash), &__ret, sizeof(hid_t), rec_ref); \
    if(newpath != __path) free(newpath); \
} while(0)

107 108 109 110 111 112 113 114 115 116 117 118 119
/*********************************************************
 *        Wrappers for HDF5 functions of interest        * 
 *********************************************************/

hid_t DARSHAN_DECL(H5Fcreate)(const char *filename, unsigned flags,
    hid_t create_plist, hid_t access_plist)
{
    int ret;
    char* tmp;
    double tm1;

    MAP_OR_FAIL(H5Fcreate);

Shane Snyder's avatar
Shane Snyder committed
120
    tm1 = darshan_core_wtime();
121 122 123 124 125 126 127 128 129 130 131 132 133
    ret = __real_H5Fcreate(filename, flags, create_plist, access_plist);
    if(ret >= 0)
    {
        /* use ROMIO approach to strip prefix if present */
        /* strip off prefix if there is one, but only skip prefixes
         * if they are greater than length one to allow for windows
         * drive specifications (e.g. c:\...) 
         */
        tmp = strchr(filename, ':');
        if (tmp > filename + 1) {
            filename = tmp + 1;
        }

134 135 136
        HDF5_PRE_RECORD();
        HDF5_RECORD_OPEN(ret, filename, tm1);
        HDF5_POST_RECORD();
137 138 139 140 141 142 143 144 145 146 147 148 149 150
    }

    return(ret);
}

hid_t DARSHAN_DECL(H5Fopen)(const char *filename, unsigned flags,
    hid_t access_plist)
{
    int ret;
    char* tmp;
    double tm1;

    MAP_OR_FAIL(H5Fopen);

Shane Snyder's avatar
Shane Snyder committed
151
    tm1 = darshan_core_wtime();
152 153 154 155 156 157 158 159 160 161 162 163 164
    ret = __real_H5Fopen(filename, flags, access_plist);
    if(ret >= 0)
    {
        /* use ROMIO approach to strip prefix if present */
        /* strip off prefix if there is one, but only skip prefixes
         * if they are greater than length one to allow for windows
         * drive specifications (e.g. c:\...) 
         */
        tmp = strchr(filename, ':');
        if (tmp > filename + 1) {
            filename = tmp + 1;
        }

165 166 167
        HDF5_PRE_RECORD();
        HDF5_RECORD_OPEN(ret, filename, tm1);
        HDF5_POST_RECORD();
168 169 170 171 172 173 174 175
    }

    return(ret);

}

herr_t DARSHAN_DECL(H5Fclose)(hid_t file_id)
{
176
    struct hdf5_file_record_ref *rec_ref;
177 178 179 180 181 182
    int ret;

    MAP_OR_FAIL(H5Fclose);

    ret = __real_H5Fclose(file_id);

183 184 185 186
    HDF5_PRE_RECORD();
    rec_ref = darshan_lookup_record_ref(hdf5_runtime->hid_hash,
        &file_id, sizeof(hid_t));
    if(rec_ref)
187
    {
188
        rec_ref->file_rec->fcounters[HDF5_F_CLOSE_TIMESTAMP] =
Shane Snyder's avatar
Shane Snyder committed
189
            darshan_core_wtime();
190 191
        darshan_delete_record_ref(&(hdf5_runtime->hid_hash),
            &file_id, sizeof(hid_t));
192
    }
193
    HDF5_POST_RECORD();
194 195 196 197 198 199 200 201 202

    return(ret);

}

/*********************************************************
 * Internal functions for manipulating HDF5 module state *
 *********************************************************/

Shane Snyder's avatar
Shane Snyder committed
203 204 205
/* initialize internal HDF5 module data strucutres and register with darshan-core */
static void hdf5_runtime_initialize()
{
206
    int hdf5_buf_size;
Shane Snyder's avatar
Shane Snyder committed
207

208 209 210
    /* try and store the default number of records for this module */
    hdf5_buf_size = DARSHAN_DEF_MOD_REC_COUNT * sizeof(struct darshan_hdf5_file);

Shane Snyder's avatar
Shane Snyder committed
211 212 213
    /* register hdf5 module with darshan-core */
    darshan_core_register_module(
        DARSHAN_HDF5_MOD,
214
        &hdf5_shutdown,
215
        &hdf5_buf_size,
Shane Snyder's avatar
Shane Snyder committed
216 217 218
        &my_rank,
        NULL);

219 220
    /* return if darshan-core does not provide enough module memory */
    if(hdf5_buf_size < sizeof(struct darshan_hdf5_file))
221 222
    {
        darshan_core_unregister_module(DARSHAN_HDF5_MOD);
Shane Snyder's avatar
Shane Snyder committed
223
        return;
224
    }
Shane Snyder's avatar
Shane Snyder committed
225 226 227

    hdf5_runtime = malloc(sizeof(*hdf5_runtime));
    if(!hdf5_runtime)
228 229
    {
        darshan_core_unregister_module(DARSHAN_HDF5_MOD);
Shane Snyder's avatar
Shane Snyder committed
230
        return;
231
    }
Shane Snyder's avatar
Shane Snyder committed
232 233 234 235 236
    memset(hdf5_runtime, 0, sizeof(*hdf5_runtime));

    return;
}

237 238
static struct hdf5_file_record_ref *hdf5_track_new_file_record(
    darshan_record_id rec_id, const char *path)
Shane Snyder's avatar
Shane Snyder committed
239
{
240 241
    struct darshan_hdf5_file *file_rec = NULL;
    struct hdf5_file_record_ref *rec_ref = NULL;
242
    int ret;
Shane Snyder's avatar
Shane Snyder committed
243

244 245
    rec_ref = malloc(sizeof(*rec_ref));
    if(!rec_ref)
Shane Snyder's avatar
Shane Snyder committed
246
        return(NULL);
247
    memset(rec_ref, 0, sizeof(*rec_ref));
Shane Snyder's avatar
Shane Snyder committed
248

249 250 251 252
    /* add a reference to this file record based on record id */
    ret = darshan_add_record_ref(&(hdf5_runtime->rec_id_hash), &rec_id,
        sizeof(darshan_record_id), rec_ref);
    if(ret == 0)
Shane Snyder's avatar
Shane Snyder committed
253
    {
254
        free(rec_ref);
Shane Snyder's avatar
Shane Snyder committed
255 256 257
        return(NULL);
    }

258 259
    /* register the actual file record with darshan-core so it is persisted
     * in the log file
Shane Snyder's avatar
Shane Snyder committed
260
     */
261 262 263 264 265 266
    file_rec = darshan_core_register_record(
        rec_id,
        path,
        DARSHAN_HDF5_MOD,
        sizeof(struct darshan_hdf5_file),
        NULL);
Shane Snyder's avatar
Shane Snyder committed
267

268
    if(!file_rec)
Shane Snyder's avatar
Shane Snyder committed
269
    {
270 271 272 273
        darshan_delete_record_ref(&(hdf5_runtime->rec_id_hash),
            &rec_id, sizeof(darshan_record_id));
        free(rec_ref);
        return(NULL);
Shane Snyder's avatar
Shane Snyder committed
274 275
    }

276 277 278 279 280 281 282
    /* registering this file record was successful, so initialize some fields */
    file_rec->base_rec.id = rec_id;
    file_rec->base_rec.rank = my_rank;
    rec_ref->file_rec = file_rec;
    hdf5_runtime->file_rec_count++;

    return(rec_ref);
Shane Snyder's avatar
Shane Snyder committed
283 284 285 286 287 288 289 290
}

/* compare function for sorting file records by descending rank */
static int hdf5_record_compare(const void* a_p, const void* b_p)
{
    const struct darshan_hdf5_file* a = a_p;
    const struct darshan_hdf5_file* b = b_p;

291
    if(a->base_rec.rank < b->base_rec.rank)
Shane Snyder's avatar
Shane Snyder committed
292
        return 1;
293
    if(a->base_rec.rank > b->base_rec.rank)
Shane Snyder's avatar
Shane Snyder committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
        return -1;

    return 0;
}

static void hdf5_record_reduction_op(void* infile_v, void* inoutfile_v,
    int *len, MPI_Datatype *datatype)
{
    struct darshan_hdf5_file tmp_file;
    struct darshan_hdf5_file *infile = infile_v;
    struct darshan_hdf5_file *inoutfile = inoutfile_v;
    int i, j;

    assert(hdf5_runtime);

    for(i=0; i<*len; i++)
    {
        memset(&tmp_file, 0, sizeof(struct darshan_hdf5_file));
312 313
        tmp_file.base_rec.id = infile->base_rec.id;
        tmp_file.base_rec.rank = -1;
Shane Snyder's avatar
Shane Snyder committed
314 315 316 317 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 347

        /* sum */
        for(j=HDF5_OPENS; j<=HDF5_OPENS; j++)
        {
            tmp_file.counters[j] = infile->counters[j] + inoutfile->counters[j];
        }

        /* min non-zero (if available) value */
        for(j=HDF5_F_OPEN_TIMESTAMP; j<=HDF5_F_OPEN_TIMESTAMP; j++)
        {
            if(infile->fcounters[j] > inoutfile->fcounters[j] && inoutfile->fcounters[j] > 0)
                tmp_file.fcounters[j] = inoutfile->fcounters[j];
            else
                tmp_file.fcounters[j] = infile->fcounters[j];
        }

        /* max */
        for(j=HDF5_F_CLOSE_TIMESTAMP; j<=HDF5_F_CLOSE_TIMESTAMP; j++)
        {
            if(infile->fcounters[j] > inoutfile->fcounters[j])
                tmp_file.fcounters[j] = infile->fcounters[j];
            else
                tmp_file.fcounters[j] = inoutfile->fcounters[j];
        }

        /* update pointers */
        *inoutfile = tmp_file;
        inoutfile++;
        infile++;
    }

    return;
}

348
static void hdf5_cleanup_runtime()
Shane Snyder's avatar
Shane Snyder committed
349
{
350 351
    darshan_clear_record_refs(&(hdf5_runtime->hid_hash), 0);
    darshan_clear_record_refs(&(hdf5_runtime->rec_id_hash), 1);
Shane Snyder's avatar
Shane Snyder committed
352

353 354
    free(hdf5_runtime);
    hdf5_runtime = NULL;
Shane Snyder's avatar
Shane Snyder committed
355 356 357 358

    return;
}

359 360 361 362 363
/************************************************************************
 * Functions exported by HDF5 module for coordinating with darshan-core *
 ************************************************************************/

static void hdf5_shutdown(
Shane Snyder's avatar
Shane Snyder committed
364 365 366 367 368 369
    MPI_Comm mod_comm,
    darshan_record_id *shared_recs,
    int shared_rec_count,
    void **hdf5_buf,
    int *hdf5_buf_sz)
{
370 371 372
    struct hdf5_file_record_ref *rec_ref;
    struct darshan_hdf5_file *hdf5_rec_buf = *(struct darshan_hdf5_file **)hdf5_buf;
    int hdf5_rec_count;
Shane Snyder's avatar
Shane Snyder committed
373 374 375 376
    struct darshan_hdf5_file *red_send_buf = NULL;
    struct darshan_hdf5_file *red_recv_buf = NULL;
    MPI_Datatype red_type;
    MPI_Op red_op;
377
    int i;
Shane Snyder's avatar
Shane Snyder committed
378

379
    HDF5_LOCK();
Shane Snyder's avatar
Shane Snyder committed
380
    assert(hdf5_runtime);
381
    hdf5_rec_count = hdf5_runtime->file_rec_count;
Shane Snyder's avatar
Shane Snyder committed
382 383

    /* if there are globally shared files, do a shared file reduction */
384 385 386 387
    /* NOTE: the shared file reduction is also skipped if the 
     * DARSHAN_DISABLE_SHARED_REDUCTION environment variable is set.
     */
    if(shared_rec_count && !getenv("DARSHAN_DISABLE_SHARED_REDUCTION"))
Shane Snyder's avatar
Shane Snyder committed
388 389 390 391
    {
        /* necessary initialization of shared records */
        for(i = 0; i < shared_rec_count; i++)
        {
392 393 394
            rec_ref = darshan_lookup_record_ref(hdf5_runtime->rec_id_hash,
                &shared_recs[i], sizeof(darshan_record_id));
            assert(rec_ref);
Shane Snyder's avatar
Shane Snyder committed
395

396
            rec_ref->file_rec->base_rec.rank = -1;
Shane Snyder's avatar
Shane Snyder committed
397 398 399 400 401 402
        }

        /* sort the array of files descending by rank so that we get all of the 
         * shared files (marked by rank -1) in a contiguous portion at end 
         * of the array
         */
403 404
        qsort(hdf5_rec_buf, hdf5_rec_count, sizeof(struct darshan_hdf5_file),
            hdf5_record_compare);
Shane Snyder's avatar
Shane Snyder committed
405 406

        /* make *send_buf point to the shared files at the end of sorted array */
407
        red_send_buf = &(hdf5_rec_buf[hdf5_rec_count-shared_rec_count]);
Shane Snyder's avatar
Shane Snyder committed
408 409 410 411 412 413

        /* allocate memory for the reduction output on rank 0 */
        if(my_rank == 0)
        {
            red_recv_buf = malloc(shared_rec_count * sizeof(struct darshan_hdf5_file));
            if(!red_recv_buf)
414
            {
415
                HDF5_UNLOCK();
Shane Snyder's avatar
Shane Snyder committed
416
                return;
417
            }
Shane Snyder's avatar
Shane Snyder committed
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
        }

        /* construct a datatype for a HDF5 file record.  This is serving no purpose
         * except to make sure we can do a reduction on proper boundaries
         */
        DARSHAN_MPI_CALL(PMPI_Type_contiguous)(sizeof(struct darshan_hdf5_file),
            MPI_BYTE, &red_type);
        DARSHAN_MPI_CALL(PMPI_Type_commit)(&red_type);

        /* register a HDF5 file record reduction operator */
        DARSHAN_MPI_CALL(PMPI_Op_create)(hdf5_record_reduction_op, 1, &red_op);

        /* reduce shared HDF5 file records */
        DARSHAN_MPI_CALL(PMPI_Reduce)(red_send_buf, red_recv_buf,
            shared_rec_count, red_type, red_op, 0, mod_comm);

        /* clean up reduction state */
        if(my_rank == 0)
        {
437 438
            int tmp_ndx = hdf5_rec_count - shared_rec_count;
            memcpy(&(hdf5_rec_buf[tmp_ndx]), red_recv_buf,
Shane Snyder's avatar
Shane Snyder committed
439 440 441 442 443
                shared_rec_count * sizeof(struct darshan_hdf5_file));
            free(red_recv_buf);
        }
        else
        {
444
            hdf5_rec_count -= shared_rec_count;
Shane Snyder's avatar
Shane Snyder committed
445 446 447 448 449 450
        }

        DARSHAN_MPI_CALL(PMPI_Type_free)(&red_type);
        DARSHAN_MPI_CALL(PMPI_Op_free)(&red_op);
    }

451 452
    /* update output buffer size to account for shared file reduction */
    *hdf5_buf_sz = hdf5_rec_count * sizeof(struct darshan_hdf5_file);
Shane Snyder's avatar
Shane Snyder committed
453

454 455
    /* shutdown internal structures used for instrumenting */
    hdf5_cleanup_runtime();
Shane Snyder's avatar
Shane Snyder committed
456

457 458
    /* disable further instrumentation */
    instrumentation_disabled = 1;
Shane Snyder's avatar
Shane Snyder committed
459

460
    HDF5_UNLOCK();
Shane Snyder's avatar
Shane Snyder committed
461 462
    return;
}
463 464 465 466 467 468 469 470 471

/*
 * Local variables:
 *  c-indent-level: 4
 *  c-basic-offset: 4
 * End:
 *
 * vim: ts=8 sts=4 sw=4 expandtab
 */