darshan-core.c 65.1 KB
Newer Older
1
/*
Shane Snyder's avatar
Shane Snyder committed
2
3
4
 * Copyright (C) 2015 University of Chicago.
 * See COPYRIGHT notice in top-level directory.
 *
5
6
 */

7
#define _XOPEN_SOURCE 500
8
#define _GNU_SOURCE
9

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

#include <stdio.h>
#ifdef HAVE_MNTENT_H
#include <mntent.h>
#endif
16
17
18
19
20
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <limits.h>
#include <pthread.h>
21
#include <fcntl.h>
22
23
#include <dirent.h>
#include <sys/ioctl.h>
24
25
#include <sys/types.h>
#include <sys/stat.h>
26
#include <sys/mman.h>
27
#include <sys/vfs.h>
28
#include <zlib.h>
29
#include <mpi.h>
30
#include <assert.h>
31

32
#include "uthash.h"
Shane Snyder's avatar
Shane Snyder committed
33
#include "darshan.h"
34
#include "darshan-core.h"
Shane Snyder's avatar
Shane Snyder committed
35
#include "darshan-dynamic.h"
36

37
#ifdef DARSHAN_LUSTRE
38
#include <lustre/lustre_user.h>
39
#endif
40

41
extern char* __progname;
42
extern char* __progname_full;
43

44
/* internal variable delcarations */
45
static struct darshan_core_runtime *darshan_core = NULL;
46
static pthread_mutex_t darshan_core_mutex = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP;
47
static int my_rank = -1;
48
static int nprocs = -1;
49
static int darshan_mem_alignment = 1;
50
static long darshan_mod_mem_quota = DARSHAN_MOD_MEM_MAX;
51

52
/* paths prefixed with the following directories are not tracked by darshan */
53
char* darshan_path_exclusions[] = {
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
    "/etc/",
    "/dev/",
    "/usr/",
    "/bin/",
    "/boot/",
    "/lib/",
    "/opt/",
    "/sbin/",
    "/sys/",
    "/proc/",
    "/var/",
    NULL
};
/* paths prefixed with the following directories are tracked by darshan even if
 * they share a root with a path listed in darshan_path_exclusions
 */
char* darshan_path_inclusions[] = {
    "/dev/shm/",
    "/var/tmp/",
    "/var/opt/cray/dws/mounts/",
    NULL
75
76
};

77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
#ifdef DARSHAN_BGQ
extern void bgq_runtime_initialize();
#endif

/* array of init functions for modules which need to be statically
 * initialized by darshan at startup time
 */
void (*mod_static_init_fns[])(void) =
{
#ifdef DARSHAN_BGQ
    &bgq_runtime_initialize,
#endif
    NULL
};

92
93
94
95
96
97
98
#ifdef DARSHAN_LUSTRE
/* XXX need to use extern to get Lustre module's instrumentation function
 * since modules have no way of providing this to darshan-core
 */
extern void darshan_instrument_lustre_file(const char *filepath, int fd);
#endif

Shane Snyder's avatar
Shane Snyder committed
99
100
101
#define DARSHAN_CORE_LOCK() pthread_mutex_lock(&darshan_core_mutex)
#define DARSHAN_CORE_UNLOCK() pthread_mutex_unlock(&darshan_core_mutex)

102
103
104
105
106
107
108
109
/* FS mount information */
#define DARSHAN_MAX_MNTS 64
#define DARSHAN_MAX_MNT_PATH 256
#define DARSHAN_MAX_MNT_TYPE 32
struct mnt_data
{
    char path[DARSHAN_MAX_MNT_PATH];
    char type[DARSHAN_MAX_MNT_TYPE];
110
    struct darshan_fs_info fs_info;
111
112
113
114
};
static struct mnt_data mnt_data_array[DARSHAN_MAX_MNTS];
static int mnt_data_count = 0;

115
/* prototypes for internal helper functions */
116
#ifdef __DARSHAN_ENABLE_MMAP_LOGS
117
118
static void *darshan_init_mmap_log(
    struct darshan_core_runtime* core, int jobid);
119
#endif
120
static void darshan_log_record_hints_and_ver(
121
    struct darshan_core_runtime* core);
122
123
static void darshan_get_exe_and_mounts(
    struct darshan_core_runtime *core, int argc, char **argv);
124
125
static void darshan_fs_info_from_path(
    const char *path, struct darshan_fs_info *fs_info);
126
static int darshan_add_name_record_ref(
127
    struct darshan_core_runtime *core, darshan_record_id rec_id,
128
    const char *name, darshan_module_id mod_id);
