darshan-stdio.c 39.9 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 81 82 83 84 85 86
#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>

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

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
87
DARSHAN_FORWARD_DECL(fdopen, FILE*, (int fd, const char *mode));
Philip Carns's avatar
Philip Carns committed
88
DARSHAN_FORWARD_DECL(freopen, FILE*, (const char *path, const char *mode, FILE *stream));
Philip Carns's avatar
Philip Carns committed
89
DARSHAN_FORWARD_DECL(freopen64, FILE*, (const char *path, const char *mode, FILE *stream));
90
DARSHAN_FORWARD_DECL(fclose, int, (FILE *fp));
Philip Carns's avatar
Philip Carns committed
91
DARSHAN_FORWARD_DECL(fflush, int, (FILE *fp));
92
DARSHAN_FORWARD_DECL(fwrite, size_t, (const void *ptr, size_t size, size_t nmemb, FILE *stream));
Philip Carns's avatar
Philip Carns committed
93
DARSHAN_FORWARD_DECL(fputc, int, (int c, FILE *stream));
Philip Carns's avatar
Philip Carns committed
94
DARSHAN_FORWARD_DECL(putw, int, (int w, FILE *stream));
Philip Carns's avatar
Philip Carns committed
95
DARSHAN_FORWARD_DECL(fputs, int, (const char *s, FILE *stream));
Philip Carns's avatar
Philip Carns committed
96
DARSHAN_FORWARD_DECL(fprintf, int, (FILE *stream, const char *format, ...));
97
DARSHAN_FORWARD_DECL(printf, int, (const char *format, ...));
Philip Carns's avatar
Philip Carns committed
98
DARSHAN_FORWARD_DECL(vfprintf, int, (FILE *stream, const char *format, va_list));
99
DARSHAN_FORWARD_DECL(vprintf, int, (const char *format, va_list));
100
DARSHAN_FORWARD_DECL(fread, size_t, (void *ptr, size_t size, size_t nmemb, FILE *stream));
Philip Carns's avatar
Philip Carns committed
101
DARSHAN_FORWARD_DECL(fgetc, int, (FILE *stream));
Philip Carns's avatar
Philip Carns committed
102
DARSHAN_FORWARD_DECL(getw, int, (FILE *stream));
Philip Carns's avatar
Philip Carns committed
103
DARSHAN_FORWARD_DECL(_IO_getc, int, (FILE *stream));
Philip Carns's avatar
Philip Carns committed
104
DARSHAN_FORWARD_DECL(_IO_putc, int, (int, FILE *stream));
105
DARSHAN_FORWARD_DECL(fscanf, int, (FILE *stream, const char *format, ...));
Philip Carns's avatar
Philip Carns committed
106
DARSHAN_FORWARD_DECL(__isoc99_fscanf, int, (FILE *stream, const char *format, ...));
107
DARSHAN_FORWARD_DECL(vfscanf, int, (FILE *stream, const char *format, va_list ap));
Philip Carns's avatar
Philip Carns committed
108
DARSHAN_FORWARD_DECL(fgets, char*, (char *s, int size, FILE *stream));
109
DARSHAN_FORWARD_DECL(fseek, int, (FILE *stream, long offset, int whence));
Philip Carns's avatar
Philip Carns committed
110
DARSHAN_FORWARD_DECL(fseeko, int, (FILE *stream, off_t offset, int whence));
Philip Carns's avatar
Philip Carns committed
111
DARSHAN_FORWARD_DECL(fseeko64, int, (FILE *stream, off_t offset, int whence));
112
DARSHAN_FORWARD_DECL(fsetpos, int, (FILE *stream, const fpos_t *pos));
113
DARSHAN_FORWARD_DECL(fsetpos64, int, (FILE *stream, const fpos64_t *pos));
Philip Carns's avatar
Philip Carns committed
114
DARSHAN_FORWARD_DECL(rewind, void, (FILE *stream));
115

