darshan-hdf5.c 14.3 KB
Newer Older
1 2 3 4 5 6
/*
 * Copyright (C) 2015 University of Chicago.
 * See COPYRIGHT notice in top-level directory.
 *
 */

7 8 9
#define _XOPEN_SOURCE 500
#define _GNU_SOURCE

10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
#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>
#include <pthread.h>

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

/* hope this doesn't change any time soon */
28 29 30 31 32 33 34
typedef int herr_t;     //hf5-1.10.0p1: H5public.h:126

#ifdef __DARSHAN_ENABLE_HDF5110
  typedef int64_t hid_t;  //hf5-1.10.0p1: H5Ipublic.h:56
#else
  typedef int hid_t;
#endif
35 36 37 38

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));
39 40 41 42 43

/* prototype for HDF symbols that we will call directly from within other
 * wrappers if HDF is linked in
 */
extern herr_t H5get_libversion(unsigned *majnum, unsigned *minnum, unsigned *relnum);
44

45 46
/* 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
47
{
48
    struct darshan_hdf5_file* file_rec;
Shane Snyder's avatar
Shane Snyder committed
49 50
};

51
/* struct to encapsulate runtime state for the HDF5 module */
52 53
struct hdf5_runtime
{
54 55 56
    void *rec_id_hash;
    void *hid_hash;
    int file_rec_count;
57 58
};

59 60 61 62 63 64 65 66 67 68 69 70 71
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 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);

72 73 74 75 76 77 78
static struct hdf5_runtime *hdf5_runtime = NULL;
static pthread_mutex_t hdf5_runtime_mutex = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP;
static int my_rank = -1;

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

79 80
#define HDF5_PRE_RECORD() do { \
    HDF5_LOCK(); \
81
    if(!darshan_core_disabled_instrumentation()) { \
82 83
        if(!hdf5_runtime) hdf5_runtime_initialize(); \
        if(hdf5_runtime) break; \
84
    } \
85 86
    HDF5_UNLOCK(); \
    return(ret); \
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
} 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)

117 118 119 120 121 122 123
/*********************************************************
 *        Wrappers for HDF5 functions of interest        * 
 *********************************************************/

hid_t DARSHAN_DECL(H5Fcreate)(const char *filename, unsigned flags,
    hid_t create_plist, hid_t access_plist)
{
124
    hid_t ret;
125 126
    char* tmp;
    double tm1;
127 128
    unsigned majnum, minnum, relnum;

129
    H5get_libversion(&majnum, &minnum, &relnum);
130
#ifdef __DARSHAN_ENABLE_HDF5110
Philip Carns's avatar
Philip Carns committed
131
    if(majnum < 1 || (majnum == 1 && minnum < 10))
132
#else
Philip Carns's avatar
Philip Carns committed
133
    if(majnum > 1 || (majnum == 1 && minnum >= 10))
134 135
#endif
    {
Philip Carns's avatar
Philip Carns committed
136 137
        if(my_rank < 0)
            MPI_Comm_rank(MPI_COMM_WORLD, &my_rank);
138 139 140 141 142 143
        if(my_rank == 0)
        {
            fprintf(stderr, "Darshan HDF5 module error: runtime library version does not match Darshan module.\n");
        }
        return(-1);
    }
144 145 146

    MAP_OR_FAIL(H5Fcreate);

Shane Snyder's avatar
Shane Snyder committed
147
    tm1 = darshan_core_wtime();
148 149 150 151 152 153 154 155 156 157 158 159 160
    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;
        }

161 162 163
        HDF5_PRE_RECORD();
        HDF5_RECORD_OPEN(ret, filename, tm1);
        HDF5_POST_RECORD();
164 165 166 167 168 169 170 171
    }

    return(ret);
}

hid_t DARSHAN_DECL(H5Fopen)(const char *filename, unsigned flags,
    hid_t access_plist)
{
172
    hid_t ret;
173 174
    char* tmp;
    double tm1;
175 176
    unsigned majnum, minnum, relnum;

177
    H5get_libversion(&majnum, &minnum, &relnum);
178
#ifdef __DARSHAN_ENABLE_HDF5110
Philip Carns's avatar
Philip Carns committed
179
    if(majnum < 1 || (majnum == 1 && minnum < 10))
180
#else
Philip Carns's avatar
Philip Carns committed
181
    if(majnum > 1 || (majnum == 1 && minnum >= 10))
182 183
#endif
    {
Philip Carns's avatar
Philip Carns committed
184 185
        if(my_rank < 0)
            MPI_Comm_rank(MPI_COMM_WORLD, &my_rank);
186 187 188 189 190 191
        if(my_rank == 0)
        {
            fprintf(stderr, "Darshan HDF5 module error: runtime library version does not match Darshan module.\n");
        }
        return(-1);
    }
192 193 194

    MAP_OR_FAIL(H5Fopen);

Shane Snyder's avatar
Shane Snyder committed
195
    tm1 = darshan_core_wtime();
196 197 198 199 200 201 202 203 204 205 206 207 208
    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;
        }