129
130
static void darshan_get_user_name(
    char *user);
131
132
static void darshan_get_logfile_name(
    char* logfile_name, int jobid, struct tm* start_tm);
133
static void darshan_get_shared_records(
134
135
    struct darshan_core_runtime *core, darshan_record_id **shared_recs,
    int *shared_rec_cnt);
136
static int darshan_log_open_all(
137
    char *logfile_name, MPI_File *log_fh);
138
static int darshan_deflate_buffer(
Shane Snyder's avatar
Shane Snyder committed
139
140
    void **pointers, int *lengths, int count, char *comp_buf,
    int *comp_buf_length);
141
static int darshan_log_write_name_record_hash(
142
    MPI_File log_fh, struct darshan_core_runtime *core,
143
144
145
    uint64_t *inout_off);
static int darshan_log_append_all(
    MPI_File log_fh, struct darshan_core_runtime *core, void *buf,
Shane Snyder's avatar
Shane Snyder committed
146
    int count, uint64_t *inout_off);
Shane Snyder's avatar
Shane Snyder committed
147
148
static void darshan_core_cleanup(
    struct darshan_core_runtime* core);
149

150
151
/* *********************************** */

Shane Snyder's avatar
Shane Snyder committed
152
void darshan_core_initialize(int argc, char **argv)
153
{
154
    struct darshan_core_runtime *init_core = NULL;
155
156
    int internal_timing_flag = 0;
    double init_start, init_time, init_max;
157
    char *envstr;
158
159
    char *jobid_str;
    int jobid;
160
161
    int ret;
    int tmpval;
162
    int i;
163
164

    DARSHAN_MPI_CALL(PMPI_Comm_size)(MPI_COMM_WORLD, &nprocs);
165
    DARSHAN_MPI_CALL(PMPI_Comm_rank)(MPI_COMM_WORLD, &my_rank);
166
167
168
169

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

170
    if(internal_timing_flag)
171
172
173
        init_start = DARSHAN_MPI_CALL(PMPI_Wtime)();

    /* setup darshan runtime if darshan is enabled and hasn't been initialized already */
174
    if(!getenv("DARSHAN_DISABLE") && !darshan_core)
175
    {
176
        #if (__DARSHAN_MEM_ALIGNMENT < 1)
177
178
            #error Darshan must be configured with a positive value for --with-mem-align
        #endif
179
        envstr = getenv(DARSHAN_MEM_ALIGNMENT_OVERRIDE);
180
181
182
183
184
185
186
187
188
189
190
        if(envstr)
        {
            ret = sscanf(envstr, "%d", &tmpval);
            /* silently ignore if the env variable is set poorly */
            if(ret == 1 && tmpval > 0)
            {
                darshan_mem_alignment = tmpval;
            }
        }
        else
        {
191
            darshan_mem_alignment = __DARSHAN_MEM_ALIGNMENT;
192
193
194
        }

        /* avoid floating point errors on faulty input */
195
        if(darshan_mem_alignment < 1)
196
197
198
        {
            darshan_mem_alignment = 1;
        }
199

200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
        /* Use DARSHAN_JOBID_OVERRIDE for the env var for __DARSHAN_JOBID */
        envstr = getenv(DARSHAN_JOBID_OVERRIDE);
        if(!envstr)
        {
            envstr = __DARSHAN_JOBID;
        }

        /* find a job id */
        jobid_str = getenv(envstr);
        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();
        }

220
221
222
223
224
225
226
227
228
229
230
231
        /* set the memory quota for darshan modules' records */
        envstr = getenv(DARSHAN_MOD_MEM_OVERRIDE);
        if(envstr)
        {
            ret = sscanf(envstr, "%d", &tmpval);
            /* silently ignore if the env variable is set poorly */
            if(ret == 1 && tmpval > 0)
            {
                darshan_mod_mem_quota = tmpval * 1024 * 1024; /* convert from MiB */
            }
        }

232
233
234
        /* allocate structure to track darshan core runtime information */
        init_core = malloc(sizeof(*init_core));
        if(init_core)
235
        {
236
237
238
            memset(init_core, 0, sizeof(*init_core));
            init_core->wtime_offset = DARSHAN_MPI_CALL(PMPI_Wtime)();

239
240
        /* TODO: do we alloc new memory as we go or just do everything up front? */

241
242
243
244
245
#ifndef __DARSHAN_ENABLE_MMAP_LOGS
            /* just allocate memory for each log file region */
            init_core->log_hdr_p = malloc(sizeof(struct darshan_header));
            init_core->log_job_p = malloc(sizeof(struct darshan_job));
            init_core->log_exemnt_p = malloc(DARSHAN_EXE_LEN+1);
246
            init_core->log_name_p = malloc(DARSHAN_NAME_RECORD_BUF_SIZE);
247
            init_core->log_mod_p = malloc(darshan_mod_mem_quota);
248
249

            if(!(init_core->log_hdr_p) || !(init_core->log_job_p) ||
250
               !(init_core->log_exemnt_p) || !(init_core->log_name_p) ||
251
252
253
254
255
256
257
258
259
               !(init_core->log_mod_p))
            {
                free(init_core);
                return;
            }
            /* if allocation succeeds, zero fill memory regions */
            memset(init_core->log_hdr_p, 0, sizeof(struct darshan_header));
            memset(init_core->log_job_p, 0, sizeof(struct darshan_job));
            memset(init_core->log_exemnt_p, 0, DARSHAN_EXE_LEN+1);
260
            memset(init_core->log_name_p, 0, DARSHAN_NAME_RECORD_BUF_SIZE);
261
            memset(init_core->log_mod_p, 0, darshan_mod_mem_quota);
262
263
264
265
#else
            /* if mmap logs are enabled, we need to initialize the mmap region
             * before setting the corresponding log file region pointers
             */
266
267
            void *mmap_p = darshan_init_mmap_log(init_core, jobid);
            if(!mmap_p)
268
            {
269
270
                free(init_core);
                return;
271
272
            }

273
            /* set the memory pointers for each log file region */
274
            init_core->log_hdr_p = (struct darshan_header *)mmap_p;
275
            init_core->log_job_p = (struct darshan_job *)
276
                ((char *)init_core->log_hdr_p + sizeof(struct darshan_header));
277
            init_core->log_exemnt_p = (char *)
278
                ((char *)init_core->log_job_p + sizeof(struct darshan_job));
279
            init_core->log_name_p = (void *)
280
281
                ((char *)init_core->log_exemnt_p + DARSHAN_EXE_LEN + 1);
            init_core->log_mod_p = (void *)
282
                ((char *)init_core->log_name_p + DARSHAN_NAME_RECORD_BUF_SIZE);
283

284
            /* set header fields needed for the mmap log mechanism */
285
            init_core->log_hdr_p->comp_type = DARSHAN_NO_COMP;
286
            init_core->log_hdr_p->name_map.off =
287
                ((char *)init_core->log_name_p - (char *)init_core->log_hdr_p);
288
289
290
291
292
#endif

            /* set known header fields for the log file */
            strcpy(init_core->log_hdr_p->version_string, DARSHAN_LOG_VERSION);
            init_core->log_hdr_p->magic_nr = DARSHAN_MAGIC_NR;
293

294
295
296
297
298
            /* set known job-level metadata fields for the log file */
            init_core->log_job_p->uid = getuid();
            init_core->log_job_p->start_time = time(NULL);
            init_core->log_job_p->nprocs = nprocs;
            init_core->log_job_p->jobid = (int64_t)jobid;
299
300
301
302
303
304

            /* if we are using any hints to write the log file, then record those
             * hints with the darshan job information
             */
            darshan_log_record_hints_and_ver(init_core);

305
            /* collect information about command line and mounted file systems */
306
            darshan_get_exe_and_mounts(init_core, argc, argv);
307

308
309
310
311
            /* if darshan was successfully initialized, set the global pointer
             * and bootstrap any modules with static initialization routines
             */
            DARSHAN_CORE_LOCK();
312
            darshan_core = init_core;
313
314
315
316
317
318
319
320
            DARSHAN_CORE_UNLOCK();

            i = 0;
            while(mod_static_init_fns[i])
            {
                (*mod_static_init_fns[i])();
                i++;
            }
321
        }
322
323
    }