116 117
/* structure to track stdio stats at runtime */
struct stdio_file_record_ref
118
{
119
    struct darshan_stdio_file* file_rec;
120 121 122 123
    int64_t offset;
    double last_meta_end;
    double last_read_end;
    double last_write_end;
124
    int fs_type;
125 126 127 128 129 130 131 132
};

/* The stdio_runtime structure maintains necessary state for storing
 * STDIO file records and for coordinating with darshan-core at 
 * shutdown time.
 */
struct stdio_runtime
{
133 134 135
    void *rec_id_hash;
    void *stream_hash;
    int file_rec_count;
136 137 138 139 140 141 142 143 144
};

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

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

#define STDIO_LOCK() pthread_mutex_lock(&stdio_runtime_mutex)
#define STDIO_UNLOCK() pthread_mutex_unlock(&stdio_runtime_mutex)

163 164
#define STDIO_PRE_RECORD() do { \
    STDIO_LOCK(); \
165 166 167
    if(!instrumentation_disabled) { \
        if(!stdio_runtime) stdio_runtime_initialize(); \
        if(stdio_runtime) break; \
168
    } \
169 170
    STDIO_UNLOCK(); \
    return(ret); \
171 172 173 174 175 176
} while(0)

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

177
#define STDIO_RECORD_OPEN(__ret, __path, __tm1, __tm2) do { \
178 179 180
    darshan_record_id rec_id; \
    struct stdio_file_record_ref* rec_ref; \
    char *newpath; \
181
    int __fd; \
182
    if(__ret == NULL) break; \
183 184 185 186 187
    newpath = darshan_clean_file_path(__path); \
    if(!newpath) newpath = (char*)__path; \
    if(darshan_core_excluded_path(newpath)) { \
        if(newpath != (char*)__path) free(newpath); \
        break; \
188
    } \
189
    rec_id = darshan_core_gen_record_id(newpath); \
Philip Carns's avatar
Philip Carns committed
190
    rec_ref = darshan_lookup_record_ref(stdio_runtime->rec_id_hash, &rec_id, sizeof(rec_id)); \
191 192 193 194 195 196 197 198 199 200 201 202 203
    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); \
204 205
    __fd = fileno(__ret); \
    darshan_instrument_fs_data(rec_ref->fs_type, newpath, __fd); \
206
    if(newpath != (char*)__path) free(newpath); \
207 208 209
} while(0)


210
#define STDIO_RECORD_READ(__fp, __bytes,  __tm1, __tm2) do{ \
211
    struct stdio_file_record_ref* rec_ref; \
212
    int64_t this_offset; \
Philip Carns's avatar
Philip Carns committed
213
    rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &(__fp), sizeof(__fp)); \
214 215 216 217 218 219 220 221 222 223 224 225
    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; \
    DARSHAN_TIMER_INC_NO_OVERLAP(rec_ref->file_rec->fcounters[STDIO_F_READ_TIME], __tm1, __tm2, rec_ref->last_write_end); \
226 227
} while(0)

Philip Carns's avatar
Philip Carns committed
228
#define STDIO_RECORD_WRITE(__fp, __bytes,  __tm1, __tm2, __fflush_flag) do{ \
229
    struct stdio_file_record_ref* rec_ref; \
230
    int64_t this_offset; \
Philip Carns's avatar
Philip Carns committed
231
    rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &(__fp), sizeof(__fp)); \
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_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
238
    if(__fflush_flag) \
239
        rec_ref->file_rec->counters[STDIO_FLUSHES] += 1; \
Philip Carns's avatar
Philip Carns committed
240
    else \
241 242 243 244 245 246
        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); \
247
} while(0)
248

