darshan-stdio.c 42 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
DARSHAN_FORWARD_DECL(fileno, int, (FILE *stream));
122

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

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

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

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

166 167 168
/* external prototype from POSIX module used to register new POSIX file
 * records corresponding to file descriptors returned by STDIO fileno()
 */
169
extern int darshan_posix_add_open_fd(int fd, char *rec_name, int counter,
170 171
    double tm1, double tm2);

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

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

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

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


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

Philip Carns's avatar
Philip Carns committed
241
#define STDIO_RECORD_WRITE(__fp, __bytes,  __tm1, __tm2, __fflush_flag) do{ \
242
    struct stdio_file_record_ref* rec_ref; \
243
    int64_t this_offset; \
Philip Carns's avatar
Philip Carns committed
244
    rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &(__fp), sizeof(__fp)); \
245 246 247 248 249 250
    if(!rec_ref) break; \
    this_offset = rec_ref->offset; \
    rec_ref->offset = this_offset + __bytes; \
    if(rec_ref->file_rec->counters[STDIO_MAX_BYTE_WRITTEN] < (this_offset + __bytes - 1)) \
        rec_ref->file_rec->counters[STDIO_MAX_BYTE_WRITTEN] = (this_offset + __bytes - 1); \
    rec_ref->file_rec->counters[STDIO_BYTES_WRITTEN] += __bytes; \
Philip Carns's avatar
Philip Carns committed
251
    if(__fflush_flag) \
252
        rec_ref->file_rec->counters[STDIO_FLUSHES] += 1; \
Philip Carns's avatar
Philip Carns committed
253
    else \
254 255 256 257 258 259
        rec_ref->file_rec->counters[STDIO_WRITES] += 1; \
    if(rec_ref->file_rec->fcounters[STDIO_F_WRITE_START_TIMESTAMP] == 0 || \
     rec_ref->file_rec->fcounters[STDIO_F_WRITE_START_TIMESTAMP] > __tm1) \
        rec_ref->file_rec->fcounters[STDIO_F_WRITE_START_TIMESTAMP] = __tm1; \
    rec_ref->file_rec->fcounters[STDIO_F_WRITE_END_TIMESTAMP] = __tm2; \
    DARSHAN_TIMER_INC_NO_OVERLAP(rec_ref->file_rec->fcounters[STDIO_F_WRITE_TIME], __tm1, __tm2, rec_ref->last_write_end); \
260
} while(0)
Philip Carns's avatar
Philip Carns committed
261

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

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

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

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

    return(ret);
}

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

Shane Snyder's avatar
Shane Snyder committed
285
    MAP_OR_FAIL(fopen64);
286

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

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

    return(ret);
}

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

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

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

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

    return(ret);
}

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

    MAP_OR_FAIL(freopen);

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

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

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
334 335 336 337 338 339 340 341 342 343 344
FILE* DARSHAN_DECL(freopen64)(const char *path, const char *mode, FILE *stream)
{
    FILE* ret;
    double tm1, tm2;

    MAP_OR_FAIL(freopen64);

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

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

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
353 354 355 356 357 358 359 360 361 362 363
int DARSHAN_DECL(fflush)(FILE *fp)
{
    double tm1, tm2;
    int ret;

    MAP_OR_FAIL(fflush);

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

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

    return(ret);
}

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

    MAP_OR_FAIL(fclose);

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

384 385 386
    STDIO_PRE_RECORD();
    rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &fp, sizeof(fp));
    if(rec_ref)
387
    {
388 389 390 391
        if(rec_ref->file_rec->fcounters[STDIO_F_CLOSE_START_TIMESTAMP] == 0 ||
         rec_ref->file_rec->fcounters[STDIO_F_CLOSE_START_TIMESTAMP] > tm1)
           rec_ref->file_rec->fcounters[STDIO_F_CLOSE_START_TIMESTAMP] = tm1;
        rec_ref->file_rec->fcounters[STDIO_F_CLOSE_END_TIMESTAMP] = tm2;
392
        DARSHAN_TIMER_INC_NO_OVERLAP(
393 394 395
            rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
            tm1, tm2, rec_ref->last_meta_end);
        darshan_delete_record_ref(&(stdio_runtime->stream_hash), &fp, sizeof(fp));
396
    }