324
325
326
327
328
    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);
329
        if(my_rank == 0)
330
        {
331
332
            fprintf(stderr, "#darshan:<op>\t<nprocs>\t<time>\n");
            fprintf(stderr, "darshan:init\t%d\t%f\n", nprocs, init_max);
333
334
335
336
337
338
        }
    }

    return;
}

Shane Snyder's avatar
Shane Snyder committed
339
void darshan_core_shutdown()
340
{
341
    struct darshan_core_runtime *final_core;
342
    int internal_timing_flag = 0;
343
344
    struct tm *start_tm;
    time_t start_time_tmp;
345
    int64_t first_start_time;
346
    int64_t last_end_time;
347
    double start_log_time;
348
    double tm_end;
349
350
351
    double open1 = 0, open2 = 0;
    double job1 = 0, job2 = 0;
    double rec1 = 0, rec2 = 0;
352
353
    double mod1[DARSHAN_MAX_MODS] = {0};
    double mod2[DARSHAN_MAX_MODS] = {0};
354
    double header1 = 0, header2 = 0;
355
356
357
358
359
360
361
362
363
364
365
366
    char *logfile_name;
    int local_mod_use[DARSHAN_MAX_MODS] = {0};
    int global_mod_use_count[DARSHAN_MAX_MODS] = {0};
    darshan_record_id *shared_recs;
    darshan_record_id *mod_shared_recs;
    int shared_rec_cnt = 0;
    int ret = 0;
    int all_ret = 0;
    int i;
    uint64_t gz_fp = 0;
    MPI_File log_fh;
    MPI_Status status;
367
368
369
370

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

371
372
    /* synchronize before getting start time */
    DARSHAN_MPI_CALL(PMPI_Barrier)(MPI_COMM_WORLD);
Shane Snyder's avatar
Shane Snyder committed
373
    start_log_time = DARSHAN_MPI_CALL(PMPI_Wtime)();
374

Shane Snyder's avatar
Shane Snyder committed
375
    /* disable darhan-core while we shutdown */
376
    DARSHAN_CORE_LOCK();
377
    if(!darshan_core)
378
    {
379
        DARSHAN_CORE_UNLOCK();
380
381
        return;
    }
382
383
    final_core = darshan_core;
    darshan_core = NULL;
384
385
    DARSHAN_CORE_UNLOCK();

386
#ifdef __DARSHAN_ENABLE_MMAP_LOGS
387
388
389
390
391
    /* remove the temporary mmap log files */
    /* NOTE: this unlink is not immediate as it must wait for the mapping
     * to no longer be referenced, which in our case happens when the
     * executable exits. If the application terminates mid-shutdown, then
     * there will be no mmap files and no final log file.
392
     */
393
    unlink(final_core->mmap_log_name);
394
#endif
Shane Snyder's avatar
Shane Snyder committed
395

396
397
398
399
400
401
402
403
    final_core->log_job_p->end_time = time(NULL);

    /* reduce to report first start and last end time across all ranks at rank 0 */
    DARSHAN_MPI_CALL(PMPI_Reduce)(&final_core->log_job_p->start_time, &first_start_time,
        1, MPI_INT64_T, MPI_MIN, 0, MPI_COMM_WORLD);
    DARSHAN_MPI_CALL(PMPI_Reduce)(&final_core->log_job_p->end_time, &last_end_time,
        1, MPI_INT64_T, MPI_MAX, 0, MPI_COMM_WORLD);
    if(my_rank == 0)
Shane Snyder's avatar
Shane Snyder committed
404
    {
405
406
        final_core->log_job_p->start_time = first_start_time;
        final_core->log_job_p->end_time = last_end_time;
Shane Snyder's avatar
Shane Snyder committed
407
    }
408

409
410
411
412
413
414
    final_core->comp_buf = malloc(DARSHAN_COMP_BUF_SIZE);
    if(!(final_core->comp_buf))
    {
        darshan_core_cleanup(final_core);
        return;
    }
415

416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
    logfile_name = malloc(PATH_MAX);
    if(!logfile_name)
    {
        darshan_core_cleanup(final_core);
        return;
    }

    /* set the log file name on rank 0 */
    if(my_rank == 0)
    {
        /* use human readable start time format in log filename */
        start_time_tmp = final_core->log_job_p->start_time;
        start_tm = localtime(&start_time_tmp);

        darshan_get_logfile_name(logfile_name, final_core->log_job_p->jobid, start_tm);
    }

    /* 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 */
        free(logfile_name);
        darshan_core_cleanup(final_core);
        return;
    }
