[svn-r9872] Purpose:

New feature.

Description:
Added new tool ph5diff. (Code done by Leon Arber.)
Code is changed but test is not working yet. For now,
it skipped all tests.

Platforms tested:
Tested in heping, serial and parallel modes.

2 files changed, 378 insertions, 257 deletions

diff --git a/tools/h5diff/h5diff_main.c b/tools/h5diff/h5diff_main.c
index ff3b2e1..bab980a 100644
--- a/tools/h5diff/h5diff_main.c
+++ b/tools/h5diff/h5diff_main.c
@@ -13,6 +13,7 @@
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
 #include "h5diff.h"
+#include "ph5diff.h"
 #include <stdlib.h>
 #include <assert.h>
 
@@ -20,11 +21,10 @@ static void usage(void);
 static int check_n_input( const char* );
 static int check_f_input( const char* );
 
-
 /*-------------------------------------------------------------------------
  * Function: main
  *
- * Purpose: h5diff main program
+ * Purpose: ph5diff main program
  *
  * Return: An  exit status of 0 means no differences were found, 1 means some 
  *   differences were found.
@@ -42,193 +42,310 @@ static int check_f_input( const char* );
  *   Verbose mode: print the above plus a list of objects and warnings
  *   Quiet mode: do not print output 
  *
+ * November 2004: Leon Arber (larber@uiuc.edu)
+ * 		  Additions that allow h5diff to be run in parallel
  *-------------------------------------------------------------------------
  */
 
 int main(int argc, const char *argv[])
 {
- int        i;
- const char *s = NULL;
- const char *fname1 = NULL;
- const char *fname2 = NULL;
- const char *objname1  = NULL;
- const char *objname2  = NULL;
- hsize_t    nfound=0;
- int        ret;
- diff_opt_t options;
-
- memset(&options, 0, sizeof (diff_opt_t));
+    int        i;
+    const char *s = NULL;
+    const char *fname1 = NULL;
+    const char *fname2 = NULL;
+    const char *objname1  = NULL;
+    const char *objname2  = NULL;
+    hsize_t    nfound=0;
+    int        ret;
+    diff_opt_t options;
 
-/*-------------------------------------------------------------------------
- * initial check of command line options
- *-------------------------------------------------------------------------
- */
+#ifdef H5_HAVE_PH5DIFF
+    int	       nID;
+    MPI_Status Status;
 
- if ( argc==2 && (strcmp("-h",argv[1])==0) ) 
-  usage();
-  
- if ( argc<3 ) 
- {
-  printf("Number of arguments is only %d\n", argc );
-  usage();
- }
 
-/*-------------------------------------------------------------------------
- * file names are first
- *-------------------------------------------------------------------------
- */
- if ( argc>=3 )
- {
-  fname1 = argv[1];
-  fname2 = argv[2];
- }
-/*-------------------------------------------------------------------------
- * parse command line options
- *-------------------------------------------------------------------------
- */
- for (i=3; i<argc ; i++) 
- {
-  /* get the single-letter switches */
-  if ( '-'==argv[i][0] )
-  {
-   for (s=argv[i]+1; *s; s++) 
-   {
-    switch (*s) {
-    default:
-    printf("-%s is an invalid option\n", s );
-    usage();
-    break;
-    case 'h': 
-     usage();
-     break;
-    case 'v': 
-     options.m_verbose = 1;
-     break;
-    case 'q': 
-     /* use quiet mode; supress the message "0 differences found" */
-     options.m_quiet = 1;
-     break;
-    case 'r': 
-     options.m_report = 1;
-     break;
-    case 'd': 
-     /* if it is not another option */
-     if ( i<argc-1 &&'-' != argv[i+1][0] )
-     {
-      options.d=1;
-      if ( check_f_input(argv[i+1])==-1)
-      {
-       printf("<-d %s> is not a valid option\n", argv[i+1] );
-       usage();
-      }
-      options.delta = atof(argv[i+1]);
-      i++; /* go to next */
-     }
-     else
-     {
-      printf("Not a valid -d option\n");
-      usage();
-     }
-     break;
-    case 'p': 
-     if ( i<argc-1 &&'-' !=argv[i+1][0] )
-     {
-      options.p=1;
-      if ( check_f_input(argv[i+1])==-1)
-      {
-       printf("<-p %s> is not a valid option\n", argv[i+1] );
-       usage();
-      }
-      options.percent = atof(argv[i+1]);
-      i++; /* go to next */
-     }
-     else
-     {
-      printf("Not a valid -p option\n");
-      usage();
-     }
-     break;
-    case 'n': 
-     if ( i<argc-1 && '-' !=argv[i+1][0] )
-     {
-      options.n=1;
-      if ( check_n_input(argv[i+1])==-1)
-      {
-       printf("<-n %s> is not a valid option\n", argv[i+1] );
-       usage();
-      }
-      options.count = atoi(argv[i+1]);
-      i++; /* go to next */
-     }
-     else
-     {
-      printf("Not a valid -n option\n");
-      usage();
-     }
-     break;
-    } /*switch*/
-   } /*for*/ 
-  } /*if*/
-  
-  else /* not single-letter switches */
-   
-  {
-   /* check if it is not a -d, -p parameter */
-   if ( '-'==argv[i-1][0] && ('d'==argv[i-1][1] ||'p'==argv[i-1][1] ))
-    continue;
-   else
-   {
-    if ( objname1==NULL )
-     objname1 = argv[i];
-    if ( objname2==NULL )
+    /*-------------------------------------------------------------------------
+     * Initialize the MPI environment
+     *-------------------------------------------------------------------------
+     */
+    MPI_Init(&argc, (char***) &argv);
+
+    MPI_Comm_rank(MPI_COMM_WORLD, &nID);
+    MPI_Comm_size(MPI_COMM_WORLD, &g_nTasks);
+
+    if(g_nTasks < 2)
     {
-     /* check if we have a second object name */
-     if ( i+1<argc && '-' !=argv[i+1][0] ) {
-      /* yes */
-      objname2 = argv[i+1];
-      i++; /* go to next */
-     }
-     else
-      /* no */
-      objname2 = objname1;
-    } /*objname2*/
-   } /*else*/
-  } /*else*/
-  
- }/*for*/
-
- nfound = h5diff(fname1,fname2,objname1,objname2,&options);
+	printf("Must have at least 2 tasks to run parallel diff\n");
+	MPI_Finalize();
+	exit(-1);
+    }
 