Philip Carns's avatar
Philip Carns committed
249
FILE* DARSHAN_DECL(fopen)(const char *path, const char *mode)
Philip Carns's avatar
Philip Carns committed
250 251 252 253
{
    FILE* ret;
    double tm1, tm2;

Philip Carns's avatar
Philip Carns committed
254
    MAP_OR_FAIL(fopen);
Philip Carns's avatar
Philip Carns committed
255 256

    tm1 = darshan_core_wtime();
Philip Carns's avatar
Philip Carns committed
257
    ret = __real_fopen(path, mode);
Philip Carns's avatar
Philip Carns committed
258 259
    tm2 = darshan_core_wtime();

260
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
261
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
262
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
263 264 265 266

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
267
FILE* DARSHAN_DECL(fopen64)(const char *path, const char *mode)
268 269
{
    FILE* ret;
270
    double tm1, tm2;
271 272 273

    MAP_OR_FAIL(fopen);

274
    tm1 = darshan_core_wtime();
Philip Carns's avatar
Philip Carns committed
275
    ret = __real_fopen64(path, mode);
276 277
    tm2 = darshan_core_wtime();

278
    STDIO_PRE_RECORD();
279
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
280
    STDIO_POST_RECORD();
281 282 283 284

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
285
FILE* DARSHAN_DECL(fdopen)(int fd, const char *mode)
286 287
{
    FILE* ret;
Philip Carns's avatar
Philip Carns committed
288
    double tm1, tm2;
289

Philip Carns's avatar
Philip Carns committed
290
    MAP_OR_FAIL(fdopen);
291

Philip Carns's avatar
Philip Carns committed
292
    tm1 = darshan_core_wtime();
Philip Carns's avatar
Philip Carns committed
293 294 295
    ret = __real_fdopen(fd, mode);
    tm2 = darshan_core_wtime();

296
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
297
    STDIO_RECORD_OPEN(ret, "UNKNOWN-FDOPEN", tm1, tm2);
298
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
299 300 301 302 303 304 305 306 307 308 309 310 311

    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
312 313
    tm2 = darshan_core_wtime();

314
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
315
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
316
    STDIO_POST_RECORD();
317 318 319 320

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
321 322 323 324 325 326 327 328 329 330 331
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();

332
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
333
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
334
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
335 336 337 338 339

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
340 341 342 343 344 345 346 347 348 349 350
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();

351
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
352 353
    if(ret >= 0)
        STDIO_RECORD_WRITE(fp, 0, tm1, tm2, 1);
354
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
355 356 357 358

    return(ret);
}

359 360 361 362
int DARSHAN_DECL(fclose)(FILE *fp)
{
    double tm1, tm2;
    int ret;
363
    struct stdio_file_record_ref *rec_ref;
364 365 366 367 368 369 370

    MAP_OR_FAIL(fclose);

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

371 372 373
    STDIO_PRE_RECORD();
    rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &fp, sizeof(fp));
    if(rec_ref)
374
    {
375 376 377 378
        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;
379
        DARSHAN_TIMER_INC_NO_OVERLAP(
380 381 382
            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));
383
    }
384
    STDIO_POST_RECORD();
385 386 387 388

    return(ret);
}

389 390 391 392 393 394 395 396 397 398 399
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();

400
    STDIO_PRE_RECORD();
401
    if(ret > 0)
Philip Carns's avatar
Philip Carns committed
402
        STDIO_RECORD_WRITE(stream, size*ret, tm1, tm2, 0);
403
    STDIO_POST_RECORD();
404 405 406 407

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
408 409 410 411 412 413 414 415 416 417 418 419

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

420
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
421 422
    if(ret != EOF)
        STDIO_RECORD_WRITE(stream, 1, tm1, tm2, 0);
423
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
424 425 426 427

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
428 429 430 431 432 433 434 435 436 437 438
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();

439
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
440 441
    if(ret != EOF)
        STDIO_RECORD_WRITE(stream, sizeof(int), tm1, tm2, 0);
442
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
443 444 445 446 447

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
448 449 450 451 452 453 454 455 456 457 458 459

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

460
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
461 462
    if(ret != EOF && ret > 0)
        STDIO_RECORD_WRITE(stream, strlen(s), tm1, tm2, 0);
463
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
464 465 466 467

    return(ret);
}

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
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
487 488 489 490 491 492 493 494 495 496 497 498
int DARSHAN_DECL(vfprintf)(FILE *stream, const char *format, va_list ap)
{
    int ret;
    double tm1, tm2;
    long start_off, end_off;

    MAP_OR_FAIL(vfprintf);

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

499
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
500
    if(ret > 0)
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
        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);
