GitLab maintenance scheduled form Friday, 2021-06-18 5:00pm to Satursday, 2021-06-19 10:00pm CT - Services will be unavailable during this time.

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

Philip Carns's avatar
Philip Carns committed
7 8 9 10 11
/* catalog of stdio functions instrumented by this module
 *
 * functions for opening streams
 * --------------
 * FILE    *fdopen(int, const char *);                      DONE
Philip Carns's avatar
Philip Carns committed
12
 * FILE    *fopen(const char *, const char *);              DONE
Philip Carns's avatar
Philip Carns committed
13
 * FILE    *fopen64(const char *, const char *);            DONE
Philip Carns's avatar
Philip Carns committed
14
 * FILE    *freopen(const char *, const char *, FILE *);    DONE
Philip Carns's avatar
Philip Carns committed
15
 * FILE    *freopen64(const char *, const char *, FILE *);  DONE
Philip Carns's avatar
Philip Carns committed
16 17 18 19 20 21 22
 *
 * functions for closing streams
 * --------------
 * int      fclose(FILE *);                                 DONE
 *
 * functions for flushing streams
 * --------------
Philip Carns's avatar
Philip Carns committed
23
 * int      fflush(FILE *);                                 DONE
Philip Carns's avatar
Philip Carns committed
24 25 26
 *
 * functions for reading data
 * --------------
Philip Carns's avatar
Philip Carns committed
27
 * int      fgetc(FILE *);                                  DONE
Philip Carns's avatar
Philip Carns committed
28
 * char    *fgets(char *, int, FILE *);                     DONE
Philip Carns's avatar
Philip Carns committed
29
 * size_t   fread(void *, size_t, size_t, FILE *);          DONE
Philip Carns's avatar
Philip Carns committed
30 31
 * int      fscanf(FILE *, const char *, ...);              DONE
 * int      vfscanf(FILE *, const char *, va_list);         DONE
Philip Carns's avatar
Philip Carns committed
32
 * int      getc(FILE *);                                   DONE
Philip Carns's avatar
Philip Carns committed
33
 * int      getw(FILE *);                                   DONE
Philip Carns's avatar
Philip Carns committed
34 35 36
 *
 * functions for writing data
 * --------------
Philip Carns's avatar
Philip Carns committed
37 38
 * int      fprintf(FILE *, const char *, ...);             DONE
 * int      vfprintf(FILE *, const char *, va_list);        DONE
Philip Carns's avatar
Philip Carns committed
39
 * int      fputc(int, FILE *);                             DONE
Philip Carns's avatar
Philip Carns committed
40
 * int      fputs(const char *, FILE *);                    DONE
Philip Carns's avatar
Philip Carns committed
41
 * size_t   fwrite(const void *, size_t, size_t, FILE *);   DONE
Philip Carns's avatar
Philip Carns committed
42
 * int      putc(int, FILE *);                              DONE
Philip Carns's avatar
Philip Carns committed
43
 * int      putw(int, FILE *);                              DONE
Philip Carns's avatar
Philip Carns committed
44 45 46 47
 *
 * functions for changing file position
 * --------------
 * int      fseek(FILE *, long int, int);                   DONE
Philip Carns's avatar
Philip Carns committed
48
 * int      fseeko(FILE *, off_t, int);                     DONE
Philip Carns's avatar
Philip Carns committed
49
 * int      fseeko64(FILE *, off_t, int);                   DONE
50 51
 * int      fsetpos(FILE *, const fpos_t *);                DONE
 * int      fsetpos64(FILE *, const fpos_t *);              DONE
Philip Carns's avatar
Philip Carns committed
52
 * void     rewind(FILE *);                                 DONE
Philip Carns's avatar
Philip Carns committed
53
 *
54 55 56 57 58
 * Omissions: 
 *   - _unlocked() variants of the various flush, read, and write
 *     functions.  There are many of these, but they are not available on all
 *     systems and the man page advises not to use them.
 *   - ungetc()
Philip Carns's avatar
Philip Carns committed
59 60
 */

61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
#define _XOPEN_SOURCE 500
#define _GNU_SOURCE

#include "darshan-runtime-config.h"
#include <stdio.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <stdarg.h>
#include <string.h>
#include <time.h>
#include <stdlib.h>
#include <errno.h>
#include <sys/uio.h>
#include <sys/mman.h>
#include <search.h>
#include <assert.h>
#include <libgen.h>
#include <pthread.h>
81 82
#include <stdint.h>
#include <limits.h>
83 84 85 86

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

87 88 89 90
#ifndef HAVE_OFF64_T
typedef int64_t off64_t;
#endif

91 92
DARSHAN_FORWARD_DECL(fopen, FILE*, (const char *path, const char *mode));
DARSHAN_FORWARD_DECL(fopen64, FILE*, (const char *path, const char *mode));
Philip Carns's avatar
Philip Carns committed
93
DARSHAN_FORWARD_DECL(fdopen, FILE*, (int fd, const char *mode));
Philip Carns's avatar
Philip Carns committed
94
DARSHAN_FORWARD_DECL(freopen, FILE*, (const char *path, const char *mode, FILE *stream));
Philip Carns's avatar
Philip Carns committed
95
DARSHAN_FORWARD_DECL(freopen64, FILE*, (const char *path, const char *mode, FILE *stream));
96
DARSHAN_FORWARD_DECL(fclose, int, (FILE *fp));
Philip Carns's avatar
Philip Carns committed
97
DARSHAN_FORWARD_DECL(fflush, int, (FILE *fp));
98
DARSHAN_FORWARD_DECL(fwrite, size_t, (const void *ptr, size_t size, size_t nmemb, FILE *stream));
Philip Carns's avatar
Philip Carns committed
99
DARSHAN_FORWARD_DECL(fputc, int, (int c, FILE *stream));
Philip Carns's avatar
Philip Carns committed
100
DARSHAN_FORWARD_DECL(putw, int, (int w, FILE *stream));
Philip Carns's avatar
Philip Carns committed
101
DARSHAN_FORWARD_DECL(fputs, int, (const char *s, FILE *stream));
Philip Carns's avatar
Philip Carns committed
102
DARSHAN_FORWARD_DECL(fprintf, int, (FILE *stream, const char *format, ...));
103
DARSHAN_FORWARD_DECL(printf, int, (const char *format, ...));
Philip Carns's avatar
Philip Carns committed
104
DARSHAN_FORWARD_DECL(vfprintf, int, (FILE *stream, const char *format, va_list));
105
DARSHAN_FORWARD_DECL(vprintf, int, (const char *format, va_list));
106
DARSHAN_FORWARD_DECL(fread, size_t, (void *ptr, size_t size, size_t nmemb, FILE *stream));
Philip Carns's avatar
Philip Carns committed
107
DARSHAN_FORWARD_DECL(fgetc, int, (FILE *stream));
Philip Carns's avatar
Philip Carns committed
108
DARSHAN_FORWARD_DECL(getw, int, (FILE *stream));
Philip Carns's avatar
Philip Carns committed
109
DARSHAN_FORWARD_DECL(_IO_getc, int, (FILE *stream));
Philip Carns's avatar
Philip Carns committed
110
DARSHAN_FORWARD_DECL(_IO_putc, int, (int, FILE *stream));
Philip Carns's avatar
Philip Carns committed
111
DARSHAN_FORWARD_DECL(fscanf, int, (FILE *stream, const char *format, ...));
112
#ifndef HAVE_FSCANF_REDIRECT
Philip Carns's avatar
Philip Carns committed
113
DARSHAN_FORWARD_DECL(__isoc99_fscanf, int, (FILE *stream, const char *format, ...));
114
#endif
Philip Carns's avatar
Philip Carns committed
115
DARSHAN_FORWARD_DECL(vfscanf, int, (FILE *stream, const char *format, va_list ap));
Philip Carns's avatar
Philip Carns committed
116
DARSHAN_FORWARD_DECL(fgets, char*, (char *s, int size, FILE *stream));
117
DARSHAN_FORWARD_DECL(fseek, int, (FILE *stream, long offset, int whence));
Philip Carns's avatar
Philip Carns committed
118
DARSHAN_FORWARD_DECL(fseeko, int, (FILE *stream, off_t offset, int whence));
119
DARSHAN_FORWARD_DECL(fseeko64, int, (FILE *stream, off64_t offset, int whence));
120
DARSHAN_FORWARD_DECL(fsetpos, int, (FILE *stream, const fpos_t *pos));
121
DARSHAN_FORWARD_DECL(fsetpos64, int, (FILE *stream, const fpos64_t *pos));
Philip Carns's avatar
Philip Carns committed
122
DARSHAN_FORWARD_DECL(rewind, void, (FILE *stream));
123

