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/>.
19 #include "translation-table.h"
20 #include "originator.h"
22 #include "gateway_common.h"
23 #include "gateway_client.h"
24 #include "hard-interface.h"
27 #include "network-coding.h"
30 * enum batadv_dup_status - duplicate status
31 * @BATADV_NO_DUP: the packet is a duplicate
32 * @BATADV_ORIG_DUP: OGM is a duplicate in the originator (but not for the
34 * @BATADV_NEIGH_DUP: OGM is a duplicate for the neighbor
35 * @BATADV_PROTECTED: originator is currently protected (after reboot)
37 enum batadv_dup_status {
45 * batadv_ring_buffer_set - update the ring buffer with the given value
46 * @lq_recv: pointer to the ring buffer
47 * @lq_index: index to store the value at
48 * @value: value to store in the ring buffer
50 static void batadv_ring_buffer_set(uint8_t lq_recv[], uint8_t *lq_index,
53 lq_recv[*lq_index] = value;
54 *lq_index = (*lq_index + 1) % BATADV_TQ_GLOBAL_WINDOW_SIZE;
58 * batadv_ring_buffer_set - compute the average of all non-zero values stored
59 * in the given ring buffer
60 * @lq_recv: pointer to the ring buffer
62 * Returns computed average value.
64 static uint8_t batadv_ring_buffer_avg(const uint8_t lq_recv[])
67 uint16_t count = 0, i = 0, sum = 0;
71 while (i < BATADV_TQ_GLOBAL_WINDOW_SIZE) {
84 return (uint8_t)(sum / count);
88 * batadv_iv_ogm_orig_free - free the private resources allocated for this
90 * @orig_node: the orig_node for which the resources have to be free'd
92 static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node)
94 kfree(orig_node->bat_iv.bcast_own);
95 kfree(orig_node->bat_iv.bcast_own_sum);
99 * batadv_iv_ogm_orig_add_if - change the private structures of the orig_node to
100 * include the new hard-interface
101 * @orig_node: the orig_node that has to be changed
102 * @max_if_num: the current amount of interfaces
104 * Returns 0 on success, a negative error code otherwise.
106 static int batadv_iv_ogm_orig_add_if(struct batadv_orig_node *orig_node,
113 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
115 old_size = (max_if_num - 1) * sizeof(unsigned long) * BATADV_NUM_WORDS;
116 data_ptr = kmalloc_array(max_if_num,
117 BATADV_NUM_WORDS * sizeof(unsigned long),
122 memcpy(data_ptr, orig_node->bat_iv.bcast_own, old_size);
123 kfree(orig_node->bat_iv.bcast_own);
124 orig_node->bat_iv.bcast_own = data_ptr;
126 data_ptr = kmalloc_array(max_if_num, sizeof(uint8_t), GFP_ATOMIC);
128 kfree(orig_node->bat_iv.bcast_own);
132 memcpy(data_ptr, orig_node->bat_iv.bcast_own_sum,
133 (max_if_num - 1) * sizeof(uint8_t));
134 kfree(orig_node->bat_iv.bcast_own_sum);
135 orig_node->bat_iv.bcast_own_sum = data_ptr;
140 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
146 * batadv_iv_ogm_orig_del_if - change the private structures of the orig_node to
147 * exclude the removed interface
148 * @orig_node: the orig_node that has to be changed
149 * @max_if_num: the current amount of interfaces
150 * @del_if_num: the index of the interface being removed
152 * Returns 0 on success, a negative error code otherwise.
154 static int batadv_iv_ogm_orig_del_if(struct batadv_orig_node *orig_node,
155 int max_if_num, int del_if_num)
157 int chunk_size, ret = -ENOMEM, if_offset;
158 void *data_ptr = NULL;
160 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
162 /* last interface was removed */
166 chunk_size = sizeof(unsigned long) * BATADV_NUM_WORDS;
167 data_ptr = kmalloc_array(max_if_num, chunk_size, GFP_ATOMIC);
171 /* copy first part */
172 memcpy(data_ptr, orig_node->bat_iv.bcast_own, del_if_num * chunk_size);
174 /* copy second part */
175 memcpy((char *)data_ptr + del_if_num * chunk_size,
176 orig_node->bat_iv.bcast_own + ((del_if_num + 1) * chunk_size),
177 (max_if_num - del_if_num) * chunk_size);
180 kfree(orig_node->bat_iv.bcast_own);
181 orig_node->bat_iv.bcast_own = data_ptr;
186 data_ptr = kmalloc_array(max_if_num, sizeof(uint8_t), GFP_ATOMIC);
188 kfree(orig_node->bat_iv.bcast_own);
192 memcpy(data_ptr, orig_node->bat_iv.bcast_own_sum,
193 del_if_num * sizeof(uint8_t));
195 if_offset = (del_if_num + 1) * sizeof(uint8_t);
196 memcpy((char *)data_ptr + del_if_num * sizeof(uint8_t),
197 orig_node->bat_iv.bcast_own_sum + if_offset,
198 (max_if_num - del_if_num) * sizeof(uint8_t));
201 kfree(orig_node->bat_iv.bcast_own_sum);
202 orig_node->bat_iv.bcast_own_sum = data_ptr;
206 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
212 * batadv_iv_ogm_orig_get - retrieve or create (if does not exist) an originator
213 * @bat_priv: the bat priv with all the soft interface information
214 * @addr: mac address of the originator
216 * Returns the originator object corresponding to the passed mac address or NULL
218 * If the object does not exists it is created an initialised.
220 static struct batadv_orig_node *
221 batadv_iv_ogm_orig_get(struct batadv_priv *bat_priv, const uint8_t *addr)
223 struct batadv_orig_node *orig_node;
224 int size, hash_added;
226 orig_node = batadv_orig_hash_find(bat_priv, addr);
230 orig_node = batadv_orig_node_new(bat_priv, addr);
234 spin_lock_init(&orig_node->bat_iv.ogm_cnt_lock);
236 size = bat_priv->num_ifaces * sizeof(unsigned long) * BATADV_NUM_WORDS;
237 orig_node->bat_iv.bcast_own = kzalloc(size, GFP_ATOMIC);
238 if (!orig_node->bat_iv.bcast_own)
241 size = bat_priv->num_ifaces * sizeof(uint8_t);
242 orig_node->bat_iv.bcast_own_sum = kzalloc(size, GFP_ATOMIC);
243 if (!orig_node->bat_iv.bcast_own_sum)
246 hash_added = batadv_hash_add(bat_priv->orig_hash, batadv_compare_orig,
247 batadv_choose_orig, orig_node,
248 &orig_node->hash_entry);
255 /* free twice, as batadv_orig_node_new sets refcount to 2 */
256 batadv_orig_node_free_ref(orig_node);
257 batadv_orig_node_free_ref(orig_node);
262 static struct batadv_neigh_node *
263 batadv_iv_ogm_neigh_new(struct batadv_hard_iface *hard_iface,
264 const uint8_t *neigh_addr,
265 struct batadv_orig_node *orig_node,
266 struct batadv_orig_node *orig_neigh)
268 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
269 struct batadv_neigh_node *neigh_node, *tmp_neigh_node;
271 neigh_node = batadv_neigh_node_new(hard_iface, neigh_addr, orig_node);
275 if (!atomic_inc_not_zero(&hard_iface->refcount)) {
281 neigh_node->orig_node = orig_neigh;
282 neigh_node->if_incoming = hard_iface;
284 spin_lock_bh(&orig_node->neigh_list_lock);
285 tmp_neigh_node = batadv_neigh_node_get(orig_node, hard_iface,
287 if (!tmp_neigh_node) {
288 hlist_add_head_rcu(&neigh_node->list, &orig_node->neigh_list);
291 batadv_hardif_free_ref(hard_iface);
292 neigh_node = tmp_neigh_node;
294 spin_unlock_bh(&orig_node->neigh_list_lock);
297 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
298 "Creating new neighbor %pM for orig_node %pM on interface %s\n",
299 neigh_addr, orig_node->orig,
300 hard_iface->net_dev->name);
306 static int batadv_iv_ogm_iface_enable(struct batadv_hard_iface *hard_iface)
308 struct batadv_ogm_packet *batadv_ogm_packet;
309 unsigned char *ogm_buff;
310 uint32_t random_seqno;
312 /* randomize initial seqno to avoid collision */
313 get_random_bytes(&random_seqno, sizeof(random_seqno));
314 atomic_set(&hard_iface->bat_iv.ogm_seqno, random_seqno);
316 hard_iface->bat_iv.ogm_buff_len = BATADV_OGM_HLEN;
317 ogm_buff = kmalloc(hard_iface->bat_iv.ogm_buff_len, GFP_ATOMIC);
321 hard_iface->bat_iv.ogm_buff = ogm_buff;
323 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
324 batadv_ogm_packet->packet_type = BATADV_IV_OGM;
325 batadv_ogm_packet->version = BATADV_COMPAT_VERSION;
326 batadv_ogm_packet->ttl = 2;
327 batadv_ogm_packet->flags = BATADV_NO_FLAGS;
328 batadv_ogm_packet->reserved = 0;
329 batadv_ogm_packet->tq = BATADV_TQ_MAX_VALUE;
334 static void batadv_iv_ogm_iface_disable(struct batadv_hard_iface *hard_iface)
336 kfree(hard_iface->bat_iv.ogm_buff);
337 hard_iface->bat_iv.ogm_buff = NULL;
340 static void batadv_iv_ogm_iface_update_mac(struct batadv_hard_iface *hard_iface)
342 struct batadv_ogm_packet *batadv_ogm_packet;
343 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
345 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
346 ether_addr_copy(batadv_ogm_packet->orig,
347 hard_iface->net_dev->dev_addr);
348 ether_addr_copy(batadv_ogm_packet->prev_sender,
349 hard_iface->net_dev->dev_addr);
353 batadv_iv_ogm_primary_iface_set(struct batadv_hard_iface *hard_iface)
355 struct batadv_ogm_packet *batadv_ogm_packet;
356 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
358 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
359 batadv_ogm_packet->flags = BATADV_PRIMARIES_FIRST_HOP;
360 batadv_ogm_packet->ttl = BATADV_TTL;
363 /* when do we schedule our own ogm to be sent */
365 batadv_iv_ogm_emit_send_time(const struct batadv_priv *bat_priv)
369 msecs = atomic_read(&bat_priv->orig_interval) - BATADV_JITTER;
370 msecs += prandom_u32() % (2 * BATADV_JITTER);
372 return jiffies + msecs_to_jiffies(msecs);
375 /* when do we schedule a ogm packet to be sent */
376 static unsigned long batadv_iv_ogm_fwd_send_time(void)
378 return jiffies + msecs_to_jiffies(prandom_u32() % (BATADV_JITTER / 2));
381 /* apply hop penalty for a normal link */
382 static uint8_t batadv_hop_penalty(uint8_t tq,
383 const struct batadv_priv *bat_priv)
385 int hop_penalty = atomic_read(&bat_priv->hop_penalty);
388 new_tq = tq * (BATADV_TQ_MAX_VALUE - hop_penalty);
389 new_tq /= BATADV_TQ_MAX_VALUE;
394 /* is there another aggregated packet here? */
395 static bool batadv_iv_ogm_aggr_packet(int buff_pos, int packet_len,
398 int next_buff_pos = 0;
400 next_buff_pos += buff_pos + BATADV_OGM_HLEN;
401 next_buff_pos += ntohs(tvlv_len);
403 return (next_buff_pos <= packet_len) &&
404 (next_buff_pos <= BATADV_MAX_AGGREGATION_BYTES);
407 /* send a batman ogm to a given interface */
408 static void batadv_iv_ogm_send_to_if(struct batadv_forw_packet *forw_packet,
409 struct batadv_hard_iface *hard_iface)
411 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
415 struct batadv_ogm_packet *batadv_ogm_packet;
419 if (hard_iface->if_status != BATADV_IF_ACTIVE)
424 packet_pos = forw_packet->skb->data;
425 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
427 /* adjust all flags and log packets */
428 while (batadv_iv_ogm_aggr_packet(buff_pos, forw_packet->packet_len,
429 batadv_ogm_packet->tvlv_len)) {
430 /* we might have aggregated direct link packets with an
431 * ordinary base packet
433 if (forw_packet->direct_link_flags & BIT(packet_num) &&
434 forw_packet->if_incoming == hard_iface)
435 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
437 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
439 if (packet_num > 0 || !forw_packet->own)
440 fwd_str = "Forwarding";
442 fwd_str = "Sending own";
444 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
445 "%s %spacket (originator %pM, seqno %u, TQ %d, TTL %d, IDF %s) on interface %s [%pM]\n",
446 fwd_str, (packet_num > 0 ? "aggregated " : ""),
447 batadv_ogm_packet->orig,
448 ntohl(batadv_ogm_packet->seqno),
449 batadv_ogm_packet->tq, batadv_ogm_packet->ttl,
450 (batadv_ogm_packet->flags & BATADV_DIRECTLINK ?
452 hard_iface->net_dev->name,
453 hard_iface->net_dev->dev_addr);
455 buff_pos += BATADV_OGM_HLEN;
456 buff_pos += ntohs(batadv_ogm_packet->tvlv_len);
458 packet_pos = forw_packet->skb->data + buff_pos;
459 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
462 /* create clone because function is called more than once */
463 skb = skb_clone(forw_packet->skb, GFP_ATOMIC);
465 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_TX);
466 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_TX_BYTES,
467 skb->len + ETH_HLEN);
468 batadv_send_skb_packet(skb, hard_iface, batadv_broadcast_addr);
472 /* send a batman ogm packet */
473 static void batadv_iv_ogm_emit(struct batadv_forw_packet *forw_packet)
475 struct net_device *soft_iface;
476 struct batadv_priv *bat_priv;
477 struct batadv_hard_iface *primary_if = NULL;
479 if (!forw_packet->if_incoming) {
480 pr_err("Error - can't forward packet: incoming iface not specified\n");
484 soft_iface = forw_packet->if_incoming->soft_iface;
485 bat_priv = netdev_priv(soft_iface);
487 if (WARN_ON(!forw_packet->if_outgoing))
490 if (WARN_ON(forw_packet->if_outgoing->soft_iface != soft_iface))
493 if (forw_packet->if_incoming->if_status != BATADV_IF_ACTIVE)
496 primary_if = batadv_primary_if_get_selected(bat_priv);
500 /* only for one specific outgoing interface */
501 batadv_iv_ogm_send_to_if(forw_packet, forw_packet->if_outgoing);
505 batadv_hardif_free_ref(primary_if);
509 * batadv_iv_ogm_can_aggregate - find out if an OGM can be aggregated on an
510 * existing forward packet
511 * @new_bat_ogm_packet: OGM packet to be aggregated
512 * @bat_priv: the bat priv with all the soft interface information
513 * @packet_len: (total) length of the OGM
514 * @send_time: timestamp (jiffies) when the packet is to be sent
515 * @directlink: true if this is a direct link packet
516 * @if_incoming: interface where the packet was received
517 * @if_outgoing: interface for which the retransmission should be considered
518 * @forw_packet: the forwarded packet which should be checked
520 * Returns true if new_packet can be aggregated with forw_packet
523 batadv_iv_ogm_can_aggregate(const struct batadv_ogm_packet *new_bat_ogm_packet,
524 struct batadv_priv *bat_priv,
525 int packet_len, unsigned long send_time,
527 const struct batadv_hard_iface *if_incoming,
528 const struct batadv_hard_iface *if_outgoing,
529 const struct batadv_forw_packet *forw_packet)
531 struct batadv_ogm_packet *batadv_ogm_packet;
532 int aggregated_bytes = forw_packet->packet_len + packet_len;
533 struct batadv_hard_iface *primary_if = NULL;
535 unsigned long aggregation_end_time;
537 batadv_ogm_packet = (struct batadv_ogm_packet *)forw_packet->skb->data;
538 aggregation_end_time = send_time;
539 aggregation_end_time += msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
541 /* we can aggregate the current packet to this aggregated packet
544 * - the send time is within our MAX_AGGREGATION_MS time
545 * - the resulting packet wont be bigger than
546 * MAX_AGGREGATION_BYTES
547 * otherwise aggregation is not possible
549 if (!time_before(send_time, forw_packet->send_time) ||
550 !time_after_eq(aggregation_end_time, forw_packet->send_time))
553 if (aggregated_bytes > BATADV_MAX_AGGREGATION_BYTES)
556 /* packet is not leaving on the same interface. */
557 if (forw_packet->if_outgoing != if_outgoing)
560 /* check aggregation compatibility
561 * -> direct link packets are broadcasted on
562 * their interface only
563 * -> aggregate packet if the current packet is
564 * a "global" packet as well as the base
567 primary_if = batadv_primary_if_get_selected(bat_priv);
571 /* packets without direct link flag and high TTL
572 * are flooded through the net
575 !(batadv_ogm_packet->flags & BATADV_DIRECTLINK) &&
576 batadv_ogm_packet->ttl != 1 &&
578 /* own packets originating non-primary
579 * interfaces leave only that interface
581 (!forw_packet->own ||
582 forw_packet->if_incoming == primary_if)) {
587 /* if the incoming packet is sent via this one
588 * interface only - we still can aggregate
591 new_bat_ogm_packet->ttl == 1 &&
592 forw_packet->if_incoming == if_incoming &&
594 /* packets from direct neighbors or
595 * own secondary interface packets
596 * (= secondary interface packets in general)
598 (batadv_ogm_packet->flags & BATADV_DIRECTLINK ||
600 forw_packet->if_incoming != primary_if))) {
607 batadv_hardif_free_ref(primary_if);
612 * batadv_iv_ogm_aggregate_new - create a new aggregated packet and add this
614 * @packet_buff: pointer to the OGM
615 * @packet_len: (total) length of the OGM
616 * @send_time: timestamp (jiffies) when the packet is to be sent
617 * @direct_link: whether this OGM has direct link status
618 * @if_incoming: interface where the packet was received
619 * @if_outgoing: interface for which the retransmission should be considered
620 * @own_packet: true if it is a self-generated ogm
622 static void batadv_iv_ogm_aggregate_new(const unsigned char *packet_buff,
623 int packet_len, unsigned long send_time,
625 struct batadv_hard_iface *if_incoming,
626 struct batadv_hard_iface *if_outgoing,
629 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
630 struct batadv_forw_packet *forw_packet_aggr;
631 unsigned char *skb_buff;
632 unsigned int skb_size;
634 if (!atomic_inc_not_zero(&if_incoming->refcount))
637 if (!atomic_inc_not_zero(&if_outgoing->refcount))
638 goto out_free_incoming;
640 /* own packet should always be scheduled */
642 if (!batadv_atomic_dec_not_zero(&bat_priv->batman_queue_left)) {
643 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
644 "batman packet queue full\n");
645 goto out_free_outgoing;
649 forw_packet_aggr = kmalloc(sizeof(*forw_packet_aggr), GFP_ATOMIC);
650 if (!forw_packet_aggr)
653 if (atomic_read(&bat_priv->aggregated_ogms) &&
654 packet_len < BATADV_MAX_AGGREGATION_BYTES)
655 skb_size = BATADV_MAX_AGGREGATION_BYTES;
657 skb_size = packet_len;
659 skb_size += ETH_HLEN;
661 forw_packet_aggr->skb = netdev_alloc_skb_ip_align(NULL, skb_size);
662 if (!forw_packet_aggr->skb)
663 goto out_free_forw_packet;
664 forw_packet_aggr->skb->priority = TC_PRIO_CONTROL;
665 skb_reserve(forw_packet_aggr->skb, ETH_HLEN);
667 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
668 forw_packet_aggr->packet_len = packet_len;
669 memcpy(skb_buff, packet_buff, packet_len);
671 forw_packet_aggr->own = own_packet;
672 forw_packet_aggr->if_incoming = if_incoming;
673 forw_packet_aggr->if_outgoing = if_outgoing;
674 forw_packet_aggr->num_packets = 0;
675 forw_packet_aggr->direct_link_flags = BATADV_NO_FLAGS;
676 forw_packet_aggr->send_time = send_time;
678 /* save packet direct link flag status */
680 forw_packet_aggr->direct_link_flags |= 1;
682 /* add new packet to packet list */
683 spin_lock_bh(&bat_priv->forw_bat_list_lock);
684 hlist_add_head(&forw_packet_aggr->list, &bat_priv->forw_bat_list);
685 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
687 /* start timer for this packet */
688 INIT_DELAYED_WORK(&forw_packet_aggr->delayed_work,
689 batadv_send_outstanding_bat_ogm_packet);
690 queue_delayed_work(batadv_event_workqueue,
691 &forw_packet_aggr->delayed_work,
692 send_time - jiffies);
695 out_free_forw_packet:
696 kfree(forw_packet_aggr);
699 atomic_inc(&bat_priv->batman_queue_left);
701 batadv_hardif_free_ref(if_outgoing);
703 batadv_hardif_free_ref(if_incoming);
706 /* aggregate a new packet into the existing ogm packet */
707 static void batadv_iv_ogm_aggregate(struct batadv_forw_packet *forw_packet_aggr,
708 const unsigned char *packet_buff,
709 int packet_len, bool direct_link)
711 unsigned char *skb_buff;
712 unsigned long new_direct_link_flag;
714 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
715 memcpy(skb_buff, packet_buff, packet_len);
716 forw_packet_aggr->packet_len += packet_len;
717 forw_packet_aggr->num_packets++;
719 /* save packet direct link flag status */
721 new_direct_link_flag = BIT(forw_packet_aggr->num_packets);
722 forw_packet_aggr->direct_link_flags |= new_direct_link_flag;
727 * batadv_iv_ogm_queue_add - queue up an OGM for transmission
728 * @bat_priv: the bat priv with all the soft interface information
729 * @packet_buff: pointer to the OGM
730 * @packet_len: (total) length of the OGM
731 * @if_incoming: interface where the packet was received
732 * @if_outgoing: interface for which the retransmission should be considered
733 * @own_packet: true if it is a self-generated ogm
734 * @send_time: timestamp (jiffies) when the packet is to be sent
736 static void batadv_iv_ogm_queue_add(struct batadv_priv *bat_priv,
737 unsigned char *packet_buff,
739 struct batadv_hard_iface *if_incoming,
740 struct batadv_hard_iface *if_outgoing,
741 int own_packet, unsigned long send_time)
743 /* _aggr -> pointer to the packet we want to aggregate with
744 * _pos -> pointer to the position in the queue
746 struct batadv_forw_packet *forw_packet_aggr = NULL;
747 struct batadv_forw_packet *forw_packet_pos = NULL;
748 struct batadv_ogm_packet *batadv_ogm_packet;
750 unsigned long max_aggregation_jiffies;
752 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_buff;
753 direct_link = !!(batadv_ogm_packet->flags & BATADV_DIRECTLINK);
754 max_aggregation_jiffies = msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
756 /* find position for the packet in the forward queue */
757 spin_lock_bh(&bat_priv->forw_bat_list_lock);
758 /* own packets are not to be aggregated */
759 if (atomic_read(&bat_priv->aggregated_ogms) && !own_packet) {
760 hlist_for_each_entry(forw_packet_pos,
761 &bat_priv->forw_bat_list, list) {
762 if (batadv_iv_ogm_can_aggregate(batadv_ogm_packet,
763 bat_priv, packet_len,
764 send_time, direct_link,
768 forw_packet_aggr = forw_packet_pos;
774 /* nothing to aggregate with - either aggregation disabled or no
775 * suitable aggregation packet found
777 if (!forw_packet_aggr) {
778 /* the following section can run without the lock */
779 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
781 /* if we could not aggregate this packet with one of the others
782 * we hold it back for a while, so that it might be aggregated
785 if (!own_packet && atomic_read(&bat_priv->aggregated_ogms))
786 send_time += max_aggregation_jiffies;
788 batadv_iv_ogm_aggregate_new(packet_buff, packet_len,
789 send_time, direct_link,
790 if_incoming, if_outgoing,
793 batadv_iv_ogm_aggregate(forw_packet_aggr, packet_buff,
794 packet_len, direct_link);
795 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
799 static void batadv_iv_ogm_forward(struct batadv_orig_node *orig_node,
800 const struct ethhdr *ethhdr,
801 struct batadv_ogm_packet *batadv_ogm_packet,
802 bool is_single_hop_neigh,
803 bool is_from_best_next_hop,
804 struct batadv_hard_iface *if_incoming,
805 struct batadv_hard_iface *if_outgoing)
807 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
810 if (batadv_ogm_packet->ttl <= 1) {
811 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "ttl exceeded\n");
815 if (!is_from_best_next_hop) {
816 /* Mark the forwarded packet when it is not coming from our
817 * best next hop. We still need to forward the packet for our
818 * neighbor link quality detection to work in case the packet
819 * originated from a single hop neighbor. Otherwise we can
820 * simply drop the ogm.
822 if (is_single_hop_neigh)
823 batadv_ogm_packet->flags |= BATADV_NOT_BEST_NEXT_HOP;
828 tvlv_len = ntohs(batadv_ogm_packet->tvlv_len);
830 batadv_ogm_packet->ttl--;
831 ether_addr_copy(batadv_ogm_packet->prev_sender, ethhdr->h_source);
833 /* apply hop penalty */
834 batadv_ogm_packet->tq = batadv_hop_penalty(batadv_ogm_packet->tq,
837 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
838 "Forwarding packet: tq: %i, ttl: %i\n",
839 batadv_ogm_packet->tq, batadv_ogm_packet->ttl);
841 /* switch of primaries first hop flag when forwarding */
842 batadv_ogm_packet->flags &= ~BATADV_PRIMARIES_FIRST_HOP;
843 if (is_single_hop_neigh)
844 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
846 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
848 batadv_iv_ogm_queue_add(bat_priv, (unsigned char *)batadv_ogm_packet,
849 BATADV_OGM_HLEN + tvlv_len,
850 if_incoming, if_outgoing, 0,
851 batadv_iv_ogm_fwd_send_time());
855 * batadv_iv_ogm_slide_own_bcast_window - bitshift own OGM broadcast windows for
856 * the given interface
857 * @hard_iface: the interface for which the windows have to be shifted
860 batadv_iv_ogm_slide_own_bcast_window(struct batadv_hard_iface *hard_iface)
862 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
863 struct batadv_hashtable *hash = bat_priv->orig_hash;
864 struct hlist_head *head;
865 struct batadv_orig_node *orig_node;
872 for (i = 0; i < hash->size; i++) {
873 head = &hash->table[i];
876 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
877 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
878 word_index = hard_iface->if_num * BATADV_NUM_WORDS;
879 word = &orig_node->bat_iv.bcast_own[word_index];
881 batadv_bit_get_packet(bat_priv, word, 1, 0);
882 if_num = hard_iface->if_num;
883 w = &orig_node->bat_iv.bcast_own_sum[if_num];
884 *w = bitmap_weight(word, BATADV_TQ_LOCAL_WINDOW_SIZE);
885 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
891 static void batadv_iv_ogm_schedule(struct batadv_hard_iface *hard_iface)
893 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
894 unsigned char **ogm_buff = &hard_iface->bat_iv.ogm_buff;
895 struct batadv_ogm_packet *batadv_ogm_packet;
896 struct batadv_hard_iface *primary_if, *tmp_hard_iface;
897 int *ogm_buff_len = &hard_iface->bat_iv.ogm_buff_len;
899 uint16_t tvlv_len = 0;
900 unsigned long send_time;
902 primary_if = batadv_primary_if_get_selected(bat_priv);
904 if (hard_iface == primary_if) {
905 /* tt changes have to be committed before the tvlv data is
906 * appended as it may alter the tt tvlv container
908 batadv_tt_local_commit_changes(bat_priv);
909 tvlv_len = batadv_tvlv_container_ogm_append(bat_priv, ogm_buff,
914 batadv_ogm_packet = (struct batadv_ogm_packet *)(*ogm_buff);
915 batadv_ogm_packet->tvlv_len = htons(tvlv_len);
917 /* change sequence number to network order */
918 seqno = (uint32_t)atomic_read(&hard_iface->bat_iv.ogm_seqno);
919 batadv_ogm_packet->seqno = htonl(seqno);
920 atomic_inc(&hard_iface->bat_iv.ogm_seqno);
922 batadv_iv_ogm_slide_own_bcast_window(hard_iface);
924 send_time = batadv_iv_ogm_emit_send_time(bat_priv);
926 if (hard_iface != primary_if) {
927 /* OGMs from secondary interfaces are only scheduled on their
928 * respective interfaces.
930 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff, *ogm_buff_len,
931 hard_iface, hard_iface, 1, send_time);
935 /* OGMs from primary interfaces are scheduled on all
939 list_for_each_entry_rcu(tmp_hard_iface, &batadv_hardif_list, list) {
940 if (tmp_hard_iface->soft_iface != hard_iface->soft_iface)
942 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff,
943 *ogm_buff_len, hard_iface,
944 tmp_hard_iface, 1, send_time);
950 batadv_hardif_free_ref(primary_if);
954 * batadv_iv_ogm_orig_update - use OGM to update corresponding data in an
956 * @bat_priv: the bat priv with all the soft interface information
957 * @orig_node: the orig node who originally emitted the ogm packet
958 * @orig_ifinfo: ifinfo for the outgoing interface of the orig_node
959 * @ethhdr: Ethernet header of the OGM
960 * @batadv_ogm_packet: the ogm packet
961 * @if_incoming: interface where the packet was received
962 * @if_outgoing: interface for which the retransmission should be considered
963 * @dup_status: the duplicate status of this ogm packet.
966 batadv_iv_ogm_orig_update(struct batadv_priv *bat_priv,
967 struct batadv_orig_node *orig_node,
968 struct batadv_orig_ifinfo *orig_ifinfo,
969 const struct ethhdr *ethhdr,
970 const struct batadv_ogm_packet *batadv_ogm_packet,
971 struct batadv_hard_iface *if_incoming,
972 struct batadv_hard_iface *if_outgoing,
973 enum batadv_dup_status dup_status)
975 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL;
976 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
977 struct batadv_neigh_node *neigh_node = NULL, *tmp_neigh_node = NULL;
978 struct batadv_neigh_node *router = NULL;
979 struct batadv_orig_node *orig_node_tmp;
981 uint8_t sum_orig, sum_neigh;
985 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
986 "update_originator(): Searching and updating originator entry of received packet\n");
989 hlist_for_each_entry_rcu(tmp_neigh_node,
990 &orig_node->neigh_list, list) {
991 neigh_addr = tmp_neigh_node->addr;
992 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
993 tmp_neigh_node->if_incoming == if_incoming &&
994 atomic_inc_not_zero(&tmp_neigh_node->refcount)) {
995 if (WARN(neigh_node, "too many matching neigh_nodes"))
996 batadv_neigh_node_free_ref(neigh_node);
997 neigh_node = tmp_neigh_node;
1001 if (dup_status != BATADV_NO_DUP)
1004 /* only update the entry for this outgoing interface */
1005 neigh_ifinfo = batadv_neigh_ifinfo_get(tmp_neigh_node,
1010 spin_lock_bh(&tmp_neigh_node->ifinfo_lock);
1011 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1012 &neigh_ifinfo->bat_iv.tq_index, 0);
1013 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1014 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1015 spin_unlock_bh(&tmp_neigh_node->ifinfo_lock);
1017 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1018 neigh_ifinfo = NULL;
1022 struct batadv_orig_node *orig_tmp;
1024 orig_tmp = batadv_iv_ogm_orig_get(bat_priv, ethhdr->h_source);
1028 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1030 orig_node, orig_tmp);
1032 batadv_orig_node_free_ref(orig_tmp);
1036 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1037 "Updating existing last-hop neighbor of originator\n");
1040 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1044 neigh_node->last_seen = jiffies;
1046 spin_lock_bh(&neigh_node->ifinfo_lock);
1047 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1048 &neigh_ifinfo->bat_iv.tq_index,
1049 batadv_ogm_packet->tq);
1050 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1051 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1052 spin_unlock_bh(&neigh_node->ifinfo_lock);
1054 if (dup_status == BATADV_NO_DUP) {
1055 orig_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1056 neigh_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1059 /* if this neighbor already is our next hop there is nothing
1062 router = batadv_orig_router_get(orig_node, if_outgoing);
1063 if (router == neigh_node)
1067 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1071 /* if this neighbor does not offer a better TQ we won't
1074 if (router_ifinfo->bat_iv.tq_avg > neigh_ifinfo->bat_iv.tq_avg)
1078 /* if the TQ is the same and the link not more symmetric we
1079 * won't consider it either
1081 if (router_ifinfo &&
1082 neigh_ifinfo->bat_iv.tq_avg == router_ifinfo->bat_iv.tq_avg) {
1083 orig_node_tmp = router->orig_node;
1084 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1085 if_num = router->if_incoming->if_num;
1086 sum_orig = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1087 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1089 orig_node_tmp = neigh_node->orig_node;
1090 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1091 if_num = neigh_node->if_incoming->if_num;
1092 sum_neigh = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1093 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1095 if (sum_orig >= sum_neigh)
1099 batadv_update_route(bat_priv, orig_node, if_outgoing, neigh_node);
1106 batadv_neigh_node_free_ref(neigh_node);
1108 batadv_neigh_node_free_ref(router);
1110 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1112 batadv_neigh_ifinfo_free_ref(router_ifinfo);
1116 * batadv_iv_ogm_calc_tq - calculate tq for current received ogm packet
1117 * @orig_node: the orig node who originally emitted the ogm packet
1118 * @orig_neigh_node: the orig node struct of the neighbor who sent the packet
1119 * @batadv_ogm_packet: the ogm packet
1120 * @if_incoming: interface where the packet was received
1121 * @if_outgoing: interface for which the retransmission should be considered
1123 * Returns 1 if the link can be considered bidirectional, 0 otherwise
1125 static int batadv_iv_ogm_calc_tq(struct batadv_orig_node *orig_node,
1126 struct batadv_orig_node *orig_neigh_node,
1127 struct batadv_ogm_packet *batadv_ogm_packet,
1128 struct batadv_hard_iface *if_incoming,
1129 struct batadv_hard_iface *if_outgoing)
1131 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1132 struct batadv_neigh_node *neigh_node = NULL, *tmp_neigh_node;
1133 struct batadv_neigh_ifinfo *neigh_ifinfo;
1134 uint8_t total_count;
1135 uint8_t orig_eq_count, neigh_rq_count, neigh_rq_inv, tq_own;
1136 unsigned int neigh_rq_inv_cube, neigh_rq_max_cube;
1137 int tq_asym_penalty, inv_asym_penalty, if_num, ret = 0;
1138 unsigned int combined_tq;
1139 int tq_iface_penalty;
1141 /* find corresponding one hop neighbor */
1143 hlist_for_each_entry_rcu(tmp_neigh_node,
1144 &orig_neigh_node->neigh_list, list) {
1145 if (!batadv_compare_eth(tmp_neigh_node->addr,
1146 orig_neigh_node->orig))
1149 if (tmp_neigh_node->if_incoming != if_incoming)
1152 if (!atomic_inc_not_zero(&tmp_neigh_node->refcount))
1155 neigh_node = tmp_neigh_node;
1161 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1162 orig_neigh_node->orig,
1169 /* if orig_node is direct neighbor update neigh_node last_seen */
1170 if (orig_node == orig_neigh_node)
1171 neigh_node->last_seen = jiffies;
1173 orig_node->last_seen = jiffies;
1175 /* find packet count of corresponding one hop neighbor */
1176 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1177 if_num = if_incoming->if_num;
1178 orig_eq_count = orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1179 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1181 neigh_rq_count = neigh_ifinfo->bat_iv.real_packet_count;
1182 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1186 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1188 /* pay attention to not get a value bigger than 100 % */
1189 if (orig_eq_count > neigh_rq_count)
1190 total_count = neigh_rq_count;
1192 total_count = orig_eq_count;
1194 /* if we have too few packets (too less data) we set tq_own to zero
1195 * if we receive too few packets it is not considered bidirectional
1197 if (total_count < BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM ||
1198 neigh_rq_count < BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM)
1201 /* neigh_node->real_packet_count is never zero as we
1202 * only purge old information when getting new
1205 tq_own = (BATADV_TQ_MAX_VALUE * total_count) / neigh_rq_count;
1207 /* 1 - ((1-x) ** 3), normalized to TQ_MAX_VALUE this does
1208 * affect the nearly-symmetric links only a little, but
1209 * punishes asymmetric links more. This will give a value
1210 * between 0 and TQ_MAX_VALUE
1212 neigh_rq_inv = BATADV_TQ_LOCAL_WINDOW_SIZE - neigh_rq_count;
1213 neigh_rq_inv_cube = neigh_rq_inv * neigh_rq_inv * neigh_rq_inv;
1214 neigh_rq_max_cube = BATADV_TQ_LOCAL_WINDOW_SIZE *
1215 BATADV_TQ_LOCAL_WINDOW_SIZE *
1216 BATADV_TQ_LOCAL_WINDOW_SIZE;
1217 inv_asym_penalty = BATADV_TQ_MAX_VALUE * neigh_rq_inv_cube;
1218 inv_asym_penalty /= neigh_rq_max_cube;
1219 tq_asym_penalty = BATADV_TQ_MAX_VALUE - inv_asym_penalty;
1221 /* penalize if the OGM is forwarded on the same interface. WiFi
1222 * interfaces and other half duplex devices suffer from throughput
1223 * drops as they can't send and receive at the same time.
1225 tq_iface_penalty = BATADV_TQ_MAX_VALUE;
1226 if (if_outgoing && (if_incoming == if_outgoing) &&
1227 batadv_is_wifi_netdev(if_outgoing->net_dev))
1228 tq_iface_penalty = batadv_hop_penalty(BATADV_TQ_MAX_VALUE,
1231 combined_tq = batadv_ogm_packet->tq *
1235 combined_tq /= BATADV_TQ_MAX_VALUE *
1236 BATADV_TQ_MAX_VALUE *
1237 BATADV_TQ_MAX_VALUE;
1238 batadv_ogm_packet->tq = combined_tq;
1240 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1241 "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",
1242 orig_node->orig, orig_neigh_node->orig, total_count,
1243 neigh_rq_count, tq_own, tq_asym_penalty, tq_iface_penalty,
1244 batadv_ogm_packet->tq, if_incoming->net_dev->name,
1245 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT");
1247 /* if link has the minimum required transmission quality
1248 * consider it bidirectional
1250 if (batadv_ogm_packet->tq >= BATADV_TQ_TOTAL_BIDRECT_LIMIT)
1255 batadv_neigh_node_free_ref(neigh_node);
1260 * batadv_iv_ogm_update_seqnos - process a batman packet for all interfaces,
1261 * adjust the sequence number and find out whether it is a duplicate
1262 * @ethhdr: ethernet header of the packet
1263 * @batadv_ogm_packet: OGM packet to be considered
1264 * @if_incoming: interface on which the OGM packet was received
1265 * @if_outgoing: interface for which the retransmission should be considered
1267 * Returns duplicate status as enum batadv_dup_status
1269 static enum batadv_dup_status
1270 batadv_iv_ogm_update_seqnos(const struct ethhdr *ethhdr,
1271 const struct batadv_ogm_packet *batadv_ogm_packet,
1272 const struct batadv_hard_iface *if_incoming,
1273 struct batadv_hard_iface *if_outgoing)
1275 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1276 struct batadv_orig_node *orig_node;
1277 struct batadv_orig_ifinfo *orig_ifinfo = NULL;
1278 struct batadv_neigh_node *neigh_node;
1279 struct batadv_neigh_ifinfo *neigh_ifinfo;
1282 int need_update = 0;
1284 enum batadv_dup_status ret = BATADV_NO_DUP;
1285 uint32_t seqno = ntohl(batadv_ogm_packet->seqno);
1286 uint8_t *neigh_addr;
1287 uint8_t packet_count;
1288 unsigned long *bitmap;
1290 orig_node = batadv_iv_ogm_orig_get(bat_priv, batadv_ogm_packet->orig);
1292 return BATADV_NO_DUP;
1294 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1295 if (WARN_ON(!orig_ifinfo)) {
1296 batadv_orig_node_free_ref(orig_node);
1300 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1301 seq_diff = seqno - orig_ifinfo->last_real_seqno;
1303 /* signalize caller that the packet is to be dropped. */
1304 if (!hlist_empty(&orig_node->neigh_list) &&
1305 batadv_window_protected(bat_priv, seq_diff,
1306 &orig_ifinfo->batman_seqno_reset)) {
1307 ret = BATADV_PROTECTED;
1312 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1313 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node,
1318 neigh_addr = neigh_node->addr;
1319 is_dup = batadv_test_bit(neigh_ifinfo->bat_iv.real_bits,
1320 orig_ifinfo->last_real_seqno,
1323 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1324 neigh_node->if_incoming == if_incoming) {
1327 ret = BATADV_NEIGH_DUP;
1330 if (is_dup && (ret != BATADV_NEIGH_DUP))
1331 ret = BATADV_ORIG_DUP;
1334 /* if the window moved, set the update flag. */
1335 bitmap = neigh_ifinfo->bat_iv.real_bits;
1336 need_update |= batadv_bit_get_packet(bat_priv, bitmap,
1337 seq_diff, set_mark);
1339 packet_count = bitmap_weight(bitmap,
1340 BATADV_TQ_LOCAL_WINDOW_SIZE);
1341 neigh_ifinfo->bat_iv.real_packet_count = packet_count;
1342 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1347 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1348 "%s updating last_seqno: old %u, new %u\n",
1349 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT",
1350 orig_ifinfo->last_real_seqno, seqno);
1351 orig_ifinfo->last_real_seqno = seqno;
1355 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1356 batadv_orig_node_free_ref(orig_node);
1358 batadv_orig_ifinfo_free_ref(orig_ifinfo);
1363 * batadv_iv_ogm_process_per_outif - process a batman iv OGM for an outgoing if
1364 * @skb: the skb containing the OGM
1365 * @ogm_offset: offset from skb->data to start of ogm header
1366 * @orig_node: the (cached) orig node for the originator of this OGM
1367 * @if_incoming: the interface where this packet was received
1368 * @if_outgoing: the interface for which the packet should be considered
1371 batadv_iv_ogm_process_per_outif(const struct sk_buff *skb, int ogm_offset,
1372 struct batadv_orig_node *orig_node,
1373 struct batadv_hard_iface *if_incoming,
1374 struct batadv_hard_iface *if_outgoing)
1376 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1377 struct batadv_neigh_node *router = NULL, *router_router = NULL;
1378 struct batadv_orig_node *orig_neigh_node;
1379 struct batadv_orig_ifinfo *orig_ifinfo;
1380 struct batadv_neigh_node *orig_neigh_router = NULL;
1381 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
1382 struct batadv_ogm_packet *ogm_packet;
1383 enum batadv_dup_status dup_status;
1384 bool is_from_best_next_hop = false;
1385 bool is_single_hop_neigh = false;
1386 bool sameseq, similar_ttl;
1387 struct sk_buff *skb_priv;
1388 struct ethhdr *ethhdr;
1389 uint8_t *prev_sender;
1392 /* create a private copy of the skb, as some functions change tq value
1395 skb_priv = skb_copy(skb, GFP_ATOMIC);
1399 ethhdr = eth_hdr(skb_priv);
1400 ogm_packet = (struct batadv_ogm_packet *)(skb_priv->data + ogm_offset);
1402 dup_status = batadv_iv_ogm_update_seqnos(ethhdr, ogm_packet,
1403 if_incoming, if_outgoing);
1404 if (batadv_compare_eth(ethhdr->h_source, ogm_packet->orig))
1405 is_single_hop_neigh = true;
1407 if (dup_status == BATADV_PROTECTED) {
1408 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1409 "Drop packet: packet within seqno protection time (sender: %pM)\n",
1414 if (ogm_packet->tq == 0) {
1415 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1416 "Drop packet: originator packet with tq equal 0\n");
1420 router = batadv_orig_router_get(orig_node, if_outgoing);
1422 router_router = batadv_orig_router_get(router->orig_node,
1424 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1427 if ((router_ifinfo && router_ifinfo->bat_iv.tq_avg != 0) &&
1428 (batadv_compare_eth(router->addr, ethhdr->h_source)))
1429 is_from_best_next_hop = true;
1431 prev_sender = ogm_packet->prev_sender;
1432 /* avoid temporary routing loops */
1433 if (router && router_router &&
1434 (batadv_compare_eth(router->addr, prev_sender)) &&
1435 !(batadv_compare_eth(ogm_packet->orig, prev_sender)) &&
1436 (batadv_compare_eth(router->addr, router_router->addr))) {
1437 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1438 "Drop packet: ignoring all rebroadcast packets that may make me loop (sender: %pM)\n",
1443 if (if_outgoing == BATADV_IF_DEFAULT)
1444 batadv_tvlv_ogm_receive(bat_priv, ogm_packet, orig_node);
1446 /* if sender is a direct neighbor the sender mac equals
1449 if (is_single_hop_neigh)
1450 orig_neigh_node = orig_node;
1452 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1455 if (!orig_neigh_node)
1458 /* Update nc_nodes of the originator */
1459 batadv_nc_update_nc_node(bat_priv, orig_node, orig_neigh_node,
1460 ogm_packet, is_single_hop_neigh);
1462 orig_neigh_router = batadv_orig_router_get(orig_neigh_node,
1465 /* drop packet if sender is not a direct neighbor and if we
1466 * don't route towards it
1468 if (!is_single_hop_neigh && (!orig_neigh_router)) {
1469 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1470 "Drop packet: OGM via unknown neighbor!\n");
1474 is_bidirect = batadv_iv_ogm_calc_tq(orig_node, orig_neigh_node,
1475 ogm_packet, if_incoming,
1478 /* update ranking if it is not a duplicate or has the same
1479 * seqno and similar ttl as the non-duplicate
1481 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1485 sameseq = orig_ifinfo->last_real_seqno == ntohl(ogm_packet->seqno);
1486 similar_ttl = (orig_ifinfo->last_ttl - 3) <= ogm_packet->ttl;
1488 if (is_bidirect && ((dup_status == BATADV_NO_DUP) ||
1489 (sameseq && similar_ttl))) {
1490 batadv_iv_ogm_orig_update(bat_priv, orig_node,
1491 orig_ifinfo, ethhdr,
1492 ogm_packet, if_incoming,
1493 if_outgoing, dup_status);
1495 batadv_orig_ifinfo_free_ref(orig_ifinfo);
1497 /* only forward for specific interface, not for the default one. */
1498 if (if_outgoing == BATADV_IF_DEFAULT)
1501 /* is single hop (direct) neighbor */
1502 if (is_single_hop_neigh) {
1503 /* OGMs from secondary interfaces should only scheduled once
1504 * per interface where it has been received, not multiple times
1506 if ((ogm_packet->ttl <= 2) &&
1507 (if_incoming != if_outgoing)) {
1508 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1509 "Drop packet: OGM from secondary interface and wrong outgoing interface\n");
1512 /* mark direct link on incoming interface */
1513 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1514 is_single_hop_neigh,
1515 is_from_best_next_hop, if_incoming,
1518 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1519 "Forwarding packet: rebroadcast neighbor packet with direct link flag\n");
1523 /* multihop originator */
1525 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1526 "Drop packet: not received via bidirectional link\n");
1530 if (dup_status == BATADV_NEIGH_DUP) {
1531 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1532 "Drop packet: duplicate packet received\n");
1536 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1537 "Forwarding packet: rebroadcast originator packet\n");
1538 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1539 is_single_hop_neigh, is_from_best_next_hop,
1540 if_incoming, if_outgoing);
1543 if ((orig_neigh_node) && (!is_single_hop_neigh))
1544 batadv_orig_node_free_ref(orig_neigh_node);
1547 batadv_neigh_ifinfo_free_ref(router_ifinfo);
1549 batadv_neigh_node_free_ref(router);
1551 batadv_neigh_node_free_ref(router_router);
1552 if (orig_neigh_router)
1553 batadv_neigh_node_free_ref(orig_neigh_router);
1555 kfree_skb(skb_priv);
1559 * batadv_iv_ogm_process - process an incoming batman iv OGM
1560 * @skb: the skb containing the OGM
1561 * @ogm_offset: offset to the OGM which should be processed (for aggregates)
1562 * @if_incoming: the interface where this packet was receved
1564 static void batadv_iv_ogm_process(const struct sk_buff *skb, int ogm_offset,
1565 struct batadv_hard_iface *if_incoming)
1567 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1568 struct batadv_orig_node *orig_neigh_node, *orig_node;
1569 struct batadv_hard_iface *hard_iface;
1570 struct batadv_ogm_packet *ogm_packet;
1571 uint32_t if_incoming_seqno;
1572 bool has_directlink_flag;
1573 struct ethhdr *ethhdr;
1574 bool is_my_oldorig = false;
1575 bool is_my_addr = false;
1576 bool is_my_orig = false;
1578 ogm_packet = (struct batadv_ogm_packet *)(skb->data + ogm_offset);
1579 ethhdr = eth_hdr(skb);
1581 /* Silently drop when the batman packet is actually not a
1584 * This might happen if a packet is padded (e.g. Ethernet has a
1585 * minimum frame length of 64 byte) and the aggregation interprets
1586 * it as an additional length.
1588 * TODO: A more sane solution would be to have a bit in the
1589 * batadv_ogm_packet to detect whether the packet is the last
1590 * packet in an aggregation. Here we expect that the padding
1591 * is always zero (or not 0x01)
1593 if (ogm_packet->packet_type != BATADV_IV_OGM)
1596 /* could be changed by schedule_own_packet() */
1597 if_incoming_seqno = atomic_read(&if_incoming->bat_iv.ogm_seqno);
1599 if (ogm_packet->flags & BATADV_DIRECTLINK)
1600 has_directlink_flag = true;
1602 has_directlink_flag = false;
1604 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1605 "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",
1606 ethhdr->h_source, if_incoming->net_dev->name,
1607 if_incoming->net_dev->dev_addr, ogm_packet->orig,
1608 ogm_packet->prev_sender, ntohl(ogm_packet->seqno),
1609 ogm_packet->tq, ogm_packet->ttl,
1610 ogm_packet->version, has_directlink_flag);
1613 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1614 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1617 if (hard_iface->soft_iface != if_incoming->soft_iface)
1620 if (batadv_compare_eth(ethhdr->h_source,
1621 hard_iface->net_dev->dev_addr))
1624 if (batadv_compare_eth(ogm_packet->orig,
1625 hard_iface->net_dev->dev_addr))
1628 if (batadv_compare_eth(ogm_packet->prev_sender,
1629 hard_iface->net_dev->dev_addr))
1630 is_my_oldorig = true;
1635 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1636 "Drop packet: received my own broadcast (sender: %pM)\n",
1642 unsigned long *word;
1648 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1650 if (!orig_neigh_node)
1653 /* neighbor has to indicate direct link and it has to
1654 * come via the corresponding interface
1655 * save packet seqno for bidirectional check
1657 if (has_directlink_flag &&
1658 batadv_compare_eth(if_incoming->net_dev->dev_addr,
1659 ogm_packet->orig)) {
1660 if_num = if_incoming->if_num;
1661 offset = if_num * BATADV_NUM_WORDS;
1663 spin_lock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1664 word = &orig_neigh_node->bat_iv.bcast_own[offset];
1665 bit_pos = if_incoming_seqno - 2;
1666 bit_pos -= ntohl(ogm_packet->seqno);
1667 batadv_set_bit(word, bit_pos);
1668 weight = &orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1669 *weight = bitmap_weight(word,
1670 BATADV_TQ_LOCAL_WINDOW_SIZE);
1671 spin_unlock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1674 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1675 "Drop packet: originator packet from myself (via neighbor)\n");
1676 batadv_orig_node_free_ref(orig_neigh_node);
1680 if (is_my_oldorig) {
1681 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1682 "Drop packet: ignoring all rebroadcast echos (sender: %pM)\n",
1687 if (ogm_packet->flags & BATADV_NOT_BEST_NEXT_HOP) {
1688 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1689 "Drop packet: ignoring all packets not forwarded from the best next hop (sender: %pM)\n",
1694 orig_node = batadv_iv_ogm_orig_get(bat_priv, ogm_packet->orig);
1698 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1699 if_incoming, BATADV_IF_DEFAULT);
1702 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1703 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1706 if (hard_iface->soft_iface != bat_priv->soft_iface)
1709 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1710 if_incoming, hard_iface);
1714 batadv_orig_node_free_ref(orig_node);
1717 static int batadv_iv_ogm_receive(struct sk_buff *skb,
1718 struct batadv_hard_iface *if_incoming)
1720 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1721 struct batadv_ogm_packet *ogm_packet;
1722 uint8_t *packet_pos;
1726 ret = batadv_check_management_packet(skb, if_incoming, BATADV_OGM_HLEN);
1730 /* did we receive a B.A.T.M.A.N. IV OGM packet on an interface
1731 * that does not have B.A.T.M.A.N. IV enabled ?
1733 if (bat_priv->bat_algo_ops->bat_ogm_emit != batadv_iv_ogm_emit)
1736 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_RX);
1737 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_RX_BYTES,
1738 skb->len + ETH_HLEN);
1741 ogm_packet = (struct batadv_ogm_packet *)skb->data;
1743 /* unpack the aggregated packets and process them one by one */
1744 while (batadv_iv_ogm_aggr_packet(ogm_offset, skb_headlen(skb),
1745 ogm_packet->tvlv_len)) {
1746 batadv_iv_ogm_process(skb, ogm_offset, if_incoming);
1748 ogm_offset += BATADV_OGM_HLEN;
1749 ogm_offset += ntohs(ogm_packet->tvlv_len);
1751 packet_pos = skb->data + ogm_offset;
1752 ogm_packet = (struct batadv_ogm_packet *)packet_pos;
1756 return NET_RX_SUCCESS;
1760 * batadv_iv_ogm_orig_print_neigh - print neighbors for the originator table
1761 * @orig_node: the orig_node for which the neighbors are printed
1762 * @if_outgoing: outgoing interface for these entries
1763 * @seq: debugfs table seq_file struct
1765 * Must be called while holding an rcu lock.
1768 batadv_iv_ogm_orig_print_neigh(struct batadv_orig_node *orig_node,
1769 struct batadv_hard_iface *if_outgoing,
1770 struct seq_file *seq)
1772 struct batadv_neigh_node *neigh_node;
1773 struct batadv_neigh_ifinfo *n_ifinfo;
1775 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1776 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
1780 seq_printf(seq, " %pM (%3i)",
1782 n_ifinfo->bat_iv.tq_avg);
1784 batadv_neigh_ifinfo_free_ref(n_ifinfo);
1789 * batadv_iv_ogm_orig_print - print the originator table
1790 * @bat_priv: the bat priv with all the soft interface information
1791 * @seq: debugfs table seq_file struct
1792 * @if_outgoing: the outgoing interface for which this should be printed
1794 static void batadv_iv_ogm_orig_print(struct batadv_priv *bat_priv,
1795 struct seq_file *seq,
1796 struct batadv_hard_iface *if_outgoing)
1798 struct batadv_neigh_node *neigh_node;
1799 struct batadv_hashtable *hash = bat_priv->orig_hash;
1800 int last_seen_msecs, last_seen_secs;
1801 struct batadv_orig_node *orig_node;
1802 struct batadv_neigh_ifinfo *n_ifinfo;
1803 unsigned long last_seen_jiffies;
1804 struct hlist_head *head;
1805 int batman_count = 0;
1808 seq_printf(seq, " %-15s %s (%s/%i) %17s [%10s]: %20s ...\n",
1809 "Originator", "last-seen", "#", BATADV_TQ_MAX_VALUE,
1810 "Nexthop", "outgoingIF", "Potential nexthops");
1812 for (i = 0; i < hash->size; i++) {
1813 head = &hash->table[i];
1816 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
1817 neigh_node = batadv_orig_router_get(orig_node,
1822 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node,
1827 if (n_ifinfo->bat_iv.tq_avg == 0)
1830 last_seen_jiffies = jiffies - orig_node->last_seen;
1831 last_seen_msecs = jiffies_to_msecs(last_seen_jiffies);
1832 last_seen_secs = last_seen_msecs / 1000;
1833 last_seen_msecs = last_seen_msecs % 1000;
1835 seq_printf(seq, "%pM %4i.%03is (%3i) %pM [%10s]:",
1836 orig_node->orig, last_seen_secs,
1837 last_seen_msecs, n_ifinfo->bat_iv.tq_avg,
1839 neigh_node->if_incoming->net_dev->name);
1841 batadv_iv_ogm_orig_print_neigh(orig_node, if_outgoing,
1843 seq_puts(seq, "\n");
1847 batadv_neigh_node_free_ref(neigh_node);
1849 batadv_neigh_ifinfo_free_ref(n_ifinfo);
1854 if (batman_count == 0)
1855 seq_puts(seq, "No batman nodes in range ...\n");
1859 * batadv_iv_ogm_neigh_cmp - compare the metrics of two neighbors
1860 * @neigh1: the first neighbor object of the comparison
1861 * @if_outgoing1: outgoing interface for the first neighbor
1862 * @neigh2: the second neighbor object of the comparison
1863 * @if_outgoing2: outgoing interface for the second neighbor
1865 * Returns a value less, equal to or greater than 0 if the metric via neigh1 is
1866 * lower, the same as or higher than the metric via neigh2
1868 static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
1869 struct batadv_hard_iface *if_outgoing1,
1870 struct batadv_neigh_node *neigh2,
1871 struct batadv_hard_iface *if_outgoing2)
1873 struct batadv_neigh_ifinfo *neigh1_ifinfo, *neigh2_ifinfo;
1877 neigh1_ifinfo = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
1878 neigh2_ifinfo = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
1880 if (!neigh1_ifinfo || !neigh2_ifinfo) {
1885 tq1 = neigh1_ifinfo->bat_iv.tq_avg;
1886 tq2 = neigh2_ifinfo->bat_iv.tq_avg;
1891 batadv_neigh_ifinfo_free_ref(neigh1_ifinfo);
1893 batadv_neigh_ifinfo_free_ref(neigh2_ifinfo);
1899 * batadv_iv_ogm_neigh_is_eob - check if neigh1 is equally good or better than
1900 * neigh2 from the metric prospective
1901 * @neigh1: the first neighbor object of the comparison
1902 * @if_outgoing1: outgoing interface for the first neighbor
1903 * @neigh2: the second neighbor object of the comparison
1904 * @if_outgoing2: outgoing interface for the second neighbor
1906 * Returns true if the metric via neigh1 is equally good or better than
1907 * the metric via neigh2, false otherwise.
1910 batadv_iv_ogm_neigh_is_eob(struct batadv_neigh_node *neigh1,
1911 struct batadv_hard_iface *if_outgoing1,
1912 struct batadv_neigh_node *neigh2,
1913 struct batadv_hard_iface *if_outgoing2)
1915 struct batadv_neigh_ifinfo *neigh1_ifinfo, *neigh2_ifinfo;
1919 neigh1_ifinfo = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
1920 neigh2_ifinfo = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
1922 /* we can't say that the metric is better */
1923 if (!neigh1_ifinfo || !neigh2_ifinfo) {
1928 tq1 = neigh1_ifinfo->bat_iv.tq_avg;
1929 tq2 = neigh2_ifinfo->bat_iv.tq_avg;
1930 ret = (tq1 - tq2) > -BATADV_TQ_SIMILARITY_THRESHOLD;
1934 batadv_neigh_ifinfo_free_ref(neigh1_ifinfo);
1936 batadv_neigh_ifinfo_free_ref(neigh2_ifinfo);
1941 static struct batadv_algo_ops batadv_batman_iv __read_mostly = {
1942 .name = "BATMAN_IV",
1943 .bat_iface_enable = batadv_iv_ogm_iface_enable,
1944 .bat_iface_disable = batadv_iv_ogm_iface_disable,
1945 .bat_iface_update_mac = batadv_iv_ogm_iface_update_mac,
1946 .bat_primary_iface_set = batadv_iv_ogm_primary_iface_set,
1947 .bat_ogm_schedule = batadv_iv_ogm_schedule,
1948 .bat_ogm_emit = batadv_iv_ogm_emit,
1949 .bat_neigh_cmp = batadv_iv_ogm_neigh_cmp,
1950 .bat_neigh_is_equiv_or_better = batadv_iv_ogm_neigh_is_eob,
1951 .bat_orig_print = batadv_iv_ogm_orig_print,
1952 .bat_orig_free = batadv_iv_ogm_orig_free,
1953 .bat_orig_add_if = batadv_iv_ogm_orig_add_if,
1954 .bat_orig_del_if = batadv_iv_ogm_orig_del_if,
1957 int __init batadv_iv_init(void)
1961 /* batman originator packet */
1962 ret = batadv_recv_handler_register(BATADV_IV_OGM,
1963 batadv_iv_ogm_receive);
1967 ret = batadv_algo_register(&batadv_batman_iv);
1969 goto handler_unregister;
1974 batadv_recv_handler_unregister(BATADV_IV_OGM);