darshan-stdio.c 41.6 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
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
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
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));
111
DARSHAN_FORWARD_DECL(fscanf, int, (FILE *stream, const char *format, ...));
Philip Carns's avatar
Philip Carns committed
112
DARSHAN_FORWARD_DECL(__isoc99_fscanf, int, (FILE *stream, const char *format, ...));
113
DARSHAN_FORWARD_DECL(vfscanf, int, (FILE *stream, const char *format, va_list ap));
Philip Carns's avatar
Philip Carns committed
114
DARSHAN_FORWARD_DECL(fgets, char*, (char *s, int size, FILE *stream));
115
DARSHAN_FORWARD_DECL(fseek, int, (FILE *stream, long offset, int whence));
Philip Carns's avatar
Philip Carns committed
116
DARSHAN_FORWARD_DECL(fseeko, int, (FILE *stream, off_t offset, int whence));
117
DARSHAN_FORWARD_DECL(fseeko64, int, (FILE *stream, off64_t offset, int whence));
118
DARSHAN_FORWARD_DECL(fsetpos, int, (FILE *stream, const fpos_t *pos));
119
DARSHAN_FORWARD_DECL(fsetpos64, int, (FILE *stream, const fpos64_t *pos));
Philip Carns's avatar
Philip Carns committed
120
DARSHAN_FORWARD_DECL(rewind, void, (FILE *stream));
121

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

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

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;

static void stdio_runtime_initialize(void);
150 151 152 153 154 155
static void stdio_shutdown(
    MPI_Comm mod_comm,
    darshan_record_id *shared_recs,
    int shared_rec_count,
    void **stdio_buf,
    int *stdio_buf_sz);
156 157
static void stdio_record_reduction_op(void* infile_v, void* inoutfile_v,
    int *len, MPI_Datatype *datatype);
158 159 160
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);
161 162 163
static struct stdio_file_record_ref *stdio_track_new_file_record(
    darshan_record_id rec_id, const char *path);
static void stdio_cleanup_runtime();
164