397
    STDIO_POST_RECORD();
398 399 400 401

    return(ret);
}

402 403 404 405 406 407 408 409 410 411 412
size_t DARSHAN_DECL(fwrite)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
{
    size_t ret;
    double tm1, tm2;

    MAP_OR_FAIL(fwrite);

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

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

    return(ret);
}

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

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

    MAP_OR_FAIL(fputc);

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

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

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
441 442 443 444 445 446 447 448 449 450 451
int DARSHAN_DECL(putw)(int w, FILE *stream)
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(putw);

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

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

    return(ret);
}


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

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

    MAP_OR_FAIL(fputs);

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

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

    return(ret);
}

481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
int DARSHAN_DECL(vprintf)(const char *format, va_list ap)
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(vprintf);

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

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

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
500 501 502 503 504 505 506 507 508 509 510
int DARSHAN_DECL(vfprintf)(FILE *stream, const char *format, va_list ap)
{
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(vfprintf);

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

511
    STDIO_PRE_RECORD();
Philip Carns's avatar
Philip Carns committed
512
    if(ret > 0)
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
        STDIO_RECORD_WRITE(stream, ret, tm1, tm2, 0);
    STDIO_POST_RECORD();

    return(ret);
}


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

    MAP_OR_FAIL(vprintf);

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

    STDIO_PRE_RECORD();
    if(ret > 0)
        STDIO_RECORD_WRITE(stdout, ret, tm1, tm2, 0);
540
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561

    return(ret);
}

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

    MAP_OR_FAIL(vfprintf);

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

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

    return(ret);
}

570 571 572 573 574 575 576 577 578 579 580
size_t DARSHAN_DECL(fread)(void *ptr, size_t size, size_t nmemb, FILE *stream)
{
    size_t ret;
    double tm1, tm2;

    MAP_OR_FAIL(fread);

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

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

    return(ret);
}

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

    MAP_OR_FAIL(fgetc);

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

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

    return(ret);
}

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

    MAP_OR_FAIL(_IO_getc);

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

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

    return(ret);
}

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

    MAP_OR_FAIL(_IO_putc);

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

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

    return(ret);
}
647 648

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

    MAP_OR_FAIL(getw);

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

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

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
/* NOTE: some glibc versions use __isoc99_fscanf as the underlying symbol
 * rather than fscanf
 */
int DARSHAN_DECL(__isoc99_fscanf)(FILE *stream, const char *format, ...)
{
    int ret;
    double tm1, tm2;
    va_list ap;
    long start_off, end_off;

    MAP_OR_FAIL(vfscanf);

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

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

    return(ret);
}

Philip Carns's avatar
Philip Carns committed
698

Philip Carns's avatar
Philip Carns committed
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
int DARSHAN_DECL(fscanf)(FILE *stream, const char *format, ...)
{
    int ret;
    double tm1, tm2;
    va_list ap;
    long start_off, end_off;

    MAP_OR_FAIL(vfscanf);

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

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

    return(ret);
}

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

    MAP_OR_FAIL(vfscanf);

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

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

    return(ret);
}


Philip Carns's avatar
Philip Carns committed
750 751 752 753 754 755 756 757 758 759 760
char* DARSHAN_DECL(fgets)(char *s, int size, FILE *stream)
{
    char *ret;
    double tm1, tm2;

    MAP_OR_FAIL(fgets);

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

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

    return(ret);
}


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

    MAP_OR_FAIL(rewind);

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

781 782 783
    /* NOTE: we don't use STDIO_PRE_RECORD here because there is no return
     * value in this wrapper.
     */
Philip Carns's avatar
Philip Carns committed
784
    STDIO_LOCK();
785
    if(darshan_core_disabled_instrumentation()) {
786 787 788 789
        STDIO_UNLOCK();
        return;
    }
    if(!stdio_runtime) stdio_runtime_initialize();
790 791 792 793 794 795 796 797
    if(!stdio_runtime) {
        STDIO_UNLOCK();
        return;
    }

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

    if(rec_ref)
