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