165 166 167 168 169 170
/* 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
171

172 173 174
#define STDIO_LOCK() pthread_mutex_lock(&stdio_runtime_mutex)
#define STDIO_UNLOCK() pthread_mutex_unlock(&stdio_runtime_mutex)

175 176
#define STDIO_PRE_RECORD() do { \
    STDIO_LOCK(); \
177
    if(!darshan_core_disabled_instrumentation()) { \
178 179
        if(!stdio_runtime) stdio_runtime_initialize(); \
        if(stdio_runtime) break; \
180
    } \
181 182
    STDIO_UNLOCK(); \
    return(ret); \
183 184 185 186 187 188
} while(0)

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

189
#define STDIO_RECORD_OPEN(__ret, __path, __tm1, __tm2) do { \
190 191 192
    darshan_record_id rec_id; \
    struct stdio_file_record_ref* rec_ref; \
    char *newpath; \
193
    int __fd; \
194
    MAP_OR_FAIL(fileno); \
195
    if(__ret == NULL) break; \
196 197 198 199 200
    newpath = darshan_clean_file_path(__path); \
    if(!newpath) newpath = (char*)__path; \
    if(darshan_core_excluded_path(newpath)) { \
        if(newpath != (char*)__path) free(newpath); \
        break; \
201
    } \
202
    rec_id = darshan_core_gen_record_id(newpath); \
Philip Carns's avatar
Philip Carns committed
203
    rec_ref = darshan_lookup_record_ref(stdio_runtime->rec_id_hash, &rec_id, sizeof(rec_id)); \
204 205 206 207 208 209 210 211 212 213 214 215 216
    if(!rec_ref) rec_ref = stdio_track_new_file_record(rec_id, newpath); \
    if(!rec_ref) { \
        if(newpath != (char*)__path) free(newpath); \
        break; \
    } \
    rec_ref->offset = 0; \
    rec_ref->file_rec->counters[STDIO_OPENS] += 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); \
217
    __fd = __real_fileno(__ret); \
218
    darshan_instrument_fs_data(rec_ref->fs_type, newpath, __fd); \
219
    if(newpath != (char*)__path) free(newpath); \
220 221 222
} while(0)


223
#define STDIO_RECORD_READ(__fp, __bytes,  __tm1, __tm2) do{ \
224
    struct stdio_file_record_ref* rec_ref; \
225
    int64_t this_offset; \
Philip Carns's avatar
Philip Carns committed
226
    rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &(__fp), sizeof(__fp)); \
227 228 229 230 231 232 233 234 235 236 237
    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; \
238
    DARSHAN_TIMER_INC_NO_OVERLAP(rec_ref->file_rec->fcounters[STDIO_F_READ_TIME], __tm1, __tm2, rec_ref->last_read_end); \
239 240
} while(0)

Philip Carns's avatar
Philip Carns committed
241
#define STDIO_RECORD_WRITE(__fp, __bytes,  __tm1, __tm2, __fflush_flag) 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
    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
251
    if(__fflush_flag) \
252
        rec_ref->file_rec->counters[STDIO_FLUSHES] += 1; \
Philip Carns's avatar
Philip Carns committed
253
    else \
254 255 256 257 258 259
        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); \
260
} while(0)
261

Philip Carns's avatar
Philip Carns committed
262
FILE* DARSHAN_DECL(fopen)(const char *path, const char *mode)
Philip Carns's avatar
Philip Carns committed
263 264 265 266
{
    FILE* ret;
    double tm1, tm2;

Philip Carns's avatar
Philip Carns committed
267
    MAP_OR_FAIL(fopen);
Philip Carns's avatar
Philip Carns committed
268 269

    tm1 = darshan_core_wtime();
Philip Carns's avatar
Philip Carns committed
270
    ret = __real_fopen(path, mode);
Philip Carns's avatar
Philip Carns committed
271 272
    tm2 = darshan_core_wtime();

273
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
274
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
275
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
276 277 278 279

    return(ret);
}

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

285
    MAP_OR_FAIL(fopen64);
286

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

291
    STDIO_PRE_RECORD();
292
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
293
    STDIO_POST_RECORD();
294 295 296 297

    return(ret);
}

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

Philip Carns's avatar
Philip Carns committed
303
    MAP_OR_FAIL(fdopen);
304

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

309
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
310
    STDIO_RECORD_OPEN(ret, "UNKNOWN-FDOPEN", tm1, tm2);
311
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
312 313 314 315 316 317 318 319 320 321 322 323 324

    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
325 326
    tm2 = darshan_core_wtime();

327
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
328
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
329
    STDIO_POST_RECORD();
330 331 332 333

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
334 335 336 337 338 339 340 341 342 343 344
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();

345
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
346
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
347
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
348 349 350 351 352

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
353 354 355 356 357 358 359 360 361 362 363
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();

364
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
365 366
    if(ret >= 0)
        STDIO_RECORD_WRITE(fp, 0, tm1, tm2, 1);
367
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
368 369 370 371

    return(ret);
}

372 373 374 375
int DARSHAN_DECL(fclose)(FILE *fp)
{
    double tm1, tm2;
    int ret;
376
    struct stdio_file_record_ref *rec_ref;
377 378 379 380 381 382 383

    MAP_OR_FAIL(fclose);

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

384 385 386
    STDIO_PRE_RECORD();
    rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &fp, sizeof(fp));
    if(rec_ref)
387
    {
388 389 390 391
        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;
392
        DARSHAN_TIMER_INC_NO_OVERLAP(
393 394 395
            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));
396
    }
397
    STDIO_POST_RECORD();
398 399 400 401

    return(ret);
}

402 403 404 405 406 407 408 409 410 411 412
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();

413
    STDIO_PRE_RECORD();
414
    if(ret > 0)
Philip Carns's avatar
Philip Carns committed
415
        STDIO_RECORD_WRITE(stream, size*ret, tm1, tm2, 0);
416
    STDIO_POST_RECORD();
417 418 419 420

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
421 422 423 424 425 426 427 428 429 430 431 432

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();

433
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
434 435
    if(ret != EOF)
        STDIO_RECORD_WRITE(stream, 1, tm1, tm2, 0);
436
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
437 438 439 440

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
441 442 443 444 445 446 447 448 449 450 451
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();

452
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
453 454
    if(ret != EOF)
        STDIO_RECORD_WRITE(stream, sizeof(int), tm1, tm2, 0);
455
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
456 457 458 459 460

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
461 462 463 464 465 466 467 468 469 470 471 472

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();

473
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
474 475
    if(ret != EOF && ret > 0)
        STDIO_RECORD_WRITE(stream, strlen(s), tm1, tm2, 0);
476
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
477 478 479 480

    return(ret);
}

481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
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
500 501 502 503 504 505 506 507 508 509 510
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();

511
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
512
    if(ret > 0)
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
        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);
540
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561

    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();

562
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
563
    if(ret > 0)
564
        STDIO_RECORD_WRITE(stream, ret, tm1, tm2, 0);
565
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
566 567 568 569

    return(ret);
}

570 571 572 573 574 575 576 577 578 579 580
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();

581
    STDIO_PRE_RECORD();
582 583
    if(ret > 0)
        STDIO_RECORD_READ(stream, size*ret, tm1, tm2);
584
    STDIO_POST_RECORD();
585 586 587 588

    return(ret);
}

589
int DARSHAN_DECL(fgetc)(FILE *stream)
Philip Carns's avatar
Philip Carns committed
590 591 592 593 594 595 596 597 598 599
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(fgetc);

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

600
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
601 602
    if(ret != EOF)
        STDIO_RECORD_READ(stream, 1, tm1, tm2);
603
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
604 605 606 607 608

    return(ret);
}

/* NOTE: stdio.h typically implements getc() as a macro pointing to _IO_getc */
609
int DARSHAN_DECL(_IO_getc)(FILE *stream)
Philip Carns's avatar
Philip Carns committed
610 611 612 613 614 615 616 617 618 619
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(_IO_getc);

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

