use new connecT API
[oweals/gnunet.git] / src / consensus / gnunet-service-consensus.c
index b1c8466cb2b9890558b6fa23eccacad9b9b2b300..99e7aca978a6c8199f71703aad61203ad3bcced0 100644 (file)
@@ -1,6 +1,6 @@
 /*
       This file is part of GNUnet
-      Copyright (C) 2012, 2013 Christian Grothoff (and other contributing authors)
+      Copyright (C) 2012, 2013 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
@@ -29,6 +29,7 @@
 #include "gnunet_protocols.h"
 #include "gnunet_applications.h"
 #include "gnunet_set_service.h"
+#include "gnunet_statistics_service.h"
 #include "gnunet_consensus_service.h"
 #include "consensus_protocol.h"
 #include "consensus.h"
@@ -54,6 +55,14 @@ enum ReferendumVote
 };
 
 
+enum EarlyStoppingPhase
+{
+  EARLY_STOPPING_NONE = 0,
+  EARLY_STOPPING_ONE_MORE = 1,
+  EARLY_STOPPING_DONE = 2,
+};
+
+
 GNUNET_NETWORK_STRUCT_BEGIN
 
 
@@ -156,6 +165,10 @@ enum SetKind
 {
   SET_KIND_NONE = 0,
   SET_KIND_CURRENT,
+  /**
+   * Last result set from a gradecast
+   */
+  SET_KIND_LAST_GRADECAST,
   SET_KIND_LEADER_PROPOSAL,
   SET_KIND_ECHO_RESULT,
 };
@@ -248,6 +261,9 @@ struct Step
 
   struct ConsensusSession *session;
 
+  /**
+   * Tasks that this step is composed of.
+   */
   struct TaskEntry **tasks;
   unsigned int tasks_len;
   unsigned int tasks_cap;
@@ -292,6 +308,19 @@ struct Step
    * the task, used for debugging.
    */
   char *debug_name;
+
+  /**
+   * When we're doing an early finish, how should this step be
+   * treated?
+   * If GNUNET_YES, the step will be marked as finished
+   * without actually running its tasks.
+   * Otherwise, the step will still be run even after
+   * an early finish.
+   *
+   * Note that a task may never be finished early if
+   * it is already running.
+   */
+  int early_finishable;
 };
 
 
@@ -458,6 +487,11 @@ struct ConsensusSession
    * Uses the session's global id as app id.
    */
   struct GNUNET_SET_ListenHandle *set_listener;
+
+  /**
+   * State of our early stopping scheme.
+   */
+  int early_stopping;
 };
 
 /**
@@ -485,6 +519,11 @@ static struct GNUNET_SERVER_Handle *srv;
  */
 static struct GNUNET_PeerIdentity my_peer;
 
+/**
+ * Statistics handle.
+ */
+struct GNUNET_STATISTICS_Handle *statistics;
+
 
 static void
 finish_task (struct TaskEntry *task);