528
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550

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

551
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
552
    if(ret > 0)
553
        STDIO_RECORD_WRITE(stream, ret, tm1, tm2, 0);
554
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
555 556 557 558

    return(ret);
}

559 560 561 562 563 564 565 566 567 568 569
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();

570
    STDIO_PRE_RECORD();
571 572
    if(ret > 0)
        STDIO_RECORD_READ(stream, size*ret, tm1, tm2);
573
    STDIO_POST_RECORD();
574 575 576 577

    return(ret);
}

578
int DARSHAN_DECL(fgetc)(FILE *stream)
Philip Carns's avatar
Philip Carns committed
579 580 581 582 583 584 585 586 587 588
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(fgetc);

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

589
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
590 591
    if(ret != EOF)
        STDIO_RECORD_READ(stream, 1, tm1, tm2);
592
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
593 594 595 596 597

    return(ret);
}

/* NOTE: stdio.h typically implements getc() as a macro pointing to _IO_getc */
598
int DARSHAN_DECL(_IO_getc)(FILE *stream)
Philip Carns's avatar
Philip Carns committed
599 600 601 602 603 604 605 606 607 608
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(_IO_getc);

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

609
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
610 611
    if(ret != EOF)
        STDIO_RECORD_READ(stream, 1, tm1, tm2);
612
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
613 614 615 616

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
617
/* NOTE: stdio.h typically implements putc() as a macro pointing to _IO_putc */
618
int DARSHAN_DECL(_IO_putc)(int c, FILE *stream)
Philip Carns's avatar
Philip Carns committed
619 620 621 622 623 624 625 626 627 628
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(_IO_putc);

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

629
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
630 631
    if(ret != EOF)
        STDIO_RECORD_WRITE(stream, 1, tm1, tm2, 0);
632
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
633 634 635

    return(ret);
}
636 637

int DARSHAN_DECL(getw)(FILE *stream)
Philip Carns's avatar
Philip Carns committed
638 639 640 641 642 643 644 645 646 647
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(getw);

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

648
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
649 650
    if(ret != EOF || ferror(stream) == 0)
        STDIO_RECORD_READ(stream, sizeof(int), tm1, tm2);