124 125
/* structure to track stdio stats at runtime */
struct stdio_file_record_ref
126
{
127
    struct darshan_stdio_file* file_rec;
128 129 130 131
    int64_t offset;
    double last_meta_end;
    double last_read_end;
    double last_write_end;
132
    int fs_type;
133 134 135 136 137 138 139 140
};

/* The stdio_runtime structure maintains necessary state for storing
 * STDIO file records and for coordinating with darshan-core at 
 * shutdown time.
 */
struct stdio_runtime
{
141 142 143
    void *rec_id_hash;
    void *stream_hash;
    int file_rec_count;
144 145 146 147 148 149 150
};

static struct stdio_runtime *stdio_runtime = NULL;
static pthread_mutex_t stdio_runtime_mutex = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP;
static int darshan_mem_alignment = 1;
static int my_rank = -1;

151 152 153 154 155 156 157
static void stdio_runtime_initialize(
    void);
static struct stdio_file_record_ref *stdio_track_new_file_record(
    darshan_record_id rec_id, const char *path);
static void stdio_cleanup_runtime(
    void);
#ifdef HAVE_MPI
158 159
static void stdio_record_reduction_op(void* infile_v, void* inoutfile_v,
    int *len, MPI_Datatype *datatype);
160 161 162
static void stdio_shared_record_variance(
    MPI_Comm mod_comm, struct darshan_stdio_file *inrec_array,
    struct darshan_stdio_file *outrec_array, int shared_rec_count);
163 164 165 166 167 168
static void stdio_mpi_redux(
    void *stdio_buf, MPI_Comm mod_comm,
    darshan_record_id *shared_recs, int shared_rec_count);
#endif
static void stdio_shutdown(
    void **stdio_buf, int *stdio_buf_sz);
169

170 171 172
/* extern function def for querying record name from a POSIX fd */
extern char *darshan_posix_lookup_record_name(int fd);

173 174 175 176 177 178
/* we need access to fileno (defined in POSIX module) for instrumenting fopen calls */
#ifdef DARSHAN_PRELOAD
extern int (*__real_fileno)(FILE *stream);
#else
extern int __real_fileno(FILE *stream);
#endif
179

180 181 182
#define STDIO_LOCK() pthread_mutex_lock(&stdio_runtime_mutex)
#define STDIO_UNLOCK() pthread_mutex_unlock(&stdio_runtime_mutex)

183 184
#define STDIO_PRE_RECORD() do { \
    STDIO_LOCK(); \
185
    if(!darshan_core_disabled_instrumentation()) { \
186 187
        if(!stdio_runtime) stdio_runtime_initialize(); \
        if(stdio_runtime) break; \
188
    } \
189 190
    STDIO_UNLOCK(); \
    return(ret); \
191 192 193 194 195 196
} while(0)

#define STDIO_POST_RECORD() do { \
    STDIO_UNLOCK(); \
} while(0)

197
#define STDIO_RECORD_OPEN(__ret, __path, __tm1, __tm2) do { \
198 199 200
    darshan_record_id __rec_id; \
    struct stdio_file_record_ref *__rec_ref; \
    char *__newpath; \
201
    int __fd; \
202
    MAP_OR_FAIL(fileno); \
203 204 205 206 207
    if(!__ret || !__path) break; \
    __newpath = darshan_clean_file_path(__path); \
    if(!__newpath) __newpath = (char*)__path; \
    if(darshan_core_excluded_path(__newpath)) { \
        if(__newpath != (char*)__path) free(__newpath); \
208
        break; \
209
    } \
210 211 212 213 214
    __rec_id = darshan_core_gen_record_id(__newpath); \
    __rec_ref = darshan_lookup_record_ref(stdio_runtime->rec_id_hash, &__rec_id, sizeof(darshan_record_id)); \
    if(!__rec_ref) __rec_ref = stdio_track_new_file_record(__rec_id, __newpath); \
    if(!__rec_ref) { \
        if(__newpath != (char*)__path) free(__newpath); \
215 216
        break; \
    } \
217
    _STDIO_RECORD_OPEN(__ret, __rec_ref, __tm1, __tm2, 1, -1); \
218
    __fd = __real_fileno(__ret); \
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
    darshan_instrument_fs_data(__rec_ref->fs_type, __newpath, __fd); \
    if(__newpath != (char*)__path) free(__newpath); \
} while(0)

#define STDIO_RECORD_REFOPEN(__ret, __rec_ref, __tm1, __tm2, __ref_counter) do { \
    if(!ret || !rec_ref) break; \
    _STDIO_RECORD_OPEN(__ret, __rec_ref, __tm1, __tm2, 0, __ref_counter); \
} while(0)

#define _STDIO_RECORD_OPEN(__ret, __rec_ref, __tm1, __tm2, __reset_flag, __ref_counter) do { \
    if(__reset_flag) __rec_ref->offset = 0; \
    __rec_ref->file_rec->counters[STDIO_OPENS] += 1; \
    if(__ref_counter >= 0) __rec_ref->file_rec->counters[__ref_counter] += 1; \
    if(__rec_ref->file_rec->fcounters[STDIO_F_OPEN_START_TIMESTAMP] == 0 || \
     __rec_ref->file_rec->fcounters[STDIO_F_OPEN_START_TIMESTAMP] > __tm1) \
        __rec_ref->file_rec->fcounters[STDIO_F_OPEN_START_TIMESTAMP] = __tm1; \
    __rec_ref->file_rec->fcounters[STDIO_F_OPEN_END_TIMESTAMP] = __tm2; \
    DARSHAN_TIMER_INC_NO_OVERLAP(__rec_ref->file_rec->fcounters[STDIO_F_META_TIME], __tm1, __tm2, __rec_ref->last_meta_end); \
    darshan_add_record_ref(&(stdio_runtime->stream_hash), &(__ret), sizeof(__ret), __rec_ref); \