209 210 211
        HDF5_PRE_RECORD();
        HDF5_RECORD_OPEN(ret, filename, tm1);
        HDF5_POST_RECORD();
212 213 214 215 216 217 218 219
    }

    return(ret);

}

herr_t DARSHAN_DECL(H5Fclose)(hid_t file_id)
{
220
    struct hdf5_file_record_ref *rec_ref;
221
    herr_t ret;
222 223 224 225 226

    MAP_OR_FAIL(H5Fclose);

    ret = __real_H5Fclose(file_id);

227 228 229 230
    HDF5_PRE_RECORD();
    rec_ref = darshan_lookup_record_ref(hdf5_runtime->hid_hash,
        &file_id, sizeof(hid_t));
    if(rec_ref)
231
    {
232
        rec_ref->file_rec->fcounters[HDF5_F_CLOSE_TIMESTAMP] =
Shane Snyder's avatar
Shane Snyder committed
233
            darshan_core_wtime();
234 235
        darshan_delete_record_ref(&(hdf5_runtime->hid_hash),
            &file_id, sizeof(hid_t));
236
    }
237
    HDF5_POST_RECORD();
238 239 240 241 242 243 244 245 246

    return(ret);

}

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

Shane Snyder's avatar
Shane Snyder committed
247 248 249
/* initialize internal HDF5 module data strucutres and register with darshan-core */
static void hdf5_runtime_initialize()
{
250
    int hdf5_buf_size;
Shane Snyder's avatar
Shane Snyder committed
251

252 253 254
    /* 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
255 256 257
    /* register hdf5 module with darshan-core */
    darshan_core_register_module(
        DARSHAN_HDF5_MOD,
258
        &hdf5_shutdown,
259
        &hdf5_buf_size,
Shane Snyder's avatar
Shane Snyder committed
260 261 262
        &my_rank,
        NULL);

263 264
    /* return if darshan-core does not provide enough module memory */
    if(hdf5_buf_size < sizeof(struct darshan_hdf5_file))
265 266
    {
        darshan_core_unregister_module(DARSHAN_HDF5_MOD);
Shane Snyder's avatar
Shane Snyder committed
267
        return;
268
    }
Shane Snyder's avatar
Shane Snyder committed
269 270 271

    hdf5_runtime = malloc(sizeof(*hdf5_runtime));
    if(!hdf5_runtime)
272 273
    {
        darshan_core_unregister_module(DARSHAN_HDF5_MOD);
Shane Snyder's avatar
Shane Snyder committed
274
        return;
275
    }
Shane Snyder's avatar
Shane Snyder committed
276 277 278 279 280
    memset(hdf5_runtime, 0, sizeof(*hdf5_runtime));

    return;
}

