darshan-posix.c 16.6 KB
Newer Older
1 2 3 4 5
/*
 *  (C) 2009 by Argonne National Laboratory.
 *      See COPYRIGHT in top-level directory.
 */

6 7
#define _GNU_SOURCE

8
#include "darshan-runtime-config.h"
9

10 11 12 13 14 15 16 17 18 19 20 21 22 23
#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>
24
#include <libgen.h>
25
#include <aio.h>
26
#include <pthread.h>
27

28
#include "uthash.h"
29
#include "darshan.h"
30
#include "darshan-posix-log-format.h"
31

32
#ifndef HAVE_OFF64_T
33 34
typedef int64_t off64_t;
#endif
35 36 37
#ifndef HAVE_AIOCB64
#define aiocb64 aiocb
#endif
38

39 40
/* TODO these go where ? */

41 42 43 44 45
#define DARSHAN_FORWARD_DECL(name,ret,args) \
  extern ret __real_ ## name args;

#define DARSHAN_DECL(__name) __wrap_ ## __name

46 47
#define MAP_OR_FAIL(func)

48
struct posix_runtime_file
49
{
50
    struct darshan_posix_file* file_record;
51
    UT_hash_handle hlink;
52
};
53

54
struct posix_runtime_file_ref
55
{
56 57 58 59 60 61 62
    struct posix_runtime_file* file;
    int fd;
    UT_hash_handle hlink;
};

struct posix_runtime
{
63 64
    struct posix_runtime_file* file_runtime_array;
    struct darshan_posix_file* file_record_array;
65
    int file_array_size;
66
    int file_array_ndx;
67 68
    struct posix_runtime_file* file_hash;
    struct posix_runtime_file_ref* fd_hash;
69 70
    void *red_buf;
    int shared_rec_count;
71 72
};

73
static struct posix_runtime *posix_runtime = NULL;
74
static pthread_mutex_t posix_runtime_mutex = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP;
Shane Snyder's avatar
Shane Snyder committed
75
static int instrumentation_disabled = 0;
76
static int my_rank = -1;
77

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
/* these are paths that we will not trace */
static char* exclusions[] = {
"/etc/",
"/dev/",
"/usr/",
"/bin/",
"/boot/",
"/lib/",
"/opt/",
"/sbin/",
"/sys/",
"/proc/",
NULL
};

93
DARSHAN_FORWARD_DECL(open, int, (const char *path, int flags, ...));
Shane Snyder's avatar
Shane Snyder committed
94
DARSHAN_FORWARD_DECL(open64, int, (const char *path, int flags, ...));
95
DARSHAN_FORWARD_DECL(close, int, (int fd));
96

97 98
static void posix_runtime_initialize(void);

99 100
static struct posix_runtime_file* posix_file_by_name(const char *name);
static struct posix_runtime_file* posix_file_by_name_setfd(const char* name, int fd);
Shane Snyder's avatar
Shane Snyder committed
101
static struct posix_runtime_file* posix_file_by_fd(int fd);
102 103
static void posix_file_close_fd(int fd);

Shane Snyder's avatar
Shane Snyder committed
104
static void posix_disable_instrumentation(void);
105 106 107 108 109
static void posix_prepare_for_reduction(darshan_record_id *shared_recs,
    int *shared_rec_count, void **send_buf, void **recv_buf, int *rec_size);
static void posix_reduce_record(void* infile_v, void* inoutfile_v,
    int *len, MPI_Datatype *datatype);
static void posix_get_output_data(void **buffer, int *size);
110
static void posix_shutdown(void);
111

112 113
#define POSIX_LOCK() pthread_mutex_lock(&posix_runtime_mutex)
#define POSIX_UNLOCK() pthread_mutex_unlock(&posix_runtime_mutex)
114

115
#define POSIX_SET(__file, __counter, __value) do {\
116
    (__file)->file_record->counters[__counter] = __value; \
117 118 119
} while(0)

#define POSIX_F_SET(__file, __counter, __value) do {\
120
    (__file)->file_record->fcounters[__counter] = __value; \
121 122 123
} while(0)

#define POSIX_INC(__file, __counter, __value) do {\
124
    (__file)->file_record->counters[__counter] += __value; \
125 126 127
} while(0)

#define POSIX_F_INC(__file, __counter, __value) do {\
128
    (__file)->file_record->fcounters[__counter] += __value; \
129 130 131 132 133 134 135 136 137 138 139 140
} while(0)

#define POSIX_F_INC_NO_OVERLAP(__file, __tm1, __tm2, __last, __counter) do { \
    if(__tm1 > __last) \
        POSIX_F_INC(__file, __counter, (__tm2-__tm1)); \
    else \
        POSIX_F_INC(__file, __counter, (__tm2 - __last)); \
    if(__tm2 > __last) \
        __last = __tm2; \
} while(0)

#define POSIX_VALUE(__file, __counter) \
141
    ((__file)->file_record->counters[__counter])
142 143

#define POSIX_F_VALUE(__file, __counter) \
144
    ((__file)->file_record->fcounters[__counter])
145 146

#define POSIX_MAX(__file, __counter, __value) do {\
147
    if((__file)->file_record->counters[__counter] < __value) \
148
    { \
149
        (__file)->file_record->counters[__counter] = __value; \
150 151 152
    } \
} while(0)

153
#define POSIX_RECORD_OPEN(__ret, __path, __mode, __stream_flag, __tm1, __tm2) do { \
154
    struct posix_runtime_file* file; \
155 156 157 158 159 160 161 162 163
    char* exclude; \
    int tmp_index = 0; \
    if(__ret < 0) break; \
    while((exclude = exclusions[tmp_index])) { \
        if(!(strncmp(exclude, __path, strlen(exclude)))) \
            break; \
        tmp_index++; \
    } \
    if(exclude) break; \
164
    file = posix_file_by_name_setfd(__path, __ret); \
165
    if(!file) break; \
166
    file->file_record->rank = my_rank; \
167
    if(__mode) \
168
        POSIX_SET(file, CP_MODE, __mode); \
169
    if(__stream_flag)\
170
        POSIX_INC(file, CP_POSIX_FOPENS, 1); \
171
    else \
172 173 174 175
        POSIX_INC(file, CP_POSIX_OPENS, 1); \
    if(POSIX_F_VALUE(file, CP_F_OPEN_TIMESTAMP) == 0) \
        POSIX_F_SET(file, CP_F_OPEN_TIMESTAMP, __tm1); \
} while(0)
176

177
int DARSHAN_DECL(open)(const char *path, int flags, ...)
178 179 180 181 182
{
    int mode = 0;
    int ret;
    double tm1, tm2;

183 184
    MAP_OR_FAIL(open);

185
    if(flags & O_CREAT) 
186 187 188 189 190 191
    {
        va_list arg;
        va_start(arg, flags);
        mode = va_arg(arg, int);
        va_end(arg);

192
        tm1 = darshan_core_wtime();
193
        ret = __real_open(path, flags, mode);
194
        tm2 = darshan_core_wtime();
195 196 197
    }
    else
    {
198
        tm1 = darshan_core_wtime();
199
        ret = __real_open(path, flags);
200
        tm2 = darshan_core_wtime();
201 202
    }

203 204 205
    POSIX_LOCK();
    posix_runtime_initialize();

206
    POSIX_RECORD_OPEN(ret, path, mode, 0, tm1, tm2);
207

208
    POSIX_UNLOCK();
209 210 211 212

    return(ret);
}

Shane Snyder's avatar
Shane Snyder committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
int DARSHAN_DECL(open64)(const char *path, int flags, ...)
{
    int mode = 0;
    int ret;
    double tm1, tm2;

    MAP_OR_FAIL(open);

    if(flags & O_CREAT)
    {
        va_list arg;
        va_start(arg, flags);
        mode = va_arg(arg, int);
        va_end(arg);

        tm1 = darshan_core_wtime();
        ret = __real_open64(path, flags, mode);
        tm2 = darshan_core_wtime();
    }
    else
    {
        tm1 = darshan_core_wtime();
        ret = __real_open64(path, flags);
        tm2 = darshan_core_wtime();
    }

    POSIX_LOCK();
    posix_runtime_initialize();

    POSIX_RECORD_OPEN(ret, path, mode, 0, tm1, tm2);
    POSIX_UNLOCK();

    return(ret);
}

248 249
int DARSHAN_DECL(close)(int fd)
{
Shane Snyder's avatar
Shane Snyder committed
250
    struct posix_runtime_file* file;
251 252 253 254 255 256 257 258 259 260 261
    double tm1, tm2;
    int ret;

    MAP_OR_FAIL(close);

    tm1 = darshan_core_wtime();
    ret = __real_close(fd);
    tm2 = darshan_core_wtime();

    POSIX_LOCK();
    posix_runtime_initialize();
262

Shane Snyder's avatar
Shane Snyder committed
263 264 265 266 267 268
    file = posix_file_by_fd(fd);
    if(file)
    {
        POSIX_F_SET(file, CP_F_CLOSE_TIMESTAMP, darshan_core_wtime());
        posix_file_close_fd(fd);
    }
269 270 271 272 273 274
    POSIX_UNLOCK();    

    return(ret);
}

/* ***************************************************** */
275

276
static void posix_runtime_initialize()
277
{
278 279 280 281 282 283
    char *alignstr;
    int tmpval;
    int ret;
    int mem_limit;
    struct darshan_module_funcs posix_mod_fns =
    {
Shane Snyder's avatar
Shane Snyder committed
284
        .disable_instrumentation = &posix_disable_instrumentation,
285 286
        .prepare_for_reduction = &posix_prepare_for_reduction,
        .reduce_record = &posix_reduce_record,
287
        .get_output_data = &posix_get_output_data,
288
        .shutdown = &posix_shutdown
289
    };
290

Shane Snyder's avatar
Shane Snyder committed
291 292
    /* don't do anything if already initialized or instrumenation is disabled */
    if(posix_runtime || instrumentation_disabled)
293
        return;
294

295 296
    /* register the posix module with darshan core */
    darshan_core_register_module(
297
        DARSHAN_POSIX_MOD,
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
        &posix_mod_fns,
        &mem_limit);

    /* return if no memory assigned by darshan core */
    if(mem_limit == 0)
        return;

    posix_runtime = malloc(sizeof(*posix_runtime));
    if(!posix_runtime)
        return;
    memset(posix_runtime, 0, sizeof(*posix_runtime));

    /* set maximum number of file records according to max memory limit */
    /* NOTE: maximum number of records is based on the size of a posix file record */
    posix_runtime->file_array_size = mem_limit / sizeof(struct darshan_posix_file);
313
    posix_runtime->file_array_ndx = 0;
314 315

    /* allocate array of runtime file records */
316 317 318 319 320
    posix_runtime->file_runtime_array = malloc(posix_runtime->file_array_size *
                                               sizeof(struct posix_runtime_file));
    posix_runtime->file_record_array = malloc(posix_runtime->file_array_size *
                                              sizeof(struct darshan_posix_file));
    if(!posix_runtime->file_runtime_array || !posix_runtime->file_record_array)
321 322 323 324
    {
        posix_runtime->file_array_size = 0;
        return;
    }
325 326 327 328
    memset(posix_runtime->file_runtime_array, 0, posix_runtime->file_array_size *
           sizeof(struct posix_runtime_file));
    memset(posix_runtime->file_record_array, 0, posix_runtime->file_array_size *
           sizeof(struct darshan_posix_file));
329

Shane Snyder's avatar
Shane Snyder committed
330
    DARSHAN_MPI_CALL(PMPI_Comm_rank)(MPI_COMM_WORLD, &my_rank); /* TODO: can we move this out of here? */
331

332 333
    return;
}
334

335
static struct posix_runtime_file* posix_file_by_name(const char *name)
336
{
337
    struct posix_runtime_file *file = NULL;
338
    char *newname = NULL;
339
    darshan_record_id file_id;
340

Shane Snyder's avatar
Shane Snyder committed
341
    if(!posix_runtime || instrumentation_disabled)
342
        return(NULL);
343

344
    newname = darshan_clean_file_path(name);
345
    if(!newname)
346
        newname = (char*)name;
347

348
    /* get a unique id for this file from darshan core */
349
    darshan_core_lookup_record_id(
350 351 352
        (void*)newname,
        strlen(newname),
        1,
353
        DARSHAN_POSIX_MOD,
354
        &file_id);
355

356
    /* search the hash table for this file record, and return if found */
357
    HASH_FIND(hlink, posix_runtime->file_hash, &file_id, sizeof(darshan_record_id), file);
358
    if(file)
359
    {
360
        if(newname != name)
361
            free(newname);
362
        return(file);
363 364
    }

365 366 367 368 369 370
    if(posix_runtime->file_array_ndx < posix_runtime->file_array_size);
    {
        /* no existing record, assign a new file record from the global array */
        file = &(posix_runtime->file_runtime_array[posix_runtime->file_array_ndx]);
        file->file_record = &(posix_runtime->file_record_array[posix_runtime->file_array_ndx]);
        file->file_record->f_id = file_id;
371

372
        /* add new record to file hash table */
373
        HASH_ADD(hlink, posix_runtime->file_hash, file_record->f_id, sizeof(darshan_record_id), file);
374

375 376
        posix_runtime->file_array_ndx++;
    }
377 378

    if(newname != name)
379
        free(newname);
380 381 382 383 384 385 386 387
    return(file);
}

