2 This file is part of GNUnet.
3 (C) 2001--2012 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 (NULL == qe->client)
59 qe->start (qe->cls, qe->client);
61 qe->h->active_blocks += qe->blocks;
62 qe->h->active_downloads++;
63 qe->start_time = GNUNET_TIME_absolute_get ();
64 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
65 "Starting job %p (%u active)\n",
67 qe->h->active_downloads);
68 GNUNET_CONTAINER_DLL_remove (qe->h->pending_head, qe->h->pending_tail, qe);
69 GNUNET_CONTAINER_DLL_insert_after (qe->h->running_head, qe->h->running_tail,
70 qe->h->running_tail, qe);
75 * Stop the given job (send signal, remove from active queue, update
76 * counters and state).
78 * @param qe job to stop
81 stop_job (struct GNUNET_FS_QueueEntry *qe)
85 GNUNET_assert (0 < qe->h->active_downloads);
86 qe->h->active_downloads--;
87 qe->h->active_blocks -= qe->blocks;
89 GNUNET_TIME_relative_add (qe->run_time,
90 GNUNET_TIME_absolute_get_duration
92 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
93 "Stopping job %p (%u active)\n",
95 qe->h->active_downloads);
96 GNUNET_CONTAINER_DLL_remove (qe->h->running_head, qe->h->running_tail, qe);
97 GNUNET_CONTAINER_DLL_insert_after (qe->h->pending_head, qe->h->pending_tail,
98 qe->h->pending_tail, qe);
103 * Process the jobs in the job queue, possibly starting some
104 * and stopping others.
106 * @param cls the 'struct GNUNET_FS_Handle'
107 * @param tc scheduler context
110 process_job_queue (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
112 struct GNUNET_FS_Handle *h = cls;
113 struct GNUNET_FS_QueueEntry *qe;
114 struct GNUNET_FS_QueueEntry *next;
115 struct GNUNET_TIME_Relative run_time;
116 struct GNUNET_TIME_Relative restart_at;
117 struct GNUNET_TIME_Relative rst;
118 struct GNUNET_TIME_Absolute end_time;
119 unsigned int num_downloads_waiting;
120 unsigned int num_downloads_active;
121 unsigned int num_downloads_expired;
122 unsigned int num_probes_active;
123 unsigned int num_probes_waiting;
124 unsigned int num_probes_expired;
125 int num_probes_change;
126 int num_downloads_change;
129 h->queue_job = GNUNET_SCHEDULER_NO_TASK;
130 /* restart_at will be set to the time when it makes sense to
131 re-evaluate the job queue (unless, of course, jobs complete
132 or are added, then we'll be triggered immediately */
133 restart_at = GNUNET_TIME_UNIT_FOREVER_REL;
134 /* first, calculate some basic statistics on pending jobs */
135 num_probes_waiting = 0;
136 num_downloads_waiting = 0;
137 for (qe = h->pending_head; NULL != qe; qe = qe->next)
139 switch (qe->priority)
141 case GNUNET_FS_QUEUE_PRIORITY_PROBE:
142 num_probes_waiting++;
144 case GNUNET_FS_QUEUE_PRIORITY_NORMAL:
145 num_downloads_waiting++;
152 /* now, calculate some basic statistics on running jobs */
153 num_probes_active = 0;
154 num_probes_expired = 0;
155 num_downloads_active = 0;
156 num_downloads_expired = 0;
157 next = h->running_head;
158 while (NULL != (qe = next))
161 switch (qe->priority)
163 case GNUNET_FS_QUEUE_PRIORITY_PROBE:
164 run_time = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2);
165 end_time = GNUNET_TIME_absolute_add (qe->start_time, run_time);
166 rst = GNUNET_TIME_absolute_get_remaining (end_time);
167 if (0 == rst.rel_value_us)
169 num_probes_expired++;
175 restart_at = GNUNET_TIME_relative_min (rst, restart_at);
178 case GNUNET_FS_QUEUE_PRIORITY_NORMAL:
180 GNUNET_TIME_relative_multiply (h->avg_block_latency,
181 qe->blocks * qe->start_times);
182 end_time = GNUNET_TIME_absolute_add (qe->start_time, run_time);
183 rst = GNUNET_TIME_absolute_get_remaining (end_time);
184 if (0 == rst.rel_value_us)
186 num_downloads_expired++;
191 num_downloads_active++;
192 restart_at = GNUNET_TIME_relative_min (rst, restart_at);
200 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
201 "PA: %u, PE: %u, PW: %u; DA: %u, DE: %u, DW: %u\n",
205 num_downloads_active,
206 num_downloads_expired,
207 num_downloads_waiting);
208 /* calculate start/stop decisions */
209 if (h->active_downloads + num_downloads_waiting > h->max_parallel_requests)
211 /* stop probes if possible */
212 num_probes_change = - num_probes_active;
213 num_downloads_change = h->max_parallel_requests - h->active_downloads;
217 /* start all downloads */
218 num_downloads_change = num_downloads_waiting;
219 /* start as many probes as we can */
220 num_probes_change = GNUNET_MIN (num_probes_waiting,
221 h->max_parallel_requests - (h->active_downloads + num_downloads_waiting));
224 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
225 "Changing %d probes and %d downloads\n",
227 num_downloads_change);
228 /* actually stop probes */
229 next = h->running_head;
230 while (NULL != (qe = next))
233 if (GNUNET_FS_QUEUE_PRIORITY_PROBE != qe->priority)
235 if (num_probes_change < 0)
239 if (0 == num_probes_change)
243 GNUNET_break (0 <= num_probes_change);
245 /* start some more tasks if we now have empty slots */
246 block_limit_hit = GNUNET_NO;
247 next = h->pending_head;
248 while ( (NULL != (qe = next)) &&
249 ( (num_probes_change > 0) ||
250 (num_downloads_change > 0) ) )
253 switch (qe->priority)
255 case GNUNET_FS_QUEUE_PRIORITY_PROBE:
256 if (num_probes_change > 0)
260 run_time = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2);
261 restart_at = GNUNET_TIME_relative_min (run_time, restart_at);
264 case GNUNET_FS_QUEUE_PRIORITY_NORMAL:
265 if ( (num_downloads_change > 0) &&
266 ( (qe->blocks + h->active_blocks <= h->max_parallel_requests) ||
267 ( (qe->blocks > h->max_parallel_requests) &&
268 (0 == h->active_downloads) ) ) )
271 num_downloads_change--;
273 else if (num_downloads_change > 0)
274 block_limit_hit = GNUNET_YES;
281 GNUNET_break ( (0 == num_downloads_change) || (GNUNET_YES == block_limit_hit) );
282 GNUNET_break (0 == num_probes_change);
284 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
285 "AD: %u, MP: %u; %d probes and %d downloads to start, will run again in %s\n",
287 h->max_parallel_requests,
289 num_downloads_change,
290 GNUNET_STRINGS_relative_time_to_string (restart_at, GNUNET_YES));
292 /* make sure we run again */
294 GNUNET_SCHEDULER_add_delayed (restart_at, &process_job_queue, h);
299 * Add a job to the queue.
301 * @param h handle to the overall FS state
302 * @param start function to call to begin the job
303 * @param stop function to call to pause the job, or on dequeue (if the job was running)
304 * @param cls closure for start and stop
305 * @param blocks number of blocks this jobs uses
306 * @param priority how important is this download
307 * @return queue handle
309 struct GNUNET_FS_QueueEntry *
310 GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h, GNUNET_FS_QueueStart start,
311 GNUNET_FS_QueueStop stop, void *cls, unsigned int blocks,
312 enum GNUNET_FS_QueuePriority priority)
314 struct GNUNET_FS_QueueEntry *qe;
316 qe = GNUNET_malloc (sizeof (struct GNUNET_FS_QueueEntry));
321 qe->queue_time = GNUNET_TIME_absolute_get ();
323 qe->priority = priority;
324 GNUNET_CONTAINER_DLL_insert_after (h->pending_head, h->pending_tail,
325 h->pending_tail, qe);
326 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
327 GNUNET_SCHEDULER_cancel (h->queue_job);
328 h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h);
329 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
337 * Dequeue a job from the queue.
339 * @param qe handle for the job
342 GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qe)
344 struct GNUNET_FS_Handle *h;
347 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
348 "Dequeueing job %p\n",
350 if (NULL != qe->client)
352 GNUNET_CONTAINER_DLL_remove (h->pending_head, h->pending_tail, qe);
354 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
355 GNUNET_SCHEDULER_cancel (h->queue_job);
356 h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h);
361 * Create a top-level activity entry.
363 * @param h global fs handle
364 * @param ssf suspend signal function to use
365 * @param ssf_cls closure for ssf
366 * @return fresh top-level activity handle
368 struct TopLevelActivity *
369 GNUNET_FS_make_top (struct GNUNET_FS_Handle *h, SuspendSignalFunction ssf,
372 struct TopLevelActivity *ret;
374 ret = GNUNET_malloc (sizeof (struct TopLevelActivity));
376 ret->ssf_cls = ssf_cls;
377 GNUNET_CONTAINER_DLL_insert (h->top_head, h->top_tail, ret);
383 * Destroy a top-level activity entry.
385 * @param h global fs handle
386 * @param top top level activity entry
389 GNUNET_FS_end_top (struct GNUNET_FS_Handle *h, struct TopLevelActivity *top)
391 GNUNET_CONTAINER_DLL_remove (h->top_head, h->top_tail, top);
398 * Closure for "data_reader_file".
403 * Name of the file to read.
408 * File descriptor, NULL if it has not yet been opened.
410 struct GNUNET_DISK_FileHandle *fd;
415 * Function that provides data by reading from a file.
417 * @param cls closure (points to the file information)
418 * @param offset offset to read from; it is possible
419 * that the caller might need to go backwards
420 * a bit at times; set to UINT64_MAX to tell
421 * the reader that we won't be reading for a while
422 * (used to close the file descriptor but NOT fully
423 * clean up the reader's state); in this case,
424 * a value of '0' for max should be ignored
425 * @param max maximum number of bytes that should be
426 * copied to buf; readers are not allowed
427 * to provide less data unless there is an error;
428 * a value of "0" will be used at the end to allow
429 * the reader to clean up its internal state
430 * @param buf where the reader should write the data
431 * @param emsg location for the reader to store an error message
432 * @return number of bytes written, usually "max", 0 on error
435 GNUNET_FS_data_reader_file_ (void *cls, uint64_t offset, size_t max, void *buf,
438 struct FileInfo *fi = cls;
441 if (UINT64_MAX == offset)
445 GNUNET_DISK_file_close (fi->fd);
453 GNUNET_DISK_file_close (fi->fd);
454 GNUNET_free (fi->filename);
461 GNUNET_DISK_file_open (fi->filename, GNUNET_DISK_OPEN_READ,
462 GNUNET_DISK_PERM_NONE);
465 GNUNET_asprintf (emsg, _("Could not open file `%s': %s"), fi->filename,
470 if ( (GNUNET_SYSERR ==
471 GNUNET_DISK_file_seek (fi->fd, offset, GNUNET_DISK_SEEK_SET)) ||
472 (-1 == (ret = GNUNET_DISK_file_read (fi->fd, buf, max))) )
474 GNUNET_asprintf (emsg, _("Could not read file `%s': %s"), fi->filename,
480 GNUNET_asprintf (emsg, _("Short read reading from file `%s'!"),
489 * Create the closure for the 'GNUNET_FS_data_reader_file_' callback.
491 * @param filename file to read
492 * @return closure to use, NULL on error
495 GNUNET_FS_make_file_reader_context_ (const char *filename)
499 fi = GNUNET_new (struct FileInfo);
500 fi->filename = GNUNET_STRINGS_filename_expand (filename);
501 if (NULL == fi->filename)
511 * Function that provides data by copying from a buffer.
513 * @param cls closure (points to the buffer)
514 * @param offset offset to read from; it is possible
515 * that the caller might need to go backwards
516 * a bit at times; set to UINT64_MAX to tell
517 * the reader that we won't be reading for a while
518 * (used to close the file descriptor but NOT fully
519 * clean up the reader's state); in this case,
520 * a value of '0' for max should be ignored
521 * @param max maximum number of bytes that should be
522 * copied to buf; readers are not allowed
523 * to provide less data unless there is an error;
524 * a value of "0" will be used at the end to allow
525 * the reader to clean up its internal state
526 * @param buf where the reader should write the data
527 * @param emsg location for the reader to store an error message
528 * @return number of bytes written, usually "max", 0 on error
531 GNUNET_FS_data_reader_copy_ (void *cls, uint64_t offset, size_t max, void *buf,
536 if (UINT64_MAX == offset)
540 GNUNET_free_non_null (data);
543 memcpy (buf, &data[offset], max);
549 * Return the full filename where we would store state information
550 * (for serialization/deserialization).
552 * @param h master context
553 * @param ext component of the path
554 * @param ent entity identifier (or emtpy string for the directory)
555 * @return NULL on error
558 get_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext,
564 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
565 return NULL; /* persistence not requested */
567 GNUNET_CONFIGURATION_get_value_filename (h->cfg, "fs", "STATE_DIR",
570 GNUNET_asprintf (&ret, "%s%s%s%s%s%s%s", basename, DIR_SEPARATOR_STR,
571 h->client_name, DIR_SEPARATOR_STR, ext, DIR_SEPARATOR_STR,
573 GNUNET_free (basename);
579 * Return the full filename where we would store state information
580 * (for serialization/deserialization) that is associated with a
583 * @param h master context
584 * @param ext component of the path
585 * @param uni name of the parent operation
586 * @param ent entity identifier (or emtpy string for the directory)
587 * @return NULL on error
590 get_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
591 const char *uni, const char *ent)
596 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
597 return NULL; /* persistence not requested */
599 GNUNET_CONFIGURATION_get_value_filename (h->cfg, "fs", "STATE_DIR",
602 GNUNET_asprintf (&ret, "%s%s%s%s%s%s%s.dir%s%s", basename, DIR_SEPARATOR_STR,
603 h->client_name, DIR_SEPARATOR_STR, ext, DIR_SEPARATOR_STR,
604 uni, DIR_SEPARATOR_STR, ent);
605 GNUNET_free (basename);
611 * Return a read handle for deserialization.
613 * @param h master context
614 * @param ext component of the path
615 * @param ent entity identifier (or emtpy string for the directory)
616 * @return NULL on error
618 static struct GNUNET_BIO_ReadHandle *
619 get_read_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
622 struct GNUNET_BIO_ReadHandle *ret;
624 fn = get_serialization_file_name (h, ext, ent);
627 ret = GNUNET_BIO_read_open (fn);
634 * Return a write handle for serialization.
636 * @param h master context
637 * @param ext component of the path
638 * @param ent entity identifier (or emtpy string for the directory)
639 * @return NULL on error
641 static struct GNUNET_BIO_WriteHandle *
642 get_write_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
645 struct GNUNET_BIO_WriteHandle *ret;
647 fn = get_serialization_file_name (h, ext, ent);
650 ret = GNUNET_BIO_write_open (fn);
651 GNUNET_break (NULL != ret);
658 * Return a write handle for serialization.
660 * @param h master context
661 * @param ext component of the path
662 * @param uni name of parent
663 * @param ent entity identifier (or emtpy string for the directory)
664 * @return NULL on error
666 static struct GNUNET_BIO_WriteHandle *
667 get_write_handle_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
668 const char *uni, const char *ent)
671 struct GNUNET_BIO_WriteHandle *ret;
673 fn = get_serialization_file_name_in_dir (h, ext, uni, ent);
676 ret = GNUNET_BIO_write_open (fn);
683 * Remove serialization/deserialization file from disk.
685 * @param h master context
686 * @param ext component of the path
687 * @param ent entity identifier
690 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext,
695 if ((NULL == ent) || (0 == strlen (ent)))
700 filename = get_serialization_file_name (h, ext, ent);
701 if (NULL != filename)
703 if (0 != UNLINK (filename))
704 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
705 GNUNET_free (filename);
711 * Remove serialization/deserialization file from disk.
713 * @param h master context
714 * @param ext component of the path
715 * @param uni parent name
716 * @param ent entity identifier
719 remove_sync_file_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
720 const char *uni, const char *ent)
724 if ((NULL == ent) || (0 == strlen (ent)))
729 filename = get_serialization_file_name_in_dir (h, ext, uni, ent);
730 if (NULL == filename)
732 if (0 != UNLINK (filename))
733 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
734 GNUNET_free (filename);
739 * Remove serialization/deserialization directory from disk.
741 * @param h master context
742 * @param ext component of the path
743 * @param uni unique name of parent
746 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext,
753 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
756 if ((GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES)) &&
757 (GNUNET_OK != GNUNET_DISK_directory_remove (dn)))
758 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "rmdir", dn);
764 * Serialize a 'start_time'. Since we use start-times to
765 * calculate the duration of some operation, we actually
766 * do not serialize the absolute time but the (relative)
767 * duration since the start time. When we then
768 * deserialize the start time, we take the current time and
769 * subtract that duration so that we get again an absolute
770 * time stamp that will result in correct performance
773 * @param wh handle for writing
774 * @param timestamp time to serialize
775 * @return GNUNET_OK on success
778 write_start_time (struct GNUNET_BIO_WriteHandle *wh,
779 struct GNUNET_TIME_Absolute timestamp)
781 struct GNUNET_TIME_Relative dur;
783 dur = GNUNET_TIME_absolute_get_duration (timestamp);
784 return GNUNET_BIO_write_int64 (wh, dur.rel_value_us);
789 * Serialize a 'start_time'. Since we use start-times to
790 * calculate the duration of some operation, we actually
791 * do not serialize the absolute time but the (relative)
792 * duration since the start time. When we then
793 * deserialize the start time, we take the current time and
794 * subtract that duration so that we get again an absolute
795 * time stamp that will result in correct performance
798 * @param rh handle for reading
799 * @param timestamp where to write the deserialized timestamp
800 * @return GNUNET_OK on success
803 read_start_time (struct GNUNET_BIO_ReadHandle *rh,
804 struct GNUNET_TIME_Absolute *timestamp)
806 struct GNUNET_TIME_Relative dur;
808 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dur.rel_value_us))
809 return GNUNET_SYSERR;
810 *timestamp = GNUNET_TIME_absolute_subtract (GNUNET_TIME_absolute_get (), dur);
816 * Using the given serialization filename, try to deserialize
817 * the file-information tree associated with it.
819 * @param h master context
820 * @param filename name of the file (without directory) with
822 * @return NULL on error
824 static struct GNUNET_FS_FileInformation *
825 deserialize_file_information (struct GNUNET_FS_Handle *h, const char *filename);
829 * Using the given serialization filename, try to deserialize
830 * the file-information tree associated with it.
832 * @param h master context
833 * @param fn name of the file (without directory) with
835 * @param rh handle for reading
836 * @return NULL on error
838 static struct GNUNET_FS_FileInformation *
839 deserialize_fi_node (struct GNUNET_FS_Handle *h, const char *fn,
840 struct GNUNET_BIO_ReadHandle *rh)
842 struct GNUNET_FS_FileInformation *ret;
843 struct GNUNET_FS_FileInformation *nxt;
850 if (GNUNET_OK != GNUNET_BIO_read (rh, "status flag", &b, sizeof (b)))
855 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_FileInformation));
860 if ((GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "metadata", &ret->meta)) ||
861 (GNUNET_OK != GNUNET_BIO_read_string (rh, "ksk-uri", &ksks, 32 * 1024)) ||
863 ( (NULL == (ret->keywords = GNUNET_FS_uri_parse (ksks, NULL))) ||
864 (GNUNET_YES != GNUNET_FS_uri_test_ksk (ret->keywords)) ) ) ||
865 (GNUNET_OK != GNUNET_BIO_read_string (rh, "chk-uri", &chks, 1024)) ||
867 ( (NULL == (ret->chk_uri = GNUNET_FS_uri_parse (chks, NULL))) ||
868 (GNUNET_YES != GNUNET_FS_uri_test_chk (ret->chk_uri))) ) ||
869 (GNUNET_OK != read_start_time (rh, &ret->start_time)) ||
870 (GNUNET_OK != GNUNET_BIO_read_string (rh, "emsg", &ret->emsg, 16 * 1024))
872 GNUNET_BIO_read_string (rh, "fn", &ret->filename, 16 * 1024)) ||
874 GNUNET_BIO_read_int64 (rh, &ret->bo.expiration_time.abs_value_us)) ||
875 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.anonymity_level)) ||
876 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.content_priority)) ||
877 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.replication_level)))
884 case 0: /* file-insert */
885 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
890 ret->is_directory = GNUNET_NO;
891 ret->data.file.do_index = GNUNET_NO;
892 ret->data.file.have_hash = GNUNET_NO;
893 ret->data.file.index_start_confirmed = GNUNET_NO;
894 if (GNUNET_NO == ret->is_published)
896 if (NULL == ret->filename)
898 ret->data.file.reader = &GNUNET_FS_data_reader_copy_;
899 ret->data.file.reader_cls =
900 GNUNET_malloc_large (ret->data.file.file_size);
901 if (ret->data.file.reader_cls == NULL)
904 GNUNET_BIO_read (rh, "file-data", ret->data.file.reader_cls,
905 ret->data.file.file_size))
913 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
914 ret->data.file.reader_cls =
915 GNUNET_FS_make_file_reader_context_ (ret->filename);
919 case 1: /* file-index, no hash */
920 if (NULL == ret->filename)
925 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
930 ret->is_directory = GNUNET_NO;
931 ret->data.file.do_index = GNUNET_YES;
932 ret->data.file.have_hash = GNUNET_NO;
933 ret->data.file.index_start_confirmed = GNUNET_NO;
934 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
935 ret->data.file.reader_cls =
936 GNUNET_FS_make_file_reader_context_ (ret->filename);
938 case 2: /* file-index-with-hash */
939 if (NULL == ret->filename)
944 if ((GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
946 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id,
947 sizeof (struct GNUNET_HashCode))))
952 ret->is_directory = GNUNET_NO;
953 ret->data.file.do_index = GNUNET_YES;
954 ret->data.file.have_hash = GNUNET_YES;
955 ret->data.file.index_start_confirmed = GNUNET_NO;
956 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
957 ret->data.file.reader_cls =
958 GNUNET_FS_make_file_reader_context_ (ret->filename);
960 case 3: /* file-index-with-hash-confirmed */
961 if (NULL == ret->filename)
966 if ((GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
968 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id,
969 sizeof (struct GNUNET_HashCode))))
974 ret->is_directory = GNUNET_NO;
975 ret->data.file.do_index = GNUNET_YES;
976 ret->data.file.have_hash = GNUNET_YES;
977 ret->data.file.index_start_confirmed = GNUNET_YES;
978 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
979 ret->data.file.reader_cls =
980 GNUNET_FS_make_file_reader_context_ (ret->filename);
982 case 4: /* directory */
983 ret->is_directory = GNUNET_YES;
984 if ((GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dsize)) ||
985 (NULL == (ret->data.dir.dir_data = GNUNET_malloc_large (dsize))) ||
987 GNUNET_BIO_read (rh, "dir-data", ret->data.dir.dir_data, dsize)) ||
989 GNUNET_BIO_read_string (rh, "ent-filename", &filename, 16 * 1024)))
994 ret->data.dir.dir_size = (uint32_t) dsize;
995 if (NULL != filename)
997 ret->data.dir.entries = deserialize_file_information (h, filename);
998 GNUNET_free (filename);
1000 nxt = ret->data.dir.entries;
1012 ret->serialization = GNUNET_strdup (fn);
1014 GNUNET_BIO_read_string (rh, "nxt-filename", &filename, 16 * 1024))
1019 if (NULL != filename)
1021 ret->next = deserialize_file_information (h, filename);
1022 GNUNET_free (filename);
1025 GNUNET_free_non_null (ksks);
1026 GNUNET_free_non_null (chks);
1029 GNUNET_free_non_null (ksks);
1030 GNUNET_free_non_null (chks);
1031 GNUNET_free_non_null (filename);
1032 GNUNET_FS_file_information_destroy (ret, NULL, NULL);
1038 * Using the given serialization filename, try to deserialize
1039 * the file-information tree associated with it.
1041 * @param h master context
1042 * @param filename name of the file (without directory) with
1044 * @return NULL on error
1046 static struct GNUNET_FS_FileInformation *
1047 deserialize_file_information (struct GNUNET_FS_Handle *h,
1048 const char *filename)
1050 struct GNUNET_FS_FileInformation *ret;
1051 struct GNUNET_BIO_ReadHandle *rh;
1055 rh = get_read_handle (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
1058 ret = deserialize_fi_node (h, filename, rh);
1059 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1061 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1062 _("Failed to resume publishing information `%s': %s\n"),
1068 fn = get_serialization_file_name (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
1071 if (0 != UNLINK (fn))
1072 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1081 * Given a serialization name (full absolute path), return the
1082 * basename of the file (without the path), which must only
1083 * consist of the 6 random characters.
1085 * @param fullname name to extract the basename from
1086 * @return copy of the basename, NULL on error
1089 get_serialization_short_name (const char *fullname)
1096 /* FIXME: we could do this faster since we know
1097 * the length of 'end'... */
1098 while ('\0' != *nxt)
1100 if (DIR_SEPARATOR == *nxt)
1104 if ((NULL == end) || (0 == strlen (end)))
1109 GNUNET_break (6 == strlen (end));
1110 return GNUNET_strdup (end);
1115 * Create a new random name for serialization. Also checks if persistence
1116 * is enabled and returns NULL if not.
1118 * @param h master context
1119 * @param ext component of the path
1120 * @return NULL on errror
1123 make_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext)
1129 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1130 return NULL; /* persistence not requested */
1131 dn = get_serialization_file_name (h, ext, "");
1134 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1139 fn = GNUNET_DISK_mktemp (dn);
1142 return NULL; /* epic fail */
1143 ret = get_serialization_short_name (fn);
1150 * Create a new random name for serialization. Also checks if persistence
1151 * is enabled and returns NULL if not.
1153 * @param h master context
1154 * @param ext component of the path
1155 * @param uni name of parent
1156 * @return NULL on errror
1159 make_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h,
1160 const char *ext, const char *uni)
1166 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1167 return NULL; /* persistence not requested */
1168 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
1171 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1176 fn = GNUNET_DISK_mktemp (dn);
1179 return NULL; /* epic fail */
1180 ret = get_serialization_short_name (fn);
1187 * Copy all of the data from the reader to the write handle.
1189 * @param wh write handle
1190 * @param fi file with reader
1191 * @return #GNUNET_OK on success
1194 copy_from_reader (struct GNUNET_BIO_WriteHandle *wh,
1195 struct GNUNET_FS_FileInformation *fi)
1197 char buf[32 * 1024];
1205 while (off < fi->data.file.file_size)
1207 left = GNUNET_MIN (sizeof (buf), fi->data.file.file_size - off);
1209 fi->data.file.reader (fi->data.file.reader_cls, off, left, buf, &emsg);
1213 return GNUNET_SYSERR;
1215 if (GNUNET_OK != GNUNET_BIO_write (wh, buf, ret))
1216 return GNUNET_SYSERR;
1224 * Create a temporary file on disk to store the current
1227 * @param fi file information to sync with disk
1230 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *fi)
1233 struct GNUNET_BIO_WriteHandle *wh;
1238 if (NULL == fi->serialization)
1240 make_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO);
1241 if (NULL == fi->serialization)
1243 wh = get_write_handle (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1247 GNUNET_free (fi->serialization);
1248 fi->serialization = NULL;
1251 if (GNUNET_YES == fi->is_directory)
1253 else if (GNUNET_YES == fi->data.file.index_start_confirmed)
1255 else if (GNUNET_YES == fi->data.file.have_hash)
1257 else if (GNUNET_YES == fi->data.file.do_index)
1261 if (NULL != fi->keywords)
1262 ksks = GNUNET_FS_uri_to_string (fi->keywords);
1265 if (NULL != fi->chk_uri)
1266 chks = GNUNET_FS_uri_to_string (fi->chk_uri);
1269 if ((GNUNET_OK != GNUNET_BIO_write (wh, &b, sizeof (b))) ||
1270 (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, fi->meta)) ||
1271 (GNUNET_OK != GNUNET_BIO_write_string (wh, ksks)) ||
1272 (GNUNET_OK != GNUNET_BIO_write_string (wh, chks)) ||
1273 (GNUNET_OK != write_start_time (wh, fi->start_time)) ||
1274 (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->emsg)) ||
1275 (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->filename)) ||
1277 GNUNET_BIO_write_int64 (wh, fi->bo.expiration_time.abs_value_us)) ||
1278 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.anonymity_level)) ||
1279 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.content_priority)) ||
1280 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.replication_level)))
1285 GNUNET_free_non_null (chks);
1287 GNUNET_free_non_null (ksks);
1292 case 0: /* file-insert */
1293 if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1298 if ((GNUNET_NO == fi->is_published) && (NULL == fi->filename))
1299 if (GNUNET_OK != copy_from_reader (wh, fi))
1305 case 1: /* file-index, no hash */
1306 if (NULL == fi->filename)
1311 if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1317 case 2: /* file-index-with-hash */
1318 case 3: /* file-index-with-hash-confirmed */
1319 if (NULL == fi->filename)
1324 if ((GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size)) ||
1326 GNUNET_BIO_write (wh, &fi->data.file.file_id,
1327 sizeof (struct GNUNET_HashCode))))
1333 case 4: /* directory */
1334 if ( (NULL != fi->data.dir.entries) &&
1335 (NULL == fi->data.dir.entries->serialization) )
1336 GNUNET_FS_file_information_sync_ (fi->data.dir.entries);
1337 if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->data.dir.dir_size)) ||
1339 GNUNET_BIO_write (wh, fi->data.dir.dir_data,
1340 (uint32_t) fi->data.dir.dir_size)) ||
1342 GNUNET_BIO_write_string (wh,
1343 (fi->data.dir.entries ==
1344 NULL) ? NULL : fi->data.dir.
1345 entries->serialization)))
1355 if ( (NULL != fi->next) &&
1356 (NULL == fi->next->serialization) )
1357 GNUNET_FS_file_information_sync_ (fi->next);
1359 GNUNET_BIO_write_string (wh,
1361 NULL) ? fi->next->serialization : NULL))
1366 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1375 (void) GNUNET_BIO_write_close (wh);
1376 GNUNET_free_non_null (chks);
1377 GNUNET_free_non_null (ksks);
1378 fn = get_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1382 if (0 != UNLINK (fn))
1383 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1386 GNUNET_free (fi->serialization);
1387 fi->serialization = NULL;
1393 * Find the entry in the file information struct where the
1394 * serialization filename matches the given name.
1396 * @param pos file information to search
1397 * @param srch filename to search for
1398 * @return NULL if srch was not found in this subtree
1400 static struct GNUNET_FS_FileInformation *
1401 find_file_position (struct GNUNET_FS_FileInformation *pos,
1404 struct GNUNET_FS_FileInformation *r;
1408 if (0 == strcmp (srch, pos->serialization))
1410 if ( (GNUNET_YES == pos->is_directory) &&
1411 (NULL != (r = find_file_position (pos->data.dir.entries, srch))) )
1420 * Signal the FS's progress function that we are resuming
1423 * @param cls closure (of type `struct GNUNET_FS_PublishContext *`, for the parent (!))
1424 * @param fi the entry in the publish-structure
1425 * @param length length of the file or directory
1426 * @param meta metadata for the file or directory (can be modified)
1427 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1428 * @param bo block options (can be modified)
1429 * @param do_index should we index?
1430 * @param client_info pointer to client context set upon creation (can be modified)
1431 * @return #GNUNET_OK to continue (always)
1434 fip_signal_resume (void *cls, struct GNUNET_FS_FileInformation *fi,
1435 uint64_t length, struct GNUNET_CONTAINER_MetaData *meta,
1436 struct GNUNET_FS_Uri **uri,
1437 struct GNUNET_FS_BlockOptions *bo, int *do_index,
1440 struct GNUNET_FS_PublishContext *pc = cls;
1441 struct GNUNET_FS_ProgressInfo pi;
1443 if (GNUNET_YES == pc->skip_next_fi_callback)
1445 pc->skip_next_fi_callback = GNUNET_NO;
1448 pi.status = GNUNET_FS_STATUS_PUBLISH_RESUME;
1449 pi.value.publish.specifics.resume.message = fi->emsg;
1450 pi.value.publish.specifics.resume.chk_uri = fi->chk_uri;
1451 *client_info = GNUNET_FS_publish_make_status_ (&pi, pc, fi, 0);
1452 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (meta))
1454 /* process entries in directory */
1455 pc->skip_next_fi_callback = GNUNET_YES;
1456 GNUNET_FS_file_information_inspect (fi, &fip_signal_resume, pc);
1463 * Function called with a filename of serialized publishing operation
1466 * @param cls the `struct GNUNET_FS_Handle *`
1467 * @param filename complete filename (absolute path)
1468 * @return #GNUNET_OK (continue to iterate)
1471 deserialize_publish_file (void *cls, const char *filename)
1473 struct GNUNET_FS_Handle *h = cls;
1474 struct GNUNET_BIO_ReadHandle *rh;
1475 struct GNUNET_FS_PublishContext *pc;
1480 struct GNUNET_CRYPTO_EccPrivateKey ns;
1484 pc = GNUNET_new (struct GNUNET_FS_PublishContext);
1486 pc->serialization = get_serialization_short_name (filename);
1489 rh = GNUNET_BIO_read_open (filename);
1495 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-nid", &pc->nid, 1024))
1497 GNUNET_BIO_read_string (rh, "publish-nuid", &pc->nuid, 1024)) ||
1498 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
1499 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &all_done)) ||
1500 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &have_ns)) ||
1502 GNUNET_BIO_read_string (rh, "publish-firoot", &fi_root, 128)) ||
1503 (GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-fipos", &fi_pos, 128))
1504 || ( (GNUNET_YES == have_ns) &&
1505 (GNUNET_OK != GNUNET_BIO_read (rh, "publish-ns", &ns, sizeof (ns)))) )
1510 pc->options = options;
1511 pc->all_done = all_done;
1512 if (NULL == fi_root)
1517 pc->fi = deserialize_file_information (h, fi_root);
1523 if (GNUNET_YES == have_ns)
1525 pc->ns = GNUNET_new (struct GNUNET_CRYPTO_EccPrivateKey);
1528 if ((0 == (pc->options & GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY)) &&
1529 (GNUNET_YES != pc->all_done))
1531 pc->dsh = GNUNET_DATASTORE_connect (h->cfg);
1532 if (NULL == pc->dsh)
1537 pc->fi_pos = find_file_position (pc->fi, fi_pos);
1538 GNUNET_free (fi_pos);
1540 if (NULL == pc->fi_pos)
1542 /* failed to find position for resuming, outch! Will start from root! */
1544 if (GNUNET_YES != pc->all_done)
1545 pc->fi_pos = pc->fi;
1548 GNUNET_free (fi_root);
1550 /* generate RESUME event(s) */
1551 GNUNET_FS_file_information_inspect (pc->fi, &fip_signal_resume, pc);
1553 /* re-start publishing (if needed)... */
1554 if (GNUNET_YES != pc->all_done)
1556 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
1558 GNUNET_SCHEDULER_add_with_priority
1559 (GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
1560 &GNUNET_FS_publish_main_, pc);
1562 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1564 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1565 _("Failure while resuming publishing operation `%s': %s\n"),
1569 pc->top = GNUNET_FS_make_top (h, &GNUNET_FS_publish_signal_suspend_, pc);
1572 GNUNET_free_non_null (pc->nid);
1573 GNUNET_free_non_null (pc->nuid);
1574 GNUNET_free_non_null (fi_root);
1575 GNUNET_free_non_null (fi_pos);
1576 if ((NULL != rh) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
1578 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1579 _("Failed to resume publishing operation `%s': %s\n"), filename,
1584 GNUNET_FS_file_information_destroy (pc->fi, NULL, NULL);
1585 if (0 != UNLINK (filename))
1586 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
1587 GNUNET_free (pc->serialization);
1594 * Synchronize this publishing struct with its mirror
1595 * on disk. Note that all internal FS-operations that change
1596 * publishing structs should already call "sync" internally,
1597 * so this function is likely not useful for clients.
1599 * @param pc the struct to sync
1602 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc)
1604 struct GNUNET_BIO_WriteHandle *wh;
1607 if (NULL == pc->serialization)
1609 make_serialization_file_name (pc->h,
1610 GNUNET_FS_SYNC_PATH_MASTER_PUBLISH);
1611 if (NULL == pc->serialization)
1615 if (NULL == pc->fi->serialization)
1620 wh = get_write_handle (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1627 have_ns = (NULL != pc->ns) ? GNUNET_YES : GNUNET_NO;
1628 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nid)) ||
1629 (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nuid)) ||
1630 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->options)) ||
1631 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->all_done)) ||
1632 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, have_ns)) ||
1633 (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->fi->serialization)) ||
1635 GNUNET_BIO_write_string (wh,
1636 (NULL == pc->fi_pos) ? NULL : pc->fi_pos->serialization)) ||
1637 ( (NULL != pc->ns) &&
1638 (GNUNET_OK != GNUNET_BIO_write (wh,
1640 sizeof (struct GNUNET_CRYPTO_EccPrivateKey)) ) ))
1645 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1654 (void) GNUNET_BIO_write_close (wh);
1655 GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1657 GNUNET_free (pc->serialization);
1658 pc->serialization = NULL;
1663 * Synchronize this unindex struct with its mirror
1664 * on disk. Note that all internal FS-operations that change
1665 * publishing structs should already call "sync" internally,
1666 * so this function is likely not useful for clients.
1668 * @param uc the struct to sync
1671 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc)
1673 struct GNUNET_BIO_WriteHandle *wh;
1676 if (NULL == uc->serialization)
1678 make_serialization_file_name (uc->h,
1679 GNUNET_FS_SYNC_PATH_MASTER_UNINDEX);
1680 if (NULL == uc->serialization)
1682 wh = get_write_handle (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1689 if (NULL != uc->ksk_uri)
1690 uris = GNUNET_FS_uri_to_string (uc->ksk_uri);
1693 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uc->filename)) ||
1694 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, uc->file_size)) ||
1695 (GNUNET_OK != write_start_time (wh, uc->start_time)) ||
1696 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->state)) ||
1698 GNUNET_BIO_write (wh, &uc->chk, sizeof (struct ContentHashKey))) ||
1699 (GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1700 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->ksk_offset)) ||
1701 ((uc->state == UNINDEX_STATE_FS_NOTIFY) &&
1703 GNUNET_BIO_write (wh, &uc->file_id, sizeof (struct GNUNET_HashCode)))) ||
1704 ((uc->state == UNINDEX_STATE_ERROR) &&
1705 (GNUNET_OK != GNUNET_BIO_write_string (wh, uc->emsg))))
1710 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1719 (void) GNUNET_BIO_write_close (wh);
1720 GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1722 GNUNET_free (uc->serialization);
1723 uc->serialization = NULL;
1728 * Serialize a download request.
1730 * @param wh the `struct GNUNET_BIO_WriteHandle*`
1731 * @param dr the the request to write to disk
1732 * @return #GNUNET_YES on success, #GNUNET_NO on error
1735 write_download_request (struct GNUNET_BIO_WriteHandle *wh,
1736 struct DownloadRequest *dr)
1740 if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->state)) ||
1741 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dr->offset)) ||
1742 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->num_children)) ||
1743 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->depth)))
1745 if ((BRS_CHK_SET == dr->state) &&
1747 GNUNET_BIO_write (wh, &dr->chk, sizeof (struct ContentHashKey))))
1749 for (i = 0; i < dr->num_children; i++)
1750 if (GNUNET_NO == write_download_request (wh, dr->children[i]))
1757 * Read a download request tree.
1759 * @param rh mesh to read from
1760 * @return value the download request read from disk, NULL on error
1762 static struct DownloadRequest *
1763 read_download_request (struct GNUNET_BIO_ReadHandle *rh)
1765 struct DownloadRequest *dr;
1768 dr = GNUNET_malloc (sizeof (struct DownloadRequest));
1769 if ((GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->state)) ||
1770 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dr->offset)) ||
1771 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->num_children)) ||
1772 (dr->num_children > CHK_PER_INODE) ||
1773 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->depth)) || ((0 == dr->depth)
1777 ((dr->depth > 0) && (0 == dr->num_children)))
1780 dr->num_children = 0;
1783 if (dr->num_children > 0)
1785 GNUNET_malloc (dr->num_children * sizeof (struct DownloadRequest *));
1789 case BRS_RECONSTRUCT_DOWN:
1790 case BRS_RECONSTRUCT_META_UP:
1791 case BRS_RECONSTRUCT_UP:
1795 GNUNET_BIO_read (rh, "chk", &dr->chk, sizeof (struct ContentHashKey)))
1798 case BRS_DOWNLOAD_DOWN:
1799 case BRS_DOWNLOAD_UP:
1806 for (i = 0; i < dr->num_children; i++)
1808 if (NULL == (dr->children[i] = read_download_request (rh)))
1810 dr->children[i]->parent = dr;
1814 GNUNET_FS_free_download_request_ (dr);
1820 * Compute the name of the sync file (or directory) for the given download
1823 * @param dc download context to compute for
1824 * @param uni unique filename to use, use "" for the directory name
1825 * @param ext extension to use, use ".dir" for our own subdirectory
1826 * @return the expanded file name, NULL for none
1829 get_download_sync_filename (struct GNUNET_FS_DownloadContext *dc,
1830 const char *uni, const char *ext)
1835 if (dc->parent == NULL)
1836 return get_serialization_file_name (dc->h,
1837 (dc->search != NULL) ?
1838 GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD :
1839 GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
1841 if (NULL == dc->parent->serialization)
1843 par = get_download_sync_filename (dc->parent, dc->parent->serialization, "");
1846 GNUNET_asprintf (&epar, "%s.dir%s%s%s", par, DIR_SEPARATOR_STR, uni, ext);
1853 * Synchronize this download struct with its mirror
1854 * on disk. Note that all internal FS-operations that change
1855 * publishing structs should already call "sync" internally,
1856 * so this function is likely not useful for clients.
1858 * @param dc the struct to sync
1861 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc)
1863 struct GNUNET_BIO_WriteHandle *wh;
1868 if (0 != (dc->options & GNUNET_FS_DOWNLOAD_IS_PROBE))
1869 return; /* we don't sync probes */
1870 if (NULL == dc->serialization)
1872 dir = get_download_sync_filename (dc, "", "");
1875 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dir))
1880 fn = GNUNET_DISK_mktemp (dir);
1884 dc->serialization = get_serialization_short_name (fn);
1888 fn = get_download_sync_filename (dc, dc->serialization, "");
1891 GNUNET_free (dc->serialization);
1892 dc->serialization = NULL;
1897 wh = GNUNET_BIO_write_open (fn);
1900 GNUNET_free (dc->serialization);
1901 dc->serialization = NULL;
1905 GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_chk (dc->uri)) ||
1906 (GNUNET_YES == GNUNET_FS_uri_test_loc (dc->uri)));
1907 uris = GNUNET_FS_uri_to_string (dc->uri);
1908 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1909 (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, dc->meta)) ||
1910 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->emsg)) ||
1911 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->filename)) ||
1912 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->temp_filename)) ||
1913 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->old_file_size)) ||
1914 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->offset)) ||
1915 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->length)) ||
1916 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->completed)) ||
1917 (GNUNET_OK != write_start_time (wh, dc->start_time)) ||
1918 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dc->anonymity)) ||
1919 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->options)) ||
1920 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->has_finished)))
1925 if (NULL == dc->emsg)
1927 GNUNET_assert (dc->top_request != NULL);
1928 if (GNUNET_YES != write_download_request (wh, dc->top_request))
1934 GNUNET_free_non_null (uris);
1936 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1946 (void) GNUNET_BIO_write_close (wh);
1947 GNUNET_free_non_null (uris);
1948 if (0 != UNLINK (fn))
1949 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1951 GNUNET_free (dc->serialization);
1952 dc->serialization = NULL;
1957 * Synchronize this search result with its mirror
1958 * on disk. Note that all internal FS-operations that change
1959 * publishing structs should already call "sync" internally,
1960 * so this function is likely not useful for clients.
1962 * @param sr the struct to sync
1965 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr)
1967 struct GNUNET_BIO_WriteHandle *wh;
1973 if (NULL == sr->serialization)
1975 make_serialization_file_name_in_dir (sr->h,
1976 (sr->sc->psearch_result ==
1978 GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1979 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1980 sr->sc->serialization);
1981 if (NULL == sr->serialization)
1983 wh = get_write_handle_in_dir (sr->h,
1984 (sr->sc->psearch_result ==
1985 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1986 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1987 sr->sc->serialization, sr->serialization);
1993 uris = GNUNET_FS_uri_to_string (sr->uri);
1994 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1996 GNUNET_BIO_write_string (wh,
1998 NULL ? sr->download->serialization : NULL)) ||
2000 GNUNET_BIO_write_string (wh,
2001 sr->update_search !=
2002 NULL ? sr->update_search->serialization : NULL))
2003 || (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, sr->meta)) ||
2004 (GNUNET_OK != GNUNET_BIO_write (wh, &sr->key, sizeof (struct GNUNET_HashCode)))
2005 || (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->mandatory_missing)) ||
2006 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->optional_support)) ||
2007 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_success)) ||
2008 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_trials)) )
2013 if ( (NULL != sr->uri) &&
2014 (GNUNET_FS_URI_KSK == sr->sc->uri->type) &&
2015 (GNUNET_OK != GNUNET_BIO_write (wh, sr->keyword_bitmap,
2016 (sr->sc->uri->data.ksk.keywordCount + 7) / 8)) )
2021 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
2027 GNUNET_free_non_null (uris);
2030 GNUNET_free_non_null (uris);
2032 (void) GNUNET_BIO_write_close (wh);
2033 remove_sync_file_in_dir (sr->h,
2034 (NULL == sr->sc->psearch_result)
2035 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2036 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2037 sr->sc->serialization, sr->serialization);
2038 GNUNET_free (sr->serialization);
2039 sr->serialization = NULL;
2044 * Synchronize this search struct with its mirror
2045 * on disk. Note that all internal FS-operations that change
2046 * publishing structs should already call "sync" internally,
2047 * so this function is likely not useful for clients.
2049 * @param sc the struct to sync
2052 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc)
2054 struct GNUNET_BIO_WriteHandle *wh;
2057 const char *category;
2060 (NULL == sc->psearch_result)
2061 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2062 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH;
2063 if (NULL == sc->serialization)
2064 sc->serialization = make_serialization_file_name (sc->h, category);
2065 if (NULL == sc->serialization)
2068 wh = get_write_handle (sc->h, category, sc->serialization);
2074 GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_ksk (sc->uri)) ||
2075 (GNUNET_YES == GNUNET_FS_uri_test_sks (sc->uri)));
2076 uris = GNUNET_FS_uri_to_string (sc->uri);
2077 in_pause = (sc->task != GNUNET_SCHEDULER_NO_TASK) ? 'r' : '\0';
2078 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
2079 (GNUNET_OK != write_start_time (wh, sc->start_time)) ||
2080 (GNUNET_OK != GNUNET_BIO_write_string (wh, sc->emsg)) ||
2081 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) sc->options)) ||
2082 (GNUNET_OK != GNUNET_BIO_write (wh, &in_pause, sizeof (in_pause))) ||
2083 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sc->anonymity)))
2090 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
2099 (void) GNUNET_BIO_write_close (wh);
2100 GNUNET_free_non_null (uris);
2101 GNUNET_FS_remove_sync_file_ (sc->h, category, sc->serialization);
2102 GNUNET_free (sc->serialization);
2103 sc->serialization = NULL;
2108 * Function called with a filename of serialized unindexing operation
2111 * @param cls the 'struct GNUNET_FS_Handle*'
2112 * @param filename complete filename (absolute path)
2113 * @return GNUNET_OK (continue to iterate)
2116 deserialize_unindex_file (void *cls, const char *filename)
2118 struct GNUNET_FS_Handle *h = cls;
2119 struct GNUNET_BIO_ReadHandle *rh;
2120 struct GNUNET_FS_UnindexContext *uc;
2121 struct GNUNET_FS_ProgressInfo pi;
2126 uc = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
2128 uc->serialization = get_serialization_short_name (filename);
2129 rh = GNUNET_BIO_read_open (filename);
2137 GNUNET_BIO_read_string (rh, "unindex-fn", &uc->filename, 10 * 1024)) ||
2138 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &uc->file_size)) ||
2139 (GNUNET_OK != read_start_time (rh, &uc->start_time)) ||
2140 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &state)) ||
2141 (GNUNET_OK != GNUNET_BIO_read (rh, "uri", &uc->chk, sizeof (struct ContentHashKey))) ||
2142 (GNUNET_OK != GNUNET_BIO_read_string (rh, "unindex-kskuri", &uris, 10 * 1024)) ||
2143 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &uc->ksk_offset)) )
2145 GNUNET_free_non_null (uris);
2151 uc->ksk_uri = GNUNET_FS_uri_parse (uris, &emsg);
2153 if (NULL == uc->ksk_uri)
2156 GNUNET_free_non_null (emsg);
2160 if ( (uc->ksk_offset > 0) &&
2161 ( (NULL == uc->ksk_uri) ||
2162 (uc->ksk_offset > uc->ksk_uri->data.ksk.keywordCount) ) )
2167 uc->state = (enum UnindexState) state;
2170 case UNINDEX_STATE_HASHING:
2172 case UNINDEX_STATE_FS_NOTIFY:
2174 GNUNET_BIO_read (rh, "unindex-hash", &uc->file_id,
2175 sizeof (struct GNUNET_HashCode)))
2181 case UNINDEX_STATE_DS_REMOVE:
2182 case UNINDEX_STATE_EXTRACT_KEYWORDS:
2183 case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2185 case UNINDEX_STATE_COMPLETE:
2187 case UNINDEX_STATE_ERROR:
2189 GNUNET_BIO_read_string (rh, "unindex-emsg", &uc->emsg, 10 * 1024))
2199 uc->top = GNUNET_FS_make_top (h, &GNUNET_FS_unindex_signal_suspend_, uc);
2200 pi.status = GNUNET_FS_STATUS_UNINDEX_RESUME;
2201 pi.value.unindex.specifics.resume.message = uc->emsg;
2202 GNUNET_FS_unindex_make_status_ (&pi, uc,
2204 UNINDEX_STATE_COMPLETE) ? uc->file_size : 0);
2207 case UNINDEX_STATE_HASHING:
2209 GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE, uc->filename,
2211 &GNUNET_FS_unindex_process_hash_, uc);
2213 case UNINDEX_STATE_FS_NOTIFY:
2214 uc->state = UNINDEX_STATE_HASHING;
2215 GNUNET_FS_unindex_process_hash_ (uc, &uc->file_id);
2217 case UNINDEX_STATE_DS_REMOVE:
2218 GNUNET_FS_unindex_do_remove_ (uc);
2220 case UNINDEX_STATE_EXTRACT_KEYWORDS:
2221 GNUNET_FS_unindex_do_extract_keywords_ (uc);
2223 case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2224 GNUNET_FS_unindex_do_remove_kblocks_ (uc);
2226 case UNINDEX_STATE_COMPLETE:
2227 case UNINDEX_STATE_ERROR:
2228 /* no need to resume any operation, we were done */
2233 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2235 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2236 _("Failure while resuming unindexing operation `%s': %s\n"),
2242 GNUNET_free_non_null (uc->filename);
2243 if ((NULL != rh) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
2245 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2246 _("Failed to resume unindexing operation `%s': %s\n"), filename,
2250 if (NULL != uc->serialization)
2251 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2253 GNUNET_free_non_null (uc->serialization);
2260 * Deserialize a download.
2262 * @param h overall context
2263 * @param rh file to deserialize from
2264 * @param parent parent download
2265 * @param search associated search
2266 * @param serialization name under which the search was serialized
2269 deserialize_download (struct GNUNET_FS_Handle *h,
2270 struct GNUNET_BIO_ReadHandle *rh,
2271 struct GNUNET_FS_DownloadContext *parent,
2272 struct GNUNET_FS_SearchResult *search,
2273 const char *serialization);
2277 * Deserialize a search.
2279 * @param h overall context
2280 * @param rh file to deserialize from
2281 * @param psearch_result parent search result
2282 * @param serialization name under which the search was serialized
2284 static struct GNUNET_FS_SearchContext *
2285 deserialize_search (struct GNUNET_FS_Handle *h,
2286 struct GNUNET_BIO_ReadHandle *rh,
2287 struct GNUNET_FS_SearchResult *psearch_result,
2288 const char *serialization);
2292 * Function called with a filename of serialized search result
2295 * @param cls the 'struct GNUNET_FS_SearchContext*'
2296 * @param filename complete filename (absolute path)
2297 * @return GNUNET_OK (continue to iterate)
2300 deserialize_search_result (void *cls, const char *filename)
2302 struct GNUNET_FS_SearchContext *sc = cls;
2308 struct GNUNET_BIO_ReadHandle *rh;
2309 struct GNUNET_BIO_ReadHandle *drh;
2310 struct GNUNET_FS_SearchResult *sr;
2312 ser = get_serialization_short_name (filename);
2313 rh = GNUNET_BIO_read_open (filename);
2318 remove_sync_file_in_dir (sc->h,
2319 (NULL == sc->psearch_result)
2320 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2321 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2322 sc->serialization, ser);
2331 sr = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchResult));
2334 sr->serialization = ser;
2335 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "result-uri", &uris, 10 * 1024))
2336 || (NULL == (sr->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2337 (GNUNET_OK != GNUNET_BIO_read_string (rh, "download-lnk", &download, 16))
2339 GNUNET_BIO_read_string (rh, "search-lnk", &update_srch, 16)) ||
2340 (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "result-meta", &sr->meta)) ||
2342 GNUNET_BIO_read (rh, "result-key", &sr->key, sizeof (struct GNUNET_HashCode)))
2343 || (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->mandatory_missing)) ||
2344 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->optional_support)) ||
2345 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_success)) ||
2346 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_trials)))
2351 if (GNUNET_FS_URI_KSK == sr->sc->uri->type)
2353 sr->keyword_bitmap = GNUNET_malloc ((sr->sc->uri->data.ksk.keywordCount + 7) / 8); /* round up, count bits */
2354 if (GNUNET_OK != GNUNET_BIO_read (rh, "keyword-bitmap",
2356 (sr->sc->uri->data.ksk.keywordCount + 7) / 8))
2363 if (NULL != download)
2365 drh = get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD, download);
2368 deserialize_download (sc->h, drh, NULL, sr, download);
2369 if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2371 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2372 _("Failed to resume sub-download `%s': %s\n"), download,
2377 GNUNET_free (download);
2379 if (NULL != update_srch)
2382 get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_SEARCH, update_srch);
2385 deserialize_search (sc->h, drh, sr, update_srch);
2386 if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2388 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2389 _("Failed to resume sub-search `%s': %s\n"), update_srch,
2394 GNUNET_free (update_srch);
2396 GNUNET_break (GNUNET_YES ==
2397 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &sr->key, sr,
2398 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
2399 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2401 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2402 _("Failure while resuming search operation `%s': %s\n"),
2408 GNUNET_free_non_null (download);
2409 GNUNET_free_non_null (emsg);
2410 GNUNET_free_non_null (uris);
2411 GNUNET_free_non_null (update_srch);
2412 if (NULL != sr->uri)
2413 GNUNET_FS_uri_destroy (sr->uri);
2414 if (NULL != sr->meta)
2415 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2416 GNUNET_free (sr->serialization);
2418 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2420 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2421 _("Failure while resuming search operation `%s': %s\n"),
2430 * Send the 'resume' signal to the callback; also actually
2431 * resume the download (put it in the queue). Does this
2432 * recursively for the top-level download and all child
2435 * @param dc download to resume
2438 signal_download_resume (struct GNUNET_FS_DownloadContext *dc)
2440 struct GNUNET_FS_DownloadContext *dcc;
2441 struct GNUNET_FS_ProgressInfo pi;
2443 pi.status = GNUNET_FS_STATUS_DOWNLOAD_RESUME;
2444 pi.value.download.specifics.resume.meta = dc->meta;
2445 pi.value.download.specifics.resume.message = dc->emsg;
2446 GNUNET_FS_download_make_status_ (&pi, dc);
2447 dcc = dc->child_head;
2450 signal_download_resume (dcc);
2453 if (NULL != dc->pending_head)
2454 GNUNET_FS_download_start_downloading_ (dc);
2459 * Signal resuming of a search to our clients (for the
2460 * top level search and all sub-searches).
2462 * @param sc search being resumed
2465 signal_search_resume (struct GNUNET_FS_SearchContext *sc);
2469 * Iterator over search results signaling resume to the client for
2472 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2473 * @param key current key code
2474 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2475 * @return GNUNET_YES (we should continue to iterate)
2478 signal_result_resume (void *cls, const struct GNUNET_HashCode * key, void *value)
2480 struct GNUNET_FS_SearchContext *sc = cls;
2481 struct GNUNET_FS_ProgressInfo pi;
2482 struct GNUNET_FS_SearchResult *sr = value;
2484 if (0 == sr->mandatory_missing)
2486 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME_RESULT;
2487 pi.value.search.specifics.resume_result.meta = sr->meta;
2488 pi.value.search.specifics.resume_result.uri = sr->uri;
2489 pi.value.search.specifics.resume_result.result = sr;
2490 pi.value.search.specifics.resume_result.availability_rank =
2491 2 * sr->availability_success - sr->availability_trials;
2492 pi.value.search.specifics.resume_result.availability_certainty =
2493 sr->availability_trials;
2494 pi.value.search.specifics.resume_result.applicability_rank =
2495 sr->optional_support;
2496 sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
2498 if (NULL != sr->download)
2500 signal_download_resume (sr->download);
2504 GNUNET_FS_search_start_probe_ (sr);
2506 if (NULL != sr->update_search)
2507 signal_search_resume (sr->update_search);
2513 * Free memory allocated by the search context and its children
2515 * @param sc search context to free
2518 free_search_context (struct GNUNET_FS_SearchContext *sc);
2522 * Iterator over search results freeing each.
2524 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2525 * @param key current key code
2526 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2527 * @return GNUNET_YES (we should continue to iterate)
2530 free_result (void *cls, const struct GNUNET_HashCode * key, void *value)
2532 struct GNUNET_FS_SearchResult *sr = value;
2534 if (NULL != sr->update_search)
2536 free_search_context (sr->update_search);
2537 GNUNET_assert (NULL == sr->update_search);
2539 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2540 GNUNET_FS_uri_destroy (sr->uri);
2547 * Free memory allocated by the search context and its children
2549 * @param sc search context to free
2552 free_search_context (struct GNUNET_FS_SearchContext *sc)
2554 if (NULL != sc->serialization)
2556 GNUNET_FS_remove_sync_file_ (sc->h,
2557 (sc->psearch_result ==
2558 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2559 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2561 GNUNET_FS_remove_sync_dir_ (sc->h,
2562 (sc->psearch_result ==
2563 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2564 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2567 GNUNET_free_non_null (sc->serialization);
2568 GNUNET_free_non_null (sc->emsg);
2569 if (NULL != sc->uri)
2570 GNUNET_FS_uri_destroy (sc->uri);
2571 if (NULL != sc->master_result_map)
2573 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map, &free_result,
2575 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
2582 * Function called with a filename of serialized sub-download
2585 * @param cls the 'struct GNUNET_FS_DownloadContext*' (parent)
2586 * @param filename complete filename (absolute path)
2587 * @return GNUNET_OK (continue to iterate)
2590 deserialize_subdownload (void *cls, const char *filename)
2592 struct GNUNET_FS_DownloadContext *parent = cls;
2595 struct GNUNET_BIO_ReadHandle *rh;
2597 ser = get_serialization_short_name (filename);
2598 rh = GNUNET_BIO_read_open (filename);
2601 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2603 ("Failed to resume sub-download `%s': could not open file `%s'\n"),
2608 deserialize_download (parent->h, rh, parent, NULL, ser);
2609 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2611 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2612 _("Failed to resume sub-download `%s': %s\n"), ser, emsg);
2621 * Free this download context and all of its descendants.
2622 * (only works during deserialization since not all possible
2623 * state it taken care of).
2625 * @param dc context to free
2628 free_download_context (struct GNUNET_FS_DownloadContext *dc)
2630 struct GNUNET_FS_DownloadContext *dcc;
2632 if (NULL != dc->meta)
2633 GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2634 if (NULL != dc->uri)
2635 GNUNET_FS_uri_destroy (dc->uri);
2636 GNUNET_free_non_null (dc->temp_filename);
2637 GNUNET_free_non_null (dc->emsg);
2638 GNUNET_free_non_null (dc->filename);
2639 GNUNET_free_non_null (dc->serialization);
2640 while (NULL != (dcc = dc->child_head))
2642 GNUNET_CONTAINER_DLL_remove (dc->child_head, dc->child_tail, dcc);
2643 free_download_context (dcc);
2645 GNUNET_FS_free_download_request_ (dc->top_request);
2646 if (NULL != dc->active)
2647 GNUNET_CONTAINER_multihashmap_destroy (dc->active);
2653 * Deserialize a download.
2655 * @param h overall context
2656 * @param rh file to deserialize from
2657 * @param parent parent download
2658 * @param search associated search
2659 * @param serialization name under which the search was serialized
2662 deserialize_download (struct GNUNET_FS_Handle *h,
2663 struct GNUNET_BIO_ReadHandle *rh,
2664 struct GNUNET_FS_DownloadContext *parent,
2665 struct GNUNET_FS_SearchResult *search,
2666 const char *serialization)
2668 struct GNUNET_FS_DownloadContext *dc;
2677 dc = GNUNET_malloc (sizeof (struct GNUNET_FS_DownloadContext));
2678 dc->parent = parent;
2680 dc->serialization = GNUNET_strdup (serialization);
2682 GNUNET_BIO_read_string (rh, "download-uri", &uris, 10 * 1024)) ||
2683 (NULL == (dc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2684 ((GNUNET_YES != GNUNET_FS_uri_test_chk (dc->uri)) &&
2685 (GNUNET_YES != GNUNET_FS_uri_test_loc (dc->uri))) ||
2686 (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "download-meta", &dc->meta))
2688 GNUNET_BIO_read_string (rh, "download-emsg", &dc->emsg, 10 * 1024)) ||
2690 GNUNET_BIO_read_string (rh, "download-fn", &dc->filename, 10 * 1024)) ||
2692 GNUNET_BIO_read_string (rh, "download-tfn", &dc->temp_filename,
2694 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->old_file_size)) ||
2695 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->offset)) ||
2696 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->length)) ||
2697 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->completed)) ||
2698 (GNUNET_OK != read_start_time (rh, &dc->start_time)) ||
2699 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dc->anonymity)) ||
2700 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2701 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &status)))
2706 dc->options = (enum GNUNET_FS_DownloadOptions) options;
2708 GNUNET_CONTAINER_multihashmap_create (1 + 2 * (dc->length / DBLOCK_SIZE), GNUNET_NO);
2709 dc->has_finished = (int) status;
2711 GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size (dc->uri));
2712 if (GNUNET_FS_uri_test_loc (dc->uri))
2713 GNUNET_assert (GNUNET_OK ==
2714 GNUNET_FS_uri_loc_get_peer_identity (dc->uri, &dc->target));
2715 if (NULL == dc->emsg)
2717 dc->top_request = read_download_request (rh);
2718 if (NULL == dc->top_request)
2724 dn = get_download_sync_filename (dc, dc->serialization, ".dir");
2727 if (GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES))
2728 GNUNET_DISK_directory_scan (dn, &deserialize_subdownload, dc);
2733 GNUNET_CONTAINER_DLL_insert (parent->child_head, parent->child_tail, dc);
2737 dc->search = search;
2738 search->download = dc;
2740 if ((NULL == parent) && (NULL == search))
2743 GNUNET_FS_make_top (dc->h, &GNUNET_FS_download_signal_suspend_, dc);
2744 signal_download_resume (dc);
2747 dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_, dc);
2750 GNUNET_free_non_null (uris);
2751 GNUNET_free_non_null (emsg);
2752 free_download_context (dc);
2757 * Signal resuming of a search to our clients (for the
2758 * top level search and all sub-searches).
2760 * @param sc search being resumed
2763 signal_search_resume (struct GNUNET_FS_SearchContext *sc)
2765 struct GNUNET_FS_ProgressInfo pi;
2767 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME;
2768 pi.value.search.specifics.resume.message = sc->emsg;
2769 pi.value.search.specifics.resume.is_paused =
2770 (NULL == sc->client) ? GNUNET_YES : GNUNET_NO;
2771 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
2772 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2773 &signal_result_resume, sc);
2779 * Deserialize a search.
2781 * @param h overall context
2782 * @param rh file to deserialize from
2783 * @param psearch_result parent search result
2784 * @param serialization name under which the search was serialized
2786 static struct GNUNET_FS_SearchContext *
2787 deserialize_search (struct GNUNET_FS_Handle *h,
2788 struct GNUNET_BIO_ReadHandle *rh,
2789 struct GNUNET_FS_SearchResult *psearch_result,
2790 const char *serialization)
2792 struct GNUNET_FS_SearchContext *sc;
2799 if ((NULL != psearch_result) && (NULL != psearch_result->update_search))
2806 sc = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchContext));
2807 if (NULL != psearch_result)
2809 sc->psearch_result = psearch_result;
2810 psearch_result->update_search = sc;
2813 sc->serialization = GNUNET_strdup (serialization);
2814 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "search-uri", &uris, 10 * 1024))
2815 || (NULL == (sc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2816 ((GNUNET_YES != GNUNET_FS_uri_test_ksk (sc->uri)) &&
2817 (GNUNET_YES != GNUNET_FS_uri_test_sks (sc->uri))) ||
2818 (GNUNET_OK != read_start_time (rh, &sc->start_time)) ||
2820 GNUNET_BIO_read_string (rh, "search-emsg", &sc->emsg, 10 * 1024)) ||
2821 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2823 GNUNET_BIO_read (rh, "search-pause", &in_pause, sizeof (in_pause))) ||
2824 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sc->anonymity)))
2829 sc->options = (enum GNUNET_FS_SearchOptions) options;
2830 sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_NO);
2831 dn = get_serialization_file_name_in_dir (h,
2832 (sc->psearch_result ==
2834 GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2835 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2836 sc->serialization, "");
2839 if (GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES))
2840 GNUNET_DISK_directory_scan (dn, &deserialize_search_result, sc);
2843 if (('\0' == in_pause) &&
2844 (GNUNET_OK != GNUNET_FS_search_start_searching_ (sc)))
2846 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2848 ("Could not resume running search, will resume as paused search\n"));
2850 signal_search_resume (sc);
2854 GNUNET_free_non_null (emsg);
2855 free_search_context (sc);
2856 GNUNET_free_non_null (uris);
2862 * Function called with a filename of serialized search operation
2865 * @param cls the 'struct GNUNET_FS_Handle*'
2866 * @param filename complete filename (absolute path)
2867 * @return GNUNET_OK (continue to iterate)
2870 deserialize_search_file (void *cls, const char *filename)
2872 struct GNUNET_FS_Handle *h = cls;
2875 struct GNUNET_BIO_ReadHandle *rh;
2876 struct GNUNET_FS_SearchContext *sc;
2879 if (0 != STAT (filename, &buf))
2881 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "stat", filename);
2884 if (S_ISDIR (buf.st_mode))
2885 return GNUNET_OK; /* skip directories */
2886 ser = get_serialization_short_name (filename);
2887 rh = GNUNET_BIO_read_open (filename);
2892 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_SEARCH, ser);
2897 sc = deserialize_search (h, rh, NULL, ser);
2899 sc->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, sc);
2901 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2903 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2904 _("Failure while resuming search operation `%s': %s\n"),
2913 * Function called with a filename of serialized download operation
2916 * @param cls the 'struct GNUNET_FS_Handle*'
2917 * @param filename complete filename (absolute path)
2918 * @return GNUNET_OK (continue to iterate)
2921 deserialize_download_file (void *cls, const char *filename)
2923 struct GNUNET_FS_Handle *h = cls;
2926 struct GNUNET_BIO_ReadHandle *rh;
2928 ser = get_serialization_short_name (filename);
2929 rh = GNUNET_BIO_read_open (filename);
2932 if (0 != UNLINK (filename))
2933 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
2937 deserialize_download (h, rh, NULL, NULL, ser);
2939 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2941 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2942 _("Failure while resuming download operation `%s': %s\n"),
2951 * Deserialize informatin about pending operations.
2953 * @param master_path which master directory should be scanned
2954 * @param proc function to call for each entry (will get 'h' for 'cls')
2955 * @param h the 'struct GNUNET_FS_Handle*'
2958 deserialization_master (const char *master_path, GNUNET_FileNameCallback proc,
2959 struct GNUNET_FS_Handle *h)
2963 dn = get_serialization_file_name (h, master_path, "");
2966 if (GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES))
2967 GNUNET_DISK_directory_scan (dn, proc, h);
2973 * Setup a connection to the file-sharing service.
2975 * @param cfg configuration to use
2976 * @param client_name unique identifier for this client
2977 * @param upcb function to call to notify about FS actions
2978 * @param upcb_cls closure for upcb
2979 * @param flags specific attributes for fs-operations
2980 * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
2981 * @return NULL on error
2983 struct GNUNET_FS_Handle *
2984 GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
2985 const char *client_name, GNUNET_FS_ProgressCallback upcb,
2986 void *upcb_cls, enum GNUNET_FS_Flags flags, ...)
2988 struct GNUNET_FS_Handle *ret;
2989 enum GNUNET_FS_OPTIONS opt;
2992 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Handle));
2994 ret->client_name = GNUNET_strdup (client_name);
2996 ret->upcb_cls = upcb_cls;
2998 ret->max_parallel_downloads = DEFAULT_MAX_PARALLEL_DOWNLOADS;
2999 ret->max_parallel_requests = DEFAULT_MAX_PARALLEL_REQUESTS;
3000 ret->avg_block_latency = GNUNET_TIME_UNIT_MINUTES; /* conservative starting point */
3001 va_start (ap, flags);
3002 while (GNUNET_FS_OPTIONS_END != (opt = va_arg (ap, enum GNUNET_FS_OPTIONS)))
3006 case GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM:
3007 ret->max_parallel_downloads = va_arg (ap, unsigned int);
3010 case GNUNET_FS_OPTIONS_REQUEST_PARALLELISM:
3011 ret->max_parallel_requests = va_arg (ap, unsigned int);
3016 GNUNET_free (ret->client_name);
3023 if (0 != (GNUNET_FS_FLAGS_PERSISTENCE & flags))
3025 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
3026 &deserialize_publish_file, ret);
3027 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
3028 &deserialize_search_file, ret);
3029 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
3030 &deserialize_download_file, ret);
3031 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
3032 &deserialize_unindex_file, ret);
3039 * Close our connection with the file-sharing service.
3040 * The callback given to GNUNET_FS_start will no longer be
3041 * called after this function returns.
3043 * @param h handle that was returned from GNUNET_FS_start
3046 GNUNET_FS_stop (struct GNUNET_FS_Handle *h)
3048 while (h->top_head != NULL)
3049 h->top_head->ssf (h->top_head->ssf_cls);
3050 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
3051 GNUNET_SCHEDULER_cancel (h->queue_job);
3052 GNUNET_free (h->client_name);