238 239 240
} while(0)


241
#define STDIO_RECORD_READ(__fp, __bytes,  __tm1, __tm2) do{ \
242
    struct stdio_file_record_ref* rec_ref; \
243
    int64_t this_offset; \
Philip Carns's avatar
Philip Carns committed
244
    rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &(__fp), sizeof(__fp)); \
245 246 247 248 249 250 251 252 253 254 255
    if(!rec_ref) break; \
    this_offset = rec_ref->offset; \
    rec_ref->offset = this_offset + __bytes; \
    if(rec_ref->file_rec->counters[STDIO_MAX_BYTE_READ] < (this_offset + __bytes - 1)) \
        rec_ref->file_rec->counters[STDIO_MAX_BYTE_READ] = (this_offset + __bytes - 1); \
    rec_ref->file_rec->counters[STDIO_BYTES_READ] += __bytes; \
    rec_ref->file_rec->counters[STDIO_READS] += 1; \
    if(rec_ref->file_rec->fcounters[STDIO_F_READ_START_TIMESTAMP] == 0 || \
     rec_ref->file_rec->fcounters[STDIO_F_READ_START_TIMESTAMP] > __tm1) \
        rec_ref->file_rec->fcounters[STDIO_F_READ_START_TIMESTAMP] = __tm1; \
    rec_ref->file_rec->fcounters[STDIO_F_READ_END_TIMESTAMP] = __tm2; \
256
    DARSHAN_TIMER_INC_NO_OVERLAP(rec_ref->file_rec->fcounters[STDIO_F_READ_TIME], __tm1, __tm2, rec_ref->last_read_end); \
257 258
} while(0)

Philip Carns's avatar
Philip Carns committed
259
#define STDIO_RECORD_WRITE(__fp, __bytes,  __tm1, __tm2, __fflush_flag) do{ \
260
    struct stdio_file_record_ref* rec_ref; \
261
    int64_t this_offset; \
Philip Carns's avatar
Philip Carns committed
262
    rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &(__fp), sizeof(__fp)); \
263 264 265 266 267 268
    if(!rec_ref) break; \
    this_offset = rec_ref->offset; \
    rec_ref->offset = this_offset + __bytes; \
    if(rec_ref->file_rec->counters[STDIO_MAX_BYTE_WRITTEN] < (this_offset + __bytes - 1)) \
        rec_ref->file_rec->counters[STDIO_MAX_BYTE_WRITTEN] = (this_offset + __bytes - 1); \
    rec_ref->file_rec->counters[STDIO_BYTES_WRITTEN] += __bytes; \
Philip Carns's avatar
Philip Carns committed
269
    if(__fflush_flag) \
270
        rec_ref->file_rec->counters[STDIO_FLUSHES] += 1; \
Philip Carns's avatar
Philip Carns committed
271
    else \
272 273 274 275 276 277
        rec_ref->file_rec->counters[STDIO_WRITES] += 1; \
    if(rec_ref->file_rec->fcounters[STDIO_F_WRITE_START_TIMESTAMP] == 0 || \
     rec_ref->file_rec->fcounters[STDIO_F_WRITE_START_TIMESTAMP] > __tm1) \
        rec_ref->file_rec->fcounters[STDIO_F_WRITE_START_TIMESTAMP] = __tm1; \
    rec_ref->file_rec->fcounters[STDIO_F_WRITE_END_TIMESTAMP] = __tm2; \
    DARSHAN_TIMER_INC_NO_OVERLAP(rec_ref->file_rec->fcounters[STDIO_F_WRITE_TIME], __tm1, __tm2, rec_ref->last_write_end); \
278
} while(0)
279

