2 This file is part of GNUnet
3 Copyright (C) 2010-2014 GNUnet e.V.
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.
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.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file transport/plugin_transport_wlan.c
23 * @brief transport plugin for wlan and/or bluetooth
24 * @author David Brodski
25 * @author Christian Grothoff
27 * BUILD_WLAN or BUILD_BLUETOOTH must be defined such that the respective
28 * variant of this code is compiled.
31 #include "gnunet_util_lib.h"
32 #include "gnunet_hello_lib.h"
33 #include "gnunet_protocols.h"
34 #include "gnunet_statistics_service.h"
35 #include "gnunet_transport_service.h"
36 #include "gnunet_transport_plugin.h"
37 #include "plugin_transport_wlan.h"
38 #include "gnunet_fragmentation_lib.h"
39 #include "gnunet_constants.h"
43 #define PLUGIN_NAME "wlan"
44 #define CONFIG_NAME "transport-wlan"
45 #define HELPER_NAME "gnunet-helper-transport-wlan"
46 #define DUMMY_HELPER_NAME "gnunet-helper-transport-wlan-dummy"
47 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_wlan_init
48 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_wlan_done
49 #define LOG(kind,...) GNUNET_log_from (kind, "transport-wlan",__VA_ARGS__)
52 * time out of a mac endpoint
54 #define MACENDPOINT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT, 2)
57 * We reduce the frequence of HELLO beacons in relation to
58 * the number of MAC addresses currently visible to us.
59 * This is the multiplication factor.
61 #define HELLO_BEACON_SCALING_FACTOR GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 2)
66 /* begin case bluetooth */
68 #define PLUGIN_NAME "bluetooth"
69 #define CONFIG_NAME "transport-bluetooth"
70 #define HELPER_NAME "gnunet-helper-transport-bluetooth"
71 /* yes, this is correct, we use the same dummy driver as 'wlan' */
72 #define DUMMY_HELPER_NAME "gnunet-helper-transport-wlan-dummy"
73 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_bluetooth_init
74 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_bluetooth_done
75 #define LOG(kind,...) GNUNET_log_from (kind, "transport-bluetooth",__VA_ARGS__)
78 * time out of a mac endpoint
80 #define MACENDPOINT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT, 60)
84 * We reduce the frequence of HELLO beacons in relation to
85 * the number of MAC addresses currently visible to us.
86 * This is the multiplication factor.
88 #define HELLO_BEACON_SCALING_FACTOR GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
90 /* end case bluetooth */
92 #error need to build wlan or bluetooth
96 * Max size of packet (that we give to the WLAN driver for transmission)
102 * Which network scope do we belong to?
105 static const enum GNUNET_ATS_Network_Type scope = GNUNET_ATS_NET_WLAN;
107 static const enum GNUNET_ATS_Network_Type scope = GNUNET_ATS_NET_BT;
112 * Maximum number of messages in defragmentation queue per MAC
114 #define MESSAGES_IN_DEFRAG_QUEUE_PER_MAC 2
117 * Link layer control fields for better compatibility
118 * (i.e. GNUnet over WLAN is not IP-over-WLAN).
120 #define WLAN_LLC_DSAP_FIELD 0x1f
121 #define WLAN_LLC_SSAP_FIELD 0x1f
124 GNUNET_NETWORK_STRUCT_BEGIN
126 * Header for messages which need fragmentation. This is the format of
127 * a message we obtain AFTER defragmentation. We then need to check
128 * the CRC and then tokenize the payload and pass it to the
129 * 'receive' callback.
135 * Message type is #GNUNET_MESSAGE_TYPE_WLAN_DATA.
137 struct GNUNET_MessageHeader header;
140 * CRC32 checksum (only over the payload), in NBO.
142 uint32_t crc GNUNET_PACKED;
145 * Sender of the message.
147 struct GNUNET_PeerIdentity sender;
150 * Target of the message.
152 struct GNUNET_PeerIdentity target;
154 /* followed by payload, possibly including
155 multiple messages! */
161 * Address format for WLAN.
166 * Options set for the WLAN, in NBO.
168 uint32_t options GNUNET_PACKED;
171 * WLAN addresses using MACs.
173 struct GNUNET_TRANSPORT_WLAN_MacAddress mac;
177 GNUNET_NETWORK_STRUCT_END
181 * Information kept for each message that is yet to be fragmented and
184 struct PendingMessage
187 * next entry in the DLL
189 struct PendingMessage *next;
192 * previous entry in the DLL
194 struct PendingMessage *prev;
197 * The pending message
199 struct WlanHeader *msg;
202 * Continuation function to call once the message
203 * has been sent. Can be NULL if there is no
204 * continuation to call.
206 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
209 * Cls for @e transmit_cont
211 void *transmit_cont_cls;
214 * Timeout task (for this message).
216 struct GNUNET_SCHEDULER_Task * timeout_task;
222 * Session handle for connections with other peers.
224 struct GNUNET_ATS_Session
227 * To whom are we talking to (set to our identity
228 * if we are still waiting for the welcome message)
230 struct GNUNET_PeerIdentity target;
233 * We keep all sessions in a DLL at their respective
234 * `struct MACEndpoint *`.
236 struct GNUNET_ATS_Session *next;
239 * We keep all sessions in a DLL at their respective
240 * `struct MACEndpoint *`.
242 struct GNUNET_ATS_Session *prev;
245 * MAC endpoint with the address of this peer.
247 struct MacEndpoint *mac;
250 * Address associated with this session and MAC endpoint
252 struct GNUNET_HELLO_Address *address;
255 * When should this session time out?
257 struct GNUNET_TIME_Absolute timeout;
260 * Timeout task (for the session).
262 struct GNUNET_SCHEDULER_Task * timeout_task;
268 * Struct for messages that are being fragmented in a MAC's transmission queue.
270 struct FragmentMessage
274 * This is a doubly-linked list.
276 struct FragmentMessage *next;
279 * This is a doubly-linked list.
281 struct FragmentMessage *prev;
284 * MAC endpoint this message belongs to
286 struct MacEndpoint *macendpoint;
289 * Fragmentation context
291 struct GNUNET_FRAGMENT_Context *fragcontext;
294 * Transmission handle to helper (to cancel if the frag context
295 * is destroyed early for some reason).
297 struct GNUNET_HELPER_SendHandle *sh;
300 * Intended recipient.
302 struct GNUNET_PeerIdentity target;
305 * Timeout value for the message.
307 struct GNUNET_TIME_Absolute timeout;
312 struct GNUNET_SCHEDULER_Task * timeout_task;
315 * Continuation to call when we're done with this message.
317 GNUNET_TRANSPORT_TransmitContinuation cont;
320 * Message we need to fragment and transmit, NULL after the
321 * @e fragmentcontext has been created.
323 struct GNUNET_MessageHeader *msg;
326 * Closure for @e cont
331 * Size of original message
336 * Number of bytes used to transmit message
344 * Struct to represent one network card connection
350 * We keep all MACs in a DLL in the plugin.
352 struct MacEndpoint *next;
355 * We keep all MACs in a DLL in the plugin.
357 struct MacEndpoint *prev;
360 * Pointer to the global plugin struct.
362 struct Plugin *plugin;
365 * Head of sessions that use this MAC.
367 struct GNUNET_ATS_Session *sessions_head;
370 * Tail of sessions that use this MAC.
372 struct GNUNET_ATS_Session *sessions_tail;
375 * Head of messages we are currently sending to this MAC.
377 struct FragmentMessage *sending_messages_head;
380 * Tail of messages we are currently sending to this MAC.
382 struct FragmentMessage *sending_messages_tail;
385 * Defrag context for this MAC
387 struct GNUNET_DEFRAGMENT_Context *defrag;
390 * When should this endpoint time out?
392 struct GNUNET_TIME_Absolute timeout;
397 struct GNUNET_SCHEDULER_Task * timeout_task;
400 * count of messages in the fragment out queue for this mac endpoint
402 unsigned int fragment_messages_out_count;
407 struct WlanAddress wlan_addr;
410 * Message delay for fragmentation context
412 struct GNUNET_TIME_Relative msg_delay;
415 * ACK delay for fragmentation context
417 struct GNUNET_TIME_Relative ack_delay;
420 * Desired transmission power for this MAC
425 * Desired transmission rate for this MAC
430 * Antenna we should use for this MAC
438 * Encapsulation of all of the state of the plugin.
445 struct GNUNET_TRANSPORT_PluginEnvironment *env;
448 * Handle to helper process for priviledged operations.
450 struct GNUNET_HELPER_Handle *suid_helper;
453 * Function to call about session status changes.
455 GNUNET_TRANSPORT_SessionInfoCallback sic;
458 * Closure for @e sic.
463 * ARGV-vector for the helper (all helpers take only the binary
464 * name, one actual argument, plus the NULL terminator for 'argv').
466 char *helper_argv[3];
469 * The interface of the wlan card given to us by the user.
471 char *wlan_interface;
474 * Tokenizer for demultiplexing of data packets resulting from
477 struct GNUNET_SERVER_MessageStreamTokenizer *fragment_data_tokenizer;
480 * Tokenizer for demultiplexing of data packets received from the suid helper
482 struct GNUNET_SERVER_MessageStreamTokenizer *helper_payload_tokenizer;
485 * Tokenizer for demultiplexing of data packets that follow the WLAN Header
487 struct GNUNET_SERVER_MessageStreamTokenizer *wlan_header_payload_tokenizer;
490 * Head of list of open connections.
492 struct MacEndpoint *mac_head;
495 * Tail of list of open connections.
497 struct MacEndpoint *mac_tail;
500 * Task that periodically sends a HELLO beacon via the helper.
502 struct GNUNET_SCHEDULER_Task *beacon_task;
505 * Tracker for bandwidth limit
507 struct GNUNET_BANDWIDTH_Tracker tracker;
510 * The mac_address of the wlan card given to us by the helper.
512 struct GNUNET_TRANSPORT_WLAN_MacAddress mac_address;
515 * Have we received a control message with our MAC address yet?
520 * Number of connections
522 unsigned int mac_count;
525 * Options for addresses
533 * Information associated with a message. Can contain
534 * the session or the MAC endpoint associated with the
540 * NULL if the identity of the other peer is not known.
542 struct GNUNET_ATS_Session *session;
545 * MAC address of the other peer, NULL if not known.
547 struct MacEndpoint *endpoint;
552 * Print MAC addresses nicely.
554 * @param mac the mac address
555 * @return string to a static buffer with
556 * the human-readable mac, will be overwritten during the next call to
560 mac_to_string (const struct GNUNET_TRANSPORT_WLAN_MacAddress * mac)
562 static char macstr[20];
564 GNUNET_snprintf (macstr,
566 "%.2X:%.2X:%.2X:%.2X:%.2X:%.2X",
567 mac->mac[0], mac->mac[1],
568 mac->mac[2], mac->mac[3],
569 mac->mac[4], mac->mac[5]);
575 * Function called for a quick conversion of the binary address to
576 * a numeric address. Note that the caller must not free the
577 * address and that the next call to this function is allowed
578 * to override the address again.
581 * @param addr binary address
582 * @param addrlen length of the address
583 * @return string representing the same address
586 wlan_plugin_address_to_string (void *cls,
590 const struct GNUNET_TRANSPORT_WLAN_MacAddress *mac;
591 static char macstr[36];
593 if (sizeof (struct WlanAddress) != addrlen)
598 mac = &((struct WlanAddress *) addr)->mac;
599 GNUNET_snprintf (macstr,
603 ntohl (((struct WlanAddress *) addr)->options),
604 mac_to_string (mac));
610 * If a session monitor is attached, notify it about the new
613 * @param plugin our plugin
614 * @param session session that changed state
615 * @param state new state of the session
618 notify_session_monitor (struct Plugin *plugin,
619 struct GNUNET_ATS_Session *session,
620 enum GNUNET_TRANSPORT_SessionState state)
622 struct GNUNET_TRANSPORT_SessionInfo info;
624 if (NULL == plugin->sic)
626 memset (&info, 0, sizeof (info));
628 info.is_inbound = GNUNET_SYSERR; /* hard to say */
629 info.num_msg_pending = 0; /* we queue per MAC, not per peer */
630 info.num_bytes_pending = 0; /* we queue per MAC, not per peer */
631 info.receive_delay = GNUNET_TIME_UNIT_ZERO_ABS; /* not supported by WLAN */
632 info.session_timeout = session->timeout;
633 info.address = session->address;
634 plugin->sic (plugin->sic_cls,
641 * Fill the radiotap header
643 * @param endpoint pointer to the endpoint, can be NULL
644 * @param header pointer to the radiotap header
645 * @param size total message size
648 get_radiotap_header (struct MacEndpoint *endpoint,
649 struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage *header,
652 header->header.type = ntohs (GNUNET_MESSAGE_TYPE_WLAN_DATA_TO_HELPER);
653 header->header.size = ntohs (size);
654 if (NULL != endpoint)
656 header->rate = endpoint->rate;
657 header->tx_power = endpoint->tx_power;
658 header->antenna = endpoint->antenna;
663 header->tx_power = 0;
670 * Generate the WLAN hardware header for one packet
672 * @param plugin the plugin handle
673 * @param header address to write the header to
674 * @param to_mac_addr address of the recipient
675 * @param size size of the whole packet, needed to calculate the time to send the packet
678 get_wlan_header (struct Plugin *plugin,
679 struct GNUNET_TRANSPORT_WLAN_Ieee80211Frame *header,
680 const struct GNUNET_TRANSPORT_WLAN_MacAddress *to_mac_addr,
683 const int rate = 11000000;
685 header->frame_control = htons (IEEE80211_FC0_TYPE_DATA);
686 header->addr1 = *to_mac_addr;
687 header->addr2 = plugin->mac_address;
688 header->addr3 = mac_bssid_gnunet;
689 header->duration = GNUNET_htole16 ((size * 1000000) / rate + 290);
690 header->sequence_control = 0; // FIXME?
691 header->llc[0] = WLAN_LLC_DSAP_FIELD;
692 header->llc[1] = WLAN_LLC_SSAP_FIELD;
693 header->llc[2] = 0; // FIXME?
694 header->llc[3] = 0; // FIXME?
699 * Send an ACK for a fragment we received.
701 * @param cls the `struct MacEndpoint *` the ACK must be sent to
702 * @param msg_id id of the message
703 * @param hdr pointer to the hdr where the ack is stored
708 const struct GNUNET_MessageHeader *hdr)
710 struct MacEndpoint *endpoint = cls;
711 struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage* radio_header;
712 uint16_t msize = ntohs (hdr->size);
713 size_t size = sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage) + msize;
716 if (NULL == endpoint)
721 if (size >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
726 LOG (GNUNET_ERROR_TYPE_DEBUG,
727 "Sending ACK to %s\n",
728 mac_to_string (&endpoint->wlan_addr.mac));
729 radio_header = (struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage *) buf;
730 get_radiotap_header (endpoint, radio_header, size);
731 get_wlan_header (endpoint->plugin,
732 &radio_header->frame,
733 &endpoint->wlan_addr.mac,
734 sizeof (endpoint->wlan_addr.mac));
735 memcpy (&radio_header[1], hdr, msize);
737 GNUNET_HELPER_send (endpoint->plugin->suid_helper,
738 &radio_header->header,
739 GNUNET_NO /* dropping ACKs is bad */,
741 GNUNET_STATISTICS_update (endpoint->plugin->env->stats,
748 * Handles the data after all fragments are put together
750 * @param cls macendpoint this messages belongs to
751 * @param hdr pointer to the data
754 wlan_data_message_handler (void *cls,
755 const struct GNUNET_MessageHeader *hdr)
757 struct MacEndpoint *endpoint = cls;
758 struct Plugin *plugin = endpoint->plugin;
759 struct MacAndSession mas;
761 GNUNET_STATISTICS_update (plugin->env->stats,
762 _("# Messages defragmented"),
766 mas.endpoint = endpoint;
767 (void) GNUNET_SERVER_mst_receive (plugin->fragment_data_tokenizer,
771 GNUNET_YES, GNUNET_NO);
778 * @param cls our `struct Plugin`.
779 * @param session the session free
782 wlan_plugin_disconnect_session (void *cls,
783 struct GNUNET_ATS_Session *session)
785 struct MacEndpoint *endpoint = session->mac;
786 struct Plugin *plugin = endpoint->plugin;
788 plugin->env->session_end (plugin->env->cls,
791 notify_session_monitor (plugin,
793 GNUNET_TRANSPORT_SS_DONE);
794 GNUNET_CONTAINER_DLL_remove (endpoint->sessions_head,
795 endpoint->sessions_tail,
797 if (session->timeout_task != NULL)
799 GNUNET_SCHEDULER_cancel (session->timeout_task);
800 session->timeout_task = NULL;
802 GNUNET_STATISTICS_update (plugin->env->stats,
803 _("# Sessions allocated"),
806 GNUNET_HELLO_address_free (session->address);
807 GNUNET_free (session);
813 * Function that is called to get the keepalive factor.
814 * #GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
815 * calculate the interval between keepalive packets.
817 * @param cls closure with the `struct Plugin`
818 * @return keepalive factor
821 wlan_plugin_query_keepalive_factor (void *cls)
828 * A session is timing out. Clean up.
830 * @param cls pointer to the Session
833 session_timeout (void *cls)
835 struct GNUNET_ATS_Session *session = cls;
836 struct GNUNET_TIME_Relative left;
838 session->timeout_task = NULL;
839 left = GNUNET_TIME_absolute_get_remaining (session->timeout);
840 if (0 != left.rel_value_us)
842 session->timeout_task =
843 GNUNET_SCHEDULER_add_delayed (left,
848 wlan_plugin_disconnect_session (session->mac->plugin,
855 * Lookup a new session
857 * @param endpoint pointer to the mac endpoint of the peer
858 * @param peer peer identity to use for this session
859 * @return returns the session or NULL
861 static struct GNUNET_ATS_Session *
862 lookup_session (struct MacEndpoint *endpoint,
863 const struct GNUNET_PeerIdentity *peer)
865 struct GNUNET_ATS_Session *session;
867 for (session = endpoint->sessions_head; NULL != session; session = session->next)
868 if (0 == memcmp (peer, &session->target, sizeof (struct GNUNET_PeerIdentity)))
875 * Create a new session
877 * @param endpoint pointer to the mac endpoint of the peer
878 * @param peer peer identity to use for this session
879 * @return returns the session or NULL
881 static struct GNUNET_ATS_Session *
882 create_session (struct MacEndpoint *endpoint,
883 const struct GNUNET_PeerIdentity *peer)
885 struct GNUNET_ATS_Session *session;
887 GNUNET_STATISTICS_update (endpoint->plugin->env->stats,
888 _("# Sessions allocated"),
891 session = GNUNET_new (struct GNUNET_ATS_Session);
892 GNUNET_CONTAINER_DLL_insert_tail (endpoint->sessions_head,
893 endpoint->sessions_tail,
895 session->address = GNUNET_HELLO_address_allocate (peer,
897 &endpoint->wlan_addr,
898 sizeof (endpoint->wlan_addr),
899 GNUNET_HELLO_ADDRESS_INFO_NONE);
900 session->mac = endpoint;
901 session->target = *peer;
902 session->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
903 session->timeout_task =
904 GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT, &session_timeout,
906 notify_session_monitor (endpoint->plugin,
908 GNUNET_TRANSPORT_SS_INIT);
909 notify_session_monitor (endpoint->plugin,
911 GNUNET_TRANSPORT_SS_UP);
912 LOG (GNUNET_ERROR_TYPE_DEBUG,
913 "Created new session %p for peer `%s' with endpoint %s\n",
916 mac_to_string (&endpoint->wlan_addr.mac));
923 * Look up a session for a peer and create a new session if none is found
925 * @param endpoint pointer to the mac endpoint of the peer
926 * @param peer peer identity to use for this session
927 * @return returns the session
929 static struct GNUNET_ATS_Session *
930 get_session (struct MacEndpoint *endpoint,
931 const struct GNUNET_PeerIdentity *peer)
933 struct GNUNET_ATS_Session *session;
935 if (NULL != (session = lookup_session (endpoint, peer)))
937 return create_session (endpoint, peer);
942 * Function called once we have successfully given the fragment
943 * message to the SUID helper process and we are thus ready for
946 * @param cls the `struct FragmentMessage *`
947 * @param result result of the operation (#GNUNET_OK on success,
948 * #GNUNET_NO if the helper died, #GNUNET_SYSERR
949 * if the helper was stopped)
952 fragment_transmission_done (void *cls,
955 struct FragmentMessage *fm = cls;
958 GNUNET_FRAGMENT_context_transmission_done (fm->fragcontext);
963 * Transmit a fragment of a message.
965 * @param cls `struct FragmentMessage *` this fragment message belongs to
966 * @param hdr pointer to the start of the fragment message
969 transmit_fragment (void *cls,
970 const struct GNUNET_MessageHeader *hdr)
972 struct FragmentMessage *fm = cls;
973 struct MacEndpoint *endpoint = fm->macendpoint;
977 if (NULL == endpoint)
982 msize = ntohs (hdr->size);
983 size = sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage) + msize;
986 struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage *radio_header;
988 radio_header = (struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage *) buf;
989 get_radiotap_header (endpoint, radio_header, size);
990 LOG (GNUNET_ERROR_TYPE_DEBUG,
991 "Sending %u bytes of data to MAC `%s'\n",
992 (unsigned int) msize,
993 mac_to_string (&endpoint->wlan_addr.mac));
995 get_wlan_header (endpoint->plugin,
996 &radio_header->frame,
997 &endpoint->wlan_addr.mac,
998 sizeof (endpoint->wlan_addr.mac));
999 memcpy (&radio_header[1], hdr, msize);
1000 GNUNET_assert (NULL == fm->sh);
1001 fm->sh = GNUNET_HELPER_send (endpoint->plugin->suid_helper,
1002 &radio_header->header,
1004 &fragment_transmission_done, fm);
1005 fm->size_on_wire += size;
1008 GNUNET_STATISTICS_update (endpoint->plugin->env->stats,
1009 _("# message fragments sent"),
1015 GNUNET_FRAGMENT_context_transmission_done (fm->fragcontext);
1017 GNUNET_STATISTICS_update (endpoint->plugin->env->stats,
1018 "# bytes currently in buffers",
1020 GNUNET_STATISTICS_update (endpoint->plugin->env->stats,
1021 "# bytes transmitted",
1028 * Frees the space of a message in the fragment queue (send queue)
1030 * @param fm message to free
1033 free_fragment_message (struct FragmentMessage *fm)
1035 struct MacEndpoint *endpoint = fm->macendpoint;
1037 GNUNET_STATISTICS_update (endpoint->plugin->env->stats,
1038 _("# messages pending (with fragmentation)"),
1040 GNUNET_CONTAINER_DLL_remove (endpoint->sending_messages_head,
1041 endpoint->sending_messages_tail,
1045 GNUNET_HELPER_send_cancel (fm->sh);
1048 if (NULL != fm->msg)
1050 GNUNET_free (fm->msg);
1053 if (NULL != fm->fragcontext)
1055 GNUNET_FRAGMENT_context_destroy (fm->fragcontext,
1056 &endpoint->msg_delay,
1057 &endpoint->ack_delay);
1058 fm->fragcontext = NULL;
1060 if (NULL != fm->timeout_task)
1062 GNUNET_SCHEDULER_cancel (fm->timeout_task);
1063 fm->timeout_task = NULL;
1070 * A FragmentMessage has timed out. Remove it.
1072 * @param cls pointer to the 'struct FragmentMessage'
1075 fragmentmessage_timeout (void *cls)
1077 struct FragmentMessage *fm = cls;
1079 fm->timeout_task = NULL;
1080 if (NULL != fm->cont)
1082 fm->cont (fm->cont_cls,
1089 free_fragment_message (fm);
1094 * Transmit a message to the given destination with fragmentation.
1096 * @param endpoint desired destination
1097 * @param timeout how long can the message wait?
1098 * @param target peer that should receive the message
1099 * @param msg message to transmit
1100 * @param payload_size bytes of payload
1101 * @param cont continuation to call once the message has
1102 * been transmitted (or if the transport is ready
1103 * for the next transmission call; or if the
1104 * peer disconnected...); can be NULL
1105 * @param cont_cls closure for @a cont
1108 send_with_fragmentation (struct MacEndpoint *endpoint,
1109 struct GNUNET_TIME_Relative timeout,
1110 const struct GNUNET_PeerIdentity *target,
1111 const struct GNUNET_MessageHeader *msg,
1112 size_t payload_size,
1113 GNUNET_TRANSPORT_TransmitContinuation cont,
1117 struct FragmentMessage *fm;
1118 struct Plugin *plugin;
1120 plugin = endpoint->plugin;
1121 fm = GNUNET_new (struct FragmentMessage);
1122 fm->macendpoint = endpoint;
1123 fm->target = *target;
1124 fm->size_payload = payload_size;
1125 fm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1127 fm->cont_cls = cont_cls;
1128 /* 1 MBit/s typical data rate, 1430 byte fragments => ~100 ms per message */
1130 GNUNET_SCHEDULER_add_delayed (timeout,
1131 &fragmentmessage_timeout,
1133 if (GNUNET_YES == plugin->have_mac)
1136 GNUNET_FRAGMENT_context_create (plugin->env->stats,
1139 fm->macendpoint->msg_delay,
1140 fm->macendpoint->ack_delay,
1142 &transmit_fragment, fm);
1146 fm->msg = GNUNET_copy_message (msg);
1148 GNUNET_CONTAINER_DLL_insert_tail (endpoint->sending_messages_head,
1149 endpoint->sending_messages_tail,
1155 * Free a MAC endpoint.
1157 * @param endpoint pointer to the MacEndpoint to free
1160 free_macendpoint (struct MacEndpoint *endpoint)
1162 struct Plugin *plugin = endpoint->plugin;
1163 struct FragmentMessage *fm;
1164 struct GNUNET_ATS_Session *session;
1166 GNUNET_STATISTICS_update (plugin->env->stats,
1167 _("# MAC endpoints allocated"),
1170 while (NULL != (session = endpoint->sessions_head))
1171 wlan_plugin_disconnect_session (plugin,
1173 while (NULL != (fm = endpoint->sending_messages_head))
1174 free_fragment_message (fm);
1175 GNUNET_CONTAINER_DLL_remove (plugin->mac_head,
1179 if (NULL != endpoint->defrag)
1181 GNUNET_DEFRAGMENT_context_destroy(endpoint->defrag);
1182 endpoint->defrag = NULL;
1185 plugin->mac_count--;
1186 if (NULL != endpoint->timeout_task)
1188 GNUNET_SCHEDULER_cancel (endpoint->timeout_task);
1189 endpoint->timeout_task = NULL;
1191 GNUNET_free (endpoint);
1196 * A MAC endpoint is timing out. Clean up.
1198 * @param cls pointer to the `struct MacEndpoint *`
1201 macendpoint_timeout (void *cls)
1203 struct MacEndpoint *endpoint = cls;
1204 struct GNUNET_TIME_Relative timeout;
1206 endpoint->timeout_task = NULL;
1207 timeout = GNUNET_TIME_absolute_get_remaining (endpoint->timeout);
1208 if (0 == timeout.rel_value_us)
1210 free_macendpoint (endpoint);
1213 endpoint->timeout_task =
1214 GNUNET_SCHEDULER_add_delayed (timeout,
1215 &macendpoint_timeout,
1221 * Find (or create) a MacEndpoint with a specific MAC address
1223 * @param plugin pointer to the plugin struct
1224 * @param mac the MAC address of the endpoint
1225 * @return handle to our data structure for this MAC
1227 static struct MacEndpoint *
1228 create_macendpoint (struct Plugin *plugin,
1229 struct WlanAddress *mac)
1231 struct MacEndpoint *pos;
1233 for (pos = plugin->mac_head; NULL != pos; pos = pos->next)
1234 if (0 == memcmp (mac, &pos->wlan_addr, sizeof (pos->wlan_addr)))
1236 pos = GNUNET_new (struct MacEndpoint);
1237 pos->wlan_addr = (*mac);
1238 pos->plugin = plugin;
1240 GNUNET_DEFRAGMENT_context_create (plugin->env->stats,
1242 MESSAGES_IN_DEFRAG_QUEUE_PER_MAC,
1244 &wlan_data_message_handler,
1247 pos->msg_delay = GNUNET_TIME_UNIT_MILLISECONDS;
1248 pos->ack_delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 100);
1249 pos->timeout = GNUNET_TIME_relative_to_absolute (MACENDPOINT_TIMEOUT);
1251 GNUNET_SCHEDULER_add_delayed (MACENDPOINT_TIMEOUT, &macendpoint_timeout,
1253 GNUNET_CONTAINER_DLL_insert (plugin->mac_head,
1256 plugin->mac_count++;
1257 GNUNET_STATISTICS_update (plugin->env->stats,
1258 _("# MAC endpoints allocated"),
1260 LOG (GNUNET_ERROR_TYPE_DEBUG,
1261 "New MAC endpoint `%s'\n",
1262 wlan_plugin_address_to_string (NULL,
1264 sizeof (struct WlanAddress)));
1270 * Function obtain the network type for a session
1272 * @param cls closure (`struct Plugin*`)
1273 * @param session the session
1274 * @return the network type in HBO or #GNUNET_SYSERR
1276 static enum GNUNET_ATS_Network_Type
1277 wlan_plugin_get_network (void *cls,
1278 struct GNUNET_ATS_Session *session)
1281 return GNUNET_ATS_NET_WLAN;
1283 return GNUNET_ATS_NET_BT;
1289 * Function obtain the network type for an address.
1291 * @param cls closure (`struct Plugin *`)
1292 * @param address the address
1293 * @return the network type
1295 static enum GNUNET_ATS_Network_Type
1296 wlan_plugin_get_network_for_address (void *cls,
1297 const struct GNUNET_HELLO_Address *address)
1300 return GNUNET_ATS_NET_WLAN;
1302 return GNUNET_ATS_NET_BT;
1308 * Creates a new outbound session the transport service will use to
1309 * send data to the peer
1311 * @param cls the `struct Plugin *`
1312 * @param address the address
1313 * @return the session or NULL of max connections exceeded
1315 static struct GNUNET_ATS_Session *
1316 wlan_plugin_get_session (void *cls,
1317 const struct GNUNET_HELLO_Address *address)
1319 struct Plugin *plugin = cls;
1320 struct MacEndpoint *endpoint;
1322 if (NULL == address)
1324 if (sizeof (struct WlanAddress) != address->address_length)
1329 LOG (GNUNET_ERROR_TYPE_DEBUG,
1330 "Service asked to create session for peer `%s' with MAC `%s'\n",
1331 GNUNET_i2s (&address->peer),
1332 wlan_plugin_address_to_string (NULL,
1334 address->address_length));
1335 endpoint = create_macendpoint (plugin,
1336 (struct WlanAddress *) address->address);
1337 return get_session (endpoint, &address->peer);
1342 * Function that can be used to force the plugin to disconnect
1343 * from the given peer and cancel all previous transmissions
1344 * (and their continuation).
1346 * @param cls closure
1347 * @param target peer from which to disconnect
1350 wlan_plugin_disconnect_peer (void *cls,
1351 const struct GNUNET_PeerIdentity *target)
1353 struct Plugin *plugin = cls;
1354 struct GNUNET_ATS_Session *session;
1355 struct MacEndpoint *endpoint;
1357 for (endpoint = plugin->mac_head; NULL != endpoint; endpoint = endpoint->next)
1358 for (session = endpoint->sessions_head; NULL != session; session = session->next)
1359 if (0 == memcmp (target, &session->target,
1360 sizeof (struct GNUNET_PeerIdentity)))
1362 wlan_plugin_disconnect_session (plugin, session);
1363 break; /* inner-loop only (in case peer has another MAC as well!) */
1369 * Function that can be used by the transport service to transmit
1370 * a message using the plugin. Note that in the case of a
1371 * peer disconnecting, the continuation MUST be called
1372 * prior to the disconnect notification itself. This function
1373 * will be called with this peer's HELLO message to initiate
1374 * a fresh connection to another peer.
1376 * @param cls closure
1377 * @param session which session must be used
1378 * @param msgbuf the message to transmit
1379 * @param msgbuf_size number of bytes in @a msgbuf
1380 * @param priority how important is the message (most plugins will
1381 * ignore message priority and just FIFO)
1382 * @param to how long to wait at most for the transmission (does not
1383 * require plugins to discard the message after the timeout,
1384 * just advisory for the desired delay; most plugins will ignore
1386 * @param cont continuation to call once the message has
1387 * been transmitted (or if the transport is ready
1388 * for the next transmission call; or if the
1389 * peer disconnected...); can be NULL
1390 * @param cont_cls closure for @a cont
1391 * @return number of bytes used (on the physical network, with overheads);
1392 * -1 on hard errors (i.e. address invalid); 0 is a legal value
1393 * and does NOT mean that the message was not transmitted (DV)
1396 wlan_plugin_send (void *cls,
1397 struct GNUNET_ATS_Session *session,
1398 const char *msgbuf, size_t msgbuf_size,
1399 unsigned int priority,
1400 struct GNUNET_TIME_Relative to,
1401 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
1403 struct Plugin *plugin = cls;
1404 struct WlanHeader *wlanheader;
1405 size_t size = msgbuf_size + sizeof (struct WlanHeader);
1406 char buf[size] GNUNET_ALIGN;
1408 LOG (GNUNET_ERROR_TYPE_DEBUG,
1409 "Transmitting %u bytes of payload to peer `%s' (starting with %u byte message of type %u)\n",
1411 GNUNET_i2s (&session->target),
1412 (unsigned int) ntohs (((struct GNUNET_MessageHeader*)msgbuf)->size),
1413 (unsigned int) ntohs (((struct GNUNET_MessageHeader*)msgbuf)->type));
1414 wlanheader = (struct WlanHeader *) buf;
1415 wlanheader->header.size = htons (msgbuf_size + sizeof (struct WlanHeader));
1416 wlanheader->header.type = htons (GNUNET_MESSAGE_TYPE_WLAN_DATA);
1417 wlanheader->sender = *plugin->env->my_identity;
1418 wlanheader->target = session->target;
1419 wlanheader->crc = htonl (GNUNET_CRYPTO_crc32_n (msgbuf, msgbuf_size));
1420 memcpy (&wlanheader[1],
1423 GNUNET_STATISTICS_update (plugin->env->stats,
1424 "# bytes currently in buffers",
1427 send_with_fragmentation (session->mac,
1430 &wlanheader->header,
1438 * We have received data from the WLAN via some session. Process depending
1439 * on the message type (HELLO, DATA, FRAGMENTATION or FRAGMENTATION-ACK).
1441 * @param cls pointer to the plugin
1442 * @param client pointer to the session this message belongs to
1443 * @param hdr start of the message
1446 process_data (void *cls,
1448 const struct GNUNET_MessageHeader *hdr)
1450 struct Plugin *plugin = cls;
1451 struct GNUNET_HELLO_Address *address;
1452 struct MacAndSession *mas = client;
1453 struct FragmentMessage *fm;
1454 struct GNUNET_PeerIdentity tmpsource;
1455 const struct WlanHeader *wlanheader;
1459 msize = ntohs (hdr->size);
1461 GNUNET_STATISTICS_update (plugin->env->stats,
1465 switch (ntohs (hdr->type))
1467 case GNUNET_MESSAGE_TYPE_HELLO:
1470 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) hdr,
1473 GNUNET_break_op (0);
1476 if (NULL == mas->endpoint)
1482 LOG (GNUNET_ERROR_TYPE_DEBUG,
1483 "Processing %u bytes of HELLO from peer `%s' at MAC %s\n",
1484 (unsigned int) msize,
1485 GNUNET_i2s (&tmpsource),
1486 wlan_plugin_address_to_string (NULL,
1487 &mas->endpoint->wlan_addr,
1488 sizeof (mas->endpoint->wlan_addr)));
1490 GNUNET_STATISTICS_update (plugin->env->stats,
1491 _("# HELLO messages received"), 1,
1493 address = GNUNET_HELLO_address_allocate (&tmpsource,
1495 &mas->endpoint->wlan_addr,
1496 sizeof (mas->endpoint->wlan_addr),
1497 GNUNET_HELLO_ADDRESS_INFO_NONE);
1498 mas->session = lookup_session (mas->endpoint,
1500 if (NULL == mas->session)
1502 mas->session = create_session (mas->endpoint,
1504 plugin->env->session_start (plugin->env->cls,
1509 plugin->env->receive (plugin->env->cls,
1513 GNUNET_HELLO_address_free (address);
1515 case GNUNET_MESSAGE_TYPE_FRAGMENT:
1516 if (NULL == mas->endpoint)
1521 LOG (GNUNET_ERROR_TYPE_DEBUG,
1522 "Processing %u bytes of FRAGMENT from MAC %s\n",
1523 (unsigned int) msize,
1524 wlan_plugin_address_to_string (NULL,
1525 &mas->endpoint->wlan_addr,
1526 sizeof (mas->endpoint->wlan_addr)));
1527 GNUNET_STATISTICS_update (plugin->env->stats,
1528 _("# fragments received"),
1531 (void) GNUNET_DEFRAGMENT_process_fragment (mas->endpoint->defrag,
1534 case GNUNET_MESSAGE_TYPE_FRAGMENT_ACK:
1535 if (NULL == mas->endpoint)
1540 GNUNET_STATISTICS_update (plugin->env->stats,
1541 _("# ACKs received"),
1543 for (fm = mas->endpoint->sending_messages_head; NULL != fm; fm = fm->next)
1545 ret = GNUNET_FRAGMENT_process_ack (fm->fragcontext, hdr);
1546 if (GNUNET_OK == ret)
1548 LOG (GNUNET_ERROR_TYPE_DEBUG,
1549 "Got last ACK, finished message transmission to `%s' (%p)\n",
1550 wlan_plugin_address_to_string (NULL,
1551 &mas->endpoint->wlan_addr,
1552 sizeof (mas->endpoint->wlan_addr)),
1554 mas->endpoint->timeout = GNUNET_TIME_relative_to_absolute (MACENDPOINT_TIMEOUT);
1555 if (NULL != fm->cont)
1557 fm->cont (fm->cont_cls,
1564 free_fragment_message (fm);
1567 if (GNUNET_NO == ret)
1569 LOG (GNUNET_ERROR_TYPE_DEBUG,
1570 "Got an ACK, message transmission to `%s' not yet finished\n",
1571 wlan_plugin_address_to_string (NULL,
1572 &mas->endpoint->wlan_addr,
1573 sizeof (mas->endpoint->wlan_addr)));
1578 LOG (GNUNET_ERROR_TYPE_DEBUG,
1579 "ACK not matched against any active fragmentation with MAC `%s'\n",
1580 wlan_plugin_address_to_string (NULL,
1581 &mas->endpoint->wlan_addr,
1582 sizeof (mas->endpoint->wlan_addr)));
1584 case GNUNET_MESSAGE_TYPE_WLAN_DATA:
1585 if (NULL == mas->endpoint)
1590 if (msize < sizeof (struct WlanHeader))
1595 wlanheader = (const struct WlanHeader *) hdr;
1596 if (0 != memcmp (&wlanheader->target,
1597 plugin->env->my_identity,
1598 sizeof (struct GNUNET_PeerIdentity)))
1600 LOG (GNUNET_ERROR_TYPE_DEBUG,
1601 "Data for `%s', not for me, ignoring\n",
1602 GNUNET_i2s (&wlanheader->target));
1605 if (ntohl (wlanheader->crc) !=
1606 GNUNET_CRYPTO_crc32_n (&wlanheader[1],
1607 msize - sizeof (struct WlanHeader)))
1609 GNUNET_STATISTICS_update (plugin->env->stats,
1610 _("# DATA messages discarded due to CRC32 error"),
1615 mas->session = lookup_session (mas->endpoint,
1616 &wlanheader->sender);
1617 if (NULL == mas->session)
1619 mas->session = create_session (mas->endpoint,
1620 &wlanheader->sender);
1621 address = GNUNET_HELLO_address_allocate (&wlanheader->sender,
1623 &mas->endpoint->wlan_addr,
1624 sizeof (struct WlanAddress),
1625 GNUNET_HELLO_ADDRESS_INFO_NONE);
1626 plugin->env->session_start (plugin->env->cls,
1630 LOG (GNUNET_ERROR_TYPE_DEBUG,
1631 "Notifying transport about peer `%s''s new session %p \n",
1632 GNUNET_i2s (&wlanheader->sender),
1634 GNUNET_HELLO_address_free (address);
1636 LOG (GNUNET_ERROR_TYPE_DEBUG,
1637 "Processing %u bytes of DATA from peer `%s'\n",
1638 (unsigned int) msize,
1639 GNUNET_i2s (&wlanheader->sender));
1640 mas->session->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1641 (void) GNUNET_SERVER_mst_receive (plugin->wlan_header_payload_tokenizer,
1643 (const char *) &wlanheader[1],
1644 msize - sizeof (struct WlanHeader),
1649 if (NULL == mas->endpoint)
1654 if (NULL == mas->session)
1659 LOG (GNUNET_ERROR_TYPE_DEBUG,
1660 "Received packet with %u bytes of type %u from peer %s\n",
1661 (unsigned int) msize,
1662 (unsigned int) ntohs (hdr->type),
1663 GNUNET_i2s (&mas->session->target));
1664 plugin->env->receive (plugin->env->cls,
1665 mas->session->address,
1675 * Task to (periodically) send a HELLO beacon
1677 * @param cls pointer to the plugin struct
1680 send_hello_beacon (void *cls)
1682 struct Plugin *plugin = cls;
1684 uint16_t hello_size;
1685 struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage *radioHeader;
1686 const struct GNUNET_MessageHeader *hello;
1688 hello = plugin->env->get_our_hello ();
1691 hello_size = GNUNET_HELLO_size ((struct GNUNET_HELLO_Message *) hello);
1692 GNUNET_assert (sizeof (struct WlanHeader) + hello_size <= WLAN_MTU);
1693 size = sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage) + hello_size;
1695 char buf[size] GNUNET_ALIGN;
1697 LOG (GNUNET_ERROR_TYPE_DEBUG,
1698 "Sending %u byte HELLO beacon\n",
1699 (unsigned int) size);
1700 radioHeader = (struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage*) buf;
1701 get_radiotap_header (NULL, radioHeader, size);
1702 LOG (GNUNET_ERROR_TYPE_DEBUG,
1703 "Broadcasting %u bytes of data to MAC `%s'\n",
1704 (unsigned int) size,
1705 mac_to_string (&bc_all_mac));
1706 get_wlan_header (plugin, &radioHeader->frame, &bc_all_mac, size);
1707 memcpy (&radioHeader[1], hello, hello_size);
1709 GNUNET_HELPER_send (plugin->suid_helper,
1710 &radioHeader->header,
1711 GNUNET_YES /* can drop */,
1713 GNUNET_STATISTICS_update (plugin->env->stats,
1714 _("# HELLO beacons sent"),
1717 plugin->beacon_task =
1718 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
1719 (HELLO_BEACON_SCALING_FACTOR,
1720 plugin->mac_count + 1),
1728 * Function used for to process the data from the suid process
1730 * @param cls the plugin handle
1731 * @param client client that send the data (not used)
1732 * @param hdr header of the GNUNET_MessageHeader
1735 handle_helper_message (void *cls, void *client,
1736 const struct GNUNET_MessageHeader *hdr)
1738 struct Plugin *plugin = cls;
1739 struct GNUNET_HELLO_Address *my_address;
1740 const struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage *rxinfo;
1741 const struct GNUNET_TRANSPORT_WLAN_HelperControlMessage *cm;
1742 struct WlanAddress wa;
1743 struct MacAndSession mas;
1745 struct FragmentMessage *fm;
1746 struct MacEndpoint *endpoint;
1748 msize = ntohs (hdr->size);
1749 switch (ntohs (hdr->type))
1751 case GNUNET_MESSAGE_TYPE_WLAN_HELPER_CONTROL:
1752 if (msize != sizeof (struct GNUNET_TRANSPORT_WLAN_HelperControlMessage))
1757 cm = (const struct GNUNET_TRANSPORT_WLAN_HelperControlMessage *) hdr;
1758 if (GNUNET_YES == plugin->have_mac)
1760 if (0 == memcmp (&plugin->mac_address,
1762 sizeof (struct GNUNET_TRANSPORT_WLAN_MacAddress)))
1763 break; /* no change */
1764 /* remove old address */
1765 memset (&wa, 0, sizeof (struct WlanAddress));
1766 wa.mac = plugin->mac_address;
1767 wa.options = htonl(plugin->options);
1768 my_address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
1771 GNUNET_HELLO_ADDRESS_INFO_NONE);
1772 plugin->env->notify_address (plugin->env->cls,
1775 GNUNET_HELLO_address_free (my_address);
1776 plugin->mac_address = cm->mac;
1780 plugin->mac_address = cm->mac;
1781 plugin->have_mac = GNUNET_YES;
1782 for (endpoint = plugin->mac_head; NULL != endpoint; endpoint = endpoint->next)
1784 for (fm = endpoint->sending_messages_head; NULL != fm; fm = fm->next)
1786 if (NULL != fm->fragcontext)
1788 GNUNET_break (0); /* should not happen */
1792 GNUNET_FRAGMENT_context_create (plugin->env->stats,
1795 fm->macendpoint->msg_delay,
1796 fm->macendpoint->ack_delay,
1798 &transmit_fragment, fm);
1799 GNUNET_free (fm->msg);
1803 GNUNET_break (NULL == plugin->beacon_task);
1804 plugin->beacon_task = GNUNET_SCHEDULER_add_now (&send_hello_beacon,
1809 memset (&wa, 0, sizeof (struct WlanAddress));
1810 wa.mac = plugin->mac_address;
1811 wa.options = htonl(plugin->options);
1812 my_address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
1815 GNUNET_HELLO_ADDRESS_INFO_NONE);
1817 LOG (GNUNET_ERROR_TYPE_DEBUG,
1818 "Received WLAN_HELPER_CONTROL message with MAC address `%s' for peer `%s'\n",
1819 mac_to_string (&cm->mac),
1820 GNUNET_i2s (plugin->env->my_identity));
1821 plugin->env->notify_address (plugin->env->cls,
1824 GNUNET_HELLO_address_free (my_address);
1826 case GNUNET_MESSAGE_TYPE_WLAN_DATA_FROM_HELPER:
1827 LOG (GNUNET_ERROR_TYPE_DEBUG,
1828 "Got data message from helper with %u bytes\n",
1830 GNUNET_STATISTICS_update (plugin->env->stats,
1831 _("# DATA messages received"), 1,
1833 if (msize < sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage))
1835 LOG (GNUNET_ERROR_TYPE_DEBUG,
1836 "Size of packet is too small (%u bytes < %u)\n",
1837 msize, sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage));
1840 rxinfo = (const struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage *) hdr;
1842 /* check if message is actually for us */
1843 if (0 != memcmp (&rxinfo->frame.addr3, &mac_bssid_gnunet,
1844 sizeof (struct GNUNET_TRANSPORT_WLAN_MacAddress)))
1846 /* Not the GNUnet BSSID */
1849 if ( (0 != memcmp (&rxinfo->frame.addr1, &bc_all_mac,
1850 sizeof (struct GNUNET_TRANSPORT_WLAN_MacAddress))) &&
1851 (0 != memcmp (&rxinfo->frame.addr1, &plugin->mac_address,
1852 sizeof (struct GNUNET_TRANSPORT_WLAN_MacAddress))) )
1854 /* Neither broadcast nor specifically for us */
1857 if (0 == memcmp (&rxinfo->frame.addr2, &plugin->mac_address,
1858 sizeof (struct GNUNET_TRANSPORT_WLAN_MacAddress)))
1860 /* packet is FROM us, thus not FOR us */
1864 GNUNET_STATISTICS_update (plugin->env->stats,
1865 _("# DATA messages processed"),
1867 LOG (GNUNET_ERROR_TYPE_DEBUG,
1868 "Receiving %u bytes of data from MAC `%s'\n",
1869 (unsigned int) (msize - sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage)),
1870 mac_to_string (&rxinfo->frame.addr2));
1871 LOG (GNUNET_ERROR_TYPE_DEBUG,
1872 "Receiving %u bytes of data to MAC `%s'\n",
1873 (unsigned int) (msize - sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage)),
1874 mac_to_string (&rxinfo->frame.addr1));
1875 LOG (GNUNET_ERROR_TYPE_DEBUG,
1876 "Receiving %u bytes of data with BSSID MAC `%s'\n",
1877 (unsigned int) (msize - sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage)),
1878 mac_to_string (&rxinfo->frame.addr3));
1879 wa.mac = rxinfo->frame.addr2;
1880 wa.options = htonl (0);
1881 mas.endpoint = create_macendpoint (plugin, &wa);
1883 (void) GNUNET_SERVER_mst_receive (plugin->helper_payload_tokenizer,
1885 (const char*) &rxinfo[1],
1886 msize - sizeof (struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage),
1887 GNUNET_YES, GNUNET_NO);
1891 LOG (GNUNET_ERROR_TYPE_DEBUG,
1892 "Unexpected message of type %u (%u bytes)",
1893 ntohs (hdr->type), ntohs (hdr->size));
1901 * Another peer has suggested an address for this
1902 * peer and transport plugin. Check that this could be a valid
1903 * address. If so, consider adding it to the list
1906 * @param cls closure
1907 * @param addr pointer to the address
1908 * @param addrlen length of @a addr
1909 * @return #GNUNET_OK if this is a plausible address for this peer
1913 wlan_plugin_address_suggested (void *cls,
1917 struct Plugin *plugin = cls;
1918 struct WlanAddress *wa = (struct WlanAddress *) addr;
1920 if (addrlen != sizeof (struct WlanAddress))
1922 GNUNET_break_op (0);
1923 return GNUNET_SYSERR;
1925 if (GNUNET_YES != plugin->have_mac)
1927 LOG (GNUNET_ERROR_TYPE_DEBUG,
1928 "Rejecting MAC `%s': I don't know my MAC!\n",
1929 mac_to_string (addr));
1930 return GNUNET_NO; /* don't know my MAC */
1932 if (0 != memcmp (&wa->mac,
1933 &plugin->mac_address,
1936 LOG (GNUNET_ERROR_TYPE_DEBUG,
1937 "Rejecting MAC `%s': not my MAC!\n",
1938 mac_to_string (addr));
1939 return GNUNET_NO; /* not my MAC */
1946 * Convert the transports address to a nice, human-readable format.
1948 * @param cls closure
1949 * @param type name of the transport that generated the address
1950 * @param addr one of the addresses of the host, NULL for the last address
1951 * the specific address format depends on the transport
1952 * @param addrlen length of the address
1953 * @param numeric should (IP) addresses be displayed in numeric form?
1954 * @param timeout after how long should we give up?
1955 * @param asc function to call on each string
1956 * @param asc_cls closure for @a asc
1959 wlan_plugin_address_pretty_printer (void *cls,
1964 struct GNUNET_TIME_Relative timeout,
1965 GNUNET_TRANSPORT_AddressStringCallback asc,
1970 if (sizeof (struct WlanAddress) == addrlen)
1971 ret = wlan_plugin_address_to_string (NULL,
1978 (NULL == ret) ? GNUNET_SYSERR : GNUNET_OK);
1979 asc (asc_cls, NULL, GNUNET_OK);
1984 * Exit point from the plugin.
1986 * @param cls pointer to the api struct
1989 LIBGNUNET_PLUGIN_TRANSPORT_DONE (void *cls)
1991 struct WlanAddress wa;
1992 struct GNUNET_HELLO_Address *address;
1993 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1994 struct Plugin *plugin = api->cls;
1995 struct MacEndpoint *endpoint;
1996 struct MacEndpoint *endpoint_next;
2003 if (GNUNET_YES == plugin->have_mac)
2005 memset (&wa, 0, sizeof(wa));
2006 wa.options = htonl (plugin->options);
2007 wa.mac = plugin->mac_address;
2008 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2010 &wa, sizeof (struct WlanAddress),
2011 GNUNET_HELLO_ADDRESS_INFO_NONE);
2013 plugin->env->notify_address (plugin->env->cls,
2016 plugin->have_mac = GNUNET_NO;
2017 GNUNET_HELLO_address_free (address);
2020 if (NULL != plugin->beacon_task)
2022 GNUNET_SCHEDULER_cancel (plugin->beacon_task);
2023 plugin->beacon_task = NULL;
2025 if (NULL != plugin->suid_helper)
2027 GNUNET_HELPER_stop (plugin->suid_helper,
2029 plugin->suid_helper = NULL;
2031 endpoint_next = plugin->mac_head;
2032 while (NULL != (endpoint = endpoint_next))
2034 endpoint_next = endpoint->next;
2035 free_macendpoint (endpoint);
2037 if (NULL != plugin->fragment_data_tokenizer)
2039 GNUNET_SERVER_mst_destroy (plugin->fragment_data_tokenizer);
2040 plugin->fragment_data_tokenizer = NULL;
2042 if (NULL != plugin->wlan_header_payload_tokenizer)
2044 GNUNET_SERVER_mst_destroy (plugin->wlan_header_payload_tokenizer);
2045 plugin->wlan_header_payload_tokenizer = NULL;
2047 if (NULL != plugin->helper_payload_tokenizer)
2049 GNUNET_SERVER_mst_destroy (plugin->helper_payload_tokenizer);
2050 plugin->helper_payload_tokenizer = NULL;
2052 GNUNET_free_non_null (plugin->wlan_interface);
2053 GNUNET_free (plugin);
2060 * Function called to convert a string address to
2063 * @param cls closure (`struct Plugin *`)
2064 * @param addr string address
2065 * @param addrlen length of the address
2066 * @param buf location to store the buffer
2067 * @param added location to store the number of bytes in the buffer.
2068 * If the function returns #GNUNET_SYSERR, its contents are undefined.
2069 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2072 wlan_plugin_string_to_address (void *cls,
2078 struct WlanAddress *wa;
2084 if ((NULL == addr) || (0 == addrlen))
2087 return GNUNET_SYSERR;
2089 if ('\0' != addr[addrlen - 1])
2092 return GNUNET_SYSERR;
2094 if (strlen (addr) != addrlen - 1)
2097 return GNUNET_SYSERR;
2100 if (8 != SSCANF (addr,
2101 "%4s.%u.%X:%X:%X:%X:%X:%X",
2103 &a[0], &a[1], &a[2],
2104 &a[3], &a[4], &a[5]))
2107 return GNUNET_SYSERR;
2109 wa = GNUNET_new (struct WlanAddress);
2111 wa->mac.mac[i] = a[i];
2112 wa->options = htonl (0);
2114 *added = sizeof (struct WlanAddress);
2120 * Begin monitoring sessions of a plugin. There can only
2121 * be one active monitor per plugin (i.e. if there are
2122 * multiple monitors, the transport service needs to
2123 * multiplex the generated events over all of them).
2125 * @param cls closure of the plugin
2126 * @param sic callback to invoke, NULL to disable monitor;
2127 * plugin will being by iterating over all active
2128 * sessions immediately and then enter monitor mode
2129 * @param sic_cls closure for @a sic
2132 wlan_plugin_setup_monitor (void *cls,
2133 GNUNET_TRANSPORT_SessionInfoCallback sic,
2136 struct Plugin *plugin = cls;
2137 struct MacEndpoint *mac;
2138 struct GNUNET_ATS_Session *session;
2141 plugin->sic_cls = sic_cls;
2144 for (mac = plugin->mac_head; NULL != mac; mac = mac->next)
2145 for (session = mac->sessions_head; NULL != session; session = session->next)
2147 notify_session_monitor (plugin,
2149 GNUNET_TRANSPORT_SS_INIT);
2150 notify_session_monitor (plugin,
2152 GNUNET_TRANSPORT_SS_UP);
2154 sic (sic_cls, NULL, NULL);
2161 * Function that will be called whenever the transport service wants to
2162 * notify the plugin that a session is still active and in use and
2163 * therefore the session timeout for this session has to be updated
2165 * @param cls closure
2166 * @param peer which peer was the session for
2167 * @param session which session is being updated
2170 wlan_plugin_update_session_timeout (void *cls,
2171 const struct GNUNET_PeerIdentity *peer,
2172 struct GNUNET_ATS_Session *session)
2174 GNUNET_assert (NULL != session->timeout_task);
2175 session->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2180 * Function that will be called whenever the transport service wants to
2181 * notify the plugin that the inbound quota changed and that the plugin
2182 * should update it's delay for the next receive value
2184 * @param cls closure
2185 * @param peer which peer was the session for
2186 * @param session which session is being updated
2187 * @param delay new delay to use for receiving
2190 wlan_plugin_update_inbound_delay (void *cls,
2191 const struct GNUNET_PeerIdentity *peer,
2192 struct GNUNET_ATS_Session *session,
2193 struct GNUNET_TIME_Relative delay)
2195 /* does nothing, as inbound delay is not supported by WLAN */
2200 * Entry point for the plugin.
2202 * @param cls closure, the `struct GNUNET_TRANSPORT_PluginEnvironment *`
2203 * @return the `struct GNUNET_TRANSPORT_PluginFunctions *` or NULL on error
2206 LIBGNUNET_PLUGIN_TRANSPORT_INIT (void *cls)
2208 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
2209 struct GNUNET_TRANSPORT_PluginFunctions *api;
2210 struct Plugin *plugin;
2211 char *wlan_interface;
2212 unsigned long long testmode;
2215 /* check for 'special' mode */
2216 if (NULL == env->receive)
2218 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
2219 initialze the plugin or the API */
2220 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2222 api->address_pretty_printer = &wlan_plugin_address_pretty_printer;
2223 api->address_to_string = &wlan_plugin_address_to_string;
2224 api->string_to_address = &wlan_plugin_string_to_address;
2229 /* check configuration */
2231 GNUNET_CONFIGURATION_have_value (env->cfg,
2235 GNUNET_CONFIGURATION_get_value_number (env->cfg,
2241 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2246 binary = GNUNET_OS_get_libexec_binary_path (HELPER_NAME);
2247 if ( (0 == testmode) &&
2249 GNUNET_OS_check_helper_binary (binary,
2253 LOG (GNUNET_ERROR_TYPE_ERROR,
2254 _("Helper binary `%s' not SUID, cannot run WLAN transport\n"),
2256 GNUNET_free (binary);
2259 GNUNET_free (binary);
2261 GNUNET_CONFIGURATION_get_value_string (env->cfg,
2266 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2272 plugin = GNUNET_new (struct Plugin);
2273 plugin->wlan_interface = wlan_interface;
2275 GNUNET_STATISTICS_set (plugin->env->stats,
2276 _("# sessions allocated"),
2278 GNUNET_STATISTICS_set (plugin->env->stats,
2279 _("# MAC endpoints allocated"),
2281 GNUNET_BANDWIDTH_tracker_init (&plugin->tracker, NULL, NULL,
2282 GNUNET_BANDWIDTH_value_init (100 * 1024 *
2285 plugin->fragment_data_tokenizer = GNUNET_SERVER_mst_create (&process_data,
2287 plugin->wlan_header_payload_tokenizer = GNUNET_SERVER_mst_create (&process_data,
2289 plugin->helper_payload_tokenizer = GNUNET_SERVER_mst_create (&process_data,
2292 plugin->options = 0;
2294 /* some compilers do not like switch on 'long long'... */
2295 switch ((unsigned int) testmode)
2297 case 0: /* normal */
2298 plugin->helper_argv[0] = (char *) HELPER_NAME;
2299 plugin->helper_argv[1] = wlan_interface;
2300 plugin->helper_argv[2] = NULL;
2301 plugin->suid_helper = GNUNET_HELPER_start (GNUNET_NO,
2303 plugin->helper_argv,
2304 &handle_helper_message,
2308 case 1: /* testmode, peer 1 */
2309 plugin->helper_argv[0] = (char *) DUMMY_HELPER_NAME;
2310 plugin->helper_argv[1] = (char *) "1";
2311 plugin->helper_argv[2] = NULL;
2312 plugin->suid_helper = GNUNET_HELPER_start (GNUNET_NO,
2314 plugin->helper_argv,
2315 &handle_helper_message,
2319 case 2: /* testmode, peer 2 */
2320 plugin->helper_argv[0] = (char *) DUMMY_HELPER_NAME;
2321 plugin->helper_argv[1] = (char *) "2";
2322 plugin->helper_argv[2] = NULL;
2323 plugin->suid_helper = GNUNET_HELPER_start (GNUNET_NO,
2325 plugin->helper_argv,
2326 &handle_helper_message,
2334 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2336 api->send = &wlan_plugin_send;
2337 api->get_session = &wlan_plugin_get_session;
2338 api->disconnect_peer = &wlan_plugin_disconnect_peer;
2339 api->disconnect_session = &wlan_plugin_disconnect_session;
2340 api->query_keepalive_factor = &wlan_plugin_query_keepalive_factor;
2341 api->address_pretty_printer = &wlan_plugin_address_pretty_printer;
2342 api->check_address = &wlan_plugin_address_suggested;
2343 api->address_to_string = &wlan_plugin_address_to_string;
2344 api->string_to_address = &wlan_plugin_string_to_address;
2345 api->get_network = &wlan_plugin_get_network;
2346 api->get_network_for_address = &wlan_plugin_get_network_for_address;
2347 api->update_session_timeout = &wlan_plugin_update_session_timeout;
2348 api->update_inbound_delay = &wlan_plugin_update_inbound_delay;
2349 api->setup_monitor = &wlan_plugin_setup_monitor;
2354 /* end of plugin_transport_wlan.c */