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