1 /* Copyright (C) 2007-2016 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 * Return: 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 * Return: 0 on success, a negative error code otherwise.
137 static int batadv_iv_ogm_orig_add_if(struct batadv_orig_node *orig_node,
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);
159 kfree(orig_node->bat_iv.bcast_own);
163 memcpy(data_ptr, orig_node->bat_iv.bcast_own_sum,
164 (max_if_num - 1) * sizeof(u8));
165 kfree(orig_node->bat_iv.bcast_own_sum);
166 orig_node->bat_iv.bcast_own_sum = data_ptr;
171 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
177 * batadv_iv_ogm_orig_del_if - change the private structures of the orig_node to
178 * exclude the removed interface
179 * @orig_node: the orig_node that has to be changed
180 * @max_if_num: the current amount of interfaces
181 * @del_if_num: the index of the interface being removed
183 * Return: 0 on success, a negative error code otherwise.
185 static int batadv_iv_ogm_orig_del_if(struct batadv_orig_node *orig_node,
186 int max_if_num, int del_if_num)
189 size_t chunk_size, if_offset;
190 void *data_ptr = NULL;
192 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
194 /* last interface was removed */
198 chunk_size = sizeof(unsigned long) * BATADV_NUM_WORDS;
199 data_ptr = kmalloc_array(max_if_num, chunk_size, GFP_ATOMIC);
203 /* copy first part */
204 memcpy(data_ptr, orig_node->bat_iv.bcast_own, del_if_num * chunk_size);
206 /* copy second part */
207 if_offset = (del_if_num + 1) * chunk_size;
208 memcpy((char *)data_ptr + del_if_num * chunk_size,
209 (uint8_t *)orig_node->bat_iv.bcast_own + if_offset,
210 (max_if_num - del_if_num) * chunk_size);
213 kfree(orig_node->bat_iv.bcast_own);
214 orig_node->bat_iv.bcast_own = data_ptr;
219 data_ptr = kmalloc_array(max_if_num, sizeof(u8), GFP_ATOMIC);
221 kfree(orig_node->bat_iv.bcast_own);
225 memcpy(data_ptr, orig_node->bat_iv.bcast_own_sum,
226 del_if_num * sizeof(u8));
228 if_offset = (del_if_num + 1) * sizeof(u8);
229 memcpy((char *)data_ptr + del_if_num * sizeof(u8),
230 orig_node->bat_iv.bcast_own_sum + if_offset,
231 (max_if_num - del_if_num) * sizeof(u8));
234 kfree(orig_node->bat_iv.bcast_own_sum);
235 orig_node->bat_iv.bcast_own_sum = data_ptr;
239 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
245 * batadv_iv_ogm_orig_get - retrieve or create (if does not exist) an originator
246 * @bat_priv: the bat priv with all the soft interface information
247 * @addr: mac address of the originator
249 * Return: the originator object corresponding to the passed mac address or NULL
251 * If the object does not exists it is created an initialised.
253 static struct batadv_orig_node *
254 batadv_iv_ogm_orig_get(struct batadv_priv *bat_priv, const u8 *addr)
256 struct batadv_orig_node *orig_node;
257 int size, hash_added;
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 /* randomize initial seqno to avoid collision */
320 get_random_bytes(&random_seqno, sizeof(random_seqno));
321 atomic_set(&hard_iface->bat_iv.ogm_seqno, random_seqno);
323 hard_iface->bat_iv.ogm_buff_len = BATADV_OGM_HLEN;
324 ogm_buff = kmalloc(hard_iface->bat_iv.ogm_buff_len, GFP_ATOMIC);
328 hard_iface->bat_iv.ogm_buff = ogm_buff;
330 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
331 batadv_ogm_packet->packet_type = BATADV_IV_OGM;
332 batadv_ogm_packet->version = BATADV_COMPAT_VERSION;
333 batadv_ogm_packet->ttl = 2;
334 batadv_ogm_packet->flags = BATADV_NO_FLAGS;
335 batadv_ogm_packet->reserved = 0;
336 batadv_ogm_packet->tq = BATADV_TQ_MAX_VALUE;
341 static void batadv_iv_ogm_iface_disable(struct batadv_hard_iface *hard_iface)
343 kfree(hard_iface->bat_iv.ogm_buff);
344 hard_iface->bat_iv.ogm_buff = NULL;
347 static void batadv_iv_ogm_iface_update_mac(struct batadv_hard_iface *hard_iface)
349 struct batadv_ogm_packet *batadv_ogm_packet;
350 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
352 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
353 ether_addr_copy(batadv_ogm_packet->orig,
354 hard_iface->net_dev->dev_addr);
355 ether_addr_copy(batadv_ogm_packet->prev_sender,
356 hard_iface->net_dev->dev_addr);
360 batadv_iv_ogm_primary_iface_set(struct batadv_hard_iface *hard_iface)
362 struct batadv_ogm_packet *batadv_ogm_packet;
363 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
365 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
366 batadv_ogm_packet->ttl = BATADV_TTL;
369 /* when do we schedule our own ogm to be sent */
371 batadv_iv_ogm_emit_send_time(const struct batadv_priv *bat_priv)
375 msecs = atomic_read(&bat_priv->orig_interval) - BATADV_JITTER;
376 msecs += prandom_u32() % (2 * BATADV_JITTER);
378 return jiffies + msecs_to_jiffies(msecs);
381 /* when do we schedule a ogm packet to be sent */
382 static unsigned long batadv_iv_ogm_fwd_send_time(void)
384 return jiffies + msecs_to_jiffies(prandom_u32() % (BATADV_JITTER / 2));
387 /* apply hop penalty for a normal link */
388 static u8 batadv_hop_penalty(u8 tq, const struct batadv_priv *bat_priv)
390 int hop_penalty = atomic_read(&bat_priv->hop_penalty);
393 new_tq = tq * (BATADV_TQ_MAX_VALUE - hop_penalty);
394 new_tq /= BATADV_TQ_MAX_VALUE;
400 * batadv_iv_ogm_aggr_packet - checks if there is another OGM attached
401 * @buff_pos: current position in the skb
402 * @packet_len: total length of the skb
403 * @tvlv_len: tvlv length of the previously considered OGM
405 * Return: true if there is enough space for another OGM, false otherwise.
407 static bool batadv_iv_ogm_aggr_packet(int buff_pos, int packet_len,
410 int next_buff_pos = 0;
412 next_buff_pos += buff_pos + BATADV_OGM_HLEN;
413 next_buff_pos += ntohs(tvlv_len);
415 return (next_buff_pos <= packet_len) &&
416 (next_buff_pos <= BATADV_MAX_AGGREGATION_BYTES);
419 /* send a batman ogm to a given interface */
420 static void batadv_iv_ogm_send_to_if(struct batadv_forw_packet *forw_packet,
421 struct batadv_hard_iface *hard_iface)
423 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
427 struct batadv_ogm_packet *batadv_ogm_packet;
431 if (hard_iface->if_status != BATADV_IF_ACTIVE)
436 packet_pos = forw_packet->skb->data;
437 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
439 /* adjust all flags and log packets */
440 while (batadv_iv_ogm_aggr_packet(buff_pos, forw_packet->packet_len,
441 batadv_ogm_packet->tvlv_len)) {
442 /* we might have aggregated direct link packets with an
443 * ordinary base packet
445 if (forw_packet->direct_link_flags & BIT(packet_num) &&
446 forw_packet->if_incoming == hard_iface)
447 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
449 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
451 if (packet_num > 0 || !forw_packet->own)
452 fwd_str = "Forwarding";
454 fwd_str = "Sending own";
456 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
457 "%s %spacket (originator %pM, seqno %u, TQ %d, TTL %d, IDF %s) on interface %s [%pM]\n",
458 fwd_str, (packet_num > 0 ? "aggregated " : ""),
459 batadv_ogm_packet->orig,
460 ntohl(batadv_ogm_packet->seqno),
461 batadv_ogm_packet->tq, batadv_ogm_packet->ttl,
462 ((batadv_ogm_packet->flags & BATADV_DIRECTLINK) ?
464 hard_iface->net_dev->name,
465 hard_iface->net_dev->dev_addr);
467 buff_pos += BATADV_OGM_HLEN;
468 buff_pos += ntohs(batadv_ogm_packet->tvlv_len);
470 packet_pos = forw_packet->skb->data + buff_pos;
471 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
474 /* create clone because function is called more than once */
475 skb = skb_clone(forw_packet->skb, GFP_ATOMIC);
477 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_TX);
478 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_TX_BYTES,
479 skb->len + ETH_HLEN);
480 batadv_send_skb_packet(skb, hard_iface, batadv_broadcast_addr);
484 /* send a batman ogm packet */
485 static void batadv_iv_ogm_emit(struct batadv_forw_packet *forw_packet)
487 struct net_device *soft_iface;
488 struct batadv_priv *bat_priv;
489 struct batadv_hard_iface *primary_if = NULL;
491 if (!forw_packet->if_incoming) {
492 pr_err("Error - can't forward packet: incoming iface not specified\n");
496 soft_iface = forw_packet->if_incoming->soft_iface;
497 bat_priv = netdev_priv(soft_iface);
499 if (WARN_ON(!forw_packet->if_outgoing))
502 if (WARN_ON(forw_packet->if_outgoing->soft_iface != soft_iface))
505 if (forw_packet->if_incoming->if_status != BATADV_IF_ACTIVE)
508 primary_if = batadv_primary_if_get_selected(bat_priv);
512 /* only for one specific outgoing interface */
513 batadv_iv_ogm_send_to_if(forw_packet, forw_packet->if_outgoing);
517 batadv_hardif_free_ref(primary_if);
521 * batadv_iv_ogm_can_aggregate - find out if an OGM can be aggregated on an
522 * existing forward packet
523 * @new_bat_ogm_packet: OGM packet to be aggregated
524 * @bat_priv: the bat priv with all the soft interface information
525 * @packet_len: (total) length of the OGM
526 * @send_time: timestamp (jiffies) when the packet is to be sent
527 * @directlink: true if this is a direct link packet
528 * @if_incoming: interface where the packet was received
529 * @if_outgoing: interface for which the retransmission should be considered
530 * @forw_packet: the forwarded packet which should be checked
532 * Return: true if new_packet can be aggregated with forw_packet
535 batadv_iv_ogm_can_aggregate(const struct batadv_ogm_packet *new_bat_ogm_packet,
536 struct batadv_priv *bat_priv,
537 int packet_len, unsigned long send_time,
539 const struct batadv_hard_iface *if_incoming,
540 const struct batadv_hard_iface *if_outgoing,
541 const struct batadv_forw_packet *forw_packet)
543 struct batadv_ogm_packet *batadv_ogm_packet;
544 int aggregated_bytes = forw_packet->packet_len + packet_len;
545 struct batadv_hard_iface *primary_if = NULL;
547 unsigned long aggregation_end_time;
549 batadv_ogm_packet = (struct batadv_ogm_packet *)forw_packet->skb->data;
550 aggregation_end_time = send_time;
551 aggregation_end_time += msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
553 /* we can aggregate the current packet to this aggregated packet
556 * - the send time is within our MAX_AGGREGATION_MS time
557 * - the resulting packet wont be bigger than
558 * MAX_AGGREGATION_BYTES
559 * otherwise aggregation is not possible
561 if (!time_before(send_time, forw_packet->send_time) ||
562 !time_after_eq(aggregation_end_time, forw_packet->send_time))
565 if (aggregated_bytes > BATADV_MAX_AGGREGATION_BYTES)
568 /* packet is not leaving on the same interface. */
569 if (forw_packet->if_outgoing != if_outgoing)
572 /* check aggregation compatibility
573 * -> direct link packets are broadcasted on
574 * their interface only
575 * -> aggregate packet if the current packet is
576 * a "global" packet as well as the base
579 primary_if = batadv_primary_if_get_selected(bat_priv);
583 /* packets without direct link flag and high TTL
584 * are flooded through the net
587 !(batadv_ogm_packet->flags & BATADV_DIRECTLINK) &&
588 batadv_ogm_packet->ttl != 1 &&
590 /* own packets originating non-primary
591 * interfaces leave only that interface
593 (!forw_packet->own ||
594 forw_packet->if_incoming == primary_if)) {
599 /* if the incoming packet is sent via this one
600 * interface only - we still can aggregate
603 new_bat_ogm_packet->ttl == 1 &&
604 forw_packet->if_incoming == if_incoming &&
606 /* packets from direct neighbors or
607 * own secondary interface packets
608 * (= secondary interface packets in general)
610 (batadv_ogm_packet->flags & BATADV_DIRECTLINK ||
612 forw_packet->if_incoming != primary_if))) {
619 batadv_hardif_free_ref(primary_if);
624 * batadv_iv_ogm_aggregate_new - create a new aggregated packet and add this
626 * @packet_buff: pointer to the OGM
627 * @packet_len: (total) length of the OGM
628 * @send_time: timestamp (jiffies) when the packet is to be sent
629 * @direct_link: whether this OGM has direct link status
630 * @if_incoming: interface where the packet was received
631 * @if_outgoing: interface for which the retransmission should be considered
632 * @own_packet: true if it is a self-generated ogm
634 static void batadv_iv_ogm_aggregate_new(const unsigned char *packet_buff,
635 int packet_len, unsigned long send_time,
637 struct batadv_hard_iface *if_incoming,
638 struct batadv_hard_iface *if_outgoing,
641 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
642 struct batadv_forw_packet *forw_packet_aggr;
643 unsigned char *skb_buff;
644 unsigned int skb_size;
646 if (!atomic_inc_not_zero(&if_incoming->refcount))
649 if (!atomic_inc_not_zero(&if_outgoing->refcount))
650 goto out_free_incoming;
652 /* own packet should always be scheduled */
654 if (!batadv_atomic_dec_not_zero(&bat_priv->batman_queue_left)) {
655 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
656 "batman packet queue full\n");
657 goto out_free_outgoing;
661 forw_packet_aggr = kmalloc(sizeof(*forw_packet_aggr), GFP_ATOMIC);
662 if (!forw_packet_aggr)
665 if (atomic_read(&bat_priv->aggregated_ogms) &&
666 packet_len < BATADV_MAX_AGGREGATION_BYTES)
667 skb_size = BATADV_MAX_AGGREGATION_BYTES;
669 skb_size = packet_len;
671 skb_size += ETH_HLEN;
673 forw_packet_aggr->skb = netdev_alloc_skb_ip_align(NULL, skb_size);
674 if (!forw_packet_aggr->skb)
675 goto out_free_forw_packet;
676 forw_packet_aggr->skb->priority = TC_PRIO_CONTROL;
677 skb_reserve(forw_packet_aggr->skb, ETH_HLEN);
679 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
680 forw_packet_aggr->packet_len = packet_len;
681 memcpy(skb_buff, packet_buff, packet_len);
683 forw_packet_aggr->own = own_packet;
684 forw_packet_aggr->if_incoming = if_incoming;
685 forw_packet_aggr->if_outgoing = if_outgoing;
686 forw_packet_aggr->num_packets = 0;
687 forw_packet_aggr->direct_link_flags = BATADV_NO_FLAGS;
688 forw_packet_aggr->send_time = send_time;
690 /* save packet direct link flag status */
692 forw_packet_aggr->direct_link_flags |= 1;
694 /* add new packet to packet list */
695 spin_lock_bh(&bat_priv->forw_bat_list_lock);
696 hlist_add_head(&forw_packet_aggr->list, &bat_priv->forw_bat_list);
697 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
699 /* start timer for this packet */
700 INIT_DELAYED_WORK(&forw_packet_aggr->delayed_work,
701 batadv_send_outstanding_bat_ogm_packet);
702 queue_delayed_work(batadv_event_workqueue,
703 &forw_packet_aggr->delayed_work,
704 send_time - jiffies);
707 out_free_forw_packet:
708 kfree(forw_packet_aggr);
711 atomic_inc(&bat_priv->batman_queue_left);
713 batadv_hardif_free_ref(if_outgoing);
715 batadv_hardif_free_ref(if_incoming);
718 /* aggregate a new packet into the existing ogm packet */
719 static void batadv_iv_ogm_aggregate(struct batadv_forw_packet *forw_packet_aggr,
720 const unsigned char *packet_buff,
721 int packet_len, bool direct_link)
723 unsigned char *skb_buff;
724 unsigned long new_direct_link_flag;
726 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
727 memcpy(skb_buff, packet_buff, packet_len);
728 forw_packet_aggr->packet_len += packet_len;
729 forw_packet_aggr->num_packets++;
731 /* save packet direct link flag status */
733 new_direct_link_flag = BIT(forw_packet_aggr->num_packets);
734 forw_packet_aggr->direct_link_flags |= new_direct_link_flag;
739 * batadv_iv_ogm_queue_add - queue up an OGM for transmission
740 * @bat_priv: the bat priv with all the soft interface information
741 * @packet_buff: pointer to the OGM
742 * @packet_len: (total) length of the OGM
743 * @if_incoming: interface where the packet was received
744 * @if_outgoing: interface for which the retransmission should be considered
745 * @own_packet: true if it is a self-generated ogm
746 * @send_time: timestamp (jiffies) when the packet is to be sent
748 static void batadv_iv_ogm_queue_add(struct batadv_priv *bat_priv,
749 unsigned char *packet_buff,
751 struct batadv_hard_iface *if_incoming,
752 struct batadv_hard_iface *if_outgoing,
753 int own_packet, unsigned long send_time)
755 /* _aggr -> pointer to the packet we want to aggregate with
756 * _pos -> pointer to the position in the queue
758 struct batadv_forw_packet *forw_packet_aggr = NULL;
759 struct batadv_forw_packet *forw_packet_pos = NULL;
760 struct batadv_ogm_packet *batadv_ogm_packet;
762 unsigned long max_aggregation_jiffies;
764 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_buff;
765 direct_link = !!(batadv_ogm_packet->flags & BATADV_DIRECTLINK);
766 max_aggregation_jiffies = msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
768 /* find position for the packet in the forward queue */
769 spin_lock_bh(&bat_priv->forw_bat_list_lock);
770 /* own packets are not to be aggregated */
771 if (atomic_read(&bat_priv->aggregated_ogms) && !own_packet) {
772 hlist_for_each_entry(forw_packet_pos,
773 &bat_priv->forw_bat_list, list) {
774 if (batadv_iv_ogm_can_aggregate(batadv_ogm_packet,
775 bat_priv, packet_len,
776 send_time, direct_link,
780 forw_packet_aggr = forw_packet_pos;
786 /* nothing to aggregate with - either aggregation disabled or no
787 * suitable aggregation packet found
789 if (!forw_packet_aggr) {
790 /* the following section can run without the lock */
791 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
793 /* if we could not aggregate this packet with one of the others
794 * we hold it back for a while, so that it might be aggregated
797 if (!own_packet && atomic_read(&bat_priv->aggregated_ogms))
798 send_time += max_aggregation_jiffies;
800 batadv_iv_ogm_aggregate_new(packet_buff, packet_len,
801 send_time, direct_link,
802 if_incoming, if_outgoing,
805 batadv_iv_ogm_aggregate(forw_packet_aggr, packet_buff,
806 packet_len, direct_link);
807 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
811 static void batadv_iv_ogm_forward(struct batadv_orig_node *orig_node,
812 const struct ethhdr *ethhdr,
813 struct batadv_ogm_packet *batadv_ogm_packet,
814 bool is_single_hop_neigh,
815 bool is_from_best_next_hop,
816 struct batadv_hard_iface *if_incoming,
817 struct batadv_hard_iface *if_outgoing)
819 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
822 if (batadv_ogm_packet->ttl <= 1) {
823 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "ttl exceeded\n");
827 if (!is_from_best_next_hop) {
828 /* Mark the forwarded packet when it is not coming from our
829 * best next hop. We still need to forward the packet for our
830 * neighbor link quality detection to work in case the packet
831 * originated from a single hop neighbor. Otherwise we can
832 * simply drop the ogm.
834 if (is_single_hop_neigh)
835 batadv_ogm_packet->flags |= BATADV_NOT_BEST_NEXT_HOP;
840 tvlv_len = ntohs(batadv_ogm_packet->tvlv_len);
842 batadv_ogm_packet->ttl--;
843 ether_addr_copy(batadv_ogm_packet->prev_sender, ethhdr->h_source);
845 /* apply hop penalty */
846 batadv_ogm_packet->tq = batadv_hop_penalty(batadv_ogm_packet->tq,
849 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
850 "Forwarding packet: tq: %i, ttl: %i\n",
851 batadv_ogm_packet->tq, batadv_ogm_packet->ttl);
853 if (is_single_hop_neigh)
854 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
856 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
858 batadv_iv_ogm_queue_add(bat_priv, (unsigned char *)batadv_ogm_packet,
859 BATADV_OGM_HLEN + tvlv_len,
860 if_incoming, if_outgoing, 0,
861 batadv_iv_ogm_fwd_send_time());
865 * batadv_iv_ogm_slide_own_bcast_window - bitshift own OGM broadcast windows for
866 * the given interface
867 * @hard_iface: the interface for which the windows have to be shifted
870 batadv_iv_ogm_slide_own_bcast_window(struct batadv_hard_iface *hard_iface)
872 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
873 struct batadv_hashtable *hash = bat_priv->orig_hash;
874 struct hlist_head *head;
875 struct batadv_orig_node *orig_node;
882 for (i = 0; i < hash->size; i++) {
883 head = &hash->table[i];
886 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
887 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
888 word_index = hard_iface->if_num * BATADV_NUM_WORDS;
889 word = &orig_node->bat_iv.bcast_own[word_index];
891 batadv_bit_get_packet(bat_priv, word, 1, 0);
892 if_num = hard_iface->if_num;
893 w = &orig_node->bat_iv.bcast_own_sum[if_num];
894 *w = bitmap_weight(word, BATADV_TQ_LOCAL_WINDOW_SIZE);
895 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
901 static void batadv_iv_ogm_schedule(struct batadv_hard_iface *hard_iface)
903 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
904 unsigned char **ogm_buff = &hard_iface->bat_iv.ogm_buff;
905 struct batadv_ogm_packet *batadv_ogm_packet;
906 struct batadv_hard_iface *primary_if, *tmp_hard_iface;
907 int *ogm_buff_len = &hard_iface->bat_iv.ogm_buff_len;
910 unsigned long send_time;
912 primary_if = batadv_primary_if_get_selected(bat_priv);
914 if (hard_iface == primary_if) {
915 /* tt changes have to be committed before the tvlv data is
916 * appended as it may alter the tt tvlv container
918 batadv_tt_local_commit_changes(bat_priv);
919 tvlv_len = batadv_tvlv_container_ogm_append(bat_priv, ogm_buff,
924 batadv_ogm_packet = (struct batadv_ogm_packet *)(*ogm_buff);
925 batadv_ogm_packet->tvlv_len = htons(tvlv_len);
927 /* change sequence number to network order */
928 seqno = (u32)atomic_read(&hard_iface->bat_iv.ogm_seqno);
929 batadv_ogm_packet->seqno = htonl(seqno);
930 atomic_inc(&hard_iface->bat_iv.ogm_seqno);
932 batadv_iv_ogm_slide_own_bcast_window(hard_iface);
934 send_time = batadv_iv_ogm_emit_send_time(bat_priv);
936 if (hard_iface != primary_if) {
937 /* OGMs from secondary interfaces are only scheduled on their
938 * respective interfaces.
940 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff, *ogm_buff_len,
941 hard_iface, hard_iface, 1, send_time);
945 /* OGMs from primary interfaces are scheduled on all
949 list_for_each_entry_rcu(tmp_hard_iface, &batadv_hardif_list, list) {
950 if (tmp_hard_iface->soft_iface != hard_iface->soft_iface)
952 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff,
953 *ogm_buff_len, hard_iface,
954 tmp_hard_iface, 1, send_time);
960 batadv_hardif_free_ref(primary_if);
964 * batadv_iv_ogm_orig_update - use OGM to update corresponding data in an
966 * @bat_priv: the bat priv with all the soft interface information
967 * @orig_node: the orig node who originally emitted the ogm packet
968 * @orig_ifinfo: ifinfo for the outgoing interface of the orig_node
969 * @ethhdr: Ethernet header of the OGM
970 * @batadv_ogm_packet: the ogm packet
971 * @if_incoming: interface where the packet was received
972 * @if_outgoing: interface for which the retransmission should be considered
973 * @dup_status: the duplicate status of this ogm packet.
976 batadv_iv_ogm_orig_update(struct batadv_priv *bat_priv,
977 struct batadv_orig_node *orig_node,
978 struct batadv_orig_ifinfo *orig_ifinfo,
979 const struct ethhdr *ethhdr,
980 const struct batadv_ogm_packet *batadv_ogm_packet,
981 struct batadv_hard_iface *if_incoming,
982 struct batadv_hard_iface *if_outgoing,
983 enum batadv_dup_status dup_status)
985 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL;
986 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
987 struct batadv_neigh_node *neigh_node = NULL;
988 struct batadv_neigh_node *tmp_neigh_node = NULL;
989 struct batadv_neigh_node *router = NULL;
990 struct batadv_orig_node *orig_node_tmp;
992 u8 sum_orig, sum_neigh;
996 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
997 "update_originator(): Searching and updating originator entry of received packet\n");
1000 hlist_for_each_entry_rcu(tmp_neigh_node,
1001 &orig_node->neigh_list, list) {
1002 neigh_addr = tmp_neigh_node->addr;
1003 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1004 tmp_neigh_node->if_incoming == if_incoming &&
1005 atomic_inc_not_zero(&tmp_neigh_node->refcount)) {
1006 if (WARN(neigh_node, "too many matching neigh_nodes"))
1007 batadv_neigh_node_free_ref(neigh_node);
1008 neigh_node = tmp_neigh_node;
1012 if (dup_status != BATADV_NO_DUP)
1015 /* only update the entry for this outgoing interface */
1016 neigh_ifinfo = batadv_neigh_ifinfo_get(tmp_neigh_node,
1021 spin_lock_bh(&tmp_neigh_node->ifinfo_lock);
1022 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1023 &neigh_ifinfo->bat_iv.tq_index, 0);
1024 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1025 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1026 spin_unlock_bh(&tmp_neigh_node->ifinfo_lock);
1028 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1029 neigh_ifinfo = NULL;
1033 struct batadv_orig_node *orig_tmp;
1035 orig_tmp = batadv_iv_ogm_orig_get(bat_priv, ethhdr->h_source);
1039 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1041 orig_node, orig_tmp);
1043 batadv_orig_node_free_ref(orig_tmp);
1047 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1048 "Updating existing last-hop neighbor of originator\n");
1052 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1056 neigh_node->last_seen = jiffies;
1058 spin_lock_bh(&neigh_node->ifinfo_lock);
1059 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1060 &neigh_ifinfo->bat_iv.tq_index,
1061 batadv_ogm_packet->tq);
1062 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1063 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1064 spin_unlock_bh(&neigh_node->ifinfo_lock);
1066 if (dup_status == BATADV_NO_DUP) {
1067 orig_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1068 neigh_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1071 /* if this neighbor already is our next hop there is nothing
1074 router = batadv_orig_router_get(orig_node, if_outgoing);
1075 if (router == neigh_node)
1079 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1083 /* if this neighbor does not offer a better TQ we won't
1086 if (router_ifinfo->bat_iv.tq_avg > neigh_ifinfo->bat_iv.tq_avg)
1090 /* if the TQ is the same and the link not more symmetric we
1091 * won't consider it either
1093 if (router_ifinfo &&
1094 neigh_ifinfo->bat_iv.tq_avg == router_ifinfo->bat_iv.tq_avg) {
1095 orig_node_tmp = router->orig_node;
1096 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1097 if_num = router->if_incoming->if_num;
1098 sum_orig = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1099 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1101 orig_node_tmp = neigh_node->orig_node;
1102 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1103 if_num = neigh_node->if_incoming->if_num;
1104 sum_neigh = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1105 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1107 if (sum_orig >= sum_neigh)
1111 batadv_update_route(bat_priv, orig_node, if_outgoing, neigh_node);
1118 batadv_neigh_node_free_ref(neigh_node);
1120 batadv_neigh_node_free_ref(router);
1122 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1124 batadv_neigh_ifinfo_free_ref(router_ifinfo);
1128 * batadv_iv_ogm_calc_tq - calculate tq for current received ogm packet
1129 * @orig_node: the orig node who originally emitted the ogm packet
1130 * @orig_neigh_node: the orig node struct of the neighbor who sent the packet
1131 * @batadv_ogm_packet: the ogm packet
1132 * @if_incoming: interface where the packet was received
1133 * @if_outgoing: interface for which the retransmission should be considered
1135 * Return: 1 if the link can be considered bidirectional, 0 otherwise
1137 static int batadv_iv_ogm_calc_tq(struct batadv_orig_node *orig_node,
1138 struct batadv_orig_node *orig_neigh_node,
1139 struct batadv_ogm_packet *batadv_ogm_packet,
1140 struct batadv_hard_iface *if_incoming,
1141 struct batadv_hard_iface *if_outgoing)
1143 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1144 struct batadv_neigh_node *neigh_node = NULL, *tmp_neigh_node;
1145 struct batadv_neigh_ifinfo *neigh_ifinfo;
1147 u8 orig_eq_count, neigh_rq_count, neigh_rq_inv, tq_own;
1148 unsigned int neigh_rq_inv_cube, neigh_rq_max_cube;
1149 int tq_asym_penalty, inv_asym_penalty, if_num, ret = 0;
1150 unsigned int combined_tq;
1151 int tq_iface_penalty;
1153 /* find corresponding one hop neighbor */
1155 hlist_for_each_entry_rcu(tmp_neigh_node,
1156 &orig_neigh_node->neigh_list, list) {
1157 if (!batadv_compare_eth(tmp_neigh_node->addr,
1158 orig_neigh_node->orig))
1161 if (tmp_neigh_node->if_incoming != if_incoming)
1164 if (!atomic_inc_not_zero(&tmp_neigh_node->refcount))
1167 neigh_node = tmp_neigh_node;
1173 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1174 orig_neigh_node->orig,
1181 /* if orig_node is direct neighbor update neigh_node last_seen */
1182 if (orig_node == orig_neigh_node)
1183 neigh_node->last_seen = jiffies;
1185 orig_node->last_seen = jiffies;
1187 /* find packet count of corresponding one hop neighbor */
1188 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1189 if_num = if_incoming->if_num;
1190 orig_eq_count = orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1191 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1193 neigh_rq_count = neigh_ifinfo->bat_iv.real_packet_count;
1194 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1198 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1200 /* pay attention to not get a value bigger than 100 % */
1201 if (orig_eq_count > neigh_rq_count)
1202 total_count = neigh_rq_count;
1204 total_count = orig_eq_count;
1206 /* if we have too few packets (too less data) we set tq_own to zero
1207 * if we receive too few packets it is not considered bidirectional
1209 if (total_count < BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM ||
1210 neigh_rq_count < BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM)
1213 /* neigh_node->real_packet_count is never zero as we
1214 * only purge old information when getting new
1217 tq_own = (BATADV_TQ_MAX_VALUE * total_count) / neigh_rq_count;
1219 /* 1 - ((1-x) ** 3), normalized to TQ_MAX_VALUE this does
1220 * affect the nearly-symmetric links only a little, but
1221 * punishes asymmetric links more. This will give a value
1222 * between 0 and TQ_MAX_VALUE
1224 neigh_rq_inv = BATADV_TQ_LOCAL_WINDOW_SIZE - neigh_rq_count;
1225 neigh_rq_inv_cube = neigh_rq_inv * neigh_rq_inv * neigh_rq_inv;
1226 neigh_rq_max_cube = BATADV_TQ_LOCAL_WINDOW_SIZE *
1227 BATADV_TQ_LOCAL_WINDOW_SIZE *
1228 BATADV_TQ_LOCAL_WINDOW_SIZE;
1229 inv_asym_penalty = BATADV_TQ_MAX_VALUE * neigh_rq_inv_cube;
1230 inv_asym_penalty /= neigh_rq_max_cube;
1231 tq_asym_penalty = BATADV_TQ_MAX_VALUE - inv_asym_penalty;
1233 /* penalize if the OGM is forwarded on the same interface. WiFi
1234 * interfaces and other half duplex devices suffer from throughput
1235 * drops as they can't send and receive at the same time.
1237 tq_iface_penalty = BATADV_TQ_MAX_VALUE;
1238 if (if_outgoing && (if_incoming == if_outgoing) &&
1239 batadv_is_wifi_netdev(if_outgoing->net_dev))
1240 tq_iface_penalty = batadv_hop_penalty(BATADV_TQ_MAX_VALUE,
1243 combined_tq = batadv_ogm_packet->tq *
1247 combined_tq /= BATADV_TQ_MAX_VALUE *
1248 BATADV_TQ_MAX_VALUE *
1249 BATADV_TQ_MAX_VALUE;
1250 batadv_ogm_packet->tq = combined_tq;
1252 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1253 "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",
1254 orig_node->orig, orig_neigh_node->orig, total_count,
1255 neigh_rq_count, tq_own, tq_asym_penalty, tq_iface_penalty,
1256 batadv_ogm_packet->tq, if_incoming->net_dev->name,
1257 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT");
1259 /* if link has the minimum required transmission quality
1260 * consider it bidirectional
1262 if (batadv_ogm_packet->tq >= BATADV_TQ_TOTAL_BIDRECT_LIMIT)
1267 batadv_neigh_node_free_ref(neigh_node);
1272 * batadv_iv_ogm_update_seqnos - process a batman packet for all interfaces,
1273 * adjust the sequence number and find out whether it is a duplicate
1274 * @ethhdr: ethernet header of the packet
1275 * @batadv_ogm_packet: OGM packet to be considered
1276 * @if_incoming: interface on which the OGM packet was received
1277 * @if_outgoing: interface for which the retransmission should be considered
1279 * Return: duplicate status as enum batadv_dup_status
1281 static enum batadv_dup_status
1282 batadv_iv_ogm_update_seqnos(const struct ethhdr *ethhdr,
1283 const struct batadv_ogm_packet *batadv_ogm_packet,
1284 const struct batadv_hard_iface *if_incoming,
1285 struct batadv_hard_iface *if_outgoing)
1287 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1288 struct batadv_orig_node *orig_node;
1289 struct batadv_orig_ifinfo *orig_ifinfo = NULL;
1290 struct batadv_neigh_node *neigh_node;
1291 struct batadv_neigh_ifinfo *neigh_ifinfo;
1294 int need_update = 0;
1296 enum batadv_dup_status ret = BATADV_NO_DUP;
1297 u32 seqno = ntohl(batadv_ogm_packet->seqno);
1300 unsigned long *bitmap;
1302 orig_node = batadv_iv_ogm_orig_get(bat_priv, batadv_ogm_packet->orig);
1304 return BATADV_NO_DUP;
1306 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1307 if (WARN_ON(!orig_ifinfo)) {
1308 batadv_orig_node_free_ref(orig_node);
1312 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1313 seq_diff = seqno - orig_ifinfo->last_real_seqno;
1315 /* signalize caller that the packet is to be dropped. */
1316 if (!hlist_empty(&orig_node->neigh_list) &&
1317 batadv_window_protected(bat_priv, seq_diff,
1318 &orig_ifinfo->batman_seqno_reset)) {
1319 ret = BATADV_PROTECTED;
1324 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1325 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node,
1330 neigh_addr = neigh_node->addr;
1331 is_dup = batadv_test_bit(neigh_ifinfo->bat_iv.real_bits,
1332 orig_ifinfo->last_real_seqno,
1335 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1336 neigh_node->if_incoming == if_incoming) {
1339 ret = BATADV_NEIGH_DUP;
1342 if (is_dup && (ret != BATADV_NEIGH_DUP))
1343 ret = BATADV_ORIG_DUP;
1346 /* if the window moved, set the update flag. */
1347 bitmap = neigh_ifinfo->bat_iv.real_bits;
1348 need_update |= batadv_bit_get_packet(bat_priv, bitmap,
1349 seq_diff, set_mark);
1351 packet_count = bitmap_weight(bitmap,
1352 BATADV_TQ_LOCAL_WINDOW_SIZE);
1353 neigh_ifinfo->bat_iv.real_packet_count = packet_count;
1354 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1359 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1360 "%s updating last_seqno: old %u, new %u\n",
1361 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT",
1362 orig_ifinfo->last_real_seqno, seqno);
1363 orig_ifinfo->last_real_seqno = seqno;
1367 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1368 batadv_orig_node_free_ref(orig_node);
1369 batadv_orig_ifinfo_free_ref(orig_ifinfo);
1374 * batadv_iv_ogm_process_per_outif - process a batman iv OGM for an outgoing if
1375 * @skb: the skb containing the OGM
1376 * @ogm_offset: offset from skb->data to start of ogm header
1377 * @orig_node: the (cached) orig node for the originator of this OGM
1378 * @if_incoming: the interface where this packet was received
1379 * @if_outgoing: the interface for which the packet should be considered
1382 batadv_iv_ogm_process_per_outif(const struct sk_buff *skb, int ogm_offset,
1383 struct batadv_orig_node *orig_node,
1384 struct batadv_hard_iface *if_incoming,
1385 struct batadv_hard_iface *if_outgoing)
1387 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1388 struct batadv_hardif_neigh_node *hardif_neigh = NULL;
1389 struct batadv_neigh_node *router = NULL;
1390 struct batadv_neigh_node *router_router = NULL;
1391 struct batadv_orig_node *orig_neigh_node;
1392 struct batadv_orig_ifinfo *orig_ifinfo;
1393 struct batadv_neigh_node *orig_neigh_router = NULL;
1394 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
1395 struct batadv_ogm_packet *ogm_packet;
1396 enum batadv_dup_status dup_status;
1397 bool is_from_best_next_hop = false;
1398 bool is_single_hop_neigh = false;
1399 bool sameseq, similar_ttl;
1400 struct sk_buff *skb_priv;
1401 struct ethhdr *ethhdr;
1405 /* create a private copy of the skb, as some functions change tq value
1408 skb_priv = skb_copy(skb, GFP_ATOMIC);
1412 ethhdr = eth_hdr(skb_priv);
1413 ogm_packet = (struct batadv_ogm_packet *)(skb_priv->data + ogm_offset);
1415 dup_status = batadv_iv_ogm_update_seqnos(ethhdr, ogm_packet,
1416 if_incoming, if_outgoing);
1417 if (batadv_compare_eth(ethhdr->h_source, ogm_packet->orig))
1418 is_single_hop_neigh = true;
1420 if (dup_status == BATADV_PROTECTED) {
1421 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1422 "Drop packet: packet within seqno protection time (sender: %pM)\n",
1427 if (ogm_packet->tq == 0) {
1428 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1429 "Drop packet: originator packet with tq equal 0\n");
1433 if (is_single_hop_neigh) {
1434 hardif_neigh = batadv_hardif_neigh_get(if_incoming,
1437 hardif_neigh->last_seen = jiffies;
1440 router = batadv_orig_router_get(orig_node, if_outgoing);
1442 router_router = batadv_orig_router_get(router->orig_node,
1444 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1447 if ((router_ifinfo && router_ifinfo->bat_iv.tq_avg != 0) &&
1448 (batadv_compare_eth(router->addr, ethhdr->h_source)))
1449 is_from_best_next_hop = true;
1451 prev_sender = ogm_packet->prev_sender;
1452 /* avoid temporary routing loops */
1453 if (router && router_router &&
1454 (batadv_compare_eth(router->addr, prev_sender)) &&
1455 !(batadv_compare_eth(ogm_packet->orig, prev_sender)) &&
1456 (batadv_compare_eth(router->addr, router_router->addr))) {
1457 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1458 "Drop packet: ignoring all rebroadcast packets that may make me loop (sender: %pM)\n",
1463 if (if_outgoing == BATADV_IF_DEFAULT)
1464 batadv_tvlv_ogm_receive(bat_priv, ogm_packet, orig_node);
1466 /* if sender is a direct neighbor the sender mac equals
1469 if (is_single_hop_neigh)
1470 orig_neigh_node = orig_node;
1472 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1475 if (!orig_neigh_node)
1478 /* Update nc_nodes of the originator */
1479 batadv_nc_update_nc_node(bat_priv, orig_node, orig_neigh_node,
1480 ogm_packet, is_single_hop_neigh);
1482 orig_neigh_router = batadv_orig_router_get(orig_neigh_node,
1485 /* drop packet if sender is not a direct neighbor and if we
1486 * don't route towards it
1488 if (!is_single_hop_neigh && (!orig_neigh_router)) {
1489 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1490 "Drop packet: OGM via unknown neighbor!\n");
1494 is_bidirect = batadv_iv_ogm_calc_tq(orig_node, orig_neigh_node,
1495 ogm_packet, if_incoming,
1498 /* update ranking if it is not a duplicate or has the same
1499 * seqno and similar ttl as the non-duplicate
1501 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1505 sameseq = orig_ifinfo->last_real_seqno == ntohl(ogm_packet->seqno);
1506 similar_ttl = (orig_ifinfo->last_ttl - 3) <= ogm_packet->ttl;
1508 if (is_bidirect && ((dup_status == BATADV_NO_DUP) ||
1509 (sameseq && similar_ttl))) {
1510 batadv_iv_ogm_orig_update(bat_priv, orig_node,
1511 orig_ifinfo, ethhdr,
1512 ogm_packet, if_incoming,
1513 if_outgoing, dup_status);
1515 batadv_orig_ifinfo_free_ref(orig_ifinfo);
1517 /* only forward for specific interface, not for the default one. */
1518 if (if_outgoing == BATADV_IF_DEFAULT)
1521 /* is single hop (direct) neighbor */
1522 if (is_single_hop_neigh) {
1523 /* OGMs from secondary interfaces should only scheduled once
1524 * per interface where it has been received, not multiple times
1526 if ((ogm_packet->ttl <= 2) &&
1527 (if_incoming != if_outgoing)) {
1528 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1529 "Drop packet: OGM from secondary interface and wrong outgoing interface\n");
1532 /* mark direct link on incoming interface */
1533 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1534 is_single_hop_neigh,
1535 is_from_best_next_hop, if_incoming,
1538 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1539 "Forwarding packet: rebroadcast neighbor packet with direct link flag\n");
1543 /* multihop originator */
1545 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1546 "Drop packet: not received via bidirectional link\n");
1550 if (dup_status == BATADV_NEIGH_DUP) {
1551 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1552 "Drop packet: duplicate packet received\n");
1556 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1557 "Forwarding packet: rebroadcast originator packet\n");
1558 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1559 is_single_hop_neigh, is_from_best_next_hop,
1560 if_incoming, if_outgoing);
1563 if ((orig_neigh_node) && (!is_single_hop_neigh))
1564 batadv_orig_node_free_ref(orig_neigh_node);
1567 batadv_neigh_ifinfo_free_ref(router_ifinfo);
1569 batadv_neigh_node_free_ref(router);
1571 batadv_neigh_node_free_ref(router_router);
1572 if (orig_neigh_router)
1573 batadv_neigh_node_free_ref(orig_neigh_router);
1575 batadv_hardif_neigh_free_ref(hardif_neigh);
1577 kfree_skb(skb_priv);
1581 * batadv_iv_ogm_process - process an incoming batman iv OGM
1582 * @skb: the skb containing the OGM
1583 * @ogm_offset: offset to the OGM which should be processed (for aggregates)
1584 * @if_incoming: the interface where this packet was receved
1586 static void batadv_iv_ogm_process(const struct sk_buff *skb, int ogm_offset,
1587 struct batadv_hard_iface *if_incoming)
1589 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1590 struct batadv_orig_node *orig_neigh_node, *orig_node;
1591 struct batadv_hard_iface *hard_iface;
1592 struct batadv_ogm_packet *ogm_packet;
1593 u32 if_incoming_seqno;
1594 bool has_directlink_flag;
1595 struct ethhdr *ethhdr;
1596 bool is_my_oldorig = false;
1597 bool is_my_addr = false;
1598 bool is_my_orig = false;
1600 ogm_packet = (struct batadv_ogm_packet *)(skb->data + ogm_offset);
1601 ethhdr = eth_hdr(skb);
1603 /* Silently drop when the batman packet is actually not a
1606 * This might happen if a packet is padded (e.g. Ethernet has a
1607 * minimum frame length of 64 byte) and the aggregation interprets
1608 * it as an additional length.
1610 * TODO: A more sane solution would be to have a bit in the
1611 * batadv_ogm_packet to detect whether the packet is the last
1612 * packet in an aggregation. Here we expect that the padding
1613 * is always zero (or not 0x01)
1615 if (ogm_packet->packet_type != BATADV_IV_OGM)
1618 /* could be changed by schedule_own_packet() */
1619 if_incoming_seqno = atomic_read(&if_incoming->bat_iv.ogm_seqno);
1621 if (ogm_packet->flags & BATADV_DIRECTLINK)
1622 has_directlink_flag = true;
1624 has_directlink_flag = false;
1626 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1627 "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",
1628 ethhdr->h_source, if_incoming->net_dev->name,
1629 if_incoming->net_dev->dev_addr, ogm_packet->orig,
1630 ogm_packet->prev_sender, ntohl(ogm_packet->seqno),
1631 ogm_packet->tq, ogm_packet->ttl,
1632 ogm_packet->version, has_directlink_flag);
1635 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1636 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1639 if (hard_iface->soft_iface != if_incoming->soft_iface)
1642 if (batadv_compare_eth(ethhdr->h_source,
1643 hard_iface->net_dev->dev_addr))
1646 if (batadv_compare_eth(ogm_packet->orig,
1647 hard_iface->net_dev->dev_addr))
1650 if (batadv_compare_eth(ogm_packet->prev_sender,
1651 hard_iface->net_dev->dev_addr))
1652 is_my_oldorig = true;
1657 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1658 "Drop packet: received my own broadcast (sender: %pM)\n",
1664 unsigned long *word;
1670 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1672 if (!orig_neigh_node)
1675 /* neighbor has to indicate direct link and it has to
1676 * come via the corresponding interface
1677 * save packet seqno for bidirectional check
1679 if (has_directlink_flag &&
1680 batadv_compare_eth(if_incoming->net_dev->dev_addr,
1681 ogm_packet->orig)) {
1682 if_num = if_incoming->if_num;
1683 offset = if_num * BATADV_NUM_WORDS;
1685 spin_lock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1686 word = &orig_neigh_node->bat_iv.bcast_own[offset];
1687 bit_pos = if_incoming_seqno - 2;
1688 bit_pos -= ntohl(ogm_packet->seqno);
1689 batadv_set_bit(word, bit_pos);
1690 weight = &orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1691 *weight = bitmap_weight(word,
1692 BATADV_TQ_LOCAL_WINDOW_SIZE);
1693 spin_unlock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1696 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1697 "Drop packet: originator packet from myself (via neighbor)\n");
1698 batadv_orig_node_free_ref(orig_neigh_node);
1702 if (is_my_oldorig) {
1703 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1704 "Drop packet: ignoring all rebroadcast echos (sender: %pM)\n",
1709 if (ogm_packet->flags & BATADV_NOT_BEST_NEXT_HOP) {
1710 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1711 "Drop packet: ignoring all packets not forwarded from the best next hop (sender: %pM)\n",
1716 orig_node = batadv_iv_ogm_orig_get(bat_priv, ogm_packet->orig);
1720 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1721 if_incoming, BATADV_IF_DEFAULT);
1724 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1725 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1728 if (hard_iface->soft_iface != bat_priv->soft_iface)
1731 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1732 if_incoming, hard_iface);
1736 batadv_orig_node_free_ref(orig_node);
1739 static int batadv_iv_ogm_receive(struct sk_buff *skb,
1740 struct batadv_hard_iface *if_incoming)
1742 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1743 struct batadv_ogm_packet *ogm_packet;
1748 ret = batadv_check_management_packet(skb, if_incoming, BATADV_OGM_HLEN);
1752 /* did we receive a B.A.T.M.A.N. IV OGM packet on an interface
1753 * that does not have B.A.T.M.A.N. IV enabled ?
1755 if (bat_priv->bat_algo_ops->bat_ogm_emit != batadv_iv_ogm_emit)
1758 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_RX);
1759 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_RX_BYTES,
1760 skb->len + ETH_HLEN);
1763 ogm_packet = (struct batadv_ogm_packet *)skb->data;
1765 /* unpack the aggregated packets and process them one by one */
1766 while (batadv_iv_ogm_aggr_packet(ogm_offset, skb_headlen(skb),
1767 ogm_packet->tvlv_len)) {
1768 batadv_iv_ogm_process(skb, ogm_offset, if_incoming);
1770 ogm_offset += BATADV_OGM_HLEN;
1771 ogm_offset += ntohs(ogm_packet->tvlv_len);
1773 packet_pos = skb->data + ogm_offset;
1774 ogm_packet = (struct batadv_ogm_packet *)packet_pos;
1778 return NET_RX_SUCCESS;
1782 * batadv_iv_ogm_orig_print_neigh - print neighbors for the originator table
1783 * @orig_node: the orig_node for which the neighbors are printed
1784 * @if_outgoing: outgoing interface for these entries
1785 * @seq: debugfs table seq_file struct
1787 * Must be called while holding an rcu lock.
1790 batadv_iv_ogm_orig_print_neigh(struct batadv_orig_node *orig_node,
1791 struct batadv_hard_iface *if_outgoing,
1792 struct seq_file *seq)
1794 struct batadv_neigh_node *neigh_node;
1795 struct batadv_neigh_ifinfo *n_ifinfo;
1797 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1798 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
1802 seq_printf(seq, " %pM (%3i)",
1804 n_ifinfo->bat_iv.tq_avg);
1806 batadv_neigh_ifinfo_free_ref(n_ifinfo);
1811 * batadv_iv_ogm_orig_print - print the originator table
1812 * @bat_priv: the bat priv with all the soft interface information
1813 * @seq: debugfs table seq_file struct
1814 * @if_outgoing: the outgoing interface for which this should be printed
1816 static void batadv_iv_ogm_orig_print(struct batadv_priv *bat_priv,
1817 struct seq_file *seq,
1818 struct batadv_hard_iface *if_outgoing)
1820 struct batadv_neigh_node *neigh_node;
1821 struct batadv_hashtable *hash = bat_priv->orig_hash;
1822 int last_seen_msecs, last_seen_secs;
1823 struct batadv_orig_node *orig_node;
1824 struct batadv_neigh_ifinfo *n_ifinfo;
1825 unsigned long last_seen_jiffies;
1826 struct hlist_head *head;
1827 int batman_count = 0;
1830 seq_printf(seq, " %-15s %s (%s/%i) %17s [%10s]: %20s ...\n",
1831 "Originator", "last-seen", "#", BATADV_TQ_MAX_VALUE,
1832 "Nexthop", "outgoingIF", "Potential nexthops");
1834 for (i = 0; i < hash->size; i++) {
1835 head = &hash->table[i];
1838 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
1839 neigh_node = batadv_orig_router_get(orig_node,
1844 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node,
1849 if (n_ifinfo->bat_iv.tq_avg == 0)
1852 last_seen_jiffies = jiffies - orig_node->last_seen;
1853 last_seen_msecs = jiffies_to_msecs(last_seen_jiffies);
1854 last_seen_secs = last_seen_msecs / 1000;
1855 last_seen_msecs = last_seen_msecs % 1000;
1857 seq_printf(seq, "%pM %4i.%03is (%3i) %pM [%10s]:",
1858 orig_node->orig, last_seen_secs,
1859 last_seen_msecs, n_ifinfo->bat_iv.tq_avg,
1861 neigh_node->if_incoming->net_dev->name);
1863 batadv_iv_ogm_orig_print_neigh(orig_node, if_outgoing,
1865 seq_puts(seq, "\n");
1869 batadv_neigh_node_free_ref(neigh_node);
1871 batadv_neigh_ifinfo_free_ref(n_ifinfo);
1876 if (batman_count == 0)
1877 seq_puts(seq, "No batman nodes in range ...\n");
1881 * batadv_iv_hardif_neigh_print - print a single hop neighbour node
1882 * @seq: neighbour table seq_file struct
1883 * @hardif_neigh: hardif neighbour information
1886 batadv_iv_hardif_neigh_print(struct seq_file *seq,
1887 struct batadv_hardif_neigh_node *hardif_neigh)
1889 int last_secs, last_msecs;
1891 last_secs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) / 1000;
1892 last_msecs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) % 1000;
1894 seq_printf(seq, " %10s %pM %4i.%03is\n",
1895 hardif_neigh->if_incoming->net_dev->name,
1896 hardif_neigh->addr, last_secs, last_msecs);
1900 * batadv_iv_ogm_neigh_print - print the single hop neighbour list
1901 * @bat_priv: the bat priv with all the soft interface information
1902 * @seq: neighbour table seq_file struct
1904 static void batadv_iv_neigh_print(struct batadv_priv *bat_priv,
1905 struct seq_file *seq)
1907 struct net_device *net_dev = (struct net_device *)seq->private;
1908 struct batadv_hardif_neigh_node *hardif_neigh;
1909 struct batadv_hard_iface *hard_iface;
1910 int batman_count = 0;
1912 seq_printf(seq, " %10s %-13s %s\n",
1913 "IF", "Neighbor", "last-seen");
1916 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1917 if (hard_iface->soft_iface != net_dev)
1920 hlist_for_each_entry_rcu(hardif_neigh,
1921 &hard_iface->neigh_list, list) {
1922 batadv_iv_hardif_neigh_print(seq, hardif_neigh);
1928 if (batman_count == 0)
1929 seq_puts(seq, "No batman nodes in range ...\n");
1933 * batadv_iv_ogm_neigh_cmp - compare the metrics of two neighbors
1934 * @neigh1: the first neighbor object of the comparison
1935 * @if_outgoing1: outgoing interface for the first neighbor
1936 * @neigh2: the second neighbor object of the comparison
1937 * @if_outgoing2: outgoing interface for the second neighbor
1939 * Return: a value less, equal to or greater than 0 if the metric via neigh1 is
1940 * lower, the same as or higher than the metric via neigh2
1942 static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
1943 struct batadv_hard_iface *if_outgoing1,
1944 struct batadv_neigh_node *neigh2,
1945 struct batadv_hard_iface *if_outgoing2)
1947 struct batadv_neigh_ifinfo *neigh1_ifinfo, *neigh2_ifinfo;
1951 neigh1_ifinfo = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
1952 neigh2_ifinfo = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
1954 if (!neigh1_ifinfo || !neigh2_ifinfo) {
1959 tq1 = neigh1_ifinfo->bat_iv.tq_avg;
1960 tq2 = neigh2_ifinfo->bat_iv.tq_avg;
1965 batadv_neigh_ifinfo_free_ref(neigh1_ifinfo);
1967 batadv_neigh_ifinfo_free_ref(neigh2_ifinfo);
1973 * batadv_iv_ogm_neigh_is_sob - check if neigh1 is similarly good or better
1974 * than neigh2 from the metric prospective
1975 * @neigh1: the first neighbor object of the comparison
1976 * @if_outgoing1: outgoing interface for the first neighbor
1977 * @neigh2: the second neighbor object of the comparison
1978 * @if_outgoing2: outgoing interface for the second neighbor
1980 * Return: true if the metric via neigh1 is equally good or better than
1981 * the metric via neigh2, false otherwise.
1984 batadv_iv_ogm_neigh_is_sob(struct batadv_neigh_node *neigh1,
1985 struct batadv_hard_iface *if_outgoing1,
1986 struct batadv_neigh_node *neigh2,
1987 struct batadv_hard_iface *if_outgoing2)
1989 struct batadv_neigh_ifinfo *neigh1_ifinfo, *neigh2_ifinfo;
1993 neigh1_ifinfo = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
1994 neigh2_ifinfo = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
1996 /* we can't say that the metric is better */
1997 if (!neigh1_ifinfo || !neigh2_ifinfo) {
2002 tq1 = neigh1_ifinfo->bat_iv.tq_avg;
2003 tq2 = neigh2_ifinfo->bat_iv.tq_avg;
2004 ret = (tq1 - tq2) > -BATADV_TQ_SIMILARITY_THRESHOLD;
2008 batadv_neigh_ifinfo_free_ref(neigh1_ifinfo);
2010 batadv_neigh_ifinfo_free_ref(neigh2_ifinfo);
2015 static struct batadv_algo_ops batadv_batman_iv __read_mostly = {
2016 .name = "BATMAN_IV",
2017 .bat_iface_enable = batadv_iv_ogm_iface_enable,
2018 .bat_iface_disable = batadv_iv_ogm_iface_disable,
2019 .bat_iface_update_mac = batadv_iv_ogm_iface_update_mac,
2020 .bat_primary_iface_set = batadv_iv_ogm_primary_iface_set,
2021 .bat_ogm_schedule = batadv_iv_ogm_schedule,
2022 .bat_ogm_emit = batadv_iv_ogm_emit,
2023 .bat_neigh_cmp = batadv_iv_ogm_neigh_cmp,
2024 .bat_neigh_is_similar_or_better = batadv_iv_ogm_neigh_is_sob,
2025 .bat_neigh_print = batadv_iv_neigh_print,
2026 .bat_orig_print = batadv_iv_ogm_orig_print,
2027 .bat_orig_free = batadv_iv_ogm_orig_free,
2028 .bat_orig_add_if = batadv_iv_ogm_orig_add_if,
2029 .bat_orig_del_if = batadv_iv_ogm_orig_del_if,
2032 int __init batadv_iv_init(void)
2036 /* batman originator packet */
2037 ret = batadv_recv_handler_register(BATADV_IV_OGM,
2038 batadv_iv_ogm_receive);
2042 ret = batadv_algo_register(&batadv_batman_iv);
2044 goto handler_unregister;
2049 batadv_recv_handler_unregister(BATADV_IV_OGM);