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/>.
18 #include "bat_iv_ogm.h"
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/kernel.h>
34 #include <linux/kref.h>
35 #include <linux/list.h>
36 #include <linux/lockdep.h>
37 #include <linux/netdevice.h>
38 #include <linux/pkt_sched.h>
39 #include <linux/printk.h>
40 #include <linux/random.h>
41 #include <linux/rculist.h>
42 #include <linux/rcupdate.h>
43 #include <linux/seq_file.h>
44 #include <linux/skbuff.h>
45 #include <linux/slab.h>
46 #include <linux/spinlock.h>
47 #include <linux/stddef.h>
48 #include <linux/string.h>
49 #include <linux/types.h>
50 #include <linux/workqueue.h>
54 #include "gateway_client.h"
55 #include "hard-interface.h"
58 #include "network-coding.h"
59 #include "originator.h"
63 #include "translation-table.h"
66 static void batadv_iv_send_outstanding_bat_ogm_packet(struct work_struct *work);
69 * enum batadv_dup_status - duplicate status
70 * @BATADV_NO_DUP: the packet is no duplicate
71 * @BATADV_ORIG_DUP: OGM is a duplicate in the originator (but not for the
73 * @BATADV_NEIGH_DUP: OGM is a duplicate for the neighbor
74 * @BATADV_PROTECTED: originator is currently protected (after reboot)
76 enum batadv_dup_status {
84 * batadv_ring_buffer_set - update the ring buffer with the given value
85 * @lq_recv: pointer to the ring buffer
86 * @lq_index: index to store the value at
87 * @value: value to store in the ring buffer
89 static void batadv_ring_buffer_set(u8 lq_recv[], u8 *lq_index, u8 value)
91 lq_recv[*lq_index] = value;
92 *lq_index = (*lq_index + 1) % BATADV_TQ_GLOBAL_WINDOW_SIZE;
96 * batadv_ring_buffer_avg - compute the average of all non-zero values stored
97 * in the given ring buffer
98 * @lq_recv: pointer to the ring buffer
100 * Return: computed average value.
102 static u8 batadv_ring_buffer_avg(const u8 lq_recv[])
111 while (i < BATADV_TQ_GLOBAL_WINDOW_SIZE) {
124 return (u8)(sum / count);
128 * batadv_iv_ogm_orig_free - free the private resources allocated for this
130 * @orig_node: the orig_node for which the resources have to be free'd
132 static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node)
134 kfree(orig_node->bat_iv.bcast_own);
135 kfree(orig_node->bat_iv.bcast_own_sum);
139 * batadv_iv_ogm_orig_add_if - change the private structures of the orig_node to
140 * include the new hard-interface
141 * @orig_node: the orig_node that has to be changed
142 * @max_if_num: the current amount of interfaces
144 * Return: 0 on success, a negative error code otherwise.
146 static int batadv_iv_ogm_orig_add_if(struct batadv_orig_node *orig_node,
153 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
155 old_size = (max_if_num - 1) * sizeof(unsigned long) * BATADV_NUM_WORDS;
156 data_ptr = kmalloc_array(max_if_num,
157 BATADV_NUM_WORDS * sizeof(unsigned long),
162 memcpy(data_ptr, orig_node->bat_iv.bcast_own, old_size);
163 kfree(orig_node->bat_iv.bcast_own);
164 orig_node->bat_iv.bcast_own = data_ptr;
166 data_ptr = kmalloc_array(max_if_num, sizeof(u8), GFP_ATOMIC);
170 memcpy(data_ptr, orig_node->bat_iv.bcast_own_sum,
171 (max_if_num - 1) * sizeof(u8));
172 kfree(orig_node->bat_iv.bcast_own_sum);
173 orig_node->bat_iv.bcast_own_sum = data_ptr;
178 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
184 * batadv_iv_ogm_drop_bcast_own_entry - drop section of bcast_own
185 * @orig_node: the orig_node that has to be changed
186 * @max_if_num: the current amount of interfaces
187 * @del_if_num: the index of the interface being removed
190 batadv_iv_ogm_drop_bcast_own_entry(struct batadv_orig_node *orig_node,
191 int max_if_num, int del_if_num)
197 lockdep_assert_held(&orig_node->bat_iv.ogm_cnt_lock);
199 chunk_size = sizeof(unsigned long) * BATADV_NUM_WORDS;
200 data_ptr = kmalloc_array(max_if_num, chunk_size, GFP_ATOMIC);
202 /* use old buffer when new one could not be allocated */
203 data_ptr = orig_node->bat_iv.bcast_own;
205 /* copy first part */
206 memmove(data_ptr, orig_node->bat_iv.bcast_own, del_if_num * chunk_size);
208 /* copy second part */
209 if_offset = (del_if_num + 1) * chunk_size;
210 memmove((char *)data_ptr + del_if_num * chunk_size,
211 (uint8_t *)orig_node->bat_iv.bcast_own + if_offset,
212 (max_if_num - del_if_num) * chunk_size);
214 /* bcast_own was shrunk down in new buffer; free old one */
215 if (orig_node->bat_iv.bcast_own != data_ptr) {
216 kfree(orig_node->bat_iv.bcast_own);
217 orig_node->bat_iv.bcast_own = data_ptr;
222 * batadv_iv_ogm_drop_bcast_own_sum_entry - drop section of bcast_own_sum
223 * @orig_node: the orig_node that has to be changed
224 * @max_if_num: the current amount of interfaces
225 * @del_if_num: the index of the interface being removed
228 batadv_iv_ogm_drop_bcast_own_sum_entry(struct batadv_orig_node *orig_node,
229 int max_if_num, int del_if_num)
234 lockdep_assert_held(&orig_node->bat_iv.ogm_cnt_lock);
236 data_ptr = kmalloc_array(max_if_num, sizeof(u8), GFP_ATOMIC);
238 /* use old buffer when new one could not be allocated */
239 data_ptr = orig_node->bat_iv.bcast_own_sum;
241 memmove(data_ptr, orig_node->bat_iv.bcast_own_sum,
242 del_if_num * sizeof(u8));
244 if_offset = (del_if_num + 1) * sizeof(u8);
245 memmove((char *)data_ptr + del_if_num * sizeof(u8),
246 orig_node->bat_iv.bcast_own_sum + if_offset,
247 (max_if_num - del_if_num) * sizeof(u8));
249 /* bcast_own_sum was shrunk down in new buffer; free old one */
250 if (orig_node->bat_iv.bcast_own_sum != data_ptr) {
251 kfree(orig_node->bat_iv.bcast_own_sum);
252 orig_node->bat_iv.bcast_own_sum = data_ptr;
257 * batadv_iv_ogm_orig_del_if - change the private structures of the orig_node to
258 * exclude the removed interface
259 * @orig_node: the orig_node that has to be changed
260 * @max_if_num: the current amount of interfaces
261 * @del_if_num: the index of the interface being removed
263 * Return: 0 on success, a negative error code otherwise.
265 static int batadv_iv_ogm_orig_del_if(struct batadv_orig_node *orig_node,
266 int max_if_num, int del_if_num)
268 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
270 if (max_if_num == 0) {
271 kfree(orig_node->bat_iv.bcast_own);
272 kfree(orig_node->bat_iv.bcast_own_sum);
273 orig_node->bat_iv.bcast_own = NULL;
274 orig_node->bat_iv.bcast_own_sum = NULL;
276 batadv_iv_ogm_drop_bcast_own_entry(orig_node, max_if_num,
278 batadv_iv_ogm_drop_bcast_own_sum_entry(orig_node, max_if_num,
282 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
288 * batadv_iv_ogm_orig_get - retrieve or create (if does not exist) an originator
289 * @bat_priv: the bat priv with all the soft interface information
290 * @addr: mac address of the originator
292 * Return: the originator object corresponding to the passed mac address or NULL
294 * If the object does not exists it is created an initialised.
296 static struct batadv_orig_node *
297 batadv_iv_ogm_orig_get(struct batadv_priv *bat_priv, const u8 *addr)
299 struct batadv_orig_node *orig_node;
300 int size, hash_added;
302 orig_node = batadv_orig_hash_find(bat_priv, addr);
306 orig_node = batadv_orig_node_new(bat_priv, addr);
310 spin_lock_init(&orig_node->bat_iv.ogm_cnt_lock);
312 size = bat_priv->num_ifaces * sizeof(unsigned long) * BATADV_NUM_WORDS;
313 orig_node->bat_iv.bcast_own = kzalloc(size, GFP_ATOMIC);
314 if (!orig_node->bat_iv.bcast_own)
317 size = bat_priv->num_ifaces * sizeof(u8);
318 orig_node->bat_iv.bcast_own_sum = kzalloc(size, GFP_ATOMIC);
319 if (!orig_node->bat_iv.bcast_own_sum)
322 hash_added = batadv_hash_add(bat_priv->orig_hash, batadv_compare_orig,
323 batadv_choose_orig, orig_node,
324 &orig_node->hash_entry);
331 /* free twice, as batadv_orig_node_new sets refcount to 2 */
332 batadv_orig_node_put(orig_node);
333 batadv_orig_node_put(orig_node);
338 static struct batadv_neigh_node *
339 batadv_iv_ogm_neigh_new(struct batadv_hard_iface *hard_iface,
340 const u8 *neigh_addr,
341 struct batadv_orig_node *orig_node,
342 struct batadv_orig_node *orig_neigh)
344 struct batadv_neigh_node *neigh_node;
346 neigh_node = batadv_neigh_node_get_or_create(orig_node,
347 hard_iface, neigh_addr);
351 neigh_node->orig_node = orig_neigh;
357 static int batadv_iv_ogm_iface_enable(struct batadv_hard_iface *hard_iface)
359 struct batadv_ogm_packet *batadv_ogm_packet;
360 unsigned char *ogm_buff;
363 /* randomize initial seqno to avoid collision */
364 get_random_bytes(&random_seqno, sizeof(random_seqno));
365 atomic_set(&hard_iface->bat_iv.ogm_seqno, random_seqno);
367 hard_iface->bat_iv.ogm_buff_len = BATADV_OGM_HLEN;
368 ogm_buff = kmalloc(hard_iface->bat_iv.ogm_buff_len, GFP_ATOMIC);
372 hard_iface->bat_iv.ogm_buff = ogm_buff;
374 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
375 batadv_ogm_packet->packet_type = BATADV_IV_OGM;
376 batadv_ogm_packet->version = BATADV_COMPAT_VERSION;
377 batadv_ogm_packet->ttl = 2;
378 batadv_ogm_packet->flags = BATADV_NO_FLAGS;
379 batadv_ogm_packet->reserved = 0;
380 batadv_ogm_packet->tq = BATADV_TQ_MAX_VALUE;
385 static void batadv_iv_ogm_iface_disable(struct batadv_hard_iface *hard_iface)
387 kfree(hard_iface->bat_iv.ogm_buff);
388 hard_iface->bat_iv.ogm_buff = NULL;
391 static void batadv_iv_ogm_iface_update_mac(struct batadv_hard_iface *hard_iface)
393 struct batadv_ogm_packet *batadv_ogm_packet;
394 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
396 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
397 ether_addr_copy(batadv_ogm_packet->orig,
398 hard_iface->net_dev->dev_addr);
399 ether_addr_copy(batadv_ogm_packet->prev_sender,
400 hard_iface->net_dev->dev_addr);
404 batadv_iv_ogm_primary_iface_set(struct batadv_hard_iface *hard_iface)
406 struct batadv_ogm_packet *batadv_ogm_packet;
407 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
409 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
410 batadv_ogm_packet->ttl = BATADV_TTL;
413 /* when do we schedule our own ogm to be sent */
415 batadv_iv_ogm_emit_send_time(const struct batadv_priv *bat_priv)
419 msecs = atomic_read(&bat_priv->orig_interval) - BATADV_JITTER;
420 msecs += prandom_u32() % (2 * BATADV_JITTER);
422 return jiffies + msecs_to_jiffies(msecs);
425 /* when do we schedule a ogm packet to be sent */
426 static unsigned long batadv_iv_ogm_fwd_send_time(void)
428 return jiffies + msecs_to_jiffies(prandom_u32() % (BATADV_JITTER / 2));
431 /* apply hop penalty for a normal link */
432 static u8 batadv_hop_penalty(u8 tq, const struct batadv_priv *bat_priv)
434 int hop_penalty = atomic_read(&bat_priv->hop_penalty);
437 new_tq = tq * (BATADV_TQ_MAX_VALUE - hop_penalty);
438 new_tq /= BATADV_TQ_MAX_VALUE;
444 * batadv_iv_ogm_aggr_packet - checks if there is another OGM attached
445 * @buff_pos: current position in the skb
446 * @packet_len: total length of the skb
447 * @tvlv_len: tvlv length of the previously considered OGM
449 * Return: true if there is enough space for another OGM, false otherwise.
451 static bool batadv_iv_ogm_aggr_packet(int buff_pos, int packet_len,
454 int next_buff_pos = 0;
456 next_buff_pos += buff_pos + BATADV_OGM_HLEN;
457 next_buff_pos += ntohs(tvlv_len);
459 return (next_buff_pos <= packet_len) &&
460 (next_buff_pos <= BATADV_MAX_AGGREGATION_BYTES);
463 /* send a batman ogm to a given interface */
464 static void batadv_iv_ogm_send_to_if(struct batadv_forw_packet *forw_packet,
465 struct batadv_hard_iface *hard_iface)
467 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
471 struct batadv_ogm_packet *batadv_ogm_packet;
475 if (hard_iface->if_status != BATADV_IF_ACTIVE)
480 packet_pos = forw_packet->skb->data;
481 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
483 /* adjust all flags and log packets */
484 while (batadv_iv_ogm_aggr_packet(buff_pos, forw_packet->packet_len,
485 batadv_ogm_packet->tvlv_len)) {
486 /* we might have aggregated direct link packets with an
487 * ordinary base packet
489 if (forw_packet->direct_link_flags & BIT(packet_num) &&
490 forw_packet->if_incoming == hard_iface)
491 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
493 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
495 if (packet_num > 0 || !forw_packet->own)
496 fwd_str = "Forwarding";
498 fwd_str = "Sending own";
500 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
501 "%s %spacket (originator %pM, seqno %u, TQ %d, TTL %d, IDF %s) on interface %s [%pM]\n",
502 fwd_str, (packet_num > 0 ? "aggregated " : ""),
503 batadv_ogm_packet->orig,
504 ntohl(batadv_ogm_packet->seqno),
505 batadv_ogm_packet->tq, batadv_ogm_packet->ttl,
506 ((batadv_ogm_packet->flags & BATADV_DIRECTLINK) ?
508 hard_iface->net_dev->name,
509 hard_iface->net_dev->dev_addr);
511 buff_pos += BATADV_OGM_HLEN;
512 buff_pos += ntohs(batadv_ogm_packet->tvlv_len);
514 packet_pos = forw_packet->skb->data + buff_pos;
515 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
518 /* create clone because function is called more than once */
519 skb = skb_clone(forw_packet->skb, GFP_ATOMIC);
521 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_TX);
522 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_TX_BYTES,
523 skb->len + ETH_HLEN);
524 batadv_send_broadcast_skb(skb, hard_iface);
528 /* send a batman ogm packet */
529 static void batadv_iv_ogm_emit(struct batadv_forw_packet *forw_packet)
531 struct net_device *soft_iface;
533 if (!forw_packet->if_incoming) {
534 pr_err("Error - can't forward packet: incoming iface not specified\n");
538 soft_iface = forw_packet->if_incoming->soft_iface;
540 if (WARN_ON(!forw_packet->if_outgoing))
543 if (WARN_ON(forw_packet->if_outgoing->soft_iface != soft_iface))
546 if (forw_packet->if_incoming->if_status != BATADV_IF_ACTIVE)
549 /* only for one specific outgoing interface */
550 batadv_iv_ogm_send_to_if(forw_packet, forw_packet->if_outgoing);
554 * batadv_iv_ogm_can_aggregate - find out if an OGM can be aggregated on an
555 * existing forward packet
556 * @new_bat_ogm_packet: OGM packet to be aggregated
557 * @bat_priv: the bat priv with all the soft interface information
558 * @packet_len: (total) length of the OGM
559 * @send_time: timestamp (jiffies) when the packet is to be sent
560 * @directlink: true if this is a direct link packet
561 * @if_incoming: interface where the packet was received
562 * @if_outgoing: interface for which the retransmission should be considered
563 * @forw_packet: the forwarded packet which should be checked
565 * Return: true if new_packet can be aggregated with forw_packet
568 batadv_iv_ogm_can_aggregate(const struct batadv_ogm_packet *new_bat_ogm_packet,
569 struct batadv_priv *bat_priv,
570 int packet_len, unsigned long send_time,
572 const struct batadv_hard_iface *if_incoming,
573 const struct batadv_hard_iface *if_outgoing,
574 const struct batadv_forw_packet *forw_packet)
576 struct batadv_ogm_packet *batadv_ogm_packet;
577 int aggregated_bytes = forw_packet->packet_len + packet_len;
578 struct batadv_hard_iface *primary_if = NULL;
580 unsigned long aggregation_end_time;
582 batadv_ogm_packet = (struct batadv_ogm_packet *)forw_packet->skb->data;
583 aggregation_end_time = send_time;
584 aggregation_end_time += msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
586 /* we can aggregate the current packet to this aggregated packet
589 * - the send time is within our MAX_AGGREGATION_MS time
590 * - the resulting packet wont be bigger than
591 * MAX_AGGREGATION_BYTES
592 * otherwise aggregation is not possible
594 if (!time_before(send_time, forw_packet->send_time) ||
595 !time_after_eq(aggregation_end_time, forw_packet->send_time))
598 if (aggregated_bytes > BATADV_MAX_AGGREGATION_BYTES)
601 /* packet is not leaving on the same interface. */
602 if (forw_packet->if_outgoing != if_outgoing)
605 /* check aggregation compatibility
606 * -> direct link packets are broadcasted on
607 * their interface only
608 * -> aggregate packet if the current packet is
609 * a "global" packet as well as the base
612 primary_if = batadv_primary_if_get_selected(bat_priv);
616 /* packets without direct link flag and high TTL
617 * are flooded through the net
620 !(batadv_ogm_packet->flags & BATADV_DIRECTLINK) &&
621 batadv_ogm_packet->ttl != 1 &&
623 /* own packets originating non-primary
624 * interfaces leave only that interface
626 (!forw_packet->own ||
627 forw_packet->if_incoming == primary_if)) {
632 /* if the incoming packet is sent via this one
633 * interface only - we still can aggregate
636 new_bat_ogm_packet->ttl == 1 &&
637 forw_packet->if_incoming == if_incoming &&
639 /* packets from direct neighbors or
640 * own secondary interface packets
641 * (= secondary interface packets in general)
643 (batadv_ogm_packet->flags & BATADV_DIRECTLINK ||
645 forw_packet->if_incoming != primary_if))) {
652 batadv_hardif_put(primary_if);
657 * batadv_iv_ogm_aggregate_new - create a new aggregated packet and add this
659 * @packet_buff: pointer to the OGM
660 * @packet_len: (total) length of the OGM
661 * @send_time: timestamp (jiffies) when the packet is to be sent
662 * @direct_link: whether this OGM has direct link status
663 * @if_incoming: interface where the packet was received
664 * @if_outgoing: interface for which the retransmission should be considered
665 * @own_packet: true if it is a self-generated ogm
667 static void batadv_iv_ogm_aggregate_new(const unsigned char *packet_buff,
668 int packet_len, unsigned long send_time,
670 struct batadv_hard_iface *if_incoming,
671 struct batadv_hard_iface *if_outgoing,
674 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
675 struct batadv_forw_packet *forw_packet_aggr;
676 unsigned char *skb_buff;
677 unsigned int skb_size;
678 atomic_t *queue_left = own_packet ? NULL : &bat_priv->batman_queue_left;
680 forw_packet_aggr = batadv_forw_packet_alloc(if_incoming, if_outgoing,
681 queue_left, bat_priv);
682 if (!forw_packet_aggr)
685 if (atomic_read(&bat_priv->aggregated_ogms) &&
686 packet_len < BATADV_MAX_AGGREGATION_BYTES)
687 skb_size = BATADV_MAX_AGGREGATION_BYTES;
689 skb_size = packet_len;
691 skb_size += ETH_HLEN;
693 forw_packet_aggr->skb = netdev_alloc_skb_ip_align(NULL, skb_size);
694 if (!forw_packet_aggr->skb) {
695 batadv_forw_packet_free(forw_packet_aggr);
699 forw_packet_aggr->skb->priority = TC_PRIO_CONTROL;
700 skb_reserve(forw_packet_aggr->skb, ETH_HLEN);
702 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
703 forw_packet_aggr->packet_len = packet_len;
704 memcpy(skb_buff, packet_buff, packet_len);
706 forw_packet_aggr->own = own_packet;
707 forw_packet_aggr->direct_link_flags = BATADV_NO_FLAGS;
708 forw_packet_aggr->send_time = send_time;
710 /* save packet direct link flag status */
712 forw_packet_aggr->direct_link_flags |= 1;
714 /* add new packet to packet list */
715 spin_lock_bh(&bat_priv->forw_bat_list_lock);
716 hlist_add_head(&forw_packet_aggr->list, &bat_priv->forw_bat_list);
717 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
719 /* start timer for this packet */
720 INIT_DELAYED_WORK(&forw_packet_aggr->delayed_work,
721 batadv_iv_send_outstanding_bat_ogm_packet);
722 queue_delayed_work(batadv_event_workqueue,
723 &forw_packet_aggr->delayed_work,
724 send_time - jiffies);
727 /* aggregate a new packet into the existing ogm packet */
728 static void batadv_iv_ogm_aggregate(struct batadv_forw_packet *forw_packet_aggr,
729 const unsigned char *packet_buff,
730 int packet_len, bool direct_link)
732 unsigned char *skb_buff;
733 unsigned long new_direct_link_flag;
735 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
736 memcpy(skb_buff, packet_buff, packet_len);
737 forw_packet_aggr->packet_len += packet_len;
738 forw_packet_aggr->num_packets++;
740 /* save packet direct link flag status */
742 new_direct_link_flag = BIT(forw_packet_aggr->num_packets);
743 forw_packet_aggr->direct_link_flags |= new_direct_link_flag;
748 * batadv_iv_ogm_queue_add - queue up an OGM for transmission
749 * @bat_priv: the bat priv with all the soft interface information
750 * @packet_buff: pointer to the OGM
751 * @packet_len: (total) length of the OGM
752 * @if_incoming: interface where the packet was received
753 * @if_outgoing: interface for which the retransmission should be considered
754 * @own_packet: true if it is a self-generated ogm
755 * @send_time: timestamp (jiffies) when the packet is to be sent
757 static void batadv_iv_ogm_queue_add(struct batadv_priv *bat_priv,
758 unsigned char *packet_buff,
760 struct batadv_hard_iface *if_incoming,
761 struct batadv_hard_iface *if_outgoing,
762 int own_packet, unsigned long send_time)
764 /* _aggr -> pointer to the packet we want to aggregate with
765 * _pos -> pointer to the position in the queue
767 struct batadv_forw_packet *forw_packet_aggr = NULL;
768 struct batadv_forw_packet *forw_packet_pos = NULL;
769 struct batadv_ogm_packet *batadv_ogm_packet;
771 unsigned long max_aggregation_jiffies;
773 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_buff;
774 direct_link = !!(batadv_ogm_packet->flags & BATADV_DIRECTLINK);
775 max_aggregation_jiffies = msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
777 /* find position for the packet in the forward queue */
778 spin_lock_bh(&bat_priv->forw_bat_list_lock);
779 /* own packets are not to be aggregated */
780 if (atomic_read(&bat_priv->aggregated_ogms) && !own_packet) {
781 hlist_for_each_entry(forw_packet_pos,
782 &bat_priv->forw_bat_list, list) {
783 if (batadv_iv_ogm_can_aggregate(batadv_ogm_packet,
784 bat_priv, packet_len,
785 send_time, direct_link,
789 forw_packet_aggr = forw_packet_pos;
795 /* nothing to aggregate with - either aggregation disabled or no
796 * suitable aggregation packet found
798 if (!forw_packet_aggr) {
799 /* the following section can run without the lock */
800 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
802 /* if we could not aggregate this packet with one of the others
803 * we hold it back for a while, so that it might be aggregated
806 if (!own_packet && atomic_read(&bat_priv->aggregated_ogms))
807 send_time += max_aggregation_jiffies;
809 batadv_iv_ogm_aggregate_new(packet_buff, packet_len,
810 send_time, direct_link,
811 if_incoming, if_outgoing,
814 batadv_iv_ogm_aggregate(forw_packet_aggr, packet_buff,
815 packet_len, direct_link);
816 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
820 static void batadv_iv_ogm_forward(struct batadv_orig_node *orig_node,
821 const struct ethhdr *ethhdr,
822 struct batadv_ogm_packet *batadv_ogm_packet,
823 bool is_single_hop_neigh,
824 bool is_from_best_next_hop,
825 struct batadv_hard_iface *if_incoming,
826 struct batadv_hard_iface *if_outgoing)
828 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
831 if (batadv_ogm_packet->ttl <= 1) {
832 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "ttl exceeded\n");
836 if (!is_from_best_next_hop) {
837 /* Mark the forwarded packet when it is not coming from our
838 * best next hop. We still need to forward the packet for our
839 * neighbor link quality detection to work in case the packet
840 * originated from a single hop neighbor. Otherwise we can
841 * simply drop the ogm.
843 if (is_single_hop_neigh)
844 batadv_ogm_packet->flags |= BATADV_NOT_BEST_NEXT_HOP;
849 tvlv_len = ntohs(batadv_ogm_packet->tvlv_len);
851 batadv_ogm_packet->ttl--;
852 ether_addr_copy(batadv_ogm_packet->prev_sender, ethhdr->h_source);
854 /* apply hop penalty */
855 batadv_ogm_packet->tq = batadv_hop_penalty(batadv_ogm_packet->tq,
858 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
859 "Forwarding packet: tq: %i, ttl: %i\n",
860 batadv_ogm_packet->tq, batadv_ogm_packet->ttl);
862 if (is_single_hop_neigh)
863 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
865 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
867 batadv_iv_ogm_queue_add(bat_priv, (unsigned char *)batadv_ogm_packet,
868 BATADV_OGM_HLEN + tvlv_len,
869 if_incoming, if_outgoing, 0,
870 batadv_iv_ogm_fwd_send_time());
874 * batadv_iv_ogm_slide_own_bcast_window - bitshift own OGM broadcast windows for
875 * the given interface
876 * @hard_iface: the interface for which the windows have to be shifted
879 batadv_iv_ogm_slide_own_bcast_window(struct batadv_hard_iface *hard_iface)
881 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
882 struct batadv_hashtable *hash = bat_priv->orig_hash;
883 struct hlist_head *head;
884 struct batadv_orig_node *orig_node;
891 for (i = 0; i < hash->size; i++) {
892 head = &hash->table[i];
895 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
896 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
897 word_index = hard_iface->if_num * BATADV_NUM_WORDS;
898 word = &orig_node->bat_iv.bcast_own[word_index];
900 batadv_bit_get_packet(bat_priv, word, 1, 0);
901 if_num = hard_iface->if_num;
902 w = &orig_node->bat_iv.bcast_own_sum[if_num];
903 *w = bitmap_weight(word, BATADV_TQ_LOCAL_WINDOW_SIZE);
904 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
910 static void batadv_iv_ogm_schedule(struct batadv_hard_iface *hard_iface)
912 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
913 unsigned char **ogm_buff = &hard_iface->bat_iv.ogm_buff;
914 struct batadv_ogm_packet *batadv_ogm_packet;
915 struct batadv_hard_iface *primary_if, *tmp_hard_iface;
916 int *ogm_buff_len = &hard_iface->bat_iv.ogm_buff_len;
919 unsigned long send_time;
921 if ((hard_iface->if_status == BATADV_IF_NOT_IN_USE) ||
922 (hard_iface->if_status == BATADV_IF_TO_BE_REMOVED))
925 /* the interface gets activated here to avoid race conditions between
926 * the moment of activating the interface in
927 * hardif_activate_interface() where the originator mac is set and
928 * outdated packets (especially uninitialized mac addresses) in the
931 if (hard_iface->if_status == BATADV_IF_TO_BE_ACTIVATED)
932 hard_iface->if_status = BATADV_IF_ACTIVE;
934 primary_if = batadv_primary_if_get_selected(bat_priv);
936 if (hard_iface == primary_if) {
937 /* tt changes have to be committed before the tvlv data is
938 * appended as it may alter the tt tvlv container
940 batadv_tt_local_commit_changes(bat_priv);
941 tvlv_len = batadv_tvlv_container_ogm_append(bat_priv, ogm_buff,
946 batadv_ogm_packet = (struct batadv_ogm_packet *)(*ogm_buff);
947 batadv_ogm_packet->tvlv_len = htons(tvlv_len);
949 /* change sequence number to network order */
950 seqno = (u32)atomic_read(&hard_iface->bat_iv.ogm_seqno);
951 batadv_ogm_packet->seqno = htonl(seqno);
952 atomic_inc(&hard_iface->bat_iv.ogm_seqno);
954 batadv_iv_ogm_slide_own_bcast_window(hard_iface);
956 send_time = batadv_iv_ogm_emit_send_time(bat_priv);
958 if (hard_iface != primary_if) {
959 /* OGMs from secondary interfaces are only scheduled on their
960 * respective interfaces.
962 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff, *ogm_buff_len,
963 hard_iface, hard_iface, 1, send_time);
967 /* OGMs from primary interfaces are scheduled on all
971 list_for_each_entry_rcu(tmp_hard_iface, &batadv_hardif_list, list) {
972 if (tmp_hard_iface->soft_iface != hard_iface->soft_iface)
975 if (!kref_get_unless_zero(&tmp_hard_iface->refcount))
978 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff,
979 *ogm_buff_len, hard_iface,
980 tmp_hard_iface, 1, send_time);
982 batadv_hardif_put(tmp_hard_iface);
988 batadv_hardif_put(primary_if);
992 * batadv_iv_ogm_orig_update - use OGM to update corresponding data in an
994 * @bat_priv: the bat priv with all the soft interface information
995 * @orig_node: the orig node who originally emitted the ogm packet
996 * @orig_ifinfo: ifinfo for the outgoing interface of the orig_node
997 * @ethhdr: Ethernet header of the OGM
998 * @batadv_ogm_packet: the ogm packet
999 * @if_incoming: interface where the packet was received
1000 * @if_outgoing: interface for which the retransmission should be considered
1001 * @dup_status: the duplicate status of this ogm packet.
1004 batadv_iv_ogm_orig_update(struct batadv_priv *bat_priv,
1005 struct batadv_orig_node *orig_node,
1006 struct batadv_orig_ifinfo *orig_ifinfo,
1007 const struct ethhdr *ethhdr,
1008 const struct batadv_ogm_packet *batadv_ogm_packet,
1009 struct batadv_hard_iface *if_incoming,
1010 struct batadv_hard_iface *if_outgoing,
1011 enum batadv_dup_status dup_status)
1013 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL;
1014 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
1015 struct batadv_neigh_node *neigh_node = NULL;
1016 struct batadv_neigh_node *tmp_neigh_node = NULL;
1017 struct batadv_neigh_node *router = NULL;
1018 struct batadv_orig_node *orig_node_tmp;
1020 u8 sum_orig, sum_neigh;
1024 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1025 "update_originator(): Searching and updating originator entry of received packet\n");
1028 hlist_for_each_entry_rcu(tmp_neigh_node,
1029 &orig_node->neigh_list, list) {
1030 neigh_addr = tmp_neigh_node->addr;
1031 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1032 tmp_neigh_node->if_incoming == if_incoming &&
1033 kref_get_unless_zero(&tmp_neigh_node->refcount)) {
1034 if (WARN(neigh_node, "too many matching neigh_nodes"))
1035 batadv_neigh_node_put(neigh_node);
1036 neigh_node = tmp_neigh_node;
1040 if (dup_status != BATADV_NO_DUP)
1043 /* only update the entry for this outgoing interface */
1044 neigh_ifinfo = batadv_neigh_ifinfo_get(tmp_neigh_node,
1049 spin_lock_bh(&tmp_neigh_node->ifinfo_lock);
1050 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1051 &neigh_ifinfo->bat_iv.tq_index, 0);
1052 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1053 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1054 spin_unlock_bh(&tmp_neigh_node->ifinfo_lock);
1056 batadv_neigh_ifinfo_put(neigh_ifinfo);
1057 neigh_ifinfo = NULL;
1061 struct batadv_orig_node *orig_tmp;
1063 orig_tmp = batadv_iv_ogm_orig_get(bat_priv, ethhdr->h_source);
1067 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1069 orig_node, orig_tmp);
1071 batadv_orig_node_put(orig_tmp);
1075 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1076 "Updating existing last-hop neighbor of originator\n");
1080 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1084 neigh_node->last_seen = jiffies;
1086 spin_lock_bh(&neigh_node->ifinfo_lock);
1087 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1088 &neigh_ifinfo->bat_iv.tq_index,
1089 batadv_ogm_packet->tq);
1090 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1091 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1092 spin_unlock_bh(&neigh_node->ifinfo_lock);
1094 if (dup_status == BATADV_NO_DUP) {
1095 orig_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1096 neigh_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1099 /* if this neighbor already is our next hop there is nothing
1102 router = batadv_orig_router_get(orig_node, if_outgoing);
1103 if (router == neigh_node)
1107 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1111 /* if this neighbor does not offer a better TQ we won't
1114 if (router_ifinfo->bat_iv.tq_avg > neigh_ifinfo->bat_iv.tq_avg)
1118 /* if the TQ is the same and the link not more symmetric we
1119 * won't consider it either
1121 if (router_ifinfo &&
1122 neigh_ifinfo->bat_iv.tq_avg == router_ifinfo->bat_iv.tq_avg) {
1123 orig_node_tmp = router->orig_node;
1124 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1125 if_num = router->if_incoming->if_num;
1126 sum_orig = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1127 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1129 orig_node_tmp = neigh_node->orig_node;
1130 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1131 if_num = neigh_node->if_incoming->if_num;
1132 sum_neigh = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1133 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1135 if (sum_orig >= sum_neigh)
1139 batadv_update_route(bat_priv, orig_node, if_outgoing, neigh_node);
1146 batadv_neigh_node_put(neigh_node);
1148 batadv_neigh_node_put(router);
1150 batadv_neigh_ifinfo_put(neigh_ifinfo);
1152 batadv_neigh_ifinfo_put(router_ifinfo);
1156 * batadv_iv_ogm_calc_tq - calculate tq for current received ogm packet
1157 * @orig_node: the orig node who originally emitted the ogm packet
1158 * @orig_neigh_node: the orig node struct of the neighbor who sent the packet
1159 * @batadv_ogm_packet: the ogm packet
1160 * @if_incoming: interface where the packet was received
1161 * @if_outgoing: interface for which the retransmission should be considered
1163 * Return: true if the link can be considered bidirectional, false otherwise
1165 static bool batadv_iv_ogm_calc_tq(struct batadv_orig_node *orig_node,
1166 struct batadv_orig_node *orig_neigh_node,
1167 struct batadv_ogm_packet *batadv_ogm_packet,
1168 struct batadv_hard_iface *if_incoming,
1169 struct batadv_hard_iface *if_outgoing)
1171 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1172 struct batadv_neigh_node *neigh_node = NULL, *tmp_neigh_node;
1173 struct batadv_neigh_ifinfo *neigh_ifinfo;
1175 u8 orig_eq_count, neigh_rq_count, neigh_rq_inv, tq_own;
1176 unsigned int neigh_rq_inv_cube, neigh_rq_max_cube;
1178 unsigned int tq_asym_penalty, inv_asym_penalty;
1179 unsigned int combined_tq;
1180 unsigned int tq_iface_penalty;
1183 /* find corresponding one hop neighbor */
1185 hlist_for_each_entry_rcu(tmp_neigh_node,
1186 &orig_neigh_node->neigh_list, list) {
1187 if (!batadv_compare_eth(tmp_neigh_node->addr,
1188 orig_neigh_node->orig))
1191 if (tmp_neigh_node->if_incoming != if_incoming)
1194 if (!kref_get_unless_zero(&tmp_neigh_node->refcount))
1197 neigh_node = tmp_neigh_node;
1203 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1204 orig_neigh_node->orig,
1211 /* if orig_node is direct neighbor update neigh_node last_seen */
1212 if (orig_node == orig_neigh_node)
1213 neigh_node->last_seen = jiffies;
1215 orig_node->last_seen = jiffies;
1217 /* find packet count of corresponding one hop neighbor */
1218 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1219 if_num = if_incoming->if_num;
1220 orig_eq_count = orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1221 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1223 neigh_rq_count = neigh_ifinfo->bat_iv.real_packet_count;
1224 batadv_neigh_ifinfo_put(neigh_ifinfo);
1228 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1230 /* pay attention to not get a value bigger than 100 % */
1231 if (orig_eq_count > neigh_rq_count)
1232 total_count = neigh_rq_count;
1234 total_count = orig_eq_count;
1236 /* if we have too few packets (too less data) we set tq_own to zero
1237 * if we receive too few packets it is not considered bidirectional
1239 if (total_count < BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM ||
1240 neigh_rq_count < BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM)
1243 /* neigh_node->real_packet_count is never zero as we
1244 * only purge old information when getting new
1247 tq_own = (BATADV_TQ_MAX_VALUE * total_count) / neigh_rq_count;
1249 /* 1 - ((1-x) ** 3), normalized to TQ_MAX_VALUE this does
1250 * affect the nearly-symmetric links only a little, but
1251 * punishes asymmetric links more. This will give a value
1252 * between 0 and TQ_MAX_VALUE
1254 neigh_rq_inv = BATADV_TQ_LOCAL_WINDOW_SIZE - neigh_rq_count;
1255 neigh_rq_inv_cube = neigh_rq_inv * neigh_rq_inv * neigh_rq_inv;
1256 neigh_rq_max_cube = BATADV_TQ_LOCAL_WINDOW_SIZE *
1257 BATADV_TQ_LOCAL_WINDOW_SIZE *
1258 BATADV_TQ_LOCAL_WINDOW_SIZE;
1259 inv_asym_penalty = BATADV_TQ_MAX_VALUE * neigh_rq_inv_cube;
1260 inv_asym_penalty /= neigh_rq_max_cube;
1261 tq_asym_penalty = BATADV_TQ_MAX_VALUE - inv_asym_penalty;
1263 /* penalize if the OGM is forwarded on the same interface. WiFi
1264 * interfaces and other half duplex devices suffer from throughput
1265 * drops as they can't send and receive at the same time.
1267 tq_iface_penalty = BATADV_TQ_MAX_VALUE;
1268 if (if_outgoing && (if_incoming == if_outgoing) &&
1269 batadv_is_wifi_netdev(if_outgoing->net_dev))
1270 tq_iface_penalty = batadv_hop_penalty(BATADV_TQ_MAX_VALUE,
1273 combined_tq = batadv_ogm_packet->tq *
1277 combined_tq /= BATADV_TQ_MAX_VALUE *
1278 BATADV_TQ_MAX_VALUE *
1279 BATADV_TQ_MAX_VALUE;
1280 batadv_ogm_packet->tq = combined_tq;
1282 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1283 "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",
1284 orig_node->orig, orig_neigh_node->orig, total_count,
1285 neigh_rq_count, tq_own, tq_asym_penalty, tq_iface_penalty,
1286 batadv_ogm_packet->tq, if_incoming->net_dev->name,
1287 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT");
1289 /* if link has the minimum required transmission quality
1290 * consider it bidirectional
1292 if (batadv_ogm_packet->tq >= BATADV_TQ_TOTAL_BIDRECT_LIMIT)
1297 batadv_neigh_node_put(neigh_node);
1302 * batadv_iv_ogm_update_seqnos - process a batman packet for all interfaces,
1303 * adjust the sequence number and find out whether it is a duplicate
1304 * @ethhdr: ethernet header of the packet
1305 * @batadv_ogm_packet: OGM packet to be considered
1306 * @if_incoming: interface on which the OGM packet was received
1307 * @if_outgoing: interface for which the retransmission should be considered
1309 * Return: duplicate status as enum batadv_dup_status
1311 static enum batadv_dup_status
1312 batadv_iv_ogm_update_seqnos(const struct ethhdr *ethhdr,
1313 const struct batadv_ogm_packet *batadv_ogm_packet,
1314 const struct batadv_hard_iface *if_incoming,
1315 struct batadv_hard_iface *if_outgoing)
1317 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1318 struct batadv_orig_node *orig_node;
1319 struct batadv_orig_ifinfo *orig_ifinfo = NULL;
1320 struct batadv_neigh_node *neigh_node;
1321 struct batadv_neigh_ifinfo *neigh_ifinfo;
1324 bool need_update = false;
1326 enum batadv_dup_status ret = BATADV_NO_DUP;
1327 u32 seqno = ntohl(batadv_ogm_packet->seqno);
1330 unsigned long *bitmap;
1332 orig_node = batadv_iv_ogm_orig_get(bat_priv, batadv_ogm_packet->orig);
1334 return BATADV_NO_DUP;
1336 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1337 if (WARN_ON(!orig_ifinfo)) {
1338 batadv_orig_node_put(orig_node);
1342 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1343 seq_diff = seqno - orig_ifinfo->last_real_seqno;
1345 /* signalize caller that the packet is to be dropped. */
1346 if (!hlist_empty(&orig_node->neigh_list) &&
1347 batadv_window_protected(bat_priv, seq_diff,
1348 BATADV_TQ_LOCAL_WINDOW_SIZE,
1349 &orig_ifinfo->batman_seqno_reset, NULL)) {
1350 ret = BATADV_PROTECTED;
1355 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1356 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node,
1361 neigh_addr = neigh_node->addr;
1362 is_dup = batadv_test_bit(neigh_ifinfo->bat_iv.real_bits,
1363 orig_ifinfo->last_real_seqno,
1366 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1367 neigh_node->if_incoming == if_incoming) {
1370 ret = BATADV_NEIGH_DUP;
1373 if (is_dup && (ret != BATADV_NEIGH_DUP))
1374 ret = BATADV_ORIG_DUP;
1377 /* if the window moved, set the update flag. */
1378 bitmap = neigh_ifinfo->bat_iv.real_bits;
1379 need_update |= batadv_bit_get_packet(bat_priv, bitmap,
1380 seq_diff, set_mark);
1382 packet_count = bitmap_weight(bitmap,
1383 BATADV_TQ_LOCAL_WINDOW_SIZE);
1384 neigh_ifinfo->bat_iv.real_packet_count = packet_count;
1385 batadv_neigh_ifinfo_put(neigh_ifinfo);
1390 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1391 "%s updating last_seqno: old %u, new %u\n",
1392 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT",
1393 orig_ifinfo->last_real_seqno, seqno);
1394 orig_ifinfo->last_real_seqno = seqno;
1398 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1399 batadv_orig_node_put(orig_node);
1400 batadv_orig_ifinfo_put(orig_ifinfo);
1405 * batadv_iv_ogm_process_per_outif - process a batman iv OGM for an outgoing if
1406 * @skb: the skb containing the OGM
1407 * @ogm_offset: offset from skb->data to start of ogm header
1408 * @orig_node: the (cached) orig node for the originator of this OGM
1409 * @if_incoming: the interface where this packet was received
1410 * @if_outgoing: the interface for which the packet should be considered
1413 batadv_iv_ogm_process_per_outif(const struct sk_buff *skb, int ogm_offset,
1414 struct batadv_orig_node *orig_node,
1415 struct batadv_hard_iface *if_incoming,
1416 struct batadv_hard_iface *if_outgoing)
1418 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1419 struct batadv_hardif_neigh_node *hardif_neigh = NULL;
1420 struct batadv_neigh_node *router = NULL;
1421 struct batadv_neigh_node *router_router = NULL;
1422 struct batadv_orig_node *orig_neigh_node;
1423 struct batadv_orig_ifinfo *orig_ifinfo;
1424 struct batadv_neigh_node *orig_neigh_router = NULL;
1425 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
1426 struct batadv_ogm_packet *ogm_packet;
1427 enum batadv_dup_status dup_status;
1428 bool is_from_best_next_hop = false;
1429 bool is_single_hop_neigh = false;
1430 bool sameseq, similar_ttl;
1431 struct sk_buff *skb_priv;
1432 struct ethhdr *ethhdr;
1436 /* create a private copy of the skb, as some functions change tq value
1439 skb_priv = skb_copy(skb, GFP_ATOMIC);
1443 ethhdr = eth_hdr(skb_priv);
1444 ogm_packet = (struct batadv_ogm_packet *)(skb_priv->data + ogm_offset);
1446 dup_status = batadv_iv_ogm_update_seqnos(ethhdr, ogm_packet,
1447 if_incoming, if_outgoing);
1448 if (batadv_compare_eth(ethhdr->h_source, ogm_packet->orig))
1449 is_single_hop_neigh = true;
1451 if (dup_status == BATADV_PROTECTED) {
1452 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1453 "Drop packet: packet within seqno protection time (sender: %pM)\n",
1458 if (ogm_packet->tq == 0) {
1459 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1460 "Drop packet: originator packet with tq equal 0\n");
1464 if (is_single_hop_neigh) {
1465 hardif_neigh = batadv_hardif_neigh_get(if_incoming,
1468 hardif_neigh->last_seen = jiffies;
1471 router = batadv_orig_router_get(orig_node, if_outgoing);
1473 router_router = batadv_orig_router_get(router->orig_node,
1475 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1478 if ((router_ifinfo && router_ifinfo->bat_iv.tq_avg != 0) &&
1479 (batadv_compare_eth(router->addr, ethhdr->h_source)))
1480 is_from_best_next_hop = true;
1482 prev_sender = ogm_packet->prev_sender;
1483 /* avoid temporary routing loops */
1484 if (router && router_router &&
1485 (batadv_compare_eth(router->addr, prev_sender)) &&
1486 !(batadv_compare_eth(ogm_packet->orig, prev_sender)) &&
1487 (batadv_compare_eth(router->addr, router_router->addr))) {
1488 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1489 "Drop packet: ignoring all rebroadcast packets that may make me loop (sender: %pM)\n",
1494 if (if_outgoing == BATADV_IF_DEFAULT)
1495 batadv_tvlv_ogm_receive(bat_priv, ogm_packet, orig_node);
1497 /* if sender is a direct neighbor the sender mac equals
1500 if (is_single_hop_neigh)
1501 orig_neigh_node = orig_node;
1503 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1506 if (!orig_neigh_node)
1509 /* Update nc_nodes of the originator */
1510 batadv_nc_update_nc_node(bat_priv, orig_node, orig_neigh_node,
1511 ogm_packet, is_single_hop_neigh);
1513 orig_neigh_router = batadv_orig_router_get(orig_neigh_node,
1516 /* drop packet if sender is not a direct neighbor and if we
1517 * don't route towards it
1519 if (!is_single_hop_neigh && (!orig_neigh_router)) {
1520 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1521 "Drop packet: OGM via unknown neighbor!\n");
1525 is_bidirect = batadv_iv_ogm_calc_tq(orig_node, orig_neigh_node,
1526 ogm_packet, if_incoming,
1529 /* update ranking if it is not a duplicate or has the same
1530 * seqno and similar ttl as the non-duplicate
1532 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1536 sameseq = orig_ifinfo->last_real_seqno == ntohl(ogm_packet->seqno);
1537 similar_ttl = (orig_ifinfo->last_ttl - 3) <= ogm_packet->ttl;
1539 if (is_bidirect && ((dup_status == BATADV_NO_DUP) ||
1540 (sameseq && similar_ttl))) {
1541 batadv_iv_ogm_orig_update(bat_priv, orig_node,
1542 orig_ifinfo, ethhdr,
1543 ogm_packet, if_incoming,
1544 if_outgoing, dup_status);
1546 batadv_orig_ifinfo_put(orig_ifinfo);
1548 /* only forward for specific interface, not for the default one. */
1549 if (if_outgoing == BATADV_IF_DEFAULT)
1552 /* is single hop (direct) neighbor */
1553 if (is_single_hop_neigh) {
1554 /* OGMs from secondary interfaces should only scheduled once
1555 * per interface where it has been received, not multiple times
1557 if ((ogm_packet->ttl <= 2) &&
1558 (if_incoming != if_outgoing)) {
1559 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1560 "Drop packet: OGM from secondary interface and wrong outgoing interface\n");
1563 /* mark direct link on incoming interface */
1564 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1565 is_single_hop_neigh,
1566 is_from_best_next_hop, if_incoming,
1569 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1570 "Forwarding packet: rebroadcast neighbor packet with direct link flag\n");
1574 /* multihop originator */
1576 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1577 "Drop packet: not received via bidirectional link\n");
1581 if (dup_status == BATADV_NEIGH_DUP) {
1582 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1583 "Drop packet: duplicate packet received\n");
1587 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1588 "Forwarding packet: rebroadcast originator packet\n");
1589 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1590 is_single_hop_neigh, is_from_best_next_hop,
1591 if_incoming, if_outgoing);
1594 if ((orig_neigh_node) && (!is_single_hop_neigh))
1595 batadv_orig_node_put(orig_neigh_node);
1598 batadv_neigh_ifinfo_put(router_ifinfo);
1600 batadv_neigh_node_put(router);
1602 batadv_neigh_node_put(router_router);
1603 if (orig_neigh_router)
1604 batadv_neigh_node_put(orig_neigh_router);
1606 batadv_hardif_neigh_put(hardif_neigh);
1608 kfree_skb(skb_priv);
1612 * batadv_iv_ogm_process - process an incoming batman iv OGM
1613 * @skb: the skb containing the OGM
1614 * @ogm_offset: offset to the OGM which should be processed (for aggregates)
1615 * @if_incoming: the interface where this packet was receved
1617 static void batadv_iv_ogm_process(const struct sk_buff *skb, int ogm_offset,
1618 struct batadv_hard_iface *if_incoming)
1620 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1621 struct batadv_orig_node *orig_neigh_node, *orig_node;
1622 struct batadv_hard_iface *hard_iface;
1623 struct batadv_ogm_packet *ogm_packet;
1624 u32 if_incoming_seqno;
1625 bool has_directlink_flag;
1626 struct ethhdr *ethhdr;
1627 bool is_my_oldorig = false;
1628 bool is_my_addr = false;
1629 bool is_my_orig = false;
1631 ogm_packet = (struct batadv_ogm_packet *)(skb->data + ogm_offset);
1632 ethhdr = eth_hdr(skb);
1634 /* Silently drop when the batman packet is actually not a
1637 * This might happen if a packet is padded (e.g. Ethernet has a
1638 * minimum frame length of 64 byte) and the aggregation interprets
1639 * it as an additional length.
1641 * TODO: A more sane solution would be to have a bit in the
1642 * batadv_ogm_packet to detect whether the packet is the last
1643 * packet in an aggregation. Here we expect that the padding
1644 * is always zero (or not 0x01)
1646 if (ogm_packet->packet_type != BATADV_IV_OGM)
1649 /* could be changed by schedule_own_packet() */
1650 if_incoming_seqno = atomic_read(&if_incoming->bat_iv.ogm_seqno);
1652 if (ogm_packet->flags & BATADV_DIRECTLINK)
1653 has_directlink_flag = true;
1655 has_directlink_flag = false;
1657 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1658 "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",
1659 ethhdr->h_source, if_incoming->net_dev->name,
1660 if_incoming->net_dev->dev_addr, ogm_packet->orig,
1661 ogm_packet->prev_sender, ntohl(ogm_packet->seqno),
1662 ogm_packet->tq, ogm_packet->ttl,
1663 ogm_packet->version, has_directlink_flag);
1666 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1667 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1670 if (hard_iface->soft_iface != if_incoming->soft_iface)
1673 if (batadv_compare_eth(ethhdr->h_source,
1674 hard_iface->net_dev->dev_addr))
1677 if (batadv_compare_eth(ogm_packet->orig,
1678 hard_iface->net_dev->dev_addr))
1681 if (batadv_compare_eth(ogm_packet->prev_sender,
1682 hard_iface->net_dev->dev_addr))
1683 is_my_oldorig = true;
1688 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1689 "Drop packet: received my own broadcast (sender: %pM)\n",
1695 unsigned long *word;
1701 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1703 if (!orig_neigh_node)
1706 /* neighbor has to indicate direct link and it has to
1707 * come via the corresponding interface
1708 * save packet seqno for bidirectional check
1710 if (has_directlink_flag &&
1711 batadv_compare_eth(if_incoming->net_dev->dev_addr,
1712 ogm_packet->orig)) {
1713 if_num = if_incoming->if_num;
1714 offset = if_num * BATADV_NUM_WORDS;
1716 spin_lock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1717 word = &orig_neigh_node->bat_iv.bcast_own[offset];
1718 bit_pos = if_incoming_seqno - 2;
1719 bit_pos -= ntohl(ogm_packet->seqno);
1720 batadv_set_bit(word, bit_pos);
1721 weight = &orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1722 *weight = bitmap_weight(word,
1723 BATADV_TQ_LOCAL_WINDOW_SIZE);
1724 spin_unlock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1727 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1728 "Drop packet: originator packet from myself (via neighbor)\n");
1729 batadv_orig_node_put(orig_neigh_node);
1733 if (is_my_oldorig) {
1734 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1735 "Drop packet: ignoring all rebroadcast echos (sender: %pM)\n",
1740 if (ogm_packet->flags & BATADV_NOT_BEST_NEXT_HOP) {
1741 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1742 "Drop packet: ignoring all packets not forwarded from the best next hop (sender: %pM)\n",
1747 orig_node = batadv_iv_ogm_orig_get(bat_priv, ogm_packet->orig);
1751 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1752 if_incoming, BATADV_IF_DEFAULT);
1755 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1756 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1759 if (hard_iface->soft_iface != bat_priv->soft_iface)
1762 if (!kref_get_unless_zero(&hard_iface->refcount))
1765 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1766 if_incoming, hard_iface);
1768 batadv_hardif_put(hard_iface);
1772 batadv_orig_node_put(orig_node);
1775 static void batadv_iv_send_outstanding_bat_ogm_packet(struct work_struct *work)
1777 struct delayed_work *delayed_work;
1778 struct batadv_forw_packet *forw_packet;
1779 struct batadv_priv *bat_priv;
1781 delayed_work = to_delayed_work(work);
1782 forw_packet = container_of(delayed_work, struct batadv_forw_packet,
1784 bat_priv = netdev_priv(forw_packet->if_incoming->soft_iface);
1785 spin_lock_bh(&bat_priv->forw_bat_list_lock);
1786 hlist_del(&forw_packet->list);
1787 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
1789 if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_DEACTIVATING)
1792 batadv_iv_ogm_emit(forw_packet);
1794 /* we have to have at least one packet in the queue to determine the
1795 * queues wake up time unless we are shutting down.
1797 * only re-schedule if this is the "original" copy, e.g. the OGM of the
1798 * primary interface should only be rescheduled once per period, but
1799 * this function will be called for the forw_packet instances of the
1800 * other secondary interfaces as well.
1802 if (forw_packet->own &&
1803 forw_packet->if_incoming == forw_packet->if_outgoing)
1804 batadv_iv_ogm_schedule(forw_packet->if_incoming);
1807 batadv_forw_packet_free(forw_packet);
1810 static int batadv_iv_ogm_receive(struct sk_buff *skb,
1811 struct batadv_hard_iface *if_incoming)
1813 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1814 struct batadv_ogm_packet *ogm_packet;
1819 ret = batadv_check_management_packet(skb, if_incoming, BATADV_OGM_HLEN);
1823 /* did we receive a B.A.T.M.A.N. IV OGM packet on an interface
1824 * that does not have B.A.T.M.A.N. IV enabled ?
1826 if (bat_priv->algo_ops->iface.enable != batadv_iv_ogm_iface_enable)
1829 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_RX);
1830 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_RX_BYTES,
1831 skb->len + ETH_HLEN);
1834 ogm_packet = (struct batadv_ogm_packet *)skb->data;
1836 /* unpack the aggregated packets and process them one by one */
1837 while (batadv_iv_ogm_aggr_packet(ogm_offset, skb_headlen(skb),
1838 ogm_packet->tvlv_len)) {
1839 batadv_iv_ogm_process(skb, ogm_offset, if_incoming);
1841 ogm_offset += BATADV_OGM_HLEN;
1842 ogm_offset += ntohs(ogm_packet->tvlv_len);
1844 packet_pos = skb->data + ogm_offset;
1845 ogm_packet = (struct batadv_ogm_packet *)packet_pos;
1849 return NET_RX_SUCCESS;
1853 * batadv_iv_ogm_orig_print_neigh - print neighbors for the originator table
1854 * @orig_node: the orig_node for which the neighbors are printed
1855 * @if_outgoing: outgoing interface for these entries
1856 * @seq: debugfs table seq_file struct
1858 * Must be called while holding an rcu lock.
1861 batadv_iv_ogm_orig_print_neigh(struct batadv_orig_node *orig_node,
1862 struct batadv_hard_iface *if_outgoing,
1863 struct seq_file *seq)
1865 struct batadv_neigh_node *neigh_node;
1866 struct batadv_neigh_ifinfo *n_ifinfo;
1868 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1869 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
1873 seq_printf(seq, " %pM (%3i)",
1875 n_ifinfo->bat_iv.tq_avg);
1877 batadv_neigh_ifinfo_put(n_ifinfo);
1882 * batadv_iv_ogm_orig_print - print the originator table
1883 * @bat_priv: the bat priv with all the soft interface information
1884 * @seq: debugfs table seq_file struct
1885 * @if_outgoing: the outgoing interface for which this should be printed
1887 static void batadv_iv_ogm_orig_print(struct batadv_priv *bat_priv,
1888 struct seq_file *seq,
1889 struct batadv_hard_iface *if_outgoing)
1891 struct batadv_neigh_node *neigh_node;
1892 struct batadv_hashtable *hash = bat_priv->orig_hash;
1893 int last_seen_msecs, last_seen_secs;
1894 struct batadv_orig_node *orig_node;
1895 struct batadv_neigh_ifinfo *n_ifinfo;
1896 unsigned long last_seen_jiffies;
1897 struct hlist_head *head;
1898 int batman_count = 0;
1902 " Originator last-seen (#/255) Nexthop [outgoingIF]: Potential nexthops ...\n");
1904 for (i = 0; i < hash->size; i++) {
1905 head = &hash->table[i];
1908 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
1909 neigh_node = batadv_orig_router_get(orig_node,
1914 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node,
1919 if (n_ifinfo->bat_iv.tq_avg == 0)
1922 last_seen_jiffies = jiffies - orig_node->last_seen;
1923 last_seen_msecs = jiffies_to_msecs(last_seen_jiffies);
1924 last_seen_secs = last_seen_msecs / 1000;
1925 last_seen_msecs = last_seen_msecs % 1000;
1927 seq_printf(seq, "%pM %4i.%03is (%3i) %pM [%10s]:",
1928 orig_node->orig, last_seen_secs,
1929 last_seen_msecs, n_ifinfo->bat_iv.tq_avg,
1931 neigh_node->if_incoming->net_dev->name);
1933 batadv_iv_ogm_orig_print_neigh(orig_node, if_outgoing,
1935 seq_puts(seq, "\n");
1939 batadv_neigh_node_put(neigh_node);
1941 batadv_neigh_ifinfo_put(n_ifinfo);
1946 if (batman_count == 0)
1947 seq_puts(seq, "No batman nodes in range ...\n");
1951 * batadv_iv_hardif_neigh_print - print a single hop neighbour node
1952 * @seq: neighbour table seq_file struct
1953 * @hardif_neigh: hardif neighbour information
1956 batadv_iv_hardif_neigh_print(struct seq_file *seq,
1957 struct batadv_hardif_neigh_node *hardif_neigh)
1959 int last_secs, last_msecs;
1961 last_secs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) / 1000;
1962 last_msecs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) % 1000;
1964 seq_printf(seq, " %10s %pM %4i.%03is\n",
1965 hardif_neigh->if_incoming->net_dev->name,
1966 hardif_neigh->addr, last_secs, last_msecs);
1970 * batadv_iv_ogm_neigh_print - print the single hop neighbour list
1971 * @bat_priv: the bat priv with all the soft interface information
1972 * @seq: neighbour table seq_file struct
1974 static void batadv_iv_neigh_print(struct batadv_priv *bat_priv,
1975 struct seq_file *seq)
1977 struct net_device *net_dev = (struct net_device *)seq->private;
1978 struct batadv_hardif_neigh_node *hardif_neigh;
1979 struct batadv_hard_iface *hard_iface;
1980 int batman_count = 0;
1982 seq_puts(seq, " IF Neighbor last-seen\n");
1985 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1986 if (hard_iface->soft_iface != net_dev)
1989 hlist_for_each_entry_rcu(hardif_neigh,
1990 &hard_iface->neigh_list, list) {
1991 batadv_iv_hardif_neigh_print(seq, hardif_neigh);
1997 if (batman_count == 0)
1998 seq_puts(seq, "No batman nodes in range ...\n");
2002 * batadv_iv_ogm_neigh_diff - calculate tq difference of two neighbors
2003 * @neigh1: the first neighbor object of the comparison
2004 * @if_outgoing1: outgoing interface for the first neighbor
2005 * @neigh2: the second neighbor object of the comparison
2006 * @if_outgoing2: outgoing interface for the second neighbor
2007 * @diff: pointer to integer receiving the calculated difference
2009 * The content of *@diff is only valid when this function returns true.
2010 * It is less, equal to or greater than 0 if the metric via neigh1 is lower,
2011 * the same as or higher than the metric via neigh2
2013 * Return: true when the difference could be calculated, false otherwise
2015 static bool batadv_iv_ogm_neigh_diff(struct batadv_neigh_node *neigh1,
2016 struct batadv_hard_iface *if_outgoing1,
2017 struct batadv_neigh_node *neigh2,
2018 struct batadv_hard_iface *if_outgoing2,
2021 struct batadv_neigh_ifinfo *neigh1_ifinfo, *neigh2_ifinfo;
2025 neigh1_ifinfo = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
2026 neigh2_ifinfo = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
2028 if (!neigh1_ifinfo || !neigh2_ifinfo) {
2033 tq1 = neigh1_ifinfo->bat_iv.tq_avg;
2034 tq2 = neigh2_ifinfo->bat_iv.tq_avg;
2035 *diff = (int)tq1 - (int)tq2;
2039 batadv_neigh_ifinfo_put(neigh1_ifinfo);
2041 batadv_neigh_ifinfo_put(neigh2_ifinfo);
2047 * batadv_iv_ogm_neigh_cmp - compare the metrics of two neighbors
2048 * @neigh1: the first neighbor object of the comparison
2049 * @if_outgoing1: outgoing interface for the first neighbor
2050 * @neigh2: the second neighbor object of the comparison
2051 * @if_outgoing2: outgoing interface for the second neighbor
2053 * Return: a value less, equal to or greater than 0 if the metric via neigh1 is
2054 * lower, the same as or higher than the metric via neigh2
2056 static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
2057 struct batadv_hard_iface *if_outgoing1,
2058 struct batadv_neigh_node *neigh2,
2059 struct batadv_hard_iface *if_outgoing2)
2064 ret = batadv_iv_ogm_neigh_diff(neigh1, if_outgoing1, neigh2,
2065 if_outgoing2, &diff);
2073 * batadv_iv_ogm_neigh_is_sob - check if neigh1 is similarly good or better
2074 * than neigh2 from the metric prospective
2075 * @neigh1: the first neighbor object of the comparison
2076 * @if_outgoing1: outgoing interface for the first neighbor
2077 * @neigh2: the second neighbor object of the comparison
2078 * @if_outgoing2: outgoing interface for the second neighbor
2080 * Return: true if the metric via neigh1 is equally good or better than
2081 * the metric via neigh2, false otherwise.
2084 batadv_iv_ogm_neigh_is_sob(struct batadv_neigh_node *neigh1,
2085 struct batadv_hard_iface *if_outgoing1,
2086 struct batadv_neigh_node *neigh2,
2087 struct batadv_hard_iface *if_outgoing2)
2092 ret = batadv_iv_ogm_neigh_diff(neigh1, if_outgoing1, neigh2,
2093 if_outgoing2, &diff);
2097 ret = diff > -BATADV_TQ_SIMILARITY_THRESHOLD;
2101 static void batadv_iv_iface_activate(struct batadv_hard_iface *hard_iface)
2103 /* begin scheduling originator messages on that interface */
2104 batadv_iv_ogm_schedule(hard_iface);
2107 static struct batadv_gw_node *
2108 batadv_iv_gw_get_best_gw_node(struct batadv_priv *bat_priv)
2110 struct batadv_neigh_node *router;
2111 struct batadv_neigh_ifinfo *router_ifinfo;
2112 struct batadv_gw_node *gw_node, *curr_gw = NULL;
2113 u64 max_gw_factor = 0;
2114 u64 tmp_gw_factor = 0;
2117 struct batadv_orig_node *orig_node;
2120 hlist_for_each_entry_rcu(gw_node, &bat_priv->gw.list, list) {
2121 orig_node = gw_node->orig_node;
2122 router = batadv_orig_router_get(orig_node, BATADV_IF_DEFAULT);
2126 router_ifinfo = batadv_neigh_ifinfo_get(router,
2131 if (!kref_get_unless_zero(&gw_node->refcount))
2134 tq_avg = router_ifinfo->bat_iv.tq_avg;
2136 switch (atomic_read(&bat_priv->gw.sel_class)) {
2137 case 1: /* fast connection */
2138 tmp_gw_factor = tq_avg * tq_avg;
2139 tmp_gw_factor *= gw_node->bandwidth_down;
2140 tmp_gw_factor *= 100 * 100;
2141 tmp_gw_factor >>= 18;
2143 if ((tmp_gw_factor > max_gw_factor) ||
2144 ((tmp_gw_factor == max_gw_factor) &&
2145 (tq_avg > max_tq))) {
2147 batadv_gw_node_put(curr_gw);
2149 kref_get(&curr_gw->refcount);
2153 default: /* 2: stable connection (use best statistic)
2154 * 3: fast-switch (use best statistic but change as
2155 * soon as a better gateway appears)
2156 * XX: late-switch (use best statistic but change as
2157 * soon as a better gateway appears which has
2158 * $routing_class more tq points)
2160 if (tq_avg > max_tq) {
2162 batadv_gw_node_put(curr_gw);
2164 kref_get(&curr_gw->refcount);
2169 if (tq_avg > max_tq)
2172 if (tmp_gw_factor > max_gw_factor)
2173 max_gw_factor = tmp_gw_factor;
2175 batadv_gw_node_put(gw_node);
2178 batadv_neigh_node_put(router);
2180 batadv_neigh_ifinfo_put(router_ifinfo);
2187 static bool batadv_iv_gw_is_eligible(struct batadv_priv *bat_priv,
2188 struct batadv_orig_node *curr_gw_orig,
2189 struct batadv_orig_node *orig_node)
2191 struct batadv_neigh_ifinfo *router_orig_ifinfo = NULL;
2192 struct batadv_neigh_ifinfo *router_gw_ifinfo = NULL;
2193 struct batadv_neigh_node *router_gw = NULL;
2194 struct batadv_neigh_node *router_orig = NULL;
2195 u8 gw_tq_avg, orig_tq_avg;
2198 /* dynamic re-election is performed only on fast or late switch */
2199 if (atomic_read(&bat_priv->gw.sel_class) <= 2)
2202 router_gw = batadv_orig_router_get(curr_gw_orig, BATADV_IF_DEFAULT);
2208 router_gw_ifinfo = batadv_neigh_ifinfo_get(router_gw,
2210 if (!router_gw_ifinfo) {
2215 router_orig = batadv_orig_router_get(orig_node, BATADV_IF_DEFAULT);
2219 router_orig_ifinfo = batadv_neigh_ifinfo_get(router_orig,
2221 if (!router_orig_ifinfo)
2224 gw_tq_avg = router_gw_ifinfo->bat_iv.tq_avg;
2225 orig_tq_avg = router_orig_ifinfo->bat_iv.tq_avg;
2227 /* the TQ value has to be better */
2228 if (orig_tq_avg < gw_tq_avg)
2231 /* if the routing class is greater than 3 the value tells us how much
2232 * greater the TQ value of the new gateway must be
2234 if ((atomic_read(&bat_priv->gw.sel_class) > 3) &&
2235 (orig_tq_avg - gw_tq_avg < atomic_read(&bat_priv->gw.sel_class)))
2238 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
2239 "Restarting gateway selection: better gateway found (tq curr: %i, tq new: %i)\n",
2240 gw_tq_avg, orig_tq_avg);
2244 if (router_gw_ifinfo)
2245 batadv_neigh_ifinfo_put(router_gw_ifinfo);
2246 if (router_orig_ifinfo)
2247 batadv_neigh_ifinfo_put(router_orig_ifinfo);
2249 batadv_neigh_node_put(router_gw);
2251 batadv_neigh_node_put(router_orig);
2256 /* fails if orig_node has no router */
2257 static int batadv_iv_gw_write_buffer_text(struct batadv_priv *bat_priv,
2258 struct seq_file *seq,
2259 const struct batadv_gw_node *gw_node)
2261 struct batadv_gw_node *curr_gw;
2262 struct batadv_neigh_node *router;
2263 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
2266 router = batadv_orig_router_get(gw_node->orig_node, BATADV_IF_DEFAULT);
2270 router_ifinfo = batadv_neigh_ifinfo_get(router, BATADV_IF_DEFAULT);
2274 curr_gw = batadv_gw_get_selected_gw_node(bat_priv);
2276 seq_printf(seq, "%s %pM (%3i) %pM [%10s]: %u.%u/%u.%u MBit\n",
2277 (curr_gw == gw_node ? "=>" : " "),
2278 gw_node->orig_node->orig,
2279 router_ifinfo->bat_iv.tq_avg, router->addr,
2280 router->if_incoming->net_dev->name,
2281 gw_node->bandwidth_down / 10,
2282 gw_node->bandwidth_down % 10,
2283 gw_node->bandwidth_up / 10,
2284 gw_node->bandwidth_up % 10);
2285 ret = seq_has_overflowed(seq) ? -1 : 0;
2288 batadv_gw_node_put(curr_gw);
2291 batadv_neigh_ifinfo_put(router_ifinfo);
2293 batadv_neigh_node_put(router);
2297 static void batadv_iv_gw_print(struct batadv_priv *bat_priv,
2298 struct seq_file *seq)
2300 struct batadv_gw_node *gw_node;
2304 " Gateway (#/255) Nexthop [outgoingIF]: advertised uplink bandwidth\n");
2307 hlist_for_each_entry_rcu(gw_node, &bat_priv->gw.list, list) {
2308 /* fails if orig_node has no router */
2309 if (batadv_iv_gw_write_buffer_text(bat_priv, seq, gw_node) < 0)
2317 seq_puts(seq, "No gateways in range ...\n");
2320 static struct batadv_algo_ops batadv_batman_iv __read_mostly = {
2321 .name = "BATMAN_IV",
2323 .activate = batadv_iv_iface_activate,
2324 .enable = batadv_iv_ogm_iface_enable,
2325 .disable = batadv_iv_ogm_iface_disable,
2326 .update_mac = batadv_iv_ogm_iface_update_mac,
2327 .primary_set = batadv_iv_ogm_primary_iface_set,
2330 .cmp = batadv_iv_ogm_neigh_cmp,
2331 .is_similar_or_better = batadv_iv_ogm_neigh_is_sob,
2332 .print = batadv_iv_neigh_print,
2335 .print = batadv_iv_ogm_orig_print,
2336 .free = batadv_iv_ogm_orig_free,
2337 .add_if = batadv_iv_ogm_orig_add_if,
2338 .del_if = batadv_iv_ogm_orig_del_if,
2341 .get_best_gw_node = batadv_iv_gw_get_best_gw_node,
2342 .is_eligible = batadv_iv_gw_is_eligible,
2343 .print = batadv_iv_gw_print,
2347 int __init batadv_iv_init(void)
2351 /* batman originator packet */
2352 ret = batadv_recv_handler_register(BATADV_IV_OGM,
2353 batadv_iv_ogm_receive);
2357 ret = batadv_algo_register(&batadv_batman_iv);
2359 goto handler_unregister;
2364 batadv_recv_handler_unregister(BATADV_IV_OGM);