Philip Carns's avatar
Philip Carns committed
280
FILE* DARSHAN_DECL(fopen)(const char *path, const char *mode)
Philip Carns's avatar
Philip Carns committed
281 282 283 284
{
    FILE* ret;
    double tm1, tm2;

Philip Carns's avatar
Philip Carns committed
285
    MAP_OR_FAIL(fopen);
Philip Carns's avatar
Philip Carns committed
286 287

    tm1 = darshan_core_wtime();
Philip Carns's avatar
Philip Carns committed
288
    ret = __real_fopen(path, mode);
Philip Carns's avatar
Philip Carns committed
289 290
    tm2 = darshan_core_wtime();

291
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
292
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
293
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
294 295 296 297

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
298
FILE* DARSHAN_DECL(fopen64)(const char *path, const char *mode)
299 300
{
    FILE* ret;
301
    double tm1, tm2;
302

Shane Snyder's avatar
Shane Snyder committed
303
    MAP_OR_FAIL(fopen64);
304

305
    tm1 = darshan_core_wtime();
Philip Carns's avatar
Philip Carns committed
306
    ret = __real_fopen64(path, mode);
307 308
    tm2 = darshan_core_wtime();

309
    STDIO_PRE_RECORD();
310
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
311
    STDIO_POST_RECORD();
312 313 314 315

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
316
FILE* DARSHAN_DECL(fdopen)(int fd, const char *mode)
317 318
{
    FILE* ret;
Philip Carns's avatar
Philip Carns committed
319
    double tm1, tm2;
320 321
    darshan_record_id rec_id;
    struct stdio_file_record_ref *rec_ref;
322

Philip Carns's avatar
Philip Carns committed
323
    MAP_OR_FAIL(fdopen);
324

Philip Carns's avatar
Philip Carns committed
325
    tm1 = darshan_core_wtime();
Philip Carns's avatar
Philip Carns committed
326 327 328
    ret = __real_fdopen(fd, mode);
    tm2 = darshan_core_wtime();

329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
    if(ret)
    {
        char *rec_name = darshan_posix_lookup_record_name(fd);
        if(rec_name)
        {
            rec_id = darshan_core_gen_record_id(rec_name);

            STDIO_PRE_RECORD();
            rec_ref = darshan_lookup_record_ref(stdio_runtime->rec_id_hash,
                &rec_id, sizeof(darshan_record_id));
            if(!rec_ref)
                rec_ref = stdio_track_new_file_record(rec_id, rec_name);
            STDIO_RECORD_REFOPEN(ret, rec_ref, tm1, tm2, STDIO_FDOPENS);
            STDIO_POST_RECORD();
        }
    }

Philip Carns's avatar
Philip Carns committed
346 347 348 349 350 351 352 353 354 355 356 357 358

    return(ret);
}

FILE* DARSHAN_DECL(freopen)(const char *path, const char *mode, FILE *stream)
{
    FILE* ret;
    double tm1, tm2;

    MAP_OR_FAIL(freopen);

    tm1 = darshan_core_wtime();
    ret = __real_freopen(path, mode, stream);
Philip Carns's avatar
Philip Carns committed
359 360
    tm2 = darshan_core_wtime();

361
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
362
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
363
    STDIO_POST_RECORD();
364 365 366 367

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
368 369 370 371 372 373 374 375 376 377 378
FILE* DARSHAN_DECL(freopen64)(const char *path, const char *mode, FILE *stream)
{
    FILE* ret;
    double tm1, tm2;

    MAP_OR_FAIL(freopen64);

    tm1 = darshan_core_wtime();
    ret = __real_freopen64(path, mode, stream);
    tm2 = darshan_core_wtime();

379
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
380
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
381
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
382 383 384 385 386

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
387 388 389 390 391 392 393 394 395 396 397
int DARSHAN_DECL(fflush)(FILE *fp)
{
    double tm1, tm2;
    int ret;

    MAP_OR_FAIL(fflush);

    tm1 = darshan_core_wtime();
    ret = __real_fflush(fp);
    tm2 = darshan_core_wtime();

398
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
399 400
    if(ret >= 0)
        STDIO_RECORD_WRITE(fp, 0, tm1, tm2, 1);
401
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
402 403 404 405

    return(ret);
}

406 407 408 409
int DARSHAN_DECL(fclose)(FILE *fp)
{
    double tm1, tm2;
    int ret;
410
    struct stdio_file_record_ref *rec_ref;
411 412 413 414 415 416 417

    MAP_OR_FAIL(fclose);

    tm1 = darshan_core_wtime();
    ret = __real_fclose(fp);
    tm2 = darshan_core_wtime();

418 419 420
    STDIO_PRE_RECORD();
    rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &fp, sizeof(fp));
    if(rec_ref)
421
    {
422 423 424 425
        if(rec_ref->file_rec->fcounters[STDIO_F_CLOSE_START_TIMESTAMP] == 0 ||
         rec_ref->file_rec->fcounters[STDIO_F_CLOSE_START_TIMESTAMP] > tm1)
           rec_ref->file_rec->fcounters[STDIO_F_CLOSE_START_TIMESTAMP] = tm1;
        rec_ref->file_rec->fcounters[STDIO_F_CLOSE_END_TIMESTAMP] = tm2;
426
        DARSHAN_TIMER_INC_NO_OVERLAP(
427 428 429
            rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
            tm1, tm2, rec_ref->last_meta_end);
        darshan_delete_record_ref(&(stdio_runtime->stream_hash), &fp, sizeof(fp));
430
    }
431
    STDIO_POST_RECORD();
432 433 434 435

    return(ret);
}

436 437 438 439 440 441 442 443 444 445 446
size_t DARSHAN_DECL(fwrite)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
{
    size_t ret;
    double tm1, tm2;

    MAP_OR_FAIL(fwrite);

    tm1 = darshan_core_wtime();
    ret = __real_fwrite(ptr, size, nmemb, stream);
    tm2 = darshan_core_wtime();

447
    STDIO_PRE_RECORD();
448
    if(ret > 0)
Philip Carns's avatar
Philip Carns committed
449
        STDIO_RECORD_WRITE(stream, size*ret, tm1, tm2, 0);
450
    STDIO_POST_RECORD();
451 452 453 454

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
455 456 457 458 459 460 461 462 463 464 465 466

int DARSHAN_DECL(fputc)(int c, FILE *stream)
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(fputc);

    tm1 = darshan_core_wtime();
    ret = __real_fputc(c, stream);
    tm2 = darshan_core_wtime();

467
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
468 469
    if(ret != EOF)
        STDIO_RECORD_WRITE(stream, 1, tm1, tm2, 0);
470
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
471 472 473 474

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
475 476 477 478 479 480 481 482 483 484 485
int DARSHAN_DECL(putw)(int w, FILE *stream)
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(putw);

    tm1 = darshan_core_wtime();
    ret = __real_putw(w, stream);
    tm2 = darshan_core_wtime();

486
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
487 488
    if(ret != EOF)
        STDIO_RECORD_WRITE(stream, sizeof(int), tm1, tm2, 0);
489
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
490 491 492 493 494

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
495 496 497 498 499 500 501 502 503 504 505 506

int DARSHAN_DECL(fputs)(const char *s, FILE *stream)
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(fputs);

    tm1 = darshan_core_wtime();
    ret = __real_fputs(s, stream);
    tm2 = darshan_core_wtime();

507
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
508 509
    if(ret != EOF && ret > 0)
        STDIO_RECORD_WRITE(stream, strlen(s), tm1, tm2, 0);
510
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
511 512 513 514

    return(ret);
}

515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
int DARSHAN_DECL(vprintf)(const char *format, va_list ap)
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(vprintf);

    tm1 = darshan_core_wtime();
    ret = __real_vprintf(format, ap);
    tm2 = darshan_core_wtime();

    STDIO_PRE_RECORD();
    if(ret > 0)
        STDIO_RECORD_WRITE(stdout, ret, tm1, tm2, 0);
    STDIO_POST_RECORD();

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
534 535 536 537 538 539 540 541 542 543 544
int DARSHAN_DECL(vfprintf)(FILE *stream, const char *format, va_list ap)
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(vfprintf);

    tm1 = darshan_core_wtime();
    ret = __real_vfprintf(stream, format, ap);
    tm2 = darshan_core_wtime();

545
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
546
    if(ret > 0)
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
        STDIO_RECORD_WRITE(stream, ret, tm1, tm2, 0);
    STDIO_POST_RECORD();

    return(ret);
}


int DARSHAN_DECL(printf)(const char *format, ...)
{
    int ret;
    double tm1, tm2;
    va_list ap;

    MAP_OR_FAIL(vprintf);

    tm1 = darshan_core_wtime();
    /* NOTE: we intentionally switch to vprintf here to handle the variable
     * length arguments.
     */
    va_start(ap, format);
    ret = __real_vprintf(format, ap);
    va_end(ap);
    tm2 = darshan_core_wtime();

    STDIO_PRE_RECORD();
    if(ret > 0)
        STDIO_RECORD_WRITE(stdout, ret, tm1, tm2, 0);
574
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595

    return(ret);
}

int DARSHAN_DECL(fprintf)(FILE *stream, const char *format, ...)
{
    int ret;
    double tm1, tm2;
    va_list ap;

    MAP_OR_FAIL(vfprintf);

    tm1 = darshan_core_wtime();
    /* NOTE: we intentionally switch to vfprintf here to handle the variable
     * length arguments.
     */
    va_start(ap, format);
    ret = __real_vfprintf(stream, format, ap);
    va_end(ap);
    tm2 = darshan_core_wtime();

596
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
597
    if(ret > 0)
598
        STDIO_RECORD_WRITE(stream, ret, tm1, tm2, 0);
599
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
600 601 602 603

    return(ret);
}

604 605 606 607 608 609 610 611 612 613 614
size_t DARSHAN_DECL(fread)(void *ptr, size_t size, size_t nmemb, FILE *stream)
{
    size_t ret;
    double tm1, tm2;

    MAP_OR_FAIL(fread);

    tm1 = darshan_core_wtime();
    ret = __real_fread(ptr, size, nmemb, stream);
    tm2 = darshan_core_wtime();

615
    STDIO_PRE_RECORD();
616 617
    if(ret > 0)
        STDIO_RECORD_READ(stream, size*ret, tm1, tm2);
618
    STDIO_POST_RECORD();
619 620 621 622

    return(ret);
}

623
int DARSHAN_DECL(fgetc)(FILE *stream)
Philip Carns's avatar
Philip Carns committed
624 625 626 627 628 629 630 631 632 633
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(fgetc);

    tm1 = darshan_core_wtime();
    ret = __real_fgetc(stream);
    tm2 = darshan_core_wtime();

634
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
635 636
    if(ret != EOF)
        STDIO_RECORD_READ(stream, 1, tm1, tm2);
637
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
638 639 640 641 642

    return(ret);
}

/* NOTE: stdio.h typically implements getc() as a macro pointing to _IO_getc */
643
int DARSHAN_DECL(_IO_getc)(FILE *stream)
Philip Carns's avatar
Philip Carns committed
644 645 646 647 648 649 650 651 652 653
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(_IO_getc);

    tm1 = darshan_core_wtime();
    ret = __real__IO_getc(stream);
    tm2 = darshan_core_wtime();

654
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
655 656
    if(ret != EOF)
        STDIO_RECORD_READ(stream, 1, tm1, tm2);
657
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
658 659 660 661

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
662
/* NOTE: stdio.h typically implements putc() as a macro pointing to _IO_putc */
663
int DARSHAN_DECL(_IO_putc)(int c, FILE *stream)
Philip Carns's avatar
Philip Carns committed
664 665 666 667 668 669 670 671 672 673
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(_IO_putc);

    tm1 = darshan_core_wtime();
    ret = __real__IO_putc(c, stream);
    tm2 = darshan_core_wtime();

674
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
675 676
    if(ret != EOF)
        STDIO_RECORD_WRITE(stream, 1, tm1, tm2, 0);
677
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
678 679 680

    return(ret);
}
681 682

