src/multicast/multicast_api.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2012, 2013 Christian Grothoff (and other contributing authors)
   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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file multicast/multicast_api.c
  23  * @brief Multicast service; implements multicast groups using CADET connections.
  24  * @author Christian Grothoff
  25  * @author Gabor X Toth
  26  */
  27
  28 #include "platform.h"
  29 #include "gnunet_util_lib.h"
  30 #include "gnunet_multicast_service.h"
  31 #include "multicast.h"
  32
  33 #define LOG(kind,...) GNUNET_log_from (kind, "multicast-api",__VA_ARGS__)
  34
  35
  36 /**
  37  * Handle for a request to send a message to all multicast group members
  38  * (from the origin).
  39  */
  40 struct GNUNET_MULTICAST_OriginTransmitHandle
  41 {
  42   GNUNET_MULTICAST_OriginTransmitNotify notify;
  43   void *notify_cls;
  44   struct GNUNET_MULTICAST_Origin *origin;
  45
  46   uint64_t message_id;
  47   uint64_t group_generation;
  48   uint64_t fragment_offset;
  49 };
  50
  51
  52 /**
  53  * Handle for a message to be delivered from a member to the origin.
  54  */
  55 struct GNUNET_MULTICAST_MemberTransmitHandle
  56 {
  57   GNUNET_MULTICAST_MemberTransmitNotify notify;
  58   void *notify_cls;
  59   struct GNUNET_MULTICAST_Member *member;
  60
  61   uint64_t request_id;
  62   uint64_t fragment_offset;
  63 };
  64
  65
  66 struct GNUNET_MULTICAST_Group
  67 {
  68   /**
  69    * Configuration to use.
  70    */
  71   const struct GNUNET_CONFIGURATION_Handle *cfg;
  72
  73   /**
  74    * Client connection to the service.
  75    */
  76   struct GNUNET_CLIENT_MANAGER_Connection *client;
  77
  78   /**
  79    * Message to send on reconnect.
  80    */
  81   struct GNUNET_MessageHeader *connect_msg;
  82
  83   GNUNET_MULTICAST_JoinRequestCallback join_req_cb;
  84   GNUNET_MULTICAST_MembershipTestCallback member_test_cb;
  85   GNUNET_MULTICAST_ReplayFragmentCallback replay_frag_cb;
  86   GNUNET_MULTICAST_ReplayMessageCallback replay_msg_cb;
  87   GNUNET_MULTICAST_MessageCallback message_cb;
  88   void *cb_cls;
  89
  90   /**
  91    * Function called after disconnected from the service.
  92    */
  93   GNUNET_ContinuationCallback disconnect_cb;
  94
  95   /**
  96    * Closure for @a disconnect_cb.
  97    */
  98   void *disconnect_cls;
  99
 100   /**
 101    * Are we currently transmitting a message?
 102    */
 103   uint8_t in_transmit;
 104
 105   /**
 106    * Is this the origin or a member?
 107    */
 108   uint8_t is_origin;
 109
 110   /**
 111    * Is this channel in the process of disconnecting from the service?
 112    * #GNUNET_YES or #GNUNET_NO
 113    */
 114   uint8_t is_disconnecting;
 115 };
 116
 117
 118 /**
 119  * Handle for the origin of a multicast group.
 120  */
 121 struct GNUNET_MULTICAST_Origin
 122 {
 123   struct GNUNET_MULTICAST_Group grp;
 124   struct GNUNET_MULTICAST_OriginTransmitHandle tmit;
 125
 126   GNUNET_MULTICAST_RequestCallback request_cb;
 127 };
 128
 129
 130 /**
 131  * Handle for a multicast group member.
 132  */
 133 struct GNUNET_MULTICAST_Member
 134 {
 135   struct GNUNET_MULTICAST_Group grp;
 136   struct GNUNET_MULTICAST_MemberTransmitHandle tmit;
 137
 138   GNUNET_MULTICAST_JoinDecisionCallback join_dcsn_cb;
 139
 140   uint64_t next_fragment_id;
 141 };
 142
 143
 144 /**
 145  * Handle that identifies a join request.
 146  *
 147  * Used to match calls to #GNUNET_MULTICAST_JoinCallback to the
 148  * corresponding calls to #GNUNET_MULTICAST_join_decision().
 149  */
 150 struct GNUNET_MULTICAST_JoinHandle
 151 {
 152   struct GNUNET_MULTICAST_Group *group;
 153
 154   /**
 155    * Public key of the member requesting join.
 156    */
 157   struct GNUNET_CRYPTO_EcdsaPublicKey member_key;
 158
 159   /**
 160    * Peer identity of the member requesting join.
 161    */
 162   struct GNUNET_PeerIdentity peer;
 163 };
 164
 165
 166 /**
 167  * Handle to pass back for the answer of a membership test.
 168  */
 169 struct GNUNET_MULTICAST_MembershipTestHandle
 170 {
 171 };
 172
 173
 174 /**
 175  * Opaque handle to a replay request from the multicast service.
 176  */
 177 struct GNUNET_MULTICAST_ReplayHandle
 178 {
 179 };
 180
 181
 182 /**
 183  * Handle for a replay request.
 184  */
 185 struct GNUNET_MULTICAST_MemberReplayHandle
 186 {
 187 };
 188
 189
 190 /**
 191  * Send first message to the service after connecting.
 192  */
 193 static void
 194 group_send_connect_msg (struct GNUNET_MULTICAST_Group *grp)
 195 {
 196   uint16_t cmsg_size = ntohs (grp->connect_msg->size);
 197   struct GNUNET_MessageHeader * cmsg = GNUNET_malloc (cmsg_size);
 198   memcpy (cmsg, grp->connect_msg, cmsg_size);
 199   GNUNET_CLIENT_MANAGER_transmit_now (grp->client, cmsg);
 200 }
 201
 202
 203 /**
 204  * Got disconnected from service.  Reconnect.
 205  */
 206 static void
 207 group_recv_disconnect (void *cls,
 208                         struct GNUNET_CLIENT_MANAGER_Connection *client,
 209                         const struct GNUNET_MessageHeader *msg)
 210 {
 211   struct GNUNET_MULTICAST_Group *
 212     grp = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
 213   GNUNET_CLIENT_MANAGER_reconnect (client);
 214   group_send_connect_msg (grp);
 215 }
 216
 217
 218 /**
 219  * Receive join request from service.
 220  */
 221 static void
 222 group_recv_join_request (void *cls,
 223                           struct GNUNET_CLIENT_MANAGER_Connection *client,
 224                           const struct GNUNET_MessageHeader *msg)
 225 {
 226   struct GNUNET_MULTICAST_Group *grp;
 227   const struct MulticastJoinRequestMessage *jreq;
 228   struct GNUNET_MULTICAST_JoinHandle *jh;
 229   const struct GNUNET_MessageHeader *jmsg;
 230
 231   grp = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
 232   if (NULL == grp)
 233   {
 234     GNUNET_break (0);
 235     return;
 236   }
 237   if (NULL == grp->join_req_cb)
 238     return;
 239   /* FIXME: this fails to check that 'msg' is well-formed! */
 240   jreq = (const struct MulticastJoinRequestMessage *) msg;
 241   if (sizeof (*jreq) + sizeof (*jmsg) <= ntohs (jreq->header.size))
 242     jmsg = (const struct GNUNET_MessageHeader *) &jreq[1];
 243   else
 244     jmsg = NULL;
 245   jh = GNUNET_malloc (sizeof (*jh));
 246   jh->group = grp;
 247   jh->member_key = jreq->member_key;
 248   jh->peer = jreq->peer;
 249   grp->join_req_cb (grp->cb_cls, &jreq->member_key, jmsg, jh);
 250 }
 251
 252
 253 /**
 254  * Receive multicast message from service.
 255  */
 256 static void
 257 group_recv_message (void *cls,
 258                     struct GNUNET_CLIENT_MANAGER_Connection *client,
 259                     const struct GNUNET_MessageHeader *msg)
 260 {
 261   struct GNUNET_MULTICAST_Group *
 262     grp = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
 263   struct GNUNET_MULTICAST_MessageHeader *
 264     mmsg = (struct GNUNET_MULTICAST_MessageHeader *) msg;
 265
 266   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 267               "Calling message callback with a message of size %u.\n",
 268               ntohs (mmsg->header.size));
 269
 270   if (NULL != grp->message_cb)
 271     grp->message_cb (grp->cb_cls, mmsg);
 272 }
 273
 274
 275 /**
 276  * Origin receives uniquest request from a member.
 277  */
 278 static void
 279 origin_recv_request (void *cls,
 280                      struct GNUNET_CLIENT_MANAGER_Connection *client,
 281                      const struct GNUNET_MessageHeader *msg)
 282 {
 283   struct GNUNET_MULTICAST_Group *grp;
 284   struct GNUNET_MULTICAST_Origin *
 285     orig = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
 286   grp = &orig->grp;
 287   struct GNUNET_MULTICAST_RequestHeader *
 288     req = (struct GNUNET_MULTICAST_RequestHeader *) msg;
 289
 290   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 291               "Calling request callback with a request of size %u.\n",
 292               ntohs (req->header.size));
 293
 294   if (NULL != orig->request_cb)
 295     orig->request_cb (grp->cb_cls, req);
 296 }
 297
 298
 299 /**
 300  * Member receives join decision.
 301  */
 302 static void
 303 member_recv_join_decision (void *cls,
 304                            struct GNUNET_CLIENT_MANAGER_Connection *client,
 305                            const struct GNUNET_MessageHeader *msg)
 306 {
 307   struct GNUNET_MULTICAST_Group *grp;
 308   struct GNUNET_MULTICAST_Member *
 309     mem = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
 310   grp = &mem->grp;
 311
 312   const struct MulticastJoinDecisionMessageHeader *
 313     hdcsn = (const struct MulticastJoinDecisionMessageHeader *) msg;
 314   const struct MulticastJoinDecisionMessage *
 315     dcsn = (const struct MulticastJoinDecisionMessage *) &hdcsn[1];
 316
 317   uint16_t dcsn_size = ntohs (dcsn->header.size);
 318   int is_admitted = ntohl (dcsn->is_admitted);
 319
 320   LOG (GNUNET_ERROR_TYPE_DEBUG,
 321        "%p Member got join decision from multicast: %d\n",
 322        mem, is_admitted);
 323
 324   const struct GNUNET_MessageHeader *join_resp = NULL;
 325   uint16_t join_resp_size = 0;
 326
 327   uint16_t relay_count = ntohl (dcsn->relay_count);
 328   const struct GNUNET_PeerIdentity *relays = NULL;
 329   uint16_t relay_size = relay_count * sizeof (*relays);
 330   if (0 < relay_count && dcsn_size < sizeof (*dcsn) + relay_size)
 331     relays = (struct GNUNET_PeerIdentity *) &dcsn[1];
 332
 333   if (sizeof (*dcsn) + relay_size + sizeof (*join_resp) <= dcsn_size)
 334   {
 335     join_resp = (const struct GNUNET_MessageHeader *) &dcsn[1];
 336     join_resp_size = ntohs (join_resp->size);
 337   }
 338   if (dcsn_size < sizeof (*dcsn) + relay_size + join_resp_size)
 339   {
 340     LOG (GNUNET_ERROR_TYPE_DEBUG,
 341          "Received invalid join decision message from multicast.\n");
 342     GNUNET_break_op (0);
 343     is_admitted = GNUNET_SYSERR;
 344   }
 345
 346   if (NULL != mem->join_dcsn_cb)
 347     mem->join_dcsn_cb (grp->cb_cls, is_admitted, &hdcsn->peer,
 348                        relay_count, relays, join_resp);
 349
 350   // FIXME:
 351   //if (GNUNET_YES != is_admitted)
 352   //  GNUNET_MULTICAST_member_part (mem);
 353 }
 354
 355
 356 /**
 357  * Message handlers for an origin.
 358  */
 359 static struct GNUNET_CLIENT_MANAGER_MessageHandler origin_handlers[] =
 360 {
 361   { &group_recv_disconnect, NULL, 0, 0, GNUNET_NO },
 362
 363   { &group_recv_message, NULL,
 364     GNUNET_MESSAGE_TYPE_MULTICAST_MESSAGE,
 365     sizeof (struct GNUNET_MULTICAST_MessageHeader), GNUNET_YES },
 366
 367   { &origin_recv_request, NULL,
 368     GNUNET_MESSAGE_TYPE_MULTICAST_REQUEST,
 369     sizeof (struct GNUNET_MULTICAST_RequestHeader), GNUNET_YES },
 370
 371   { &group_recv_join_request, NULL,
 372     GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_REQUEST,
 373     sizeof (struct MulticastJoinRequestMessage), GNUNET_YES },
 374
 375   { NULL, NULL, 0, 0, GNUNET_NO }
 376 };
 377
 378
 379 /**
 380  * Message handlers for a member.
 381  */
 382 static struct GNUNET_CLIENT_MANAGER_MessageHandler member_handlers[] =
 383 {
 384   { &group_recv_disconnect, NULL, 0, 0, GNUNET_NO },
 385
 386   { &group_recv_message, NULL,
 387     GNUNET_MESSAGE_TYPE_MULTICAST_MESSAGE,
 388     sizeof (struct GNUNET_MULTICAST_MessageHeader), GNUNET_YES },
 389
 390   { &group_recv_join_request, NULL,
 391     GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_REQUEST,
 392     sizeof (struct MulticastJoinRequestMessage), GNUNET_YES },
 393
 394   { &member_recv_join_decision, NULL,
 395     GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_DECISION,
 396     sizeof (struct MulticastJoinDecisionMessage), GNUNET_YES },
 397
 398   { NULL, NULL, 0, 0, GNUNET_NO }
 399 };
 400
 401
 402 static void
 403 group_cleanup (struct GNUNET_MULTICAST_Group *grp)
 404 {
 405   GNUNET_free (grp->connect_msg);
 406   if (NULL != grp->disconnect_cb)
 407     grp->disconnect_cb (grp->disconnect_cls);
 408 }
 409
 410
 411 static void
 412 origin_cleanup (void *cls)
 413 {
 414   struct GNUNET_MULTICAST_Origin *orig = cls;
 415   group_cleanup (&orig->grp);
 416   GNUNET_free (orig);
 417 }
 418
 419
 420 static void
 421 member_cleanup (void *cls)
 422 {
 423   struct GNUNET_MULTICAST_Member *mem = cls;
 424   group_cleanup (&mem->grp);
 425   GNUNET_free (mem);
 426 }
 427
 428
 429 /**
 430  * Function to call with the decision made for a join request.
 431  *
 432  * Must be called once and only once in response to an invocation of the
 433  * #GNUNET_MULTICAST_JoinRequestCallback.
 434  *
 435  * @param join  Join request handle.
 436  * @param is_admitted  #GNUNET_YES    if the join is approved,
 437  *                     #GNUNET_NO     if it is disapproved,
 438  *                     #GNUNET_SYSERR if we cannot answer the request.
 439  * @param relay_count Number of relays given.
 440  * @param relays Array of suggested peers that might be useful relays to use
 441  *        when joining the multicast group (essentially a list of peers that
 442  *        are already part of the multicast group and might thus be willing
 443  *        to help with routing).  If empty, only this local peer (which must
 444  *        be the multicast origin) is a good candidate for building the
 445  *        multicast tree.  Note that it is unnecessary to specify our own
 446  *        peer identity in this array.
 447  * @param join_resp  Message to send in response to the joining peer;
 448  *        can also be used to redirect the peer to a different group at the
 449  *        application layer; this response is to be transmitted to the
 450  *        peer that issued the request even if admission is denied.
 451  */
 452 struct GNUNET_MULTICAST_ReplayHandle *
 453 GNUNET_MULTICAST_join_decision (struct GNUNET_MULTICAST_JoinHandle *join,
 454                                 int is_admitted,
 455                                 uint16_t relay_count,
 456                                 const struct GNUNET_PeerIdentity *relays,
 457                                 const struct GNUNET_MessageHeader *join_resp)
 458 {
 459   struct GNUNET_MULTICAST_Group *grp = join->group;
 460   uint16_t join_resp_size = (NULL != join_resp) ? ntohs (join_resp->size) : 0;
 461   uint16_t relay_size = relay_count * sizeof (*relays);
 462
 463   struct MulticastJoinDecisionMessageHeader * hdcsn;
 464   struct MulticastJoinDecisionMessage *dcsn;
 465   hdcsn = GNUNET_malloc (sizeof (*hdcsn) + sizeof (*dcsn)
 466                          + relay_size + join_resp_size);
 467   hdcsn->header.size = htons (sizeof (*hdcsn) + sizeof (*dcsn)
 468                               + relay_size + join_resp_size);
 469   hdcsn->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_DECISION);
 470   hdcsn->member_key = join->member_key;
 471   hdcsn->peer = join->peer;
 472
 473   dcsn = (struct MulticastJoinDecisionMessage *) &hdcsn[1];
 474   dcsn->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_DECISION);
 475   dcsn->header.size = htons (sizeof (*dcsn) + relay_size + join_resp_size);
 476   dcsn->is_admitted = htonl (is_admitted);
 477   dcsn->relay_count = htonl (relay_count);
 478   if (0 < relay_size)
 479     memcpy (&dcsn[1], relays, relay_size);
 480   if (0 < join_resp_size)
 481     memcpy (((char *) &dcsn[1]) + relay_size, join_resp, join_resp_size);
 482
 483   GNUNET_CLIENT_MANAGER_transmit (grp->client, &hdcsn->header);
 484   GNUNET_free (join);
 485   return NULL;
 486 }
 487
 488
 489 /**
 490  * Call informing multicast about the decision taken for a membership test.
 491  *
 492  * @param mth Handle that was given for the query.
 493  * @param result #GNUNET_YES if peer was a member, #GNUNET_NO if peer was not a member,
 494  *        #GNUNET_SYSERR if we cannot answer the membership test.
 495  */
 496 void
 497 GNUNET_MULTICAST_membership_test_result (struct GNUNET_MULTICAST_MembershipTestHandle *mth,
 498                                          int result)
 499 {
 500 }
 501
 502
 503 /**
 504  * Replay a message fragment for the multicast group.
 505  *
 506  * @param rh Replay handle identifying which replay operation was requested.
 507  * @param msg Replayed message fragment, NULL if unknown/error.
 508  * @param ec Error code.
 509  */
 510 void
 511 GNUNET_MULTICAST_replay_response (struct GNUNET_MULTICAST_ReplayHandle *rh,
 512                                   const struct GNUNET_MessageHeader *msg,
 513                                   enum GNUNET_MULTICAST_ReplayErrorCode ec)
 514 {
 515 }
 516
 517
 518 /**
 519  * Indicate the end of the replay session.
 520  *
 521  * Invalidates the replay handle.
 522  *
 523  * @param rh Replay session to end.
 524  */
 525 void
 526 GNUNET_MULTICAST_replay_response_end (struct GNUNET_MULTICAST_ReplayHandle *rh)
 527 {
 528 }
 529
 530
 531 /**
 532  * Replay a message for the multicast group.
 533  *
 534  * @param rh Replay handle identifying which replay operation was requested.
 535  * @param notify Function to call to get the message.
 536  * @param notify_cls Closure for @a notify.
 537  */
 538 void
 539 GNUNET_MULTICAST_replay_response2 (struct GNUNET_MULTICAST_ReplayHandle *rh,
 540                                    GNUNET_MULTICAST_ReplayTransmitNotify notify,
 541                                    void *notify_cls)
 542 {
 543 }
 544
 545
 546 /**
 547  * Start a multicast group.
 548  *
 549  * Will advertise the origin in the P2P overlay network under the respective
 550  * public key so that other peer can find this peer to join it.  Peers that
 551  * issue GNUNET_MULTICAST_member_join() can then transmit a join request to
 552  * either an existing group member or to the origin.  If the joining is
 553  * approved, the member is cleared for @e replay and will begin to receive
 554  * messages transmitted to the group.  If joining is disapproved, the failed
 555  * candidate will be given a response.  Members in the group can send messages
 556  * to the origin (one at a time).
 557  *
 558  * @param cfg  Configuration to use.
 559  * @param priv_key  ECC key that will be used to sign messages for this
 560  *        multicast session; public key is used to identify the multicast group;
 561  * @param max_fragment_id  Maximum fragment ID already sent to the group.
 562  *        0 for a new group.
 563  * @param join_request_cb Function called to approve / disapprove joining of a peer.
 564  * @param member_test_cb  Function multicast can use to test group membership.
 565  * @param replay_frag_cb  Function that can be called to replay a message fragment.
 566  * @param replay_msg_cb  Function that can be called to replay a message.
 567  * @param request_cb  Function called with message fragments from group members.
 568  * @param message_cb  Function called with the message fragments sent to the
 569  *        network by GNUNET_MULTICAST_origin_to_all().  These message fragments
 570  *        should be stored for answering replay requests later.
 571  * @param cls  Closure for the various callbacks that follow.
 572  *
 573  * @return Handle for the origin, NULL on error.
 574  */
 575 struct GNUNET_MULTICAST_Origin *
 576 GNUNET_MULTICAST_origin_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 577                                const struct GNUNET_CRYPTO_EddsaPrivateKey *priv_key,
 578                                uint64_t max_fragment_id,
 579                                GNUNET_MULTICAST_JoinRequestCallback join_request_cb,
 580                                GNUNET_MULTICAST_MembershipTestCallback member_test_cb,
 581                                GNUNET_MULTICAST_ReplayFragmentCallback replay_frag_cb,
 582                                GNUNET_MULTICAST_ReplayMessageCallback replay_msg_cb,
 583                                GNUNET_MULTICAST_RequestCallback request_cb,
 584                                GNUNET_MULTICAST_MessageCallback message_cb,
 585                                void *cls)
 586 {
 587   struct GNUNET_MULTICAST_Origin *orig = GNUNET_malloc (sizeof (*orig));
 588   struct GNUNET_MULTICAST_Group *grp = &orig->grp;
 589   struct MulticastOriginStartMessage *start = GNUNET_malloc (sizeof (*start));
 590
 591   start->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_ORIGIN_START);
 592   start->header.size = htons (sizeof (*start));
 593   start->max_fragment_id = max_fragment_id;
 594   memcpy (&start->group_key, priv_key, sizeof (*priv_key));
 595
 596   grp->connect_msg = (struct GNUNET_MessageHeader *) start;
 597   grp->is_origin = GNUNET_YES;
 598   grp->cfg = cfg;
 599
 600   grp->cb_cls = cls;
 601   grp->join_req_cb = join_request_cb;
 602   grp->member_test_cb = member_test_cb;
 603   grp->replay_frag_cb = replay_frag_cb;
 604   grp->replay_msg_cb = replay_msg_cb;
 605   grp->message_cb = message_cb;
 606
 607   orig->request_cb = request_cb;
 608
 609   grp->client = GNUNET_CLIENT_MANAGER_connect (cfg, "multicast", origin_handlers);
 610   GNUNET_CLIENT_MANAGER_set_user_context_ (grp->client, orig, sizeof (*grp));
 611   group_send_connect_msg (grp);
 612
 613   return orig;
 614 }
 615
 616
 617 /**
 618  * Stop a multicast group.
 619  *
 620  * @param origin Multicast group to stop.
 621  */
 622 void
 623 GNUNET_MULTICAST_origin_stop (struct GNUNET_MULTICAST_Origin *orig,
 624                               GNUNET_ContinuationCallback stop_cb,
 625                               void *stop_cls)
 626 {
 627   struct GNUNET_MULTICAST_Group *grp = &orig->grp;
 628
 629   grp->is_disconnecting = GNUNET_YES;
 630   grp->disconnect_cb = stop_cb;
 631   grp->disconnect_cls = stop_cls;
 632
 633   GNUNET_CLIENT_MANAGER_disconnect (orig->grp.client, GNUNET_YES,
 634                                     &origin_cleanup, orig);
 635 }
 636
 637
 638 static void
 639 origin_to_all (struct GNUNET_MULTICAST_Origin *orig)
 640 {
 641   LOG (GNUNET_ERROR_TYPE_DEBUG, "origin_to_all()\n");
 642   struct GNUNET_MULTICAST_Group *grp = &orig->grp;
 643   struct GNUNET_MULTICAST_OriginTransmitHandle *tmit = &orig->tmit;
 644
 645   size_t buf_size = GNUNET_MULTICAST_FRAGMENT_MAX_SIZE;
 646   struct GNUNET_MULTICAST_MessageHeader *msg = GNUNET_malloc (buf_size);
 647   int ret = tmit->notify (tmit->notify_cls, &buf_size, &msg[1]);
 648
 649   if (! (GNUNET_YES == ret || GNUNET_NO == ret)
 650       || GNUNET_MULTICAST_FRAGMENT_MAX_SIZE < buf_size)
 651   {
 652     LOG (GNUNET_ERROR_TYPE_ERROR,
 653          "OriginTransmitNotify() returned error or invalid message size.\n");
 654     /* FIXME: handle error */
 655     GNUNET_free (msg);
 656     return;
 657   }
 658
 659   if (GNUNET_NO == ret && 0 == buf_size)
 660   {
 661     GNUNET_free (msg);
 662     return; /* Transmission paused. */
 663   }
 664
 665   msg->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_MESSAGE);
 666   msg->header.size = htons (sizeof (*msg) + buf_size);
 667   msg->message_id = GNUNET_htonll (tmit->message_id);
 668   msg->group_generation = tmit->group_generation;
 669   msg->fragment_offset = GNUNET_htonll (tmit->fragment_offset);
 670   tmit->fragment_offset += sizeof (*msg) + buf_size;
 671
 672   GNUNET_CLIENT_MANAGER_transmit (grp->client, &msg->header);
 673 }
 674
 675
 676 /**
 677  * Send a message to the multicast group.
 678  *
 679  * @param orig  Handle to the multicast group.
 680  * @param message_id  Application layer ID for the message.  Opaque to multicast.
 681  * @param group_generation  Group generation of the message.
 682  *                          Documented in struct GNUNET_MULTICAST_MessageHeader.
 683  * @param notify  Function to call to get the message.
 684  * @param notify_cls  Closure for @a notify.
 685  *
 686  * @return Message handle on success,
 687  *         NULL on error (i.e. another request is already pending).
 688  */
 689 struct GNUNET_MULTICAST_OriginTransmitHandle *
 690 GNUNET_MULTICAST_origin_to_all (struct GNUNET_MULTICAST_Origin *orig,
 691                                 uint64_t message_id,
 692                                 uint64_t group_generation,
 693                                 GNUNET_MULTICAST_OriginTransmitNotify notify,
 694                                 void *notify_cls)
 695 {
 696 /* FIXME
 697   if (GNUNET_YES == orig->grp.in_transmit)
 698     return NULL;
 699   orig->grp.in_transmit = GNUNET_YES;
 700 */
 701
 702   struct GNUNET_MULTICAST_OriginTransmitHandle *tmit = &orig->tmit;
 703   tmit->origin = orig;
 704   tmit->message_id = message_id;
 705   tmit->group_generation = group_generation;
 706   tmit->notify = notify;
 707   tmit->notify_cls = notify_cls;
 708
 709   origin_to_all (orig);
 710   return tmit;
 711 }
 712
 713
 714 /**
 715  * Resume message transmission to multicast group.
 716  *
 717  * @param th  Transmission to cancel.
 718  */
 719 void
 720 GNUNET_MULTICAST_origin_to_all_resume (struct GNUNET_MULTICAST_OriginTransmitHandle *th)
 721 {
 722   origin_to_all (th->origin);
 723 }
 724
 725
 726 /**
 727  * Cancel request for message transmission to multicast group.
 728  *
 729  * @param th  Transmission to cancel.
 730  */
 731 void
 732 GNUNET_MULTICAST_origin_to_all_cancel (struct GNUNET_MULTICAST_OriginTransmitHandle *th)
 733 {
 734 }
 735
 736
 737 /**
 738  * Join a multicast group.
 739  *
 740  * The entity joining is always the local peer.  Further information about the
 741  * candidate can be provided in the @a join_request message.  If the join fails, the
 742  * @a message_cb is invoked with a (failure) response and then with NULL.  If
 743  * the join succeeds, outstanding (state) messages and ongoing multicast
 744  * messages will be given to the @a message_cb until the member decides to part
 745  * the group.  The @a test_cb and @a replay_cb functions may be called at
 746  * anytime by the multicast service to support relaying messages to other
 747  * members of the group.
 748  *
 749  * @param cfg Configuration to use.
 750  * @param group_key ECC public key that identifies the group to join.
 751  * @param member_key ECC key that identifies the member and used to sign
 752  *        requests sent to the origin.
 753  * @param origin Peer ID of the origin to send unicast requsets to.  If NULL,
 754  *        unicast requests are sent back via multiple hops on the reverse path
 755  *        of multicast messages.
 756  * @param relay_count Number of peers in the @a relays array.
 757  * @param relays Peer identities of members of the group, which serve as relays
 758  *        and can be used to join the group at. and send the @a join_request to.
 759  *        If empty, the @a join_request is sent directly to the @a origin.
 760  * @param join_msg  Application-dependent join message to be passed to the peer
 761  *        @a origin.
 762  * @param join_request_cb Function called to approve / disapprove joining of a peer.
 763  * @param join_decision_cb Function called to inform about the join decision.
 764  * @param member_test_cb Function multicast can use to test group membership.
 765  * @param replay_frag_cb Function that can be called to replay message fragments
 766  *        this peer already knows from this group. NULL if this
 767  *        client is unable to support replay.
 768  * @param replay_msg_cb Function that can be called to replay message fragments
 769  *        this peer already knows from this group. NULL if this
 770  *        client is unable to support replay.
 771  * @param message_cb Function to be called for all message fragments we
 772  *        receive from the group, excluding those our @a replay_cb
 773  *        already has.
 774  * @param cls Closure for callbacks.
 775  * @return Handle for the member, NULL on error.
 776  */
 777 struct GNUNET_MULTICAST_Member *
 778 GNUNET_MULTICAST_member_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
 779                               const struct GNUNET_CRYPTO_EddsaPublicKey *group_key,
 780                               const struct GNUNET_CRYPTO_EcdsaPrivateKey *member_key,
 781                               const struct GNUNET_PeerIdentity *origin,
 782                               uint16_t relay_count,
 783                               const struct GNUNET_PeerIdentity *relays,
 784                               const struct GNUNET_MessageHeader *join_msg,
 785                               GNUNET_MULTICAST_JoinRequestCallback join_request_cb,
 786                               GNUNET_MULTICAST_JoinDecisionCallback join_decision_cb,
 787                               GNUNET_MULTICAST_MembershipTestCallback member_test_cb,
 788                               GNUNET_MULTICAST_ReplayFragmentCallback replay_frag_cb,
 789                               GNUNET_MULTICAST_ReplayMessageCallback replay_msg_cb,
 790                               GNUNET_MULTICAST_MessageCallback message_cb,
 791                               void *cls)
 792 {
 793   struct GNUNET_MULTICAST_Member *mem = GNUNET_malloc (sizeof (*mem));
 794   struct GNUNET_MULTICAST_Group *grp = &mem->grp;
 795
 796   uint16_t relay_size = relay_count * sizeof (*relays);
 797   uint16_t join_msg_size = (NULL != join_msg) ? ntohs (join_msg->size) : 0;
 798   struct MulticastMemberJoinMessage *
 799     join = GNUNET_malloc (sizeof (*join) + relay_size + join_msg_size);
 800   join->header.size = htons (sizeof (*join) + relay_size + join_msg_size);
 801   join->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_MEMBER_JOIN);
 802   join->group_key = *group_key;
 803   join->member_key = *member_key;
 804   join->origin = *origin;
 805   if (0 < relay_size)
 806     memcpy (&join[1], relays, relay_size);
 807   if (0 < join_msg_size)
 808     memcpy (((char *) &join[1]) + relay_size, join_msg, join_msg_size);
 809
 810   grp->connect_msg = (struct GNUNET_MessageHeader *) join;
 811   grp->is_origin = GNUNET_NO;
 812   grp->cfg = cfg;
 813
 814   mem->join_dcsn_cb = join_decision_cb;
 815   grp->join_req_cb = join_request_cb;
 816   grp->member_test_cb = member_test_cb;
 817   grp->replay_frag_cb = replay_frag_cb;
 818   grp->message_cb = message_cb;
 819   grp->cb_cls = cls;
 820
 821   grp->client = GNUNET_CLIENT_MANAGER_connect (cfg, "multicast", member_handlers);
 822   GNUNET_CLIENT_MANAGER_set_user_context_ (grp->client, mem, sizeof (*grp));
 823   group_send_connect_msg (grp);
 824
 825   return mem;
 826 }
 827
 828
 829 /**
 830  * Part a multicast group.
 831  *
 832  * Disconnects from all group members and invalidates the @a member handle.
 833  *
 834  * An application-dependent part message can be transmitted beforehand using
 835  * #GNUNET_MULTICAST_member_to_origin())
 836  *
 837  * @param member Membership handle.
 838  */
 839 void
 840 GNUNET_MULTICAST_member_part (struct GNUNET_MULTICAST_Member *mem,
 841                               GNUNET_ContinuationCallback part_cb,
 842                               void *part_cls)
 843 {
 844   struct GNUNET_MULTICAST_Group *grp = &mem->grp;
 845
 846   grp->is_disconnecting = GNUNET_YES;
 847   grp->disconnect_cb = part_cb;
 848   grp->disconnect_cls = part_cls;
 849
 850   GNUNET_CLIENT_MANAGER_disconnect (mem->grp.client, GNUNET_YES,
 851                                     &member_cleanup, mem);
 852 }
 853
 854
 855 /**
 856  * Request a fragment to be replayed by fragment ID.
 857  *
 858  * Useful if messages below the @e max_known_fragment_id given when joining are
 859  * needed and not known to the client.
 860  *
 861  * @param member Membership handle.
 862  * @param fragment_id ID of a message fragment that this client would like to
 863           see replayed.
 864  * @param flags Additional flags for the replay request.  It is used and defined
 865  *        by the replay callback.  FIXME: which replay callback? FIXME: use enum?
 866  *        FIXME: why not pass reply cb here?
 867  * @return Replay request handle, NULL on error.
 868  */
 869 struct GNUNET_MULTICAST_MemberReplayHandle *
 870 GNUNET_MULTICAST_member_replay_fragment (struct GNUNET_MULTICAST_Member *member,
 871                                          uint64_t fragment_id,
 872                                          uint64_t flags)
 873 {
 874   return NULL;
 875 }
 876
 877
 878 /**
 879  * Request a message fragment to be replayed.
 880  *
 881  * Useful if messages below the @e max_known_fragment_id given when joining are
 882  * needed and not known to the client.
 883  *
 884  * @param member Membership handle.
 885  * @param message_id ID of the message this client would like to see replayed.
 886  * @param fragment_offset Offset of the fragment within the message to replay.
 887  * @param flags Additional flags for the replay request.  It is used & defined
 888  *        by the replay callback.
 889  * @param result_cb Function to be called for the replayed message.
 890  * @param result_cb_cls Closure for @a result_cb.
 891  * @return Replay request handle, NULL on error.
 892  */
 893 struct GNUNET_MULTICAST_MemberReplayHandle *
 894 GNUNET_MULTICAST_member_replay_message (struct GNUNET_MULTICAST_Member *member,
 895                                         uint64_t message_id,
 896                                         uint64_t fragment_offset,
 897                                         uint64_t flags,
 898                                         GNUNET_MULTICAST_ResultCallback result_cb,
 899                                         void *result_cb_cls)
 900 {
 901   return NULL;
 902 }
 903
 904
 905 /**
 906  * Cancel a replay request.
 907  *
 908  * @param rh Request to cancel.
 909  */
 910 void
 911 GNUNET_MULTICAST_member_replay_cancel (struct GNUNET_MULTICAST_MemberReplayHandle *rh)
 912 {
 913 }
 914
 915
 916 static void
 917 member_to_origin (struct GNUNET_MULTICAST_Member *mem)
 918 {
 919   LOG (GNUNET_ERROR_TYPE_DEBUG, "member_to_origin()\n");
 920   struct GNUNET_MULTICAST_Group *grp = &mem->grp;
 921   struct GNUNET_MULTICAST_MemberTransmitHandle *tmit = &mem->tmit;
 922
 923   size_t buf_size = GNUNET_MULTICAST_FRAGMENT_MAX_SIZE;
 924   struct GNUNET_MULTICAST_RequestHeader *req = GNUNET_malloc (buf_size);
 925   int ret = tmit->notify (tmit->notify_cls, &buf_size, &req[1]);
 926
 927   if (! (GNUNET_YES == ret || GNUNET_NO == ret)
 928       || GNUNET_MULTICAST_FRAGMENT_MAX_SIZE < buf_size)
 929   {
 930     LOG (GNUNET_ERROR_TYPE_ERROR,
 931          "MemberTransmitNotify() returned error or invalid message size.\n");
 932     /* FIXME: handle error */
 933     GNUNET_free (req);
 934     return;
 935   }
 936
 937   if (GNUNET_NO == ret && 0 == buf_size)
 938   {
 939     /* Transmission paused. */
 940     GNUNET_free (req);
 941     return;
 942   }
 943
 944   req->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_REQUEST);
 945   req->header.size = htons (sizeof (*req) + buf_size);
 946   req->request_id = GNUNET_htonll (tmit->request_id);
 947   req->fragment_offset = GNUNET_ntohll (tmit->fragment_offset);
 948   tmit->fragment_offset += sizeof (*req) + buf_size;
 949
 950   GNUNET_CLIENT_MANAGER_transmit (grp->client, &req->header);
 951 }
 952
 953
 954 /**
 955  * Send a message to the origin of the multicast group.
 956  *
 957  * @param mem Membership handle.
 958  * @param request_id Application layer ID for the request.  Opaque to multicast.
 959  * @param notify Callback to call to get the message.
 960  * @param notify_cls Closure for @a notify.
 961  * @return Handle to cancel request, NULL on error (i.e. request already pending).
 962  */
 963 struct GNUNET_MULTICAST_MemberTransmitHandle *
 964 GNUNET_MULTICAST_member_to_origin (struct GNUNET_MULTICAST_Member *mem,
 965                                    uint64_t request_id,
 966                                    GNUNET_MULTICAST_MemberTransmitNotify notify,
 967                                    void *notify_cls)
 968 {
 969 /* FIXME
 970   if (GNUNET_YES == mem->grp.in_transmit)
 971     return NULL;
 972   mem->grp.in_transmit = GNUNET_YES;
 973 */
 974
 975   struct GNUNET_MULTICAST_MemberTransmitHandle *tmit = &mem->tmit;
 976   tmit->member = mem;
 977   tmit->request_id = request_id;
 978   tmit->notify = notify;
 979   tmit->notify_cls = notify_cls;
 980
 981   member_to_origin (mem);
 982   return tmit;
 983 }
 984
 985
 986 /**
 987  * Resume message transmission to origin.
 988  *
 989  * @param th  Transmission to cancel.
 990  */
 991 void
 992 GNUNET_MULTICAST_member_to_origin_resume (struct GNUNET_MULTICAST_MemberTransmitHandle *th)
 993 {
 994   member_to_origin (th->member);
 995 }
 996
 997
 998 /**
 999  * Cancel request for message transmission to origin.
1000  *
1001  * @param th  Transmission to cancel.
1002  */
1003 void
1004 GNUNET_MULTICAST_member_to_origin_cancel (struct GNUNET_MULTICAST_MemberTransmitHandle *th)
1005 {
1006 }
1007
1008
1009 /* end of multicast_api.c */