-/*-------------------------------------------------------------------------
- * print how many differences were found
- *-------------------------------------------------------------------------
- */
- if (!options.m_quiet) 
- {
-  if (options.cmn_objs==0)
-  {
-   printf("No common objects found. Files are not comparable.\n");
-   if (!options.m_verbose)
-    printf("Use -v for a list of objects.\n");
-  }
-  else
-  {
-   if (!options.err_stat)
-    print_found(nfound);
-  }
- }
+    /* Have the manager process the command-line */
+    if(nID == 0)
+    {
+#endif
+	memset(&options, 0, sizeof (diff_opt_t));
 
-/*-------------------------------------------------------------------------
- * exit code 
- *   >0 if differences, 0 if no differences, <0 if error
- *-------------------------------------------------------------------------
- */
+	/*-------------------------------------------------------------------------
+	 * initial check of command line options
+	 *-------------------------------------------------------------------------
+	 */
+
+	if ( argc==2 && (strcmp("-h",argv[1])==0) ) 
+	    usage();
+
+	if ( argc<3 ) 
+	{
+	    printf("Number of arguments is only %d\n", argc );
+	    usage();
+	}
+
+	/*-------------------------------------------------------------------------
+	 * file names are first
+	 *-------------------------------------------------------------------------
+	 */
+	if ( argc>=3 )
+	{
+	    fname1 = argv[1];
+	    fname2 = argv[2];
+	}
+	/*-------------------------------------------------------------------------
+	 * parse command line options
+	 *-------------------------------------------------------------------------
+	 */
+	for (i=3; i<argc ; i++) 
+	{
+	    /* get the single-letter switches */
+	    if ( '-'==argv[i][0] )
+	    {
+		for (s=argv[i]+1; *s; s++) 
+		{
+		    switch (*s) {
+			default:
+			    printf("-%s is an invalid option\n", s );
+			    usage();
+			    break;
+			case 'h': 
+			    usage();
+			    break;
+			case 'v': 
+			    options.m_verbose = 1;
+			    break;
+			case 'q': 
+			    /* use quiet mode; supress the message "0 differences found" */
+			    options.m_quiet = 1;
+			    break;
+			case 'r': 
+			    options.m_report = 1;
+			    break;
+			case 'd': 
+			    /* if it is not another option */
+			    if ( i<argc-1 &&'-' != argv[i+1][0] )
+			    {
+				options.d=1;
+				if ( check_f_input(argv[i+1])==-1)
+				{
+				    printf("<-d %s> is not a valid option\n", argv[i+1] );
+				    usage();
+				}
+				options.delta = atof(argv[i+1]);
+				i++; /* go to next */
+			    }
+			    else
+			    {
+				printf("Not a valid -d option\n");
+				usage();
+			    }
+			    break;
+			case 'p': 
+			    if ( i<argc-1 &&'-' !=argv[i+1][0] )
+			    {
+				options.p=1;
+				if ( check_f_input(argv[i+1])==-1)
+				{
+				    printf("<-p %s> is not a valid option\n", argv[i+1] );
+				    usage();
+				}
+				options.percent = atof(argv[i+1]);
+				i++; /* go to next */
+			    }
+			    else
+			    {
+				printf("Not a valid -p option\n");
+				usage();
+			    }
+			    break;
+			case 'n': 
+			    if ( i<argc-1 && '-' !=argv[i+1][0] )
+			    {
+				options.n=1;
+				if ( check_n_input(argv[i+1])==-1)
+				{
+				    printf("<-n %s> is not a valid option\n", argv[i+1] );
+				    usage();
+				}
+				options.count = atoi(argv[i+1]);
+				i++; /* go to next */
+			    }
+			    else
+			    {
+				printf("Not a valid -n option\n");
+				usage();
+			    }
+			    break;
+		    } /*switch*/
+		} /*for*/ 
+	    } /*if*/
+
+	    else /* not single-letter switches */
 
- ret= (nfound==0 ? 0 : 1 );
- if (options.err_stat)
-  ret=-1;
- return ret;
- 
+	    {
+		/* check if it is not a -d, -p parameter */
+		if ( '-'==argv[i-1][0] && ('d'==argv[i-1][1] ||'p'==argv[i-1][1] ))
+		    continue;
+		else
+		{
+		    if ( objname1==NULL )
+			objname1 = argv[i];
+		    if ( objname2==NULL )
+		    {
+			/* check if we have a second object name */
+			if ( i+1<argc && '-' !=argv[i+1][0] ) {
+			    /* yes */
+			    objname2 = argv[i+1];
+			    i++; /* go to next */
+			}
+			else
+			    /* no */
+			    objname2 = objname1;
+		    } /*objname2*/
+		} /*else*/
+	    } /*else*/
+
+	}/*for*/
+
+	nfound = h5diff(fname1,fname2,objname1,objname2,&options);
+
+#ifdef H5_HAVE_PH5DIFF
+	MPI_Barrier(MPI_COMM_WORLD);
+#endif
+
+	/*-------------------------------------------------------------------------
+	 * print how many differences were found
+	 *-------------------------------------------------------------------------
+	 */
+	if (!options.m_quiet) 
+	{
+	    if (options.cmn_objs==0)
+	    {
+		printf("No common objects found. Files are not comparable.\n");
+		if (!options.m_verbose)
+		    printf("Use -v for a list of objects.\n");
+	    }
+	    else
+	    {
+		if (!options.err_stat)
+		    print_found(nfound);
+	    }
+	}
+
+	/*-------------------------------------------------------------------------
+	 * exit code 
+	 *   >0 if differences, 0 if no differences, <0 if error
+	 *-------------------------------------------------------------------------
+	 */
+
+#ifdef H5_HAVE_PH5DIFF
+	MPI_Finalize();
+#endif
+	
+	ret= (nfound==0 ? 0 : 1 );
+	if (options.err_stat)
+	    ret=-1;
+	return ret;
+#ifdef H5_HAVE_PH5DIFF
+    }
+    /* All the other tasks just sit around and wait to be assigned something to diff */
+    else
+    {	
+	struct diff_args args;
+	hid_t file1_id, file2_id;	
+	char	filenames[2][255];
+
+	outBuffOffset = 0;
+	
+	MPI_Recv(filenames, 255*2, MPI_CHAR, 0, MPI_ANY_TAG, MPI_COMM_WORLD, &Status);
+	if(Status.MPI_TAG == MPI_TAG_PARALLEL)
+	{
+	    printf("We're in parallel mode...opening the files\n");
+
+	    /* disable error reporting */
+	    H5E_BEGIN_TRY
+	    {
+		/* Open the files */
+		if ((file1_id = H5Fopen (filenames[0], H5F_ACC_RDONLY, H5P_DEFAULT)) < 0)
+		{
+		    printf ("h5diff Task [%d]: <%s>: unable to open file\n", nID, fname1);
+		    MPI_Abort(MPI_COMM_WORLD, 0);
+		}
+		if ((file2_id = H5Fopen (filenames[1], H5F_ACC_RDONLY, H5P_DEFAULT)) < 0)
+		{
+		    printf ("h5diff Task [%d]: <%s>: unable to open file\n", nID, fname2);
+		    MPI_Abort(MPI_COMM_WORLD, 0);
+		}
+		/* enable error reporting */
+	    }
+	    H5E_END_TRY;
+
+
+	    while(1)
+	    {
+		MPI_Probe(0, MPI_ANY_TAG, MPI_COMM_WORLD, &Status);
+
+		if(Status.MPI_TAG == MPI_TAG_ARGS)
+		{
+		    /*Recv parameters for diff from manager task */
+		    MPI_Recv(&args, sizeof(struct diff_args), MPI_BYTE, 0, MPI_TAG_ARGS, MPI_COMM_WORLD, &Status);
+		    /*Do the diff */
+		    nfound = diff(file1_id, args.name, file2_id, args.name, &(args.options), args.type);
+
+		    /*If print buffer has something in it, request print token.*/
+		    if(outBuffOffset>0)
+		    {
+			MPI_Send(NULL, 0, MPI_BYTE, 0, MPI_TAG_TOK_REQUEST, MPI_COMM_WORLD);
+
+			/*Wait for print token. */
+			MPI_Recv(NULL, 0, MPI_BYTE, 0, MPI_TAG_PRINT_TOK, MPI_COMM_WORLD, &Status);
+
+			/*When get token, print stuff out and return token */
+			printf("%s", outBuff);
+			memset(outBuff, 0, OUTBUFF_SIZE);
+			outBuffOffset = 0;
+
+			MPI_Send(&nfound, 1, MPI_LONG_LONG, 0, MPI_TAG_TOK_RETURN, MPI_COMM_WORLD);
+		    }
+		    else
+			MPI_Send(&nfound, 1, MPI_LONG_LONG, 0, MPI_TAG_DONE, MPI_COMM_WORLD);
+
+		}
+		else if(Status.MPI_TAG == MPI_TAG_END)
+		{
+		    MPI_Recv(NULL, 0, MPI_BYTE, 0, MPI_TAG_END, MPI_COMM_WORLD, &Status);
+		    printf("exiting..., task: %d\n", nID);
+		    break;
+		}
+		else
+		{
+		    printf("ERROR....invalid tag received\n");
+		    MPI_Abort(MPI_COMM_WORLD, 0);
+		}
+
+	    }
+	}
+	MPI_Barrier(MPI_COMM_WORLD);
+	MPI_Finalize();	
+    }
+#endif
 }
 
 /*-------------------------------------------------------------------------
@@ -248,25 +365,25 @@ int main(int argc, const char *argv[])
  *
  *-------------------------------------------------------------------------
  */