281 282
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
283
{
284 285
    struct darshan_hdf5_file *file_rec = NULL;
    struct hdf5_file_record_ref *rec_ref = NULL;
286
    int ret;
Shane Snyder's avatar
Shane Snyder committed
287

288 289
    rec_ref = malloc(sizeof(*rec_ref));
    if(!rec_ref)
Shane Snyder's avatar
Shane Snyder committed
290
        return(NULL);
291
    memset(rec_ref, 0, sizeof(*rec_ref));
Shane Snyder's avatar
Shane Snyder committed
292

293 294 295 296
    /* 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
297
    {
298
        free(rec_ref);
Shane Snyder's avatar
Shane Snyder committed
299 300 301
        return(NULL);
    }

302 303
    /* register the actual file record with darshan-core so it is persisted
     * in the log file
Shane Snyder's avatar
Shane Snyder committed
304
     */
305 306 307 308 309 310
    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
311

312
    if(!file_rec)
Shane Snyder's avatar
Shane Snyder committed
313
    {
314 315 316 317
        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
318 319
    }

320 321 322 323 324 325 326
    /* 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
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
}

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));
342 343
        tmp_file.base_rec.id = infile->base_rec.id;
        tmp_file.base_rec.rank = -1;
Shane Snyder's avatar
Shane Snyder committed
344 345 346 347 348 349 350 351 352 353

        /* 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++)
        {
354 355
            if((infile->fcounters[j] < inoutfile->fcounters[j] &&
               infile->fcounters[j] > 0) || inoutfile->fcounters[j] == 0) 
Shane Snyder's avatar
Shane Snyder committed
356
                tmp_file.fcounters[j] = infile->fcounters[j];
357 358
            else
                tmp_file.fcounters[j] = inoutfile->fcounters[j];
Shane Snyder's avatar
Shane Snyder committed
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
        }

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

379
static void hdf5_cleanup_runtime()
Shane Snyder's avatar
Shane Snyder committed
380
{
381 382
    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
383

384 385
    free(hdf5_runtime);
    hdf5_runtime = NULL;
Shane Snyder's avatar
Shane Snyder committed
386 387 388 389

    return;
}

390 391 392 393 394
/************************************************************************
 * Functions exported by HDF5 module for coordinating with darshan-core *
 ************************************************************************/

static void hdf5_shutdown(
Shane Snyder's avatar
Shane Snyder committed
395 396 397 398 399 400
    MPI_Comm mod_comm,
    darshan_record_id *shared_recs,
    int shared_rec_count,
    void **hdf5_buf,
    int *hdf5_buf_sz)
{
401 402 403
    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
404 405 406 407
    struct darshan_hdf5_file *red_send_buf = NULL;
    struct darshan_hdf5_file *red_recv_buf = NULL;
    MPI_Datatype red_type;
    MPI_Op red_op;
408
    int i;
Shane Snyder's avatar
Shane Snyder committed
409

410
    HDF5_LOCK();
Shane Snyder's avatar
Shane Snyder committed
411
    assert(hdf5_runtime);
412

413
    hdf5_rec_count = hdf5_runtime->file_rec_count;
Shane Snyder's avatar
Shane Snyder committed
414 415

    /* if there are globally shared files, do a shared file reduction */
416 417 418 419
    /* 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
420 421 422 423
    {
        /* necessary initialization of shared records */
        for(i = 0; i < shared_rec_count; i++)
        {
424 425 426
            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
427

428
            rec_ref->file_rec->base_rec.rank = -1;
Shane Snyder's avatar
Shane Snyder committed
429 430
        }

431 432
        /* sort the array of records so we get all of the shared records
         * (marked by rank -1) in a contiguous portion at end of the array
Shane Snyder's avatar
Shane Snyder committed
433
         */
434 435
        darshan_record_sort(hdf5_rec_buf, hdf5_rec_count,
            sizeof(struct darshan_hdf5_file));
Shane Snyder's avatar
Shane Snyder committed
436 437

        /* make *send_buf point to the shared files at the end of sorted array */
438
        red_send_buf = &(hdf5_rec_buf[hdf5_rec_count-shared_rec_count]);
Shane Snyder's avatar
Shane Snyder committed
439 440 441 442 443 444

        /* 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)
445
            {
446
                HDF5_UNLOCK();
Shane Snyder's avatar
Shane Snyder committed
447
                return;
448
            }
Shane Snyder's avatar
Shane Snyder committed
449 450 451 452 453
        }

        /* 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
         */
454
        PMPI_Type_contiguous(sizeof(struct darshan_hdf5_file),
Shane Snyder's avatar
Shane Snyder committed
455
            MPI_BYTE, &red_type);
456
        PMPI_Type_commit(&red_type);
Shane Snyder's avatar
Shane Snyder committed
457 458

        /* register a HDF5 file record reduction operator */
459
        PMPI_Op_create(hdf5_record_reduction_op, 1, &red_op);
Shane Snyder's avatar
Shane Snyder committed
460 461

        /* reduce shared HDF5 file records */
462
        PMPI_Reduce(red_send_buf, red_recv_buf,
Shane Snyder's avatar
Shane Snyder committed
463 464 465 466 467
            shared_rec_count, red_type, red_op, 0, mod_comm);

        /* clean up reduction state */
        if(my_rank == 0)
        {
468 469
            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
470 471 472 473 474
                shared_rec_count * sizeof(struct darshan_hdf5_file));
            free(red_recv_buf);
        }
        else
        {
475
            hdf5_rec_count -= shared_rec_count;
Shane Snyder's avatar
Shane Snyder committed
476 477
        }

478 479
        PMPI_Type_free(&red_type);
        PMPI_Op_free(&red_op);
Shane Snyder's avatar
Shane Snyder committed
480 481
    }

482 483
    /* 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
484

485 486
    /* shutdown internal structures used for instrumenting */
    hdf5_cleanup_runtime();
Shane Snyder's avatar
Shane Snyder committed
487

488
    HDF5_UNLOCK();
Shane Snyder's avatar
Shane Snyder committed
489 490
    return;
}
491 492 493 494 495 496 497 498 499

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