620
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
621 622
    if(ret != EOF)
        STDIO_RECORD_READ(stream, 1, tm1, tm2);
623
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
624 625 626 627

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
628
/* NOTE: stdio.h typically implements putc() as a macro pointing to _IO_putc */
629
int DARSHAN_DECL(_IO_putc)(int c, FILE *stream)
Philip Carns's avatar
Philip Carns committed
630 631 632 633 634 635 636 637 638 639
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(_IO_putc);

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

640
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
641 642
    if(ret != EOF)
        STDIO_RECORD_WRITE(stream, 1, tm1, tm2, 0);
643
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
644 645 646

    return(ret);
}
647 648

int DARSHAN_DECL(getw)(FILE *stream)
Philip Carns's avatar
Philip Carns committed
649 650 651 652 653 654 655 656 657 658
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(getw);

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

659
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
660 661
    if(ret != EOF || ferror(stream) == 0)
        STDIO_RECORD_READ(stream, sizeof(int), tm1, tm2);
662
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
663 664 665 666

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
/* 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();

690
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
691 692
    if(ret != 0)
        STDIO_RECORD_READ(stream, (end_off-start_off), tm1, tm2);
693
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
694 695 696 697

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
698

699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
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();

719
    STDIO_PRE_RECORD();
720
    if(ret != 0)
Philip Carns's avatar
Philip Carns committed
721
        STDIO_RECORD_READ(stream, (end_off-start_off), tm1, tm2);
722
    STDIO_POST_RECORD();
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740

    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();

741
    STDIO_PRE_RECORD();
742 743
    if(ret != 0)
        STDIO_RECORD_READ(stream, end_off-start_off, tm1, tm2);
744
    STDIO_POST_RECORD();
745 746 747 748 749

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
750 751 752 753 754 755 756 757 758 759 760
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();

761
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
762 763
    if(ret != NULL)
        STDIO_RECORD_READ(stream, strlen(ret), tm1, tm2);
764
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
765 766 767 768 769

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
770 771 772
void DARSHAN_DECL(rewind)(FILE *stream)
{
    double tm1, tm2;
773
    struct stdio_file_record_ref *rec_ref;
Philip Carns's avatar
Philip Carns committed
774 775 776 777 778 779 780

    MAP_OR_FAIL(rewind);

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

781 782 783
    /* 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
784
    STDIO_LOCK();
785
    if(darshan_core_disabled_instrumentation()) {
786 787 788 789
        STDIO_UNLOCK();
        return;
    }
    if(!stdio_runtime) stdio_runtime_initialize();
790 791 792 793 794 795 796 797
    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
798
    {
799
        rec_ref->offset = 0;
Philip Carns's avatar
Philip Carns committed
800
        DARSHAN_TIMER_INC_NO_OVERLAP(
801 802 803
            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
804
    }
805
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
806 807 808 809

    return;
}

810 811 812
int DARSHAN_DECL(fseek)(FILE *stream, long offset, int whence)
{
    int ret;
813
    struct stdio_file_record_ref *rec_ref;
814 815 816 817 818 819 820 821 822 823
    double tm1, tm2;

    MAP_OR_FAIL(fseek);

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

    if(ret >= 0)
    {
824 825 826
        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
827
        {
828
            rec_ref->offset = ftell(stream);
Philip Carns's avatar
Philip Carns committed
829
            DARSHAN_TIMER_INC_NO_OVERLAP(
830 831 832
                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
833
        }
834
        STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
835 836 837 838 839 840 841 842
    }

    return(ret);
}

int DARSHAN_DECL(fseeko)(FILE *stream, off_t offset, int whence)
{
    int ret;
843
    struct stdio_file_record_ref *rec_ref;
Philip Carns's avatar
Philip Carns committed
844 845 846 847 848 849 850 851 852 853
    double tm1, tm2;

    MAP_OR_FAIL(fseeko);

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

    if(ret >= 0)
    {
854 855 856
        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
857
        {
858
            rec_ref->offset = ftell(stream);
Philip Carns's avatar
Philip Carns committed
859
            DARSHAN_TIMER_INC_NO_OVERLAP(
860 861 862
                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
863
        }
864
        STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
865 866 867 868 869
    }

    return(ret);
}

870
int DARSHAN_DECL(fseeko64)(FILE *stream, off64_t offset, int whence)
Philip Carns's avatar
Philip Carns committed
871 872
{
    int ret;
873
    struct stdio_file_record_ref *rec_ref;
Philip Carns's avatar
Philip Carns committed
874 875 876 877 878 879 880 881 882 883
    double tm1, tm2;

    MAP_OR_FAIL(fseeko64);

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

    if(ret >= 0)
    {
884 885 886
        STDIO_PRE_RECORD();
        rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &stream, sizeof(stream));
        if(rec_ref)
887
        {
888
            rec_ref->offset = ftell(stream);
889
            DARSHAN_TIMER_INC_NO_OVERLAP(
890 891 892
                rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
                tm1, tm2, rec_ref->last_meta_end);
            rec_ref->file_rec->counters[STDIO_SEEKS] += 1;
893
        }
894
        STDIO_POST_RECORD();
895 896 897 898 899
    }

    return(ret);
}

900 901 902
int DARSHAN_DECL(fsetpos)(FILE *stream, const fpos_t *pos)
{
    int ret;
903
    struct stdio_file_record_ref *rec_ref;
904 905 906 907 908 909 910 911 912 913
    double tm1, tm2;

    MAP_OR_FAIL(fsetpos);

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

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

    return(ret);
}

930
int DARSHAN_DECL(fsetpos64)(FILE *stream, const fpos64_t *pos)
931 932
{
    int ret;
933
    struct stdio_file_record_ref *rec_ref;
934 935 936 937 938 939 940 941 942 943
    double tm1, tm2;

    MAP_OR_FAIL(fsetpos64);

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

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

    return(ret);
}

960 961 962 963 964 965 966
/**********************************************************
 * Internal functions for manipulating STDIO module state *
 **********************************************************/

