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

6
#define _XOPEN_SOURCE 500
7
#define _GNU_SOURCE
8

9 10 11 12 13 14
#include "darshan-runtime-config.h"

#include <stdio.h>
#ifdef HAVE_MNTENT_H
#include <mntent.h>
#endif
15 16 17 18 19
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <limits.h>
#include <pthread.h>
20 21 22
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/vfs.h>
23
#include <zlib.h>
24
#include <mpi.h>
25
#include <assert.h>
26

27
#include "uthash.h"
28 29
#include "darshan-core.h"

30 31
/* TODO is __progname_full needed here */
extern char* __progname;
32

33
/* internal variable delcarations */
34
static struct darshan_core_runtime *darshan_core = NULL;
35
static pthread_mutex_t darshan_core_mutex = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP;
36
static int my_rank = -1;
37
static int nprocs = -1;
38

Shane Snyder's avatar
Shane Snyder committed
39 40 41
#define DARSHAN_CORE_LOCK() pthread_mutex_lock(&darshan_core_mutex)
#define DARSHAN_CORE_UNLOCK() pthread_mutex_unlock(&darshan_core_mutex)

42 43 44 45 46 47 48 49 50 51 52 53 54
/* FS mount information */
#define DARSHAN_MAX_MNTS 64
#define DARSHAN_MAX_MNT_PATH 256
#define DARSHAN_MAX_MNT_TYPE 32
struct mnt_data
{
    int64_t block_size;
    char path[DARSHAN_MAX_MNT_PATH];
    char type[DARSHAN_MAX_MNT_TYPE];
};
static struct mnt_data mnt_data_array[DARSHAN_MAX_MNTS];
static int mnt_data_count = 0;

55 56 57 58 59 60
/* prototypes for internal helper functions */
static void darshan_core_initialize(
    int *argc, char ***argv);
static void darshan_core_shutdown(
    void);
static void darshan_core_cleanup(
61
    struct darshan_core_runtime* core);
62 63 64
static void darshan_get_logfile_name(
    char* logfile_name, int jobid, struct tm* start_tm);
static void darshan_log_record_hints_and_ver(
65 66 67 68 69 70
    struct darshan_core_runtime* core);
static void darshan_get_exe_and_mounts_root(
    struct darshan_core_runtime *core, char* trailing_data,
    int space_left);
static char* darshan_get_exe_and_mounts(
    struct darshan_core_runtime *core);
71
static void darshan_get_shared_records(
72
    struct darshan_core_runtime *core, darshan_record_id *shared_recs);
73 74
static int darshan_log_coll_open(
    char *logfile_name, MPI_File *log_fh);
75 76
static int darshan_compress_buffer(void **pointers, int *lengths,
    int count, char *comp_buf, int *comp_length);
77
static int darshan_log_write_record_hash(
78
    MPI_File log_fh, struct darshan_core_runtime *core,
79
    struct darshan_log_map *map);
80 81
static int darshan_log_coll_write(
    MPI_File log_fh, void *buf, int count, struct darshan_log_map *map);
82

83
/* intercept MPI initialize and finalize to manage darshan core runtime */
84 85 86 87 88 89 90 91 92 93
int MPI_Init(int *argc, char ***argv)
{
    int ret;

    ret = DARSHAN_MPI_CALL(PMPI_Init)(argc, argv);
    if(ret != MPI_SUCCESS)
    {
        return(ret);
    }

94
    darshan_core_initialize(argc, argv);
95 96 97 98

    return(ret);
}

99
int MPI_Init_thread(int *argc, char ***argv, int required, int *provided)
100 101 102 103
{
    int ret;

    ret = DARSHAN_MPI_CALL(PMPI_Init_thread)(argc, argv, required, provided);
104
    if(ret != MPI_SUCCESS)
105 106 107 108
    {
        return(ret);
    }

109
    darshan_core_initialize(argc, argv);
110 111 112 113 114 115 116 117

    return(ret);
}

int MPI_Finalize(void)
{
    int ret;

118
    darshan_core_shutdown();
119 120 121 122 123

    ret = DARSHAN_MPI_CALL(PMPI_Finalize)();
    return(ret);
}

124 125
/* *********************************** */

