src/transport/plugin_transport_bluetooth.c

   1 /*
   2   This file is part of GNUnet
   3   (C) 2010, 2011, 2012 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 transport/plugin_transport_bluetooth.c
  23  * @brief transport plugin for bluetooth
  24  * @author David Brodski
  25  * @author Christian Grothoff
  26  *
  27  * THIS IS A COPY OF plugin_transport_wlan.c
  28  */
  29 #include "platform.h"
  30 #include "gnunet_hello_lib.h"
  31 #include "gnunet_protocols.h"
  32 #include "gnunet_util_lib.h"
  33 #include "gnunet_statistics_service.h"
  34 #include "gnunet_transport_service.h"
  35 #include "gnunet_transport_plugin.h"
  36 #include "plugin_transport_wlan.h"
  37 #include "gnunet_common.h"
  38 #include "gnunet_crypto_lib.h"
  39 #include "gnunet_fragmentation_lib.h"
  40 #include "gnunet_constants.h"
  41
  42 #ifdef MINGW
  43  #undef interface
  44 #endif
  45
  46 #define LOG(kind,...) GNUNET_log_from (kind, "transport-bluetooth",__VA_ARGS__)
  47
  48 #define PLUGIN_NAME "bluetooth"
  49
  50 /**
  51  * Max size of packet (that we give to the WLAN driver for transmission)
  52  */
  53 #define WLAN_MTU 1430
  54
  55 /**
  56  * time out of a mac endpoint
  57  */
  58 #define MACENDPOINT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT, 60)
  59
  60 /**
  61  * We reduce the frequence of HELLO beacons in relation to
  62  * the number of MAC addresses currently visible to us.
  63  * This is the multiplication factor.
  64  */
  65 #define HELLO_BEACON_SCALING_FACTOR GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
  66
  67 /**
  68  * Maximum number of messages in defragmentation queue per MAC
  69  */
  70 #define MESSAGES_IN_DEFRAG_QUEUE_PER_MAC 2
  71
  72 /**
  73  * Link layer control fields for better compatibility
  74  * (i.e. GNUnet over WLAN is not IP-over-WLAN).
  75  */
  76 #define WLAN_LLC_DSAP_FIELD 0x1f
  77 #define WLAN_LLC_SSAP_FIELD 0x1f
  78
  79
  80 GNUNET_NETWORK_STRUCT_BEGIN
  81 /**
  82  * Header for messages which need fragmentation.  This is the format of
  83  * a message we obtain AFTER defragmentation.  We then need to check
  84  * the CRC and then tokenize the payload and pass it to the
  85  * 'receive' callback.
  86  */
  87 struct WlanHeader
  88 {
  89
  90   /**
  91    * Message type is GNUNET_MESSAGE_TYPE_WLAN_DATA.
  92    */
  93   struct GNUNET_MessageHeader header;
  94
  95   /**
  96    * CRC32 checksum (only over the payload), in NBO.
  97    */
  98   uint32_t crc GNUNET_PACKED;
  99
 100   /**
 101    * Sender of the message.
 102    */
 103   struct GNUNET_PeerIdentity sender;
 104
 105   /**
 106    * Target of the message.
 107    */
 108   struct GNUNET_PeerIdentity target;
 109
 110   /* followed by payload, possibly including
 111      multiple messages! */
 112
 113 };
 114
 115
 116 struct WlanAddress
 117 {
 118   uint32_t options GNUNET_PACKED;
 119
 120   struct GNUNET_TRANSPORT_WLAN_MacAddress mac;
 121 };
 122
 123
 124 GNUNET_NETWORK_STRUCT_END
 125
 126
 127 /**
 128  * Information kept for each message that is yet to be fragmented and
 129  * transmitted.
 130  */
 131 struct PendingMessage
 132 {
 133   /**
 134    * next entry in the DLL
 135    */
 136   struct PendingMessage *next;
 137
 138   /**
 139    * previous entry in the DLL
 140    */
 141   struct PendingMessage *prev;
 142
 143   /**
 144    * The pending message
 145    */
 146   struct WlanHeader *msg;
 147
 148   /**
 149    * Continuation function to call once the message
 150    * has been sent.  Can be NULL if there is no
 151    * continuation to call.
 152    */
 153   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
 154
 155   /**
 156    * Cls for transmit_cont
 157    */
 158   void *transmit_cont_cls;
 159
 160   /**
 161    * Timeout task (for this message).
 162    */
 163   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
 164
 165 };
 166
 167
 168 /**
 169  * Session handle for connections with other peers.
 170  */
 171 struct Session
 172 {
 173   /**
 174    * To whom are we talking to (set to our identity
 175    * if we are still waiting for the welcome message)
 176    */
 177   struct GNUNET_PeerIdentity target;
 178
 179   /**
 180    * API requirement (must be first).
 181    */
 182   struct SessionHeader header;
 183
 184   /**
 185    * We keep all sessions in a DLL at their respective
 186    * 'struct MACEndpoint'.
 187    */
 188   struct Session *next;
 189
 190   /**
 191    * We keep all sessions in a DLL at their respective
 192    * 'struct MACEndpoint'.
 193    */
 194   struct Session *prev;
 195
 196   /**
 197    * MAC endpoint with the address of this peer.
 198    */
 199   struct MacEndpoint *mac;
 200
 201   /**
 202    * Head of messages currently pending for transmission to this peer.
 203    */
 204   struct PendingMessage *pending_message_head;
 205
 206   /**
 207    * Tail of messages currently pending for transmission to this peer.
 208    */
 209   struct PendingMessage *pending_message_tail;
 210
 211   /**
 212    * When should this session time out?
 213    */
 214   struct GNUNET_TIME_Absolute timeout;
 215
 216   /**
 217    * Timeout task (for the session).
 218    */
 219   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
 220
 221 };
 222
 223
 224 /**
 225  * Struct for messages that are being fragmented in a MAC's transmission queue.
 226  */
 227 struct FragmentMessage
 228 {
 229
 230   /**
 231    * This is a doubly-linked list.
 232    */
 233   struct FragmentMessage *next;
 234
 235   /**
 236    * This is a doubly-linked list.
 237    */
 238   struct FragmentMessage *prev;
 239
 240   /**
 241    * MAC endpoint this message belongs to
 242    */
 243   struct MacEndpoint *macendpoint;
 244
 245   /**
 246    * Fragmentation context
 247    */
 248   struct GNUNET_FRAGMENT_Context *fragcontext;
 249
 250   /**
 251    * Transmission handle to helper (to cancel if the frag context
 252    * is destroyed early for some reason).
 253    */
 254   struct GNUNET_HELPER_SendHandle *sh;
 255
 256   /**
 257    * Intended recipient.
 258    */
 259   struct GNUNET_PeerIdentity target;
 260
 261   /**
 262    * Timeout value for the message.
 263    */
 264   struct GNUNET_TIME_Absolute timeout;
 265
 266   /**
 267    * Timeout task.
 268    */
 269   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
 270
 271   /**
 272    * Continuation to call when we're done with this message.
 273    */
 274   GNUNET_TRANSPORT_TransmitContinuation cont;
 275
 276   /**
 277    * Closure for 'cont'
 278    */
 279   void *cont_cls;
 280
 281   /**
 282    * Size of original message
 283    */
 284   size_t size_payload;
 285
 286   /**
 287    * Number of bytes used to transmit message
 288    */
 289   size_t size_on_wire;
 290
 291 };
 292
 293
 294 /**
 295  * Struct to represent one network card connection
 296  */
 297 struct MacEndpoint
 298 {
 299
 300   /**
 301    * We keep all MACs in a DLL in the plugin.
 302    */
 303   struct MacEndpoint *next;
 304
 305   /**
 306    * We keep all MACs in a DLL in the plugin.
 307    */
 308   struct MacEndpoint *prev;
 309
 310   /**
 311    * Pointer to the global plugin struct.
 312    */
 313   struct Plugin *plugin;
 314
 315   /**
 316    * Head of sessions that use this MAC.
 317    */
 318   struct Session *sessions_head;
 319
 320   /**
 321    * Tail of sessions that use this MAC.
 322    */
 323   struct Session *sessions_tail;
 324
 325   /**
 326    * Head of messages we are currently sending to this MAC.
 327    */
 328   struct FragmentMessage *sending_messages_head;
 329
 330   /**
 331    * Tail of messages we are currently sending to this MAC.
 332    */
 333   struct FragmentMessage *sending_messages_tail;
 334
 335   /**
 336    * Defrag context for this MAC
 337    */
 338   struct GNUNET_DEFRAGMENT_Context *defrag;
 339
 340   /**
 341    * When should this endpoint time out?
 342    */
 343   struct GNUNET_TIME_Absolute timeout;
 344
 345   /**
 346    * Timeout task.
 347    */
 348   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
 349
 350   /**
 351    * count of messages in the fragment out queue for this mac endpoint
 352    */
 353   unsigned int fragment_messages_out_count;
 354
 355   /**
 356    * peer mac address
 357    */
 358   struct WlanAddress addr;
 359
 360   /**
 361    * Message delay for fragmentation context
 362    */
 363   struct GNUNET_TIME_Relative msg_delay;
 364
 365   /**
 366    * ACK delay for fragmentation context
 367    */
 368   struct GNUNET_TIME_Relative ack_delay;
 369
 370   /**
 371    * Desired transmission power for this MAC
 372    */
 373   uint16_t tx_power;
 374
 375   /**
 376    * Desired transmission rate for this MAC
 377    */
 378   uint8_t rate;
 379
 380   /**
 381    * Antenna we should use for this MAC
 382    */
 383   uint8_t antenna;
 384
 385 };
 386
 387
 388 /**
 389  * Encapsulation of all of the state of the plugin.
 390  */
 391 struct Plugin
 392 {
 393   /**
 394    * Our environment.
 395    */
 396   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 397
 398   /**
 399    * Handle to helper process for priviledged operations.
 400    */
 401   struct GNUNET_HELPER_Handle *suid_helper;
 402
 403   /**
 404    * ARGV-vector for the helper (all helpers take only the binary
 405    * name, one actual argument, plus the NULL terminator for 'argv').
 406    */
 407   char * helper_argv[3];
 408
 409   /**
 410    * The interface of the wlan card given to us by the user.
 411    */
 412   char *interface;
 413
 414   /**
 415    * Tokenizer for demultiplexing of data packets resulting from defragmentation.
 416    */
 417   struct GNUNET_SERVER_MessageStreamTokenizer *fragment_data_tokenizer;
 418
 419   /**
 420    * Tokenizer for demultiplexing of data packets received from the suid helper
 421    */
 422   struct GNUNET_SERVER_MessageStreamTokenizer *helper_payload_tokenizer;
 423
 424   /**
 425    * Tokenizer for demultiplexing of data packets that follow the WLAN Header
 426    */
 427   struct GNUNET_SERVER_MessageStreamTokenizer *wlan_header_payload_tokenizer;
 428
 429   /**
 430    * Head of list of open connections.
 431    */
 432   struct MacEndpoint *mac_head;
 433
 434   /**
 435    * Tail of list of open connections.
 436    */
 437   struct MacEndpoint *mac_tail;
 438
 439   /**
 440    * Number of connections
 441    */
 442   unsigned int mac_count;
 443
 444   /**
 445    * Task that periodically sends a HELLO beacon via the helper.
 446    */
 447   GNUNET_SCHEDULER_TaskIdentifier beacon_task;
 448
 449   /**
 450    * Tracker for bandwidth limit
 451    */
 452   struct GNUNET_BANDWIDTH_Tracker tracker;
 453
 454   /**
 455    * The mac_address of the wlan card given to us by the helper.
 456    */
 457   struct GNUNET_TRANSPORT_WLAN_MacAddress mac_address;
 458
 459   /**
 460    * Have we received a control message with our MAC address yet?
 461    */
 462   int have_mac;
 463
 464   /**
 465    * Options for addresses
 466    */
 467   uint32_t options;
 468
 469 };
 470
 471
 472 /**
 473  * Information associated with a message.  Can contain
 474  * the session or the MAC endpoint associated with the
 475  * message (or both).
 476  */
 477 struct MacAndSession
 478 {
 479   /**
 480    * NULL if the identity of the other peer is not known.
 481    */
 482   struct Session *session;
 483
 484   /**
 485    * MAC address of the other peer, NULL if not known.
 486    */
 487   struct MacEndpoint *endpoint;
 488 };
 489
 490 /**
 491  * Function called for a quick conversion of the binary address to
 492  * a numeric address.  Note that the caller must not free the
 493  * address and that the next call to this function is allowed
 494  * to override the address again.
 495  *
 496  * @param cls closure
 497  * @param addr binary address
 498  * @param addrlen length of the address
 499  * @return string representing the same address
 500  */
 501 static const char *
 502 bluetooth_plugin_address_to_string (void *cls, const void *addr, size_t addrlen);
 503
 504 /**
 505  * Print MAC addresses nicely.
 506  *
 507  * @param mac the mac address
 508  * @return string to a static buffer with the human-readable mac, will be overwritten during the next call to this function
 509  */
 510 static const char *
 511 mac_to_string (const struct GNUNET_TRANSPORT_WLAN_MacAddress * mac)
 512 {
 513   static char macstr[20];
 514
 515   GNUNET_snprintf (macstr, sizeof (macstr), "%.2X:%.2X:%.2X:%.2X:%.2X:%.2X",
 516                                                                  mac->mac[0], mac->mac[1],
 517                    mac->mac[2], mac->mac[3], mac->mac[4], mac->mac[5]);
 518   return macstr;
 519 }
 520
 521
 522 /**
 523  * Fill the radiotap header
 524  *
 525  * @param endpoint pointer to the endpoint, can be NULL
 526  * @param header pointer to the radiotap header
 527  * @param size total message size
 528  */
 529 static void
 530 get_radiotap_header (struct MacEndpoint *endpoint,
 531                      struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage *header,
 532                      uint16_t size)
 533 {
 534   header->header.type = ntohs (GNUNET_MESSAGE_TYPE_WLAN_DATA_TO_HELPER);
 535   header->header.size = ntohs (size);
 536   if (NULL != endpoint)
 537   {
 538     header->rate = endpoint->rate;
 539     header->tx_power = endpoint->tx_power;
 540     header->antenna = endpoint->antenna;
 541   }
 542   else
 543   {
 544     header->rate = 255;
 545     header->tx_power = 0;
 546     header->antenna = 0;
 547   }
 548 }
 549
 550
 551 /**
 552  * Generate the WLAN hardware header for one packet
 553  *
 554  * @param plugin the plugin handle
 555  * @param header address to write the header to
 556  * @param to_mac_addr address of the recipient
 557  * @param size size of the whole packet, needed to calculate the time to send the packet
 558  */
 559 static void
 560 get_wlan_header (struct Plugin *plugin,
 561                  struct GNUNET_TRANSPORT_WLAN_Ieee80211Frame *header,
 562                  const struct GNUNET_TRANSPORT_WLAN_MacAddress *to_mac_addr,
 563                  unsigned int size)
 564 {
 565   const int rate = 11000000;
 566
 567   header->frame_control = htons (IEEE80211_FC0_TYPE_DATA);
 568   header->addr1 = *to_mac_addr;
 569   header->addr2 = plugin->mac_address;
 570   header->addr3 = mac_bssid_gnunet;
 571   header->duration = GNUNET_htole16 ((size * 1000000) / rate + 290);
 572   header->sequence_control = 0; // FIXME?
 573   header->llc[0] = WLAN_LLC_DSAP_FIELD;
 574   header->llc[1] = WLAN_LLC_SSAP_FIELD;
 575   header->llc[2] = 0;  // FIXME?
 576   header->llc[3] = 0;  // FIXME?
 577 }
 578
 579
 580 /**
 581  * Send an ACK for a fragment we received.
 582  *
 583  * @param cls the 'struct MacEndpoint' the ACK must be sent to
 584  * @param msg_id id of the message
 585  * @param hdr pointer to the hdr where the ack is stored
 586  */
 587 static void
 588 send_ack (void *cls, uint32_t msg_id,
 589           const struct GNUNET_MessageHeader *hdr)
 590 {
 591   struct MacEndpoint *endpoint = cls;
 592   struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage* radio_header;
 593   uint16_t msize = ntohs (hdr->size);
 594   size_t size = sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage) + msize;
 595   char buf[size];
 596
 597   if (size >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 598   {
 599     GNUNET_break (0);
 600     return;
 601   }
 602   LOG (GNUNET_ERROR_TYPE_DEBUG,
 603        "Sending ACK to helper\n");
 604   radio_header = (struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage *) buf;
 605   get_radiotap_header (endpoint, radio_header, size);
 606   get_wlan_header (endpoint->plugin,
 607                    &radio_header->frame,
 608                    &endpoint->addr.mac,
 609                    size);
 610   memcpy (&radio_header[1], hdr, msize);
 611   if (NULL !=
 612       GNUNET_HELPER_send (endpoint->plugin->suid_helper,
 613                           &radio_header->header,
 614                           GNUNET_NO /* dropping ACKs is bad */,
 615                           NULL, NULL))
 616     GNUNET_STATISTICS_update (endpoint->plugin->env->stats, _("# Bluetooth ACKs sent"),
 617                               1, GNUNET_NO);
 618 }
 619
 620
 621 /**
 622  * Handles the data after all fragments are put together
 623  *
 624  * @param cls macendpoint this messages belongs to
 625  * @param hdr pointer to the data
 626  */
 627 static void
 628 bluetooth_data_message_handler (void *cls, const struct GNUNET_MessageHeader *hdr)
 629 {
 630   struct MacEndpoint *endpoint = cls;
 631   struct Plugin *plugin = endpoint->plugin;
 632   struct MacAndSession mas;
 633
 634   GNUNET_STATISTICS_update (plugin->env->stats,
 635                             _("# Bluetooth messages defragmented"), 1,
 636                             GNUNET_NO);
 637   mas.session = NULL;
 638   mas.endpoint = endpoint;
 639   (void) GNUNET_SERVER_mst_receive (plugin->fragment_data_tokenizer,
 640                                     &mas,
 641                                     (const char *) hdr,
 642                                     ntohs (hdr->size),
 643                                     GNUNET_YES, GNUNET_NO);
 644 }
 645
 646
 647 /**
 648  * Free a session
 649  *
 650  * @param session the session free
 651  */
 652 static void
 653 free_session (struct Session *session)
 654 {
 655   struct MacEndpoint *endpoint = session->mac;
 656   struct PendingMessage *pm;
 657
 658   endpoint->plugin->env->session_end (endpoint->plugin->env->cls,
 659                                       &session->target,
 660                                       session);
 661   while (NULL != (pm = session->pending_message_head))
 662   {
 663     GNUNET_CONTAINER_DLL_remove (session->pending_message_head,
 664                                  session->pending_message_tail, pm);
 665     if (GNUNET_SCHEDULER_NO_TASK != pm->timeout_task)
 666     {
 667       GNUNET_SCHEDULER_cancel (pm->timeout_task);
 668       pm->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 669     }
 670     GNUNET_free (pm->msg);
 671     GNUNET_free (pm);
 672   }
 673   GNUNET_CONTAINER_DLL_remove (endpoint->sessions_head,
 674                                endpoint->sessions_tail,
 675                                session);
 676   if (session->timeout_task != GNUNET_SCHEDULER_NO_TASK)
 677   {
 678     GNUNET_SCHEDULER_cancel (session->timeout_task);
 679     session->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 680   }
 681   GNUNET_STATISTICS_update (endpoint->plugin->env->stats, _("# Bluetooth sessions allocated"), -1,
 682                             GNUNET_NO);
 683   GNUNET_free (session);
 684 }
 685
 686
 687 /**
 688  * A session is timing out.  Clean up.
 689  *
 690  * @param cls pointer to the Session
 691  * @param tc pointer to the GNUNET_SCHEDULER_TaskContext
 692  */
 693 static void
 694 session_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 695 {
 696   struct Session * session = cls;
 697   struct GNUNET_TIME_Relative timeout;
 698
 699   session->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 700   timeout = GNUNET_TIME_absolute_get_remaining (session->timeout);
 701   if (0 == timeout.rel_value_us)
 702   {
 703     free_session (session);
 704     return;
 705   }
 706   session->timeout_task =
 707     GNUNET_SCHEDULER_add_delayed (timeout, &session_timeout, session);
 708 }
 709
 710
 711 /**
 712  * Create a new session
 713  *
 714  * @param endpoint pointer to the mac endpoint of the peer
 715  * @param peer peer identity to use for this session
 716  * @return returns the session
 717  */
 718 static struct Session *
 719 create_session (struct MacEndpoint *endpoint,
 720                 const struct GNUNET_PeerIdentity *peer)
 721 {
 722   struct Session *session;
 723
 724   for (session = endpoint->sessions_head; NULL != session; session = session->next)
 725     if (0 == memcmp (peer, &session->target,
 726                      sizeof (struct GNUNET_PeerIdentity)))
 727     {
 728       session->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
 729       return session;
 730     }
 731   GNUNET_STATISTICS_update (endpoint->plugin->env->stats, _("# Bluetooth sessions allocated"), 1,
 732                             GNUNET_NO);
 733   session = GNUNET_malloc (sizeof (struct Session));
 734   GNUNET_CONTAINER_DLL_insert_tail (endpoint->sessions_head,
 735                                     endpoint->sessions_tail,
 736                                     session);
 737   session->mac = endpoint;
 738   session->target = *peer;
 739   session->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
 740   session->timeout_task =
 741       GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT, &session_timeout, session);
 742   LOG (GNUNET_ERROR_TYPE_DEBUG,
 743        "Created new session for peer `%s' with endpoint %s\n",
 744        GNUNET_i2s (peer),
 745        mac_to_string (&endpoint->addr.mac));
 746   return session;
 747 }
 748
 749
 750 /**
 751  * Function called once we have successfully given the fragment
 752  * message to the SUID helper process and we are thus ready for
 753  * the next fragment.
 754  *
 755  * @param cls the 'struct FragmentMessage'
 756  * @param result result of the operation (GNUNET_OK on success, GNUNET_NO if the helper died, GNUNET_SYSERR
 757  *        if the helper was stopped)
 758  */
 759 static void
 760 fragment_transmission_done (void *cls,
 761                             int result)
 762 {
 763   struct FragmentMessage *fm = cls;
 764
 765
 766   fm->sh = NULL;
 767   GNUNET_FRAGMENT_context_transmission_done (fm->fragcontext);
 768 }
 769
 770
 771 /**
 772  * Transmit a fragment of a message.
 773  *
 774  * @param cls 'struct FragmentMessage' this fragment message belongs to
 775  * @param hdr pointer to the start of the fragment message
 776  */
 777 static void
 778 transmit_fragment (void *cls,
 779                    const struct GNUNET_MessageHeader *hdr)
 780 {
 781   struct FragmentMessage *fm = cls;
 782   struct MacEndpoint *endpoint = fm->macendpoint;
 783   size_t size;
 784   uint16_t msize;
 785
 786   msize = ntohs (hdr->size);
 787   size = sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage) + msize;
 788   {
 789     char buf[size];
 790     struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage *radio_header;
 791
 792     radio_header = (struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage *) buf;
 793     get_radiotap_header (endpoint, radio_header, size);
 794     get_wlan_header (endpoint->plugin,
 795                      &radio_header->frame,
 796                      &endpoint->addr.mac,
 797                      size);
 798     memcpy (&radio_header[1], hdr, msize);
 799     GNUNET_assert (NULL == fm->sh);
 800     fm->sh = GNUNET_HELPER_send (endpoint->plugin->suid_helper,
 801                                  &radio_header->header,
 802                                  GNUNET_NO,
 803                                  &fragment_transmission_done, fm);
 804     fm->size_on_wire += size;
 805     if (NULL != fm->sh)
 806       GNUNET_STATISTICS_update (endpoint->plugin->env->stats, _("# Bluetooth message fragments sent"),
 807                                 1, GNUNET_NO);
 808     else
 809       GNUNET_FRAGMENT_context_transmission_done (fm->fragcontext);
 810     GNUNET_STATISTICS_update (endpoint->plugin->env->stats,
 811                               "# bytes currently in Bluetooth buffers",
 812                               -msize, GNUNET_NO);
 813     GNUNET_STATISTICS_update (endpoint->plugin->env->stats,
 814                               "# bytes transmitted via Bluetooth",
 815                               msize, GNUNET_NO);
 816   }
 817 }
 818
 819
 820 /**
 821  * Frees the space of a message in the fragment queue (send queue)
 822  *
 823  * @param fm message to free
 824  */
 825 static void
 826 free_fragment_message (struct FragmentMessage *fm)
 827 {
 828   struct MacEndpoint *endpoint = fm->macendpoint;
 829
 830   GNUNET_STATISTICS_update (endpoint->plugin->env->stats, _("# Bluetooth messages pending (with fragmentation)"),
 831                             -1, GNUNET_NO);
 832   GNUNET_CONTAINER_DLL_remove (endpoint->sending_messages_head,
 833                                endpoint->sending_messages_tail, fm);
 834   if (NULL != fm->sh)
 835   {
 836     GNUNET_HELPER_send_cancel (fm->sh);
 837     fm->sh = NULL;
 838   }
 839   GNUNET_FRAGMENT_context_destroy (fm->fragcontext,
 840                                                                    &endpoint->msg_delay,
 841                                                                    &endpoint->ack_delay);
 842   if (fm->timeout_task != GNUNET_SCHEDULER_NO_TASK)
 843   {
 844     GNUNET_SCHEDULER_cancel (fm->timeout_task);
 845     fm->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 846   }
 847   GNUNET_free (fm);
 848 }
 849
 850
 851 /**
 852  * A FragmentMessage has timed out.  Remove it.
 853  *
 854  * @param cls pointer to the 'struct FragmentMessage'
 855  * @param tc pointer to the GNUNET_SCHEDULER_TaskContext
 856  */
 857 static void
 858 fragmentmessage_timeout (void *cls,
 859                          const struct GNUNET_SCHEDULER_TaskContext *tc)
 860 {
 861   struct FragmentMessage *fm = cls;
 862
 863   fm->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 864   if (NULL != fm->cont)
 865   {
 866     fm->cont (fm->cont_cls, &fm->target, GNUNET_SYSERR, fm->size_payload, fm->size_on_wire);
 867     fm->cont = NULL;
 868   }
 869   free_fragment_message (fm);
 870 }
 871
 872
 873 /**
 874  * Transmit a message to the given destination with fragmentation.
 875  *
 876  * @param endpoint desired destination
 877  * @param timeout how long can the message wait?
 878  * @param target peer that should receive the message
 879  * @param msg message to transmit
 880  * @param payload_size bytes of payload
 881  * @param cont continuation to call once the message has
 882  *        been transmitted (or if the transport is ready
 883  *        for the next transmission call; or if the
 884  *        peer disconnected...); can be NULL
 885  * @param cont_cls closure for cont
 886  */
 887 static void
 888 send_with_fragmentation (struct MacEndpoint *endpoint,
 889                          struct GNUNET_TIME_Relative timeout,
 890                          const struct GNUNET_PeerIdentity *target,
 891                          const struct GNUNET_MessageHeader *msg,
 892                          size_t payload_size,
 893                          GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
 894
 895 {
 896   struct FragmentMessage *fm;
 897   struct Plugin *plugin;
 898
 899   plugin = endpoint->plugin;
 900   fm = GNUNET_malloc (sizeof (struct FragmentMessage));
 901   fm->macendpoint = endpoint;
 902   fm->target = *target;
 903   fm->size_payload = payload_size;
 904   fm->size_on_wire = 0;
 905   fm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 906   fm->cont = cont;
 907   fm->cont_cls = cont_cls;
 908   /* 1 MBit/s typical data rate, 1430 byte fragments => ~100 ms per message */
 909   fm->fragcontext =
 910     GNUNET_FRAGMENT_context_create (plugin->env->stats, WLAN_MTU,
 911                                     &plugin->tracker,
 912                                     endpoint->msg_delay,
 913                                     endpoint->ack_delay,
 914                                     msg,
 915                                     &transmit_fragment, fm);
 916   fm->timeout_task =
 917     GNUNET_SCHEDULER_add_delayed (timeout,
 918                                   &fragmentmessage_timeout, fm);
 919   GNUNET_CONTAINER_DLL_insert_tail (endpoint->sending_messages_head,
 920                                     endpoint->sending_messages_tail,
 921                                     fm);
 922 }
 923
 924
 925 /**
 926  * Free a MAC endpoint.
 927  *
 928  * @param endpoint pointer to the MacEndpoint to free
 929  */
 930 static void
 931 free_macendpoint (struct MacEndpoint *endpoint)
 932 {
 933   struct Plugin *plugin = endpoint->plugin;
 934   struct FragmentMessage *fm;
 935   struct Session *session;
 936
 937   GNUNET_STATISTICS_update (plugin->env->stats,
 938                             _("# Bluetooth MAC endpoints allocated"), -1, GNUNET_NO);
 939   while (NULL != (session = endpoint->sessions_head))
 940     free_session (session);
 941   while (NULL != (fm = endpoint->sending_messages_head))
 942     free_fragment_message (fm);
 943   GNUNET_CONTAINER_DLL_remove (plugin->mac_head,
 944                                plugin->mac_tail,
 945                                endpoint);
 946
 947   if (NULL != endpoint->defrag)
 948   {
 949     GNUNET_DEFRAGMENT_context_destroy(endpoint->defrag);
 950     endpoint->defrag = NULL;
 951   }
 952
 953   plugin->mac_count--;
 954   if (GNUNET_SCHEDULER_NO_TASK != endpoint->timeout_task)
 955   {
 956     GNUNET_SCHEDULER_cancel (endpoint->timeout_task);
 957     endpoint->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 958   }
 959   GNUNET_free (endpoint);
 960 }
 961
 962
 963 /**
 964  * A MAC endpoint is timing out.  Clean up.
 965  *
 966  * @param cls pointer to the MacEndpoint
 967  * @param tc pointer to the GNUNET_SCHEDULER_TaskContext
 968  */
 969 static void
 970 macendpoint_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 971 {
 972   struct MacEndpoint *endpoint = cls;
 973   struct GNUNET_TIME_Relative timeout;
 974
 975   endpoint->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 976   timeout = GNUNET_TIME_absolute_get_remaining (endpoint->timeout);
 977   if (0 == timeout.rel_value_us)
 978   {
 979     free_macendpoint (endpoint);
 980     return;
 981   }
 982   endpoint->timeout_task =
 983     GNUNET_SCHEDULER_add_delayed (timeout, &macendpoint_timeout,
 984                                   endpoint);
 985 }
 986
 987
 988 /**
 989  * Find (or create) a MacEndpoint with a specific MAC address
 990  *
 991  * @param plugin pointer to the plugin struct
 992  * @param addr the MAC address of the endpoint
 993  * @return handle to our data structure for this MAC
 994  */
 995 static struct MacEndpoint *
 996 create_macendpoint (struct Plugin *plugin,
 997                     const struct WlanAddress *addr)
 998 {
 999   struct MacEndpoint *pos;
1000
1001   for (pos = plugin->mac_head; NULL != pos; pos = pos->next)
1002     if (0 == memcmp (addr, &pos->addr, sizeof (struct WlanAddress)))
1003       return pos;
1004   pos = GNUNET_malloc (sizeof (struct MacEndpoint));
1005   pos->addr = *addr;
1006   pos->plugin = plugin;
1007   pos->defrag =
1008     GNUNET_DEFRAGMENT_context_create (plugin->env->stats, WLAN_MTU,
1009                                       MESSAGES_IN_DEFRAG_QUEUE_PER_MAC,
1010                                       pos,
1011                                       &bluetooth_data_message_handler,
1012                                       &send_ack);
1013
1014   pos->msg_delay = GNUNET_TIME_UNIT_MILLISECONDS;
1015   pos->ack_delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
1016                                                                                                   100);
1017   pos->timeout = GNUNET_TIME_relative_to_absolute (MACENDPOINT_TIMEOUT);
1018   pos->timeout_task =
1019       GNUNET_SCHEDULER_add_delayed (MACENDPOINT_TIMEOUT, &macendpoint_timeout,
1020                                     pos);
1021   GNUNET_CONTAINER_DLL_insert (plugin->mac_head, plugin->mac_tail, pos);
1022   plugin->mac_count++;
1023   GNUNET_STATISTICS_update (plugin->env->stats, _("# Bluetooth MAC endpoints allocated"),
1024                             1, GNUNET_NO);
1025   LOG (GNUNET_ERROR_TYPE_DEBUG,
1026        "New MAC endpoint `%s'\n",
1027        bluetooth_plugin_address_to_string(NULL, addr, sizeof (struct WlanAddress)));
1028   return pos;
1029 }
1030
1031
1032 /**
1033  * Function obtain the network type for a session
1034  *
1035  * @param cls closure ('struct Plugin*')
1036  * @param session the session
1037  * @return the network type in HBO or GNUNET_SYSERR
1038  */
1039 static enum GNUNET_ATS_Network_Type
1040 bluetooth_get_network (void *cls,
1041                        struct Session *session)
1042 {
1043   GNUNET_assert (NULL != session);
1044   return GNUNET_ATS_NET_BT;
1045 }
1046
1047
1048 /**
1049  * Creates a new outbound session the transport service will use to send data to the
1050  * peer
1051  *
1052  * @param cls the plugin
1053  * @param address the address
1054  * @return the session or NULL of max connections exceeded
1055  */
1056 static struct Session *
1057 bluetooth_plugin_get_session (void *cls,
1058                          const struct GNUNET_HELLO_Address *address)
1059 {
1060   struct Plugin *plugin = cls;
1061   struct MacEndpoint *endpoint;
1062
1063   if (NULL == address)
1064     return NULL;
1065   if (sizeof (struct WlanAddress) != address->address_length)
1066   {
1067     GNUNET_break (0);
1068     return NULL;
1069   }
1070   LOG (GNUNET_ERROR_TYPE_DEBUG,
1071        "Service asked to create session for peer `%s' with MAC `%s'\n",
1072        GNUNET_i2s (&address->peer),
1073        bluetooth_plugin_address_to_string(NULL, address->address, address->address_length));
1074   endpoint = create_macendpoint (plugin, address->address);
1075   return create_session (endpoint, &address->peer);
1076 }
1077
1078
1079 /**
1080  * Function that can be used to force the plugin to disconnect
1081  * from the given peer and cancel all previous transmissions
1082  * (and their continuation).
1083  *
1084  * @param cls closure
1085  * @param target peer from which to disconnect
1086  */
1087 static void
1088 bluetooth_plugin_disconnect_peer (void *cls, const struct GNUNET_PeerIdentity *target)
1089 {
1090   struct Plugin *plugin = cls;
1091   struct Session *session;
1092   struct MacEndpoint *endpoint;
1093
1094   for (endpoint = plugin->mac_head; NULL != endpoint; endpoint = endpoint->next)
1095     for (session = endpoint->sessions_head; NULL != session; session = session->next)
1096       if (0 == memcmp (target, &session->target,
1097         sizeof (struct GNUNET_PeerIdentity)))
1098       {
1099         free_session (session);
1100         break; /* inner-loop only (in case peer has another MAC as well!) */
1101       }
1102 }
1103
1104
1105 /**
1106  * Function that can be used to force the plugin to disconnect
1107  * from the given peer and cancel all previous transmissions
1108  * (and their continuation).
1109  *
1110  * @param cls closure
1111  * @param session session to disconnect
1112  */
1113 static int
1114 bluetooth_plugin_disconnect_session (void *cls,
1115                                      struct Session *session)
1116 {
1117   free_session (session);
1118   return GNUNET_OK;
1119 }
1120
1121
1122 /**
1123  * Function that can be used by the transport service to transmit
1124  * a message using the plugin.   Note that in the case of a
1125  * peer disconnecting, the continuation MUST be called
1126  * prior to the disconnect notification itself.  This function
1127  * will be called with this peer's HELLO message to initiate
1128  * a fresh connection to another peer.
1129  *
1130  * @param cls closure
1131  * @param session which session must be used
1132  * @param msgbuf the message to transmit
1133  * @param msgbuf_size number of bytes in 'msgbuf'
1134  * @param priority how important is the message (most plugins will
1135  *                 ignore message priority and just FIFO)
1136  * @param to how long to wait at most for the transmission (does not
1137  *                require plugins to discard the message after the timeout,
1138  *                just advisory for the desired delay; most plugins will ignore
1139  *                this as well)
1140  * @param cont continuation to call once the message has
1141  *        been transmitted (or if the transport is ready
1142  *        for the next transmission call; or if the
1143  *        peer disconnected...); can be NULL
1144  * @param cont_cls closure for cont
1145  * @return number of bytes used (on the physical network, with overheads);
1146  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
1147  *         and does NOT mean that the message was not transmitted (DV)
1148  */
1149 static ssize_t
1150 bluetooth_plugin_send (void *cls,
1151                   struct Session *session,
1152                   const char *msgbuf, size_t msgbuf_size,
1153                   unsigned int priority,
1154                   struct GNUNET_TIME_Relative to,
1155                   GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
1156 {
1157   struct Plugin *plugin = cls;
1158   struct WlanHeader *wlanheader;
1159   size_t size = msgbuf_size + sizeof (struct WlanHeader);
1160   char buf[size] GNUNET_ALIGN;
1161
1162   LOG (GNUNET_ERROR_TYPE_DEBUG,
1163        "Transmitting %u bytes of payload to peer `%s' (starting with %u byte message of type %u)\n",
1164        msgbuf_size,
1165        GNUNET_i2s (&session->target),
1166        (unsigned int) ntohs (((struct GNUNET_MessageHeader*)msgbuf)->size),
1167        (unsigned int) ntohs (((struct GNUNET_MessageHeader*)msgbuf)->type));
1168   wlanheader = (struct WlanHeader *) buf;
1169   wlanheader->header.size = htons (msgbuf_size + sizeof (struct WlanHeader));
1170   wlanheader->header.type = htons (GNUNET_MESSAGE_TYPE_WLAN_DATA);
1171   wlanheader->sender = *plugin->env->my_identity;
1172   wlanheader->target = session->target;
1173   wlanheader->crc = htonl (GNUNET_CRYPTO_crc32_n (msgbuf, msgbuf_size));
1174   memcpy (&wlanheader[1], msgbuf, msgbuf_size);
1175
1176   GNUNET_STATISTICS_update (plugin->env->stats,
1177                             "# bytes currently in Bluetooth buffers",
1178                             msgbuf_size, GNUNET_NO);
1179
1180   send_with_fragmentation (session->mac,
1181                            to,
1182                            &session->target,
1183                            &wlanheader->header,
1184                            msgbuf_size,
1185                            cont, cont_cls);
1186   return size;
1187 }
1188
1189
1190 /**
1191  * We have received data from the WLAN via some session.  Process depending
1192  * on the message type (HELLO, DATA, FRAGMENTATION or FRAGMENTATION-ACK).
1193  *
1194  * @param cls pointer to the plugin
1195  * @param client pointer to the session this message belongs to
1196  * @param hdr start of the message
1197  */
1198 static int
1199 process_data (void *cls, void *client, const struct GNUNET_MessageHeader *hdr)
1200 {
1201   struct Plugin *plugin = cls;
1202   struct MacAndSession *mas = client;
1203   struct MacAndSession xmas;
1204   struct GNUNET_ATS_Information ats;
1205   struct FragmentMessage *fm;
1206   struct GNUNET_PeerIdentity tmpsource;
1207   const struct WlanHeader *wlanheader;
1208   int ret;
1209   uint16_t msize;
1210
1211   ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
1212   ats.value = htonl (GNUNET_ATS_NET_BT);
1213   msize = ntohs (hdr->size);
1214
1215   GNUNET_STATISTICS_update (plugin->env->stats,
1216                             "# bytes received via Bluetooth",
1217                             msize, GNUNET_NO);
1218
1219   switch (ntohs (hdr->type))
1220   {
1221   case GNUNET_MESSAGE_TYPE_HELLO:
1222     if (GNUNET_OK !=
1223         GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) hdr, &tmpsource))
1224     {
1225       GNUNET_break_op (0);
1226       break;
1227     }
1228     LOG (GNUNET_ERROR_TYPE_DEBUG,
1229          "Processing %u bytes of HELLO from peer `%s' at MAC %s\n",
1230          (unsigned int) msize,
1231          GNUNET_i2s (&tmpsource),
1232          bluetooth_plugin_address_to_string (NULL, &mas->endpoint->addr, sizeof (struct WlanAddress)));
1233
1234     GNUNET_STATISTICS_update (plugin->env->stats,
1235                               _("# HELLO messages received via Bluetooth"), 1,
1236                               GNUNET_NO);
1237     plugin->env->receive (plugin->env->cls,
1238                           &tmpsource,
1239                           hdr,
1240                           mas->session,
1241                           (mas->endpoint == NULL) ? NULL : (const char *) &mas->endpoint->addr,
1242                           (mas->endpoint == NULL) ? 0 : sizeof (struct GNUNET_TRANSPORT_WLAN_MacAddress));
1243     plugin->env->update_address_metrics (plugin->env->cls,
1244                                          &tmpsource,
1245                                          (mas->endpoint == NULL) ? NULL : (const char *) &mas->endpoint->addr,
1246                                          (mas->endpoint == NULL) ? 0 : sizeof (struct GNUNET_TRANSPORT_WLAN_MacAddress),
1247                                          mas->session,
1248                                          &ats, 1);
1249     break;
1250   case GNUNET_MESSAGE_TYPE_FRAGMENT:
1251     if (NULL == mas->endpoint)
1252     {
1253       GNUNET_break (0);
1254       break;
1255     }
1256     LOG (GNUNET_ERROR_TYPE_DEBUG,
1257          "Processing %u bytes of FRAGMENT from MAC %s\n",
1258          (unsigned int) msize,
1259          bluetooth_plugin_address_to_string (NULL, &mas->endpoint->addr, sizeof (struct WlanAddress)));
1260     GNUNET_STATISTICS_update (plugin->env->stats,
1261                               _("# fragments received via Bluetooth"), 1, GNUNET_NO);
1262     (void) GNUNET_DEFRAGMENT_process_fragment (mas->endpoint->defrag,
1263                                               hdr);
1264     break;
1265   case GNUNET_MESSAGE_TYPE_FRAGMENT_ACK:
1266     if (NULL == mas->endpoint)
1267     {
1268       GNUNET_break (0);
1269       break;
1270     }
1271     GNUNET_STATISTICS_update (plugin->env->stats, _("# ACKs received via Bluetooth"),
1272                               1, GNUNET_NO);
1273     for (fm = mas->endpoint->sending_messages_head; NULL != fm; fm = fm->next)
1274     {
1275       ret = GNUNET_FRAGMENT_process_ack (fm->fragcontext, hdr);
1276       if (GNUNET_OK == ret)
1277       {
1278         LOG (GNUNET_ERROR_TYPE_DEBUG,
1279              "Got last ACK, finished message transmission to `%s' (%p)\n",
1280                  bluetooth_plugin_address_to_string (NULL, &mas->endpoint->addr, sizeof (struct WlanAddress)),
1281              fm);
1282         mas->endpoint->timeout = GNUNET_TIME_relative_to_absolute (MACENDPOINT_TIMEOUT);
1283         if (NULL != fm->cont)
1284         {
1285           fm->cont (fm->cont_cls, &fm->target, GNUNET_OK, fm->size_payload, fm->size_on_wire);
1286           fm->cont = NULL;
1287         }
1288         free_fragment_message (fm);
1289         break;
1290       }
1291       if (GNUNET_NO == ret)
1292       {
1293         LOG (GNUNET_ERROR_TYPE_DEBUG,
1294              "Got an ACK, message transmission to `%s' not yet finished\n",
1295                   bluetooth_plugin_address_to_string (NULL, &mas->endpoint->addr, sizeof (struct WlanAddress)));
1296         break;
1297       }
1298     }
1299     LOG (GNUNET_ERROR_TYPE_DEBUG,
1300          "ACK not matched against any active fragmentation with MAC `%s'\n",
1301          bluetooth_plugin_address_to_string (NULL, &mas->endpoint->addr, sizeof (struct WlanAddress)));
1302     break;
1303   case GNUNET_MESSAGE_TYPE_WLAN_DATA:
1304     if (NULL == mas->endpoint)
1305     {
1306       GNUNET_break (0);
1307       break;
1308     }
1309     if (msize < sizeof (struct WlanHeader))
1310     {
1311       GNUNET_break (0);
1312       break;
1313     }
1314     wlanheader = (const struct WlanHeader *) hdr;
1315     if (0 != memcmp (&wlanheader->target,
1316                      plugin->env->my_identity,
1317                      sizeof (struct GNUNET_PeerIdentity)))
1318     {
1319       LOG (GNUNET_ERROR_TYPE_DEBUG,
1320            "Bluetooth data for `%s', not for me, ignoring\n",
1321            GNUNET_i2s (&wlanheader->target));
1322       break;
1323     }
1324     if (ntohl (wlanheader->crc) !=
1325         GNUNET_CRYPTO_crc32_n (&wlanheader[1], msize - sizeof (struct WlanHeader)))
1326     {
1327       GNUNET_STATISTICS_update (plugin->env->stats,
1328                                 _("# Bluetooth DATA messages discarded due to CRC32 error"), 1,
1329                                 GNUNET_NO);
1330       break;
1331     }
1332     xmas.endpoint = mas->endpoint;
1333     xmas.session = create_session (mas->endpoint, &wlanheader->sender);
1334     LOG (GNUNET_ERROR_TYPE_DEBUG,
1335          "Processing %u bytes of BLUETOOTH DATA from peer `%s'\n",
1336          (unsigned int) msize,
1337          GNUNET_i2s (&wlanheader->sender));
1338     (void) GNUNET_SERVER_mst_receive (plugin->wlan_header_payload_tokenizer,
1339                                       &xmas,
1340                                       (const char *) &wlanheader[1],
1341                                       msize - sizeof (struct WlanHeader),
1342                                       GNUNET_YES, GNUNET_NO);
1343     break;
1344   default:
1345     if (NULL == mas->endpoint)
1346     {
1347       GNUNET_break (0);
1348       break;
1349     }
1350     if (NULL == mas->session)
1351     {
1352       GNUNET_break (0);
1353       break;
1354     }
1355     LOG (GNUNET_ERROR_TYPE_DEBUG,
1356          "Received packet with %u bytes of type %u from peer %s\n",
1357          (unsigned int) msize,
1358          (unsigned int) ntohs (hdr->type),
1359          GNUNET_i2s (&mas->session->target));
1360     plugin->env->receive (plugin->env->cls,
1361                           &mas->session->target,
1362                           hdr,
1363                           mas->session,
1364                           (mas->endpoint == NULL) ? NULL : (const char *) &mas->endpoint->addr,
1365                           (mas->endpoint == NULL) ? 0 : sizeof (struct WlanAddress));
1366     plugin->env->update_address_metrics (plugin->env->cls,
1367                                          &mas->session->target,
1368                                          (mas->endpoint == NULL) ? NULL : (const char *) &mas->endpoint->addr,
1369                                          (mas->endpoint == NULL) ? 0 : sizeof (struct WlanAddress),
1370                                          mas->session,
1371                                          &ats, 1);
1372     break;
1373   }
1374   return GNUNET_OK;
1375 }
1376
1377
1378 /**
1379  * Function used for to process the data from the suid process
1380  *
1381  * @param cls the plugin handle
1382  * @param client client that send the data (not used)
1383  * @param hdr header of the GNUNET_MessageHeader
1384  */
1385 static int
1386 handle_helper_message (void *cls, void *client,
1387                        const struct GNUNET_MessageHeader *hdr)
1388 {
1389   struct Plugin *plugin = cls;
1390   const struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage *rxinfo;
1391   const struct GNUNET_TRANSPORT_WLAN_HelperControlMessage *cm;
1392   struct WlanAddress wa;
1393   struct MacAndSession mas;
1394   uint16_t msize;
1395
1396   msize = ntohs (hdr->size);
1397   switch (ntohs (hdr->type))
1398   {
1399   case GNUNET_MESSAGE_TYPE_WLAN_HELPER_CONTROL:
1400     if (msize != sizeof (struct GNUNET_TRANSPORT_WLAN_HelperControlMessage))
1401     {
1402       GNUNET_break (0);
1403       break;
1404     }
1405     cm = (const struct GNUNET_TRANSPORT_WLAN_HelperControlMessage *) hdr;
1406     if (GNUNET_YES == plugin->have_mac)
1407     {
1408       if (0 == memcmp (&plugin->mac_address,
1409                        &cm->mac,
1410                        sizeof (struct GNUNET_TRANSPORT_WLAN_MacAddress)))
1411         break; /* no change */
1412       /* remove old address */
1413       memset (&wa, 0, sizeof (struct WlanAddress));
1414       wa.mac = plugin->mac_address;
1415       wa.options = htonl(plugin->options);
1416       plugin->env->notify_address (plugin->env->cls, GNUNET_NO,
1417                                    &wa,
1418                                    sizeof (wa),
1419                                    "bluetooth");
1420     }
1421     plugin->mac_address = cm->mac;
1422     plugin->have_mac = GNUNET_YES;
1423     memset (&wa, 0, sizeof (struct WlanAddress));
1424     wa.mac = plugin->mac_address;
1425     wa.options = htonl(plugin->options);
1426     LOG (GNUNET_ERROR_TYPE_DEBUG,
1427          "Received BT_HELPER_CONTROL message with MAC address `%s' for peer `%s'\n",
1428          mac_to_string (&cm->mac),
1429          GNUNET_i2s (plugin->env->my_identity));
1430     plugin->env->notify_address (plugin->env->cls, GNUNET_YES,
1431                                  &wa,
1432                                  sizeof (struct WlanAddress),
1433                                  "bluetooth");
1434     break;
1435   case GNUNET_MESSAGE_TYPE_WLAN_DATA_FROM_HELPER:
1436     LOG (GNUNET_ERROR_TYPE_DEBUG,
1437          "Got data message from helper with %u bytes\n",
1438          msize);
1439     GNUNET_STATISTICS_update (plugin->env->stats,
1440                               _("# DATA messages received via Bluetooth"), 1,
1441                               GNUNET_NO);
1442     if (msize < sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage))
1443     {
1444       GNUNET_break (0);
1445       LOG (GNUNET_ERROR_TYPE_DEBUG,
1446            "Size of packet is too small (%u bytes)\n",
1447            msize);
1448       break;
1449     }
1450     rxinfo = (const struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage *) hdr;
1451
1452     /* check if message is actually for us */
1453     if (0 != memcmp (&rxinfo->frame.addr3, &mac_bssid_gnunet,
1454                      sizeof (struct GNUNET_TRANSPORT_WLAN_MacAddress)))
1455     {
1456       /* Not the GNUnet BSSID */
1457       break;
1458     }
1459     if ( (0 != memcmp (&rxinfo->frame.addr1, &bc_all_mac,
1460                        sizeof (struct GNUNET_TRANSPORT_WLAN_MacAddress))) &&
1461          (0 != memcmp (&rxinfo->frame.addr1, &plugin->mac_address,
1462                        sizeof (struct GNUNET_TRANSPORT_WLAN_MacAddress))) )
1463     {
1464       /* Neither broadcast nor specifically for us */
1465       break;
1466     }
1467     if (0 == memcmp (&rxinfo->frame.addr2, &plugin->mac_address,
1468                      sizeof (struct GNUNET_TRANSPORT_WLAN_MacAddress)))
1469     {
1470       /* packet is FROM us, thus not FOR us */
1471       break;
1472     }
1473
1474     GNUNET_STATISTICS_update (plugin->env->stats,
1475                               _("# Bluetooth DATA messages processed"),
1476                               1, GNUNET_NO);
1477     LOG (GNUNET_ERROR_TYPE_DEBUG,
1478          "Receiving %u bytes of data from MAC `%s'\n",
1479          (unsigned int) (msize - sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage)),
1480          mac_to_string (&rxinfo->frame.addr2));
1481     wa.mac = rxinfo->frame.addr2;
1482     wa.options = htonl (0);
1483     mas.endpoint = create_macendpoint (plugin, &wa);
1484     mas.session = NULL;
1485     (void) GNUNET_SERVER_mst_receive (plugin->helper_payload_tokenizer,
1486                                       &mas,
1487                                       (const char*) &rxinfo[1],
1488                                       msize - sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage),
1489                                       GNUNET_YES, GNUNET_NO);
1490     break;
1491   default:
1492     GNUNET_break (0);
1493     LOG (GNUNET_ERROR_TYPE_DEBUG,
1494          "Unexpected message of type %u (%u bytes)",
1495          ntohs (hdr->type), ntohs (hdr->size));
1496     break;
1497   }
1498   return GNUNET_OK;
1499 }
1500
1501
1502
1503 /**
1504  * Task to (periodically) send a HELLO beacon
1505  *
1506  * @param cls pointer to the plugin struct
1507  * @param tc scheduler context
1508  */
1509 static void
1510 send_hello_beacon (void *cls,
1511                    const struct GNUNET_SCHEDULER_TaskContext *tc)
1512 {
1513   struct Plugin *plugin = cls;
1514   uint16_t size;
1515   uint16_t hello_size;
1516   struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage *radioHeader;
1517   const struct GNUNET_MessageHeader *hello;
1518
1519   hello = plugin->env->get_our_hello ();
1520   hello_size = GNUNET_HELLO_size ((struct GNUNET_HELLO_Message *) hello);
1521   GNUNET_assert (sizeof (struct WlanHeader) + hello_size <= WLAN_MTU);
1522   size = sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage) + hello_size;
1523   {
1524     char buf[size] GNUNET_ALIGN;
1525
1526     LOG (GNUNET_ERROR_TYPE_DEBUG,
1527          "Sending %u byte HELLO beacon\n",
1528          (unsigned int) size);
1529     radioHeader = (struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage*) buf;
1530     get_radiotap_header (NULL, radioHeader, size);
1531     get_wlan_header (plugin, &radioHeader->frame, &bc_all_mac, size);
1532     memcpy (&radioHeader[1], hello, hello_size);
1533     if (NULL !=
1534         GNUNET_HELPER_send (plugin->suid_helper,
1535                             &radioHeader->header,
1536                             GNUNET_YES /* can drop */,
1537                             NULL, NULL))
1538       GNUNET_STATISTICS_update (plugin->env->stats, _("# HELLO beacons sent via Bluetooth"),
1539                                 1, GNUNET_NO);
1540   }
1541   plugin->beacon_task =
1542     GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
1543                                   (HELLO_BEACON_SCALING_FACTOR,
1544                                    plugin->mac_count + 1),
1545                                   &send_hello_beacon,
1546                                   plugin);
1547
1548 }
1549
1550
1551 /**
1552  * Another peer has suggested an address for this
1553  * peer and transport plugin.  Check that this could be a valid
1554  * address.  If so, consider adding it to the list
1555  * of addresses.
1556  *
1557  * @param cls closure
1558  * @param addr pointer to the address
1559  * @param addrlen length of addr
1560  * @return GNUNET_OK if this is a plausible address for this peer
1561  *         and transport
1562  */
1563 static int
1564 bluetooth_plugin_address_suggested (void *cls, const void *addr, size_t addrlen)
1565 {
1566   struct Plugin *plugin = cls;
1567   struct WlanAddress *wa = (struct WlanAddress *) addr;
1568
1569   if (addrlen != sizeof (struct WlanAddress))
1570   {
1571     GNUNET_break_op (0);
1572     return GNUNET_SYSERR;
1573   }
1574   if (GNUNET_YES != plugin->have_mac)
1575   {
1576     LOG (GNUNET_ERROR_TYPE_DEBUG,
1577          "Rejecting MAC `%s': I don't know my MAC!\n",
1578          mac_to_string (addr));
1579     return GNUNET_NO; /* don't know my MAC */
1580   }
1581   if (0 != memcmp (&wa->mac,
1582                    &plugin->mac_address,
1583                    sizeof (wa->mac)))
1584   {
1585     LOG (GNUNET_ERROR_TYPE_DEBUG,
1586          "Rejecting MAC `%s': not my MAC!\n",
1587          mac_to_string (addr));
1588     return GNUNET_NO; /* not my MAC */
1589   }
1590   return GNUNET_OK;
1591 }
1592
1593
1594 /**
1595  * Function called for a quick conversion of the binary address to
1596  * a numeric address.  Note that the caller must not free the
1597  * address and that the next call to this function is allowed
1598  * to override the address again.
1599  *
1600  * @param cls closure
1601  * @param addr binary address
1602  * @param addrlen length of the address
1603  * @return string representing the same address
1604  */
1605 static const char *
1606 bluetooth_plugin_address_to_string (void *cls, const void *addr, size_t addrlen)
1607 {
1608   const struct GNUNET_TRANSPORT_WLAN_MacAddress *mac;
1609   static char macstr[36];
1610
1611   if (sizeof (struct WlanAddress) != addrlen)
1612   {
1613     GNUNET_break (0);
1614     return NULL;
1615   }
1616   mac = &((struct WlanAddress *) addr)->mac;
1617   GNUNET_snprintf (macstr, sizeof (macstr), "%s.%u.%s",
1618                 PLUGIN_NAME, ntohl (((struct WlanAddress *) addr)->options),
1619                 mac_to_string (mac));
1620   return macstr;
1621 }
1622
1623
1624 /**
1625  * Convert the transports address to a nice, human-readable format.
1626  *
1627  * @param cls closure
1628  * @param type name of the transport that generated the address
1629  * @param addr one of the addresses of the host, NULL for the last address
1630  *        the specific address format depends on the transport
1631  * @param addrlen length of the address
1632  * @param numeric should (IP) addresses be displayed in numeric form?
1633  * @param timeout after how long should we give up?
1634  * @param asc function to call on each string
1635  * @param asc_cls closure for asc
1636  */
1637 static void
1638 bluetooth_plugin_address_pretty_printer (void *cls, const char *type,
1639                                     const void *addr, size_t addrlen,
1640                                     int numeric,
1641                                     struct GNUNET_TIME_Relative timeout,
1642                                     GNUNET_TRANSPORT_AddressStringCallback asc,
1643                                     void *asc_cls)
1644 {
1645   char *ret;
1646
1647   if (sizeof (struct WlanAddress) != addrlen)
1648   {
1649     /* invalid address  */
1650     LOG (GNUNET_ERROR_TYPE_WARNING,
1651          _("Bluetooth address with invalid size encountered\n"));
1652     asc (asc_cls, NULL);
1653     return;
1654   }
1655   ret = GNUNET_strdup (bluetooth_plugin_address_to_string(NULL, addr, addrlen));
1656   asc (asc_cls, ret);
1657   GNUNET_free (ret);
1658   asc (asc_cls, NULL);
1659 }
1660
1661
1662 /**
1663  * Exit point from the plugin.
1664  *
1665  * @param cls pointer to the api struct
1666  */
1667 void *
1668 libgnunet_plugin_transport_bluetooth_done (void *cls)
1669 {
1670         struct WlanAddress wa;
1671   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1672   struct Plugin *plugin = api->cls;
1673   struct MacEndpoint *endpoint;
1674   struct MacEndpoint *endpoint_next;
1675
1676   if (NULL == plugin)
1677   {
1678     GNUNET_free (api);
1679     return NULL;
1680   }
1681
1682   if (GNUNET_YES == plugin->have_mac)
1683   {
1684                 memset (&wa, 0, sizeof (wa));
1685                 wa.options = htonl (plugin->options);
1686                 wa.mac = plugin->mac_address;
1687       plugin->env->notify_address (plugin->env->cls, GNUNET_NO,
1688                                &wa,
1689                                sizeof (struct WlanAddress),
1690                                "bluetooth");
1691       plugin->have_mac = GNUNET_NO;
1692   }
1693
1694   if (GNUNET_SCHEDULER_NO_TASK != plugin->beacon_task)
1695   {
1696     GNUNET_SCHEDULER_cancel (plugin->beacon_task);
1697     plugin->beacon_task = GNUNET_SCHEDULER_NO_TASK;
1698   }
1699   if (NULL != plugin->suid_helper)
1700   {
1701     GNUNET_HELPER_stop (plugin->suid_helper, GNUNET_NO);
1702     plugin->suid_helper = NULL;
1703   }
1704   endpoint_next = plugin->mac_head;
1705   while (NULL != (endpoint = endpoint_next))
1706   {
1707     endpoint_next = endpoint->next;
1708     free_macendpoint (endpoint);
1709   }
1710   if (NULL != plugin->fragment_data_tokenizer)
1711   {
1712     GNUNET_SERVER_mst_destroy (plugin->fragment_data_tokenizer);
1713     plugin->fragment_data_tokenizer = NULL;
1714   }
1715   if (NULL != plugin->wlan_header_payload_tokenizer)
1716   {
1717     GNUNET_SERVER_mst_destroy (plugin->wlan_header_payload_tokenizer);
1718     plugin->wlan_header_payload_tokenizer = NULL;
1719   }
1720   if (NULL != plugin->helper_payload_tokenizer)
1721   {
1722     GNUNET_SERVER_mst_destroy (plugin->helper_payload_tokenizer);
1723     plugin->helper_payload_tokenizer = NULL;
1724   }
1725   GNUNET_free_non_null (plugin->interface);
1726   GNUNET_free (plugin);
1727   GNUNET_free (api);
1728   return NULL;
1729 }
1730
1731
1732 /**
1733  * Function called to convert a string address to
1734  * a binary address.
1735  *
1736  * @param cls closure ('struct Plugin*')
1737  * @param addr string address
1738  * @param addrlen length of the address
1739  * @param buf location to store the buffer
1740  * @param added location to store the number of bytes in the buffer.
1741  *        If the function returns GNUNET_SYSERR, its contents are undefined.
1742  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
1743  */
1744 static int
1745 bluetooth_string_to_address (void *cls, const char *addr, uint16_t addrlen,
1746                         void **buf, size_t *added)
1747 {
1748   struct WlanAddress *wa;
1749   unsigned int a[6];
1750   unsigned int i;
1751   char plugin[10];
1752   uint32_t options;
1753
1754   if ((NULL == addr) || (addrlen == 0))
1755   {
1756     GNUNET_break (0);
1757     return GNUNET_SYSERR;
1758   }
1759   if ('\0' != addr[addrlen - 1])
1760   {
1761     GNUNET_break (0);
1762     return GNUNET_SYSERR;
1763   }
1764   if (strlen (addr) != addrlen - 1)
1765   {
1766     GNUNET_break (0);
1767     return GNUNET_SYSERR;
1768   }
1769
1770   if (8 != SSCANF (addr,
1771                    "%9s.%u.%X:%X:%X:%X:%X:%X",
1772                    plugin, &options,
1773                    &a[0], &a[1], &a[2], &a[3], &a[4], &a[5]))
1774   {
1775     GNUNET_break (0);
1776     return GNUNET_SYSERR;
1777   }
1778   wa = GNUNET_malloc (sizeof (struct WlanAddress));
1779   for (i=0;i<6;i++)
1780     wa->mac.mac[i] = a[i];
1781   wa->options = htonl (0);
1782   *buf = wa;
1783   *added = sizeof (struct WlanAddress);
1784   return GNUNET_OK;
1785 }
1786
1787
1788 /**
1789  * Entry point for the plugin.
1790  *
1791  * @param cls closure, the 'struct GNUNET_TRANSPORT_PluginEnvironment*'
1792  * @return the 'struct GNUNET_TRANSPORT_PluginFunctions*' or NULL on error
1793  */
1794 void *
1795 libgnunet_plugin_transport_bluetooth_init (void *cls)
1796 {
1797   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1798   struct GNUNET_TRANSPORT_PluginFunctions *api;
1799   struct Plugin *plugin;
1800   char *interface;
1801   unsigned long long testmode;
1802   char *binary;
1803
1804   /* check for 'special' mode */
1805   if (NULL == env->receive)
1806   {
1807     /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
1808        initialze the plugin or the API */
1809     api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1810     api->cls = NULL;
1811     api->address_pretty_printer = &bluetooth_plugin_address_pretty_printer;
1812     api->address_to_string = &bluetooth_plugin_address_to_string;
1813     api->string_to_address = &bluetooth_string_to_address;
1814     return api;
1815   }
1816
1817   testmode = 0;
1818   /* check configuration */
1819   if ( (GNUNET_YES ==
1820         GNUNET_CONFIGURATION_have_value (env->cfg, "transport-bluetooth", "TESTMODE")) &&
1821        ( (GNUNET_SYSERR ==
1822           GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-bluetooth",
1823                                                  "TESTMODE", &testmode)) ||
1824          (testmode > 2) ) )
1825   {
1826     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
1827                                "transport-bluetooth", "TESTMODE");
1828     return NULL;
1829   }
1830   binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-transport-bluetooth");
1831   if ( (0 == testmode) &&
1832        (GNUNET_YES != GNUNET_OS_check_helper_binary (binary, GNUNET_YES, NULL)) )
1833   {
1834     LOG (GNUNET_ERROR_TYPE_ERROR,
1835          _("Helper binary `%s' not SUID, cannot run bluetooth transport\n"),
1836          "gnunet-helper-transport-bluetooth");
1837     GNUNET_free (binary);
1838     return NULL;
1839   }
1840     GNUNET_free (binary);
1841   if (GNUNET_YES !=
1842       GNUNET_CONFIGURATION_get_value_string
1843       (env->cfg, "transport-bluetooth", "INTERFACE",
1844        &interface))
1845   {
1846     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
1847                                "transport-bluetooth", "INTERFACE");
1848     return NULL;
1849   }
1850
1851   plugin = GNUNET_malloc (sizeof (struct Plugin));
1852   plugin->interface = interface;
1853   plugin->env = env;
1854   GNUNET_STATISTICS_set (plugin->env->stats, _("# Bluetooth sessions allocated"),
1855                          0, GNUNET_NO);
1856   GNUNET_STATISTICS_set (plugin->env->stats, _("# Bluetooth MAC endpoints allocated"),
1857                          0, 0);
1858   GNUNET_BANDWIDTH_tracker_init (&plugin->tracker,
1859                                  GNUNET_BANDWIDTH_value_init (100 * 1024 *
1860                                                               1024 / 8), 100);
1861   plugin->fragment_data_tokenizer = GNUNET_SERVER_mst_create (&process_data, plugin);
1862   plugin->wlan_header_payload_tokenizer = GNUNET_SERVER_mst_create (&process_data, plugin);
1863   plugin->helper_payload_tokenizer = GNUNET_SERVER_mst_create (&process_data, plugin);
1864   plugin->beacon_task = GNUNET_SCHEDULER_add_now (&send_hello_beacon,
1865                                                   plugin);
1866
1867   plugin->options = 0;
1868
1869   /* some compilers do not like switch on 'long long'... */
1870   switch ((unsigned int) testmode)
1871   {
1872   case 0: /* normal */
1873     plugin->helper_argv[0] = (char *) "gnunet-helper-transport-bluetooth";
1874     plugin->helper_argv[1] = interface;
1875     plugin->helper_argv[2] = NULL;
1876     plugin->suid_helper = GNUNET_HELPER_start (GNUNET_NO,
1877                                                "gnunet-helper-transport-bluetooth",
1878                                                plugin->helper_argv,
1879                                                &handle_helper_message,
1880                                                NULL,
1881                                                plugin);
1882     break;
1883   case 1: /* testmode, peer 1 */
1884     plugin->helper_argv[0] = (char *) "gnunet-helper-transport-wlan-dummy";
1885     plugin->helper_argv[1] = (char *) "1";
1886     plugin->helper_argv[2] = NULL;
1887     plugin->suid_helper = GNUNET_HELPER_start (GNUNET_NO,
1888                  "gnunet-helper-transport-wlan-dummy",
1889                  plugin->helper_argv,
1890                  &handle_helper_message,
1891                  NULL,
1892                  plugin);
1893     break;
1894   case 2: /* testmode, peer 2 */
1895     plugin->helper_argv[0] = (char *) "gnunet-helper-transport-wlan-dummy";
1896     plugin->helper_argv[1] = (char *) "2";
1897     plugin->helper_argv[2] = NULL;
1898     plugin->suid_helper = GNUNET_HELPER_start (GNUNET_NO,
1899                  "gnunet-helper-transport-wlan-dummy",
1900                  plugin->helper_argv,
1901                  &handle_helper_message,
1902                  NULL,
1903                  plugin);
1904     break;
1905   default:
1906     GNUNET_assert (0);
1907   }
1908
1909   api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1910   api->cls = plugin;
1911   api->send = &bluetooth_plugin_send;
1912   api->get_session = &bluetooth_plugin_get_session;
1913   api->disconnect_peer = &bluetooth_plugin_disconnect_peer;
1914   api->disconnect_session = &bluetooth_plugin_disconnect_session;
1915   api->address_pretty_printer = &bluetooth_plugin_address_pretty_printer;
1916   api->check_address = &bluetooth_plugin_address_suggested;
1917   api->address_to_string = &bluetooth_plugin_address_to_string;;
1918   api->string_to_address = &bluetooth_string_to_address;
1919   api->get_network = &bluetooth_get_network;
1920
1921   return api;
1922 }
1923
1924
1925 /* end of plugin_transport_bluetooth.c */