/* initialize internal STDIO module data structures and register with darshan-core */
static void stdio_runtime_initialize()
{
967 968 969 970
    int stdio_buf_size;

    /* try to store default number of records for this module */
    stdio_buf_size = DARSHAN_DEF_MOD_REC_COUNT * sizeof(struct darshan_stdio_file);
971 972 973 974

    /* register the stdio module with darshan core */
    darshan_core_register_module(
        DARSHAN_STDIO_MOD,
975 976
        &stdio_shutdown,
        &stdio_buf_size,
977
        &my_rank,
978 979
        &darshan_mem_alignment);

980 981 982
    /* return if darshan-core does not provide enough module memory */
    if(stdio_buf_size < sizeof(struct darshan_stdio_file))
    {
983
        darshan_core_unregister_module(DARSHAN_STDIO_MOD);
984
        return;
985
    }
986 987 988 989

    stdio_runtime = malloc(sizeof(*stdio_runtime));
    if(!stdio_runtime)
    {
990
        darshan_core_unregister_module(DARSHAN_STDIO_MOD);
991 992
        return;
    }
993
    memset(stdio_runtime, 0, sizeof(*stdio_runtime));
994 995 996 997 998

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

1001 1002 1003
/************************************************************************
 * Functions exported by this module for coordinating with darshan-core *
 ************************************************************************/
1004

1005 1006
static void stdio_record_reduction_op(void* infile_v, void* inoutfile_v,
    int *len, MPI_Datatype *datatype)
1007
{
1008 1009 1010 1011
    struct darshan_stdio_file tmp_file;
    struct darshan_stdio_file *infile = infile_v;
    struct darshan_stdio_file *inoutfile = inoutfile_v;
    int i, j;
1012

1013
    assert(stdio_runtime);
1014

1015
    for(i=0; i<*len; i++)
1016
    {
1017 1018 1019
        memset(&tmp_file, 0, sizeof(struct darshan_stdio_file));
        tmp_file.base_rec.id = infile->base_rec.id;
        tmp_file.base_rec.rank = -1;
1020

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
        /* 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];
        }
1035

1036 1037 1038 1039 1040
        /* sum */
        for(j=STDIO_F_META_TIME; j<=STDIO_F_READ_TIME; j++)
        {
            tmp_file.fcounters[j] = infile->fcounters[j] + inoutfile->fcounters[j];
        }
1041

1042 1043 1044 1045 1046 1047 1048 1049 1050
        /* 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];
        }
1051

1052 1053 1054 1055 1056 1057 1058 1059
        /* 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];
        }
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
        /* 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];
        }

1103 1104 1105 1106
        /* update pointers */
        *inoutfile = tmp_file;
        inoutfile++;
        infile++;
1107 1108 1109 1110 1111
    }

    return;
}

1112
static void stdio_shutdown(
1113 1114 1115 1116 1117 1118
    MPI_Comm mod_comm,
    darshan_record_id *shared_recs,
    int shared_rec_count,
    void **stdio_buf,
    int *stdio_buf_sz)
{
1119 1120
    struct stdio_file_record_ref *rec_ref;
    struct darshan_stdio_file *stdio_rec_buf = *(struct darshan_stdio_file **)stdio_buf;
1121
    int i;
1122 1123
    struct darshan_stdio_file *red_send_buf = NULL;
    struct darshan_stdio_file *red_recv_buf = NULL;
1124 1125
    MPI_Datatype red_type;
    MPI_Op red_op;
1126
    int stdio_rec_count;
1127
    double stdio_time;
1128

1129
    STDIO_LOCK();
1130
    assert(stdio_runtime);
1131

1132
    stdio_rec_count = stdio_runtime->file_rec_count;
1133

1134 1135 1136 1137 1138 1139 1140 1141 1142
    /* if there are globally shared files, do a shared file reduction */
    /* 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"))
    {
        /* necessary initialization of shared records */
        for(i = 0; i < shared_rec_count; i++)
        {
1143 1144 1145
            rec_ref = darshan_lookup_record_ref(stdio_runtime->rec_id_hash,
                &shared_recs[i], sizeof(darshan_record_id));
            assert(rec_ref);
1146

1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
            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];

1172
            rec_ref->file_rec->base_rec.rank = -1;
1173 1174 1175 1176 1177 1178
        }

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

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

        /* allocate memory for the reduction output on rank 0 */
        if(my_rank == 0)
        {
1187
            red_recv_buf = malloc(shared_rec_count * sizeof(struct darshan_stdio_file));
1188 1189 1190 1191 1192 1193 1194 1195 1196
            if(!red_recv_buf)
            {
                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
         */
1197
        PMPI_Type_contiguous(sizeof(struct darshan_stdio_file),
1198
            MPI_BYTE, &red_type);
1199
        PMPI_Type_commit(&red_type);
1200 1201

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

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

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

1212 1213 1214
        /* clean up reduction state */
        if(my_rank == 0)
        {
1215 1216 1217
            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));
1218 1219 1220 1221
            free(red_recv_buf);
        }
        else
        {
1222
            stdio_rec_count -= shared_rec_count;
1223 1224
        }

1225 1226
        PMPI_Type_free(&red_type);
        PMPI_Op_free(&red_op);
1227 1228
    }

