src/mapcache.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24
  25 #include <glib.h>
  26 #include <glib/gi18n.h>
  27 #include <string.h>
  28 #include "globals.h"
  29 #include "mapcache.h"
  30 #include "preferences.h"
  31
  32 typedef struct _List {
  33   struct _List *next;
  34   gchar *key;
  35 } List;
  36
  37 /* a circular linked list, a pointer to the tail, and the tail points to the head */
  38 /* this is so we can free the last */
  39 static List *queue_tail = NULL;
  40 static int queue_count = 0;
  41
  42 static guint32 cache_size = 0;
  43 static guint32 max_cache_size = VIK_CONFIG_MAPCACHE_SIZE * 1024 * 1024;
  44
  45 static GHashTable *cache = NULL;
  46
  47 static GMutex *mc_mutex = NULL;
  48
  49 #define HASHKEY_FORMAT_STRING "%d-%d-%d-%d-%d-%d-%d-%.3f-%.3f"
  50 #define HASHKEY_FORMAT_STRING_NOSHRINK_NOR_ALPHA "%d-%d-%d-%d-%d-%d-"
  51
  52 static VikLayerParamScale params_scales[] = {
  53   /* min, max, step, digits (decimal places) */
  54  { 1, 1024, 1, 0 },
  55 };
  56
  57 static VikLayerParam prefs[] = {
  58   { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_NAMESPACE "mapcache_size", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Map cache memory size (MB):"), VIK_LAYER_WIDGET_HSCALE, params_scales, NULL, NULL, NULL, NULL, NULL },
  59 };
  60
  61 void a_mapcache_init ()
  62 {
  63   VikLayerParamData tmp;
  64   tmp.u = VIK_CONFIG_MAPCACHE_SIZE;
  65   a_preferences_register(prefs, tmp, VIKING_PREFERENCES_GROUP_KEY);
  66
  67   mc_mutex = g_mutex_new();
  68   cache = g_hash_table_new_full ( g_str_hash, g_str_equal, g_free, g_object_unref );
  69 }
  70
  71 static void cache_add(gchar *key, GdkPixbuf *pixbuf)
  72 {
  73 #if !GLIB_CHECK_VERSION(2,26,0)
  74   // Only later versions of GLib actually return a value for this function
  75   // Annoyingly the documentation doesn't say anything about this interface change :(
  76   if ( g_hash_table_insert ( cache, key, pixbuf ) )
  77 #else
  78   g_hash_table_insert ( cache, key, pixbuf );
  79 #endif
  80   {
  81     cache_size += gdk_pixbuf_get_rowstride(pixbuf) * gdk_pixbuf_get_height(pixbuf);
  82     cache_size += 100;
  83   }
  84 }
  85
  86 static void cache_remove(const gchar *key)
  87 {
  88   GdkPixbuf *buf = g_hash_table_lookup ( cache, key );
  89   if (buf) {
  90     cache_size -= gdk_pixbuf_get_rowstride(buf) * gdk_pixbuf_get_height(buf);
  91     cache_size -= 100;
  92     g_hash_table_remove ( cache, key );
  93   }
  94 }
  95
  96 /* returns key from head, adds on newtailkey to tail. */
  97 static gchar *list_shift_add_entry ( gchar *newtailkey )
  98 {
  99   gchar *oldheadkey = queue_tail->next->key;
 100   queue_tail->next->key = newtailkey;
 101   queue_tail = queue_tail->next;
 102   return oldheadkey;
 103 }
 104
 105 static gchar *list_shift ()
 106 {
 107   gchar *oldheadkey = queue_tail->next->key;
 108   List *oldhead = queue_tail->next;
 109   queue_tail->next = queue_tail->next->next;
 110   g_free ( oldhead );
 111   queue_count--;
 112   return oldheadkey;
 113 }
 114
 115 /* adds key to tail */
 116 static void list_add_entry ( gchar *key )
 117 {
 118   List *newlist = g_malloc ( sizeof ( List ) );
 119   newlist->key = key;
 120   if ( queue_tail ) {
 121     newlist->next = queue_tail->next;
 122     queue_tail->next = newlist;
 123     queue_tail = newlist;
 124   } else {
 125     newlist->next = newlist;
 126     queue_tail = newlist;
 127   }
 128   queue_count++;
 129 }
 130
 131 void a_mapcache_add ( GdkPixbuf *pixbuf, gint x, gint y, gint z, guint16 type, gint zoom, guint8 alpha, gdouble xshrinkfactor, gdouble yshrinkfactor, const gchar* name )
 132 {
 133   guint nn = name ? g_str_hash ( name ) : 0;
 134   gchar *key = g_strdup_printf ( HASHKEY_FORMAT_STRING, x, y, z, type, zoom, nn, alpha, xshrinkfactor, yshrinkfactor );
 135
 136   g_mutex_lock(mc_mutex);
 137   cache_add(key, pixbuf);
 138
 139   // TODO: that should be done on preference change only...
 140   max_cache_size = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "mapcache_size")->u * 1024 * 1024;
 141
 142   if ( cache_size > max_cache_size ) {
 143     if ( queue_tail ) {
 144       gchar *oldkey = list_shift_add_entry ( key );
 145       cache_remove(oldkey);
 146
 147       while ( cache_size > max_cache_size &&
 148              (queue_tail->next != queue_tail) ) { /* make sure there's more than one thing to delete */
 149         oldkey = list_shift ();
 150         cache_remove(oldkey);
 151       }
 152     }
 153     /* chop off 'start' etc */
 154   } else {
 155     list_add_entry ( key );
 156     /* business as usual */
 157   }
 158   g_mutex_unlock(mc_mutex);
 159
 160   static int tmp = 0;
 161   if ( (++tmp == 100 )) { g_debug("DEBUG: cache count=%d size=%u list count=%d\n", g_hash_table_size(cache), cache_size, queue_count ); tmp=0; }
 162 }
 163
 164 GdkPixbuf *a_mapcache_get ( gint x, gint y, gint z, guint16 type, gint zoom, guint8 alpha, gdouble xshrinkfactor, gdouble yshrinkfactor, const gchar* name )
 165 {
 166   static char key[64];
 167   guint nn = name ? g_str_hash ( name ) : 0;
 168   g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING, x, y, z, type, zoom, nn, alpha, xshrinkfactor, yshrinkfactor );
 169   return g_hash_table_lookup ( cache, key );
 170 }
 171
 172 /**
 173  * Appears this is only used when redownloading tiles (i.e. to invalidate old images)
 174  */
 175 void a_mapcache_remove_all_shrinkfactors ( gint x, gint y, gint z, guint16 type, gint zoom )
 176 {
 177   char key[64];
 178   List *loop = queue_tail;
 179   List *tmp;
 180   gint len;
 181
 182   if ( queue_tail == NULL )
 183     return;
 184
 185   g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING_NOSHRINK_NOR_ALPHA, x, y, z, type, zoom, 0 );
 186   len = strlen(key);
 187
 188   g_mutex_lock(mc_mutex);
 189   /* TODO: check logic here */
 190   do {
 191     tmp = loop->next;
 192     if ( tmp ) {
 193     if ( strncmp(tmp->key, key, len) == 0 )
 194     {
 195       cache_remove(tmp->key);
 196       if ( tmp == loop ) /* we deleted the last thing in the queue! */
 197         loop = queue_tail = NULL;
 198       else {
 199         loop->next = tmp->next;
 200         if ( tmp == queue_tail )
 201           queue_tail = tmp->next;
 202       }
 203       g_free ( tmp );
 204       tmp = NULL;
 205       queue_count--;
 206     }
 207     else
 208       loop = tmp;
 209     } else
 210       loop = NULL;
 211   } while ( loop && (loop != queue_tail || tmp == NULL) );
 212
 213   /* loop thru list, looking for the one, compare first whatever chars */
 214   cache_remove(key);
 215   g_mutex_unlock(mc_mutex);
 216 }
 217
 218 void a_mapcache_flush ()
 219 {
 220   List *loop = queue_tail;
 221   List *tmp;
 222
 223   if ( queue_tail == NULL )
 224     return;
 225
 226   g_mutex_lock(mc_mutex);
 227   do {
 228     tmp = loop->next;
 229     cache_remove(tmp->key);
 230     if ( tmp == queue_tail ) /* we deleted the last thing in the queue */
 231       loop = queue_tail = NULL;
 232     else
 233       loop->next = tmp->next;
 234     g_free ( tmp );
 235     tmp = NULL;
 236   } while ( loop );
 237
 238   g_mutex_unlock(mc_mutex);
 239 }
 240
 241 void a_mapcache_uninit ()
 242 {
 243   g_hash_table_destroy ( cache );
 244   /* free list */
 245   cache = NULL;
 246 }
 247
 248 // Size of mapcache in memory
 249 gint a_mapcache_get_size ()
 250 {
 251   return cache_size;
 252 }
 253
 254 // Count of items in the mapcache
 255 gint a_mapcache_get_count ()
 256 {
 257   return g_hash_table_size ( cache );
 258 }