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