444

445
446
447
448
449
    /* set which modules were registered locally, and call into
     * them to disable further instrumentation and to perform any
     * other pre-shutdown steps
     */
    for(i = 0; i < DARSHAN_MAX_MODS; i++)
450
    {
451
452
        if(final_core->mod_array[i])
            local_mod_use[i] = 1;
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
    }

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

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

    if(internal_timing_flag)
        open1 = DARSHAN_MPI_CALL(PMPI_Wtime)();
    /* collectively open the darshan log file */
    ret = darshan_log_open_all(logfile_name, &log_fh);
    if(internal_timing_flag)
        open2 = DARSHAN_MPI_CALL(PMPI_Wtime)();

    /* 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)
        {
            fprintf(stderr, "darshan library warning: unable to open log file %s\n",
                logfile_name);
        }
        free(logfile_name);
        darshan_core_cleanup(final_core);
        return;
    }

    if(internal_timing_flag)
        job1 = DARSHAN_MPI_CALL(PMPI_Wtime)();
    /* rank 0 is responsible for writing the compressed darshan job information */
    if(my_rank == 0)
    {
489
        void *pointers[2] = {final_core->log_job_p, final_core->log_exemnt_p};
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
        int lengths[2] = {sizeof(struct darshan_job), strlen(final_core->log_exemnt_p)};
        int comp_buf_sz = 0;

        /* compress the job info and the trailing mount/exe data */
        all_ret = darshan_deflate_buffer(pointers, lengths, 2,
            final_core->comp_buf, &comp_buf_sz);
        if(all_ret)
        {
            fprintf(stderr, "darshan library warning: unable to compress job data\n");
            unlink(logfile_name);
        }
        else
        {
            /* write the job information, preallocing space for the log header */
            gz_fp += sizeof(struct darshan_header);
            all_ret = DARSHAN_MPI_CALL(PMPI_File_write_at)(log_fh, gz_fp,
                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);

            }
            gz_fp += comp_buf_sz;
        }
    }

    /* 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);
        darshan_core_cleanup(final_core);
        return;
    }
    if(internal_timing_flag)
        job2 = DARSHAN_MPI_CALL(PMPI_Wtime)();

    if(internal_timing_flag)
        rec1 = DARSHAN_MPI_CALL(PMPI_Wtime)();
    /* write the record name->id hash to the log file */
