Changeset 17364 in josm for trunk/src/org/openstreetmap/josm/data

Timestamp:

2020-11-26T22:24:27+01:00 (3 years ago)

Author:

simon04

Message:

see #20141 - ImageProvider: cache rendered SVG images using JCS

This experimental feature is disabled by default. Set the advanced preference jcs.cache.use_image_resource_cache=true to enable. No cache eviction for altered images is implemented at the moment.

File:

• trunk/src/org/openstreetmap/josm/data/cache/JCSCacheManager.java (modified) (6 diffs)

trunk/src/org/openstreetmap/josm/data/cache/JCSCacheManager.java

@@ -31 +31 @@
 import org.openstreetmap.josm.data.preferences.IntegerProperty;
 import org.openstreetmap.josm.spi.preferences.Config;
+import org.openstreetmap.josm.tools.ImageResource;
 import org.openstreetmap.josm.tools.Logging;
 import org.openstreetmap.josm.tools.Utils;
@@ -45 +46 @@
     private static final String PREFERENCE_PREFIX = "jcs.cache";
     public static final BooleanProperty USE_BLOCK_CACHE = new BooleanProperty(PREFERENCE_PREFIX + ".use_block_cache", true);
+
+    /**
+     * The preference key {@code jcs.cache.use_image_resource_cache} controls the caching mechanism used for {@link ImageResource}.
+     * If set to {@code true}, a combined memory/disk is used. Otherwise, an in-memory-cache is used.
+     */
+    public static final BooleanProperty USE_IMAGE_RESOURCE_CACHE = new BooleanProperty(PREFERENCE_PREFIX + ".use_image_resource_cache", false);
 
     private static final AuxiliaryCacheFactory DISK_CACHE_FACTORY =
@@ -171 +178 @@
      * @return cache access object
      */
+    public static <K, V> CacheAccess<K, V> getCache(String cacheName, int maxMemoryObjects, int maxDiskObjects, String cachePath) {
+        return getCache(cacheName, maxMemoryObjects, maxDiskObjects, cachePath, USE_BLOCK_CACHE.get() ? 4096 : 0);
+    }
+
     @SuppressWarnings("unchecked")
-    public static <K, V> CacheAccess<K, V> getCache(String cacheName, int maxMemoryObjects, int maxDiskObjects, String cachePath) {
+    private static <K, V> CacheAccess<K, V> getCache(String cacheName, int maxMemoryObjects, int maxDiskObjects,
+                                                     String cachePath, int blockSizeBytes) {
         CacheAccess<K, V> cacheAccess = JCS.getInstance(cacheName, getCacheAttributes(maxMemoryObjects));
         CompositeCache<K, V> cc = cacheAccess.getCacheControl();
 
         if (cachePath != null && cacheDirLock != null) {
-            IDiskCacheAttributes diskAttributes = getDiskCacheAttributes(maxDiskObjects, cachePath, cacheName);
+            IDiskCacheAttributes diskAttributes = getDiskCacheAttributes(maxDiskObjects, cachePath, cacheName, blockSizeBytes);
+            Logging.debug("Setting up cache: {0}", diskAttributes);
             try {
                 if (cc.getAuxCaches().length == 0) {
@@ -193 +206 @@
 
     /**
+     * Returns a cache for {@link ImageResource}
+     * @param <K> key type
+     * @param <V> value type
+     * @return cache access object
+     */
+    public static <K, V> CacheAccess<K, V> getImageResourceCache() {
+        if (!USE_IMAGE_RESOURCE_CACHE.get()) {
+            return getCache("images", 16 * 1024, 0, null);
+        }
+        String cachePath = new File(Config.getDirs().getCacheDirectory(true), "images").getAbsolutePath();
+        Logging.warn("Using experimental disk cache {0} for ImageResource", cachePath);
+        return getCache("images", 16 * 1024, 512 * 1024, cachePath, 1024);
+    }
+
+    /**
      * Close all files to ensure, that all indexes and data are properly written
      */
@@ -199 +227 @@
     }
 
-    private static IDiskCacheAttributes getDiskCacheAttributes(int maxDiskObjects, String cachePath, String cacheName) {
+    private static IDiskCacheAttributes getDiskCacheAttributes(int maxDiskObjects, String cachePath, String cacheName, int blockSizeBytes) {
         IDiskCacheAttributes ret;
-        removeStaleFiles(cachePath + File.separator + cacheName, USE_BLOCK_CACHE.get() ? "_INDEX_v2" : "_BLOCK_v2");
-        String newCacheName = cacheName + (USE_BLOCK_CACHE.get() ? "_BLOCK_v2" : "_INDEX_v2");
-
-        if (USE_BLOCK_CACHE.get()) {
+        boolean isBlockDiskCache = blockSizeBytes > 0;
+        removeStaleFiles(cachePath + File.separator + cacheName, isBlockDiskCache ? "_INDEX_v2" : "_BLOCK_v2");
+        String newCacheName = cacheName + (isBlockDiskCache ? "_BLOCK_v2" : "_INDEX_v2");
+
+        if (isBlockDiskCache) {
             BlockDiskCacheAttributes blockAttr = new BlockDiskCacheAttributes();
             /*
@@ -218 +247 @@
                 blockAttr.setMaxKeySize(maxDiskObjects);
             }
-            blockAttr.setBlockSizeBytes(4096); // use 4k blocks
+            blockAttr.setBlockSizeBytes(blockSizeBytes);
             ret = blockAttr;
         } else {