651
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
652 653 654 655

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
/* 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();

679
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
680 681
    if(ret != 0)
        STDIO_RECORD_READ(stream, (end_off-start_off), tm1, tm2);
682
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
683 684 685 686

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
687

688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
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();

708
    STDIO_PRE_RECORD();
709
    if(ret != 0)
Philip Carns's avatar
Philip Carns committed
710
        STDIO_RECORD_READ(stream, (end_off-start_off), tm1, tm2);
711
    STDIO_POST_RECORD();
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729

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

730
    STDIO_PRE_RECORD();
731 732
    if(ret != 0)
        STDIO_RECORD_READ(stream, end_off-start_off, tm1, tm2);
733
    STDIO_POST_RECORD();
734 735 736 737 738

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
739 740 741 742 743 744 745 746 747 748 749
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();

750
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
751 752
    if(ret != NULL)
        STDIO_RECORD_READ(stream, strlen(ret), tm1, tm2);
753
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
754 755 756 757 758

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
759 760 761
void DARSHAN_DECL(rewind)(FILE *stream)
{
    double tm1, tm2;
762
    struct stdio_file_record_ref *rec_ref;
Philip Carns's avatar
Philip Carns committed
763 764 765 766 767 768 769

    MAP_OR_FAIL(rewind);

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

770 771 772
    /* 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
773
    STDIO_LOCK();
774 775 776 777 778
    if(instrumentation_disabled) {
        STDIO_UNLOCK();
        return;
    }
    if(!stdio_runtime) stdio_runtime_initialize();
779 780 781 782 783 784 785 786
    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
787
    {
788
        rec_ref->offset = 0;
Philip Carns's avatar
Philip Carns committed
789
        DARSHAN_TIMER_INC_NO_OVERLAP(
790 791 792
            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
793
    }
794
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
795 796 797 798

    return;
}

799 800 801
int DARSHAN_DECL(fseek)(FILE *stream, long offset, int whence)
{
    int ret;
802
    struct stdio_file_record_ref *rec_ref;
803 804 805 806 807 808 809 810 811 812
    double tm1, tm2;

    MAP_OR_FAIL(fseek);

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

    if(ret >= 0)
    {
813 814 815
        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
816
        {
817
            rec_ref->offset = ftell(stream);
Philip Carns's avatar
Philip Carns committed
818
            DARSHAN_TIMER_INC_NO_OVERLAP(
819 820 821
                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
822
        }
823
        STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
824 825 826 827 828 829 830 831
    }

    return(ret);
}

int DARSHAN_DECL(fseeko)(FILE *stream, off_t offset, int whence)
{
    int ret;
832
    struct stdio_file_record_ref *rec_ref;
Philip Carns's avatar
Philip Carns committed
833 834 835 836 837 838 839 840 841 842
    double tm1, tm2;

    MAP_OR_FAIL(fseeko);

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

    if(ret >= 0)
    {
843 844 845
        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
846
        {
847
            rec_ref->offset = ftell(stream);
Philip Carns's avatar
Philip Carns committed
848
            DARSHAN_TIMER_INC_NO_OVERLAP(
849 850 851
                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
852
        }
853
        STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
854 855 856 857 858 859 860 861
    }

    return(ret);
}

int DARSHAN_DECL(fseeko64)(FILE *stream, off_t offset, int whence)
{
    int ret;
862
    struct stdio_file_record_ref *rec_ref;
Philip Carns's avatar
Philip Carns committed
863 864 865 866 867 868 869 870 871 872
    double tm1, tm2;

    MAP_OR_FAIL(fseeko64);

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

    if(ret >= 0)
    {
873 874 875
        STDIO_PRE_RECORD();
        rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &stream, sizeof(stream));
        if(rec_ref)
876
        {
877
            rec_ref->offset = ftell(stream);
878
            DARSHAN_TIMER_INC_NO_OVERLAP(
879 880 881
                rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
                tm1, tm2, rec_ref->last_meta_end);
            rec_ref->file_rec->counters[STDIO_SEEKS] += 1;
882
        }
883
        STDIO_POST_RECORD();
884 885 886 887 888
    }

    return(ret);
}

889 890 891
int DARSHAN_DECL(fsetpos)(FILE *stream, const fpos_t *pos)
{
    int ret;
892
    struct stdio_file_record_ref *rec_ref;
893 894 895 896 897 898 899 900 901 902
    double tm1, tm2;

    MAP_OR_FAIL(fsetpos);

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

    if(ret >= 0)
    {
903 904 905
        STDIO_PRE_RECORD();
        rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &stream, sizeof(stream));
        if(rec_ref)
906
        {
907
            rec_ref->offset = ftell(stream);
908
            DARSHAN_TIMER_INC_NO_OVERLAP(
909 910 911
                rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
                tm1, tm2, rec_ref->last_meta_end);
            rec_ref->file_rec->counters[STDIO_SEEKS] += 1;
912
        }
913
        STDIO_POST_RECORD();
914 915 916 917 918
    }

    return(ret);
}

919
int DARSHAN_DECL(fsetpos64)(FILE *stream, const fpos64_t *pos)
920 921
{
    int ret;
922
    struct stdio_file_record_ref *rec_ref;
923 924 925 926 927 928 929 930 931 932
    double tm1, tm2;

    MAP_OR_FAIL(fsetpos64);

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

    if(ret >= 0)
    {
933 934 935
        STDIO_PRE_RECORD();
        rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &stream, sizeof(stream));
        if(rec_ref)
936
        {
937
            rec_ref->offset = ftell(stream);
938
            DARSHAN_TIMER_INC_NO_OVERLAP(
939 940 941
                rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
                tm1, tm2, rec_ref->last_meta_end);
            rec_ref->file_rec->counters[STDIO_SEEKS] += 1;
942
        }
943
        STDIO_POST_RECORD();
944 945 946 947 948 949
    }

    return(ret);
}


950 951 952 953 954 955 956
/**********************************************************
 * Internal functions for manipulating STDIO module state *
 **********************************************************/

