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 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 (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
113 _("Configuration option `%s' in section `%s' missing.\n"),
117 wh = GNUNET_BIO_write_open (fn);
120 GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
121 _("Could not open `%s'.\n"), fn);
129 GNUNET_BIO_write (wh, &pos->file_id, sizeof (GNUNET_HashCode))) ||
130 (GNUNET_OK != GNUNET_BIO_write_string (wh, pos->filename)))
134 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
136 GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
137 _("Error writing `%s'.\n"), fn);
146 * Read index information from disk.
151 struct GNUNET_BIO_ReadHandle *rh;
153 struct IndexInfo *pos;
160 GNUNET_CONFIGURATION_get_value_filename (cfg, "FS", "INDEXDB", &fn))
162 GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
163 _("Configuration option `%s' in section `%s' missing.\n"),
167 if (GNUNET_NO == GNUNET_DISK_file_test (fn))
169 /* no index info yet */
173 rh = GNUNET_BIO_read_open (fn);
176 GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
177 _("Could not open `%s'.\n"), fn);
182 GNUNET_BIO_read (rh, "Hash of indexed file", &hc,
183 sizeof (GNUNET_HashCode))) &&
185 GNUNET_BIO_read_string (rh, "Name of indexed file", &fname,
186 1024 * 16)) && (fname != NULL))
188 slen = strlen (fname) + 1;
189 pos = GNUNET_malloc (sizeof (struct IndexInfo) + slen);
191 pos->filename = (const char *) &pos[1];
192 memcpy (&pos[1], fname, slen);
194 GNUNET_CONTAINER_multihashmap_put (ifm, &hc, (void *) pos->filename,
195 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
201 pos->next = indexed_files;
206 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
213 * We've validated the hash of the file we're about to index. Signal
214 * success to the client and update our internal data structures.
216 * @param ii the index info entry for the request
219 signal_index_ok (struct IndexInfo *ii)
222 GNUNET_CONTAINER_multihashmap_put (ifm, &ii->file_id,
223 (void *) ii->filename,
224 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
226 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
228 ("Index request received for file `%s' is already indexed as `%s'. Permitting anyway.\n"),
230 (const char *) GNUNET_CONTAINER_multihashmap_get (ifm,
232 GNUNET_SERVER_transmit_context_append_data (ii->tc, NULL, 0,
233 GNUNET_MESSAGE_TYPE_FS_INDEX_START_OK);
234 GNUNET_SERVER_transmit_context_run (ii->tc, GNUNET_TIME_UNIT_MINUTES);
238 ii->next = indexed_files;
241 GNUNET_SERVER_transmit_context_append_data (ii->tc, NULL, 0,
242 GNUNET_MESSAGE_TYPE_FS_INDEX_START_OK);
243 GNUNET_SERVER_transmit_context_run (ii->tc, GNUNET_TIME_UNIT_MINUTES);
249 * Function called once the hash computation over an
250 * indexed file has completed.
252 * @param cls closure, our publishing context
253 * @param res resulting hash, NULL on error
256 hash_for_index_val (void *cls, const GNUNET_HashCode * res)
258 struct IndexInfo *ii = cls;
262 (0 != memcmp (res, &ii->file_id, sizeof (GNUNET_HashCode))))
264 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
266 ("Hash mismatch trying to index file `%s' which has hash `%s'\n"),
267 ii->filename, GNUNET_h2s (res));
268 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Wanted `%s'\n",
269 GNUNET_h2s (&ii->file_id));
270 GNUNET_SERVER_transmit_context_append_data (ii->tc, NULL, 0,
271 GNUNET_MESSAGE_TYPE_FS_INDEX_START_FAILED);
272 GNUNET_SERVER_transmit_context_run (ii->tc, GNUNET_TIME_UNIT_MINUTES);
276 signal_index_ok (ii);
281 * Handle INDEX_START-message.
284 * @param client identification of the client
285 * @param message the actual message
288 GNUNET_FS_handle_index_start (void *cls, struct GNUNET_SERVER_Client *client,
289 const struct GNUNET_MessageHeader *message)
291 const struct IndexStartMessage *ism;
294 struct IndexInfo *ii;
301 msize = ntohs (message->size);
302 if ((msize <= sizeof (struct IndexStartMessage)) ||
303 (((const char *) message)[msize - 1] != '\0'))
306 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
309 ism = (const struct IndexStartMessage *) message;
310 if (0 != ism->reserved)
313 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
316 fn = GNUNET_STRINGS_filename_expand ((const char *) &ism[1]);
319 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
322 dev = GNUNET_ntohll (ism->device);
323 ino = GNUNET_ntohll (ism->inode);
324 ism = (const struct IndexStartMessage *) message;
325 slen = strlen (fn) + 1;
326 ii = GNUNET_malloc (sizeof (struct IndexInfo) + slen);
327 ii->filename = (const char *) &ii[1];
328 memcpy (&ii[1], fn, slen);
329 ii->file_id = ism->file_id;
330 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message for file `%s'\n",
331 "START_INDEX", ii->filename);
332 ii->tc = GNUNET_SERVER_transmit_context_create (client);
335 if (((dev != 0) || (ino != 0)) &&
336 (GNUNET_OK == GNUNET_DISK_file_get_identifiers (fn, &mydev, &myino)) &&
337 ((dev == mydev) && (ino == myino)))
339 /* fast validation OK! */
340 signal_index_ok (ii);
344 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
345 "Mismatch in file identifiers (%llu != %llu or %u != %u), need to hash.\n",
346 (unsigned long long) ino, (unsigned long long) myino,
347 (unsigned int) dev, (unsigned int) mydev);
348 /* slow validation, need to hash full file (again) */
350 GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE, fn,
351 HASHING_BLOCKSIZE, &hash_for_index_val, ii);
353 hash_for_index_val (ii, NULL);
359 * Handle INDEX_LIST_GET-message.
362 * @param client identification of the client
363 * @param message the actual message
366 GNUNET_FS_handle_index_list_get (void *cls, struct GNUNET_SERVER_Client *client,
367 const struct GNUNET_MessageHeader *message)
369 struct GNUNET_SERVER_TransmitContext *tc;
370 struct IndexInfoMessage *iim;
371 char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
374 struct IndexInfo *pos;
376 tc = GNUNET_SERVER_transmit_context_create (client);
377 iim = (struct IndexInfoMessage *) buf;
382 slen = strlen (fn) + 1;
383 if (slen + sizeof (struct IndexInfoMessage) >=
384 GNUNET_SERVER_MAX_MESSAGE_SIZE)
389 iim->header.type = htons (GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY);
390 iim->header.size = htons (slen + sizeof (struct IndexInfoMessage));
392 iim->file_id = pos->file_id;
393 memcpy (&iim[1], fn, slen);
394 GNUNET_SERVER_transmit_context_append_message (tc, &iim->header);
397 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
398 GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_END);
399 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_MINUTES);
404 * Handle UNINDEX-message.
407 * @param client identification of the client
408 * @param message the actual message
411 GNUNET_FS_handle_unindex (void *cls, struct GNUNET_SERVER_Client *client,
412 const struct GNUNET_MessageHeader *message)
414 const struct UnindexMessage *um;
415 struct IndexInfo *pos;
416 struct IndexInfo *prev;
417 struct IndexInfo *next;
418 struct GNUNET_SERVER_TransmitContext *tc;
421 um = (const struct UnindexMessage *) message;
422 if (0 != um->reserved)
425 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
434 if (0 == memcmp (&pos->file_id, &um->file_id, sizeof (GNUNET_HashCode)))
437 indexed_files = next;
440 GNUNET_break (GNUNET_OK ==
441 GNUNET_CONTAINER_multihashmap_remove (ifm, &pos->file_id,
453 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
454 "Client requested unindexing of file `%s': %s\n",
455 GNUNET_h2s (&um->file_id), found ? "found" : "not found");
456 if (GNUNET_YES == found)
458 tc = GNUNET_SERVER_transmit_context_create (client);
459 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
460 GNUNET_MESSAGE_TYPE_FS_UNINDEX_OK);
461 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_MINUTES);
466 * Continuation called from datastore's remove
470 * @param success did the deletion work?
471 * @param min_expiration minimum expiration time required for content to be stored
472 * @param msg error message
475 remove_cont (void *cls, int success,
476 struct GNUNET_TIME_Absolute min_expiration,
479 if (GNUNET_OK != success)
480 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
481 _("Failed to delete bogus block: %s\n"), msg);
486 * We've received an on-demand encoded block from the datastore.
487 * Attempt to do on-demand encoding and (if successful), call the
488 * continuation with the resulting block. On error, clean up and ask
489 * the datastore for more results.
491 * @param key key for the content
492 * @param size number of bytes in data
493 * @param data content stored
494 * @param type type of the content
495 * @param priority priority of the content
496 * @param anonymity anonymity-level for the content
497 * @param expiration expiration time for the content
498 * @param uid unique identifier for the datum;
499 * maybe 0 if no unique identifier is available
500 * @param cont function to call with the actual block (at most once, on success)
501 * @param cont_cls closure for cont
502 * @return GNUNET_OK on success
505 GNUNET_FS_handle_on_demand_block (const GNUNET_HashCode * key, uint32_t size,
506 const void *data, enum GNUNET_BLOCK_Type type,
507 uint32_t priority, uint32_t anonymity,
508 struct GNUNET_TIME_Absolute expiration,
510 GNUNET_DATASTORE_DatumProcessor cont,
513 const struct OnDemandBlock *odb;
514 GNUNET_HashCode nkey;
515 struct GNUNET_CRYPTO_AesSessionKey skey;
516 struct GNUNET_CRYPTO_AesInitializationVector iv;
517 GNUNET_HashCode query;
519 char ndata[DBLOCK_SIZE];
520 char edata[DBLOCK_SIZE];
522 struct GNUNET_DISK_FileHandle *fh;
525 if (size != sizeof (struct OnDemandBlock))
528 GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1,
529 GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
530 return GNUNET_SYSERR;
532 odb = (const struct OnDemandBlock *) data;
533 off = GNUNET_ntohll (odb->offset);
534 fn = (const char *) GNUNET_CONTAINER_multihashmap_get (ifm, &odb->file_id);
535 if ((NULL == fn) || (0 != ACCESS (fn, R_OK)))
537 GNUNET_STATISTICS_update (GSF_stats,
539 ("# index blocks removed: original file inaccessible"),
541 GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1,
542 GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
543 return GNUNET_SYSERR;
547 GNUNET_DISK_file_open (fn, GNUNET_DISK_OPEN_READ,
548 GNUNET_DISK_PERM_NONE))) ||
549 (off != GNUNET_DISK_file_seek (fh, off, GNUNET_DISK_SEEK_SET)) ||
550 (-1 == (nsize = GNUNET_DISK_file_read (fh, ndata, sizeof (ndata)))))
552 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
554 ("Could not access indexed file `%s' (%s) at offset %llu: %s\n"),
555 GNUNET_h2s (&odb->file_id), fn, (unsigned long long) off,
556 (fn == NULL) ? _("not indexed") : STRERROR (errno));
558 GNUNET_DISK_file_close (fh);
559 GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1,
560 GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
561 return GNUNET_SYSERR;
563 GNUNET_DISK_file_close (fh);
564 GNUNET_CRYPTO_hash (ndata, nsize, &nkey);
565 GNUNET_CRYPTO_hash_to_aes_key (&nkey, &skey, &iv);
566 GNUNET_CRYPTO_aes_encrypt (ndata, nsize, &skey, &iv, edata);
567 GNUNET_CRYPTO_hash (edata, nsize, &query);
568 if (0 != memcmp (&query, key, sizeof (GNUNET_HashCode)))
570 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
571 _("Indexed file `%s' changed at offset %llu\n"), fn,
572 (unsigned long long) off);
573 GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1,
574 GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
575 return GNUNET_SYSERR;
577 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
578 "On-demand encoded block for query `%s'\n", GNUNET_h2s (key));
579 cont (cont_cls, key, nsize, edata, GNUNET_BLOCK_TYPE_FS_DBLOCK, priority,
580 anonymity, expiration, uid);
586 * Shutdown the module.
589 GNUNET_FS_indexing_done ()
591 struct IndexInfo *pos;
593 GNUNET_CONTAINER_multihashmap_destroy (ifm);
595 while (NULL != (pos = indexed_files))
597 indexed_files = pos->next;
598 if (pos->fhc != NULL)
599 GNUNET_CRYPTO_hash_file_cancel (pos->fhc);
607 * Initialize the indexing submodule.
609 * @param c configuration to use
610 * @param d datastore to use
613 GNUNET_FS_indexing_init (const struct GNUNET_CONFIGURATION_Handle *c,
614 struct GNUNET_DATASTORE_Handle *d)
618 ifm = GNUNET_CONTAINER_multihashmap_create (128);
623 /* end of gnunet-service-fs_indexing.c */