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

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

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

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

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

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

91 92
DARSHAN_FORWARD_DECL(fopen, FILE*, (const char *path, const char *mode));
DARSHAN_FORWARD_DECL(fopen64, FILE*, (const char *path, const char *mode));
Philip Carns's avatar
Philip Carns committed
93
DARSHAN_FORWARD_DECL(fdopen, FILE*, (int fd, const char *mode));
Philip Carns's avatar
Philip Carns committed
94
DARSHAN_FORWARD_DECL(freopen, FILE*, (const char *path, const char *mode, FILE *stream));
Philip Carns's avatar
Philip Carns committed
95
DARSHAN_FORWARD_DECL(freopen64, FILE*, (const char *path, const char *mode, FILE *stream));
96
DARSHAN_FORWARD_DECL(fclose, int, (FILE *fp));
Philip Carns's avatar
Philip Carns committed
97
DARSHAN_FORWARD_DECL(fflush, int, (FILE *fp));
98
DARSHAN_FORWARD_DECL(fwrite, size_t, (const void *ptr, size_t size, size_t nmemb, FILE *stream));
Philip Carns's avatar
Philip Carns committed
99
DARSHAN_FORWARD_DECL(fputc, int, (int c, FILE *stream));
Philip Carns's avatar
Philip Carns committed
100
DARSHAN_FORWARD_DECL(putw, int, (int w, FILE *stream));
Philip Carns's avatar
Philip Carns committed
101
DARSHAN_FORWARD_DECL(fputs, int, (const char *s, FILE *stream));
Philip Carns's avatar
Philip Carns committed
102
DARSHAN_FORWARD_DECL(fprintf, int, (FILE *stream, const char *format, ...));
103
DARSHAN_FORWARD_DECL(printf, int, (const char *format, ...));
Philip Carns's avatar
Philip Carns committed
104
DARSHAN_FORWARD_DECL(vfprintf, int, (FILE *stream, const char *format, va_list));
105
DARSHAN_FORWARD_DECL(vprintf, int, (const char *format, va_list));
106
DARSHAN_FORWARD_DECL(fread, size_t, (void *ptr, size_t size, size_t nmemb, FILE *stream));
Philip Carns's avatar
Philip Carns committed
107
DARSHAN_FORWARD_DECL(fgetc, int, (FILE *stream));
Philip Carns's avatar
Philip Carns committed
108
DARSHAN_FORWARD_DECL(getw, int, (FILE *stream));
Philip Carns's avatar
Philip Carns committed
109
DARSHAN_FORWARD_DECL(_IO_getc, int, (FILE *stream));
Philip Carns's avatar
Philip Carns committed
110
DARSHAN_FORWARD_DECL(_IO_putc, int, (int, FILE *stream));
Philip Carns's avatar
Philip Carns committed
111
DARSHAN_FORWARD_DECL(fscanf, int, (FILE *stream, const char *format, ...));
Philip Carns's avatar
Philip Carns committed
112
DARSHAN_FORWARD_DECL(__isoc99_fscanf, int, (FILE *stream, const char *format, ...));
Philip Carns's avatar
Philip Carns committed
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));
Philip Carns's avatar
Philip Carns committed
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

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

168 169
#define STDIO_PRE_RECORD() do { \
    STDIO_LOCK(); \
170
    if(!darshan_core_disabled_instrumentation()) { \
171 172
        if(!stdio_runtime) stdio_runtime_initialize(); \
        if(stdio_runtime) break; \
173
    } \
174 175
    STDIO_UNLOCK(); \
    return(ret); \
176 177 178 179 180 181
} while(0)

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

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


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

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

