tolerate additional IPv4 address now available for gnunet.org
[oweals/gnunet.git] / src / fs / fs_api.c
index eb692a93efa4df0e2859c4afd6d56606529d05cf..aec5ff3405b997eb02c11430ad5f341025c2aa40 100644 (file)
@@ -1,21 +1,21 @@
 /*
      This file is part of GNUnet.
-     Copyright (C) 2001--2012 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2001--2012 GNUnet e.V.
 
-     GNUnet is free software; you can redistribute it and/or modify
-     it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 3, or (at your
-     option) any later version.
+     GNUnet is free software: you can redistribute it and/or modify it
+     under the terms of the GNU Affero General Public License as published
+     by the Free Software Foundation, either version 3 of the License,
+     or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-     General Public License for more details.
+     Affero General Public License for more details.
+    
+     You should have received a copy of the GNU Affero General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-     You should have received a copy of the GNU General Public License
-     along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
 /**
 static void
 start_job (struct GNUNET_FS_QueueEntry *qe)
 {
-  GNUNET_assert (NULL == qe->client);
-  qe->client = GNUNET_CLIENT_connect ("fs", qe->h->cfg);
-  if (NULL == qe->client)
-  {
-    GNUNET_break (0);
-    return;
-  }
-  qe->start (qe->cls, qe->client);
+  qe->active = GNUNET_YES;
+  qe->start (qe->cls);
   qe->start_times++;
   qe->h->active_blocks += qe->blocks;
   qe->h->active_downloads++;
@@ -84,7 +78,7 @@ start_job (struct GNUNET_FS_QueueEntry *qe)
 static void
 stop_job (struct GNUNET_FS_QueueEntry *qe)
 {
-  qe->client = NULL;
+  qe->active = GNUNET_NO;
   qe->stop (qe->cls);
   GNUNET_assert (0 < qe->h->active_downloads);
   qe->h->active_downloads--;
@@ -97,9 +91,13 @@ stop_job (struct GNUNET_FS_QueueEntry *qe)
              "Stopping job %p (%u active)\n",
              qe,
              qe->h->active_downloads);
-  GNUNET_CONTAINER_DLL_remove (qe->h->running_head, qe->h->running_tail, qe);
-  GNUNET_CONTAINER_DLL_insert_after (qe->h->pending_head, qe->h->pending_tail,
-                                     qe->h->pending_tail, qe);
+  GNUNET_CONTAINER_DLL_remove (qe->h->running_head,
+                               qe->h->running_tail,
+                               qe);
+  GNUNET_CONTAINER_DLL_insert_after (qe->h->pending_head,
+                                     qe->h->pending_tail,
+                                     qe->h->pending_tail,
+                                     qe);
 }
 
 
@@ -108,11 +106,9 @@ stop_job (struct GNUNET_FS_QueueEntry *qe)
  * and stopping others.
  *
  * @param cls the `struct GNUNET_FS_Handle *`
- * @param tc scheduler context
  */
 static void
