Final merge of page buffering branch to develop

1 files changed, 200 insertions, 55 deletions

diff --git a/tools/src/misc/h5clear.c b/tools/src/misc/h5clear.c
index 481c6db..b6c6ea3 100644
--- a/tools/src/misc/h5clear.c
+++ b/tools/src/misc/h5clear.c
@@ -14,11 +14,10 @@
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
 /*
- * Programmer:
- *
- * Purpose:
+ * Purpose: A tool to clear the status_flags field from the file's superblock via -s option.
+ *          A tool to remove cache image from the file via -m option.
+ *          
  */
-
 #include "hdf5.h"
 #include "H5private.h"
 #include "h5tools.h"
@@ -30,59 +29,171 @@
 /* Make this private property (defined in H5Fprivate.h) available to h5clear. */
 #define H5F_ACS_CLEAR_STATUS_FLAGS_NAME            "clear_status_flags"
 
+static char *fname_g = NULL;
+static hbool_t clear_status_flags = FALSE;
+static hbool_t remove_cache_image = FALSE;
+
+/*
+ * Command-line options: The user can specify short or long-named
+ * parameters.
+ */
+static const char *s_opts = "hVsm";
+static struct long_options l_opts[] = {
+        { "help", no_arg, 'h' },
+        { "hel", no_arg, 'h'},
+        { "he", no_arg, 'h'},
+        { "version", no_arg, 'V' },
+        { "version", no_arg, 'V' },
+        { "versio", no_arg, 'V' },
+        { "versi", no_arg, 'V' },
+        { "vers", no_arg, 'V' },
+        { "status", no_arg, 's' },
+        { "statu", no_arg, 's' },
+        { "stat", no_arg, 's' },
+        { "sta", no_arg, 's' },
+        { "st", no_arg, 's' },
+        { "image", no_arg, 'm' },
+        { "imag", no_arg, 'm' },
+        { "ima", no_arg, 'm' },
+        { "im", no_arg, 'm' },
+        { NULL, 0, '\0' }
+};
+
+
+
 /*-------------------------------------------------------------------------
- * Function:    leave
+ * Function:    usage
  *
- * Purpose:     Close the tools library and exit
+ * Purpose:     Prints a usage message
  *
- * Return:       Does not return
+ * Return:      void
  *
  *-------------------------------------------------------------------------
  */
-static void
-leave(int ret)
+static void usage(const char *prog)
 {
-    h5tools_close();
-    HDexit(ret);
-} /* leave() */
+    HDfprintf(stdout, "usage: %s [OPTIONS] file_name\n", prog);
+    HDfprintf(stdout, "  OPTIONS\n");
+    HDfprintf(stdout, "   -h, --help                Print a usage message and exit\n");
+    HDfprintf(stdout, "   -V, --version             Print version number and exit\n");
+    HDfprintf(stdout, "   -s, --status              Clear the status_flags field in the file's superblock\n");
+    HDfprintf(stdout, "   -m, --image               Remove the metadata cache image from the file\n");
+    HDfprintf(stdout, "\n");
+    HDfprintf(stdout, "Examples of use:\n");
+    HDfprintf(stdout, "\n");
+    HDfprintf(stdout, "h5clear -s file_name\n");
+    HDfprintf(stdout, "  Clear the status_flags field in the superblock of the HDF5 file <file_name>.\n");
+    HDfprintf(stdout, "\n");
+    HDfprintf(stdout, "h5clear -m file_name\n");
+    HDfprintf(stdout, "  Remove the metadata cache image from the HDF5 file <file_name>.\n");
+} /* usage() */
 
+
 /*-------------------------------------------------------------------------
- * Function:     usage
+ * Function: parse_command_line
  *
- * Purpose:     Prints a usage message
+ * Purpose: Parses command line and sets up global variable to control output
+ *
+ * Return:  Success: 0
  *
- * Return:     void
+ *          Failure: -1
  *
  *-------------------------------------------------------------------------
  */
-static void
-usage(void)
+static int
+parse_command_line(int argc, const char **argv)
 {
-    HDfprintf(stdout, "usage: h5clear filename\n");
+    int opt;
 
-} /* usage() */
+     /* no arguments */
+    if (argc == 1) {
+        usage(h5tools_getprogname());
+        h5tools_setstatus(EXIT_FAILURE);
+        goto error;
+    }
+
+    /* parse command line options */
+    while((opt = get_option(argc, argv, s_opts, l_opts)) != EOF) {
+        switch((char)opt) {
+            case 'h':
+                usage(h5tools_getprogname());
+                h5tools_setstatus(EXIT_SUCCESS);
+                goto done;
+
+            case 'V':
+                print_version(h5tools_getprogname());
+                h5tools_setstatus(EXIT_SUCCESS);
+                goto done;
+
+            case 's':
+                clear_status_flags = TRUE;
+                break;
+
+            case 'm':
+                remove_cache_image = TRUE;
+                break;
+
+            default:
+                usage(h5tools_getprogname());
+                h5tools_setstatus(EXIT_FAILURE);
+                goto error;
+        } /* end switch */
+    } /* end while */
+
+    /* check for file name to be processed */
+    if(argc <= opt_ind) {
+        error_msg("missing file name\n");
+        usage(h5tools_getprogname());
+        h5tools_setstatus(EXIT_FAILURE);
+        goto error;
+    } /* end if */
+
+    fname_g = HDstrdup(argv[opt_ind]);
+
+done:
+    return(0);
+
+error:
+    return -1;
+}
+
+/*-------------------------------------------------------------------------
+ * Function:    leave
+ *
+ * Purpose:     Close the tools library and exit
+ *
+ * Return:      Does not return
+ *
+ *-------------------------------------------------------------------------
+ */
+static void
+leave(int ret)
+{
+    h5tools_close();
+    HDexit(ret);
+} /* leave() */
 
 
 
 /*-------------------------------------------------------------------------
  * Function:    main
  *
- * Purpose:
- *
- * Return:    Success:
- *        Failure:
+ * Purpose:     To clear the status_flags field in the file's superblock (-s option).
+ *              To remove the cache image from the file (-m option).
  *
- * Programmer:
+ * Return:      Success: 0
+ *              Failure: 1
  *
  *-------------------------------------------------------------------------
  */
 int