Philip Carns's avatar
Philip Carns committed
254
FILE* DARSHAN_DECL(fopen)(const char *path, const char *mode)
Philip Carns's avatar
Philip Carns committed
255 256 257 258
{
    FILE* ret;
    double tm1, tm2;

Philip Carns's avatar
Philip Carns committed
259
    MAP_OR_FAIL(fopen);
Philip Carns's avatar
Philip Carns committed
260 261

    tm1 = darshan_core_wtime();
Philip Carns's avatar
Philip Carns committed
262
    ret = __real_fopen(path, mode);
Philip Carns's avatar
Philip Carns committed
263 264
    tm2 = darshan_core_wtime();

265
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
266
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
267
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
268 269 270 271

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
272
FILE* DARSHAN_DECL(fopen64)(const char *path, const char *mode)
273 274
{
    FILE* ret;
Philip Carns's avatar
Philip Carns committed
275
    double tm1, tm2;
276

Shane Snyder's avatar
Shane Snyder committed
277
    MAP_OR_FAIL(fopen64);
278

Philip Carns's avatar
Philip Carns committed
279
    tm1 = darshan_core_wtime();
Philip Carns's avatar
Philip Carns committed
280
    ret = __real_fopen64(path, mode);
Philip Carns's avatar
Philip Carns committed
281 282
    tm2 = darshan_core_wtime();

283
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
284
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
285
    STDIO_POST_RECORD();
286 287 288 289

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
290
FILE* DARSHAN_DECL(fdopen)(int fd, const char *mode)
291 292
{
    FILE* ret;
Philip Carns's avatar
Philip Carns committed
293
    double tm1, tm2;
294

Philip Carns's avatar
Philip Carns committed
295
    MAP_OR_FAIL(fdopen);
296

Philip Carns's avatar
Philip Carns committed
297
    tm1 = darshan_core_wtime();
Philip Carns's avatar
Philip Carns committed
298 299 300
    ret = __real_fdopen(fd, mode);
    tm2 = darshan_core_wtime();

301
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
302
    STDIO_RECORD_OPEN(ret, "UNKNOWN-FDOPEN", tm1, tm2);
303
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
304 305 306 307 308 309 310 311 312 313 314 315 316

    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
317 318
    tm2 = darshan_core_wtime();

319
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
320
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
321
    STDIO_POST_RECORD();
322 323 324 325

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
326 327 328 329 330 331 332 333 334 335 336
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();

337
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
338
    STDIO_RECORD_OPEN(ret, path, tm1, tm2);
339
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
340 341 342 343 344

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
345 346 347 348 349 350 351 352 353 354 355
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();

356
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
357 358
    if(ret >= 0)
        STDIO_RECORD_WRITE(fp, 0, tm1, tm2, 1);
359
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
360 361 362 363

    return(ret);
}

364 365 366 367
int DARSHAN_DECL(fclose)(FILE *fp)
{
    double tm1, tm2;
    int ret;
368
    struct stdio_file_record_ref *rec_ref;
369 370 371 372 373 374 375

    MAP_OR_FAIL(fclose);

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

376 377 378
    STDIO_PRE_RECORD();
    rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &fp, sizeof(fp));
    if(rec_ref)
379
    {
380 381 382 383
        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;
384
        DARSHAN_TIMER_INC_NO_OVERLAP(
385 386 387
            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));
388
    }
389
    STDIO_POST_RECORD();
390 391 392 393

    return(ret);
}

394 395 396 397 398 399 400 401 402 403 404
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();

405
    STDIO_PRE_RECORD();
406
    if(ret > 0)
Philip Carns's avatar
Philip Carns committed
407
        STDIO_RECORD_WRITE(stream, size*ret, tm1, tm2, 0);
408
    STDIO_POST_RECORD();
409 410 411 412

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
413 414 415 416 417 418 419 420 421 422 423 424

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

425
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
426 427
    if(ret != EOF)
        STDIO_RECORD_WRITE(stream, 1, tm1, tm2, 0);
428
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
429 430 431 432

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
433 434 435 436 437 438 439 440 441 442 443
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();

444
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
445 446
    if(ret != EOF)
        STDIO_RECORD_WRITE(stream, sizeof(int), tm1, tm2, 0);
447
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
448 449 450 451 452

    return(ret);
}


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

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

465
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
466 467
    if(ret != EOF && ret > 0)
        STDIO_RECORD_WRITE(stream, strlen(s), tm1, tm2, 0);
468
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
469 470 471 472

    return(ret);
}

473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
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
492 493 494 495 496 497 498 499 500 501 502
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();

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

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

555
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
556
    if(ret > 0)
557
        STDIO_RECORD_WRITE(stream, ret, tm1, tm2, 0);
558
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
559 560 561 562

    return(ret);
}

563 564 565 566 567 568 569 570 571 572 573
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();

574
    STDIO_PRE_RECORD();
575 576
    if(ret > 0)
        STDIO_RECORD_READ(stream, size*ret, tm1, tm2);
577
    STDIO_POST_RECORD();
578 579 580 581

    return(ret);
}

582
int DARSHAN_DECL(fgetc)(FILE *stream)
Philip Carns's avatar
Philip Carns committed
583 584 585 586 587 588 589 590 591 592
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(fgetc);

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

593
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
594 595
    if(ret != EOF)
        STDIO_RECORD_READ(stream, 1, tm1, tm2);
596
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
597 598 599 600 601

    return(ret);
}

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

    MAP_OR_FAIL(_IO_getc);

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

613
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
614 615
    if(ret != EOF)
        STDIO_RECORD_READ(stream, 1, tm1, tm2);
616
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
617 618 619 620

    return(ret);
}

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

    MAP_OR_FAIL(_IO_putc);

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

633
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
634 635
    if(ret != EOF)
        STDIO_RECORD_WRITE(stream, 1, tm1, tm2, 0);
636
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
637 638 639

    return(ret);
}
640 641

int DARSHAN_DECL(getw)(FILE *stream)
Philip Carns's avatar
Philip Carns committed
642 643 644 645 646 647 648 649 650 651
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(getw);

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

652
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
653 654
    if(ret != EOF || ferror(stream) == 0)
        STDIO_RECORD_READ(stream, sizeof(int), tm1, tm2);
655
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
656 657 658 659

    return(ret);
}

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

683
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
684 685
    if(ret != 0)
        STDIO_RECORD_READ(stream, (end_off-start_off), tm1, tm2);
686
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
687 688 689 690

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
691

