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   GNUNET_free(srm);
 159   return GNUNET_YES;
 160 }
 161
 162 /**
 163  * Iterator over all watcher clients
 164  * to notify them of a new record
 165  *
 166  * @param cls closuer, a 'struct GNUNET_PEERSTORE_Record *'
 167  * @param key hash of record key
 168  * @param value the watcher client, a 'struct GNUNET_SERVER_Client *'
 169  * @return #GNUNET_YES to continue iterating
 170  */
 171 int watch_notifier_it(void *cls,
 172     const struct GNUNET_HashCode *key,
 173     void *value)
 174 {
 175   struct GNUNET_PEERSTORE_Record *record = cls;
 176   struct GNUNET_SERVER_Client *client = value;
 177   struct StoreRecordMessage *srm;
 178
 179   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Found a watcher to update.\n");
 180   if(NULL == value)
 181   {
 182     GNUNET_CONTAINER_multihashmap_remove(watchers, key, value);
 183     return GNUNET_YES;
 184   }
 185   srm = PEERSTORE_create_record_message(record->sub_system,
 186       record->peer,
 187       record->key,
 188       record->value,
 189       record->value_size,
 190       record->expiry,
 191       GNUNET_MESSAGE_TYPE_PEERSTORE_WATCH_RECORD);
 192   GNUNET_SERVER_notification_context_unicast(nc, client,
 193       (const struct GNUNET_MessageHeader *)srm, GNUNET_NO);
 194   GNUNET_free(srm);
 195   return GNUNET_YES;
 196 }
 197
 198 /**
 199  * Given a new record, notifies watchers
 200  *
 201  * @param record changed record to update watchers with
 202  */
 203 void watch_notifier (struct GNUNET_PEERSTORE_Record *record)
 204 {
 205   struct GNUNET_HashCode keyhash;
 206
 207   GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Sending update to any watchers.\n");
 208   PEERSTORE_hash_key(record->sub_system,
 209       record->peer,
 210       record->key,
 211       &keyhash);
 212   GNUNET_CONTAINER_multihashmap_get_multiple(watchers, &keyhash, &watch_notifier_it, record);
 213 }
 214
 215 /**
 216  * Handle a watch cancel request from client
 217  *
 218  * @param cls unused
 219  * @param client identification of the client
 220  * @param message the actual message
 221  */
 222 void handle_watch_cancel (void *cls,
 223     struct GNUNET_SERVER_Client *client,
 224     const struct GNUNET_MessageHeader *message)
 225 {
 226   struct StoreKeyHashMessage *hm;
 227
 228   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received a watch cancel request from client.\n");
 229   hm = (struct StoreKeyHashMessage *) message;
 230   GNUNET_CONTAINER_multihashmap_remove(watchers, &hm->keyhash, client);
 231   GNUNET_SERVER_receive_done(client, GNUNET_OK);
 232 }
 233
 234 /**
 235  * Handle a watch request from client
 236  *
 237  * @param cls unused
 238  * @param client identification of the client
 239  * @param message the actual message
 240  */
 241 void handle_watch (void *cls,
 242     struct GNUNET_SERVER_Client *client,
 243     const struct GNUNET_MessageHeader *message)
 244 {
 245   struct StoreKeyHashMessage *hm;
 246
 247   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received a watch request from client.\n");
 248   hm = (struct StoreKeyHashMessage *) message;
 249   GNUNET_SERVER_client_mark_monitor(client);
 250   GNUNET_SERVER_notification_context_add(nc, client);
 251   GNUNET_CONTAINER_multihashmap_put(watchers, &hm->keyhash,
 252      client, GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 253   GNUNET_SERVER_receive_done(client, GNUNET_OK);
 254 }
 255
 256 /**
 257  * Handle an iterate request from client
 258  *
 259  * @param cls unused
 260  * @param client identification of the client
 261  * @param message the actual message
 262  */
 263 void handle_iterate (void *cls,
 264     struct GNUNET_SERVER_Client *client,
 265     const struct GNUNET_MessageHeader *message)
 266 {
 267   struct GNUNET_PEERSTORE_Record *record;
 268   struct GNUNET_MessageHeader *endmsg;
 269
 270   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received an iterate request from client.\n");
 271   record = PEERSTORE_parse_record_message(message);
 272   if(NULL == record)
 273   {
 274     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Malformed iterate request from client\n");
 275     GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
 276     return;
 277   }
 278   if(NULL == record->sub_system)
 279   {
 280     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Sub system not supplied in client iterate request\n");
 281     GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
 282     return;
 283   }
 284   GNUNET_SERVER_notification_context_add(nc, client);
 285   if(GNUNET_OK == db->iterate_records(db->cls,
 286       record->sub_system,
 287       record->peer,
 288       record->key,
 289       &record_iterator,
 290       client))
 291   {
 292     endmsg = GNUNET_new(struct GNUNET_MessageHeader);
 293     endmsg->size = htons(sizeof(struct GNUNET_MessageHeader));
 294     endmsg->type = htons(GNUNET_MESSAGE_TYPE_PEERSTORE_ITERATE_END);
 295     GNUNET_SERVER_notification_context_unicast(nc, client, endmsg, GNUNET_NO);
 296     GNUNET_free(endmsg);
 297     GNUNET_SERVER_receive_done(client, GNUNET_OK);
 298   }
 299   else
 300   {
 301     GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
 302   }
 303   PEERSTORE_destroy_record(record);
 304 }
 305
 306 /**
 307  * Handle a store request from client
 308  *
 309  * @param cls unused
 310  * @param client identification of the client
 311  * @param message the actual message
 312  */
 313 void handle_store (void *cls,
 314     struct GNUNET_SERVER_Client *client,
 315     const struct GNUNET_MessageHeader *message)
 316 {
 317   struct GNUNET_PEERSTORE_Record *record;
 318
 319   record = PEERSTORE_parse_record_message(message);
 320   if(NULL == record)
 321   {
 322     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Malformed store request from client\n");
 323     GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
 324     return;
 325   }
 326   if(NULL == record->sub_system
 327       || NULL == record->peer
 328       || NULL == record->key)
 329   {
 330     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Full key not supplied in client store request\n");
 331     PEERSTORE_destroy_record(record);
 332     GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
 333     return;
 334   }
 335   GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Received a store request (size: %lu) for sub system `%s', peer `%s', key `%s'\n",
 336       record->value_size,
 337       record->sub_system,
 338       GNUNET_i2s (record->peer),
 339       record->key);
 340   if(GNUNET_OK != db->store_record(db->cls,
 341       record->sub_system,
 342       record->peer,
 343       record->key,
 344       record->value,
 345       record->value_size,
 346       *record->expiry))
 347   {
 348     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Failed to store requested value, sqlite database error.");
 349     PEERSTORE_destroy_record(record);
 350     GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
 351     return;
 352   }
 353   GNUNET_SERVER_receive_done(client, GNUNET_OK);
 354   watch_notifier(record);
 355   PEERSTORE_destroy_record(record);
 356 }
 357
 358 /**
 359  * Peerstore service runner.
 360  *
 361  * @param cls closure
 362  * @param server the initialized server
 363  * @param c configuration to use
 364  */
 365 static void
 366 run (void *cls,
 367      struct GNUNET_SERVER_Handle *server,
 368      const struct GNUNET_CONFIGURATION_Handle *c)
 369 {
 370   static const struct GNUNET_SERVER_MessageHandler handlers[] = {
 371       {&handle_store, NULL, GNUNET_MESSAGE_TYPE_PEERSTORE_STORE, 0},
 372       {&handle_iterate, NULL, GNUNET_MESSAGE_TYPE_PEERSTORE_ITERATE, 0},
 373       {&handle_watch, NULL, GNUNET_MESSAGE_TYPE_PEERSTORE_WATCH, sizeof(struct StoreKeyHashMessage)},
 374       {&handle_watch_cancel, NULL, GNUNET_MESSAGE_TYPE_PEERSTORE_WATCH_CANCEL, sizeof(struct StoreKeyHashMessage)},
 375       {NULL, NULL, 0, 0}
 376   };
 377   char *database;
 378
 379   cfg = c;
 380   if (GNUNET_OK !=
 381         GNUNET_CONFIGURATION_get_value_string (cfg, "peerstore", "DATABASE",
 382                                                &database))
 383     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "No database backend configured\n");
 384
 385   else
 386   {
 387     GNUNET_asprintf (&db_lib_name, "libgnunet_plugin_peerstore_%s", database);
 388     db = GNUNET_PLUGIN_load(db_lib_name, (void *) cfg);
 389     GNUNET_free(database);
 390   }
 391   if(NULL == db)
 392           GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Could not load database backend `%s'\n", db_lib_name);
 393   else
 394   {
 395     nc = GNUNET_SERVER_notification_context_create (server, 16);
 396     watchers = GNUNET_CONTAINER_multihashmap_create(10, GNUNET_NO);
 397     GNUNET_SCHEDULER_add_now(&cleanup_expired_records, NULL);
 398     GNUNET_SERVER_add_handlers (server, handlers);
 399     GNUNET_SERVER_disconnect_notify (server,
 400              &handle_client_disconnect,
 401              NULL);
 402   }
 403   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
 404                                 &shutdown_task,
 405                                 NULL);
 406 }
 407
 408
 409 /**
 410  * The main function for the peerstore service.
 411  *
 412  * @param argc number of arguments from the command line
 413  * @param argv command line arguments
 414  * @return 0 ok, 1 on error
 415  */
 416 int
 417 main (int argc, char *const *argv)
 418 {
 419   return (GNUNET_OK ==
 420           GNUNET_SERVICE_run (argc,
 421                               argv,
 422                               "peerstore",
 423                               GNUNET_SERVICE_OPTION_NONE,
 424                               &run, NULL)) ? 0 : 1;
 425 }
 426
 427 /* end of gnunet-service-peerstore.c */