1229 1230 1231 1232 1233 1234 1235 1236 1237
    /* 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.
     */
1238 1239 1240
    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>");
1241 1242
    for(i=0; i<stdio_rec_count; i++)
    {
1243 1244 1245
        if((stdio_rec_buf[i].base_rec.id == stdin_rec_id) ||
           (stdio_rec_buf[i].base_rec.id == stdout_rec_id) ||
           (stdio_rec_buf[i].base_rec.id == stderr_rec_id))
1246
        {
1247 1248
            if(stdio_rec_buf[i].counters[STDIO_WRITES] == 0 &&
                stdio_rec_buf[i].counters[STDIO_READS] == 0)
1249
            {
1250 1251 1252 1253 1254 1255 1256
                if(i != (stdio_rec_count-1))
                {
                    memmove(&stdio_rec_buf[i], &stdio_rec_buf[i+1],
                        (stdio_rec_count-i-1)*sizeof(stdio_rec_buf[i]));
                    i--;
                }
                stdio_rec_count--;
1257 1258 1259 1260
            }
        }
    }

1261 1262
    /* update output buffer size to account for shared file reduction */
    *stdio_buf_sz = stdio_rec_count * sizeof(struct darshan_stdio_file);
1263

1264 1265
    /* shutdown internal structures used for instrumenting */
    stdio_cleanup_runtime();
