src/filecache.c

   1 /*
   2  * Geeqie
   3  * Copyright (C) 2008 The Geeqie Team
   4  *
   5  * Author: Vladimir Nadvornik
   6  *
   7  * This software is released under the GNU General Public License (GNU GPL).
   8  * Please read the included file COPYING for more information.
   9  * This software comes with no warranty of any kind, use at your own risk!
  10  */
  11
  12
  13 #include "main.h"
  14 #include "filecache.h"
  15
  16 /* Set to TRUE to add file cache dumps to the debug output */
  17 const gboolean debug_file_cache = FALSE;
  18
  19 /* this implements a simple LRU algorithm */
  20
  21 struct _FileCacheData {
  22         FileCacheReleaseFunc release;
  23         GList *list;
  24         gulong max_size;
  25         gulong size;
  26         };
  27
  28 typedef struct _FileCacheEntry FileCacheEntry;
  29 struct _FileCacheEntry {
  30         FileData *fd;
  31         gulong size;
  32         };
  33
  34 static void file_cache_notify_cb(FileData *fd, NotifyType type, gpointer data);
  35
  36 FileCacheData *file_cache_new(FileCacheReleaseFunc release, gulong max_size)
  37 {
  38         FileCacheData *fc = g_new(FileCacheData, 1);
  39         fc->release = release;
  40         fc->list = NULL;
  41         fc->max_size = max_size;
  42         fc->size = 0;
  43
  44         file_data_register_notify_func(file_cache_notify_cb, fc, NOTIFY_PRIORITY_HIGH);
  45
  46         return fc;
  47 }
  48
  49 gboolean file_cache_get(FileCacheData *fc, FileData *fd)
  50 {
  51         GList *work;
  52
  53         g_assert(fc && fd);
  54
  55         work = fc->list;
  56         while (work)
  57                 {
  58                 FileCacheEntry *fce = work->data;
  59                 if (fce->fd == fd)
  60                         {
  61                         /* entry exists */
  62                         DEBUG_1("cache hit: fc=%p %s", fc, fd->path);
  63                         if (work == fc->list) return TRUE; /* already at the beginning */
  64                         /* move it to the beginning */
  65                         DEBUG_1("cache move to front: fc=%p %s", fc, fd->path);
  66                         fc->list = g_list_remove_link(fc->list, work);
  67                         fc->list = g_list_concat(work, fc->list);
  68
  69                         if (file_data_check_changed_files(fd)) /* this will eventually remove changed files from cache via file_cache_notify_cb */
  70                                 return FALSE;
  71
  72                         if (debug_file_cache) file_cache_dump(fc);
  73                         return TRUE;
  74                         }
  75                 work = work->next;
  76                 }
  77         DEBUG_1("cache miss: fc=%p %s", fc, fd->path);
  78         return FALSE;
  79 }
  80
  81 void file_cache_set_size(FileCacheData *fc, gulong size)
  82 {
  83         GList *work;
  84         FileCacheEntry *last_fe;
  85
  86         if (debug_file_cache) file_cache_dump(fc);
  87
  88         work = g_list_last(fc->list);
  89         while (fc->size > size && work)
  90                 {
  91                 GList *prev;
  92                 last_fe = work->data;
  93                 prev = work->prev;
  94                 fc->list = g_list_delete_link(fc->list, work);
  95                 work = prev;
  96
  97                 DEBUG_1("file changed - cache remove: fc=%p %s", fc, last_fe->fd->path);
  98                 fc->size -= last_fe->size;
  99                 fc->release(last_fe->fd);
 100                 file_data_unref(last_fe->fd);
 101                 g_free(last_fe);
 102                 }
 103 }
 104
 105 void file_cache_put(FileCacheData *fc, FileData *fd, gulong size)
 106 {
 107         FileCacheEntry *fe;
 108
 109         if (file_cache_get(fc, fd)) return;
 110
 111         DEBUG_1("cache add: fc=%p %s", fc, fd->path);
 112         fe = g_new(FileCacheEntry, 1);
 113         fe->fd = file_data_ref(fd);
 114         fe->size = size;
 115         fc->list = g_list_prepend(fc->list, fe);
 116         fc->size += size;
 117
 118         file_cache_set_size(fc, fc->max_size);
 119 }
 120
 121 gulong file_cache_get_max_size(FileCacheData *fc)
 122 {
 123         return fc->max_size;
 124 }
 125
 126 gulong file_cache_get_size(FileCacheData *fc)
 127 {
 128         return fc->size;
 129 }
 130
 131 void file_cache_set_max_size(FileCacheData *fc, gulong size)
 132 {
 133         fc->max_size = size;
 134         file_cache_set_size(fc, fc->max_size);
 135 }
 136
 137 static void file_cache_remove_fd(FileCacheData *fc, FileData *fd)
 138 {
 139         GList *work;
 140         FileCacheEntry *fe;
 141
 142         if (debug_file_cache) file_cache_dump(fc);
 143
 144         work = fc->list;
 145         while (work)
 146                 {
 147                 GList *current = work;
 148                 fe = work->data;
 149                 work = work->next;
 150
 151                 if (fe->fd == fd)
 152                         {
 153                         fc->list = g_list_delete_link(fc->list, current);
 154
 155                         DEBUG_1("cache remove: fc=%p %s", fc, fe->fd->path);
 156                         fc->size -= fe->size;
 157                         fc->release(fe->fd);
 158                         file_data_unref(fe->fd);
 159                         g_free(fe);
 160                         }
 161                 }
 162 }
 163
 164 void file_cache_dump(FileCacheData *fc)
 165 {
 166         GList *work;
 167         work = fc->list;
 168         guint n = 0;
 169         DEBUG_1("cache dump: fc=%p max size:%ld size:%ld", fc, fc->max_size, fc->size);
 170
 171         while (work)
 172                 {
 173                 FileCacheEntry *fe = work->data;
 174                 work = work->next;
 175                 DEBUG_1("cache entry: fc=%p [%lu] %s %ld", fc, ++n, fe->fd->path, fe->size);
 176                 }
 177 }
 178
 179 static void file_cache_notify_cb(FileData *fd, NotifyType type, gpointer data)
 180 {
 181         FileCacheData *fc = data;
 182
 183         if (type == NOTIFY_TYPE_REREAD)
 184                 {
 185                 file_cache_remove_fd(fc, fd);
 186                 }
 187 }
 188 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */