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,
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);
528 ret = GNUNET_BIO_write_open (fn);
535 * Return a write handle for serialization.
537 * @param h master context
538 * @param ext component of the path
539 * @param uni name of parent
540 * @param ent entity identifier (or emtpy string for the directory)
541 * @return NULL on error
543 static struct GNUNET_BIO_WriteHandle *
544 get_write_handle_in_dir (struct GNUNET_FS_Handle *h,
550 struct GNUNET_BIO_WriteHandle *ret;
552 fn = get_serialization_file_name_in_dir (h, ext, uni, ent);
555 ret = GNUNET_BIO_write_open (fn);
562 * Remove serialization/deserialization file from disk.
564 * @param h master context
565 * @param ext component of the path
566 * @param ent entity identifier
569 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h,
575 if ( (NULL == ent) ||
576 (0 == strlen (ent)) )
581 filename = get_serialization_file_name (h, ext, ent);
582 if (0 != UNLINK (filename))
583 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
586 GNUNET_free (filename);
591 * Remove serialization/deserialization file from disk.
593 * @param h master context
594 * @param ext component of the path
595 * @param uni parent name
596 * @param ent entity identifier
599 remove_sync_file_in_dir (struct GNUNET_FS_Handle *h,
606 if ( (NULL == ent) ||
607 (0 == strlen (ent)) )
612 filename = get_serialization_file_name_in_dir (h, ext, uni, ent);
613 if (0 != UNLINK (filename))
614 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
617 GNUNET_free (filename);
622 * Remove serialization/deserialization directory from disk.
624 * @param h master context
625 * @param ext component of the path
626 * @param uni unique name of parent
629 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h,
637 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
640 if ( (GNUNET_OK == GNUNET_DISK_directory_test (dn)) &&
641 (GNUNET_OK != GNUNET_DISK_directory_remove (dn)) )
642 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
650 * Serialize a 'start_time'. Since we use start-times to
651 * calculate the duration of some operation, we actually
652 * do not serialize the absolute time but the (relative)
653 * duration since the start time. When we then
654 * deserialize the start time, we take the current time and
655 * subtract that duration so that we get again an absolute
656 * time stamp that will result in correct performance
659 * @param wh handle for writing
660 * @param timestamp time to serialize
661 * @return GNUNET_OK on success
664 write_start_time (struct GNUNET_BIO_WriteHandle *wh,
665 struct GNUNET_TIME_Absolute timestamp)
667 struct GNUNET_TIME_Relative dur;
669 dur = GNUNET_TIME_absolute_get_duration (timestamp);
670 return GNUNET_BIO_write_int64 (wh, dur.value);
675 * Serialize a 'start_time'. Since we use start-times to
676 * calculate the duration of some operation, we actually
677 * do not serialize the absolute time but the (relative)
678 * duration since the start time. When we then
679 * deserialize the start time, we take the current time and
680 * subtract that duration so that we get again an absolute
681 * time stamp that will result in correct performance
684 * @param rh handle for reading
685 * @param timestamp where to write the deserialized timestamp
686 * @return GNUNET_OK on success
689 read_start_time (struct GNUNET_BIO_ReadHandle *rh,
690 struct GNUNET_TIME_Absolute *timestamp)
692 struct GNUNET_TIME_Relative dur;
694 GNUNET_BIO_read_int64 (rh, &dur.value))
695 return GNUNET_SYSERR;
696 *timestamp = GNUNET_TIME_absolute_subtract (GNUNET_TIME_absolute_get (),
703 * Using the given serialization filename, try to deserialize
704 * the file-information tree associated with it.
706 * @param h master context
707 * @param filename name of the file (without directory) with
709 * @return NULL on error
711 static struct GNUNET_FS_FileInformation *
712 deserialize_file_information (struct GNUNET_FS_Handle *h,
713 const char *filename);
717 * Using the given serialization filename, try to deserialize
718 * the file-information tree associated with it.
720 * @param h master context
721 * @param fn name of the file (without directory) with
723 * @param rh handle for reading
724 * @return NULL on error
726 static struct GNUNET_FS_FileInformation *
727 deserialize_fi_node (struct GNUNET_FS_Handle *h,
729 struct GNUNET_BIO_ReadHandle *rh)
731 struct GNUNET_FS_FileInformation *ret;
732 struct GNUNET_FS_FileInformation *nxt;
740 GNUNET_BIO_read (rh, "status flag", &b, sizeof(b)))
745 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_FileInformation));
750 GNUNET_BIO_read_meta_data (rh, "metadata", &ret->meta)) ||
752 GNUNET_BIO_read_string (rh, "ksk-uri", &ksks, 32*1024)) ||
755 (ret->keywords = GNUNET_FS_uri_parse (ksks, NULL))) ) ||
757 GNUNET_FS_uri_test_ksk (ret->keywords)) ||
759 GNUNET_BIO_read_string (rh, "chk-uri", &chks, 1024)) ||
762 (ret->chk_uri = GNUNET_FS_uri_parse (chks, NULL))) ||
764 GNUNET_FS_uri_test_chk (ret->chk_uri)) ) ) ||
766 GNUNET_BIO_read_int64 (rh, &ret->expirationTime.value)) ||
768 read_start_time (rh, &ret->start_time)) ||
770 GNUNET_BIO_read_string (rh, "emsg", &ret->emsg, 16*1024)) ||
772 GNUNET_BIO_read_string (rh, "fn", &ret->filename, 16*1024)) ||
774 GNUNET_BIO_read_int32 (rh, &ret->anonymity)) ||
776 GNUNET_BIO_read_int32 (rh, &ret->priority)) )
780 case 0: /* file-insert */
782 GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
784 ret->is_directory = GNUNET_NO;
785 ret->data.file.do_index = GNUNET_NO;
786 ret->data.file.have_hash = GNUNET_NO;
787 ret->data.file.index_start_confirmed = GNUNET_NO;
788 if (GNUNET_NO == ret->is_published)
790 if (NULL == ret->filename)
792 ret->data.file.reader = &GNUNET_FS_data_reader_copy_;
793 ret->data.file.reader_cls = GNUNET_malloc_large (ret->data.file.file_size);
794 if (ret->data.file.reader_cls == NULL)
797 GNUNET_BIO_read (rh, "file-data", ret->data.file.reader_cls, ret->data.file.file_size))
802 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
803 ret->data.file.reader_cls = GNUNET_FS_make_file_reader_context_ (ret->filename);
807 case 1: /* file-index, no hash */
808 if (NULL == ret->filename)
811 GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
813 ret->is_directory = GNUNET_NO;
814 ret->data.file.do_index = GNUNET_YES;
815 ret->data.file.have_hash = GNUNET_NO;
816 ret->data.file.index_start_confirmed = GNUNET_NO;
817 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
818 ret->data.file.reader_cls = GNUNET_FS_make_file_reader_context_ (ret->filename);
820 case 2: /* file-index-with-hash */
821 if (NULL == ret->filename)
824 GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
826 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id, sizeof (GNUNET_HashCode))) )
828 ret->is_directory = GNUNET_NO;
829 ret->data.file.do_index = GNUNET_YES;
830 ret->data.file.have_hash = GNUNET_YES;
831 ret->data.file.index_start_confirmed = GNUNET_NO;
832 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
833 ret->data.file.reader_cls = GNUNET_FS_make_file_reader_context_ (ret->filename);
835 case 3: /* file-index-with-hash-confirmed */
836 if (NULL == ret->filename)
839 GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
841 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id, sizeof (GNUNET_HashCode))) )
844 ret->is_directory = GNUNET_NO;
845 ret->data.file.do_index = GNUNET_YES;
846 ret->data.file.have_hash = GNUNET_YES;
847 ret->data.file.index_start_confirmed = GNUNET_YES;
848 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
849 ret->data.file.reader_cls = GNUNET_FS_make_file_reader_context_ (ret->filename);
851 case 4: /* directory */
853 GNUNET_BIO_read_int32 (rh, &dsize)) ||
854 (NULL == (ret->data.dir.dir_data = GNUNET_malloc_large (dsize))) ||
856 GNUNET_BIO_read (rh, "dir-data", ret->data.dir.dir_data, dsize)) ||
858 GNUNET_BIO_read_string (rh, "ent-filename", &filename, 16*1024)) )
860 ret->data.dir.dir_size = (uint32_t) dsize;
861 ret->is_directory = GNUNET_YES;
862 if (filename != NULL)
864 ret->data.dir.entries = deserialize_file_information (h, filename);
865 GNUNET_free (filename);
867 nxt = ret->data.dir.entries;
879 ret->serialization = GNUNET_strdup (fn);
881 GNUNET_BIO_read_string (rh, "nxt-filename", &filename, 16*1024))
883 if (filename != NULL)
885 ret->next = deserialize_file_information (h, filename);
886 GNUNET_free (filename);
889 GNUNET_free_non_null (ksks);
890 GNUNET_free_non_null (chks);
893 GNUNET_free_non_null (ksks);
894 GNUNET_free_non_null (chks);
895 GNUNET_free_non_null (filename);
896 GNUNET_FS_file_information_destroy (ret, NULL, NULL);
902 * Using the given serialization filename, try to deserialize
903 * the file-information tree associated with it.
905 * @param h master context
906 * @param filename name of the file (without directory) with
908 * @return NULL on error
910 static struct GNUNET_FS_FileInformation *
911 deserialize_file_information (struct GNUNET_FS_Handle *h,
912 const char *filename)
914 struct GNUNET_FS_FileInformation *ret;
915 struct GNUNET_BIO_ReadHandle *rh;
918 rh = get_read_handle (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
921 ret = deserialize_fi_node (h, filename, rh);
923 GNUNET_BIO_read_close (rh, &emsg))
925 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
926 _("Failed to resume publishing information `%s': %s\n"),
936 * Given a serialization name (full absolute path), return the
937 * basename of the file (without the path), which must only
938 * consist of the 6 random characters.
940 * @param fullname name to extract the basename from
941 * @return copy of the basename, NULL on error
944 get_serialization_short_name (const char *fullname)
951 /* FIXME: we could do this faster since we know
952 the length of 'end'... */
955 if (DIR_SEPARATOR == *nxt)
959 if ( (end == NULL) ||
960 (strlen (end) == 0) )
965 GNUNET_break (6 == strlen (end));
966 return GNUNET_strdup (end);
971 * Create a new random name for serialization. Also checks if persistence
972 * is enabled and returns NULL if not.
974 * @param h master context
975 * @param ext component of the path
976 * @return NULL on errror
979 make_serialization_file_name (struct GNUNET_FS_Handle *h,
986 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
987 return NULL; /* persistence not requested */
988 dn = get_serialization_file_name (h, ext, "");
990 GNUNET_DISK_directory_create_for_file (dn))
995 fn = GNUNET_DISK_mktemp (dn);
998 return NULL; /* epic fail */
999 ret = get_serialization_short_name (fn);
1006 * Create a new random name for serialization. Also checks if persistence
1007 * is enabled and returns NULL if not.
1009 * @param h master context
1010 * @param ext component of the path
1011 * @param uni name of parent
1012 * @return NULL on errror
1015 make_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h,
1023 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1024 return NULL; /* persistence not requested */
1025 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
1027 GNUNET_DISK_directory_create_for_file (dn))
1032 fn = GNUNET_DISK_mktemp (dn);
1035 return NULL; /* epic fail */
1036 ret = get_serialization_short_name (fn);
1043 * Copy all of the data from the reader to the write handle.
1045 * @param wh write handle
1046 * @param fi file with reader
1047 * @return GNUNET_OK on success
1050 copy_from_reader (struct GNUNET_BIO_WriteHandle *wh,
1051 struct GNUNET_FS_FileInformation * fi)
1053 char buf[32 * 1024];
1060 while (off < fi->data.file.file_size)
1062 ret = fi->data.file.reader (fi->data.file.reader_cls,
1069 return GNUNET_SYSERR;
1072 GNUNET_BIO_write (wh, buf, ret))
1073 return GNUNET_SYSERR;
1081 * Create a temporary file on disk to store the current
1084 * @param fi file information to sync with disk
1087 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation * fi)
1090 struct GNUNET_BIO_WriteHandle *wh;
1095 if (NULL == fi->serialization)
1096 fi->serialization = make_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO);
1097 if (NULL == fi->serialization)
1099 wh = get_write_handle (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO, fi->serialization);
1102 GNUNET_free (fi->serialization);
1103 fi->serialization = NULL;
1106 if (GNUNET_YES == fi->is_directory)
1108 else if (GNUNET_YES == fi->data.file.index_start_confirmed)
1110 else if (GNUNET_YES == fi->data.file.have_hash)
1112 else if (GNUNET_YES == fi->data.file.do_index)
1116 if (fi->keywords != NULL)
1117 ksks = GNUNET_FS_uri_to_string (fi->keywords);
1120 if (fi->chk_uri != NULL)
1121 chks = GNUNET_FS_uri_to_string (fi->chk_uri);
1125 GNUNET_BIO_write (wh, &b, sizeof (b))) ||
1127 GNUNET_BIO_write_meta_data (wh, fi->meta)) ||
1129 GNUNET_BIO_write_string (wh, ksks)) ||
1131 GNUNET_BIO_write_string (wh, chks)) ||
1133 GNUNET_BIO_write_int64 (wh, fi->expirationTime.value)) ||
1135 write_start_time (wh, fi->start_time)) ||
1137 GNUNET_BIO_write_string (wh, fi->emsg)) ||
1139 GNUNET_BIO_write_string (wh, fi->filename)) ||
1141 GNUNET_BIO_write_int32 (wh, fi->anonymity)) ||
1143 GNUNET_BIO_write_int32 (wh, fi->priority)) )
1145 GNUNET_free_non_null (chks);
1147 GNUNET_free_non_null (ksks);
1152 case 0: /* file-insert */
1154 GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1156 if ( (GNUNET_NO == fi->is_published) &&
1157 (NULL == fi->filename) )
1159 copy_from_reader (wh, fi))
1162 case 1: /* file-index, no hash */
1163 if (NULL == fi->filename)
1166 GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1169 case 2: /* file-index-with-hash */
1170 case 3: /* file-index-with-hash-confirmed */
1171 if (NULL == fi->filename)
1174 GNUNET_BIO_write_int64 (wh, fi->data.file.file_size)) ||
1176 GNUNET_BIO_write (wh, &fi->data.file.file_id, sizeof (GNUNET_HashCode))) )
1179 case 4: /* directory */
1181 GNUNET_BIO_write_int32 (wh, fi->data.dir.dir_size)) ||
1183 GNUNET_BIO_write (wh, fi->data.dir.dir_data, (uint32_t) fi->data.dir.dir_size)) ||
1185 GNUNET_BIO_write_string (wh, fi->data.dir.entries->serialization)) )
1193 GNUNET_BIO_write_string (wh, fi->next->serialization))
1196 GNUNET_BIO_write_close (wh))
1199 (void) GNUNET_BIO_write_close (wh);
1200 GNUNET_free_non_null (chks);
1201 GNUNET_free_non_null (ksks);
1202 fn = get_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO, fi->serialization);
1203 if (0 != UNLINK (fn))
1204 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1206 GNUNET_free (fi->serialization);
1207 fi->serialization = NULL;
1213 * Find the entry in the file information struct where the
1214 * serialization filename matches the given name.
1216 * @param pos file information to search
1217 * @param srch filename to search for
1218 * @return NULL if srch was not found in this subtree
1220 static struct GNUNET_FS_FileInformation *
1221 find_file_position (struct GNUNET_FS_FileInformation *pos,
1224 struct GNUNET_FS_FileInformation *r;
1228 if (0 == strcmp (srch,
1229 pos->serialization))
1231 if (pos->is_directory)
1233 r = find_file_position (pos->data.dir.entries,
1245 * Signal the FS's progress function that we are resuming
1248 * @param cls closure (of type "struct GNUNET_FS_PublishContext*")
1249 * @param fi the entry in the publish-structure
1250 * @param length length of the file or directory
1251 * @param meta metadata for the file or directory (can be modified)
1252 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1253 * @param anonymity pointer to selected anonymity level (can be modified)
1254 * @param priority pointer to selected priority (can be modified)
1255 * @param expirationTime pointer to selected expiration time (can be modified)
1256 * @param client_info pointer to client context set upon creation (can be modified)
1257 * @return GNUNET_OK to continue (always)
1260 fip_signal_resume(void *cls,
1261 struct GNUNET_FS_FileInformation *fi,
1263 struct GNUNET_CONTAINER_MetaData *meta,
1264 struct GNUNET_FS_Uri **uri,
1265 uint32_t *anonymity,
1267 struct GNUNET_TIME_Absolute *expirationTime,
1270 struct GNUNET_FS_PublishContext *sc = cls;
1271 struct GNUNET_FS_ProgressInfo pi;
1273 pi.status = GNUNET_FS_STATUS_PUBLISH_RESUME;
1274 pi.value.publish.specifics.resume.message = sc->fi->emsg;
1275 pi.value.publish.specifics.resume.chk_uri = sc->fi->chk_uri;
1276 *client_info = GNUNET_FS_publish_make_status_ (&pi, sc, fi, 0);
1282 * Function called with a filename of serialized publishing operation
1285 * @param cls the 'struct GNUNET_FS_Handle*'
1286 * @param filename complete filename (absolute path)
1287 * @return GNUNET_OK (continue to iterate)
1290 deserialize_publish_file (void *cls,
1291 const char *filename)
1293 struct GNUNET_FS_Handle *h = cls;
1294 struct GNUNET_BIO_ReadHandle *rh;
1295 struct GNUNET_FS_PublishContext *pc;
1303 pc = GNUNET_malloc (sizeof (struct GNUNET_FS_PublishContext));
1305 pc->serialization = get_serialization_short_name (filename);
1309 rh = GNUNET_BIO_read_open (filename);
1313 GNUNET_BIO_read_string (rh, "publish-nid", &pc->nid, 1024)) ||
1315 GNUNET_BIO_read_string (rh, "publish-nuid", &pc->nuid, 1024)) ||
1317 GNUNET_BIO_read_int32 (rh, &options)) ||
1319 GNUNET_BIO_read_int32 (rh, &all_done)) ||
1321 GNUNET_BIO_read_string (rh, "publish-firoot", &fi_root, 128)) ||
1323 GNUNET_BIO_read_string (rh, "publish-fipos", &fi_pos, 128)) ||
1325 GNUNET_BIO_read_string (rh, "publish-ns", &ns, 1024)) )
1327 pc->options = options;
1328 pc->all_done = all_done;
1329 pc->fi = deserialize_file_information (h, fi_root);
1334 pc->namespace = GNUNET_FS_namespace_create (h, ns);
1335 if (pc->namespace == NULL)
1337 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1338 _("Failed to recover namespace `%s', cannot resume publishing operation.\n"),
1345 pc->fi_pos = find_file_position (pc->fi,
1347 GNUNET_free (fi_pos);
1349 if (pc->fi_pos == NULL)
1351 /* failed to find position for resuming, outch! Will start from root! */
1353 if (pc->all_done != GNUNET_YES)
1354 pc->fi_pos = pc->fi;
1357 /* generate RESUME event(s) */
1358 GNUNET_FS_file_information_inspect (pc->fi,
1362 /* re-start publishing (if needed)... */
1363 if (pc->all_done != GNUNET_YES)
1365 = GNUNET_SCHEDULER_add_with_priority (h->sched,
1366 GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
1367 &GNUNET_FS_publish_main_,
1370 GNUNET_BIO_read_close (rh, &emsg))
1372 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1373 _("Failure while resuming publishing operation `%s': %s\n"),
1378 GNUNET_free_non_null (ns);
1381 GNUNET_free_non_null (pc->nid);
1382 GNUNET_free_non_null (pc->nuid);
1383 GNUNET_free_non_null (fi_root);
1384 GNUNET_free_non_null (fi_pos);
1385 GNUNET_free_non_null (ns);
1386 if ( (rh != NULL) &&
1388 GNUNET_BIO_read_close (rh, &emsg)) )
1390 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1391 _("Failed to resume publishing operation `%s': %s\n"),
1397 GNUNET_FS_file_information_destroy (pc->fi, NULL, NULL);
1398 if (0 != UNLINK (filename))
1399 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
1400 GNUNET_free_non_null (pc->serialization);
1407 * Synchronize this publishing struct with its mirror
1408 * on disk. Note that all internal FS-operations that change
1409 * publishing structs should already call "sync" internally,
1410 * so this function is likely not useful for clients.
1412 * @param pc the struct to sync
1415 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc)
1417 struct GNUNET_BIO_WriteHandle *wh;
1419 if (NULL == pc->serialization)
1420 pc->serialization = make_serialization_file_name (pc->h,
1421 GNUNET_FS_SYNC_PATH_MASTER_PUBLISH);
1422 if (NULL == pc->serialization)
1426 if (NULL == pc->fi->serialization)
1431 wh = get_write_handle (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH, pc->serialization);
1433 GNUNET_BIO_write_string (wh, pc->nid)) ||
1435 GNUNET_BIO_write_string (wh, pc->nuid)) ||
1437 GNUNET_BIO_write_int32 (wh, pc->options)) ||
1439 GNUNET_BIO_write_int32 (wh, pc->all_done)) ||
1441 GNUNET_BIO_write_string (wh, pc->fi->serialization)) ||
1443 GNUNET_BIO_write_string (wh, (pc->fi_pos == NULL) ? NULL : pc->fi_pos->serialization)) ||
1445 GNUNET_BIO_write_string (wh, (pc->namespace == NULL) ? NULL : pc->namespace->name)) )
1450 GNUNET_BIO_write_close (wh))
1458 (void) GNUNET_BIO_write_close (wh);
1459 GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH, pc->serialization);
1460 GNUNET_free (pc->serialization);
1461 pc->serialization = NULL;
1466 * Synchronize this unindex struct with its mirror
1467 * on disk. Note that all internal FS-operations that change
1468 * publishing structs should already call "sync" internally,
1469 * so this function is likely not useful for clients.
1471 * @param uc the struct to sync
1474 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc)
1476 struct GNUNET_BIO_WriteHandle *wh;
1478 if (UNINDEX_STATE_ABORTED == uc->state)
1480 if (NULL == uc->serialization)
1481 uc->serialization = make_serialization_file_name (uc->h,
1482 GNUNET_FS_SYNC_PATH_MASTER_UNINDEX);
1483 if (NULL == uc->serialization)
1485 wh = get_write_handle (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX, uc->serialization);
1487 GNUNET_BIO_write_string (wh, uc->filename)) ||
1489 GNUNET_BIO_write_int64 (wh, uc->file_size)) ||
1491 write_start_time (wh, uc->start_time)) ||
1493 GNUNET_BIO_write_int32 (wh, (uint32_t) uc->state)) ||
1494 ( (uc->state == UNINDEX_STATE_FS_NOTIFY) &&
1496 GNUNET_BIO_write (wh, &uc->file_id, sizeof (GNUNET_HashCode))) ) ||
1497 ( (uc->state == UNINDEX_STATE_ERROR) &&
1499 GNUNET_BIO_write_string (wh, uc->emsg)) ) )
1502 GNUNET_BIO_write_close (wh))
1510 (void) GNUNET_BIO_write_close (wh);
1511 GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX, uc->serialization);
1512 GNUNET_free (uc->serialization);
1513 uc->serialization = NULL;
1518 * Serialize an active or pending download request.
1520 * @param cls the 'struct GNUNET_BIO_WriteHandle*'
1521 * @param key unused, can be NULL
1522 * @param value the 'struct DownloadRequest'
1523 * @return GNUNET_YES on success, GNUNET_NO on error
1526 write_download_request (void *cls,
1527 const GNUNET_HashCode *key,
1530 struct GNUNET_BIO_WriteHandle *wh = cls;
1531 struct DownloadRequest *dr = value;
1534 GNUNET_BIO_write (wh, &dr->chk, sizeof (struct ContentHashKey))) ||
1536 GNUNET_BIO_write_int64 (wh, dr->offset)) ||
1538 GNUNET_BIO_write_int32 (wh, dr->depth)) )
1545 * Count active download requests.
1547 * @param cls the 'uint32_t*' counter
1548 * @param key unused, can be NULL
1549 * @param value the 'struct DownloadRequest'
1550 * @return GNUNET_YES (continue iteration)
1553 count_download_requests (void *cls,
1554 const GNUNET_HashCode *key,
1557 uint32_t *counter = cls;
1565 * Compute the name of the sync file (or directory) for the given download
1568 * @param dc download context to compute for
1569 * @param uni unique filename to use, use "" for the directory name
1570 * @return the expanded file name, NULL for none
1573 get_download_sync_filename (struct GNUNET_FS_DownloadContext *dc,
1579 if (dc->parent == NULL)
1580 return get_serialization_file_name (dc->h,
1581 (dc->search != NULL) ?
1582 GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD :
1583 GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
1585 if (dc->parent->serialization == NULL)
1587 par = get_download_sync_filename (dc->parent, dc->parent->serialization);
1590 GNUNET_asprintf (&epar,
1601 * Synchronize this download struct with its mirror
1602 * on disk. Note that all internal FS-operations that change
1603 * publishing structs should already call "sync" internally,
1604 * so this function is likely not useful for clients.
1606 * @param dc the struct to sync
1609 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc)
1611 struct GNUNET_BIO_WriteHandle *wh;
1615 uint32_t num_pending;
1617 if (NULL == dc->serialization)
1619 dir = get_download_sync_filename (dc, "");
1623 GNUNET_DISK_directory_create_for_file (dir))
1628 fn = GNUNET_DISK_mktemp (dir);
1630 dc->serialization = get_serialization_short_name (fn);
1634 fn = get_download_sync_filename (dc, dc->serialization);
1636 wh = GNUNET_BIO_write_open (fn);
1639 GNUNET_free (dc->serialization);
1640 dc->serialization = NULL;
1644 GNUNET_assert ( (GNUNET_YES == GNUNET_FS_uri_test_chk (dc->uri)) ||
1645 (GNUNET_YES == GNUNET_FS_uri_test_loc (dc->uri)) );
1646 uris = GNUNET_FS_uri_to_string (dc->uri);
1648 if (dc->emsg != NULL)
1649 (void) GNUNET_CONTAINER_multihashmap_iterate (dc->active,
1650 &count_download_requests,
1652 GNUNET_assert ( (dc->length == dc->completed) ||
1653 (dc->emsg != NULL) ||
1654 (num_pending > 0) );
1656 GNUNET_BIO_write_string (wh, uris)) ||
1658 GNUNET_BIO_write_meta_data (wh, dc->meta)) ||
1660 GNUNET_BIO_write_string (wh, dc->emsg)) ||
1662 GNUNET_BIO_write_string (wh, dc->filename)) ||
1664 GNUNET_BIO_write_string (wh, dc->temp_filename)) ||
1666 GNUNET_BIO_write_int64 (wh, dc->old_file_size)) ||
1668 GNUNET_BIO_write_int64 (wh, dc->offset)) ||
1670 GNUNET_BIO_write_int64 (wh, dc->length)) ||
1672 GNUNET_BIO_write_int64 (wh, dc->completed)) ||
1674 write_start_time (wh, dc->start_time)) ||
1676 GNUNET_BIO_write_int32 (wh, dc->anonymity)) ||
1678 GNUNET_BIO_write_int32 (wh, (uint32_t) dc->options)) ||
1680 GNUNET_BIO_write_int32 (wh, (uint32_t) dc->has_finished)) ||
1682 GNUNET_BIO_write_int32 (wh, num_pending)) )
1684 if (GNUNET_SYSERR ==
1685 GNUNET_CONTAINER_multihashmap_iterate (dc->active,
1686 &write_download_request,
1689 GNUNET_free_non_null (uris);
1691 GNUNET_BIO_write_close (wh))
1700 (void) GNUNET_BIO_write_close (wh);
1701 GNUNET_free_non_null (uris);
1702 if (0 != UNLINK (fn))
1703 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1705 GNUNET_free (dc->serialization);
1706 dc->serialization = NULL;
1711 * Synchronize this search result with its mirror
1712 * on disk. Note that all internal FS-operations that change
1713 * publishing structs should already call "sync" internally,
1714 * so this function is likely not useful for clients.
1716 * @param sr the struct to sync
1719 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr)
1721 struct GNUNET_BIO_WriteHandle *wh;
1725 if (NULL == sr->serialization)
1726 sr->serialization = make_serialization_file_name_in_dir (sr->sc->h,
1727 (sr->sc->psearch_result == NULL)
1728 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
1729 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1730 sr->sc->serialization);
1731 if (NULL == sr->serialization)
1733 wh = get_write_handle_in_dir (sr->sc->h,
1734 (sr->sc->psearch_result == NULL)
1735 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
1736 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1737 sr->sc->serialization,
1739 uris = GNUNET_FS_uri_to_string (sr->uri);
1741 GNUNET_BIO_write_string (wh, uris)) ||
1743 GNUNET_BIO_write_string (wh, sr->download != NULL ? sr->download->serialization : NULL)) ||
1745 GNUNET_BIO_write_string (wh, sr->update_search != NULL ? sr->update_search->serialization : NULL)) ||
1747 GNUNET_BIO_write_meta_data (wh, sr->meta)) ||
1749 GNUNET_BIO_write (wh, &sr->key, sizeof (GNUNET_HashCode))) ||
1751 GNUNET_BIO_write_int32 (wh, sr->mandatory_missing)) ||
1753 GNUNET_BIO_write_int32 (wh, sr->optional_support)) ||
1755 GNUNET_BIO_write_int32 (wh, sr->availability_success)) ||
1757 GNUNET_BIO_write_int32 (wh, sr->availability_trials)) )
1760 GNUNET_BIO_write_close (wh))
1765 GNUNET_free_non_null (uris);
1768 GNUNET_free_non_null (uris);
1770 (void) GNUNET_BIO_write_close (wh);
1771 remove_sync_file_in_dir (sr->sc->h,
1772 (sr->sc->psearch_result == NULL)
1773 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
1774 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1775 sr->sc->serialization,
1777 GNUNET_free (sr->serialization);
1778 sr->serialization = NULL;
1783 * Synchronize this search struct with its mirror
1784 * on disk. Note that all internal FS-operations that change
1785 * publishing structs should already call "sync" internally,
1786 * so this function is likely not useful for clients.
1788 * @param sc the struct to sync
1791 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc)
1793 struct GNUNET_BIO_WriteHandle *wh;
1796 const char *category;
1798 category = (sc->psearch_result == NULL)
1799 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
1800 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH;
1801 if (NULL == sc->serialization)
1802 sc->serialization = make_serialization_file_name (sc->h,
1804 if (NULL == sc->serialization)
1806 wh = get_write_handle (sc->h, category, sc->serialization);
1807 GNUNET_assert ( (GNUNET_YES == GNUNET_FS_uri_test_ksk (sc->uri)) ||
1808 (GNUNET_YES == GNUNET_FS_uri_test_sks (sc->uri)) );
1809 uris = GNUNET_FS_uri_to_string (sc->uri);
1810 in_pause = (sc->task != GNUNET_SCHEDULER_NO_TASK) ? 'r' : '\0';
1812 GNUNET_BIO_write_string (wh, uris)) ||
1814 write_start_time (wh, sc->start_time)) ||
1816 GNUNET_BIO_write_string (wh, sc->emsg)) ||
1818 GNUNET_BIO_write_int32 (wh, (uint32_t) sc->options)) ||
1820 GNUNET_BIO_write (wh, &in_pause, sizeof (in_pause))) ||
1822 GNUNET_BIO_write_int32 (wh, sc->anonymity)) )
1827 GNUNET_BIO_write_close (wh))
1835 (void) GNUNET_BIO_write_close (wh);
1836 GNUNET_free_non_null (uris);
1837 GNUNET_FS_remove_sync_file_ (sc->h, category, sc->serialization);
1838 GNUNET_free (sc->serialization);
1839 sc->serialization = NULL;
1844 * Function called with a filename of serialized unindexing operation
1847 * @param cls the 'struct GNUNET_FS_Handle*'
1848 * @param filename complete filename (absolute path)
1849 * @return GNUNET_OK (continue to iterate)
1852 deserialize_unindex_file (void *cls,
1853 const char *filename)
1855 struct GNUNET_FS_Handle *h = cls;
1856 struct GNUNET_BIO_ReadHandle *rh;
1857 struct GNUNET_FS_UnindexContext *uc;
1858 struct GNUNET_FS_ProgressInfo pi;
1862 uc = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
1864 uc->serialization = get_serialization_short_name (filename);
1865 rh = GNUNET_BIO_read_open (filename);
1869 GNUNET_BIO_read_string (rh, "unindex-fn", &uc->filename, 10*1024)) ||
1871 GNUNET_BIO_read_int64 (rh, &uc->file_size)) ||
1873 read_start_time (rh, &uc->start_time)) ||
1875 GNUNET_BIO_read_int32 (rh, &state)) )
1877 uc->state = (enum UnindexState) state;
1880 case UNINDEX_STATE_HASHING:
1882 case UNINDEX_STATE_FS_NOTIFY:
1884 GNUNET_BIO_read (rh, "unindex-hash", &uc->file_id, sizeof (GNUNET_HashCode)))
1887 case UNINDEX_STATE_DS_REMOVE:
1889 case UNINDEX_STATE_COMPLETE:
1891 case UNINDEX_STATE_ERROR:
1893 GNUNET_BIO_read_string (rh, "unindex-emsg", &uc->emsg, 10*1024))
1896 case UNINDEX_STATE_ABORTED:
1903 pi.status = GNUNET_FS_STATUS_UNINDEX_RESUME;
1904 pi.value.unindex.specifics.resume.message = uc->emsg;
1905 GNUNET_FS_unindex_make_status_ (&pi,
1907 (uc->state == UNINDEX_STATE_COMPLETE)
1912 case UNINDEX_STATE_HASHING:
1913 GNUNET_CRYPTO_hash_file (uc->h->sched,
1914 GNUNET_SCHEDULER_PRIORITY_IDLE,
1917 &GNUNET_FS_unindex_process_hash_,
1920 case UNINDEX_STATE_FS_NOTIFY:
1921 uc->state = UNINDEX_STATE_HASHING;
1922 GNUNET_FS_unindex_process_hash_ (uc,
1925 case UNINDEX_STATE_DS_REMOVE:
1926 GNUNET_FS_unindex_do_remove_ (uc);
1928 case UNINDEX_STATE_COMPLETE:
1929 case UNINDEX_STATE_ERROR:
1930 /* no need to resume any operation, we were done */
1936 GNUNET_BIO_read_close (rh, &emsg))
1938 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1939 _("Failure while resuming unindexing operation `%s': %s\n"),
1946 GNUNET_free_non_null (uc->filename);
1947 if ( (rh != NULL) &&
1949 GNUNET_BIO_read_close (rh, &emsg)) )
1951 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1952 _("Failed to resume unindexing operation `%s': %s\n"),
1957 if (uc->serialization != NULL)
1958 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX, uc->serialization);
1959 GNUNET_free_non_null (uc->serialization);
1966 * Deserialize a download.
1968 * @param h overall context
1969 * @param rh file to deserialize from
1970 * @param parent parent download
1971 * @param search associated search
1972 * @param serialization name under which the search was serialized
1975 deserialize_download (struct GNUNET_FS_Handle *h,
1976 struct GNUNET_BIO_ReadHandle *rh,
1977 struct GNUNET_FS_DownloadContext *parent,
1978 struct GNUNET_FS_SearchResult *search,
1979 const char *serialization);
1983 * Deserialize a search.
1985 * @param h overall context
1986 * @param rh file to deserialize from
1987 * @param psearch_result parent search result
1988 * @param serialization name under which the search was serialized
1990 static struct GNUNET_FS_SearchContext *
1991 deserialize_search (struct GNUNET_FS_Handle *h,
1992 struct GNUNET_BIO_ReadHandle *rh,
1993 struct GNUNET_FS_SearchResult *psearch_result,
1994 const char *serialization);
1998 * Function called with a filename of serialized search result
2001 * @param cls the 'struct GNUNET_FS_SearchContext*'
2002 * @param filename complete filename (absolute path)
2003 * @return GNUNET_OK (continue to iterate)
2006 deserialize_search_result (void *cls,
2007 const char *filename)
2009 struct GNUNET_FS_SearchContext *sc = cls;
2015 struct GNUNET_BIO_ReadHandle *rh;
2016 struct GNUNET_BIO_ReadHandle *drh;
2017 struct GNUNET_FS_SearchResult *sr;
2019 ser = get_serialization_short_name (filename);
2020 rh = GNUNET_BIO_read_open (filename);
2025 remove_sync_file_in_dir (sc->h,
2026 (sc->psearch_result == NULL)
2027 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2028 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2038 sr = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchResult));
2039 sr->serialization = ser;
2041 GNUNET_BIO_read_string (rh, "result-uri", &uris, 10*1024)) ||
2042 (NULL == (sr->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2044 GNUNET_BIO_read_string (rh, "download-lnk", &download, 16)) ||
2046 GNUNET_BIO_read_string (rh, "search-lnk", &update_srch, 16)) ||
2048 GNUNET_BIO_read_meta_data (rh, "result-meta", &sr->meta)) ||
2050 GNUNET_BIO_read (rh, "result-key", &sr->key, sizeof (GNUNET_HashCode))) ||
2052 GNUNET_BIO_read_int32 (rh, &sr->mandatory_missing)) ||
2054 GNUNET_BIO_read_int32 (rh, &sr->optional_support)) ||
2056 GNUNET_BIO_read_int32 (rh, &sr->availability_success)) ||
2058 GNUNET_BIO_read_int32 (rh, &sr->availability_trials)) )
2061 if (download != NULL)
2063 drh = get_read_handle (sc->h,
2064 GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD,
2066 deserialize_download (sc->h,
2072 GNUNET_BIO_read_close (drh, &emsg))
2074 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2075 _("Failed to resume sub-download `%s': %s\n"),
2080 GNUNET_free (download);
2082 if (update_srch != NULL)
2084 drh = get_read_handle (sc->h,
2085 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2087 deserialize_search (sc->h,
2092 GNUNET_BIO_read_close (drh, &emsg))
2094 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2095 _("Failed to resume sub-search `%s': %s\n"),
2100 GNUNET_free (update_srch);
2102 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map,
2105 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2108 GNUNET_free_non_null (download);
2109 GNUNET_free_non_null (emsg);
2110 GNUNET_free_non_null (uris);
2111 if (sr->uri != NULL)
2112 GNUNET_FS_uri_destroy (sr->uri);
2113 if (sr->meta != NULL)
2114 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2115 GNUNET_free (sr->serialization);
2122 * Send the 'resume' signal to the callback; also actually
2123 * resume the download (put it in the queue). Does this
2124 * recursively for the top-level download and all child
2127 * @param dc download to resume
2130 signal_download_resume (struct GNUNET_FS_DownloadContext *dc)
2132 struct GNUNET_FS_DownloadContext *dcc;
2133 struct GNUNET_FS_ProgressInfo pi;
2135 pi.status = GNUNET_FS_STATUS_DOWNLOAD_RESUME;
2136 pi.value.download.specifics.resume.meta = dc->meta;
2137 pi.value.download.specifics.resume.message = dc->emsg;
2138 GNUNET_FS_download_make_status_ (&pi,
2140 dcc = dc->child_head;
2143 signal_download_resume (dcc);
2146 if (dc->pending != NULL)
2147 GNUNET_FS_download_start_downloading_ (dc);
2152 * Signal resuming of a search to our clients (for the
2153 * top level search and all sub-searches).
2155 * @param sc search being resumed
2158 signal_search_resume (struct GNUNET_FS_SearchContext *sc);
2162 * Iterator over search results signaling resume to the client for
2165 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2166 * @param key current key code
2167 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2168 * @return GNUNET_YES (we should continue to iterate)
2171 signal_result_resume (void *cls,
2172 const GNUNET_HashCode * key,
2175 struct GNUNET_FS_SearchContext *sc = cls;
2176 struct GNUNET_FS_ProgressInfo pi;
2177 struct GNUNET_FS_SearchResult *sr = value;
2179 if (0 == sr->mandatory_missing)
2181 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME_RESULT;
2182 pi.value.search.specifics.resume_result.meta = sr->meta;
2183 pi.value.search.specifics.resume_result.uri = sr->uri;
2184 pi.value.search.specifics.resume_result.result = sr;
2185 pi.value.search.specifics.resume_result.availability_rank = 2*sr->availability_success - sr->availability_trials;
2186 pi.value.search.specifics.resume_result.availability_certainty = sr->availability_trials;
2187 pi.value.search.specifics.resume_result.applicability_rank = sr->optional_support;
2188 sr->client_info = GNUNET_FS_search_make_status_ (&pi,
2191 if (sr->download != NULL)
2193 signal_download_resume (sr->download);
2197 GNUNET_FS_search_start_probe_ (sr);
2199 if (sr->update_search != NULL)
2200 signal_search_resume (sr->update_search);
2206 * Free memory allocated by the search context and its children
2208 * @param sc search context to free
2211 free_search_context (struct GNUNET_FS_SearchContext *sc);
2215 * Iterator over search results freeing each.
2217 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2218 * @param key current key code
2219 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2220 * @return GNUNET_YES (we should continue to iterate)
2223 free_result (void *cls,
2224 const GNUNET_HashCode * key,
2227 struct GNUNET_FS_SearchResult *sr = value;
2229 if (sr->update_search != NULL)
2231 free_search_context (sr->update_search);
2232 GNUNET_assert (NULL == sr->update_search);
2234 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2235 GNUNET_FS_uri_destroy (sr->uri);
2242 * Free memory allocated by the search context and its children
2244 * @param sc search context to free
2247 free_search_context (struct GNUNET_FS_SearchContext *sc)
2249 if (sc->serialization != NULL)
2251 GNUNET_FS_remove_sync_file_ (sc->h,
2252 (sc->psearch_result == NULL)
2253 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2254 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2256 GNUNET_FS_remove_sync_dir_ (sc->h,
2257 (sc->psearch_result == NULL)
2258 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2259 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2262 GNUNET_free_non_null (sc->serialization);
2263 GNUNET_free_non_null (sc->emsg);
2264 if (sc->uri != NULL)
2265 GNUNET_FS_uri_destroy (sc->uri);
2266 if (sc->master_result_map != NULL)
2268 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2271 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
2278 * Function called with a filename of serialized sub-download
2281 * @param cls the 'struct GNUNET_FS_DownloadContext*' (parent)
2282 * @param filename complete filename (absolute path)
2283 * @return GNUNET_OK (continue to iterate)
2286 deserialize_subdownload (void *cls,
2287 const char *filename)
2289 struct GNUNET_FS_DownloadContext *parent = cls;
2292 struct GNUNET_BIO_ReadHandle *rh;
2294 ser = get_serialization_short_name (filename);
2295 rh = GNUNET_BIO_read_open (filename);
2296 deserialize_download (parent->h,
2302 GNUNET_BIO_read_close (rh, &emsg))
2304 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2305 _("Failed to resume sub-download `%s': %s\n"),
2316 * Free this download context and all of its descendants.
2317 * (only works during deserialization since not all possible
2318 * state it taken care of).
2320 * @param dc context to free
2323 free_download_context (struct GNUNET_FS_DownloadContext *dc)
2325 struct GNUNET_FS_DownloadContext *dcc;
2326 struct DownloadRequest *dr;
2327 if (dc->meta != NULL)
2328 GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2329 if (dc->uri != NULL)
2330 GNUNET_FS_uri_destroy (dc->uri);
2331 GNUNET_free_non_null (dc->temp_filename);
2332 GNUNET_free_non_null (dc->emsg);
2333 GNUNET_free_non_null (dc->filename);
2334 while (NULL != (dcc = dc->child_head))
2336 GNUNET_CONTAINER_DLL_remove (dc->child_head,
2339 free_download_context (dcc);
2341 while (NULL != (dr = dc->pending))
2343 dc->pending = dr->next;
2351 * Deserialize a download.
2353 * @param h overall context
2354 * @param rh file to deserialize from
2355 * @param parent parent download
2356 * @param search associated search
2357 * @param serialization name under which the search was serialized
2360 deserialize_download (struct GNUNET_FS_Handle *h,
2361 struct GNUNET_BIO_ReadHandle *rh,
2362 struct GNUNET_FS_DownloadContext *parent,
2363 struct GNUNET_FS_SearchResult *search,
2364 const char *serialization)
2366 struct GNUNET_FS_DownloadContext *dc;
2367 struct DownloadRequest *dr;
2373 uint32_t num_pending;
2378 dc = GNUNET_malloc (sizeof (struct GNUNET_FS_DownloadContext));
2379 dc->parent = parent;
2381 dc->serialization = GNUNET_strdup (serialization);
2383 GNUNET_BIO_read_string (rh, "download-uri", &uris, 10*1024)) ||
2384 (NULL == (dc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2385 ( (GNUNET_YES != GNUNET_FS_uri_test_chk (dc->uri)) &&
2386 (GNUNET_YES != GNUNET_FS_uri_test_loc (dc->uri)) ) ||
2388 GNUNET_BIO_read_meta_data (rh, "download-meta", &dc->meta)) ||
2390 GNUNET_BIO_read_string (rh, "download-emsg", &dc->emsg, 10*1024)) ||
2392 GNUNET_BIO_read_string (rh, "download-fn", &dc->filename, 10*1024)) ||
2394 GNUNET_BIO_read_string (rh, "download-tfn", &dc->temp_filename, 10*1024)) ||
2396 GNUNET_BIO_read_int64 (rh, &dc->old_file_size)) ||
2398 GNUNET_BIO_read_int64 (rh, &dc->offset)) ||
2400 GNUNET_BIO_read_int64 (rh, &dc->length)) ||
2402 GNUNET_BIO_read_int64 (rh, &dc->completed)) ||
2404 read_start_time (rh, &dc->start_time)) ||
2406 GNUNET_BIO_read_int32 (rh, &dc->anonymity)) ||
2408 GNUNET_BIO_read_int32 (rh, &options)) ||
2410 GNUNET_BIO_read_int32 (rh, &status)) ||
2412 GNUNET_BIO_read_int32 (rh, &num_pending)) )
2414 dc->options = (enum GNUNET_FS_DownloadOptions) options;
2415 dc->active = GNUNET_CONTAINER_multihashmap_create (16);
2416 dc->has_finished = (int) status;
2417 dc->treedepth = GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size (dc->uri));
2418 if (GNUNET_FS_uri_test_loc (dc->uri))
2419 GNUNET_assert (GNUNET_OK ==
2420 GNUNET_FS_uri_loc_get_peer_identity (dc->uri,
2422 if ( (dc->length > dc->completed) &&
2423 (num_pending == 0) )
2425 while (0 < num_pending--)
2427 dr = GNUNET_malloc (sizeof (struct DownloadRequest));
2429 GNUNET_BIO_read (rh, "chk", &dr->chk, sizeof (struct ContentHashKey))) ||
2431 GNUNET_BIO_read_int64 (rh, &dr->offset)) ||
2433 GNUNET_BIO_read_int32 (rh, &dr->depth)) )
2435 dr->is_pending = GNUNET_YES;
2436 dr->next = dc->pending;
2440 dn = get_download_sync_filename (dc, "");
2444 GNUNET_DISK_directory_test (dn))
2445 GNUNET_DISK_directory_scan (dn, &deserialize_subdownload, dc);
2449 GNUNET_CONTAINER_DLL_insert (parent->child_head,
2454 dc->search = search;
2455 search->download = dc;
2457 signal_download_resume (dc);
2461 GNUNET_free_non_null (uris);
2462 GNUNET_free_non_null (dr);
2463 GNUNET_free_non_null (emsg);
2464 free_download_context (dc);
2469 * Signal resuming of a search to our clients (for the
2470 * top level search and all sub-searches).
2472 * @param sc search being resumed
2475 signal_search_resume (struct GNUNET_FS_SearchContext *sc)
2477 struct GNUNET_FS_ProgressInfo pi;
2479 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME;
2480 pi.value.search.specifics.resume.message = sc->emsg;
2481 pi.value.search.specifics.resume.is_paused = (sc->client == NULL) ? GNUNET_YES : GNUNET_NO;
2482 sc->client_info = GNUNET_FS_search_make_status_ (&pi,
2484 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2485 &signal_result_resume,
2492 * Deserialize a search.
2494 * @param h overall context
2495 * @param rh file to deserialize from
2496 * @param psearch_result parent search result
2497 * @param serialization name under which the search was serialized
2499 static struct GNUNET_FS_SearchContext *
2500 deserialize_search (struct GNUNET_FS_Handle *h,
2501 struct GNUNET_BIO_ReadHandle *rh,
2502 struct GNUNET_FS_SearchResult *psearch_result,
2503 const char *serialization)
2505 struct GNUNET_FS_SearchContext *sc;
2512 if ( (psearch_result != NULL) &&
2513 (psearch_result->update_search != NULL) )
2520 sc = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchContext));
2521 if (psearch_result != NULL)
2523 sc->psearch_result = psearch_result;
2524 psearch_result->update_search = sc;
2527 sc->serialization = GNUNET_strdup (serialization);
2529 GNUNET_BIO_read_string (rh, "search-uri", &uris, 10*1024)) ||
2530 (NULL == (sc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2531 ( (GNUNET_YES != GNUNET_FS_uri_test_ksk (sc->uri)) &&
2532 (GNUNET_YES != GNUNET_FS_uri_test_sks (sc->uri)) ) ||
2534 read_start_time (rh, &sc->start_time)) ||
2536 GNUNET_BIO_read_string (rh, "search-emsg", &sc->emsg, 10*1024)) ||
2538 GNUNET_BIO_read_int32 (rh, &options)) ||
2540 GNUNET_BIO_read (rh, "search-pause", &in_pause, sizeof (in_pause))) ||
2542 GNUNET_BIO_read_int32 (rh, &sc->anonymity)) )
2544 sc->options = (enum GNUNET_FS_SearchOptions) options;
2545 sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16);
2546 dn = get_serialization_file_name_in_dir (h,
2547 (sc->psearch_result == NULL)
2548 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2549 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2555 GNUNET_DISK_directory_test (dn))
2556 GNUNET_DISK_directory_scan (dn, &deserialize_search_result, sc);
2559 if ( ('\0' == in_pause) &&
2561 GNUNET_FS_search_start_searching_ (sc)) )
2563 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2564 _("Could not resume running search, will resume as paused search\n"));
2566 signal_search_resume (sc);
2570 GNUNET_free_non_null (emsg);
2571 free_search_context (sc);
2572 GNUNET_free_non_null (uris);
2578 * Function called with a filename of serialized search operation
2581 * @param cls the 'struct GNUNET_FS_Handle*'
2582 * @param filename complete filename (absolute path)
2583 * @return GNUNET_OK (continue to iterate)
2586 deserialize_search_file (void *cls,
2587 const char *filename)
2589 struct GNUNET_FS_Handle *h = cls;
2592 struct GNUNET_BIO_ReadHandle *rh;
2594 ser = get_serialization_short_name (filename);
2595 rh = GNUNET_BIO_read_open (filename);
2600 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_SEARCH, ser);
2605 (void) deserialize_search (h, rh, NULL, ser);
2608 GNUNET_BIO_read_close (rh, &emsg))
2610 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2611 _("Failure while resuming search operation `%s': %s\n"),
2621 * Function called with a filename of serialized download operation
2624 * @param cls the 'struct GNUNET_FS_Handle*'
2625 * @param filename complete filename (absolute path)
2626 * @return GNUNET_OK (continue to iterate)
2629 deserialize_download_file (void *cls,
2630 const char *filename)
2632 struct GNUNET_FS_Handle *h = cls;
2635 struct GNUNET_BIO_ReadHandle *rh;
2637 ser = get_serialization_short_name (filename);
2638 rh = GNUNET_BIO_read_open (filename);
2641 if (filename != NULL)
2643 if (0 != UNLINK (filename))
2644 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
2651 deserialize_download (h, rh, NULL, NULL, ser);
2654 GNUNET_BIO_read_close (rh, &emsg))
2656 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2657 _("Failure while resuming download operation `%s': %s\n"),
2667 * Deserialize informatin about pending operations.
2669 * @param master_path which master directory should be scanned
2670 * @param proc function to call for each entry (will get 'h' for 'cls')
2671 * @param h the 'struct GNUNET_FS_Handle*'
2674 deserialization_master (const char *master_path,
2675 GNUNET_FileNameCallback proc,
2676 struct GNUNET_FS_Handle *h)
2680 dn = get_serialization_file_name (h, master_path, "");
2684 GNUNET_DISK_directory_test (dn))
2685 GNUNET_DISK_directory_scan (dn, proc, h);
2691 * Setup a connection to the file-sharing service.
2693 * @param sched scheduler to use
2694 * @param cfg configuration to use
2695 * @param client_name unique identifier for this client
2696 * @param upcb function to call to notify about FS actions
2697 * @param upcb_cls closure for upcb
2698 * @param flags specific attributes for fs-operations
2699 * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
2700 * @return NULL on error
2702 struct GNUNET_FS_Handle *
2703 GNUNET_FS_start (struct GNUNET_SCHEDULER_Handle *sched,
2704 const struct GNUNET_CONFIGURATION_Handle *cfg,
2705 const char *client_name,
2706 GNUNET_FS_ProgressCallback upcb,
2708 enum GNUNET_FS_Flags flags,
2711 struct GNUNET_FS_Handle *ret;
2712 enum GNUNET_FS_OPTIONS opt;
2715 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Handle));
2718 ret->client_name = GNUNET_strdup (client_name);
2720 ret->upcb_cls = upcb_cls;
2722 ret->max_parallel_downloads = 1;
2723 ret->max_parallel_requests = 1;
2724 ret->avg_block_latency = GNUNET_TIME_UNIT_MINUTES; /* conservative starting point */
2725 va_start (ap, flags);
2726 while (GNUNET_FS_OPTIONS_END != (opt = va_arg (ap, enum GNUNET_FS_OPTIONS)))
2730 case GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM:
2731 ret->max_parallel_downloads = va_arg (ap, unsigned int);
2733 case GNUNET_FS_OPTIONS_REQUEST_PARALLELISM:
2734 ret->max_parallel_requests = va_arg (ap, unsigned int);
2738 GNUNET_free (ret->client_name);
2745 if (0 != (GNUNET_FS_FLAGS_PERSISTENCE & flags))
2747 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
2748 &deserialize_publish_file,
2750 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
2751 &deserialize_search_file,
2753 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
2754 &deserialize_download_file,
2756 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2757 &deserialize_unindex_file,
2765 * Close our connection with the file-sharing service.
2766 * The callback given to GNUNET_FS_start will no longer be
2767 * called after this function returns.
2769 * @param h handle that was returned from GNUNET_FS_start
2772 GNUNET_FS_stop (struct GNUNET_FS_Handle *h)
2774 while (h->top_head != NULL)
2775 h->top_head->ssf (h->top_head->ssf_cls);
2776 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
2777 GNUNET_SCHEDULER_cancel (h->sched,
2779 GNUNET_free (h->client_name);