vfs/gc.c

   1 /* Virtual File System garbage collection code
   2    Copyright (C) 2003, 2004, 2005, 2007 Free Software Foundation, Inc.
   3
   4    Written by: 1995 Miguel de Icaza
   5                1995 Jakub Jelinek
   6                1998 Pavel Machek
   7                2003 Pavel Roskin
   8
   9    This program is free software; you can redistribute it and/or
  10    modify it under the terms of the GNU Library General Public License
  11    as published by the Free Software Foundation; either version 2 of
  12    the License, or (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU Library General Public License for more details.
  18
  19    You should have received a copy of the GNU Library General Public
  20    License along with this program; if not, write to the Free Software
  21    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  22
  23 /**
  24  * \file
  25  * \brief Source: Virtual File System: garbage collection code
  26  * \author Miguel de Icaza
  27  * \author Jakub Jelinek
  28  * \author Pavel Machek
  29  * \author Pavel Roskin
  30  * \date 1995, 1998, 2003
  31  */
  32
  33
  34 #include <config.h>
  35
  36 #include <stdio.h>
  37 #include <stdlib.h>             /* For atol() */
  38 #include <stdarg.h>
  39 #include <string.h>
  40 #include <errno.h>
  41 #include <sys/types.h>
  42 #include <ctype.h>              /* is_digit() */
  43 #include <sys/time.h>           /* gettimeofday() */
  44
  45 #include "../src/global.h"
  46
  47 #include "../src/wtools.h"      /* message() */
  48 #include "../src/main.h"        /* print_vfs_message */
  49 #include "../src/panel.h"       /* get_current_panel() */
  50 #include "../src/layout.h"      /* get_current_type() */
  51
  52 #include "utilvfs.h"
  53 #include "vfs-impl.h"
  54 #include "vfs.h"
  55 #include "gc.h"
  56
  57
  58 int vfs_timeout = 60;           /* VFS timeout in seconds */
  59
  60 static struct vfs_stamping *stamps;
  61
  62
  63 static void
  64 vfs_addstamp (struct vfs_class *v, vfsid id)
  65 {
  66     if (!(v->flags & VFSF_LOCAL) && id != NULL) {
  67         struct vfs_stamping *stamp;
  68         struct vfs_stamping *last_stamp = NULL;
  69
  70         for (stamp = stamps; stamp != NULL; stamp = stamp->next) {
  71             if (stamp->v == v && stamp->id == id) {
  72                 gettimeofday (&(stamp->time), NULL);
  73                 return;
  74             }
  75             last_stamp = stamp;
  76         }
  77         stamp = g_new (struct vfs_stamping, 1);
  78         stamp->v = v;
  79         stamp->id = id;
  80
  81         gettimeofday (&(stamp->time), NULL);
  82         stamp->next = 0;
  83
  84         if (stamps) {
  85             /* Add to the end */
  86             last_stamp->next = stamp;
  87         } else {
  88             /* Add first element */
  89             stamps = stamp;
  90         }
  91     }
  92 }
  93
  94
  95 void
  96 vfs_stamp (struct vfs_class *v, vfsid id)
  97 {
  98     struct vfs_stamping *stamp;
  99
 100     for (stamp = stamps; stamp != NULL; stamp = stamp->next)
 101         if (stamp->v == v && stamp->id == id) {
 102             gettimeofday (&(stamp->time), NULL);
 103             return;
 104         }
 105 }
 106
 107
 108 void
 109 vfs_rmstamp (struct vfs_class *v, vfsid id)
 110 {
 111     struct vfs_stamping *stamp, *st1;
 112
 113     for (stamp = stamps, st1 = NULL; stamp != NULL;
 114          st1 = stamp, stamp = stamp->next)
 115         if (stamp->v == v && stamp->id == id) {
 116             if (st1 == NULL) {
 117                 stamps = stamp->next;
 118             } else {
 119                 st1->next = stamp->next;
 120             }
 121             g_free (stamp);
 122
 123             return;
 124         }
 125 }
 126
 127
 128 /* Find VFS id for given directory name */
 129 vfsid
 130 vfs_getid (struct vfs_class *vclass, const char *dir)
 131 {
 132     char *dir1;
 133     vfsid id = NULL;
 134
 135     /* append slash if needed */
 136     dir1 = concat_dir_and_file (dir, "");
 137     if (vclass->getid)
 138         id = (*vclass->getid) (vclass, dir1);
 139
 140     g_free (dir1);
 141     return id;
 142 }
 143
 144
 145 static void
 146 vfs_stamp_path (char *path)
 147 {
 148     struct vfs_class *vfs;
 149     vfsid id;
 150
 151     vfs = vfs_get_class (path);
 152     id = vfs_getid (vfs, path);
 153     vfs_addstamp (vfs, id);
 154 }
 155
 156
 157 /*
 158  * Create a new timestamp item by VFS class and VFS id.
 159  */
 160 void
 161 vfs_stamp_create (struct vfs_class *oldvfs, vfsid oldvfsid)
 162 {
 163     struct vfs_class *nvfs, *n2vfs, *n3vfs;
 164     vfsid nvfsid, n2vfsid, n3vfsid;
 165
 166     /* There are three directories we have to take care of: current_dir,
 167        current_panel->cwd and other_panel->cwd. Athough most of the time either
 168        current_dir and current_panel->cwd or current_dir and other_panel->cwd are the
 169        same, it's possible that all three are different -- Norbert */
 170
 171     if (!current_panel)
 172         return;
 173
 174     nvfs = vfs_get_class (vfs_get_current_dir ());
 175     nvfsid = vfs_getid (nvfs, vfs_get_current_dir ());
 176     vfs_rmstamp (nvfs, nvfsid);
 177
 178     if ((nvfs == oldvfs && nvfsid == oldvfsid) || oldvfsid == NULL) {
 179         return;
 180     }
 181
 182     if (get_current_type () == view_listing) {
 183         n2vfs = vfs_get_class (current_panel->cwd);
 184         n2vfsid = vfs_getid (n2vfs, current_panel->cwd);
 185         if (n2vfs == oldvfs && n2vfsid == oldvfsid)
 186             return;
 187     } else {
 188         n2vfs = NULL;
 189         n2vfsid = NULL;
 190     }
 191
 192     if (get_other_type () == view_listing) {
 193         n3vfs = vfs_get_class (other_panel->cwd);
 194         n3vfsid = vfs_getid (n3vfs, other_panel->cwd);
 195         if (n3vfs == oldvfs && n3vfsid == oldvfsid)
 196             return;
 197     } else {
 198         n3vfs = NULL;
 199         n3vfsid = NULL;
 200     }
 201
 202     if (!oldvfs->nothingisopen || !(*oldvfs->nothingisopen) (oldvfsid))
 203         return;
 204
 205     vfs_addstamp (oldvfs, oldvfsid);
 206 }
 207
 208
 209 void
 210 vfs_add_current_stamps (void)
 211 {
 212     vfs_stamp_path (vfs_get_current_dir ());
 213
 214     if (current_panel) {
 215         if (get_current_type () == view_listing)
 216             vfs_stamp_path (current_panel->cwd);
 217     }
 218
 219     if (other_panel) {
 220         if (get_other_type () == view_listing)
 221             vfs_stamp_path (other_panel->cwd);
 222     }
 223 }
 224
 225
 226 /* Compare two timeval structures.  Return 0 is t1 is less than t2. */
 227 static inline int
 228 timeoutcmp (struct timeval *t1, struct timeval *t2)
 229 {
 230     return ((t1->tv_sec < t2->tv_sec)
 231             || ((t1->tv_sec == t2->tv_sec)
 232                 && (t1->tv_usec <= t2->tv_usec)));
 233 }
 234
 235
 236 /* This is called from timeout handler with now = 0, or can be called
 237    with now = 1 to force freeing all filesystems that are not in use */
 238 void
 239 vfs_expire (int now)
 240 {
 241     static int locked = 0;
 242     struct timeval time;
 243     struct vfs_stamping *stamp, *st;
 244
 245     /* Avoid recursive invocation, e.g. when one of the free functions
 246        calls message */
 247     if (locked)
 248         return;
 249     locked = 1;
 250
 251     gettimeofday (&time, NULL);
 252     time.tv_sec -= vfs_timeout;
 253
 254     for (stamp = stamps; stamp != NULL;) {
 255         if (now || (timeoutcmp (&stamp->time, &time))) {
 256             st = stamp->next;
 257             if (stamp->v->free)
 258                 (*stamp->v->free) (stamp->id);
 259             vfs_rmstamp (stamp->v, stamp->id);
 260             stamp = st;
 261         } else
 262             stamp = stamp->next;
 263     }
 264     locked = 0;
 265 }
 266
 267
 268 /*
 269  * Return the number of seconds remaining to the vfs timeout.
 270  * FIXME: The code should be improved to actually return the number of
 271  * seconds until the next item times out.
 272  */
 273 int
 274 vfs_timeouts ()
 275 {
 276     return stamps ? 10 : 0;
 277 }
 278
 279
 280 void
 281 vfs_timeout_handler (void)
 282 {
 283     vfs_expire (0);
 284 }
 285
 286
 287 void
 288 vfs_release_path (const char *dir)
 289 {
 290     struct vfs_class *oldvfs;
 291     vfsid oldvfsid;
 292
 293     oldvfs = vfs_get_class (dir);
 294     oldvfsid = vfs_getid (oldvfs, dir);
 295     vfs_stamp_create (oldvfs, oldvfsid);
 296 }
 297
 298
 299 /* Free all data */
 300 void
 301 vfs_gc_done (void)
 302 {
 303     struct vfs_stamping *stamp, *st;
 304
 305     for (stamp = stamps, stamps = 0; stamp != NULL;) {
 306         if (stamp->v->free)
 307             (*stamp->v->free) (stamp->id);
 308         st = stamp->next;
 309         g_free (stamp);
 310         stamp = st;
 311     }
 312
 313     if (stamps)
 314         vfs_rmstamp (stamps->v, stamps->id);
 315 }