static struct posix_runtime_file* posix_file_by_name_setfd(const char* name, int fd)
{
    struct posix_runtime_file* file;
    struct posix_runtime_file_ref* ref;

Shane Snyder's avatar
Shane Snyder committed
388
    if(!posix_runtime || instrumentation_disabled)
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
        return(NULL);

    /* find file record by name first */
    file = posix_file_by_name(name);

    if(!file)
        return(NULL);

    /* search hash table for existing file ref for this fd */
    HASH_FIND(hlink, posix_runtime->fd_hash, &fd, sizeof(int), ref);
    if(ref)
    {
        /* we have a reference.  Make sure it points to the correct file
         * and return it
         */
        ref->file = file;
        return(file);
    }

    /* if we hit this point, then we don't have a reference for this fd
     * in the table yet.  Add it.
     */
    ref = malloc(sizeof(*ref));
    if(!ref)
        return(NULL);
    memset(ref, 0, sizeof(*ref));
Shane Snyder's avatar
Shane Snyder committed
415

416 417 418 419 420 421 422
    ref->file = file;
    ref->fd = fd;    
    HASH_ADD(hlink, posix_runtime->fd_hash, fd, sizeof(int), ref);

    return(file);
}

Shane Snyder's avatar
Shane Snyder committed
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
static struct posix_runtime_file* posix_file_by_fd(int fd)
{
    struct posix_runtime_file_ref* ref;

    if(!posix_runtime || instrumentation_disabled)
        return(NULL);

    /* search hash table for existing file ref for this fd */
    HASH_FIND(hlink, posix_runtime->fd_hash, &fd, sizeof(int), ref);
    if(ref)
        return(ref->file);

    return(NULL);
}

438 439
static void posix_file_close_fd(int fd)
{
440
    struct posix_runtime_file_ref* ref;
441

Shane Snyder's avatar
Shane Snyder committed
442
    if(!posix_runtime || instrumentation_disabled)
443 444 445 446
        return;

    /* search hash table for this fd */
    HASH_FIND(hlink, posix_runtime->fd_hash, &fd, sizeof(int), ref);
447
    if(ref)
448 449 450 451 452 453 454
    {
        /* we have a reference, delete it */
        HASH_DELETE(hlink, posix_runtime->fd_hash, ref);
        free(ref);
    }

    return;
455 456
}

457 458 459 460 461 462 463 464 465 466 467 468 469
static int posix_file_compare(const void* a, const void* b)
{
    const struct darshan_posix_file* f_a = a;
    const struct darshan_posix_file* f_b = b;

    if(f_a->rank < f_b->rank)
        return 1;
    if(f_a->rank > f_b->rank)
        return -1;

    return 0;
}

470 471
/* ***************************************************** */

Shane Snyder's avatar
Shane Snyder committed
472
static void posix_disable_instrumentation()
473
{
474 475
    assert(posix_runtime);

Shane Snyder's avatar
Shane Snyder committed
476 477 478
    POSIX_LOCK();
    instrumentation_disabled = 1;
    POSIX_UNLOCK();
479

Shane Snyder's avatar
Shane Snyder committed
480 481 482
    return;
}

483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 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 528 529 530 531 532 533 534 535 536 537 538 539 540
static void posix_prepare_for_reduction(
    darshan_record_id *shared_recs,
    int *shared_rec_count,
    void **send_buf,
    void **recv_buf,
    int *rec_size)
{
    struct posix_runtime_file *file;
    struct darshan_posix_file *tmp_array;
    int i;

    assert(posix_runtime);

    /* necessary initialization of shared records (e.g., change rank to -1) */
    for(i = 0; i < *shared_rec_count; i++)
    {
        HASH_FIND(hlink, posix_runtime->file_hash, &shared_recs[i],
            sizeof(darshan_record_id), file);
        assert(file);

        /* TODO: any initialization before reduction */
        file->file_record->rank = -1;
    }

    /* sort the array of files descending by rank so that we get all of the 
     * shared files (marked by rank -1) in a contiguous portion at end 
     * of the array
     */
    qsort(posix_runtime->file_record_array, posix_runtime->file_array_ndx,
        sizeof(struct darshan_posix_file), posix_file_compare);

    /* make *send_buf point to the shared files at the end of sorted array */
    *send_buf =
        &(posix_runtime->file_record_array[posix_runtime->file_array_ndx-(*shared_rec_count)]);

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

    *rec_size = sizeof(struct darshan_posix_file);

    /* TODO: HACK-Y -- how can we do this in a cleaner way?? */
    if(my_rank == 0)
        posix_runtime->red_buf = *recv_buf;
    posix_runtime->shared_rec_count = *shared_rec_count;

    return;
}

