1 /* Copyright (C) 2007-2015 B.A.T.M.A.N. contributors:
3 * Marek Lindner, Simon Wunderlich
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of version 2 of the GNU General Public
7 * License as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 #include <linux/atomic.h>
22 #include <linux/bitmap.h>
23 #include <linux/bitops.h>
24 #include <linux/bug.h>
25 #include <linux/byteorder/generic.h>
26 #include <linux/cache.h>
27 #include <linux/errno.h>
28 #include <linux/etherdevice.h>
30 #include <linux/if_ether.h>
31 #include <linux/init.h>
32 #include <linux/jiffies.h>
33 #include <linux/list.h>
34 #include <linux/netdevice.h>
35 #include <linux/pkt_sched.h>
36 #include <linux/printk.h>
37 #include <linux/random.h>
38 #include <linux/rculist.h>
39 #include <linux/rcupdate.h>
40 #include <linux/seq_file.h>
41 #include <linux/skbuff.h>
42 #include <linux/slab.h>
43 #include <linux/spinlock.h>
44 #include <linux/stddef.h>
45 #include <linux/string.h>
46 #include <linux/types.h>
47 #include <linux/workqueue.h>
50 #include "hard-interface.h"
52 #include "network-coding.h"
53 #include "originator.h"
57 #include "translation-table.h"
60 * enum batadv_dup_status - duplicate status
61 * @BATADV_NO_DUP: the packet is no duplicate
62 * @BATADV_ORIG_DUP: OGM is a duplicate in the originator (but not for the
64 * @BATADV_NEIGH_DUP: OGM is a duplicate for the neighbor
65 * @BATADV_PROTECTED: originator is currently protected (after reboot)
67 enum batadv_dup_status {
75 * batadv_ring_buffer_set - update the ring buffer with the given value
76 * @lq_recv: pointer to the ring buffer
77 * @lq_index: index to store the value at
78 * @value: value to store in the ring buffer
80 static void batadv_ring_buffer_set(u8 lq_recv[], u8 *lq_index, u8 value)
82 lq_recv[*lq_index] = value;
83 *lq_index = (*lq_index + 1) % BATADV_TQ_GLOBAL_WINDOW_SIZE;
87 * batadv_ring_buffer_avg - compute the average of all non-zero values stored
88 * in the given ring buffer
89 * @lq_recv: pointer to the ring buffer
91 * Returns computed average value.
93 static u8 batadv_ring_buffer_avg(const u8 lq_recv[])
102 while (i < BATADV_TQ_GLOBAL_WINDOW_SIZE) {
115 return (u8)(sum / count);
119 * batadv_iv_ogm_orig_free - free the private resources allocated for this
121 * @orig_node: the orig_node for which the resources have to be free'd
123 static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node)
125 kfree(orig_node->bat_iv.bcast_own);
126 kfree(orig_node->bat_iv.bcast_own_sum);
130 * batadv_iv_ogm_orig_add_if - change the private structures of the orig_node to
131 * include the new hard-interface
132 * @orig_node: the orig_node that has to be changed
133 * @max_if_num: the current amount of interfaces
135 * Returns 0 on success, a negative error code otherwise.
137 static int batadv_iv_ogm_orig_add_if(struct batadv_orig_node *orig_node,
138 unsigned int max_if_num)
144 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
146 old_size = (max_if_num - 1) * sizeof(unsigned long) * BATADV_NUM_WORDS;
147 data_ptr = kmalloc_array(max_if_num,
148 BATADV_NUM_WORDS * sizeof(unsigned long),
153 memcpy(data_ptr, orig_node->bat_iv.bcast_own, old_size);
154 kfree(orig_node->bat_iv.bcast_own);
155 orig_node->bat_iv.bcast_own = data_ptr;
157 data_ptr = kmalloc_array(max_if_num, sizeof(u8), GFP_ATOMIC);
161 memcpy(data_ptr, orig_node->bat_iv.bcast_own_sum,
162 (max_if_num - 1) * sizeof(u8));
163 kfree(orig_node->bat_iv.bcast_own_sum);
164 orig_node->bat_iv.bcast_own_sum = data_ptr;
169 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
175 * batadv_iv_ogm_orig_del_if - change the private structures of the orig_node to
176 * exclude the removed interface
177 * @orig_node: the orig_node that has to be changed
178 * @max_if_num: the current amount of interfaces
179 * @del_if_num: the index of the interface being removed
181 * Returns 0 on success, a negative error code otherwise.
183 static int batadv_iv_ogm_orig_del_if(struct batadv_orig_node *orig_node,
184 unsigned int max_if_num,
185 unsigned int del_if_num)
188 size_t chunk_size, if_offset;
189 void *data_ptr = NULL;
191 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
193 /* last interface was removed */
197 chunk_size = sizeof(unsigned long) * BATADV_NUM_WORDS;
198 data_ptr = kmalloc_array(max_if_num, chunk_size, GFP_ATOMIC);
202 /* copy first part */
203 memcpy(data_ptr, orig_node->bat_iv.bcast_own, del_if_num * chunk_size);
205 /* copy second part */
206 if_offset = (del_if_num + 1) * chunk_size;
207 memcpy((char *)data_ptr + del_if_num * chunk_size,
208 (uint8_t *)orig_node->bat_iv.bcast_own + if_offset,
209 (max_if_num - del_if_num) * chunk_size);
212 kfree(orig_node->bat_iv.bcast_own);
213 orig_node->bat_iv.bcast_own = data_ptr;
218 data_ptr = kmalloc_array(max_if_num, sizeof(u8), GFP_ATOMIC);
220 kfree(orig_node->bat_iv.bcast_own);
224 memcpy(data_ptr, orig_node->bat_iv.bcast_own_sum,
225 del_if_num * sizeof(u8));
227 if_offset = (del_if_num + 1) * sizeof(u8);
228 memcpy((char *)data_ptr + del_if_num * sizeof(u8),
229 orig_node->bat_iv.bcast_own_sum + if_offset,
230 (max_if_num - del_if_num) * sizeof(u8));
233 kfree(orig_node->bat_iv.bcast_own_sum);
234 orig_node->bat_iv.bcast_own_sum = data_ptr;
238 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
244 * batadv_iv_ogm_orig_get - retrieve or create (if does not exist) an originator
245 * @bat_priv: the bat priv with all the soft interface information
246 * @addr: mac address of the originator
248 * Returns the originator object corresponding to the passed mac address or NULL
250 * If the object does not exists it is created an initialised.
252 static struct batadv_orig_node *
253 batadv_iv_ogm_orig_get(struct batadv_priv *bat_priv, const u8 *addr)
255 struct batadv_orig_node *orig_node;
259 orig_node = batadv_orig_hash_find(bat_priv, addr);
263 orig_node = batadv_orig_node_new(bat_priv, addr);
267 spin_lock_init(&orig_node->bat_iv.ogm_cnt_lock);
269 size = bat_priv->num_ifaces * sizeof(unsigned long) * BATADV_NUM_WORDS;
270 orig_node->bat_iv.bcast_own = kzalloc(size, GFP_ATOMIC);
271 if (!orig_node->bat_iv.bcast_own)
274 size = bat_priv->num_ifaces * sizeof(u8);
275 orig_node->bat_iv.bcast_own_sum = kzalloc(size, GFP_ATOMIC);
276 if (!orig_node->bat_iv.bcast_own_sum)
279 hash_added = batadv_hash_add(bat_priv->orig_hash, batadv_compare_orig,
280 batadv_choose_orig, orig_node,
281 &orig_node->hash_entry);
288 /* free twice, as batadv_orig_node_new sets refcount to 2 */
289 batadv_orig_node_free_ref(orig_node);
290 batadv_orig_node_free_ref(orig_node);
295 static struct batadv_neigh_node *
296 batadv_iv_ogm_neigh_new(struct batadv_hard_iface *hard_iface,
297 const u8 *neigh_addr,
298 struct batadv_orig_node *orig_node,
299 struct batadv_orig_node *orig_neigh)
301 struct batadv_neigh_node *neigh_node;
303 neigh_node = batadv_neigh_node_new(orig_node, hard_iface, neigh_addr);
307 neigh_node->orig_node = orig_neigh;
313 static int batadv_iv_ogm_iface_enable(struct batadv_hard_iface *hard_iface)
315 struct batadv_ogm_packet *batadv_ogm_packet;
316 unsigned char *ogm_buff;
319 mutex_lock(&hard_iface->bat_iv.ogm_buff_mutex);
321 /* randomize initial seqno to avoid collision */
322 get_random_bytes(&random_seqno, sizeof(random_seqno));
323 atomic_set(&hard_iface->bat_iv.ogm_seqno, random_seqno);
325 hard_iface->bat_iv.ogm_buff_len = BATADV_OGM_HLEN;
326 ogm_buff = kmalloc(hard_iface->bat_iv.ogm_buff_len, GFP_ATOMIC);
328 mutex_unlock(&hard_iface->bat_iv.ogm_buff_mutex);
332 hard_iface->bat_iv.ogm_buff = ogm_buff;
334 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
335 batadv_ogm_packet->packet_type = BATADV_IV_OGM;
336 batadv_ogm_packet->version = BATADV_COMPAT_VERSION;
337 batadv_ogm_packet->ttl = 2;
338 batadv_ogm_packet->flags = BATADV_NO_FLAGS;
339 batadv_ogm_packet->reserved = 0;
340 batadv_ogm_packet->tq = BATADV_TQ_MAX_VALUE;
342 mutex_unlock(&hard_iface->bat_iv.ogm_buff_mutex);
347 static void batadv_iv_ogm_iface_disable(struct batadv_hard_iface *hard_iface)
349 mutex_lock(&hard_iface->bat_iv.ogm_buff_mutex);
351 kfree(hard_iface->bat_iv.ogm_buff);
352 hard_iface->bat_iv.ogm_buff = NULL;
354 mutex_unlock(&hard_iface->bat_iv.ogm_buff_mutex);
357 static void batadv_iv_ogm_iface_update_mac(struct batadv_hard_iface *hard_iface)
359 struct batadv_ogm_packet *batadv_ogm_packet;
362 mutex_lock(&hard_iface->bat_iv.ogm_buff_mutex);
364 ogm_buff = hard_iface->bat_iv.ogm_buff;
368 batadv_ogm_packet = ogm_buff;
369 ether_addr_copy(batadv_ogm_packet->orig,
370 hard_iface->net_dev->dev_addr);
371 ether_addr_copy(batadv_ogm_packet->prev_sender,
372 hard_iface->net_dev->dev_addr);
375 mutex_unlock(&hard_iface->bat_iv.ogm_buff_mutex);
379 batadv_iv_ogm_primary_iface_set(struct batadv_hard_iface *hard_iface)
381 struct batadv_ogm_packet *batadv_ogm_packet;
384 mutex_lock(&hard_iface->bat_iv.ogm_buff_mutex);
386 ogm_buff = hard_iface->bat_iv.ogm_buff;
390 batadv_ogm_packet = ogm_buff;
391 batadv_ogm_packet->flags = BATADV_PRIMARIES_FIRST_HOP;
392 batadv_ogm_packet->ttl = BATADV_TTL;
395 mutex_unlock(&hard_iface->bat_iv.ogm_buff_mutex);
398 /* when do we schedule our own ogm to be sent */
400 batadv_iv_ogm_emit_send_time(const struct batadv_priv *bat_priv)
404 msecs = atomic_read(&bat_priv->orig_interval) - BATADV_JITTER;
405 msecs += prandom_u32() % (2 * BATADV_JITTER);
407 return jiffies + msecs_to_jiffies(msecs);
410 /* when do we schedule a ogm packet to be sent */
411 static unsigned long batadv_iv_ogm_fwd_send_time(void)
413 return jiffies + msecs_to_jiffies(prandom_u32() % (BATADV_JITTER / 2));
416 /* apply hop penalty for a normal link */
417 static u8 batadv_hop_penalty(u8 tq, const struct batadv_priv *bat_priv)
419 int hop_penalty = atomic_read(&bat_priv->hop_penalty);
422 new_tq = tq * (BATADV_TQ_MAX_VALUE - hop_penalty);
423 new_tq /= BATADV_TQ_MAX_VALUE;
429 batadv_iv_ogm_aggr_packet(int buff_pos, int packet_len,
430 const struct batadv_ogm_packet *ogm_packet)
432 int next_buff_pos = 0;
434 /* check if there is enough space for the header */
435 next_buff_pos += buff_pos + sizeof(*ogm_packet);
436 if (next_buff_pos > packet_len)
439 /* check if there is enough space for the optional TVLV */
440 next_buff_pos += ntohs(ogm_packet->tvlv_len);
442 return (next_buff_pos <= packet_len) &&
443 (next_buff_pos <= BATADV_MAX_AGGREGATION_BYTES);
446 /* send a batman ogm to a given interface */
447 static void batadv_iv_ogm_send_to_if(struct batadv_forw_packet *forw_packet,
448 struct batadv_hard_iface *hard_iface)
450 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
454 struct batadv_ogm_packet *batadv_ogm_packet;
458 if (hard_iface->if_status != BATADV_IF_ACTIVE)
463 packet_pos = forw_packet->skb->data;
464 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
466 /* adjust all flags and log packets */
467 while (batadv_iv_ogm_aggr_packet(buff_pos, forw_packet->packet_len,
468 batadv_ogm_packet)) {
469 /* we might have aggregated direct link packets with an
470 * ordinary base packet
472 if (forw_packet->direct_link_flags & BIT(packet_num) &&
473 forw_packet->if_incoming == hard_iface)
474 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
476 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
478 if (packet_num > 0 || !forw_packet->own)
479 fwd_str = "Forwarding";
481 fwd_str = "Sending own";
483 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
484 "%s %spacket (originator %pM, seqno %u, TQ %d, TTL %d, IDF %s) on interface %s [%pM]\n",
485 fwd_str, (packet_num > 0 ? "aggregated " : ""),
486 batadv_ogm_packet->orig,
487 ntohl(batadv_ogm_packet->seqno),
488 batadv_ogm_packet->tq, batadv_ogm_packet->ttl,
489 ((batadv_ogm_packet->flags & BATADV_DIRECTLINK) ?
491 hard_iface->net_dev->name,
492 hard_iface->net_dev->dev_addr);
494 buff_pos += BATADV_OGM_HLEN;
495 buff_pos += ntohs(batadv_ogm_packet->tvlv_len);
497 packet_pos = forw_packet->skb->data + buff_pos;
498 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
501 /* create clone because function is called more than once */
502 skb = skb_clone(forw_packet->skb, GFP_ATOMIC);
504 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_TX);
505 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_TX_BYTES,
506 skb->len + ETH_HLEN);
507 batadv_send_skb_packet(skb, hard_iface, batadv_broadcast_addr);
511 /* send a batman ogm packet */
512 static void batadv_iv_ogm_emit(struct batadv_forw_packet *forw_packet)
514 struct net_device *soft_iface;
515 struct batadv_priv *bat_priv;
516 struct batadv_hard_iface *primary_if = NULL;
518 if (!forw_packet->if_incoming) {
519 pr_err("Error - can't forward packet: incoming iface not specified\n");
523 soft_iface = forw_packet->if_incoming->soft_iface;
524 bat_priv = netdev_priv(soft_iface);
526 if (WARN_ON(!forw_packet->if_outgoing))
529 if (WARN_ON(forw_packet->if_outgoing->soft_iface != soft_iface))
532 if (forw_packet->if_incoming->if_status != BATADV_IF_ACTIVE)
535 primary_if = batadv_primary_if_get_selected(bat_priv);
539 /* only for one specific outgoing interface */
540 batadv_iv_ogm_send_to_if(forw_packet, forw_packet->if_outgoing);
544 batadv_hardif_free_ref(primary_if);
548 * batadv_iv_ogm_can_aggregate - find out if an OGM can be aggregated on an
549 * existing forward packet
550 * @new_bat_ogm_packet: OGM packet to be aggregated
551 * @bat_priv: the bat priv with all the soft interface information
552 * @packet_len: (total) length of the OGM
553 * @send_time: timestamp (jiffies) when the packet is to be sent
554 * @directlink: true if this is a direct link packet
555 * @if_incoming: interface where the packet was received
556 * @if_outgoing: interface for which the retransmission should be considered
557 * @forw_packet: the forwarded packet which should be checked
559 * Returns true if new_packet can be aggregated with forw_packet
562 batadv_iv_ogm_can_aggregate(const struct batadv_ogm_packet *new_bat_ogm_packet,
563 struct batadv_priv *bat_priv,
564 int packet_len, unsigned long send_time,
566 const struct batadv_hard_iface *if_incoming,
567 const struct batadv_hard_iface *if_outgoing,
568 const struct batadv_forw_packet *forw_packet)
570 struct batadv_ogm_packet *batadv_ogm_packet;
571 int aggregated_bytes = forw_packet->packet_len + packet_len;
572 struct batadv_hard_iface *primary_if = NULL;
574 unsigned long aggregation_end_time;
576 batadv_ogm_packet = (struct batadv_ogm_packet *)forw_packet->skb->data;
577 aggregation_end_time = send_time;
578 aggregation_end_time += msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
580 /* we can aggregate the current packet to this aggregated packet
583 * - the send time is within our MAX_AGGREGATION_MS time
584 * - the resulting packet wont be bigger than
585 * MAX_AGGREGATION_BYTES
586 * otherwise aggregation is not possible
588 if (!time_before(send_time, forw_packet->send_time) ||
589 !time_after_eq(aggregation_end_time, forw_packet->send_time))
592 if (aggregated_bytes > BATADV_MAX_AGGREGATION_BYTES)
595 /* packet is not leaving on the same interface. */
596 if (forw_packet->if_outgoing != if_outgoing)
599 /* check aggregation compatibility
600 * -> direct link packets are broadcasted on
601 * their interface only
602 * -> aggregate packet if the current packet is
603 * a "global" packet as well as the base
606 primary_if = batadv_primary_if_get_selected(bat_priv);
610 /* packets without direct link flag and high TTL
611 * are flooded through the net
614 !(batadv_ogm_packet->flags & BATADV_DIRECTLINK) &&
615 batadv_ogm_packet->ttl != 1 &&
617 /* own packets originating non-primary
618 * interfaces leave only that interface
620 (!forw_packet->own ||
621 forw_packet->if_incoming == primary_if)) {
626 /* if the incoming packet is sent via this one
627 * interface only - we still can aggregate
630 new_bat_ogm_packet->ttl == 1 &&
631 forw_packet->if_incoming == if_incoming &&
633 /* packets from direct neighbors or
634 * own secondary interface packets
635 * (= secondary interface packets in general)
637 (batadv_ogm_packet->flags & BATADV_DIRECTLINK ||
639 forw_packet->if_incoming != primary_if))) {
646 batadv_hardif_free_ref(primary_if);
651 * batadv_iv_ogm_aggregate_new - create a new aggregated packet and add this
653 * @packet_buff: pointer to the OGM
654 * @packet_len: (total) length of the OGM
655 * @send_time: timestamp (jiffies) when the packet is to be sent
656 * @direct_link: whether this OGM has direct link status
657 * @if_incoming: interface where the packet was received
658 * @if_outgoing: interface for which the retransmission should be considered
659 * @own_packet: true if it is a self-generated ogm
661 static void batadv_iv_ogm_aggregate_new(const unsigned char *packet_buff,
662 int packet_len, unsigned long send_time,
664 struct batadv_hard_iface *if_incoming,
665 struct batadv_hard_iface *if_outgoing,
668 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
669 struct batadv_forw_packet *forw_packet_aggr;
670 unsigned char *skb_buff;
671 unsigned int skb_size;
673 if (!atomic_inc_not_zero(&if_incoming->refcount))
676 if (!atomic_inc_not_zero(&if_outgoing->refcount))
677 goto out_free_incoming;
679 /* own packet should always be scheduled */
681 if (!batadv_atomic_dec_not_zero(&bat_priv->batman_queue_left)) {
682 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
683 "batman packet queue full\n");
684 goto out_free_outgoing;
688 forw_packet_aggr = kmalloc(sizeof(*forw_packet_aggr), GFP_ATOMIC);
689 if (!forw_packet_aggr)
692 if (atomic_read(&bat_priv->aggregated_ogms) &&
693 packet_len < BATADV_MAX_AGGREGATION_BYTES)
694 skb_size = BATADV_MAX_AGGREGATION_BYTES;
696 skb_size = packet_len;
698 skb_size += ETH_HLEN;
700 forw_packet_aggr->skb = netdev_alloc_skb_ip_align(NULL, skb_size);
701 if (!forw_packet_aggr->skb)
702 goto out_free_forw_packet;
703 forw_packet_aggr->skb->priority = TC_PRIO_CONTROL;
704 skb_reserve(forw_packet_aggr->skb, ETH_HLEN);
706 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
707 forw_packet_aggr->packet_len = packet_len;
708 memcpy(skb_buff, packet_buff, packet_len);
710 forw_packet_aggr->own = own_packet;
711 forw_packet_aggr->if_incoming = if_incoming;
712 forw_packet_aggr->if_outgoing = if_outgoing;
713 forw_packet_aggr->num_packets = 0;
714 forw_packet_aggr->direct_link_flags = BATADV_NO_FLAGS;
715 forw_packet_aggr->send_time = send_time;
717 /* save packet direct link flag status */
719 forw_packet_aggr->direct_link_flags |= 1;
721 /* add new packet to packet list */
722 spin_lock_bh(&bat_priv->forw_bat_list_lock);
723 hlist_add_head(&forw_packet_aggr->list, &bat_priv->forw_bat_list);
724 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
726 /* start timer for this packet */
727 INIT_DELAYED_WORK(&forw_packet_aggr->delayed_work,
728 batadv_send_outstanding_bat_ogm_packet);
729 queue_delayed_work(batadv_event_workqueue,
730 &forw_packet_aggr->delayed_work,
731 send_time - jiffies);
734 out_free_forw_packet:
735 kfree(forw_packet_aggr);
738 atomic_inc(&bat_priv->batman_queue_left);
740 batadv_hardif_free_ref(if_outgoing);
742 batadv_hardif_free_ref(if_incoming);
745 /* aggregate a new packet into the existing ogm packet */
746 static void batadv_iv_ogm_aggregate(struct batadv_forw_packet *forw_packet_aggr,
747 const unsigned char *packet_buff,
748 int packet_len, bool direct_link)
750 unsigned char *skb_buff;
751 unsigned long new_direct_link_flag;
753 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
754 memcpy(skb_buff, packet_buff, packet_len);
755 forw_packet_aggr->packet_len += packet_len;
756 forw_packet_aggr->num_packets++;
758 /* save packet direct link flag status */
760 new_direct_link_flag = BIT(forw_packet_aggr->num_packets);
761 forw_packet_aggr->direct_link_flags |= new_direct_link_flag;
766 * batadv_iv_ogm_queue_add - queue up an OGM for transmission
767 * @bat_priv: the bat priv with all the soft interface information
768 * @packet_buff: pointer to the OGM
769 * @packet_len: (total) length of the OGM
770 * @if_incoming: interface where the packet was received
771 * @if_outgoing: interface for which the retransmission should be considered
772 * @own_packet: true if it is a self-generated ogm
773 * @send_time: timestamp (jiffies) when the packet is to be sent
775 static void batadv_iv_ogm_queue_add(struct batadv_priv *bat_priv,
776 unsigned char *packet_buff,
778 struct batadv_hard_iface *if_incoming,
779 struct batadv_hard_iface *if_outgoing,
780 int own_packet, unsigned long send_time)
782 /* _aggr -> pointer to the packet we want to aggregate with
783 * _pos -> pointer to the position in the queue
785 struct batadv_forw_packet *forw_packet_aggr = NULL;
786 struct batadv_forw_packet *forw_packet_pos = NULL;
787 struct batadv_ogm_packet *batadv_ogm_packet;
789 unsigned long max_aggregation_jiffies;
791 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_buff;
792 direct_link = !!(batadv_ogm_packet->flags & BATADV_DIRECTLINK);
793 max_aggregation_jiffies = msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
795 /* find position for the packet in the forward queue */
796 spin_lock_bh(&bat_priv->forw_bat_list_lock);
797 /* own packets are not to be aggregated */
798 if (atomic_read(&bat_priv->aggregated_ogms) && !own_packet) {
799 hlist_for_each_entry(forw_packet_pos,
800 &bat_priv->forw_bat_list, list) {
801 if (batadv_iv_ogm_can_aggregate(batadv_ogm_packet,
802 bat_priv, packet_len,
803 send_time, direct_link,
807 forw_packet_aggr = forw_packet_pos;
813 /* nothing to aggregate with - either aggregation disabled or no
814 * suitable aggregation packet found
816 if (!forw_packet_aggr) {
817 /* the following section can run without the lock */
818 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
820 /* if we could not aggregate this packet with one of the others
821 * we hold it back for a while, so that it might be aggregated
824 if (!own_packet && atomic_read(&bat_priv->aggregated_ogms))
825 send_time += max_aggregation_jiffies;
827 batadv_iv_ogm_aggregate_new(packet_buff, packet_len,
828 send_time, direct_link,
829 if_incoming, if_outgoing,
832 batadv_iv_ogm_aggregate(forw_packet_aggr, packet_buff,
833 packet_len, direct_link);
834 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
838 static void batadv_iv_ogm_forward(struct batadv_orig_node *orig_node,
839 const struct ethhdr *ethhdr,
840 struct batadv_ogm_packet *batadv_ogm_packet,
841 bool is_single_hop_neigh,
842 bool is_from_best_next_hop,
843 struct batadv_hard_iface *if_incoming,
844 struct batadv_hard_iface *if_outgoing)
846 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
849 if (batadv_ogm_packet->ttl <= 1) {
850 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "ttl exceeded\n");
854 if (!is_from_best_next_hop) {
855 /* Mark the forwarded packet when it is not coming from our
856 * best next hop. We still need to forward the packet for our
857 * neighbor link quality detection to work in case the packet
858 * originated from a single hop neighbor. Otherwise we can
859 * simply drop the ogm.
861 if (is_single_hop_neigh)
862 batadv_ogm_packet->flags |= BATADV_NOT_BEST_NEXT_HOP;
867 tvlv_len = ntohs(batadv_ogm_packet->tvlv_len);
869 batadv_ogm_packet->ttl--;
870 ether_addr_copy(batadv_ogm_packet->prev_sender, ethhdr->h_source);
872 /* apply hop penalty */
873 batadv_ogm_packet->tq = batadv_hop_penalty(batadv_ogm_packet->tq,
876 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
877 "Forwarding packet: tq: %i, ttl: %i\n",
878 batadv_ogm_packet->tq, batadv_ogm_packet->ttl);
880 /* switch of primaries first hop flag when forwarding */
881 batadv_ogm_packet->flags &= ~BATADV_PRIMARIES_FIRST_HOP;
882 if (is_single_hop_neigh)
883 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
885 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
887 batadv_iv_ogm_queue_add(bat_priv, (unsigned char *)batadv_ogm_packet,
888 BATADV_OGM_HLEN + tvlv_len,
889 if_incoming, if_outgoing, 0,
890 batadv_iv_ogm_fwd_send_time());
894 * batadv_iv_ogm_slide_own_bcast_window - bitshift own OGM broadcast windows for
895 * the given interface
896 * @hard_iface: the interface for which the windows have to be shifted
899 batadv_iv_ogm_slide_own_bcast_window(struct batadv_hard_iface *hard_iface)
901 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
902 struct batadv_hashtable *hash = bat_priv->orig_hash;
903 struct hlist_head *head;
904 struct batadv_orig_node *orig_node;
911 for (i = 0; i < hash->size; i++) {
912 head = &hash->table[i];
915 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
916 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
917 word_index = hard_iface->if_num * BATADV_NUM_WORDS;
918 word = &orig_node->bat_iv.bcast_own[word_index];
920 batadv_bit_get_packet(bat_priv, word, 1, 0);
921 if_num = hard_iface->if_num;
922 w = &orig_node->bat_iv.bcast_own_sum[if_num];
923 *w = bitmap_weight(word, BATADV_TQ_LOCAL_WINDOW_SIZE);
924 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
931 * batadv_iv_ogm_schedule_buff() - schedule submission of hardif ogm buffer
932 * @hard_iface: interface whose ogm buffer should be transmitted
934 static void batadv_iv_ogm_schedule_buff(struct batadv_hard_iface *hard_iface)
936 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
937 unsigned char **ogm_buff = &hard_iface->bat_iv.ogm_buff;
938 struct batadv_ogm_packet *batadv_ogm_packet;
939 struct batadv_hard_iface *primary_if, *tmp_hard_iface;
940 int *ogm_buff_len = &hard_iface->bat_iv.ogm_buff_len;
943 unsigned long send_time;
945 lockdep_assert_held(&hard_iface->bat_iv.ogm_buff_mutex);
947 /* interface already disabled by batadv_iv_ogm_iface_disable */
951 primary_if = batadv_primary_if_get_selected(bat_priv);
953 if (hard_iface == primary_if) {
954 /* tt changes have to be committed before the tvlv data is
955 * appended as it may alter the tt tvlv container
957 batadv_tt_local_commit_changes(bat_priv);
958 tvlv_len = batadv_tvlv_container_ogm_append(bat_priv, ogm_buff,
963 batadv_ogm_packet = (struct batadv_ogm_packet *)(*ogm_buff);
964 batadv_ogm_packet->tvlv_len = htons(tvlv_len);
966 /* change sequence number to network order */
967 seqno = (u32)atomic_read(&hard_iface->bat_iv.ogm_seqno);
968 batadv_ogm_packet->seqno = htonl(seqno);
969 atomic_inc(&hard_iface->bat_iv.ogm_seqno);
971 batadv_iv_ogm_slide_own_bcast_window(hard_iface);
973 send_time = batadv_iv_ogm_emit_send_time(bat_priv);
975 if (hard_iface != primary_if) {
976 /* OGMs from secondary interfaces are only scheduled on their
977 * respective interfaces.
979 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff, *ogm_buff_len,
980 hard_iface, hard_iface, 1, send_time);
984 /* OGMs from primary interfaces are scheduled on all
988 list_for_each_entry_rcu(tmp_hard_iface, &batadv_hardif_list, list) {
989 if (tmp_hard_iface->soft_iface != hard_iface->soft_iface)
991 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff,
992 *ogm_buff_len, hard_iface,
993 tmp_hard_iface, 1, send_time);
999 batadv_hardif_free_ref(primary_if);
1002 static void batadv_iv_ogm_schedule(struct batadv_hard_iface *hard_iface)
1004 if (hard_iface->if_status == BATADV_IF_NOT_IN_USE ||
1005 hard_iface->if_status == BATADV_IF_TO_BE_REMOVED)
1008 mutex_lock(&hard_iface->bat_iv.ogm_buff_mutex);
1009 batadv_iv_ogm_schedule_buff(hard_iface);
1010 mutex_unlock(&hard_iface->bat_iv.ogm_buff_mutex);
1014 * batadv_iv_ogm_orig_update - use OGM to update corresponding data in an
1016 * @bat_priv: the bat priv with all the soft interface information
1017 * @orig_node: the orig node who originally emitted the ogm packet
1018 * @orig_ifinfo: ifinfo for the outgoing interface of the orig_node
1019 * @ethhdr: Ethernet header of the OGM
1020 * @batadv_ogm_packet: the ogm packet
1021 * @if_incoming: interface where the packet was received
1022 * @if_outgoing: interface for which the retransmission should be considered
1023 * @dup_status: the duplicate status of this ogm packet.
1026 batadv_iv_ogm_orig_update(struct batadv_priv *bat_priv,
1027 struct batadv_orig_node *orig_node,
1028 struct batadv_orig_ifinfo *orig_ifinfo,
1029 const struct ethhdr *ethhdr,
1030 const struct batadv_ogm_packet *batadv_ogm_packet,
1031 struct batadv_hard_iface *if_incoming,
1032 struct batadv_hard_iface *if_outgoing,
1033 enum batadv_dup_status dup_status)
1035 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL;
1036 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
1037 struct batadv_neigh_node *neigh_node = NULL;
1038 struct batadv_neigh_node *tmp_neigh_node = NULL;
1039 struct batadv_neigh_node *router = NULL;
1040 struct batadv_orig_node *orig_node_tmp;
1041 unsigned int if_num;
1042 u8 sum_orig, sum_neigh;
1046 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1047 "update_originator(): Searching and updating originator entry of received packet\n");
1050 hlist_for_each_entry_rcu(tmp_neigh_node,
1051 &orig_node->neigh_list, list) {
1052 neigh_addr = tmp_neigh_node->addr;
1053 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1054 tmp_neigh_node->if_incoming == if_incoming &&
1055 atomic_inc_not_zero(&tmp_neigh_node->refcount)) {
1056 if (WARN(neigh_node, "too many matching neigh_nodes"))
1057 batadv_neigh_node_free_ref(neigh_node);
1058 neigh_node = tmp_neigh_node;
1062 if (dup_status != BATADV_NO_DUP)
1065 /* only update the entry for this outgoing interface */
1066 neigh_ifinfo = batadv_neigh_ifinfo_get(tmp_neigh_node,
1071 spin_lock_bh(&tmp_neigh_node->ifinfo_lock);
1072 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1073 &neigh_ifinfo->bat_iv.tq_index, 0);
1074 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1075 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1076 spin_unlock_bh(&tmp_neigh_node->ifinfo_lock);
1078 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1079 neigh_ifinfo = NULL;
1083 struct batadv_orig_node *orig_tmp;
1085 orig_tmp = batadv_iv_ogm_orig_get(bat_priv, ethhdr->h_source);
1089 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1091 orig_node, orig_tmp);
1093 batadv_orig_node_free_ref(orig_tmp);
1097 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1098 "Updating existing last-hop neighbor of originator\n");
1102 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1106 neigh_node->last_seen = jiffies;
1108 spin_lock_bh(&neigh_node->ifinfo_lock);
1109 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1110 &neigh_ifinfo->bat_iv.tq_index,
1111 batadv_ogm_packet->tq);
1112 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1113 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1114 spin_unlock_bh(&neigh_node->ifinfo_lock);
1116 if (dup_status == BATADV_NO_DUP) {
1117 orig_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1118 neigh_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1121 /* if this neighbor already is our next hop there is nothing
1124 router = batadv_orig_router_get(orig_node, if_outgoing);
1125 if (router == neigh_node)
1129 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1133 /* if this neighbor does not offer a better TQ we won't
1136 if (router_ifinfo->bat_iv.tq_avg > neigh_ifinfo->bat_iv.tq_avg)
1140 /* if the TQ is the same and the link not more symmetric we
1141 * won't consider it either
1143 if (router_ifinfo &&
1144 neigh_ifinfo->bat_iv.tq_avg == router_ifinfo->bat_iv.tq_avg) {
1145 orig_node_tmp = router->orig_node;
1146 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1147 if_num = router->if_incoming->if_num;
1148 sum_orig = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1149 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1151 orig_node_tmp = neigh_node->orig_node;
1152 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1153 if_num = neigh_node->if_incoming->if_num;
1154 sum_neigh = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1155 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1157 if (sum_orig >= sum_neigh)
1161 batadv_update_route(bat_priv, orig_node, if_outgoing, neigh_node);
1168 batadv_neigh_node_free_ref(neigh_node);
1170 batadv_neigh_node_free_ref(router);
1172 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1174 batadv_neigh_ifinfo_free_ref(router_ifinfo);
1178 * batadv_iv_ogm_calc_tq - calculate tq for current received ogm packet
1179 * @orig_node: the orig node who originally emitted the ogm packet
1180 * @orig_neigh_node: the orig node struct of the neighbor who sent the packet
1181 * @batadv_ogm_packet: the ogm packet
1182 * @if_incoming: interface where the packet was received
1183 * @if_outgoing: interface for which the retransmission should be considered
1185 * Returns 1 if the link can be considered bidirectional, 0 otherwise
1187 static int batadv_iv_ogm_calc_tq(struct batadv_orig_node *orig_node,
1188 struct batadv_orig_node *orig_neigh_node,
1189 struct batadv_ogm_packet *batadv_ogm_packet,
1190 struct batadv_hard_iface *if_incoming,
1191 struct batadv_hard_iface *if_outgoing)
1193 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1194 struct batadv_neigh_node *neigh_node = NULL, *tmp_neigh_node;
1195 struct batadv_neigh_ifinfo *neigh_ifinfo;
1197 u8 orig_eq_count, neigh_rq_count, neigh_rq_inv, tq_own;
1198 unsigned int neigh_rq_inv_cube, neigh_rq_max_cube;
1199 int if_num, ret = 0;
1200 unsigned int tq_asym_penalty, inv_asym_penalty;
1201 unsigned int combined_tq;
1202 unsigned int tq_iface_penalty;
1204 /* find corresponding one hop neighbor */
1206 hlist_for_each_entry_rcu(tmp_neigh_node,
1207 &orig_neigh_node->neigh_list, list) {
1208 if (!batadv_compare_eth(tmp_neigh_node->addr,
1209 orig_neigh_node->orig))
1212 if (tmp_neigh_node->if_incoming != if_incoming)
1215 if (!atomic_inc_not_zero(&tmp_neigh_node->refcount))
1218 neigh_node = tmp_neigh_node;
1224 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1225 orig_neigh_node->orig,
1232 /* if orig_node is direct neighbor update neigh_node last_seen */
1233 if (orig_node == orig_neigh_node)
1234 neigh_node->last_seen = jiffies;
1236 orig_node->last_seen = jiffies;
1238 /* find packet count of corresponding one hop neighbor */
1239 spin_lock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1240 if_num = if_incoming->if_num;
1241 orig_eq_count = orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1242 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1244 neigh_rq_count = neigh_ifinfo->bat_iv.real_packet_count;
1245 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1249 spin_unlock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1251 /* pay attention to not get a value bigger than 100 % */
1252 if (orig_eq_count > neigh_rq_count)
1253 total_count = neigh_rq_count;
1255 total_count = orig_eq_count;
1257 /* if we have too few packets (too less data) we set tq_own to zero
1258 * if we receive too few packets it is not considered bidirectional
1260 if (total_count < BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM ||
1261 neigh_rq_count < BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM)
1264 /* neigh_node->real_packet_count is never zero as we
1265 * only purge old information when getting new
1268 tq_own = (BATADV_TQ_MAX_VALUE * total_count) / neigh_rq_count;
1270 /* 1 - ((1-x) ** 3), normalized to TQ_MAX_VALUE this does
1271 * affect the nearly-symmetric links only a little, but
1272 * punishes asymmetric links more. This will give a value
1273 * between 0 and TQ_MAX_VALUE
1275 neigh_rq_inv = BATADV_TQ_LOCAL_WINDOW_SIZE - neigh_rq_count;
1276 neigh_rq_inv_cube = neigh_rq_inv * neigh_rq_inv * neigh_rq_inv;
1277 neigh_rq_max_cube = BATADV_TQ_LOCAL_WINDOW_SIZE *
1278 BATADV_TQ_LOCAL_WINDOW_SIZE *
1279 BATADV_TQ_LOCAL_WINDOW_SIZE;
1280 inv_asym_penalty = BATADV_TQ_MAX_VALUE * neigh_rq_inv_cube;
1281 inv_asym_penalty /= neigh_rq_max_cube;
1282 tq_asym_penalty = BATADV_TQ_MAX_VALUE - inv_asym_penalty;
1284 /* penalize if the OGM is forwarded on the same interface. WiFi
1285 * interfaces and other half duplex devices suffer from throughput
1286 * drops as they can't send and receive at the same time.
1288 tq_iface_penalty = BATADV_TQ_MAX_VALUE;
1289 if (if_outgoing && (if_incoming == if_outgoing) &&
1290 batadv_is_wifi_netdev(if_outgoing->net_dev))
1291 tq_iface_penalty = batadv_hop_penalty(BATADV_TQ_MAX_VALUE,
1294 combined_tq = batadv_ogm_packet->tq *
1298 combined_tq /= BATADV_TQ_MAX_VALUE *
1299 BATADV_TQ_MAX_VALUE *
1300 BATADV_TQ_MAX_VALUE;
1301 batadv_ogm_packet->tq = combined_tq;
1303 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1304 "bidirectional: orig = %-15pM neigh = %-15pM => own_bcast = %2i, real recv = %2i, local tq: %3i, asym_penalty: %3i, iface_penalty: %3i, total tq: %3i, if_incoming = %s, if_outgoing = %s\n",
1305 orig_node->orig, orig_neigh_node->orig, total_count,
1306 neigh_rq_count, tq_own, tq_asym_penalty, tq_iface_penalty,
1307 batadv_ogm_packet->tq, if_incoming->net_dev->name,
1308 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT");
1310 /* if link has the minimum required transmission quality
1311 * consider it bidirectional
1313 if (batadv_ogm_packet->tq >= BATADV_TQ_TOTAL_BIDRECT_LIMIT)
1318 batadv_neigh_node_free_ref(neigh_node);
1323 * batadv_iv_ogm_update_seqnos - process a batman packet for all interfaces,
1324 * adjust the sequence number and find out whether it is a duplicate
1325 * @ethhdr: ethernet header of the packet
1326 * @batadv_ogm_packet: OGM packet to be considered
1327 * @if_incoming: interface on which the OGM packet was received
1328 * @if_outgoing: interface for which the retransmission should be considered
1330 * Returns duplicate status as enum batadv_dup_status
1332 static enum batadv_dup_status
1333 batadv_iv_ogm_update_seqnos(const struct ethhdr *ethhdr,
1334 const struct batadv_ogm_packet *batadv_ogm_packet,
1335 const struct batadv_hard_iface *if_incoming,
1336 struct batadv_hard_iface *if_outgoing)
1338 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1339 struct batadv_orig_node *orig_node;
1340 struct batadv_orig_ifinfo *orig_ifinfo = NULL;
1341 struct batadv_neigh_node *neigh_node;
1342 struct batadv_neigh_ifinfo *neigh_ifinfo;
1345 int need_update = 0;
1347 enum batadv_dup_status ret = BATADV_NO_DUP;
1348 u32 seqno = ntohl(batadv_ogm_packet->seqno);
1351 unsigned long *bitmap;
1353 orig_node = batadv_iv_ogm_orig_get(bat_priv, batadv_ogm_packet->orig);
1355 return BATADV_NO_DUP;
1357 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1358 if (WARN_ON(!orig_ifinfo)) {
1359 batadv_orig_node_free_ref(orig_node);
1363 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1364 seq_diff = seqno - orig_ifinfo->last_real_seqno;
1366 /* signalize caller that the packet is to be dropped. */
1367 if (!hlist_empty(&orig_node->neigh_list) &&
1368 batadv_window_protected(bat_priv, seq_diff,
1369 &orig_ifinfo->batman_seqno_reset)) {
1370 ret = BATADV_PROTECTED;
1375 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1376 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node,
1381 neigh_addr = neigh_node->addr;
1382 is_dup = batadv_test_bit(neigh_ifinfo->bat_iv.real_bits,
1383 orig_ifinfo->last_real_seqno,
1386 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1387 neigh_node->if_incoming == if_incoming) {
1390 ret = BATADV_NEIGH_DUP;
1393 if (is_dup && (ret != BATADV_NEIGH_DUP))
1394 ret = BATADV_ORIG_DUP;
1397 /* if the window moved, set the update flag. */
1398 bitmap = neigh_ifinfo->bat_iv.real_bits;
1399 need_update |= batadv_bit_get_packet(bat_priv, bitmap,
1400 seq_diff, set_mark);
1402 packet_count = bitmap_weight(bitmap,
1403 BATADV_TQ_LOCAL_WINDOW_SIZE);
1404 neigh_ifinfo->bat_iv.real_packet_count = packet_count;
1405 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1410 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1411 "%s updating last_seqno: old %u, new %u\n",
1412 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT",
1413 orig_ifinfo->last_real_seqno, seqno);
1414 orig_ifinfo->last_real_seqno = seqno;
1418 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1419 batadv_orig_node_free_ref(orig_node);
1420 batadv_orig_ifinfo_free_ref(orig_ifinfo);
1425 * batadv_iv_ogm_process_per_outif - process a batman iv OGM for an outgoing if
1426 * @skb: the skb containing the OGM
1427 * @ogm_offset: offset from skb->data to start of ogm header
1428 * @orig_node: the (cached) orig node for the originator of this OGM
1429 * @if_incoming: the interface where this packet was received
1430 * @if_outgoing: the interface for which the packet should be considered
1433 batadv_iv_ogm_process_per_outif(const struct sk_buff *skb, int ogm_offset,
1434 struct batadv_orig_node *orig_node,
1435 struct batadv_hard_iface *if_incoming,
1436 struct batadv_hard_iface *if_outgoing)
1438 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1439 struct batadv_neigh_node *router = NULL;
1440 struct batadv_neigh_node *router_router = NULL;
1441 struct batadv_orig_node *orig_neigh_node;
1442 struct batadv_orig_ifinfo *orig_ifinfo;
1443 struct batadv_neigh_node *orig_neigh_router = NULL;
1444 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
1445 struct batadv_ogm_packet *ogm_packet;
1446 enum batadv_dup_status dup_status;
1447 bool is_from_best_next_hop = false;
1448 bool is_single_hop_neigh = false;
1449 bool sameseq, similar_ttl;
1450 struct sk_buff *skb_priv;
1451 struct ethhdr *ethhdr;
1455 /* create a private copy of the skb, as some functions change tq value
1458 skb_priv = skb_copy(skb, GFP_ATOMIC);
1462 ethhdr = eth_hdr(skb_priv);
1463 ogm_packet = (struct batadv_ogm_packet *)(skb_priv->data + ogm_offset);
1465 dup_status = batadv_iv_ogm_update_seqnos(ethhdr, ogm_packet,
1466 if_incoming, if_outgoing);
1467 if (batadv_compare_eth(ethhdr->h_source, ogm_packet->orig))
1468 is_single_hop_neigh = true;
1470 if (dup_status == BATADV_PROTECTED) {
1471 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1472 "Drop packet: packet within seqno protection time (sender: %pM)\n",
1477 if (ogm_packet->tq == 0) {
1478 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1479 "Drop packet: originator packet with tq equal 0\n");
1483 router = batadv_orig_router_get(orig_node, if_outgoing);
1485 router_router = batadv_orig_router_get(router->orig_node,
1487 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1490 if ((router_ifinfo && router_ifinfo->bat_iv.tq_avg != 0) &&
1491 (batadv_compare_eth(router->addr, ethhdr->h_source)))
1492 is_from_best_next_hop = true;
1494 prev_sender = ogm_packet->prev_sender;
1495 /* avoid temporary routing loops */
1496 if (router && router_router &&
1497 (batadv_compare_eth(router->addr, prev_sender)) &&
1498 !(batadv_compare_eth(ogm_packet->orig, prev_sender)) &&
1499 (batadv_compare_eth(router->addr, router_router->addr))) {
1500 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1501 "Drop packet: ignoring all rebroadcast packets that may make me loop (sender: %pM)\n",
1506 if (if_outgoing == BATADV_IF_DEFAULT)
1507 batadv_tvlv_ogm_receive(bat_priv, ogm_packet, orig_node);
1509 /* if sender is a direct neighbor the sender mac equals
1512 if (is_single_hop_neigh)
1513 orig_neigh_node = orig_node;
1515 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1518 if (!orig_neigh_node)
1521 /* Update nc_nodes of the originator */
1522 batadv_nc_update_nc_node(bat_priv, orig_node, orig_neigh_node,
1523 ogm_packet, is_single_hop_neigh);
1525 orig_neigh_router = batadv_orig_router_get(orig_neigh_node,
1528 /* drop packet if sender is not a direct neighbor and if we
1529 * don't route towards it
1531 if (!is_single_hop_neigh && (!orig_neigh_router)) {
1532 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1533 "Drop packet: OGM via unknown neighbor!\n");
1537 is_bidirect = batadv_iv_ogm_calc_tq(orig_node, orig_neigh_node,
1538 ogm_packet, if_incoming,
1541 /* update ranking if it is not a duplicate or has the same
1542 * seqno and similar ttl as the non-duplicate
1544 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1548 sameseq = orig_ifinfo->last_real_seqno == ntohl(ogm_packet->seqno);
1549 similar_ttl = (orig_ifinfo->last_ttl - 3) <= ogm_packet->ttl;
1551 if (is_bidirect && ((dup_status == BATADV_NO_DUP) ||
1552 (sameseq && similar_ttl))) {
1553 batadv_iv_ogm_orig_update(bat_priv, orig_node,
1554 orig_ifinfo, ethhdr,
1555 ogm_packet, if_incoming,
1556 if_outgoing, dup_status);
1558 batadv_orig_ifinfo_free_ref(orig_ifinfo);
1560 /* only forward for specific interface, not for the default one. */
1561 if (if_outgoing == BATADV_IF_DEFAULT)
1564 /* is single hop (direct) neighbor */
1565 if (is_single_hop_neigh) {
1566 /* OGMs from secondary interfaces should only scheduled once
1567 * per interface where it has been received, not multiple times
1569 if ((ogm_packet->ttl <= 2) &&
1570 (if_incoming != if_outgoing)) {
1571 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1572 "Drop packet: OGM from secondary interface and wrong outgoing interface\n");
1575 /* mark direct link on incoming interface */
1576 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1577 is_single_hop_neigh,
1578 is_from_best_next_hop, if_incoming,
1581 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1582 "Forwarding packet: rebroadcast neighbor packet with direct link flag\n");
1586 /* multihop originator */
1588 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1589 "Drop packet: not received via bidirectional link\n");
1593 if (dup_status == BATADV_NEIGH_DUP) {
1594 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1595 "Drop packet: duplicate packet received\n");
1599 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1600 "Forwarding packet: rebroadcast originator packet\n");
1601 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1602 is_single_hop_neigh, is_from_best_next_hop,
1603 if_incoming, if_outgoing);
1606 if ((orig_neigh_node) && (!is_single_hop_neigh))
1607 batadv_orig_node_free_ref(orig_neigh_node);
1610 batadv_neigh_ifinfo_free_ref(router_ifinfo);
1612 batadv_neigh_node_free_ref(router);
1614 batadv_neigh_node_free_ref(router_router);
1615 if (orig_neigh_router)
1616 batadv_neigh_node_free_ref(orig_neigh_router);
1618 kfree_skb(skb_priv);
1622 * batadv_iv_ogm_process - process an incoming batman iv OGM
1623 * @skb: the skb containing the OGM
1624 * @ogm_offset: offset to the OGM which should be processed (for aggregates)
1625 * @if_incoming: the interface where this packet was receved
1627 static void batadv_iv_ogm_process(const struct sk_buff *skb, int ogm_offset,
1628 struct batadv_hard_iface *if_incoming)
1630 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1631 struct batadv_orig_node *orig_neigh_node, *orig_node;
1632 struct batadv_hard_iface *hard_iface;
1633 struct batadv_ogm_packet *ogm_packet;
1634 u32 if_incoming_seqno;
1635 bool has_directlink_flag;
1636 struct ethhdr *ethhdr;
1637 bool is_my_oldorig = false;
1638 bool is_my_addr = false;
1639 bool is_my_orig = false;
1641 ogm_packet = (struct batadv_ogm_packet *)(skb->data + ogm_offset);
1642 ethhdr = eth_hdr(skb);
1644 /* Silently drop when the batman packet is actually not a
1647 * This might happen if a packet is padded (e.g. Ethernet has a
1648 * minimum frame length of 64 byte) and the aggregation interprets
1649 * it as an additional length.
1651 * TODO: A more sane solution would be to have a bit in the
1652 * batadv_ogm_packet to detect whether the packet is the last
1653 * packet in an aggregation. Here we expect that the padding
1654 * is always zero (or not 0x01)
1656 if (ogm_packet->packet_type != BATADV_IV_OGM)
1659 /* could be changed by schedule_own_packet() */
1660 if_incoming_seqno = atomic_read(&if_incoming->bat_iv.ogm_seqno);
1662 if (ogm_packet->flags & BATADV_DIRECTLINK)
1663 has_directlink_flag = true;
1665 has_directlink_flag = false;
1667 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1668 "Received BATMAN packet via NB: %pM, IF: %s [%pM] (from OG: %pM, via prev OG: %pM, seqno %u, tq %d, TTL %d, V %d, IDF %d)\n",
1669 ethhdr->h_source, if_incoming->net_dev->name,
1670 if_incoming->net_dev->dev_addr, ogm_packet->orig,
1671 ogm_packet->prev_sender, ntohl(ogm_packet->seqno),
1672 ogm_packet->tq, ogm_packet->ttl,
1673 ogm_packet->version, has_directlink_flag);
1676 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1677 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1680 if (hard_iface->soft_iface != if_incoming->soft_iface)
1683 if (batadv_compare_eth(ethhdr->h_source,
1684 hard_iface->net_dev->dev_addr))
1687 if (batadv_compare_eth(ogm_packet->orig,
1688 hard_iface->net_dev->dev_addr))
1691 if (batadv_compare_eth(ogm_packet->prev_sender,
1692 hard_iface->net_dev->dev_addr))
1693 is_my_oldorig = true;
1698 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1699 "Drop packet: received my own broadcast (sender: %pM)\n",
1705 unsigned long *word;
1708 unsigned int if_num;
1711 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1713 if (!orig_neigh_node)
1716 /* neighbor has to indicate direct link and it has to
1717 * come via the corresponding interface
1718 * save packet seqno for bidirectional check
1720 if (has_directlink_flag &&
1721 batadv_compare_eth(if_incoming->net_dev->dev_addr,
1722 ogm_packet->orig)) {
1723 if_num = if_incoming->if_num;
1724 offset = if_num * BATADV_NUM_WORDS;
1726 spin_lock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1727 word = &orig_neigh_node->bat_iv.bcast_own[offset];
1728 bit_pos = if_incoming_seqno - 2;
1729 bit_pos -= ntohl(ogm_packet->seqno);
1730 batadv_set_bit(word, bit_pos);
1731 weight = &orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1732 *weight = bitmap_weight(word,
1733 BATADV_TQ_LOCAL_WINDOW_SIZE);
1734 spin_unlock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1737 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1738 "Drop packet: originator packet from myself (via neighbor)\n");
1739 batadv_orig_node_free_ref(orig_neigh_node);
1743 if (is_my_oldorig) {
1744 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1745 "Drop packet: ignoring all rebroadcast echos (sender: %pM)\n",
1750 if (ogm_packet->flags & BATADV_NOT_BEST_NEXT_HOP) {
1751 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1752 "Drop packet: ignoring all packets not forwarded from the best next hop (sender: %pM)\n",
1757 orig_node = batadv_iv_ogm_orig_get(bat_priv, ogm_packet->orig);
1761 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1762 if_incoming, BATADV_IF_DEFAULT);
1765 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1766 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1769 if (hard_iface->soft_iface != bat_priv->soft_iface)
1772 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1773 if_incoming, hard_iface);
1777 batadv_orig_node_free_ref(orig_node);
1780 static int batadv_iv_ogm_receive(struct sk_buff *skb,
1781 struct batadv_hard_iface *if_incoming)
1783 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1784 struct batadv_ogm_packet *ogm_packet;
1789 ret = batadv_check_management_packet(skb, if_incoming, BATADV_OGM_HLEN);
1793 /* did we receive a B.A.T.M.A.N. IV OGM packet on an interface
1794 * that does not have B.A.T.M.A.N. IV enabled ?
1796 if (bat_priv->bat_algo_ops->bat_ogm_emit != batadv_iv_ogm_emit)
1799 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_RX);
1800 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_RX_BYTES,
1801 skb->len + ETH_HLEN);
1804 ogm_packet = (struct batadv_ogm_packet *)skb->data;
1806 /* unpack the aggregated packets and process them one by one */
1807 while (batadv_iv_ogm_aggr_packet(ogm_offset, skb_headlen(skb),
1809 batadv_iv_ogm_process(skb, ogm_offset, if_incoming);
1811 ogm_offset += BATADV_OGM_HLEN;
1812 ogm_offset += ntohs(ogm_packet->tvlv_len);
1814 packet_pos = skb->data + ogm_offset;
1815 ogm_packet = (struct batadv_ogm_packet *)packet_pos;
1819 return NET_RX_SUCCESS;
1823 * batadv_iv_ogm_orig_print_neigh - print neighbors for the originator table
1824 * @orig_node: the orig_node for which the neighbors are printed
1825 * @if_outgoing: outgoing interface for these entries
1826 * @seq: debugfs table seq_file struct
1828 * Must be called while holding an rcu lock.
1831 batadv_iv_ogm_orig_print_neigh(struct batadv_orig_node *orig_node,
1832 struct batadv_hard_iface *if_outgoing,
1833 struct seq_file *seq)
1835 struct batadv_neigh_node *neigh_node;
1836 struct batadv_neigh_ifinfo *n_ifinfo;
1838 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1839 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
1843 seq_printf(seq, " %pM (%3i)",
1845 n_ifinfo->bat_iv.tq_avg);
1847 batadv_neigh_ifinfo_free_ref(n_ifinfo);
1852 * batadv_iv_ogm_orig_print - print the originator table
1853 * @bat_priv: the bat priv with all the soft interface information
1854 * @seq: debugfs table seq_file struct
1855 * @if_outgoing: the outgoing interface for which this should be printed
1857 static void batadv_iv_ogm_orig_print(struct batadv_priv *bat_priv,
1858 struct seq_file *seq,
1859 struct batadv_hard_iface *if_outgoing)
1861 struct batadv_neigh_node *neigh_node;
1862 struct batadv_hashtable *hash = bat_priv->orig_hash;
1863 int last_seen_msecs, last_seen_secs;
1864 struct batadv_orig_node *orig_node;
1865 struct batadv_neigh_ifinfo *n_ifinfo;
1866 unsigned long last_seen_jiffies;
1867 struct hlist_head *head;
1868 int batman_count = 0;
1871 seq_printf(seq, " %-15s %s (%s/%i) %17s [%10s]: %20s ...\n",
1872 "Originator", "last-seen", "#", BATADV_TQ_MAX_VALUE,
1873 "Nexthop", "outgoingIF", "Potential nexthops");
1875 for (i = 0; i < hash->size; i++) {
1876 head = &hash->table[i];
1879 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
1880 neigh_node = batadv_orig_router_get(orig_node,
1885 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node,
1890 if (n_ifinfo->bat_iv.tq_avg == 0)
1893 last_seen_jiffies = jiffies - orig_node->last_seen;
1894 last_seen_msecs = jiffies_to_msecs(last_seen_jiffies);
1895 last_seen_secs = last_seen_msecs / 1000;
1896 last_seen_msecs = last_seen_msecs % 1000;
1898 seq_printf(seq, "%pM %4i.%03is (%3i) %pM [%10s]:",
1899 orig_node->orig, last_seen_secs,
1900 last_seen_msecs, n_ifinfo->bat_iv.tq_avg,
1902 neigh_node->if_incoming->net_dev->name);
1904 batadv_iv_ogm_orig_print_neigh(orig_node, if_outgoing,
1906 seq_puts(seq, "\n");
1910 batadv_neigh_node_free_ref(neigh_node);
1912 batadv_neigh_ifinfo_free_ref(n_ifinfo);
1917 if (batman_count == 0)
1918 seq_puts(seq, "No batman nodes in range ...\n");
1922 * batadv_iv_ogm_neigh_cmp - compare the metrics of two neighbors
1923 * @neigh1: the first neighbor object of the comparison
1924 * @if_outgoing1: outgoing interface for the first neighbor
1925 * @neigh2: the second neighbor object of the comparison
1926 * @if_outgoing2: outgoing interface for the second neighbor
1928 * Returns a value less, equal to or greater than 0 if the metric via neigh1 is
1929 * lower, the same as or higher than the metric via neigh2
1931 static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
1932 struct batadv_hard_iface *if_outgoing1,
1933 struct batadv_neigh_node *neigh2,
1934 struct batadv_hard_iface *if_outgoing2)
1936 struct batadv_neigh_ifinfo *neigh1_ifinfo, *neigh2_ifinfo;
1940 neigh1_ifinfo = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
1941 neigh2_ifinfo = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
1943 if (!neigh1_ifinfo || !neigh2_ifinfo) {
1948 tq1 = neigh1_ifinfo->bat_iv.tq_avg;
1949 tq2 = neigh2_ifinfo->bat_iv.tq_avg;
1954 batadv_neigh_ifinfo_free_ref(neigh1_ifinfo);
1956 batadv_neigh_ifinfo_free_ref(neigh2_ifinfo);
1962 * batadv_iv_ogm_neigh_is_eob - check if neigh1 is equally good or better than
1963 * neigh2 from the metric prospective
1964 * @neigh1: the first neighbor object of the comparison
1965 * @if_outgoing1: outgoing interface for the first neighbor
1966 * @neigh2: the second neighbor object of the comparison
1967 * @if_outgoing2: outgoing interface for the second neighbor
1969 * Returns true if the metric via neigh1 is equally good or better than
1970 * the metric via neigh2, false otherwise.
1973 batadv_iv_ogm_neigh_is_eob(struct batadv_neigh_node *neigh1,
1974 struct batadv_hard_iface *if_outgoing1,
1975 struct batadv_neigh_node *neigh2,
1976 struct batadv_hard_iface *if_outgoing2)
1978 struct batadv_neigh_ifinfo *neigh1_ifinfo, *neigh2_ifinfo;
1982 neigh1_ifinfo = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
1983 neigh2_ifinfo = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
1985 /* we can't say that the metric is better */
1986 if (!neigh1_ifinfo || !neigh2_ifinfo) {
1991 tq1 = neigh1_ifinfo->bat_iv.tq_avg;
1992 tq2 = neigh2_ifinfo->bat_iv.tq_avg;
1993 ret = (tq1 - tq2) > -BATADV_TQ_SIMILARITY_THRESHOLD;
1997 batadv_neigh_ifinfo_free_ref(neigh1_ifinfo);
1999 batadv_neigh_ifinfo_free_ref(neigh2_ifinfo);
2004 static struct batadv_algo_ops batadv_batman_iv __read_mostly = {
2005 .name = "BATMAN_IV",
2006 .bat_iface_enable = batadv_iv_ogm_iface_enable,
2007 .bat_iface_disable = batadv_iv_ogm_iface_disable,
2008 .bat_iface_update_mac = batadv_iv_ogm_iface_update_mac,
2009 .bat_primary_iface_set = batadv_iv_ogm_primary_iface_set,
2010 .bat_ogm_schedule = batadv_iv_ogm_schedule,
2011 .bat_ogm_emit = batadv_iv_ogm_emit,
2012 .bat_neigh_cmp = batadv_iv_ogm_neigh_cmp,
2013 .bat_neigh_is_equiv_or_better = batadv_iv_ogm_neigh_is_eob,
2014 .bat_orig_print = batadv_iv_ogm_orig_print,
2015 .bat_orig_free = batadv_iv_ogm_orig_free,
2016 .bat_orig_add_if = batadv_iv_ogm_orig_add_if,
2017 .bat_orig_del_if = batadv_iv_ogm_orig_del_if,
2020 int __init batadv_iv_init(void)
2024 /* batman originator packet */
2025 ret = batadv_recv_handler_register(BATADV_IV_OGM,
2026 batadv_iv_ogm_receive);
2030 ret = batadv_algo_register(&batadv_batman_iv);
2032 goto handler_unregister;
2037 batadv_recv_handler_unregister(BATADV_IV_OGM);