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)
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)
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_malloc (sizeof (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);
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))
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)) ||
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, const char *filename)
1049 struct GNUNET_FS_FileInformation *ret;
1050 struct GNUNET_BIO_ReadHandle *rh;
1054 rh = get_read_handle (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
1057 ret = deserialize_fi_node (h, filename, rh);
1058 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1060 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1061 _("Failed to resume publishing information `%s': %s\n"),
1067 fn = get_serialization_file_name (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
1070 if (0 != UNLINK (fn))
1071 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1080 * Given a serialization name (full absolute path), return the
1081 * basename of the file (without the path), which must only
1082 * consist of the 6 random characters.
1084 * @param fullname name to extract the basename from
1085 * @return copy of the basename, NULL on error
1088 get_serialization_short_name (const char *fullname)
1095 /* FIXME: we could do this faster since we know
1096 * the length of 'end'... */
1097 while ('\0' != *nxt)
1099 if (DIR_SEPARATOR == *nxt)
1103 if ((NULL == end) || (0 == strlen (end)))
1108 GNUNET_break (6 == strlen (end));
1109 return GNUNET_strdup (end);
1114 * Create a new random name for serialization. Also checks if persistence
1115 * is enabled and returns NULL if not.
1117 * @param h master context
1118 * @param ext component of the path
1119 * @return NULL on errror
1122 make_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext)
1128 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1129 return NULL; /* persistence not requested */
1130 dn = get_serialization_file_name (h, ext, "");
1133 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1138 fn = GNUNET_DISK_mktemp (dn);
1141 return NULL; /* epic fail */
1142 ret = get_serialization_short_name (fn);
1149 * Create a new random name for serialization. Also checks if persistence
1150 * is enabled and returns NULL if not.
1152 * @param h master context
1153 * @param ext component of the path
1154 * @param uni name of parent
1155 * @return NULL on errror
1158 make_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h,
1159 const char *ext, const char *uni)
1165 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1166 return NULL; /* persistence not requested */
1167 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
1170 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1175 fn = GNUNET_DISK_mktemp (dn);
1178 return NULL; /* epic fail */
1179 ret = get_serialization_short_name (fn);
1186 * Copy all of the data from the reader to the write handle.
1188 * @param wh write handle
1189 * @param fi file with reader
1190 * @return GNUNET_OK on success
1193 copy_from_reader (struct GNUNET_BIO_WriteHandle *wh,
1194 struct GNUNET_FS_FileInformation *fi)
1196 char buf[32 * 1024];
1204 while (off < fi->data.file.file_size)
1206 left = GNUNET_MIN (sizeof (buf), fi->data.file.file_size - off);
1208 fi->data.file.reader (fi->data.file.reader_cls, off, left, buf, &emsg);
1212 return GNUNET_SYSERR;
1214 if (GNUNET_OK != GNUNET_BIO_write (wh, buf, ret))
1215 return GNUNET_SYSERR;
1223 * Create a temporary file on disk to store the current
1226 * @param fi file information to sync with disk
1229 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *fi)
1232 struct GNUNET_BIO_WriteHandle *wh;
1237 if (NULL == fi->serialization)
1239 make_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO);
1240 if (NULL == fi->serialization)
1242 wh = get_write_handle (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1246 GNUNET_free (fi->serialization);
1247 fi->serialization = NULL;
1250 if (GNUNET_YES == fi->is_directory)
1252 else if (GNUNET_YES == fi->data.file.index_start_confirmed)
1254 else if (GNUNET_YES == fi->data.file.have_hash)
1256 else if (GNUNET_YES == fi->data.file.do_index)
1260 if (NULL != fi->keywords)
1261 ksks = GNUNET_FS_uri_to_string (fi->keywords);
1264 if (NULL != fi->chk_uri)
1265 chks = GNUNET_FS_uri_to_string (fi->chk_uri);
1268 if ((GNUNET_OK != GNUNET_BIO_write (wh, &b, sizeof (b))) ||
1269 (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, fi->meta)) ||
1270 (GNUNET_OK != GNUNET_BIO_write_string (wh, ksks)) ||
1271 (GNUNET_OK != GNUNET_BIO_write_string (wh, chks)) ||
1272 (GNUNET_OK != write_start_time (wh, fi->start_time)) ||
1273 (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->emsg)) ||
1274 (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->filename)) ||
1276 GNUNET_BIO_write_int64 (wh, fi->bo.expiration_time.abs_value)) ||
1277 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.anonymity_level)) ||
1278 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.content_priority)) ||
1279 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.replication_level)))
1284 GNUNET_free_non_null (chks);
1286 GNUNET_free_non_null (ksks);
1291 case 0: /* file-insert */
1292 if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1297 if ((GNUNET_NO == fi->is_published) && (NULL == fi->filename))
1298 if (GNUNET_OK != copy_from_reader (wh, fi))
1304 case 1: /* file-index, no hash */
1305 if (NULL == fi->filename)
1310 if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1316 case 2: /* file-index-with-hash */
1317 case 3: /* file-index-with-hash-confirmed */
1318 if (NULL == fi->filename)
1323 if ((GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size)) ||
1325 GNUNET_BIO_write (wh, &fi->data.file.file_id,
1326 sizeof (struct GNUNET_HashCode))))
1332 case 4: /* directory */
1333 if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->data.dir.dir_size)) ||
1335 GNUNET_BIO_write (wh, fi->data.dir.dir_data,
1336 (uint32_t) fi->data.dir.dir_size)) ||
1338 GNUNET_BIO_write_string (wh,
1339 (fi->data.dir.entries ==
1340 NULL) ? NULL : fi->data.dir.
1341 entries->serialization)))
1352 GNUNET_BIO_write_string (wh,
1354 NULL) ? fi->next->serialization : NULL))
1359 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1368 (void) GNUNET_BIO_write_close (wh);
1369 GNUNET_free_non_null (chks);
1370 GNUNET_free_non_null (ksks);
1371 fn = get_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1375 if (0 != UNLINK (fn))
1376 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1379 GNUNET_free (fi->serialization);
1380 fi->serialization = NULL;
1386 * Find the entry in the file information struct where the
1387 * serialization filename matches the given name.
1389 * @param pos file information to search
1390 * @param srch filename to search for
1391 * @return NULL if srch was not found in this subtree
1393 static struct GNUNET_FS_FileInformation *
1394 find_file_position (struct GNUNET_FS_FileInformation *pos, const char *srch)
1396 struct GNUNET_FS_FileInformation *r;
1400 if (0 == strcmp (srch, pos->serialization))
1402 if ( (GNUNET_YES == pos->is_directory) &&
1403 (NULL != (r = find_file_position (pos->data.dir.entries, srch))) )
1412 * Signal the FS's progress function that we are resuming
1415 * @param cls closure (of type "struct GNUNET_FS_PublishContext*")
1416 * @param fi the entry in the publish-structure
1417 * @param length length of the file or directory
1418 * @param meta metadata for the file or directory (can be modified)
1419 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1420 * @param bo block options (can be modified)
1421 * @param do_index should we index?
1422 * @param client_info pointer to client context set upon creation (can be modified)
1423 * @return GNUNET_OK to continue (always)
1426 fip_signal_resume (void *cls, struct GNUNET_FS_FileInformation *fi,
1427 uint64_t length, struct GNUNET_CONTAINER_MetaData *meta,
1428 struct GNUNET_FS_Uri **uri,
1429 struct GNUNET_FS_BlockOptions *bo, int *do_index,
1432 struct GNUNET_FS_PublishContext *pc = cls;
1433 struct GNUNET_FS_ProgressInfo pi;
1435 if (GNUNET_YES == pc->skip_next_fi_callback)
1437 pc->skip_next_fi_callback = GNUNET_NO;
1440 pi.status = GNUNET_FS_STATUS_PUBLISH_RESUME;
1441 pi.value.publish.specifics.resume.message = pc->fi->emsg;
1442 pi.value.publish.specifics.resume.chk_uri = pc->fi->chk_uri;
1443 *client_info = GNUNET_FS_publish_make_status_ (&pi, pc, fi, 0);
1444 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (meta))
1446 /* process entries in directory */
1447 pc->skip_next_fi_callback = GNUNET_YES;
1448 GNUNET_FS_file_information_inspect (fi, &fip_signal_resume, pc);
1455 * Function called with a filename of serialized publishing operation
1458 * @param cls the 'struct GNUNET_FS_Handle*'
1459 * @param filename complete filename (absolute path)
1460 * @return GNUNET_OK (continue to iterate)
1463 deserialize_publish_file (void *cls, const char *filename)
1465 struct GNUNET_FS_Handle *h = cls;
1466 struct GNUNET_BIO_ReadHandle *rh;
1467 struct GNUNET_FS_PublishContext *pc;
1475 pc = GNUNET_malloc (sizeof (struct GNUNET_FS_PublishContext));
1477 pc->serialization = get_serialization_short_name (filename);
1481 rh = GNUNET_BIO_read_open (filename);
1487 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-nid", &pc->nid, 1024))
1489 GNUNET_BIO_read_string (rh, "publish-nuid", &pc->nuid, 1024)) ||
1490 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
1491 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &all_done)) ||
1493 GNUNET_BIO_read_string (rh, "publish-firoot", &fi_root, 128)) ||
1494 (GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-fipos", &fi_pos, 128))
1495 || (GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-ns", &ns, 1024)))
1500 pc->options = options;
1501 pc->all_done = all_done;
1502 if (NULL == fi_root)
1507 pc->fi = deserialize_file_information (h, fi_root);
1515 pc->ns = GNUNET_FS_namespace_create (h, ns);
1518 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1520 ("Failed to recover namespace `%s', cannot resume publishing operation.\n"),
1525 if ((0 == (pc->options & GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY)) &&
1526 (GNUNET_YES != pc->all_done))
1528 pc->dsh = GNUNET_DATASTORE_connect (h->cfg);
1529 if (NULL == pc->dsh)
1534 pc->fi_pos = find_file_position (pc->fi, fi_pos);
1535 GNUNET_free (fi_pos);
1537 if (NULL == pc->fi_pos)
1539 /* failed to find position for resuming, outch! Will start from root! */
1541 if (GNUNET_YES != pc->all_done)
1542 pc->fi_pos = pc->fi;
1545 GNUNET_free (fi_root);
1547 /* generate RESUME event(s) */
1548 GNUNET_FS_file_information_inspect (pc->fi, &fip_signal_resume, pc);
1550 /* re-start publishing (if needed)... */
1551 if (GNUNET_YES != pc->all_done)
1553 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
1555 GNUNET_SCHEDULER_add_with_priority
1556 (GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
1557 &GNUNET_FS_publish_main_, pc);
1559 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1561 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1562 _("Failure while resuming publishing operation `%s': %s\n"),
1566 GNUNET_free_non_null (ns);
1567 pc->top = GNUNET_FS_make_top (h, &GNUNET_FS_publish_signal_suspend_, pc);
1570 GNUNET_free_non_null (pc->nid);
1571 GNUNET_free_non_null (pc->nuid);
1572 GNUNET_free_non_null (fi_root);
1573 GNUNET_free_non_null (fi_pos);
1574 GNUNET_free_non_null (ns);
1575 if ((NULL != rh) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
1577 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1578 _("Failed to resume publishing operation `%s': %s\n"), filename,
1583 GNUNET_FS_file_information_destroy (pc->fi, NULL, NULL);
1584 if (0 != UNLINK (filename))
1585 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
1586 GNUNET_free (pc->serialization);
1593 * Synchronize this publishing struct with its mirror
1594 * on disk. Note that all internal FS-operations that change
1595 * publishing structs should already call "sync" internally,
1596 * so this function is likely not useful for clients.
1598 * @param pc the struct to sync
1601 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc)
1603 struct GNUNET_BIO_WriteHandle *wh;
1605 if (NULL == pc->serialization)
1607 make_serialization_file_name (pc->h,
1608 GNUNET_FS_SYNC_PATH_MASTER_PUBLISH);
1609 if (NULL == pc->serialization)
1613 if (NULL == pc->fi->serialization)
1618 wh = get_write_handle (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1625 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nid)) ||
1626 (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nuid)) ||
1627 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->options)) ||
1628 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->all_done)) ||
1629 (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->fi->serialization)) ||
1631 GNUNET_BIO_write_string (wh,
1632 (NULL == pc->fi_pos) ? NULL : pc->fi_pos->serialization)) ||
1634 GNUNET_BIO_write_string (wh,
1635 (NULL == pc->ns) ? NULL : pc->ns->name)))
1640 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1649 (void) GNUNET_BIO_write_close (wh);
1650 GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1652 GNUNET_free (pc->serialization);
1653 pc->serialization = NULL;
1658 * Synchronize this unindex struct with its mirror
1659 * on disk. Note that all internal FS-operations that change
1660 * publishing structs should already call "sync" internally,
1661 * so this function is likely not useful for clients.
1663 * @param uc the struct to sync
1666 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc)
1668 struct GNUNET_BIO_WriteHandle *wh;
1671 if (NULL == uc->serialization)
1673 make_serialization_file_name (uc->h,
1674 GNUNET_FS_SYNC_PATH_MASTER_UNINDEX);
1675 if (NULL == uc->serialization)
1677 wh = get_write_handle (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1684 if (NULL != uc->ksk_uri)
1685 uris = GNUNET_FS_uri_to_string (uc->ksk_uri);
1688 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uc->filename)) ||
1689 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, uc->file_size)) ||
1690 (GNUNET_OK != write_start_time (wh, uc->start_time)) ||
1691 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->state)) ||
1693 GNUNET_BIO_write (wh, &uc->chk, sizeof (struct ContentHashKey))) ||
1694 (GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1695 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->ksk_offset)) ||
1696 ((uc->state == UNINDEX_STATE_FS_NOTIFY) &&
1698 GNUNET_BIO_write (wh, &uc->file_id, sizeof (struct GNUNET_HashCode)))) ||
1699 ((uc->state == UNINDEX_STATE_ERROR) &&
1700 (GNUNET_OK != GNUNET_BIO_write_string (wh, uc->emsg))))
1705 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1714 (void) GNUNET_BIO_write_close (wh);
1715 GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1717 GNUNET_free (uc->serialization);
1718 uc->serialization = NULL;
1723 * Serialize a download request.
1725 * @param wh the 'struct GNUNET_BIO_WriteHandle*'
1726 * @param dr the 'struct DownloadRequest'
1727 * @return GNUNET_YES on success, GNUNET_NO on error
1730 write_download_request (struct GNUNET_BIO_WriteHandle *wh,
1731 struct DownloadRequest *dr)
1735 if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->state)) ||
1736 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dr->offset)) ||
1737 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->num_children)) ||
1738 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->depth)))
1740 if ((BRS_CHK_SET == dr->state) &&
1742 GNUNET_BIO_write (wh, &dr->chk, sizeof (struct ContentHashKey))))
1744 for (i = 0; i < dr->num_children; i++)
1745 if (GNUNET_NO == write_download_request (wh, dr->children[i]))
1752 * Read a download request tree.
1754 * @param rh stream to read from
1755 * @return value the 'struct DownloadRequest', NULL on error
1757 static struct DownloadRequest *
1758 read_download_request (struct GNUNET_BIO_ReadHandle *rh)
1760 struct DownloadRequest *dr;
1763 dr = GNUNET_malloc (sizeof (struct DownloadRequest));
1764 if ((GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->state)) ||
1765 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dr->offset)) ||
1766 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->num_children)) ||
1767 (dr->num_children > CHK_PER_INODE) ||
1768 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->depth)) || ((0 == dr->depth)
1772 ((dr->depth > 0) && (0 == dr->num_children)))
1775 dr->num_children = 0;
1778 if (dr->num_children > 0)
1780 GNUNET_malloc (dr->num_children * sizeof (struct DownloadRequest *));
1784 case BRS_RECONSTRUCT_DOWN:
1785 case BRS_RECONSTRUCT_META_UP:
1786 case BRS_RECONSTRUCT_UP:
1790 GNUNET_BIO_read (rh, "chk", &dr->chk, sizeof (struct ContentHashKey)))
1793 case BRS_DOWNLOAD_DOWN:
1794 case BRS_DOWNLOAD_UP:
1801 for (i = 0; i < dr->num_children; i++)
1803 if (NULL == (dr->children[i] = read_download_request (rh)))
1805 dr->children[i]->parent = dr;
1809 GNUNET_FS_free_download_request_ (dr);
1815 * Compute the name of the sync file (or directory) for the given download
1818 * @param dc download context to compute for
1819 * @param uni unique filename to use, use "" for the directory name
1820 * @param ext extension to use, use ".dir" for our own subdirectory
1821 * @return the expanded file name, NULL for none
1824 get_download_sync_filename (struct GNUNET_FS_DownloadContext *dc,
1825 const char *uni, const char *ext)
1830 if (dc->parent == NULL)
1831 return get_serialization_file_name (dc->h,
1832 (dc->search != NULL) ?
1833 GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD :
1834 GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
1836 if (NULL == dc->parent->serialization)
1838 par = get_download_sync_filename (dc->parent, dc->parent->serialization, "");
1841 GNUNET_asprintf (&epar, "%s.dir%s%s%s", par, DIR_SEPARATOR_STR, uni, ext);
1848 * Synchronize this download struct with its mirror
1849 * on disk. Note that all internal FS-operations that change
1850 * publishing structs should already call "sync" internally,
1851 * so this function is likely not useful for clients.
1853 * @param dc the struct to sync
1856 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc)
1858 struct GNUNET_BIO_WriteHandle *wh;
1863 if (0 != (dc->options & GNUNET_FS_DOWNLOAD_IS_PROBE))
1864 return; /* we don't sync probes */
1865 if (NULL == dc->serialization)
1867 dir = get_download_sync_filename (dc, "", "");
1870 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dir))
1875 fn = GNUNET_DISK_mktemp (dir);
1879 dc->serialization = get_serialization_short_name (fn);
1883 fn = get_download_sync_filename (dc, dc->serialization, "");
1886 GNUNET_free (dc->serialization);
1887 dc->serialization = NULL;
1892 wh = GNUNET_BIO_write_open (fn);
1895 GNUNET_free (dc->serialization);
1896 dc->serialization = NULL;
1900 GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_chk (dc->uri)) ||
1901 (GNUNET_YES == GNUNET_FS_uri_test_loc (dc->uri)));
1902 uris = GNUNET_FS_uri_to_string (dc->uri);
1903 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1904 (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, dc->meta)) ||
1905 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->emsg)) ||
1906 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->filename)) ||
1907 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->temp_filename)) ||
1908 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->old_file_size)) ||
1909 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->offset)) ||
1910 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->length)) ||
1911 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->completed)) ||
1912 (GNUNET_OK != write_start_time (wh, dc->start_time)) ||
1913 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dc->anonymity)) ||
1914 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->options)) ||
1915 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->has_finished)))
1920 if (NULL == dc->emsg)
1922 GNUNET_assert (dc->top_request != NULL);
1923 if (GNUNET_YES != write_download_request (wh, dc->top_request))
1929 GNUNET_free_non_null (uris);
1931 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1941 (void) GNUNET_BIO_write_close (wh);
1942 GNUNET_free_non_null (uris);
1943 if (0 != UNLINK (fn))
1944 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1946 GNUNET_free (dc->serialization);
1947 dc->serialization = NULL;
1952 * Synchronize this search result with its mirror
1953 * on disk. Note that all internal FS-operations that change
1954 * publishing structs should already call "sync" internally,
1955 * so this function is likely not useful for clients.
1957 * @param sr the struct to sync
1960 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr)
1962 struct GNUNET_BIO_WriteHandle *wh;
1966 if (NULL == sr->serialization)
1968 make_serialization_file_name_in_dir (sr->sc->h,
1969 (sr->sc->psearch_result ==
1971 GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1972 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1973 sr->sc->serialization);
1974 if (NULL == sr->serialization)
1976 wh = get_write_handle_in_dir (sr->sc->h,
1977 (sr->sc->psearch_result ==
1978 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1979 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1980 sr->sc->serialization, sr->serialization);
1986 uris = GNUNET_FS_uri_to_string (sr->uri);
1987 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1989 GNUNET_BIO_write_string (wh,
1991 NULL ? sr->download->serialization : NULL)) ||
1993 GNUNET_BIO_write_string (wh,
1994 sr->update_search !=
1995 NULL ? sr->update_search->serialization : NULL))
1996 || (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, sr->meta)) ||
1997 (GNUNET_OK != GNUNET_BIO_write (wh, &sr->key, sizeof (struct GNUNET_HashCode)))
1998 || (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->mandatory_missing)) ||
1999 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->optional_support)) ||
2000 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_success)) ||
2001 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_trials)) )
2006 if ( (NULL != sr->uri) &&
2007 (GNUNET_FS_URI_KSK == sr->sc->uri->type) &&
2008 (GNUNET_OK != GNUNET_BIO_write (wh, sr->keyword_bitmap,
2009 (sr->sc->uri->data.ksk.keywordCount + 7) / 8)) )
2014 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
2020 GNUNET_free_non_null (uris);
2023 GNUNET_free_non_null (uris);
2025 (void) GNUNET_BIO_write_close (wh);
2026 remove_sync_file_in_dir (sr->sc->h,
2027 (NULL == sr->sc->psearch_result)
2028 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2029 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2030 sr->sc->serialization, sr->serialization);
2031 GNUNET_free (sr->serialization);
2032 sr->serialization = NULL;
2037 * Synchronize this search struct with its mirror
2038 * on disk. Note that all internal FS-operations that change
2039 * publishing structs should already call "sync" internally,
2040 * so this function is likely not useful for clients.
2042 * @param sc the struct to sync
2045 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc)
2047 struct GNUNET_BIO_WriteHandle *wh;
2050 const char *category;
2053 (NULL == sc->psearch_result)
2054 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2055 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH;
2056 if (NULL == sc->serialization)
2057 sc->serialization = make_serialization_file_name (sc->h, category);
2058 if (NULL == sc->serialization)
2061 wh = get_write_handle (sc->h, category, sc->serialization);
2067 GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_ksk (sc->uri)) ||
2068 (GNUNET_YES == GNUNET_FS_uri_test_sks (sc->uri)));
2069 uris = GNUNET_FS_uri_to_string (sc->uri);
2070 in_pause = (sc->task != GNUNET_SCHEDULER_NO_TASK) ? 'r' : '\0';
2071 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
2072 (GNUNET_OK != write_start_time (wh, sc->start_time)) ||
2073 (GNUNET_OK != GNUNET_BIO_write_string (wh, sc->emsg)) ||
2074 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) sc->options)) ||
2075 (GNUNET_OK != GNUNET_BIO_write (wh, &in_pause, sizeof (in_pause))) ||
2076 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sc->anonymity)))
2083 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
2092 (void) GNUNET_BIO_write_close (wh);
2093 GNUNET_free_non_null (uris);
2094 GNUNET_FS_remove_sync_file_ (sc->h, category, sc->serialization);
2095 GNUNET_free (sc->serialization);
2096 sc->serialization = NULL;
2101 * Function called with a filename of serialized unindexing operation
2104 * @param cls the 'struct GNUNET_FS_Handle*'
2105 * @param filename complete filename (absolute path)
2106 * @return GNUNET_OK (continue to iterate)
2109 deserialize_unindex_file (void *cls, const char *filename)
2111 struct GNUNET_FS_Handle *h = cls;
2112 struct GNUNET_BIO_ReadHandle *rh;
2113 struct GNUNET_FS_UnindexContext *uc;
2114 struct GNUNET_FS_ProgressInfo pi;
2119 uc = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
2121 uc->serialization = get_serialization_short_name (filename);
2122 rh = GNUNET_BIO_read_open (filename);
2130 GNUNET_BIO_read_string (rh, "unindex-fn", &uc->filename, 10 * 1024)) ||
2131 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &uc->file_size)) ||
2132 (GNUNET_OK != read_start_time (rh, &uc->start_time)) ||
2133 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &state)) ||
2134 (GNUNET_OK != GNUNET_BIO_read (rh, "uri", &uc->chk, sizeof (struct ContentHashKey))) ||
2135 (GNUNET_OK != GNUNET_BIO_read_string (rh, "unindex-kskuri", &uris, 10 * 1024)) ||
2136 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &uc->ksk_offset)) )
2138 GNUNET_free_non_null (uris);
2144 uc->ksk_uri = GNUNET_FS_uri_parse (uris, &emsg);
2146 if (NULL == uc->ksk_uri)
2149 GNUNET_free_non_null (emsg);
2153 if ( (uc->ksk_offset > 0) &&
2154 ( (NULL == uc->ksk_uri) ||
2155 (uc->ksk_offset > uc->ksk_uri->data.ksk.keywordCount) ) )
2160 uc->state = (enum UnindexState) state;
2163 case UNINDEX_STATE_HASHING:
2165 case UNINDEX_STATE_FS_NOTIFY:
2167 GNUNET_BIO_read (rh, "unindex-hash", &uc->file_id,
2168 sizeof (struct GNUNET_HashCode)))
2174 case UNINDEX_STATE_DS_REMOVE:
2175 case UNINDEX_STATE_EXTRACT_KEYWORDS:
2176 case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2178 case UNINDEX_STATE_COMPLETE:
2180 case UNINDEX_STATE_ERROR:
2182 GNUNET_BIO_read_string (rh, "unindex-emsg", &uc->emsg, 10 * 1024))
2192 uc->top = GNUNET_FS_make_top (h, &GNUNET_FS_unindex_signal_suspend_, uc);
2193 pi.status = GNUNET_FS_STATUS_UNINDEX_RESUME;
2194 pi.value.unindex.specifics.resume.message = uc->emsg;
2195 GNUNET_FS_unindex_make_status_ (&pi, uc,
2197 UNINDEX_STATE_COMPLETE) ? uc->file_size : 0);
2200 case UNINDEX_STATE_HASHING:
2202 GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE, uc->filename,
2204 &GNUNET_FS_unindex_process_hash_, uc);
2206 case UNINDEX_STATE_FS_NOTIFY:
2207 uc->state = UNINDEX_STATE_HASHING;
2208 GNUNET_FS_unindex_process_hash_ (uc, &uc->file_id);
2210 case UNINDEX_STATE_DS_REMOVE:
2211 GNUNET_FS_unindex_do_remove_ (uc);
2213 case UNINDEX_STATE_EXTRACT_KEYWORDS:
2214 GNUNET_FS_unindex_do_extract_keywords_ (uc);
2216 case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2217 GNUNET_FS_unindex_do_remove_kblocks_ (uc);
2219 case UNINDEX_STATE_COMPLETE:
2220 case UNINDEX_STATE_ERROR:
2221 /* no need to resume any operation, we were done */
2226 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2228 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2229 _("Failure while resuming unindexing operation `%s': %s\n"),
2235 GNUNET_free_non_null (uc->filename);
2236 if ((NULL != rh) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
2238 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2239 _("Failed to resume unindexing operation `%s': %s\n"), filename,
2243 if (NULL != uc->serialization)
2244 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2246 GNUNET_free_non_null (uc->serialization);
2253 * Deserialize a download.
2255 * @param h overall context
2256 * @param rh file to deserialize from
2257 * @param parent parent download
2258 * @param search associated search
2259 * @param serialization name under which the search was serialized
2262 deserialize_download (struct GNUNET_FS_Handle *h,
2263 struct GNUNET_BIO_ReadHandle *rh,
2264 struct GNUNET_FS_DownloadContext *parent,
2265 struct GNUNET_FS_SearchResult *search,
2266 const char *serialization);
2270 * Deserialize a search.
2272 * @param h overall context
2273 * @param rh file to deserialize from
2274 * @param psearch_result parent search result
2275 * @param serialization name under which the search was serialized
2277 static struct GNUNET_FS_SearchContext *
2278 deserialize_search (struct GNUNET_FS_Handle *h,
2279 struct GNUNET_BIO_ReadHandle *rh,
2280 struct GNUNET_FS_SearchResult *psearch_result,
2281 const char *serialization);
2285 * Function called with a filename of serialized search result
2288 * @param cls the 'struct GNUNET_FS_SearchContext*'
2289 * @param filename complete filename (absolute path)
2290 * @return GNUNET_OK (continue to iterate)
2293 deserialize_search_result (void *cls, const char *filename)
2295 struct GNUNET_FS_SearchContext *sc = cls;
2301 struct GNUNET_BIO_ReadHandle *rh;
2302 struct GNUNET_BIO_ReadHandle *drh;
2303 struct GNUNET_FS_SearchResult *sr;
2305 ser = get_serialization_short_name (filename);
2306 rh = GNUNET_BIO_read_open (filename);
2311 remove_sync_file_in_dir (sc->h,
2312 (NULL == sc->psearch_result)
2313 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2314 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2315 sc->serialization, ser);
2324 sr = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchResult));
2326 sr->serialization = ser;
2327 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "result-uri", &uris, 10 * 1024))
2328 || (NULL == (sr->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2329 (GNUNET_OK != GNUNET_BIO_read_string (rh, "download-lnk", &download, 16))
2331 GNUNET_BIO_read_string (rh, "search-lnk", &update_srch, 16)) ||
2332 (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "result-meta", &sr->meta)) ||
2334 GNUNET_BIO_read (rh, "result-key", &sr->key, sizeof (struct GNUNET_HashCode)))
2335 || (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->mandatory_missing)) ||
2336 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->optional_support)) ||
2337 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_success)) ||
2338 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_trials)))
2343 if (GNUNET_FS_URI_KSK == sr->sc->uri->type)
2345 sr->keyword_bitmap = GNUNET_malloc ((sr->sc->uri->data.ksk.keywordCount + 7) / 8); /* round up, count bits */
2346 if (GNUNET_OK != GNUNET_BIO_read (rh, "keyword-bitmap",
2348 (sr->sc->uri->data.ksk.keywordCount + 7) / 8))
2355 if (NULL != download)
2357 drh = get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD, download);
2360 deserialize_download (sc->h, drh, NULL, sr, download);
2361 if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2363 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2364 _("Failed to resume sub-download `%s': %s\n"), download,
2369 GNUNET_free (download);
2371 if (NULL != update_srch)
2374 get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_SEARCH, update_srch);
2377 deserialize_search (sc->h, drh, sr, update_srch);
2378 if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2380 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2381 _("Failed to resume sub-search `%s': %s\n"), update_srch,
2386 GNUNET_free (update_srch);
2388 GNUNET_break (GNUNET_YES ==
2389 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &sr->key, sr,
2390 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
2391 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2393 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2394 _("Failure while resuming search operation `%s': %s\n"),
2400 GNUNET_free_non_null (download);
2401 GNUNET_free_non_null (emsg);
2402 GNUNET_free_non_null (uris);
2403 GNUNET_free_non_null (update_srch);
2404 if (NULL != sr->uri)
2405 GNUNET_FS_uri_destroy (sr->uri);
2406 if (NULL != sr->meta)
2407 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2408 GNUNET_free (sr->serialization);
2410 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2412 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2413 _("Failure while resuming search operation `%s': %s\n"),
2422 * Send the 'resume' signal to the callback; also actually
2423 * resume the download (put it in the queue). Does this
2424 * recursively for the top-level download and all child
2427 * @param dc download to resume
2430 signal_download_resume (struct GNUNET_FS_DownloadContext *dc)
2432 struct GNUNET_FS_DownloadContext *dcc;
2433 struct GNUNET_FS_ProgressInfo pi;
2435 pi.status = GNUNET_FS_STATUS_DOWNLOAD_RESUME;
2436 pi.value.download.specifics.resume.meta = dc->meta;
2437 pi.value.download.specifics.resume.message = dc->emsg;
2438 GNUNET_FS_download_make_status_ (&pi, dc);
2439 dcc = dc->child_head;
2442 signal_download_resume (dcc);
2445 if (NULL != dc->pending_head)
2446 GNUNET_FS_download_start_downloading_ (dc);
2451 * Signal resuming of a search to our clients (for the
2452 * top level search and all sub-searches).
2454 * @param sc search being resumed
2457 signal_search_resume (struct GNUNET_FS_SearchContext *sc);
2461 * Iterator over search results signaling resume to the client for
2464 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2465 * @param key current key code
2466 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2467 * @return GNUNET_YES (we should continue to iterate)
2470 signal_result_resume (void *cls, const struct GNUNET_HashCode * key, void *value)
2472 struct GNUNET_FS_SearchContext *sc = cls;
2473 struct GNUNET_FS_ProgressInfo pi;
2474 struct GNUNET_FS_SearchResult *sr = value;
2476 if (0 == sr->mandatory_missing)
2478 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME_RESULT;
2479 pi.value.search.specifics.resume_result.meta = sr->meta;
2480 pi.value.search.specifics.resume_result.uri = sr->uri;
2481 pi.value.search.specifics.resume_result.result = sr;
2482 pi.value.search.specifics.resume_result.availability_rank =
2483 2 * sr->availability_success - sr->availability_trials;
2484 pi.value.search.specifics.resume_result.availability_certainty =
2485 sr->availability_trials;
2486 pi.value.search.specifics.resume_result.applicability_rank =
2487 sr->optional_support;
2488 sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
2490 if (NULL != sr->download)
2492 signal_download_resume (sr->download);
2496 GNUNET_FS_search_start_probe_ (sr);
2498 if (NULL != sr->update_search)
2499 signal_search_resume (sr->update_search);
2505 * Free memory allocated by the search context and its children
2507 * @param sc search context to free
2510 free_search_context (struct GNUNET_FS_SearchContext *sc);
2514 * Iterator over search results freeing each.
2516 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2517 * @param key current key code
2518 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2519 * @return GNUNET_YES (we should continue to iterate)
2522 free_result (void *cls, const struct GNUNET_HashCode * key, void *value)
2524 struct GNUNET_FS_SearchResult *sr = value;
2526 if (NULL != sr->update_search)
2528 free_search_context (sr->update_search);
2529 GNUNET_assert (NULL == sr->update_search);
2531 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2532 GNUNET_FS_uri_destroy (sr->uri);
2539 * Free memory allocated by the search context and its children
2541 * @param sc search context to free
2544 free_search_context (struct GNUNET_FS_SearchContext *sc)
2546 if (NULL != sc->serialization)
2548 GNUNET_FS_remove_sync_file_ (sc->h,
2549 (sc->psearch_result ==
2550 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2551 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2553 GNUNET_FS_remove_sync_dir_ (sc->h,
2554 (sc->psearch_result ==
2555 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2556 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2559 GNUNET_free_non_null (sc->serialization);
2560 GNUNET_free_non_null (sc->emsg);
2561 if (NULL != sc->uri)
2562 GNUNET_FS_uri_destroy (sc->uri);
2563 if (NULL != sc->master_result_map)
2565 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map, &free_result,
2567 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
2574 * Function called with a filename of serialized sub-download
2577 * @param cls the 'struct GNUNET_FS_DownloadContext*' (parent)
2578 * @param filename complete filename (absolute path)
2579 * @return GNUNET_OK (continue to iterate)
2582 deserialize_subdownload (void *cls, const char *filename)
2584 struct GNUNET_FS_DownloadContext *parent = cls;
2587 struct GNUNET_BIO_ReadHandle *rh;
2589 ser = get_serialization_short_name (filename);
2590 rh = GNUNET_BIO_read_open (filename);
2593 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2595 ("Failed to resume sub-download `%s': could not open file `%s'\n"),
2600 deserialize_download (parent->h, rh, parent, NULL, ser);
2601 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2603 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2604 _("Failed to resume sub-download `%s': %s\n"), ser, emsg);
2613 * Free this download context and all of its descendants.
2614 * (only works during deserialization since not all possible
2615 * state it taken care of).
2617 * @param dc context to free
2620 free_download_context (struct GNUNET_FS_DownloadContext *dc)
2622 struct GNUNET_FS_DownloadContext *dcc;
2624 if (NULL != dc->meta)
2625 GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2626 if (NULL != dc->uri)
2627 GNUNET_FS_uri_destroy (dc->uri);
2628 GNUNET_free_non_null (dc->temp_filename);
2629 GNUNET_free_non_null (dc->emsg);
2630 GNUNET_free_non_null (dc->filename);
2631 GNUNET_free_non_null (dc->serialization);
2632 while (NULL != (dcc = dc->child_head))
2634 GNUNET_CONTAINER_DLL_remove (dc->child_head, dc->child_tail, dcc);
2635 free_download_context (dcc);
2637 GNUNET_FS_free_download_request_ (dc->top_request);
2638 if (NULL != dc->active)
2639 GNUNET_CONTAINER_multihashmap_destroy (dc->active);
2645 * Deserialize a download.
2647 * @param h overall context
2648 * @param rh file to deserialize from
2649 * @param parent parent download
2650 * @param search associated search
2651 * @param serialization name under which the search was serialized
2654 deserialize_download (struct GNUNET_FS_Handle *h,
2655 struct GNUNET_BIO_ReadHandle *rh,
2656 struct GNUNET_FS_DownloadContext *parent,
2657 struct GNUNET_FS_SearchResult *search,
2658 const char *serialization)
2660 struct GNUNET_FS_DownloadContext *dc;
2669 dc = GNUNET_malloc (sizeof (struct GNUNET_FS_DownloadContext));
2670 dc->parent = parent;
2672 dc->serialization = GNUNET_strdup (serialization);
2674 GNUNET_BIO_read_string (rh, "download-uri", &uris, 10 * 1024)) ||
2675 (NULL == (dc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2676 ((GNUNET_YES != GNUNET_FS_uri_test_chk (dc->uri)) &&
2677 (GNUNET_YES != GNUNET_FS_uri_test_loc (dc->uri))) ||
2678 (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "download-meta", &dc->meta))
2680 GNUNET_BIO_read_string (rh, "download-emsg", &dc->emsg, 10 * 1024)) ||
2682 GNUNET_BIO_read_string (rh, "download-fn", &dc->filename, 10 * 1024)) ||
2684 GNUNET_BIO_read_string (rh, "download-tfn", &dc->temp_filename,
2686 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->old_file_size)) ||
2687 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->offset)) ||
2688 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->length)) ||
2689 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->completed)) ||
2690 (GNUNET_OK != read_start_time (rh, &dc->start_time)) ||
2691 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dc->anonymity)) ||
2692 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2693 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &status)))
2698 dc->options = (enum GNUNET_FS_DownloadOptions) options;
2700 GNUNET_CONTAINER_multihashmap_create (1 + 2 * (dc->length / DBLOCK_SIZE), GNUNET_NO);
2701 dc->has_finished = (int) status;
2703 GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size (dc->uri));
2704 if (GNUNET_FS_uri_test_loc (dc->uri))
2705 GNUNET_assert (GNUNET_OK ==
2706 GNUNET_FS_uri_loc_get_peer_identity (dc->uri, &dc->target));
2707 if (NULL == dc->emsg)
2709 dc->top_request = read_download_request (rh);
2710 if (NULL == dc->top_request)
2716 dn = get_download_sync_filename (dc, dc->serialization, ".dir");
2719 if (GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES))
2720 GNUNET_DISK_directory_scan (dn, &deserialize_subdownload, dc);
2725 GNUNET_abort (); // for debugging for now - FIXME
2726 GNUNET_CONTAINER_DLL_insert (parent->child_head, parent->child_tail, dc);
2730 dc->search = search;
2731 search->download = dc;
2733 if ((NULL == parent) && (NULL == search))
2736 GNUNET_FS_make_top (dc->h, &GNUNET_FS_download_signal_suspend_, dc);
2737 signal_download_resume (dc);
2740 dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_, dc);
2743 GNUNET_free_non_null (uris);
2744 GNUNET_free_non_null (emsg);
2745 free_download_context (dc);
2750 * Signal resuming of a search to our clients (for the
2751 * top level search and all sub-searches).
2753 * @param sc search being resumed
2756 signal_search_resume (struct GNUNET_FS_SearchContext *sc)
2758 struct GNUNET_FS_ProgressInfo pi;
2760 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME;
2761 pi.value.search.specifics.resume.message = sc->emsg;
2762 pi.value.search.specifics.resume.is_paused =
2763 (NULL == sc->client) ? GNUNET_YES : GNUNET_NO;
2764 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
2765 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2766 &signal_result_resume, sc);
2772 * Deserialize a search.
2774 * @param h overall context
2775 * @param rh file to deserialize from
2776 * @param psearch_result parent search result
2777 * @param serialization name under which the search was serialized
2779 static struct GNUNET_FS_SearchContext *
2780 deserialize_search (struct GNUNET_FS_Handle *h,
2781 struct GNUNET_BIO_ReadHandle *rh,
2782 struct GNUNET_FS_SearchResult *psearch_result,
2783 const char *serialization)
2785 struct GNUNET_FS_SearchContext *sc;
2792 if ((NULL != psearch_result) && (NULL != psearch_result->update_search))
2799 sc = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchContext));
2800 if (NULL != psearch_result)
2802 sc->psearch_result = psearch_result;
2803 psearch_result->update_search = sc;
2806 sc->serialization = GNUNET_strdup (serialization);
2807 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "search-uri", &uris, 10 * 1024))
2808 || (NULL == (sc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2809 ((GNUNET_YES != GNUNET_FS_uri_test_ksk (sc->uri)) &&
2810 (GNUNET_YES != GNUNET_FS_uri_test_sks (sc->uri))) ||
2811 (GNUNET_OK != read_start_time (rh, &sc->start_time)) ||
2813 GNUNET_BIO_read_string (rh, "search-emsg", &sc->emsg, 10 * 1024)) ||
2814 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2816 GNUNET_BIO_read (rh, "search-pause", &in_pause, sizeof (in_pause))) ||
2817 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sc->anonymity)))
2822 sc->options = (enum GNUNET_FS_SearchOptions) options;
2823 sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_NO);
2824 dn = get_serialization_file_name_in_dir (h,
2825 (sc->psearch_result ==
2827 GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2828 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2829 sc->serialization, "");
2832 if (GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES))
2833 GNUNET_DISK_directory_scan (dn, &deserialize_search_result, sc);
2836 if (('\0' == in_pause) &&
2837 (GNUNET_OK != GNUNET_FS_search_start_searching_ (sc)))
2839 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2841 ("Could not resume running search, will resume as paused search\n"));
2843 signal_search_resume (sc);
2847 GNUNET_free_non_null (emsg);
2848 free_search_context (sc);
2849 GNUNET_free_non_null (uris);
2855 * Function called with a filename of serialized search operation
2858 * @param cls the 'struct GNUNET_FS_Handle*'
2859 * @param filename complete filename (absolute path)
2860 * @return GNUNET_OK (continue to iterate)
2863 deserialize_search_file (void *cls, const char *filename)
2865 struct GNUNET_FS_Handle *h = cls;
2868 struct GNUNET_BIO_ReadHandle *rh;
2869 struct GNUNET_FS_SearchContext *sc;
2872 if (0 != STAT (filename, &buf))
2874 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "stat", filename);
2877 if (S_ISDIR (buf.st_mode))
2878 return GNUNET_OK; /* skip directories */
2879 ser = get_serialization_short_name (filename);
2880 rh = GNUNET_BIO_read_open (filename);
2885 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_SEARCH, ser);
2890 sc = deserialize_search (h, rh, NULL, ser);
2892 sc->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, sc);
2894 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2896 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2897 _("Failure while resuming search operation `%s': %s\n"),
2906 * Function called with a filename of serialized download operation
2909 * @param cls the 'struct GNUNET_FS_Handle*'
2910 * @param filename complete filename (absolute path)
2911 * @return GNUNET_OK (continue to iterate)
2914 deserialize_download_file (void *cls, const char *filename)
2916 struct GNUNET_FS_Handle *h = cls;
2919 struct GNUNET_BIO_ReadHandle *rh;
2921 ser = get_serialization_short_name (filename);
2922 rh = GNUNET_BIO_read_open (filename);
2925 if (0 != UNLINK (filename))
2926 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
2930 deserialize_download (h, rh, NULL, NULL, ser);
2932 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2934 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2935 _("Failure while resuming download operation `%s': %s\n"),
2944 * Deserialize informatin about pending operations.
2946 * @param master_path which master directory should be scanned
2947 * @param proc function to call for each entry (will get 'h' for 'cls')
2948 * @param h the 'struct GNUNET_FS_Handle*'
2951 deserialization_master (const char *master_path, GNUNET_FileNameCallback proc,
2952 struct GNUNET_FS_Handle *h)
2956 dn = get_serialization_file_name (h, master_path, "");
2959 if (GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES))
2960 GNUNET_DISK_directory_scan (dn, proc, h);
2966 * Setup a connection to the file-sharing service.
2968 * @param cfg configuration to use
2969 * @param client_name unique identifier for this client
2970 * @param upcb function to call to notify about FS actions
2971 * @param upcb_cls closure for upcb
2972 * @param flags specific attributes for fs-operations
2973 * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
2974 * @return NULL on error
2976 struct GNUNET_FS_Handle *
2977 GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
2978 const char *client_name, GNUNET_FS_ProgressCallback upcb,
2979 void *upcb_cls, enum GNUNET_FS_Flags flags, ...)
2981 struct GNUNET_FS_Handle *ret;
2982 enum GNUNET_FS_OPTIONS opt;
2985 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Handle));
2987 ret->client_name = GNUNET_strdup (client_name);
2989 ret->upcb_cls = upcb_cls;
2991 ret->max_parallel_downloads = DEFAULT_MAX_PARALLEL_DOWNLOADS;
2992 ret->max_parallel_requests = DEFAULT_MAX_PARALLEL_REQUESTS;
2993 ret->avg_block_latency = GNUNET_TIME_UNIT_MINUTES; /* conservative starting point */
2994 va_start (ap, flags);
2995 while (GNUNET_FS_OPTIONS_END != (opt = va_arg (ap, enum GNUNET_FS_OPTIONS)))
2999 case GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM:
3000 ret->max_parallel_downloads = va_arg (ap, unsigned int);
3003 case GNUNET_FS_OPTIONS_REQUEST_PARALLELISM:
3004 ret->max_parallel_requests = va_arg (ap, unsigned int);
3009 GNUNET_free (ret->client_name);
3016 if (0 != (GNUNET_FS_FLAGS_PERSISTENCE & flags))
3018 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
3019 &deserialize_publish_file, ret);
3020 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
3021 &deserialize_search_file, ret);
3022 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
3023 &deserialize_download_file, ret);
3024 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
3025 &deserialize_unindex_file, ret);
3032 * Close our connection with the file-sharing service.
3033 * The callback given to GNUNET_FS_start will no longer be
3034 * called after this function returns.
3036 * @param h handle that was returned from GNUNET_FS_start
3039 GNUNET_FS_stop (struct GNUNET_FS_Handle *h)
3041 while (h->top_head != NULL)
3042 h->top_head->ssf (h->top_head->ssf_cls);
3043 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
3044 GNUNET_SCHEDULER_cancel (h->queue_job);
3045 GNUNET_free (h->client_name);