2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
23 * @brief main FS functions (master initialization, serialization, deserialization, shared code)
24 * @author Christian Grothoff
28 #include "gnunet_util_lib.h"
29 #include "gnunet_fs_service.h"
34 * How many block requests can we have outstanding in parallel at a time by default?
36 #define DEFAULT_MAX_PARALLEL_REQUESTS (1024 * 10)
39 * How many downloads can we have outstanding in parallel at a time by default?
41 #define DEFAULT_MAX_PARALLEL_DOWNLOADS 16
44 * Start the given job (send signal, remove from pending queue, update
45 * counters and state).
47 * @param qe job to start
50 start_job (struct GNUNET_FS_QueueEntry *qe)
52 GNUNET_assert (NULL == qe->client);
53 qe->client = GNUNET_CLIENT_connect ("fs", qe->h->cfg);
54 if (NULL == qe->client)
59 qe->start (qe->cls, qe->client);
61 qe->h->active_blocks += qe->blocks;
62 qe->start_time = GNUNET_TIME_absolute_get ();
63 GNUNET_CONTAINER_DLL_remove (qe->h->pending_head, qe->h->pending_tail, qe);
64 GNUNET_CONTAINER_DLL_insert_after (qe->h->running_head, qe->h->running_tail,
65 qe->h->running_tail, qe);
70 * Stop the given job (send signal, remove from active queue, update
71 * counters and state).
73 * @param qe job to stop
76 stop_job (struct GNUNET_FS_QueueEntry *qe)
80 qe->h->active_downloads--;
81 qe->h->active_blocks -= qe->blocks;
83 GNUNET_TIME_relative_add (qe->run_time,
84 GNUNET_TIME_absolute_get_duration
86 GNUNET_CONTAINER_DLL_remove (qe->h->running_head, qe->h->running_tail, qe);
87 GNUNET_CONTAINER_DLL_insert_after (qe->h->pending_head, qe->h->pending_tail,
88 qe->h->pending_tail, qe);
93 * Process the jobs in the job queue, possibly starting some
94 * and stopping others.
96 * @param cls the 'struct GNUNET_FS_Handle'
97 * @param tc scheduler context
100 process_job_queue (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
102 struct GNUNET_FS_Handle *h = cls;
103 struct GNUNET_FS_QueueEntry *qe;
104 struct GNUNET_FS_QueueEntry *next;
105 struct GNUNET_TIME_Relative run_time;
106 struct GNUNET_TIME_Relative restart_at;
107 struct GNUNET_TIME_Relative rst;
108 struct GNUNET_TIME_Absolute end_time;
109 unsigned int num_download_waiting;
110 unsigned int num_download_active;
111 unsigned int num_download_expired;
112 unsigned int num_probes_active;
113 unsigned int num_probes_waiting;
114 unsigned int num_probes_expired;
115 int num_probes_change;
116 int num_download_change;
118 h->queue_job = GNUNET_SCHEDULER_NO_TASK;
119 restart_at = GNUNET_TIME_UNIT_FOREVER_REL;
120 /* first, see if we can start all the jobs */
121 num_probes_waiting = 0;
122 num_download_waiting = 0;
123 for (qe = h->pending_head; NULL != qe; qe = qe->next)
125 switch (qe->priority)
127 case GNUNET_FS_QUEUE_PRIORITY_PROBE:
128 num_probes_waiting++;
130 case GNUNET_FS_QUEUE_PRIORITY_NORMAL:
131 num_download_waiting++;
138 num_probes_active = 0;
139 num_probes_expired = 0;
140 num_download_active = 0;
141 num_download_expired = 0;
142 for (qe = h->running_head; NULL != qe; qe = qe->next)
145 GNUNET_TIME_relative_multiply (h->avg_block_latency,
146 qe->blocks * qe->start_times);
147 switch (qe->priority)
149 case GNUNET_FS_QUEUE_PRIORITY_PROBE:
151 /* run probes for at most 1s * number-of-restarts; note that
152 as the total runtime of a probe is limited to 2m, we don't
153 need to additionally limit the total time of a probe to
154 strictly limit its lifetime. */
155 run_time = GNUNET_TIME_relative_min (run_time,
156 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
157 1 + qe->start_times));
158 end_time = GNUNET_TIME_absolute_add (qe->start_time, run_time);
159 rst = GNUNET_TIME_absolute_get_remaining (end_time);
160 restart_at = GNUNET_TIME_relative_min (rst, restart_at);
161 if (0 == rst.rel_value)
162 num_probes_expired++;
164 case GNUNET_FS_QUEUE_PRIORITY_NORMAL:
165 num_download_active++;
166 end_time = GNUNET_TIME_absolute_add (qe->start_time, run_time);
167 rst = GNUNET_TIME_absolute_get_remaining (end_time);
168 restart_at = GNUNET_TIME_relative_min (rst, restart_at);
169 if (0 == rst.rel_value)
170 num_download_expired++;
178 /* calculate stop decisions */
179 num_probes_change = 0;
180 num_download_change = 0;
181 if (h->active_downloads + num_download_waiting > h->max_parallel_requests)
183 if (num_probes_active > 0)
184 num_probes_change = - GNUNET_MIN (num_probes_active,
185 h->max_parallel_requests - (h->active_downloads + num_download_waiting));
186 else if (h->active_downloads + num_download_waiting > h->max_parallel_requests)
187 num_download_change = - GNUNET_MIN (num_download_expired,
188 h->max_parallel_requests - (h->active_downloads + num_download_waiting));
191 /* then, check if we should stop some jobs */
192 next = h->running_head;
193 while (NULL != (qe = next))
197 GNUNET_TIME_relative_multiply (h->avg_block_latency,
198 qe->blocks * qe->start_times);
199 switch (qe->priority)
201 case GNUNET_FS_QUEUE_PRIORITY_PROBE:
202 /* run probes for at most 1s * number-of-restarts; note that
203 as the total runtime of a probe is limited to 2m, we don't
204 need to additionally limit the total time of a probe to
205 strictly limit its lifetime. */
206 run_time = GNUNET_TIME_relative_min (run_time,
207 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
208 1 + qe->start_times));
209 end_time = GNUNET_TIME_absolute_add (qe->start_time, run_time);
210 rst = GNUNET_TIME_absolute_get_remaining (end_time);
211 restart_at = GNUNET_TIME_relative_min (rst, restart_at);
212 if ( (num_probes_change < 0) &&
213 ( (num_probes_expired < - num_probes_change) ||
214 (0 == rst.rel_value) ) )
218 if (0 == rst.rel_value)
219 num_probes_expired--;
222 case GNUNET_FS_QUEUE_PRIORITY_NORMAL:
223 end_time = GNUNET_TIME_absolute_add (qe->start_time, run_time);
224 rst = GNUNET_TIME_absolute_get_remaining (end_time);
225 restart_at = GNUNET_TIME_relative_min (rst, restart_at);
226 if ( (num_download_change < 0) &&
227 ( (num_download_expired < - num_download_change) ||
228 (0 == rst.rel_value) ) )
231 num_download_change++;
232 if (0 == rst.rel_value)
233 num_download_expired--;
242 /* FIXME: calculate start decisions */
243 num_probes_change = 0;
244 num_download_change = 0;
245 if (h->active_downloads + num_download_waiting < h->max_parallel_requests)
247 num_download_change = num_download_waiting;
248 num_probes_change = GNUNET_MIN (num_probes_waiting,
249 h->max_parallel_requests - (h->active_downloads + num_download_waiting));
253 next = h->pending_head;
254 while (NULL != (qe = next))
257 if (NULL == h->running_head)
262 if ((qe->blocks + h->active_blocks <= h->max_parallel_requests) &&
263 (h->active_downloads < h->max_parallel_downloads))
269 if (NULL == h->pending_head)
270 return; /* no need to stop anything */
271 /* then, check if we should stop some jobs */
272 next = h->running_head;
273 while (NULL != (qe = next))
277 GNUNET_TIME_relative_multiply (h->avg_block_latency,
278 qe->blocks * qe->start_times);
279 switch (qe->priority)
281 case GNUNET_FS_QUEUE_PRIORITY_PROBE:
282 /* run probes for at most 1s * number-of-restarts; note that
283 as the total runtime of a probe is limited to 2m, we don't
284 need to additionally limit the total time of a probe to
285 strictly limit its lifetime. */
286 run_time = GNUNET_TIME_relative_min (run_time,
287 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
288 1 + qe->start_times));
290 case GNUNET_FS_QUEUE_PRIORITY_NORMAL:
296 end_time = GNUNET_TIME_absolute_add (qe->start_time, run_time);
297 rst = GNUNET_TIME_absolute_get_remaining (end_time);
298 restart_at = GNUNET_TIME_relative_min (rst, restart_at);
299 if (rst.rel_value > 0)
303 /* finally, start some more tasks if we now have empty slots */
304 next = h->pending_head;
305 while (NULL != (qe = next))
308 if ((qe->blocks + h->active_blocks <= h->max_parallel_requests) &&
309 (h->active_downloads < h->max_parallel_downloads))
316 GNUNET_SCHEDULER_add_delayed (restart_at, &process_job_queue, h);
321 * Add a job to the queue.
323 * @param h handle to the overall FS state
324 * @param start function to call to begin the job
325 * @param stop function to call to pause the job, or on dequeue (if the job was running)
326 * @param cls closure for start and stop
327 * @param blocks number of blocks this jobs uses
328 * @param priority how important is this download
329 * @return queue handle
331 struct GNUNET_FS_QueueEntry *
332 GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h, GNUNET_FS_QueueStart start,
333 GNUNET_FS_QueueStop stop, void *cls, unsigned int blocks,
334 enum GNUNET_FS_QueuePriority priority)
336 struct GNUNET_FS_QueueEntry *qe;
338 qe = GNUNET_malloc (sizeof (struct GNUNET_FS_QueueEntry));
343 qe->queue_time = GNUNET_TIME_absolute_get ();
345 qe->priority = priority;
346 GNUNET_CONTAINER_DLL_insert_after (h->pending_head, h->pending_tail,
347 h->pending_tail, qe);
348 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
349 GNUNET_SCHEDULER_cancel (h->queue_job);
350 h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h);
356 * Dequeue a job from the queue.
357 * @param qh handle for the job
360 GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qh)
362 struct GNUNET_FS_Handle *h;
365 if (NULL != qh->client)
367 GNUNET_CONTAINER_DLL_remove (h->pending_head, h->pending_tail, qh);
369 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
370 GNUNET_SCHEDULER_cancel (h->queue_job);
371 h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h);
376 * Create a top-level activity entry.
378 * @param h global fs handle
379 * @param ssf suspend signal function to use
380 * @param ssf_cls closure for ssf
381 * @return fresh top-level activity handle
383 struct TopLevelActivity *
384 GNUNET_FS_make_top (struct GNUNET_FS_Handle *h, SuspendSignalFunction ssf,
387 struct TopLevelActivity *ret;
389 ret = GNUNET_malloc (sizeof (struct TopLevelActivity));
391 ret->ssf_cls = ssf_cls;
392 GNUNET_CONTAINER_DLL_insert (h->top_head, h->top_tail, ret);
398 * Destroy a top-level activity entry.
400 * @param h global fs handle
401 * @param top top level activity entry
404 GNUNET_FS_end_top (struct GNUNET_FS_Handle *h, struct TopLevelActivity *top)
406 GNUNET_CONTAINER_DLL_remove (h->top_head, h->top_tail, top);
413 * Closure for "data_reader_file".
418 * Name of the file to read.
423 * File descriptor, NULL if it has not yet been opened.
425 struct GNUNET_DISK_FileHandle *fd;
430 * Function that provides data by reading from a file.
432 * @param cls closure (points to the file information)
433 * @param offset offset to read from; it is possible
434 * that the caller might need to go backwards
435 * a bit at times; set to UINT64_MAX to tell
436 * the reader that we won't be reading for a while
437 * (used to close the file descriptor but NOT fully
438 * clean up the reader's state); in this case,
439 * a value of '0' for max should be ignored
440 * @param max maximum number of bytes that should be
441 * copied to buf; readers are not allowed
442 * to provide less data unless there is an error;
443 * a value of "0" will be used at the end to allow
444 * the reader to clean up its internal state
445 * @param buf where the reader should write the data
446 * @param emsg location for the reader to store an error message
447 * @return number of bytes written, usually "max", 0 on error
450 GNUNET_FS_data_reader_file_ (void *cls, uint64_t offset, size_t max, void *buf,
453 struct FileInfo *fi = cls;
456 if (UINT64_MAX == offset)
460 GNUNET_DISK_file_close (fi->fd);
468 GNUNET_DISK_file_close (fi->fd);
469 GNUNET_free (fi->filename);
476 GNUNET_DISK_file_open (fi->filename, GNUNET_DISK_OPEN_READ,
477 GNUNET_DISK_PERM_NONE);
480 GNUNET_asprintf (emsg, _("Could not open file `%s': %s"), fi->filename,
485 GNUNET_DISK_file_seek (fi->fd, offset, GNUNET_DISK_SEEK_SET);
486 ret = GNUNET_DISK_file_read (fi->fd, buf, max);
489 GNUNET_asprintf (emsg, _("Could not read file `%s': %s"), fi->filename,
495 GNUNET_asprintf (emsg, _("Short read reading from file `%s'!"),
504 * Create the closure for the 'GNUNET_FS_data_reader_file_' callback.
506 * @param filename file to read
507 * @return closure to use, NULL on error
510 GNUNET_FS_make_file_reader_context_ (const char *filename)
514 fi = GNUNET_malloc (sizeof (struct FileInfo));
515 fi->filename = GNUNET_STRINGS_filename_expand (filename);
516 if (fi->filename == NULL)
526 * Function that provides data by copying from a buffer.
528 * @param cls closure (points to the buffer)
529 * @param offset offset to read from; it is possible
530 * that the caller might need to go backwards
531 * a bit at times; set to UINT64_MAX to tell
532 * the reader that we won't be reading for a while
533 * (used to close the file descriptor but NOT fully
534 * clean up the reader's state); in this case,
535 * a value of '0' for max should be ignored
536 * @param max maximum number of bytes that should be
537 * copied to buf; readers are not allowed
538 * to provide less data unless there is an error;
539 * a value of "0" will be used at the end to allow
540 * the reader to clean up its internal state
541 * @param buf where the reader should write the data
542 * @param emsg location for the reader to store an error message
543 * @return number of bytes written, usually "max", 0 on error
546 GNUNET_FS_data_reader_copy_ (void *cls, uint64_t offset, size_t max, void *buf,
551 if (UINT64_MAX == offset)
555 GNUNET_free_non_null (data);
558 memcpy (buf, &data[offset], max);
564 * Return the full filename where we would store state information
565 * (for serialization/deserialization).
567 * @param h master context
568 * @param ext component of the path
569 * @param ent entity identifier (or emtpy string for the directory)
570 * @return NULL on error
573 get_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext,
579 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
580 return NULL; /* persistence not requested */
582 GNUNET_CONFIGURATION_get_value_filename (h->cfg, "fs", "STATE_DIR",
585 GNUNET_asprintf (&ret, "%s%s%s%s%s%s%s", basename, DIR_SEPARATOR_STR,
586 h->client_name, DIR_SEPARATOR_STR, ext, DIR_SEPARATOR_STR,
588 GNUNET_free (basename);
594 * Return the full filename where we would store state information
595 * (for serialization/deserialization) that is associated with a
598 * @param h master context
599 * @param ext component of the path
600 * @param uni name of the parent operation
601 * @param ent entity identifier (or emtpy string for the directory)
602 * @return NULL on error
605 get_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
606 const char *uni, const char *ent)
611 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
612 return NULL; /* persistence not requested */
614 GNUNET_CONFIGURATION_get_value_filename (h->cfg, "fs", "STATE_DIR",
617 GNUNET_asprintf (&ret, "%s%s%s%s%s%s%s.dir%s%s", basename, DIR_SEPARATOR_STR,
618 h->client_name, DIR_SEPARATOR_STR, ext, DIR_SEPARATOR_STR,
619 uni, DIR_SEPARATOR_STR, ent);
620 GNUNET_free (basename);
626 * Return a read handle for deserialization.
628 * @param h master context
629 * @param ext component of the path
630 * @param ent entity identifier (or emtpy string for the directory)
631 * @return NULL on error
633 static struct GNUNET_BIO_ReadHandle *
634 get_read_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
637 struct GNUNET_BIO_ReadHandle *ret;
639 fn = get_serialization_file_name (h, ext, ent);
642 ret = GNUNET_BIO_read_open (fn);
649 * Return a write handle for serialization.
651 * @param h master context
652 * @param ext component of the path
653 * @param ent entity identifier (or emtpy string for the directory)
654 * @return NULL on error
656 static struct GNUNET_BIO_WriteHandle *
657 get_write_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
660 struct GNUNET_BIO_WriteHandle *ret;
662 fn = get_serialization_file_name (h, ext, ent);
665 ret = GNUNET_BIO_write_open (fn);
666 GNUNET_break (ret != NULL);
673 * Return a write handle for serialization.
675 * @param h master context
676 * @param ext component of the path
677 * @param uni name of parent
678 * @param ent entity identifier (or emtpy string for the directory)
679 * @return NULL on error
681 static struct GNUNET_BIO_WriteHandle *
682 get_write_handle_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
683 const char *uni, const char *ent)
686 struct GNUNET_BIO_WriteHandle *ret;
688 fn = get_serialization_file_name_in_dir (h, ext, uni, ent);
691 ret = GNUNET_BIO_write_open (fn);
698 * Remove serialization/deserialization file from disk.
700 * @param h master context
701 * @param ext component of the path
702 * @param ent entity identifier
705 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext,
710 if ((NULL == ent) || (0 == strlen (ent)))
715 filename = get_serialization_file_name (h, ext, ent);
716 if (filename != NULL)
718 if (0 != UNLINK (filename))
719 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
720 GNUNET_free (filename);
726 * Remove serialization/deserialization file from disk.
728 * @param h master context
729 * @param ext component of the path
730 * @param uni parent name
731 * @param ent entity identifier
734 remove_sync_file_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
735 const char *uni, const char *ent)
739 if ((NULL == ent) || (0 == strlen (ent)))
744 filename = get_serialization_file_name_in_dir (h, ext, uni, ent);
745 if (filename != NULL)
747 if (0 != UNLINK (filename))
748 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
749 GNUNET_free (filename);
755 * Remove serialization/deserialization directory from disk.
757 * @param h master context
758 * @param ext component of the path
759 * @param uni unique name of parent
762 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext,
769 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
772 if ((GNUNET_OK == GNUNET_DISK_directory_test (dn)) &&
773 (GNUNET_OK != GNUNET_DISK_directory_remove (dn)))
774 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "rmdir", dn);
780 * Serialize a 'start_time'. Since we use start-times to
781 * calculate the duration of some operation, we actually
782 * do not serialize the absolute time but the (relative)
783 * duration since the start time. When we then
784 * deserialize the start time, we take the current time and
785 * subtract that duration so that we get again an absolute
786 * time stamp that will result in correct performance
789 * @param wh handle for writing
790 * @param timestamp time to serialize
791 * @return GNUNET_OK on success
794 write_start_time (struct GNUNET_BIO_WriteHandle *wh,
795 struct GNUNET_TIME_Absolute timestamp)
797 struct GNUNET_TIME_Relative dur;
799 dur = GNUNET_TIME_absolute_get_duration (timestamp);
800 return GNUNET_BIO_write_int64 (wh, dur.rel_value);
805 * Serialize a 'start_time'. Since we use start-times to
806 * calculate the duration of some operation, we actually
807 * do not serialize the absolute time but the (relative)
808 * duration since the start time. When we then
809 * deserialize the start time, we take the current time and
810 * subtract that duration so that we get again an absolute
811 * time stamp that will result in correct performance
814 * @param rh handle for reading
815 * @param timestamp where to write the deserialized timestamp
816 * @return GNUNET_OK on success
819 read_start_time (struct GNUNET_BIO_ReadHandle *rh,
820 struct GNUNET_TIME_Absolute *timestamp)
822 struct GNUNET_TIME_Relative dur;
824 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dur.rel_value))
825 return GNUNET_SYSERR;
826 *timestamp = GNUNET_TIME_absolute_subtract (GNUNET_TIME_absolute_get (), dur);
832 * Using the given serialization filename, try to deserialize
833 * the file-information tree associated with it.
835 * @param h master context
836 * @param filename name of the file (without directory) with
838 * @return NULL on error
840 static struct GNUNET_FS_FileInformation *
841 deserialize_file_information (struct GNUNET_FS_Handle *h, const char *filename);
845 * Using the given serialization filename, try to deserialize
846 * the file-information tree associated with it.
848 * @param h master context
849 * @param fn name of the file (without directory) with
851 * @param rh handle for reading
852 * @return NULL on error
854 static struct GNUNET_FS_FileInformation *
855 deserialize_fi_node (struct GNUNET_FS_Handle *h, const char *fn,
856 struct GNUNET_BIO_ReadHandle *rh)
858 struct GNUNET_FS_FileInformation *ret;
859 struct GNUNET_FS_FileInformation *nxt;
866 if (GNUNET_OK != GNUNET_BIO_read (rh, "status flag", &b, sizeof (b)))
871 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_FileInformation));
876 if ((GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "metadata", &ret->meta)) ||
877 (GNUNET_OK != GNUNET_BIO_read_string (rh, "ksk-uri", &ksks, 32 * 1024)) ||
879 ( (NULL == (ret->keywords = GNUNET_FS_uri_parse (ksks, NULL))) ||
880 (GNUNET_YES != GNUNET_FS_uri_test_ksk (ret->keywords)) ) ) ||
881 (GNUNET_OK != GNUNET_BIO_read_string (rh, "chk-uri", &chks, 1024)) ||
883 ( (NULL == (ret->chk_uri = GNUNET_FS_uri_parse (chks, NULL))) ||
884 (GNUNET_YES != GNUNET_FS_uri_test_chk (ret->chk_uri))) ) ||
885 (GNUNET_OK != read_start_time (rh, &ret->start_time)) ||
886 (GNUNET_OK != GNUNET_BIO_read_string (rh, "emsg", &ret->emsg, 16 * 1024))
888 GNUNET_BIO_read_string (rh, "fn", &ret->filename, 16 * 1024)) ||
890 GNUNET_BIO_read_int64 (rh, &ret->bo.expiration_time.abs_value)) ||
891 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.anonymity_level)) ||
892 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.content_priority)) ||
893 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.replication_level)))
900 case 0: /* file-insert */
901 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
906 ret->is_directory = GNUNET_NO;
907 ret->data.file.do_index = GNUNET_NO;
908 ret->data.file.have_hash = GNUNET_NO;
909 ret->data.file.index_start_confirmed = GNUNET_NO;
910 if (GNUNET_NO == ret->is_published)
912 if (NULL == ret->filename)
914 ret->data.file.reader = &GNUNET_FS_data_reader_copy_;
915 ret->data.file.reader_cls =
916 GNUNET_malloc_large (ret->data.file.file_size);
917 if (ret->data.file.reader_cls == NULL)
920 GNUNET_BIO_read (rh, "file-data", ret->data.file.reader_cls,
921 ret->data.file.file_size))
929 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
930 ret->data.file.reader_cls =
931 GNUNET_FS_make_file_reader_context_ (ret->filename);
935 case 1: /* file-index, no hash */
936 if (NULL == ret->filename)
941 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
946 ret->is_directory = GNUNET_NO;
947 ret->data.file.do_index = GNUNET_YES;
948 ret->data.file.have_hash = GNUNET_NO;
949 ret->data.file.index_start_confirmed = GNUNET_NO;
950 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
951 ret->data.file.reader_cls =
952 GNUNET_FS_make_file_reader_context_ (ret->filename);
954 case 2: /* file-index-with-hash */
955 if (NULL == ret->filename)
960 if ((GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
962 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id,
963 sizeof (struct GNUNET_HashCode))))
968 ret->is_directory = GNUNET_NO;
969 ret->data.file.do_index = GNUNET_YES;
970 ret->data.file.have_hash = GNUNET_YES;
971 ret->data.file.index_start_confirmed = GNUNET_NO;
972 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
973 ret->data.file.reader_cls =
974 GNUNET_FS_make_file_reader_context_ (ret->filename);
976 case 3: /* file-index-with-hash-confirmed */
977 if (NULL == ret->filename)
982 if ((GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
984 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id,
985 sizeof (struct GNUNET_HashCode))))
990 ret->is_directory = GNUNET_NO;
991 ret->data.file.do_index = GNUNET_YES;
992 ret->data.file.have_hash = GNUNET_YES;
993 ret->data.file.index_start_confirmed = GNUNET_YES;
994 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
995 ret->data.file.reader_cls =
996 GNUNET_FS_make_file_reader_context_ (ret->filename);
998 case 4: /* directory */
999 ret->is_directory = GNUNET_YES;
1000 if ((GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dsize)) ||
1001 (NULL == (ret->data.dir.dir_data = GNUNET_malloc_large (dsize))) ||
1003 GNUNET_BIO_read (rh, "dir-data", ret->data.dir.dir_data, dsize)) ||
1005 GNUNET_BIO_read_string (rh, "ent-filename", &filename, 16 * 1024)))
1010 ret->data.dir.dir_size = (uint32_t) dsize;
1011 if (filename != NULL)
1013 ret->data.dir.entries = deserialize_file_information (h, filename);
1014 GNUNET_free (filename);
1016 nxt = ret->data.dir.entries;
1028 ret->serialization = GNUNET_strdup (fn);
1030 GNUNET_BIO_read_string (rh, "nxt-filename", &filename, 16 * 1024))
1035 if (filename != NULL)
1037 ret->next = deserialize_file_information (h, filename);
1038 GNUNET_free (filename);
1041 GNUNET_free_non_null (ksks);
1042 GNUNET_free_non_null (chks);
1045 GNUNET_free_non_null (ksks);
1046 GNUNET_free_non_null (chks);
1047 GNUNET_free_non_null (filename);
1048 GNUNET_FS_file_information_destroy (ret, NULL, NULL);
1054 * Using the given serialization filename, try to deserialize
1055 * the file-information tree associated with it.
1057 * @param h master context
1058 * @param filename name of the file (without directory) with
1060 * @return NULL on error
1062 static struct GNUNET_FS_FileInformation *
1063 deserialize_file_information (struct GNUNET_FS_Handle *h, const char *filename)
1065 struct GNUNET_FS_FileInformation *ret;
1066 struct GNUNET_BIO_ReadHandle *rh;
1070 rh = get_read_handle (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
1073 ret = deserialize_fi_node (h, filename, rh);
1074 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1076 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1077 _("Failed to resume publishing information `%s': %s\n"),
1083 fn = get_serialization_file_name (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
1086 if (0 != UNLINK (fn))
1087 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1096 * Given a serialization name (full absolute path), return the
1097 * basename of the file (without the path), which must only
1098 * consist of the 6 random characters.
1100 * @param fullname name to extract the basename from
1101 * @return copy of the basename, NULL on error
1104 get_serialization_short_name (const char *fullname)
1111 /* FIXME: we could do this faster since we know
1112 * the length of 'end'... */
1113 while ('\0' != *nxt)
1115 if (DIR_SEPARATOR == *nxt)
1119 if ((end == NULL) || (strlen (end) == 0))
1124 GNUNET_break (6 == strlen (end));
1125 return GNUNET_strdup (end);
1130 * Create a new random name for serialization. Also checks if persistence
1131 * is enabled and returns NULL if not.
1133 * @param h master context
1134 * @param ext component of the path
1135 * @return NULL on errror
1138 make_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext)
1144 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1145 return NULL; /* persistence not requested */
1146 dn = get_serialization_file_name (h, ext, "");
1149 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1154 fn = GNUNET_DISK_mktemp (dn);
1157 return NULL; /* epic fail */
1158 ret = get_serialization_short_name (fn);
1165 * Create a new random name for serialization. Also checks if persistence
1166 * is enabled and returns NULL if not.
1168 * @param h master context
1169 * @param ext component of the path
1170 * @param uni name of parent
1171 * @return NULL on errror
1174 make_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h,
1175 const char *ext, const char *uni)
1181 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1182 return NULL; /* persistence not requested */
1183 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
1186 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1191 fn = GNUNET_DISK_mktemp (dn);
1194 return NULL; /* epic fail */
1195 ret = get_serialization_short_name (fn);
1202 * Copy all of the data from the reader to the write handle.
1204 * @param wh write handle
1205 * @param fi file with reader
1206 * @return GNUNET_OK on success
1209 copy_from_reader (struct GNUNET_BIO_WriteHandle *wh,
1210 struct GNUNET_FS_FileInformation *fi)
1212 char buf[32 * 1024];
1220 while (off < fi->data.file.file_size)
1222 left = GNUNET_MIN (sizeof (buf), fi->data.file.file_size - off);
1224 fi->data.file.reader (fi->data.file.reader_cls, off, left, buf, &emsg);
1228 return GNUNET_SYSERR;
1230 if (GNUNET_OK != GNUNET_BIO_write (wh, buf, ret))
1231 return GNUNET_SYSERR;
1239 * Create a temporary file on disk to store the current
1242 * @param fi file information to sync with disk
1245 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *fi)
1248 struct GNUNET_BIO_WriteHandle *wh;
1253 if (NULL == fi->serialization)
1255 make_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO);
1256 if (NULL == fi->serialization)
1258 wh = get_write_handle (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1262 GNUNET_free (fi->serialization);
1263 fi->serialization = NULL;
1266 if (GNUNET_YES == fi->is_directory)
1268 else if (GNUNET_YES == fi->data.file.index_start_confirmed)
1270 else if (GNUNET_YES == fi->data.file.have_hash)
1272 else if (GNUNET_YES == fi->data.file.do_index)
1276 if (fi->keywords != NULL)
1277 ksks = GNUNET_FS_uri_to_string (fi->keywords);
1280 if (fi->chk_uri != NULL)
1281 chks = GNUNET_FS_uri_to_string (fi->chk_uri);
1284 if ((GNUNET_OK != GNUNET_BIO_write (wh, &b, sizeof (b))) ||
1285 (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, fi->meta)) ||
1286 (GNUNET_OK != GNUNET_BIO_write_string (wh, ksks)) ||
1287 (GNUNET_OK != GNUNET_BIO_write_string (wh, chks)) ||
1288 (GNUNET_OK != write_start_time (wh, fi->start_time)) ||
1289 (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->emsg)) ||
1290 (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->filename)) ||
1292 GNUNET_BIO_write_int64 (wh, fi->bo.expiration_time.abs_value)) ||
1293 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.anonymity_level)) ||
1294 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.content_priority)) ||
1295 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.replication_level)))
1300 GNUNET_free_non_null (chks);
1302 GNUNET_free_non_null (ksks);
1307 case 0: /* file-insert */
1308 if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1313 if ((GNUNET_NO == fi->is_published) && (NULL == fi->filename))
1314 if (GNUNET_OK != copy_from_reader (wh, fi))
1320 case 1: /* file-index, no hash */
1321 if (NULL == fi->filename)
1326 if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1332 case 2: /* file-index-with-hash */
1333 case 3: /* file-index-with-hash-confirmed */
1334 if (NULL == fi->filename)
1339 if ((GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size)) ||
1341 GNUNET_BIO_write (wh, &fi->data.file.file_id,
1342 sizeof (struct GNUNET_HashCode))))
1348 case 4: /* directory */
1349 if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->data.dir.dir_size)) ||
1351 GNUNET_BIO_write (wh, fi->data.dir.dir_data,
1352 (uint32_t) fi->data.dir.dir_size)) ||
1354 GNUNET_BIO_write_string (wh,
1355 (fi->data.dir.entries ==
1356 NULL) ? NULL : fi->data.dir.
1357 entries->serialization)))
1368 GNUNET_BIO_write_string (wh,
1370 NULL) ? fi->next->serialization : NULL))
1375 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1384 (void) GNUNET_BIO_write_close (wh);
1385 GNUNET_free_non_null (chks);
1386 GNUNET_free_non_null (ksks);
1387 fn = get_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1391 if (0 != UNLINK (fn))
1392 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1395 GNUNET_free (fi->serialization);
1396 fi->serialization = NULL;
1402 * Find the entry in the file information struct where the
1403 * serialization filename matches the given name.
1405 * @param pos file information to search
1406 * @param srch filename to search for
1407 * @return NULL if srch was not found in this subtree
1409 static struct GNUNET_FS_FileInformation *
1410 find_file_position (struct GNUNET_FS_FileInformation *pos, const char *srch)
1412 struct GNUNET_FS_FileInformation *r;
1416 if (0 == strcmp (srch, pos->serialization))
1418 if (pos->is_directory == GNUNET_YES)
1420 r = find_file_position (pos->data.dir.entries, srch);
1431 * Signal the FS's progress function that we are resuming
1434 * @param cls closure (of type "struct GNUNET_FS_PublishContext*")
1435 * @param fi the entry in the publish-structure
1436 * @param length length of the file or directory
1437 * @param meta metadata for the file or directory (can be modified)
1438 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1439 * @param bo block options (can be modified)
1440 * @param do_index should we index?
1441 * @param client_info pointer to client context set upon creation (can be modified)
1442 * @return GNUNET_OK to continue (always)
1445 fip_signal_resume (void *cls, struct GNUNET_FS_FileInformation *fi,
1446 uint64_t length, struct GNUNET_CONTAINER_MetaData *meta,
1447 struct GNUNET_FS_Uri **uri,
1448 struct GNUNET_FS_BlockOptions *bo, int *do_index,
1451 struct GNUNET_FS_PublishContext *pc = cls;
1452 struct GNUNET_FS_ProgressInfo pi;
1454 if (GNUNET_YES == pc->skip_next_fi_callback)
1456 pc->skip_next_fi_callback = GNUNET_NO;
1459 pi.status = GNUNET_FS_STATUS_PUBLISH_RESUME;
1460 pi.value.publish.specifics.resume.message = pc->fi->emsg;
1461 pi.value.publish.specifics.resume.chk_uri = pc->fi->chk_uri;
1462 *client_info = GNUNET_FS_publish_make_status_ (&pi, pc, fi, 0);
1463 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (meta))
1465 /* process entries in directory */
1466 pc->skip_next_fi_callback = GNUNET_YES;
1467 GNUNET_FS_file_information_inspect (fi, &fip_signal_resume, pc);
1474 * Function called with a filename of serialized publishing operation
1477 * @param cls the 'struct GNUNET_FS_Handle*'
1478 * @param filename complete filename (absolute path)
1479 * @return GNUNET_OK (continue to iterate)
1482 deserialize_publish_file (void *cls, const char *filename)
1484 struct GNUNET_FS_Handle *h = cls;
1485 struct GNUNET_BIO_ReadHandle *rh;
1486 struct GNUNET_FS_PublishContext *pc;
1494 pc = GNUNET_malloc (sizeof (struct GNUNET_FS_PublishContext));
1496 pc->serialization = get_serialization_short_name (filename);
1500 rh = GNUNET_BIO_read_open (filename);
1506 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-nid", &pc->nid, 1024))
1508 GNUNET_BIO_read_string (rh, "publish-nuid", &pc->nuid, 1024)) ||
1509 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
1510 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &all_done)) ||
1512 GNUNET_BIO_read_string (rh, "publish-firoot", &fi_root, 128)) ||
1513 (GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-fipos", &fi_pos, 128))
1514 || (GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-ns", &ns, 1024)))
1519 pc->options = options;
1520 pc->all_done = all_done;
1521 if (NULL == fi_root)
1526 pc->fi = deserialize_file_information (h, fi_root);
1534 pc->namespace = GNUNET_FS_namespace_create (h, ns);
1535 if (pc->namespace == NULL)
1537 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1539 ("Failed to recover namespace `%s', cannot resume publishing operation.\n"),
1544 if ((0 == (pc->options & GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY)) &&
1545 (GNUNET_YES != pc->all_done))
1547 pc->dsh = GNUNET_DATASTORE_connect (h->cfg);
1548 if (NULL == pc->dsh)
1553 pc->fi_pos = find_file_position (pc->fi, fi_pos);
1554 GNUNET_free (fi_pos);
1556 if (pc->fi_pos == NULL)
1558 /* failed to find position for resuming, outch! Will start from root! */
1560 if (pc->all_done != GNUNET_YES)
1561 pc->fi_pos = pc->fi;
1564 GNUNET_free (fi_root);
1566 /* generate RESUME event(s) */
1567 GNUNET_FS_file_information_inspect (pc->fi, &fip_signal_resume, pc);
1569 /* re-start publishing (if needed)... */
1570 if (pc->all_done != GNUNET_YES)
1572 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
1574 GNUNET_SCHEDULER_add_with_priority
1575 (GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
1576 &GNUNET_FS_publish_main_, pc);
1578 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1580 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1581 _("Failure while resuming publishing operation `%s': %s\n"),
1585 GNUNET_free_non_null (ns);
1586 pc->top = GNUNET_FS_make_top (h, &GNUNET_FS_publish_signal_suspend_, pc);
1589 GNUNET_free_non_null (pc->nid);
1590 GNUNET_free_non_null (pc->nuid);
1591 GNUNET_free_non_null (fi_root);
1592 GNUNET_free_non_null (fi_pos);
1593 GNUNET_free_non_null (ns);
1594 if ((rh != NULL) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
1596 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1597 _("Failed to resume publishing operation `%s': %s\n"), filename,
1602 GNUNET_FS_file_information_destroy (pc->fi, NULL, NULL);
1603 if (0 != UNLINK (filename))
1604 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
1605 GNUNET_free (pc->serialization);
1612 * Synchronize this publishing struct with its mirror
1613 * on disk. Note that all internal FS-operations that change
1614 * publishing structs should already call "sync" internally,
1615 * so this function is likely not useful for clients.
1617 * @param pc the struct to sync
1620 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc)
1622 struct GNUNET_BIO_WriteHandle *wh;
1624 if (NULL == pc->serialization)
1626 make_serialization_file_name (pc->h,
1627 GNUNET_FS_SYNC_PATH_MASTER_PUBLISH);
1628 if (NULL == pc->serialization)
1632 if (NULL == pc->fi->serialization)
1637 wh = get_write_handle (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1644 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nid)) ||
1645 (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nuid)) ||
1646 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->options)) ||
1647 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->all_done)) ||
1648 (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->fi->serialization)) ||
1650 GNUNET_BIO_write_string (wh,
1652 NULL) ? NULL : pc->fi_pos->serialization)) ||
1654 GNUNET_BIO_write_string (wh,
1656 NULL) ? NULL : pc->namespace->name)))
1661 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1670 (void) GNUNET_BIO_write_close (wh);
1671 GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1673 GNUNET_free (pc->serialization);
1674 pc->serialization = NULL;
1679 * Synchronize this unindex struct with its mirror
1680 * on disk. Note that all internal FS-operations that change
1681 * publishing structs should already call "sync" internally,
1682 * so this function is likely not useful for clients.
1684 * @param uc the struct to sync
1687 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc)
1689 struct GNUNET_BIO_WriteHandle *wh;
1692 if (NULL == uc->serialization)
1694 make_serialization_file_name (uc->h,
1695 GNUNET_FS_SYNC_PATH_MASTER_UNINDEX);
1696 if (NULL == uc->serialization)
1698 wh = get_write_handle (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1705 if (NULL != uc->ksk_uri)
1706 uris = GNUNET_FS_uri_to_string (uc->ksk_uri);
1709 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uc->filename)) ||
1710 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, uc->file_size)) ||
1711 (GNUNET_OK != write_start_time (wh, uc->start_time)) ||
1712 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->state)) ||
1714 GNUNET_BIO_write (wh, &uc->chk, sizeof (struct ContentHashKey))) ||
1715 (GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1716 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->ksk_offset)) ||
1717 ((uc->state == UNINDEX_STATE_FS_NOTIFY) &&
1719 GNUNET_BIO_write (wh, &uc->file_id, sizeof (struct GNUNET_HashCode)))) ||
1720 ((uc->state == UNINDEX_STATE_ERROR) &&
1721 (GNUNET_OK != GNUNET_BIO_write_string (wh, uc->emsg))))
1726 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1735 (void) GNUNET_BIO_write_close (wh);
1736 GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1738 GNUNET_free (uc->serialization);
1739 uc->serialization = NULL;
1744 * Serialize a download request.
1746 * @param wh the 'struct GNUNET_BIO_WriteHandle*'
1747 * @param dr the 'struct DownloadRequest'
1748 * @return GNUNET_YES on success, GNUNET_NO on error
1751 write_download_request (struct GNUNET_BIO_WriteHandle *wh,
1752 struct DownloadRequest *dr)
1756 if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->state)) ||
1757 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dr->offset)) ||
1758 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->num_children)) ||
1759 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->depth)))
1761 if ((dr->state == BRS_CHK_SET) &&
1763 GNUNET_BIO_write (wh, &dr->chk, sizeof (struct ContentHashKey))))
1765 for (i = 0; i < dr->num_children; i++)
1766 if (GNUNET_NO == write_download_request (wh, dr->children[i]))
1773 * Read a download request tree.
1775 * @param rh stream to read from
1776 * @return value the 'struct DownloadRequest', NULL on error
1778 static struct DownloadRequest *
1779 read_download_request (struct GNUNET_BIO_ReadHandle *rh)
1781 struct DownloadRequest *dr;
1784 dr = GNUNET_malloc (sizeof (struct DownloadRequest));
1786 if ((GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->state)) ||
1787 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dr->offset)) ||
1788 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->num_children)) ||
1789 (dr->num_children > CHK_PER_INODE) ||
1790 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->depth)) || ((dr->depth == 0)
1794 ((dr->depth > 0) && (dr->num_children == 0)))
1797 dr->num_children = 0;
1800 if (dr->num_children > 0)
1802 GNUNET_malloc (dr->num_children * sizeof (struct ContentHashKey));
1806 case BRS_RECONSTRUCT_DOWN:
1807 case BRS_RECONSTRUCT_META_UP:
1808 case BRS_RECONSTRUCT_UP:
1812 GNUNET_BIO_read (rh, "chk", &dr->chk, sizeof (struct ContentHashKey)))
1815 case BRS_DOWNLOAD_DOWN:
1816 case BRS_DOWNLOAD_UP:
1823 for (i = 0; i < dr->num_children; i++)
1825 if (NULL == (dr->children[i] = read_download_request (rh)))
1827 dr->children[i]->parent = dr;
1831 GNUNET_FS_free_download_request_ (dr);
1837 * Compute the name of the sync file (or directory) for the given download
1840 * @param dc download context to compute for
1841 * @param uni unique filename to use, use "" for the directory name
1842 * @param ext extension to use, use ".dir" for our own subdirectory
1843 * @return the expanded file name, NULL for none
1846 get_download_sync_filename (struct GNUNET_FS_DownloadContext *dc,
1847 const char *uni, const char *ext)
1852 if (dc->parent == NULL)
1853 return get_serialization_file_name (dc->h,
1854 (dc->search != NULL) ?
1855 GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD :
1856 GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
1858 if (dc->parent->serialization == NULL)
1860 par = get_download_sync_filename (dc->parent, dc->parent->serialization, "");
1863 GNUNET_asprintf (&epar, "%s.dir%s%s%s", par, DIR_SEPARATOR_STR, uni, ext);
1870 * Synchronize this download struct with its mirror
1871 * on disk. Note that all internal FS-operations that change
1872 * publishing structs should already call "sync" internally,
1873 * so this function is likely not useful for clients.
1875 * @param dc the struct to sync
1878 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc)
1880 struct GNUNET_BIO_WriteHandle *wh;
1885 if (0 != (dc->options & GNUNET_FS_DOWNLOAD_IS_PROBE))
1886 return; /* we don't sync probes */
1887 if (NULL == dc->serialization)
1889 dir = get_download_sync_filename (dc, "", "");
1892 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dir))
1897 fn = GNUNET_DISK_mktemp (dir);
1901 dc->serialization = get_serialization_short_name (fn);
1905 fn = get_download_sync_filename (dc, dc->serialization, "");
1908 GNUNET_free (dc->serialization);
1909 dc->serialization = NULL;
1914 wh = GNUNET_BIO_write_open (fn);
1917 GNUNET_free (dc->serialization);
1918 dc->serialization = NULL;
1922 GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_chk (dc->uri)) ||
1923 (GNUNET_YES == GNUNET_FS_uri_test_loc (dc->uri)));
1924 uris = GNUNET_FS_uri_to_string (dc->uri);
1925 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1926 (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, dc->meta)) ||
1927 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->emsg)) ||
1928 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->filename)) ||
1929 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->temp_filename)) ||
1930 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->old_file_size)) ||
1931 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->offset)) ||
1932 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->length)) ||
1933 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->completed)) ||
1934 (GNUNET_OK != write_start_time (wh, dc->start_time)) ||
1935 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dc->anonymity)) ||
1936 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->options)) ||
1937 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->has_finished)))
1942 if (NULL == dc->emsg)
1944 GNUNET_assert (dc->top_request != NULL);
1945 if (GNUNET_YES != write_download_request (wh, dc->top_request))
1951 GNUNET_free_non_null (uris);
1953 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1963 (void) GNUNET_BIO_write_close (wh);
1964 GNUNET_free_non_null (uris);
1965 if (0 != UNLINK (fn))
1966 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1968 GNUNET_free (dc->serialization);
1969 dc->serialization = NULL;
1974 * Synchronize this search result with its mirror
1975 * on disk. Note that all internal FS-operations that change
1976 * publishing structs should already call "sync" internally,
1977 * so this function is likely not useful for clients.
1979 * @param sr the struct to sync
1982 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr)
1984 struct GNUNET_BIO_WriteHandle *wh;
1988 if (NULL == sr->serialization)
1990 make_serialization_file_name_in_dir (sr->sc->h,
1991 (sr->sc->psearch_result ==
1993 GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1994 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1995 sr->sc->serialization);
1996 if (NULL == sr->serialization)
1998 wh = get_write_handle_in_dir (sr->sc->h,
1999 (sr->sc->psearch_result ==
2000 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2001 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2002 sr->sc->serialization, sr->serialization);
2008 uris = GNUNET_FS_uri_to_string (sr->uri);
2009 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
2011 GNUNET_BIO_write_string (wh,
2013 NULL ? sr->download->serialization : NULL)) ||
2015 GNUNET_BIO_write_string (wh,
2016 sr->update_search !=
2017 NULL ? sr->update_search->serialization : NULL))
2018 || (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, sr->meta)) ||
2019 (GNUNET_OK != GNUNET_BIO_write (wh, &sr->key, sizeof (struct GNUNET_HashCode)))
2020 || (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->mandatory_missing)) ||
2021 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->optional_support)) ||
2022 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_success)) ||
2023 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_trials)) )
2028 if ( (NULL != sr->uri) &&
2029 (sr->sc->uri->type == ksk) &&
2030 (GNUNET_OK != GNUNET_BIO_write (wh, sr->keyword_bitmap,
2031 (sr->sc->uri->data.ksk.keywordCount + 7) / 8)) )
2036 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
2042 GNUNET_free_non_null (uris);
2045 GNUNET_free_non_null (uris);
2047 (void) GNUNET_BIO_write_close (wh);
2048 remove_sync_file_in_dir (sr->sc->h,
2049 (sr->sc->psearch_result ==
2050 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2051 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2052 sr->sc->serialization, sr->serialization);
2053 GNUNET_free (sr->serialization);
2054 sr->serialization = NULL;
2059 * Synchronize this search struct with its mirror
2060 * on disk. Note that all internal FS-operations that change
2061 * publishing structs should already call "sync" internally,
2062 * so this function is likely not useful for clients.
2064 * @param sc the struct to sync
2067 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc)
2069 struct GNUNET_BIO_WriteHandle *wh;
2072 const char *category;
2075 (sc->psearch_result ==
2076 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2077 GNUNET_FS_SYNC_PATH_CHILD_SEARCH;
2078 if (NULL == sc->serialization)
2079 sc->serialization = make_serialization_file_name (sc->h, category);
2080 if (NULL == sc->serialization)
2083 wh = get_write_handle (sc->h, category, sc->serialization);
2089 GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_ksk (sc->uri)) ||
2090 (GNUNET_YES == GNUNET_FS_uri_test_sks (sc->uri)));
2091 uris = GNUNET_FS_uri_to_string (sc->uri);
2092 in_pause = (sc->task != GNUNET_SCHEDULER_NO_TASK) ? 'r' : '\0';
2093 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
2094 (GNUNET_OK != write_start_time (wh, sc->start_time)) ||
2095 (GNUNET_OK != GNUNET_BIO_write_string (wh, sc->emsg)) ||
2096 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) sc->options)) ||
2097 (GNUNET_OK != GNUNET_BIO_write (wh, &in_pause, sizeof (in_pause))) ||
2098 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sc->anonymity)))
2105 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
2114 (void) GNUNET_BIO_write_close (wh);
2115 GNUNET_free_non_null (uris);
2116 GNUNET_FS_remove_sync_file_ (sc->h, category, sc->serialization);
2117 GNUNET_free (sc->serialization);
2118 sc->serialization = NULL;
2123 * Function called with a filename of serialized unindexing operation
2126 * @param cls the 'struct GNUNET_FS_Handle*'
2127 * @param filename complete filename (absolute path)
2128 * @return GNUNET_OK (continue to iterate)
2131 deserialize_unindex_file (void *cls, const char *filename)
2133 struct GNUNET_FS_Handle *h = cls;
2134 struct GNUNET_BIO_ReadHandle *rh;
2135 struct GNUNET_FS_UnindexContext *uc;
2136 struct GNUNET_FS_ProgressInfo pi;
2141 uc = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
2143 uc->serialization = get_serialization_short_name (filename);
2144 rh = GNUNET_BIO_read_open (filename);
2152 GNUNET_BIO_read_string (rh, "unindex-fn", &uc->filename, 10 * 1024)) ||
2153 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &uc->file_size)) ||
2154 (GNUNET_OK != read_start_time (rh, &uc->start_time)) ||
2155 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &state)) ||
2156 (GNUNET_OK != GNUNET_BIO_read (rh, "uri", &uc->chk, sizeof (struct ContentHashKey))) ||
2157 (GNUNET_OK != GNUNET_BIO_read_string (rh, "unindex-kskuri", &uris, 10 * 1024)) ||
2158 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &uc->ksk_offset)) )
2160 GNUNET_free_non_null (uris);
2166 uc->ksk_uri = GNUNET_FS_uri_parse (uris, &emsg);
2168 if (NULL == uc->ksk_uri)
2174 if ( (uc->ksk_offset > 0) &&
2175 ( (NULL == uc->ksk_uri) ||
2176 (uc->ksk_offset > uc->ksk_uri->data.ksk.keywordCount) ) )
2181 uc->state = (enum UnindexState) state;
2184 case UNINDEX_STATE_HASHING:
2186 case UNINDEX_STATE_FS_NOTIFY:
2188 GNUNET_BIO_read (rh, "unindex-hash", &uc->file_id,
2189 sizeof (struct GNUNET_HashCode)))
2195 case UNINDEX_STATE_DS_REMOVE:
2196 case UNINDEX_STATE_EXTRACT_KEYWORDS:
2197 case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2199 case UNINDEX_STATE_COMPLETE:
2201 case UNINDEX_STATE_ERROR:
2203 GNUNET_BIO_read_string (rh, "unindex-emsg", &uc->emsg, 10 * 1024))
2213 uc->top = GNUNET_FS_make_top (h, &GNUNET_FS_unindex_signal_suspend_, uc);
2214 pi.status = GNUNET_FS_STATUS_UNINDEX_RESUME;
2215 pi.value.unindex.specifics.resume.message = uc->emsg;
2216 GNUNET_FS_unindex_make_status_ (&pi, uc,
2218 UNINDEX_STATE_COMPLETE) ? uc->file_size : 0);
2221 case UNINDEX_STATE_HASHING:
2223 GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE, uc->filename,
2225 &GNUNET_FS_unindex_process_hash_, uc);
2227 case UNINDEX_STATE_FS_NOTIFY:
2228 uc->state = UNINDEX_STATE_HASHING;
2229 GNUNET_FS_unindex_process_hash_ (uc, &uc->file_id);
2231 case UNINDEX_STATE_DS_REMOVE:
2232 GNUNET_FS_unindex_do_remove_ (uc);
2234 case UNINDEX_STATE_EXTRACT_KEYWORDS:
2235 GNUNET_FS_unindex_do_extract_keywords_ (uc);
2237 case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2238 GNUNET_FS_unindex_do_remove_kblocks_ (uc);
2240 case UNINDEX_STATE_COMPLETE:
2241 case UNINDEX_STATE_ERROR:
2242 /* no need to resume any operation, we were done */
2247 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2249 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2250 _("Failure while resuming unindexing operation `%s': %s\n"),
2256 GNUNET_free_non_null (uc->filename);
2257 if ((rh != NULL) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
2259 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2260 _("Failed to resume unindexing operation `%s': %s\n"), filename,
2264 if (uc->serialization != NULL)
2265 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2267 GNUNET_free_non_null (uc->serialization);
2274 * Deserialize a download.
2276 * @param h overall context
2277 * @param rh file to deserialize from
2278 * @param parent parent download
2279 * @param search associated search
2280 * @param serialization name under which the search was serialized
2283 deserialize_download (struct GNUNET_FS_Handle *h,
2284 struct GNUNET_BIO_ReadHandle *rh,
2285 struct GNUNET_FS_DownloadContext *parent,
2286 struct GNUNET_FS_SearchResult *search,
2287 const char *serialization);
2291 * Deserialize a search.
2293 * @param h overall context
2294 * @param rh file to deserialize from
2295 * @param psearch_result parent search result
2296 * @param serialization name under which the search was serialized
2298 static struct GNUNET_FS_SearchContext *
2299 deserialize_search (struct GNUNET_FS_Handle *h,
2300 struct GNUNET_BIO_ReadHandle *rh,
2301 struct GNUNET_FS_SearchResult *psearch_result,
2302 const char *serialization);
2306 * Function called with a filename of serialized search result
2309 * @param cls the 'struct GNUNET_FS_SearchContext*'
2310 * @param filename complete filename (absolute path)
2311 * @return GNUNET_OK (continue to iterate)
2314 deserialize_search_result (void *cls, const char *filename)
2316 struct GNUNET_FS_SearchContext *sc = cls;
2322 struct GNUNET_BIO_ReadHandle *rh;
2323 struct GNUNET_BIO_ReadHandle *drh;
2324 struct GNUNET_FS_SearchResult *sr;
2326 ser = get_serialization_short_name (filename);
2327 rh = GNUNET_BIO_read_open (filename);
2332 remove_sync_file_in_dir (sc->h,
2333 (sc->psearch_result ==
2334 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2335 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2336 sc->serialization, ser);
2345 sr = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchResult));
2347 sr->serialization = ser;
2348 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "result-uri", &uris, 10 * 1024))
2349 || (NULL == (sr->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2350 (GNUNET_OK != GNUNET_BIO_read_string (rh, "download-lnk", &download, 16))
2352 GNUNET_BIO_read_string (rh, "search-lnk", &update_srch, 16)) ||
2353 (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "result-meta", &sr->meta)) ||
2355 GNUNET_BIO_read (rh, "result-key", &sr->key, sizeof (struct GNUNET_HashCode)))
2356 || (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->mandatory_missing)) ||
2357 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->optional_support)) ||
2358 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_success)) ||
2359 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_trials)))
2364 if (sr->sc->uri->type == ksk)
2366 sr->keyword_bitmap = GNUNET_malloc ((sr->sc->uri->data.ksk.keywordCount + 7) / 8); /* round up, count bits */
2367 if (GNUNET_OK != GNUNET_BIO_read (rh, "keyword-bitmap",
2369 (sr->sc->uri->data.ksk.keywordCount + 7) / 8))
2376 if (download != NULL)
2378 drh = get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD, download);
2381 deserialize_download (sc->h, drh, NULL, sr, download);
2382 if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2384 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2385 _("Failed to resume sub-download `%s': %s\n"), download,
2390 GNUNET_free (download);
2392 if (update_srch != NULL)
2395 get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_SEARCH, update_srch);
2398 deserialize_search (sc->h, drh, sr, update_srch);
2399 if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2401 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2402 _("Failed to resume sub-search `%s': %s\n"), update_srch,
2407 GNUNET_free (update_srch);
2409 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &sr->key, sr,
2410 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2411 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2413 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2414 _("Failure while resuming search operation `%s': %s\n"),
2420 GNUNET_free_non_null (download);
2421 GNUNET_free_non_null (emsg);
2422 GNUNET_free_non_null (uris);
2423 GNUNET_free_non_null (update_srch);
2424 if (sr->uri != NULL)
2425 GNUNET_FS_uri_destroy (sr->uri);
2426 if (sr->meta != NULL)
2427 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2428 GNUNET_free (sr->serialization);
2430 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2432 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2433 _("Failure while resuming search operation `%s': %s\n"),
2442 * Send the 'resume' signal to the callback; also actually
2443 * resume the download (put it in the queue). Does this
2444 * recursively for the top-level download and all child
2447 * @param dc download to resume
2450 signal_download_resume (struct GNUNET_FS_DownloadContext *dc)
2452 struct GNUNET_FS_DownloadContext *dcc;
2453 struct GNUNET_FS_ProgressInfo pi;
2455 pi.status = GNUNET_FS_STATUS_DOWNLOAD_RESUME;
2456 pi.value.download.specifics.resume.meta = dc->meta;
2457 pi.value.download.specifics.resume.message = dc->emsg;
2458 GNUNET_FS_download_make_status_ (&pi, dc);
2459 dcc = dc->child_head;
2462 signal_download_resume (dcc);
2465 if (dc->pending_head != NULL)
2466 GNUNET_FS_download_start_downloading_ (dc);
2471 * Signal resuming of a search to our clients (for the
2472 * top level search and all sub-searches).
2474 * @param sc search being resumed
2477 signal_search_resume (struct GNUNET_FS_SearchContext *sc);
2481 * Iterator over search results signaling resume to the client for
2484 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2485 * @param key current key code
2486 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2487 * @return GNUNET_YES (we should continue to iterate)
2490 signal_result_resume (void *cls, const struct GNUNET_HashCode * key, void *value)
2492 struct GNUNET_FS_SearchContext *sc = cls;
2493 struct GNUNET_FS_ProgressInfo pi;
2494 struct GNUNET_FS_SearchResult *sr = value;
2496 if (0 == sr->mandatory_missing)
2498 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME_RESULT;
2499 pi.value.search.specifics.resume_result.meta = sr->meta;
2500 pi.value.search.specifics.resume_result.uri = sr->uri;
2501 pi.value.search.specifics.resume_result.result = sr;
2502 pi.value.search.specifics.resume_result.availability_rank =
2503 2 * sr->availability_success - sr->availability_trials;
2504 pi.value.search.specifics.resume_result.availability_certainty =
2505 sr->availability_trials;
2506 pi.value.search.specifics.resume_result.applicability_rank =
2507 sr->optional_support;
2508 sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
2510 if (sr->download != NULL)
2512 signal_download_resume (sr->download);
2516 GNUNET_FS_search_start_probe_ (sr);
2518 if (sr->update_search != NULL)
2519 signal_search_resume (sr->update_search);
2525 * Free memory allocated by the search context and its children
2527 * @param sc search context to free
2530 free_search_context (struct GNUNET_FS_SearchContext *sc);
2534 * Iterator over search results freeing each.
2536 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2537 * @param key current key code
2538 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2539 * @return GNUNET_YES (we should continue to iterate)
2542 free_result (void *cls, const struct GNUNET_HashCode * key, void *value)
2544 struct GNUNET_FS_SearchResult *sr = value;
2546 if (sr->update_search != NULL)
2548 free_search_context (sr->update_search);
2549 GNUNET_assert (NULL == sr->update_search);
2551 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2552 GNUNET_FS_uri_destroy (sr->uri);
2559 * Free memory allocated by the search context and its children
2561 * @param sc search context to free
2564 free_search_context (struct GNUNET_FS_SearchContext *sc)
2566 if (sc->serialization != NULL)
2568 GNUNET_FS_remove_sync_file_ (sc->h,
2569 (sc->psearch_result ==
2570 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2571 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2573 GNUNET_FS_remove_sync_dir_ (sc->h,
2574 (sc->psearch_result ==
2575 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2576 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2579 GNUNET_free_non_null (sc->serialization);
2580 GNUNET_free_non_null (sc->emsg);
2581 if (sc->uri != NULL)
2582 GNUNET_FS_uri_destroy (sc->uri);
2583 if (sc->master_result_map != NULL)
2585 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map, &free_result,
2587 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
2594 * Function called with a filename of serialized sub-download
2597 * @param cls the 'struct GNUNET_FS_DownloadContext*' (parent)
2598 * @param filename complete filename (absolute path)
2599 * @return GNUNET_OK (continue to iterate)
2602 deserialize_subdownload (void *cls, const char *filename)
2604 struct GNUNET_FS_DownloadContext *parent = cls;
2607 struct GNUNET_BIO_ReadHandle *rh;
2609 ser = get_serialization_short_name (filename);
2610 rh = GNUNET_BIO_read_open (filename);
2613 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2615 ("Failed to resume sub-download `%s': could not open file `%s'\n"),
2620 deserialize_download (parent->h, rh, parent, NULL, ser);
2621 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2623 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2624 _("Failed to resume sub-download `%s': %s\n"), ser, emsg);
2633 * Free this download context and all of its descendants.
2634 * (only works during deserialization since not all possible
2635 * state it taken care of).
2637 * @param dc context to free
2640 free_download_context (struct GNUNET_FS_DownloadContext *dc)
2642 struct GNUNET_FS_DownloadContext *dcc;
2644 if (dc->meta != NULL)
2645 GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2646 if (dc->uri != NULL)
2647 GNUNET_FS_uri_destroy (dc->uri);
2648 GNUNET_free_non_null (dc->temp_filename);
2649 GNUNET_free_non_null (dc->emsg);
2650 GNUNET_free_non_null (dc->filename);
2651 GNUNET_free_non_null (dc->serialization);
2652 while (NULL != (dcc = dc->child_head))
2654 GNUNET_CONTAINER_DLL_remove (dc->child_head, dc->child_tail, dcc);
2655 free_download_context (dcc);
2657 GNUNET_FS_free_download_request_ (dc->top_request);
2658 if (NULL != dc->active)
2659 GNUNET_CONTAINER_multihashmap_destroy (dc->active);
2665 * Deserialize a download.
2667 * @param h overall context
2668 * @param rh file to deserialize from
2669 * @param parent parent download
2670 * @param search associated search
2671 * @param serialization name under which the search was serialized
2674 deserialize_download (struct GNUNET_FS_Handle *h,
2675 struct GNUNET_BIO_ReadHandle *rh,
2676 struct GNUNET_FS_DownloadContext *parent,
2677 struct GNUNET_FS_SearchResult *search,
2678 const char *serialization)
2680 struct GNUNET_FS_DownloadContext *dc;
2689 dc = GNUNET_malloc (sizeof (struct GNUNET_FS_DownloadContext));
2690 dc->parent = parent;
2692 dc->serialization = GNUNET_strdup (serialization);
2694 GNUNET_BIO_read_string (rh, "download-uri", &uris, 10 * 1024)) ||
2695 (NULL == (dc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2696 ((GNUNET_YES != GNUNET_FS_uri_test_chk (dc->uri)) &&
2697 (GNUNET_YES != GNUNET_FS_uri_test_loc (dc->uri))) ||
2698 (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "download-meta", &dc->meta))
2700 GNUNET_BIO_read_string (rh, "download-emsg", &dc->emsg, 10 * 1024)) ||
2702 GNUNET_BIO_read_string (rh, "download-fn", &dc->filename, 10 * 1024)) ||
2704 GNUNET_BIO_read_string (rh, "download-tfn", &dc->temp_filename,
2706 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->old_file_size)) ||
2707 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->offset)) ||
2708 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->length)) ||
2709 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->completed)) ||
2710 (GNUNET_OK != read_start_time (rh, &dc->start_time)) ||
2711 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dc->anonymity)) ||
2712 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2713 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &status)))
2718 dc->options = (enum GNUNET_FS_DownloadOptions) options;
2720 GNUNET_CONTAINER_multihashmap_create (1 + 2 * (dc->length / DBLOCK_SIZE));
2721 dc->has_finished = (int) status;
2723 GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size (dc->uri));
2724 if (GNUNET_FS_uri_test_loc (dc->uri))
2725 GNUNET_assert (GNUNET_OK ==
2726 GNUNET_FS_uri_loc_get_peer_identity (dc->uri, &dc->target));
2727 if (dc->emsg == NULL)
2729 dc->top_request = read_download_request (rh);
2730 if (dc->top_request == NULL)
2736 dn = get_download_sync_filename (dc, dc->serialization, ".dir");
2739 if (GNUNET_YES == GNUNET_DISK_directory_test (dn))
2740 GNUNET_DISK_directory_scan (dn, &deserialize_subdownload, dc);
2745 GNUNET_abort (); // for debugging for now - FIXME
2746 GNUNET_CONTAINER_DLL_insert (parent->child_head, parent->child_tail, dc);
2750 dc->search = search;
2751 search->download = dc;
2753 if ((parent == NULL) && (search == NULL))
2756 GNUNET_FS_make_top (dc->h, &GNUNET_FS_download_signal_suspend_, dc);
2757 signal_download_resume (dc);
2760 dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_, dc);
2763 GNUNET_free_non_null (uris);
2764 GNUNET_free_non_null (emsg);
2765 free_download_context (dc);
2770 * Signal resuming of a search to our clients (for the
2771 * top level search and all sub-searches).
2773 * @param sc search being resumed
2776 signal_search_resume (struct GNUNET_FS_SearchContext *sc)
2778 struct GNUNET_FS_ProgressInfo pi;
2780 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME;
2781 pi.value.search.specifics.resume.message = sc->emsg;
2782 pi.value.search.specifics.resume.is_paused =
2783 (sc->client == NULL) ? GNUNET_YES : GNUNET_NO;
2784 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
2785 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2786 &signal_result_resume, sc);
2792 * Deserialize a search.
2794 * @param h overall context
2795 * @param rh file to deserialize from
2796 * @param psearch_result parent search result
2797 * @param serialization name under which the search was serialized
2799 static struct GNUNET_FS_SearchContext *
2800 deserialize_search (struct GNUNET_FS_Handle *h,
2801 struct GNUNET_BIO_ReadHandle *rh,
2802 struct GNUNET_FS_SearchResult *psearch_result,
2803 const char *serialization)
2805 struct GNUNET_FS_SearchContext *sc;
2812 if ((psearch_result != NULL) && (psearch_result->update_search != NULL))
2819 sc = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchContext));
2820 if (psearch_result != NULL)
2822 sc->psearch_result = psearch_result;
2823 psearch_result->update_search = sc;
2826 sc->serialization = GNUNET_strdup (serialization);
2827 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "search-uri", &uris, 10 * 1024))
2828 || (NULL == (sc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2829 ((GNUNET_YES != GNUNET_FS_uri_test_ksk (sc->uri)) &&
2830 (GNUNET_YES != GNUNET_FS_uri_test_sks (sc->uri))) ||
2831 (GNUNET_OK != read_start_time (rh, &sc->start_time)) ||
2833 GNUNET_BIO_read_string (rh, "search-emsg", &sc->emsg, 10 * 1024)) ||
2834 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2836 GNUNET_BIO_read (rh, "search-pause", &in_pause, sizeof (in_pause))) ||
2837 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sc->anonymity)))
2842 sc->options = (enum GNUNET_FS_SearchOptions) options;
2843 sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16);
2844 dn = get_serialization_file_name_in_dir (h,
2845 (sc->psearch_result ==
2847 GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2848 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2849 sc->serialization, "");
2852 if (GNUNET_YES == GNUNET_DISK_directory_test (dn))
2853 GNUNET_DISK_directory_scan (dn, &deserialize_search_result, sc);
2856 if (('\0' == in_pause) &&
2857 (GNUNET_OK != GNUNET_FS_search_start_searching_ (sc)))
2859 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2861 ("Could not resume running search, will resume as paused search\n"));
2863 signal_search_resume (sc);
2867 GNUNET_free_non_null (emsg);
2868 free_search_context (sc);
2869 GNUNET_free_non_null (uris);
2875 * Function called with a filename of serialized search operation
2878 * @param cls the 'struct GNUNET_FS_Handle*'
2879 * @param filename complete filename (absolute path)
2880 * @return GNUNET_OK (continue to iterate)
2883 deserialize_search_file (void *cls, const char *filename)
2885 struct GNUNET_FS_Handle *h = cls;
2888 struct GNUNET_BIO_ReadHandle *rh;
2889 struct GNUNET_FS_SearchContext *sc;
2892 if (0 != STAT (filename, &buf))
2894 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "stat", filename);
2897 if (S_ISDIR (buf.st_mode))
2898 return GNUNET_OK; /* skip directories */
2899 ser = get_serialization_short_name (filename);
2900 rh = GNUNET_BIO_read_open (filename);
2905 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_SEARCH, ser);
2910 sc = deserialize_search (h, rh, NULL, ser);
2912 sc->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, sc);
2914 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2916 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2917 _("Failure while resuming search operation `%s': %s\n"),
2926 * Function called with a filename of serialized download operation
2929 * @param cls the 'struct GNUNET_FS_Handle*'
2930 * @param filename complete filename (absolute path)
2931 * @return GNUNET_OK (continue to iterate)
2934 deserialize_download_file (void *cls, const char *filename)
2936 struct GNUNET_FS_Handle *h = cls;
2939 struct GNUNET_BIO_ReadHandle *rh;
2941 ser = get_serialization_short_name (filename);
2942 rh = GNUNET_BIO_read_open (filename);
2945 if (0 != UNLINK (filename))
2946 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
2950 deserialize_download (h, rh, NULL, NULL, ser);
2952 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2954 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2955 _("Failure while resuming download operation `%s': %s\n"),
2964 * Deserialize informatin about pending operations.
2966 * @param master_path which master directory should be scanned
2967 * @param proc function to call for each entry (will get 'h' for 'cls')
2968 * @param h the 'struct GNUNET_FS_Handle*'
2971 deserialization_master (const char *master_path, GNUNET_FileNameCallback proc,
2972 struct GNUNET_FS_Handle *h)
2976 dn = get_serialization_file_name (h, master_path, "");
2979 if (GNUNET_YES == GNUNET_DISK_directory_test (dn))
2980 GNUNET_DISK_directory_scan (dn, proc, h);
2986 * Setup a connection to the file-sharing service.
2988 * @param cfg configuration to use
2989 * @param client_name unique identifier for this client
2990 * @param upcb function to call to notify about FS actions
2991 * @param upcb_cls closure for upcb
2992 * @param flags specific attributes for fs-operations
2993 * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
2994 * @return NULL on error
2996 struct GNUNET_FS_Handle *
2997 GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
2998 const char *client_name, GNUNET_FS_ProgressCallback upcb,
2999 void *upcb_cls, enum GNUNET_FS_Flags flags, ...)
3001 struct GNUNET_FS_Handle *ret;
3002 enum GNUNET_FS_OPTIONS opt;
3005 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Handle));
3007 ret->client_name = GNUNET_strdup (client_name);
3009 ret->upcb_cls = upcb_cls;
3011 ret->max_parallel_downloads = DEFAULT_MAX_PARALLEL_DOWNLOADS;
3012 ret->max_parallel_requests = DEFAULT_MAX_PARALLEL_REQUESTS;
3013 ret->avg_block_latency = GNUNET_TIME_UNIT_MINUTES; /* conservative starting point */
3014 va_start (ap, flags);
3015 while (GNUNET_FS_OPTIONS_END != (opt = va_arg (ap, enum GNUNET_FS_OPTIONS)))
3019 case GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM:
3020 ret->max_parallel_downloads = va_arg (ap, unsigned int);
3023 case GNUNET_FS_OPTIONS_REQUEST_PARALLELISM:
3024 ret->max_parallel_requests = va_arg (ap, unsigned int);
3029 GNUNET_free (ret->client_name);
3036 if (0 != (GNUNET_FS_FLAGS_PERSISTENCE & flags))
3038 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
3039 &deserialize_publish_file, ret);
3040 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
3041 &deserialize_search_file, ret);
3042 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
3043 &deserialize_download_file, ret);
3044 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
3045 &deserialize_unindex_file, ret);
3052 * Close our connection with the file-sharing service.
3053 * The callback given to GNUNET_FS_start will no longer be
3054 * called after this function returns.
3056 * @param h handle that was returned from GNUNET_FS_start
3059 GNUNET_FS_stop (struct GNUNET_FS_Handle *h)
3061 while (h->top_head != NULL)
3062 h->top_head->ssf (h->top_head->ssf_cls);
3063 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
3064 GNUNET_SCHEDULER_cancel (h->queue_job);
3065 GNUNET_free (h->client_name);