/* initialize internal STDIO module data structures and register with darshan-core */
static void stdio_runtime_initialize()
{
957 958 959 960
    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);
961 962 963 964

    /* register the stdio module with darshan core */
    darshan_core_register_module(
        DARSHAN_STDIO_MOD,
965 966
        &stdio_shutdown,
        &stdio_buf_size,
967
        &my_rank,
968 969
        &darshan_mem_alignment);

970 971 972 973
    /* return if darshan-core does not provide enough module memory */
    if(stdio_buf_size < sizeof(struct darshan_stdio_file))
    {
        darshan_core_unregister_module(DARSHAN_POSIX_MOD);
974
        return;
975
    }
976 977 978 979

    stdio_runtime = malloc(sizeof(*stdio_runtime));
    if(!stdio_runtime)
    {
980
        darshan_core_unregister_module(DARSHAN_STDIO_MOD);
981 982
        return;
    }
983
    memset(stdio_runtime, 0, sizeof(*stdio_runtime));
984 985 986 987 988

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

991 992 993
/************************************************************************
 * Functions exported by this module for coordinating with darshan-core *
 ************************************************************************/
994

995 996
static void stdio_record_reduction_op(void* infile_v, void* inoutfile_v,
    int *len, MPI_Datatype *datatype)
997
{
998 999 1000 1001
    struct darshan_stdio_file tmp_file;
    struct darshan_stdio_file *infile = infile_v;
    struct darshan_stdio_file *inoutfile = inoutfile_v;
    int i, j;
1002

1003
    assert(stdio_runtime);
1004

1005
    for(i=0; i<*len; i++)
1006
    {
1007 1008 1009
        memset(&tmp_file, 0, sizeof(struct darshan_stdio_file));
        tmp_file.base_rec.id = infile->base_rec.id;
        tmp_file.base_rec.rank = -1;
1010

1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
        /* 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];
        }
1025

1026 1027 1028 1029 1030
        /* sum */
        for(j=STDIO_F_META_TIME; j<=STDIO_F_READ_TIME; j++)
        {
            tmp_file.fcounters[j] = infile->fcounters[j] + inoutfile->fcounters[j];
        }
1031

1032 1033 1034 1035 1036 1037 1038 1039 1040
        /* 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];
        }
1041

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

1093 1094 1095 1096
        /* update pointers */
        *inoutfile = tmp_file;
        inoutfile++;
        infile++;
1097 1098 1099 1100 1101
    }

    return;
}

1102
static void stdio_shutdown(
1103 1104 1105 1106 1107 1108
    MPI_Comm mod_comm,
    darshan_record_id *shared_recs,
    int shared_rec_count,
    void **stdio_buf,
    int *stdio_buf_sz)
{
1109 1110
    struct stdio_file_record_ref *rec_ref;
    struct darshan_stdio_file *stdio_rec_buf = *(struct darshan_stdio_file **)stdio_buf;
1111
    int i;
1112 1113
    struct darshan_stdio_file *red_send_buf = NULL;
    struct darshan_stdio_file *red_recv_buf = NULL;
1114 1115
    MPI_Datatype red_type;
    MPI_Op red_op;
1116
    int stdio_rec_count;
1117
    double stdio_time;
1118

1119
    STDIO_LOCK();
1120
    assert(stdio_runtime);
1121 1122 1123 1124

    /* disable further instrumentation */
    instrumentation_disabled = 1;

1125
    stdio_rec_count = stdio_runtime->file_rec_count;
1126

1127 1128 1129 1130 1131 1132 1133 1134 1135
    /* 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++)
        {
1136 1137 1138
            rec_ref = darshan_lookup_record_ref(stdio_runtime->rec_id_hash,
                &shared_recs[i], sizeof(darshan_record_id));
            assert(rec_ref);
1139

1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
            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];

1165
            rec_ref->file_rec->base_rec.rank = -1;
1166 1167 1168 1169 1170 1171
        }

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

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

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

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

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

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

1205 1206 1207
        /* clean up reduction state */
        if(my_rank == 0)
        {
1208 1209 1210
            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));