-main (int argc, char *argv[])
+main (int argc, const char *argv[])
 {
-    char *fname;        /* File name */
-    hbool_t clear = TRUE;      /* To clear the status_flags in the file's superblock */
-    hid_t fapl = -1;           /* File access property list */
+    char *fname = NULL;    /* File name */
+    hid_t fapl = -1;       /* File access property list */
     hid_t fid = -1;        /* File ID */
+    haddr_t image_addr;
+    hsize_t image_len;
 
     h5tools_setprogname(PROGRAMNAME);
     h5tools_setstatus(EXIT_SUCCESS);
@@ -93,46 +204,80 @@ main (int argc, char *argv[])
     /* initialize h5tools lib */
     h5tools_init();
 
-    /* Check for the # of arguments */
-    if(argc != 2) {
-        usage();
-        leave(EXIT_FAILURE);
+    /* Parse command line options */
+    if(parse_command_line(argc, argv) < 0)
+        goto done;
+
+    if(fname_g == NULL)
+        goto done;
+
+    if(!clear_status_flags && !remove_cache_image) {
+        usage(h5tools_getprogname());
+        h5tools_setstatus(EXIT_FAILURE);
+        goto done;
     }
 
+    /* Duplicate the file name */
+    fname = HDstrdup(fname_g);
+
     /* Get a copy of the file access property list */
     if((fapl = H5Pcreate(H5P_FILE_ACCESS)) < 0) {
         error_msg("H5Pcreate\n");
-        leave(EXIT_FAILURE);
-    }
+        h5tools_setstatus(EXIT_FAILURE);
+        goto done;
+     }
 
-    /* Set to clear the status_flags in the file's superblock */
-    /* This is a private property used by h5clear only */
-    if(H5Pset(fapl, H5F_ACS_CLEAR_STATUS_FLAGS_NAME, &clear) < 0) {
-        error_msg("H5Pset\n");
-        leave(EXIT_FAILURE);
+    /* -s option */
+    if(clear_status_flags) { 
+        /* Set to clear the status_flags in the file's superblock */
+        /* This is a private property used by h5clear only */
+        if(H5Pset(fapl, H5F_ACS_CLEAR_STATUS_FLAGS_NAME, &clear_status_flags) < 0) {
+            error_msg("H5Pset\n");
+            h5tools_setstatus(EXIT_FAILURE);
+            goto done;
+        }
     }
 
-    /* Duplicate the file name */
-    fname = HDstrdup(argv[opt_ind]);
-
     if((fid = h5tools_fopen(fname, H5F_ACC_RDWR, fapl, NULL, NULL, (size_t)0)) < 0) {
         error_msg("h5tools_fopen\n");
-        HDfree(fname);
-        leave(EXIT_FAILURE);
+        h5tools_setstatus(EXIT_FAILURE);
+        goto done;
     }
-    HDfree(fname);
 
-    /* Close the file */
-    if(H5Fclose(fid) < 0) {
-        error_msg("H5Fclose\n");
-        leave(EXIT_FAILURE);
-    }
+    /* -m option */
+    if(remove_cache_image) { 
+        H5AC_cache_image_config_t config;
 
-    /* CLose the property list */
-    if(H5Pclose(fapl) < 0) {
-        error_msg("H5Pclose\n");
-        leave(EXIT_FAILURE);
-    }
+        /* Retrieve cache image config */
+        if((fapl = H5Fget_access_plist(fid)) < 0) {
+            error_msg("H5Fget_access_plist\n");
+            h5tools_setstatus(EXIT_FAILURE);
+            goto done;
+        }
+        config.version = H5AC__CURR_CACHE_IMAGE_CONFIG_VERSION;
+        if(H5Pget_mdc_image_config(fapl, &config) < 0) {
+            error_msg("H5Pget_mdc_image_config\n");
+            h5tools_setstatus(EXIT_FAILURE);
+            goto done;
+        }
+
+        /* Check for image */
+        if(!config.generate_image)
+            warn_msg("No cache image in the file\n");
+    } 
+
+    h5tools_setstatus(EXIT_SUCCESS);
+
+done:
+    if(fname)
+        HDfree(fname);
+    if(fname_g)
+        HDfree(fname_g);
+
+    H5E_BEGIN_TRY {
+        H5Pclose(fapl);
+        H5Fclose(fid);
+    } H5E_END_TRY
 
     leave(h5tools_getstatus());
 } /* main() */