int DARSHAN_DECL(getw)(FILE *stream)
Philip Carns's avatar
Philip Carns committed
683 684 685 686 687 688 689 690 691 692
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(getw);

    tm1 = darshan_core_wtime();
    ret = __real_getw(stream);
    tm2 = darshan_core_wtime();

693
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
694 695
    if(ret != EOF || ferror(stream) == 0)
        STDIO_RECORD_READ(stream, sizeof(int), tm1, tm2);
696
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
697 698 699 700

    return(ret);
}

701
#ifndef HAVE_FSCANF_REDIRECT
Philip Carns's avatar
Philip Carns committed
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
/* NOTE: some glibc versions use __isoc99_fscanf as the underlying symbol
 * rather than fscanf
 */
int DARSHAN_DECL(__isoc99_fscanf)(FILE *stream, const char *format, ...)
{
    int ret;
    double tm1, tm2;
    va_list ap;
    long start_off, end_off;

    MAP_OR_FAIL(vfscanf);

    tm1 = darshan_core_wtime();
    /* NOTE: we intentionally switch to vfscanf here to handle the variable
     * length arguments.
     */
    start_off = ftell(stream);
    va_start(ap, format);
    ret = __real_vfscanf(stream, format, ap);
    va_end(ap);
    end_off = ftell(stream);
    tm2 = darshan_core_wtime();

725
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
726 727
    if(ret != 0)
        STDIO_RECORD_READ(stream, (end_off-start_off), tm1, tm2);
728
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
729 730 731

    return(ret);
}
732
#endif
Philip Carns's avatar
Philip Carns committed
733

Philip Carns's avatar
Philip Carns committed
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
int DARSHAN_DECL(fscanf)(FILE *stream, const char *format, ...)
{
    int ret;
    double tm1, tm2;
    va_list ap;
    long start_off, end_off;

    MAP_OR_FAIL(vfscanf);

    tm1 = darshan_core_wtime();
    /* NOTE: we intentionally switch to vfscanf here to handle the variable
     * length arguments.
     */
    start_off = ftell(stream);
    va_start(ap, format);
    ret = __real_vfscanf(stream, format, ap);
    va_end(ap);
    end_off = ftell(stream);
    tm2 = darshan_core_wtime();

754
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
755
    if(ret != 0)
Philip Carns's avatar
Philip Carns committed
756
        STDIO_RECORD_READ(stream, (end_off-start_off), tm1, tm2);
757
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775

    return(ret);
}

int DARSHAN_DECL(vfscanf)(FILE *stream, const char *format, va_list ap)
{
    int ret;
    double tm1, tm2;
    long start_off, end_off;

    MAP_OR_FAIL(vfscanf);

    tm1 = darshan_core_wtime();
    start_off = ftell(stream);
    ret = __real_vfscanf(stream, format, ap);
    end_off = ftell(stream);
    tm2 = darshan_core_wtime();

776
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
777 778
    if(ret != 0)
        STDIO_RECORD_READ(stream, end_off-start_off, tm1, tm2);
779
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
780 781 782 783 784

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
785 786 787 788 789 790 791 792 793 794 795
char* DARSHAN_DECL(fgets)(char *s, int size, FILE *stream)
{
    char *ret;
    double tm1, tm2;

    MAP_OR_FAIL(fgets);

    tm1 = darshan_core_wtime();
    ret = __real_fgets(s, size, stream);
    tm2 = darshan_core_wtime();

796
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
797 798
    if(ret != NULL)
        STDIO_RECORD_READ(stream, strlen(ret), tm1, tm2);
799
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
800 801 802 803 804

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
805 806 807
void DARSHAN_DECL(rewind)(FILE *stream)
{
    double tm1, tm2;
808
    struct stdio_file_record_ref *rec_ref;
Philip Carns's avatar
Philip Carns committed
809 810 811 812 813 814 815

    MAP_OR_FAIL(rewind);

    tm1 = darshan_core_wtime();
    __real_rewind(stream);
    tm2 = darshan_core_wtime();

816 817 818
    /* NOTE: we don't use STDIO_PRE_RECORD here because there is no return
     * value in this wrapper.
     */
Philip Carns's avatar
Philip Carns committed
819
    STDIO_LOCK();
820
    if(darshan_core_disabled_instrumentation()) {
821 822 823 824
        STDIO_UNLOCK();
        return;
    }
    if(!stdio_runtime) stdio_runtime_initialize();
825 826 827 828 829 830 831 832
    if(!stdio_runtime) {
        STDIO_UNLOCK();
        return;
    }

    rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &stream, sizeof(stream));

    if(rec_ref)
Philip Carns's avatar
Philip Carns committed
833
    {
834
        rec_ref->offset = 0;
Philip Carns's avatar
Philip Carns committed
835
        DARSHAN_TIMER_INC_NO_OVERLAP(
836 837 838
            rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
            tm1, tm2, rec_ref->last_meta_end);
        rec_ref->file_rec->counters[STDIO_SEEKS] += 1;
Philip Carns's avatar
Philip Carns committed
839
    }
840
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
841 842 843 844

    return;
}

845 846 847
int DARSHAN_DECL(fseek)(FILE *stream, long offset, int whence)
{
    int ret;
848
    struct stdio_file_record_ref *rec_ref;
849 850 851 852 853 854 855 856 857 858
    double tm1, tm2;

    MAP_OR_FAIL(fseek);

    tm1 = darshan_core_wtime();
    ret = __real_fseek(stream, offset, whence);
    tm2 = darshan_core_wtime();

    if(ret >= 0)
    {
859 860 861
        STDIO_PRE_RECORD();
        rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &stream, sizeof(stream));
        if(rec_ref)
Philip Carns's avatar
Philip Carns committed
862
        {
863
            rec_ref->offset = ftell(stream);
Philip Carns's avatar
Philip Carns committed
864
            DARSHAN_TIMER_INC_NO_OVERLAP(
865 866 867
                rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
                tm1, tm2, rec_ref->last_meta_end);
            rec_ref->file_rec->counters[STDIO_SEEKS] += 1;
Philip Carns's avatar
Philip Carns committed
868
        }
869
        STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
870 871 872 873 874 875 876 877
    }

    return(ret);
}