static void posix_reduce_record(
    void* infile_v,
    void* inoutfile_v,
    int *len,
    MPI_Datatype *datatype)
Shane Snyder's avatar
Shane Snyder committed
541
{
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
    struct darshan_posix_file tmp_file;
    struct darshan_posix_file *infile = infile_v;
    struct darshan_posix_file *inoutfile = inoutfile_v;
    int i;

    assert(posix_runtime);

    for(i = 0; i < *len; i++)
    {
        memset(&tmp_file, 0, sizeof(struct darshan_posix_file));

        tmp_file.f_id = infile->f_id;
        tmp_file.rank = -1;

        tmp_file.counters[CP_POSIX_OPENS] = infile->counters[CP_POSIX_OPENS] +
            inoutfile->counters[CP_POSIX_OPENS];

        if((infile->fcounters[CP_F_OPEN_TIMESTAMP] > inoutfile->fcounters[CP_F_OPEN_TIMESTAMP]) &&
            (inoutfile->fcounters[CP_F_OPEN_TIMESTAMP] > 0))
            tmp_file.fcounters[CP_F_OPEN_TIMESTAMP] = inoutfile->fcounters[CP_F_OPEN_TIMESTAMP];
        else
            tmp_file.fcounters[CP_F_OPEN_TIMESTAMP] = infile->fcounters[CP_F_OPEN_TIMESTAMP];

        if(infile->fcounters[CP_F_CLOSE_TIMESTAMP] > inoutfile->fcounters[CP_F_CLOSE_TIMESTAMP])
            tmp_file.fcounters[CP_F_CLOSE_TIMESTAMP] = infile->fcounters[CP_F_CLOSE_TIMESTAMP];
        else
            tmp_file.fcounters[CP_F_CLOSE_TIMESTAMP] = inoutfile->fcounters[CP_F_CLOSE_TIMESTAMP];

        /* update pointers */
        *inoutfile = tmp_file;
        inoutfile++;
        infile++;
    }

    return;
}

static void posix_get_output_data(
    void **buffer,
    int *size)
{
    assert(posix_runtime);

    /* TODO: HACK-Y -- how can we do this in a cleaner way?? */
    /* clean up reduction state */
    if(my_rank == 0)
    {
        int tmp_ndx = posix_runtime->file_array_ndx - posix_runtime->shared_rec_count;
        memcpy(&(posix_runtime->file_record_array[tmp_ndx]), posix_runtime->red_buf,
            posix_runtime->shared_rec_count * sizeof(struct darshan_posix_file));
        free(posix_runtime->red_buf);
    }
    else
    {
        posix_runtime->file_array_ndx -= posix_runtime->shared_rec_count;
    }
598 599 600

    *buffer = (void *)(posix_runtime->file_record_array);
    *size = posix_runtime->file_array_ndx * sizeof(struct darshan_posix_file);
601

602
    return;
603 604
}

605
static void posix_shutdown()
606
{
607 608 609 610 611 612 613
    struct posix_runtime_file_ref *ref, *tmp;

    HASH_ITER(hlink, posix_runtime->fd_hash, ref, tmp)
    {
        HASH_DELETE(hlink, posix_runtime->fd_hash, ref);
        free(ref);
    }
614

615
    HASH_CLEAR(hlink, posix_runtime->file_hash); /* these entries are freed all at once below */
616 617 618 619 620

    free(posix_runtime->file_runtime_array);
    free(posix_runtime->file_record_array);
    free(posix_runtime);
    posix_runtime = NULL;
621 622

    return;
623 624
}

625 626 627 628 629 630 631 632
/*
 * Local variables:
 *  c-indent-level: 4
 *  c-basic-offset: 4
 * End:
 *
 * vim: ts=8 sts=4 sw=4 expandtab
 */