1266

1267 1268 1269
    STDIO_UNLOCK();
    
    return;
1270 1271
}

1272 1273
static struct stdio_file_record_ref *stdio_track_new_file_record(
    darshan_record_id rec_id, const char *path)
1274
{
1275 1276
    struct darshan_stdio_file *file_rec = NULL;
    struct stdio_file_record_ref *rec_ref = NULL;
1277
    struct darshan_fs_info fs_info;
1278
    int ret;
1279

1280 1281 1282 1283
    rec_ref = malloc(sizeof(*rec_ref));
    if(!rec_ref)
        return(NULL);
    memset(rec_ref, 0, sizeof(*rec_ref));
1284

1285 1286 1287 1288
    /* 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)
1289
    {
1290 1291 1292
        free(rec_ref);
        return(NULL);
    }
1293

1294 1295 1296 1297 1298 1299
    /* 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,
Philip Carns's avatar
Philip Carns committed
1300
        DARSHAN_STDIO_MOD,
1301
        sizeof(struct darshan_stdio_file),
1302
        &fs_info);
1303 1304 1305 1306 1307 1308 1309 1310

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

1312 1313 1314
    /* registering this file record was successful, so initialize some fields */
    file_rec->base_rec.id = rec_id;
    file_rec->base_rec.rank = my_rank;
1315
    rec_ref->fs_type = fs_info.fs_type;
1316 1317
    rec_ref->file_rec = file_rec;
    stdio_runtime->file_rec_count++;
1318

1319
    return(rec_ref);
1320 1321 1322

}

1323
static void stdio_cleanup_runtime()
1324
{
1325 1326
    darshan_clear_record_refs(&(stdio_runtime->stream_hash), 0);
    darshan_clear_record_refs(&(stdio_runtime->rec_id_hash), 1);
1327 1328 1329

    free(stdio_runtime);
    stdio_runtime = NULL;
1330

1331 1332 1333
    return;
}

1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
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;

1344
    PMPI_Type_contiguous(sizeof(struct darshan_variance_dt),
1345
        MPI_BYTE, &var_dt);
1346
    PMPI_Type_commit(&var_dt);
1347

1348
    PMPI_Op_create(darshan_variance_reduce, 1, &var_op);
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372

    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];
    }

1373
    PMPI_Reduce(var_send_buf, var_recv_buf, shared_rec_count,
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
        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];
    }

1396
    PMPI_Reduce(var_send_buf, var_recv_buf, shared_rec_count,
1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
        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);
        }
    }

1408 1409
    PMPI_Type_free(&var_dt);
    PMPI_Op_free(&var_op);
1410 1411 1412 1413 1414 1415
    free(var_send_buf);
    free(var_recv_buf);

    return;
}

1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
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);
}
1433

1434 1435 1436 1437 1438 1439 1440 1441
/*
 * Local variables:
 *  c-indent-level: 4
 *  c-basic-offset: 4
 * End:
 *
 * vim: ts=8 sts=4 sw=4 expandtab
 */