darshan-log-format.h 2.01 KB
Newer Older
1 2 3 4 5
/*
 *  (C) 2009 by Argonne National Laboratory.
 *      See COPYRIGHT in top-level directory.
 */

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

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

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

21
/* update this on file format changes */
22
#define CP_VERSION "3.00"
23

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

27
/* size (in bytes) of job record */
Philip Carns's avatar
Philip Carns committed
28
#define CP_JOB_RECORD_SIZE 4096
29 30 31 32

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

33 34 35 36
/* max length of module name string (not counting '\0') */
/* TODO */
#define DARSHAN_MOD_NAME_LEN 31

37 38
typedef uint64_t darshan_record_id;

39 40 41 42 43 44 45 46 47 48 49 50 51
/* 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
{
    DARSHAN_POSIX_MOD,
    DARSHAN_MPIIO_MOD,
    DARSHAN_HDF5_MOD,
    DARSHAN_PNETCDF_MOD,
} darshan_module_id;

Shane Snyder's avatar
Shane Snyder committed
52 53 54
enum darshan_comp_type
{
    DARSHAN_GZ_COMP,
55
    DARSHAN_BZ2_COMP, /* TODO: no bz2 support util side, yet */
Shane Snyder's avatar
Shane Snyder committed
56 57
};

58
struct darshan_log_map
59
{
60 61
    uint64_t off;
    uint64_t len;
62 63
};

64
struct darshan_header
65
{
66 67 68 69 70
    char version_string[8];
    int64_t magic_nr;
    unsigned char comp_type;
    struct darshan_log_map rec_map;
    struct darshan_log_map mod_map[DARSHAN_MAX_MODS];
71 72
};

73
/* statistics for the job as a whole */
74
#define DARSHAN_JOB_METADATA_LEN 1024 /* including null terminator! */
75 76
struct darshan_job
{
77 78 79 80
    int64_t uid;
    int64_t start_time;
    int64_t end_time;
    int64_t nprocs;
81
    int64_t jobid;
82
    char metadata[DARSHAN_JOB_METADATA_LEN]; /* TODO: what is this? */
83 84
};

85 86 87 88 89 90
struct darshan_record
{
    char* name;
    darshan_record_id id;
};

91
#endif /* __DARSHAN_LOG_FORMAT_H */