@@ -1226,6 +1265,14 @@ commit_set (struct ConsensusSession *session,
     struct Evilness evil;
 
     get_evilness (session, &evil);
+    if (EVILNESS_NONE != evil.type)
+    {
+      /* Useful for evaluation */
+      GNUNET_STATISTICS_set (statistics,
+                             "is evil",
+                             1,
+                             GNUNET_NO);
+    }
     switch (evil.type)
     {
       case EVILNESS_CRAM_ALL:
@@ -1240,7 +1287,8 @@ commit_set (struct ConsensusSession *session,
           GNUNET_SET_commit (setop->op, set->h);
           break;
         }
-        if ((EVILNESS_CRAM_LEAD == evil.type) && (PHASE_KIND_GRADECAST_LEADER != task->key.kind))
+        if ((EVILNESS_CRAM_LEAD == evil.type) &&
+            ((PHASE_KIND_GRADECAST_LEADER != task->key.kind) || SET_KIND_CURRENT != set->key.set_kind))
         {
           GNUNET_SET_commit (setop->op, set->h);
           break;
@@ -1282,6 +1330,10 @@ commit_set (struct ConsensusSession *session,
                       debug_str_task_key (&task->key));
 #endif
         }
+        GNUNET_STATISTICS_update (statistics,
+                                  "# stuffed elements",
+                                  evil.num,
+                                  GNUNET_NO);
         GNUNET_SET_commit (setop->op, set->h);
         break;
       case EVILNESS_SLACK:
@@ -1348,9 +1400,9 @@ put_set (struct ConsensusSession *session,
               debug_str_set_key (&set->key));
 
   GNUNET_CRYPTO_hash (&set->key, sizeof (struct SetKey), &hash);
-  GNUNET_assert (GNUNET_OK ==
+  GNUNET_assert (GNUNET_SYSERR !=
                  GNUNET_CONTAINER_multihashmap_put (session->setmap, &hash, set,
-                                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
+                                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE));
 }
 
 
@@ -1468,6 +1520,11 @@ diff_destroy (struct DiffEntry *diff)
 }
 
 
+/**
+ * For a given majority, count what the outcome
+ * is (add/remove/keep), and give the number
+ * of peers that voted for this outcome.
+ */
 static void
 rfn_majority (const struct ReferendumEntry *rfn,
               const struct RfnElementInfo *ri,
@@ -1586,6 +1643,89 @@ set_mutation_done (void *cls)
   }
 }
 
+
+static void
+try_finish_step_early (struct Step *step)
+{
+  unsigned int i;
+
+  if (GNUNET_YES == step->is_running)
+    return;
+  if (GNUNET_YES == step->is_finished)
+    return;
+  if (GNUNET_NO == step->early_finishable)
+    return;
+
+  step->is_finished = GNUNET_YES;
+
+#ifdef GNUNET_EXTRA_LOGGING
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Finishing step `%s' early.\n",
+              step->debug_name);
+#endif
+
+  for (i = 0; i < step->subordinates_len; i++)
+  {
+    GNUNET_assert (step->subordinates[i]->pending_prereq > 0);
+    step->subordinates[i]->pending_prereq--;
+#ifdef GNUNET_EXTRA_LOGGING
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+                "Decreased pending_prereq to %u for step `%s'.\n",
+                step->subordinates[i]->pending_prereq,
+                step->subordinates[i]->debug_name);
+
+#endif
+    try_finish_step_early (step->subordinates[i]);
+  }
+
+  // XXX: maybe schedule as task to avoid recursion?
+  run_ready_steps (step->session);
+}
+
+
+static void
+finish_step (struct Step *step)
+{
+  unsigned int i;
+
+  GNUNET_assert (step->finished_tasks == step->tasks_len);
+  GNUNET_assert (GNUNET_YES == step->is_running);
+  GNUNET_assert (GNUNET_NO == step->is_finished);
+
+#ifdef GNUNET_EXTRA_LOGGING
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "All tasks of step `%s' with %u subordinates finished.\n",
+              step->debug_name,
+              step->subordinates_len);
+#endif
+
+  for (i = 0; i < step->subordinates_len; i++)
+  {
+    GNUNET_assert (step->subordinates[i]->pending_prereq > 0);
+    step->subordinates[i]->pending_prereq--;
+#ifdef GNUNET_EXTRA_LOGGING
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+                "Decreased pending_prereq to %u for step `%s'.\n",
+                step->subordinates[i]->pending_prereq,
+                step->subordinates[i]->debug_name);
+
+#endif
+  }
+
+  step->is_finished = GNUNET_YES;
+
+  // XXX: maybe schedule as task to avoid recursion?
+  run_ready_steps (step->session);
+}
+
+
+
+/**
+ * Apply the result from one round of gradecasts (i.e. every peer
+ * should have gradecasted) to the peer's current set.
+ *
+ * @param task the task with context information
+ */
 static void
 task_start_apply_round (struct TaskEntry *task)
 {
@@ -1598,6 +1738,7 @@ task_start_apply_round (struct TaskEntry *task)
   struct GNUNET_CONTAINER_MultiHashMapIterator *iter;
   struct RfnElementInfo *ri;
   struct SetMutationProgressCls *progress_cls;
+  uint16_t worst_majority = UINT16_MAX;
 
   sk_in = (struct SetKey) { SET_KIND_CURRENT, task->key.repetition };
   rk_in = (struct RfnKey) { RFN_KIND_GRADECAST_RESULT, task->key.repetition };
@@ -1625,6 +1766,9 @@ task_start_apply_round (struct TaskEntry *task)
 
     rfn_majority (rfn_in, ri, &majority_num, &majority_vote);
 
+    if (worst_majority > majority_num)
+      worst_majority = majority_num;
+
     switch (majority_vote)
     {
       case VOTE_ADD:
@@ -1634,6 +1778,10 @@ task_start_apply_round (struct TaskEntry *task)
                                                ri->element,
                                                set_mutation_done,
                                                progress_cls));
