2 This file is part of GNUnet.
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.
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.
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.
22 * @file peerstore/gnunet-service-peerstore.c
23 * @brief peerstore service implementation
24 * @author Omar Tarabai
27 #include "gnunet_util_lib.h"
28 #include "peerstore.h"
29 #include "gnunet_peerstore_plugin.h"
30 #include "peerstore_common.h"
33 * Context of a PEERSTORE watch
39 * Hash of key of watched record
41 struct GNUNET_HashCode keyhash;
44 * Client requested the watch
46 struct GNUNET_SERVER_Client *client;
51 * Interval for expired records cleanup (in seconds)
53 #define CLEANUP_INTERVAL 300 /* 5mins */
58 static const struct GNUNET_CONFIGURATION_Handle *cfg;
61 * Database plugin library name
68 static struct GNUNET_PEERSTORE_PluginFunctions *db;
71 * Hashmap with all watch requests
73 static struct GNUNET_CONTAINER_MultiHashMap *watchers;
76 * Our notification context.
78 static struct GNUNET_SERVER_NotificationContext *nc;
81 * Task run during shutdown.
87 shutdown_task (void *cls,
88 const struct GNUNET_SCHEDULER_TaskContext *tc)
90 if(NULL != db_lib_name)
92 GNUNET_break (NULL == GNUNET_PLUGIN_unload (db_lib_name, db));
93 GNUNET_free (db_lib_name);
96 GNUNET_SERVER_notification_context_destroy(nc);
97 GNUNET_CONTAINER_multihashmap_destroy(watchers);
98 GNUNET_SCHEDULER_shutdown();
102 * Deletes any expired records from storage
105 cleanup_expired_records(void *cls,
106 const struct GNUNET_SCHEDULER_TaskContext *tc)
110 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
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);
122 * A client disconnected. Remove all of its data structure entries.
124 * @param cls closure, NULL
125 * @param client identification of the client
128 handle_client_disconnect (void *cls,
129 struct GNUNET_SERVER_Client
135 * Function called by for each matching record.
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
143 int record_iterator(void *cls,
144 struct GNUNET_PEERSTORE_Record *record,
147 struct GNUNET_SERVER_Client *client = cls;
148 struct StoreRecordMessage *srm;
150 srm = PEERSTORE_create_record_message(record->sub_system,
156 GNUNET_MESSAGE_TYPE_PEERSTORE_ITERATE_RECORD);
157 GNUNET_SERVER_notification_context_unicast(nc, client, (struct GNUNET_MessageHeader *)srm, GNUNET_NO);
162 * Iterator over all watcher clients
163 * to notify them of a new record
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
170 int watch_notifier_it(void *cls,
171 const struct GNUNET_HashCode *key,
174 struct GNUNET_PEERSTORE_Record *record = cls;
175 struct GNUNET_SERVER_Client *client = value;
176 struct StoreRecordMessage *srm;
178 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Found a watcher to update.\n");
181 GNUNET_CONTAINER_multihashmap_remove(watchers, key, value);
184 srm = PEERSTORE_create_record_message(record->sub_system,
190 GNUNET_MESSAGE_TYPE_PEERSTORE_WATCH_RECORD);
191 GNUNET_SERVER_notification_context_unicast(nc, client,
192 (const struct GNUNET_MessageHeader *)srm, GNUNET_NO);
197 * Given a new record, notifies watchers
199 * @param record changed record to update watchers with
201 void watch_notifier (struct GNUNET_PEERSTORE_Record *record)
203 struct GNUNET_HashCode keyhash;
205 GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Sending update to any watchers.\n");
206 PEERSTORE_hash_key(record->sub_system,
210 GNUNET_CONTAINER_multihashmap_get_multiple(watchers, &keyhash, &watch_notifier_it, record);
214 * Handle a watch cancel request from client
217 * @param client identification of the client
218 * @param message the actual message
220 void handle_watch_cancel (void *cls,
221 struct GNUNET_SERVER_Client *client,
222 const struct GNUNET_MessageHeader *message)
224 struct StoreKeyHashMessage *hm;
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);
233 * Handle a watch request from client
236 * @param client identification of the client
237 * @param message the actual message
239 void handle_watch (void *cls,
240 struct GNUNET_SERVER_Client *client,
241 const struct GNUNET_MessageHeader *message)
243 struct StoreKeyHashMessage *hm;
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);
255 * Handle an iterate request from client
258 * @param client identification of the client
259 * @param message the actual message
261 void handle_iterate (void *cls,
262 struct GNUNET_SERVER_Client *client,
263 const struct GNUNET_MessageHeader *message)
265 struct GNUNET_PEERSTORE_Record *record;
266 struct GNUNET_MessageHeader *endmsg;
268 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received an iterate request from client.\n");
269 record = PEERSTORE_parse_record_message(message);
272 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Malformed iterate request from client\n");
273 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
276 if(NULL == record->sub_system)
278 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Sub system not supplied in client iterate request\n");
279 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
282 GNUNET_SERVER_notification_context_add(nc, client);
283 if(GNUNET_OK == db->iterate_records(db->cls,
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);
297 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
299 GNUNET_free(record); /* FIXME: destroy record */
303 * Handle a store request from client
306 * @param client identification of the client
307 * @param message the actual message
309 void handle_store (void *cls,
310 struct GNUNET_SERVER_Client *client,
311 const struct GNUNET_MessageHeader *message)
313 struct GNUNET_PEERSTORE_Record *record;
315 record = PEERSTORE_parse_record_message(message);
318 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Malformed store request from client\n");
319 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
322 if(NULL == record->sub_system
323 || NULL == record->peer
324 || NULL == record->key)
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);
331 GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Received a store request (size: %lu) for sub system `%s', peer `%s', key `%s'\n",
334 GNUNET_i2s (record->peer),
336 if(GNUNET_OK != db->store_record(db->cls,
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);
349 GNUNET_SERVER_receive_done(client, GNUNET_OK);
350 watch_notifier(record);
354 * Peerstore service runner.
357 * @param server the initialized server
358 * @param c configuration to use
362 struct GNUNET_SERVER_Handle *server,
363 const struct GNUNET_CONFIGURATION_Handle *c)
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)},
376 GNUNET_CONFIGURATION_get_value_string (cfg, "peerstore", "DATABASE",
378 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "No database backend configured\n");
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);
387 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Could not load database backend `%s'\n", db_lib_name);
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,
398 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
405 * The main function for the peerstore service.
407 * @param argc number of arguments from the command line
408 * @param argv command line arguments
409 * @return 0 ok, 1 on error
412 main (int argc, char *const *argv)
415 GNUNET_SERVICE_run (argc,
418 GNUNET_SERVICE_OPTION_NONE,
419 &run, NULL)) ? 0 : 1;
422 /* end of gnunet-service-peerstore.c */