]>
Commit | Line | Data |
---|---|---|
50a14534 EB |
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 | */ | |
065a9ace GB |
21 | #ifdef HAVE_CONFIG_H |
22 | #include "config.h" | |
23 | #endif | |
50a14534 | 24 | |
e8518759 | 25 | #include <glib.h> |
9de4d421 | 26 | #include <glib/gi18n.h> |
50a14534 | 27 | #include <string.h> |
44b37676 | 28 | #include "globals.h" |
50a14534 | 29 | #include "mapcache.h" |
9de4d421 | 30 | #include "preferences.h" |
fc6640a9 | 31 | #include "vik_compat.h" |
50a14534 | 32 | |
9095ea4c RN |
33 | #define MC_KEY_SIZE 64 |
34 | ||
50a14534 EB |
35 | typedef struct _List { |
36 | struct _List *next; | |
37 | gchar *key; | |
38 | } List; | |
39 | ||
40 | /* a circular linked list, a pointer to the tail, and the tail points to the head */ | |
41 | /* this is so we can free the last */ | |
42 | static List *queue_tail = NULL; | |
43 | static int queue_count = 0; | |
44 | ||
e8518759 RN |
45 | static guint32 cache_size = 0; |
46 | static guint32 max_cache_size = VIK_CONFIG_MAPCACHE_SIZE * 1024 * 1024; | |
50a14534 EB |
47 | |
48 | static GHashTable *cache = NULL; | |
49 | ||
19c3c24c RN |
50 | typedef struct { |
51 | GdkPixbuf *pixbuf; | |
52 | mapcache_extra_t extra; | |
53 | } cache_item_t; | |
54 | ||
9b79169d QT |
55 | static GMutex *mc_mutex = NULL; |
56 | ||
df5b2993 | 57 | #define HASHKEY_FORMAT_STRING "%d-%d-%d-%d-%d-%d-%d-%.3f-%.3f" |
57c1c96a | 58 | #define HASHKEY_FORMAT_STRING_NOSHRINK_NOR_ALPHA "%d-%d-%d-%d-%d-%d-" |
9095ea4c | 59 | #define HASHKEY_FORMAT_STRING_TYPE "%d-" |
50a14534 | 60 | |
9de4d421 JJ |
61 | static VikLayerParamScale params_scales[] = { |
62 | /* min, max, step, digits (decimal places) */ | |
e6e277a8 | 63 | { 1, 1024, 1, 0 }, |
9de4d421 JJ |
64 | }; |
65 | ||
66 | static VikLayerParam prefs[] = { | |
63959706 | 67 | { 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 }, |
9de4d421 JJ |
68 | }; |
69 | ||
19c3c24c RN |
70 | static void cache_item_free (cache_item_t *ci) |
71 | { | |
72 | g_object_unref ( ci->pixbuf ); | |
73 | g_free ( ci ); | |
74 | } | |
75 | ||
50a14534 EB |
76 | void a_mapcache_init () |
77 | { | |
9de4d421 | 78 | VikLayerParamData tmp; |
e6e277a8 | 79 | tmp.u = VIK_CONFIG_MAPCACHE_SIZE; |
9de4d421 JJ |
80 | a_preferences_register(prefs, tmp, VIKING_PREFERENCES_GROUP_KEY); |
81 | ||
fc6640a9 | 82 | mc_mutex = vik_mutex_new (); |
19c3c24c | 83 | cache = g_hash_table_new_full ( g_str_hash, g_str_equal, g_free, (GDestroyNotify) cache_item_free ); |
50a14534 EB |
84 | } |
85 | ||
19c3c24c | 86 | static void cache_add(gchar *key, GdkPixbuf *pixbuf, mapcache_extra_t extra) |
fd4536cf | 87 | { |
19c3c24c RN |
88 | cache_item_t *ci = g_malloc ( sizeof(cache_item_t) ); |
89 | ci->pixbuf = pixbuf; | |
90 | ci->extra = extra; | |
02a5b4d7 RN |
91 | #if !GLIB_CHECK_VERSION(2,26,0) |
92 | // Only later versions of GLib actually return a value for this function | |
93 | // Annoyingly the documentation doesn't say anything about this interface change :( | |
19c3c24c | 94 | if ( g_hash_table_insert ( cache, key, ci ) ) |
02a5b4d7 | 95 | #else |
19c3c24c | 96 | g_hash_table_insert ( cache, key, ci ); |
02a5b4d7 RN |
97 | #endif |
98 | { | |
e8518759 | 99 | cache_size += gdk_pixbuf_get_rowstride(pixbuf) * gdk_pixbuf_get_height(pixbuf); |
19c3c24c RN |
100 | // ATM size of 'extra' data hardly worth trying to count (compared to pixbuf sizes) |
101 | // Not sure what this 100 represents anyway - probably a guess at an average pixbuf metadata size | |
e8518759 RN |
102 | cache_size += 100; |
103 | } | |
fd4536cf QT |
104 | } |
105 | ||
106 | static void cache_remove(const gchar *key) | |
107 | { | |
19c3c24c RN |
108 | cache_item_t *ci = g_hash_table_lookup ( cache, key ); |
109 | if (ci && ci->pixbuf) { | |
110 | cache_size -= gdk_pixbuf_get_rowstride(ci->pixbuf) * gdk_pixbuf_get_height(ci->pixbuf); | |
e8518759 RN |
111 | cache_size -= 100; |
112 | g_hash_table_remove ( cache, key ); | |
113 | } | |
fd4536cf QT |
114 | } |
115 | ||
50a14534 EB |
116 | /* returns key from head, adds on newtailkey to tail. */ |
117 | static gchar *list_shift_add_entry ( gchar *newtailkey ) | |
118 | { | |
119 | gchar *oldheadkey = queue_tail->next->key; | |
120 | queue_tail->next->key = newtailkey; | |
121 | queue_tail = queue_tail->next; | |
122 | return oldheadkey; | |
123 | } | |
124 | ||
125 | static gchar *list_shift () | |
126 | { | |
127 | gchar *oldheadkey = queue_tail->next->key; | |
128 | List *oldhead = queue_tail->next; | |
129 | queue_tail->next = queue_tail->next->next; | |
130 | g_free ( oldhead ); | |
e8518759 | 131 | queue_count--; |
50a14534 EB |
132 | return oldheadkey; |
133 | } | |
134 | ||
135 | /* adds key to tail */ | |
136 | static void list_add_entry ( gchar *key ) | |
137 | { | |
138 | List *newlist = g_malloc ( sizeof ( List ) ); | |
139 | newlist->key = key; | |
140 | if ( queue_tail ) { | |
141 | newlist->next = queue_tail->next; | |
142 | queue_tail->next = newlist; | |
143 | queue_tail = newlist; | |
144 | } else { | |
145 | newlist->next = newlist; | |
146 | queue_tail = newlist; | |
147 | } | |
e8518759 | 148 | queue_count++; |
50a14534 EB |
149 | } |
150 | ||
38597a6d SB |
151 | /** |
152 | * Function increments reference counter of pixbuf. | |
153 | * Caller may (and should) decrease it's reference. | |
154 | */ | |
19c3c24c | 155 | void a_mapcache_add ( GdkPixbuf *pixbuf, mapcache_extra_t extra, gint x, gint y, gint z, guint16 type, gint zoom, guint8 alpha, gdouble xshrinkfactor, gdouble yshrinkfactor, const gchar* name ) |
50a14534 | 156 | { |
4cf4c9ea RN |
157 | if ( ! GDK_IS_PIXBUF(pixbuf) ) { |
158 | g_debug ( "Not caching corrupt pixbuf for maptype %d at %d %d %d %d", type, x, y, z, zoom ); | |
159 | return; | |
160 | } | |
161 | ||
df5b2993 | 162 | guint nn = name ? g_str_hash ( name ) : 0; |
9095ea4c | 163 | gchar *key = g_strdup_printf ( HASHKEY_FORMAT_STRING, type, x, y, z, zoom, nn, alpha, xshrinkfactor, yshrinkfactor ); |
50a14534 | 164 | |
9b79169d | 165 | g_mutex_lock(mc_mutex); |
38597a6d | 166 | g_object_ref(pixbuf); |
19c3c24c | 167 | cache_add(key, pixbuf, extra); |
50a14534 | 168 | |
9de4d421 | 169 | // TODO: that should be done on preference change only... |
e8518759 | 170 | max_cache_size = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "mapcache_size")->u * 1024 * 1024; |
9de4d421 | 171 | |
e8518759 | 172 | if ( cache_size > max_cache_size ) { |
df05b6e9 RN |
173 | if ( queue_tail ) { |
174 | gchar *oldkey = list_shift_add_entry ( key ); | |
fd4536cf | 175 | cache_remove(oldkey); |
50a14534 | 176 | |
e8518759 | 177 | while ( cache_size > max_cache_size && |
df05b6e9 RN |
178 | (queue_tail->next != queue_tail) ) { /* make sure there's more than one thing to delete */ |
179 | oldkey = list_shift (); | |
180 | cache_remove(oldkey); | |
181 | } | |
182 | } | |
50a14534 EB |
183 | /* chop off 'start' etc */ |
184 | } else { | |
185 | list_add_entry ( key ); | |
186 | /* business as usual */ | |
187 | } | |
9b79169d | 188 | g_mutex_unlock(mc_mutex); |
50a14534 | 189 | |
a3040a49 RN |
190 | static int tmp = 0; |
191 | 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; } | |
50a14534 EB |
192 | } |
193 | ||
38597a6d SB |
194 | /** |
195 | * Function increases reference counter of pixels buffer in behalf of caller. | |
196 | * Caller have to decrease references counter, when buffer is no longer needed. | |
197 | */ | |
b7464e99 | 198 | GdkPixbuf *a_mapcache_get ( gint x, gint y, gint z, guint16 type, gint zoom, guint8 alpha, gdouble xshrinkfactor, gdouble yshrinkfactor, const gchar* name ) |
50a14534 | 199 | { |
9095ea4c | 200 | static char key[MC_KEY_SIZE]; |
df5b2993 | 201 | guint nn = name ? g_str_hash ( name ) : 0; |
9095ea4c | 202 | g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING, type, x, y, z, zoom, nn, alpha, xshrinkfactor, yshrinkfactor ); |
38597a6d | 203 | g_mutex_lock(mc_mutex); /* prevent returning pixbuf when cache is being cleared */ |
19c3c24c | 204 | cache_item_t *ci = g_hash_table_lookup ( cache, key ); |
38597a6d SB |
205 | if ( ci ) { |
206 | g_object_ref(ci->pixbuf); | |
207 | g_mutex_unlock(mc_mutex); | |
19c3c24c | 208 | return ci->pixbuf; |
38597a6d SB |
209 | } else { |
210 | g_mutex_unlock(mc_mutex); | |
19c3c24c | 211 | return NULL; |
38597a6d | 212 | } |
19c3c24c RN |
213 | } |
214 | ||
215 | mapcache_extra_t a_mapcache_get_extra ( gint x, gint y, gint z, guint16 type, gint zoom, guint8 alpha, gdouble xshrinkfactor, gdouble yshrinkfactor, const gchar* name ) | |
216 | { | |
217 | static char key[MC_KEY_SIZE]; | |
218 | guint nn = name ? g_str_hash ( name ) : 0; | |
219 | g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING, type, x, y, z, zoom, nn, alpha, xshrinkfactor, yshrinkfactor ); | |
220 | cache_item_t *ci = g_hash_table_lookup ( cache, key ); | |
221 | if ( ci ) | |
222 | return ci->extra; | |
223 | else | |
224 | return (mapcache_extra_t) { 0.0 }; | |
50a14534 EB |
225 | } |
226 | ||
df5b2993 | 227 | /** |
9095ea4c | 228 | * Common function to remove cache items for keys starting with the specified string |
df5b2993 | 229 | */ |
9095ea4c | 230 | static void flush_matching ( gchar *str ) |
50a14534 | 231 | { |
44d67e01 SB |
232 | g_mutex_lock(mc_mutex); |
233 | ||
234 | if ( queue_tail == NULL ) { | |
235 | g_mutex_unlock(mc_mutex); | |
50a14534 | 236 | return; |
44d67e01 | 237 | } |
50a14534 | 238 | |
44d67e01 SB |
239 | // The 'loop' variable must be assigned within the mutex lock section, |
240 | // otherwise where it points to might not be valid anymore when the actual processing occurs | |
9095ea4c RN |
241 | List *loop = queue_tail; |
242 | List *tmp; | |
243 | gint len = strlen(str); | |
50a14534 | 244 | |
50a14534 EB |
245 | do { |
246 | tmp = loop->next; | |
2ae6f542 | 247 | if ( tmp ) { |
9095ea4c | 248 | if ( strncmp(tmp->key, str, len) == 0 ) |
50a14534 | 249 | { |
fd4536cf | 250 | cache_remove(tmp->key); |
093c5c71 | 251 | if ( tmp == loop ) /* we deleted the last thing in the queue! */ |
50a14534 | 252 | loop = queue_tail = NULL; |
093c5c71 | 253 | else { |
50a14534 | 254 | loop->next = tmp->next; |
093c5c71 EB |
255 | if ( tmp == queue_tail ) |
256 | queue_tail = tmp->next; | |
257 | } | |
50a14534 EB |
258 | g_free ( tmp ); |
259 | tmp = NULL; | |
e8518759 | 260 | queue_count--; |
50a14534 EB |
261 | } |
262 | else | |
263 | loop = tmp; | |
2ae6f542 RN |
264 | } else |
265 | loop = NULL; | |
50a14534 | 266 | } while ( loop && (loop != queue_tail || tmp == NULL) ); |
50a14534 | 267 | /* loop thru list, looking for the one, compare first whatever chars */ |
9095ea4c RN |
268 | |
269 | cache_remove(str); | |
9b79169d | 270 | g_mutex_unlock(mc_mutex); |
50a14534 EB |
271 | } |
272 | ||
9095ea4c RN |
273 | /** |
274 | * Appears this is only used when redownloading tiles (i.e. to invalidate old images) | |
275 | */ | |
353996de | 276 | void a_mapcache_remove_all_shrinkfactors ( gint x, gint y, gint z, guint16 type, gint zoom, const gchar* name ) |
9095ea4c RN |
277 | { |
278 | char key[MC_KEY_SIZE]; | |
353996de RN |
279 | guint nn = name ? g_str_hash ( name ) : 0; |
280 | g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING_NOSHRINK_NOR_ALPHA, type, x, y, z, zoom, nn ); | |
9095ea4c RN |
281 | flush_matching ( key ); |
282 | } | |
283 | ||
c57a0943 JJ |
284 | void a_mapcache_flush () |
285 | { | |
948c2f08 RN |
286 | // Everything happens within the mutex lock section |
287 | g_mutex_lock(mc_mutex); | |
288 | ||
c57a0943 JJ |
289 | List *loop = queue_tail; |
290 | List *tmp; | |
291 | ||
948c2f08 | 292 | while ( loop ) { |
c57a0943 JJ |
293 | tmp = loop->next; |
294 | cache_remove(tmp->key); | |
295 | if ( tmp == queue_tail ) /* we deleted the last thing in the queue */ | |
296 | loop = queue_tail = NULL; | |
297 | else | |
298 | loop->next = tmp->next; | |
299 | g_free ( tmp ); | |
300 | tmp = NULL; | |
948c2f08 | 301 | } |
c57a0943 JJ |
302 | |
303 | g_mutex_unlock(mc_mutex); | |
304 | } | |
305 | ||
9095ea4c RN |
306 | /** |
307 | * a_mapcache_flush_type: | |
308 | * @type: Specified map type | |
309 | * | |
310 | * Just remove cache items for the specified map type | |
311 | * i.e. all related xyz+zoom+alpha+etc... | |
312 | */ | |
313 | void a_mapcache_flush_type ( guint16 type ) | |
314 | { | |
315 | char key[MC_KEY_SIZE]; | |
316 | g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING_TYPE, type ); | |
317 | flush_matching ( key ); | |
318 | } | |
319 | ||
50a14534 EB |
320 | void a_mapcache_uninit () |
321 | { | |
322 | g_hash_table_destroy ( cache ); | |
323 | /* free list */ | |
324 | cache = NULL; | |
fc6640a9 | 325 | vik_mutex_free (mc_mutex); |
50a14534 | 326 | } |
a3040a49 RN |
327 | |
328 | // Size of mapcache in memory | |
329 | gint a_mapcache_get_size () | |
330 | { | |
331 | return cache_size; | |
332 | } | |
333 | ||
334 | // Count of items in the mapcache | |
335 | gint a_mapcache_get_count () | |
336 | { | |
337 | return g_hash_table_size ( cache ); | |
338 | } |