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 struct hashtable_t *vis_hash;
47 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_KERNEL);
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);
146 static ssize_t vis_data_read_entry(char *buff, struct vis_info_entry *entry,
147 uint8_t *src, bool primary)
151 addr_to_string(to, entry->dest);
152 if (primary && entry->quality == 0)
153 return sprintf(buff, "HNA %s, ", to);
154 else if (compare_orig(entry->src, src))
155 return sprintf(buff, "TQ %s %d, ", to, entry->quality);
160 ssize_t vis_fill_buffer_text(struct net_device *net_dev, char *buff,
161 size_t count, loff_t off)
164 struct vis_info *info;
165 struct vis_info_entry *entries;
166 struct bat_priv *bat_priv = netdev_priv(net_dev);
167 HLIST_HEAD(vis_if_list);
168 struct if_list_entry *entry;
169 struct hlist_node *pos, *n;
170 size_t hdr_len, tmp_len;
171 int i, bytes_written = 0;
172 char tmp_addr_str[ETH_STR_LEN];
174 int vis_server = atomic_read(&bat_priv->vis_mode);
177 if (list_empty(&if_list) || (vis_server == VIS_TYPE_CLIENT_UPDATE)) {
185 spin_lock_irqsave(&vis_hash_lock, flags);
186 while (hash_iterate(vis_hash, &hashit)) {
187 info = hashit.bucket->data;
188 entries = (struct vis_info_entry *)
189 ((char *)info + sizeof(struct vis_info));
191 /* estimated line length */
192 if (count < bytes_written + 200)
195 for (i = 0; i < info->packet.entries; i++) {
196 if (entries[i].quality == 0)
198 vis_data_insert_interface(entries[i].src, &vis_if_list,
199 compare_orig(entries[i].src,
200 info->packet.vis_orig));
203 hlist_for_each_entry(entry, pos, &vis_if_list, list) {
204 addr_to_string(tmp_addr_str, entry->addr);
205 tmp_len = sprintf(buff + bytes_written,
206 "%s,", tmp_addr_str);
208 for (i = 0; i < info->packet.entries; i++)
209 tmp_len += vis_data_read_entry(
210 buff + bytes_written + tmp_len,
211 &entries[i], entry->addr,
214 /* add primary/secondary records */
215 if (compare_orig(entry->addr, info->packet.vis_orig))
216 tmp_len += vis_data_read_prim_sec(
217 buff + bytes_written + tmp_len,
220 tmp_len += sprintf(buff + bytes_written + tmp_len,
228 bytes_written += tmp_len;
231 hlist_for_each_entry_safe(entry, pos, n, &vis_if_list, list) {
232 hlist_del(&entry->list);
236 spin_unlock_irqrestore(&vis_hash_lock, flags);
238 return bytes_written;
241 /* add the info packet to the send list, if it was not
242 * already linked in. */
243 static void send_list_add(struct vis_info *info)
245 if (list_empty(&info->send_list)) {
246 kref_get(&info->refcount);
247 list_add_tail(&info->send_list, &send_list);
251 /* delete the info packet from the send list, if it was
253 static void send_list_del(struct vis_info *info)
255 if (!list_empty(&info->send_list)) {
256 list_del_init(&info->send_list);
257 kref_put(&info->refcount, free_info);
261 /* tries to add one entry to the receive list. */
262 static void recv_list_add(struct list_head *recv_list, char *mac)
264 struct recvlist_node *entry;
267 entry = kmalloc(sizeof(struct recvlist_node), GFP_ATOMIC);
271 memcpy(entry->mac, mac, ETH_ALEN);
272 spin_lock_irqsave(&recv_list_lock, flags);
273 list_add_tail(&entry->list, recv_list);
274 spin_unlock_irqrestore(&recv_list_lock, flags);
277 /* returns 1 if this mac is in the recv_list */
278 static int recv_list_is_in(struct list_head *recv_list, char *mac)
280 struct recvlist_node *entry;
283 spin_lock_irqsave(&recv_list_lock, flags);
284 list_for_each_entry(entry, recv_list, list) {
285 if (memcmp(entry->mac, mac, ETH_ALEN) == 0) {
286 spin_unlock_irqrestore(&recv_list_lock, flags);
290 spin_unlock_irqrestore(&recv_list_lock, flags);
294 /* try to add the packet to the vis_hash. return NULL if invalid (e.g. too old,
295 * broken.. ). vis hash must be locked outside. is_new is set when the packet
296 * is newer than old entries in the hash. */
297 static struct vis_info *add_packet(struct vis_packet *vis_packet,
298 int vis_info_len, int *is_new,
301 struct vis_info *info, *old_info;
302 struct vis_info search_elem;
306 if (vis_hash == NULL)
309 /* see if the packet is already in vis_hash */
310 memcpy(search_elem.packet.vis_orig, vis_packet->vis_orig, ETH_ALEN);
311 old_info = hash_find(vis_hash, &search_elem);
313 if (old_info != NULL) {
314 if (!seq_after(vis_packet->seqno, old_info->packet.seqno)) {
315 if (old_info->packet.seqno == vis_packet->seqno) {
316 recv_list_add(&old_info->recv_list,
317 vis_packet->sender_orig);
320 /* newer packet is already in hash. */
324 /* remove old entry */
325 hash_remove(vis_hash, old_info);
326 send_list_del(old_info);
327 kref_put(&old_info->refcount, free_info);
330 info = kmalloc(sizeof(struct vis_info) + vis_info_len, GFP_ATOMIC);
334 kref_init(&info->refcount);
335 INIT_LIST_HEAD(&info->send_list);
336 INIT_LIST_HEAD(&info->recv_list);
337 info->first_seen = jiffies;
338 memcpy(&info->packet, vis_packet,
339 sizeof(struct vis_packet) + vis_info_len);
341 /* initialize and add new packet. */
344 /* Make it a broadcast packet, if required */
346 memcpy(info->packet.target_orig, broadcastAddr, ETH_ALEN);
348 /* repair if entries is longer than packet. */
349 if (info->packet.entries * sizeof(struct vis_info_entry) > vis_info_len)
350 info->packet.entries = vis_info_len /
351 sizeof(struct vis_info_entry);
353 recv_list_add(&info->recv_list, info->packet.sender_orig);
356 if (hash_add(vis_hash, info) < 0) {
357 /* did not work (for some reason) */
358 kref_put(&old_info->refcount, free_info);
365 /* handle the server sync packet, forward if needed. */
366 void receive_server_sync_packet(struct bat_priv *bat_priv,
367 struct vis_packet *vis_packet,
370 struct vis_info *info;
371 int is_new, make_broadcast;
373 int vis_server = atomic_read(&bat_priv->vis_mode);
375 make_broadcast = (vis_server == VIS_TYPE_SERVER_SYNC);
377 spin_lock_irqsave(&vis_hash_lock, flags);
378 info = add_packet(vis_packet, vis_info_len, &is_new, make_broadcast);
382 /* only if we are server ourselves and packet is newer than the one in
384 if (vis_server == VIS_TYPE_SERVER_SYNC && is_new)
387 spin_unlock_irqrestore(&vis_hash_lock, flags);
390 /* handle an incoming client update packet and schedule forward if needed. */
391 void receive_client_update_packet(struct bat_priv *bat_priv,
392 struct vis_packet *vis_packet,
395 struct vis_info *info;
398 int vis_server = atomic_read(&bat_priv->vis_mode);
401 /* clients shall not broadcast. */
402 if (is_bcast(vis_packet->target_orig))
405 /* Are we the target for this VIS packet? */
406 if (vis_server == VIS_TYPE_SERVER_SYNC &&
407 is_my_mac(vis_packet->target_orig))
410 spin_lock_irqsave(&vis_hash_lock, flags);
411 info = add_packet(vis_packet, vis_info_len, &is_new, are_target);
414 /* note that outdated packets will be dropped at this point. */
417 /* send only if we're the target server or ... */
418 if (are_target && is_new) {
419 info->packet.vis_type = VIS_TYPE_SERVER_SYNC; /* upgrade! */
422 /* ... we're not the recipient (and thus need to forward). */
423 } else if (!is_my_mac(info->packet.target_orig)) {
427 spin_unlock_irqrestore(&vis_hash_lock, flags);
430 /* Walk the originators and find the VIS server with the best tq. Set the packet
431 * address to its address and return the best_tq.
433 * Must be called with the originator hash locked */
434 static int find_best_vis_server(struct vis_info *info)
437 struct orig_node *orig_node;
440 while (hash_iterate(orig_hash, &hashit)) {
441 orig_node = hashit.bucket->data;
442 if ((orig_node != NULL) &&
443 (orig_node->router != NULL) &&
444 (orig_node->flags & VIS_SERVER) &&
445 (orig_node->router->tq_avg > best_tq)) {
446 best_tq = orig_node->router->tq_avg;
447 memcpy(info->packet.target_orig, orig_node->orig,
454 /* Return true if the vis packet is full. */
455 static bool vis_packet_full(struct vis_info *info)
457 if (info->packet.entries + 1 >
458 (1000 - sizeof(struct vis_info)) / sizeof(struct vis_info_entry))
463 /* generates a packet of own vis data,
464 * returns 0 on success, -1 if no packet could be generated */
465 static int generate_vis_packet(struct bat_priv *bat_priv)
467 HASHIT(hashit_local);
468 HASHIT(hashit_global);
469 struct orig_node *orig_node;
470 struct vis_info *info = (struct vis_info *)my_vis_info;
471 struct vis_info_entry *entry, *entry_array;
472 struct hna_local_entry *hna_local_entry;
476 info->first_seen = jiffies;
477 info->packet.vis_type = atomic_read(&bat_priv->vis_mode);
479 spin_lock_irqsave(&orig_hash_lock, flags);
480 memcpy(info->packet.target_orig, broadcastAddr, ETH_ALEN);
481 info->packet.ttl = TTL;
482 info->packet.seqno++;
483 info->packet.entries = 0;
485 if (info->packet.vis_type == VIS_TYPE_CLIENT_UPDATE) {
486 best_tq = find_best_vis_server(info);
488 spin_unlock_irqrestore(&orig_hash_lock, flags);
493 entry_array = (struct vis_info_entry *)
494 ((char *)info + sizeof(struct vis_info));
496 while (hash_iterate(orig_hash, &hashit_global)) {
497 orig_node = hashit_global.bucket->data;
498 if (orig_node->router != NULL
499 && compare_orig(orig_node->router->addr,
501 && orig_node->batman_if
502 && (orig_node->batman_if->if_active == IF_ACTIVE)
503 && orig_node->router->tq_avg > 0) {
505 /* fill one entry into buffer. */
506 entry = &entry_array[info->packet.entries];
508 orig_node->batman_if->net_dev->dev_addr,
510 memcpy(entry->dest, orig_node->orig, ETH_ALEN);
511 entry->quality = orig_node->router->tq_avg;
512 info->packet.entries++;
514 if (vis_packet_full(info)) {
515 spin_unlock_irqrestore(&orig_hash_lock, flags);
521 spin_unlock_irqrestore(&orig_hash_lock, flags);
523 spin_lock_irqsave(&hna_local_hash_lock, flags);
524 while (hash_iterate(hna_local_hash, &hashit_local)) {
525 hna_local_entry = hashit_local.bucket->data;
526 entry = &entry_array[info->packet.entries];
527 memset(entry->src, 0, ETH_ALEN);
528 memcpy(entry->dest, hna_local_entry->addr, ETH_ALEN);
529 entry->quality = 0; /* 0 means HNA */
530 info->packet.entries++;
532 if (vis_packet_full(info)) {
533 spin_unlock_irqrestore(&hna_local_hash_lock, flags);
537 spin_unlock_irqrestore(&hna_local_hash_lock, flags);
541 /* free old vis packets. Must be called with this vis_hash_lock
543 static void purge_vis_packets(void)
546 struct vis_info *info;
548 while (hash_iterate(vis_hash, &hashit)) {
549 info = hashit.bucket->data;
550 if (info == my_vis_info) /* never purge own data. */
552 if (time_after(jiffies,
553 info->first_seen + (VIS_TIMEOUT*HZ)/1000)) {
554 hash_remove_bucket(vis_hash, &hashit);
556 kref_put(&info->refcount, free_info);
561 static void broadcast_vis_packet(struct vis_info *info, int packet_length)
564 struct orig_node *orig_node;
566 struct batman_if *batman_if;
567 uint8_t dstaddr[ETH_ALEN];
569 spin_lock_irqsave(&orig_hash_lock, flags);
571 /* send to all routers in range. */
572 while (hash_iterate(orig_hash, &hashit)) {
573 orig_node = hashit.bucket->data;
575 /* if it's a vis server and reachable, send it. */
576 if ((!orig_node) || (!orig_node->batman_if) ||
577 (!orig_node->router))
579 if (!(orig_node->flags & VIS_SERVER))
581 /* don't send it if we already received the packet from
583 if (recv_list_is_in(&info->recv_list, orig_node->orig))
586 memcpy(info->packet.target_orig, orig_node->orig, ETH_ALEN);
587 batman_if = orig_node->batman_if;
588 memcpy(dstaddr, orig_node->router->addr, ETH_ALEN);
589 spin_unlock_irqrestore(&orig_hash_lock, flags);
591 send_raw_packet((unsigned char *)&info->packet,
592 packet_length, batman_if, dstaddr);
594 spin_lock_irqsave(&orig_hash_lock, flags);
597 spin_unlock_irqrestore(&orig_hash_lock, flags);
598 memcpy(info->packet.target_orig, broadcastAddr, ETH_ALEN);
601 static void unicast_vis_packet(struct vis_info *info, int packet_length)
603 struct orig_node *orig_node;
605 struct batman_if *batman_if;
606 uint8_t dstaddr[ETH_ALEN];
608 spin_lock_irqsave(&orig_hash_lock, flags);
609 orig_node = ((struct orig_node *)
610 hash_find(orig_hash, info->packet.target_orig));
612 if ((!orig_node) || (!orig_node->batman_if) || (!orig_node->router))
615 /* don't lock while sending the packets ... we therefore
616 * copy the required data before sending */
617 batman_if = orig_node->batman_if;
618 memcpy(dstaddr, orig_node->router->addr, ETH_ALEN);
619 spin_unlock_irqrestore(&orig_hash_lock, flags);
621 send_raw_packet((unsigned char *)&info->packet,
622 packet_length, batman_if, dstaddr);
626 spin_unlock_irqrestore(&orig_hash_lock, flags);
629 /* only send one vis packet. called from send_vis_packets() */
630 static void send_vis_packet(struct vis_info *info)
634 if (info->packet.ttl < 2) {
635 printk(KERN_WARNING "batman-adv: Error - can't send vis packet: ttl exceeded\n");
639 memcpy(info->packet.sender_orig, mainIfAddr, ETH_ALEN);
642 packet_length = sizeof(struct vis_packet) +
643 info->packet.entries * sizeof(struct vis_info_entry);
645 if (is_bcast(info->packet.target_orig))
646 broadcast_vis_packet(info, packet_length);
648 unicast_vis_packet(info, packet_length);
649 info->packet.ttl++; /* restore TTL */
652 /* called from timer; send (and maybe generate) vis packet. */
653 static void send_vis_packets(struct work_struct *work)
655 struct vis_info *info, *temp;
657 /* FIXME: each batman_if will be attached to a softif */
658 struct bat_priv *bat_priv = netdev_priv(soft_device);
660 spin_lock_irqsave(&vis_hash_lock, flags);
664 if (generate_vis_packet(bat_priv) == 0) {
665 /* schedule if generation was successful */
666 send_list_add(my_vis_info);
669 list_for_each_entry_safe(info, temp, &send_list, send_list) {
671 kref_get(&info->refcount);
672 spin_unlock_irqrestore(&vis_hash_lock, flags);
674 send_vis_packet(info);
676 spin_lock_irqsave(&vis_hash_lock, flags);
678 kref_put(&info->refcount, free_info);
680 spin_unlock_irqrestore(&vis_hash_lock, flags);
683 static DECLARE_DELAYED_WORK(vis_timer_wq, send_vis_packets);
685 /* init the vis server. this may only be called when if_list is already
686 * initialized (e.g. bat0 is initialized, interfaces have been added) */
693 spin_lock_irqsave(&vis_hash_lock, flags);
695 vis_hash = hash_new(256, vis_info_cmp, vis_info_choose);
697 printk(KERN_ERR "batman-adv:Can't initialize vis_hash\n");
701 my_vis_info = kmalloc(1000, GFP_ATOMIC);
703 printk(KERN_ERR "batman-adv:Can't initialize vis packet\n");
707 /* prefill the vis info */
708 my_vis_info->first_seen = jiffies - atomic_read(&vis_interval);
709 INIT_LIST_HEAD(&my_vis_info->recv_list);
710 INIT_LIST_HEAD(&my_vis_info->send_list);
711 kref_init(&my_vis_info->refcount);
712 my_vis_info->packet.version = COMPAT_VERSION;
713 my_vis_info->packet.packet_type = BAT_VIS;
714 my_vis_info->packet.ttl = TTL;
715 my_vis_info->packet.seqno = 0;
716 my_vis_info->packet.entries = 0;
718 INIT_LIST_HEAD(&send_list);
720 memcpy(my_vis_info->packet.vis_orig, mainIfAddr, ETH_ALEN);
721 memcpy(my_vis_info->packet.sender_orig, mainIfAddr, ETH_ALEN);
723 if (hash_add(vis_hash, my_vis_info) < 0) {
725 "batman-adv:Can't add own vis packet into hash\n");
726 /* not in hash, need to remove it manually. */
727 kref_put(&my_vis_info->refcount, free_info);
731 spin_unlock_irqrestore(&vis_hash_lock, flags);
736 spin_unlock_irqrestore(&vis_hash_lock, flags);
741 /* Decrease the reference count on a hash item info */
742 static void free_info_ref(void *data)
744 struct vis_info *info = data;
747 kref_put(&info->refcount, free_info);
750 /* shutdown vis-server */
757 cancel_delayed_work_sync(&vis_timer_wq);
759 spin_lock_irqsave(&vis_hash_lock, flags);
760 /* properly remove, kill timers ... */
761 hash_delete(vis_hash, free_info_ref);
764 spin_unlock_irqrestore(&vis_hash_lock, flags);
767 /* schedule packets for (re)transmission */
768 static void start_vis_timer(void)
770 queue_delayed_work(bat_event_workqueue, &vis_timer_wq,
771 (atomic_read(&vis_interval) * HZ) / 1000);