src/datacache/datacache.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2004, 2005, 2006, 2007, 2009, 2010 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file datacache/datacache.c
  23  * @brief datacache API implementation
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_datacache_lib.h"
  29 #include "gnunet_statistics_service.h"
  30 #include "gnunet_datacache_plugin.h"
  31
  32
  33 #define LOG(kind,...) GNUNET_log_from (kind, "datacache", __VA_ARGS__)
  34
  35 #define LOG_STRERROR_FILE(kind,op,fn) GNUNET_log_from_strerror_file (kind, "datacache", op, fn)
  36
  37 /**
  38  * Internal state of the datacache library.
  39  */
  40 struct GNUNET_DATACACHE_Handle
  41 {
  42
  43   /**
  44    * Bloomfilter to quickly tell if we don't have the content.
  45    */
  46   struct GNUNET_CONTAINER_BloomFilter *filter;
  47
  48   /**
  49    * Our configuration.
  50    */
  51   const struct GNUNET_CONFIGURATION_Handle *cfg;
  52
  53   /**
  54    * Opaque handle for the statistics service.
  55    */
  56   struct GNUNET_STATISTICS_Handle *stats;
  57
  58   /**
  59    * Configuration section to use.
  60    */
  61   char *section;
  62
  63   /**
  64    * API of the transport as returned by the plugin's
  65    * initialization function.
  66    */
  67   struct GNUNET_DATACACHE_PluginFunctions *api;
  68
  69   /**
  70    * Short name for the plugin (i.e. "sqlite").
  71    */
  72   char *short_name;
  73
  74   /**
  75    * Name of the library (i.e. "gnunet_plugin_datacache_sqlite").
  76    */
  77   char *lib_name;
  78
  79   /**
  80    * Name for the bloom filter file.
  81    */
  82   char *bloom_name;
  83
  84   /**
  85    * Environment provided to our plugin.
  86    */
  87   struct GNUNET_DATACACHE_PluginEnvironment env;
  88
  89   /**
  90    * How much space is in use right now?
  91    */
  92   unsigned long long utilization;
  93
  94 };
  95
  96
  97 /**
  98  * Function called by plugins to notify the datacache
  99  * about content deletions.
 100  *
 101  * @param cls closure
 102  * @param key key of the content that was deleted
 103  * @param size number of bytes that were made available
 104  */
 105 static void
 106 env_delete_notify (void *cls, const struct GNUNET_HashCode * key, size_t size)
 107 {
 108   struct GNUNET_DATACACHE_Handle *h = cls;
 109
 110   LOG (GNUNET_ERROR_TYPE_DEBUG, "Content under key `%s' discarded\n",
 111        GNUNET_h2s (key));
 112   GNUNET_assert (h->utilization >= size);
 113   h->utilization -= size;
 114   GNUNET_CONTAINER_bloomfilter_remove (h->filter, key);
 115   GNUNET_STATISTICS_update (h->stats, gettext_noop ("# bytes stored"), -size,
 116                             GNUNET_NO);
 117   GNUNET_STATISTICS_update (h->stats, gettext_noop ("# items stored"), -1,
 118                             GNUNET_NO);
 119 }
 120
 121
 122 /**
 123  * Create a data cache.
 124  *
 125  * @param cfg configuration to use
 126  * @param section section in the configuration that contains our options
 127  * @return handle to use to access the service
 128  */
 129 struct GNUNET_DATACACHE_Handle *
 130 GNUNET_DATACACHE_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
 131                          const char *section)
 132 {
 133   unsigned int bf_size;
 134   unsigned long long quota;
 135   struct GNUNET_DATACACHE_Handle *ret;
 136   char *libname;
 137   char *name;
 138
 139   if (GNUNET_OK !=
 140       GNUNET_CONFIGURATION_get_value_size (cfg, section, "QUOTA", &quota))
 141   {
 142     LOG (GNUNET_ERROR_TYPE_ERROR,
 143          _("No `%s' specified for `%s' in configuration!\n"), "QUOTA", section);
 144     return NULL;
 145   }
 146   if (GNUNET_OK !=
 147       GNUNET_CONFIGURATION_get_value_string (cfg, section, "DATABASE", &name))
 148   {
 149     LOG (GNUNET_ERROR_TYPE_ERROR,
 150          _("No `%s' specified for `%s' in configuration!\n"), "DATABASE",
 151          section);
 152     return NULL;
 153   }
 154   bf_size = quota / 32;         /* 8 bit per entry, 1 bit per 32 kb in DB */
 155
 156   ret = GNUNET_malloc (sizeof (struct GNUNET_DATACACHE_Handle));
 157
 158   if (GNUNET_YES !=
 159       GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "DISABLE_BF_RC"))
 160   {
 161     fprintf (stderr, "Using RC!\n");
 162     ret->bloom_name = GNUNET_DISK_mktemp ("gnunet-datacachebloom");
 163   }
 164   if (NULL != ret->bloom_name)
 165   {
 166     ret->filter = GNUNET_CONTAINER_bloomfilter_load (ret->bloom_name, quota / 1024,     /* 8 bit per entry in DB, expect 1k entries */
 167                                                      5);
 168   }
 169
 170   if (NULL == ret->filter)
 171   {
 172     ret->filter = GNUNET_CONTAINER_bloomfilter_init (NULL, bf_size, 5); /* approx. 3% false positives at max use */
 173   }
 174   if (NULL == ret->filter)
 175   {
 176     GNUNET_free (name);
 177     GNUNET_free (ret->bloom_name);
 178     GNUNET_free (ret);
 179     return NULL;
 180   }
 181   ret->stats = GNUNET_STATISTICS_create ("datacache", cfg);
 182   ret->section = GNUNET_strdup (section);
 183   ret->env.cfg = cfg;
 184   ret->env.delete_notify = &env_delete_notify;
 185   ret->env.section = ret->section;
 186   ret->env.cls = ret;
 187   ret->env.delete_notify = &env_delete_notify;
 188   ret->env.quota = quota;
 189   LOG (GNUNET_ERROR_TYPE_INFO, _("Loading `%s' datacache plugin\n"), name);
 190   GNUNET_asprintf (&libname, "libgnunet_plugin_datacache_%s", name);
 191   ret->short_name = name;
 192   ret->lib_name = libname;
 193   ret->api = GNUNET_PLUGIN_load (libname, &ret->env);
 194   if (ret->api == NULL)
 195   {
 196     LOG (GNUNET_ERROR_TYPE_ERROR,
 197          _("Failed to load datacache plugin for `%s'\n"), name);
 198     GNUNET_DATACACHE_destroy (ret);
 199     return NULL;
 200   }
 201   return ret;
 202 }
 203
 204
 205 /**
 206  * Destroy a data cache (and free associated resources).
 207  *
 208  * @param h handle to the datastore
 209  */
 210 void
 211 GNUNET_DATACACHE_destroy (struct GNUNET_DATACACHE_Handle *h)
 212 {
 213   if (h->filter != NULL)
 214     GNUNET_CONTAINER_bloomfilter_free (h->filter);
 215   if (h->api != NULL)
 216     GNUNET_break (NULL == GNUNET_PLUGIN_unload (h->lib_name, h->api));
 217   GNUNET_free (h->lib_name);
 218   GNUNET_free (h->short_name);
 219   GNUNET_free (h->section);
 220   if (h->bloom_name != NULL)
 221   {
 222     if (0 != UNLINK (h->bloom_name))
 223       GNUNET_log_from_strerror_file (GNUNET_ERROR_TYPE_WARNING, "datacache",
 224                                      "unlink", h->bloom_name);
 225     GNUNET_free (h->bloom_name);
 226   }
 227   GNUNET_STATISTICS_destroy (h->stats, GNUNET_NO);
 228   GNUNET_free (h);
 229 }
 230
 231
 232 /**
 233  * Store an item in the datastore.
 234  *
 235  * @param h handle to the datacache
 236  * @param key key to store data under
 237  * @param size number of bytes in data
 238  * @param data data to store
 239  * @param type type of the value
 240  * @param discard_time when to discard the value in any case
 241  * @return GNUNET_OK on success, GNUNET_SYSERR on error (full, etc.)
 242  */
 243 int
 244 GNUNET_DATACACHE_put (struct GNUNET_DATACACHE_Handle *h,
 245                       const struct GNUNET_HashCode * key, size_t size,
 246                       const char *data, enum GNUNET_BLOCK_Type type,
 247                       struct GNUNET_TIME_Absolute discard_time)
 248 {
 249   uint32_t used;
 250
 251   used = h->api->put (h->api->cls, key, size, data, type, discard_time);
 252   if (used == 0)
 253   {
 254     GNUNET_break (0);
 255     return GNUNET_SYSERR;
 256   }
 257   LOG (GNUNET_ERROR_TYPE_DEBUG, "Stored data under key `%s' in cache\n",
 258        GNUNET_h2s (key));
 259   GNUNET_STATISTICS_update (h->stats, gettext_noop ("# bytes stored"), size,
 260                             GNUNET_NO);
 261   GNUNET_STATISTICS_update (h->stats, gettext_noop ("# items stored"), 1,
 262                             GNUNET_NO);
 263   GNUNET_CONTAINER_bloomfilter_add (h->filter, key);
 264   while (h->utilization + used > h->env.quota)
 265     GNUNET_assert (GNUNET_OK == h->api->del (h->api->cls));
 266   h->utilization += used;
 267   return GNUNET_OK;
 268 }
 269
 270
 271 /**
 272  * Iterate over the results for a particular key
 273  * in the datacache.
 274  *
 275  * @param h handle to the datacache
 276  * @param key what to look up
 277  * @param type entries of which type are relevant?
 278  * @param iter maybe NULL (to just count)
 279  * @param iter_cls closure for iter
 280  * @return the number of results found
 281  */
 282 unsigned int
 283 GNUNET_DATACACHE_get (struct GNUNET_DATACACHE_Handle *h,
 284                       const struct GNUNET_HashCode * key, enum GNUNET_BLOCK_Type type,
 285                       GNUNET_DATACACHE_Iterator iter, void *iter_cls)
 286 {
 287   GNUNET_STATISTICS_update (h->stats, gettext_noop ("# requests received"), 1,
 288                             GNUNET_NO);
 289   LOG (GNUNET_ERROR_TYPE_DEBUG, "Processing request for key `%s'\n",
 290        GNUNET_h2s (key));
 291   if (GNUNET_OK != GNUNET_CONTAINER_bloomfilter_test (h->filter, key))
 292   {
 293     GNUNET_STATISTICS_update (h->stats,
 294                               gettext_noop
 295                               ("# requests filtered by bloom filter"), 1,
 296                               GNUNET_NO);
 297     LOG (GNUNET_ERROR_TYPE_DEBUG, "Bloomfilter filters request for key `%s'\n",
 298          GNUNET_h2s (key));
 299     return 0;                   /* can not be present */
 300   }
 301   return h->api->get (h->api->cls, key, type, iter, iter_cls);
 302 }
 303
 304
 305
 306 /* end of datacache_api.c */