int DARSHAN_DECL(fseeko)(FILE *stream, off_t offset, int whence)
{
    int ret;
878
    struct stdio_file_record_ref *rec_ref;
Philip Carns's avatar
Philip Carns committed
879 880 881 882 883 884 885 886 887 888
    double tm1, tm2;

    MAP_OR_FAIL(fseeko);

    tm1 = darshan_core_wtime();
    ret = __real_fseeko(stream, offset, whence);
    tm2 = darshan_core_wtime();

    if(ret >= 0)
    {
889 890 891
        STDIO_PRE_RECORD();
        rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &stream, sizeof(stream));
        if(rec_ref)
Philip Carns's avatar
Philip Carns committed
892
        {
893
            rec_ref->offset = ftell(stream);
Philip Carns's avatar
Philip Carns committed
894
            DARSHAN_TIMER_INC_NO_OVERLAP(
895 896 897
                rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
                tm1, tm2, rec_ref->last_meta_end);
            rec_ref->file_rec->counters[STDIO_SEEKS] += 1;
Philip Carns's avatar
Philip Carns committed
898
        }
899
        STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
900 901 902 903 904
    }

    return(ret);
}

905
int DARSHAN_DECL(fseeko64)(FILE *stream, off64_t offset, int whence)
Philip Carns's avatar
Philip Carns committed
906 907
{
    int ret;
908
    struct stdio_file_record_ref *rec_ref;
Philip Carns's avatar
Philip Carns committed
909 910 911 912 913 914 915 916 917 918
    double tm1, tm2;

    MAP_OR_FAIL(fseeko64);

    tm1 = darshan_core_wtime();
    ret = __real_fseeko64(stream, offset, whence);
    tm2 = darshan_core_wtime();

    if(ret >= 0)
    {
919 920 921
        STDIO_PRE_RECORD();
        rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &stream, sizeof(stream));
        if(rec_ref)
922
        {
923
            rec_ref->offset = ftell(stream);
924
            DARSHAN_TIMER_INC_NO_OVERLAP(
925 926 927
                rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
                tm1, tm2, rec_ref->last_meta_end);
            rec_ref->file_rec->counters[STDIO_SEEKS] += 1;
928
        }
929
        STDIO_POST_RECORD();
930 931 932 933 934
    }

    return(ret);
}

935 936 937
int DARSHAN_DECL(fsetpos)(FILE *stream, const fpos_t *pos)
{
    int ret;
938
    struct stdio_file_record_ref *rec_ref;
939 940 941 942 943 944 945 946 947 948
    double tm1, tm2;

    MAP_OR_FAIL(fsetpos);

    tm1 = darshan_core_wtime();
    ret = __real_fsetpos(stream, pos);
    tm2 = darshan_core_wtime();

    if(ret >= 0)
    {
949 950 951
        STDIO_PRE_RECORD();
        rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &stream, sizeof(stream));
        if(rec_ref)
952
        {
953
            rec_ref->offset = ftell(stream);
954
            DARSHAN_TIMER_INC_NO_OVERLAP(
955 956 957
                rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
                tm1, tm2, rec_ref->last_meta_end);
            rec_ref->file_rec->counters[STDIO_SEEKS] += 1;
958
        }
959
        STDIO_POST_RECORD();
960 961 962 963 964
    }

    return(ret);
}

965
int DARSHAN_DECL(fsetpos64)(FILE *stream, const fpos64_t *pos)
966 967
{
    int ret;
968
    struct stdio_file_record_ref *rec_ref;
969 970 971 972 973 974 975 976 977 978
    double tm1, tm2;

    MAP_OR_FAIL(fsetpos64);

    tm1 = darshan_core_wtime();
    ret = __real_fsetpos64(stream, pos);
    tm2 = darshan_core_wtime();

    if(ret >= 0)
    {
979 980 981
        STDIO_PRE_RECORD();
        rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &stream, sizeof(stream));
        if(rec_ref)
982
        {
983
            rec_ref->offset = ftell(stream);
984
            DARSHAN_TIMER_INC_NO_OVERLAP(
985 986 987
                rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
                tm1, tm2, rec_ref->last_meta_end);
            rec_ref->file_rec->counters[STDIO_SEEKS] += 1;
988
        }
989
        STDIO_POST_RECORD();
990 991 992 993 994
    }

    return(ret);
}

995 996 997 998 999 1000 1001
/**********************************************************
 * Internal functions for manipulating STDIO module state *
 **********************************************************/

/* initialize internal STDIO module data structures and register with darshan-core */
static void stdio_runtime_initialize()
{
1002
    int stdio_buf_size;
1003 1004 1005 1006 1007 1008
    darshan_module_funcs mod_funcs = {
#ifdef HAVE_MPI
    .mod_redux_func = &stdio_mpi_redux,
#endif
    .mod_shutdown_func = &stdio_shutdown
    };
1009 1010 1011

    /* try to store default number of records for this module */
    stdio_buf_size = DARSHAN_DEF_MOD_REC_COUNT * sizeof(struct darshan_stdio_file);
1012 1013 1014 1015

    /* register the stdio module with darshan core */
    darshan_core_register_module(
        DARSHAN_STDIO_MOD,
1016
        mod_funcs,
1017
        &stdio_buf_size,
1018
        &my_rank,
1019 1020
        &darshan_mem_alignment);

1021 1022 1023
    /* return if darshan-core does not provide enough module memory */
    if(stdio_buf_size < sizeof(struct darshan_stdio_file))
    {
Shane Snyder's avatar
Shane Snyder committed
1024
        darshan_core_unregister_module(DARSHAN_STDIO_MOD);
1025
        return;
1026
    }
1027 1028 1029 1030

    stdio_runtime = malloc(sizeof(*stdio_runtime));
    if(!stdio_runtime)
    {
1031
        darshan_core_unregister_module(DARSHAN_STDIO_MOD);
1032 1033
        return;
    }
1034
    memset(stdio_runtime, 0, sizeof(*stdio_runtime));
1035 1036 1037 1038 1039

    /* instantiate records for stdin, stdout, and stderr */
    STDIO_RECORD_OPEN(stdin, "<STDIN>", 0, 0);
    STDIO_RECORD_OPEN(stdout, "<STDOUT>", 0, 0);
    STDIO_RECORD_OPEN(stderr, "<STDERR>", 0, 0);
1040 1041
}