+        GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                    "P%u: apply round: adding element %s with %u-majority.\n",
+                    session->local_peer_idx,
+                    debug_str_element (ri->element), majority_num);
         break;
       case VOTE_REMOVE:
         progress_cls->num_pending++;
@@ -1642,8 +1790,16 @@ task_start_apply_round (struct TaskEntry *task)
                                                   ri->element,
                                                   set_mutation_done,
                                                   progress_cls));
+        GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                    "P%u: apply round: deleting element %s with %u-majority.\n",
+                    session->local_peer_idx,
+                    debug_str_element (ri->element), majority_num);
         break;
       case VOTE_STAY:
+        GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                    "P%u: apply round: keeping element %s with %u-majority.\n",
+                    session->local_peer_idx,
+                    debug_str_element (ri->element), majority_num);
         // do nothing
         break;
       default:
@@ -1658,10 +1814,53 @@ task_start_apply_round (struct TaskEntry *task)
     GNUNET_free (progress_cls);
     finish_task (task);
   }
-}
 
+  {
+    uint16_t thresh = (session->num_peers / 3) * 2;
+
+    if (worst_majority >= thresh)
+    {
+      switch (session->early_stopping)
+      {
+        case EARLY_STOPPING_NONE:
+          session->early_stopping = EARLY_STOPPING_ONE_MORE;
+          GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                      "P%u: Stopping early (after one more superround)\n",
+                      session->local_peer_idx);
+          break;
+        case EARLY_STOPPING_ONE_MORE:
+          GNUNET_log (GNUNET_ERROR_TYPE_INFO, "P%u: finishing steps due to early finish\n",
+                      session->local_peer_idx);
+          session->early_stopping = EARLY_STOPPING_DONE;
+          {
+            struct Step *step;
+            for (step = session->steps_head; NULL != step; step = step->next)
+              try_finish_step_early (step);
+          }
+          break;
+        case EARLY_STOPPING_DONE:
+          /* We shouldn't be here anymore after early stopping */
+          GNUNET_break (0);
+          break;
+        default:
+          GNUNET_assert (0);
+          break;
+      }
+    }
+    else if (EARLY_STOPPING_NONE != session->early_stopping)
+    {
+      // Our assumption about the number of bad peers
+      // has been broken.
+      GNUNET_break_op (0);
+    }
+    else
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_INFO, "P%u: NOT finishing early (majority not good enough)\n",
+                  session->local_peer_idx);
+    }
+  }
 
-#define THRESH(s) (((s)->num_peers / 3))
+}
 
 
 static void
@@ -1842,12 +2041,7 @@ task_start_reconcile (struct TaskEntry *task)
                                     set_result_cb,
                                     task);
 
-    if (GNUNET_OK != GNUNET_SET_commit (setop->op, input->h))
-    {
-      GNUNET_break (0);
-      /* XXX: cleanup? */
-      return;
-    }
+    commit_set (session, task);
   }
   else if (task->key.peer2 == session->local_peer_idx)
   {
@@ -1890,6 +2084,16 @@ task_start_eval_echo (struct TaskEntry *task)
     return;
   }
 
