add the darshan-diff utility back

darshan-util/Makefile.in

-all: libdarshan-util.a darshan-null-logutils.o darshan-analyzer darshan-convert darshan-parser jenkins-hash-gen
+all: libdarshan-util.a darshan-null-logutils.o darshan-analyzer darshan-convert darshan-diff darshan-parser jenkins-hash-gen
 
 DESTDIR =
 srcdir = @srcdir@
@@ -99,10 +99,8 @@ darshan-analyzer: darshan-analyzer.c darshan-logutils.h $(DARSHAN_LOG_FORMAT) $(
 darshan-convert: darshan-convert.c darshan-logutils.h $(DARSHAN_LOG_FORMAT) libdarshan-util.a lookup3.o | uthash-1.9.2
 	$(CC) $(CFLAGS) $(LDFLAGS) $< lookup3.o libdarshan-util.a -o $@ $(LIBS)
 
-#darshan-diff: darshan-diff.o $(DARSHAN_LOG_FORMAT) darshan-logutils.o darshan-logutils.h
-#	$(CC) $(CFLAGS)  $(LDFLAGS) $< darshan-logutils.o -o $@ $(LIBS)
-#darshan-diff.o: darshan-diff.c
-#	$(CC) $(CFLAGS) -c  $< -o $@
+darshan-diff: darshan-diff.c darshan-logutils.h $(DARSHAN_LOG_FORMAT) $(DARSHAN_MOD_LOGUTIL_HEADERS) $(DARSHAN_MOD_LOG_FORMATS) libdarshan-util.a | uthash-1.9.2
+	$(CC) $(CFLAGS) $(LDFLAGS) $< libdarshan-util.a -o $@ $(LIBS) 
 
 darshan-parser: darshan-parser.c darshan-logutils.h $(DARSHAN_LOG_FORMAT) $(DARSHAN_MOD_LOGUTIL_HEADERS) $(DARSHAN_MOD_LOG_FORMATS) libdarshan-util.a | uthash-1.9.2
 	$(CC) $(CFLAGS) $(LDFLAGS) $< libdarshan-util.a -o $@ $(LIBS) 
@@ -120,7 +118,7 @@ install:: all
 	install -d $(pkgconfigdir)
 	install -m 755 darshan-analyzer $(bindir)
 	install -m 755 darshan-convert $(bindir)
-#	install -m 755 darshan-diff $(bindir)
+	install -m 755 darshan-diff $(bindir)
 	install -m 755 darshan-parser $(bindir)
 	install -m 755 $(srcdir)/darshan-summary-per-file.sh $(bindir)
 	install -m 755 libdarshan-util.a $(libdir)

darshan-util/darshan-diff.c

 /*
- *  (C) 2009 by Argonne National Laboratory.
- *      See COPYRIGHT in top-level directory.
+ * Copyright (C) 2015 University of Chicago.
+ * See COPYRIGHT notice in top-level directory.
+ *
  */
 
 #include <stdio.h>
-#include <zlib.h>
-#include <string.h>
-#include "darshan-log-format.h"
+#include <stdlib.h>
+#include <inttypes.h>
+#include <sys/types.h>
+#include <assert.h>
+
 #include "darshan-logutils.h"
+#include "uthash-1.9.2/src/uthash.h"
+
+#define DEF_MOD_BUF_SIZE 1024 /* 1 KiB is enough for all current mod records ... */
+
+/* XXX: this structure is a temporary hack to get at the rank for each module's record */
+struct darshan_base_rec
+{
+    darshan_record_id f_id;
+    int64_t rank;
+};
+
+struct darshan_mod_record_ref
+{
+    int rank;
+    char mod_dat[DEF_MOD_BUF_SIZE];
+    struct darshan_mod_record_ref *prev;
+    struct darshan_mod_record_ref *next;
+};
 
+struct darshan_file_record_ref
+{
+    darshan_record_id rec_id;
+    struct darshan_mod_record_ref *mod_recs[DARSHAN_MAX_MODS];
+    UT_hash_handle hlink;
+};
 
-/* utility functions just for darshan-diff */
+static int darshan_build_global_record_hash(
+    darshan_fd fd, struct darshan_file_record_ref **rec_hash);
 
-static void cd_print_str(char * prefix, char * arg1, char *arg2)
+static void print_str_diff(char *prefix, char *arg1, char *arg2)
 {
     printf("- %s %s\n", prefix, arg1);
     printf("+ %s %s\n", prefix, arg2);
+    return;
 }
-static void cd_print_int(char * prefix, int arg1, int arg2)
-{
-    printf("- %s %d\n", prefix, arg1);
-    printf("+ %s %d\n", prefix, arg2);
-}
-static void cd_print_int64(char * prefix, int64_t arg1, int64_t arg2)
+
+static void print_int64_diff(char *prefix, int64_t arg1, int64_t arg2)
 {
     printf("- %s %" PRId64 "\n", prefix, arg1);
     printf("+ %s %" PRId64 "\n", prefix, arg2);
+    return;
 }
 
-
-int main(int argc, char ** argv)
+int main(int argc, char *argv[])
 {
+    char *logfile1, *logfile2;
     darshan_fd file1, file2;
     struct darshan_job job1, job2;
-    struct darshan_file cp_file1, cp_file2;
     char exe1[4096], exe2[4096];
-    int i, ret1,ret2;
+    struct darshan_record_ref *name_hash1 = NULL, *name_hash2 = NULL;
+    struct darshan_record_ref *name_ref1, *name_ref2;
+    struct darshan_file_record_ref *rec_hash1 = NULL, *rec_hash2 = NULL;
+    struct darshan_file_record_ref *rec_ref1, *rec_ref2, *rec_tmp;
+    struct darshan_mod_record_ref *mod_rec1, *mod_rec2;
+    void *mod_buf1, *mod_buf2;
+    struct darshan_base_rec *base_rec1, *base_rec2;
+    char *file_name1, *file_name2;
+    int i;
+    int ret;
 
-    if (argc != 3)
+    if(argc != 3)
     {
-        fprintf(stderr, "Usage: %s <file1> <file2>\n", argv[0]);
+        fprintf(stderr, "Usage: darshan-diff <logfile1> <logfile2>\n");
         return(-1);
     }
 
-    file1 = darshan_log_open(argv[1], "r");
-    if(!file1) {
-        fprintf(stderr, "darshan_log_open() failed to open %s\n.", argv[1]);
+    logfile1 = argv[1];
+    logfile2 = argv[2];
+
+    file1 = darshan_log_open(logfile1);
+    if(!file1)
+    {
+        fprintf(stderr, "Error: unable to open darshan log file %s.\n", logfile1);
         return(-1);
     }
-    file2 = darshan_log_open(argv[2], "r");
-    if(!file2) {
-        fprintf(stderr, "darshan_log_open() failed to open %s\n.", argv[2]);
+
+    file2 = darshan_log_open(logfile2);
+    if(!file2)
+    {
+        darshan_log_close(file1);
+        fprintf(stderr, "Error: unable to open darshan log file %s.\n", logfile2);
         return(-1);
     }
 
-    if (darshan_log_getjob(file1, &job1))
+    /* get job data for each log file */
+    ret = darshan_log_getjob(file1, &job1);
+    if(ret < 0)
     {
         darshan_log_close(file1);
+        darshan_log_close(file2);
+        fprintf(stderr, "Error: unable to read job info for darshan log file %s.\n", logfile1);
         return(-1);
     }
-    if (darshan_log_getjob(file2, &job2))
+
+    ret = darshan_log_getjob(file2, &job2);
+    if(ret < 0)
     {
+        darshan_log_close(file1);
         darshan_log_close(file2);
+        fprintf(stderr, "Error: unable to read job info for darshan log file %s.\n", logfile2);
         return(-1);
     }
 
-    if (darshan_log_getexe(file1, exe1))
+    /* get exe string for each log file */
+    ret = darshan_log_getexe(file1, exe1);
+    if(ret < 0)
     {
         darshan_log_close(file1);
+        darshan_log_close(file2);
+        fprintf(stderr, "Error: unable to read exe for darshan log file %s.\n", logfile1);
         return(-1);
     }
-    if (darshan_log_getexe(file2, exe2))
+
+    ret = darshan_log_getexe(file2, exe2);
+    if(ret < 0)
     {
+        darshan_log_close(file1);
         darshan_log_close(file2);
+        fprintf(stderr, "Error: unable to read exe for darshan log file %s.\n", logfile2);
         return(-1);
     }
 
-    if (strcmp(exe1, exe2)) 
-        cd_print_str("# exe: ", exe1, exe2);
+    /* print diff of exe and job data */
+    if (strcmp(exe1, exe2))
+        print_str_diff("# exe: ", exe1, exe2);
 
     if (job1.uid != job2.uid)
-        cd_print_int("# uid:", job1.uid, job2.uid);
+        print_int64_diff("# uid:", job1.uid, job2.uid);
     if (job1.start_time != job2.start_time)
-        cd_print_int64("# start_time:", 
-                (int64_t)job1.start_time, (int64_t)job2.start_time);
-    if (job1.end_time!= job2.end_time)
-        cd_print_int64("# end_time:", 
-                (int64_t)job1.end_time,(int64_t)job2.end_time);
-    if (job1.nprocs!= job2.nprocs)
-        cd_print_int("# nprocs:", job1.nprocs, job2.nprocs);
+        print_int64_diff("# start_time:", job1.start_time, job2.start_time);
+    if (job1.end_time != job2.end_time)
+        print_int64_diff("# end_time:", job1.end_time, job2.end_time);
+    if (job1.nprocs != job2.nprocs)
+        print_int64_diff("# nprocs:", job1.nprocs, job2.nprocs);
     if ((job1.end_time-job1.start_time) != (job2.end_time - job2.start_time))
-        cd_print_int64("# run time:", 
-                (int64_t)(job1.end_time - job1.start_time +1),
+        print_int64_diff("# run time:",
+                (int64_t)(job1.end_time - job1.start_time + 1),
                 (int64_t)(job2.end_time - job2.start_time + 1));
 
-    /* if for some reason no files were accessed, then we'll have to fix-up the
-     * buffers in the while loop */
-
-    do {
-        ret1 = darshan_log_getfile(file1, &job1, &cp_file1);
-	if (ret1 < 0) 
-	{
-		perror("darshan_log_getfile");
-		darshan_log_close(file1);
-		return(-1);
-	}
-        ret2 = darshan_log_getfile(file2, &job2, &cp_file2);
-	if (ret2 < 0) 
-	{
-		perror("darshan_log_getfile");
-		darshan_log_close(file2);
-		return(-1);
-	}
-
-        for(i=0; i<CP_NUM_INDICES; i++) {
-            if (cp_file1.counters[i] != cp_file2.counters[i]) {
-		printf("- ");
-		printf("%" PRId64 "\t%" PRIu64 "\t%s\t%" PRId64 "\t...%s\n",
-			cp_file1.rank, cp_file1.hash, darshan_names[i], 
-			cp_file1.counters[i], cp_file1.name_suffix);
-		printf("+ ");
-		printf("%" PRId64 "\t%" PRIu64 "\t%s\t%" PRId64 "\t...%s\n",
-			cp_file2.rank, cp_file2.hash, darshan_names[i], 
-			cp_file2.counters[i], cp_file2.name_suffix);
+    /* get hash of record ids to file names for each log */
+    ret = darshan_log_gethash(file1, &name_hash1);
+    if(ret < 0)
+    {
+        darshan_log_close(file1);
+        darshan_log_close(file2);
+        fprintf(stderr, "Error: unable to read record hash for darshan log file %s.\n", logfile1);
+        return(-1);
+    }
+
+    ret = darshan_log_gethash(file2, &name_hash2);
+    if(ret < 0)
+    {
+        darshan_log_close(file1);
+        darshan_log_close(file2);
+        fprintf(stderr, "Error: unable to read record hash for darshan log file %s.\n", logfile2);
+        return(-1);
+    }
+
+    /* build hash tables of all records opened by all modules for each darshan log file */
+    ret = darshan_build_global_record_hash(file1, &rec_hash1);
+    if(ret < 0)
+    {
+        fprintf(stderr, "Error: unable to build record hash for darshan log file %s.\n", logfile1);
+        darshan_log_close(file1);
+        darshan_log_close(file2);
+        return(-1);
+    }
+
+    ret = darshan_build_global_record_hash(file2, &rec_hash2);
+    if(ret < 0)
+    {
+        fprintf(stderr, "Error: unable to build record hash for darshan log file %s.\n", logfile2);
+        darshan_log_close(file1);
+        darshan_log_close(file2);
+        return(-1);
+    }
+
+    /* iterate records for the first log file and correlate/diff with records from
+     * the second log file
+     */
+    HASH_ITER(hlink, rec_hash1, rec_ref1, rec_tmp)
+    {
+        printf("\n");
+
+        /* search hash2 for this record */
+        HASH_FIND(hlink, rec_hash2, &(rec_ref1->rec_id), sizeof(darshan_record_id), rec_ref2);
+
+        for(i = 0; i < DARSHAN_MAX_MODS; i++)
+        {
+            /* TODO: skip modules that don't have the same format version, for now */
+            if(rec_ref1->mod_recs[i] && rec_ref2 && rec_ref2->mod_recs[i] &&
+                (file1->mod_ver[i] != file2->mod_ver[i]))
+            {
+                fprintf(stderr, "Warning: skipping %s module data due to incompatible"
+                    "version numbers (file1=%d, file2=%d).\n",
+                    darshan_module_names[i], file1->mod_ver[i], file2->mod_ver[i]);
+                continue;
             }
-        }
-        for(i=0; i<CP_F_NUM_INDICES; i++) {
-            if (cp_file1.fcounters[i] != cp_file2.fcounters[i]) {
-		printf("- ");
-		printf("%" PRId64 "\t%" PRIu64 "\t%s\t%f\t...%s\n",
-			cp_file1.rank, cp_file1.hash, darshan_f_names[i], 
-			cp_file1.fcounters[i], cp_file1.name_suffix);
-		printf("+ ");
-		printf("%" PRId64 "\t%" PRIu64 "\t%s\t%f\t...%s\n",
-			cp_file2.rank, cp_file2.hash, darshan_f_names[i], 
-			cp_file2.fcounters[i], cp_file2.name_suffix);
+
+            while(1)
+            {
+                mod_rec1 = rec_ref1->mod_recs[i];
+                if(rec_ref2)
+                    mod_rec2 = rec_ref2->mod_recs[i];
+                else
+                    mod_rec2 = NULL;
+
+                if(mod_rec1 == NULL)
+                    mod_buf1 = NULL;
+                else
+                    mod_buf1 = mod_rec1->mod_dat;
+                if(mod_rec2 == NULL)
+                    mod_buf2 = NULL;
+                else
+                    mod_buf2 = mod_rec2->mod_dat;
+
+                base_rec1 = (struct darshan_base_rec *)mod_buf1;
+                base_rec2 = (struct darshan_base_rec *)mod_buf2;
+
+                if(!base_rec1 && !base_rec2)
+                {
+                    /* break out if there are no more records for this module */
+                    break;
+                }
+                else if(base_rec1 && base_rec2)
+                {
+                    /* make sure if we have module records for this darshan record
+                     * from both log files, that we are performing the diff rank-by-rank
+                     * (i.e., we diff rank 1 records together, rank 2 records together,
+                     * and so on)
+                     */
+                    if(base_rec1->rank < base_rec2->rank)
+                        mod_buf2 = NULL;
+                    else if(base_rec1->rank > base_rec2->rank)
+                        mod_buf1 = NULL;
+                }
+
+                /* get corresponding file name for each record */
+                if(mod_buf1)
+                {
+                    HASH_FIND(hlink, name_hash1, &(base_rec1->f_id),
+                        sizeof(darshan_record_id), name_ref1);
+                    assert(name_ref1);
+                    file_name1 = name_ref1->rec.name;
+                }
+                if(mod_buf2)
+                {
+                    HASH_FIND(hlink, name_hash2, &(base_rec2->f_id),
+                        sizeof(darshan_record_id), name_ref2);
+                    assert(name_ref2);
+                    file_name2 = name_ref2->rec.name;
+                }
+
+                mod_logutils[i]->log_print_diff(mod_buf1, file_name1, mod_buf2, file_name2);
+
+                /* remove records which we have diffed already */
+                if(mod_buf1)
+                {
+                    if(mod_rec1->next == mod_rec1)
+                    {
+                        rec_ref1->mod_recs[i] = NULL;
+                    }
+                    else
+                    {
+                        mod_rec1->prev->next = mod_rec1->next;
+                        mod_rec1->next->prev = mod_rec1->prev;
+                        rec_ref1->mod_recs[i] = mod_rec1->next;
+                    }
+                    free(mod_rec1);
+                }
+                if(mod_buf2)
+                {
+                    if(mod_rec2->next == mod_rec2)
+                    {
+                        rec_ref2->mod_recs[i] = NULL;
+                    }
+                    else
+                    {
+                        mod_rec2->prev->next = mod_rec2->next;
+                        mod_rec2->next->prev = mod_rec2->prev;
+                        rec_ref2->mod_recs[i] = mod_rec2->next;
+                    }
+                    free(mod_rec2);
+                }
             }
         }
 
+        HASH_DELETE(hlink, rec_hash1, rec_ref1);
+        free(rec_ref1);
+        if(rec_ref2)
+        {
+            HASH_DELETE(hlink, rec_hash2, rec_ref2);
+            free(rec_ref2);
+        }
+    }
+
+    /* iterate any remaning records from the 2nd log file and print the diff output --
+     * NOTE: that these records do not have corresponding records in the first log file
+     */
+    HASH_ITER(hlink, rec_hash2, rec_ref2, rec_tmp)
+    {
+        printf("\n");
+
+        for(i = 0; i < DARSHAN_MAX_MODS; i++)
+        {
+            while(rec_ref2->mod_recs[i])
+            {
+                mod_rec2 = rec_ref2->mod_recs[i];
+                base_rec2 = (struct darshan_base_rec *)mod_rec2->mod_dat;
 
-    } while (ret1 == 1 || ret2 == 1);
+                HASH_FIND(hlink, name_hash2, &(base_rec2->f_id),
+                    sizeof(darshan_record_id), name_ref2);
+                assert(name_ref2);
+                file_name2 = name_ref2->rec.name;
 
+                mod_logutils[i]->log_print_diff(NULL, NULL, mod_rec2->mod_dat, file_name2);
+                
+                /* remove the record we just diffed */
+                if(mod_rec2->next == mod_rec2)
+                {
+                    rec_ref2->mod_recs[i] = NULL;
+                }
+                else
+                {
+                    mod_rec2->prev->next = mod_rec2->next;
+                    mod_rec2->next->prev = mod_rec2->prev;
+                    rec_ref2->mod_recs[i] = mod_rec2->next;
+                }
+                free(mod_rec2);
+            }
+        }
+
+        HASH_DELETE(hlink, rec_hash2, rec_ref2);
+        free(rec_ref2);
+    }
+
+    HASH_ITER(hlink, name_hash1, name_ref1, name_ref2)
+    {
+        HASH_DELETE(hlink, name_hash1, name_ref1);
+        free(name_ref1->rec.name);
+        free(name_ref1);
+    }
+    HASH_ITER(hlink, name_hash2, name_ref2, name_ref1)
+    {
+        HASH_DELETE(hlink, name_hash2, name_ref2);
+        free(name_ref2->rec.name);
+        free(name_ref2);
+    }
 
     darshan_log_close(file1);
     darshan_log_close(file2);
+
+    return(0);
+}
+
+static int darshan_build_global_record_hash(
+    darshan_fd fd, struct darshan_file_record_ref **rec_hash)
+{
+    struct darshan_mod_record_ref *mod_rec;
+    struct darshan_file_record_ref *file_rec;
+    darshan_record_id tmp_rec_id;
+    struct darshan_base_rec *base_rec;
+    int i;
+    int ret;
+
+    /* iterate over all modules in each log file, adding records to the
+     * appropriate hash table
+     */
+    for(i = 0; i < DARSHAN_MAX_MODS; i++)
+    {
+        while(1)
+        {
+            if(!mod_logutils[i]) break;
+
+            mod_rec = malloc(sizeof(struct darshan_mod_record_ref));
+            assert(mod_rec);
+            memset(mod_rec, 0, sizeof(struct darshan_mod_record_ref));
+
+            ret = mod_logutils[i]->log_get_record(fd, mod_rec->mod_dat, &tmp_rec_id);
+            if(ret < 0)
+            {
+                fprintf(stderr, "Error: unable to read module %s data from log file.\n",
+                    darshan_module_names[i]);
+                free(mod_rec);
+                return(-1);
+            }
+            else if(ret == 0)
+            {
+                free(mod_rec);
+                break;
+            }
+            else
+            {
+                base_rec = (struct darshan_base_rec *)mod_rec->mod_dat;
+                mod_rec->rank = base_rec->rank;
+
+                HASH_FIND(hlink, *rec_hash, &tmp_rec_id, sizeof(darshan_record_id), file_rec);
+                if(file_rec)
+                {
+                    /* the global record already exists, so we need to just add the
+                     * module record to the linked list of records for this module
+                     */
+
+                    /* we start at the end of the list and work backwards to insert this
+                     * record (the list is sorted according to increasing ranks, and in
+                     * general, darshan log records are sorted according to increasing
+                     * ranks, as well)
+                     */
+                    struct darshan_mod_record_ref *tmp_mod_rec = file_rec->mod_recs[i]->prev;
+                    while(1)
+                    {
+                        if(mod_rec->rank > tmp_mod_rec->rank)
+                        {
+                            /* insert new module record after this record */
+                            mod_rec->prev = tmp_mod_rec;
+                            mod_rec->next = tmp_mod_rec->next;
+                            tmp_mod_rec->next->prev = mod_rec;
+                            tmp_mod_rec->next = mod_rec;
+                            break;
+                        }
+                        else if(mod_rec->rank < tmp_mod_rec->rank)
+                        {
+                            /* insert new module record before this record */
+                            mod_rec->prev = tmp_mod_rec->prev;
+                            mod_rec->next = tmp_mod_rec;
+                            tmp_mod_rec->prev->next = mod_rec;
+                            tmp_mod_rec->prev = mod_rec;
+                            if(file_rec->mod_recs[i] == mod_rec->next)
+                                file_rec->mod_recs[i] = mod_rec;
+                            break;
+                        }
+
+                        tmp_mod_rec = tmp_mod_rec->prev;
+                        assert(tmp_mod_rec != file_rec->mod_recs[i]);
+                    }
+                }
+                else
+                {
+                    /* there is no entry in the global hash table of darshan records
+                     * for this log file, so create one and add it.
+                     */
+                    file_rec = malloc(sizeof(struct darshan_file_record_ref));
+                    assert(file_rec);
+
+                    memset(file_rec, 0, sizeof(struct darshan_file_record_ref));
+                    file_rec->rec_id = tmp_rec_id;
+                    HASH_ADD(hlink, *rec_hash, rec_id, sizeof(darshan_record_id), file_rec);
+
+                    /* also, add this record to this module's linked list of records */
+                    mod_rec->prev = mod_rec->next = mod_rec;
+                    file_rec->mod_recs[i] = mod_rec;
+                }
+            }
+        }
+    }
+
     return(0);
 }
 

darshan-util/darshan-logutils.h

@@ -91,6 +91,13 @@ struct darshan_mod_logutil_funcs
     );
     /* print module-specific description of I/O characterization data */
     void (*log_print_description)(void);
+    /* print a text diff of 2 module I/O records */
+    void (*log_print_diff)(
+        void *rec1,
+        char *name1,
+        void *rec2,
+        char *name2
+    );
 };
 
 extern struct darshan_mod_logutil_funcs *mod_logutils[];

darshan-util/darshan-posix-logutils.c

@@ -36,13 +36,16 @@ static int darshan_log_put_posix_file(darshan_fd fd, void* posix_buf, int ver);
 static void darshan_log_print_posix_file(void *file_rec,
     char *file_name, char *mnt_pt, char *fs_type, int ver);
 static void darshan_log_print_posix_description(void);
+static void darshan_log_print_posix_file_diff(void *file_rec1, char *file_name1,
+    void *file_rec2, char *file_name2);
 
 struct darshan_mod_logutil_funcs posix_logutils =
 {
     .log_get_record = &darshan_log_get_posix_file,
     .log_put_record = &darshan_log_put_posix_file,
     .log_print_record = &darshan_log_print_posix_file,
-    .log_print_description = &darshan_log_print_posix_description
+    .log_print_description