2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 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 2, 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.
23 * @brief main FS functions (master initialization, serialization, deserialization, shared code)
24 * @author Christian Grothoff
28 #include "gnunet_util_lib.h"
29 #include "gnunet_fs_service.h"
35 * Start the given job (send signal, remove from pending queue, update
36 * counters and state).
38 * @param qe job to start
41 start_job (struct GNUNET_FS_QueueEntry *qe)
43 qe->client = GNUNET_CLIENT_connect (qe->h->sched, "fs", qe->h->cfg);
44 if (qe->client == NULL)
49 qe->start (qe->cls, qe->client);
51 qe->h->active_blocks += qe->blocks;
52 qe->start_time = GNUNET_TIME_absolute_get ();
53 GNUNET_CONTAINER_DLL_remove (qe->h->pending_head,
56 GNUNET_CONTAINER_DLL_insert_after (qe->h->running_head,
64 * Stop the given job (send signal, remove from active queue, update
65 * counters and state).
67 * @param qe job to stop
70 stop_job (struct GNUNET_FS_QueueEntry *qe)
74 qe->h->active_downloads--;
75 qe->h->active_blocks -= qe->blocks;
76 qe->run_time = GNUNET_TIME_relative_add (qe->run_time,
77 GNUNET_TIME_absolute_get_duration (qe->start_time));
78 GNUNET_CONTAINER_DLL_remove (qe->h->running_head,
81 GNUNET_CONTAINER_DLL_insert_after (qe->h->pending_head,
89 * Process the jobs in the job queue, possibly starting some
90 * and stopping others.
92 * @param cls the 'struct GNUNET_FS_Handle'
93 * @param tc scheduler context
96 process_job_queue (void *cls,
97 const struct GNUNET_SCHEDULER_TaskContext *tc)
99 struct GNUNET_FS_Handle *h = cls;
100 struct GNUNET_FS_QueueEntry *qe;
101 struct GNUNET_FS_QueueEntry *next;
102 struct GNUNET_TIME_Relative run_time;
103 struct GNUNET_TIME_Relative restart_at;
104 struct GNUNET_TIME_Relative rst;
105 struct GNUNET_TIME_Absolute end_time;
107 h->queue_job = GNUNET_SCHEDULER_NO_TASK;
108 next = h->pending_head;
109 while (NULL != (qe = next))
112 if (h->running_head == NULL)
117 if ( (qe->blocks + h->active_blocks <= h->max_parallel_requests) &&
118 (h->active_downloads + 1 <= h->max_parallel_downloads) )
124 if (h->pending_head == NULL)
125 return; /* no need to stop anything */
126 restart_at = GNUNET_TIME_UNIT_FOREVER_REL;
127 next = h->running_head;
128 while (NULL != (qe = next))
131 run_time = GNUNET_TIME_relative_multiply (h->avg_block_latency,
132 qe->blocks * qe->start_times);
133 end_time = GNUNET_TIME_absolute_add (qe->start_time,
135 rst = GNUNET_TIME_absolute_get_remaining (end_time);
136 restart_at = GNUNET_TIME_relative_min (rst, restart_at);
141 h->queue_job = GNUNET_SCHEDULER_add_delayed (h->sched,
149 * Add a job to the queue.
151 * @param h handle to the overall FS state
152 * @param start function to call to begin the job
153 * @param stop function to call to pause the job, or on dequeue (if the job was running)
154 * @param cls closure for start and stop
155 * @param blocks number of blocks this jobs uses
156 * @return queue handle
158 struct GNUNET_FS_QueueEntry *
159 GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h,
160 GNUNET_FS_QueueStart start,
161 GNUNET_FS_QueueStop stop,
165 struct GNUNET_FS_QueueEntry *qe;
167 qe = GNUNET_malloc (sizeof (struct GNUNET_FS_QueueEntry));
172 qe->queue_time = GNUNET_TIME_absolute_get ();
174 GNUNET_CONTAINER_DLL_insert_after (h->pending_head,
178 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
179 GNUNET_SCHEDULER_cancel (h->sched,
182 = GNUNET_SCHEDULER_add_now (h->sched,
190 * Dequeue a job from the queue.
191 * @param qh handle for the job
194 GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qh)
196 struct GNUNET_FS_Handle *h;
199 if (qh->client != NULL)
201 GNUNET_CONTAINER_DLL_remove (h->pending_head,
205 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
206 GNUNET_SCHEDULER_cancel (h->sched,
209 = GNUNET_SCHEDULER_add_now (h->sched,
216 * Create a top-level activity entry.
218 * @param h global fs handle
219 * @param ssf suspend signal function to use
220 * @param ssf_cls closure for ssf
221 * @return fresh top-level activity handle
223 struct TopLevelActivity *
224 GNUNET_FS_make_top (struct GNUNET_FS_Handle *h,
225 SuspendSignalFunction ssf,
228 struct TopLevelActivity *ret;
230 ret = GNUNET_malloc (sizeof (struct TopLevelActivity));
232 ret->ssf_cls = ssf_cls;
233 GNUNET_CONTAINER_DLL_insert (h->top_head,
241 * Destroy a top-level activity entry.
243 * @param h global fs handle
244 * @param top top level activity entry
247 GNUNET_FS_end_top (struct GNUNET_FS_Handle *h,
248 struct TopLevelActivity *top)
250 GNUNET_CONTAINER_DLL_remove (h->top_head,
259 * Closure for "data_reader_file".
264 * Name of the file to read.
269 * File descriptor, NULL if it has not yet been opened.
271 struct GNUNET_DISK_FileHandle *fd;
276 * Function that provides data by reading from a file.
278 * @param cls closure (points to the file information)
279 * @param offset offset to read from; it is possible
280 * that the caller might need to go backwards
282 * @param max maximum number of bytes that should be
283 * copied to buf; readers are not allowed
284 * to provide less data unless there is an error;
285 * a value of "0" will be used at the end to allow
286 * the reader to clean up its internal state
287 * @param buf where the reader should write the data
288 * @param emsg location for the reader to store an error message
289 * @return number of bytes written, usually "max", 0 on error
292 GNUNET_FS_data_reader_file_(void *cls,
298 struct FileInfo *fi = cls;
304 GNUNET_DISK_file_close (fi->fd);
305 GNUNET_free (fi->filename);
311 fi->fd = GNUNET_DISK_file_open (fi->filename,
312 GNUNET_DISK_OPEN_READ,
313 GNUNET_DISK_PERM_NONE);
316 GNUNET_asprintf (emsg,
317 _("Could not open file `%s': %s"),
323 GNUNET_DISK_file_seek (fi->fd, offset, GNUNET_DISK_SEEK_SET);
324 ret = GNUNET_DISK_file_read (fi->fd, buf, max);
327 GNUNET_asprintf (emsg,
328 _("Could not read file `%s': %s"),
335 GNUNET_asprintf (emsg,
336 _("Short read reading from file `%s'!"),
345 * Create the closure for the 'GNUNET_FS_data_reader_file_' callback.
347 * @param filename file to read
348 * @return closure to use, NULL on error
351 GNUNET_FS_make_file_reader_context_ (const char *filename)
355 fi = GNUNET_malloc (sizeof(struct FileInfo));
356 fi->filename = GNUNET_STRINGS_filename_expand (filename);
357 if (fi->filename == NULL)
367 * Function that provides data by copying from a buffer.
369 * @param cls closure (points to the buffer)
370 * @param offset offset to read from; it is possible
371 * that the caller might need to go backwards
373 * @param max maximum number of bytes that should be
374 * copied to buf; readers are not allowed
375 * to provide less data unless there is an error;
376 * a value of "0" will be used at the end to allow
377 * the reader to clean up its internal state
378 * @param buf where the reader should write the data
379 * @param emsg location for the reader to store an error message
380 * @return number of bytes written, usually "max", 0 on error
383 GNUNET_FS_data_reader_copy_ (void *cls,
393 GNUNET_free_non_null (data);
396 memcpy (buf, &data[offset], max);
402 * Return the full filename where we would store state information
403 * (for serialization/deserialization).
405 * @param h master context
406 * @param ext component of the path
407 * @param ent entity identifier (or emtpy string for the directory)
408 * @return NULL on error
411 get_serialization_file_name (struct GNUNET_FS_Handle *h,
418 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
419 return NULL; /* persistence not requested */
421 GNUNET_CONFIGURATION_get_value_filename (h->cfg,
426 GNUNET_asprintf (&ret,
435 GNUNET_free (basename);
441 * Return the full filename where we would store state information
442 * (for serialization/deserialization) that is associated with a
445 * @param h master context
446 * @param ext component of the path
447 * @param uni name of the parent operation
448 * @param ent entity identifier (or emtpy string for the directory)
449 * @return NULL on error
452 get_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h,
460 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
461 return NULL; /* persistence not requested */
463 GNUNET_CONFIGURATION_get_value_filename (h->cfg,
468 GNUNET_asprintf (&ret,
469 "%s%s%s%s%s%s%s%s%s",
479 GNUNET_free (basename);
485 * Return a read handle for deserialization.
487 * @param h master context
488 * @param ext component of the path
489 * @param ent entity identifier (or emtpy string for the directory)
490 * @return NULL on error
492 static struct GNUNET_BIO_ReadHandle *
493 get_read_handle (struct GNUNET_FS_Handle *h,
498 struct GNUNET_BIO_ReadHandle *ret;
500 fn = get_serialization_file_name (h, ext, ent);
503 ret = GNUNET_BIO_read_open (fn);
510 * Return a write handle for serialization.
512 * @param h master context
513 * @param ext component of the path
514 * @param ent entity identifier (or emtpy string for the directory)
515 * @return NULL on error
517 static struct GNUNET_BIO_WriteHandle *
518 get_write_handle (struct GNUNET_FS_Handle *h,
523 struct GNUNET_BIO_WriteHandle *ret;
525 fn = get_serialization_file_name (h, ext, ent);
530 ret = GNUNET_BIO_write_open (fn);
533 "Failed to create write handle for `%s' from `%s/%s'\n",
541 * Return a write handle for serialization.
543 * @param h master context
544 * @param ext component of the path
545 * @param uni name of parent
546 * @param ent entity identifier (or emtpy string for the directory)
547 * @return NULL on error
549 static struct GNUNET_BIO_WriteHandle *
550 get_write_handle_in_dir (struct GNUNET_FS_Handle *h,
556 struct GNUNET_BIO_WriteHandle *ret;
558 fn = get_serialization_file_name_in_dir (h, ext, uni, ent);
561 ret = GNUNET_BIO_write_open (fn);
568 * Remove serialization/deserialization file from disk.
570 * @param h master context
571 * @param ext component of the path
572 * @param ent entity identifier
575 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h,
581 if ( (NULL == ent) ||
582 (0 == strlen (ent)) )
587 filename = get_serialization_file_name (h, ext, ent);
588 if (0 != UNLINK (filename))
589 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
592 GNUNET_free (filename);
597 * Remove serialization/deserialization file from disk.
599 * @param h master context
600 * @param ext component of the path
601 * @param uni parent name
602 * @param ent entity identifier
605 remove_sync_file_in_dir (struct GNUNET_FS_Handle *h,
612 if ( (NULL == ent) ||
613 (0 == strlen (ent)) )
618 filename = get_serialization_file_name_in_dir (h, ext, uni, ent);
619 if (0 != UNLINK (filename))
620 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
623 GNUNET_free (filename);
628 * Remove serialization/deserialization directory from disk.
630 * @param h master context
631 * @param ext component of the path
632 * @param uni unique name of parent
635 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h,
643 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
646 if ( (GNUNET_OK == GNUNET_DISK_directory_test (dn)) &&
647 (GNUNET_OK != GNUNET_DISK_directory_remove (dn)) )
648 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
656 * Serialize a 'start_time'. Since we use start-times to
657 * calculate the duration of some operation, we actually
658 * do not serialize the absolute time but the (relative)
659 * duration since the start time. When we then
660 * deserialize the start time, we take the current time and
661 * subtract that duration so that we get again an absolute
662 * time stamp that will result in correct performance
665 * @param wh handle for writing
666 * @param timestamp time to serialize
667 * @return GNUNET_OK on success
670 write_start_time (struct GNUNET_BIO_WriteHandle *wh,
671 struct GNUNET_TIME_Absolute timestamp)
673 struct GNUNET_TIME_Relative dur;
675 dur = GNUNET_TIME_absolute_get_duration (timestamp);
676 return GNUNET_BIO_write_int64 (wh, dur.value);
681 * Serialize a 'start_time'. Since we use start-times to
682 * calculate the duration of some operation, we actually
683 * do not serialize the absolute time but the (relative)
684 * duration since the start time. When we then
685 * deserialize the start time, we take the current time and
686 * subtract that duration so that we get again an absolute
687 * time stamp that will result in correct performance
690 * @param rh handle for reading
691 * @param timestamp where to write the deserialized timestamp
692 * @return GNUNET_OK on success
695 read_start_time (struct GNUNET_BIO_ReadHandle *rh,
696 struct GNUNET_TIME_Absolute *timestamp)
698 struct GNUNET_TIME_Relative dur;
700 GNUNET_BIO_read_int64 (rh, &dur.value))
701 return GNUNET_SYSERR;
702 *timestamp = GNUNET_TIME_absolute_subtract (GNUNET_TIME_absolute_get (),
709 * Using the given serialization filename, try to deserialize
710 * the file-information tree associated with it.
712 * @param h master context
713 * @param filename name of the file (without directory) with
715 * @return NULL on error
717 static struct GNUNET_FS_FileInformation *
718 deserialize_file_information (struct GNUNET_FS_Handle *h,
719 const char *filename);
723 * Using the given serialization filename, try to deserialize
724 * the file-information tree associated with it.
726 * @param h master context
727 * @param fn name of the file (without directory) with
729 * @param rh handle for reading
730 * @return NULL on error
732 static struct GNUNET_FS_FileInformation *
733 deserialize_fi_node (struct GNUNET_FS_Handle *h,
735 struct GNUNET_BIO_ReadHandle *rh)
737 struct GNUNET_FS_FileInformation *ret;
738 struct GNUNET_FS_FileInformation *nxt;
746 GNUNET_BIO_read (rh, "status flag", &b, sizeof(b)))
751 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_FileInformation));
756 GNUNET_BIO_read_meta_data (rh, "metadata", &ret->meta)) ||
758 GNUNET_BIO_read_string (rh, "ksk-uri", &ksks, 32*1024)) ||
761 (ret->keywords = GNUNET_FS_uri_parse (ksks, NULL))) ) ||
763 GNUNET_FS_uri_test_ksk (ret->keywords)) ||
765 GNUNET_BIO_read_string (rh, "chk-uri", &chks, 1024)) ||
768 (ret->chk_uri = GNUNET_FS_uri_parse (chks, NULL))) ||
770 GNUNET_FS_uri_test_chk (ret->chk_uri)) ) ) ||
772 GNUNET_BIO_read_int64 (rh, &ret->expirationTime.value)) ||
774 read_start_time (rh, &ret->start_time)) ||
776 GNUNET_BIO_read_string (rh, "emsg", &ret->emsg, 16*1024)) ||
778 GNUNET_BIO_read_string (rh, "fn", &ret->filename, 16*1024)) ||
780 GNUNET_BIO_read_int32 (rh, &ret->anonymity)) ||
782 GNUNET_BIO_read_int32 (rh, &ret->priority)) )
786 case 0: /* file-insert */
788 GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
790 ret->is_directory = GNUNET_NO;
791 ret->data.file.do_index = GNUNET_NO;
792 ret->data.file.have_hash = GNUNET_NO;
793 ret->data.file.index_start_confirmed = GNUNET_NO;
794 if (GNUNET_NO == ret->is_published)
796 if (NULL == ret->filename)
798 ret->data.file.reader = &GNUNET_FS_data_reader_copy_;
799 ret->data.file.reader_cls = GNUNET_malloc_large (ret->data.file.file_size);
800 if (ret->data.file.reader_cls == NULL)
803 GNUNET_BIO_read (rh, "file-data", ret->data.file.reader_cls, ret->data.file.file_size))
808 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
809 ret->data.file.reader_cls = GNUNET_FS_make_file_reader_context_ (ret->filename);
813 case 1: /* file-index, no hash */
814 if (NULL == ret->filename)
817 GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
819 ret->is_directory = GNUNET_NO;
820 ret->data.file.do_index = GNUNET_YES;
821 ret->data.file.have_hash = GNUNET_NO;
822 ret->data.file.index_start_confirmed = GNUNET_NO;
823 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
824 ret->data.file.reader_cls = GNUNET_FS_make_file_reader_context_ (ret->filename);
826 case 2: /* file-index-with-hash */
827 if (NULL == ret->filename)
830 GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
832 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id, sizeof (GNUNET_HashCode))) )
834 ret->is_directory = GNUNET_NO;
835 ret->data.file.do_index = GNUNET_YES;
836 ret->data.file.have_hash = GNUNET_YES;
837 ret->data.file.index_start_confirmed = GNUNET_NO;
838 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
839 ret->data.file.reader_cls = GNUNET_FS_make_file_reader_context_ (ret->filename);
841 case 3: /* file-index-with-hash-confirmed */
842 if (NULL == ret->filename)
845 GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
847 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id, sizeof (GNUNET_HashCode))) )
850 ret->is_directory = GNUNET_NO;
851 ret->data.file.do_index = GNUNET_YES;
852 ret->data.file.have_hash = GNUNET_YES;
853 ret->data.file.index_start_confirmed = GNUNET_YES;
854 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
855 ret->data.file.reader_cls = GNUNET_FS_make_file_reader_context_ (ret->filename);
857 case 4: /* directory */
859 GNUNET_BIO_read_int32 (rh, &dsize)) ||
860 (NULL == (ret->data.dir.dir_data = GNUNET_malloc_large (dsize))) ||
862 GNUNET_BIO_read (rh, "dir-data", ret->data.dir.dir_data, dsize)) ||
864 GNUNET_BIO_read_string (rh, "ent-filename", &filename, 16*1024)) )
866 ret->data.dir.dir_size = (uint32_t) dsize;
867 ret->is_directory = GNUNET_YES;
868 if (filename != NULL)
870 ret->data.dir.entries = deserialize_file_information (h, filename);
871 GNUNET_free (filename);
873 nxt = ret->data.dir.entries;
885 ret->serialization = GNUNET_strdup (fn);
887 GNUNET_BIO_read_string (rh, "nxt-filename", &filename, 16*1024))
889 if (filename != NULL)
891 ret->next = deserialize_file_information (h, filename);
892 GNUNET_free (filename);
895 GNUNET_free_non_null (ksks);
896 GNUNET_free_non_null (chks);
899 GNUNET_free_non_null (ksks);
900 GNUNET_free_non_null (chks);
901 GNUNET_free_non_null (filename);
902 GNUNET_FS_file_information_destroy (ret, NULL, NULL);
908 * Using the given serialization filename, try to deserialize
909 * the file-information tree associated with it.
911 * @param h master context
912 * @param filename name of the file (without directory) with
914 * @return NULL on error
916 static struct GNUNET_FS_FileInformation *
917 deserialize_file_information (struct GNUNET_FS_Handle *h,
918 const char *filename)
920 struct GNUNET_FS_FileInformation *ret;
921 struct GNUNET_BIO_ReadHandle *rh;
924 rh = get_read_handle (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
927 ret = deserialize_fi_node (h, filename, rh);
929 GNUNET_BIO_read_close (rh, &emsg))
931 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
932 _("Failed to resume publishing information `%s': %s\n"),
942 * Given a serialization name (full absolute path), return the
943 * basename of the file (without the path), which must only
944 * consist of the 6 random characters.
946 * @param fullname name to extract the basename from
947 * @return copy of the basename, NULL on error
950 get_serialization_short_name (const char *fullname)
957 /* FIXME: we could do this faster since we know
958 the length of 'end'... */
961 if (DIR_SEPARATOR == *nxt)
965 if ( (end == NULL) ||
966 (strlen (end) == 0) )
971 GNUNET_break (6 == strlen (end));
972 return GNUNET_strdup (end);
977 * Create a new random name for serialization. Also checks if persistence
978 * is enabled and returns NULL if not.
980 * @param h master context
981 * @param ext component of the path
982 * @return NULL on errror
985 make_serialization_file_name (struct GNUNET_FS_Handle *h,
992 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
993 return NULL; /* persistence not requested */
994 dn = get_serialization_file_name (h, ext, "");
996 GNUNET_DISK_directory_create_for_file (dn))
1001 fn = GNUNET_DISK_mktemp (dn);
1004 return NULL; /* epic fail */
1005 ret = get_serialization_short_name (fn);
1012 * Create a new random name for serialization. Also checks if persistence
1013 * is enabled and returns NULL if not.
1015 * @param h master context
1016 * @param ext component of the path
1017 * @param uni name of parent
1018 * @return NULL on errror
1021 make_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h,
1029 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1030 return NULL; /* persistence not requested */
1031 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
1033 GNUNET_DISK_directory_create_for_file (dn))
1038 fn = GNUNET_DISK_mktemp (dn);
1041 return NULL; /* epic fail */
1042 ret = get_serialization_short_name (fn);
1049 * Copy all of the data from the reader to the write handle.
1051 * @param wh write handle
1052 * @param fi file with reader
1053 * @return GNUNET_OK on success
1056 copy_from_reader (struct GNUNET_BIO_WriteHandle *wh,
1057 struct GNUNET_FS_FileInformation * fi)
1059 char buf[32 * 1024];
1066 while (off < fi->data.file.file_size)
1068 ret = fi->data.file.reader (fi->data.file.reader_cls,
1075 return GNUNET_SYSERR;
1078 GNUNET_BIO_write (wh, buf, ret))
1079 return GNUNET_SYSERR;
1087 * Create a temporary file on disk to store the current
1090 * @param fi file information to sync with disk
1093 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation * fi)
1096 struct GNUNET_BIO_WriteHandle *wh;
1101 if (NULL == fi->serialization)
1102 fi->serialization = make_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO);
1103 if (NULL == fi->serialization)
1105 wh = get_write_handle (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO, fi->serialization);
1108 GNUNET_free (fi->serialization);
1109 fi->serialization = NULL;
1112 if (GNUNET_YES == fi->is_directory)
1114 else if (GNUNET_YES == fi->data.file.index_start_confirmed)
1116 else if (GNUNET_YES == fi->data.file.have_hash)
1118 else if (GNUNET_YES == fi->data.file.do_index)
1122 if (fi->keywords != NULL)
1123 ksks = GNUNET_FS_uri_to_string (fi->keywords);
1126 if (fi->chk_uri != NULL)
1127 chks = GNUNET_FS_uri_to_string (fi->chk_uri);
1131 GNUNET_BIO_write (wh, &b, sizeof (b))) ||
1133 GNUNET_BIO_write_meta_data (wh, fi->meta)) ||
1135 GNUNET_BIO_write_string (wh, ksks)) ||
1137 GNUNET_BIO_write_string (wh, chks)) ||
1139 GNUNET_BIO_write_int64 (wh, fi->expirationTime.value)) ||
1141 write_start_time (wh, fi->start_time)) ||
1143 GNUNET_BIO_write_string (wh, fi->emsg)) ||
1145 GNUNET_BIO_write_string (wh, fi->filename)) ||
1147 GNUNET_BIO_write_int32 (wh, fi->anonymity)) ||
1149 GNUNET_BIO_write_int32 (wh, fi->priority)) )
1151 GNUNET_free_non_null (chks);
1153 GNUNET_free_non_null (ksks);
1158 case 0: /* file-insert */
1160 GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1162 if ( (GNUNET_NO == fi->is_published) &&
1163 (NULL == fi->filename) )
1165 copy_from_reader (wh, fi))
1168 case 1: /* file-index, no hash */
1169 if (NULL == fi->filename)
1172 GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1175 case 2: /* file-index-with-hash */
1176 case 3: /* file-index-with-hash-confirmed */
1177 if (NULL == fi->filename)
1180 GNUNET_BIO_write_int64 (wh, fi->data.file.file_size)) ||
1182 GNUNET_BIO_write (wh, &fi->data.file.file_id, sizeof (GNUNET_HashCode))) )
1185 case 4: /* directory */
1187 GNUNET_BIO_write_int32 (wh, fi->data.dir.dir_size)) ||
1189 GNUNET_BIO_write (wh, fi->data.dir.dir_data, (uint32_t) fi->data.dir.dir_size)) ||
1191 GNUNET_BIO_write_string (wh, fi->data.dir.entries->serialization)) )
1199 GNUNET_BIO_write_string (wh, (fi->next != NULL) ? fi->next->serialization : NULL))
1202 GNUNET_BIO_write_close (wh))
1205 (void) GNUNET_BIO_write_close (wh);
1206 GNUNET_free_non_null (chks);
1207 GNUNET_free_non_null (ksks);
1208 fn = get_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO, fi->serialization);
1209 if (0 != UNLINK (fn))
1210 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1212 GNUNET_free (fi->serialization);
1213 fi->serialization = NULL;
1219 * Find the entry in the file information struct where the
1220 * serialization filename matches the given name.
1222 * @param pos file information to search
1223 * @param srch filename to search for
1224 * @return NULL if srch was not found in this subtree
1226 static struct GNUNET_FS_FileInformation *
1227 find_file_position (struct GNUNET_FS_FileInformation *pos,
1230 struct GNUNET_FS_FileInformation *r;
1234 if (0 == strcmp (srch,
1235 pos->serialization))
1237 if (pos->is_directory)
1239 r = find_file_position (pos->data.dir.entries,
1251 * Signal the FS's progress function that we are resuming
1254 * @param cls closure (of type "struct GNUNET_FS_PublishContext*")
1255 * @param fi the entry in the publish-structure
1256 * @param length length of the file or directory
1257 * @param meta metadata for the file or directory (can be modified)
1258 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1259 * @param anonymity pointer to selected anonymity level (can be modified)
1260 * @param priority pointer to selected priority (can be modified)
1261 * @param expirationTime pointer to selected expiration time (can be modified)
1262 * @param client_info pointer to client context set upon creation (can be modified)
1263 * @return GNUNET_OK to continue (always)
1266 fip_signal_resume(void *cls,
1267 struct GNUNET_FS_FileInformation *fi,
1269 struct GNUNET_CONTAINER_MetaData *meta,
1270 struct GNUNET_FS_Uri **uri,
1271 uint32_t *anonymity,
1273 struct GNUNET_TIME_Absolute *expirationTime,
1276 struct GNUNET_FS_PublishContext *sc = cls;
1277 struct GNUNET_FS_ProgressInfo pi;
1279 pi.status = GNUNET_FS_STATUS_PUBLISH_RESUME;
1280 pi.value.publish.specifics.resume.message = sc->fi->emsg;
1281 pi.value.publish.specifics.resume.chk_uri = sc->fi->chk_uri;
1282 *client_info = GNUNET_FS_publish_make_status_ (&pi, sc, fi, 0);
1288 * Function called with a filename of serialized publishing operation
1291 * @param cls the 'struct GNUNET_FS_Handle*'
1292 * @param filename complete filename (absolute path)
1293 * @return GNUNET_OK (continue to iterate)
1296 deserialize_publish_file (void *cls,
1297 const char *filename)
1299 struct GNUNET_FS_Handle *h = cls;
1300 struct GNUNET_BIO_ReadHandle *rh;
1301 struct GNUNET_FS_PublishContext *pc;
1309 pc = GNUNET_malloc (sizeof (struct GNUNET_FS_PublishContext));
1311 pc->serialization = get_serialization_short_name (filename);
1315 rh = GNUNET_BIO_read_open (filename);
1319 GNUNET_BIO_read_string (rh, "publish-nid", &pc->nid, 1024)) ||
1321 GNUNET_BIO_read_string (rh, "publish-nuid", &pc->nuid, 1024)) ||
1323 GNUNET_BIO_read_int32 (rh, &options)) ||
1325 GNUNET_BIO_read_int32 (rh, &all_done)) ||
1327 GNUNET_BIO_read_string (rh, "publish-firoot", &fi_root, 128)) ||
1329 GNUNET_BIO_read_string (rh, "publish-fipos", &fi_pos, 128)) ||
1331 GNUNET_BIO_read_string (rh, "publish-ns", &ns, 1024)) )
1333 pc->options = options;
1334 pc->all_done = all_done;
1335 pc->fi = deserialize_file_information (h, fi_root);
1340 pc->namespace = GNUNET_FS_namespace_create (h, ns);
1341 if (pc->namespace == NULL)
1343 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1344 _("Failed to recover namespace `%s', cannot resume publishing operation.\n"),
1351 pc->fi_pos = find_file_position (pc->fi,
1353 GNUNET_free (fi_pos);
1355 if (pc->fi_pos == NULL)
1357 /* failed to find position for resuming, outch! Will start from root! */
1359 if (pc->all_done != GNUNET_YES)
1360 pc->fi_pos = pc->fi;
1363 /* generate RESUME event(s) */
1364 GNUNET_FS_file_information_inspect (pc->fi,
1368 /* re-start publishing (if needed)... */
1369 if (pc->all_done != GNUNET_YES)
1371 = GNUNET_SCHEDULER_add_with_priority (h->sched,
1372 GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
1373 &GNUNET_FS_publish_main_,
1376 GNUNET_BIO_read_close (rh, &emsg))
1378 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1379 _("Failure while resuming publishing operation `%s': %s\n"),
1384 GNUNET_free_non_null (ns);
1387 GNUNET_free_non_null (pc->nid);
1388 GNUNET_free_non_null (pc->nuid);
1389 GNUNET_free_non_null (fi_root);
1390 GNUNET_free_non_null (fi_pos);
1391 GNUNET_free_non_null (ns);
1392 if ( (rh != NULL) &&
1394 GNUNET_BIO_read_close (rh, &emsg)) )
1396 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1397 _("Failed to resume publishing operation `%s': %s\n"),
1403 GNUNET_FS_file_information_destroy (pc->fi, NULL, NULL);
1404 if (0 != UNLINK (filename))
1405 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
1406 GNUNET_free_non_null (pc->serialization);
1413 * Synchronize this publishing struct with its mirror
1414 * on disk. Note that all internal FS-operations that change
1415 * publishing structs should already call "sync" internally,
1416 * so this function is likely not useful for clients.
1418 * @param pc the struct to sync
1421 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc)
1423 struct GNUNET_BIO_WriteHandle *wh;
1425 if (NULL == pc->serialization)
1426 pc->serialization = make_serialization_file_name (pc->h,
1427 GNUNET_FS_SYNC_PATH_MASTER_PUBLISH);
1428 if (NULL == pc->serialization)
1432 if (NULL == pc->fi->serialization)
1437 wh = get_write_handle (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH, pc->serialization);
1441 GNUNET_BIO_write_string (wh, pc->nid)) ||
1443 GNUNET_BIO_write_string (wh, pc->nuid)) ||
1445 GNUNET_BIO_write_int32 (wh, pc->options)) ||
1447 GNUNET_BIO_write_int32 (wh, pc->all_done)) ||
1449 GNUNET_BIO_write_string (wh, pc->fi->serialization)) ||
1451 GNUNET_BIO_write_string (wh, (pc->fi_pos == NULL) ? NULL : pc->fi_pos->serialization)) ||
1453 GNUNET_BIO_write_string (wh, (pc->namespace == NULL) ? NULL : pc->namespace->name)) )
1458 GNUNET_BIO_write_close (wh))
1466 (void) GNUNET_BIO_write_close (wh);
1467 GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH, pc->serialization);
1468 GNUNET_free (pc->serialization);
1469 pc->serialization = NULL;
1474 * Synchronize this unindex struct with its mirror
1475 * on disk. Note that all internal FS-operations that change
1476 * publishing structs should already call "sync" internally,
1477 * so this function is likely not useful for clients.
1479 * @param uc the struct to sync
1482 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc)
1484 struct GNUNET_BIO_WriteHandle *wh;
1486 if (UNINDEX_STATE_ABORTED == uc->state)
1488 if (NULL == uc->serialization)
1489 uc->serialization = make_serialization_file_name (uc->h,
1490 GNUNET_FS_SYNC_PATH_MASTER_UNINDEX);
1491 if (NULL == uc->serialization)
1493 wh = get_write_handle (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX, uc->serialization);
1497 GNUNET_BIO_write_string (wh, uc->filename)) ||
1499 GNUNET_BIO_write_int64 (wh, uc->file_size)) ||
1501 write_start_time (wh, uc->start_time)) ||
1503 GNUNET_BIO_write_int32 (wh, (uint32_t) uc->state)) ||
1504 ( (uc->state == UNINDEX_STATE_FS_NOTIFY) &&
1506 GNUNET_BIO_write (wh, &uc->file_id, sizeof (GNUNET_HashCode))) ) ||
1507 ( (uc->state == UNINDEX_STATE_ERROR) &&
1509 GNUNET_BIO_write_string (wh, uc->emsg)) ) )
1512 GNUNET_BIO_write_close (wh))
1520 (void) GNUNET_BIO_write_close (wh);
1521 GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX, uc->serialization);
1522 GNUNET_free (uc->serialization);
1523 uc->serialization = NULL;
1528 * Serialize an active or pending download request.
1530 * @param cls the 'struct GNUNET_BIO_WriteHandle*'
1531 * @param key unused, can be NULL
1532 * @param value the 'struct DownloadRequest'
1533 * @return GNUNET_YES on success, GNUNET_NO on error
1536 write_download_request (void *cls,
1537 const GNUNET_HashCode *key,
1540 struct GNUNET_BIO_WriteHandle *wh = cls;
1541 struct DownloadRequest *dr = value;
1544 GNUNET_BIO_write (wh, &dr->chk, sizeof (struct ContentHashKey))) ||
1546 GNUNET_BIO_write_int64 (wh, dr->offset)) ||
1548 GNUNET_BIO_write_int32 (wh, dr->depth)) )
1555 * Count active download requests.
1557 * @param cls the 'uint32_t*' counter
1558 * @param key unused, can be NULL
1559 * @param value the 'struct DownloadRequest'
1560 * @return GNUNET_YES (continue iteration)
1563 count_download_requests (void *cls,
1564 const GNUNET_HashCode *key,
1567 uint32_t *counter = cls;
1575 * Compute the name of the sync file (or directory) for the given download
1578 * @param dc download context to compute for
1579 * @param uni unique filename to use, use "" for the directory name
1580 * @return the expanded file name, NULL for none
1583 get_download_sync_filename (struct GNUNET_FS_DownloadContext *dc,
1589 if (dc->parent == NULL)
1590 return get_serialization_file_name (dc->h,
1591 (dc->search != NULL) ?
1592 GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD :
1593 GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
1595 if (dc->parent->serialization == NULL)
1597 par = get_download_sync_filename (dc->parent, dc->parent->serialization);
1600 GNUNET_asprintf (&epar,
1611 * Synchronize this download struct with its mirror
1612 * on disk. Note that all internal FS-operations that change
1613 * publishing structs should already call "sync" internally,
1614 * so this function is likely not useful for clients.
1616 * @param dc the struct to sync
1619 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc)
1621 struct GNUNET_BIO_WriteHandle *wh;
1625 uint32_t num_pending;
1627 if (NULL == dc->serialization)
1629 dir = get_download_sync_filename (dc, "");
1633 GNUNET_DISK_directory_create_for_file (dir))
1638 fn = GNUNET_DISK_mktemp (dir);
1640 dc->serialization = get_serialization_short_name (fn);
1644 fn = get_download_sync_filename (dc, dc->serialization);
1646 wh = GNUNET_BIO_write_open (fn);
1649 GNUNET_free (dc->serialization);
1650 dc->serialization = NULL;
1654 GNUNET_assert ( (GNUNET_YES == GNUNET_FS_uri_test_chk (dc->uri)) ||
1655 (GNUNET_YES == GNUNET_FS_uri_test_loc (dc->uri)) );
1656 uris = GNUNET_FS_uri_to_string (dc->uri);
1658 if (dc->emsg != NULL)
1659 (void) GNUNET_CONTAINER_multihashmap_iterate (dc->active,
1660 &count_download_requests,
1662 GNUNET_assert ( (dc->length == dc->completed) ||
1663 (dc->emsg != NULL) ||
1664 (num_pending > 0) );
1666 GNUNET_BIO_write_string (wh, uris)) ||
1668 GNUNET_BIO_write_meta_data (wh, dc->meta)) ||
1670 GNUNET_BIO_write_string (wh, dc->emsg)) ||
1672 GNUNET_BIO_write_string (wh, dc->filename)) ||
1674 GNUNET_BIO_write_string (wh, dc->temp_filename)) ||
1676 GNUNET_BIO_write_int64 (wh, dc->old_file_size)) ||
1678 GNUNET_BIO_write_int64 (wh, dc->offset)) ||
1680 GNUNET_BIO_write_int64 (wh, dc->length)) ||
1682 GNUNET_BIO_write_int64 (wh, dc->completed)) ||
1684 write_start_time (wh, dc->start_time)) ||
1686 GNUNET_BIO_write_int32 (wh, dc->anonymity)) ||
1688 GNUNET_BIO_write_int32 (wh, (uint32_t) dc->options)) ||
1690 GNUNET_BIO_write_int32 (wh, (uint32_t) dc->has_finished)) ||
1692 GNUNET_BIO_write_int32 (wh, num_pending)) )
1694 if (GNUNET_SYSERR ==
1695 GNUNET_CONTAINER_multihashmap_iterate (dc->active,
1696 &write_download_request,
1699 GNUNET_free_non_null (uris);
1701 GNUNET_BIO_write_close (wh))
1710 (void) GNUNET_BIO_write_close (wh);
1711 GNUNET_free_non_null (uris);
1712 if (0 != UNLINK (fn))
1713 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1715 GNUNET_free (dc->serialization);
1716 dc->serialization = NULL;
1721 * Synchronize this search result with its mirror
1722 * on disk. Note that all internal FS-operations that change
1723 * publishing structs should already call "sync" internally,
1724 * so this function is likely not useful for clients.
1726 * @param sr the struct to sync
1729 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr)
1731 struct GNUNET_BIO_WriteHandle *wh;
1735 if (NULL == sr->serialization)
1736 sr->serialization = make_serialization_file_name_in_dir (sr->sc->h,
1737 (sr->sc->psearch_result == NULL)
1738 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
1739 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1740 sr->sc->serialization);
1741 if (NULL == sr->serialization)
1743 wh = get_write_handle_in_dir (sr->sc->h,
1744 (sr->sc->psearch_result == NULL)
1745 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
1746 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1747 sr->sc->serialization,
1751 uris = GNUNET_FS_uri_to_string (sr->uri);
1753 GNUNET_BIO_write_string (wh, uris)) ||
1755 GNUNET_BIO_write_string (wh, sr->download != NULL ? sr->download->serialization : NULL)) ||
1757 GNUNET_BIO_write_string (wh, sr->update_search != NULL ? sr->update_search->serialization : NULL)) ||
1759 GNUNET_BIO_write_meta_data (wh, sr->meta)) ||
1761 GNUNET_BIO_write (wh, &sr->key, sizeof (GNUNET_HashCode))) ||
1763 GNUNET_BIO_write_int32 (wh, sr->mandatory_missing)) ||
1765 GNUNET_BIO_write_int32 (wh, sr->optional_support)) ||
1767 GNUNET_BIO_write_int32 (wh, sr->availability_success)) ||
1769 GNUNET_BIO_write_int32 (wh, sr->availability_trials)) )
1772 GNUNET_BIO_write_close (wh))
1777 GNUNET_free_non_null (uris);
1780 GNUNET_free_non_null (uris);
1782 (void) GNUNET_BIO_write_close (wh);
1783 remove_sync_file_in_dir (sr->sc->h,
1784 (sr->sc->psearch_result == NULL)
1785 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
1786 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1787 sr->sc->serialization,
1789 GNUNET_free (sr->serialization);
1790 sr->serialization = NULL;
1795 * Synchronize this search struct with its mirror
1796 * on disk. Note that all internal FS-operations that change
1797 * publishing structs should already call "sync" internally,
1798 * so this function is likely not useful for clients.
1800 * @param sc the struct to sync
1803 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc)
1805 struct GNUNET_BIO_WriteHandle *wh;
1808 const char *category;
1810 category = (sc->psearch_result == NULL)
1811 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
1812 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH;
1813 if (NULL == sc->serialization)
1814 sc->serialization = make_serialization_file_name (sc->h,
1816 if (NULL == sc->serialization)
1818 wh = get_write_handle (sc->h, category, sc->serialization);
1821 GNUNET_assert ( (GNUNET_YES == GNUNET_FS_uri_test_ksk (sc->uri)) ||
1822 (GNUNET_YES == GNUNET_FS_uri_test_sks (sc->uri)) );
1823 uris = GNUNET_FS_uri_to_string (sc->uri);
1824 in_pause = (sc->task != GNUNET_SCHEDULER_NO_TASK) ? 'r' : '\0';
1826 GNUNET_BIO_write_string (wh, uris)) ||
1828 write_start_time (wh, sc->start_time)) ||
1830 GNUNET_BIO_write_string (wh, sc->emsg)) ||
1832 GNUNET_BIO_write_int32 (wh, (uint32_t) sc->options)) ||
1834 GNUNET_BIO_write (wh, &in_pause, sizeof (in_pause))) ||
1836 GNUNET_BIO_write_int32 (wh, sc->anonymity)) )
1841 GNUNET_BIO_write_close (wh))
1849 (void) GNUNET_BIO_write_close (wh);
1850 GNUNET_free_non_null (uris);
1851 GNUNET_FS_remove_sync_file_ (sc->h, category, sc->serialization);
1852 GNUNET_free (sc->serialization);
1853 sc->serialization = NULL;
1858 * Function called with a filename of serialized unindexing operation
1861 * @param cls the 'struct GNUNET_FS_Handle*'
1862 * @param filename complete filename (absolute path)
1863 * @return GNUNET_OK (continue to iterate)
1866 deserialize_unindex_file (void *cls,
1867 const char *filename)
1869 struct GNUNET_FS_Handle *h = cls;
1870 struct GNUNET_BIO_ReadHandle *rh;
1871 struct GNUNET_FS_UnindexContext *uc;
1872 struct GNUNET_FS_ProgressInfo pi;
1876 uc = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
1878 uc->serialization = get_serialization_short_name (filename);
1879 rh = GNUNET_BIO_read_open (filename);
1883 GNUNET_BIO_read_string (rh, "unindex-fn", &uc->filename, 10*1024)) ||
1885 GNUNET_BIO_read_int64 (rh, &uc->file_size)) ||
1887 read_start_time (rh, &uc->start_time)) ||
1889 GNUNET_BIO_read_int32 (rh, &state)) )
1891 uc->state = (enum UnindexState) state;
1894 case UNINDEX_STATE_HASHING:
1896 case UNINDEX_STATE_FS_NOTIFY:
1898 GNUNET_BIO_read (rh, "unindex-hash", &uc->file_id, sizeof (GNUNET_HashCode)))
1901 case UNINDEX_STATE_DS_REMOVE:
1903 case UNINDEX_STATE_COMPLETE:
1905 case UNINDEX_STATE_ERROR:
1907 GNUNET_BIO_read_string (rh, "unindex-emsg", &uc->emsg, 10*1024))
1910 case UNINDEX_STATE_ABORTED:
1917 pi.status = GNUNET_FS_STATUS_UNINDEX_RESUME;
1918 pi.value.unindex.specifics.resume.message = uc->emsg;
1919 GNUNET_FS_unindex_make_status_ (&pi,
1921 (uc->state == UNINDEX_STATE_COMPLETE)
1926 case UNINDEX_STATE_HASHING:
1927 GNUNET_CRYPTO_hash_file (uc->h->sched,
1928 GNUNET_SCHEDULER_PRIORITY_IDLE,
1931 &GNUNET_FS_unindex_process_hash_,
1934 case UNINDEX_STATE_FS_NOTIFY:
1935 uc->state = UNINDEX_STATE_HASHING;
1936 GNUNET_FS_unindex_process_hash_ (uc,
1939 case UNINDEX_STATE_DS_REMOVE:
1940 GNUNET_FS_unindex_do_remove_ (uc);
1942 case UNINDEX_STATE_COMPLETE:
1943 case UNINDEX_STATE_ERROR:
1944 /* no need to resume any operation, we were done */
1950 GNUNET_BIO_read_close (rh, &emsg))
1952 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1953 _("Failure while resuming unindexing operation `%s': %s\n"),
1960 GNUNET_free_non_null (uc->filename);
1961 if ( (rh != NULL) &&
1963 GNUNET_BIO_read_close (rh, &emsg)) )
1965 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1966 _("Failed to resume unindexing operation `%s': %s\n"),
1971 if (uc->serialization != NULL)
1972 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX, uc->serialization);
1973 GNUNET_free_non_null (uc->serialization);
1980 * Deserialize a download.
1982 * @param h overall context
1983 * @param rh file to deserialize from
1984 * @param parent parent download
1985 * @param search associated search
1986 * @param serialization name under which the search was serialized
1989 deserialize_download (struct GNUNET_FS_Handle *h,
1990 struct GNUNET_BIO_ReadHandle *rh,
1991 struct GNUNET_FS_DownloadContext *parent,
1992 struct GNUNET_FS_SearchResult *search,
1993 const char *serialization);
1997 * Deserialize a search.
1999 * @param h overall context
2000 * @param rh file to deserialize from
2001 * @param psearch_result parent search result
2002 * @param serialization name under which the search was serialized
2004 static struct GNUNET_FS_SearchContext *
2005 deserialize_search (struct GNUNET_FS_Handle *h,
2006 struct GNUNET_BIO_ReadHandle *rh,
2007 struct GNUNET_FS_SearchResult *psearch_result,
2008 const char *serialization);
2012 * Function called with a filename of serialized search result
2015 * @param cls the 'struct GNUNET_FS_SearchContext*'
2016 * @param filename complete filename (absolute path)
2017 * @return GNUNET_OK (continue to iterate)
2020 deserialize_search_result (void *cls,
2021 const char *filename)
2023 struct GNUNET_FS_SearchContext *sc = cls;
2029 struct GNUNET_BIO_ReadHandle *rh;
2030 struct GNUNET_BIO_ReadHandle *drh;
2031 struct GNUNET_FS_SearchResult *sr;
2033 ser = get_serialization_short_name (filename);
2034 rh = GNUNET_BIO_read_open (filename);
2039 remove_sync_file_in_dir (sc->h,
2040 (sc->psearch_result == NULL)
2041 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2042 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2052 sr = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchResult));
2053 sr->serialization = ser;
2055 GNUNET_BIO_read_string (rh, "result-uri", &uris, 10*1024)) ||
2056 (NULL == (sr->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2058 GNUNET_BIO_read_string (rh, "download-lnk", &download, 16)) ||
2060 GNUNET_BIO_read_string (rh, "search-lnk", &update_srch, 16)) ||
2062 GNUNET_BIO_read_meta_data (rh, "result-meta", &sr->meta)) ||
2064 GNUNET_BIO_read (rh, "result-key", &sr->key, sizeof (GNUNET_HashCode))) ||
2066 GNUNET_BIO_read_int32 (rh, &sr->mandatory_missing)) ||
2068 GNUNET_BIO_read_int32 (rh, &sr->optional_support)) ||
2070 GNUNET_BIO_read_int32 (rh, &sr->availability_success)) ||
2072 GNUNET_BIO_read_int32 (rh, &sr->availability_trials)) )
2075 if (download != NULL)
2077 drh = get_read_handle (sc->h,
2078 GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD,
2080 deserialize_download (sc->h,
2086 GNUNET_BIO_read_close (drh, &emsg))
2088 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2089 _("Failed to resume sub-download `%s': %s\n"),
2094 GNUNET_free (download);
2096 if (update_srch != NULL)
2098 drh = get_read_handle (sc->h,
2099 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2101 deserialize_search (sc->h,
2106 GNUNET_BIO_read_close (drh, &emsg))
2108 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2109 _("Failed to resume sub-search `%s': %s\n"),
2114 GNUNET_free (update_srch);
2116 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map,
2119 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2122 GNUNET_free_non_null (download);
2123 GNUNET_free_non_null (emsg);
2124 GNUNET_free_non_null (uris);
2125 if (sr->uri != NULL)
2126 GNUNET_FS_uri_destroy (sr->uri);
2127 if (sr->meta != NULL)
2128 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2129 GNUNET_free (sr->serialization);
2136 * Send the 'resume' signal to the callback; also actually
2137 * resume the download (put it in the queue). Does this
2138 * recursively for the top-level download and all child
2141 * @param dc download to resume
2144 signal_download_resume (struct GNUNET_FS_DownloadContext *dc)
2146 struct GNUNET_FS_DownloadContext *dcc;
2147 struct GNUNET_FS_ProgressInfo pi;
2149 pi.status = GNUNET_FS_STATUS_DOWNLOAD_RESUME;
2150 pi.value.download.specifics.resume.meta = dc->meta;
2151 pi.value.download.specifics.resume.message = dc->emsg;
2152 GNUNET_FS_download_make_status_ (&pi,
2154 dcc = dc->child_head;
2157 signal_download_resume (dcc);
2160 if (dc->pending != NULL)
2161 GNUNET_FS_download_start_downloading_ (dc);
2166 * Signal resuming of a search to our clients (for the
2167 * top level search and all sub-searches).
2169 * @param sc search being resumed
2172 signal_search_resume (struct GNUNET_FS_SearchContext *sc);
2176 * Iterator over search results signaling resume to the client for
2179 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2180 * @param key current key code
2181 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2182 * @return GNUNET_YES (we should continue to iterate)
2185 signal_result_resume (void *cls,
2186 const GNUNET_HashCode * key,
2189 struct GNUNET_FS_SearchContext *sc = cls;
2190 struct GNUNET_FS_ProgressInfo pi;
2191 struct GNUNET_FS_SearchResult *sr = value;
2193 if (0 == sr->mandatory_missing)
2195 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME_RESULT;
2196 pi.value.search.specifics.resume_result.meta = sr->meta;
2197 pi.value.search.specifics.resume_result.uri = sr->uri;
2198 pi.value.search.specifics.resume_result.result = sr;
2199 pi.value.search.specifics.resume_result.availability_rank = 2*sr->availability_success - sr->availability_trials;
2200 pi.value.search.specifics.resume_result.availability_certainty = sr->availability_trials;
2201 pi.value.search.specifics.resume_result.applicability_rank = sr->optional_support;
2202 sr->client_info = GNUNET_FS_search_make_status_ (&pi,
2205 if (sr->download != NULL)
2207 signal_download_resume (sr->download);
2211 GNUNET_FS_search_start_probe_ (sr);
2213 if (sr->update_search != NULL)
2214 signal_search_resume (sr->update_search);
2220 * Free memory allocated by the search context and its children
2222 * @param sc search context to free
2225 free_search_context (struct GNUNET_FS_SearchContext *sc);
2229 * Iterator over search results freeing each.
2231 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2232 * @param key current key code
2233 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2234 * @return GNUNET_YES (we should continue to iterate)
2237 free_result (void *cls,
2238 const GNUNET_HashCode * key,
2241 struct GNUNET_FS_SearchResult *sr = value;
2243 if (sr->update_search != NULL)
2245 free_search_context (sr->update_search);
2246 GNUNET_assert (NULL == sr->update_search);
2248 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2249 GNUNET_FS_uri_destroy (sr->uri);
2256 * Free memory allocated by the search context and its children
2258 * @param sc search context to free
2261 free_search_context (struct GNUNET_FS_SearchContext *sc)
2263 if (sc->serialization != NULL)
2265 GNUNET_FS_remove_sync_file_ (sc->h,
2266 (sc->psearch_result == NULL)
2267 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2268 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2270 GNUNET_FS_remove_sync_dir_ (sc->h,
2271 (sc->psearch_result == NULL)
2272 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2273 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2276 GNUNET_free_non_null (sc->serialization);
2277 GNUNET_free_non_null (sc->emsg);
2278 if (sc->uri != NULL)
2279 GNUNET_FS_uri_destroy (sc->uri);
2280 if (sc->master_result_map != NULL)
2282 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2285 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
2292 * Function called with a filename of serialized sub-download
2295 * @param cls the 'struct GNUNET_FS_DownloadContext*' (parent)
2296 * @param filename complete filename (absolute path)
2297 * @return GNUNET_OK (continue to iterate)
2300 deserialize_subdownload (void *cls,
2301 const char *filename)
2303 struct GNUNET_FS_DownloadContext *parent = cls;
2306 struct GNUNET_BIO_ReadHandle *rh;
2308 ser = get_serialization_short_name (filename);
2309 rh = GNUNET_BIO_read_open (filename);
2310 deserialize_download (parent->h,
2316 GNUNET_BIO_read_close (rh, &emsg))
2318 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2319 _("Failed to resume sub-download `%s': %s\n"),
2330 * Free this download context and all of its descendants.
2331 * (only works during deserialization since not all possible
2332 * state it taken care of).
2334 * @param dc context to free
2337 free_download_context (struct GNUNET_FS_DownloadContext *dc)
2339 struct GNUNET_FS_DownloadContext *dcc;
2340 struct DownloadRequest *dr;
2341 if (dc->meta != NULL)
2342 GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2343 if (dc->uri != NULL)
2344 GNUNET_FS_uri_destroy (dc->uri);
2345 GNUNET_free_non_null (dc->temp_filename);
2346 GNUNET_free_non_null (dc->emsg);
2347 GNUNET_free_non_null (dc->filename);
2348 while (NULL != (dcc = dc->child_head))
2350 GNUNET_CONTAINER_DLL_remove (dc->child_head,
2353 free_download_context (dcc);
2355 while (NULL != (dr = dc->pending))
2357 dc->pending = dr->next;
2365 * Deserialize a download.
2367 * @param h overall context
2368 * @param rh file to deserialize from
2369 * @param parent parent download
2370 * @param search associated search
2371 * @param serialization name under which the search was serialized
2374 deserialize_download (struct GNUNET_FS_Handle *h,
2375 struct GNUNET_BIO_ReadHandle *rh,
2376 struct GNUNET_FS_DownloadContext *parent,
2377 struct GNUNET_FS_SearchResult *search,
2378 const char *serialization)
2380 struct GNUNET_FS_DownloadContext *dc;
2381 struct DownloadRequest *dr;
2387 uint32_t num_pending;
2392 dc = GNUNET_malloc (sizeof (struct GNUNET_FS_DownloadContext));
2393 dc->parent = parent;
2395 dc->serialization = GNUNET_strdup (serialization);
2397 GNUNET_BIO_read_string (rh, "download-uri", &uris, 10*1024)) ||
2398 (NULL == (dc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2399 ( (GNUNET_YES != GNUNET_FS_uri_test_chk (dc->uri)) &&
2400 (GNUNET_YES != GNUNET_FS_uri_test_loc (dc->uri)) ) ||
2402 GNUNET_BIO_read_meta_data (rh, "download-meta", &dc->meta)) ||
2404 GNUNET_BIO_read_string (rh, "download-emsg", &dc->emsg, 10*1024)) ||
2406 GNUNET_BIO_read_string (rh, "download-fn", &dc->filename, 10*1024)) ||
2408 GNUNET_BIO_read_string (rh, "download-tfn", &dc->temp_filename, 10*1024)) ||
2410 GNUNET_BIO_read_int64 (rh, &dc->old_file_size)) ||
2412 GNUNET_BIO_read_int64 (rh, &dc->offset)) ||
2414 GNUNET_BIO_read_int64 (rh, &dc->length)) ||
2416 GNUNET_BIO_read_int64 (rh, &dc->completed)) ||
2418 read_start_time (rh, &dc->start_time)) ||
2420 GNUNET_BIO_read_int32 (rh, &dc->anonymity)) ||
2422 GNUNET_BIO_read_int32 (rh, &options)) ||
2424 GNUNET_BIO_read_int32 (rh, &status)) ||
2426 GNUNET_BIO_read_int32 (rh, &num_pending)) )
2428 dc->options = (enum GNUNET_FS_DownloadOptions) options;
2429 dc->active = GNUNET_CONTAINER_multihashmap_create (16);
2430 dc->has_finished = (int) status;
2431 dc->treedepth = GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size (dc->uri));
2432 if (GNUNET_FS_uri_test_loc (dc->uri))
2433 GNUNET_assert (GNUNET_OK ==
2434 GNUNET_FS_uri_loc_get_peer_identity (dc->uri,
2436 if ( (dc->length > dc->completed) &&
2437 (num_pending == 0) )
2439 while (0 < num_pending--)
2441 dr = GNUNET_malloc (sizeof (struct DownloadRequest));
2443 GNUNET_BIO_read (rh, "chk", &dr->chk, sizeof (struct ContentHashKey))) ||
2445 GNUNET_BIO_read_int64 (rh, &dr->offset)) ||
2447 GNUNET_BIO_read_int32 (rh, &dr->depth)) )
2449 dr->is_pending = GNUNET_YES;
2450 dr->next = dc->pending;
2454 dn = get_download_sync_filename (dc, "");
2458 GNUNET_DISK_directory_test (dn))
2459 GNUNET_DISK_directory_scan (dn, &deserialize_subdownload, dc);
2463 GNUNET_CONTAINER_DLL_insert (parent->child_head,
2468 dc->search = search;
2469 search->download = dc;
2471 signal_download_resume (dc);
2475 GNUNET_free_non_null (uris);
2476 GNUNET_free_non_null (dr);
2477 GNUNET_free_non_null (emsg);
2478 free_download_context (dc);
2483 * Signal resuming of a search to our clients (for the
2484 * top level search and all sub-searches).
2486 * @param sc search being resumed
2489 signal_search_resume (struct GNUNET_FS_SearchContext *sc)
2491 struct GNUNET_FS_ProgressInfo pi;
2493 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME;
2494 pi.value.search.specifics.resume.message = sc->emsg;
2495 pi.value.search.specifics.resume.is_paused = (sc->client == NULL) ? GNUNET_YES : GNUNET_NO;
2496 sc->client_info = GNUNET_FS_search_make_status_ (&pi,
2498 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2499 &signal_result_resume,
2506 * Deserialize a search.
2508 * @param h overall context
2509 * @param rh file to deserialize from
2510 * @param psearch_result parent search result
2511 * @param serialization name under which the search was serialized
2513 static struct GNUNET_FS_SearchContext *
2514 deserialize_search (struct GNUNET_FS_Handle *h,
2515 struct GNUNET_BIO_ReadHandle *rh,
2516 struct GNUNET_FS_SearchResult *psearch_result,
2517 const char *serialization)
2519 struct GNUNET_FS_SearchContext *sc;
2526 if ( (psearch_result != NULL) &&
2527 (psearch_result->update_search != NULL) )
2534 sc = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchContext));
2535 if (psearch_result != NULL)
2537 sc->psearch_result = psearch_result;
2538 psearch_result->update_search = sc;
2541 sc->serialization = GNUNET_strdup (serialization);
2543 GNUNET_BIO_read_string (rh, "search-uri", &uris, 10*1024)) ||
2544 (NULL == (sc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2545 ( (GNUNET_YES != GNUNET_FS_uri_test_ksk (sc->uri)) &&
2546 (GNUNET_YES != GNUNET_FS_uri_test_sks (sc->uri)) ) ||
2548 read_start_time (rh, &sc->start_time)) ||
2550 GNUNET_BIO_read_string (rh, "search-emsg", &sc->emsg, 10*1024)) ||
2552 GNUNET_BIO_read_int32 (rh, &options)) ||
2554 GNUNET_BIO_read (rh, "search-pause", &in_pause, sizeof (in_pause))) ||
2556 GNUNET_BIO_read_int32 (rh, &sc->anonymity)) )
2558 sc->options = (enum GNUNET_FS_SearchOptions) options;
2559 sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16);
2560 dn = get_serialization_file_name_in_dir (h,
2561 (sc->psearch_result == NULL)
2562 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2563 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2569 GNUNET_DISK_directory_test (dn))
2570 GNUNET_DISK_directory_scan (dn, &deserialize_search_result, sc);
2573 if ( ('\0' == in_pause) &&
2575 GNUNET_FS_search_start_searching_ (sc)) )
2577 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2578 _("Could not resume running search, will resume as paused search\n"));
2580 signal_search_resume (sc);
2584 GNUNET_free_non_null (emsg);
2585 free_search_context (sc);
2586 GNUNET_free_non_null (uris);
2592 * Function called with a filename of serialized search operation
2595 * @param cls the 'struct GNUNET_FS_Handle*'
2596 * @param filename complete filename (absolute path)
2597 * @return GNUNET_OK (continue to iterate)
2600 deserialize_search_file (void *cls,
2601 const char *filename)
2603 struct GNUNET_FS_Handle *h = cls;
2606 struct GNUNET_BIO_ReadHandle *rh;
2608 ser = get_serialization_short_name (filename);
2609 rh = GNUNET_BIO_read_open (filename);
2614 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_SEARCH, ser);
2619 (void) deserialize_search (h, rh, NULL, ser);
2622 GNUNET_BIO_read_close (rh, &emsg))
2624 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2625 _("Failure while resuming search operation `%s': %s\n"),
2635 * Function called with a filename of serialized download operation
2638 * @param cls the 'struct GNUNET_FS_Handle*'
2639 * @param filename complete filename (absolute path)
2640 * @return GNUNET_OK (continue to iterate)
2643 deserialize_download_file (void *cls,
2644 const char *filename)
2646 struct GNUNET_FS_Handle *h = cls;
2649 struct GNUNET_BIO_ReadHandle *rh;
2651 ser = get_serialization_short_name (filename);
2652 rh = GNUNET_BIO_read_open (filename);
2655 if (filename != NULL)
2657 if (0 != UNLINK (filename))
2658 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
2665 deserialize_download (h, rh, NULL, NULL, ser);
2668 GNUNET_BIO_read_close (rh, &emsg))
2670 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2671 _("Failure while resuming download operation `%s': %s\n"),
2681 * Deserialize informatin about pending operations.
2683 * @param master_path which master directory should be scanned
2684 * @param proc function to call for each entry (will get 'h' for 'cls')
2685 * @param h the 'struct GNUNET_FS_Handle*'
2688 deserialization_master (const char *master_path,
2689 GNUNET_FileNameCallback proc,
2690 struct GNUNET_FS_Handle *h)
2694 dn = get_serialization_file_name (h, master_path, "");
2698 GNUNET_DISK_directory_test (dn))
2699 GNUNET_DISK_directory_scan (dn, proc, h);
2705 * Setup a connection to the file-sharing service.
2707 * @param sched scheduler to use
2708 * @param cfg configuration to use
2709 * @param client_name unique identifier for this client
2710 * @param upcb function to call to notify about FS actions
2711 * @param upcb_cls closure for upcb
2712 * @param flags specific attributes for fs-operations
2713 * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
2714 * @return NULL on error
2716 struct GNUNET_FS_Handle *
2717 GNUNET_FS_start (struct GNUNET_SCHEDULER_Handle *sched,
2718 const struct GNUNET_CONFIGURATION_Handle *cfg,
2719 const char *client_name,
2720 GNUNET_FS_ProgressCallback upcb,
2722 enum GNUNET_FS_Flags flags,
2725 struct GNUNET_FS_Handle *ret;
2726 enum GNUNET_FS_OPTIONS opt;
2729 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Handle));
2732 ret->client_name = GNUNET_strdup (client_name);
2734 ret->upcb_cls = upcb_cls;
2736 ret->max_parallel_downloads = 1;
2737 ret->max_parallel_requests = 1;
2738 ret->avg_block_latency = GNUNET_TIME_UNIT_MINUTES; /* conservative starting point */
2739 va_start (ap, flags);
2740 while (GNUNET_FS_OPTIONS_END != (opt = va_arg (ap, enum GNUNET_FS_OPTIONS)))
2744 case GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM:
2745 ret->max_parallel_downloads = va_arg (ap, unsigned int);
2747 case GNUNET_FS_OPTIONS_REQUEST_PARALLELISM:
2748 ret->max_parallel_requests = va_arg (ap, unsigned int);
2752 GNUNET_free (ret->client_name);
2759 if (0 != (GNUNET_FS_FLAGS_PERSISTENCE & flags))
2761 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
2762 &deserialize_publish_file,
2764 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
2765 &deserialize_search_file,
2767 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
2768 &deserialize_download_file,
2770 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2771 &deserialize_unindex_file,
2779 * Close our connection with the file-sharing service.
2780 * The callback given to GNUNET_FS_start will no longer be
2781 * called after this function returns.
2783 * @param h handle that was returned from GNUNET_FS_start
2786 GNUNET_FS_stop (struct GNUNET_FS_Handle *h)
2788 while (h->top_head != NULL)
2789 h->top_head->ssf (h->top_head->ssf_cls);
2790 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
2791 GNUNET_SCHEDULER_cancel (h->sched,
2793 GNUNET_free (h->client_name);