src/datastore/gnunet-service-datastore.c

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2004-2014 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 3, 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 datastore/gnunet-service-datastore.c
  23  * @brief Management for the datastore for files stored on a GNUnet node
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet_protocols.h"
  30 #include "gnunet_statistics_service.h"
  31 #include "gnunet_datastore_plugin.h"
  32 #include "datastore.h"
  33
  34 /**
  35  * How many messages do we queue at most per client?
  36  */
  37 #define MAX_PENDING 1024
  38
  39 /**
  40  * How long are we at most keeping "expired" content
  41  * past the expiration date in the database?
  42  */
  43 #define MAX_EXPIRE_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
  44
  45 /**
  46  * How fast are we allowed to query the database for deleting
  47  * expired content? (1 item per second).
  48  */
  49 #define MIN_EXPIRE_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
  50
  51 /**
  52  * Name under which we store current space consumption.
  53  */
  54 static char *quota_stat_name;
  55
  56 /**
  57  * After how many payload-changing operations
  58  * do we sync our statistics?
  59  */
  60 #define MAX_STAT_SYNC_LAG 50
  61
  62
  63 /**
  64  * Our datastore plugin.
  65  */
  66 struct DatastorePlugin
  67 {
  68
  69   /**
  70    * API of the transport as returned by the plugin's
  71    * initialization function.
  72    */
  73   struct GNUNET_DATASTORE_PluginFunctions *api;
  74
  75   /**
  76    * Short name for the plugin (i.e. "sqlite").
  77    */
  78   char *short_name;
  79
  80   /**
  81    * Name of the library (i.e. "gnunet_plugin_datastore_sqlite").
  82    */
  83   char *lib_name;
  84
  85   /**
  86    * Environment this transport service is using
  87    * for this plugin.
  88    */
  89   struct GNUNET_DATASTORE_PluginEnvironment env;
  90
  91 };
  92
  93
  94 /**
  95  * Linked list of active reservations.
  96  */
  97 struct ReservationList
  98 {
  99
 100   /**
 101    * This is a linked list.
 102    */
 103   struct ReservationList *next;
 104
 105   /**
 106    * Client that made the reservation.
 107    */
 108   struct GNUNET_SERVER_Client *client;
 109
 110   /**
 111    * Number of bytes (still) reserved.
 112    */
 113   uint64_t amount;
 114
 115   /**
 116    * Number of items (still) reserved.
 117    */
 118   uint64_t entries;
 119
 120   /**
 121    * Reservation identifier.
 122    */
 123   int32_t rid;
 124
 125 };
 126
 127
 128
 129 /**
 130  * Our datastore plugin (NULL if not available).
 131  */
 132 static struct DatastorePlugin *plugin;
 133
 134 /**
 135  * Linked list of space reservations made by clients.
 136  */
 137 static struct ReservationList *reservations;
 138
 139 /**
 140  * Bloomfilter to quickly tell if we don't have the content.
 141  */
 142 static struct GNUNET_CONTAINER_BloomFilter *filter;
 143
 144 /**
 145  * Name of our plugin.
 146  */
 147 static char *plugin_name;
 148
 149 /**
 150  * Our configuration.
 151  */
 152 static const struct GNUNET_CONFIGURATION_Handle *cfg;
 153
 154 /**
 155  * Handle for reporting statistics.
 156  */
 157 static struct GNUNET_STATISTICS_Handle *stats;
 158
 159 /**
 160  * How much space are we using for the cache?  (space available for
 161  * insertions that will be instantly reclaimed by discarding less
 162  * important content --- or possibly whatever we just inserted into
 163  * the "cache").
 164  */
 165 static unsigned long long cache_size;
 166
 167 /**
 168  * How much space have we currently reserved?
 169  */
 170 static unsigned long long reserved;
 171
 172 /**
 173  * How much data are we currently storing
 174  * in the database?
 175  */
 176 static unsigned long long payload;
 177
 178 /**
 179  * Identity of the task that is used to delete
 180  * expired content.
 181  */
 182 static struct GNUNET_SCHEDULER_Task * expired_kill_task;
 183
 184 /**
 185  * Minimum time that content should have to not be discarded instantly
 186  * (time stamp of any content that we've been discarding recently to
 187  * stay below the quota).  FOREVER if we had to expire content with
 188  * non-zero priority.
 189  */
 190 static struct GNUNET_TIME_Absolute min_expiration;
 191
 192 /**
 193  * How much space are we allowed to use?
 194  */
 195 static unsigned long long quota;
 196
 197 /**
 198  * Should the database be dropped on exit?
 199  */
 200 static int do_drop;
 201
 202 /**
 203  * Should we refresh the BF when the DB is loaded?
 204  */
 205 static int refresh_bf;
 206
 207 /**
 208  * Number of updates that were made to the
 209  * payload value since we last synchronized
 210  * it with the statistics service.
 211  */
 212 static unsigned int last_sync;
 213
 214 /**
 215  * Did we get an answer from statistics?
 216  */
 217 static int stats_worked;
 218
 219
 220 /**
 221  * Synchronize our utilization statistics with the
 222  * statistics service.
 223  */
 224 static void
 225 sync_stats ()
 226 {
 227   GNUNET_STATISTICS_set (stats, quota_stat_name, payload, GNUNET_YES);
 228   GNUNET_STATISTICS_set (stats, "# utilization by current datastore", payload, GNUNET_NO);
 229   last_sync = 0;
 230 }
 231
 232
 233 /**
 234  * Context for transmitting replies to clients.
 235  */
 236 struct TransmitCallbackContext
 237 {
 238
 239   /**
 240    * We keep these in a doubly-linked list (for cleanup).
 241    */
 242   struct TransmitCallbackContext *next;
 243
 244   /**
 245    * We keep these in a doubly-linked list (for cleanup).
 246    */
 247   struct TransmitCallbackContext *prev;
 248
 249   /**
 250    * The message that we're asked to transmit.
 251    */
 252   struct GNUNET_MessageHeader *msg;
 253
 254   /**
 255    * Handle for the transmission request.
 256    */
 257   struct GNUNET_SERVER_TransmitHandle *th;
 258
 259   /**
 260    * Client that we are transmitting to.
 261    */
 262   struct GNUNET_SERVER_Client *client;
 263
 264 };
 265
 266
 267 /**
 268  * Head of the doubly-linked list (for cleanup).
 269  */
 270 static struct TransmitCallbackContext *tcc_head;
 271
 272 /**
 273  * Tail of the doubly-linked list (for cleanup).
 274  */
 275 static struct TransmitCallbackContext *tcc_tail;
 276
 277 /**
 278  * Have we already cleaned up the TCCs and are hence no longer
 279  * willing (or able) to transmit anything to anyone?
 280  */
 281 static int cleaning_done;
 282
 283 /**
 284  * Handle for pending get request.
 285  */
 286 static struct GNUNET_STATISTICS_GetHandle *stat_get;
 287
 288 /**
 289  * Handle to our server.
 290  */
 291 static struct GNUNET_SERVER_Handle *server;
 292
 293 /**
 294  * Task that is used to remove expired entries from
 295  * the datastore.  This task will schedule itself
 296  * again automatically to always delete all expired
 297  * content quickly.
 298  *
 299  * @param cls not used
 300  * @param tc task context
 301  */
 302 static void
 303 delete_expired (void *cls,
 304                 const struct GNUNET_SCHEDULER_TaskContext *tc);
 305
 306
 307 /**
 308  * Iterate over the expired items stored in the datastore.
 309  * Delete all expired items; once we have processed all
 310  * expired items, re-schedule the "delete_expired" task.
 311  *
 312  * @param cls not used
 313  * @param key key for the content
 314  * @param size number of bytes in data
 315  * @param data content stored
 316  * @param type type of the content
 317  * @param priority priority of the content
 318  * @param anonymity anonymity-level for the content
 319  * @param expiration expiration time for the content
 320  * @param uid unique identifier for the datum;
 321  *        maybe 0 if no unique identifier is available
 322  *
 323  * @return #GNUNET_SYSERR to abort the iteration, #GNUNET_OK to continue
 324  *         (continue on call to "next", of course),
 325  *         #GNUNET_NO to delete the item and continue (if supported)
 326  */
 327 static int
 328 expired_processor (void *cls,
 329                    const struct GNUNET_HashCode *key,
 330                    uint32_t size,
 331                    const void *data,
 332                    enum GNUNET_BLOCK_Type type,
 333                    uint32_t priority,
 334                    uint32_t anonymity,
 335                    struct GNUNET_TIME_Absolute expiration,
 336                    uint64_t uid)
 337 {
 338   struct GNUNET_TIME_Absolute now;
 339
 340   if (key == NULL)
 341   {
 342     expired_kill_task =
 343         GNUNET_SCHEDULER_add_delayed_with_priority (MAX_EXPIRE_DELAY,
 344                                                     GNUNET_SCHEDULER_PRIORITY_IDLE,
 345                                                     &delete_expired, NULL);
 346     return GNUNET_SYSERR;
 347   }
 348   now = GNUNET_TIME_absolute_get ();
 349   if (expiration.abs_value_us > now.abs_value_us)
 350   {
 351     /* finished processing */
 352     expired_kill_task =
 353         GNUNET_SCHEDULER_add_delayed_with_priority (MAX_EXPIRE_DELAY,
 354                                                     GNUNET_SCHEDULER_PRIORITY_IDLE,
 355                                                     &delete_expired, NULL);
 356     return GNUNET_SYSERR;
 357   }
 358   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 359               "Deleting content `%s' of type %u that expired %s ago\n",
 360               GNUNET_h2s (key), type,
 361               GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_difference (expiration,
 362                                                                                            now),
 363                                                       GNUNET_YES));
 364   min_expiration = now;
 365   GNUNET_STATISTICS_update (stats, gettext_noop ("# bytes expired"), size,
 366                             GNUNET_YES);
 367   GNUNET_CONTAINER_bloomfilter_remove (filter, key);
 368   expired_kill_task =
 369       GNUNET_SCHEDULER_add_delayed_with_priority (MIN_EXPIRE_DELAY,
 370                                                   GNUNET_SCHEDULER_PRIORITY_IDLE,
 371                                                   &delete_expired, NULL);
 372   return GNUNET_NO;
 373 }
 374
 375
 376 /**
 377  * Task that is used to remove expired entries from
 378  * the datastore.  This task will schedule itself
 379  * again automatically to always delete all expired
 380  * content quickly.
 381  *
 382  * @param cls not used
 383  * @param tc task context
 384  */
 385 static void
 386 delete_expired (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 387 {
 388   expired_kill_task = NULL;
 389   plugin->api->get_expiration (plugin->api->cls, &expired_processor, NULL);
 390 }
 391
 392
 393 /**
 394  * An iterator over a set of items stored in the datastore
 395  * that deletes until we're happy with respect to our quota.
 396  *
 397  * @param cls closure
 398  * @param key key for the content
 399  * @param size number of bytes in data
 400  * @param data content stored
 401  * @param type type of the content
 402  * @param priority priority of the content
 403  * @param anonymity anonymity-level for the content
 404  * @param expiration expiration time for the content
 405  * @param uid unique identifier for the datum;
 406  *        maybe 0 if no unique identifier is available
 407  *
 408  * @return GNUNET_SYSERR to abort the iteration, GNUNET_OK to continue
 409  *         (continue on call to "next", of course),
 410  *         GNUNET_NO to delete the item and continue (if supported)
 411  */
 412 static int
 413 quota_processor (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
 414                  const void *data, enum GNUNET_BLOCK_Type type,
 415                  uint32_t priority, uint32_t anonymity,
 416                  struct GNUNET_TIME_Absolute expiration, uint64_t uid)
 417 {
 418   unsigned long long *need = cls;
 419
 420   if (NULL == key)
 421     return GNUNET_SYSERR;
 422   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 423               "Deleting %llu bytes of low-priority (%u) content `%s' of type %u at %s prior to expiration (still trying to free another %llu bytes)\n",
 424               (unsigned long long) (size + GNUNET_DATASTORE_ENTRY_OVERHEAD),
 425               (unsigned int) priority,
 426               GNUNET_h2s (key), type,
 427               GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (expiration),
 428                                                       GNUNET_YES),
 429               *need);
 430   if (size + GNUNET_DATASTORE_ENTRY_OVERHEAD > *need)
 431     *need = 0;
 432   else
 433     *need -= size + GNUNET_DATASTORE_ENTRY_OVERHEAD;
 434   if (priority > 0)
 435     min_expiration = GNUNET_TIME_UNIT_FOREVER_ABS;
 436   else
 437     min_expiration = expiration;
 438   GNUNET_STATISTICS_update (stats,
 439                             gettext_noop ("# bytes purged (low-priority)"),
 440                             size, GNUNET_YES);
 441   GNUNET_CONTAINER_bloomfilter_remove (filter, key);
 442   return GNUNET_NO;
 443 }
 444
 445
 446 /**
 447  * Manage available disk space by running tasks
 448  * that will discard content if necessary.  This
 449  * function will be run whenever a request for
 450  * "need" bytes of storage could only be satisfied
 451  * by eating into the "cache" (and we want our cache
 452  * space back).
 453  *
 454  * @param need number of bytes of content that were
 455  *        placed into the "cache" (and hence the
 456  *        number of bytes that should be removed).
 457  */
 458 static void
 459 manage_space (unsigned long long need)
 460 {
 461   unsigned long long last;
 462
 463   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 464               "Asked to free up %llu bytes of cache space\n", need);
 465   last = 0;
 466   while ((need > 0) && (last != need))
 467   {
 468     last = need;
 469     plugin->api->get_expiration (plugin->api->cls, &quota_processor, &need);
 470   }
 471 }
 472
 473
 474 /**
 475  * Function called to notify a client about the socket
 476  * begin ready to queue more data.  "buf" will be
 477  * NULL and "size" zero if the socket was closed for
 478  * writing in the meantime.
 479  *
 480  * @param cls closure
 481  * @param size number of bytes available in buf
 482  * @param buf where the callee should write the message
 483  * @return number of bytes written to buf
 484  */
 485 static size_t
 486 transmit_callback (void *cls, size_t size, void *buf)
 487 {
 488   struct TransmitCallbackContext *tcc = cls;
 489   size_t msize;
 490
 491   tcc->th = NULL;
 492   GNUNET_CONTAINER_DLL_remove (tcc_head, tcc_tail, tcc);
 493   msize = ntohs (tcc->msg->size);
 494   if (size == 0)
 495   {
 496     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 497                 _("Transmission to client failed!\n"));
 498     GNUNET_SERVER_receive_done (tcc->client, GNUNET_SYSERR);
 499     GNUNET_SERVER_client_drop (tcc->client);
 500     GNUNET_free (tcc->msg);
 501     GNUNET_free (tcc);
 502     return 0;
 503   }
 504   GNUNET_assert (size >= msize);
 505   memcpy (buf, tcc->msg, msize);
 506   GNUNET_SERVER_receive_done (tcc->client, GNUNET_OK);
 507   GNUNET_SERVER_client_drop (tcc->client);
 508   GNUNET_free (tcc->msg);
 509   GNUNET_free (tcc);
 510   return msize;
 511 }
 512
 513
 514 /**
 515  * Transmit the given message to the client.
 516  *
 517  * @param client target of the message
 518  * @param msg message to transmit, will be freed!
 519  */
 520 static void
 521 transmit (struct GNUNET_SERVER_Client *client, struct GNUNET_MessageHeader *msg)
 522 {
 523   struct TransmitCallbackContext *tcc;
 524
 525   if (GNUNET_YES == cleaning_done)
 526   {
 527     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 528                 _("Shutdown in progress, aborting transmission.\n"));
 529     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 530     GNUNET_free (msg);
 531     return;
 532   }
 533   tcc = GNUNET_new (struct TransmitCallbackContext);
 534   tcc->msg = msg;
 535   tcc->client = client;
 536   if (NULL ==
 537       (tcc->th =
 538        GNUNET_SERVER_notify_transmit_ready (client, ntohs (msg->size),
 539                                             GNUNET_TIME_UNIT_FOREVER_REL,
 540                                             &transmit_callback, tcc)))
 541   {
 542     GNUNET_break (0);
 543     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 544     GNUNET_free (msg);
 545     GNUNET_free (tcc);
 546     return;
 547   }
 548   GNUNET_SERVER_client_keep (client);
 549   GNUNET_CONTAINER_DLL_insert (tcc_head, tcc_tail, tcc);
 550 }
 551
 552
 553 /**
 554  * Transmit a status code to the client.
 555  *
 556  * @param client receiver of the response
 557  * @param code status code
 558  * @param msg optional error message (can be NULL)
 559  */
 560 static void
 561 transmit_status (struct GNUNET_SERVER_Client *client, int code, const char *msg)
 562 {
 563   struct StatusMessage *sm;
 564   size_t slen;
 565
 566   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 567               "Transmitting `%s' message with value %d and message `%s'\n",
 568               "STATUS", code, msg != NULL ? msg : "(none)");
 569   slen = (msg == NULL) ? 0 : strlen (msg) + 1;
 570   sm = GNUNET_malloc (sizeof (struct StatusMessage) + slen);
 571   sm->header.size = htons (sizeof (struct StatusMessage) + slen);
 572   sm->header.type = htons (GNUNET_MESSAGE_TYPE_DATASTORE_STATUS);
 573   sm->status = htonl (code);
 574   sm->min_expiration = GNUNET_TIME_absolute_hton (min_expiration);
 575   if (slen > 0)
 576     memcpy (&sm[1], msg, slen);
 577   transmit (client, &sm->header);
 578 }
 579
 580
 581 /**
 582  * Function that will transmit the given datastore entry
 583  * to the client.
 584  *
 585  * @param cls closure, pointer to the client (of type GNUNET_SERVER_Client).
 586  * @param key key for the content
 587  * @param size number of bytes in data
 588  * @param data content stored
 589  * @param type type of the content
 590  * @param priority priority of the content
 591  * @param anonymity anonymity-level for the content
 592  * @param expiration expiration time for the content
 593  * @param uid unique identifier for the datum;
 594  *        maybe 0 if no unique identifier is available
 595  *
 596  * @return GNUNET_SYSERR to abort the iteration, GNUNET_OK to continue,
 597  *         GNUNET_NO to delete the item and continue (if supported)
 598  */
 599 static int
 600 transmit_item (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
 601                const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority,
 602                uint32_t anonymity, struct GNUNET_TIME_Absolute expiration,
 603                uint64_t uid)
 604 {
 605   struct GNUNET_SERVER_Client *client = cls;
 606   struct GNUNET_MessageHeader *end;
 607   struct DataMessage *dm;
 608
 609   if (key == NULL)
 610   {
 611     /* transmit 'DATA_END' */
 612     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting `%s' message\n",
 613                 "DATA_END");
 614     end = GNUNET_new (struct GNUNET_MessageHeader);
 615     end->size = htons (sizeof (struct GNUNET_MessageHeader));
 616     end->type = htons (GNUNET_MESSAGE_TYPE_DATASTORE_DATA_END);
 617     transmit (client, end);
 618     GNUNET_SERVER_client_drop (client);
 619     return GNUNET_OK;
 620   }
 621   GNUNET_assert (sizeof (struct DataMessage) + size <
 622                  GNUNET_SERVER_MAX_MESSAGE_SIZE);
 623   dm = GNUNET_malloc (sizeof (struct DataMessage) + size);
 624   dm->header.size = htons (sizeof (struct DataMessage) + size);
 625   dm->header.type = htons (GNUNET_MESSAGE_TYPE_DATASTORE_DATA);
 626   dm->rid = htonl (0);
 627   dm->size = htonl (size);
 628   dm->type = htonl (type);
 629   dm->priority = htonl (priority);
 630   dm->anonymity = htonl (anonymity);
 631   dm->replication = htonl (0);
 632   dm->reserved = htonl (0);
 633   dm->expiration = GNUNET_TIME_absolute_hton (expiration);
 634   dm->uid = GNUNET_htonll (uid);
 635   dm->key = *key;
 636   memcpy (&dm[1], data, size);
 637   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 638               "Transmitting `%s' message for `%s' of type %u with expiration %s (in: %s)\n",
 639               "DATA", GNUNET_h2s (key), type,
 640               GNUNET_STRINGS_absolute_time_to_string (expiration),
 641               GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (expiration),
 642                                                       GNUNET_YES));
 643   GNUNET_STATISTICS_update (stats, gettext_noop ("# results found"), 1,
 644                             GNUNET_NO);
 645   transmit (client, &dm->header);
 646   GNUNET_SERVER_client_drop (client);
 647   return GNUNET_OK;
 648 }
 649
 650
 651 /**
 652  * Handle RESERVE-message.
 653  *
 654  * @param cls closure
 655  * @param client identification of the client
 656  * @param message the actual message
 657  */
 658 static void
 659 handle_reserve (void *cls, struct GNUNET_SERVER_Client *client,
 660                 const struct GNUNET_MessageHeader *message)
 661 {
 662   /**
 663    * Static counter to produce reservation identifiers.
 664    */
 665   static int reservation_gen;
 666
 667   const struct ReserveMessage *msg = (const struct ReserveMessage *) message;
 668   struct ReservationList *e;
 669   unsigned long long used;
 670   unsigned long long req;
 671   uint64_t amount;
 672   uint32_t entries;
 673
 674   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n", "RESERVE");
 675   amount = GNUNET_ntohll (msg->amount);
 676   entries = ntohl (msg->entries);
 677   used = payload + reserved;
 678   req =
 679       amount + ((unsigned long long) GNUNET_DATASTORE_ENTRY_OVERHEAD) * entries;
 680   if (used + req > quota)
 681   {
 682     if (quota < used)
 683       used = quota;             /* cheat a bit for error message (to avoid negative numbers) */
 684     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 685                 _
 686                 ("Insufficient space (%llu bytes are available) to satisfy `%s' request for %llu bytes\n"),
 687                 quota - used, "RESERVE", req);
 688     if (cache_size < req)
 689     {
 690       /* TODO: document this in the FAQ; essentially, if this
 691        * message happens, the insertion request could be blocked
 692        * by less-important content from migration because it is
 693        * larger than 1/8th of the overall available space, and
 694        * we only reserve 1/8th for "fresh" insertions */
 695       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 696                   _
 697                   ("The requested amount (%llu bytes) is larger than the cache size (%llu bytes)\n"),
 698                   req, cache_size);
 699       transmit_status (client, 0,
 700                        gettext_noop
 701                        ("Insufficient space to satisfy request and "
 702                         "requested amount is larger than cache size"));
 703     }
 704     else
 705     {
 706       transmit_status (client, 0,
 707                        gettext_noop ("Insufficient space to satisfy request"));
 708     }
 709     return;
 710   }
 711   reserved += req;
 712   GNUNET_STATISTICS_set (stats, gettext_noop ("# reserved"), reserved,
 713                          GNUNET_NO);
 714   e = GNUNET_new (struct ReservationList);
 715   e->next = reservations;
 716   reservations = e;
 717   e->client = client;
 718   e->amount = amount;
 719   e->entries = entries;
 720   e->rid = ++reservation_gen;
 721   if (reservation_gen < 0)
 722     reservation_gen = 0;        /* wrap around */
 723   transmit_status (client, e->rid, NULL);
 724 }
 725
 726
 727 /**
 728  * Handle RELEASE_RESERVE-message.
 729  *
 730  * @param cls closure
 731  * @param client identification of the client
 732  * @param message the actual message
 733  */
 734 static void
 735 handle_release_reserve (void *cls,
 736                         struct GNUNET_SERVER_Client *client,
 737                         const struct GNUNET_MessageHeader *message)
 738 {
 739   const struct ReleaseReserveMessage *msg =
 740       (const struct ReleaseReserveMessage *) message;
 741   struct ReservationList *pos;
 742   struct ReservationList *prev;
 743   struct ReservationList *next;
 744   int rid = ntohl (msg->rid);
 745   unsigned long long rem;
 746
 747   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 748               "Processing `%s' request\n",
 749               "RELEASE_RESERVE");
 750   next = reservations;
 751   prev = NULL;
 752   while (NULL != (pos = next))
 753   {
 754     next = pos->next;
 755     if (rid == pos->rid)
 756     {
 757       if (prev == NULL)
 758         reservations = next;
 759       else
 760         prev->next = next;
 761       rem =
 762           pos->amount +
 763           ((unsigned long long) GNUNET_DATASTORE_ENTRY_OVERHEAD) * pos->entries;
 764       GNUNET_assert (reserved >= rem);
 765       reserved -= rem;
 766       GNUNET_STATISTICS_set (stats,
 767                              gettext_noop ("# reserved"), reserved,
 768                              GNUNET_NO);
 769       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 770                   "Returning %llu remaining reserved bytes to storage pool\n",
 771                   rem);
 772       GNUNET_free (pos);
 773       transmit_status (client, GNUNET_OK, NULL);
 774       return;
 775     }
 776     prev = pos;
 777   }
 778   GNUNET_break (0);
 779   transmit_status (client, GNUNET_SYSERR,
 780                    gettext_noop ("Could not find matching reservation"));
 781 }
 782
 783
 784 /**
 785  * Check that the given message is a valid data message.
 786  *
 787  * @return NULL if the message is not well-formed, otherwise the message
 788  */
 789 static const struct DataMessage *
 790 check_data (const struct GNUNET_MessageHeader *message)
 791 {
 792   uint16_t size;
 793   uint32_t dsize;
 794   const struct DataMessage *dm;
 795
 796   size = ntohs (message->size);
 797   if (size < sizeof (struct DataMessage))
 798   {
 799     GNUNET_break (0);
 800     return NULL;
 801   }
 802   dm = (const struct DataMessage *) message;
 803   dsize = ntohl (dm->size);
 804   if (size != dsize + sizeof (struct DataMessage))
 805   {
 806     GNUNET_break (0);
 807     return NULL;
 808   }
 809   return dm;
 810 }
 811
 812
 813 /**
 814  * Context for a PUT request used to see if the content is
 815  * already present.
 816  */
 817 struct PutContext
 818 {
 819   /**
 820    * Client to notify on completion.
 821    */
 822   struct GNUNET_SERVER_Client *client;
 823
 824 #if ! HAVE_UNALIGNED_64_ACCESS
 825   void *reserved;
 826 #endif
 827
 828   /* followed by the 'struct DataMessage' */
 829 };
 830
 831
 832 static void
 833 put_continuation (void *cls, const struct GNUNET_HashCode *key, uint32_t size,
 834                   int status, char *msg)
 835 {
 836   struct GNUNET_SERVER_Client *client = cls;
 837
 838   if (GNUNET_OK == status)
 839   {
 840     GNUNET_STATISTICS_update (stats,
 841                               gettext_noop ("# bytes stored"), size,
 842                               GNUNET_YES);
 843     GNUNET_CONTAINER_bloomfilter_add (filter, key);
 844     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 845                 "Successfully stored %u bytes under key `%s'\n",
 846                 size, GNUNET_h2s (key));
 847   }
 848   transmit_status (client, status, msg);
 849   GNUNET_SERVER_client_drop (client);
 850   if (quota - reserved - cache_size < payload)
 851   {
 852     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 853                 _("Need %llu bytes more space (%llu allowed, using %llu)\n"),
 854                 (unsigned long long) size + GNUNET_DATASTORE_ENTRY_OVERHEAD,
 855                 (unsigned long long) (quota - reserved - cache_size),
 856                 (unsigned long long) payload);
 857     manage_space (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
 858   }
 859 }
 860
 861 /**
 862  * Actually put the data message.
 863  *
 864  * @param client sender of the message
 865  * @param dm message with the data to store
 866  */
 867 static void
 868 execute_put (struct GNUNET_SERVER_Client *client, const struct DataMessage *dm)
 869 {
 870   GNUNET_SERVER_client_keep (client);
 871   plugin->api->put (plugin->api->cls, &dm->key, ntohl (dm->size), &dm[1],
 872                     ntohl (dm->type), ntohl (dm->priority),
 873                     ntohl (dm->anonymity), ntohl (dm->replication),
 874                     GNUNET_TIME_absolute_ntoh (dm->expiration),
 875                     &put_continuation, client);
 876 }
 877
 878
 879 static void
 880 check_present_continuation (void *cls, int status, char *msg)
 881 {
 882   struct GNUNET_SERVER_Client *client = cls;
 883
 884   transmit_status (client, GNUNET_NO, NULL);
 885   GNUNET_SERVER_client_drop (client);
 886 }
 887
 888
 889 /**
 890  * Function that will check if the given datastore entry
 891  * matches the put and if none match executes the put.
 892  *
 893  * @param cls closure, pointer to the client (of type 'struct PutContext').
 894  * @param key key for the content
 895  * @param size number of bytes in data
 896  * @param data content stored
 897  * @param type type of the content
 898  * @param priority priority of the content
 899  * @param anonymity anonymity-level for the content
 900  * @param expiration expiration time for the content
 901  * @param uid unique identifier for the datum;
 902  *        maybe 0 if no unique identifier is available
 903  *
 904  * @return GNUNET_OK usually
 905  *         GNUNET_NO to delete the item
 906  */
 907 static int
 908 check_present (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
 909                const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority,
 910                uint32_t anonymity, struct GNUNET_TIME_Absolute expiration,
 911                uint64_t uid)
 912 {
 913   struct PutContext *pc = cls;
 914   const struct DataMessage *dm;
 915
 916   dm = (const struct DataMessage *) &pc[1];
 917   if (key == NULL)
 918   {
 919     execute_put (pc->client, dm);
 920     GNUNET_SERVER_client_drop (pc->client);
 921     GNUNET_free (pc);
 922     return GNUNET_OK;
 923   }
 924   if ((GNUNET_BLOCK_TYPE_FS_DBLOCK == type) ||
 925       (GNUNET_BLOCK_TYPE_FS_IBLOCK == type) || ((size == ntohl (dm->size)) &&
 926                                                 (0 ==
 927                                                  memcmp (&dm[1], data, size))))
 928   {
 929     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 930                 "Result already present in datastore\n");
 931     /* FIXME: change API to allow increasing 'replication' counter */
 932     if ((ntohl (dm->priority) > 0) ||
 933         (GNUNET_TIME_absolute_ntoh (dm->expiration).abs_value_us >
 934          expiration.abs_value_us))
 935       plugin->api->update (plugin->api->cls, uid,
 936                            (int32_t) ntohl (dm->priority),
 937                            GNUNET_TIME_absolute_ntoh (dm->expiration),
 938                            check_present_continuation, pc->client);
 939     else
 940     {
 941       transmit_status (pc->client, GNUNET_NO, NULL);
 942       GNUNET_SERVER_client_drop (pc->client);
 943     }
 944     GNUNET_free (pc);
 945   }
 946   else
 947   {
 948     execute_put (pc->client, dm);
 949     GNUNET_SERVER_client_drop (pc->client);
 950     GNUNET_free (pc);
 951   }
 952   return GNUNET_OK;
 953 }
 954
 955
 956 /**
 957  * Handle PUT-message.
 958  *
 959  * @param cls closure
 960  * @param client identification of the client
 961  * @param message the actual message
 962  */
 963 static void
 964 handle_put (void *cls, struct GNUNET_SERVER_Client *client,
 965             const struct GNUNET_MessageHeader *message)
 966 {
 967   const struct DataMessage *dm = check_data (message);
 968   int rid;
 969   struct ReservationList *pos;
 970   struct PutContext *pc;
 971   struct GNUNET_HashCode vhash;
 972   uint32_t size;
 973
 974   if ((dm == NULL) || (ntohl (dm->type) == 0))
 975   {
 976     GNUNET_break (0);
 977     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 978     return;
 979   }
 980   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 981               "Processing `%s' request for `%s' of type %u\n", "PUT",
 982               GNUNET_h2s (&dm->key), ntohl (dm->type));
 983   rid = ntohl (dm->rid);
 984   size = ntohl (dm->size);
 985   if (rid > 0)
 986   {
 987     pos = reservations;
 988     while ((NULL != pos) && (rid != pos->rid))
 989       pos = pos->next;
 990     GNUNET_break (pos != NULL);
 991     if (NULL != pos)
 992     {
 993       GNUNET_break (pos->entries > 0);
 994       GNUNET_break (pos->amount >= size);
 995       pos->entries--;
 996       pos->amount -= size;
 997       reserved -= (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
 998       GNUNET_STATISTICS_set (stats,
 999                              gettext_noop ("# reserved"), reserved,
1000                              GNUNET_NO);
1001     }
1002   }
1003   if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (filter, &dm->key))
1004   {
1005     GNUNET_CRYPTO_hash (&dm[1], size, &vhash);
1006     pc = GNUNET_malloc (sizeof (struct PutContext) + size +
1007                         sizeof (struct DataMessage));
1008     pc->client = client;
1009     GNUNET_SERVER_client_keep (client);
1010     memcpy (&pc[1], dm, size + sizeof (struct DataMessage));
1011     plugin->api->get_key (plugin->api->cls, 0, &dm->key, &vhash,
1012                           ntohl (dm->type), &check_present, pc);
1013     return;
1014   }
1015   execute_put (client, dm);
1016 }
1017
1018
1019 /**
1020  * Handle GET-message.
1021  *
1022  * @param cls closure
1023  * @param client identification of the client
1024  * @param message the actual message
1025  */
1026 static void
1027 handle_get (void *cls, struct GNUNET_SERVER_Client *client,
1028             const struct GNUNET_MessageHeader *message)
1029 {
1030   const struct GetMessage *msg;
1031   uint16_t size;
1032
1033   size = ntohs (message->size);
1034   if ((size != sizeof (struct GetMessage)) &&
1035       (size != sizeof (struct GetMessage) - sizeof (struct GNUNET_HashCode)))
1036   {
1037     GNUNET_break (0);
1038     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1039     return;
1040   }
1041   msg = (const struct GetMessage *) message;
1042   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1043               "Processing `%s' request for `%s' of type %u\n", "GET",
1044               GNUNET_h2s (&msg->key), ntohl (msg->type));
1045   GNUNET_STATISTICS_update (stats,
1046                             gettext_noop ("# GET requests received"), 1,
1047                             GNUNET_NO);
1048   GNUNET_SERVER_client_keep (client);
1049   if ((size == sizeof (struct GetMessage)) &&
1050       (GNUNET_YES != GNUNET_CONTAINER_bloomfilter_test (filter, &msg->key)))
1051   {
1052     /* don't bother database... */
1053     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1054                 "Empty result set for `%s' request for `%s' (bloomfilter).\n",
1055                 "GET", GNUNET_h2s (&msg->key));
1056     GNUNET_STATISTICS_update (stats,
1057                               gettext_noop
1058                               ("# requests filtered by bloomfilter"), 1,
1059                               GNUNET_NO);
1060     transmit_item (client, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS,
1061                    0);
1062     return;
1063   }
1064   plugin->api->get_key (plugin->api->cls, GNUNET_ntohll (msg->offset),
1065                         ((size ==
1066                           sizeof (struct GetMessage)) ? &msg->key : NULL), NULL,
1067                         ntohl (msg->type), &transmit_item, client);
1068 }
1069
1070
1071 static void
1072 update_continuation (void *cls, int status, char *msg)
1073 {
1074   struct GNUNET_SERVER_Client *client = cls;
1075
1076   transmit_status (client, status, msg);
1077   GNUNET_SERVER_client_drop (client);
1078 }
1079
1080
1081 /**
1082  * Handle UPDATE-message.
1083  *
1084  * @param cls closure
1085  * @param client identification of the client
1086  * @param message the actual message
1087  */
1088 static void
1089 handle_update (void *cls, struct GNUNET_SERVER_Client *client,
1090                const struct GNUNET_MessageHeader *message)
1091 {
1092   const struct UpdateMessage *msg;
1093
1094   GNUNET_STATISTICS_update (stats, gettext_noop ("# UPDATE requests received"),
1095                             1, GNUNET_NO);
1096   msg = (const struct UpdateMessage *) message;
1097   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request for %llu\n",
1098               "UPDATE", (unsigned long long) GNUNET_ntohll (msg->uid));
1099   GNUNET_SERVER_client_keep (client);
1100   plugin->api->update (plugin->api->cls, GNUNET_ntohll (msg->uid),
1101                        (int32_t) ntohl (msg->priority),
1102                        GNUNET_TIME_absolute_ntoh (msg->expiration),
1103                        update_continuation, client);
1104 }
1105
1106
1107 /**
1108  * Handle GET_REPLICATION-message.
1109  *
1110  * @param cls closure
1111  * @param client identification of the client
1112  * @param message the actual message
1113  */
1114 static void
1115 handle_get_replication (void *cls, struct GNUNET_SERVER_Client *client,
1116                         const struct GNUNET_MessageHeader *message)
1117 {
1118   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n",
1119               "GET_REPLICATION");
1120   GNUNET_STATISTICS_update (stats,
1121                             gettext_noop
1122                             ("# GET REPLICATION requests received"), 1,
1123                             GNUNET_NO);
1124   GNUNET_SERVER_client_keep (client);
1125   plugin->api->get_replication (plugin->api->cls, &transmit_item, client);
1126 }
1127
1128
1129 /**
1130  * Handle GET_ZERO_ANONYMITY-message.
1131  *
1132  * @param cls closure
1133  * @param client identification of the client
1134  * @param message the actual message
1135  */
1136 static void
1137 handle_get_zero_anonymity (void *cls, struct GNUNET_SERVER_Client *client,
1138                            const struct GNUNET_MessageHeader *message)
1139 {
1140   const struct GetZeroAnonymityMessage *msg =
1141       (const struct GetZeroAnonymityMessage *) message;
1142   enum GNUNET_BLOCK_Type type;
1143
1144   type = (enum GNUNET_BLOCK_Type) ntohl (msg->type);
1145   if (type == GNUNET_BLOCK_TYPE_ANY)
1146   {
1147     GNUNET_break (0);
1148     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1149     return;
1150   }
1151   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n",
1152               "GET_ZERO_ANONYMITY");
1153   GNUNET_STATISTICS_update (stats,
1154                             gettext_noop
1155                             ("# GET ZERO ANONYMITY requests received"), 1,
1156                             GNUNET_NO);
1157   GNUNET_SERVER_client_keep (client);
1158   plugin->api->get_zero_anonymity (plugin->api->cls,
1159                                    GNUNET_ntohll (msg->offset), type,
1160                                    &transmit_item, client);
1161 }
1162
1163
1164 /**
1165  * Callback function that will cause the item that is passed
1166  * in to be deleted (by returning GNUNET_NO).
1167  */
1168 static int
1169 remove_callback (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
1170                  const void *data, enum GNUNET_BLOCK_Type type,
1171                  uint32_t priority, uint32_t anonymity,
1172                  struct GNUNET_TIME_Absolute expiration, uint64_t uid)
1173 {
1174   struct GNUNET_SERVER_Client *client = cls;
1175
1176   if (key == NULL)
1177   {
1178     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1179                 "No further matches for `%s' request.\n", "REMOVE");
1180     transmit_status (client, GNUNET_NO, _("Content not found"));
1181     GNUNET_SERVER_client_drop (client);
1182     return GNUNET_OK;           /* last item */
1183   }
1184   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1185               "Item %llu matches `%s' request for key `%s' and type %u.\n",
1186               (unsigned long long) uid, "REMOVE", GNUNET_h2s (key), type);
1187   GNUNET_STATISTICS_update (stats,
1188                             gettext_noop ("# bytes removed (explicit request)"),
1189                             size, GNUNET_YES);
1190   GNUNET_CONTAINER_bloomfilter_remove (filter, key);
1191   transmit_status (client, GNUNET_OK, NULL);
1192   GNUNET_SERVER_client_drop (client);
1193   return GNUNET_NO;
1194 }
1195
1196
1197 /**
1198  * Handle REMOVE-message.
1199  *
1200  * @param cls closure
1201  * @param client identification of the client
1202  * @param message the actual message
1203  */
1204 static void
1205 handle_remove (void *cls, struct GNUNET_SERVER_Client *client,
1206                const struct GNUNET_MessageHeader *message)
1207 {
1208   const struct DataMessage *dm = check_data (message);
1209   struct GNUNET_HashCode vhash;
1210
1211   if (dm == NULL)
1212   {
1213     GNUNET_break (0);
1214     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1215     return;
1216   }
1217   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1218               "Processing `%s' request for `%s' of type %u\n", "REMOVE",
1219               GNUNET_h2s (&dm->key), ntohl (dm->type));
1220   GNUNET_STATISTICS_update (stats, gettext_noop ("# REMOVE requests received"),
1221                             1, GNUNET_NO);
1222   GNUNET_SERVER_client_keep (client);
1223   GNUNET_CRYPTO_hash (&dm[1], ntohl (dm->size), &vhash);
1224   plugin->api->get_key (plugin->api->cls, 0, &dm->key, &vhash,
1225                         (enum GNUNET_BLOCK_Type) ntohl (dm->type),
1226                         &remove_callback, client);
1227 }
1228
1229
1230 /**
1231  * Handle DROP-message.
1232  *
1233  * @param cls closure
1234  * @param client identification of the client
1235  * @param message the actual message
1236  */
1237 static void
1238 handle_drop (void *cls, struct GNUNET_SERVER_Client *client,
1239              const struct GNUNET_MessageHeader *message)
1240 {
1241   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1242               "Processing `%s' request\n",
1243               "DROP");
1244   do_drop = GNUNET_YES;
1245   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1246 }
1247
1248
1249 /**
1250  * Function called by plugins to notify us about a
1251  * change in their disk utilization.
1252  *
1253  * @param cls closure (NULL)
1254  * @param delta change in disk utilization,
1255  *        0 for "reset to empty"
1256  */
1257 static void
1258 disk_utilization_change_cb (void *cls,
1259                             int delta)
1260 {
1261   if ((delta < 0) && (payload < -delta))
1262   {
1263     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1264                 _("Datastore payload must have been inaccurate (%lld < %lld). Recomputing it.\n"),
1265                 (long long) payload,
1266                 (long long) -delta);
1267     plugin->api->estimate_size (plugin->api->cls, &payload);
1268     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1269                 _("New payload: %lld\n"),
1270                 (long long) payload);
1271      sync_stats ();
1272     return;
1273   }
1274   payload += delta;
1275   last_sync++;
1276   if (last_sync >= MAX_STAT_SYNC_LAG)
1277     sync_stats ();
1278 }
1279
1280
1281 /**
1282  * Callback function to process statistic values.
1283  *
1284  * @param cls closure (struct Plugin*)
1285  * @param subsystem name of subsystem that created the statistic
1286  * @param name the name of the datum
1287  * @param value the current value
1288  * @param is_persistent #GNUNET_YES if the value is persistent, #GNUNET_NO if not
1289  * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration
1290  */
1291 static int
1292 process_stat_in (void *cls,
1293                  const char *subsystem,
1294                  const char *name,
1295                  uint64_t value,
1296                  int is_persistent)
1297 {
1298   GNUNET_assert (GNUNET_NO == stats_worked);
1299   stats_worked = GNUNET_YES;
1300   payload += value;
1301   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1302               "Notification from statistics about existing payload (%llu), new payload is %llu\n",
1303               value, payload);
1304   return GNUNET_OK;
1305 }
1306
1307
1308 /**
1309  * Load the datastore plugin.
1310  */
1311 static struct DatastorePlugin *
1312 load_plugin ()
1313 {
1314   struct DatastorePlugin *ret;
1315   char *libname;
1316
1317   ret = GNUNET_new (struct DatastorePlugin);
1318   ret->env.cfg = cfg;
1319   ret->env.duc = &disk_utilization_change_cb;
1320   ret->env.cls = NULL;
1321   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1322               _("Loading `%s' datastore plugin\n"),
1323               plugin_name);
1324   GNUNET_asprintf (&libname,
1325                    "libgnunet_plugin_datastore_%s",
1326                    plugin_name);
1327   ret->short_name = GNUNET_strdup (plugin_name);
1328   ret->lib_name = libname;
1329   ret->api = GNUNET_PLUGIN_load (libname, &ret->env);
1330   if (NULL == ret->api)
1331   {
1332     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1333                 _("Failed to load datastore plugin for `%s'\n"),
1334                 plugin_name);
1335     GNUNET_free (ret->short_name);
1336     GNUNET_free (libname);
1337     GNUNET_free (ret);
1338     return NULL;
1339   }
1340   return ret;
1341 }
1342
1343
1344 /**
1345  * Function called when the service shuts
1346  * down.  Unloads our datastore plugin.
1347  *
1348  * @param plug plugin to unload
1349  */
1350 static void
1351 unload_plugin (struct DatastorePlugin *plug)
1352 {
1353   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1354               "Datastore service is unloading plugin...\n");
1355   GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
1356   GNUNET_free (plug->lib_name);
1357   GNUNET_free (plug->short_name);
1358   GNUNET_free (plug);
1359 }
1360
1361
1362 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1363   {&handle_reserve, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE,
1364    sizeof (struct ReserveMessage)},
1365   {&handle_release_reserve, NULL,
1366    GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE,
1367    sizeof (struct ReleaseReserveMessage)},
1368   {&handle_put, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_PUT, 0},
1369   {&handle_update, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_UPDATE,
1370    sizeof (struct UpdateMessage)},
1371   {&handle_get, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_GET, 0},
1372   {&handle_get_replication, NULL,
1373    GNUNET_MESSAGE_TYPE_DATASTORE_GET_REPLICATION,
1374    sizeof (struct GNUNET_MessageHeader)},
1375   {&handle_get_zero_anonymity, NULL,
1376    GNUNET_MESSAGE_TYPE_DATASTORE_GET_ZERO_ANONYMITY,
1377    sizeof (struct GetZeroAnonymityMessage)},
1378   {&handle_remove, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_REMOVE, 0},
1379   {&handle_drop, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_DROP,
1380    sizeof (struct GNUNET_MessageHeader)},
1381   {NULL, NULL, 0, 0}
1382 };
1383
1384
1385 /**
1386  * Adds a given @a key to the bloomfilter in @a cls @a count times.
1387  *
1388  * @param cls the bloomfilter
1389  * @param key key to add
1390  * @param count number of times to add key
1391  */
1392 static void
1393 add_key_to_bloomfilter (void *cls,
1394                         const struct GNUNET_HashCode *key,
1395                         unsigned int count)
1396 {
1397   struct GNUNET_CONTAINER_BloomFilter *bf = cls;
1398
1399   if (NULL == key)
1400   {
1401     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1402                 _("Bloomfilter construction complete.\n"));
1403     GNUNET_SERVER_add_handlers (server, handlers);
1404     GNUNET_SERVER_resume (server);
1405     expired_kill_task
1406       = GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
1407                                             &delete_expired,
1408                                             NULL);
1409     return;
1410   }
1411
1412   while (0 < count--)
1413     GNUNET_CONTAINER_bloomfilter_add (bf, key);
1414 }
1415
1416
1417 /**
1418  * We finished receiving the statistic.  Initialize the plugin; if
1419  * loading the statistic failed, run the estimator.
1420  *
1421  * @param cls NULL
1422  * @param success #GNUNET_NO if we failed to read the stat
1423  */
1424 static void
1425 process_stat_done (void *cls, int success)
1426 {
1427
1428   stat_get = NULL;
1429   plugin = load_plugin ();
1430   if (NULL == plugin)
1431   {
1432     GNUNET_CONTAINER_bloomfilter_free (filter);
1433     filter = NULL;
1434     if (NULL != stats)
1435     {
1436       GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1437       stats = NULL;
1438     }
1439     return;
1440   }
1441   if (GNUNET_NO == stats_worked)
1442   {
1443     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1444                 "Failed to obtain value from statistics service, recomputing it\n");
1445     plugin->api->estimate_size (plugin->api->cls, &payload);
1446   }
1447   if (GNUNET_YES == refresh_bf)
1448   {
1449     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1450                 _("Rebuilding bloomfilter.  Please be patient.\n"));
1451     if (NULL != plugin->api->get_keys)
1452     {
1453       plugin->api->get_keys (plugin->api->cls,
1454                              &add_key_to_bloomfilter,
1455                              filter);
1456       return;
1457     }
1458     else
1459       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1460                   _("Plugin does not support get_keys function. Please fix!\n"));
1461
1462     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1463                 _("Bloomfilter construction complete.\n"));
1464   }
1465
1466   GNUNET_SERVER_add_handlers (server, handlers);
1467   GNUNET_SERVER_resume (server);
1468   expired_kill_task
1469     = GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
1470                                           &delete_expired,
1471                                           NULL);
1472 }
1473
1474
1475 /**
1476  * Task run during shutdown.
1477  */
1478 static void
1479 cleaning_task (void *cls,
1480                const struct GNUNET_SCHEDULER_TaskContext *tc)
1481 {
1482   struct TransmitCallbackContext *tcc;
1483
1484   cleaning_done = GNUNET_YES;
1485   while (NULL != (tcc = tcc_head))
1486   {
1487     GNUNET_CONTAINER_DLL_remove (tcc_head, tcc_tail, tcc);
1488     if (tcc->th != NULL)
1489     {
1490       GNUNET_SERVER_notify_transmit_ready_cancel (tcc->th);
1491       GNUNET_SERVER_client_drop (tcc->client);
1492     }
1493     GNUNET_free (tcc->msg);
1494     GNUNET_free (tcc);
1495   }
1496   if (NULL != expired_kill_task)
1497   {
1498     GNUNET_SCHEDULER_cancel (expired_kill_task);
1499     expired_kill_task = NULL;
1500   }
1501   if (GNUNET_YES == do_drop)
1502     plugin->api->drop (plugin->api->cls);
1503   if (NULL != plugin)
1504   {
1505     unload_plugin (plugin);
1506     plugin = NULL;
1507   }
1508   if (NULL != filter)
1509   {
1510     GNUNET_CONTAINER_bloomfilter_free (filter);
1511     filter = NULL;
1512   }
1513   if (NULL != stat_get)
1514   {
1515     GNUNET_STATISTICS_get_cancel (stat_get);
1516     stat_get = NULL;
1517   }
1518   GNUNET_free_non_null (plugin_name);
1519   plugin_name = NULL;
1520   if (last_sync > 0)
1521     sync_stats ();
1522   if (NULL != stats)
1523   {
1524     GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1525     stats = NULL;
1526   }
1527   GNUNET_free (quota_stat_name);
1528   quota_stat_name = NULL;
1529 }
1530
1531
1532 /**
1533  * Function that removes all active reservations made
1534  * by the given client and releases the space for other
1535  * requests.
1536  *
1537  * @param cls closure
1538  * @param client identification of the client
1539  */
1540 static void
1541 cleanup_reservations (void *cls,
1542                       struct GNUNET_SERVER_Client *client)
1543 {
1544   struct ReservationList *pos;
1545   struct ReservationList *prev;
1546   struct ReservationList *next;
1547
1548   if (NULL == client)
1549     return;
1550   prev = NULL;
1551   pos = reservations;
1552   while (NULL != pos)
1553   {
1554     next = pos->next;
1555     if (pos->client == client)
1556     {
1557       if (NULL == prev)
1558         reservations = next;
1559       else
1560         prev->next = next;
1561       reserved -= pos->amount + pos->entries * GNUNET_DATASTORE_ENTRY_OVERHEAD;
1562       GNUNET_free (pos);
1563     }
1564     else
1565     {
1566       prev = pos;
1567     }
1568     pos = next;
1569   }
1570   GNUNET_STATISTICS_set (stats, gettext_noop ("# reserved"), reserved,
1571                          GNUNET_NO);
1572 }
1573
1574
1575 /**
1576  * Process datastore requests.
1577  *
1578  * @param cls closure
1579  * @param serv the initialized server
1580  * @param c configuration to use
1581  */
1582 static void
1583 run (void *cls,
1584      struct GNUNET_SERVER_Handle *serv,
1585      const struct GNUNET_CONFIGURATION_Handle *c)
1586 {
1587   char *fn;
1588   char *pfn;
1589   unsigned int bf_size;
1590
1591   server = serv;
1592   cfg = c;
1593   if (GNUNET_OK !=
1594       GNUNET_CONFIGURATION_get_value_string (cfg, "DATASTORE", "DATABASE",
1595                                              &plugin_name))
1596   {
1597     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1598                 _("No `%s' specified for `%s' in configuration!\n"), "DATABASE",
1599                 "DATASTORE");
1600     return;
1601   }
1602   GNUNET_asprintf (&quota_stat_name,
1603                    _("# bytes used in file-sharing datastore `%s'"),
1604                    plugin_name);
1605   if (GNUNET_OK !=
1606       GNUNET_CONFIGURATION_get_value_size (cfg, "DATASTORE", "QUOTA", &quota))
1607   {
1608     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1609                 _("No `%s' specified for `%s' in configuration!\n"), "QUOTA",
1610                 "DATASTORE");
1611     return;
1612   }
1613   stats = GNUNET_STATISTICS_create ("datastore", cfg);
1614   GNUNET_STATISTICS_set (stats, gettext_noop ("# quota"), quota, GNUNET_NO);
1615   cache_size = quota / 8;       /* Or should we make this an option? */
1616   GNUNET_STATISTICS_set (stats, gettext_noop ("# cache size"), cache_size,
1617                          GNUNET_NO);
1618   if (quota / (32 * 1024LL) > (1 << 31))
1619     bf_size = (1 << 31);          /* absolute limit: ~2 GB, beyond that BF just won't help anyway */
1620   else
1621     bf_size = quota / (32 * 1024LL);         /* 8 bit per entry, 1 bit per 32 kb in DB */
1622   fn = NULL;
1623   if ((GNUNET_OK !=
1624        GNUNET_CONFIGURATION_get_value_filename (cfg, "DATASTORE", "BLOOMFILTER",
1625                                                 &fn)) ||
1626       (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn)))
1627   {
1628     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1629                 _("Could not use specified filename `%s' for bloomfilter.\n"),
1630                 NULL != fn ? fn : "");
1631     GNUNET_free_non_null (fn);
1632     fn = NULL;
1633   }
1634   if (NULL != fn)
1635   {
1636     GNUNET_asprintf (&pfn, "%s.%s", fn, plugin_name);
1637     if (GNUNET_YES == GNUNET_DISK_file_test (pfn))
1638     {
1639       filter = GNUNET_CONTAINER_bloomfilter_load (pfn, bf_size, 5);        /* approx. 3% false positives at max use */
1640       if (NULL == filter)
1641       {
1642         /* file exists but not valid, remove and try again, but refresh */
1643         if (0 != UNLINK (pfn))
1644         {
1645           /* failed to remove, run without file */
1646           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1647                       _("Failed to remove bogus bloomfilter file `%s'\n"),
1648                       pfn);
1649           GNUNET_free (pfn);
1650           pfn = NULL;
1651           filter = GNUNET_CONTAINER_bloomfilter_load (NULL, bf_size, 5);        /* approx. 3% false positives at max use */
1652           refresh_bf = GNUNET_YES;
1653         }
1654         else
1655         {
1656           /* try again after remove */
1657           filter = GNUNET_CONTAINER_bloomfilter_load (pfn, bf_size, 5);        /* approx. 3% false positives at max use */
1658           refresh_bf = GNUNET_YES;
1659           if (NULL == filter)
1660           {
1661             /* failed yet again, give up on using file */
1662             GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1663                         _("Failed to remove bogus bloomfilter file `%s'\n"),
1664                         pfn);
1665             GNUNET_free (pfn);
1666             pfn = NULL;
1667             filter = GNUNET_CONTAINER_bloomfilter_init (NULL, bf_size, 5);        /* approx. 3% false positives at max use */
1668           }
1669         }
1670       }
1671       else
1672       {
1673         /* normal case: have an existing valid bf file, no need to refresh */
1674         refresh_bf = GNUNET_NO;
1675       }
1676     }
1677     else
1678     {
1679       filter = GNUNET_CONTAINER_bloomfilter_load (pfn, bf_size, 5);        /* approx. 3% false positives at max use */
1680       refresh_bf = GNUNET_YES;
1681     }
1682     GNUNET_free (pfn);
1683   }
1684   else
1685   {
1686     filter = GNUNET_CONTAINER_bloomfilter_init (NULL, bf_size, 5);      /* approx. 3% false positives at max use */
1687     refresh_bf = GNUNET_YES;
1688   }
1689   GNUNET_free_non_null (fn);
1690   if (NULL == filter)
1691   {
1692     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1693                 _("Failed to initialize bloomfilter.\n"));
1694     if (NULL != stats)
1695     {
1696       GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1697       stats = NULL;
1698     }
1699     return;
1700   }
1701   GNUNET_SERVER_suspend (server);
1702   stat_get =
1703       GNUNET_STATISTICS_get (stats,
1704                              "datastore",
1705                              quota_stat_name,
1706                              GNUNET_TIME_UNIT_SECONDS,
1707                              &process_stat_done,
1708                              &process_stat_in,
1709                              NULL);
1710   if (NULL == stat_get)
1711     process_stat_done (NULL, GNUNET_SYSERR);
1712   GNUNET_SERVER_disconnect_notify (server,
1713                                    &cleanup_reservations,
1714                                    NULL);
1715   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1716                                 &cleaning_task,
1717                                 NULL);
1718 }
1719
1720
1721 /**
1722  * The main function for the datastore service.
1723  *
1724  * @param argc number of arguments from the command line
1725  * @param argv command line arguments
1726  * @return 0 ok, 1 on error
1727  */
1728 int
1729 main (int argc,
1730       char *const *argv)
1731 {
1732   int ret;
1733
1734   ret =
1735       (GNUNET_OK ==
1736        GNUNET_SERVICE_run (argc, argv, "datastore",
1737                            GNUNET_SERVICE_OPTION_NONE,
1738                            &run, NULL)) ? 0 : 1;
1739   return ret;
1740 }
1741
1742
1743 /* end of gnunet-service-datastore.c */