533
    final_core->log_hdr_p->name_map.off = gz_fp;
534
    ret = darshan_log_write_name_record_hash(log_fh, final_core, &gz_fp);
535
    final_core->log_hdr_p->name_map.len = gz_fp - final_core->log_hdr_p->name_map.off;
536

537
    /* error out if unable to write the name record hash */
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
    DARSHAN_MPI_CALL(PMPI_Allreduce)(&ret, &all_ret, 1, MPI_INT,
        MPI_LOR, MPI_COMM_WORLD);
    if(all_ret != 0)
    {
        if(my_rank == 0)
        {
            fprintf(stderr,
                "darshan library warning: unable to write record hash to log file %s\n",
                logfile_name);
            unlink(logfile_name);
        }
        free(logfile_name);
        darshan_core_cleanup(final_core);
        return;
    }
    if(internal_timing_flag)
        rec2 = DARSHAN_MPI_CALL(PMPI_Wtime)();

    mod_shared_recs = malloc(shared_rec_cnt * sizeof(darshan_record_id));
    assert(mod_shared_recs);

    /* loop over globally used darshan modules and:
     *      - get final output buffer
     *      - compress (zlib) provided output buffer
     *      - append compressed buffer to log file
563
     *      - add module map info (file offset/length) to log header
564
565
566
567
568
     *      - shutdown the module
     */
    for(i = 0; i < DARSHAN_MAX_MODS; i++)
    {
        struct darshan_core_module* this_mod = final_core->mod_array[i];
569
        struct darshan_core_name_record_ref *ref = NULL;
570
571
572
573
574
575
576
577
578
        int mod_shared_rec_cnt = 0;
        void* mod_buf = NULL;
        int mod_buf_sz = 0;
        int j;

        if(global_mod_use_count[i] == 0)
        {
            if(my_rank == 0)
            {
579
580
                final_core->log_hdr_p->mod_map[i].off = 0;
                final_core->log_hdr_p->mod_map[i].len = 0;
581
582
583
584
585
586
587
            }
            continue;
        }

        if(internal_timing_flag)
            mod1[i] = DARSHAN_MPI_CALL(PMPI_Wtime)();

588
        /* set the shared record list for this module */
589
590
        for(j = 0; j < shared_rec_cnt; j++)
        {
591
            HASH_FIND(hlink, final_core->name_hash, &shared_recs[j],
592
593
594
595
596
597
598
599
600
601
602
                sizeof(darshan_record_id), ref);
            assert(ref);
            if(DARSHAN_MOD_FLAG_ISSET(ref->global_mod_flags, i))
            {
                mod_shared_recs[mod_shared_rec_cnt++] = shared_recs[j];
            }
        }

        /* if module is registered locally, get the corresponding output buffer
         * 
         * NOTE: this function can be used to run collective operations across
603
         * modules, if there are records shared globally.
604
605
606
         */
        if(this_mod)
        {
607
608
            mod_buf = final_core->mod_array[i]->rec_buf_start;
            mod_buf_sz = final_core->mod_array[i]->rec_buf_p - mod_buf;
609
            this_mod->mod_shutdown_func(MPI_COMM_WORLD, mod_shared_recs,
610
611
612
613
                mod_shared_rec_cnt, &mod_buf, &mod_buf_sz);
        }

        /* append this module's data to the darshan log */
614
        final_core->log_hdr_p->mod_map[i].off = gz_fp;
615
        ret = darshan_log_append_all(log_fh, final_core, mod_buf, mod_buf_sz, &gz_fp);
616
617
        final_core->log_hdr_p->mod_map[i].len =
            gz_fp - final_core->log_hdr_p->mod_map[i].off;
618

619
620
621
622
623
624
        /* XXX: DXT manages its own module memory buffers, so we need to
         * explicitly free them
         */
        if(i == DXT_POSIX_MOD || i == DXT_MPIIO_MOD)
            free(mod_buf);

625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
        /* error out if the log append failed */
        DARSHAN_MPI_CALL(PMPI_Allreduce)(&ret, &all_ret, 1, MPI_INT,
            MPI_LOR, MPI_COMM_WORLD);
        if(all_ret != 0)
        {
            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);
            darshan_core_cleanup(final_core);
            return;
        }

        if(internal_timing_flag)
            mod2[i] = DARSHAN_MPI_CALL(PMPI_Wtime)();
    }

    if(internal_timing_flag)
        header1 = DARSHAN_MPI_CALL(PMPI_Wtime)();
