1 /* Copyright (C) 2007-2017 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/netlink.h>
39 #include <linux/pkt_sched.h>
40 #include <linux/printk.h>
41 #include <linux/random.h>
42 #include <linux/rculist.h>
43 #include <linux/rcupdate.h>
44 #include <linux/seq_file.h>
45 #include <linux/skbuff.h>
46 #include <linux/slab.h>
47 #include <linux/spinlock.h>
48 #include <linux/stddef.h>
49 #include <linux/string.h>
50 #include <linux/types.h>
51 #include <linux/workqueue.h>
52 #include <net/genetlink.h>
53 #include <net/netlink.h>
54 #include <uapi/linux/batman_adv.h>
58 #include "gateway_client.h"
59 #include "hard-interface.h"
63 #include "network-coding.h"
64 #include "originator.h"
68 #include "translation-table.h"
71 static void batadv_iv_send_outstanding_bat_ogm_packet(struct work_struct *work);
74 * enum batadv_dup_status - duplicate status
75 * @BATADV_NO_DUP: the packet is no duplicate
76 * @BATADV_ORIG_DUP: OGM is a duplicate in the originator (but not for the
78 * @BATADV_NEIGH_DUP: OGM is a duplicate for the neighbor
79 * @BATADV_PROTECTED: originator is currently protected (after reboot)
81 enum batadv_dup_status {
89 * batadv_ring_buffer_set - update the ring buffer with the given value
90 * @lq_recv: pointer to the ring buffer
91 * @lq_index: index to store the value at
92 * @value: value to store in the ring buffer
94 static void batadv_ring_buffer_set(u8 lq_recv[], u8 *lq_index, u8 value)
96 lq_recv[*lq_index] = value;
97 *lq_index = (*lq_index + 1) % BATADV_TQ_GLOBAL_WINDOW_SIZE;
101 * batadv_ring_buffer_avg - compute the average of all non-zero values stored
102 * in the given ring buffer
103 * @lq_recv: pointer to the ring buffer
105 * Return: computed average value.
107 static u8 batadv_ring_buffer_avg(const u8 lq_recv[])
116 while (i < BATADV_TQ_GLOBAL_WINDOW_SIZE) {
129 return (u8)(sum / count);
133 * batadv_iv_ogm_orig_free - free the private resources allocated for this
135 * @orig_node: the orig_node for which the resources have to be free'd
137 static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node)
139 kfree(orig_node->bat_iv.bcast_own);
140 kfree(orig_node->bat_iv.bcast_own_sum);
144 * batadv_iv_ogm_orig_add_if - change the private structures of the orig_node to
145 * include the new hard-interface
146 * @orig_node: the orig_node that has to be changed
147 * @max_if_num: the current amount of interfaces
149 * Return: 0 on success, a negative error code otherwise.
151 static int batadv_iv_ogm_orig_add_if(struct batadv_orig_node *orig_node,
158 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
160 old_size = (max_if_num - 1) * sizeof(unsigned long) * BATADV_NUM_WORDS;
161 data_ptr = kmalloc_array(max_if_num,
162 BATADV_NUM_WORDS * sizeof(unsigned long),
167 memcpy(data_ptr, orig_node->bat_iv.bcast_own, old_size);
168 kfree(orig_node->bat_iv.bcast_own);
169 orig_node->bat_iv.bcast_own = data_ptr;
171 data_ptr = kmalloc_array(max_if_num, sizeof(u8), GFP_ATOMIC);
175 memcpy(data_ptr, orig_node->bat_iv.bcast_own_sum,
176 (max_if_num - 1) * sizeof(u8));
177 kfree(orig_node->bat_iv.bcast_own_sum);
178 orig_node->bat_iv.bcast_own_sum = data_ptr;
183 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
189 * batadv_iv_ogm_drop_bcast_own_entry - drop section of bcast_own
190 * @orig_node: the orig_node that has to be changed
191 * @max_if_num: the current amount of interfaces
192 * @del_if_num: the index of the interface being removed
195 batadv_iv_ogm_drop_bcast_own_entry(struct batadv_orig_node *orig_node,
196 int max_if_num, int del_if_num)
202 lockdep_assert_held(&orig_node->bat_iv.ogm_cnt_lock);
204 chunk_size = sizeof(unsigned long) * BATADV_NUM_WORDS;
205 data_ptr = kmalloc_array(max_if_num, chunk_size, GFP_ATOMIC);
207 /* use old buffer when new one could not be allocated */
208 data_ptr = orig_node->bat_iv.bcast_own;
210 /* copy first part */
211 memmove(data_ptr, orig_node->bat_iv.bcast_own, del_if_num * chunk_size);
213 /* copy second part */
214 if_offset = (del_if_num + 1) * chunk_size;
215 memmove((char *)data_ptr + del_if_num * chunk_size,
216 (uint8_t *)orig_node->bat_iv.bcast_own + if_offset,
217 (max_if_num - del_if_num) * chunk_size);
219 /* bcast_own was shrunk down in new buffer; free old one */
220 if (orig_node->bat_iv.bcast_own != data_ptr) {
221 kfree(orig_node->bat_iv.bcast_own);
222 orig_node->bat_iv.bcast_own = data_ptr;
227 * batadv_iv_ogm_drop_bcast_own_sum_entry - drop section of bcast_own_sum
228 * @orig_node: the orig_node that has to be changed
229 * @max_if_num: the current amount of interfaces
230 * @del_if_num: the index of the interface being removed
233 batadv_iv_ogm_drop_bcast_own_sum_entry(struct batadv_orig_node *orig_node,
234 int max_if_num, int del_if_num)
239 lockdep_assert_held(&orig_node->bat_iv.ogm_cnt_lock);
241 data_ptr = kmalloc_array(max_if_num, sizeof(u8), GFP_ATOMIC);
243 /* use old buffer when new one could not be allocated */
244 data_ptr = orig_node->bat_iv.bcast_own_sum;
246 memmove(data_ptr, orig_node->bat_iv.bcast_own_sum,
247 del_if_num * sizeof(u8));
249 if_offset = (del_if_num + 1) * sizeof(u8);
250 memmove((char *)data_ptr + del_if_num * sizeof(u8),
251 orig_node->bat_iv.bcast_own_sum + if_offset,
252 (max_if_num - del_if_num) * sizeof(u8));
254 /* bcast_own_sum was shrunk down in new buffer; free old one */
255 if (orig_node->bat_iv.bcast_own_sum != data_ptr) {
256 kfree(orig_node->bat_iv.bcast_own_sum);
257 orig_node->bat_iv.bcast_own_sum = data_ptr;
262 * batadv_iv_ogm_orig_del_if - change the private structures of the orig_node to
263 * exclude the removed interface
264 * @orig_node: the orig_node that has to be changed
265 * @max_if_num: the current amount of interfaces
266 * @del_if_num: the index of the interface being removed
268 * Return: 0 on success, a negative error code otherwise.
270 static int batadv_iv_ogm_orig_del_if(struct batadv_orig_node *orig_node,
271 int max_if_num, int del_if_num)
273 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
275 if (max_if_num == 0) {
276 kfree(orig_node->bat_iv.bcast_own);
277 kfree(orig_node->bat_iv.bcast_own_sum);
278 orig_node->bat_iv.bcast_own = NULL;
279 orig_node->bat_iv.bcast_own_sum = NULL;
281 batadv_iv_ogm_drop_bcast_own_entry(orig_node, max_if_num,
283 batadv_iv_ogm_drop_bcast_own_sum_entry(orig_node, max_if_num,
287 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
293 * batadv_iv_ogm_orig_get - retrieve or create (if does not exist) an originator
294 * @bat_priv: the bat priv with all the soft interface information
295 * @addr: mac address of the originator
297 * Return: the originator object corresponding to the passed mac address or NULL
299 * If the object does not exists it is created an initialised.
301 static struct batadv_orig_node *
302 batadv_iv_ogm_orig_get(struct batadv_priv *bat_priv, const u8 *addr)
304 struct batadv_orig_node *orig_node;
305 int size, hash_added;
307 orig_node = batadv_orig_hash_find(bat_priv, addr);
311 orig_node = batadv_orig_node_new(bat_priv, addr);
315 spin_lock_init(&orig_node->bat_iv.ogm_cnt_lock);
317 size = bat_priv->num_ifaces * sizeof(unsigned long) * BATADV_NUM_WORDS;
318 orig_node->bat_iv.bcast_own = kzalloc(size, GFP_ATOMIC);
319 if (!orig_node->bat_iv.bcast_own)
322 size = bat_priv->num_ifaces * sizeof(u8);
323 orig_node->bat_iv.bcast_own_sum = kzalloc(size, GFP_ATOMIC);
324 if (!orig_node->bat_iv.bcast_own_sum)
327 kref_get(&orig_node->refcount);
328 hash_added = batadv_hash_add(bat_priv->orig_hash, batadv_compare_orig,
329 batadv_choose_orig, orig_node,
330 &orig_node->hash_entry);
332 goto free_orig_node_hash;
337 batadv_orig_node_put(orig_node);
339 batadv_orig_node_put(orig_node);
344 static struct batadv_neigh_node *
345 batadv_iv_ogm_neigh_new(struct batadv_hard_iface *hard_iface,
346 const u8 *neigh_addr,
347 struct batadv_orig_node *orig_node,
348 struct batadv_orig_node *orig_neigh)
350 struct batadv_neigh_node *neigh_node;
352 neigh_node = batadv_neigh_node_get_or_create(orig_node,
353 hard_iface, neigh_addr);
357 neigh_node->orig_node = orig_neigh;
363 static int batadv_iv_ogm_iface_enable(struct batadv_hard_iface *hard_iface)
365 struct batadv_ogm_packet *batadv_ogm_packet;
366 unsigned char *ogm_buff;
369 /* randomize initial seqno to avoid collision */
370 get_random_bytes(&random_seqno, sizeof(random_seqno));
371 atomic_set(&hard_iface->bat_iv.ogm_seqno, random_seqno);
373 hard_iface->bat_iv.ogm_buff_len = BATADV_OGM_HLEN;
374 ogm_buff = kmalloc(hard_iface->bat_iv.ogm_buff_len, GFP_ATOMIC);
378 hard_iface->bat_iv.ogm_buff = ogm_buff;
380 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
381 batadv_ogm_packet->packet_type = BATADV_IV_OGM;
382 batadv_ogm_packet->version = BATADV_COMPAT_VERSION;
383 batadv_ogm_packet->ttl = 2;
384 batadv_ogm_packet->flags = BATADV_NO_FLAGS;
385 batadv_ogm_packet->reserved = 0;
386 batadv_ogm_packet->tq = BATADV_TQ_MAX_VALUE;
391 static void batadv_iv_ogm_iface_disable(struct batadv_hard_iface *hard_iface)
393 kfree(hard_iface->bat_iv.ogm_buff);
394 hard_iface->bat_iv.ogm_buff = NULL;
397 static void batadv_iv_ogm_iface_update_mac(struct batadv_hard_iface *hard_iface)
399 struct batadv_ogm_packet *batadv_ogm_packet;
400 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
402 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
403 ether_addr_copy(batadv_ogm_packet->orig,
404 hard_iface->net_dev->dev_addr);
405 ether_addr_copy(batadv_ogm_packet->prev_sender,
406 hard_iface->net_dev->dev_addr);
410 batadv_iv_ogm_primary_iface_set(struct batadv_hard_iface *hard_iface)
412 struct batadv_ogm_packet *batadv_ogm_packet;
413 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
415 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
416 batadv_ogm_packet->ttl = BATADV_TTL;
419 /* when do we schedule our own ogm to be sent */
421 batadv_iv_ogm_emit_send_time(const struct batadv_priv *bat_priv)
425 msecs = atomic_read(&bat_priv->orig_interval) - BATADV_JITTER;
426 msecs += prandom_u32() % (2 * BATADV_JITTER);
428 return jiffies + msecs_to_jiffies(msecs);
431 /* when do we schedule a ogm packet to be sent */
432 static unsigned long batadv_iv_ogm_fwd_send_time(void)
434 return jiffies + msecs_to_jiffies(prandom_u32() % (BATADV_JITTER / 2));
437 /* apply hop penalty for a normal link */
438 static u8 batadv_hop_penalty(u8 tq, const struct batadv_priv *bat_priv)
440 int hop_penalty = atomic_read(&bat_priv->hop_penalty);
443 new_tq = tq * (BATADV_TQ_MAX_VALUE - hop_penalty);
444 new_tq /= BATADV_TQ_MAX_VALUE;
450 * batadv_iv_ogm_aggr_packet - checks if there is another OGM attached
451 * @buff_pos: current position in the skb
452 * @packet_len: total length of the skb
453 * @tvlv_len: tvlv length of the previously considered OGM
455 * Return: true if there is enough space for another OGM, false otherwise.
457 static bool batadv_iv_ogm_aggr_packet(int buff_pos, int packet_len,
460 int next_buff_pos = 0;
462 next_buff_pos += buff_pos + BATADV_OGM_HLEN;
463 next_buff_pos += ntohs(tvlv_len);
465 return (next_buff_pos <= packet_len) &&
466 (next_buff_pos <= BATADV_MAX_AGGREGATION_BYTES);
469 /* send a batman ogm to a given interface */
470 static void batadv_iv_ogm_send_to_if(struct batadv_forw_packet *forw_packet,
471 struct batadv_hard_iface *hard_iface)
473 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
477 struct batadv_ogm_packet *batadv_ogm_packet;
481 if (hard_iface->if_status != BATADV_IF_ACTIVE)
486 packet_pos = forw_packet->skb->data;
487 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
489 /* adjust all flags and log packets */
490 while (batadv_iv_ogm_aggr_packet(buff_pos, forw_packet->packet_len,
491 batadv_ogm_packet->tvlv_len)) {
492 /* we might have aggregated direct link packets with an
493 * ordinary base packet
495 if (forw_packet->direct_link_flags & BIT(packet_num) &&
496 forw_packet->if_incoming == hard_iface)
497 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
499 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
501 if (packet_num > 0 || !forw_packet->own)
502 fwd_str = "Forwarding";
504 fwd_str = "Sending own";
506 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
507 "%s %spacket (originator %pM, seqno %u, TQ %d, TTL %d, IDF %s) on interface %s [%pM]\n",
508 fwd_str, (packet_num > 0 ? "aggregated " : ""),
509 batadv_ogm_packet->orig,
510 ntohl(batadv_ogm_packet->seqno),
511 batadv_ogm_packet->tq, batadv_ogm_packet->ttl,
512 ((batadv_ogm_packet->flags & BATADV_DIRECTLINK) ?
514 hard_iface->net_dev->name,
515 hard_iface->net_dev->dev_addr);
517 buff_pos += BATADV_OGM_HLEN;
518 buff_pos += ntohs(batadv_ogm_packet->tvlv_len);
520 packet_pos = forw_packet->skb->data + buff_pos;
521 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
524 /* create clone because function is called more than once */
525 skb = skb_clone(forw_packet->skb, GFP_ATOMIC);
527 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_TX);
528 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_TX_BYTES,
529 skb->len + ETH_HLEN);
530 batadv_send_broadcast_skb(skb, hard_iface);
534 /* send a batman ogm packet */
535 static void batadv_iv_ogm_emit(struct batadv_forw_packet *forw_packet)
537 struct net_device *soft_iface;
539 if (!forw_packet->if_incoming) {
540 pr_err("Error - can't forward packet: incoming iface not specified\n");
544 soft_iface = forw_packet->if_incoming->soft_iface;
546 if (WARN_ON(!forw_packet->if_outgoing))
549 if (WARN_ON(forw_packet->if_outgoing->soft_iface != soft_iface))
552 if (forw_packet->if_incoming->if_status != BATADV_IF_ACTIVE)
555 /* only for one specific outgoing interface */
556 batadv_iv_ogm_send_to_if(forw_packet, forw_packet->if_outgoing);
560 * batadv_iv_ogm_can_aggregate - find out if an OGM can be aggregated on an
561 * existing forward packet
562 * @new_bat_ogm_packet: OGM packet to be aggregated
563 * @bat_priv: the bat priv with all the soft interface information
564 * @packet_len: (total) length of the OGM
565 * @send_time: timestamp (jiffies) when the packet is to be sent
566 * @directlink: true if this is a direct link packet
567 * @if_incoming: interface where the packet was received
568 * @if_outgoing: interface for which the retransmission should be considered
569 * @forw_packet: the forwarded packet which should be checked
571 * Return: true if new_packet can be aggregated with forw_packet
574 batadv_iv_ogm_can_aggregate(const struct batadv_ogm_packet *new_bat_ogm_packet,
575 struct batadv_priv *bat_priv,
576 int packet_len, unsigned long send_time,
578 const struct batadv_hard_iface *if_incoming,
579 const struct batadv_hard_iface *if_outgoing,
580 const struct batadv_forw_packet *forw_packet)
582 struct batadv_ogm_packet *batadv_ogm_packet;
583 int aggregated_bytes = forw_packet->packet_len + packet_len;
584 struct batadv_hard_iface *primary_if = NULL;
586 unsigned long aggregation_end_time;
588 batadv_ogm_packet = (struct batadv_ogm_packet *)forw_packet->skb->data;
589 aggregation_end_time = send_time;
590 aggregation_end_time += msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
592 /* we can aggregate the current packet to this aggregated packet
595 * - the send time is within our MAX_AGGREGATION_MS time
596 * - the resulting packet wont be bigger than
597 * MAX_AGGREGATION_BYTES
598 * otherwise aggregation is not possible
600 if (!time_before(send_time, forw_packet->send_time) ||
601 !time_after_eq(aggregation_end_time, forw_packet->send_time))
604 if (aggregated_bytes > BATADV_MAX_AGGREGATION_BYTES)
607 /* packet is not leaving on the same interface. */
608 if (forw_packet->if_outgoing != if_outgoing)
611 /* check aggregation compatibility
612 * -> direct link packets are broadcasted on
613 * their interface only
614 * -> aggregate packet if the current packet is
615 * a "global" packet as well as the base
618 primary_if = batadv_primary_if_get_selected(bat_priv);
622 /* packets without direct link flag and high TTL
623 * are flooded through the net
626 !(batadv_ogm_packet->flags & BATADV_DIRECTLINK) &&
627 batadv_ogm_packet->ttl != 1 &&
629 /* own packets originating non-primary
630 * interfaces leave only that interface
632 (!forw_packet->own ||
633 forw_packet->if_incoming == primary_if)) {
638 /* if the incoming packet is sent via this one
639 * interface only - we still can aggregate
642 new_bat_ogm_packet->ttl == 1 &&
643 forw_packet->if_incoming == if_incoming &&
645 /* packets from direct neighbors or
646 * own secondary interface packets
647 * (= secondary interface packets in general)
649 (batadv_ogm_packet->flags & BATADV_DIRECTLINK ||
651 forw_packet->if_incoming != primary_if))) {
658 batadv_hardif_put(primary_if);
663 * batadv_iv_ogm_aggregate_new - create a new aggregated packet and add this
665 * @packet_buff: pointer to the OGM
666 * @packet_len: (total) length of the OGM
667 * @send_time: timestamp (jiffies) when the packet is to be sent
668 * @direct_link: whether this OGM has direct link status
669 * @if_incoming: interface where the packet was received
670 * @if_outgoing: interface for which the retransmission should be considered
671 * @own_packet: true if it is a self-generated ogm
673 static void batadv_iv_ogm_aggregate_new(const unsigned char *packet_buff,
674 int packet_len, unsigned long send_time,
676 struct batadv_hard_iface *if_incoming,
677 struct batadv_hard_iface *if_outgoing,
680 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
681 struct batadv_forw_packet *forw_packet_aggr;
683 unsigned char *skb_buff;
684 unsigned int skb_size;
685 atomic_t *queue_left = own_packet ? NULL : &bat_priv->batman_queue_left;
687 if (atomic_read(&bat_priv->aggregated_ogms) &&
688 packet_len < BATADV_MAX_AGGREGATION_BYTES)
689 skb_size = BATADV_MAX_AGGREGATION_BYTES;
691 skb_size = packet_len;
693 skb_size += ETH_HLEN;
695 skb = netdev_alloc_skb_ip_align(NULL, skb_size);
699 forw_packet_aggr = batadv_forw_packet_alloc(if_incoming, if_outgoing,
700 queue_left, bat_priv, skb);
701 if (!forw_packet_aggr) {
706 forw_packet_aggr->skb->priority = TC_PRIO_CONTROL;
707 skb_reserve(forw_packet_aggr->skb, ETH_HLEN);
709 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
710 forw_packet_aggr->packet_len = packet_len;
711 memcpy(skb_buff, packet_buff, packet_len);
713 forw_packet_aggr->own = own_packet;
714 forw_packet_aggr->direct_link_flags = BATADV_NO_FLAGS;
715 forw_packet_aggr->send_time = send_time;
717 /* save packet direct link flag status */
719 forw_packet_aggr->direct_link_flags |= 1;
721 INIT_DELAYED_WORK(&forw_packet_aggr->delayed_work,
722 batadv_iv_send_outstanding_bat_ogm_packet);
724 batadv_forw_packet_ogmv1_queue(bat_priv, forw_packet_aggr, send_time);
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 long new_direct_link_flag;
734 skb_put_data(forw_packet_aggr->skb, packet_buff, packet_len);
735 forw_packet_aggr->packet_len += packet_len;
736 forw_packet_aggr->num_packets++;
738 /* save packet direct link flag status */
740 new_direct_link_flag = BIT(forw_packet_aggr->num_packets);
741 forw_packet_aggr->direct_link_flags |= new_direct_link_flag;
746 * batadv_iv_ogm_queue_add - queue up an OGM for transmission
747 * @bat_priv: the bat priv with all the soft interface information
748 * @packet_buff: pointer to the OGM
749 * @packet_len: (total) length of the OGM
750 * @if_incoming: interface where the packet was received
751 * @if_outgoing: interface for which the retransmission should be considered
752 * @own_packet: true if it is a self-generated ogm
753 * @send_time: timestamp (jiffies) when the packet is to be sent
755 static void batadv_iv_ogm_queue_add(struct batadv_priv *bat_priv,
756 unsigned char *packet_buff,
758 struct batadv_hard_iface *if_incoming,
759 struct batadv_hard_iface *if_outgoing,
760 int own_packet, unsigned long send_time)
762 /* _aggr -> pointer to the packet we want to aggregate with
763 * _pos -> pointer to the position in the queue
765 struct batadv_forw_packet *forw_packet_aggr = NULL;
766 struct batadv_forw_packet *forw_packet_pos = NULL;
767 struct batadv_ogm_packet *batadv_ogm_packet;
769 unsigned long max_aggregation_jiffies;
771 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_buff;
772 direct_link = !!(batadv_ogm_packet->flags & BATADV_DIRECTLINK);
773 max_aggregation_jiffies = msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
775 /* find position for the packet in the forward queue */
776 spin_lock_bh(&bat_priv->forw_bat_list_lock);
777 /* own packets are not to be aggregated */
778 if (atomic_read(&bat_priv->aggregated_ogms) && !own_packet) {
779 hlist_for_each_entry(forw_packet_pos,
780 &bat_priv->forw_bat_list, list) {
781 if (batadv_iv_ogm_can_aggregate(batadv_ogm_packet,
782 bat_priv, packet_len,
783 send_time, direct_link,
787 forw_packet_aggr = forw_packet_pos;
793 /* nothing to aggregate with - either aggregation disabled or no
794 * suitable aggregation packet found
796 if (!forw_packet_aggr) {
797 /* the following section can run without the lock */
798 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
800 /* if we could not aggregate this packet with one of the others
801 * we hold it back for a while, so that it might be aggregated
804 if (!own_packet && atomic_read(&bat_priv->aggregated_ogms))
805 send_time += max_aggregation_jiffies;
807 batadv_iv_ogm_aggregate_new(packet_buff, packet_len,
808 send_time, direct_link,
809 if_incoming, if_outgoing,
812 batadv_iv_ogm_aggregate(forw_packet_aggr, packet_buff,
813 packet_len, direct_link);
814 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
818 static void batadv_iv_ogm_forward(struct batadv_orig_node *orig_node,
819 const struct ethhdr *ethhdr,
820 struct batadv_ogm_packet *batadv_ogm_packet,
821 bool is_single_hop_neigh,
822 bool is_from_best_next_hop,
823 struct batadv_hard_iface *if_incoming,
824 struct batadv_hard_iface *if_outgoing)
826 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
829 if (batadv_ogm_packet->ttl <= 1) {
830 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "ttl exceeded\n");
834 if (!is_from_best_next_hop) {
835 /* Mark the forwarded packet when it is not coming from our
836 * best next hop. We still need to forward the packet for our
837 * neighbor link quality detection to work in case the packet
838 * originated from a single hop neighbor. Otherwise we can
839 * simply drop the ogm.
841 if (is_single_hop_neigh)
842 batadv_ogm_packet->flags |= BATADV_NOT_BEST_NEXT_HOP;
847 tvlv_len = ntohs(batadv_ogm_packet->tvlv_len);
849 batadv_ogm_packet->ttl--;
850 ether_addr_copy(batadv_ogm_packet->prev_sender, ethhdr->h_source);
852 /* apply hop penalty */
853 batadv_ogm_packet->tq = batadv_hop_penalty(batadv_ogm_packet->tq,
856 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
857 "Forwarding packet: tq: %i, ttl: %i\n",
858 batadv_ogm_packet->tq, batadv_ogm_packet->ttl);
860 if (is_single_hop_neigh)
861 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
863 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
865 batadv_iv_ogm_queue_add(bat_priv, (unsigned char *)batadv_ogm_packet,
866 BATADV_OGM_HLEN + tvlv_len,
867 if_incoming, if_outgoing, 0,
868 batadv_iv_ogm_fwd_send_time());
872 * batadv_iv_ogm_slide_own_bcast_window - bitshift own OGM broadcast windows for
873 * the given interface
874 * @hard_iface: the interface for which the windows have to be shifted
877 batadv_iv_ogm_slide_own_bcast_window(struct batadv_hard_iface *hard_iface)
879 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
880 struct batadv_hashtable *hash = bat_priv->orig_hash;
881 struct hlist_head *head;
882 struct batadv_orig_node *orig_node;
889 for (i = 0; i < hash->size; i++) {
890 head = &hash->table[i];
893 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
894 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
895 word_index = hard_iface->if_num * BATADV_NUM_WORDS;
896 word = &orig_node->bat_iv.bcast_own[word_index];
898 batadv_bit_get_packet(bat_priv, word, 1, 0);
899 if_num = hard_iface->if_num;
900 w = &orig_node->bat_iv.bcast_own_sum[if_num];
901 *w = bitmap_weight(word, BATADV_TQ_LOCAL_WINDOW_SIZE);
902 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
908 static void batadv_iv_ogm_schedule(struct batadv_hard_iface *hard_iface)
910 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
911 unsigned char **ogm_buff = &hard_iface->bat_iv.ogm_buff;
912 struct batadv_ogm_packet *batadv_ogm_packet;
913 struct batadv_hard_iface *primary_if, *tmp_hard_iface;
914 int *ogm_buff_len = &hard_iface->bat_iv.ogm_buff_len;
917 unsigned long send_time;
919 if ((hard_iface->if_status == BATADV_IF_NOT_IN_USE) ||
920 (hard_iface->if_status == BATADV_IF_TO_BE_REMOVED))
923 /* the interface gets activated here to avoid race conditions between
924 * the moment of activating the interface in
925 * hardif_activate_interface() where the originator mac is set and
926 * outdated packets (especially uninitialized mac addresses) in the
929 if (hard_iface->if_status == BATADV_IF_TO_BE_ACTIVATED)
930 hard_iface->if_status = BATADV_IF_ACTIVE;
932 primary_if = batadv_primary_if_get_selected(bat_priv);
934 if (hard_iface == primary_if) {
935 /* tt changes have to be committed before the tvlv data is
936 * appended as it may alter the tt tvlv container
938 batadv_tt_local_commit_changes(bat_priv);
939 tvlv_len = batadv_tvlv_container_ogm_append(bat_priv, ogm_buff,
944 batadv_ogm_packet = (struct batadv_ogm_packet *)(*ogm_buff);
945 batadv_ogm_packet->tvlv_len = htons(tvlv_len);
947 /* change sequence number to network order */
948 seqno = (u32)atomic_read(&hard_iface->bat_iv.ogm_seqno);
949 batadv_ogm_packet->seqno = htonl(seqno);
950 atomic_inc(&hard_iface->bat_iv.ogm_seqno);
952 batadv_iv_ogm_slide_own_bcast_window(hard_iface);
954 send_time = batadv_iv_ogm_emit_send_time(bat_priv);
956 if (hard_iface != primary_if) {
957 /* OGMs from secondary interfaces are only scheduled on their
958 * respective interfaces.
960 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff, *ogm_buff_len,
961 hard_iface, hard_iface, 1, send_time);
965 /* OGMs from primary interfaces are scheduled on all
969 list_for_each_entry_rcu(tmp_hard_iface, &batadv_hardif_list, list) {
970 if (tmp_hard_iface->soft_iface != hard_iface->soft_iface)
973 if (!kref_get_unless_zero(&tmp_hard_iface->refcount))
976 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff,
977 *ogm_buff_len, hard_iface,
978 tmp_hard_iface, 1, send_time);
980 batadv_hardif_put(tmp_hard_iface);
986 batadv_hardif_put(primary_if);
990 * batadv_iv_ogm_orig_update - use OGM to update corresponding data in an
992 * @bat_priv: the bat priv with all the soft interface information
993 * @orig_node: the orig node who originally emitted the ogm packet
994 * @orig_ifinfo: ifinfo for the outgoing interface of the orig_node
995 * @ethhdr: Ethernet header of the OGM
996 * @batadv_ogm_packet: the ogm packet
997 * @if_incoming: interface where the packet was received
998 * @if_outgoing: interface for which the retransmission should be considered
999 * @dup_status: the duplicate status of this ogm packet.
1002 batadv_iv_ogm_orig_update(struct batadv_priv *bat_priv,
1003 struct batadv_orig_node *orig_node,
1004 struct batadv_orig_ifinfo *orig_ifinfo,
1005 const struct ethhdr *ethhdr,
1006 const struct batadv_ogm_packet *batadv_ogm_packet,
1007 struct batadv_hard_iface *if_incoming,
1008 struct batadv_hard_iface *if_outgoing,
1009 enum batadv_dup_status dup_status)
1011 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL;
1012 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
1013 struct batadv_neigh_node *neigh_node = NULL;
1014 struct batadv_neigh_node *tmp_neigh_node = NULL;
1015 struct batadv_neigh_node *router = NULL;
1016 struct batadv_orig_node *orig_node_tmp;
1018 u8 sum_orig, sum_neigh;
1022 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1023 "%s(): Searching and updating originator entry of received packet\n",
1027 hlist_for_each_entry_rcu(tmp_neigh_node,
1028 &orig_node->neigh_list, list) {
1029 neigh_addr = tmp_neigh_node->addr;
1030 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1031 tmp_neigh_node->if_incoming == if_incoming &&
1032 kref_get_unless_zero(&tmp_neigh_node->refcount)) {
1033 if (WARN(neigh_node, "too many matching neigh_nodes"))
1034 batadv_neigh_node_put(neigh_node);
1035 neigh_node = tmp_neigh_node;
1039 if (dup_status != BATADV_NO_DUP)
1042 /* only update the entry for this outgoing interface */
1043 neigh_ifinfo = batadv_neigh_ifinfo_get(tmp_neigh_node,
1048 spin_lock_bh(&tmp_neigh_node->ifinfo_lock);
1049 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1050 &neigh_ifinfo->bat_iv.tq_index, 0);
1051 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1052 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1053 spin_unlock_bh(&tmp_neigh_node->ifinfo_lock);
1055 batadv_neigh_ifinfo_put(neigh_ifinfo);
1056 neigh_ifinfo = NULL;
1060 struct batadv_orig_node *orig_tmp;
1062 orig_tmp = batadv_iv_ogm_orig_get(bat_priv, ethhdr->h_source);
1066 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1068 orig_node, orig_tmp);
1070 batadv_orig_node_put(orig_tmp);
1074 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1075 "Updating existing last-hop neighbor of originator\n");
1079 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1083 neigh_node->last_seen = jiffies;
1085 spin_lock_bh(&neigh_node->ifinfo_lock);
1086 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1087 &neigh_ifinfo->bat_iv.tq_index,
1088 batadv_ogm_packet->tq);
1089 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1090 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1091 spin_unlock_bh(&neigh_node->ifinfo_lock);
1093 if (dup_status == BATADV_NO_DUP) {
1094 orig_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1095 neigh_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1098 /* if this neighbor already is our next hop there is nothing
1101 router = batadv_orig_router_get(orig_node, if_outgoing);
1102 if (router == neigh_node)
1106 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1110 /* if this neighbor does not offer a better TQ we won't
1113 if (router_ifinfo->bat_iv.tq_avg > neigh_ifinfo->bat_iv.tq_avg)
1117 /* if the TQ is the same and the link not more symmetric we
1118 * won't consider it either
1120 if (router_ifinfo &&
1121 neigh_ifinfo->bat_iv.tq_avg == router_ifinfo->bat_iv.tq_avg) {
1122 orig_node_tmp = router->orig_node;
1123 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1124 if_num = router->if_incoming->if_num;
1125 sum_orig = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1126 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1128 orig_node_tmp = neigh_node->orig_node;
1129 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1130 if_num = neigh_node->if_incoming->if_num;
1131 sum_neigh = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1132 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1134 if (sum_orig >= sum_neigh)
1138 batadv_update_route(bat_priv, orig_node, if_outgoing, neigh_node);
1145 batadv_neigh_node_put(neigh_node);
1147 batadv_neigh_node_put(router);
1149 batadv_neigh_ifinfo_put(neigh_ifinfo);
1151 batadv_neigh_ifinfo_put(router_ifinfo);
1155 * batadv_iv_ogm_calc_tq - calculate tq for current received ogm packet
1156 * @orig_node: the orig node who originally emitted the ogm packet
1157 * @orig_neigh_node: the orig node struct of the neighbor who sent the packet
1158 * @batadv_ogm_packet: the ogm packet
1159 * @if_incoming: interface where the packet was received
1160 * @if_outgoing: interface for which the retransmission should be considered
1162 * Return: true if the link can be considered bidirectional, false otherwise
1164 static bool batadv_iv_ogm_calc_tq(struct batadv_orig_node *orig_node,
1165 struct batadv_orig_node *orig_neigh_node,
1166 struct batadv_ogm_packet *batadv_ogm_packet,
1167 struct batadv_hard_iface *if_incoming,
1168 struct batadv_hard_iface *if_outgoing)
1170 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1171 struct batadv_neigh_node *neigh_node = NULL, *tmp_neigh_node;
1172 struct batadv_neigh_ifinfo *neigh_ifinfo;
1174 u8 orig_eq_count, neigh_rq_count, neigh_rq_inv, tq_own;
1175 unsigned int neigh_rq_inv_cube, neigh_rq_max_cube;
1177 unsigned int tq_asym_penalty, inv_asym_penalty;
1178 unsigned int combined_tq;
1179 unsigned int tq_iface_penalty;
1182 /* find corresponding one hop neighbor */
1184 hlist_for_each_entry_rcu(tmp_neigh_node,
1185 &orig_neigh_node->neigh_list, list) {
1186 if (!batadv_compare_eth(tmp_neigh_node->addr,
1187 orig_neigh_node->orig))
1190 if (tmp_neigh_node->if_incoming != if_incoming)
1193 if (!kref_get_unless_zero(&tmp_neigh_node->refcount))
1196 neigh_node = tmp_neigh_node;
1202 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1203 orig_neigh_node->orig,
1210 /* if orig_node is direct neighbor update neigh_node last_seen */
1211 if (orig_node == orig_neigh_node)
1212 neigh_node->last_seen = jiffies;
1214 orig_node->last_seen = jiffies;
1216 /* find packet count of corresponding one hop neighbor */
1217 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1218 if_num = if_incoming->if_num;
1219 orig_eq_count = orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1220 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1222 neigh_rq_count = neigh_ifinfo->bat_iv.real_packet_count;
1223 batadv_neigh_ifinfo_put(neigh_ifinfo);
1227 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1229 /* pay attention to not get a value bigger than 100 % */
1230 if (orig_eq_count > neigh_rq_count)
1231 total_count = neigh_rq_count;
1233 total_count = orig_eq_count;
1235 /* if we have too few packets (too less data) we set tq_own to zero
1236 * if we receive too few packets it is not considered bidirectional
1238 if (total_count < BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM ||
1239 neigh_rq_count < BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM)
1242 /* neigh_node->real_packet_count is never zero as we
1243 * only purge old information when getting new
1246 tq_own = (BATADV_TQ_MAX_VALUE * total_count) / neigh_rq_count;
1248 /* 1 - ((1-x) ** 3), normalized to TQ_MAX_VALUE this does
1249 * affect the nearly-symmetric links only a little, but
1250 * punishes asymmetric links more. This will give a value
1251 * between 0 and TQ_MAX_VALUE
1253 neigh_rq_inv = BATADV_TQ_LOCAL_WINDOW_SIZE - neigh_rq_count;
1254 neigh_rq_inv_cube = neigh_rq_inv * neigh_rq_inv * neigh_rq_inv;
1255 neigh_rq_max_cube = BATADV_TQ_LOCAL_WINDOW_SIZE *
1256 BATADV_TQ_LOCAL_WINDOW_SIZE *
1257 BATADV_TQ_LOCAL_WINDOW_SIZE;
1258 inv_asym_penalty = BATADV_TQ_MAX_VALUE * neigh_rq_inv_cube;
1259 inv_asym_penalty /= neigh_rq_max_cube;
1260 tq_asym_penalty = BATADV_TQ_MAX_VALUE - inv_asym_penalty;
1262 /* penalize if the OGM is forwarded on the same interface. WiFi
1263 * interfaces and other half duplex devices suffer from throughput
1264 * drops as they can't send and receive at the same time.
1266 tq_iface_penalty = BATADV_TQ_MAX_VALUE;
1267 if (if_outgoing && (if_incoming == if_outgoing) &&
1268 batadv_is_wifi_hardif(if_outgoing))
1269 tq_iface_penalty = batadv_hop_penalty(BATADV_TQ_MAX_VALUE,
1272 combined_tq = batadv_ogm_packet->tq *
1276 combined_tq /= BATADV_TQ_MAX_VALUE *
1277 BATADV_TQ_MAX_VALUE *
1278 BATADV_TQ_MAX_VALUE;
1279 batadv_ogm_packet->tq = combined_tq;
1281 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1282 "bidirectional: orig = %pM neigh = %pM => 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",
1283 orig_node->orig, orig_neigh_node->orig, total_count,
1284 neigh_rq_count, tq_own, tq_asym_penalty, tq_iface_penalty,
1285 batadv_ogm_packet->tq, if_incoming->net_dev->name,
1286 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT");
1288 /* if link has the minimum required transmission quality
1289 * consider it bidirectional
1291 if (batadv_ogm_packet->tq >= BATADV_TQ_TOTAL_BIDRECT_LIMIT)
1296 batadv_neigh_node_put(neigh_node);
1301 * batadv_iv_ogm_update_seqnos - process a batman packet for all interfaces,
1302 * adjust the sequence number and find out whether it is a duplicate
1303 * @ethhdr: ethernet header of the packet
1304 * @batadv_ogm_packet: OGM packet to be considered
1305 * @if_incoming: interface on which the OGM packet was received
1306 * @if_outgoing: interface for which the retransmission should be considered
1308 * Return: duplicate status as enum batadv_dup_status
1310 static enum batadv_dup_status
1311 batadv_iv_ogm_update_seqnos(const struct ethhdr *ethhdr,
1312 const struct batadv_ogm_packet *batadv_ogm_packet,
1313 const struct batadv_hard_iface *if_incoming,
1314 struct batadv_hard_iface *if_outgoing)
1316 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1317 struct batadv_orig_node *orig_node;
1318 struct batadv_orig_ifinfo *orig_ifinfo = NULL;
1319 struct batadv_neigh_node *neigh_node;
1320 struct batadv_neigh_ifinfo *neigh_ifinfo;
1323 bool need_update = false;
1325 enum batadv_dup_status ret = BATADV_NO_DUP;
1326 u32 seqno = ntohl(batadv_ogm_packet->seqno);
1329 unsigned long *bitmap;
1331 orig_node = batadv_iv_ogm_orig_get(bat_priv, batadv_ogm_packet->orig);
1333 return BATADV_NO_DUP;
1335 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1336 if (WARN_ON(!orig_ifinfo)) {
1337 batadv_orig_node_put(orig_node);
1341 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1342 seq_diff = seqno - orig_ifinfo->last_real_seqno;
1344 /* signalize caller that the packet is to be dropped. */
1345 if (!hlist_empty(&orig_node->neigh_list) &&
1346 batadv_window_protected(bat_priv, seq_diff,
1347 BATADV_TQ_LOCAL_WINDOW_SIZE,
1348 &orig_ifinfo->batman_seqno_reset, NULL)) {
1349 ret = BATADV_PROTECTED;
1354 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1355 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node,
1360 neigh_addr = neigh_node->addr;
1361 is_dup = batadv_test_bit(neigh_ifinfo->bat_iv.real_bits,
1362 orig_ifinfo->last_real_seqno,
1365 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1366 neigh_node->if_incoming == if_incoming) {
1369 ret = BATADV_NEIGH_DUP;
1372 if (is_dup && (ret != BATADV_NEIGH_DUP))
1373 ret = BATADV_ORIG_DUP;
1376 /* if the window moved, set the update flag. */
1377 bitmap = neigh_ifinfo->bat_iv.real_bits;
1378 need_update |= batadv_bit_get_packet(bat_priv, bitmap,
1379 seq_diff, set_mark);
1381 packet_count = bitmap_weight(bitmap,
1382 BATADV_TQ_LOCAL_WINDOW_SIZE);
1383 neigh_ifinfo->bat_iv.real_packet_count = packet_count;
1384 batadv_neigh_ifinfo_put(neigh_ifinfo);
1389 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1390 "%s updating last_seqno: old %u, new %u\n",
1391 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT",
1392 orig_ifinfo->last_real_seqno, seqno);
1393 orig_ifinfo->last_real_seqno = seqno;
1397 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1398 batadv_orig_node_put(orig_node);
1399 batadv_orig_ifinfo_put(orig_ifinfo);
1404 * batadv_iv_ogm_process_per_outif - process a batman iv OGM for an outgoing if
1405 * @skb: the skb containing the OGM
1406 * @ogm_offset: offset from skb->data to start of ogm header
1407 * @orig_node: the (cached) orig node for the originator of this OGM
1408 * @if_incoming: the interface where this packet was received
1409 * @if_outgoing: the interface for which the packet should be considered
1412 batadv_iv_ogm_process_per_outif(const struct sk_buff *skb, int ogm_offset,
1413 struct batadv_orig_node *orig_node,
1414 struct batadv_hard_iface *if_incoming,
1415 struct batadv_hard_iface *if_outgoing)
1417 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1418 struct batadv_hardif_neigh_node *hardif_neigh = NULL;
1419 struct batadv_neigh_node *router = NULL;
1420 struct batadv_neigh_node *router_router = NULL;
1421 struct batadv_orig_node *orig_neigh_node;
1422 struct batadv_orig_ifinfo *orig_ifinfo;
1423 struct batadv_neigh_node *orig_neigh_router = NULL;
1424 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
1425 struct batadv_ogm_packet *ogm_packet;
1426 enum batadv_dup_status dup_status;
1427 bool is_from_best_next_hop = false;
1428 bool is_single_hop_neigh = false;
1429 bool sameseq, similar_ttl;
1430 struct sk_buff *skb_priv;
1431 struct ethhdr *ethhdr;
1435 /* create a private copy of the skb, as some functions change tq value
1438 skb_priv = skb_copy(skb, GFP_ATOMIC);
1442 ethhdr = eth_hdr(skb_priv);
1443 ogm_packet = (struct batadv_ogm_packet *)(skb_priv->data + ogm_offset);
1445 dup_status = batadv_iv_ogm_update_seqnos(ethhdr, ogm_packet,
1446 if_incoming, if_outgoing);
1447 if (batadv_compare_eth(ethhdr->h_source, ogm_packet->orig))
1448 is_single_hop_neigh = true;
1450 if (dup_status == BATADV_PROTECTED) {
1451 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1452 "Drop packet: packet within seqno protection time (sender: %pM)\n",
1457 if (ogm_packet->tq == 0) {
1458 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1459 "Drop packet: originator packet with tq equal 0\n");
1463 if (is_single_hop_neigh) {
1464 hardif_neigh = batadv_hardif_neigh_get(if_incoming,
1467 hardif_neigh->last_seen = jiffies;
1470 router = batadv_orig_router_get(orig_node, if_outgoing);
1472 router_router = batadv_orig_router_get(router->orig_node,
1474 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1477 if ((router_ifinfo && router_ifinfo->bat_iv.tq_avg != 0) &&
1478 (batadv_compare_eth(router->addr, ethhdr->h_source)))
1479 is_from_best_next_hop = true;
1481 prev_sender = ogm_packet->prev_sender;
1482 /* avoid temporary routing loops */
1483 if (router && router_router &&
1484 (batadv_compare_eth(router->addr, prev_sender)) &&
1485 !(batadv_compare_eth(ogm_packet->orig, prev_sender)) &&
1486 (batadv_compare_eth(router->addr, router_router->addr))) {
1487 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1488 "Drop packet: ignoring all rebroadcast packets that may make me loop (sender: %pM)\n",
1493 if (if_outgoing == BATADV_IF_DEFAULT)
1494 batadv_tvlv_ogm_receive(bat_priv, ogm_packet, orig_node);
1496 /* if sender is a direct neighbor the sender mac equals
1499 if (is_single_hop_neigh)
1500 orig_neigh_node = orig_node;
1502 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1505 if (!orig_neigh_node)
1508 /* Update nc_nodes of the originator */
1509 batadv_nc_update_nc_node(bat_priv, orig_node, orig_neigh_node,
1510 ogm_packet, is_single_hop_neigh);
1512 orig_neigh_router = batadv_orig_router_get(orig_neigh_node,
1515 /* drop packet if sender is not a direct neighbor and if we
1516 * don't route towards it
1518 if (!is_single_hop_neigh && (!orig_neigh_router)) {
1519 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1520 "Drop packet: OGM via unknown neighbor!\n");
1524 is_bidirect = batadv_iv_ogm_calc_tq(orig_node, orig_neigh_node,
1525 ogm_packet, if_incoming,
1528 /* update ranking if it is not a duplicate or has the same
1529 * seqno and similar ttl as the non-duplicate
1531 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1535 sameseq = orig_ifinfo->last_real_seqno == ntohl(ogm_packet->seqno);
1536 similar_ttl = (orig_ifinfo->last_ttl - 3) <= ogm_packet->ttl;
1538 if (is_bidirect && ((dup_status == BATADV_NO_DUP) ||
1539 (sameseq && similar_ttl))) {
1540 batadv_iv_ogm_orig_update(bat_priv, orig_node,
1541 orig_ifinfo, ethhdr,
1542 ogm_packet, if_incoming,
1543 if_outgoing, dup_status);
1545 batadv_orig_ifinfo_put(orig_ifinfo);
1547 /* only forward for specific interface, not for the default one. */
1548 if (if_outgoing == BATADV_IF_DEFAULT)
1551 /* is single hop (direct) neighbor */
1552 if (is_single_hop_neigh) {
1553 /* OGMs from secondary interfaces should only scheduled once
1554 * per interface where it has been received, not multiple times
1556 if ((ogm_packet->ttl <= 2) &&
1557 (if_incoming != if_outgoing)) {
1558 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1559 "Drop packet: OGM from secondary interface and wrong outgoing interface\n");
1562 /* mark direct link on incoming interface */
1563 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1564 is_single_hop_neigh,
1565 is_from_best_next_hop, if_incoming,
1568 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1569 "Forwarding packet: rebroadcast neighbor packet with direct link flag\n");
1573 /* multihop originator */
1575 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1576 "Drop packet: not received via bidirectional link\n");
1580 if (dup_status == BATADV_NEIGH_DUP) {
1581 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1582 "Drop packet: duplicate packet received\n");
1586 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1587 "Forwarding packet: rebroadcast originator packet\n");
1588 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1589 is_single_hop_neigh, is_from_best_next_hop,
1590 if_incoming, if_outgoing);
1593 if ((orig_neigh_node) && (!is_single_hop_neigh))
1594 batadv_orig_node_put(orig_neigh_node);
1597 batadv_neigh_ifinfo_put(router_ifinfo);
1599 batadv_neigh_node_put(router);
1601 batadv_neigh_node_put(router_router);
1602 if (orig_neigh_router)
1603 batadv_neigh_node_put(orig_neigh_router);
1605 batadv_hardif_neigh_put(hardif_neigh);
1607 consume_skb(skb_priv);
1611 * batadv_iv_ogm_process - process an incoming batman iv OGM
1612 * @skb: the skb containing the OGM
1613 * @ogm_offset: offset to the OGM which should be processed (for aggregates)
1614 * @if_incoming: the interface where this packet was receved
1616 static void batadv_iv_ogm_process(const struct sk_buff *skb, int ogm_offset,
1617 struct batadv_hard_iface *if_incoming)
1619 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1620 struct batadv_orig_node *orig_neigh_node, *orig_node;
1621 struct batadv_hard_iface *hard_iface;
1622 struct batadv_ogm_packet *ogm_packet;
1623 u32 if_incoming_seqno;
1624 bool has_directlink_flag;
1625 struct ethhdr *ethhdr;
1626 bool is_my_oldorig = false;
1627 bool is_my_addr = false;
1628 bool is_my_orig = false;
1630 ogm_packet = (struct batadv_ogm_packet *)(skb->data + ogm_offset);
1631 ethhdr = eth_hdr(skb);
1633 /* Silently drop when the batman packet is actually not a
1636 * This might happen if a packet is padded (e.g. Ethernet has a
1637 * minimum frame length of 64 byte) and the aggregation interprets
1638 * it as an additional length.
1640 * TODO: A more sane solution would be to have a bit in the
1641 * batadv_ogm_packet to detect whether the packet is the last
1642 * packet in an aggregation. Here we expect that the padding
1643 * is always zero (or not 0x01)
1645 if (ogm_packet->packet_type != BATADV_IV_OGM)
1648 /* could be changed by schedule_own_packet() */
1649 if_incoming_seqno = atomic_read(&if_incoming->bat_iv.ogm_seqno);
1651 if (ogm_packet->flags & BATADV_DIRECTLINK)
1652 has_directlink_flag = true;
1654 has_directlink_flag = false;
1656 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1657 "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",
1658 ethhdr->h_source, if_incoming->net_dev->name,
1659 if_incoming->net_dev->dev_addr, ogm_packet->orig,
1660 ogm_packet->prev_sender, ntohl(ogm_packet->seqno),
1661 ogm_packet->tq, ogm_packet->ttl,
1662 ogm_packet->version, has_directlink_flag);
1665 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1666 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1669 if (hard_iface->soft_iface != if_incoming->soft_iface)
1672 if (batadv_compare_eth(ethhdr->h_source,
1673 hard_iface->net_dev->dev_addr))
1676 if (batadv_compare_eth(ogm_packet->orig,
1677 hard_iface->net_dev->dev_addr))
1680 if (batadv_compare_eth(ogm_packet->prev_sender,
1681 hard_iface->net_dev->dev_addr))
1682 is_my_oldorig = true;
1687 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1688 "Drop packet: received my own broadcast (sender: %pM)\n",
1694 unsigned long *word;
1700 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1702 if (!orig_neigh_node)
1705 /* neighbor has to indicate direct link and it has to
1706 * come via the corresponding interface
1707 * save packet seqno for bidirectional check
1709 if (has_directlink_flag &&
1710 batadv_compare_eth(if_incoming->net_dev->dev_addr,
1711 ogm_packet->orig)) {
1712 if_num = if_incoming->if_num;
1713 offset = if_num * BATADV_NUM_WORDS;
1715 spin_lock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1716 word = &orig_neigh_node->bat_iv.bcast_own[offset];
1717 bit_pos = if_incoming_seqno - 2;
1718 bit_pos -= ntohl(ogm_packet->seqno);
1719 batadv_set_bit(word, bit_pos);
1720 weight = &orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1721 *weight = bitmap_weight(word,
1722 BATADV_TQ_LOCAL_WINDOW_SIZE);
1723 spin_unlock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1726 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1727 "Drop packet: originator packet from myself (via neighbor)\n");
1728 batadv_orig_node_put(orig_neigh_node);
1732 if (is_my_oldorig) {
1733 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1734 "Drop packet: ignoring all rebroadcast echos (sender: %pM)\n",
1739 if (ogm_packet->flags & BATADV_NOT_BEST_NEXT_HOP) {
1740 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1741 "Drop packet: ignoring all packets not forwarded from the best next hop (sender: %pM)\n",
1746 orig_node = batadv_iv_ogm_orig_get(bat_priv, ogm_packet->orig);
1750 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1751 if_incoming, BATADV_IF_DEFAULT);
1754 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1755 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1758 if (hard_iface->soft_iface != bat_priv->soft_iface)
1761 if (!kref_get_unless_zero(&hard_iface->refcount))
1764 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1765 if_incoming, hard_iface);
1767 batadv_hardif_put(hard_iface);
1771 batadv_orig_node_put(orig_node);
1774 static void batadv_iv_send_outstanding_bat_ogm_packet(struct work_struct *work)
1776 struct delayed_work *delayed_work;
1777 struct batadv_forw_packet *forw_packet;
1778 struct batadv_priv *bat_priv;
1779 bool dropped = false;
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);
1786 if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_DEACTIVATING) {
1791 batadv_iv_ogm_emit(forw_packet);
1793 /* we have to have at least one packet in the queue to determine the
1794 * queues wake up time unless we are shutting down.
1796 * only re-schedule if this is the "original" copy, e.g. the OGM of the
1797 * primary interface should only be rescheduled once per period, but
1798 * this function will be called for the forw_packet instances of the
1799 * other secondary interfaces as well.
1801 if (forw_packet->own &&
1802 forw_packet->if_incoming == forw_packet->if_outgoing)
1803 batadv_iv_ogm_schedule(forw_packet->if_incoming);
1806 /* do we get something for free()? */
1807 if (batadv_forw_packet_steal(forw_packet,
1808 &bat_priv->forw_bat_list_lock))
1809 batadv_forw_packet_free(forw_packet, dropped);
1812 static int batadv_iv_ogm_receive(struct sk_buff *skb,
1813 struct batadv_hard_iface *if_incoming)
1815 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1816 struct batadv_ogm_packet *ogm_packet;
1820 int ret = NET_RX_DROP;
1822 res = batadv_check_management_packet(skb, if_incoming, BATADV_OGM_HLEN);
1826 /* did we receive a B.A.T.M.A.N. IV OGM packet on an interface
1827 * that does not have B.A.T.M.A.N. IV enabled ?
1829 if (bat_priv->algo_ops->iface.enable != batadv_iv_ogm_iface_enable)
1832 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_RX);
1833 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_RX_BYTES,
1834 skb->len + ETH_HLEN);
1837 ogm_packet = (struct batadv_ogm_packet *)skb->data;
1839 /* unpack the aggregated packets and process them one by one */
1840 while (batadv_iv_ogm_aggr_packet(ogm_offset, skb_headlen(skb),
1841 ogm_packet->tvlv_len)) {
1842 batadv_iv_ogm_process(skb, ogm_offset, if_incoming);
1844 ogm_offset += BATADV_OGM_HLEN;
1845 ogm_offset += ntohs(ogm_packet->tvlv_len);
1847 packet_pos = skb->data + ogm_offset;
1848 ogm_packet = (struct batadv_ogm_packet *)packet_pos;
1851 ret = NET_RX_SUCCESS;
1854 if (ret == NET_RX_SUCCESS)
1862 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1864 * batadv_iv_ogm_orig_print_neigh - print neighbors for the originator table
1865 * @orig_node: the orig_node for which the neighbors are printed
1866 * @if_outgoing: outgoing interface for these entries
1867 * @seq: debugfs table seq_file struct
1869 * Must be called while holding an rcu lock.
1872 batadv_iv_ogm_orig_print_neigh(struct batadv_orig_node *orig_node,
1873 struct batadv_hard_iface *if_outgoing,
1874 struct seq_file *seq)
1876 struct batadv_neigh_node *neigh_node;
1877 struct batadv_neigh_ifinfo *n_ifinfo;
1879 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1880 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
1884 seq_printf(seq, " %pM (%3i)",
1886 n_ifinfo->bat_iv.tq_avg);
1888 batadv_neigh_ifinfo_put(n_ifinfo);
1893 * batadv_iv_ogm_orig_print - print the originator table
1894 * @bat_priv: the bat priv with all the soft interface information
1895 * @seq: debugfs table seq_file struct
1896 * @if_outgoing: the outgoing interface for which this should be printed
1898 static void batadv_iv_ogm_orig_print(struct batadv_priv *bat_priv,
1899 struct seq_file *seq,
1900 struct batadv_hard_iface *if_outgoing)
1902 struct batadv_neigh_node *neigh_node;
1903 struct batadv_hashtable *hash = bat_priv->orig_hash;
1904 int last_seen_msecs, last_seen_secs;
1905 struct batadv_orig_node *orig_node;
1906 struct batadv_neigh_ifinfo *n_ifinfo;
1907 unsigned long last_seen_jiffies;
1908 struct hlist_head *head;
1909 int batman_count = 0;
1913 " Originator last-seen (#/255) Nexthop [outgoingIF]: Potential nexthops ...\n");
1915 for (i = 0; i < hash->size; i++) {
1916 head = &hash->table[i];
1919 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
1920 neigh_node = batadv_orig_router_get(orig_node,
1925 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node,
1930 if (n_ifinfo->bat_iv.tq_avg == 0)
1933 last_seen_jiffies = jiffies - orig_node->last_seen;
1934 last_seen_msecs = jiffies_to_msecs(last_seen_jiffies);
1935 last_seen_secs = last_seen_msecs / 1000;
1936 last_seen_msecs = last_seen_msecs % 1000;
1938 seq_printf(seq, "%pM %4i.%03is (%3i) %pM [%10s]:",
1939 orig_node->orig, last_seen_secs,
1940 last_seen_msecs, n_ifinfo->bat_iv.tq_avg,
1942 neigh_node->if_incoming->net_dev->name);
1944 batadv_iv_ogm_orig_print_neigh(orig_node, if_outgoing,
1946 seq_putc(seq, '\n');
1950 batadv_neigh_node_put(neigh_node);
1952 batadv_neigh_ifinfo_put(n_ifinfo);
1957 if (batman_count == 0)
1958 seq_puts(seq, "No batman nodes in range ...\n");
1963 * batadv_iv_ogm_neigh_get_tq_avg - Get the TQ average for a neighbour on a
1964 * given outgoing interface.
1965 * @neigh_node: Neighbour of interest
1966 * @if_outgoing: Outgoing interface of interest
1967 * @tq_avg: Pointer of where to store the TQ average
1969 * Return: False if no average TQ available, otherwise true.
1972 batadv_iv_ogm_neigh_get_tq_avg(struct batadv_neigh_node *neigh_node,
1973 struct batadv_hard_iface *if_outgoing,
1976 struct batadv_neigh_ifinfo *n_ifinfo;
1978 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
1982 *tq_avg = n_ifinfo->bat_iv.tq_avg;
1983 batadv_neigh_ifinfo_put(n_ifinfo);
1989 * batadv_iv_ogm_orig_dump_subentry - Dump an originator subentry into a
1991 * @msg: Netlink message to dump into
1992 * @portid: Port making netlink request
1993 * @seq: Sequence number of netlink message
1994 * @bat_priv: The bat priv with all the soft interface information
1995 * @if_outgoing: Limit dump to entries with this outgoing interface
1996 * @orig_node: Originator to dump
1997 * @neigh_node: Single hops neighbour
1998 * @best: Is the best originator
2000 * Return: Error code, or 0 on success
2003 batadv_iv_ogm_orig_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq,
2004 struct batadv_priv *bat_priv,
2005 struct batadv_hard_iface *if_outgoing,
2006 struct batadv_orig_node *orig_node,
2007 struct batadv_neigh_node *neigh_node,
2012 unsigned int last_seen_msecs;
2014 last_seen_msecs = jiffies_to_msecs(jiffies - orig_node->last_seen);
2016 if (!batadv_iv_ogm_neigh_get_tq_avg(neigh_node, if_outgoing, &tq_avg))
2019 if (if_outgoing != BATADV_IF_DEFAULT &&
2020 if_outgoing != neigh_node->if_incoming)
2023 hdr = genlmsg_put(msg, portid, seq, &batadv_netlink_family,
2024 NLM_F_MULTI, BATADV_CMD_GET_ORIGINATORS);
2028 if (nla_put(msg, BATADV_ATTR_ORIG_ADDRESS, ETH_ALEN,
2030 nla_put(msg, BATADV_ATTR_NEIGH_ADDRESS, ETH_ALEN,
2031 neigh_node->addr) ||
2032 nla_put_u32(msg, BATADV_ATTR_HARD_IFINDEX,
2033 neigh_node->if_incoming->net_dev->ifindex) ||
2034 nla_put_u8(msg, BATADV_ATTR_TQ, tq_avg) ||
2035 nla_put_u32(msg, BATADV_ATTR_LAST_SEEN_MSECS,
2037 goto nla_put_failure;
2039 if (best && nla_put_flag(msg, BATADV_ATTR_FLAG_BEST))
2040 goto nla_put_failure;
2042 genlmsg_end(msg, hdr);
2046 genlmsg_cancel(msg, hdr);
2051 * batadv_iv_ogm_orig_dump_entry - Dump an originator entry into a message
2052 * @msg: Netlink message to dump into
2053 * @portid: Port making netlink request
2054 * @seq: Sequence number of netlink message
2055 * @bat_priv: The bat priv with all the soft interface information
2056 * @if_outgoing: Limit dump to entries with this outgoing interface
2057 * @orig_node: Originator to dump
2058 * @sub_s: Number of sub entries to skip
2060 * This function assumes the caller holds rcu_read_lock().
2062 * Return: Error code, or 0 on success
2065 batadv_iv_ogm_orig_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
2066 struct batadv_priv *bat_priv,
2067 struct batadv_hard_iface *if_outgoing,
2068 struct batadv_orig_node *orig_node, int *sub_s)
2070 struct batadv_neigh_node *neigh_node_best;
2071 struct batadv_neigh_node *neigh_node;
2076 neigh_node_best = batadv_orig_router_get(orig_node, if_outgoing);
2077 if (!neigh_node_best)
2080 if (!batadv_iv_ogm_neigh_get_tq_avg(neigh_node_best, if_outgoing,
2084 if (tq_avg_best == 0)
2087 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
2091 best = (neigh_node == neigh_node_best);
2093 if (batadv_iv_ogm_orig_dump_subentry(msg, portid, seq,
2094 bat_priv, if_outgoing,
2095 orig_node, neigh_node,
2097 batadv_neigh_node_put(neigh_node_best);
2105 if (neigh_node_best)
2106 batadv_neigh_node_put(neigh_node_best);
2113 * batadv_iv_ogm_orig_dump_bucket - Dump an originator bucket into a
2115 * @msg: Netlink message to dump into
2116 * @portid: Port making netlink request
2117 * @seq: Sequence number of netlink message
2118 * @bat_priv: The bat priv with all the soft interface information
2119 * @if_outgoing: Limit dump to entries with this outgoing interface
2120 * @head: Bucket to be dumped
2121 * @idx_s: Number of entries to be skipped
2122 * @sub: Number of sub entries to be skipped
2124 * Return: Error code, or 0 on success
2127 batadv_iv_ogm_orig_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq,
2128 struct batadv_priv *bat_priv,
2129 struct batadv_hard_iface *if_outgoing,
2130 struct hlist_head *head, int *idx_s, int *sub)
2132 struct batadv_orig_node *orig_node;
2136 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
2140 if (batadv_iv_ogm_orig_dump_entry(msg, portid, seq, bat_priv,
2141 if_outgoing, orig_node,
2156 * batadv_iv_ogm_orig_dump - Dump the originators into a message
2157 * @msg: Netlink message to dump into
2158 * @cb: Control block containing additional options
2159 * @bat_priv: The bat priv with all the soft interface information
2160 * @if_outgoing: Limit dump to entries with this outgoing interface
2163 batadv_iv_ogm_orig_dump(struct sk_buff *msg, struct netlink_callback *cb,
2164 struct batadv_priv *bat_priv,
2165 struct batadv_hard_iface *if_outgoing)
2167 struct batadv_hashtable *hash = bat_priv->orig_hash;
2168 struct hlist_head *head;
2169 int bucket = cb->args[0];
2170 int idx = cb->args[1];
2171 int sub = cb->args[2];
2172 int portid = NETLINK_CB(cb->skb).portid;
2174 while (bucket < hash->size) {
2175 head = &hash->table[bucket];
2177 if (batadv_iv_ogm_orig_dump_bucket(msg, portid,
2179 bat_priv, if_outgoing, head,
2186 cb->args[0] = bucket;
2191 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2193 * batadv_iv_hardif_neigh_print - print a single hop neighbour node
2194 * @seq: neighbour table seq_file struct
2195 * @hardif_neigh: hardif neighbour information
2198 batadv_iv_hardif_neigh_print(struct seq_file *seq,
2199 struct batadv_hardif_neigh_node *hardif_neigh)
2201 int last_secs, last_msecs;
2203 last_secs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) / 1000;
2204 last_msecs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) % 1000;
2206 seq_printf(seq, " %10s %pM %4i.%03is\n",
2207 hardif_neigh->if_incoming->net_dev->name,
2208 hardif_neigh->addr, last_secs, last_msecs);
2212 * batadv_iv_ogm_neigh_print - print the single hop neighbour list
2213 * @bat_priv: the bat priv with all the soft interface information
2214 * @seq: neighbour table seq_file struct
2216 static void batadv_iv_neigh_print(struct batadv_priv *bat_priv,
2217 struct seq_file *seq)
2219 struct net_device *net_dev = (struct net_device *)seq->private;
2220 struct batadv_hardif_neigh_node *hardif_neigh;
2221 struct batadv_hard_iface *hard_iface;
2222 int batman_count = 0;
2224 seq_puts(seq, " IF Neighbor last-seen\n");
2227 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
2228 if (hard_iface->soft_iface != net_dev)
2231 hlist_for_each_entry_rcu(hardif_neigh,
2232 &hard_iface->neigh_list, list) {
2233 batadv_iv_hardif_neigh_print(seq, hardif_neigh);
2239 if (batman_count == 0)
2240 seq_puts(seq, "No batman nodes in range ...\n");
2245 * batadv_iv_ogm_neigh_diff - calculate tq difference of two neighbors
2246 * @neigh1: the first neighbor object of the comparison
2247 * @if_outgoing1: outgoing interface for the first neighbor
2248 * @neigh2: the second neighbor object of the comparison
2249 * @if_outgoing2: outgoing interface for the second neighbor
2250 * @diff: pointer to integer receiving the calculated difference
2252 * The content of *@diff is only valid when this function returns true.
2253 * It is less, equal to or greater than 0 if the metric via neigh1 is lower,
2254 * the same as or higher than the metric via neigh2
2256 * Return: true when the difference could be calculated, false otherwise
2258 static bool batadv_iv_ogm_neigh_diff(struct batadv_neigh_node *neigh1,
2259 struct batadv_hard_iface *if_outgoing1,
2260 struct batadv_neigh_node *neigh2,
2261 struct batadv_hard_iface *if_outgoing2,
2264 struct batadv_neigh_ifinfo *neigh1_ifinfo, *neigh2_ifinfo;
2268 neigh1_ifinfo = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
2269 neigh2_ifinfo = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
2271 if (!neigh1_ifinfo || !neigh2_ifinfo) {
2276 tq1 = neigh1_ifinfo->bat_iv.tq_avg;
2277 tq2 = neigh2_ifinfo->bat_iv.tq_avg;
2278 *diff = (int)tq1 - (int)tq2;
2282 batadv_neigh_ifinfo_put(neigh1_ifinfo);
2284 batadv_neigh_ifinfo_put(neigh2_ifinfo);
2290 * batadv_iv_ogm_neigh_dump_neigh - Dump a neighbour into a netlink message
2291 * @msg: Netlink message to dump into
2292 * @portid: Port making netlink request
2293 * @seq: Sequence number of netlink message
2294 * @hardif_neigh: Neighbour to be dumped
2296 * Return: Error code, or 0 on success
2299 batadv_iv_ogm_neigh_dump_neigh(struct sk_buff *msg, u32 portid, u32 seq,
2300 struct batadv_hardif_neigh_node *hardif_neigh)
2303 unsigned int last_seen_msecs;
2305 last_seen_msecs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen);
2307 hdr = genlmsg_put(msg, portid, seq, &batadv_netlink_family,
2308 NLM_F_MULTI, BATADV_CMD_GET_NEIGHBORS);
2312 if (nla_put(msg, BATADV_ATTR_NEIGH_ADDRESS, ETH_ALEN,
2313 hardif_neigh->addr) ||
2314 nla_put_u32(msg, BATADV_ATTR_HARD_IFINDEX,
2315 hardif_neigh->if_incoming->net_dev->ifindex) ||
2316 nla_put_u32(msg, BATADV_ATTR_LAST_SEEN_MSECS,
2318 goto nla_put_failure;
2320 genlmsg_end(msg, hdr);
2324 genlmsg_cancel(msg, hdr);
2329 * batadv_iv_ogm_neigh_dump_hardif - Dump the neighbours of a hard interface
2331 * @msg: Netlink message to dump into
2332 * @portid: Port making netlink request
2333 * @seq: Sequence number of netlink message
2334 * @bat_priv: The bat priv with all the soft interface information
2335 * @hard_iface: Hard interface to dump the neighbours for
2336 * @idx_s: Number of entries to skip
2338 * This function assumes the caller holds rcu_read_lock().
2340 * Return: Error code, or 0 on success
2343 batadv_iv_ogm_neigh_dump_hardif(struct sk_buff *msg, u32 portid, u32 seq,
2344 struct batadv_priv *bat_priv,
2345 struct batadv_hard_iface *hard_iface,
2348 struct batadv_hardif_neigh_node *hardif_neigh;
2351 hlist_for_each_entry_rcu(hardif_neigh,
2352 &hard_iface->neigh_list, list) {
2356 if (batadv_iv_ogm_neigh_dump_neigh(msg, portid, seq,
2368 * batadv_iv_ogm_neigh_dump - Dump the neighbours into a message
2369 * @msg: Netlink message to dump into
2370 * @cb: Control block containing additional options
2371 * @bat_priv: The bat priv with all the soft interface information
2372 * @single_hardif: Limit dump to this hard interfaace
2375 batadv_iv_ogm_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb,
2376 struct batadv_priv *bat_priv,
2377 struct batadv_hard_iface *single_hardif)
2379 struct batadv_hard_iface *hard_iface;
2381 int i_hardif_s = cb->args[0];
2382 int idx = cb->args[1];
2383 int portid = NETLINK_CB(cb->skb).portid;
2386 if (single_hardif) {
2387 if (i_hardif_s == 0) {
2388 if (batadv_iv_ogm_neigh_dump_hardif(msg, portid,
2396 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list,
2398 if (hard_iface->soft_iface != bat_priv->soft_iface)
2401 if (i_hardif++ < i_hardif_s)
2404 if (batadv_iv_ogm_neigh_dump_hardif(msg, portid,
2407 hard_iface, &idx)) {
2415 cb->args[0] = i_hardif;
2420 * batadv_iv_ogm_neigh_cmp - compare the metrics of two neighbors
2421 * @neigh1: the first neighbor object of the comparison
2422 * @if_outgoing1: outgoing interface for the first neighbor
2423 * @neigh2: the second neighbor object of the comparison
2424 * @if_outgoing2: outgoing interface for the second neighbor
2426 * Return: a value less, equal to or greater than 0 if the metric via neigh1 is
2427 * lower, the same as or higher than the metric via neigh2
2429 static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
2430 struct batadv_hard_iface *if_outgoing1,
2431 struct batadv_neigh_node *neigh2,
2432 struct batadv_hard_iface *if_outgoing2)
2437 ret = batadv_iv_ogm_neigh_diff(neigh1, if_outgoing1, neigh2,
2438 if_outgoing2, &diff);
2446 * batadv_iv_ogm_neigh_is_sob - check if neigh1 is similarly good or better
2447 * than neigh2 from the metric prospective
2448 * @neigh1: the first neighbor object of the comparison
2449 * @if_outgoing1: outgoing interface for the first neighbor
2450 * @neigh2: the second neighbor object of the comparison
2451 * @if_outgoing2: outgoing interface for the second neighbor
2453 * Return: true if the metric via neigh1 is equally good or better than
2454 * the metric via neigh2, false otherwise.
2457 batadv_iv_ogm_neigh_is_sob(struct batadv_neigh_node *neigh1,
2458 struct batadv_hard_iface *if_outgoing1,
2459 struct batadv_neigh_node *neigh2,
2460 struct batadv_hard_iface *if_outgoing2)
2465 ret = batadv_iv_ogm_neigh_diff(neigh1, if_outgoing1, neigh2,
2466 if_outgoing2, &diff);
2470 ret = diff > -BATADV_TQ_SIMILARITY_THRESHOLD;
2474 static void batadv_iv_iface_activate(struct batadv_hard_iface *hard_iface)
2476 /* begin scheduling originator messages on that interface */
2477 batadv_iv_ogm_schedule(hard_iface);
2481 * batadv_iv_init_sel_class - initialize GW selection class
2482 * @bat_priv: the bat priv with all the soft interface information
2484 static void batadv_iv_init_sel_class(struct batadv_priv *bat_priv)
2486 /* set default TQ difference threshold to 20 */
2487 atomic_set(&bat_priv->gw.sel_class, 20);
2490 static struct batadv_gw_node *
2491 batadv_iv_gw_get_best_gw_node(struct batadv_priv *bat_priv)
2493 struct batadv_neigh_node *router;
2494 struct batadv_neigh_ifinfo *router_ifinfo;
2495 struct batadv_gw_node *gw_node, *curr_gw = NULL;
2496 u64 max_gw_factor = 0;
2497 u64 tmp_gw_factor = 0;
2500 struct batadv_orig_node *orig_node;
2503 hlist_for_each_entry_rcu(gw_node, &bat_priv->gw.gateway_list, list) {
2504 orig_node = gw_node->orig_node;
2505 router = batadv_orig_router_get(orig_node, BATADV_IF_DEFAULT);
2509 router_ifinfo = batadv_neigh_ifinfo_get(router,
2514 if (!kref_get_unless_zero(&gw_node->refcount))
2517 tq_avg = router_ifinfo->bat_iv.tq_avg;
2519 switch (atomic_read(&bat_priv->gw.sel_class)) {
2520 case 1: /* fast connection */
2521 tmp_gw_factor = tq_avg * tq_avg;
2522 tmp_gw_factor *= gw_node->bandwidth_down;
2523 tmp_gw_factor *= 100 * 100;
2524 tmp_gw_factor >>= 18;
2526 if ((tmp_gw_factor > max_gw_factor) ||
2527 ((tmp_gw_factor == max_gw_factor) &&
2528 (tq_avg > max_tq))) {
2530 batadv_gw_node_put(curr_gw);
2532 kref_get(&curr_gw->refcount);
2536 default: /* 2: stable connection (use best statistic)
2537 * 3: fast-switch (use best statistic but change as
2538 * soon as a better gateway appears)
2539 * XX: late-switch (use best statistic but change as
2540 * soon as a better gateway appears which has
2541 * $routing_class more tq points)
2543 if (tq_avg > max_tq) {
2545 batadv_gw_node_put(curr_gw);
2547 kref_get(&curr_gw->refcount);
2552 if (tq_avg > max_tq)
2555 if (tmp_gw_factor > max_gw_factor)
2556 max_gw_factor = tmp_gw_factor;
2558 batadv_gw_node_put(gw_node);
2561 batadv_neigh_node_put(router);
2563 batadv_neigh_ifinfo_put(router_ifinfo);
2570 static bool batadv_iv_gw_is_eligible(struct batadv_priv *bat_priv,
2571 struct batadv_orig_node *curr_gw_orig,
2572 struct batadv_orig_node *orig_node)
2574 struct batadv_neigh_ifinfo *router_orig_ifinfo = NULL;
2575 struct batadv_neigh_ifinfo *router_gw_ifinfo = NULL;
2576 struct batadv_neigh_node *router_gw = NULL;
2577 struct batadv_neigh_node *router_orig = NULL;
2578 u8 gw_tq_avg, orig_tq_avg;
2581 /* dynamic re-election is performed only on fast or late switch */
2582 if (atomic_read(&bat_priv->gw.sel_class) <= 2)
2585 router_gw = batadv_orig_router_get(curr_gw_orig, BATADV_IF_DEFAULT);
2591 router_gw_ifinfo = batadv_neigh_ifinfo_get(router_gw,
2593 if (!router_gw_ifinfo) {
2598 router_orig = batadv_orig_router_get(orig_node, BATADV_IF_DEFAULT);
2602 router_orig_ifinfo = batadv_neigh_ifinfo_get(router_orig,
2604 if (!router_orig_ifinfo)
2607 gw_tq_avg = router_gw_ifinfo->bat_iv.tq_avg;
2608 orig_tq_avg = router_orig_ifinfo->bat_iv.tq_avg;
2610 /* the TQ value has to be better */
2611 if (orig_tq_avg < gw_tq_avg)
2614 /* if the routing class is greater than 3 the value tells us how much
2615 * greater the TQ value of the new gateway must be
2617 if ((atomic_read(&bat_priv->gw.sel_class) > 3) &&
2618 (orig_tq_avg - gw_tq_avg < atomic_read(&bat_priv->gw.sel_class)))
2621 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
2622 "Restarting gateway selection: better gateway found (tq curr: %i, tq new: %i)\n",
2623 gw_tq_avg, orig_tq_avg);
2627 if (router_gw_ifinfo)
2628 batadv_neigh_ifinfo_put(router_gw_ifinfo);
2629 if (router_orig_ifinfo)
2630 batadv_neigh_ifinfo_put(router_orig_ifinfo);
2632 batadv_neigh_node_put(router_gw);
2634 batadv_neigh_node_put(router_orig);
2639 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2640 /* fails if orig_node has no router */
2641 static int batadv_iv_gw_write_buffer_text(struct batadv_priv *bat_priv,
2642 struct seq_file *seq,
2643 const struct batadv_gw_node *gw_node)
2645 struct batadv_gw_node *curr_gw;
2646 struct batadv_neigh_node *router;
2647 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
2650 router = batadv_orig_router_get(gw_node->orig_node, BATADV_IF_DEFAULT);
2654 router_ifinfo = batadv_neigh_ifinfo_get(router, BATADV_IF_DEFAULT);
2658 curr_gw = batadv_gw_get_selected_gw_node(bat_priv);
2660 seq_printf(seq, "%s %pM (%3i) %pM [%10s]: %u.%u/%u.%u MBit\n",
2661 (curr_gw == gw_node ? "=>" : " "),
2662 gw_node->orig_node->orig,
2663 router_ifinfo->bat_iv.tq_avg, router->addr,
2664 router->if_incoming->net_dev->name,
2665 gw_node->bandwidth_down / 10,
2666 gw_node->bandwidth_down % 10,
2667 gw_node->bandwidth_up / 10,
2668 gw_node->bandwidth_up % 10);
2669 ret = seq_has_overflowed(seq) ? -1 : 0;
2672 batadv_gw_node_put(curr_gw);
2675 batadv_neigh_ifinfo_put(router_ifinfo);
2677 batadv_neigh_node_put(router);
2681 static void batadv_iv_gw_print(struct batadv_priv *bat_priv,
2682 struct seq_file *seq)
2684 struct batadv_gw_node *gw_node;
2688 " Gateway (#/255) Nexthop [outgoingIF]: advertised uplink bandwidth\n");
2691 hlist_for_each_entry_rcu(gw_node, &bat_priv->gw.gateway_list, list) {
2692 /* fails if orig_node has no router */
2693 if (batadv_iv_gw_write_buffer_text(bat_priv, seq, gw_node) < 0)
2701 seq_puts(seq, "No gateways in range ...\n");
2706 * batadv_iv_gw_dump_entry - Dump a gateway into a message
2707 * @msg: Netlink message to dump into
2708 * @portid: Port making netlink request
2709 * @seq: Sequence number of netlink message
2710 * @bat_priv: The bat priv with all the soft interface information
2711 * @gw_node: Gateway to be dumped
2713 * Return: Error code, or 0 on success
2715 static int batadv_iv_gw_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
2716 struct batadv_priv *bat_priv,
2717 struct batadv_gw_node *gw_node)
2719 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
2720 struct batadv_neigh_node *router;
2721 struct batadv_gw_node *curr_gw;
2725 router = batadv_orig_router_get(gw_node->orig_node, BATADV_IF_DEFAULT);
2729 router_ifinfo = batadv_neigh_ifinfo_get(router, BATADV_IF_DEFAULT);
2733 curr_gw = batadv_gw_get_selected_gw_node(bat_priv);
2735 hdr = genlmsg_put(msg, portid, seq, &batadv_netlink_family,
2736 NLM_F_MULTI, BATADV_CMD_GET_GATEWAYS);
2744 if (curr_gw == gw_node)
2745 if (nla_put_flag(msg, BATADV_ATTR_FLAG_BEST)) {
2746 genlmsg_cancel(msg, hdr);
2750 if (nla_put(msg, BATADV_ATTR_ORIG_ADDRESS, ETH_ALEN,
2751 gw_node->orig_node->orig) ||
2752 nla_put_u8(msg, BATADV_ATTR_TQ, router_ifinfo->bat_iv.tq_avg) ||
2753 nla_put(msg, BATADV_ATTR_ROUTER, ETH_ALEN,
2755 nla_put_string(msg, BATADV_ATTR_HARD_IFNAME,
2756 router->if_incoming->net_dev->name) ||
2757 nla_put_u32(msg, BATADV_ATTR_BANDWIDTH_DOWN,
2758 gw_node->bandwidth_down) ||
2759 nla_put_u32(msg, BATADV_ATTR_BANDWIDTH_UP,
2760 gw_node->bandwidth_up)) {
2761 genlmsg_cancel(msg, hdr);
2765 genlmsg_end(msg, hdr);
2770 batadv_neigh_ifinfo_put(router_ifinfo);
2772 batadv_neigh_node_put(router);
2777 * batadv_iv_gw_dump - Dump gateways into a message
2778 * @msg: Netlink message to dump into
2779 * @cb: Control block containing additional options
2780 * @bat_priv: The bat priv with all the soft interface information
2782 static void batadv_iv_gw_dump(struct sk_buff *msg, struct netlink_callback *cb,
2783 struct batadv_priv *bat_priv)
2785 int portid = NETLINK_CB(cb->skb).portid;
2786 struct batadv_gw_node *gw_node;
2787 int idx_skip = cb->args[0];
2791 hlist_for_each_entry_rcu(gw_node, &bat_priv->gw.gateway_list, list) {
2792 if (idx++ < idx_skip)
2795 if (batadv_iv_gw_dump_entry(msg, portid, cb->nlh->nlmsg_seq,
2796 bat_priv, gw_node)) {
2806 cb->args[0] = idx_skip;
2809 static struct batadv_algo_ops batadv_batman_iv __read_mostly = {
2810 .name = "BATMAN_IV",
2812 .activate = batadv_iv_iface_activate,
2813 .enable = batadv_iv_ogm_iface_enable,
2814 .disable = batadv_iv_ogm_iface_disable,
2815 .update_mac = batadv_iv_ogm_iface_update_mac,
2816 .primary_set = batadv_iv_ogm_primary_iface_set,
2819 .cmp = batadv_iv_ogm_neigh_cmp,
2820 .is_similar_or_better = batadv_iv_ogm_neigh_is_sob,
2821 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2822 .print = batadv_iv_neigh_print,
2824 .dump = batadv_iv_ogm_neigh_dump,
2827 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2828 .print = batadv_iv_ogm_orig_print,
2830 .dump = batadv_iv_ogm_orig_dump,
2831 .free = batadv_iv_ogm_orig_free,
2832 .add_if = batadv_iv_ogm_orig_add_if,
2833 .del_if = batadv_iv_ogm_orig_del_if,
2836 .init_sel_class = batadv_iv_init_sel_class,
2837 .get_best_gw_node = batadv_iv_gw_get_best_gw_node,
2838 .is_eligible = batadv_iv_gw_is_eligible,
2839 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2840 .print = batadv_iv_gw_print,
2842 .dump = batadv_iv_gw_dump,
2846 int __init batadv_iv_init(void)
2850 /* batman originator packet */
2851 ret = batadv_recv_handler_register(BATADV_IV_OGM,
2852 batadv_iv_ogm_receive);
2856 ret = batadv_algo_register(&batadv_batman_iv);
2858 goto handler_unregister;
2863 batadv_recv_handler_unregister(BATADV_IV_OGM);