Philip Carns's avatar
Philip Carns committed
798
    {
799
        rec_ref->offset = 0;
Philip Carns's avatar
Philip Carns committed
800
        DARSHAN_TIMER_INC_NO_OVERLAP(
801 802 803
            rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
            tm1, tm2, rec_ref->last_meta_end);
        rec_ref->file_rec->counters[STDIO_SEEKS] += 1;
Philip Carns's avatar
Philip Carns committed
804
    }
805
    STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
806 807 808 809

    return;
}

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

    MAP_OR_FAIL(fseek);

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

    if(ret >= 0)
    {
824 825 826
        STDIO_PRE_RECORD();
        rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &stream, sizeof(stream));
        if(rec_ref)
Philip Carns's avatar
Philip Carns committed
827
        {
828
            rec_ref->offset = ftell(stream);
Philip Carns's avatar
Philip Carns committed
829
            DARSHAN_TIMER_INC_NO_OVERLAP(
830 831 832
                rec_ref->file_rec->fcounters[STDIO_F_META_TIME],
                tm1, tm2, rec_ref->last_meta_end);
            rec_ref->file_rec->counters[STDIO_SEEKS] += 1;
Philip Carns's avatar
Philip Carns committed
833
        }
834
        STDIO_POST_RECORD();
Philip Carns's avatar
Philip Carns committed
835 836 837 838 839 840 841 842
    }

    return(ret);
}

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

    MAP_OR_FAIL(fseeko);

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

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

    return(ret);
}

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

    MAP_OR_FAIL(fseeko64);

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

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

    return(ret);
}

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

    MAP_OR_FAIL(fsetpos);

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

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

    return(ret);
}

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

    MAP_OR_FAIL(fsetpos64);

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

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

    return(ret);
}

960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
int DARSHAN_DECL(fileno)(FILE *stream)
{
    int ret;
    struct stdio_file_record_ref *rec_ref;
    double tm1, tm2;

    MAP_OR_FAIL(fileno);

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

    if(ret >= 0)
    {
        STDIO_PRE_RECORD();
        rec_ref = darshan_lookup_record_ref(stdio_runtime->stream_hash, &stream, sizeof(stream));
        if(rec_ref)
        {
            char *rec_name = darshan_core_lookup_record_name(
                rec_ref->file_rec->base_rec.id);
            /* register this new FD with the POSIX module so we can track it */
981
            darshan_posix_add_open_fd(ret, rec_name, POSIX_FILENOS, tm1, tm2);
982 983 984 985 986 987
        }
        STDIO_POST_RECORD();
    }

    return(ret);
}
Philip Carns's avatar
Philip Carns committed
988

989 990 991 992 993 994 995
/**********************************************************
 * Internal functions for manipulating STDIO module state *
 **********************************************************/

/* initialize internal STDIO module data structures and register with darshan-core */
static void stdio_runtime_initialize()
{
996 997 998 999
    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);
1000 1001 1002 1003

    /* register the stdio module with darshan core */
    darshan_core_register_module(
        DARSHAN_STDIO_MOD,
1004 1005
        &stdio_shutdown,
        &stdio_buf_size,
1006
        &my_rank,
1007 1008
        &darshan_mem_alignment);

1009 1010 1011
    /* 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
1012
        darshan_core_unregister_module(DARSHAN_STDIO_MOD);
1013
        return;
1014
    }
1015 1016 1017 1018

    stdio_runtime = malloc(sizeof(*stdio_runtime));
    if(!stdio_runtime)
    {
1019
        darshan_core_unregister_module(DARSHAN_STDIO_MOD);
1020 1021
        return;
    }
1022
    memset(stdio_runtime, 0, sizeof(*stdio_runtime));
1023 1024 1025 1026 1027

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

1030 1031 1032
/************************************************************************
 * Functions exported by this module for coordinating with darshan-core *
 ************************************************************************/
1033

1034 1035
static void stdio_record_reduction_op(void* infile_v, void* inoutfile_v,
    int *len, MPI_Datatype *datatype)
1036
{
1037 1038 1039 1040
    struct darshan_stdio_file tmp_file;
    struct darshan_stdio_file *infile = infile_v;
    struct darshan_stdio_file *inoutfile = inoutfile_v;
    int i, j;
1041

1042
    assert(stdio_runtime);