2 * Copyright (C) 2008-2010 B.A.T.M.A.N. contributors:
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of version 2 of the GNU General Public
8 * License as published by the Free Software Foundation.
10 * This program 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 this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 #include "translation-table.h"
26 #include "soft-interface.h"
27 #include "hard-interface.h"
30 /* Returns the smallest signed integer in two's complement with the sizeof x */
31 #define smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
33 /* Checks if a sequence number x is a predecessor/successor of y.
34 they handle overflows/underflows and can correctly check for a
35 predecessor/successor unless the variable sequence number has grown by
36 more then 2**(bitwidth(x)-1)-1.
37 This means that for a uint8_t with the maximum value 255, it would think:
38 * when adding nothing - it is neither a predecessor nor a successor
39 * before adding more than 127 to the starting value - it is a predecessor,
40 * when adding 128 - it is neither a predecessor nor a successor,
41 * after adding more than 127 to the starting value - it is a successor */
42 #define seq_before(x, y) ({typeof(x) _dummy = (x - y); \
43 _dummy > smallest_signed_int(_dummy); })
44 #define seq_after(x, y) seq_before(y, x)
46 static struct hashtable_t *vis_hash;
47 static DEFINE_SPINLOCK(vis_hash_lock);
48 static DEFINE_SPINLOCK(recv_list_lock);
49 static struct vis_info *my_vis_info;
50 static struct list_head send_list; /* always locked with vis_hash_lock */
52 static void start_vis_timer(void);
55 static void free_info(struct kref *ref)
57 struct vis_info *info = container_of(ref, struct vis_info, refcount);
58 struct recvlist_node *entry, *tmp;
61 list_del_init(&info->send_list);
62 spin_lock_irqsave(&recv_list_lock, flags);
63 list_for_each_entry_safe(entry, tmp, &info->recv_list, list) {
64 list_del(&entry->list);
67 spin_unlock_irqrestore(&recv_list_lock, flags);
71 /* Compare two vis packets, used by the hashing algorithm */
72 static int vis_info_cmp(void *data1, void *data2)
74 struct vis_info *d1, *d2;
77 return compare_orig(d1->packet.vis_orig, d2->packet.vis_orig);
80 /* hash function to choose an entry in a hash table of given size */
81 /* hash algorithm from http://en.wikipedia.org/wiki/Hash_table */
82 static int vis_info_choose(void *data, int size)
84 struct vis_info *vis_info = data;
89 key = vis_info->packet.vis_orig;
90 for (i = 0; i < ETH_ALEN; i++) {
103 /* insert interface to the list of interfaces of one originator, if it
104 * does not already exist in the list */
105 static void vis_data_insert_interface(const uint8_t *interface,
106 struct hlist_head *if_list,
109 struct if_list_entry *entry;
110 struct hlist_node *pos;
112 hlist_for_each_entry(entry, pos, if_list, list) {
113 if (compare_orig(entry->addr, (void *)interface))
117 /* its a new address, add it to the list */
118 entry = kmalloc(sizeof(*entry), GFP_ATOMIC);
121 memcpy(entry->addr, interface, ETH_ALEN);
122 entry->primary = primary;
123 hlist_add_head(&entry->list, if_list);
126 static ssize_t vis_data_read_prim_sec(char *buff, struct hlist_head *if_list)
128 struct if_list_entry *entry;
129 struct hlist_node *pos;
130 char tmp_addr_str[ETH_STR_LEN];
133 hlist_for_each_entry(entry, pos, if_list, list) {
135 len += sprintf(buff + len, "PRIMARY, ");
137 addr_to_string(tmp_addr_str, entry->addr);
138 len += sprintf(buff + len, "SEC %s, ", tmp_addr_str);
145 static size_t vis_data_count_prim_sec(struct hlist_head *if_list)
147 struct if_list_entry *entry;
148 struct hlist_node *pos;
151 hlist_for_each_entry(entry, pos, if_list, list) {
162 static ssize_t vis_data_read_entry(char *buff, struct vis_info_entry *entry,
163 uint8_t *src, bool primary)
167 /* maximal length: max(4+17+2, 3+17+1+3+2) == 26 */
168 addr_to_string(to, entry->dest);
169 if (primary && entry->quality == 0)
170 return sprintf(buff, "HNA %s, ", to);
171 else if (compare_orig(entry->src, src))
172 return sprintf(buff, "TQ %s %d, ", to, entry->quality);
177 int vis_seq_print_text(struct seq_file *seq, void *offset)
180 HASHIT(hashit_count);
181 struct vis_info *info;
182 struct vis_info_entry *entries;
183 struct net_device *net_dev = (struct net_device *)seq->private;
184 struct bat_priv *bat_priv = netdev_priv(net_dev);
185 HLIST_HEAD(vis_if_list);
186 struct if_list_entry *entry;
187 struct hlist_node *pos, *n;
189 char tmp_addr_str[ETH_STR_LEN];
191 int vis_server = atomic_read(&bat_priv->vis_mode);
192 size_t buff_pos, buf_size;
195 if ((!bat_priv->primary_if) ||
196 (vis_server == VIS_TYPE_CLIENT_UPDATE))
200 /* Estimate length */
201 spin_lock_irqsave(&vis_hash_lock, flags);
202 while (hash_iterate(vis_hash, &hashit_count)) {
203 info = hashit_count.bucket->data;
204 entries = (struct vis_info_entry *)
205 ((char *)info + sizeof(struct vis_info));
207 for (i = 0; i < info->packet.entries; i++) {
208 if (entries[i].quality == 0)
210 vis_data_insert_interface(entries[i].src, &vis_if_list,
211 compare_orig(entries[i].src,
212 info->packet.vis_orig));
215 hlist_for_each_entry(entry, pos, &vis_if_list, list) {
216 buf_size += 18 + 26 * info->packet.entries;
218 /* add primary/secondary records */
219 if (compare_orig(entry->addr, info->packet.vis_orig))
221 vis_data_count_prim_sec(&vis_if_list);
226 hlist_for_each_entry_safe(entry, pos, n, &vis_if_list, list) {
227 hlist_del(&entry->list);
232 buff = kmalloc(buf_size, GFP_ATOMIC);
234 spin_unlock_irqrestore(&vis_hash_lock, flags);
240 while (hash_iterate(vis_hash, &hashit)) {
241 info = hashit.bucket->data;
242 entries = (struct vis_info_entry *)
243 ((char *)info + sizeof(struct vis_info));
245 for (i = 0; i < info->packet.entries; i++) {
246 if (entries[i].quality == 0)
248 vis_data_insert_interface(entries[i].src, &vis_if_list,
249 compare_orig(entries[i].src,
250 info->packet.vis_orig));
253 hlist_for_each_entry(entry, pos, &vis_if_list, list) {
254 addr_to_string(tmp_addr_str, entry->addr);
255 buff_pos += sprintf(buff + buff_pos, "%s,",
258 for (i = 0; i < info->packet.entries; i++)
259 buff_pos += vis_data_read_entry(buff + buff_pos,
264 /* add primary/secondary records */
265 if (compare_orig(entry->addr, info->packet.vis_orig))
267 vis_data_read_prim_sec(buff + buff_pos,
270 buff_pos += sprintf(buff + buff_pos, "\n");
273 hlist_for_each_entry_safe(entry, pos, n, &vis_if_list, list) {
274 hlist_del(&entry->list);
279 spin_unlock_irqrestore(&vis_hash_lock, flags);
281 seq_printf(seq, "%s", buff);
287 /* add the info packet to the send list, if it was not
288 * already linked in. */
289 static void send_list_add(struct vis_info *info)
291 if (list_empty(&info->send_list)) {
292 kref_get(&info->refcount);
293 list_add_tail(&info->send_list, &send_list);
297 /* delete the info packet from the send list, if it was
299 static void send_list_del(struct vis_info *info)
301 if (!list_empty(&info->send_list)) {
302 list_del_init(&info->send_list);
303 kref_put(&info->refcount, free_info);
307 /* tries to add one entry to the receive list. */
308 static void recv_list_add(struct list_head *recv_list, char *mac)
310 struct recvlist_node *entry;
313 entry = kmalloc(sizeof(struct recvlist_node), GFP_ATOMIC);
317 memcpy(entry->mac, mac, ETH_ALEN);
318 spin_lock_irqsave(&recv_list_lock, flags);
319 list_add_tail(&entry->list, recv_list);
320 spin_unlock_irqrestore(&recv_list_lock, flags);
323 /* returns 1 if this mac is in the recv_list */
324 static int recv_list_is_in(struct list_head *recv_list, char *mac)
326 struct recvlist_node *entry;
329 spin_lock_irqsave(&recv_list_lock, flags);
330 list_for_each_entry(entry, recv_list, list) {
331 if (memcmp(entry->mac, mac, ETH_ALEN) == 0) {
332 spin_unlock_irqrestore(&recv_list_lock, flags);
336 spin_unlock_irqrestore(&recv_list_lock, flags);
340 /* try to add the packet to the vis_hash. return NULL if invalid (e.g. too old,
341 * broken.. ). vis hash must be locked outside. is_new is set when the packet
342 * is newer than old entries in the hash. */
343 static struct vis_info *add_packet(struct vis_packet *vis_packet,
344 int vis_info_len, int *is_new,
347 struct vis_info *info, *old_info;
348 struct vis_info search_elem;
352 if (vis_hash == NULL)
355 /* see if the packet is already in vis_hash */
356 memcpy(search_elem.packet.vis_orig, vis_packet->vis_orig, ETH_ALEN);
357 old_info = hash_find(vis_hash, &search_elem);
359 if (old_info != NULL) {
360 if (!seq_after(ntohl(vis_packet->seqno),
361 ntohl(old_info->packet.seqno))) {
362 if (old_info->packet.seqno == vis_packet->seqno) {
363 recv_list_add(&old_info->recv_list,
364 vis_packet->sender_orig);
367 /* newer packet is already in hash. */
371 /* remove old entry */
372 hash_remove(vis_hash, old_info);
373 send_list_del(old_info);
374 kref_put(&old_info->refcount, free_info);
377 info = kmalloc(sizeof(struct vis_info) + vis_info_len, GFP_ATOMIC);
381 kref_init(&info->refcount);
382 INIT_LIST_HEAD(&info->send_list);
383 INIT_LIST_HEAD(&info->recv_list);
384 info->first_seen = jiffies;
385 memcpy(&info->packet, vis_packet,
386 sizeof(struct vis_packet) + vis_info_len);
388 /* initialize and add new packet. */
391 /* Make it a broadcast packet, if required */
393 memcpy(info->packet.target_orig, broadcast_addr, ETH_ALEN);
395 /* repair if entries is longer than packet. */
396 if (info->packet.entries * sizeof(struct vis_info_entry) > vis_info_len)
397 info->packet.entries = vis_info_len /
398 sizeof(struct vis_info_entry);
400 recv_list_add(&info->recv_list, info->packet.sender_orig);
403 if (hash_add(vis_hash, info) < 0) {
404 /* did not work (for some reason) */
405 kref_put(&old_info->refcount, free_info);
412 /* handle the server sync packet, forward if needed. */
413 void receive_server_sync_packet(struct bat_priv *bat_priv,
414 struct vis_packet *vis_packet,
417 struct vis_info *info;
418 int is_new, make_broadcast;
420 int vis_server = atomic_read(&bat_priv->vis_mode);
422 make_broadcast = (vis_server == VIS_TYPE_SERVER_SYNC);
424 spin_lock_irqsave(&vis_hash_lock, flags);
425 info = add_packet(vis_packet, vis_info_len, &is_new, make_broadcast);
429 /* only if we are server ourselves and packet is newer than the one in
431 if (vis_server == VIS_TYPE_SERVER_SYNC && is_new)
434 spin_unlock_irqrestore(&vis_hash_lock, flags);
437 /* handle an incoming client update packet and schedule forward if needed. */
438 void receive_client_update_packet(struct bat_priv *bat_priv,
439 struct vis_packet *vis_packet,
442 struct vis_info *info;
445 int vis_server = atomic_read(&bat_priv->vis_mode);
448 /* clients shall not broadcast. */
449 if (is_bcast(vis_packet->target_orig))
452 /* Are we the target for this VIS packet? */
453 if (vis_server == VIS_TYPE_SERVER_SYNC &&
454 is_my_mac(vis_packet->target_orig))
457 spin_lock_irqsave(&vis_hash_lock, flags);
458 info = add_packet(vis_packet, vis_info_len, &is_new, are_target);
461 /* note that outdated packets will be dropped at this point. */
464 /* send only if we're the target server or ... */
465 if (are_target && is_new) {
466 info->packet.vis_type = VIS_TYPE_SERVER_SYNC; /* upgrade! */
469 /* ... we're not the recipient (and thus need to forward). */
470 } else if (!is_my_mac(info->packet.target_orig)) {
474 spin_unlock_irqrestore(&vis_hash_lock, flags);
477 /* Walk the originators and find the VIS server with the best tq. Set the packet
478 * address to its address and return the best_tq.
480 * Must be called with the originator hash locked */
481 static int find_best_vis_server(struct vis_info *info)
484 struct orig_node *orig_node;
487 while (hash_iterate(orig_hash, &hashit)) {
488 orig_node = hashit.bucket->data;
489 if ((orig_node != NULL) &&
490 (orig_node->router != NULL) &&
491 (orig_node->flags & VIS_SERVER) &&
492 (orig_node->router->tq_avg > best_tq)) {
493 best_tq = orig_node->router->tq_avg;
494 memcpy(info->packet.target_orig, orig_node->orig,
501 /* Return true if the vis packet is full. */
502 static bool vis_packet_full(struct vis_info *info)
504 if (info->packet.entries + 1 >
505 (1000 - sizeof(struct vis_info)) / sizeof(struct vis_info_entry))
510 /* generates a packet of own vis data,
511 * returns 0 on success, -1 if no packet could be generated */
512 static int generate_vis_packet(struct bat_priv *bat_priv)
514 HASHIT(hashit_local);
515 HASHIT(hashit_global);
516 struct orig_node *orig_node;
517 struct vis_info *info = (struct vis_info *)my_vis_info;
518 struct vis_info_entry *entry, *entry_array;
519 struct hna_local_entry *hna_local_entry;
523 info->first_seen = jiffies;
524 info->packet.vis_type = atomic_read(&bat_priv->vis_mode);
526 spin_lock_irqsave(&orig_hash_lock, flags);
527 memcpy(info->packet.target_orig, broadcast_addr, ETH_ALEN);
528 info->packet.ttl = TTL;
529 info->packet.seqno = htonl(ntohl(info->packet.seqno) + 1);
530 info->packet.entries = 0;
532 if (info->packet.vis_type == VIS_TYPE_CLIENT_UPDATE) {
533 best_tq = find_best_vis_server(info);
535 spin_unlock_irqrestore(&orig_hash_lock, flags);
540 entry_array = (struct vis_info_entry *)
541 ((char *)info + sizeof(struct vis_info));
543 while (hash_iterate(orig_hash, &hashit_global)) {
544 orig_node = hashit_global.bucket->data;
545 if (orig_node->router != NULL
546 && compare_orig(orig_node->router->addr,
548 && (orig_node->router->if_incoming->if_status ==
550 && orig_node->router->tq_avg > 0) {
552 /* fill one entry into buffer. */
553 entry = &entry_array[info->packet.entries];
555 orig_node->router->if_incoming->net_dev->dev_addr,
557 memcpy(entry->dest, orig_node->orig, ETH_ALEN);
558 entry->quality = orig_node->router->tq_avg;
559 info->packet.entries++;
561 if (vis_packet_full(info)) {
562 spin_unlock_irqrestore(&orig_hash_lock, flags);
568 spin_unlock_irqrestore(&orig_hash_lock, flags);
570 spin_lock_irqsave(&hna_local_hash_lock, flags);
571 while (hash_iterate(hna_local_hash, &hashit_local)) {
572 hna_local_entry = hashit_local.bucket->data;
573 entry = &entry_array[info->packet.entries];
574 memset(entry->src, 0, ETH_ALEN);
575 memcpy(entry->dest, hna_local_entry->addr, ETH_ALEN);
576 entry->quality = 0; /* 0 means HNA */
577 info->packet.entries++;
579 if (vis_packet_full(info)) {
580 spin_unlock_irqrestore(&hna_local_hash_lock, flags);
584 spin_unlock_irqrestore(&hna_local_hash_lock, flags);
588 /* free old vis packets. Must be called with this vis_hash_lock
590 static void purge_vis_packets(void)
593 struct vis_info *info;
595 while (hash_iterate(vis_hash, &hashit)) {
596 info = hashit.bucket->data;
597 if (info == my_vis_info) /* never purge own data. */
599 if (time_after(jiffies,
600 info->first_seen + VIS_TIMEOUT * HZ)) {
601 hash_remove_bucket(vis_hash, &hashit);
603 kref_put(&info->refcount, free_info);
608 static void broadcast_vis_packet(struct vis_info *info, int packet_length)
611 struct orig_node *orig_node;
613 struct batman_if *batman_if;
614 uint8_t dstaddr[ETH_ALEN];
616 spin_lock_irqsave(&orig_hash_lock, flags);
618 /* send to all routers in range. */
619 while (hash_iterate(orig_hash, &hashit)) {
620 orig_node = hashit.bucket->data;
622 /* if it's a vis server and reachable, send it. */
623 if ((!orig_node) || (!orig_node->router))
625 if (!(orig_node->flags & VIS_SERVER))
627 /* don't send it if we already received the packet from
629 if (recv_list_is_in(&info->recv_list, orig_node->orig))
632 memcpy(info->packet.target_orig, orig_node->orig, ETH_ALEN);
633 batman_if = orig_node->router->if_incoming;
634 memcpy(dstaddr, orig_node->router->addr, ETH_ALEN);
635 spin_unlock_irqrestore(&orig_hash_lock, flags);
637 send_raw_packet((unsigned char *)&info->packet,
638 packet_length, batman_if, dstaddr);
640 spin_lock_irqsave(&orig_hash_lock, flags);
643 spin_unlock_irqrestore(&orig_hash_lock, flags);
644 memcpy(info->packet.target_orig, broadcast_addr, ETH_ALEN);
647 static void unicast_vis_packet(struct vis_info *info, int packet_length)
649 struct orig_node *orig_node;
651 struct batman_if *batman_if;
652 uint8_t dstaddr[ETH_ALEN];
654 spin_lock_irqsave(&orig_hash_lock, flags);
655 orig_node = ((struct orig_node *)
656 hash_find(orig_hash, info->packet.target_orig));
658 if ((!orig_node) || (!orig_node->router))
661 /* don't lock while sending the packets ... we therefore
662 * copy the required data before sending */
663 batman_if = orig_node->router->if_incoming;
664 memcpy(dstaddr, orig_node->router->addr, ETH_ALEN);
665 spin_unlock_irqrestore(&orig_hash_lock, flags);
667 send_raw_packet((unsigned char *)&info->packet,
668 packet_length, batman_if, dstaddr);
672 spin_unlock_irqrestore(&orig_hash_lock, flags);
675 /* only send one vis packet. called from send_vis_packets() */
676 static void send_vis_packet(struct vis_info *info)
680 if (info->packet.ttl < 2) {
681 pr_warning("Error - can't send vis packet: ttl exceeded\n");
685 memcpy(info->packet.sender_orig, main_if_addr, ETH_ALEN);
688 packet_length = sizeof(struct vis_packet) +
689 info->packet.entries * sizeof(struct vis_info_entry);
691 if (is_bcast(info->packet.target_orig))
692 broadcast_vis_packet(info, packet_length);
694 unicast_vis_packet(info, packet_length);
695 info->packet.ttl++; /* restore TTL */
698 /* called from timer; send (and maybe generate) vis packet. */
699 static void send_vis_packets(struct work_struct *work)
701 struct vis_info *info, *temp;
703 /* FIXME: each batman_if will be attached to a softif */
704 struct bat_priv *bat_priv = netdev_priv(soft_device);
706 spin_lock_irqsave(&vis_hash_lock, flags);
710 if (generate_vis_packet(bat_priv) == 0) {
711 /* schedule if generation was successful */
712 send_list_add(my_vis_info);
715 list_for_each_entry_safe(info, temp, &send_list, send_list) {
717 kref_get(&info->refcount);
718 spin_unlock_irqrestore(&vis_hash_lock, flags);
720 send_vis_packet(info);
722 spin_lock_irqsave(&vis_hash_lock, flags);
724 kref_put(&info->refcount, free_info);
726 spin_unlock_irqrestore(&vis_hash_lock, flags);
729 static DECLARE_DELAYED_WORK(vis_timer_wq, send_vis_packets);
731 /* init the vis server. this may only be called when if_list is already
732 * initialized (e.g. bat0 is initialized, interfaces have been added) */
739 spin_lock_irqsave(&vis_hash_lock, flags);
741 vis_hash = hash_new(256, vis_info_cmp, vis_info_choose);
743 pr_err("Can't initialize vis_hash\n");
747 my_vis_info = kmalloc(1000, GFP_ATOMIC);
749 pr_err("Can't initialize vis packet\n");
753 /* prefill the vis info */
754 my_vis_info->first_seen = jiffies - msecs_to_jiffies(VIS_INTERVAL);
755 INIT_LIST_HEAD(&my_vis_info->recv_list);
756 INIT_LIST_HEAD(&my_vis_info->send_list);
757 kref_init(&my_vis_info->refcount);
758 my_vis_info->packet.version = COMPAT_VERSION;
759 my_vis_info->packet.packet_type = BAT_VIS;
760 my_vis_info->packet.ttl = TTL;
761 my_vis_info->packet.seqno = 0;
762 my_vis_info->packet.entries = 0;
764 INIT_LIST_HEAD(&send_list);
766 memcpy(my_vis_info->packet.vis_orig, main_if_addr, ETH_ALEN);
767 memcpy(my_vis_info->packet.sender_orig, main_if_addr, ETH_ALEN);
769 if (hash_add(vis_hash, my_vis_info) < 0) {
770 pr_err("Can't add own vis packet into hash\n");
771 /* not in hash, need to remove it manually. */
772 kref_put(&my_vis_info->refcount, free_info);
776 spin_unlock_irqrestore(&vis_hash_lock, flags);
781 spin_unlock_irqrestore(&vis_hash_lock, flags);
786 /* Decrease the reference count on a hash item info */
787 static void free_info_ref(void *data)
789 struct vis_info *info = data;
792 kref_put(&info->refcount, free_info);
795 /* shutdown vis-server */
802 cancel_delayed_work_sync(&vis_timer_wq);
804 spin_lock_irqsave(&vis_hash_lock, flags);
805 /* properly remove, kill timers ... */
806 hash_delete(vis_hash, free_info_ref);
809 spin_unlock_irqrestore(&vis_hash_lock, flags);
812 /* schedule packets for (re)transmission */
813 static void start_vis_timer(void)
815 queue_delayed_work(bat_event_workqueue, &vis_timer_wq,
816 (VIS_INTERVAL * HZ) / 1000);