Merge lp:~pbeaman/akiban-persistit/display-volume-header-info into lp:akiban-persistit

[Peter Beaman]

Add volumeinfo CLI command. Pretty-prints all the dates and other information in the volume header. Useful for diagnosing problems on client machines.

[Nathan Williams (nwilliams)]

Looks good.

review: Approve

=== modified file 'src/main/java/com/persistit/CLI.java'
--- src/main/java/com/persistit/CLI.java	2013-01-19 17:52:20 +0000
+++ src/main/java/com/persistit/CLI.java	2013-02-05 18:08:28 +0000
@@ -156,7 +156,7 @@
     private final static Map<String, Command> COMMANDS = new TreeMap<String, Command>();
 
     private final static Class<?>[] CLASSES = { CLI.class, BackupTask.class, IntegrityCheck.class, StreamSaver.class,
-            StreamLoader.class, StatisticsTask.class, TaskCheck.class };
+            StreamLoader.class, StatisticsTask.class, TaskCheck.class, VolumeHeader.class };
 
     static {
         for (final Class<?> clazz : CLASSES) {
 
=== modified file 'src/main/java/com/persistit/CheckpointManager.java'
--- src/main/java/com/persistit/CheckpointManager.java	2013-02-01 12:09:51 +0000
+++ src/main/java/com/persistit/CheckpointManager.java	2013-02-05 18:08:28 +0000
@@ -26,7 +26,6 @@
 import java.util.concurrent.atomic.AtomicBoolean;
 
 import com.persistit.Transaction.CommitPolicy;
-import com.persistit.exception.MissingThreadException;
 import com.persistit.exception.PersistitException;
 import com.persistit.exception.PersistitInterruptedException;
 import com.persistit.mxbeans.CheckpointManagerMXBean;
 
=== modified file 'src/main/java/com/persistit/VolumeHeader.java'
--- src/main/java/com/persistit/VolumeHeader.java	2012-10-05 19:37:58 +0000
+++ src/main/java/com/persistit/VolumeHeader.java	2013-02-05 18:08:28 +0000
@@ -18,11 +18,17 @@
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
+import java.io.PrintWriter;
+import java.text.SimpleDateFormat;
+import java.util.Date;
 
+import com.persistit.CLI.Arg;
+import com.persistit.CLI.Cmd;
 import com.persistit.exception.CorruptVolumeException;
 import com.persistit.exception.InvalidVolumeSpecificationException;
 import com.persistit.exception.PersistitException;
 import com.persistit.exception.PersistitIOException;
+import com.persistit.util.ArgParser;
 import com.persistit.util.Util;
 
 /**
@@ -30,7 +36,13 @@
  * volume file.
  */
 class VolumeHeader {
+
+    private final static String[] ARGS_TEMPLATE = { "path|string:|Volume file name" };
+
+    private final static SimpleDateFormat SDF = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss.SSS");
+
     /**
+     * 
      * Signature value - human and machine readable confirmation that this file
      * resulted from Persistit.
      */
@@ -355,4 +367,88 @@
         return CURRENT_VERSION;
     }
 
+    @Cmd("volumeinfo")
+    static VolumeInfoTask createTask(@Arg("file|string:|Volume file") final String file) throws Exception {
+        return new VolumeInfoTask(file);
+    }
+
+    private static class VolumeInfoTask extends Task {
+        String _volumeFileName;
+
+        private VolumeInfoTask(final String fileName) {
+            _volumeFileName = fileName;
+        }
+
+        @Override
+        protected void runTask() throws Exception {
+            final File file = new File(_volumeFileName);
+            final FileInputStream stream = new FileInputStream(file);
+            final byte[] bytes = new byte[SIZE];
+            final int readSize = stream.read(bytes);
+            stream.close();
+            if (readSize < SIZE) {
+                throw new CorruptVolumeException(String.format(
+                        "File %s of size %,d is too short to be a Volume file\n", file, readSize));
+            }
+            /*
+             * Check out the fixed Volume file and learn the buffer size.
+             */
+            if (!verifySignature(bytes)) {
+                throw new CorruptVolumeException(String.format("File %s is not a Volume file: Invalid signature", file));
+            }
+            postMessage(String.format("%30s: %s", "File", file), Task.LOG_NORMAL);
+            outn("ID", getId(bytes));
+            outn("Page size", getPageSize(bytes));
+            outd("Creation time", getCreateTime(bytes));
+            outd("Last open time", getOpenTime(bytes));
+            outd("Last extension time", getLastExtensionTime(bytes));
+            outd("Last read time", getLastReadTime(bytes));
+            outd("Last write time", getLastWriteTime(bytes));
+            outn("Global timestamp", getGlobalTimestamp(bytes));
+            outn("Timestamp", getTimestamp(bytes));
+            outn("Version", getVersion(bytes));
+
+            outn("Directory root", getDirectoryRoot(bytes));
+            outn("Garbage root", getGarbageRoot(bytes));
+            outn("Initial pages", getInitialPages(bytes));
+            outn("Next available page", getNextAvailablePage(bytes));
+            outn("Extended page count", getExtendedPageCount(bytes));
+            outn("Pages per extension", getExtensionPages(bytes));
+            outn("Maximum pages", getMaximumPages(bytes));
+
+            outn("Fetch counter", getfetchCounter(bytes));
+            outn("Get counter", getGetCounter(bytes));
+            outn("Read counter", getReadCounter(bytes));
+            outn("Remove counter", getRemoveCounter(bytes));
+            outn("Store counter", getStoreCounter(bytes));
+            outn("Traverse counter", getTraverseCounter(bytes));
+            outn("Write counter", getWriteCounter(bytes));
+
+        }
+
+        private void outd(final String legend, final long value) {
+            postMessage(String.format("%30s: %s", legend, SDF.format(new Date(value))), Task.LOG_NORMAL);
+        }
+
+        private void outn(final String legend, final long value) {
+            postMessage(String.format("%30s: %,12d", legend, value), Task.LOG_NORMAL);
+        }
+
+        @Override
+        public String getStatus() {
+            return "";
+        }
+
+    }
+
+    public static void main(final String[] args) throws Exception {
+        final ArgParser ap = new ArgParser("VolumeHeader", args, ARGS_TEMPLATE).strict();
+        if (ap.isUsageOnly()) {
+            return;
+        }
+        final Task task = new VolumeInfoTask(ap.getStringValue("path"));
+        task.setMessageWriter(new PrintWriter(System.out));
+        task.runTask();
+    }
+
 }