648
    /* write out log header, after running 2 reductions on header variables:
649
     *  1) reduce 'partial_flag' variable to determine which modules ran out
650
     *     of memory for storing data
651
652
653
654
655
656
     *  2) reduce 'mod_ver' array to determine which log format version each
     *     module used for this output log
     */
    if(my_rank == 0)
    {
        /* rank 0 is responsible for writing the log header */
657
658
659
660
661
662
663
664
        final_core->log_hdr_p->comp_type = DARSHAN_ZLIB_COMP;

        DARSHAN_MPI_CALL(PMPI_Reduce)(
            MPI_IN_PLACE, &(final_core->log_hdr_p->partial_flag),
            1, MPI_UINT32_T, MPI_BOR, 0, MPI_COMM_WORLD);
        DARSHAN_MPI_CALL(PMPI_Reduce)(
            MPI_IN_PLACE, &(final_core->log_hdr_p->mod_ver),
            DARSHAN_MAX_MODS, MPI_UINT32_T, MPI_MAX, 0, MPI_COMM_WORLD);
665

666
        all_ret = DARSHAN_MPI_CALL(PMPI_File_write_at)(log_fh, 0, final_core->log_hdr_p,
667
668
669
670
671
672
673
674
            sizeof(struct darshan_header), MPI_BYTE, &status);
        if(all_ret != MPI_SUCCESS)
        {
            fprintf(stderr, "darshan library warning: unable to write header to log file %s\n",
                    logfile_name);
            unlink(logfile_name);
        }
    }
675
676
677
678
679
680
681
682
683
    else
    {
        DARSHAN_MPI_CALL(PMPI_Reduce)(
            &(final_core->log_hdr_p->partial_flag), &(final_core->log_hdr_p->partial_flag),
            1, MPI_UINT32_T, MPI_BOR, 0, MPI_COMM_WORLD);
        DARSHAN_MPI_CALL(PMPI_Reduce)(
            &(final_core->log_hdr_p->mod_ver), &(final_core->log_hdr_p->mod_ver),
            DARSHAN_MAX_MODS, MPI_UINT32_T, MPI_MAX, 0, MPI_COMM_WORLD);
    }
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703

    /* 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);
        darshan_core_cleanup(final_core);
        return;
    }
    if(internal_timing_flag)
        header2 = DARSHAN_MPI_CALL(PMPI_Wtime)();

    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, which indicates that this log file is
     * complete and ready for analysis
     */
    if(my_rank == 0)
    {
704
        mode_t chmod_mode = S_IRUSR;
705
#ifdef __DARSHAN_GROUP_READABLE_LOGS
706
        chmod_mode |= S_IRGRP;
707
#endif
708
709
710
711

        if(getenv("DARSHAN_LOGFILE"))
        {
            chmod(logfile_name, chmod_mode);
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
        }
        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", (int)(end_log_time-start_log_time+1));
                rename(logfile_name, new_logfile_name);
                /* set permissions on log file */
729
                chmod(new_logfile_name, chmod_mode);
730
731
732
733
734
735
                free(new_logfile_name);
            }
        }
    }

    free(logfile_name);