-process_job_queue (void *cls,
-                   const struct GNUNET_SCHEDULER_TaskContext *tc)
+process_job_queue (void *cls)
 {
   struct GNUNET_FS_Handle *h = cls;
   struct GNUNET_FS_QueueEntry *qe;
@@ -182,8 +178,8 @@ process_job_queue (void *cls,
       break;
     case GNUNET_FS_QUEUE_PRIORITY_NORMAL:
       run_time =
-        GNUNET_TIME_relative_multiply (h->avg_block_latency,
-                                       qe->blocks * qe->start_times);
+        GNUNET_TIME_relative_saturating_multiply (h->avg_block_latency,
+                                                  qe->blocks * qe->start_times);
       end_time = GNUNET_TIME_absolute_add (qe->start_time, run_time);
       rst = GNUNET_TIME_absolute_get_remaining (end_time);
       if (0 == rst.rel_value_us)
@@ -202,6 +198,8 @@ process_job_queue (void *cls,
       break;
     }
   }
+  GNUNET_break (h->active_downloads ==
+                num_downloads_active + num_probes_active);
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "PA: %u, PE: %u, PW: %u; DA: %u, DE: %u, DW: %u\n",
              num_probes_active,
@@ -210,6 +208,8 @@ process_job_queue (void *cls,
              num_downloads_active,
              num_downloads_expired,
              num_downloads_waiting);
+  GNUNET_break (h->active_downloads + num_probes_active <=
+                h->max_parallel_downloads);
   /* calculate start/stop decisions */
   if (h->active_downloads + num_downloads_waiting > h->max_parallel_downloads)
   {
@@ -225,17 +225,19 @@ process_job_queue (void *cls,
     /* start all downloads (we can) */
     num_downloads_change = num_downloads_waiting;
     /* also start probes if there is room, but use a lower cap of (mpd/4) + 1 */
-    if (h->max_parallel_downloads / 2 >= (h->active_downloads + num_downloads_change))
+    if (1 + h->max_parallel_downloads / 4 >= (h->active_downloads + num_downloads_change))
       num_probes_change = GNUNET_MIN (num_probes_waiting,
                                       (1 + h->max_parallel_downloads / 4) - (h->active_downloads + num_downloads_change));
     else
       num_probes_change = 0;
   }
-
+  GNUNET_break (num_downloads_change <= num_downloads_waiting);
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-             "Changing %d probes and %d downloads\n",
+             "Changing %d probes and %d/%u/%u downloads\n",
              num_probes_change,
-             num_downloads_change);
+             num_downloads_change,
+              (unsigned int) h->active_downloads,
+              (unsigned int) h->max_parallel_downloads);
   /* actually stop probes */
   next = h->running_head;
   while (NULL != (qe = next))
@@ -289,7 +291,8 @@ process_job_queue (void *cls,
       break;
     }
   }
-  GNUNET_break ( (0 == num_downloads_change) || (GNUNET_YES == block_limit_hit) );
+  GNUNET_break ( (0 == num_downloads_change) ||
+                 (GNUNET_YES == block_limit_hit) );
   GNUNET_break (0 == num_probes_change);
 
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
@@ -300,7 +303,11 @@ process_job_queue (void *cls,
              num_downloads_change,
              GNUNET_STRINGS_relative_time_to_string (restart_at, GNUNET_YES));
 
-  /* make sure we run again */
+  /* make sure we run again, callbacks might have
+     already re-scheduled the job, so cancel such
+     an operation (if it exists) */
+  if (NULL != h->queue_job)
+    GNUNET_SCHEDULER_cancel (h->queue_job);
   h->queue_job =
       GNUNET_SCHEDULER_add_delayed (restart_at, &process_job_queue, h);
 }
@@ -319,8 +326,9 @@ process_job_queue (void *cls,
  */
 struct GNUNET_FS_QueueEntry *
 GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h,
-                  GNUNET_FS_QueueStart start,
-                  GNUNET_FS_QueueStop stop, void *cls,
+                  GNUNET_SCHEDULER_TaskCallback start,
+                  GNUNET_SCHEDULER_TaskCallback stop,
+                  void *cls,
                   unsigned int blocks,
                  enum GNUNET_FS_QueuePriority priority)
 {
@@ -336,7 +344,7 @@ GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h,
   qe->priority = priority;
   GNUNET_CONTAINER_DLL_insert_after (h->pending_head, h->pending_tail,
                                      h->pending_tail, qe);
-  if (h->queue_job != NULL)
+  if (NULL != h->queue_job)
     GNUNET_SCHEDULER_cancel (h->queue_job);
   h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h);
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
@@ -360,13 +368,16 @@ GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qe)
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Dequeueing job %p\n",
              qe);
-  if (NULL != qe->client)
+  if (GNUNET_YES == qe->active)
     stop_job (qe);
-  GNUNET_CONTAINER_DLL_remove (h->pending_head, h->pending_tail, qe);
+  GNUNET_CONTAINER_DLL_remove (h->pending_head,
+                               h->pending_tail,
+                               qe);
   GNUNET_free (qe);
