darshan-null-logutils.c 7.86 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/*
 * Copyright (C) 2015 University of Chicago.
 * See COPYRIGHT notice in top-level directory.
 *
 */

#define _GNU_SOURCE
#include "darshan-util-config.h"
#include <stdio.h>
#include <string.h>
#include <assert.h>
#include <stdlib.h>
#include <unistd.h>
#include <inttypes.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <errno.h>

20
#include "darshan-logutils.h"
21 22 23 24 25 26 27 28 29 30 31 32 33 34

/* integer counter name strings for the NULL module */
#define X(a) #a,
char *null_counter_names[] = {
    NULL_COUNTERS
};

/* floating point counter name strings for the NULL module */
char *null_f_counter_names[] = {
    NULL_F_COUNTERS
};
#undef X

/* prototypes for each of the NULL module's logutil functions */
35
static int darshan_log_get_null_record(darshan_fd fd, void* null_buf);
36
static int darshan_log_put_null_record(darshan_fd fd, void* null_buf, int ver);
37
static void darshan_log_print_null_record(void *file_rec,
38
    char *file_name, char *mnt_pt, char *fs_type, int ver);
39
static void darshan_log_print_null_description(void);
40 41
static void darshan_log_print_null_record_diff(void *file_rec1, char *file_name1,
    void *file_rec2, char *file_name2);
42
static void darshan_log_agg_null_records(void *rec, void *agg_rec, int init_flag);
43 44 45 46 47 48 49 50 51 52

/* structure storing each function needed for implementing the darshan
 * logutil interface. these functions are used for reading, writing, and
 * printing module data in a consistent manner.
 */
struct darshan_mod_logutil_funcs null_logutils =
{
    .log_get_record = &darshan_log_get_null_record,
    .log_put_record = &darshan_log_put_null_record,
    .log_print_record = &darshan_log_print_null_record,
53
    .log_print_description = &darshan_log_print_null_description,
54
    .log_print_diff = &darshan_log_print_null_record_diff,
55
    .log_agg_records = &darshan_log_agg_null_records
56 57 58 59
};

/* retrieve a NULL record from log file descriptor 'fd', storing the
 * buffer in 'null_buf' and the corresponding Darshan record id in
60 61
 * 'rec_id'. Return 1 on successful record read, 0 on no more data,
 * and -1 on error.
62
 */
63
static int darshan_log_get_null_record(darshan_fd fd, void* null_buf)
64 65 66 67 68 69
{
    struct darshan_null_record *rec;
    int i;
    int ret;

    /* read a NULL module record from the darshan log file */
70
    ret = darshan_log_get_mod(fd, DARSHAN_NULL_MOD, null_buf,
71 72 73 74 75 76 77 78 79 80 81 82
        sizeof(struct darshan_null_record));
    if(ret < 0)
        return(-1);
    else if(ret < sizeof(struct darshan_null_record))
        return(0);
    else
    {
        /* if the read was successful, do any necessary byte-swapping */
        rec = (struct darshan_null_record *)null_buf;
        if(fd->swap_flag)
        {
            /* swap bytes if necessary */
83 84
            DARSHAN_BSWAP64(&(rec->base_rec.id));
            DARSHAN_BSWAP64(&(rec->base_rec.rank));
85 86 87 88 89 90 91 92 93 94 95 96 97
            for(i=0; i<NULL_NUM_INDICES; i++)
                DARSHAN_BSWAP64(&rec->counters[i]);
            for(i=0; i<NULL_F_NUM_INDICES; i++)
                DARSHAN_BSWAP64(&rec->fcounters[i]);
        }

        return(1);
    }
}

/* write the NULL record stored in 'null_buf' to log file descriptor 'fd'.
 * Return 0 on success, -1 on failure
 */
98
static int darshan_log_put_null_record(darshan_fd fd, void* null_buf, int ver)
99 100 101 102 103
{
    struct darshan_null_record *rec = (struct darshan_null_record *)null_buf;
    int ret;

    /* append NULL record to darshan log file */
104
    ret = darshan_log_put_mod(fd, DARSHAN_NULL_MOD, rec,
105
        sizeof(struct darshan_null_record), ver);
106 107 108 109 110 111 112 113
    if(ret < 0)
        return(-1);

    return(0);
}

/* print all I/O data record statistics for the given NULL record */
static void darshan_log_print_null_record(void *file_rec, char *file_name,
114
    char *mnt_pt, char *fs_type, int ver)