736
737
    free(shared_recs);
    free(mod_shared_recs);
738
    darshan_core_cleanup(final_core);
739

740
    if(internal_timing_flag)
741
    {
742
743
744
745
746
        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];
747
748
749
750
        double all_tm, all_slowest;

        tm_end = DARSHAN_MPI_CALL(PMPI_Wtime)();

751
752
753
754
        open_tm = open2 - open1;
        header_tm = header2 - header1;
        job_tm = job2 - job1;
        rec_tm = rec2 - rec1;
755
        all_tm = tm_end - start_log_time;
756
757
758
759
        for(i = 0;i < DARSHAN_MAX_MODS; i++)
        {
            mod_tm[i] = mod2[i] - mod1[i];
        }
760

761
762
763
764
765
766
767
768
        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);
769
770
        DARSHAN_MPI_CALL(PMPI_Reduce)(&all_tm, &all_slowest, 1,
            MPI_DOUBLE, MPI_MAX, 0, MPI_COMM_WORLD);
771
772
        DARSHAN_MPI_CALL(PMPI_Reduce)(mod_tm, mod_slowest, DARSHAN_MAX_MODS,
            MPI_DOUBLE, MPI_MAX, 0, MPI_COMM_WORLD);
773
774
775

        if(my_rank == 0)
        {
776
            fprintf(stderr, "#darshan:<op>\t<nprocs>\t<time>\n");
777
778
779
780
781
782
783
784
785
786
            fprintf(stderr, "darshan:log_open\t%d\t%f\n", nprocs, open_slowest);
            fprintf(stderr, "darshan:job_write\t%d\t%f\n", nprocs, job_slowest);
            fprintf(stderr, "darshan:hash_write\t%d\t%f\n", nprocs, rec_slowest);
            fprintf(stderr, "darshan:header_write\t%d\t%f\n", nprocs, header_slowest);
            for(i = 0; i < DARSHAN_MAX_MODS; i++)
            {
                if(global_mod_use_count[i])
                    fprintf(stderr, "darshan:%s_shutdown\t%d\t%f\n", darshan_module_names[i],
                        nprocs, mod_slowest[i]);
            }
787
            fprintf(stderr, "darshan:core_shutdown\t%d\t%f\n", nprocs, all_slowest);
788
        }
789
    }
790

791
792
    return;
}
793

Shane Snyder's avatar
Shane Snyder committed
794
/* *********************************** */
795

796
#ifdef __DARSHAN_ENABLE_MMAP_LOGS
797
798
799
800
801
802
803
static void *darshan_init_mmap_log(struct darshan_core_runtime* core, int jobid)
{
    int ret;
    int mmap_fd;
    int mmap_size;
    int sys_page_size;
    char cuser[L_cuserid] = {0};
804
805
806
    uint64_t hlevel;
    char hname[HOST_NAME_MAX];
    uint64_t logmod;
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
    char *envstr;
    char *mmap_log_path;
    void *mmap_p;

    sys_page_size = sysconf(_SC_PAGESIZE);
    assert(sys_page_size > 0);

    mmap_size = sizeof(struct darshan_header) + DARSHAN_JOB_RECORD_SIZE +
        + DARSHAN_NAME_RECORD_BUF_SIZE + darshan_mod_mem_quota;
    if(mmap_size % sys_page_size)
        mmap_size = ((mmap_size / sys_page_size) + 1) * sys_page_size;

    envstr = getenv(DARSHAN_MMAP_LOG_PATH_OVERRIDE);
    if(envstr)
        mmap_log_path = envstr;
    else
        mmap_log_path = DARSHAN_DEF_MMAP_LOG_PATH;

    darshan_get_user_name(cuser);

827
828
829
830
831
832
833
834
835
836
837
838
839
    /* generate a random number to help differentiate the temporary log */
    /* NOTE: job id is not sufficient for constructing a unique log file name,
     * since a job could be composed of multiple application runs, so we also
     * add a random number component to the log name
     */
    if(my_rank == 0)
    {
        hlevel=DARSHAN_MPI_CALL(PMPI_Wtime)() * 1000000;
        (void)gethostname(hname, sizeof(hname));
        logmod = darshan_hash((void*)hname,strlen(hname),hlevel);
    }
    DARSHAN_MPI_CALL(PMPI_Bcast)(&logmod, 1, MPI_UINT64_T, 0, MPI_COMM_WORLD);

840
841
842
843
    /* construct a unique temporary log file name for this process
     * to write mmap log data to
     */
    snprintf(core->mmap_log_name, PATH_MAX,
844
845
        "/%s/%s_%s_id%d_mmap-log-%" PRIu64 "-%d.darshan",
        mmap_log_path, cuser, __progname, jobid, logmod, my_rank);
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885

    /* create the temporary mmapped darshan log */
    mmap_fd = open(core->mmap_log_name, O_CREAT|O_RDWR|O_EXCL , 0644);
    if(mmap_fd < 0)
    {
        fprintf(stderr, "darshan library warning: "
            "unable to create darshan log file %s\n", core->mmap_log_name);
        return(NULL);
    }

    /* TODO: ftruncate or just zero fill? */
    /* allocate the necessary space in the log file */
    ret = ftruncate(mmap_fd, mmap_size);
    if(ret < 0)
    {
        fprintf(stderr, "darshan library warning: "
            "unable to allocate darshan log file %s\n", core->mmap_log_name);
        close(mmap_fd);
        unlink(core->mmap_log_name);
        return(NULL);
    }

    /* create the memory map for darshan's data structures so they are
     * persisted to file as the application executes
     */
    mmap_p = mmap(NULL, mmap_size, PROT_WRITE, MAP_SHARED, mmap_fd, 0);
    if(mmap_p == MAP_FAILED)
    {
        fprintf(stderr, "darshan library warning: "
            "unable to mmap darshan log file %s\n", core->mmap_log_name);
        close(mmap_fd);
        unlink(core->mmap_log_name);
        return(NULL);
    }

    /* close darshan log file (this does *not* unmap the log file) */
    close(mmap_fd);

    return(mmap_p);
}
886
#endif
887