126
static void darshan_core_initialize(int *argc, char ***argv)
127 128 129 130 131 132 133 134 135
{
    int i;
    int internal_timing_flag = 0;
    double init_start, init_time, init_max;
    char* truncate_string = "<TRUNCATED>";
    int truncate_offset;
    int chars_left = 0;

    DARSHAN_MPI_CALL(PMPI_Comm_size)(MPI_COMM_WORLD, &nprocs);
136
    DARSHAN_MPI_CALL(PMPI_Comm_rank)(MPI_COMM_WORLD, &my_rank);
137 138 139 140

    if(getenv("DARSHAN_INTERNAL_TIMING"))
        internal_timing_flag = 1;

141
    if(internal_timing_flag)
142 143 144
        init_start = DARSHAN_MPI_CALL(PMPI_Wtime)();

    /* setup darshan runtime if darshan is enabled and hasn't been initialized already */
145
    if(!getenv("DARSHAN_DISABLE") && !darshan_core)
146
    {
147 148 149 150 151
        /* TODO: darshan mem alignment code? */

        /* allocate structure to track darshan_core_runtime information */
        darshan_core = malloc(sizeof(*darshan_core));
        if(darshan_core)
152
        {
153
            memset(darshan_core, 0, sizeof(*darshan_core));
154

155 156 157 158
            darshan_core->log_job.uid = getuid();
            darshan_core->log_job.start_time = time(NULL);
            darshan_core->log_job.nprocs = nprocs;
            darshan_core->wtime_offset = DARSHAN_MPI_CALL(PMPI_Wtime)();
159 160 161 162

            /* record exe and arguments */
            for(i=0; i<(*argc); i++)
            {
163
                chars_left = DARSHAN_EXE_LEN-strlen(darshan_core->exe);
164
                strncat(darshan_core->exe, (*argv)[i], chars_left);
165 166
                if(i < ((*argc)-1))
                {
167
                    chars_left = DARSHAN_EXE_LEN-strlen(darshan_core->exe);
168
                    strncat(darshan_core->exe, " ", chars_left);
169 170 171 172 173 174 175 176
                }
            }

            /* if we don't see any arguments, then use glibc symbol to get
             * program name at least (this happens in fortran)
             */
            if(argc == 0)
            {
177
                chars_left = DARSHAN_EXE_LEN-strlen(darshan_core->exe);
178
                strncat(darshan_core->exe, __progname, chars_left);
179
                chars_left = DARSHAN_EXE_LEN-strlen(darshan_core->exe);
180
                strncat(darshan_core->exe, " <unknown args>", chars_left);
181 182 183 184 185
            }

            if(chars_left == 0)
            {
                /* we ran out of room; mark that string was truncated */
186
                truncate_offset = DARSHAN_EXE_LEN - strlen(truncate_string);
187
                sprintf(&darshan_core->exe[truncate_offset], "%s",
188 189
                    truncate_string);
            }
190 191 192

            /* collect information about command line and mounted file systems */
            darshan_core->trailing_data = darshan_get_exe_and_mounts(darshan_core);
193 194 195 196 197 198 199 200
        }
    }

    if(internal_timing_flag)
    {
        init_time = DARSHAN_MPI_CALL(PMPI_Wtime)() - init_start;
        DARSHAN_MPI_CALL(PMPI_Reduce)(&init_time, &init_max, 1,
            MPI_DOUBLE, MPI_MAX, 0, MPI_COMM_WORLD);
201
        if(my_rank == 0)
202 203 204 205 206 207 208 209 210
        {
            printf("#darshan:<op>\t<nprocs>\t<time>\n");
            printf("darshan:init\t%d\t%f\n", nprocs, init_max);
        }
    }

    return;
}

