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

7 8 9 10 11 12
#ifndef __DARSHAN_LOG_FORMAT_H
#define __DARSHAN_LOG_FORMAT_H

#include <unistd.h>
#include <sys/types.h>
#include <stdint.h>
13
#include <inttypes.h>
14

15 16
#if !defined PRId64
#error failed to detect PRId64
17
#endif
18 19
#if !defined PRIu64
#error failed to detect PRIu64
Philip Carns's avatar
Philip Carns committed
20
#endif
21

22
/* update this on file format changes */
23
#define DARSHAN_LOG_VERSION "3.00"
24

25
/* magic number for validating output files and checking byte order */
26
#define DARSHAN_MAGIC_NR 6567223
27

28
/* size (in bytes) of job record */
29
#define DARSHAN_JOB_RECORD_SIZE 4096
30 31

/* max length of exe string within job record (not counting '\0') */
32
#define DARSHAN_EXE_LEN (DARSHAN_JOB_RECORD_SIZE - sizeof(struct darshan_job) - 1)
33

34 35
typedef uint64_t darshan_record_id;

36 37 38 39 40 41 42
/* unique identifiers to distinguish between available darshan modules */
/* NOTES: - valid ids range from [0...DARSHAN_MAX_MODS-1]
 *        - order of ids control module shutdown order (and consequently, order in log file)
 */
#define DARSHAN_MAX_MODS 16
typedef enum
{
43 44
    DARSHAN_NULL_MOD = 0,
    DARSHAN_POSIX_MOD,
45 46 47 48 49
    DARSHAN_MPIIO_MOD,
    DARSHAN_HDF5_MOD,
    DARSHAN_PNETCDF_MOD,
} darshan_module_id;

Shane Snyder's avatar
Shane Snyder committed
50
static char * const darshan_module_names[] =
51
{
52
    "NULL",
53 54 55 56 57 58
    "POSIX",
    "MPI-IO",
    "HDF5",
    "PNETCDF"
};

59 60 61 62 63 64 65
/* the darshan_log_map structure is used to indicate the location of
 * specific module data in a Darshan log. Note that 'off' and 'len' are
 * the respective offset and length of the data in the file, in *uncompressed*
 * terms -- this is nonintuitive since the data is compressed, but this is
 * done so we can utilize the gzread interface for all Darshan log reading
 * utilities. 
 */
66
struct darshan_log_map
67
{
68 69
    uint64_t off;
    uint64_t len;
70 71
};

72 73 74
/* the darshan header stores critical metadata needed for correctly
 * reading the contents of the corresponding Darshan log
 */
75
struct darshan_header
76
{
77 78 79 80
    char version_string[8];
    int64_t magic_nr;
    struct darshan_log_map rec_map;
    struct darshan_log_map mod_map[DARSHAN_MAX_MODS];
81 82
};

83
/* job-level metadata stored for this application */
84
#define DARSHAN_JOB_METADATA_LEN 1024 /* including null terminator! */
85 86
struct darshan_job
{
87 88 89 90
    int64_t uid;
    int64_t start_time;
    int64_t end_time;
    int64_t nprocs;
91
    int64_t jobid;
92
    char metadata[DARSHAN_JOB_METADATA_LEN];
93 94
};

95
/* minimal record stored for each file/object accessed by Darshan */
96 97 98 99 100 101
struct darshan_record
{
    char* name;
    darshan_record_id id;
};

102
#endif /* __DARSHAN_LOG_FORMAT_H */