2 This file is part of GNUnet.
3 (C) 2009, 2010 Christian Grothoff (and other contributing authors)
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 fs/gnunet-service-fs_indexing.c
23 * @brief program that provides indexing functions of the file-sharing service
24 * @author Christian Grothoff
28 #include "gnunet_core_service.h"
29 #include "gnunet_datastore_service.h"
30 #include "gnunet_peer_lib.h"
31 #include "gnunet_protocols.h"
32 #include "gnunet_signatures.h"
33 #include "gnunet_util_lib.h"
34 #include "gnunet-service-fs.h"
35 #include "gnunet-service-fs_indexing.h"
39 * In-memory information about indexed files (also available
46 * This is a linked list.
48 struct IndexInfo *next;
51 * Name of the indexed file. Memory allocated
52 * at the end of this struct (do not free).
57 * Context for transmitting confirmation to client,
58 * NULL if we've done this already.
60 struct GNUNET_SERVER_TransmitContext *tc;
63 * Context for hashing of the file.
65 struct GNUNET_CRYPTO_FileHashContext *fhc;
68 * Hash of the contents of the file.
70 struct GNUNET_HashCode file_id;
76 * Linked list of indexed files.
78 static struct IndexInfo *indexed_files;
81 * Maps hash over content of indexed files to the respective filename.
82 * The filenames are pointers into the indexed_files linked list and
83 * do not need to be freed.
85 static struct GNUNET_CONTAINER_MultiHashMap *ifm;
90 static const struct GNUNET_CONFIGURATION_Handle *cfg;
93 * Datastore handle. Created and destroyed by code in
94 * gnunet-service-fs (this is an alias).
96 static struct GNUNET_DATASTORE_Handle *dsh;
100 * Write the current index information list to disk.
105 struct GNUNET_BIO_WriteHandle *wh;
107 struct IndexInfo *pos;
110 GNUNET_CONFIGURATION_get_value_filename (cfg, "FS", "INDEXDB", &fn))
112 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
116 wh = GNUNET_BIO_write_open (fn);
119 GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
120 _("Could not open `%s'.\n"), fn);
128 GNUNET_BIO_write (wh, &pos->file_id, sizeof (struct GNUNET_HashCode))) ||
129 (GNUNET_OK != GNUNET_BIO_write_string (wh, pos->filename)))
133 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
135 GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
136 _("Error writing `%s'.\n"), fn);
145 * Read index information from disk.
150 struct GNUNET_BIO_ReadHandle *rh;
152 struct IndexInfo *pos;
154 struct GNUNET_HashCode hc;
159 GNUNET_CONFIGURATION_get_value_filename (cfg, "FS", "INDEXDB", &fn))
161 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
165 if (GNUNET_NO == GNUNET_DISK_file_test (fn))
167 /* no index info yet */
171 rh = GNUNET_BIO_read_open (fn);
174 GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
175 _("Could not open `%s'.\n"), fn);
180 GNUNET_BIO_read (rh, "Hash of indexed file", &hc,
181 sizeof (struct GNUNET_HashCode))) &&
183 GNUNET_BIO_read_string (rh, "Name of indexed file", &fname,
184 1024 * 16)) && (fname != NULL))
186 slen = strlen (fname) + 1;
187 pos = GNUNET_malloc (sizeof (struct IndexInfo) + slen);
189 pos->filename = (const char *) &pos[1];
190 memcpy (&pos[1], fname, slen);
192 GNUNET_CONTAINER_multihashmap_put (ifm, &hc, (void *) pos->filename,
193 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
199 pos->next = indexed_files;
204 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
211 * We've validated the hash of the file we're about to index. Signal
212 * success to the client and update our internal data structures.
214 * @param ii the index info entry for the request
217 signal_index_ok (struct IndexInfo *ii)
220 GNUNET_CONTAINER_multihashmap_put (ifm, &ii->file_id,
221 (void *) ii->filename,
222 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
224 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
226 ("Index request received for file `%s' is already indexed as `%s'. Permitting anyway.\n"),
228 (const char *) GNUNET_CONTAINER_multihashmap_get (ifm,
230 GNUNET_SERVER_transmit_context_append_data (ii->tc, NULL, 0,
231 GNUNET_MESSAGE_TYPE_FS_INDEX_START_OK);
232 GNUNET_SERVER_transmit_context_run (ii->tc, GNUNET_TIME_UNIT_MINUTES);
236 ii->next = indexed_files;
239 GNUNET_SERVER_transmit_context_append_data (ii->tc, NULL, 0,
240 GNUNET_MESSAGE_TYPE_FS_INDEX_START_OK);
241 GNUNET_SERVER_transmit_context_run (ii->tc, GNUNET_TIME_UNIT_MINUTES);
247 * Function called once the hash computation over an
248 * indexed file has completed.
250 * @param cls closure, our publishing context
251 * @param res resulting hash, NULL on error
254 hash_for_index_val (void *cls, const struct GNUNET_HashCode * res)
256 struct IndexInfo *ii = cls;
260 (0 != memcmp (res, &ii->file_id, sizeof (struct GNUNET_HashCode))))
262 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
264 ("Hash mismatch trying to index file `%s' which has hash `%s'\n"),
265 ii->filename, GNUNET_h2s (res));
266 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Wanted `%s'\n",
267 GNUNET_h2s (&ii->file_id));
268 GNUNET_SERVER_transmit_context_append_data (ii->tc, NULL, 0,
269 GNUNET_MESSAGE_TYPE_FS_INDEX_START_FAILED);
270 GNUNET_SERVER_transmit_context_run (ii->tc, GNUNET_TIME_UNIT_MINUTES);
274 signal_index_ok (ii);
279 * Handle INDEX_START-message.
282 * @param client identification of the client
283 * @param message the actual message
286 GNUNET_FS_handle_index_start (void *cls, struct GNUNET_SERVER_Client *client,
287 const struct GNUNET_MessageHeader *message)
289 const struct IndexStartMessage *ism;
292 struct IndexInfo *ii;
299 msize = ntohs (message->size);
300 if ((msize <= sizeof (struct IndexStartMessage)) ||
301 (((const char *) message)[msize - 1] != '\0'))
304 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
307 ism = (const struct IndexStartMessage *) message;
308 if (0 != ism->reserved)
311 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
314 fn = GNUNET_STRINGS_filename_expand ((const char *) &ism[1]);
317 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
320 dev = GNUNET_ntohll (ism->device);
321 ino = GNUNET_ntohll (ism->inode);
322 ism = (const struct IndexStartMessage *) message;
323 slen = strlen (fn) + 1;
324 ii = GNUNET_malloc (sizeof (struct IndexInfo) + slen);
325 ii->filename = (const char *) &ii[1];
326 memcpy (&ii[1], fn, slen);
327 ii->file_id = ism->file_id;
328 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message for file `%s'\n",
329 "START_INDEX", ii->filename);
330 ii->tc = GNUNET_SERVER_transmit_context_create (client);
333 if (((dev != 0) || (ino != 0)) &&
334 (GNUNET_OK == GNUNET_DISK_file_get_identifiers (fn, &mydev, &myino)) &&
335 ((dev == mydev) && (ino == myino)))
337 /* fast validation OK! */
338 signal_index_ok (ii);
342 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
343 "Mismatch in file identifiers (%llu != %llu or %u != %u), need to hash.\n",
344 (unsigned long long) ino, (unsigned long long) myino,
345 (unsigned int) dev, (unsigned int) mydev);
346 /* slow validation, need to hash full file (again) */
348 GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE, fn,
349 HASHING_BLOCKSIZE, &hash_for_index_val, ii);
351 hash_for_index_val (ii, NULL);
357 * Handle INDEX_LIST_GET-message.
360 * @param client identification of the client
361 * @param message the actual message
364 GNUNET_FS_handle_index_list_get (void *cls, struct GNUNET_SERVER_Client *client,
365 const struct GNUNET_MessageHeader *message)
367 struct GNUNET_SERVER_TransmitContext *tc;
368 struct IndexInfoMessage *iim;
369 char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1] GNUNET_ALIGN;
372 struct IndexInfo *pos;
374 tc = GNUNET_SERVER_transmit_context_create (client);
375 iim = (struct IndexInfoMessage *) buf;
380 slen = strlen (fn) + 1;
381 if (slen + sizeof (struct IndexInfoMessage) >=
382 GNUNET_SERVER_MAX_MESSAGE_SIZE)
387 iim->header.type = htons (GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY);
388 iim->header.size = htons (slen + sizeof (struct IndexInfoMessage));
390 iim->file_id = pos->file_id;
391 memcpy (&iim[1], fn, slen);
392 GNUNET_SERVER_transmit_context_append_message (tc, &iim->header);
395 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
396 GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_END);
397 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_MINUTES);
402 * Handle UNINDEX-message.
405 * @param client identification of the client
406 * @param message the actual message
409 GNUNET_FS_handle_unindex (void *cls, struct GNUNET_SERVER_Client *client,
410 const struct GNUNET_MessageHeader *message)
412 const struct UnindexMessage *um;
413 struct IndexInfo *pos;
414 struct IndexInfo *prev;
415 struct IndexInfo *next;
416 struct GNUNET_SERVER_TransmitContext *tc;
419 um = (const struct UnindexMessage *) message;
420 if (0 != um->reserved)
423 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
432 if (0 == memcmp (&pos->file_id, &um->file_id, sizeof (struct GNUNET_HashCode)))
435 indexed_files = next;
438 GNUNET_break (GNUNET_OK ==
439 GNUNET_CONTAINER_multihashmap_remove (ifm, &pos->file_id,
451 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
452 "Client requested unindexing of file `%s': %s\n",
453 GNUNET_h2s (&um->file_id), found ? "found" : "not found");
454 if (GNUNET_YES == found)
456 tc = GNUNET_SERVER_transmit_context_create (client);
457 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
458 GNUNET_MESSAGE_TYPE_FS_UNINDEX_OK);
459 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_MINUTES);
464 * Continuation called from datastore's remove
468 * @param success did the deletion work?
469 * @param min_expiration minimum expiration time required for content to be stored
470 * @param msg error message
473 remove_cont (void *cls, int success,
474 struct GNUNET_TIME_Absolute min_expiration,
477 if (GNUNET_OK != success)
478 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
479 _("Failed to delete bogus block: %s\n"), msg);
484 * We've received an on-demand encoded block from the datastore.
485 * Attempt to do on-demand encoding and (if successful), call the
486 * continuation with the resulting block. On error, clean up and ask
487 * the datastore for more results.
489 * @param key key for the content
490 * @param size number of bytes in data
491 * @param data content stored
492 * @param type type of the content
493 * @param priority priority of the content
494 * @param anonymity anonymity-level for the content
495 * @param expiration expiration time for the content
496 * @param uid unique identifier for the datum;
497 * maybe 0 if no unique identifier is available
498 * @param cont function to call with the actual block (at most once, on success)
499 * @param cont_cls closure for cont
500 * @return GNUNET_OK on success
503 GNUNET_FS_handle_on_demand_block (const struct GNUNET_HashCode * key, uint32_t size,
504 const void *data, enum GNUNET_BLOCK_Type type,
505 uint32_t priority, uint32_t anonymity,
506 struct GNUNET_TIME_Absolute expiration,
508 GNUNET_DATASTORE_DatumProcessor cont,
511 const struct OnDemandBlock *odb;
512 struct GNUNET_HashCode nkey;
513 struct GNUNET_CRYPTO_AesSessionKey skey;
514 struct GNUNET_CRYPTO_AesInitializationVector iv;
515 struct GNUNET_HashCode query;
517 char ndata[DBLOCK_SIZE];
518 char edata[DBLOCK_SIZE];
520 struct GNUNET_DISK_FileHandle *fh;
523 if (size != sizeof (struct OnDemandBlock))
526 GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1,
527 GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
528 return GNUNET_SYSERR;
530 odb = (const struct OnDemandBlock *) data;
531 off = GNUNET_ntohll (odb->offset);
532 fn = (const char *) GNUNET_CONTAINER_multihashmap_get (ifm, &odb->file_id);
533 if ((NULL == fn) || (0 != ACCESS (fn, R_OK)))
535 GNUNET_STATISTICS_update (GSF_stats,
537 ("# index blocks removed: original file inaccessible"),
539 GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1,
540 GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
541 return GNUNET_SYSERR;
545 GNUNET_DISK_file_open (fn, GNUNET_DISK_OPEN_READ,
546 GNUNET_DISK_PERM_NONE))) ||
547 (off != GNUNET_DISK_file_seek (fh, off, GNUNET_DISK_SEEK_SET)) ||
548 (-1 == (nsize = GNUNET_DISK_file_read (fh, ndata, sizeof (ndata)))))
550 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
552 ("Could not access indexed file `%s' (%s) at offset %llu: %s\n"),
553 GNUNET_h2s (&odb->file_id), fn, (unsigned long long) off,
554 (fn == NULL) ? _("not indexed") : STRERROR (errno));
556 GNUNET_DISK_file_close (fh);
557 GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1,
558 GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
559 return GNUNET_SYSERR;
561 GNUNET_DISK_file_close (fh);
562 GNUNET_CRYPTO_hash (ndata, nsize, &nkey);
563 GNUNET_CRYPTO_hash_to_aes_key (&nkey, &skey, &iv);
564 GNUNET_CRYPTO_aes_encrypt (ndata, nsize, &skey, &iv, edata);
565 GNUNET_CRYPTO_hash (edata, nsize, &query);
566 if (0 != memcmp (&query, key, sizeof (struct GNUNET_HashCode)))
568 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
569 _("Indexed file `%s' changed at offset %llu\n"), fn,
570 (unsigned long long) off);
571 GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1,
572 GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
573 return GNUNET_SYSERR;
575 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
576 "On-demand encoded block for query `%s'\n", GNUNET_h2s (key));
577 cont (cont_cls, key, nsize, edata, GNUNET_BLOCK_TYPE_FS_DBLOCK, priority,
578 anonymity, expiration, uid);
584 * Shutdown the module.
587 GNUNET_FS_indexing_done ()
589 struct IndexInfo *pos;
591 GNUNET_CONTAINER_multihashmap_destroy (ifm);
593 while (NULL != (pos = indexed_files))
595 indexed_files = pos->next;
596 if (pos->fhc != NULL)
597 GNUNET_CRYPTO_hash_file_cancel (pos->fhc);
605 * Initialize the indexing submodule.
607 * @param c configuration to use
608 * @param d datastore to use
611 GNUNET_FS_indexing_init (const struct GNUNET_CONFIGURATION_Handle *c,
612 struct GNUNET_DATASTORE_Handle *d)
616 ifm = GNUNET_CONTAINER_multihashmap_create (128);
621 /* end of gnunet-service-fs_indexing.c */