1042 1043 1044 1045 1046 1047 1048
static struct stdio_file_record_ref *stdio_track_new_file_record(
    darshan_record_id rec_id, const char *path)
{
    struct darshan_stdio_file *file_rec = NULL;
    struct stdio_file_record_ref *rec_ref = NULL;
    struct darshan_fs_info fs_info;
    int ret;
1049

1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
    rec_ref = malloc(sizeof(*rec_ref));
    if(!rec_ref)
        return(NULL);
    memset(rec_ref, 0, sizeof(*rec_ref));

    /* add a reference to this file record based on record id */
    ret = darshan_add_record_ref(&(stdio_runtime->rec_id_hash), &rec_id,
        sizeof(darshan_record_id), rec_ref);
    if(ret == 0)
    {
        free(rec_ref);
        return(NULL);
    }

    /* register the actual file record with darshan-core so it is persisted
     * in the log file
     */
    file_rec = darshan_core_register_record(
        rec_id,
        path,
        DARSHAN_STDIO_MOD,
        sizeof(struct darshan_stdio_file),
        &fs_info);

    if(!file_rec)
    {
        darshan_delete_record_ref(&(stdio_runtime->rec_id_hash),
            &rec_id, sizeof(darshan_record_id));
        free(rec_ref);
        return(NULL);
    }

    /* 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->fs_type = fs_info.fs_type;
    rec_ref->file_rec = file_rec;
    stdio_runtime->file_rec_count++;

    return(rec_ref);
}

static void stdio_cleanup_runtime()
{
    darshan_clear_record_refs(&(stdio_runtime->stream_hash), 0);
    darshan_clear_record_refs(&(stdio_runtime->rec_id_hash), 1);

    free(stdio_runtime);
    stdio_runtime = NULL;

    return;
}

#ifdef HAVE_MPI
1104 1105
static void stdio_record_reduction_op(void* infile_v, void* inoutfile_v,
    int *len, MPI_Datatype *datatype)
1106
{
1107 1108 1109 1110
    struct darshan_stdio_file tmp_file;
    struct darshan_stdio_file *infile = infile_v;
    struct darshan_stdio_file *inoutfile = inoutfile_v;
    int i, j;
1111

1112
    assert(stdio_runtime);
1113

1114
    for(i=0; i<*len; i++)
1115
    {
1116 1117 1118
        memset(&tmp_file, 0, sizeof(struct darshan_stdio_file));
        tmp_file.base_rec.id = infile->base_rec.id;
        tmp_file.base_rec.rank = -1;
1119

1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
        /* sum */
        for(j=STDIO_OPENS; j<=STDIO_BYTES_READ; j++)
        {
            tmp_file.counters[j] = infile->counters[j] + inoutfile->counters[j];
        }
        
        /* max */
        for(j=STDIO_MAX_BYTE_READ; j<=STDIO_MAX_BYTE_WRITTEN; j++)
        {
            if(infile->counters[j] > inoutfile->counters[j])
                tmp_file.counters[j] = infile->counters[j];
            else
                tmp_file.counters[j] = inoutfile->counters[j];
        }
1134

1135 1136 1137 1138 1139
        /* sum */
        for(j=STDIO_F_META_TIME; j<=STDIO_F_READ_TIME; j++)
        {
            tmp_file.fcounters[j] = infile->fcounters[j] + inoutfile->fcounters[j];
        }
1140

1141 1142 1143 1144 1145 1146 1147 1148 1149
        /* min non-zero (if available) value */
        for(j=STDIO_F_OPEN_START_TIMESTAMP; j<=STDIO_F_READ_START_TIMESTAMP; j++)
        {
            if((infile->fcounters[j] < inoutfile->fcounters[j] &&
               infile->fcounters[j] > 0) || inoutfile->fcounters[j] == 0) 
                tmp_file.fcounters[j] = infile->fcounters[j];
            else
                tmp_file.fcounters[j] = inoutfile->fcounters[j];
        }
1150

1151 1152 1153 1154 1155 1156 1157 1158
        /* max */
        for(j=STDIO_F_OPEN_END_TIMESTAMP; j<=STDIO_F_READ_END_TIMESTAMP; j++)
        {
            if(infile->fcounters[j] > inoutfile->fcounters[j])
                tmp_file.fcounters[j] = infile->fcounters[j];
            else
                tmp_file.fcounters[j] = inoutfile->fcounters[j];
        }
1159

1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
        /* min (zeroes are ok here; some procs don't do I/O) */
        if(infile->fcounters[STDIO_F_FASTEST_RANK_TIME] <
           inoutfile->fcounters[STDIO_F_FASTEST_RANK_TIME])
        {
            tmp_file.counters[STDIO_FASTEST_RANK] =
                infile->counters[STDIO_FASTEST_RANK];
            tmp_file.counters[STDIO_FASTEST_RANK_BYTES] =
                infile->counters[STDIO_FASTEST_RANK_BYTES];
            tmp_file.fcounters[STDIO_F_FASTEST_RANK_TIME] =
                infile->fcounters[STDIO_F_FASTEST_RANK_TIME];
        }
        else
        {
            tmp_file.counters[STDIO_FASTEST_RANK] =
                inoutfile->counters[STDIO_FASTEST_RANK];
            tmp_file.counters[STDIO_FASTEST_RANK_BYTES] =
                inoutfile->counters[STDIO_FASTEST_RANK_BYTES];
            tmp_file.fcounters[STDIO_F_FASTEST_RANK_TIME] =
                inoutfile->fcounters[STDIO_F_FASTEST_RANK_TIME];
        }

        /* max */
        if(infile->fcounters[STDIO_F_SLOWEST_RANK_TIME] >
           inoutfile->fcounters[STDIO_F_SLOWEST_RANK_TIME])
        {
            tmp_file.counters[STDIO_SLOWEST_RANK] =
                infile->counters[STDIO_SLOWEST_RANK];
            tmp_file.counters[STDIO_SLOWEST_RANK_BYTES] =
                infile->counters[STDIO_SLOWEST_RANK_BYTES];
            tmp_file.fcounters[STDIO_F_SLOWEST_RANK_TIME] =
                infile->fcounters[STDIO_F_SLOWEST_RANK_TIME];
        }
        else
        {
            tmp_file.counters[STDIO_SLOWEST_RANK] =
                inoutfile->counters[STDIO_SLOWEST_RANK];
            tmp_file.counters[STDIO_SLOWEST_RANK_BYTES] =
                inoutfile->counters[STDIO_SLOWEST_RANK_BYTES];
            tmp_file.fcounters[STDIO_F_SLOWEST_RANK_TIME] =
                inoutfile->fcounters[STDIO_F_SLOWEST_RANK_TIME];
        }

1202 1203 1204 1205
        /* update pointers */
        *inoutfile = tmp_file;
        inoutfile++;
        infile++;
1206 1207 1208 1209 1210
    }

    return;
}