+
+  {
+    // FIXME: should be marked as a shallow copy, so
+    // we can destroy everything correctly
+    struct SetEntry *last_set = GNUNET_new (struct SetEntry);
+    last_set->h = output_set->h;
+    last_set->key = (struct SetKey) { SET_KIND_LAST_GRADECAST };
+    put_set (session, last_set);
+  }
+
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               "Evaluating referendum in Task {%s}\n",
               debug_str_task_key (&task->key));
@@ -1995,39 +2199,6 @@ start_task (struct ConsensusSession *session, struct TaskEntry *task)
 }
 
 
-static void finish_step (struct Step *step)
-{
-  unsigned int i;
-
-  GNUNET_assert (step->finished_tasks == step->tasks_len);
-  GNUNET_assert (GNUNET_YES == step->is_running);
-  GNUNET_assert (GNUNET_NO == step->is_finished);
-
-#ifdef GNUNET_EXTRA_LOGGING
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-              "All tasks of step `%s' with %u subordinates finished.\n",
-              step->debug_name,
-              step->subordinates_len);
-#endif
-
-  for (i = 0; i < step->subordinates_len; i++)
-  {
-    GNUNET_assert (step->subordinates[i]->pending_prereq > 0);
-    step->subordinates[i]->pending_prereq--;
-#ifdef GNUNET_EXTRA_LOGGING
-    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-                "Decreased pending_prereq to %u for step `%s'.\n",
-                step->subordinates[i]->pending_prereq,
-                step->subordinates[i]->debug_name);
-
-#endif
-  }
-
-  step->is_finished = GNUNET_YES;
-
-  // XXX: maybe schedule as task to avoid recursion?
-  run_ready_steps (step->session);
-}
 
 
 /*
@@ -2043,7 +2214,7 @@ run_ready_steps (struct ConsensusSession *session)
 
   while (NULL != step)
   {
-    if ( (GNUNET_NO == step->is_running) && (0 == step->pending_prereq) )
+    if ( (GNUNET_NO == step->is_running) && (0 == step->pending_prereq) && (GNUNET_NO == step->is_finished) )
     {
       size_t i;
 
@@ -2436,12 +2607,13 @@ step_depend_on (struct Step *step, struct Step *dep)
 
 
 static struct Step *
-create_step (struct ConsensusSession *session, int round)
+create_step (struct ConsensusSession *session, int round, int early_finishable)
 {
   struct Step *step;
   step = GNUNET_new (struct Step);
   step->session = session;
   step->round = round;
+  step->early_finishable = early_finishable;
   GNUNET_CONTAINER_DLL_insert_tail (session->steps_head,
                                     session->steps_tail,
                                     step);
@@ -2480,7 +2652,7 @@ construct_task_graph_gradecast (struct ConsensusSession *session,
 
   /* gcast step 1: leader disseminates */
 
-  step = create_step (session, round);
+  step = create_step (session, round, GNUNET_YES);
 
 #ifdef GNUNET_EXTRA_LOGGING
   GNUNET_asprintf (&step->debug_name, "disseminate leader %u rep %u", lead, rep);
