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

#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"
Shane Snyder's avatar
Shane Snyder committed
21

22 23 24 25 26 27 28 29 30 31 32
/* counter name strings for the POSIX module */
#define X(a) #a,
char *posix_counter_names[] = {
    POSIX_COUNTERS
};

char *posix_f_counter_names[] = {
    POSIX_F_COUNTERS
};
#undef X

33
static int darshan_log_get_posix_file(darshan_fd fd, void* posix_buf);
34
static int darshan_log_put_posix_file(darshan_fd fd, void* posix_buf, int ver);
35
static void darshan_log_print_posix_file(void *file_rec,
36
    char *file_name, char *mnt_pt, char *fs_type, int ver);
37
static void darshan_log_print_posix_description(void);
38 39
static void darshan_log_print_posix_file_diff(void *file_rec1, char *file_name1,
    void *file_rec2, char *file_name2);
40
static void darshan_log_agg_posix_files(void *rec, void *agg_rec, int init_flag);
41

42 43 44
struct darshan_mod_logutil_funcs posix_logutils =
{
    .log_get_record = &darshan_log_get_posix_file,
45
    .log_put_record = &darshan_log_put_posix_file,
46
    .log_print_record = &darshan_log_print_posix_file,
47
    .log_print_description = &darshan_log_print_posix_description,
48
    .log_print_diff = &darshan_log_print_posix_file_diff,
49
    .log_agg_records = &darshan_log_agg_posix_files,
50 51
};

52
static int darshan_log_get_posix_file(darshan_fd fd, void* posix_buf)
Shane Snyder's avatar
Shane Snyder committed
53
{
54
    struct darshan_posix_file *file;
Shane Snyder's avatar
Shane Snyder committed
55
    int i;
56
    int ret;
Shane Snyder's avatar
Shane Snyder committed
57

58 59 60
    ret = darshan_log_getmod(fd, DARSHAN_POSIX_MOD, posix_buf,
        sizeof(struct darshan_posix_file));
    if(ret < 0)
61
        return(-1);
62 63 64
    else if(ret < sizeof(struct darshan_posix_file))
        return(0);
    else
Shane Snyder's avatar
Shane Snyder committed
65
    {
66 67 68 69
        file = (struct darshan_posix_file *)posix_buf;
        if(fd->swap_flag)
        {
            /* swap bytes if necessary */
70 71
            DARSHAN_BSWAP64(&file->base_rec.id);
            DARSHAN_BSWAP64(&file->base_rec.rank);
72 73 74 75 76 77 78
            for(i=0; i<POSIX_NUM_INDICES; i++)
                DARSHAN_BSWAP64(&file->counters[i]);
            for(i=0; i<POSIX_F_NUM_INDICES; i++)
                DARSHAN_BSWAP64(&file->fcounters[i]);
        }

        return(1);
Shane Snyder's avatar
Shane Snyder committed
79
    }
80
}
Shane Snyder's avatar
Shane Snyder committed
81

82
static int darshan_log_put_posix_file(darshan_fd fd, void* posix_buf, int ver)
83 84 85 86 87
{
    struct darshan_posix_file *file = (struct darshan_posix_file *)posix_buf;
    int ret;

    ret = darshan_log_putmod(fd, DARSHAN_POSIX_MOD, file,
88
        sizeof(struct darshan_posix_file), ver);
89 90
    if(ret < 0)
        return(-1);
91 92

    return(0);
Shane Snyder's avatar
Shane Snyder committed
93 94
}

95
static void darshan_log_print_posix_file(void *file_rec, char *file_name,
96
    char *mnt_pt, char *fs_type, int ver)
97 98 99 100 101 102 103 104
{
    int i;
    struct darshan_posix_file *posix_file_rec =
        (struct darshan_posix_file *)file_rec;

    for(i=0; i<POSIX_NUM_INDICES; i++)
    {
        DARSHAN_COUNTER_PRINT(darshan_module_names[DARSHAN_POSIX_MOD],
105 106 107
            posix_file_rec->base_rec.rank, posix_file_rec->base_rec.id,
            posix_counter_names[i], posix_file_rec->counters[i],
            file_name, mnt_pt, fs_type);
108 109 110 111 112
    }

    for(i=0; i<POSIX_F_NUM_INDICES; i++)
    {
        DARSHAN_F_COUNTER_PRINT(darshan_module_names[DARSHAN_POSIX_MOD],
113 114 115
            posix_file_rec->base_rec.rank, posix_file_rec->base_rec.id,
            posix_f_counter_names[i], posix_file_rec->fcounters[i],
            file_name, mnt_pt, fs_type);
116 117 118 119 120
    }

    return;
}