-  if (h->queue_job != NULL)
+  if (NULL != h->queue_job)
     GNUNET_SCHEDULER_cancel (h->queue_job);
-  h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h);
+  h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue,
+                                           h);
 }
 
 
@@ -388,7 +399,9 @@ GNUNET_FS_make_top (struct GNUNET_FS_Handle *h,
   ret = GNUNET_new (struct TopLevelActivity);
   ret->ssf = ssf;
   ret->ssf_cls = ssf_cls;
-  GNUNET_CONTAINER_DLL_insert (h->top_head, h->top_tail, ret);
+  GNUNET_CONTAINER_DLL_insert (h->top_head,
+                               h->top_tail,
+                               ret);
   return ret;
 }
 
@@ -403,7 +416,9 @@ void
 GNUNET_FS_end_top (struct GNUNET_FS_Handle *h,
                    struct TopLevelActivity *top)
 {
-  GNUNET_CONTAINER_DLL_remove (h->top_head, h->top_tail, top);
+  GNUNET_CONTAINER_DLL_remove (h->top_head,
+                               h->top_tail,
+                               top);
   GNUNET_free (top);
 }
 
@@ -566,7 +581,7 @@ GNUNET_FS_data_reader_copy_ (void *cls,
     GNUNET_free_non_null (data);
     return 0;
   }
-  memcpy (buf, &data[offset], max);
+  GNUNET_memcpy (buf, &data[offset], max);
   return max;
 }
 
@@ -1632,7 +1647,9 @@ deserialize_publish_file (void *cls,
                 filename, emsg);
     GNUNET_free (emsg);
   }
-  pc->top = GNUNET_FS_make_top (h, &GNUNET_FS_publish_signal_suspend_, pc);
+  pc->top = GNUNET_FS_make_top (h,
+                                &GNUNET_FS_publish_signal_suspend_,
+                                pc);
   return GNUNET_OK;
 cleanup:
   GNUNET_free_non_null (pc->nid);
@@ -2263,7 +2280,9 @@ deserialize_unindex_file (void *cls,
     GNUNET_break (0);
     goto cleanup;
   }
-  uc->top = GNUNET_FS_make_top (h, &GNUNET_FS_unindex_signal_suspend_, uc);
+  uc->top = GNUNET_FS_make_top (h,
+                                &GNUNET_FS_unindex_signal_suspend_,
+                                uc);
   pi.status = GNUNET_FS_STATUS_UNINDEX_RESUME;
   pi.value.unindex.specifics.resume.message = uc->emsg;
   GNUNET_FS_unindex_make_status_ (&pi, uc,
@@ -2522,8 +2541,6 @@ signal_download_resume (struct GNUNET_FS_DownloadContext *dc)
     signal_download_resume (dcc);
     dcc = dcc->next;
   }
-  if (NULL != dc->pending_head)
-    GNUNET_FS_download_start_downloading_ (dc);
 }
 
 
@@ -2792,7 +2809,8 @@ deserialize_download (struct GNUNET_FS_Handle *h,
       GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size (dc->uri));
   if (GNUNET_FS_uri_test_loc (dc->uri))
     GNUNET_assert (GNUNET_OK ==
-                   GNUNET_FS_uri_loc_get_peer_identity (dc->uri, &dc->target));
+                   GNUNET_FS_uri_loc_get_peer_identity (dc->uri,
+                                                        &dc->target));
   if (NULL == dc->emsg)
   {
     dc->top_request = read_download_request (rh);
@@ -2802,30 +2820,43 @@ deserialize_download (struct GNUNET_FS_Handle *h,
       goto cleanup;
     }
   }