@@ -2540,7 +2712,7 @@ construct_task_graph_gradecast (struct ConsensusSession *session,
   /* gcast phase 2: echo */
   prev_step = step;
   round += 1;
-  step = create_step (session, round);
+  step = create_step (session, round, GNUNET_YES);
 #ifdef GNUNET_EXTRA_LOGGING
   GNUNET_asprintf (&step->debug_name, "echo leader %u rep %u", lead, rep);
 #endif
@@ -2564,7 +2736,7 @@ construct_task_graph_gradecast (struct ConsensusSession *session,
 
   prev_step = step;
   /* Same round, since step only has local tasks */
-  step = create_step (session, round);
+  step = create_step (session, round, GNUNET_YES);
 #ifdef GNUNET_EXTRA_LOGGING
   GNUNET_asprintf (&step->debug_name, "echo grade leader %u rep %u", lead, rep);
 #endif
@@ -2580,7 +2752,7 @@ construct_task_graph_gradecast (struct ConsensusSession *session,
 
   prev_step = step;
   round += 1;
-  step = create_step (session, round);
+  step = create_step (session, round, GNUNET_YES);
 #ifdef GNUNET_EXTRA_LOGGING
   GNUNET_asprintf (&step->debug_name, "confirm leader %u rep %u", lead, rep);
 #endif
@@ -2610,7 +2782,7 @@ construct_task_graph_gradecast (struct ConsensusSession *session,
 
   prev_step = step;
   /* Same round, since step only has local tasks */
-  step = create_step (session, round);
+  step = create_step (session, round, GNUNET_YES);
 #ifdef GNUNET_EXTRA_LOGGING
   GNUNET_asprintf (&step->debug_name, "confirm grade leader %u rep %u", lead, rep);
 #endif
@@ -2661,7 +2833,7 @@ construct_task_graph (struct ConsensusSession *session)
 
   /* all-to-all step */
 
-  step = create_step (session, round);
+  step = create_step (session, round, GNUNET_NO);
 
 #ifdef GNUNET_EXTRA_LOGGING
   step->debug_name = GNUNET_strdup ("all to all");
@@ -2698,7 +2870,7 @@ construct_task_graph (struct ConsensusSession *session)
     struct Step *step_rep_end;
 
     /* Every repetition is in a separate round. */
-    step_rep_start = create_step (session, round);
+    step_rep_start = create_step (session, round, GNUNET_YES);
 #ifdef GNUNET_EXTRA_LOGGING
     GNUNET_asprintf (&step_rep_start->debug_name, "gradecast start rep %u", i);
 #endif
@@ -2707,7 +2879,7 @@ construct_task_graph (struct ConsensusSession *session)
 
     /* gradecast has three rounds */
     round += 3;
-    step_rep_end = create_step (session, round);
+    step_rep_end = create_step (session, round, GNUNET_YES);
 #ifdef GNUNET_EXTRA_LOGGING
     GNUNET_asprintf (&step_rep_end->debug_name, "gradecast end rep %u", i);
 #endif
@@ -2729,7 +2901,7 @@ construct_task_graph (struct ConsensusSession *session)
  /* There is no next gradecast round, thus the final
     start step is the overall end step of the gradecasts */
   round += 1;
-  step = create_step (session, round);
+  step = create_step (session, round, GNUNET_NO);
 #ifdef GNUNET_EXTRA_LOGGING
   GNUNET_asprintf (&step->debug_name, "finish");
 #endif
@@ -2740,7 +2912,7 @@ construct_task_graph (struct ConsensusSession *session)
     .key = (struct TaskKey) { PHASE_KIND_FINISH, -1, -1, -1, -1 },
     .start = task_start_finish,
   });
-  task.cls.finish.input_set = (struct SetKey) { SET_KIND_CURRENT, t + 1 };
+  task.cls.finish.input_set = (struct SetKey) { SET_KIND_LAST_GRADECAST };
 
   put_task (session->taskmap, &task);
 }
@@ -2997,15 +3169,14 @@ client_conclude (void *cls,
  * Called to clean up, after a shutdown has been requested.
  *
  * @param cls closure
- * @param tc context information (why was this task triggered now)
  */
 static void
-shutdown_task (void *cls,
-               const struct GNUNET_SCHEDULER_TaskContext *tc)
+shutdown_task (void *cls)
 {
   while (NULL != sessions_head)
     destroy_session (sessions_head);
 
+  GNUNET_STATISTICS_destroy (statistics, GNUNET_YES);
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "handled shutdown request\n");
 }
 
@@ -3058,8 +3229,9 @@ run (void *cls, struct GNUNET_SERVER_Handle *server,
     GNUNET_SCHEDULER_shutdown ();
     return;
   }
+  statistics = GNUNET_STATISTICS_create ("consensus", cfg);
   GNUNET_SERVER_add_handlers (server, server_handlers);
-  GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task, NULL);
+  GNUNET_SCHEDULER_add_shutdown (&shutdown_task, NULL);
   GNUNET_SERVER_disconnect_notify (server, handle_client_disconnect, NULL);
   GNUNET_log (GNUNET_ERROR_TYPE_INFO, "consensus running\n");
 }