src/consensus/consensus_api.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2012, 2016 GNUnet e.V.
   4
   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.
   9
  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.
  14
  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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @file consensus/consensus_api.c
  23  * @brief
  24  * @author Florian Dold
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_protocols.h"
  29 #include "gnunet_client_lib.h"
  30 #include "gnunet_consensus_service.h"
  31 #include "consensus.h"
  32
  33
  34 #define LOG(kind,...) GNUNET_log_from (kind, "consensus-api",__VA_ARGS__)
  35
  36
  37 /**
  38  * Handle for the service.
  39  */
  40 struct GNUNET_CONSENSUS_Handle
  41 {
  42   /**
  43    * Configuration to use.
  44    */
  45   const struct GNUNET_CONFIGURATION_Handle *cfg;
  46
  47   /**
  48    * Callback for new elements. Not called for elements added locally.
  49    */
  50   GNUNET_CONSENSUS_ElementCallback new_element_cb;
  51
  52   /**
  53    * Closure for @e new_element_cb
  54    */
  55   void *new_element_cls;
  56
  57   /**
  58    * The (local) session identifier for the consensus session.
  59    */
  60   struct GNUNET_HashCode session_id;
  61
  62   /**
  63    * #GNUNET_YES iff the join message has been sent to the service.
  64    */
  65   int joined;
  66
  67   /**
  68    * Called when the conclude operation finishes or fails.
  69    */
  70   GNUNET_CONSENSUS_ConcludeCallback conclude_cb;
  71
  72   /**
  73    * Closure for the @e conclude_cb callback.
  74    */
  75   void *conclude_cls;
  76
  77   /**
  78    * Deadline for the conclude operation.
  79    */
  80   struct GNUNET_TIME_Absolute conclude_deadline;
  81
  82   /**
  83    * Message queue for the client.
  84    */
  85   struct GNUNET_MQ_Handle *mq;
  86 };
  87
  88
  89 /**
  90  * FIXME: this should not bee necessary when the API
  91  * issue has been fixed
  92  */
  93 struct InsertDoneInfo
  94 {
  95   GNUNET_CONSENSUS_InsertDoneCallback idc;
  96   void *cls;
  97 };
  98
  99
 100 /**
 101  * Called when the server has sent is a new element
 102  *
 103  * @param cls consensus handle
 104  * @param msg element message
 105  */
 106 static int
 107 check_new_element (void *cls,
 108                    const struct GNUNET_CONSENSUS_ElementMessage *msg)
 109 {
 110   /* any size is fine, elements are variable-size */
 111   return GNUNET_OK;
 112 }
 113
 114
 115 /**
 116  * Called when the server has sent is a new element
 117  *
 118  * @param cls consensus handle
 119  * @param msg element message
 120  */
 121 static void
 122 handle_new_element (void *cls,
 123                     const struct GNUNET_CONSENSUS_ElementMessage *msg)
 124 {
 125   struct GNUNET_CONSENSUS_Handle *consensus = cls;
 126   struct GNUNET_SET_Element element;
 127
 128   LOG (GNUNET_ERROR_TYPE_DEBUG,
 129        "received new element\n");
 130   element.element_type = msg->element_type;
 131   element.size = ntohs (msg->header.size) - sizeof (struct GNUNET_CONSENSUS_ElementMessage);
 132   element.data = &msg[1];
 133   consensus->new_element_cb (consensus->new_element_cls,
 134                              &element);
 135 }
 136
 137
 138 /**
 139  * Called when the server has announced
 140  * that the conclusion is over.
 141  *
 142  * @param cls consensus handle
 143  * @param msg conclude done message
 144  */
 145 static void
 146 handle_conclude_done (void *cls,
 147                       const struct GNUNET_MessageHeader *msg)
 148 {
 149   struct GNUNET_CONSENSUS_Handle *consensus = cls;
 150   GNUNET_CONSENSUS_ConcludeCallback cc;
 151
 152   GNUNET_MQ_destroy (consensus->mq);
 153   consensus->mq = NULL;
 154   GNUNET_assert (NULL != (cc = consensus->conclude_cb));
 155   consensus->conclude_cb = NULL;
 156   cc (consensus->conclude_cls);
 157 }
 158
 159
 160 /**
 161  * Generic error handler, called with the appropriate
 162  * error code and the same closure specified at the creation of
 163  * the message queue.
 164  * Not every message queue implementation supports an error handler.
 165  *
 166  * @param cls closure, same closure as for the message handlers
 167  * @param error error code
 168  */
 169 static void
 170 mq_error_handler (void *cls,
 171                   enum GNUNET_MQ_Error error)
 172 {
 173   LOG (GNUNET_ERROR_TYPE_WARNING,
 174        "consensus service disconnected us\n");
 175 }
 176
 177
 178 /**
 179  * Create a consensus session.
 180  *
 181  * @param cfg configuration to use for connecting to the consensus service
 182  * @param num_peers number of peers in the peers array
 183  * @param peers array of peers participating in this consensus session
 184  *              Inclusion of the local peer is optional.
 185  * @param session_id session identifier
 186  *                   Allows a group of peers to have more than consensus session.
 187  * @param start start time of the consensus, conclude should be called before
 188  *              the start time.
 189  * @param deadline time when the consensus should have concluded
 190  * @param new_element_cb callback, called when a new element is added to the set by
 191  *                    another peer
 192  * @param new_element_cls closure for new_element
 193  * @return handle to use, NULL on error
 194  */
 195 struct GNUNET_CONSENSUS_Handle *
 196 GNUNET_CONSENSUS_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
 197                          unsigned int num_peers,
 198                          const struct GNUNET_PeerIdentity *peers,
 199                          const struct GNUNET_HashCode *session_id,
 200                          struct GNUNET_TIME_Absolute start,
 201                          struct GNUNET_TIME_Absolute deadline,
 202                          GNUNET_CONSENSUS_ElementCallback new_element_cb,
 203                          void *new_element_cls)
 204 {
 205   GNUNET_MQ_hd_var_size (new_element,
 206                          GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_RECEIVED_ELEMENT,
 207                          struct GNUNET_CONSENSUS_ElementMessage);
 208   GNUNET_MQ_hd_fixed_size (conclude_done,
 209                            GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_CONCLUDE_DONE,
 210                            struct GNUNET_MessageHeader);
 211   struct GNUNET_CONSENSUS_Handle *consensus
 212     = GNUNET_new (struct GNUNET_CONSENSUS_Handle);
 213   struct GNUNET_MQ_MessageHandler mq_handlers[] = {
 214     make_new_element_handler (consensus),
 215     make_conclude_done_handler (consensus),
 216     GNUNET_MQ_handler_end ()
 217   };
 218   struct GNUNET_CONSENSUS_JoinMessage *join_msg;
 219   struct GNUNET_MQ_Envelope *ev;
 220
 221   consensus->cfg = cfg;
 222   consensus->new_element_cb = new_element_cb;
 223   consensus->new_element_cls = new_element_cls;
 224   consensus->session_id = *session_id;
 225   consensus->mq = GNUNET_CLIENT_connecT (cfg,
 226                                          "consensus",
 227                                          mq_handlers,
 228                                          &mq_error_handler,
 229                                          consensus);
 230   if (NULL == consensus->mq)
 231   {
 232     GNUNET_free (consensus);
 233     return NULL;
 234   }
 235   ev = GNUNET_MQ_msg_extra (join_msg,
 236                             (num_peers * sizeof (struct GNUNET_PeerIdentity)),
 237                             GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_JOIN);
 238
 239   join_msg->session_id = consensus->session_id;
 240   join_msg->start = GNUNET_TIME_absolute_hton (start);
 241   join_msg->deadline = GNUNET_TIME_absolute_hton (deadline);
 242   join_msg->num_peers = htonl (num_peers);
 243   memcpy(&join_msg[1],
 244          peers,
 245          num_peers * sizeof (struct GNUNET_PeerIdentity));
 246
 247   GNUNET_MQ_send (consensus->mq, ev);
 248   return consensus;
 249 }
 250
 251
 252 static void
 253 idc_adapter (void *cls)
 254 {
 255   struct InsertDoneInfo *i = cls;
 256   i->idc (i->cls, GNUNET_OK);
 257   GNUNET_free (i);
 258 }
 259
 260 /**
 261  * Insert an element in the set being reconsiled.  Must not be called after
 262  * "GNUNET_CONSENSUS_conclude".
 263  *
 264  * @param consensus handle for the consensus session
 265  * @param element the element to be inserted
 266  * @param idc function called when we are done with this element and it
 267  *            is thus allowed to call GNUNET_CONSENSUS_insert again
 268  * @param idc_cls closure for 'idc'
 269  */
 270 void
 271 GNUNET_CONSENSUS_insert (struct GNUNET_CONSENSUS_Handle *consensus,
 272                          const struct GNUNET_SET_Element *element,
 273                          GNUNET_CONSENSUS_InsertDoneCallback idc,
 274                          void *idc_cls)
 275 {
 276   struct GNUNET_CONSENSUS_ElementMessage *element_msg;
 277   struct GNUNET_MQ_Envelope *ev;
 278   struct InsertDoneInfo *i;
 279
 280   LOG (GNUNET_ERROR_TYPE_DEBUG, "inserting, size=%llu\n", element->size);
 281
 282   ev = GNUNET_MQ_msg_extra (element_msg, element->size,
 283                             GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_INSERT);
 284
 285   memcpy (&element_msg[1], element->data, element->size);
 286
 287   if (NULL != idc)
 288   {
 289     i = GNUNET_new (struct InsertDoneInfo);
 290     i->idc = idc;
 291     i->cls = idc_cls;
 292     GNUNET_MQ_notify_sent (ev, idc_adapter, i);
 293   }
 294   GNUNET_MQ_send (consensus->mq, ev);
 295 }
 296
 297
 298 /**
 299  * We are done with inserting new elements into the consensus;
 300  * try to conclude the consensus within a given time window.
 301  * After conclude has been called, no further elements may be
 302  * inserted by the client.
 303  *
 304  * @param consensus consensus session
 305  * @param deadline deadline after which the conculde callback
 306  *                must be called
 307  * @param conclude called when the conclusion was successful
 308  * @param conclude_cls closure for the conclude callback
 309  */
 310 void
 311 GNUNET_CONSENSUS_conclude (struct GNUNET_CONSENSUS_Handle *consensus,
 312                            GNUNET_CONSENSUS_ConcludeCallback conclude,
 313                            void *conclude_cls)
 314 {
 315   struct GNUNET_MQ_Envelope *ev;
 316
 317   GNUNET_assert (NULL != conclude);
 318   GNUNET_assert (NULL == consensus->conclude_cb);
 319
 320   consensus->conclude_cls = conclude_cls;
 321   consensus->conclude_cb = conclude;
 322
 323   ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_CONCLUDE);
 324   GNUNET_MQ_send (consensus->mq, ev);
 325 }
 326
 327
 328 /**
 329  * Destroy a consensus handle (free all state associated with
 330  * it, no longer call any of the callbacks).
 331  *
 332  * @param consensus handle to destroy
 333  */
 334 void
 335 GNUNET_CONSENSUS_destroy (struct GNUNET_CONSENSUS_Handle *consensus)
 336 {
 337   if (NULL != consensus->mq)
 338   {
 339     GNUNET_MQ_destroy (consensus->mq);
 340     consensus->mq = NULL;
 341   }
 342   GNUNET_free (consensus);
 343 }
 344
 345 /* end of consensus_api.c */