do not load dirty cache; prevent loading cache created on different OS; prevent loading cache for different heap dump

Author: thurka

visualvm/libs.profiler/lib.profiler/src/org/graalvm/visualvm/lib/jfluid/heap/CacheDirectory.java

@@ -51,6 +51,7 @@ class CacheDirectory {
 
     private static final String DIR_EXT = ".hwcache";   // NOI18N
     private static final String DUMP_AUX_FILE = "NBProfiler.nphd";   // NOI18N
+    private static final String DIRTY_FILENAME = "dirty.lck";   // NOI18N
 
     private File cacheDirectory;
 
@@ -122,6 +123,36 @@ File getHeapFile(String fileName) throws FileNotFoundException {
         throw new FileNotFoundException(fileName);        
     }
 
+    void deleteAllCachedFiles() {
+        assert !isTemporary();
+        for (File f : cacheDirectory.listFiles()) {
+            f.delete();
+        }
+    }
+
+    boolean isDirty() {
+        if (isTemporary()) return true;
+        File dirtyFile = new File(cacheDirectory,DIRTY_FILENAME);
+        return isFileR(dirtyFile);
+    }
+
+    void setDirty(boolean dirty) {
+        if (!isTemporary()) {
+            File dirtyFile = new File(cacheDirectory, DIRTY_FILENAME);
+            try {
+                if (dirty) {
+                    assert !isFileR(dirtyFile);
+                    dirtyFile.createNewFile();
+                } else {
+                    assert isFileRW(dirtyFile);
+                    dirtyFile.delete();
+                }
+            } catch (IOException ex) {
+                ex.printStackTrace();
+            }
+        }
+    }
+
     private static boolean isFileR(File f) {
         return f.exists() && f.isFile() && f.canRead();
     }

visualvm/libs.profiler/lib.profiler/src/org/graalvm/visualvm/lib/jfluid/heap/HeapFactory.java

@@ -98,6 +98,7 @@ public static Heap createHeap(File heapDump, int segment)
                 } catch (IOException ex) {
                     System.err.println("Loading heap dump "+heapDump+" from cache failed.");
                     ex.printStackTrace(System.err);
+                    cacheDir.deleteAllCachedFiles();
                 }
             }
         }

visualvm/libs.profiler/lib.profiler/src/org/graalvm/visualvm/lib/jfluid/heap/HprofHeap.java

@@ -121,7 +121,8 @@ class HprofHeap implements Heap {
     private static final boolean DEBUG = false;
 
     private static final String SNAPSHOT_ID = "NBPHD";
-    private static final int SNAPSHOT_VERSION  = 2;
+    private static final int SNAPSHOT_VERSION  = 3;
+    private static final String OS_PROP = "os.name";
 
     //~ Instance fields ----------------------------------------------------------------------------------------------------------
 
@@ -347,6 +348,7 @@ void writeToFile() {
                 out = new DataOutputStream(new BufferedOutputStream(new FileOutputStream(outFile), 32768));
                 writeToStream(out);
                 out.close();
+                cacheDirectory.setDirty(false);
             } catch (IOException ex) {
                 ex.printStackTrace(System.err);
             }
@@ -357,6 +359,8 @@ void writeToStream(DataOutputStream out) throws IOException {
         out.writeUTF(SNAPSHOT_ID);
         out.writeInt(SNAPSHOT_VERSION);
         out.writeUTF(heapDumpFile.getAbsolutePath());
+        out.writeLong(dumpBuffer.getTime());
+        out.writeUTF(System.getProperty(OS_PROP));
         nearestGCRoot.writeToStream(out);
         allInstanceDumpBounds.writeToStream(out);
         heapDumpSegment.writeToStream(out);
@@ -376,6 +380,9 @@ void writeToStream(DataOutputStream out) throws IOException {
     }
 
     HprofHeap(DataInputStream dis, CacheDirectory cacheDir) throws IOException {
+        if (cacheDir.isDirty()) {
+            throw new IOException("Dirty cache "+cacheDir);
+        }
         String id = dis.readUTF();
         if (!SNAPSHOT_ID.equals(id)) {
             throw new IOException("Invalid HPROF dump id "+id);
@@ -387,6 +394,14 @@ void writeToStream(DataOutputStream out) throws IOException {
         heapDumpFile = cacheDir.getHeapFile(dis.readUTF());
         cacheDirectory = cacheDir;
         dumpBuffer = HprofByteBuffer.createHprofByteBuffer(heapDumpFile);
+        long time = dis.readLong();
+        if (time != dumpBuffer.getTime()) {
+            throw new IOException("HPROF time mismatch. Cached "+time+" from heap dump "+dumpBuffer.getTime());
+        }
+        String os = dis.readUTF();
+        if (!os.equals(System.getProperty(OS_PROP))) {
+            throw new IOException("HPROF OS mismatch. Cached "+os+" current OS "+System.getProperty(OS_PROP));
+        }
         nearestGCRoot = new NearestGCRoot(this, dis);
         allInstanceDumpBounds = new TagBounds(dis);
         heapDumpSegment = new TagBounds(dis);
@@ -523,6 +538,7 @@ void computeInstances() {
         }
 
         HeapProgress.progressStart();
+        cacheDirectory.setDirty(true);
         ClassDumpSegment classDumpBounds = getClassDumpSegment();
         int idSize = dumpBuffer.getIDSize();
         long[] offset = new long[] { allInstanceDumpBounds.startOffset };
@@ -646,6 +662,7 @@ void computeReferences() {
         Map classIdToClassMap = classDumpBounds.getClassIdToClassMap();
 
         computeInstances();
+        cacheDirectory.setDirty(true);
         for (long counter=0; offset[0] < allInstanceDumpBounds.endOffset; counter++) {
             long start = offset[0];
             int tag = readDumpTag(offset);
@@ -729,7 +746,9 @@ void computeRetainedSize() {
         if (retainedSizeComputed) {
             return;
         }
-        new TreeObject(this,nearestGCRoot.getLeaves()).computeTrees();
+        LongBuffer leaves = nearestGCRoot.getLeaves();
+        cacheDirectory.setDirty(true);
+        new TreeObject(this,leaves).computeTrees();
         domTree = new DominatorTree(this,nearestGCRoot.getMultipleParents());
         domTree.computeDominators();
         long[] offset = new long[] { allInstanceDumpBounds.startOffset };
@@ -793,6 +812,7 @@ void computeRetainedSizeByClass() {
             return;
         }
         computeRetainedSize();
+        cacheDirectory.setDirty(true);
         long[] offset = new long[] { allInstanceDumpBounds.startOffset };
 
         while (offset[0] < allInstanceDumpBounds.endOffset) {

visualvm/libs.profiler/lib.profiler/src/org/graalvm/visualvm/lib/jfluid/heap/NearestGCRoot.java

@@ -122,6 +122,7 @@ private synchronized void computeGCRoots() {
             }
         }
         heap.computeReferences(); // make sure references are computed first
+        heap.cacheDirectory.setDirty(true);
         allInstances = heap.getSummary().getTotalLiveInstances();
         Set processedClasses = new HashSet(heap.getAllClasses().size()*4/3);