Philip Carns's avatar
Philip Carns committed
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
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();

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

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

734
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
735 736
    if(ret != 0)
        STDIO_RECORD_READ(stream, end_off-start_off, tm1, tm2);
737
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
738 739 740 741 742

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
743 744 745 746 747 748 749 750 751 752 753
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();

754
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
755 756
    if(ret != NULL)
        STDIO_RECORD_READ(stream, strlen(ret), tm1, tm2);
757
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
758 759 760 761 762

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
763 764 765
void DARSHAN_DECL(rewind)(FILE *stream)
{
    double tm1, tm2;
766
    struct stdio_file_record_ref *rec_ref;
Philip Carns's avatar
Philip Carns committed
767 768 769 770 771 772 773

    MAP_OR_FAIL(rewind);

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

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

    return;
}

803 804 805
int DARSHAN_DECL(fseek)(FILE *stream, long offset, int whence)
{
    int ret;
806
    struct stdio_file_record_ref *rec_ref;
807 808 809 810 811 812 813 814 815 816
    double tm1, tm2;

    MAP_OR_FAIL(fseek);

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

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

    return(ret);
}

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

    MAP_OR_FAIL(fseeko);

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

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

    return(ret);
}

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

    MAP_OR_FAIL(fseeko64);

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

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

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
893 894 895
int DARSHAN_DECL(fsetpos)(FILE *stream, const fpos_t *pos)
{
    int ret;
896
    struct stdio_file_record_ref *rec_ref;
Philip Carns's avatar
Philip Carns committed
897 898 899 900 901 902 903 904 905 906
    double tm1, tm2;

    MAP_OR_FAIL(fsetpos);

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

    if(ret >= 0)
    {
907 908 909
        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
910
        {
911
            rec_ref->offset = ftell(stream);
Philip Carns's avatar
Philip Carns committed
912
            DARSHAN_TIMER_INC_NO_OVERLAP(
913 914 915
                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
916
        }
917
        STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
918 919 920 921 922
    }

    return(ret);
}

923
int DARSHAN_DECL(fsetpos64)(FILE *stream, const fpos64_t *pos)
Philip Carns's avatar
Philip Carns committed
924 925
{
    int ret;
926
    struct stdio_file_record_ref *rec_ref;
Philip Carns's avatar
Philip Carns committed
927 928 929 930 931 932 933 934 935 936
    double tm1, tm2;

    MAP_OR_FAIL(fsetpos64);

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

    if(ret >= 0)
    {
937 938 939
        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
940
        {
941
            rec_ref->offset = ftell(stream);
Philip Carns's avatar
Philip Carns committed
942
            DARSHAN_TIMER_INC_NO_OVERLAP(
943 944 945
                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
946
        }
947
        STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
948 949 950 951 952 953
    }

    return(ret);
}


954 955 956 957 958 959 960
/**********************************************************
 * Internal functions for manipulating STDIO module state *
 **********************************************************/

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

    /* register the stdio module with darshan core */
    darshan_core_register_module(
        DARSHAN_STDIO_MOD,
969 970
        &stdio_shutdown,
        &stdio_buf_size,
971
        &my_rank,
972 973
        &darshan_mem_alignment);

974 975 976
    /* return if darshan-core does not provide enough module memory */
    if(stdio_buf_size < sizeof(struct darshan_stdio_file))
    {
Shane Snyder's avatar
Shane Snyder committed
977
        darshan_core_unregister_module(DARSHAN_STDIO_MOD);
978
        return;
979
    }
980 981 982 983

    stdio_runtime = malloc(sizeof(*stdio_runtime));
    if(!stdio_runtime)
    {
984
        darshan_core_unregister_module(DARSHAN_STDIO_MOD);
985 986
        return;
    }
987
    memset(stdio_runtime, 0, sizeof(*stdio_runtime));
988 989 990 991 992

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

995 996 997
/************************************************************************
 * Functions exported by this module for coordinating with darshan-core *
 ************************************************************************/
998

999 1000
static void stdio_record_reduction_op(void* infile_v, void* inoutfile_v,
    int *len, MPI_Datatype *datatype)
1001
{
1002 1003 1004 1005
    struct darshan_stdio_file tmp_file;
    struct darshan_stdio_file *infile = infile_v;
    struct darshan_stdio_file *inoutfile = inoutfile_v;
    int i, j;
1006

1007
    assert(stdio_runtime);
1008

1009
    for(i=0; i<*len; i++)
1010
    {
1011 1012 1013
        memset(&tmp_file, 0, sizeof(struct darshan_stdio_file));
        tmp_file.base_rec.id = infile->base_rec.id;
        tmp_file.base_rec.rank = -1;
1014

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
        /* 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];
        }
1029

1030 1031 1032 1033 1034
        /* sum */
        for(j=STDIO_F_META_TIME; j<=STDIO_F_READ_TIME; j++)
        {
            tmp_file.fcounters[j] = infile->fcounters[j] + inoutfile->fcounters[j];
        }
1035

1036 1037 1038 1039 1040 1041 1042 1043 1044
        /* 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