115 116 117 118 119 120 121 122 123 124
{
    int i;
    struct darshan_null_record *null_rec =
        (struct darshan_null_record *)file_rec;

    /* print each of the integer and floating point counters for the NULL module */
    for(i=0; i<NULL_NUM_INDICES; i++)
    {
        /* macro defined in darshan-logutils.h */
        DARSHAN_COUNTER_PRINT(darshan_module_names[DARSHAN_NULL_MOD],
125 126 127
            null_rec->base_rec.rank, null_rec->base_rec.id,
            null_counter_names[i], null_rec->counters[i],
            file_name, mnt_pt, fs_type);
128 129 130 131 132 133
    }

    for(i=0; i<NULL_F_NUM_INDICES; i++)
    {
        /* macro defined in darshan-logutils.h */
        DARSHAN_F_COUNTER_PRINT(darshan_module_names[DARSHAN_NULL_MOD],
134 135 136
            null_rec->base_rec.rank, null_rec->base_rec.id,
            null_f_counter_names[i], null_rec->fcounters[i],
            file_name, mnt_pt, fs_type);
137 138 139 140 141
    }

    return;
}

142 143
/* print out a description of the NULL module record fields */
static void darshan_log_print_null_description()
144
{
145
    printf("\n# description of NULL counters:\n");
146 147 148 149 150 151 152 153
    printf("#   NULL_BARS: number of 'bar' function calls.\n");
    printf("#   NULL_BAR_DAT: value set by last call to function 'bar'.\n");
    printf("#   NULL_F_BAR_TIMESTAMP: timestamp of the first call to function 'bar'.\n");
    printf("#   NULL_F_BAR_DURATION: duration of the last call to function 'bar'.\n");

    return;
}

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
static void darshan_log_print_null_record_diff(void *file_rec1, char *file_name1,
    void *file_rec2, char *file_name2)
{
    struct darshan_null_record *file1 = (struct darshan_null_record *)file_rec1;
    struct darshan_null_record *file2 = (struct darshan_null_record *)file_rec2;
    int i;

    /* NOTE: we assume that both input records are the same module format version */

    for(i=0; i<NULL_NUM_INDICES; i++)
    {
        if(!file2)
        {
            printf("- ");
            DARSHAN_COUNTER_PRINT(darshan_module_names[DARSHAN_NULL_MOD],
169
                file1->base_rec.rank, file1->base_rec.id, null_counter_names[i],
170 171 172 173 174 175 176
                file1->counters[i], file_name1, "", "");

        }
        else if(!file1)
        {
            printf("+ ");
            DARSHAN_COUNTER_PRINT(darshan_module_names[DARSHAN_NULL_MOD],
177
                file2->base_rec.rank, file2->base_rec.id, null_counter_names[i],
178 179 180 181 182 183
                file2->counters[i], file_name2, "", "");
        }
        else if(file1->counters[i] != file2->counters[i])
        {
            printf("- ");
            DARSHAN_COUNTER_PRINT(darshan_module_names[DARSHAN_NULL_MOD],
184
                file1->base_rec.rank, file1->base_rec.id, null_counter_names[i],
185 186 187
                file1->counters[i], file_name1, "", "");
            printf("+ ");
            DARSHAN_COUNTER_PRINT(darshan_module_names[DARSHAN_NULL_MOD],
188
                file2->base_rec.rank, file2->base_rec.id, null_counter_names[i],
189 190 191 192 193 194 195 196 197 198
                file2->counters[i], file_name2, "", "");
        }
    }

    for(i=0; i<NULL_F_NUM_INDICES; i++)
    {
        if(!file2)
        {
            printf("- ");
            DARSHAN_F_COUNTER_PRINT(darshan_module_names[DARSHAN_NULL_MOD],
199
                file1->base_rec.rank, file1->base_rec.id, null_f_counter_names[i],
200 201 202 203 204 205 206
                file1->fcounters[i], file_name1, "", "");

        }
        else if(!file1)
        {
            printf("+ ");
            DARSHAN_F_COUNTER_PRINT(darshan_module_names[DARSHAN_NULL_MOD],
207
                file2->base_rec.rank, file2->base_rec.id, null_f_counter_names[i],
208 209 210 211 212 213
                file2->fcounters[i], file_name2, "", "");
        }
        else if(file1->fcounters[i] != file2->fcounters[i])
        {
            printf("- ");
            DARSHAN_F_COUNTER_PRINT(darshan_module_names[DARSHAN_NULL_MOD],
214
                file1->base_rec.rank, file1->base_rec.id, null_f_counter_names[i],
215 216 217
                file1->fcounters[i], file_name1, "", "");
            printf("+ ");
            DARSHAN_F_COUNTER_PRINT(darshan_module_names[DARSHAN_NULL_MOD],
218
                file2->base_rec.rank, file2->base_rec.id, null_f_counter_names[i],
219 220 221
                file2->fcounters[i], file_name2, "", "");
        }
    }
222 223 224 225

    return;
}

226 227 228 229
static void darshan_log_agg_null_records(void *rec, void *agg_rec, int init_flag)
{
    return;
}
230

231 232 233 234 235 236 237 238
/*
 * Local variables:
 *  c-indent-level: 4
 *  c-basic-offset: 4
 * End:
 *
 * vim: ts=8 sts=4 sw=4 expandtab
 */