8257234 : Add gz option to SA jmap to write a gzipped heap dump

src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot/CommandProcessor.java

@@ -1789,6 +1789,7 @@ public void doit(Tokens t) {
                      *     dumpheap gz=1 file;
                      *     dumpheap gz=1;
                      *     dumpheap file;
+                     *     dumpheap
                      */
                     if (cntTokens == 2) {
                         /* First argument is compression level, second is filename */
@@ -1800,25 +1801,25 @@ public void doit(Tokens t) {
                         }
                         /* Parse filename. */
                         filename = t.nextToken();
+                        // Don't accept filename that start with "gz=" to avoid case like
+                        // "dumpheap gz=1 gz=2"
+                        if (filename.startsWith("gz=")) {
+                            err.println("Illegal filename \" + filename + \" should not start with \"gz=\".");
+                            usage();
+                            return;
+                        }
                     } else if (cntTokens == 1) {
                         filename = option;
                         // Try to parse "gz=" option.
                         if (option.startsWith("gz=")) {
                             gzlevel = parseHeapDumpCompressionLevel(option);
                             if (gzlevel == 0) {
-                                 usage();
-                                 return;
+                                usage();
+                                return;
                             }
                             filename = "heap.bin.gz";
                         }
                     }
-                    // Don't accept filename that start with "gz=" to avoid case like
-                    // "dumpheap gz=1 gz=2"
-                    if (filename.startsWith("gz=")) {
-                        err.println("Illegal filename \" + filename + \" should not start with \"gz=\".");
-                        usage();
-                        return;
-                    }
                     try {
                         jmap.writeHeapHprofBin(filename, gzlevel);
                     } catch (Exception e) {

src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot/tools/JMap.java

@@ -50,18 +50,18 @@ public String getName() {
     }
 
     protected String getCommandFlags() {
-        return "-heap|-heap:format=b[,gz=<1-9>]|-histo|-clstats|-finalizerinfo";
+        return "-heap|-heap:format=b[,gz=<1-9>][,file=<dumpfile>]|-heap:format=x[,file=<dumpfile>]|{-histo|-clstats|-finalizerinfo";
     }
 
     protected void printFlagsUsage() {
         System.out.println("    <no option>\tTo print same info as Solaris pmap.");
         System.out.println("    -heap\tTo print java heap summary.");
-        System.out.println("    -heap:format=b[,gz=<1-9>]\tTo dump java heap in hprof binary format.");
-        System.out.println("                             \tIf gz specified, the heap dump is written");
-        System.out.println("                             \tin gzipped format using the given compression level.");
-        System.err.println("                             \t1 (recommended) is the fastest, 9 the strongest compression.");
-        System.out.println("    -heap:format=x           \tTo dump java heap in GXL format.");
-        System.out.println("                             \tPlease be aware that \"gz\" option is not valid for heap dump in GXL format.");
+        System.out.println("    -heap:format=b[,gz=<1-9>][,file=<dumpfile>]  \tTo dump java heap in hprof binary format.");
+        System.out.println("                                                 \tIf gz specified, the heap dump is written");
+        System.out.println("                                                 \tin gzipped format using the given compression level.");
+        System.err.println("                                                 \t1 (recommended) is the fastest, 9 the strongest compression.");
+        System.out.println("    -heap:format=x[,file=<dumpfile>]             \tTo dump java heap in GXL format.");
+        System.out.println("                                                 \tPlease be aware that \"gz\" option is not valid for heap dump in GXL format.");
         System.out.println("    -histo\tTo print histogram of java object heap.");
         System.out.println("    -clstats\tTo print class loader statistics.");
         System.out.println("    -finalizerinfo\tTo print information on objects awaiting finalization.");

src/jdk.jcmd/share/classes/sun/tools/jmap/JMap.java

@@ -227,7 +227,7 @@ private static void dump(String pid, String options)
                 // ignore format (not needed at this time)
             } else if (subopt.startsWith("gz=")) {
                compress_level = subopt.substring("gz=".length());
-               if (compress_level == null) {
+               if (compress_level == null || compress_level.length() == 0) {
                     System.err.println("Fail: no number provided in option: '" + subopt + "'");
                     usage(1);
                }

test/jdk/sun/tools/jmap/BasicJMapTest.java

@@ -118,6 +118,7 @@ public static void main(String[] args) throws Exception {
         testDumpLive();
         testDumpAll();
         testDumpCompressed();
+        testDumpIllegalCompressedArgs();
     }
 
     private static void testHisto() throws Exception {
@@ -230,7 +231,23 @@ private static void testDumpCompressed() throws Exception {
         dump(true, false, true);
     }
 
+    private static void testDumpIllegalCompressedArgs() throws Exception{
+        dump(true, false, true, "0", 1, "Compression level out of range");
+        dump(true, false, true, "100", 1, "Compression level out of range");
+        dump(true, false, true, "abc", 1, "Invalid compress level");
+        dump(true, false, true, "", 1, "Fail: no number provided in option:");
+    }
+
     private static void dump(boolean live, boolean explicitAll, boolean compressed) throws Exception {
+        dump(live, explicitAll, compressed, "1", 0, "Heap dump file created");
+    }
+
+    private static void dump(boolean live,
+                             boolean explicitAll,
+                             boolean compressed,
+                             String compressLevel,
+                             int expExitValue,
+                             String expOutput) throws Exception {
         String liveArg = "";
         String fileArg = "";
         String compressArg = "";
@@ -248,22 +265,24 @@ private static void dump(boolean live, boolean explicitAll, boolean compressed)
 
         String filePath = "jmap.dump" + System.currentTimeMillis() + ".hprof";
         if (compressed) {
-            compressArg = "gz=1,";
+            compressArg = "gz=" + compressLevel;
             filePath = filePath + ".gz";
         }
 
         File file = new File(filePath);
         if (file.exists()) {
             file.delete();
         }
-        fileArg = "file=" + file.getName();
+        fileArg = "file=" + file.getName() + ",";
 
         OutputAnalyzer output;
-        allArgs = allArgs + liveArg + compressArg + "format=b," + fileArg;
+        allArgs = allArgs + liveArg + "format=b," + fileArg + compressArg;
         output = jmap(allArgs);
-        output.shouldHaveExitValue(0);
-        output.shouldContain("Heap dump file created");
-        verifyDumpFile(file);
+        output.shouldHaveExitValue(expExitValue);
+        output.shouldContain(expOutput);
+        if (expExitValue == 0) {
+            verifyDumpFile(file);
+        }
         file.delete();
     }