211
static void darshan_core_shutdown()
212
{
213
    int i;
214
    char *logfile_name;
215
    struct darshan_core_runtime *final_core;
216
    int internal_timing_flag = 0;
217 218
    char *envjobid;
    char *jobid_str;
219
    int jobid;
220
    struct tm *start_tm;
221
    time_t start_time_tmp;
222 223
    int ret = 0;
    int all_ret = 0;
224 225
    int64_t first_start_time;
    int64_t last_end_time;
226 227
    int local_mod_use[DARSHAN_MAX_MODS] = {0};
    int global_mod_use_count[DARSHAN_MAX_MODS] = {0};
228
    darshan_record_id shared_recs[DARSHAN_CORE_MAX_RECORDS] = {0};
229
    double start_log_time;
230 231 232 233 234 235 236
    double open1, open2;
    double job1, job2;
    double rec1, rec2;
    double mod1[DARSHAN_MAX_MODS] = {0};
    double mod2[DARSHAN_MAX_MODS] = {0};
    double header1, header2;
    double tm_end;
237
    long offset;
238
    struct darshan_header log_header;
239
    MPI_File log_fh;
240
    MPI_Offset tmp_off = 0;
241
    MPI_Status status;
242 243 244 245

    if(getenv("DARSHAN_INTERNAL_TIMING"))
        internal_timing_flag = 1;

246 247
    start_log_time = DARSHAN_MPI_CALL(PMPI_Wtime)();

Shane Snyder's avatar
Shane Snyder committed
248
    /* disable darhan-core while we shutdown */
249
    DARSHAN_CORE_LOCK();
250
    if(!darshan_core)
251
    {
252
        DARSHAN_CORE_UNLOCK();
253 254
        return;
    }
255 256
    final_core = darshan_core;
    darshan_core = NULL;
Shane Snyder's avatar
Shane Snyder committed
257

258
    /* we also need to set which modules were registered on this process and
Shane Snyder's avatar
Shane Snyder committed
259 260 261 262 263 264 265 266 267 268
     * disable tracing within those modules while we shutdown
     */
    for(i = 0; i < DARSHAN_MAX_MODS; i++)
    {
        if(final_core->mod_array[i])
        {
            local_mod_use[i] = 1;
            final_core->mod_array[i]->mod_funcs.disable_instrumentation();
        }
    }
269
    DARSHAN_CORE_UNLOCK();
270 271 272 273

    logfile_name = malloc(PATH_MAX);
    if(!logfile_name)
    {
274
        darshan_core_cleanup(final_core);
275 276 277
        return;
    }

278
    /* set darshan job id/metadata and constuct log file name on rank 0 */
279
    if(my_rank == 0)
280 281 282
    {
        /* Use CP_JOBID_OVERRIDE for the env var or CP_JOBID */
        envjobid = getenv(CP_JOBID_OVERRIDE);
283
        if(!envjobid)
284 285 286 287
        {
            envjobid = CP_JOBID;
        }

288
        /* find a job id */
289 290 291 292 293 294 295 296 297 298 299 300
        jobid_str = getenv(envjobid);
        if(jobid_str)
        {
            /* in cobalt we can find it in env var */
            ret = sscanf(jobid_str, "%d", &jobid);
        }
        if(!jobid_str || ret != 1)
        {
            /* use pid as fall back */
            jobid = getpid();
        }

301
        final_core->log_job.jobid = (int64_t)jobid;
302

303
        /* if we are using any hints to write the log file, then record those
304
         * hints with the darshan job information
305
         */
306
        darshan_log_record_hints_and_ver(final_core);
307

308
        /* use human readable start time format in log filename */
309
        start_time_tmp = final_core->log_job.start_time;
310
        start_tm = localtime(&start_time_tmp);
311

312 313
        /* construct log file name */
        darshan_get_logfile_name(logfile_name, jobid, start_tm);
314 315 316 317 318 319 320 321 322
    }

    /* broadcast log file name */
    DARSHAN_MPI_CALL(PMPI_Bcast)(logfile_name, PATH_MAX, MPI_CHAR, 0,
        MPI_COMM_WORLD);

    if(strlen(logfile_name) == 0)
    {
        /* failed to generate log file name */
323
        free(logfile_name);
324
        darshan_core_cleanup(final_core);
325 326 327
        return;
    }

328
    final_core->log_job.end_time = time(NULL);
329

330 331 332
    /* reduce to report first start time and last end time across all ranks
     * at rank 0
     */
333 334
    DARSHAN_MPI_CALL(PMPI_Reduce)(&final_core->log_job.start_time, &first_start_time, 1, MPI_LONG_LONG, MPI_MIN, 0, MPI_COMM_WORLD);
    DARSHAN_MPI_CALL(PMPI_Reduce)(&final_core->log_job.end_time, &last_end_time, 1, MPI_LONG_LONG, MPI_MAX, 0, MPI_COMM_WORLD);
335 336
    if(my_rank == 0)
    {
337 338
        final_core->log_job.start_time = first_start_time;
        final_core->log_job.end_time = last_end_time;
339
    }
340

341 342 343
    /* reduce the number of times a module was opened globally and bcast to everyone */   
    DARSHAN_MPI_CALL(PMPI_Allreduce)(local_mod_use, global_mod_use_count, DARSHAN_MAX_MODS, MPI_INT, MPI_SUM, MPI_COMM_WORLD);

344
    /* get a list of records which are shared across all processes */
345
    darshan_get_shared_records(final_core, shared_recs);
346

347 348
    if(internal_timing_flag)
        open1 = DARSHAN_MPI_CALL(PMPI_Wtime)();
349 350
    /* collectively open the darshan log file */
    ret = darshan_log_coll_open(logfile_name, &log_fh);
351 352
    if(internal_timing_flag)
        open2 = DARSHAN_MPI_CALL(PMPI_Wtime)();
353 354 355 356 357 358 359 360

    /* error out if unable to open log file */
    DARSHAN_MPI_CALL(PMPI_Allreduce)(&ret, &all_ret, 1, MPI_INT,
        MPI_LOR, MPI_COMM_WORLD);
    if(all_ret != 0)
    {
        if(my_rank == 0)
        {
361 362
            fprintf(stderr, "darshan library warning: unable to open log file %s\n",
                logfile_name);
363 364 365
            unlink(logfile_name);
        }
        free(logfile_name);
366
        darshan_core_cleanup(final_core);
367 368 369
        return;
    }

370 371
    if(internal_timing_flag)
        job1 = DARSHAN_MPI_CALL(PMPI_Wtime)();
372
    /* rank 0 is responsible for writing the compressed darshan job information */
Shane Snyder's avatar
Shane Snyder committed
373
    if(my_rank == 0)
374
    {
375 376 377
        void *pointers[2] = {&final_core->log_job, final_core->trailing_data};
        int lengths[2] = {sizeof(struct darshan_job), DARSHAN_EXE_LEN+1};
        int comp_buf_sz = 0;
378

379 380 381 382
        /* compress the job info and the trailing mount/exe data */
        all_ret = darshan_compress_buffer(pointers, lengths, 2,
            final_core->comp_buf, &comp_buf_sz);
        if(all_ret)
383
        {
384
            fprintf(stderr, "darshan library warning: unable to compress job data\n");
385
            unlink(logfile_name);
386
        }
387 388 389 390 391 392 393 394 395 396 397
        else
        {
            /* write the job information, preallocing space for the log header */
            all_ret = DARSHAN_MPI_CALL(PMPI_File_write_at)(
                log_fh, sizeof(struct darshan_header), final_core->comp_buf,
                comp_buf_sz, MPI_BYTE, &status);
            if(all_ret != MPI_SUCCESS)
            {
                fprintf(stderr, "darshan library warning: unable to write job data to log file %s\n",
                        logfile_name);
                unlink(logfile_name);
Shane Snyder's avatar
Shane Snyder committed
398
                
399
            }
Shane Snyder's avatar
Shane Snyder committed
400

401 402 403
            /* set the beginning offset of record hash, which precedes job info just written */
            log_header.rec_map.off = sizeof(struct darshan_header) + comp_buf_sz;
        }
404 405
    }

406 407 408 409 410
    /* error out if unable to write job information */
    DARSHAN_MPI_CALL(PMPI_Bcast)(&all_ret, 1, MPI_INT, 0, MPI_COMM_WORLD);
    if(all_ret != 0)
    {
        free(logfile_name);
411
        darshan_core_cleanup(final_core);
412 413
        return;
    }
414 415
    if(internal_timing_flag)
        job2 = DARSHAN_MPI_CALL(PMPI_Wtime)();
416

417 418
    if(internal_timing_flag)
        rec1 = DARSHAN_MPI_CALL(PMPI_Wtime)();
419
    /* write the record name->id hash to the log file */
420
    ret = darshan_log_write_record_hash(log_fh, final_core, &log_header.rec_map);
421

422
    /* error out if unable to write record hash */
423 424 425 426 427 428
    DARSHAN_MPI_CALL(PMPI_Allreduce)(&ret, &all_ret, 1, MPI_INT,
        MPI_LOR, MPI_COMM_WORLD);
    if(all_ret != 0)
    {
        if(my_rank == 0)
        {
429
            fprintf(stderr, "darshan library warning: unable to write record hash to log file %s\n",
430
                logfile_name);
431
            unlink(logfile_name);
432 433
        }
        free(logfile_name);
434
        darshan_core_cleanup(final_core);
435 436
        return;
    }
Shane Snyder's avatar
Shane Snyder committed
437 438
    if(internal_timing_flag)
        rec2 = DARSHAN_MPI_CALL(PMPI_Wtime)();
439 440

    /* loop over globally used darshan modules and:
441
     *      - perform shared file reductions, if possible
442
     *      - get final output buffer
443
     *      - compress (zlib) provided output buffer
Shane Snyder's avatar
Shane Snyder committed
444
     *      - append compressed buffer to log file
445 446
     *      - add module index info (file offset/length) to log header
     *      - shutdown the module
447
     */
448
    for(i = 0; i < DARSHAN_MAX_MODS; i++)
449
    {
450
        struct darshan_core_module* this_mod = final_core->mod_array[i];
451 452 453
        darshan_record_id mod_shared_recs[DARSHAN_CORE_MAX_RECORDS];
        struct darshan_core_record_ref *ref = NULL;
        int shared_rec_cnt = 0;
454
        void* mod_buf = NULL;
455 456
        int mod_buf_sz = 0;
        int comp_buf_sz = 0;
457
        int j;
458

459
        if(global_mod_use_count[i] == 0)
460 461 462 463
        {
            if(my_rank == 0)
                log_header.mod_map[i].off = log_header.mod_map[i].len = 0;

464
            continue;
465
        }
466 467 468 469 470
 
        if(internal_timing_flag)
            mod1[i] = DARSHAN_MPI_CALL(PMPI_Wtime)();   
        /* if all processes used this module, prepare to do a shared file reduction */
        if(global_mod_use_count[j] == nprocs)
471
        {
472 473 474 475 476 477 478 479 480 481 482 483 484
            int shared_rec_count = 0;
            int rec_sz = 0;
            void *red_send_buf = NULL, *red_recv_buf = NULL;
            MPI_Datatype red_type;
            MPI_Op red_op;

            /* set the shared file list for this module */
            memset(mod_shared_recs, 0, DARSHAN_CORE_MAX_RECORDS * sizeof(darshan_record_id));
            for(j = 0; j < DARSHAN_CORE_MAX_RECORDS && shared_recs[j] != 0; j++)
            {
                HASH_FIND(hlink, final_core->rec_hash, &shared_recs[j],
                    sizeof(darshan_record_id), ref);
                assert(ref);
Shane Snyder's avatar
Shane Snyder committed
485
                if(DARSHAN_CORE_MOD_ISSET(ref->global_mod_flags, i))
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
                {
                    mod_shared_recs[shared_rec_count++] = shared_recs[j];
                }
            }

            /* if there are globally shared files, do a shared file reduction */
            if(shared_rec_count)
            {
                this_mod->mod_funcs.prepare_for_reduction(mod_shared_recs, &shared_rec_count,
                    &red_send_buf, &red_recv_buf, &rec_sz);

                if(shared_rec_count)
                {
                    /* construct a datatype for a file record.  This is serving no purpose
                     * except to make sure we can do a reduction on proper boundaries
                     */
                    DARSHAN_MPI_CALL(PMPI_Type_contiguous)(rec_sz, MPI_BYTE, &red_type);
                    DARSHAN_MPI_CALL(PMPI_Type_commit)(&red_type);

                    /* register a reduction operator for this module */
Shane Snyder's avatar
Shane Snyder committed
506
                    DARSHAN_MPI_CALL(PMPI_Op_create)(this_mod->mod_funcs.reduce_records,
507 508 509 510 511 512 513 514 515 516
                        1, &red_op);

                    /* reduce shared file records for this module */
                    DARSHAN_MPI_CALL(PMPI_Reduce)(red_send_buf, red_recv_buf,
                        shared_rec_count, red_type, red_op, 0, MPI_COMM_WORLD);

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

519
        /* if module is registered locally, get the corresponding output buffer */
520
        if(this_mod)
521 522
        {
            /* get output buffer from module */
523
            this_mod->mod_funcs.get_output_data(&mod_buf, &mod_buf_sz);
524 525
        }

526 527 528 529 530 531 532 533
        /* compress the module buffer */
        ret = darshan_compress_buffer((void**)&mod_buf, &mod_buf_sz, 1,
            final_core->comp_buf, &comp_buf_sz);
        if(ret == 0)
        {
            /* set the starting offset of this module */
            if(tmp_off == 0)
                tmp_off = log_header.rec_map.off + log_header.rec_map.len;
534

535
            log_header.mod_map[i].off = tmp_off;
536

537 538 539 540 541 542 543 544 545 546 547
            /* write (compressed) module data buffer to the darshan log file */
            ret = darshan_log_coll_write(log_fh, final_core->comp_buf, comp_buf_sz,
                &log_header.mod_map[i]);
        }
        else
        {
            /* error in compression, participate in collective write to avoid
             * deadlock, but preserve return value to terminate darshan_shutdown.
             */
            (void)darshan_log_coll_write(log_fh, NULL, 0, &log_header.mod_map[i]);
        }
548

549
        /* error out if the compression or collective write failed */
550 551 552
        DARSHAN_MPI_CALL(PMPI_Allreduce)(&ret, &all_ret, 1, MPI_INT,
            MPI_LOR, MPI_COMM_WORLD);
        if(all_ret != 0)
553
        {
554 555 556 557 558 559 560 561
            if(my_rank == 0)
            {
                fprintf(stderr,
                    "darshan library warning: unable to write %s module data to log file %s\n",
                    darshan_module_names[i], logfile_name);
                unlink(logfile_name);
            }
            free(logfile_name);
562
            darshan_core_cleanup(final_core);
563
            return;
564 565
        }

566 567
        tmp_off += log_header.mod_map[i].len;

568
        /* shutdown module if registered locally */
569
        if(this_mod)
570 571 572
        {
            this_mod->mod_funcs.shutdown();
        }
573 574
        if(internal_timing_flag)
            mod2[i] = DARSHAN_MPI_CALL(PMPI_Wtime)();
575 576
    }

577 578
    if(internal_timing_flag)
        header1 = DARSHAN_MPI_CALL(PMPI_Wtime)();
579
    /* rank 0 is responsible for writing the log header */
580 581
    if(my_rank == 0)
    {
582
        /* initialize the remaining header fields */
583 584
        strcpy(log_header.version_string, DARSHAN_LOG_VERSION);
        log_header.magic_nr = DARSHAN_MAGIC_NR;
585 586
        log_header.comp_type = DARSHAN_GZ_COMP;

587
        all_ret = DARSHAN_MPI_CALL(PMPI_File_write_at)(log_fh, 0, &log_header,
588
            sizeof(struct darshan_header), MPI_BYTE, &status);
589
        if(all_ret != MPI_SUCCESS)
590
        {
591 592 593
            fprintf(stderr, "darshan library warning: unable to write header to log file %s\n",
                    logfile_name);
            unlink(logfile_name);
594
        }
595 596
    }

597 598 599 600 601
    /* error out if unable to write log header */
    DARSHAN_MPI_CALL(PMPI_Bcast)(&all_ret, 1, MPI_INT, 0, MPI_COMM_WORLD);
    if(all_ret != 0)
    {
        free(logfile_name);
602
        darshan_core_cleanup(final_core);
603 604
        return;
    }
605 606
    if(internal_timing_flag)
        header2 = DARSHAN_MPI_CALL(PMPI_Wtime)();
607

608 609 610 611 612 613
    DARSHAN_MPI_CALL(PMPI_File_close)(&log_fh);

    /* if we got this far, there are no errors, so rename from *.darshan_partial
     * to *-<logwritetime>.darshan.gz, which indicates that this log file is
     * complete and ready for analysis
     */
614 615
    if(my_rank == 0)
    {
Shane Snyder's avatar
Shane Snyder committed
616
        if(getenv("DARSHAN_LOGFILE"))
617
        {
618
#ifdef __CP_GROUP_READABLE_LOGS
Shane Snyder's avatar
Shane Snyder committed
619
            chmod(logfile_name, (S_IRUSR|S_IRGRP));
620
#else
Shane Snyder's avatar
Shane Snyder committed
621
            chmod(logfile_name, (S_IRUSR));
622
#endif
Shane Snyder's avatar
Shane Snyder committed
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
        }
        else
        {
            char* tmp_index;
            double end_log_time;
            char* new_logfile_name;

            new_logfile_name = malloc(PATH_MAX);
            if(new_logfile_name)
            {
                new_logfile_name[0] = '\0';
                end_log_time = DARSHAN_MPI_CALL(PMPI_Wtime)();
                strcat(new_logfile_name, logfile_name);
                tmp_index = strstr(new_logfile_name, ".darshan_partial");
                sprintf(tmp_index, "_%d.darshan.gz", (int)(end_log_time-start_log_time+1));
                rename(logfile_name, new_logfile_name);
                /* set permissions on log file */
#ifdef __CP_GROUP_READABLE_LOGS
                chmod(new_logfile_name, (S_IRUSR|S_IRGRP));
#else
                chmod(new_logfile_name, (S_IRUSR));
#endif
                free(new_logfile_name);
            }
647
        }
648
    }
649

650
    free(logfile_name);
651
    darshan_core_cleanup(final_core);
652

653
    if(internal_timing_flag)
654
    {
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
        double open_tm, open_slowest;
        double header_tm, header_slowest;
        double job_tm, job_slowest;
        double rec_tm, rec_slowest;
        double mod_tm[DARSHAN_MAX_MODS], mod_slowest[DARSHAN_MAX_MODS];
        double all_tm, all_slowest;

        tm_end = DARSHAN_MPI_CALL(PMPI_Wtime)();

        open_tm = open2 - open1;
        header_tm = header2 - header1;
        job_tm = job2 - job1;
        rec_tm = rec2 - rec1;
        all_tm = tm_end - start_log_time;
        for(i = 0;i < DARSHAN_MAX_MODS; i++)
        {
            mod_tm[i] = mod2[i] - mod1[i];
        }

        DARSHAN_MPI_CALL(PMPI_Reduce)(&open_tm, &open_slowest, 1,
            MPI_DOUBLE, MPI_MAX, 0, MPI_COMM_WORLD);
        DARSHAN_MPI_CALL(PMPI_Reduce)(&header_tm, &header_slowest, 1,
            MPI_DOUBLE, MPI_MAX, 0, MPI_COMM_WORLD);
        DARSHAN_MPI_CALL(PMPI_Reduce)(&job_tm, &job_slowest, 1,
            MPI_DOUBLE, MPI_MAX, 0, MPI_COMM_WORLD);
        DARSHAN_MPI_CALL(PMPI_Reduce)(&rec_tm, &rec_slowest, 1,
            MPI_DOUBLE, MPI_MAX, 0, MPI_COMM_WORLD);
        DARSHAN_MPI_CALL(PMPI_Reduce)(&all_tm, &all_slowest, 1,
            MPI_DOUBLE, MPI_MAX, 0, MPI_COMM_WORLD);
        DARSHAN_MPI_CALL(PMPI_Reduce)(mod_tm, mod_slowest, DARSHAN_MAX_MODS,
            MPI_DOUBLE, MPI_MAX, 0, MPI_COMM_WORLD);

        if(my_rank == 0)
        {
            printf("#darshan:<op>\t<nprocs>\t<time>\n");
            printf("darshan:log_open\t%d\t%f\n", nprocs, open_slowest);
            printf("darshan:job_write\t%d\t%f\n", nprocs, job_slowest);
            printf("darshan:hash_write\t%d\t%f\n", nprocs, rec_slowest);
Shane Snyder's avatar
Shane Snyder committed
693
            printf("darshan:header_write\t%d\t%f\n", nprocs, header_slowest);
694 695 696 697
            for(i = 0; i < DARSHAN_MAX_MODS; i++)
            {
                if(global_mod_use_count[i])
                    printf("darshan:%s_shutdown\t%d\t%f\n", darshan_module_names[i],
Shane Snyder's avatar
Shane Snyder committed
698
                        nprocs, mod_slowest[i]);
699 700 701
            }
            printf("darshan:core_shutdown\t%d\t%f\n", nprocs, all_slowest);
        }
702 703 704 705
    }
    
    return;
}
706

707
/* free darshan core data structures to shutdown */
708
static void darshan_core_cleanup(struct darshan_core_runtime* core)
709
{
710
    struct darshan_core_record_ref *tmp, *ref;
711
    int i;
712

713 714 715 716 717 718
    HASH_ITER(hlink, core->rec_hash, ref, tmp)
    {
        HASH_DELETE(hlink, core->rec_hash, ref);
        free(ref->rec.name);
        free(ref);
    }
719

720
    for(i = 0; i < DARSHAN_MAX_MODS; i++)
721
    {
722
        if(core->mod_array[i])
723
        {        
724 725
            free(core->mod_array[i]);
            core->mod_array[i] = NULL;
726
        }
727
    }
728

729
    free(core->trailing_data);
730
    free(core);
731 732 733 734

    return;
}

735
/* construct the darshan log file name */
736
static void darshan_get_logfile_name(char* logfile_name, int jobid, struct tm* start_tm)
737
{
Shane Snyder's avatar
Shane Snyder committed
738
    char* user_logfile_name;
739 740 741 742 743 744 745 746 747 748 749 750 751
    char* logpath;
    char* logname_string;
    char* logpath_override = NULL;
#ifdef __CP_LOG_ENV
    char env_check[256];
    char* env_tok;
#endif
    uint64_t hlevel;
    char hname[HOST_NAME_MAX];
    uint64_t logmod;
    char cuser[L_cuserid] = {0};
    int ret;

Shane Snyder's avatar
Shane Snyder committed
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
    /* first, check if user specifies a complete logpath to use */
    user_logfile_name = getenv("DARSHAN_LOGFILE");
    if(user_logfile_name)
    {
        if(strlen(user_logfile_name) >= (PATH_MAX-1))
        {
            fprintf(stderr, "darshan library warning: user log file name too long.\n");
            logfile_name[0] = '\0';
        }
        else
        {
            strcpy(logfile_name, user_logfile_name);
        }
    }
    else
767
    {
Shane Snyder's avatar
Shane Snyder committed
768 769 770 771 772 773
        /* otherwise, generate the log path automatically */

        /* Use CP_LOG_PATH_OVERRIDE for the value or __CP_LOG_PATH */
        logpath = getenv(CP_LOG_PATH_OVERRIDE);
        if(!logpath)
        {
774
#ifdef __CP_LOG_PATH
Shane Snyder's avatar
Shane Snyder committed
775
            logpath = __CP_LOG_PATH;
776
#endif
Shane Snyder's avatar
Shane Snyder committed
777
        }
778

Shane Snyder's avatar
Shane Snyder committed
779 780 781 782 783 784 785 786 787 788
        /* get the username for this job.  In order we will try each of the
         * following until one of them succeeds:
         *
         * - cuserid()
         * - getenv("LOGNAME")
         * - snprintf(..., geteuid());
         *
         * Note that we do not use getpwuid() because it generally will not
         * work in statically compiled binaries.
         */
789 790

#ifndef DARSHAN_DISABLE_CUSERID
Shane Snyder's avatar
Shane Snyder committed
791
        cuserid(cuser);
792 793
#endif

Shane Snyder's avatar
Shane Snyder committed
794 795
        /* if cuserid() didn't work, then check the environment */
        if(strcmp(cuser, "") == 0)
796
        {
Shane Snyder's avatar
Shane Snyder committed
797 798 799 800 801
            logname_string = getenv("LOGNAME");
            if(logname_string)
            {
                strncpy(cuser, logname_string, (L_cuserid-1));
            }
802 803
        }

Shane Snyder's avatar
Shane Snyder committed
804 805 806 807 808 809
        /* if cuserid() and environment both fail, then fall back to uid */
        if(strcmp(cuser, "") == 0)
        {
            uid_t uid = geteuid();
            snprintf(cuser, sizeof(cuser), "%u", uid);
        }
810

Shane Snyder's avatar
Shane Snyder committed
811 812 813 814
        /* generate a random number to help differentiate the log */
        hlevel=DARSHAN_MPI_CALL(PMPI_Wtime)() * 1000000;
        (void)gethostname(hname, sizeof(hname));
        logmod = darshan_hash((void*)hname,strlen(hname),hlevel);
815

Shane Snyder's avatar
Shane Snyder committed
816 817 818 819
        /* see if darshan was configured using the --with-logpath-by-env
         * argument, which allows the user to specify an absolute path to
         * place logs via an env variable.
         */
820
#ifdef __CP_LOG_ENV
Shane Snyder's avatar
Shane Snyder committed
821 822
        /* just silently skip if the environment variable list is too big */
        if(strlen(__CP_LOG_ENV) < 256)
823
        {
Shane Snyder's avatar
Shane Snyder committed
824 825 826 827 828
            /* copy env variable list to a temporary buffer */
            strcpy(env_check, __CP_LOG_ENV);
            /* tokenize the comma-separated list */
            env_tok = strtok(env_check, ",");
            if(env_tok)
829
            {
Shane Snyder's avatar
Shane Snyder committed
830
                do
831
                {
Shane Snyder's avatar
Shane Snyder committed
832 833 834 835 836 837 838 839 840
                    /* check each env variable in order */
                    logpath_override = getenv(env_tok);
                    if(logpath_override)
                    {
                        /* stop as soon as we find a match */
                        break;
                    }
                }while((env_tok = strtok(NULL, ",")));
            }
841 842 843
        }
#endif

Shane Snyder's avatar
Shane Snyder committed
844
        if(logpath_override)
845
        {
Shane Snyder's avatar
Shane Snyder committed
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
            ret = snprintf(logfile_name, PATH_MAX,
                "%s/%s_%s_id%d_%d-%d-%d-%" PRIu64 ".darshan_partial",
                logpath_override,
                cuser, __progname, jobid,
                (start_tm->tm_mon+1),
                start_tm->tm_mday,
                (start_tm->tm_hour*60*60 + start_tm->tm_min*60 + start_tm->tm_sec),
                logmod);
            if(ret == (PATH_MAX-1))
            {
                /* file name was too big; squish it down */
                snprintf(logfile_name, PATH_MAX,
                    "%s/id%d.darshan_partial",
                    logpath_override, jobid);
            }
861
        }
Shane Snyder's avatar
Shane Snyder committed
862
        else if(logpath)
863
        {
Shane Snyder's avatar
Shane Snyder committed
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
            ret = snprintf(logfile_name, PATH_MAX,
                "%s/%d/%d/%d/%s_%s_id%d_%d-%d-%d-%" PRIu64 ".darshan_partial",
                logpath, (start_tm->tm_year+1900),
                (start_tm->tm_mon+1), start_tm->tm_mday,
                cuser, __progname, jobid,
                (start_tm->tm_mon+1),
                start_tm->tm_mday,
                (start_tm->tm_hour*60*60 + start_tm->tm_min*60 + start_tm->tm_sec),
                logmod);
            if(ret == (PATH_MAX-1))
            {
                /* file name was too big; squish it down */
                snprintf(logfile_name, PATH_MAX,
                    "%s/id%d.darshan_partial",
                    logpath, jobid);
            }
        }
        else
        {
            logfile_name[0] = '\0';
884 885 886 887
        }
    }

    return;
888 889
}

890
/* record any hints used to write the darshan log in the log header */
891
static void darshan_log_record_hints_and_ver(struct darshan_core_runtime* core)
892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
{
    char* hints;
    char* header_hints;
    int meta_remain = 0;
    char* m;

    /* check environment variable to see if the default MPI file hints have
     * been overridden
     */
    hints = getenv(CP_LOG_HINTS_OVERRIDE);
    if(!hints)
    {
        hints = __CP_LOG_HINTS;
    }

    if(!hints || strlen(hints) < 1)
        return;

    header_hints = strdup(hints);
    if(!header_hints)
        return;

    meta_remain = DARSHAN_JOB_METADATA_LEN -
915
        strlen(core->log_job.metadata) - 1;
916 917
    if(meta_remain >= (strlen(PACKAGE_VERSION) + 9))
    {
918
        sprintf(core->log_job.metadata, "lib_ver=%s\n", PACKAGE_VERSION);
919 920 921 922
        meta_remain -= (strlen(PACKAGE_VERSION) + 9);
    }
    if(meta_remain >= (3 + strlen(header_hints)))
    {
923
        m = core->log_job.metadata + strlen(core->log_job.metadata);
924 925 926 927 928 929 930 931 932 933 934 935
        /* We have room to store the hints in the metadata portion of
         * the job header.  We just prepend an h= to the hints list.  The
         * metadata parser will ignore = characters that appear in the value
         * portion of the metadata key/value pair.
         */
        sprintf(m, "h=%s\n", header_hints);
    }
    free(header_hints);

    return;
}

936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
static int mnt_data_cmp(const void* a, const void* b)
{
    const struct mnt_data *d_a = (const struct mnt_data*)a;
    const struct mnt_data *d_b = (const struct mnt_data*)b;

    if(strlen(d_a->path) > strlen(d_b->path))
        return(-1);
    else if(strlen(d_a->path) < strlen(d_b->path))
        return(1);
    else
        return(0);
}

/* adds an entry to table of mounted file systems */
static void add_entry(char* trailing_data, int* space_left, struct mntent *entry)
{
    int ret;
    char tmp_mnt[256];
    struct statfs statfsbuf;

    strncpy(mnt_data_array[mnt_data_count].path, entry->mnt_dir,
        DARSHAN_MAX_MNT_PATH-1);
    strncpy(mnt_data_array[mnt_data_count].type, entry->mnt_type,
        DARSHAN_MAX_MNT_TYPE-1);
    /* NOTE: we now try to detect the preferred block size for each file 
     * system using fstatfs().  On Lustre we assume a size of 1 MiB 
     * because fstatfs() reports 4 KiB. 
     */
#ifndef LL_SUPER_MAGIC
#define LL_SUPER_MAGIC 0x0BD00BD0
#endif
    ret = statfs(entry->mnt_dir, &statfsbuf);
    if(ret == 0 && statfsbuf.f_type != LL_SUPER_MAGIC)
        mnt_data_array[mnt_data_count].block_size = statfsbuf.f_bsize;
    else if(ret == 0 && statfsbuf.f_type == LL_SUPER_MAGIC)
        mnt_data_array[mnt_data_count].block_size = 1024*1024;
    else
        mnt_data_array[mnt_data_count].block_size = 4096;

    /* store mount information for use in header of darshan log */
976
    ret = snprintf(tmp_mnt, 256, "\n%s\t%s",
977 978 979 980 981 982