1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
static void stdio_shared_record_variance(MPI_Comm mod_comm,
    struct darshan_stdio_file *inrec_array, struct darshan_stdio_file *outrec_array,
    int shared_rec_count)
{
    MPI_Datatype var_dt;
    MPI_Op var_op;
    int i;
    struct darshan_variance_dt *var_send_buf = NULL;
    struct darshan_variance_dt *var_recv_buf = NULL;

1221
    PMPI_Type_contiguous(sizeof(struct darshan_variance_dt),
1222
        MPI_BYTE, &var_dt);
1223
    PMPI_Type_commit(&var_dt);
1224

1225
    PMPI_Op_create(darshan_variance_reduce, 1, &var_op);
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249

    var_send_buf = malloc(shared_rec_count * sizeof(struct darshan_variance_dt));
    if(!var_send_buf)
        return;

    if(my_rank == 0)
    {
        var_recv_buf = malloc(shared_rec_count * sizeof(struct darshan_variance_dt));

        if(!var_recv_buf)
            return;
    }

    /* get total i/o time variances for shared records */

    for(i=0; i<shared_rec_count; i++)
    {
        var_send_buf[i].n = 1;
        var_send_buf[i].S = 0;
        var_send_buf[i].T = inrec_array[i].fcounters[STDIO_F_READ_TIME] +
                            inrec_array[i].fcounters[STDIO_F_WRITE_TIME] +
                            inrec_array[i].fcounters[STDIO_F_META_TIME];
    }

1250
    PMPI_Reduce(var_send_buf, var_recv_buf, shared_rec_count,
1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
        var_dt, var_op, 0, mod_comm);

    if(my_rank == 0)
    {
        for(i=0; i<shared_rec_count; i++)
        {
            outrec_array[i].fcounters[STDIO_F_VARIANCE_RANK_TIME] =
                (var_recv_buf[i].S / var_recv_buf[i].n);
        }
    }

    /* get total bytes moved variances for shared records */

    for(i=0; i<shared_rec_count; i++)
    {
        var_send_buf[i].n = 1;
        var_send_buf[i].S = 0;
        var_send_buf[i].T = (double)
                            inrec_array[i].counters[STDIO_BYTES_READ] +
                            inrec_array[i].counters[STDIO_BYTES_WRITTEN];
    }

1273
    PMPI_Reduce(var_send_buf, var_recv_buf, shared_rec_count,
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
        var_dt, var_op, 0, mod_comm);

    if(my_rank == 0)
    {
        for(i=0; i<shared_rec_count; i++)
        {
            outrec_array[i].fcounters[STDIO_F_VARIANCE_RANK_BYTES] =
                (var_recv_buf[i].S / var_recv_buf[i].n);
        }
    }

1285 1286
    PMPI_Type_free(&var_dt);
    PMPI_Op_free(&var_op);
1287 1288 1289 1290 1291
    free(var_send_buf);
    free(var_recv_buf);

    return;
}
1292
#endif
1293

1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
char *darshan_stdio_lookup_record_name(FILE *stream)
{
    struct stdio_file_record_ref *rec_ref;
    char *rec_name = NULL;

    STDIO_LOCK();
    if(stdio_runtime)
    {
        rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash,
            &stream, sizeof(stream));
        if(rec_ref)
            rec_name = darshan_core_lookup_record_name(rec_ref->file_rec->base_rec.id);
    }
    STDIO_UNLOCK();

    return(rec_name);
}
1311

1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
/************************************************************************
 * Functions exported by this module for coordinating with darshan-core *
 ************************************************************************/

#ifdef HAVE_MPI
static void stdio_mpi_redux(
    void *stdio_buf,
    MPI_Comm mod_comm,
    darshan_record_id *shared_recs,
    int shared_rec_count)
{
    int stdio_rec_count;
    struct stdio_file_record_ref *rec_ref;
    struct darshan_stdio_file *stdio_rec_buf = (struct darshan_stdio_file *)stdio_buf;
    double stdio_time;
    struct darshan_stdio_file *red_send_buf = NULL;
    struct darshan_stdio_file *red_recv_buf = NULL;
    MPI_Datatype red_type;
    MPI_Op red_op;
    int i;

    STDIO_LOCK();
    assert(stdio_runtime);

    stdio_rec_count = stdio_runtime->file_rec_count;

    /* necessary initialization of shared records */
    for(i = 0; i < shared_rec_count; i++)
    {
        rec_ref = darshan_lookup_record_ref(stdio_runtime->rec_id_hash,
            &shared_recs[i], sizeof(darshan_record_id));
        assert(rec_ref);

        stdio_time =
            rec_ref->file_rec->fcounters[STDIO_F_READ_TIME] +
            rec_ref->file_rec->fcounters[STDIO_F_WRITE_TIME] +
            rec_ref->file_rec->fcounters[STDIO_F_META_TIME];

        /* initialize fastest/slowest info prior to the reduction */
        rec_ref->file_rec->counters[STDIO_FASTEST_RANK] =
            rec_ref->file_rec->base_rec.rank;
        rec_ref->file_rec->counters[STDIO_FASTEST_RANK_BYTES] =
            rec_ref->file_rec->counters[STDIO_BYTES_READ] +
            rec_ref->file_rec->counters[STDIO_BYTES_WRITTEN];
        rec_ref->file_rec->fcounters[STDIO_F_FASTEST_RANK_TIME] =
            stdio_time;

        /* until reduction occurs, we assume that this rank is both
         * the fastest and slowest. It is up to the reduction operator
         * to find the true min and max.
         */
        rec_ref->file_rec->counters[STDIO_SLOWEST_RANK] =
            rec_ref->file_rec->counters[STDIO_FASTEST_RANK];
        rec_ref->file_rec->counters[STDIO_SLOWEST_RANK_BYTES] =
            rec_ref->file_rec->counters[STDIO_FASTEST_RANK_BYTES];
        rec_ref->file_rec->fcounters[STDIO_F_SLOWEST_RANK_TIME] =
            rec_ref->file_rec->fcounters[STDIO_F_FASTEST_RANK_TIME];

        rec_ref->file_rec->base_rec.rank = -1;
    }

    /* 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
     */
    darshan_record_sort(stdio_rec_buf, stdio_rec_count, sizeof(struct darshan_stdio_file));

    /* make *send_buf point to the shared files at the end of sorted array */
    red_send_buf = &(stdio_rec_buf[stdio_rec_count-shared_rec_count]);

    /* allocate memory for the reduction output on rank 0 */
    if(my_rank == 0)
    {
        red_recv_buf = malloc(shared_rec_count * sizeof(struct darshan_stdio_file));
        if(!red_recv_buf)
        {
            STDIO_UNLOCK();
            return;
        }
    }

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

    /* register a STDIO file record reduction operator */
    PMPI_Op_create(stdio_record_reduction_op, 1, &red_op);

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

    /* get the time and byte variances for shared files */
    stdio_shared_record_variance(mod_comm, red_send_buf, red_recv_buf,
        shared_rec_count);

    /* clean up reduction state */
    if(my_rank == 0)
    {
        int tmp_ndx = stdio_rec_count - shared_rec_count;
        memcpy(&(stdio_rec_buf[tmp_ndx]), red_recv_buf,
            shared_rec_count * sizeof(struct darshan_stdio_file));
        free(red_recv_buf);
    }
    else
    {
1421
        stdio_runtime->file_rec_count -= shared_rec_count;
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
    }

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

    STDIO_UNLOCK();
    return;
}
#endif

static void stdio_shutdown(
    void **stdio_buf,
    int *stdio_buf_sz)
{
    int stdio_rec_count;
    struct darshan_stdio_file *stdio_rec_buf = *(struct darshan_stdio_file **)stdio_buf;
    int i;

    STDIO_LOCK();
    assert(stdio_runtime);

    stdio_rec_count = stdio_runtime->file_rec_count;

    /* filter out any records that have no activity on them; this is
     * specifically meant to filter out unused stdin, stdout, or stderr
     * entries
     *
     * NOTE: we can no longer use the darshan_lookup_record_ref()
     * function at this point to find specific records, because the
     * logic above has likely broken the mapping to the static array.
     * We walk it manually here instead.
     */
    darshan_record_id stdin_rec_id = darshan_core_gen_record_id("<STDIN>");
    darshan_record_id stdout_rec_id = darshan_core_gen_record_id("<STDOUT>");
    darshan_record_id stderr_rec_id = darshan_core_gen_record_id("<STDERR>");
    for(i=0; i<stdio_rec_count; i++)
    {
        if