2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
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"
34 * How many block requests can we have outstanding in parallel at a time by default?
36 #define DEFAULT_MAX_PARALLEL_REQUESTS (1024 * 10)
39 * How many downloads can we have outstanding in parallel at a time by default?
41 #define DEFAULT_MAX_PARALLEL_DOWNLOADS 16
44 * Start the given job (send signal, remove from pending queue, update
45 * counters and state).
47 * @param qe job to start
50 start_job (struct GNUNET_FS_QueueEntry *qe)
52 GNUNET_assert (NULL == qe->client);
53 qe->client = GNUNET_CLIENT_connect ("fs", qe->h->cfg);
54 if (qe->client == NULL)
59 qe->start (qe->cls, qe->client);
61 qe->h->active_blocks += qe->blocks;
62 qe->start_time = GNUNET_TIME_absolute_get ();
63 GNUNET_CONTAINER_DLL_remove (qe->h->pending_head, qe->h->pending_tail, qe);
64 GNUNET_CONTAINER_DLL_insert_after (qe->h->running_head, qe->h->running_tail,
65 qe->h->running_tail, qe);
70 * Stop the given job (send signal, remove from active queue, update
71 * counters and state).
73 * @param qe job to stop
76 stop_job (struct GNUNET_FS_QueueEntry *qe)
80 qe->h->active_downloads--;
81 qe->h->active_blocks -= qe->blocks;
83 GNUNET_TIME_relative_add (qe->run_time,
84 GNUNET_TIME_absolute_get_duration
86 GNUNET_CONTAINER_DLL_remove (qe->h->running_head, qe->h->running_tail, qe);
87 GNUNET_CONTAINER_DLL_insert_after (qe->h->pending_head, qe->h->pending_tail,
88 qe->h->pending_tail, qe);
93 * Process the jobs in the job queue, possibly starting some
94 * and stopping others.
96 * @param cls the 'struct GNUNET_FS_Handle'
97 * @param tc scheduler context
100 process_job_queue (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
102 struct GNUNET_FS_Handle *h = cls;
103 struct GNUNET_FS_QueueEntry *qe;
104 struct GNUNET_FS_QueueEntry *next;
105 struct GNUNET_TIME_Relative run_time;
106 struct GNUNET_TIME_Relative restart_at;
107 struct GNUNET_TIME_Relative rst;
108 struct GNUNET_TIME_Absolute end_time;
110 h->queue_job = GNUNET_SCHEDULER_NO_TASK;
111 restart_at = GNUNET_TIME_UNIT_FOREVER_REL;
112 /* first, see if we can start all the jobs */
113 next = h->pending_head;
114 while (NULL != (qe = next))
117 if (h->running_head == NULL)
122 if ((qe->blocks + h->active_blocks <= h->max_parallel_requests) &&
123 (h->active_downloads < h->max_parallel_downloads))
129 if (h->pending_head == NULL)
130 return; /* no need to stop anything */
131 /* then, check if we should stop some jobs */
132 next = h->running_head;
133 while (NULL != (qe = next))
137 GNUNET_TIME_relative_multiply (h->avg_block_latency,
138 qe->blocks * qe->start_times);
139 switch (qe->priority)
141 case GNUNET_FS_QUEUE_PRIORITY_PROBE:
142 /* run probes for at most 1s * number-of-restarts; note that
143 as the total runtime of a probe is limited to 2m, we don't
144 need to additionally limit the total time of a probe to
145 strictly limit its lifetime. */
146 run_time = GNUNET_TIME_relative_min (run_time,
147 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
148 1 + qe->start_times));
150 case GNUNET_FS_QUEUE_PRIORITY_NORMAL:
155 end_time = GNUNET_TIME_absolute_add (qe->start_time, run_time);
156 rst = GNUNET_TIME_absolute_get_remaining (end_time);
157 restart_at = GNUNET_TIME_relative_min (rst, restart_at);
158 if (rst.rel_value > 0)
162 /* finally, start some more tasks if we now have empty slots */
163 next = h->pending_head;
164 while (NULL != (qe = next))
167 if ((qe->blocks + h->active_blocks <= h->max_parallel_requests) &&
168 (h->active_downloads < h->max_parallel_downloads))
175 GNUNET_SCHEDULER_add_delayed (restart_at, &process_job_queue, h);
180 * Add a job to the queue.
182 * @param h handle to the overall FS state
183 * @param start function to call to begin the job
184 * @param stop function to call to pause the job, or on dequeue (if the job was running)
185 * @param cls closure for start and stop
186 * @param blocks number of blocks this jobs uses
187 * @param priority how important is this download
188 * @return queue handle
190 struct GNUNET_FS_QueueEntry *
191 GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h, GNUNET_FS_QueueStart start,
192 GNUNET_FS_QueueStop stop, void *cls, unsigned int blocks,
193 enum GNUNET_FS_QueuePriority priority)
195 struct GNUNET_FS_QueueEntry *qe;
197 qe = GNUNET_malloc (sizeof (struct GNUNET_FS_QueueEntry));
202 qe->queue_time = GNUNET_TIME_absolute_get ();
204 qe->priority = priority;
205 GNUNET_CONTAINER_DLL_insert_after (h->pending_head, h->pending_tail,
206 h->pending_tail, qe);
207 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
208 GNUNET_SCHEDULER_cancel (h->queue_job);
209 h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h);
215 * Dequeue a job from the queue.
216 * @param qh handle for the job
219 GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qh)
221 struct GNUNET_FS_Handle *h;
224 if (qh->client != NULL)
226 GNUNET_CONTAINER_DLL_remove (h->pending_head, h->pending_tail, qh);
228 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
229 GNUNET_SCHEDULER_cancel (h->queue_job);
230 h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h);
235 * Create a top-level activity entry.
237 * @param h global fs handle
238 * @param ssf suspend signal function to use
239 * @param ssf_cls closure for ssf
240 * @return fresh top-level activity handle
242 struct TopLevelActivity *
243 GNUNET_FS_make_top (struct GNUNET_FS_Handle *h, SuspendSignalFunction ssf,
246 struct TopLevelActivity *ret;
248 ret = GNUNET_malloc (sizeof (struct TopLevelActivity));
250 ret->ssf_cls = ssf_cls;
251 GNUNET_CONTAINER_DLL_insert (h->top_head, h->top_tail, ret);
257 * Destroy a top-level activity entry.
259 * @param h global fs handle
260 * @param top top level activity entry
263 GNUNET_FS_end_top (struct GNUNET_FS_Handle *h, struct TopLevelActivity *top)
265 GNUNET_CONTAINER_DLL_remove (h->top_head, h->top_tail, top);
272 * Closure for "data_reader_file".
277 * Name of the file to read.
282 * File descriptor, NULL if it has not yet been opened.
284 struct GNUNET_DISK_FileHandle *fd;
289 * Function that provides data by reading from a file.
291 * @param cls closure (points to the file information)
292 * @param offset offset to read from; it is possible
293 * that the caller might need to go backwards
294 * a bit at times; set to UINT64_MAX to tell
295 * the reader that we won't be reading for a while
296 * (used to close the file descriptor but NOT fully
297 * clean up the reader's state); in this case,
298 * a value of '0' for max should be ignored
299 * @param max maximum number of bytes that should be
300 * copied to buf; readers are not allowed
301 * to provide less data unless there is an error;
302 * a value of "0" will be used at the end to allow
303 * the reader to clean up its internal state
304 * @param buf where the reader should write the data
305 * @param emsg location for the reader to store an error message
306 * @return number of bytes written, usually "max", 0 on error
309 GNUNET_FS_data_reader_file_ (void *cls, uint64_t offset, size_t max, void *buf,
312 struct FileInfo *fi = cls;
315 if (UINT64_MAX == offset)
319 GNUNET_DISK_file_close (fi->fd);
327 GNUNET_DISK_file_close (fi->fd);
328 GNUNET_free (fi->filename);
335 GNUNET_DISK_file_open (fi->filename, GNUNET_DISK_OPEN_READ,
336 GNUNET_DISK_PERM_NONE);
339 GNUNET_asprintf (emsg, _("Could not open file `%s': %s"), fi->filename,
344 GNUNET_DISK_file_seek (fi->fd, offset, GNUNET_DISK_SEEK_SET);
345 ret = GNUNET_DISK_file_read (fi->fd, buf, max);
348 GNUNET_asprintf (emsg, _("Could not read file `%s': %s"), fi->filename,
354 GNUNET_asprintf (emsg, _("Short read reading from file `%s'!"),
363 * Create the closure for the 'GNUNET_FS_data_reader_file_' callback.
365 * @param filename file to read
366 * @return closure to use, NULL on error
369 GNUNET_FS_make_file_reader_context_ (const char *filename)
373 fi = GNUNET_malloc (sizeof (struct FileInfo));
374 fi->filename = GNUNET_STRINGS_filename_expand (filename);
375 if (fi->filename == NULL)
385 * Function that provides data by copying from a buffer.
387 * @param cls closure (points to the buffer)
388 * @param offset offset to read from; it is possible
389 * that the caller might need to go backwards
390 * a bit at times; set to UINT64_MAX to tell
391 * the reader that we won't be reading for a while
392 * (used to close the file descriptor but NOT fully
393 * clean up the reader's state); in this case,
394 * a value of '0' for max should be ignored
395 * @param max maximum number of bytes that should be
396 * copied to buf; readers are not allowed
397 * to provide less data unless there is an error;
398 * a value of "0" will be used at the end to allow
399 * the reader to clean up its internal state
400 * @param buf where the reader should write the data
401 * @param emsg location for the reader to store an error message
402 * @return number of bytes written, usually "max", 0 on error
405 GNUNET_FS_data_reader_copy_ (void *cls, uint64_t offset, size_t max, void *buf,
410 if (UINT64_MAX == offset)
414 GNUNET_free_non_null (data);
417 memcpy (buf, &data[offset], max);
423 * Return the full filename where we would store state information
424 * (for serialization/deserialization).
426 * @param h master context
427 * @param ext component of the path
428 * @param ent entity identifier (or emtpy string for the directory)
429 * @return NULL on error
432 get_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext,
438 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
439 return NULL; /* persistence not requested */
441 GNUNET_CONFIGURATION_get_value_filename (h->cfg, "fs", "STATE_DIR",
444 GNUNET_asprintf (&ret, "%s%s%s%s%s%s%s", basename, DIR_SEPARATOR_STR,
445 h->client_name, DIR_SEPARATOR_STR, ext, DIR_SEPARATOR_STR,
447 GNUNET_free (basename);
453 * Return the full filename where we would store state information
454 * (for serialization/deserialization) that is associated with a
457 * @param h master context
458 * @param ext component of the path
459 * @param uni name of the parent operation
460 * @param ent entity identifier (or emtpy string for the directory)
461 * @return NULL on error
464 get_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
465 const char *uni, const char *ent)
470 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
471 return NULL; /* persistence not requested */
473 GNUNET_CONFIGURATION_get_value_filename (h->cfg, "fs", "STATE_DIR",
476 GNUNET_asprintf (&ret, "%s%s%s%s%s%s%s.dir%s%s", basename, DIR_SEPARATOR_STR,
477 h->client_name, DIR_SEPARATOR_STR, ext, DIR_SEPARATOR_STR,
478 uni, DIR_SEPARATOR_STR, ent);
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, const char *ext, const char *ent)
496 struct GNUNET_BIO_ReadHandle *ret;
498 fn = get_serialization_file_name (h, ext, ent);
501 ret = GNUNET_BIO_read_open (fn);
508 * Return a write handle for serialization.
510 * @param h master context
511 * @param ext component of the path
512 * @param ent entity identifier (or emtpy string for the directory)
513 * @return NULL on error
515 static struct GNUNET_BIO_WriteHandle *
516 get_write_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
519 struct GNUNET_BIO_WriteHandle *ret;
521 fn = get_serialization_file_name (h, ext, ent);
524 ret = GNUNET_BIO_write_open (fn);
525 GNUNET_break (ret != NULL);
532 * Return a write handle for serialization.
534 * @param h master context
535 * @param ext component of the path
536 * @param uni name of parent
537 * @param ent entity identifier (or emtpy string for the directory)
538 * @return NULL on error
540 static struct GNUNET_BIO_WriteHandle *
541 get_write_handle_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
542 const char *uni, const char *ent)
545 struct GNUNET_BIO_WriteHandle *ret;
547 fn = get_serialization_file_name_in_dir (h, ext, uni, ent);
550 ret = GNUNET_BIO_write_open (fn);
557 * Remove serialization/deserialization file from disk.
559 * @param h master context
560 * @param ext component of the path
561 * @param ent entity identifier
564 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext,
569 if ((NULL == ent) || (0 == strlen (ent)))
574 filename = get_serialization_file_name (h, ext, ent);
575 if (filename != NULL)
577 if (0 != UNLINK (filename))
578 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
579 GNUNET_free (filename);
585 * Remove serialization/deserialization file from disk.
587 * @param h master context
588 * @param ext component of the path
589 * @param uni parent name
590 * @param ent entity identifier
593 remove_sync_file_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
594 const char *uni, const char *ent)
598 if ((NULL == ent) || (0 == strlen (ent)))
603 filename = get_serialization_file_name_in_dir (h, ext, uni, ent);
604 if (filename != NULL)
606 if (0 != UNLINK (filename))
607 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
608 GNUNET_free (filename);
614 * Remove serialization/deserialization directory from disk.
616 * @param h master context
617 * @param ext component of the path
618 * @param uni unique name of parent
621 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext,
628 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
631 if ((GNUNET_OK == GNUNET_DISK_directory_test (dn)) &&
632 (GNUNET_OK != GNUNET_DISK_directory_remove (dn)))
633 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "rmdir", dn);
639 * Serialize a 'start_time'. Since we use start-times to
640 * calculate the duration of some operation, we actually
641 * do not serialize the absolute time but the (relative)
642 * duration since the start time. When we then
643 * deserialize the start time, we take the current time and
644 * subtract that duration so that we get again an absolute
645 * time stamp that will result in correct performance
648 * @param wh handle for writing
649 * @param timestamp time to serialize
650 * @return GNUNET_OK on success
653 write_start_time (struct GNUNET_BIO_WriteHandle *wh,
654 struct GNUNET_TIME_Absolute timestamp)
656 struct GNUNET_TIME_Relative dur;
658 dur = GNUNET_TIME_absolute_get_duration (timestamp);
659 return GNUNET_BIO_write_int64 (wh, dur.rel_value);
664 * Serialize a 'start_time'. Since we use start-times to
665 * calculate the duration of some operation, we actually
666 * do not serialize the absolute time but the (relative)
667 * duration since the start time. When we then
668 * deserialize the start time, we take the current time and
669 * subtract that duration so that we get again an absolute
670 * time stamp that will result in correct performance
673 * @param rh handle for reading
674 * @param timestamp where to write the deserialized timestamp
675 * @return GNUNET_OK on success
678 read_start_time (struct GNUNET_BIO_ReadHandle *rh,
679 struct GNUNET_TIME_Absolute *timestamp)
681 struct GNUNET_TIME_Relative dur;
683 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dur.rel_value))
684 return GNUNET_SYSERR;
685 *timestamp = GNUNET_TIME_absolute_subtract (GNUNET_TIME_absolute_get (), dur);
691 * Using the given serialization filename, try to deserialize
692 * the file-information tree associated with it.
694 * @param h master context
695 * @param filename name of the file (without directory) with
697 * @return NULL on error
699 static struct GNUNET_FS_FileInformation *
700 deserialize_file_information (struct GNUNET_FS_Handle *h, const char *filename);
704 * Using the given serialization filename, try to deserialize
705 * the file-information tree associated with it.
707 * @param h master context
708 * @param fn name of the file (without directory) with
710 * @param rh handle for reading
711 * @return NULL on error
713 static struct GNUNET_FS_FileInformation *
714 deserialize_fi_node (struct GNUNET_FS_Handle *h, const char *fn,
715 struct GNUNET_BIO_ReadHandle *rh)
717 struct GNUNET_FS_FileInformation *ret;
718 struct GNUNET_FS_FileInformation *nxt;
725 if (GNUNET_OK != GNUNET_BIO_read (rh, "status flag", &b, sizeof (b)))
730 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_FileInformation));
735 if ((GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "metadata", &ret->meta)) ||
736 (GNUNET_OK != GNUNET_BIO_read_string (rh, "ksk-uri", &ksks, 32 * 1024)) ||
738 ( (NULL == (ret->keywords = GNUNET_FS_uri_parse (ksks, NULL))) ||
739 (GNUNET_YES != GNUNET_FS_uri_test_ksk (ret->keywords)) ) ) ||
740 (GNUNET_OK != GNUNET_BIO_read_string (rh, "chk-uri", &chks, 1024)) ||
742 ( (NULL == (ret->chk_uri = GNUNET_FS_uri_parse (chks, NULL))) ||
743 (GNUNET_YES != GNUNET_FS_uri_test_chk (ret->chk_uri))) ) ||
744 (GNUNET_OK != read_start_time (rh, &ret->start_time)) ||
745 (GNUNET_OK != GNUNET_BIO_read_string (rh, "emsg", &ret->emsg, 16 * 1024))
747 GNUNET_BIO_read_string (rh, "fn", &ret->filename, 16 * 1024)) ||
749 GNUNET_BIO_read_int64 (rh, &ret->bo.expiration_time.abs_value)) ||
750 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.anonymity_level)) ||
751 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.content_priority)) ||
752 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.replication_level)))
759 case 0: /* file-insert */
760 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
765 ret->is_directory = GNUNET_NO;
766 ret->data.file.do_index = GNUNET_NO;
767 ret->data.file.have_hash = GNUNET_NO;
768 ret->data.file.index_start_confirmed = GNUNET_NO;
769 if (GNUNET_NO == ret->is_published)
771 if (NULL == ret->filename)
773 ret->data.file.reader = &GNUNET_FS_data_reader_copy_;
774 ret->data.file.reader_cls =
775 GNUNET_malloc_large (ret->data.file.file_size);
776 if (ret->data.file.reader_cls == NULL)
779 GNUNET_BIO_read (rh, "file-data", ret->data.file.reader_cls,
780 ret->data.file.file_size))
788 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
789 ret->data.file.reader_cls =
790 GNUNET_FS_make_file_reader_context_ (ret->filename);
794 case 1: /* file-index, no hash */
795 if (NULL == ret->filename)
800 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
805 ret->is_directory = GNUNET_NO;
806 ret->data.file.do_index = GNUNET_YES;
807 ret->data.file.have_hash = GNUNET_NO;
808 ret->data.file.index_start_confirmed = GNUNET_NO;
809 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
810 ret->data.file.reader_cls =
811 GNUNET_FS_make_file_reader_context_ (ret->filename);
813 case 2: /* file-index-with-hash */
814 if (NULL == ret->filename)
819 if ((GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
821 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id,
822 sizeof (GNUNET_HashCode))))
827 ret->is_directory = GNUNET_NO;
828 ret->data.file.do_index = GNUNET_YES;
829 ret->data.file.have_hash = GNUNET_YES;
830 ret->data.file.index_start_confirmed = GNUNET_NO;
831 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
832 ret->data.file.reader_cls =
833 GNUNET_FS_make_file_reader_context_ (ret->filename);
835 case 3: /* file-index-with-hash-confirmed */
836 if (NULL == ret->filename)
841 if ((GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
843 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id,
844 sizeof (GNUNET_HashCode))))
849 ret->is_directory = GNUNET_NO;
850 ret->data.file.do_index = GNUNET_YES;
851 ret->data.file.have_hash = GNUNET_YES;
852 ret->data.file.index_start_confirmed = GNUNET_YES;
853 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
854 ret->data.file.reader_cls =
855 GNUNET_FS_make_file_reader_context_ (ret->filename);
857 case 4: /* directory */
858 ret->is_directory = GNUNET_YES;
859 if ((GNUNET_OK != 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)))
869 ret->data.dir.dir_size = (uint32_t) dsize;
870 if (filename != NULL)
872 ret->data.dir.entries = deserialize_file_information (h, filename);
873 GNUNET_free (filename);
875 nxt = ret->data.dir.entries;
887 ret->serialization = GNUNET_strdup (fn);
889 GNUNET_BIO_read_string (rh, "nxt-filename", &filename, 16 * 1024))
894 if (filename != NULL)
896 ret->next = deserialize_file_information (h, filename);
897 GNUNET_free (filename);
900 GNUNET_free_non_null (ksks);
901 GNUNET_free_non_null (chks);
904 GNUNET_free_non_null (ksks);
905 GNUNET_free_non_null (chks);
906 GNUNET_free_non_null (filename);
907 GNUNET_FS_file_information_destroy (ret, NULL, NULL);
913 * Using the given serialization filename, try to deserialize
914 * the file-information tree associated with it.
916 * @param h master context
917 * @param filename name of the file (without directory) with
919 * @return NULL on error
921 static struct GNUNET_FS_FileInformation *
922 deserialize_file_information (struct GNUNET_FS_Handle *h, const char *filename)
924 struct GNUNET_FS_FileInformation *ret;
925 struct GNUNET_BIO_ReadHandle *rh;
929 rh = get_read_handle (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
932 ret = deserialize_fi_node (h, filename, rh);
933 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
935 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
936 _("Failed to resume publishing information `%s': %s\n"),
942 fn = get_serialization_file_name (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
945 if (0 != UNLINK (fn))
946 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
955 * Given a serialization name (full absolute path), return the
956 * basename of the file (without the path), which must only
957 * consist of the 6 random characters.
959 * @param fullname name to extract the basename from
960 * @return copy of the basename, NULL on error
963 get_serialization_short_name (const char *fullname)
970 /* FIXME: we could do this faster since we know
971 * the length of 'end'... */
974 if (DIR_SEPARATOR == *nxt)
978 if ((end == NULL) || (strlen (end) == 0))
983 GNUNET_break (6 == strlen (end));
984 return GNUNET_strdup (end);
989 * Create a new random name for serialization. Also checks if persistence
990 * is enabled and returns NULL if not.
992 * @param h master context
993 * @param ext component of the path
994 * @return NULL on errror
997 make_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext)
1003 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1004 return NULL; /* persistence not requested */
1005 dn = get_serialization_file_name (h, ext, "");
1008 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1013 fn = GNUNET_DISK_mktemp (dn);
1016 return NULL; /* epic fail */
1017 ret = get_serialization_short_name (fn);
1024 * Create a new random name for serialization. Also checks if persistence
1025 * is enabled and returns NULL if not.
1027 * @param h master context
1028 * @param ext component of the path
1029 * @param uni name of parent
1030 * @return NULL on errror
1033 make_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h,
1034 const char *ext, const char *uni)
1040 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1041 return NULL; /* persistence not requested */
1042 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
1045 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1050 fn = GNUNET_DISK_mktemp (dn);
1053 return NULL; /* epic fail */
1054 ret = get_serialization_short_name (fn);
1061 * Copy all of the data from the reader to the write handle.
1063 * @param wh write handle
1064 * @param fi file with reader
1065 * @return GNUNET_OK on success
1068 copy_from_reader (struct GNUNET_BIO_WriteHandle *wh,
1069 struct GNUNET_FS_FileInformation *fi)
1071 char buf[32 * 1024];
1079 while (off < fi->data.file.file_size)
1081 left = GNUNET_MIN (sizeof (buf), fi->data.file.file_size - off);
1083 fi->data.file.reader (fi->data.file.reader_cls, off, left, buf, &emsg);
1087 return GNUNET_SYSERR;
1089 if (GNUNET_OK != GNUNET_BIO_write (wh, buf, ret))
1090 return GNUNET_SYSERR;
1098 * Create a temporary file on disk to store the current
1101 * @param fi file information to sync with disk
1104 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *fi)
1107 struct GNUNET_BIO_WriteHandle *wh;
1112 if (NULL == fi->serialization)
1114 make_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO);
1115 if (NULL == fi->serialization)
1117 wh = get_write_handle (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1121 GNUNET_free (fi->serialization);
1122 fi->serialization = NULL;
1125 if (GNUNET_YES == fi->is_directory)
1127 else if (GNUNET_YES == fi->data.file.index_start_confirmed)
1129 else if (GNUNET_YES == fi->data.file.have_hash)
1131 else if (GNUNET_YES == fi->data.file.do_index)
1135 if (fi->keywords != NULL)
1136 ksks = GNUNET_FS_uri_to_string (fi->keywords);
1139 if (fi->chk_uri != NULL)
1140 chks = GNUNET_FS_uri_to_string (fi->chk_uri);
1143 if ((GNUNET_OK != GNUNET_BIO_write (wh, &b, sizeof (b))) ||
1144 (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, fi->meta)) ||
1145 (GNUNET_OK != GNUNET_BIO_write_string (wh, ksks)) ||
1146 (GNUNET_OK != GNUNET_BIO_write_string (wh, chks)) ||
1147 (GNUNET_OK != write_start_time (wh, fi->start_time)) ||
1148 (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->emsg)) ||
1149 (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->filename)) ||
1151 GNUNET_BIO_write_int64 (wh, fi->bo.expiration_time.abs_value)) ||
1152 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.anonymity_level)) ||
1153 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.content_priority)) ||
1154 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.replication_level)))
1159 GNUNET_free_non_null (chks);
1161 GNUNET_free_non_null (ksks);
1166 case 0: /* file-insert */
1167 if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1172 if ((GNUNET_NO == fi->is_published) && (NULL == fi->filename))
1173 if (GNUNET_OK != copy_from_reader (wh, fi))
1179 case 1: /* file-index, no hash */
1180 if (NULL == fi->filename)
1185 if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1191 case 2: /* file-index-with-hash */
1192 case 3: /* file-index-with-hash-confirmed */
1193 if (NULL == fi->filename)
1198 if ((GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size)) ||
1200 GNUNET_BIO_write (wh, &fi->data.file.file_id,
1201 sizeof (GNUNET_HashCode))))
1207 case 4: /* directory */
1208 if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->data.dir.dir_size)) ||
1210 GNUNET_BIO_write (wh, fi->data.dir.dir_data,
1211 (uint32_t) fi->data.dir.dir_size)) ||
1213 GNUNET_BIO_write_string (wh,
1214 (fi->data.dir.entries ==
1215 NULL) ? NULL : fi->data.dir.
1216 entries->serialization)))
1227 GNUNET_BIO_write_string (wh,
1229 NULL) ? fi->next->serialization : NULL))
1234 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1243 (void) GNUNET_BIO_write_close (wh);
1244 GNUNET_free_non_null (chks);
1245 GNUNET_free_non_null (ksks);
1246 fn = get_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1250 if (0 != UNLINK (fn))
1251 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1254 GNUNET_free (fi->serialization);
1255 fi->serialization = NULL;
1261 * Find the entry in the file information struct where the
1262 * serialization filename matches the given name.
1264 * @param pos file information to search
1265 * @param srch filename to search for
1266 * @return NULL if srch was not found in this subtree
1268 static struct GNUNET_FS_FileInformation *
1269 find_file_position (struct GNUNET_FS_FileInformation *pos, const char *srch)
1271 struct GNUNET_FS_FileInformation *r;
1275 if (0 == strcmp (srch, pos->serialization))
1277 if (pos->is_directory == GNUNET_YES)
1279 r = find_file_position (pos->data.dir.entries, srch);
1290 * Signal the FS's progress function that we are resuming
1293 * @param cls closure (of type "struct GNUNET_FS_PublishContext*")
1294 * @param fi the entry in the publish-structure
1295 * @param length length of the file or directory
1296 * @param meta metadata for the file or directory (can be modified)
1297 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1298 * @param bo block options (can be modified)
1299 * @param do_index should we index?
1300 * @param client_info pointer to client context set upon creation (can be modified)
1301 * @return GNUNET_OK to continue (always)
1304 fip_signal_resume (void *cls, struct GNUNET_FS_FileInformation *fi,
1305 uint64_t length, struct GNUNET_CONTAINER_MetaData *meta,
1306 struct GNUNET_FS_Uri **uri,
1307 struct GNUNET_FS_BlockOptions *bo, int *do_index,
1310 struct GNUNET_FS_PublishContext *pc = cls;
1311 struct GNUNET_FS_ProgressInfo pi;
1313 if (GNUNET_YES == pc->skip_next_fi_callback)
1315 pc->skip_next_fi_callback = GNUNET_NO;
1318 pi.status = GNUNET_FS_STATUS_PUBLISH_RESUME;
1319 pi.value.publish.specifics.resume.message = pc->fi->emsg;
1320 pi.value.publish.specifics.resume.chk_uri = pc->fi->chk_uri;
1321 *client_info = GNUNET_FS_publish_make_status_ (&pi, pc, fi, 0);
1322 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (meta))
1324 /* process entries in directory */
1325 pc->skip_next_fi_callback = GNUNET_YES;
1326 GNUNET_FS_file_information_inspect (fi, &fip_signal_resume, pc);
1333 * Function called with a filename of serialized publishing operation
1336 * @param cls the 'struct GNUNET_FS_Handle*'
1337 * @param filename complete filename (absolute path)
1338 * @return GNUNET_OK (continue to iterate)
1341 deserialize_publish_file (void *cls, const char *filename)
1343 struct GNUNET_FS_Handle *h = cls;
1344 struct GNUNET_BIO_ReadHandle *rh;
1345 struct GNUNET_FS_PublishContext *pc;
1353 pc = GNUNET_malloc (sizeof (struct GNUNET_FS_PublishContext));
1355 pc->serialization = get_serialization_short_name (filename);
1359 rh = GNUNET_BIO_read_open (filename);
1365 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-nid", &pc->nid, 1024))
1367 GNUNET_BIO_read_string (rh, "publish-nuid", &pc->nuid, 1024)) ||
1368 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
1369 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &all_done)) ||
1371 GNUNET_BIO_read_string (rh, "publish-firoot", &fi_root, 128)) ||
1372 (GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-fipos", &fi_pos, 128))
1373 || (GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-ns", &ns, 1024)))
1378 pc->options = options;
1379 pc->all_done = all_done;
1380 if (NULL == fi_root)
1385 pc->fi = deserialize_file_information (h, fi_root);
1393 pc->namespace = GNUNET_FS_namespace_create (h, ns);
1394 if (pc->namespace == NULL)
1396 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1398 ("Failed to recover namespace `%s', cannot resume publishing operation.\n"),
1403 if ((0 == (pc->options & GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY)) &&
1404 (GNUNET_YES != pc->all_done))
1406 pc->dsh = GNUNET_DATASTORE_connect (h->cfg);
1407 if (NULL == pc->dsh)
1412 pc->fi_pos = find_file_position (pc->fi, fi_pos);
1413 GNUNET_free (fi_pos);
1415 if (pc->fi_pos == NULL)
1417 /* failed to find position for resuming, outch! Will start from root! */
1419 if (pc->all_done != GNUNET_YES)
1420 pc->fi_pos = pc->fi;
1423 GNUNET_free (fi_root);
1425 /* generate RESUME event(s) */
1426 GNUNET_FS_file_information_inspect (pc->fi, &fip_signal_resume, pc);
1428 /* re-start publishing (if needed)... */
1429 if (pc->all_done != GNUNET_YES)
1431 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
1433 GNUNET_SCHEDULER_add_with_priority
1434 (GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
1435 &GNUNET_FS_publish_main_, pc);
1437 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1439 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1440 _("Failure while resuming publishing operation `%s': %s\n"),
1444 GNUNET_free_non_null (ns);
1445 pc->top = GNUNET_FS_make_top (h, &GNUNET_FS_publish_signal_suspend_, pc);
1448 GNUNET_free_non_null (pc->nid);
1449 GNUNET_free_non_null (pc->nuid);
1450 GNUNET_free_non_null (fi_root);
1451 GNUNET_free_non_null (fi_pos);
1452 GNUNET_free_non_null (ns);
1453 if ((rh != NULL) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
1455 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1456 _("Failed to resume publishing operation `%s': %s\n"), filename,
1461 GNUNET_FS_file_information_destroy (pc->fi, NULL, NULL);
1462 if (0 != UNLINK (filename))
1463 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
1464 GNUNET_free (pc->serialization);
1471 * Synchronize this publishing struct with its mirror
1472 * on disk. Note that all internal FS-operations that change
1473 * publishing structs should already call "sync" internally,
1474 * so this function is likely not useful for clients.
1476 * @param pc the struct to sync
1479 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc)
1481 struct GNUNET_BIO_WriteHandle *wh;
1483 if (NULL == pc->serialization)
1485 make_serialization_file_name (pc->h,
1486 GNUNET_FS_SYNC_PATH_MASTER_PUBLISH);
1487 if (NULL == pc->serialization)
1491 if (NULL == pc->fi->serialization)
1496 wh = get_write_handle (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1503 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nid)) ||
1504 (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nuid)) ||
1505 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->options)) ||
1506 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->all_done)) ||
1507 (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->fi->serialization)) ||
1509 GNUNET_BIO_write_string (wh,
1511 NULL) ? NULL : pc->fi_pos->serialization)) ||
1513 GNUNET_BIO_write_string (wh,
1515 NULL) ? NULL : pc->namespace->name)))
1520 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1529 (void) GNUNET_BIO_write_close (wh);
1530 GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1532 GNUNET_free (pc->serialization);
1533 pc->serialization = NULL;
1538 * Synchronize this unindex struct with its mirror
1539 * on disk. Note that all internal FS-operations that change
1540 * publishing structs should already call "sync" internally,
1541 * so this function is likely not useful for clients.
1543 * @param uc the struct to sync
1546 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc)
1548 struct GNUNET_BIO_WriteHandle *wh;
1551 if (NULL == uc->serialization)
1553 make_serialization_file_name (uc->h,
1554 GNUNET_FS_SYNC_PATH_MASTER_UNINDEX);
1555 if (NULL == uc->serialization)
1557 wh = get_write_handle (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1564 if (NULL != uc->ksk_uri)
1565 uris = GNUNET_FS_uri_to_string (uc->ksk_uri);
1568 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uc->filename)) ||
1569 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, uc->file_size)) ||
1570 (GNUNET_OK != write_start_time (wh, uc->start_time)) ||
1571 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->state)) ||
1573 GNUNET_BIO_write (wh, &uc->chk, sizeof (struct ContentHashKey))) ||
1574 (GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1575 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->ksk_offset)) ||
1576 ((uc->state == UNINDEX_STATE_FS_NOTIFY) &&
1578 GNUNET_BIO_write (wh, &uc->file_id, sizeof (GNUNET_HashCode)))) ||
1579 ((uc->state == UNINDEX_STATE_ERROR) &&
1580 (GNUNET_OK != GNUNET_BIO_write_string (wh, uc->emsg))))
1585 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1594 (void) GNUNET_BIO_write_close (wh);
1595 GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1597 GNUNET_free (uc->serialization);
1598 uc->serialization = NULL;
1603 * Serialize a download request.
1605 * @param wh the 'struct GNUNET_BIO_WriteHandle*'
1606 * @param dr the 'struct DownloadRequest'
1607 * @return GNUNET_YES on success, GNUNET_NO on error
1610 write_download_request (struct GNUNET_BIO_WriteHandle *wh,
1611 struct DownloadRequest *dr)
1615 if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->state)) ||
1616 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dr->offset)) ||
1617 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->num_children)) ||
1618 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->depth)))
1620 if ((dr->state == BRS_CHK_SET) &&
1622 GNUNET_BIO_write (wh, &dr->chk, sizeof (struct ContentHashKey))))
1624 for (i = 0; i < dr->num_children; i++)
1625 if (GNUNET_NO == write_download_request (wh, dr->children[i]))
1632 * Read a download request tree.
1634 * @param rh stream to read from
1635 * @return value the 'struct DownloadRequest', NULL on error
1637 static struct DownloadRequest *
1638 read_download_request (struct GNUNET_BIO_ReadHandle *rh)
1640 struct DownloadRequest *dr;
1643 dr = GNUNET_malloc (sizeof (struct DownloadRequest));
1645 if ((GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->state)) ||
1646 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dr->offset)) ||
1647 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->num_children)) ||
1648 (dr->num_children > CHK_PER_INODE) ||
1649 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->depth)) || ((dr->depth == 0)
1653 ((dr->depth > 0) && (dr->num_children == 0)))
1656 dr->num_children = 0;
1659 if (dr->num_children > 0)
1661 GNUNET_malloc (dr->num_children * sizeof (struct ContentHashKey));
1665 case BRS_RECONSTRUCT_DOWN:
1666 case BRS_RECONSTRUCT_META_UP:
1667 case BRS_RECONSTRUCT_UP:
1671 GNUNET_BIO_read (rh, "chk", &dr->chk, sizeof (struct ContentHashKey)))
1674 case BRS_DOWNLOAD_DOWN:
1675 case BRS_DOWNLOAD_UP:
1682 for (i = 0; i < dr->num_children; i++)
1684 if (NULL == (dr->children[i] = read_download_request (rh)))
1686 dr->children[i]->parent = dr;
1690 GNUNET_FS_free_download_request_ (dr);
1696 * Compute the name of the sync file (or directory) for the given download
1699 * @param dc download context to compute for
1700 * @param uni unique filename to use, use "" for the directory name
1701 * @param ext extension to use, use ".dir" for our own subdirectory
1702 * @return the expanded file name, NULL for none
1705 get_download_sync_filename (struct GNUNET_FS_DownloadContext *dc,
1706 const char *uni, const char *ext)
1711 if (dc->parent == NULL)
1712 return get_serialization_file_name (dc->h,
1713 (dc->search != NULL) ?
1714 GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD :
1715 GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
1717 if (dc->parent->serialization == NULL)
1719 par = get_download_sync_filename (dc->parent, dc->parent->serialization, "");
1722 GNUNET_asprintf (&epar, "%s.dir%s%s%s", par, DIR_SEPARATOR_STR, uni, ext);
1729 * Synchronize this download struct with its mirror
1730 * on disk. Note that all internal FS-operations that change
1731 * publishing structs should already call "sync" internally,
1732 * so this function is likely not useful for clients.
1734 * @param dc the struct to sync
1737 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc)
1739 struct GNUNET_BIO_WriteHandle *wh;
1744 if (0 != (dc->options & GNUNET_FS_DOWNLOAD_IS_PROBE))
1745 return; /* we don't sync probes */
1746 if (NULL == dc->serialization)
1748 dir = get_download_sync_filename (dc, "", "");
1751 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dir))
1756 fn = GNUNET_DISK_mktemp (dir);
1760 dc->serialization = get_serialization_short_name (fn);
1764 fn = get_download_sync_filename (dc, dc->serialization, "");
1767 GNUNET_free (dc->serialization);
1768 dc->serialization = NULL;
1773 wh = GNUNET_BIO_write_open (fn);
1776 GNUNET_free (dc->serialization);
1777 dc->serialization = NULL;
1781 GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_chk (dc->uri)) ||
1782 (GNUNET_YES == GNUNET_FS_uri_test_loc (dc->uri)));
1783 uris = GNUNET_FS_uri_to_string (dc->uri);
1784 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1785 (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, dc->meta)) ||
1786 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->emsg)) ||
1787 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->filename)) ||
1788 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->temp_filename)) ||
1789 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->old_file_size)) ||
1790 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->offset)) ||
1791 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->length)) ||
1792 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->completed)) ||
1793 (GNUNET_OK != write_start_time (wh, dc->start_time)) ||
1794 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dc->anonymity)) ||
1795 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->options)) ||
1796 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->has_finished)))
1801 if (NULL == dc->emsg)
1803 GNUNET_assert (dc->top_request != NULL);
1804 if (GNUNET_YES != write_download_request (wh, dc->top_request))
1810 GNUNET_free_non_null (uris);
1812 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1822 (void) GNUNET_BIO_write_close (wh);
1823 GNUNET_free_non_null (uris);
1824 if (0 != UNLINK (fn))
1825 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1827 GNUNET_free (dc->serialization);
1828 dc->serialization = NULL;
1833 * Synchronize this search result with its mirror
1834 * on disk. Note that all internal FS-operations that change
1835 * publishing structs should already call "sync" internally,
1836 * so this function is likely not useful for clients.
1838 * @param sr the struct to sync
1841 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr)
1843 struct GNUNET_BIO_WriteHandle *wh;
1847 if (NULL == sr->serialization)
1849 make_serialization_file_name_in_dir (sr->sc->h,
1850 (sr->sc->psearch_result ==
1852 GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1853 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1854 sr->sc->serialization);
1855 if (NULL == sr->serialization)
1857 wh = get_write_handle_in_dir (sr->sc->h,
1858 (sr->sc->psearch_result ==
1859 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1860 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1861 sr->sc->serialization, sr->serialization);
1867 uris = GNUNET_FS_uri_to_string (sr->uri);
1868 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1870 GNUNET_BIO_write_string (wh,
1872 NULL ? sr->download->serialization : NULL)) ||
1874 GNUNET_BIO_write_string (wh,
1875 sr->update_search !=
1876 NULL ? sr->update_search->serialization : NULL))
1877 || (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, sr->meta)) ||
1878 (GNUNET_OK != GNUNET_BIO_write (wh, &sr->key, sizeof (GNUNET_HashCode)))
1879 || (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->mandatory_missing)) ||
1880 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->optional_support)) ||
1881 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_success)) ||
1882 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_trials)) )
1887 if ( (NULL != sr->uri) &&
1888 (sr->sc->uri->type == ksk) &&
1889 (GNUNET_OK != GNUNET_BIO_write (wh, sr->keyword_bitmap,
1890 (sr->sc->uri->data.ksk.keywordCount + 7) / 8)) )
1895 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1901 GNUNET_free_non_null (uris);
1904 GNUNET_free_non_null (uris);
1906 (void) GNUNET_BIO_write_close (wh);
1907 remove_sync_file_in_dir (sr->sc->h,
1908 (sr->sc->psearch_result ==
1909 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1910 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1911 sr->sc->serialization, sr->serialization);
1912 GNUNET_free (sr->serialization);
1913 sr->serialization = NULL;
1918 * Synchronize this search struct with its mirror
1919 * on disk. Note that all internal FS-operations that change
1920 * publishing structs should already call "sync" internally,
1921 * so this function is likely not useful for clients.
1923 * @param sc the struct to sync
1926 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc)
1928 struct GNUNET_BIO_WriteHandle *wh;
1931 const char *category;
1934 (sc->psearch_result ==
1935 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1936 GNUNET_FS_SYNC_PATH_CHILD_SEARCH;
1937 if (NULL == sc->serialization)
1938 sc->serialization = make_serialization_file_name (sc->h, category);
1939 if (NULL == sc->serialization)
1942 wh = get_write_handle (sc->h, category, sc->serialization);
1948 GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_ksk (sc->uri)) ||
1949 (GNUNET_YES == GNUNET_FS_uri_test_sks (sc->uri)));
1950 uris = GNUNET_FS_uri_to_string (sc->uri);
1951 in_pause = (sc->task != GNUNET_SCHEDULER_NO_TASK) ? 'r' : '\0';
1952 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1953 (GNUNET_OK != write_start_time (wh, sc->start_time)) ||
1954 (GNUNET_OK != GNUNET_BIO_write_string (wh, sc->emsg)) ||
1955 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) sc->options)) ||
1956 (GNUNET_OK != GNUNET_BIO_write (wh, &in_pause, sizeof (in_pause))) ||
1957 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sc->anonymity)))
1964 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1973 (void) GNUNET_BIO_write_close (wh);
1974 GNUNET_free_non_null (uris);
1975 GNUNET_FS_remove_sync_file_ (sc->h, category, sc->serialization);
1976 GNUNET_free (sc->serialization);
1977 sc->serialization = NULL;
1982 * Function called with a filename of serialized unindexing operation
1985 * @param cls the 'struct GNUNET_FS_Handle*'
1986 * @param filename complete filename (absolute path)
1987 * @return GNUNET_OK (continue to iterate)
1990 deserialize_unindex_file (void *cls, const char *filename)
1992 struct GNUNET_FS_Handle *h = cls;
1993 struct GNUNET_BIO_ReadHandle *rh;
1994 struct GNUNET_FS_UnindexContext *uc;
1995 struct GNUNET_FS_ProgressInfo pi;
2000 uc = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
2002 uc->serialization = get_serialization_short_name (filename);
2003 rh = GNUNET_BIO_read_open (filename);
2011 GNUNET_BIO_read_string (rh, "unindex-fn", &uc->filename, 10 * 1024)) ||
2012 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &uc->file_size)) ||
2013 (GNUNET_OK != read_start_time (rh, &uc->start_time)) ||
2014 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &state)) ||
2015 (GNUNET_OK != GNUNET_BIO_read (rh, "uri", &uc->chk, sizeof (struct ContentHashKey))) ||
2016 (GNUNET_OK != GNUNET_BIO_read_string (rh, "unindex-kskuri", &uris, 10 * 1024)) ||
2017 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &uc->ksk_offset)) )
2019 GNUNET_free_non_null (uris);
2025 uc->ksk_uri = GNUNET_FS_uri_parse (uris, &emsg);
2027 if (NULL == uc->ksk_uri)
2033 if ( (uc->ksk_offset > 0) &&
2034 ( (NULL == uc->ksk_uri) ||
2035 (uc->ksk_offset > uc->ksk_uri->data.ksk.keywordCount) ) )
2040 uc->state = (enum UnindexState) state;
2043 case UNINDEX_STATE_HASHING:
2045 case UNINDEX_STATE_FS_NOTIFY:
2047 GNUNET_BIO_read (rh, "unindex-hash", &uc->file_id,
2048 sizeof (GNUNET_HashCode)))
2054 case UNINDEX_STATE_DS_REMOVE:
2055 case UNINDEX_STATE_EXTRACT_KEYWORDS:
2056 case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2058 case UNINDEX_STATE_COMPLETE:
2060 case UNINDEX_STATE_ERROR:
2062 GNUNET_BIO_read_string (rh, "unindex-emsg", &uc->emsg, 10 * 1024))
2072 uc->top = GNUNET_FS_make_top (h, &GNUNET_FS_unindex_signal_suspend_, uc);
2073 pi.status = GNUNET_FS_STATUS_UNINDEX_RESUME;
2074 pi.value.unindex.specifics.resume.message = uc->emsg;
2075 GNUNET_FS_unindex_make_status_ (&pi, uc,
2077 UNINDEX_STATE_COMPLETE) ? uc->file_size : 0);
2080 case UNINDEX_STATE_HASHING:
2082 GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE, uc->filename,
2084 &GNUNET_FS_unindex_process_hash_, uc);
2086 case UNINDEX_STATE_FS_NOTIFY:
2087 uc->state = UNINDEX_STATE_HASHING;
2088 GNUNET_FS_unindex_process_hash_ (uc, &uc->file_id);
2090 case UNINDEX_STATE_DS_REMOVE:
2091 GNUNET_FS_unindex_do_remove_ (uc);
2093 case UNINDEX_STATE_EXTRACT_KEYWORDS:
2094 GNUNET_FS_unindex_do_extract_keywords_ (uc);
2096 case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2097 GNUNET_FS_unindex_do_remove_kblocks_ (uc);
2099 case UNINDEX_STATE_COMPLETE:
2100 case UNINDEX_STATE_ERROR:
2101 /* no need to resume any operation, we were done */
2106 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2108 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2109 _("Failure while resuming unindexing operation `%s': %s\n"),
2115 GNUNET_free_non_null (uc->filename);
2116 if ((rh != NULL) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
2118 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2119 _("Failed to resume unindexing operation `%s': %s\n"), filename,
2123 if (uc->serialization != NULL)
2124 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2126 GNUNET_free_non_null (uc->serialization);
2133 * Deserialize a download.
2135 * @param h overall context
2136 * @param rh file to deserialize from
2137 * @param parent parent download
2138 * @param search associated search
2139 * @param serialization name under which the search was serialized
2142 deserialize_download (struct GNUNET_FS_Handle *h,
2143 struct GNUNET_BIO_ReadHandle *rh,
2144 struct GNUNET_FS_DownloadContext *parent,
2145 struct GNUNET_FS_SearchResult *search,
2146 const char *serialization);
2150 * Deserialize a search.
2152 * @param h overall context
2153 * @param rh file to deserialize from
2154 * @param psearch_result parent search result
2155 * @param serialization name under which the search was serialized
2157 static struct GNUNET_FS_SearchContext *
2158 deserialize_search (struct GNUNET_FS_Handle *h,
2159 struct GNUNET_BIO_ReadHandle *rh,
2160 struct GNUNET_FS_SearchResult *psearch_result,
2161 const char *serialization);
2165 * Function called with a filename of serialized search result
2168 * @param cls the 'struct GNUNET_FS_SearchContext*'
2169 * @param filename complete filename (absolute path)
2170 * @return GNUNET_OK (continue to iterate)
2173 deserialize_search_result (void *cls, const char *filename)
2175 struct GNUNET_FS_SearchContext *sc = cls;
2181 struct GNUNET_BIO_ReadHandle *rh;
2182 struct GNUNET_BIO_ReadHandle *drh;
2183 struct GNUNET_FS_SearchResult *sr;
2185 ser = get_serialization_short_name (filename);
2186 rh = GNUNET_BIO_read_open (filename);
2191 remove_sync_file_in_dir (sc->h,
2192 (sc->psearch_result ==
2193 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2194 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2195 sc->serialization, ser);
2204 sr = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchResult));
2206 sr->serialization = ser;
2207 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "result-uri", &uris, 10 * 1024))
2208 || (NULL == (sr->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2209 (GNUNET_OK != GNUNET_BIO_read_string (rh, "download-lnk", &download, 16))
2211 GNUNET_BIO_read_string (rh, "search-lnk", &update_srch, 16)) ||
2212 (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "result-meta", &sr->meta)) ||
2214 GNUNET_BIO_read (rh, "result-key", &sr->key, sizeof (GNUNET_HashCode)))
2215 || (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->mandatory_missing)) ||
2216 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->optional_support)) ||
2217 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_success)) ||
2218 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_trials)))
2223 if (sr->sc->uri->type == ksk)
2225 sr->keyword_bitmap = GNUNET_malloc ((sr->sc->uri->data.ksk.keywordCount + 7) / 8); /* round up, count bits */
2226 if (GNUNET_OK != GNUNET_BIO_read (rh, "keyword-bitmap",
2228 (sr->sc->uri->data.ksk.keywordCount + 7) / 8))
2235 if (download != NULL)
2237 drh = get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD, download);
2240 deserialize_download (sc->h, drh, NULL, sr, download);
2241 if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2243 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2244 _("Failed to resume sub-download `%s': %s\n"), download,
2249 GNUNET_free (download);
2251 if (update_srch != NULL)
2254 get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_SEARCH, update_srch);
2257 deserialize_search (sc->h, drh, sr, update_srch);
2258 if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2260 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2261 _("Failed to resume sub-search `%s': %s\n"), update_srch,
2266 GNUNET_free (update_srch);
2268 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &sr->key, sr,
2269 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2270 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2272 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2273 _("Failure while resuming search operation `%s': %s\n"),
2279 GNUNET_free_non_null (download);
2280 GNUNET_free_non_null (emsg);
2281 GNUNET_free_non_null (uris);
2282 GNUNET_free_non_null (update_srch);
2283 if (sr->uri != NULL)
2284 GNUNET_FS_uri_destroy (sr->uri);
2285 if (sr->meta != NULL)
2286 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2287 GNUNET_free (sr->serialization);
2289 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2291 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2292 _("Failure while resuming search operation `%s': %s\n"),
2301 * Send the 'resume' signal to the callback; also actually
2302 * resume the download (put it in the queue). Does this
2303 * recursively for the top-level download and all child
2306 * @param dc download to resume
2309 signal_download_resume (struct GNUNET_FS_DownloadContext *dc)
2311 struct GNUNET_FS_DownloadContext *dcc;
2312 struct GNUNET_FS_ProgressInfo pi;
2314 pi.status = GNUNET_FS_STATUS_DOWNLOAD_RESUME;
2315 pi.value.download.specifics.resume.meta = dc->meta;
2316 pi.value.download.specifics.resume.message = dc->emsg;
2317 GNUNET_FS_download_make_status_ (&pi, dc);
2318 dcc = dc->child_head;
2321 signal_download_resume (dcc);
2324 if (dc->pending_head != NULL)
2325 GNUNET_FS_download_start_downloading_ (dc);
2330 * Signal resuming of a search to our clients (for the
2331 * top level search and all sub-searches).
2333 * @param sc search being resumed
2336 signal_search_resume (struct GNUNET_FS_SearchContext *sc);
2340 * Iterator over search results signaling resume to the client for
2343 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2344 * @param key current key code
2345 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2346 * @return GNUNET_YES (we should continue to iterate)
2349 signal_result_resume (void *cls, const GNUNET_HashCode * key, void *value)
2351 struct GNUNET_FS_SearchContext *sc = cls;
2352 struct GNUNET_FS_ProgressInfo pi;
2353 struct GNUNET_FS_SearchResult *sr = value;
2355 if (0 == sr->mandatory_missing)
2357 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME_RESULT;
2358 pi.value.search.specifics.resume_result.meta = sr->meta;
2359 pi.value.search.specifics.resume_result.uri = sr->uri;
2360 pi.value.search.specifics.resume_result.result = sr;
2361 pi.value.search.specifics.resume_result.availability_rank =
2362 2 * sr->availability_success - sr->availability_trials;
2363 pi.value.search.specifics.resume_result.availability_certainty =
2364 sr->availability_trials;
2365 pi.value.search.specifics.resume_result.applicability_rank =
2366 sr->optional_support;
2367 sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
2369 if (sr->download != NULL)
2371 signal_download_resume (sr->download);
2375 GNUNET_FS_search_start_probe_ (sr);
2377 if (sr->update_search != NULL)
2378 signal_search_resume (sr->update_search);
2384 * Free memory allocated by the search context and its children
2386 * @param sc search context to free
2389 free_search_context (struct GNUNET_FS_SearchContext *sc);
2393 * Iterator over search results freeing each.
2395 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2396 * @param key current key code
2397 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2398 * @return GNUNET_YES (we should continue to iterate)
2401 free_result (void *cls, const GNUNET_HashCode * key, void *value)
2403 struct GNUNET_FS_SearchResult *sr = value;
2405 if (sr->update_search != NULL)
2407 free_search_context (sr->update_search);
2408 GNUNET_assert (NULL == sr->update_search);
2410 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2411 GNUNET_FS_uri_destroy (sr->uri);
2418 * Free memory allocated by the search context and its children
2420 * @param sc search context to free
2423 free_search_context (struct GNUNET_FS_SearchContext *sc)
2425 if (sc->serialization != NULL)
2427 GNUNET_FS_remove_sync_file_ (sc->h,
2428 (sc->psearch_result ==
2429 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2430 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2432 GNUNET_FS_remove_sync_dir_ (sc->h,
2433 (sc->psearch_result ==
2434 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2435 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2438 GNUNET_free_non_null (sc->serialization);
2439 GNUNET_free_non_null (sc->emsg);
2440 if (sc->uri != NULL)
2441 GNUNET_FS_uri_destroy (sc->uri);
2442 if (sc->master_result_map != NULL)
2444 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map, &free_result,
2446 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
2453 * Function called with a filename of serialized sub-download
2456 * @param cls the 'struct GNUNET_FS_DownloadContext*' (parent)
2457 * @param filename complete filename (absolute path)
2458 * @return GNUNET_OK (continue to iterate)
2461 deserialize_subdownload (void *cls, const char *filename)
2463 struct GNUNET_FS_DownloadContext *parent = cls;
2466 struct GNUNET_BIO_ReadHandle *rh;
2468 ser = get_serialization_short_name (filename);
2469 rh = GNUNET_BIO_read_open (filename);
2472 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2474 ("Failed to resume sub-download `%s': could not open file `%s'\n"),
2479 deserialize_download (parent->h, rh, parent, NULL, ser);
2480 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2482 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2483 _("Failed to resume sub-download `%s': %s\n"), ser, emsg);
2492 * Free this download context and all of its descendants.
2493 * (only works during deserialization since not all possible
2494 * state it taken care of).
2496 * @param dc context to free
2499 free_download_context (struct GNUNET_FS_DownloadContext *dc)
2501 struct GNUNET_FS_DownloadContext *dcc;
2503 if (dc->meta != NULL)
2504 GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2505 if (dc->uri != NULL)
2506 GNUNET_FS_uri_destroy (dc->uri);
2507 GNUNET_free_non_null (dc->temp_filename);
2508 GNUNET_free_non_null (dc->emsg);
2509 GNUNET_free_non_null (dc->filename);
2510 GNUNET_free_non_null (dc->serialization);
2511 while (NULL != (dcc = dc->child_head))
2513 GNUNET_CONTAINER_DLL_remove (dc->child_head, dc->child_tail, dcc);
2514 free_download_context (dcc);
2516 GNUNET_FS_free_download_request_ (dc->top_request);
2517 if (NULL != dc->active)
2518 GNUNET_CONTAINER_multihashmap_destroy (dc->active);
2524 * Deserialize a download.
2526 * @param h overall context
2527 * @param rh file to deserialize from
2528 * @param parent parent download
2529 * @param search associated search
2530 * @param serialization name under which the search was serialized
2533 deserialize_download (struct GNUNET_FS_Handle *h,
2534 struct GNUNET_BIO_ReadHandle *rh,
2535 struct GNUNET_FS_DownloadContext *parent,
2536 struct GNUNET_FS_SearchResult *search,
2537 const char *serialization)
2539 struct GNUNET_FS_DownloadContext *dc;
2548 dc = GNUNET_malloc (sizeof (struct GNUNET_FS_DownloadContext));
2549 dc->parent = parent;
2551 dc->serialization = GNUNET_strdup (serialization);
2553 GNUNET_BIO_read_string (rh, "download-uri", &uris, 10 * 1024)) ||
2554 (NULL == (dc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2555 ((GNUNET_YES != GNUNET_FS_uri_test_chk (dc->uri)) &&
2556 (GNUNET_YES != GNUNET_FS_uri_test_loc (dc->uri))) ||
2557 (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "download-meta", &dc->meta))
2559 GNUNET_BIO_read_string (rh, "download-emsg", &dc->emsg, 10 * 1024)) ||
2561 GNUNET_BIO_read_string (rh, "download-fn", &dc->filename, 10 * 1024)) ||
2563 GNUNET_BIO_read_string (rh, "download-tfn", &dc->temp_filename,
2565 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->old_file_size)) ||
2566 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->offset)) ||
2567 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->length)) ||
2568 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->completed)) ||
2569 (GNUNET_OK != read_start_time (rh, &dc->start_time)) ||
2570 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dc->anonymity)) ||
2571 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2572 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &status)))
2577 dc->options = (enum GNUNET_FS_DownloadOptions) options;
2579 GNUNET_CONTAINER_multihashmap_create (1 + 2 * (dc->length / DBLOCK_SIZE));
2580 dc->has_finished = (int) status;
2582 GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size (dc->uri));
2583 if (GNUNET_FS_uri_test_loc (dc->uri))
2584 GNUNET_assert (GNUNET_OK ==
2585 GNUNET_FS_uri_loc_get_peer_identity (dc->uri, &dc->target));
2586 if (dc->emsg == NULL)
2588 dc->top_request = read_download_request (rh);
2589 if (dc->top_request == NULL)
2595 dn = get_download_sync_filename (dc, dc->serialization, ".dir");
2598 if (GNUNET_YES == GNUNET_DISK_directory_test (dn))
2599 GNUNET_DISK_directory_scan (dn, &deserialize_subdownload, dc);
2604 GNUNET_abort (); // for debugging for now - FIXME
2605 GNUNET_CONTAINER_DLL_insert (parent->child_head, parent->child_tail, dc);
2609 dc->search = search;
2610 search->download = dc;
2612 if ((parent == NULL) && (search == NULL))
2615 GNUNET_FS_make_top (dc->h, &GNUNET_FS_download_signal_suspend_, dc);
2616 signal_download_resume (dc);
2619 dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_, dc);
2622 GNUNET_free_non_null (uris);
2623 GNUNET_free_non_null (emsg);
2624 free_download_context (dc);
2629 * Signal resuming of a search to our clients (for the
2630 * top level search and all sub-searches).
2632 * @param sc search being resumed
2635 signal_search_resume (struct GNUNET_FS_SearchContext *sc)
2637 struct GNUNET_FS_ProgressInfo pi;
2639 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME;
2640 pi.value.search.specifics.resume.message = sc->emsg;
2641 pi.value.search.specifics.resume.is_paused =
2642 (sc->client == NULL) ? GNUNET_YES : GNUNET_NO;
2643 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
2644 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2645 &signal_result_resume, sc);
2651 * Deserialize a search.
2653 * @param h overall context
2654 * @param rh file to deserialize from
2655 * @param psearch_result parent search result
2656 * @param serialization name under which the search was serialized
2658 static struct GNUNET_FS_SearchContext *
2659 deserialize_search (struct GNUNET_FS_Handle *h,
2660 struct GNUNET_BIO_ReadHandle *rh,
2661 struct GNUNET_FS_SearchResult *psearch_result,
2662 const char *serialization)
2664 struct GNUNET_FS_SearchContext *sc;
2671 if ((psearch_result != NULL) && (psearch_result->update_search != NULL))
2678 sc = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchContext));
2679 if (psearch_result != NULL)
2681 sc->psearch_result = psearch_result;
2682 psearch_result->update_search = sc;
2685 sc->serialization = GNUNET_strdup (serialization);
2686 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "search-uri", &uris, 10 * 1024))
2687 || (NULL == (sc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2688 ((GNUNET_YES != GNUNET_FS_uri_test_ksk (sc->uri)) &&
2689 (GNUNET_YES != GNUNET_FS_uri_test_sks (sc->uri))) ||
2690 (GNUNET_OK != read_start_time (rh, &sc->start_time)) ||
2692 GNUNET_BIO_read_string (rh, "search-emsg", &sc->emsg, 10 * 1024)) ||
2693 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2695 GNUNET_BIO_read (rh, "search-pause", &in_pause, sizeof (in_pause))) ||
2696 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sc->anonymity)))
2701 sc->options = (enum GNUNET_FS_SearchOptions) options;
2702 sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16);
2703 dn = get_serialization_file_name_in_dir (h,
2704 (sc->psearch_result ==
2706 GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2707 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2708 sc->serialization, "");
2711 if (GNUNET_YES == GNUNET_DISK_directory_test (dn))
2712 GNUNET_DISK_directory_scan (dn, &deserialize_search_result, sc);
2715 if (('\0' == in_pause) &&
2716 (GNUNET_OK != GNUNET_FS_search_start_searching_ (sc)))
2718 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2720 ("Could not resume running search, will resume as paused search\n"));
2722 signal_search_resume (sc);
2726 GNUNET_free_non_null (emsg);
2727 free_search_context (sc);
2728 GNUNET_free_non_null (uris);
2734 * Function called with a filename of serialized search operation
2737 * @param cls the 'struct GNUNET_FS_Handle*'
2738 * @param filename complete filename (absolute path)
2739 * @return GNUNET_OK (continue to iterate)
2742 deserialize_search_file (void *cls, const char *filename)
2744 struct GNUNET_FS_Handle *h = cls;
2747 struct GNUNET_BIO_ReadHandle *rh;
2748 struct GNUNET_FS_SearchContext *sc;
2751 if (0 != STAT (filename, &buf))
2753 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "stat", filename);
2756 if (S_ISDIR (buf.st_mode))
2757 return GNUNET_OK; /* skip directories */
2758 ser = get_serialization_short_name (filename);
2759 rh = GNUNET_BIO_read_open (filename);
2764 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_SEARCH, ser);
2769 sc = deserialize_search (h, rh, NULL, ser);
2771 sc->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, sc);
2773 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2775 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2776 _("Failure while resuming search operation `%s': %s\n"),
2785 * Function called with a filename of serialized download operation
2788 * @param cls the 'struct GNUNET_FS_Handle*'
2789 * @param filename complete filename (absolute path)
2790 * @return GNUNET_OK (continue to iterate)
2793 deserialize_download_file (void *cls, const char *filename)
2795 struct GNUNET_FS_Handle *h = cls;
2798 struct GNUNET_BIO_ReadHandle *rh;
2800 ser = get_serialization_short_name (filename);
2801 rh = GNUNET_BIO_read_open (filename);
2804 if (0 != UNLINK (filename))
2805 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
2809 deserialize_download (h, rh, NULL, NULL, ser);
2811 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2813 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2814 _("Failure while resuming download operation `%s': %s\n"),
2823 * Deserialize informatin about pending operations.
2825 * @param master_path which master directory should be scanned
2826 * @param proc function to call for each entry (will get 'h' for 'cls')
2827 * @param h the 'struct GNUNET_FS_Handle*'
2830 deserialization_master (const char *master_path, GNUNET_FileNameCallback proc,
2831 struct GNUNET_FS_Handle *h)
2835 dn = get_serialization_file_name (h, master_path, "");
2838 if (GNUNET_YES == GNUNET_DISK_directory_test (dn))
2839 GNUNET_DISK_directory_scan (dn, proc, h);
2845 * Setup a connection to the file-sharing service.
2847 * @param cfg configuration to use
2848 * @param client_name unique identifier for this client
2849 * @param upcb function to call to notify about FS actions
2850 * @param upcb_cls closure for upcb
2851 * @param flags specific attributes for fs-operations
2852 * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
2853 * @return NULL on error
2855 struct GNUNET_FS_Handle *
2856 GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
2857 const char *client_name, GNUNET_FS_ProgressCallback upcb,
2858 void *upcb_cls, enum GNUNET_FS_Flags flags, ...)
2860 struct GNUNET_FS_Handle *ret;
2861 enum GNUNET_FS_OPTIONS opt;
2864 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Handle));
2866 ret->client_name = GNUNET_strdup (client_name);
2868 ret->upcb_cls = upcb_cls;
2870 ret->max_parallel_downloads = DEFAULT_MAX_PARALLEL_DOWNLOADS;
2871 ret->max_parallel_requests = DEFAULT_MAX_PARALLEL_REQUESTS;
2872 ret->avg_block_latency = GNUNET_TIME_UNIT_MINUTES; /* conservative starting point */
2873 va_start (ap, flags);
2874 while (GNUNET_FS_OPTIONS_END != (opt = va_arg (ap, enum GNUNET_FS_OPTIONS)))
2878 case GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM:
2879 ret->max_parallel_downloads = va_arg (ap, unsigned int);
2882 case GNUNET_FS_OPTIONS_REQUEST_PARALLELISM:
2883 ret->max_parallel_requests = va_arg (ap, unsigned int);
2888 GNUNET_free (ret->client_name);
2895 if (0 != (GNUNET_FS_FLAGS_PERSISTENCE & flags))
2897 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
2898 &deserialize_publish_file, ret);
2899 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
2900 &deserialize_search_file, ret);
2901 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
2902 &deserialize_download_file, ret);
2903 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2904 &deserialize_unindex_file, ret);
2911 * Close our connection with the file-sharing service.
2912 * The callback given to GNUNET_FS_start will no longer be
2913 * called after this function returns.
2915 * @param h handle that was returned from GNUNET_FS_start
2918 GNUNET_FS_stop (struct GNUNET_FS_Handle *h)
2920 while (h->top_head != NULL)
2921 h->top_head->ssf (h->top_head->ssf_cls);
2922 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
2923 GNUNET_SCHEDULER_cancel (h->queue_job);
2924 GNUNET_free (h->client_name);