-static 
+    static 
 int check_n_input( const char *str )
 {
- unsigned i;
- char c;
-
- for ( i = 0; i < strlen(str); i++)
- {
-  c = str[i];
-  if ( i==0 )
-  {
-   if ( c < 49 || c > 57  ) /* ascii values between 1 and 9 */
-    return -1;
-  }
-  else
-   if ( c < 48 || c > 57  ) /* 0 also */
-    return -1;
- }
- return 1;
+    unsigned i;
+    char c;
+
+    for ( i = 0; i < strlen(str); i++)
+    {
+	c = str[i];
+	if ( i==0 )
+	{
+	    if ( c < 49 || c > 57  ) /* ascii values between 1 and 9 */
+		return -1;
+	}
+	else
+	    if ( c < 48 || c > 57  ) /* 0 also */
+		return -1;
+    }
+    return 1;
 }
 
 /*-------------------------------------------------------------------------
@@ -284,23 +401,23 @@ int check_n_input( const char *str )
  *
  *-------------------------------------------------------------------------
  */
-static 
+    static 
 int check_f_input( const char *str )
 {
- double x;
+    double x;
 
- /* 
- the atof return value on a hexadecimal input is different 
- on some systems; we do a character check for this
- */
- if (strlen(str)>2 && str[0]=='0' && str[1]=='x')
-  return -1;
- 
- x=atof(str);
- if (x==0)
-  return -1;
-
- return 1;
+    /* 
+       the atof return value on a hexadecimal input is different 
+       on some systems; we do a character check for this
+     */
+    if (strlen(str)>2 && str[0]=='0' && str[1]=='x')
+	return -1;
+
+    x=atof(str);
+    if (x==0)
+	return -1;
+
+    return 1;
 }
 
 /*-------------------------------------------------------------------------
@@ -312,57 +429,57 @@ int check_f_input( const char *str )
  *
  *-------------------------------------------------------------------------
  */