888
/* record any hints used to write the darshan log in the job data */
889
static void darshan_log_record_hints_and_ver(struct darshan_core_runtime* core)
890
891
{
    char* hints;
892
    char* job_hints;
893
894
895
896
897
898
    int meta_remain = 0;
    char* m;

    /* check environment variable to see if the default MPI file hints have
     * been overridden
     */
899
    hints = getenv(DARSHAN_LOG_HINTS_OVERRIDE);
900
901
    if(!hints)
    {
902
        hints = __DARSHAN_LOG_HINTS;
903
904
905
906
907
    }

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

908
909
    job_hints = strdup(hints);
    if(!job_hints)
910
911
912
        return;

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

    return;
}

934
935
936
937
938
939
940
941
942
943
944
945
946
947
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 */
948
static void add_entry(char* buf, int* space_left, struct mntent* entry)
949
{
950
    int i;
951
952
953
954
    int ret;
    char tmp_mnt[256];
    struct statfs statfsbuf;

955
956
957
958
959
960
961
962
963
964
    /* avoid adding the same mount points multiple times -- to limit
     * storage space and potential statfs, ioctl, etc calls
     */
    for(i = 0; i < mnt_data_count; i++)
    {
        if((strncmp(mnt_data_array[i].path, entry->mnt_dir, DARSHAN_MAX_MNT_PATH) == 0) &&
           (strncmp(mnt_data_array[i].type, entry->mnt_type, DARSHAN_MAX_MNT_PATH) == 0))
            return;
    }

965
966
967
968
969
970
971
972
973
974
975
976
    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);
977
    mnt_data_array[mnt_data_count].fs_info.fs_type = statfsbuf.f_type;
978
    if(ret == 0 && statfsbuf.f_type != LL_SUPER_MAGIC)
979
        mnt_data_array[mnt_data_count].fs_info.block_size = statfsbuf.f_bsize;
980
    else if(ret == 0 && statfsbuf.f_type == LL_SUPER_MAGIC)
981
        mnt_data_array[mnt_data_count].fs_info.block_size = 1024*1024;
982
    else
983
        mnt_data_array[mnt_data_count].fs_info.block_size = 4096;
984

985
#ifdef DARSHAN_LUSTRE
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
    /* attempt to retrieve OST and MDS counts from Lustre */
    mnt_data_array[mnt_data_count].fs_info.ost_count = -1;
    mnt_data_array[mnt_data_count].fs_info.mdt_count = -1;
    if ( statfsbuf.f_type == LL_SUPER_MAGIC )
    {
        int n_ost, n_mdt;
        int ret_ost, ret_mdt;
        DIR *mount_dir;

        mount_dir = opendir( entry->mnt_dir );
        if ( mount_dir  ) 
        {
            /* n_ost and n_mdt are used for both input and output to ioctl */
            n_ost = 0;
            n_mdt = 1;
For faster browsing, not all history is shown. View entire blame