-  dn = get_download_sync_filename (dc, dc->serialization, ".dir");
+  dn = get_download_sync_filename (dc,
+                                   dc->serialization,
+                                   ".dir");
   if (NULL != dn)
   {
-    if (GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES))
-      GNUNET_DISK_directory_scan (dn, &deserialize_subdownload, dc);
+    if (GNUNET_YES ==
+        GNUNET_DISK_directory_test (dn,
+                                    GNUNET_YES))
+      GNUNET_DISK_directory_scan (dn,
+                                  &deserialize_subdownload,
+                                  dc);
     GNUNET_free (dn);
   }
   if (NULL != parent)
   {
-    GNUNET_CONTAINER_DLL_insert (parent->child_head, parent->child_tail, dc);
+    GNUNET_CONTAINER_DLL_insert (parent->child_head,
+                                 parent->child_tail,
+                                 dc);
   }
   if (NULL != search)
   {
     dc->search = search;
     search->download = dc;
   }
-  if ((NULL == parent) && (NULL == search))
+  if ( (NULL == parent) &&
+       (NULL == search) )
   {
-    dc->top =
-        GNUNET_FS_make_top (dc->h, &GNUNET_FS_download_signal_suspend_, dc);
+    dc->top
+      = GNUNET_FS_make_top (dc->h,
+                            &GNUNET_FS_download_signal_suspend_,
+                            dc);
     signal_download_resume (dc);
   }
   GNUNET_free (uris);
-  dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_, dc);
+  GNUNET_assert (NULL == dc->job_queue);
+  dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_,
+                                       dc);
   return;
 cleanup:
   GNUNET_free_non_null (uris);
@@ -2848,7 +2879,7 @@ signal_search_resume (struct GNUNET_FS_SearchContext *sc)
   pi.status = GNUNET_FS_STATUS_SEARCH_RESUME;
   pi.value.search.specifics.resume.message = sc->emsg;
   pi.value.search.specifics.resume.is_paused =
-      (NULL == sc->client) ? GNUNET_YES : GNUNET_NO;
+      (NULL == sc->mq) ? GNUNET_YES : GNUNET_NO;
   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
                                          &signal_result_resume, sc);
@@ -3032,11 +3063,12 @@ deserialize_download_file (void *cls, const char *filename)
  * Deserialize informatin about pending operations.
  *
  * @param master_path which master directory should be scanned
- * @param proc function to call for each entry (will get 'h' for 'cls')
- * @param h the 'struct GNUNET_FS_Handle*'
+ * @param proc function to call for each entry (will get @a h for 'cls')
+ * @param h the `struct GNUNET_FS_Handle *`
  */
 static void
-deserialization_master (const char *master_path, GNUNET_FileNameCallback proc,
+deserialization_master (const char *master_path,
+                       GNUNET_FileNameCallback proc,
                         struct GNUNET_FS_Handle *h)
 {
   char *dn;
@@ -3082,7 +3114,7 @@ GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
   ret->max_parallel_requests = DEFAULT_MAX_PARALLEL_REQUESTS;
   ret->avg_block_latency = GNUNET_TIME_UNIT_MINUTES;    /* conservative starting point */
   va_start (ap, flags);
-  while (GNUNET_FS_OPTIONS_END != (opt = va_arg (ap, enum GNUNET_FS_OPTIONS)))
+  while (GNUNET_FS_OPTIONS_END != (opt = GNUNET_VA_ARG_ENUM (ap,GNUNET_FS_OPTIONS)))
   {
     switch (opt)
     {
@@ -3120,17 +3152,19 @@ GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 
 /**
  * Close our connection with the file-sharing service.
- * The callback given to GNUNET_FS_start will no longer be
+ * The callback given to #GNUNET_FS_start() will no longer be
  * called after this function returns.
+ * This function MUST NOT be called from within the
+ * callback itself.
  *
  * @param h handle that was returned from #GNUNET_FS_start()
  */
 void
 GNUNET_FS_stop (struct GNUNET_FS_Handle *h)
 {
-  while (h->top_head != NULL)
+  while (NULL != h->top_head)
     h->top_head->ssf (h->top_head->ssf_cls);
-  if (h->queue_job != NULL)
+  if (NULL != h->queue_job)
     GNUNET_SCHEDULER_cancel (h->queue_job);
   GNUNET_free (h->client_name);
   GNUNET_free (h);