1211 1212 1213 1214
            free(red_recv_buf);
        }
        else
        {
1215
            stdio_rec_count -= shared_rec_count;
1216 1217 1218 1219 1220 1221
        }

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

1222 1223
    /* update output buffer size to account for shared file reduction */
    *stdio_buf_sz = stdio_rec_count * sizeof(struct darshan_stdio_file);
1224

1225 1226
    /* shutdown internal structures used for instrumenting */
    stdio_cleanup_runtime();
1227

1228 1229 1230
    STDIO_UNLOCK();
    
    return;
1231 1232
}

1233 1234
static struct stdio_file_record_ref *stdio_track_new_file_record(
    darshan_record_id rec_id, const char *path)
1235
{
1236 1237
    struct darshan_stdio_file *file_rec = NULL;
    struct stdio_file_record_ref *rec_ref = NULL;
1238
    struct darshan_fs_info fs_info;
1239
    int ret;
1240

1241 1242 1243 1244
    rec_ref = malloc(sizeof(*rec_ref));
    if(!rec_ref)
        return(NULL);
    memset(rec_ref, 0, sizeof(*rec_ref));
1245

1246 1247 1248 1249
    /* 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)
1250
    {
1251 1252 1253
        free(rec_ref);
        return(NULL);
    }
1254

1255 1256 1257 1258 1259 1260
    /* 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
1261
        DARSHAN_STDIO_MOD,
1262
        sizeof(struct darshan_stdio_file),
1263
        &fs_info);
1264 1265 1266 1267 1268 1269 1270 1271

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

1273 1274 1275
    /* registering this file record was successful, so initialize some fields */
    file_rec->base_rec.id = rec_id;
    file_rec->base_rec.rank = my_rank;
1276
    rec_ref->fs_type = fs_info.fs_type;
1277 1278
    rec_ref->file_rec = file_rec;
    stdio_runtime->file_rec_count++;
1279

1280
    return(rec_ref);
1281 1282 1283

}

1284
static void stdio_cleanup_runtime()
1285
{
1286 1287
    darshan_clear_record_refs(&(stdio_runtime->stream_hash), 0);
    darshan_clear_record_refs(&(stdio_runtime->rec_id_hash), 1);
1288 1289 1290

    free(stdio_runtime);
    stdio_runtime = NULL;
1291
    instrumentation_disabled = 0;
1292

1293 1294 1295
    return;
}

1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 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
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;

    DARSHAN_MPI_CALL(PMPI_Type_contiguous)(sizeof(struct darshan_variance_dt),
        MPI_BYTE, &var_dt);
    DARSHAN_MPI_CALL(PMPI_Type_commit)(&var_dt);

    DARSHAN_MPI_CALL(PMPI_Op_create)(darshan_variance_reduce, 1, &var_op);

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

    DARSHAN_MPI_CALL(PMPI_Reduce)(var_send_buf, var_recv_buf, shared_rec_count,
        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];
    }

    DARSHAN_MPI_CALL(PMPI_Reduce)(var_send_buf, var_recv_buf, shared_rec_count,
        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);
        }
    }

    DARSHAN_MPI_CALL(PMPI_Type_free)(&var_dt);
    DARSHAN_MPI_CALL(PMPI_Op_free)(&var_op);
    free(var_send_buf);
    free(var_recv_buf);

    return;
}


1379 1380 1381 1382 1383 1384 1385 1386
/*
 * Local variables:
 *  c-indent-level: 4
 *  c-basic-offset: 4
 * End:
 *
 * vim: ts=8 sts=4 sw=4 expandtab
 */