-static 
+    static 
 void usage(void)
 {
- printf("Usage: h5diff file1 file2 [OPTIONS] [obj1[obj2]] \n");
- printf("\n");
- printf("file1             File name of the first HDF5 file\n");
- printf("file2             File name of the second HDF5 file\n");
- printf("[obj1]            Name of an HDF5 object, in absolute path\n");
- printf("[obj2]            Name of an HDF5 object, in absolute path\n");
- printf("[OPTIONS] are:\n");
- printf("[-h]              Print out this information\n");
- printf("[-r]              Report mode. Print the differences\n");
- printf("[-v]              Verbose mode. Print the differences, list of objects, warnings\n");
- printf("[-q]              Quiet mode. Do not do output\n");
- printf("[-n count]        Print difference up to count number\n");
- printf("[-d delta]        Print difference when it is greater than limit delta\n");
- printf("[-p relative]     Print difference when it is greater than a relative limit\n");
- printf("\n");
- printf("Items in [] are optional\n");
- printf("[obj1] and [obj2] are HDF5 objects (datasets, groups or datatypes)\n");
- printf("The 'count' value must be a positive integer\n");
- printf("The 'delta' and 'relative' values must be positive numbers\n");
- printf("The -d compare criteria is |a - b| > delta\n");
- printf("The -p compare criteria is |1 - b/a| > relative\n");
- printf("\n");
- printf("h5diff has four modes of output:\n");
- printf(" Normal mode: print the number of differences found and where they occured\n");
- printf(" Report mode: print the above plus the differences\n");
- printf(" Verbose mode: print the above plus a list of objects and warnings\n");
- printf(" Quiet mode: do not print output (h5diff always returns an exit code of 1 when differences are found)\n");
- printf("\n");
- printf("Examples of use:\n");
- printf("\n");
- printf("1) h5diff file1 file2 /g1/dset1 /g1/dset2\n");
- printf("\n");
- printf("   Compares object '/g1/dset1' in file1 with '/g1/dset2' in file2\n");
- printf("\n");
- printf("2) h5diff file1 file2 /g1/dset1\n");
- printf("\n");
- printf("   Compares object '/g1/dset1' in both files\n");
- printf("\n");
- printf("3) h5diff file1 file2\n");
- printf("\n");
- printf("   Compares all objects in both files\n");
- printf("\n");
- printf("Note)  file1 and file2 can be the same file. Use\n");
- printf("\n");
- printf("   h5diff file1 file1 /g1/dset1 /g1/dset2\n");
- printf("\n");
- printf("   to compare '/g1/dset1' and '/g1/dset2' in the same file\n");
- exit(0);
+    printf("Usage: h5diff file1 file2 [OPTIONS] [obj1[obj2]] \n");
+    printf("\n");
+    printf("file1             File name of the first HDF5 file\n");
+    printf("file2             File name of the second HDF5 file\n");
+    printf("[obj1]            Name of an HDF5 object, in absolute path\n");
+    printf("[obj2]            Name of an HDF5 object, in absolute path\n");
+    printf("[OPTIONS] are:\n");
+    printf("[-h]              Print out this information\n");
+    printf("[-r]              Report mode. Print the differences\n");
+    printf("[-v]              Verbose mode. Print the differences, list of objects, warnings\n");
+    printf("[-q]              Quiet mode. Do not do output\n");
+    printf("[-n count]        Print difference up to count number\n");
+    printf("[-d delta]        Print difference when it is greater than limit delta\n");
+    printf("[-p relative]     Print difference when it is greater than a relative limit\n");
+    printf("\n");
+    printf("Items in [] are optional\n");
+    printf("[obj1] and [obj2] are HDF5 objects (datasets, groups or datatypes)\n");
+    printf("The 'count' value must be a positive integer\n");
+    printf("The 'delta' and 'relative' values must be positive numbers\n");
+    printf("The -d compare criteria is |a - b| > delta\n");
+    printf("The -p compare criteria is |1 - b/a| > relative\n");
+    printf("\n");
+    printf("h5diff has four modes of output:\n");
+    printf(" Normal mode: print the number of differences found and where they occured\n");
+    printf(" Report mode: print the above plus the differences\n");
+    printf(" Verbose mode: print the above plus a list of objects and warnings\n");
+    printf(" Quiet mode: do not print output (h5diff always returns an exit code of 1 when differences are found)\n");
+    printf("\n");
+    printf("Examples of use:\n");
+    printf("\n");
+    printf("1) h5diff file1 file2 /g1/dset1 /g1/dset2\n");
+    printf("\n");
+    printf("   Compares object '/g1/dset1' in file1 with '/g1/dset2' in file2\n");
+    printf("\n");
+    printf("2) h5diff file1 file2 /g1/dset1\n");
+    printf("\n");
+    printf("   Compares object '/g1/dset1' in both files\n");
+    printf("\n");
+    printf("3) h5diff file1 file2\n");
+    printf("\n");
+    printf("   Compares all objects in both files\n");
+    printf("\n");
+    printf("Note)  file1 and file2 can be the same file. Use\n");
+    printf("\n");
+    printf("   h5diff file1 file1 /g1/dset1 /g1/dset2\n");
+    printf("\n");
+    printf("   to compare '/g1/dset1' and '/g1/dset2' in the same file\n");
+    exit(0);
 }
 
 
diff --git a/tools/h5diff/testh5diff.sh b/tools/h5diff/testh5diff.sh
index 91a2eb5..f8e70d7 100755
--- a/tools/h5diff/testh5diff.sh
+++ b/tools/h5diff/testh5diff.sh
@@ -47,6 +47,9 @@ TESTING() {
 # non-zero value.
 #
 TOOLTEST() {
+   if test -n "$RUNPARALLEL"; then
+	echo $* SKIPPED
+   else
    expect="$srcdir/../testfiles/$1"
    actual="../testfiles/`basename $1 .txt`.out"
    actual_err="../testfiles/`basename $1 .txt`.err"
@@ -86,6 +89,7 @@ TOOLTEST() {
      if test -z "$HDF5_NOCLEANUP"; then
      rm -f $actual $actual_err
      fi
+   fi
 }
 
 ##############################################################################