1 /* Copyright (C) 2007-2015 B.A.T.M.A.N. contributors:
3 * Marek Lindner, Simon Wunderlich
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of version 2 of the GNU General Public
7 * License as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 #include <linux/atomic.h>
22 #include <linux/bitmap.h>
23 #include <linux/bitops.h>
24 #include <linux/bug.h>
25 #include <linux/byteorder/generic.h>
26 #include <linux/cache.h>
27 #include <linux/errno.h>
28 #include <linux/etherdevice.h>
30 #include <linux/if_ether.h>
31 #include <linux/init.h>
32 #include <linux/jiffies.h>
33 #include <linux/list.h>
34 #include <linux/netdevice.h>
35 #include <linux/pkt_sched.h>
36 #include <linux/printk.h>
37 #include <linux/random.h>
38 #include <linux/rculist.h>
39 #include <linux/rcupdate.h>
40 #include <linux/seq_file.h>
41 #include <linux/skbuff.h>
42 #include <linux/slab.h>
43 #include <linux/spinlock.h>
44 #include <linux/stddef.h>
45 #include <linux/string.h>
46 #include <linux/types.h>
47 #include <linux/workqueue.h>
50 #include "hard-interface.h"
52 #include "network-coding.h"
53 #include "originator.h"
57 #include "translation-table.h"
60 * enum batadv_dup_status - duplicate status
61 * @BATADV_NO_DUP: the packet is no duplicate
62 * @BATADV_ORIG_DUP: OGM is a duplicate in the originator (but not for the
64 * @BATADV_NEIGH_DUP: OGM is a duplicate for the neighbor
65 * @BATADV_PROTECTED: originator is currently protected (after reboot)
67 enum batadv_dup_status {
75 * batadv_ring_buffer_set - update the ring buffer with the given value
76 * @lq_recv: pointer to the ring buffer
77 * @lq_index: index to store the value at
78 * @value: value to store in the ring buffer
80 static void batadv_ring_buffer_set(u8 lq_recv[], u8 *lq_index, u8 value)
82 lq_recv[*lq_index] = value;
83 *lq_index = (*lq_index + 1) % BATADV_TQ_GLOBAL_WINDOW_SIZE;
87 * batadv_ring_buffer_avg - compute the average of all non-zero values stored
88 * in the given ring buffer
89 * @lq_recv: pointer to the ring buffer
91 * Returns computed average value.
93 static u8 batadv_ring_buffer_avg(const u8 lq_recv[])
102 while (i < BATADV_TQ_GLOBAL_WINDOW_SIZE) {
115 return (u8)(sum / count);
119 * batadv_iv_ogm_orig_free - free the private resources allocated for this
121 * @orig_node: the orig_node for which the resources have to be free'd
123 static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node)
125 kfree(orig_node->bat_iv.bcast_own);
126 kfree(orig_node->bat_iv.bcast_own_sum);
130 * batadv_iv_ogm_orig_add_if - change the private structures of the orig_node to
131 * include the new hard-interface
132 * @orig_node: the orig_node that has to be changed
133 * @max_if_num: the current amount of interfaces
135 * Returns 0 on success, a negative error code otherwise.
137 static int batadv_iv_ogm_orig_add_if(struct batadv_orig_node *orig_node,
144 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
146 old_size = (max_if_num - 1) * sizeof(unsigned long) * BATADV_NUM_WORDS;
147 data_ptr = kmalloc_array(max_if_num,
148 BATADV_NUM_WORDS * sizeof(unsigned long),
153 memcpy(data_ptr, orig_node->bat_iv.bcast_own, old_size);
154 kfree(orig_node->bat_iv.bcast_own);
155 orig_node->bat_iv.bcast_own = data_ptr;
157 data_ptr = kmalloc_array(max_if_num, sizeof(u8), GFP_ATOMIC);
159 kfree(orig_node->bat_iv.bcast_own);
163 memcpy(data_ptr, orig_node->bat_iv.bcast_own_sum,
164 (max_if_num - 1) * sizeof(u8));
165 kfree(orig_node->bat_iv.bcast_own_sum);
166 orig_node->bat_iv.bcast_own_sum = data_ptr;
171 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
177 * batadv_iv_ogm_orig_del_if - change the private structures of the orig_node to
178 * exclude the removed interface
179 * @orig_node: the orig_node that has to be changed
180 * @max_if_num: the current amount of interfaces
181 * @del_if_num: the index of the interface being removed
183 * Returns 0 on success, a negative error code otherwise.
185 static int batadv_iv_ogm_orig_del_if(struct batadv_orig_node *orig_node,
186 int max_if_num, int del_if_num)
189 size_t chunk_size, if_offset;
190 void *data_ptr = NULL;
192 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
194 /* last interface was removed */
198 chunk_size = sizeof(unsigned long) * BATADV_NUM_WORDS;
199 data_ptr = kmalloc_array(max_if_num, chunk_size, GFP_ATOMIC);
203 /* copy first part */
204 memcpy(data_ptr, orig_node->bat_iv.bcast_own, del_if_num * chunk_size);
206 /* copy second part */
207 if_offset = (del_if_num + 1) * chunk_size;
208 memcpy((char *)data_ptr + del_if_num * chunk_size,
209 (uint8_t *)orig_node->bat_iv.bcast_own + if_offset,
210 (max_if_num - del_if_num) * chunk_size);
213 kfree(orig_node->bat_iv.bcast_own);
214 orig_node->bat_iv.bcast_own = data_ptr;
219 data_ptr = kmalloc_array(max_if_num, sizeof(u8), GFP_ATOMIC);
221 kfree(orig_node->bat_iv.bcast_own);
225 memcpy(data_ptr, orig_node->bat_iv.bcast_own_sum,
226 del_if_num * sizeof(u8));
228 if_offset = (del_if_num + 1) * sizeof(u8);
229 memcpy((char *)data_ptr + del_if_num * sizeof(u8),
230 orig_node->bat_iv.bcast_own_sum + if_offset,
231 (max_if_num - del_if_num) * sizeof(u8));
234 kfree(orig_node->bat_iv.bcast_own_sum);
235 orig_node->bat_iv.bcast_own_sum = data_ptr;
239 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
245 * batadv_iv_ogm_orig_get - retrieve or create (if does not exist) an originator
246 * @bat_priv: the bat priv with all the soft interface information
247 * @addr: mac address of the originator
249 * Returns the originator object corresponding to the passed mac address or NULL
251 * If the object does not exists it is created an initialised.
253 static struct batadv_orig_node *
254 batadv_iv_ogm_orig_get(struct batadv_priv *bat_priv, const u8 *addr)
256 struct batadv_orig_node *orig_node;
257 int size, hash_added;
259 orig_node = batadv_orig_hash_find(bat_priv, addr);
263 orig_node = batadv_orig_node_new(bat_priv, addr);
267 spin_lock_init(&orig_node->bat_iv.ogm_cnt_lock);
269 size = bat_priv->num_ifaces * sizeof(unsigned long) * BATADV_NUM_WORDS;
270 orig_node->bat_iv.bcast_own = kzalloc(size, GFP_ATOMIC);
271 if (!orig_node->bat_iv.bcast_own)
274 size = bat_priv->num_ifaces * sizeof(u8);
275 orig_node->bat_iv.bcast_own_sum = kzalloc(size, GFP_ATOMIC);
276 if (!orig_node->bat_iv.bcast_own_sum)
279 hash_added = batadv_hash_add(bat_priv->orig_hash, batadv_compare_orig,
280 batadv_choose_orig, orig_node,
281 &orig_node->hash_entry);
288 /* free twice, as batadv_orig_node_new sets refcount to 2 */
289 batadv_orig_node_free_ref(orig_node);
290 batadv_orig_node_free_ref(orig_node);
295 static struct batadv_neigh_node *
296 batadv_iv_ogm_neigh_new(struct batadv_hard_iface *hard_iface,
297 const u8 *neigh_addr,
298 struct batadv_orig_node *orig_node,
299 struct batadv_orig_node *orig_neigh)
301 struct batadv_neigh_node *neigh_node;
303 neigh_node = batadv_neigh_node_new(orig_node, hard_iface, neigh_addr);
307 neigh_node->orig_node = orig_neigh;
313 static int batadv_iv_ogm_iface_enable(struct batadv_hard_iface *hard_iface)
315 struct batadv_ogm_packet *batadv_ogm_packet;
316 unsigned char *ogm_buff;
319 /* randomize initial seqno to avoid collision */
320 get_random_bytes(&random_seqno, sizeof(random_seqno));
321 atomic_set(&hard_iface->bat_iv.ogm_seqno, random_seqno);
323 hard_iface->bat_iv.ogm_buff_len = BATADV_OGM_HLEN;
324 ogm_buff = kmalloc(hard_iface->bat_iv.ogm_buff_len, GFP_ATOMIC);
328 hard_iface->bat_iv.ogm_buff = ogm_buff;
330 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
331 batadv_ogm_packet->packet_type = BATADV_IV_OGM;
332 batadv_ogm_packet->version = BATADV_COMPAT_VERSION;
333 batadv_ogm_packet->ttl = 2;
334 batadv_ogm_packet->flags = BATADV_NO_FLAGS;
335 batadv_ogm_packet->reserved = 0;
336 batadv_ogm_packet->tq = BATADV_TQ_MAX_VALUE;
341 static void batadv_iv_ogm_iface_disable(struct batadv_hard_iface *hard_iface)
343 kfree(hard_iface->bat_iv.ogm_buff);
344 hard_iface->bat_iv.ogm_buff = NULL;
347 static void batadv_iv_ogm_iface_update_mac(struct batadv_hard_iface *hard_iface)
349 struct batadv_ogm_packet *batadv_ogm_packet;
350 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
352 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
353 ether_addr_copy(batadv_ogm_packet->orig,
354 hard_iface->net_dev->dev_addr);
355 ether_addr_copy(batadv_ogm_packet->prev_sender,
356 hard_iface->net_dev->dev_addr);
360 batadv_iv_ogm_primary_iface_set(struct batadv_hard_iface *hard_iface)
362 struct batadv_ogm_packet *batadv_ogm_packet;
363 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
365 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
366 batadv_ogm_packet->ttl = BATADV_TTL;
369 /* when do we schedule our own ogm to be sent */
371 batadv_iv_ogm_emit_send_time(const struct batadv_priv *bat_priv)
375 msecs = atomic_read(&bat_priv->orig_interval) - BATADV_JITTER;
376 msecs += prandom_u32() % (2 * BATADV_JITTER);
378 return jiffies + msecs_to_jiffies(msecs);
381 /* when do we schedule a ogm packet to be sent */
382 static unsigned long batadv_iv_ogm_fwd_send_time(void)
384 return jiffies + msecs_to_jiffies(prandom_u32() % (BATADV_JITTER / 2));
387 /* apply hop penalty for a normal link */
388 static u8 batadv_hop_penalty(u8 tq, const struct batadv_priv *bat_priv)
390 int hop_penalty = atomic_read(&bat_priv->hop_penalty);
393 new_tq = tq * (BATADV_TQ_MAX_VALUE - hop_penalty);
394 new_tq /= BATADV_TQ_MAX_VALUE;
399 /* is there another aggregated packet here? */
400 static bool batadv_iv_ogm_aggr_packet(int buff_pos, int packet_len,
403 int next_buff_pos = 0;
405 next_buff_pos += buff_pos + BATADV_OGM_HLEN;
406 next_buff_pos += ntohs(tvlv_len);
408 return (next_buff_pos <= packet_len) &&
409 (next_buff_pos <= BATADV_MAX_AGGREGATION_BYTES);
412 /* send a batman ogm to a given interface */
413 static void batadv_iv_ogm_send_to_if(struct batadv_forw_packet *forw_packet,
414 struct batadv_hard_iface *hard_iface)
416 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
420 struct batadv_ogm_packet *batadv_ogm_packet;
424 if (hard_iface->if_status != BATADV_IF_ACTIVE)
429 packet_pos = forw_packet->skb->data;
430 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
432 /* adjust all flags and log packets */
433 while (batadv_iv_ogm_aggr_packet(buff_pos, forw_packet->packet_len,
434 batadv_ogm_packet->tvlv_len)) {
435 /* we might have aggregated direct link packets with an
436 * ordinary base packet
438 if (forw_packet->direct_link_flags & BIT(packet_num) &&
439 forw_packet->if_incoming == hard_iface)
440 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
442 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
444 if (packet_num > 0 || !forw_packet->own)
445 fwd_str = "Forwarding";
447 fwd_str = "Sending own";
449 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
450 "%s %spacket (originator %pM, seqno %u, TQ %d, TTL %d, IDF %s) on interface %s [%pM]\n",
451 fwd_str, (packet_num > 0 ? "aggregated " : ""),
452 batadv_ogm_packet->orig,
453 ntohl(batadv_ogm_packet->seqno),
454 batadv_ogm_packet->tq, batadv_ogm_packet->ttl,
455 ((batadv_ogm_packet->flags & BATADV_DIRECTLINK) ?
457 hard_iface->net_dev->name,
458 hard_iface->net_dev->dev_addr);
460 buff_pos += BATADV_OGM_HLEN;
461 buff_pos += ntohs(batadv_ogm_packet->tvlv_len);
463 packet_pos = forw_packet->skb->data + buff_pos;
464 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
467 /* create clone because function is called more than once */
468 skb = skb_clone(forw_packet->skb, GFP_ATOMIC);
470 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_TX);
471 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_TX_BYTES,
472 skb->len + ETH_HLEN);
473 batadv_send_skb_packet(skb, hard_iface, batadv_broadcast_addr);
477 /* send a batman ogm packet */
478 static void batadv_iv_ogm_emit(struct batadv_forw_packet *forw_packet)
480 struct net_device *soft_iface;
481 struct batadv_priv *bat_priv;
482 struct batadv_hard_iface *primary_if = NULL;
484 if (!forw_packet->if_incoming) {
485 pr_err("Error - can't forward packet: incoming iface not specified\n");
489 soft_iface = forw_packet->if_incoming->soft_iface;
490 bat_priv = netdev_priv(soft_iface);
492 if (WARN_ON(!forw_packet->if_outgoing))
495 if (WARN_ON(forw_packet->if_outgoing->soft_iface != soft_iface))
498 if (forw_packet->if_incoming->if_status != BATADV_IF_ACTIVE)
501 primary_if = batadv_primary_if_get_selected(bat_priv);
505 /* only for one specific outgoing interface */
506 batadv_iv_ogm_send_to_if(forw_packet, forw_packet->if_outgoing);
510 batadv_hardif_free_ref(primary_if);
514 * batadv_iv_ogm_can_aggregate - find out if an OGM can be aggregated on an
515 * existing forward packet
516 * @new_bat_ogm_packet: OGM packet to be aggregated
517 * @bat_priv: the bat priv with all the soft interface information
518 * @packet_len: (total) length of the OGM
519 * @send_time: timestamp (jiffies) when the packet is to be sent
520 * @directlink: true if this is a direct link packet
521 * @if_incoming: interface where the packet was received
522 * @if_outgoing: interface for which the retransmission should be considered
523 * @forw_packet: the forwarded packet which should be checked
525 * Returns true if new_packet can be aggregated with forw_packet
528 batadv_iv_ogm_can_aggregate(const struct batadv_ogm_packet *new_bat_ogm_packet,
529 struct batadv_priv *bat_priv,
530 int packet_len, unsigned long send_time,
532 const struct batadv_hard_iface *if_incoming,
533 const struct batadv_hard_iface *if_outgoing,
534 const struct batadv_forw_packet *forw_packet)
536 struct batadv_ogm_packet *batadv_ogm_packet;
537 int aggregated_bytes = forw_packet->packet_len + packet_len;
538 struct batadv_hard_iface *primary_if = NULL;
540 unsigned long aggregation_end_time;
542 batadv_ogm_packet = (struct batadv_ogm_packet *)forw_packet->skb->data;
543 aggregation_end_time = send_time;
544 aggregation_end_time += msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
546 /* we can aggregate the current packet to this aggregated packet
549 * - the send time is within our MAX_AGGREGATION_MS time
550 * - the resulting packet wont be bigger than
551 * MAX_AGGREGATION_BYTES
552 * otherwise aggregation is not possible
554 if (!time_before(send_time, forw_packet->send_time) ||
555 !time_after_eq(aggregation_end_time, forw_packet->send_time))
558 if (aggregated_bytes > BATADV_MAX_AGGREGATION_BYTES)
561 /* packet is not leaving on the same interface. */
562 if (forw_packet->if_outgoing != if_outgoing)
565 /* check aggregation compatibility
566 * -> direct link packets are broadcasted on
567 * their interface only
568 * -> aggregate packet if the current packet is
569 * a "global" packet as well as the base
572 primary_if = batadv_primary_if_get_selected(bat_priv);
576 /* packets without direct link flag and high TTL
577 * are flooded through the net
580 !(batadv_ogm_packet->flags & BATADV_DIRECTLINK) &&
581 batadv_ogm_packet->ttl != 1 &&
583 /* own packets originating non-primary
584 * interfaces leave only that interface
586 (!forw_packet->own ||
587 forw_packet->if_incoming == primary_if)) {
592 /* if the incoming packet is sent via this one
593 * interface only - we still can aggregate
596 new_bat_ogm_packet->ttl == 1 &&
597 forw_packet->if_incoming == if_incoming &&
599 /* packets from direct neighbors or
600 * own secondary interface packets
601 * (= secondary interface packets in general)
603 (batadv_ogm_packet->flags & BATADV_DIRECTLINK ||
605 forw_packet->if_incoming != primary_if))) {
612 batadv_hardif_free_ref(primary_if);
617 * batadv_iv_ogm_aggregate_new - create a new aggregated packet and add this
619 * @packet_buff: pointer to the OGM
620 * @packet_len: (total) length of the OGM
621 * @send_time: timestamp (jiffies) when the packet is to be sent
622 * @direct_link: whether this OGM has direct link status
623 * @if_incoming: interface where the packet was received
624 * @if_outgoing: interface for which the retransmission should be considered
625 * @own_packet: true if it is a self-generated ogm
627 static void batadv_iv_ogm_aggregate_new(const unsigned char *packet_buff,
628 int packet_len, unsigned long send_time,
630 struct batadv_hard_iface *if_incoming,
631 struct batadv_hard_iface *if_outgoing,
634 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
635 struct batadv_forw_packet *forw_packet_aggr;
636 unsigned char *skb_buff;
637 unsigned int skb_size;
639 if (!atomic_inc_not_zero(&if_incoming->refcount))
642 if (!atomic_inc_not_zero(&if_outgoing->refcount))
643 goto out_free_incoming;
645 /* own packet should always be scheduled */
647 if (!batadv_atomic_dec_not_zero(&bat_priv->batman_queue_left)) {
648 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
649 "batman packet queue full\n");
650 goto out_free_outgoing;
654 forw_packet_aggr = kmalloc(sizeof(*forw_packet_aggr), GFP_ATOMIC);
655 if (!forw_packet_aggr)
658 if (atomic_read(&bat_priv->aggregated_ogms) &&
659 packet_len < BATADV_MAX_AGGREGATION_BYTES)
660 skb_size = BATADV_MAX_AGGREGATION_BYTES;
662 skb_size = packet_len;
664 skb_size += ETH_HLEN;
666 forw_packet_aggr->skb = netdev_alloc_skb_ip_align(NULL, skb_size);
667 if (!forw_packet_aggr->skb)
668 goto out_free_forw_packet;
669 forw_packet_aggr->skb->priority = TC_PRIO_CONTROL;
670 skb_reserve(forw_packet_aggr->skb, ETH_HLEN);
672 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
673 forw_packet_aggr->packet_len = packet_len;
674 memcpy(skb_buff, packet_buff, packet_len);
676 forw_packet_aggr->own = own_packet;
677 forw_packet_aggr->if_incoming = if_incoming;
678 forw_packet_aggr->if_outgoing = if_outgoing;
679 forw_packet_aggr->num_packets = 0;
680 forw_packet_aggr->direct_link_flags = BATADV_NO_FLAGS;
681 forw_packet_aggr->send_time = send_time;
683 /* save packet direct link flag status */
685 forw_packet_aggr->direct_link_flags |= 1;
687 /* add new packet to packet list */
688 spin_lock_bh(&bat_priv->forw_bat_list_lock);
689 hlist_add_head(&forw_packet_aggr->list, &bat_priv->forw_bat_list);
690 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
692 /* start timer for this packet */
693 INIT_DELAYED_WORK(&forw_packet_aggr->delayed_work,
694 batadv_send_outstanding_bat_ogm_packet);
695 queue_delayed_work(batadv_event_workqueue,
696 &forw_packet_aggr->delayed_work,
697 send_time - jiffies);
700 out_free_forw_packet:
701 kfree(forw_packet_aggr);
704 atomic_inc(&bat_priv->batman_queue_left);
706 batadv_hardif_free_ref(if_outgoing);
708 batadv_hardif_free_ref(if_incoming);
711 /* aggregate a new packet into the existing ogm packet */
712 static void batadv_iv_ogm_aggregate(struct batadv_forw_packet *forw_packet_aggr,
713 const unsigned char *packet_buff,
714 int packet_len, bool direct_link)
716 unsigned char *skb_buff;
717 unsigned long new_direct_link_flag;
719 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
720 memcpy(skb_buff, packet_buff, packet_len);
721 forw_packet_aggr->packet_len += packet_len;
722 forw_packet_aggr->num_packets++;
724 /* save packet direct link flag status */
726 new_direct_link_flag = BIT(forw_packet_aggr->num_packets);
727 forw_packet_aggr->direct_link_flags |= new_direct_link_flag;
732 * batadv_iv_ogm_queue_add - queue up an OGM for transmission
733 * @bat_priv: the bat priv with all the soft interface information
734 * @packet_buff: pointer to the OGM
735 * @packet_len: (total) length of the OGM
736 * @if_incoming: interface where the packet was received
737 * @if_outgoing: interface for which the retransmission should be considered
738 * @own_packet: true if it is a self-generated ogm
739 * @send_time: timestamp (jiffies) when the packet is to be sent
741 static void batadv_iv_ogm_queue_add(struct batadv_priv *bat_priv,
742 unsigned char *packet_buff,
744 struct batadv_hard_iface *if_incoming,
745 struct batadv_hard_iface *if_outgoing,
746 int own_packet, unsigned long send_time)
748 /* _aggr -> pointer to the packet we want to aggregate with
749 * _pos -> pointer to the position in the queue
751 struct batadv_forw_packet *forw_packet_aggr = NULL;
752 struct batadv_forw_packet *forw_packet_pos = NULL;
753 struct batadv_ogm_packet *batadv_ogm_packet;
755 unsigned long max_aggregation_jiffies;
757 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_buff;
758 direct_link = !!(batadv_ogm_packet->flags & BATADV_DIRECTLINK);
759 max_aggregation_jiffies = msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
761 /* find position for the packet in the forward queue */
762 spin_lock_bh(&bat_priv->forw_bat_list_lock);
763 /* own packets are not to be aggregated */
764 if (atomic_read(&bat_priv->aggregated_ogms) && !own_packet) {
765 hlist_for_each_entry(forw_packet_pos,
766 &bat_priv->forw_bat_list, list) {
767 if (batadv_iv_ogm_can_aggregate(batadv_ogm_packet,
768 bat_priv, packet_len,
769 send_time, direct_link,
773 forw_packet_aggr = forw_packet_pos;
779 /* nothing to aggregate with - either aggregation disabled or no
780 * suitable aggregation packet found
782 if (!forw_packet_aggr) {
783 /* the following section can run without the lock */
784 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
786 /* if we could not aggregate this packet with one of the others
787 * we hold it back for a while, so that it might be aggregated
790 if (!own_packet && atomic_read(&bat_priv->aggregated_ogms))
791 send_time += max_aggregation_jiffies;
793 batadv_iv_ogm_aggregate_new(packet_buff, packet_len,
794 send_time, direct_link,
795 if_incoming, if_outgoing,
798 batadv_iv_ogm_aggregate(forw_packet_aggr, packet_buff,
799 packet_len, direct_link);
800 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
804 static void batadv_iv_ogm_forward(struct batadv_orig_node *orig_node,
805 const struct ethhdr *ethhdr,
806 struct batadv_ogm_packet *batadv_ogm_packet,
807 bool is_single_hop_neigh,
808 bool is_from_best_next_hop,
809 struct batadv_hard_iface *if_incoming,
810 struct batadv_hard_iface *if_outgoing)
812 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
815 if (batadv_ogm_packet->ttl <= 1) {
816 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "ttl exceeded\n");
820 if (!is_from_best_next_hop) {
821 /* Mark the forwarded packet when it is not coming from our
822 * best next hop. We still need to forward the packet for our
823 * neighbor link quality detection to work in case the packet
824 * originated from a single hop neighbor. Otherwise we can
825 * simply drop the ogm.
827 if (is_single_hop_neigh)
828 batadv_ogm_packet->flags |= BATADV_NOT_BEST_NEXT_HOP;
833 tvlv_len = ntohs(batadv_ogm_packet->tvlv_len);
835 batadv_ogm_packet->ttl--;
836 ether_addr_copy(batadv_ogm_packet->prev_sender, ethhdr->h_source);
838 /* apply hop penalty */
839 batadv_ogm_packet->tq = batadv_hop_penalty(batadv_ogm_packet->tq,
842 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
843 "Forwarding packet: tq: %i, ttl: %i\n",
844 batadv_ogm_packet->tq, batadv_ogm_packet->ttl);
846 if (is_single_hop_neigh)
847 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
849 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
851 batadv_iv_ogm_queue_add(bat_priv, (unsigned char *)batadv_ogm_packet,
852 BATADV_OGM_HLEN + tvlv_len,
853 if_incoming, if_outgoing, 0,
854 batadv_iv_ogm_fwd_send_time());
858 * batadv_iv_ogm_slide_own_bcast_window - bitshift own OGM broadcast windows for
859 * the given interface
860 * @hard_iface: the interface for which the windows have to be shifted
863 batadv_iv_ogm_slide_own_bcast_window(struct batadv_hard_iface *hard_iface)
865 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
866 struct batadv_hashtable *hash = bat_priv->orig_hash;
867 struct hlist_head *head;
868 struct batadv_orig_node *orig_node;
875 for (i = 0; i < hash->size; i++) {
876 head = &hash->table[i];
879 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
880 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
881 word_index = hard_iface->if_num * BATADV_NUM_WORDS;
882 word = &orig_node->bat_iv.bcast_own[word_index];
884 batadv_bit_get_packet(bat_priv, word, 1, 0);
885 if_num = hard_iface->if_num;
886 w = &orig_node->bat_iv.bcast_own_sum[if_num];
887 *w = bitmap_weight(word, BATADV_TQ_LOCAL_WINDOW_SIZE);
888 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
894 static void batadv_iv_ogm_schedule(struct batadv_hard_iface *hard_iface)
896 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
897 unsigned char **ogm_buff = &hard_iface->bat_iv.ogm_buff;
898 struct batadv_ogm_packet *batadv_ogm_packet;
899 struct batadv_hard_iface *primary_if, *tmp_hard_iface;
900 int *ogm_buff_len = &hard_iface->bat_iv.ogm_buff_len;
903 unsigned long send_time;
905 primary_if = batadv_primary_if_get_selected(bat_priv);
907 if (hard_iface == primary_if) {
908 /* tt changes have to be committed before the tvlv data is
909 * appended as it may alter the tt tvlv container
911 batadv_tt_local_commit_changes(bat_priv);
912 tvlv_len = batadv_tvlv_container_ogm_append(bat_priv, ogm_buff,
917 batadv_ogm_packet = (struct batadv_ogm_packet *)(*ogm_buff);
918 batadv_ogm_packet->tvlv_len = htons(tvlv_len);
920 /* change sequence number to network order */
921 seqno = (u32)atomic_read(&hard_iface->bat_iv.ogm_seqno);
922 batadv_ogm_packet->seqno = htonl(seqno);
923 atomic_inc(&hard_iface->bat_iv.ogm_seqno);
925 batadv_iv_ogm_slide_own_bcast_window(hard_iface);
927 send_time = batadv_iv_ogm_emit_send_time(bat_priv);
929 if (hard_iface != primary_if) {
930 /* OGMs from secondary interfaces are only scheduled on their
931 * respective interfaces.
933 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff, *ogm_buff_len,
934 hard_iface, hard_iface, 1, send_time);
938 /* OGMs from primary interfaces are scheduled on all
942 list_for_each_entry_rcu(tmp_hard_iface, &batadv_hardif_list, list) {
943 if (tmp_hard_iface->soft_iface != hard_iface->soft_iface)
945 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff,
946 *ogm_buff_len, hard_iface,
947 tmp_hard_iface, 1, send_time);
953 batadv_hardif_free_ref(primary_if);
957 * batadv_iv_ogm_orig_update - use OGM to update corresponding data in an
959 * @bat_priv: the bat priv with all the soft interface information
960 * @orig_node: the orig node who originally emitted the ogm packet
961 * @orig_ifinfo: ifinfo for the outgoing interface of the orig_node
962 * @ethhdr: Ethernet header of the OGM
963 * @batadv_ogm_packet: the ogm packet
964 * @if_incoming: interface where the packet was received
965 * @if_outgoing: interface for which the retransmission should be considered
966 * @dup_status: the duplicate status of this ogm packet.
969 batadv_iv_ogm_orig_update(struct batadv_priv *bat_priv,
970 struct batadv_orig_node *orig_node,
971 struct batadv_orig_ifinfo *orig_ifinfo,
972 const struct ethhdr *ethhdr,
973 const struct batadv_ogm_packet *batadv_ogm_packet,
974 struct batadv_hard_iface *if_incoming,
975 struct batadv_hard_iface *if_outgoing,
976 enum batadv_dup_status dup_status)
978 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL;
979 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
980 struct batadv_neigh_node *neigh_node = NULL;
981 struct batadv_neigh_node *tmp_neigh_node = NULL;
982 struct batadv_neigh_node *router = NULL;
983 struct batadv_orig_node *orig_node_tmp;
985 u8 sum_orig, sum_neigh;
989 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
990 "update_originator(): Searching and updating originator entry of received packet\n");
993 hlist_for_each_entry_rcu(tmp_neigh_node,
994 &orig_node->neigh_list, list) {
995 neigh_addr = tmp_neigh_node->addr;
996 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
997 tmp_neigh_node->if_incoming == if_incoming &&
998 atomic_inc_not_zero(&tmp_neigh_node->refcount)) {
999 if (WARN(neigh_node, "too many matching neigh_nodes"))
1000 batadv_neigh_node_free_ref(neigh_node);
1001 neigh_node = tmp_neigh_node;
1005 if (dup_status != BATADV_NO_DUP)
1008 /* only update the entry for this outgoing interface */
1009 neigh_ifinfo = batadv_neigh_ifinfo_get(tmp_neigh_node,
1014 spin_lock_bh(&tmp_neigh_node->ifinfo_lock);
1015 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1016 &neigh_ifinfo->bat_iv.tq_index, 0);
1017 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1018 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1019 spin_unlock_bh(&tmp_neigh_node->ifinfo_lock);
1021 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1022 neigh_ifinfo = NULL;
1026 struct batadv_orig_node *orig_tmp;
1028 orig_tmp = batadv_iv_ogm_orig_get(bat_priv, ethhdr->h_source);
1032 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1034 orig_node, orig_tmp);
1036 batadv_orig_node_free_ref(orig_tmp);
1040 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1041 "Updating existing last-hop neighbor of originator\n");
1045 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1049 neigh_node->last_seen = jiffies;
1051 spin_lock_bh(&neigh_node->ifinfo_lock);
1052 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1053 &neigh_ifinfo->bat_iv.tq_index,
1054 batadv_ogm_packet->tq);
1055 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1056 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1057 spin_unlock_bh(&neigh_node->ifinfo_lock);
1059 if (dup_status == BATADV_NO_DUP) {
1060 orig_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1061 neigh_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1064 /* if this neighbor already is our next hop there is nothing
1067 router = batadv_orig_router_get(orig_node, if_outgoing);
1068 if (router == neigh_node)
1072 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1076 /* if this neighbor does not offer a better TQ we won't
1079 if (router_ifinfo->bat_iv.tq_avg > neigh_ifinfo->bat_iv.tq_avg)
1083 /* if the TQ is the same and the link not more symmetric we
1084 * won't consider it either
1086 if (router_ifinfo &&
1087 neigh_ifinfo->bat_iv.tq_avg == router_ifinfo->bat_iv.tq_avg) {
1088 orig_node_tmp = router->orig_node;
1089 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1090 if_num = router->if_incoming->if_num;
1091 sum_orig = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1092 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1094 orig_node_tmp = neigh_node->orig_node;
1095 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1096 if_num = neigh_node->if_incoming->if_num;
1097 sum_neigh = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1098 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1100 if (sum_orig >= sum_neigh)
1104 batadv_update_route(bat_priv, orig_node, if_outgoing, neigh_node);
1111 batadv_neigh_node_free_ref(neigh_node);
1113 batadv_neigh_node_free_ref(router);
1115 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1117 batadv_neigh_ifinfo_free_ref(router_ifinfo);
1121 * batadv_iv_ogm_calc_tq - calculate tq for current received ogm packet
1122 * @orig_node: the orig node who originally emitted the ogm packet
1123 * @orig_neigh_node: the orig node struct of the neighbor who sent the packet
1124 * @batadv_ogm_packet: the ogm packet
1125 * @if_incoming: interface where the packet was received
1126 * @if_outgoing: interface for which the retransmission should be considered
1128 * Returns 1 if the link can be considered bidirectional, 0 otherwise
1130 static int batadv_iv_ogm_calc_tq(struct batadv_orig_node *orig_node,
1131 struct batadv_orig_node *orig_neigh_node,
1132 struct batadv_ogm_packet *batadv_ogm_packet,
1133 struct batadv_hard_iface *if_incoming,
1134 struct batadv_hard_iface *if_outgoing)
1136 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1137 struct batadv_neigh_node *neigh_node = NULL, *tmp_neigh_node;
1138 struct batadv_neigh_ifinfo *neigh_ifinfo;
1140 u8 orig_eq_count, neigh_rq_count, neigh_rq_inv, tq_own;
1141 unsigned int neigh_rq_inv_cube, neigh_rq_max_cube;
1142 int tq_asym_penalty, inv_asym_penalty, if_num, ret = 0;
1143 unsigned int combined_tq;
1144 int tq_iface_penalty;
1146 /* find corresponding one hop neighbor */
1148 hlist_for_each_entry_rcu(tmp_neigh_node,
1149 &orig_neigh_node->neigh_list, list) {
1150 if (!batadv_compare_eth(tmp_neigh_node->addr,
1151 orig_neigh_node->orig))
1154 if (tmp_neigh_node->if_incoming != if_incoming)
1157 if (!atomic_inc_not_zero(&tmp_neigh_node->refcount))
1160 neigh_node = tmp_neigh_node;
1166 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1167 orig_neigh_node->orig,
1174 /* if orig_node is direct neighbor update neigh_node last_seen */
1175 if (orig_node == orig_neigh_node)
1176 neigh_node->last_seen = jiffies;
1178 orig_node->last_seen = jiffies;
1180 /* find packet count of corresponding one hop neighbor */
1181 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1182 if_num = if_incoming->if_num;
1183 orig_eq_count = orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1184 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1186 neigh_rq_count = neigh_ifinfo->bat_iv.real_packet_count;
1187 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1191 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1193 /* pay attention to not get a value bigger than 100 % */
1194 if (orig_eq_count > neigh_rq_count)
1195 total_count = neigh_rq_count;
1197 total_count = orig_eq_count;
1199 /* if we have too few packets (too less data) we set tq_own to zero
1200 * if we receive too few packets it is not considered bidirectional
1202 if (total_count < BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM ||
1203 neigh_rq_count < BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM)
1206 /* neigh_node->real_packet_count is never zero as we
1207 * only purge old information when getting new
1210 tq_own = (BATADV_TQ_MAX_VALUE * total_count) / neigh_rq_count;
1212 /* 1 - ((1-x) ** 3), normalized to TQ_MAX_VALUE this does
1213 * affect the nearly-symmetric links only a little, but
1214 * punishes asymmetric links more. This will give a value
1215 * between 0 and TQ_MAX_VALUE
1217 neigh_rq_inv = BATADV_TQ_LOCAL_WINDOW_SIZE - neigh_rq_count;
1218 neigh_rq_inv_cube = neigh_rq_inv * neigh_rq_inv * neigh_rq_inv;
1219 neigh_rq_max_cube = BATADV_TQ_LOCAL_WINDOW_SIZE *
1220 BATADV_TQ_LOCAL_WINDOW_SIZE *
1221 BATADV_TQ_LOCAL_WINDOW_SIZE;
1222 inv_asym_penalty = BATADV_TQ_MAX_VALUE * neigh_rq_inv_cube;
1223 inv_asym_penalty /= neigh_rq_max_cube;
1224 tq_asym_penalty = BATADV_TQ_MAX_VALUE - inv_asym_penalty;
1226 /* penalize if the OGM is forwarded on the same interface. WiFi
1227 * interfaces and other half duplex devices suffer from throughput
1228 * drops as they can't send and receive at the same time.
1230 tq_iface_penalty = BATADV_TQ_MAX_VALUE;
1231 if (if_outgoing && (if_incoming == if_outgoing) &&
1232 batadv_is_wifi_netdev(if_outgoing->net_dev))
1233 tq_iface_penalty = batadv_hop_penalty(BATADV_TQ_MAX_VALUE,
1236 combined_tq = batadv_ogm_packet->tq *
1240 combined_tq /= BATADV_TQ_MAX_VALUE *
1241 BATADV_TQ_MAX_VALUE *
1242 BATADV_TQ_MAX_VALUE;
1243 batadv_ogm_packet->tq = combined_tq;
1245 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1246 "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",
1247 orig_node->orig, orig_neigh_node->orig, total_count,
1248 neigh_rq_count, tq_own, tq_asym_penalty, tq_iface_penalty,
1249 batadv_ogm_packet->tq, if_incoming->net_dev->name,
1250 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT");
1252 /* if link has the minimum required transmission quality
1253 * consider it bidirectional
1255 if (batadv_ogm_packet->tq >= BATADV_TQ_TOTAL_BIDRECT_LIMIT)
1260 batadv_neigh_node_free_ref(neigh_node);
1265 * batadv_iv_ogm_update_seqnos - process a batman packet for all interfaces,
1266 * adjust the sequence number and find out whether it is a duplicate
1267 * @ethhdr: ethernet header of the packet
1268 * @batadv_ogm_packet: OGM packet to be considered
1269 * @if_incoming: interface on which the OGM packet was received
1270 * @if_outgoing: interface for which the retransmission should be considered
1272 * Returns duplicate status as enum batadv_dup_status
1274 static enum batadv_dup_status
1275 batadv_iv_ogm_update_seqnos(const struct ethhdr *ethhdr,
1276 const struct batadv_ogm_packet *batadv_ogm_packet,
1277 const struct batadv_hard_iface *if_incoming,
1278 struct batadv_hard_iface *if_outgoing)
1280 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1281 struct batadv_orig_node *orig_node;
1282 struct batadv_orig_ifinfo *orig_ifinfo = NULL;
1283 struct batadv_neigh_node *neigh_node;
1284 struct batadv_neigh_ifinfo *neigh_ifinfo;
1287 int need_update = 0;
1289 enum batadv_dup_status ret = BATADV_NO_DUP;
1290 u32 seqno = ntohl(batadv_ogm_packet->seqno);
1293 unsigned long *bitmap;
1295 orig_node = batadv_iv_ogm_orig_get(bat_priv, batadv_ogm_packet->orig);
1297 return BATADV_NO_DUP;
1299 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1300 if (WARN_ON(!orig_ifinfo)) {
1301 batadv_orig_node_free_ref(orig_node);
1305 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1306 seq_diff = seqno - orig_ifinfo->last_real_seqno;
1308 /* signalize caller that the packet is to be dropped. */
1309 if (!hlist_empty(&orig_node->neigh_list) &&
1310 batadv_window_protected(bat_priv, seq_diff,
1311 &orig_ifinfo->batman_seqno_reset)) {
1312 ret = BATADV_PROTECTED;
1317 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1318 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node,
1323 neigh_addr = neigh_node->addr;
1324 is_dup = batadv_test_bit(neigh_ifinfo->bat_iv.real_bits,
1325 orig_ifinfo->last_real_seqno,
1328 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1329 neigh_node->if_incoming == if_incoming) {
1332 ret = BATADV_NEIGH_DUP;
1335 if (is_dup && (ret != BATADV_NEIGH_DUP))
1336 ret = BATADV_ORIG_DUP;
1339 /* if the window moved, set the update flag. */
1340 bitmap = neigh_ifinfo->bat_iv.real_bits;
1341 need_update |= batadv_bit_get_packet(bat_priv, bitmap,
1342 seq_diff, set_mark);
1344 packet_count = bitmap_weight(bitmap,
1345 BATADV_TQ_LOCAL_WINDOW_SIZE);
1346 neigh_ifinfo->bat_iv.real_packet_count = packet_count;
1347 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1352 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1353 "%s updating last_seqno: old %u, new %u\n",
1354 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT",
1355 orig_ifinfo->last_real_seqno, seqno);
1356 orig_ifinfo->last_real_seqno = seqno;
1360 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1361 batadv_orig_node_free_ref(orig_node);
1362 batadv_orig_ifinfo_free_ref(orig_ifinfo);
1367 * batadv_iv_ogm_process_per_outif - process a batman iv OGM for an outgoing if
1368 * @skb: the skb containing the OGM
1369 * @ogm_offset: offset from skb->data to start of ogm header
1370 * @orig_node: the (cached) orig node for the originator of this OGM
1371 * @if_incoming: the interface where this packet was received
1372 * @if_outgoing: the interface for which the packet should be considered
1375 batadv_iv_ogm_process_per_outif(const struct sk_buff *skb, int ogm_offset,
1376 struct batadv_orig_node *orig_node,
1377 struct batadv_hard_iface *if_incoming,
1378 struct batadv_hard_iface *if_outgoing)
1380 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1381 struct batadv_hardif_neigh_node *hardif_neigh = NULL;
1382 struct batadv_neigh_node *router = NULL;
1383 struct batadv_neigh_node *router_router = NULL;
1384 struct batadv_orig_node *orig_neigh_node;
1385 struct batadv_orig_ifinfo *orig_ifinfo;
1386 struct batadv_neigh_node *orig_neigh_router = NULL;
1387 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
1388 struct batadv_ogm_packet *ogm_packet;
1389 enum batadv_dup_status dup_status;
1390 bool is_from_best_next_hop = false;
1391 bool is_single_hop_neigh = false;
1392 bool sameseq, similar_ttl;
1393 struct sk_buff *skb_priv;
1394 struct ethhdr *ethhdr;
1398 /* create a private copy of the skb, as some functions change tq value
1401 skb_priv = skb_copy(skb, GFP_ATOMIC);
1405 ethhdr = eth_hdr(skb_priv);
1406 ogm_packet = (struct batadv_ogm_packet *)(skb_priv->data + ogm_offset);
1408 dup_status = batadv_iv_ogm_update_seqnos(ethhdr, ogm_packet,
1409 if_incoming, if_outgoing);
1410 if (batadv_compare_eth(ethhdr->h_source, ogm_packet->orig))
1411 is_single_hop_neigh = true;
1413 if (dup_status == BATADV_PROTECTED) {
1414 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1415 "Drop packet: packet within seqno protection time (sender: %pM)\n",
1420 if (ogm_packet->tq == 0) {
1421 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1422 "Drop packet: originator packet with tq equal 0\n");
1426 if (is_single_hop_neigh) {
1427 hardif_neigh = batadv_hardif_neigh_get(if_incoming,
1430 hardif_neigh->last_seen = jiffies;
1433 router = batadv_orig_router_get(orig_node, if_outgoing);
1435 router_router = batadv_orig_router_get(router->orig_node,
1437 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1440 if ((router_ifinfo && router_ifinfo->bat_iv.tq_avg != 0) &&
1441 (batadv_compare_eth(router->addr, ethhdr->h_source)))
1442 is_from_best_next_hop = true;
1444 prev_sender = ogm_packet->prev_sender;
1445 /* avoid temporary routing loops */
1446 if (router && router_router &&
1447 (batadv_compare_eth(router->addr, prev_sender)) &&
1448 !(batadv_compare_eth(ogm_packet->orig, prev_sender)) &&
1449 (batadv_compare_eth(router->addr, router_router->addr))) {
1450 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1451 "Drop packet: ignoring all rebroadcast packets that may make me loop (sender: %pM)\n",
1456 if (if_outgoing == BATADV_IF_DEFAULT)
1457 batadv_tvlv_ogm_receive(bat_priv, ogm_packet, orig_node);
1459 /* if sender is a direct neighbor the sender mac equals
1462 if (is_single_hop_neigh)
1463 orig_neigh_node = orig_node;
1465 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1468 if (!orig_neigh_node)
1471 /* Update nc_nodes of the originator */
1472 batadv_nc_update_nc_node(bat_priv, orig_node, orig_neigh_node,
1473 ogm_packet, is_single_hop_neigh);
1475 orig_neigh_router = batadv_orig_router_get(orig_neigh_node,
1478 /* drop packet if sender is not a direct neighbor and if we
1479 * don't route towards it
1481 if (!is_single_hop_neigh && (!orig_neigh_router)) {
1482 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1483 "Drop packet: OGM via unknown neighbor!\n");
1487 is_bidirect = batadv_iv_ogm_calc_tq(orig_node, orig_neigh_node,
1488 ogm_packet, if_incoming,
1491 /* update ranking if it is not a duplicate or has the same
1492 * seqno and similar ttl as the non-duplicate
1494 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1498 sameseq = orig_ifinfo->last_real_seqno == ntohl(ogm_packet->seqno);
1499 similar_ttl = (orig_ifinfo->last_ttl - 3) <= ogm_packet->ttl;
1501 if (is_bidirect && ((dup_status == BATADV_NO_DUP) ||
1502 (sameseq && similar_ttl))) {
1503 batadv_iv_ogm_orig_update(bat_priv, orig_node,
1504 orig_ifinfo, ethhdr,
1505 ogm_packet, if_incoming,
1506 if_outgoing, dup_status);
1508 batadv_orig_ifinfo_free_ref(orig_ifinfo);
1510 /* only forward for specific interface, not for the default one. */
1511 if (if_outgoing == BATADV_IF_DEFAULT)
1514 /* is single hop (direct) neighbor */
1515 if (is_single_hop_neigh) {
1516 /* OGMs from secondary interfaces should only scheduled once
1517 * per interface where it has been received, not multiple times
1519 if ((ogm_packet->ttl <= 2) &&
1520 (if_incoming != if_outgoing)) {
1521 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1522 "Drop packet: OGM from secondary interface and wrong outgoing interface\n");
1525 /* mark direct link on incoming interface */
1526 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1527 is_single_hop_neigh,
1528 is_from_best_next_hop, if_incoming,
1531 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1532 "Forwarding packet: rebroadcast neighbor packet with direct link flag\n");
1536 /* multihop originator */
1538 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1539 "Drop packet: not received via bidirectional link\n");
1543 if (dup_status == BATADV_NEIGH_DUP) {
1544 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1545 "Drop packet: duplicate packet received\n");
1549 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1550 "Forwarding packet: rebroadcast originator packet\n");
1551 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1552 is_single_hop_neigh, is_from_best_next_hop,
1553 if_incoming, if_outgoing);
1556 if ((orig_neigh_node) && (!is_single_hop_neigh))
1557 batadv_orig_node_free_ref(orig_neigh_node);
1560 batadv_neigh_ifinfo_free_ref(router_ifinfo);
1562 batadv_neigh_node_free_ref(router);
1564 batadv_neigh_node_free_ref(router_router);
1565 if (orig_neigh_router)
1566 batadv_neigh_node_free_ref(orig_neigh_router);
1568 batadv_hardif_neigh_free_ref(hardif_neigh);
1570 kfree_skb(skb_priv);
1574 * batadv_iv_ogm_process - process an incoming batman iv OGM
1575 * @skb: the skb containing the OGM
1576 * @ogm_offset: offset to the OGM which should be processed (for aggregates)
1577 * @if_incoming: the interface where this packet was receved
1579 static void batadv_iv_ogm_process(const struct sk_buff *skb, int ogm_offset,
1580 struct batadv_hard_iface *if_incoming)
1582 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1583 struct batadv_orig_node *orig_neigh_node, *orig_node;
1584 struct batadv_hard_iface *hard_iface;
1585 struct batadv_ogm_packet *ogm_packet;
1586 u32 if_incoming_seqno;
1587 bool has_directlink_flag;
1588 struct ethhdr *ethhdr;
1589 bool is_my_oldorig = false;
1590 bool is_my_addr = false;
1591 bool is_my_orig = false;
1593 ogm_packet = (struct batadv_ogm_packet *)(skb->data + ogm_offset);
1594 ethhdr = eth_hdr(skb);
1596 /* Silently drop when the batman packet is actually not a
1599 * This might happen if a packet is padded (e.g. Ethernet has a
1600 * minimum frame length of 64 byte) and the aggregation interprets
1601 * it as an additional length.
1603 * TODO: A more sane solution would be to have a bit in the
1604 * batadv_ogm_packet to detect whether the packet is the last
1605 * packet in an aggregation. Here we expect that the padding
1606 * is always zero (or not 0x01)
1608 if (ogm_packet->packet_type != BATADV_IV_OGM)
1611 /* could be changed by schedule_own_packet() */
1612 if_incoming_seqno = atomic_read(&if_incoming->bat_iv.ogm_seqno);
1614 if (ogm_packet->flags & BATADV_DIRECTLINK)
1615 has_directlink_flag = true;
1617 has_directlink_flag = false;
1619 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1620 "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",
1621 ethhdr->h_source, if_incoming->net_dev->name,
1622 if_incoming->net_dev->dev_addr, ogm_packet->orig,
1623 ogm_packet->prev_sender, ntohl(ogm_packet->seqno),
1624 ogm_packet->tq, ogm_packet->ttl,
1625 ogm_packet->version, has_directlink_flag);
1628 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1629 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1632 if (hard_iface->soft_iface != if_incoming->soft_iface)
1635 if (batadv_compare_eth(ethhdr->h_source,
1636 hard_iface->net_dev->dev_addr))
1639 if (batadv_compare_eth(ogm_packet->orig,
1640 hard_iface->net_dev->dev_addr))
1643 if (batadv_compare_eth(ogm_packet->prev_sender,
1644 hard_iface->net_dev->dev_addr))
1645 is_my_oldorig = true;
1650 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1651 "Drop packet: received my own broadcast (sender: %pM)\n",
1657 unsigned long *word;
1663 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1665 if (!orig_neigh_node)
1668 /* neighbor has to indicate direct link and it has to
1669 * come via the corresponding interface
1670 * save packet seqno for bidirectional check
1672 if (has_directlink_flag &&
1673 batadv_compare_eth(if_incoming->net_dev->dev_addr,
1674 ogm_packet->orig)) {
1675 if_num = if_incoming->if_num;
1676 offset = if_num * BATADV_NUM_WORDS;
1678 spin_lock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1679 word = &orig_neigh_node->bat_iv.bcast_own[offset];
1680 bit_pos = if_incoming_seqno - 2;
1681 bit_pos -= ntohl(ogm_packet->seqno);
1682 batadv_set_bit(word, bit_pos);
1683 weight = &orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1684 *weight = bitmap_weight(word,
1685 BATADV_TQ_LOCAL_WINDOW_SIZE);
1686 spin_unlock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1689 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1690 "Drop packet: originator packet from myself (via neighbor)\n");
1691 batadv_orig_node_free_ref(orig_neigh_node);
1695 if (is_my_oldorig) {
1696 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1697 "Drop packet: ignoring all rebroadcast echos (sender: %pM)\n",
1702 if (ogm_packet->flags & BATADV_NOT_BEST_NEXT_HOP) {
1703 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1704 "Drop packet: ignoring all packets not forwarded from the best next hop (sender: %pM)\n",
1709 orig_node = batadv_iv_ogm_orig_get(bat_priv, ogm_packet->orig);
1713 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1714 if_incoming, BATADV_IF_DEFAULT);
1717 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1718 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1721 if (hard_iface->soft_iface != bat_priv->soft_iface)
1724 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1725 if_incoming, hard_iface);
1729 batadv_orig_node_free_ref(orig_node);
1732 static int batadv_iv_ogm_receive(struct sk_buff *skb,
1733 struct batadv_hard_iface *if_incoming)
1735 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1736 struct batadv_ogm_packet *ogm_packet;
1741 ret = batadv_check_management_packet(skb, if_incoming, BATADV_OGM_HLEN);
1745 /* did we receive a B.A.T.M.A.N. IV OGM packet on an interface
1746 * that does not have B.A.T.M.A.N. IV enabled ?
1748 if (bat_priv->bat_algo_ops->bat_ogm_emit != batadv_iv_ogm_emit)
1751 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_RX);
1752 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_RX_BYTES,
1753 skb->len + ETH_HLEN);
1756 ogm_packet = (struct batadv_ogm_packet *)skb->data;
1758 /* unpack the aggregated packets and process them one by one */
1759 while (batadv_iv_ogm_aggr_packet(ogm_offset, skb_headlen(skb),
1760 ogm_packet->tvlv_len)) {
1761 batadv_iv_ogm_process(skb, ogm_offset, if_incoming);
1763 ogm_offset += BATADV_OGM_HLEN;
1764 ogm_offset += ntohs(ogm_packet->tvlv_len);
1766 packet_pos = skb->data + ogm_offset;
1767 ogm_packet = (struct batadv_ogm_packet *)packet_pos;
1771 return NET_RX_SUCCESS;
1775 * batadv_iv_ogm_orig_print_neigh - print neighbors for the originator table
1776 * @orig_node: the orig_node for which the neighbors are printed
1777 * @if_outgoing: outgoing interface for these entries
1778 * @seq: debugfs table seq_file struct
1780 * Must be called while holding an rcu lock.
1783 batadv_iv_ogm_orig_print_neigh(struct batadv_orig_node *orig_node,
1784 struct batadv_hard_iface *if_outgoing,
1785 struct seq_file *seq)
1787 struct batadv_neigh_node *neigh_node;
1788 struct batadv_neigh_ifinfo *n_ifinfo;
1790 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1791 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
1795 seq_printf(seq, " %pM (%3i)",
1797 n_ifinfo->bat_iv.tq_avg);
1799 batadv_neigh_ifinfo_free_ref(n_ifinfo);
1804 * batadv_iv_ogm_orig_print - print the originator table
1805 * @bat_priv: the bat priv with all the soft interface information
1806 * @seq: debugfs table seq_file struct
1807 * @if_outgoing: the outgoing interface for which this should be printed
1809 static void batadv_iv_ogm_orig_print(struct batadv_priv *bat_priv,
1810 struct seq_file *seq,
1811 struct batadv_hard_iface *if_outgoing)
1813 struct batadv_neigh_node *neigh_node;
1814 struct batadv_hashtable *hash = bat_priv->orig_hash;
1815 int last_seen_msecs, last_seen_secs;
1816 struct batadv_orig_node *orig_node;
1817 struct batadv_neigh_ifinfo *n_ifinfo;
1818 unsigned long last_seen_jiffies;
1819 struct hlist_head *head;
1820 int batman_count = 0;
1823 seq_printf(seq, " %-15s %s (%s/%i) %17s [%10s]: %20s ...\n",
1824 "Originator", "last-seen", "#", BATADV_TQ_MAX_VALUE,
1825 "Nexthop", "outgoingIF", "Potential nexthops");
1827 for (i = 0; i < hash->size; i++) {
1828 head = &hash->table[i];
1831 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
1832 neigh_node = batadv_orig_router_get(orig_node,
1837 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node,
1842 if (n_ifinfo->bat_iv.tq_avg == 0)
1845 last_seen_jiffies = jiffies - orig_node->last_seen;
1846 last_seen_msecs = jiffies_to_msecs(last_seen_jiffies);
1847 last_seen_secs = last_seen_msecs / 1000;
1848 last_seen_msecs = last_seen_msecs % 1000;
1850 seq_printf(seq, "%pM %4i.%03is (%3i) %pM [%10s]:",
1851 orig_node->orig, last_seen_secs,
1852 last_seen_msecs, n_ifinfo->bat_iv.tq_avg,
1854 neigh_node->if_incoming->net_dev->name);
1856 batadv_iv_ogm_orig_print_neigh(orig_node, if_outgoing,
1858 seq_puts(seq, "\n");
1862 batadv_neigh_node_free_ref(neigh_node);
1864 batadv_neigh_ifinfo_free_ref(n_ifinfo);
1869 if (batman_count == 0)
1870 seq_puts(seq, "No batman nodes in range ...\n");
1874 * batadv_iv_hardif_neigh_print - print a single hop neighbour node
1875 * @seq: neighbour table seq_file struct
1876 * @hardif_neigh: hardif neighbour information
1879 batadv_iv_hardif_neigh_print(struct seq_file *seq,
1880 struct batadv_hardif_neigh_node *hardif_neigh)
1882 int last_secs, last_msecs;
1884 last_secs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) / 1000;
1885 last_msecs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) % 1000;
1887 seq_printf(seq, " %10s %pM %4i.%03is\n",
1888 hardif_neigh->if_incoming->net_dev->name,
1889 hardif_neigh->addr, last_secs, last_msecs);
1893 * batadv_iv_ogm_neigh_print - print the single hop neighbour list
1894 * @bat_priv: the bat priv with all the soft interface information
1895 * @seq: neighbour table seq_file struct
1897 static void batadv_iv_neigh_print(struct batadv_priv *bat_priv,
1898 struct seq_file *seq)
1900 struct net_device *net_dev = (struct net_device *)seq->private;
1901 struct batadv_hardif_neigh_node *hardif_neigh;
1902 struct batadv_hard_iface *hard_iface;
1903 int batman_count = 0;
1905 seq_printf(seq, " %10s %-13s %s\n",
1906 "IF", "Neighbor", "last-seen");
1909 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1910 if (hard_iface->soft_iface != net_dev)
1913 hlist_for_each_entry_rcu(hardif_neigh,
1914 &hard_iface->neigh_list, list) {
1915 batadv_iv_hardif_neigh_print(seq, hardif_neigh);
1921 if (batman_count == 0)
1922 seq_puts(seq, "No batman nodes in range ...\n");
1926 * batadv_iv_ogm_neigh_cmp - compare the metrics of two neighbors
1927 * @neigh1: the first neighbor object of the comparison
1928 * @if_outgoing1: outgoing interface for the first neighbor
1929 * @neigh2: the second neighbor object of the comparison
1930 * @if_outgoing2: outgoing interface for the second neighbor
1932 * Returns a value less, equal to or greater than 0 if the metric via neigh1 is
1933 * lower, the same as or higher than the metric via neigh2
1935 static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
1936 struct batadv_hard_iface *if_outgoing1,
1937 struct batadv_neigh_node *neigh2,
1938 struct batadv_hard_iface *if_outgoing2)
1940 struct batadv_neigh_ifinfo *neigh1_ifinfo, *neigh2_ifinfo;
1944 neigh1_ifinfo = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
1945 neigh2_ifinfo = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
1947 if (!neigh1_ifinfo || !neigh2_ifinfo) {
1952 tq1 = neigh1_ifinfo->bat_iv.tq_avg;
1953 tq2 = neigh2_ifinfo->bat_iv.tq_avg;
1958 batadv_neigh_ifinfo_free_ref(neigh1_ifinfo);
1960 batadv_neigh_ifinfo_free_ref(neigh2_ifinfo);
1966 * batadv_iv_ogm_neigh_is_sob - check if neigh1 is similarly good or better
1967 * than neigh2 from the metric prospective
1968 * @neigh1: the first neighbor object of the comparison
1969 * @if_outgoing1: outgoing interface for the first neighbor
1970 * @neigh2: the second neighbor object of the comparison
1971 * @if_outgoing2: outgoing interface for the second neighbor
1973 * Returns true if the metric via neigh1 is equally good or better than
1974 * the metric via neigh2, false otherwise.
1977 batadv_iv_ogm_neigh_is_sob(struct batadv_neigh_node *neigh1,
1978 struct batadv_hard_iface *if_outgoing1,
1979 struct batadv_neigh_node *neigh2,
1980 struct batadv_hard_iface *if_outgoing2)
1982 struct batadv_neigh_ifinfo *neigh1_ifinfo, *neigh2_ifinfo;
1986 neigh1_ifinfo = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
1987 neigh2_ifinfo = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
1989 /* we can't say that the metric is better */
1990 if (!neigh1_ifinfo || !neigh2_ifinfo) {
1995 tq1 = neigh1_ifinfo->bat_iv.tq_avg;
1996 tq2 = neigh2_ifinfo->bat_iv.tq_avg;
1997 ret = (tq1 - tq2) > -BATADV_TQ_SIMILARITY_THRESHOLD;
2001 batadv_neigh_ifinfo_free_ref(neigh1_ifinfo);
2003 batadv_neigh_ifinfo_free_ref(neigh2_ifinfo);
2008 static struct batadv_algo_ops batadv_batman_iv __read_mostly = {
2009 .name = "BATMAN_IV",
2010 .bat_iface_enable = batadv_iv_ogm_iface_enable,
2011 .bat_iface_disable = batadv_iv_ogm_iface_disable,
2012 .bat_iface_update_mac = batadv_iv_ogm_iface_update_mac,
2013 .bat_primary_iface_set = batadv_iv_ogm_primary_iface_set,
2014 .bat_ogm_schedule = batadv_iv_ogm_schedule,
2015 .bat_ogm_emit = batadv_iv_ogm_emit,
2016 .bat_neigh_cmp = batadv_iv_ogm_neigh_cmp,
2017 .bat_neigh_is_similar_or_better = batadv_iv_ogm_neigh_is_sob,
2018 .bat_neigh_print = batadv_iv_neigh_print,
2019 .bat_orig_print = batadv_iv_ogm_orig_print,
2020 .bat_orig_free = batadv_iv_ogm_orig_free,
2021 .bat_orig_add_if = batadv_iv_ogm_orig_add_if,
2022 .bat_orig_del_if = batadv_iv_ogm_orig_del_if,
2025 int __init batadv_iv_init(void)
2029 /* batman originator packet */
2030 ret = batadv_recv_handler_register(BATADV_IV_OGM,
2031 batadv_iv_ogm_receive);
2035 ret = batadv_algo_register(&batadv_batman_iv);
2037 goto handler_unregister;
2042 batadv_recv_handler_unregister(BATADV_IV_OGM);