src/peerstore/gnunet-service-peerstore.c

   1 /*
   2      This file is part of GNUnet.
   3      (C)
   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 peerstore/gnunet-service-peerstore.c
  23  * @brief peerstore service implementation
  24  * @author Omar Tarabai
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "peerstore.h"
  29 #include "gnunet_peerstore_plugin.h"
  30 #include "peerstore_common.h"
  31
  32 /**
  33  * Context of a PEERSTORE watch
  34  */
  35 struct WatchContext
  36 {
  37
  38   /**
  39    * Hash of key of watched record
  40    */
  41   struct GNUNET_HashCode keyhash;
  42
  43   /**
  44    * Client requested the watch
  45    */
  46   struct GNUNET_SERVER_Client *client;
  47
  48 };
  49
  50 /**
  51  * Interval for expired records cleanup (in seconds)
  52  */
  53 #define CLEANUP_INTERVAL 300 /* 5mins */
  54
  55 /**
  56  * Our configuration.
  57  */
  58 static const struct GNUNET_CONFIGURATION_Handle *cfg;
  59
  60 /**
  61  * Database plugin library name
  62  */
  63 char *db_lib_name;
  64
  65 /**
  66  * Database handle
  67  */
  68 static struct GNUNET_PEERSTORE_PluginFunctions *db;
  69
  70 /**
  71  * Hashmap with all watch requests
  72  */
  73 static struct GNUNET_CONTAINER_MultiHashMap *watchers;
  74
  75 /**
  76  * Our notification context.
  77  */
  78 static struct GNUNET_SERVER_NotificationContext *nc;
  79
  80 /**
  81  * Task run during shutdown.
  82  *
  83  * @param cls unused
  84  * @param tc unused
  85  */
  86 static void
  87 shutdown_task (void *cls,
  88                const struct GNUNET_SCHEDULER_TaskContext *tc)
  89 {
  90   if(NULL != db_lib_name)
  91   {
  92     GNUNET_break (NULL == GNUNET_PLUGIN_unload (db_lib_name, db));
  93     GNUNET_free (db_lib_name);
  94     db_lib_name = NULL;
  95   }
  96   GNUNET_SERVER_notification_context_destroy(nc);
  97   GNUNET_CONTAINER_multihashmap_destroy(watchers);
  98   GNUNET_SCHEDULER_shutdown();
  99 }
 100
 101 /**
 102  * Deletes any expired records from storage
 103  */
 104 static void
 105 cleanup_expired_records(void *cls,
 106     const struct GNUNET_SCHEDULER_TaskContext *tc)
 107 {
 108   int deleted;
 109
 110   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 111     return;
 112   GNUNET_assert(NULL != db);
 113   deleted = db->expire_records(db->cls, GNUNET_TIME_absolute_get());
 114   GNUNET_log(GNUNET_ERROR_TYPE_INFO, "%d records expired.\n", deleted);
 115   GNUNET_SCHEDULER_add_delayed(
 116       GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, CLEANUP_INTERVAL),
 117       &cleanup_expired_records, NULL);
 118 }
 119
 120
 121 /**
 122  * A client disconnected.  Remove all of its data structure entries.
 123  *
 124  * @param cls closure, NULL
 125  * @param client identification of the client
 126  */
 127 static void
 128 handle_client_disconnect (void *cls,
 129                           struct GNUNET_SERVER_Client
 130                           * client)
 131 {
 132 }
 133
 134 /**
 135  * Function called by for each matching record.
 136  *
 137  * @param cls closure
 138  * @param peer peer identity
 139  * @param sub_system name of the GNUnet sub system responsible
 140  * @param value stored value
 141  * @param size size of stored value
 142  */
 143 int record_iterator(void *cls,
 144     struct GNUNET_PEERSTORE_Record *record,
 145     char *emsg)
 146 {
 147   struct GNUNET_SERVER_Client *client = cls;
 148   struct StoreRecordMessage *srm;
 149
 150   srm = PEERSTORE_create_record_message(record->sub_system,
 151       record->peer,
 152       record->key,
 153       record->value,
 154       record->value_size,
 155       record->expiry,
 156       GNUNET_MESSAGE_TYPE_PEERSTORE_ITERATE_RECORD);
 157   GNUNET_SERVER_notification_context_unicast(nc, client, (struct GNUNET_MessageHeader *)srm, GNUNET_NO);
 158   return GNUNET_YES;
 159 }
 160
 161 /**
 162  * Iterator over all watcher clients
 163  * to notify them of a new record
 164  *
 165  * @param cls closuer, a 'struct GNUNET_PEERSTORE_Record *'
 166  * @param key hash of record key
 167  * @param value the watcher client, a 'struct GNUNET_SERVER_Client *'
 168  * @return #GNUNET_YES to continue iterating
 169  */
 170 int watch_notifier_it(void *cls,
 171     const struct GNUNET_HashCode *key,
 172     void *value)
 173 {
 174   struct GNUNET_PEERSTORE_Record *record = cls;
 175   struct GNUNET_SERVER_Client *client = value;
 176   struct StoreRecordMessage *srm;
 177
 178   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Found a watcher to update.\n");
 179   if(NULL == value)
 180   {
 181     GNUNET_CONTAINER_multihashmap_remove(watchers, key, value);
 182     return GNUNET_YES;
 183   }
 184   srm = PEERSTORE_create_record_message(record->sub_system,
 185       record->peer,
 186       record->key,
 187       record->value,
 188       record->value_size,
 189       record->expiry,
 190       GNUNET_MESSAGE_TYPE_PEERSTORE_WATCH_RECORD);
 191   GNUNET_SERVER_notification_context_unicast(nc, client,
 192       (const struct GNUNET_MessageHeader *)srm, GNUNET_NO);
 193   return GNUNET_YES;
 194 }
 195
 196 /**
 197  * Given a new record, notifies watchers
 198  *
 199  * @param record changed record to update watchers with
 200  */
 201 void watch_notifier (struct GNUNET_PEERSTORE_Record *record)
 202 {
 203   struct GNUNET_HashCode keyhash;
 204
 205   GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Sending update to any watchers.\n");
 206   PEERSTORE_hash_key(record->sub_system,
 207       record->peer,
 208       record->key,
 209       &keyhash);
 210   GNUNET_CONTAINER_multihashmap_get_multiple(watchers, &keyhash, &watch_notifier_it, record);
 211 }
 212
 213 /**
 214  * Handle a watch cancel request from client
 215  *
 216  * @param cls unused
 217  * @param client identification of the client
 218  * @param message the actual message
 219  */
 220 void handle_watch_cancel (void *cls,
 221     struct GNUNET_SERVER_Client *client,
 222     const struct GNUNET_MessageHeader *message)
 223 {
 224   struct StoreKeyHashMessage *hm;
 225
 226   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received a watch cancel request from client.\n");
 227   hm = (struct StoreKeyHashMessage *) message;
 228   GNUNET_CONTAINER_multihashmap_remove(watchers, &hm->keyhash, client);
 229   GNUNET_SERVER_receive_done(client, GNUNET_OK);
 230 }
 231
 232 /**
 233  * Handle a watch request from client
 234  *
 235  * @param cls unused
 236  * @param client identification of the client
 237  * @param message the actual message
 238  */
 239 void handle_watch (void *cls,
 240     struct GNUNET_SERVER_Client *client,
 241     const struct GNUNET_MessageHeader *message)
 242 {
 243   struct StoreKeyHashMessage *hm;
 244
 245   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received a watch request from client.\n");
 246   hm = (struct StoreKeyHashMessage *) message;
 247   GNUNET_SERVER_client_mark_monitor(client);
 248   GNUNET_SERVER_notification_context_add(nc, client);
 249   GNUNET_CONTAINER_multihashmap_put(watchers, &hm->keyhash,
 250      client, GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 251   GNUNET_SERVER_receive_done(client, GNUNET_OK);
 252 }
 253
 254 /**
 255  * Handle an iterate request from client
 256  *
 257  * @param cls unused
 258  * @param client identification of the client
 259  * @param message the actual message
 260  */
 261 void handle_iterate (void *cls,
 262     struct GNUNET_SERVER_Client *client,
 263     const struct GNUNET_MessageHeader *message)
 264 {
 265   struct GNUNET_PEERSTORE_Record *record;
 266   struct GNUNET_MessageHeader *endmsg;
 267
 268   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received an iterate request from client.\n");
 269   record = PEERSTORE_parse_record_message(message);
 270   if(NULL == record)
 271   {
 272     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Malformed iterate request from client\n");
 273     GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
 274     return;
 275   }
 276   if(NULL == record->sub_system)
 277   {
 278     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Sub system not supplied in client iterate request\n");
 279     GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
 280     return;
 281   }
 282   GNUNET_SERVER_notification_context_add(nc, client);
 283   if(GNUNET_OK == db->iterate_records(db->cls,
 284       record->sub_system,
 285       record->peer,
 286       record->key,
 287       &record_iterator,
 288       client))
 289   {
 290     endmsg = GNUNET_new(struct GNUNET_MessageHeader);
 291     endmsg->size = htons(sizeof(struct GNUNET_MessageHeader));
 292     endmsg->type = htons(GNUNET_MESSAGE_TYPE_PEERSTORE_ITERATE_END);
 293     GNUNET_SERVER_notification_context_unicast(nc, client, endmsg, GNUNET_NO);
 294   }
 295   else
 296   {
 297     GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
 298   }
 299   GNUNET_free(record); /* FIXME: destroy record */
 300 }
 301
 302 /**
 303  * Handle a store request from client
 304  *
 305  * @param cls unused
 306  * @param client identification of the client
 307  * @param message the actual message
 308  */
 309 void handle_store (void *cls,
 310     struct GNUNET_SERVER_Client *client,
 311     const struct GNUNET_MessageHeader *message)
 312 {
 313   struct GNUNET_PEERSTORE_Record *record;
 314
 315   record = PEERSTORE_parse_record_message(message);
 316   if(NULL == record)
 317   {
 318     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Malformed store request from client\n");
 319     GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
 320     return;
 321   }
 322   if(NULL == record->sub_system
 323       || NULL == record->peer
 324       || NULL == record->key)
 325   {
 326     /* FIXME: Destroy record */
 327     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Full key not supplied in client store request\n");
 328     GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
 329     return;
 330   }
 331   GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Received a store request (size: %lu) for sub system `%s', peer `%s', key `%s'\n",
 332       record->value_size,
 333       record->sub_system,
 334       GNUNET_i2s (record->peer),
 335       record->key);
 336   if(GNUNET_OK != db->store_record(db->cls,
 337       record->sub_system,
 338       record->peer,
 339       record->key,
 340       record->value,
 341       record->value_size,
 342       *record->expiry))
 343   {
 344     /* FIXME: Destroy record */
 345     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Failed to store requested value, sqlite database error.");
 346     GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
 347     return;
 348   }
 349   GNUNET_SERVER_receive_done(client, GNUNET_OK);
 350   watch_notifier(record);
 351 }
 352
 353 /**
 354  * Peerstore service runner.
 355  *
 356  * @param cls closure
 357  * @param server the initialized server
 358  * @param c configuration to use
 359  */
 360 static void
 361 run (void *cls,
 362      struct GNUNET_SERVER_Handle *server,
 363      const struct GNUNET_CONFIGURATION_Handle *c)
 364 {
 365   static const struct GNUNET_SERVER_MessageHandler handlers[] = {
 366       {&handle_store, NULL, GNUNET_MESSAGE_TYPE_PEERSTORE_STORE, 0},
 367       {&handle_iterate, NULL, GNUNET_MESSAGE_TYPE_PEERSTORE_ITERATE, 0},
 368       {&handle_watch, NULL, GNUNET_MESSAGE_TYPE_PEERSTORE_WATCH, sizeof(struct StoreKeyHashMessage)},
 369       {&handle_watch_cancel, NULL, GNUNET_MESSAGE_TYPE_PEERSTORE_WATCH_CANCEL, sizeof(struct StoreKeyHashMessage)},
 370       {NULL, NULL, 0, 0}
 371   };
 372   char *database;
 373
 374   cfg = c;
 375   if (GNUNET_OK !=
 376         GNUNET_CONFIGURATION_get_value_string (cfg, "peerstore", "DATABASE",
 377                                                &database))
 378     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "No database backend configured\n");
 379
 380   else
 381   {
 382     GNUNET_asprintf (&db_lib_name, "libgnunet_plugin_peerstore_%s", database);
 383     db = GNUNET_PLUGIN_load(db_lib_name, (void *) cfg);
 384     GNUNET_free(database);
 385   }
 386   if(NULL == db)
 387           GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Could not load database backend `%s'\n", db_lib_name);
 388   else
 389   {
 390     nc = GNUNET_SERVER_notification_context_create (server, 16);
 391     watchers = GNUNET_CONTAINER_multihashmap_create(10, GNUNET_NO);
 392     GNUNET_SCHEDULER_add_now(&cleanup_expired_records, NULL);
 393     GNUNET_SERVER_add_handlers (server, handlers);
 394     GNUNET_SERVER_disconnect_notify (server,
 395              &handle_client_disconnect,
 396              NULL);
 397   }
 398   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
 399                                 &shutdown_task,
 400                                 NULL);
 401 }
 402
 403
 404 /**
 405  * The main function for the peerstore service.
 406  *
 407  * @param argc number of arguments from the command line
 408  * @param argv command line arguments
 409  * @return 0 ok, 1 on error
 410  */
 411 int
 412 main (int argc, char *const *argv)
 413 {
 414   return (GNUNET_OK ==
 415           GNUNET_SERVICE_run (argc,
 416                               argv,
 417                               "peerstore",
 418                               GNUNET_SERVICE_OPTION_NONE,
 419                               &run, NULL)) ? 0 : 1;
 420 }
 421
 422 /* end of gnunet-service-peerstore.c */