121 122
static void darshan_log_print_posix_description()
{
123
    printf("\n# description of POSIX counters:\n");
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
    printf("#   POSIX_*: posix operation counts.\n");
    printf("#   READS,WRITES,OPENS,SEEKS,STATS, and MMAPS are types of operations.\n");
    printf("#   POSIX_MODE: mode that file was opened in.\n");
    printf("#   POSIX_BYTES_*: total bytes read and written.\n");
    printf("#   POSIX_MAX_BYTE_*: highest offset byte read and written.\n");
    printf("#   POSIX_CONSEC_*: number of exactly adjacent reads and writes.\n");
    printf("#   POSIX_SEQ_*: number of reads and writes from increasing offsets.\n");
    printf("#   POSIX_RW_SWITCHES: number of times access alternated between read and write.\n");
    printf("#   POSIX_*_ALIGNMENT: memory and file alignment.\n");
    printf("#   POSIX_*_NOT_ALIGNED: number of reads and writes that were not aligned.\n");
    printf("#   POSIX_MAX_*_TIME_SIZE: size of the slowest read and write operations.\n");
    printf("#   POSIX_SIZE_*_*: histogram of read and write access sizes.\n");
    printf("#   POSIX_STRIDE*_STRIDE: the four most common strides detected.\n");
    printf("#   POSIX_STRIDE*_COUNT: count of the four most common strides.\n");
    printf("#   POSIX_ACCESS*_ACCESS: the four most common access sizes.\n");
    printf("#   POSIX_ACCESS*_COUNT: count of the four most common access sizes.\n");
    printf("#   POSIX_*_RANK: rank of the processes that were the fastest and slowest at I/O (for shared files).\n");
    printf("#   POSIX_*_RANK_BYTES: bytes transferred by the fastest and slowest ranks (for shared files).\n");
    printf("#   POSIX_F_OPEN_TIMESTAMP: timestamp of first open.\n");
    printf("#   POSIX_F_*_START_TIMESTAMP: timestamp of first read/write.\n");
    printf("#   POSIX_F_*_END_TIMESTAMP: timestamp of last read/write.\n");
    printf("#   POSIX_F_CLOSE_TIMESTAMP: timestamp of last close.\n");
    printf("#   POSIX_F_READ/WRITE/META_TIME: cumulative time spent in read, write, or metadata operations.\n");
    printf("#   POSIX_F_MAX_*_TIME: duration of the slowest read and write operations.\n");
    printf("#   POSIX_F_*_RANK_TIME: fastest and slowest I/O time for a single rank (for shared files).\n");
    printf("#   POSIX_F_VARIANCE_RANK_*: variance of total I/O time and bytes moved for all ranks (for shared files).\n");

    DARSHAN_PRINT_HEADER();

    return;
}

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

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

    for(i=0; i<POSIX_NUM_INDICES; i++)
    {
        if(!file2)
        {
            printf("- ");
            DARSHAN_COUNTER_PRINT(darshan_module_names[DARSHAN_POSIX_MOD],
171
                file1->base_rec.rank, file1->base_rec.id, posix_counter_names[i],
172
                file1->counters[i], file_name1, "", "");
173

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

    for(i=0; i<POSIX_F_NUM_INDICES; i++)
    {
        if(!file2)
        {
            printf("- ");
            DARSHAN_F_COUNTER_PRINT(darshan_module_names[DARSHAN_POSIX_MOD],
201
                file1->base_rec.rank, file1->base_rec.id, posix_f_counter_names[i],
202
                file1->fcounters[i], file_name1, "", "");
203

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

    return;
}

228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
static void darshan_log_agg_posix_files(void *rec, void *agg_rec, int init_flag)
{
    struct darshan_posix_file *psx_rec = (struct darshan_posix_file *)rec;
    struct darshan_posix_file *agg_psx_rec = (struct darshan_posix_file *)agg_rec;
    int i;
    double psx_time = psx_rec->fcounters[POSIX_F_READ_TIME] +
        psx_rec->fcounters[POSIX_F_WRITE_TIME] +
        psx_rec->fcounters[POSIX_F_META_TIME];

    /* special case initialization of shared record for
     * first call of this function
     */
    if(init_flag)
    {
        /* set fastest/slowest rank counters according to root rank.
         * these counters will be determined as the aggregation progresses.
         */
        agg_psx_rec->counters[POSIX_FASTEST_RANK] = psx_rec->base_rec.rank;
        agg_psx_rec->counters[POSIX_FASTEST_RANK_BYTES] =
            psx_rec->counters[POSIX_BYTES_READ] +
            psx_rec->counters[POSIX_BYTES_WRITTEN];
        agg_psx_rec->fcounters[POSIX_F_FASTEST_RANK_TIME] = psx_time;

        agg_psx_rec->counters[POSIX_SLOWEST_RANK] =
            agg_psx_rec->counters[POSIX_FASTEST_RANK];
        agg_psx_rec->counters[POSIX_SLOWEST_RANK_BYTES] =
            agg_psx_rec->counters[POSIX_FASTEST_RANK_BYTES];
        agg_psx_rec->fcounters[POSIX_F_SLOWEST_RANK_TIME] =
            agg_psx_rec->fcounters[POSIX_F_FASTEST_RANK_TIME];
    }

    for(i = 0; i < POSIX_NUM_INDICES; i++)
    {
        switch(i)
        {
            case POSIX_OPENS:
            case POSIX_READS:
            case POSIX_WRITES:
            case POSIX_SEEKS:
            case POSIX_STATS:
            case POSIX_MMAPS:
            case POSIX_FOPENS:
            case POSIX_FREADS:
            case POSIX_FWRITES:
            case POSIX_FSEEKS:
            case POSIX_FSYNCS:
            case POSIX_FDSYNCS:
            case POSIX_BYTES_READ:
            case POSIX_BYTES_WRITTEN:
            case POSIX_CONSEC_READS:
            case POSIX_CONSEC_WRITES:
            case POSIX_SEQ_READS:
            case POSIX_SEQ_WRITES:
            case POSIX_RW_SWITCHES:
            case POSIX_MEM_NOT_ALIGNED:
            case POSIX_FILE_NOT_ALIGNED:
            case POSIX_SIZE_READ_0_100:
            case POSIX_SIZE_READ_100_1K:
            case POSIX_SIZE_READ_1K_10K:
            case POSIX_SIZE_READ_10K_100K:
            case POSIX_SIZE_READ_100K_1M:
            case POSIX_SIZE_READ_1M_4M:
            case POSIX_SIZE_READ_4M_10M:
            case POSIX_SIZE_READ_10M_100M:
            case POSIX_SIZE_READ_100M_1G:
            case POSIX_SIZE_READ_1G_PLUS:
            case POSIX_SIZE_WRITE_0_100:
            case POSIX_SIZE_WRITE_100_1K:
            case POSIX_SIZE_WRITE_1K_10K:
            case POSIX_SIZE_WRITE_10K_100K:
            case POSIX_SIZE_WRITE_100K_1M:
            case POSIX_SIZE_WRITE_1M_4M:
            case POSIX_SIZE_WRITE_4M_10M:
            case POSIX_SIZE_WRITE_10M_100M:
            case POSIX_SIZE_WRITE_100M_1G:
303
            case POSIX_SIZE_WRITE_1G_PLUS:
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
                /* sum */
                agg_psx_rec->counters[i] += psx_rec->counters[i];
                break;
            case POSIX_MODE:
            case POSIX_MEM_ALIGNMENT:
            case POSIX_FILE_ALIGNMENT:
                /* just set to the input value */
                agg_psx_rec->counters[i] = psx_rec->counters[i];
                break;
            case POSIX_MAX_BYTE_READ:
            case POSIX_MAX_BYTE_WRITTEN:
                /* max */
                if(psx_rec->counters[i] > agg_psx_rec->counters[i])
                {
                    agg_psx_rec->counters[i] = psx_rec->counters[i];
                }
                break;
            case POSIX_MAX_READ_TIME_SIZE:
            case POSIX_MAX_WRITE_TIME_SIZE:
            case POSIX_FASTEST_RANK:
            case POSIX_FASTEST_RANK_BYTES:
            case POSIX_SLOWEST_RANK:
            case POSIX_SLOWEST_RANK_BYTES:
                /* these are set with the FP counters */
                break;
            default:
                /* TODO: common access counters and strides */
                agg_psx_rec->counters[i] = -1;
                break;
        }
    }

    for(i = 0; i < POSIX_F_NUM_INDICES; i++)
    {
        switch(i)
        {
            case POSIX_F_READ_TIME:
            case POSIX_F_WRITE_TIME:
            case POSIX_F_META_TIME:
                /* sum */
                agg_psx_rec->fcounters[i] += psx_rec->fcounters[i];
                break;
            case POSIX_F_OPEN_TIMESTAMP:
            case POSIX_F_READ_START_TIMESTAMP:
            case POSIX_F_WRITE_START_TIMESTAMP:
349 350 351 352
                /* minimum non-zero */
                if((psx_rec->fcounters[i] > 0)  &&
                    ((agg_psx_rec->fcounters[i] == 0) ||
                    (psx_rec->fcounters[i] < agg_psx_rec->fcounters[i])))
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
                {
                    agg_psx_rec->fcounters[i] = psx_rec->fcounters[i];
                }
                break;
            case POSIX_F_READ_END_TIMESTAMP:
            case POSIX_F_WRITE_END_TIMESTAMP:
            case POSIX_F_CLOSE_TIMESTAMP:
                /* maximum */
                if(psx_rec->fcounters[i] > agg_psx_rec->fcounters[i])
                {
                    agg_psx_rec->fcounters[i] = psx_rec->fcounters[i];
                }
                break;
            case POSIX_F_MAX_READ_TIME:
                if(psx_rec->fcounters[i] > agg_psx_rec->fcounters[i])
                {
                    agg_psx_rec->fcounters[i] = psx_rec->fcounters[i];
                    agg_psx_rec->counters[POSIX_MAX_READ_TIME_SIZE] =
                        psx_rec->counters[POSIX_MAX_READ_TIME_SIZE];
                }
                break;
            case POSIX_F_MAX_WRITE_TIME:
                if(psx_rec->fcounters[i] > agg_psx_rec->fcounters[i])
                {
                    agg_psx_rec->fcounters[i] = psx_rec->fcounters[i];
                    agg_psx_rec->counters[POSIX_MAX_WRITE_TIME_SIZE] =
                        psx_rec->counters[POSIX_MAX_WRITE_TIME_SIZE];
                }
                break;
            case POSIX_F_FASTEST_RANK_TIME:
                if(psx_time < agg_psx_rec->fcounters[POSIX_F_FASTEST_RANK_TIME])
                {
                    agg_psx_rec->counters[POSIX_FASTEST_RANK] = psx_rec->base_rec.rank;
                    agg_psx_rec->counters[POSIX_FASTEST_RANK_BYTES] =
                        psx_rec->counters[POSIX_BYTES_READ] +
                        psx_rec->counters[POSIX_BYTES_WRITTEN];
                    agg_psx_rec->fcounters[POSIX_F_FASTEST_RANK_TIME] = psx_time;
                }
                break;
            case POSIX_F_SLOWEST_RANK_TIME:
                if(psx_time > agg_psx_rec->fcounters[POSIX_F_SLOWEST_RANK_TIME])
                {
                    agg_psx_rec->counters[POSIX_SLOWEST_RANK] = psx_rec->base_rec.rank;
                    agg_psx_rec->counters[POSIX_SLOWEST_RANK_BYTES] =
                        psx_rec->counters[POSIX_BYTES_READ] +
                        psx_rec->counters[POSIX_BYTES_WRITTEN];
                    agg_psx_rec->fcounters[POSIX_F_SLOWEST_RANK_TIME] = psx_time;
                }
                break;
            default:
                /* TODO: variance */
                agg_psx_rec->fcounters[i] = -1;
                break;
        }
    }

    return;
}

Shane Snyder's avatar
Shane Snyder committed
412 413 414 415 416 417 418 419
/*
 * Local variables:
 *  c-indent-level: 4
 *  c-basic-offset: 4
 * End:
 *
 * vim: ts=8 sts=4 sw=4 expandtab
 */