1 /* Copyright (C) 2007-2014 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"
31 * batadv_dup_status - duplicate status
32 * @BATADV_NO_DUP: the packet is a duplicate
33 * @BATADV_ORIG_DUP: OGM is a duplicate in the originator (but not for the
35 * @BATADV_NEIGH_DUP: OGM is a duplicate for the neighbor
36 * @BATADV_PROTECTED: originator is currently protected (after reboot)
38 enum batadv_dup_status {
46 * batadv_ring_buffer_set - update the ring buffer with the given value
47 * @lq_recv: pointer to the ring buffer
48 * @lq_index: index to store the value at
49 * @value: value to store in the ring buffer
51 static void batadv_ring_buffer_set(uint8_t lq_recv[], uint8_t *lq_index,
54 lq_recv[*lq_index] = value;
55 *lq_index = (*lq_index + 1) % BATADV_TQ_GLOBAL_WINDOW_SIZE;
59 * batadv_ring_buffer_set - compute the average of all non-zero values stored
60 * in the given ring buffer
61 * @lq_recv: pointer to the ring buffer
63 * Returns computed average value.
65 static uint8_t batadv_ring_buffer_avg(const uint8_t lq_recv[])
68 uint16_t count = 0, i = 0, sum = 0;
72 while (i < BATADV_TQ_GLOBAL_WINDOW_SIZE) {
85 return (uint8_t)(sum / count);
89 * batadv_iv_ogm_orig_free - free the private resources allocated for this
91 * @orig_node: the orig_node for which the resources have to be free'd
93 static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node)
95 kfree(orig_node->bat_iv.bcast_own);
96 kfree(orig_node->bat_iv.bcast_own_sum);
100 * batadv_iv_ogm_orig_add_if - change the private structures of the orig_node to
101 * include the new hard-interface
102 * @orig_node: the orig_node that has to be changed
103 * @max_if_num: the current amount of interfaces
105 * Returns 0 on success, a negative error code otherwise.
107 static int batadv_iv_ogm_orig_add_if(struct batadv_orig_node *orig_node,
111 size_t data_size, old_size;
114 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
116 data_size = max_if_num * sizeof(unsigned long) * BATADV_NUM_WORDS;
117 old_size = (max_if_num - 1) * sizeof(unsigned long) * BATADV_NUM_WORDS;
118 data_ptr = kmalloc(data_size, GFP_ATOMIC);
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(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(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(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;
313 /* randomize initial seqno to avoid collision */
314 get_random_bytes(&random_seqno, sizeof(random_seqno));
315 atomic_set(&hard_iface->bat_iv.ogm_seqno, random_seqno);
317 hard_iface->bat_iv.ogm_buff_len = BATADV_OGM_HLEN;
318 ogm_buff = kmalloc(hard_iface->bat_iv.ogm_buff_len, GFP_ATOMIC);
322 hard_iface->bat_iv.ogm_buff = ogm_buff;
324 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
325 batadv_ogm_packet->packet_type = BATADV_IV_OGM;
326 batadv_ogm_packet->version = BATADV_COMPAT_VERSION;
327 batadv_ogm_packet->ttl = 2;
328 batadv_ogm_packet->flags = BATADV_NO_FLAGS;
329 batadv_ogm_packet->reserved = 0;
330 batadv_ogm_packet->tq = BATADV_TQ_MAX_VALUE;
338 static void batadv_iv_ogm_iface_disable(struct batadv_hard_iface *hard_iface)
340 kfree(hard_iface->bat_iv.ogm_buff);
341 hard_iface->bat_iv.ogm_buff = NULL;
344 static void batadv_iv_ogm_iface_update_mac(struct batadv_hard_iface *hard_iface)
346 struct batadv_ogm_packet *batadv_ogm_packet;
347 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
349 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
350 memcpy(batadv_ogm_packet->orig,
351 hard_iface->net_dev->dev_addr, ETH_ALEN);
352 memcpy(batadv_ogm_packet->prev_sender,
353 hard_iface->net_dev->dev_addr, ETH_ALEN);
357 batadv_iv_ogm_primary_iface_set(struct batadv_hard_iface *hard_iface)
359 struct batadv_ogm_packet *batadv_ogm_packet;
360 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
362 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
363 batadv_ogm_packet->flags = BATADV_PRIMARIES_FIRST_HOP;
364 batadv_ogm_packet->ttl = BATADV_TTL;
367 /* when do we schedule our own ogm to be sent */
369 batadv_iv_ogm_emit_send_time(const struct batadv_priv *bat_priv)
373 msecs = atomic_read(&bat_priv->orig_interval) - BATADV_JITTER;
374 msecs += prandom_u32() % (2 * BATADV_JITTER);
376 return jiffies + msecs_to_jiffies(msecs);
379 /* when do we schedule a ogm packet to be sent */
380 static unsigned long batadv_iv_ogm_fwd_send_time(void)
382 return jiffies + msecs_to_jiffies(prandom_u32() % (BATADV_JITTER / 2));
385 /* apply hop penalty for a normal link */
386 static uint8_t batadv_hop_penalty(uint8_t tq,
387 const struct batadv_priv *bat_priv)
389 int hop_penalty = atomic_read(&bat_priv->hop_penalty);
392 new_tq = tq * (BATADV_TQ_MAX_VALUE - hop_penalty);
393 new_tq /= BATADV_TQ_MAX_VALUE;
398 /* is there another aggregated packet here? */
399 static int batadv_iv_ogm_aggr_packet(int buff_pos, int packet_len,
402 int next_buff_pos = 0;
404 next_buff_pos += buff_pos + BATADV_OGM_HLEN;
405 next_buff_pos += ntohs(tvlv_len);
407 return (next_buff_pos <= packet_len) &&
408 (next_buff_pos <= BATADV_MAX_AGGREGATION_BYTES);
411 /* send a batman ogm to a given interface */
412 static void batadv_iv_ogm_send_to_if(struct batadv_forw_packet *forw_packet,
413 struct batadv_hard_iface *hard_iface)
415 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
419 struct batadv_ogm_packet *batadv_ogm_packet;
423 if (hard_iface->if_status != BATADV_IF_ACTIVE)
428 packet_pos = forw_packet->skb->data;
429 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
431 /* adjust all flags and log packets */
432 while (batadv_iv_ogm_aggr_packet(buff_pos, forw_packet->packet_len,
433 batadv_ogm_packet->tvlv_len)) {
434 /* we might have aggregated direct link packets with an
435 * ordinary base packet
437 if (forw_packet->direct_link_flags & BIT(packet_num) &&
438 forw_packet->if_incoming == hard_iface)
439 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
441 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
443 if (packet_num > 0 || !forw_packet->own)
444 fwd_str = "Forwarding";
446 fwd_str = "Sending own";
448 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
449 "%s %spacket (originator %pM, seqno %u, TQ %d, TTL %d, IDF %s) on interface %s [%pM]\n",
450 fwd_str, (packet_num > 0 ? "aggregated " : ""),
451 batadv_ogm_packet->orig,
452 ntohl(batadv_ogm_packet->seqno),
453 batadv_ogm_packet->tq, batadv_ogm_packet->ttl,
454 (batadv_ogm_packet->flags & BATADV_DIRECTLINK ?
456 hard_iface->net_dev->name,
457 hard_iface->net_dev->dev_addr);
459 buff_pos += BATADV_OGM_HLEN;
460 buff_pos += ntohs(batadv_ogm_packet->tvlv_len);
462 packet_pos = forw_packet->skb->data + buff_pos;
463 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
466 /* create clone because function is called more than once */
467 skb = skb_clone(forw_packet->skb, GFP_ATOMIC);
469 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_TX);
470 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_TX_BYTES,
471 skb->len + ETH_HLEN);
472 batadv_send_skb_packet(skb, hard_iface, batadv_broadcast_addr);
476 /* send a batman ogm packet */
477 static void batadv_iv_ogm_emit(struct batadv_forw_packet *forw_packet)
479 struct net_device *soft_iface;
480 struct batadv_priv *bat_priv;
481 struct batadv_hard_iface *primary_if = NULL;
483 if (!forw_packet->if_incoming) {
484 pr_err("Error - can't forward packet: incoming iface not specified\n");
488 soft_iface = forw_packet->if_incoming->soft_iface;
489 bat_priv = netdev_priv(soft_iface);
491 if (WARN_ON(!forw_packet->if_outgoing))
494 if (WARN_ON(forw_packet->if_outgoing->soft_iface != soft_iface))
497 if (forw_packet->if_incoming->if_status != BATADV_IF_ACTIVE)
500 primary_if = batadv_primary_if_get_selected(bat_priv);
504 /* only for one specific outgoing interface */
505 batadv_iv_ogm_send_to_if(forw_packet, forw_packet->if_outgoing);
509 batadv_hardif_free_ref(primary_if);
513 * batadv_iv_ogm_can_aggregate - find out if an OGM can be aggregated on an
514 * existing forward packet
515 * @new_bat_ogm_packet: OGM packet to be aggregated
516 * @bat_priv: the bat priv with all the soft interface information
517 * @packet_len: (total) length of the OGM
518 * @send_time: timestamp (jiffies) when the packet is to be sent
519 * @direktlink: true if this is a direct link packet
520 * @if_incoming: interface where the packet was received
521 * @if_outgoing: interface for which the retransmission should be considered
522 * @forw_packet: the forwarded packet which should be checked
524 * Returns true if new_packet can be aggregated with forw_packet
527 batadv_iv_ogm_can_aggregate(const struct batadv_ogm_packet *new_bat_ogm_packet,
528 struct batadv_priv *bat_priv,
529 int packet_len, unsigned long send_time,
531 const struct batadv_hard_iface *if_incoming,
532 const struct batadv_hard_iface *if_outgoing,
533 const struct batadv_forw_packet *forw_packet)
535 struct batadv_ogm_packet *batadv_ogm_packet;
536 int aggregated_bytes = forw_packet->packet_len + packet_len;
537 struct batadv_hard_iface *primary_if = NULL;
539 unsigned long aggregation_end_time;
541 batadv_ogm_packet = (struct batadv_ogm_packet *)forw_packet->skb->data;
542 aggregation_end_time = send_time;
543 aggregation_end_time += msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
545 /* we can aggregate the current packet to this aggregated packet
548 * - the send time is within our MAX_AGGREGATION_MS time
549 * - the resulting packet wont be bigger than
550 * MAX_AGGREGATION_BYTES
552 if (time_before(send_time, forw_packet->send_time) &&
553 time_after_eq(aggregation_end_time, forw_packet->send_time) &&
554 (aggregated_bytes <= BATADV_MAX_AGGREGATION_BYTES)) {
555 /* check aggregation compatibility
556 * -> direct link packets are broadcasted on
557 * their interface only
558 * -> aggregate packet if the current packet is
559 * a "global" packet as well as the base
562 primary_if = batadv_primary_if_get_selected(bat_priv);
566 /* packet is not leaving on the same interface. */
567 if (forw_packet->if_outgoing != if_outgoing)
570 /* packets without direct link flag and high TTL
571 * are flooded through the net
574 (!(batadv_ogm_packet->flags & BATADV_DIRECTLINK)) &&
575 (batadv_ogm_packet->ttl != 1) &&
577 /* own packets originating non-primary
578 * interfaces leave only that interface
580 ((!forw_packet->own) ||
581 (forw_packet->if_incoming == primary_if))) {
586 /* if the incoming packet is sent via this one
587 * interface only - we still can aggregate
590 (new_bat_ogm_packet->ttl == 1) &&
591 (forw_packet->if_incoming == if_incoming) &&
593 /* packets from direct neighbors or
594 * own secondary interface packets
595 * (= secondary interface packets in general)
597 (batadv_ogm_packet->flags & BATADV_DIRECTLINK ||
599 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");
649 forw_packet_aggr = kmalloc(sizeof(*forw_packet_aggr), GFP_ATOMIC);
650 if (!forw_packet_aggr) {
652 atomic_inc(&bat_priv->batman_queue_left);
656 if ((atomic_read(&bat_priv->aggregated_ogms)) &&
657 (packet_len < BATADV_MAX_AGGREGATION_BYTES))
658 skb_size = BATADV_MAX_AGGREGATION_BYTES;
660 skb_size = packet_len;
662 skb_size += ETH_HLEN;
664 forw_packet_aggr->skb = netdev_alloc_skb_ip_align(NULL, skb_size);
665 if (!forw_packet_aggr->skb) {
667 atomic_inc(&bat_priv->batman_queue_left);
668 kfree(forw_packet_aggr);
671 forw_packet_aggr->skb->priority = TC_PRIO_CONTROL;
672 skb_reserve(forw_packet_aggr->skb, ETH_HLEN);
674 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
675 forw_packet_aggr->packet_len = packet_len;
676 memcpy(skb_buff, packet_buff, packet_len);
678 forw_packet_aggr->own = own_packet;
679 forw_packet_aggr->if_incoming = if_incoming;
680 forw_packet_aggr->if_outgoing = if_outgoing;
681 forw_packet_aggr->num_packets = 0;
682 forw_packet_aggr->direct_link_flags = BATADV_NO_FLAGS;
683 forw_packet_aggr->send_time = send_time;
685 /* save packet direct link flag status */
687 forw_packet_aggr->direct_link_flags |= 1;
689 /* add new packet to packet list */
690 spin_lock_bh(&bat_priv->forw_bat_list_lock);
691 hlist_add_head(&forw_packet_aggr->list, &bat_priv->forw_bat_list);
692 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
694 /* start timer for this packet */
695 INIT_DELAYED_WORK(&forw_packet_aggr->delayed_work,
696 batadv_send_outstanding_bat_ogm_packet);
697 queue_delayed_work(batadv_event_workqueue,
698 &forw_packet_aggr->delayed_work,
699 send_time - jiffies);
703 batadv_hardif_free_ref(if_outgoing);
705 batadv_hardif_free_ref(if_incoming);
708 /* aggregate a new packet into the existing ogm packet */
709 static void batadv_iv_ogm_aggregate(struct batadv_forw_packet *forw_packet_aggr,
710 const unsigned char *packet_buff,
711 int packet_len, bool direct_link)
713 unsigned char *skb_buff;
714 unsigned long new_direct_link_flag;
716 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
717 memcpy(skb_buff, packet_buff, packet_len);
718 forw_packet_aggr->packet_len += packet_len;
719 forw_packet_aggr->num_packets++;
721 /* save packet direct link flag status */
723 new_direct_link_flag = BIT(forw_packet_aggr->num_packets);
724 forw_packet_aggr->direct_link_flags |= new_direct_link_flag;
729 * batadv_iv_ogm_queue_add - queue up an OGM for transmission
730 * @bat_priv: the bat priv with all the soft interface information
731 * @packet_buff: pointer to the OGM
732 * @packet_len: (total) length of the OGM
733 * @if_incoming: interface where the packet was received
734 * @if_outgoing: interface for which the retransmission should be considered
735 * @own_packet: true if it is a self-generated ogm
736 * @send_time: timestamp (jiffies) when the packet is to be sent
738 static void batadv_iv_ogm_queue_add(struct batadv_priv *bat_priv,
739 unsigned char *packet_buff,
741 struct batadv_hard_iface *if_incoming,
742 struct batadv_hard_iface *if_outgoing,
743 int own_packet, unsigned long send_time)
745 /* _aggr -> pointer to the packet we want to aggregate with
746 * _pos -> pointer to the position in the queue
748 struct batadv_forw_packet *forw_packet_aggr = NULL;
749 struct batadv_forw_packet *forw_packet_pos = NULL;
750 struct batadv_ogm_packet *batadv_ogm_packet;
752 unsigned long max_aggregation_jiffies;
754 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_buff;
755 direct_link = batadv_ogm_packet->flags & BATADV_DIRECTLINK ? 1 : 0;
756 max_aggregation_jiffies = msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
758 /* find position for the packet in the forward queue */
759 spin_lock_bh(&bat_priv->forw_bat_list_lock);
760 /* own packets are not to be aggregated */
761 if ((atomic_read(&bat_priv->aggregated_ogms)) && (!own_packet)) {
762 hlist_for_each_entry(forw_packet_pos,
763 &bat_priv->forw_bat_list, list) {
764 if (batadv_iv_ogm_can_aggregate(batadv_ogm_packet,
765 bat_priv, packet_len,
766 send_time, direct_link,
770 forw_packet_aggr = forw_packet_pos;
776 /* nothing to aggregate with - either aggregation disabled or no
777 * suitable aggregation packet found
779 if (!forw_packet_aggr) {
780 /* the following section can run without the lock */
781 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
783 /* if we could not aggregate this packet with one of the others
784 * we hold it back for a while, so that it might be aggregated
787 if (!own_packet && atomic_read(&bat_priv->aggregated_ogms))
788 send_time += max_aggregation_jiffies;
790 batadv_iv_ogm_aggregate_new(packet_buff, packet_len,
791 send_time, direct_link,
792 if_incoming, if_outgoing,
795 batadv_iv_ogm_aggregate(forw_packet_aggr, packet_buff,
796 packet_len, direct_link);
797 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
801 static void batadv_iv_ogm_forward(struct batadv_orig_node *orig_node,
802 const struct ethhdr *ethhdr,
803 struct batadv_ogm_packet *batadv_ogm_packet,
804 bool is_single_hop_neigh,
805 bool is_from_best_next_hop,
806 struct batadv_hard_iface *if_incoming,
807 struct batadv_hard_iface *if_outgoing)
809 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
812 if (batadv_ogm_packet->ttl <= 1) {
813 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "ttl exceeded\n");
817 if (!is_from_best_next_hop) {
818 /* Mark the forwarded packet when it is not coming from our
819 * best next hop. We still need to forward the packet for our
820 * neighbor link quality detection to work in case the packet
821 * originated from a single hop neighbor. Otherwise we can
822 * simply drop the ogm.
824 if (is_single_hop_neigh)
825 batadv_ogm_packet->flags |= BATADV_NOT_BEST_NEXT_HOP;
830 tvlv_len = ntohs(batadv_ogm_packet->tvlv_len);
832 batadv_ogm_packet->ttl--;
833 memcpy(batadv_ogm_packet->prev_sender, ethhdr->h_source, ETH_ALEN);
835 /* apply hop penalty */
836 batadv_ogm_packet->tq = batadv_hop_penalty(batadv_ogm_packet->tq,
839 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
840 "Forwarding packet: tq: %i, ttl: %i\n",
841 batadv_ogm_packet->tq, batadv_ogm_packet->ttl);
843 /* switch of primaries first hop flag when forwarding */
844 batadv_ogm_packet->flags &= ~BATADV_PRIMARIES_FIRST_HOP;
845 if (is_single_hop_neigh)
846 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
848 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
850 batadv_iv_ogm_queue_add(bat_priv, (unsigned char *)batadv_ogm_packet,
851 BATADV_OGM_HLEN + tvlv_len,
852 if_incoming, if_outgoing, 0,
853 batadv_iv_ogm_fwd_send_time());
857 * batadv_iv_ogm_slide_own_bcast_window - bitshift own OGM broadcast windows for
858 * the given interface
859 * @hard_iface: the interface for which the windows have to be shifted
862 batadv_iv_ogm_slide_own_bcast_window(struct batadv_hard_iface *hard_iface)
864 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
865 struct batadv_hashtable *hash = bat_priv->orig_hash;
866 struct hlist_head *head;
867 struct batadv_orig_node *orig_node;
874 for (i = 0; i < hash->size; i++) {
875 head = &hash->table[i];
878 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
879 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
880 word_index = hard_iface->if_num * BATADV_NUM_WORDS;
881 word = &(orig_node->bat_iv.bcast_own[word_index]);
883 batadv_bit_get_packet(bat_priv, word, 1, 0);
884 if_num = hard_iface->if_num;
885 w = &orig_node->bat_iv.bcast_own_sum[if_num];
886 *w = bitmap_weight(word, BATADV_TQ_LOCAL_WINDOW_SIZE);
887 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
893 static void batadv_iv_ogm_schedule(struct batadv_hard_iface *hard_iface)
895 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
896 unsigned char **ogm_buff = &hard_iface->bat_iv.ogm_buff;
897 struct batadv_ogm_packet *batadv_ogm_packet;
898 struct batadv_hard_iface *primary_if, *tmp_hard_iface;
899 int *ogm_buff_len = &hard_iface->bat_iv.ogm_buff_len;
901 uint16_t tvlv_len = 0;
902 unsigned long send_time;
904 primary_if = batadv_primary_if_get_selected(bat_priv);
906 if (hard_iface == primary_if) {
907 /* tt changes have to be committed before the tvlv data is
908 * appended as it may alter the tt tvlv container
910 batadv_tt_local_commit_changes(bat_priv);
911 tvlv_len = batadv_tvlv_container_ogm_append(bat_priv, ogm_buff,
916 batadv_ogm_packet = (struct batadv_ogm_packet *)(*ogm_buff);
917 batadv_ogm_packet->tvlv_len = htons(tvlv_len);
919 /* change sequence number to network order */
920 seqno = (uint32_t)atomic_read(&hard_iface->bat_iv.ogm_seqno);
921 batadv_ogm_packet->seqno = htonl(seqno);
922 atomic_inc(&hard_iface->bat_iv.ogm_seqno);
924 batadv_iv_ogm_slide_own_bcast_window(hard_iface);
926 send_time = batadv_iv_ogm_emit_send_time(bat_priv);
928 if (hard_iface != primary_if) {
929 /* OGMs from secondary interfaces are only scheduled on their
930 * respective interfaces.
932 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff, *ogm_buff_len,
933 hard_iface, hard_iface, 1, send_time);
937 /* OGMs from primary interfaces are scheduled on all
941 list_for_each_entry_rcu(tmp_hard_iface, &batadv_hardif_list, list) {
942 if (tmp_hard_iface->soft_iface != hard_iface->soft_iface)
944 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff,
945 *ogm_buff_len, hard_iface,
946 tmp_hard_iface, 1, send_time);
952 batadv_hardif_free_ref(primary_if);
956 * batadv_iv_ogm_orig_update - use OGM to update corresponding data in an
958 * @bat_priv: the bat priv with all the soft interface information
959 * @orig_node: the orig node who originally emitted the ogm packet
960 * @orig_ifinfo: ifinfo for the outgoing interface of the orig_node
961 * @ethhdr: Ethernet header of the OGM
962 * @batadv_ogm_packet: the ogm packet
963 * @if_incoming: interface where the packet was received
964 * @if_outgoing: interface for which the retransmission should be considered
965 * @dup_status: the duplicate status of this ogm packet.
968 batadv_iv_ogm_orig_update(struct batadv_priv *bat_priv,
969 struct batadv_orig_node *orig_node,
970 struct batadv_orig_ifinfo *orig_ifinfo,
971 const struct ethhdr *ethhdr,
972 const struct batadv_ogm_packet *batadv_ogm_packet,
973 struct batadv_hard_iface *if_incoming,
974 struct batadv_hard_iface *if_outgoing,
975 enum batadv_dup_status dup_status)
977 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL;
978 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
979 struct batadv_neigh_node *neigh_node = NULL, *tmp_neigh_node = NULL;
980 struct batadv_neigh_node *router = NULL;
981 struct batadv_orig_node *orig_node_tmp;
983 uint8_t sum_orig, sum_neigh;
987 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
988 "update_originator(): Searching and updating originator entry of received packet\n");
991 hlist_for_each_entry_rcu(tmp_neigh_node,
992 &orig_node->neigh_list, list) {
993 neigh_addr = tmp_neigh_node->addr;
994 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
995 tmp_neigh_node->if_incoming == if_incoming &&
996 atomic_inc_not_zero(&tmp_neigh_node->refcount)) {
997 if (WARN(neigh_node, "too many matching neigh_nodes"))
998 batadv_neigh_node_free_ref(neigh_node);
999 neigh_node = tmp_neigh_node;
1003 if (dup_status != BATADV_NO_DUP)
1006 /* only update the entry for this outgoing interface */
1007 neigh_ifinfo = batadv_neigh_ifinfo_get(tmp_neigh_node,
1012 spin_lock_bh(&tmp_neigh_node->ifinfo_lock);
1013 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1014 &neigh_ifinfo->bat_iv.tq_index, 0);
1015 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1016 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1017 spin_unlock_bh(&tmp_neigh_node->ifinfo_lock);
1019 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1020 neigh_ifinfo = NULL;
1024 struct batadv_orig_node *orig_tmp;
1026 orig_tmp = batadv_iv_ogm_orig_get(bat_priv, ethhdr->h_source);
1030 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1032 orig_node, orig_tmp);
1034 batadv_orig_node_free_ref(orig_tmp);
1038 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1039 "Updating existing last-hop neighbor of originator\n");
1042 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1046 neigh_node->last_seen = jiffies;
1048 spin_lock_bh(&neigh_node->ifinfo_lock);
1049 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1050 &neigh_ifinfo->bat_iv.tq_index,
1051 batadv_ogm_packet->tq);
1052 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1053 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1054 spin_unlock_bh(&neigh_node->ifinfo_lock);
1056 if (dup_status == BATADV_NO_DUP) {
1057 orig_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1058 neigh_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1061 /* if this neighbor already is our next hop there is nothing
1064 router = batadv_orig_router_get(orig_node, if_outgoing);
1065 if (router == neigh_node)
1069 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1073 /* if this neighbor does not offer a better TQ we won't
1076 if (router_ifinfo->bat_iv.tq_avg > neigh_ifinfo->bat_iv.tq_avg)
1080 /* if the TQ is the same and the link not more symmetric we
1081 * won't consider it either
1083 if (router_ifinfo &&
1084 (neigh_ifinfo->bat_iv.tq_avg == router_ifinfo->bat_iv.tq_avg)) {
1085 orig_node_tmp = router->orig_node;
1086 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1087 if_num = router->if_incoming->if_num;
1088 sum_orig = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1089 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1091 orig_node_tmp = neigh_node->orig_node;
1092 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1093 if_num = neigh_node->if_incoming->if_num;
1094 sum_neigh = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1095 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1097 if (sum_orig >= sum_neigh)
1101 batadv_update_route(bat_priv, orig_node, if_outgoing, neigh_node);
1108 batadv_neigh_node_free_ref(neigh_node);
1110 batadv_neigh_node_free_ref(router);
1112 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1114 batadv_neigh_ifinfo_free_ref(router_ifinfo);
1118 * batadv_iv_ogm_calc_tq - calculate tq for current received ogm packet
1119 * @orig_node: the orig node who originally emitted the ogm packet
1120 * @orig_neigh_node: the orig node struct of the neighbor who sent the packet
1121 * @batadv_ogm_packet: the ogm packet
1122 * @if_incoming: interface where the packet was received
1123 * @if_outgoing: interface for which the retransmission should be considered
1125 * Returns 1 if the link can be considered bidirectional, 0 otherwise
1127 static int batadv_iv_ogm_calc_tq(struct batadv_orig_node *orig_node,
1128 struct batadv_orig_node *orig_neigh_node,
1129 struct batadv_ogm_packet *batadv_ogm_packet,
1130 struct batadv_hard_iface *if_incoming,
1131 struct batadv_hard_iface *if_outgoing)
1133 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1134 struct batadv_neigh_node *neigh_node = NULL, *tmp_neigh_node;
1135 struct batadv_neigh_ifinfo *neigh_ifinfo;
1136 uint8_t total_count;
1137 uint8_t orig_eq_count, neigh_rq_count, neigh_rq_inv, tq_own;
1138 unsigned int neigh_rq_inv_cube, neigh_rq_max_cube;
1139 int tq_asym_penalty, inv_asym_penalty, if_num, ret = 0;
1140 unsigned int combined_tq;
1141 int tq_iface_penalty;
1143 /* find corresponding one hop neighbor */
1145 hlist_for_each_entry_rcu(tmp_neigh_node,
1146 &orig_neigh_node->neigh_list, list) {
1147 if (!batadv_compare_eth(tmp_neigh_node->addr,
1148 orig_neigh_node->orig))
1151 if (tmp_neigh_node->if_incoming != if_incoming)
1154 if (!atomic_inc_not_zero(&tmp_neigh_node->refcount))
1157 neigh_node = tmp_neigh_node;
1163 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1164 orig_neigh_node->orig,
1171 /* if orig_node is direct neighbor update neigh_node last_seen */
1172 if (orig_node == orig_neigh_node)
1173 neigh_node->last_seen = jiffies;
1175 orig_node->last_seen = jiffies;
1177 /* find packet count of corresponding one hop neighbor */
1178 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1179 if_num = if_incoming->if_num;
1180 orig_eq_count = orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1181 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1183 neigh_rq_count = neigh_ifinfo->bat_iv.real_packet_count;
1184 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1188 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1190 /* pay attention to not get a value bigger than 100 % */
1191 if (orig_eq_count > neigh_rq_count)
1192 total_count = neigh_rq_count;
1194 total_count = orig_eq_count;
1196 /* if we have too few packets (too less data) we set tq_own to zero
1197 * if we receive too few packets it is not considered bidirectional
1199 if (total_count < BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM ||
1200 neigh_rq_count < BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM)
1203 /* neigh_node->real_packet_count is never zero as we
1204 * only purge old information when getting new
1207 tq_own = (BATADV_TQ_MAX_VALUE * total_count) / neigh_rq_count;
1209 /* 1 - ((1-x) ** 3), normalized to TQ_MAX_VALUE this does
1210 * affect the nearly-symmetric links only a little, but
1211 * punishes asymmetric links more. This will give a value
1212 * between 0 and TQ_MAX_VALUE
1214 neigh_rq_inv = BATADV_TQ_LOCAL_WINDOW_SIZE - neigh_rq_count;
1215 neigh_rq_inv_cube = neigh_rq_inv * neigh_rq_inv * neigh_rq_inv;
1216 neigh_rq_max_cube = BATADV_TQ_LOCAL_WINDOW_SIZE *
1217 BATADV_TQ_LOCAL_WINDOW_SIZE *
1218 BATADV_TQ_LOCAL_WINDOW_SIZE;
1219 inv_asym_penalty = BATADV_TQ_MAX_VALUE * neigh_rq_inv_cube;
1220 inv_asym_penalty /= neigh_rq_max_cube;
1221 tq_asym_penalty = BATADV_TQ_MAX_VALUE - inv_asym_penalty;
1223 /* penalize if the OGM is forwarded on the same interface. WiFi
1224 * interfaces and other half duplex devices suffer from throughput
1225 * drops as they can't send and receive at the same time.
1227 tq_iface_penalty = BATADV_TQ_MAX_VALUE;
1228 if (if_outgoing && (if_incoming == if_outgoing) &&
1229 batadv_is_wifi_netdev(if_outgoing->net_dev))
1230 tq_iface_penalty = batadv_hop_penalty(BATADV_TQ_MAX_VALUE,
1233 combined_tq = batadv_ogm_packet->tq *
1237 combined_tq /= BATADV_TQ_MAX_VALUE *
1238 BATADV_TQ_MAX_VALUE *
1239 BATADV_TQ_MAX_VALUE;
1240 batadv_ogm_packet->tq = combined_tq;
1242 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1243 "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",
1244 orig_node->orig, orig_neigh_node->orig, total_count,
1245 neigh_rq_count, tq_own, tq_asym_penalty, tq_iface_penalty,
1246 batadv_ogm_packet->tq, if_incoming->net_dev->name,
1247 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT");
1249 /* if link has the minimum required transmission quality
1250 * consider it bidirectional
1252 if (batadv_ogm_packet->tq >= BATADV_TQ_TOTAL_BIDRECT_LIMIT)
1257 batadv_neigh_node_free_ref(neigh_node);
1262 * batadv_iv_ogm_update_seqnos - process a batman packet for all interfaces,
1263 * adjust the sequence number and find out whether it is a duplicate
1264 * @ethhdr: ethernet header of the packet
1265 * @batadv_ogm_packet: OGM packet to be considered
1266 * @if_incoming: interface on which the OGM packet was received
1267 * @if_outgoing: interface for which the retransmission should be considered
1269 * Returns duplicate status as enum batadv_dup_status
1271 static enum batadv_dup_status
1272 batadv_iv_ogm_update_seqnos(const struct ethhdr *ethhdr,
1273 const struct batadv_ogm_packet *batadv_ogm_packet,
1274 const struct batadv_hard_iface *if_incoming,
1275 struct batadv_hard_iface *if_outgoing)
1277 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1278 struct batadv_orig_node *orig_node;
1279 struct batadv_orig_ifinfo *orig_ifinfo = NULL;
1280 struct batadv_neigh_node *neigh_node;
1281 struct batadv_neigh_ifinfo *neigh_ifinfo;
1284 int need_update = 0;
1286 enum batadv_dup_status ret = BATADV_NO_DUP;
1287 uint32_t seqno = ntohl(batadv_ogm_packet->seqno);
1288 uint8_t *neigh_addr;
1289 uint8_t packet_count;
1290 unsigned long *bitmap;
1292 orig_node = batadv_iv_ogm_orig_get(bat_priv, batadv_ogm_packet->orig);
1294 return BATADV_NO_DUP;
1296 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1297 if (WARN_ON(!orig_ifinfo)) {
1298 batadv_orig_node_free_ref(orig_node);
1302 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1303 seq_diff = seqno - orig_ifinfo->last_real_seqno;
1305 /* signalize caller that the packet is to be dropped. */
1306 if (!hlist_empty(&orig_node->neigh_list) &&
1307 batadv_window_protected(bat_priv, seq_diff,
1308 &orig_ifinfo->batman_seqno_reset)) {
1309 ret = BATADV_PROTECTED;
1314 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1315 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node,
1320 neigh_addr = neigh_node->addr;
1321 is_dup = batadv_test_bit(neigh_ifinfo->bat_iv.real_bits,
1322 orig_ifinfo->last_real_seqno,
1325 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1326 neigh_node->if_incoming == if_incoming) {
1329 ret = BATADV_NEIGH_DUP;
1332 if (is_dup && (ret != BATADV_NEIGH_DUP))
1333 ret = BATADV_ORIG_DUP;
1336 /* if the window moved, set the update flag. */
1337 bitmap = neigh_ifinfo->bat_iv.real_bits;
1338 need_update |= batadv_bit_get_packet(bat_priv, bitmap,
1339 seq_diff, set_mark);
1341 packet_count = bitmap_weight(bitmap,
1342 BATADV_TQ_LOCAL_WINDOW_SIZE);
1343 neigh_ifinfo->bat_iv.real_packet_count = packet_count;
1344 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1349 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1350 "%s updating last_seqno: old %u, new %u\n",
1351 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT",
1352 orig_ifinfo->last_real_seqno, seqno);
1353 orig_ifinfo->last_real_seqno = seqno;
1357 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1358 batadv_orig_node_free_ref(orig_node);
1360 batadv_orig_ifinfo_free_ref(orig_ifinfo);
1366 * batadv_iv_ogm_process_per_outif - process a batman iv OGM for an outgoing if
1367 * @skb: the skb containing the OGM
1368 * @orig_node: the (cached) orig node for the originator of this OGM
1369 * @if_incoming: the interface where this packet was received
1370 * @if_outgoing: the interface for which the packet should be considered
1373 batadv_iv_ogm_process_per_outif(const struct sk_buff *skb, int ogm_offset,
1374 struct batadv_orig_node *orig_node,
1375 struct batadv_hard_iface *if_incoming,
1376 struct batadv_hard_iface *if_outgoing)
1378 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1379 struct batadv_neigh_node *router = NULL, *router_router = NULL;
1380 struct batadv_orig_node *orig_neigh_node;
1381 struct batadv_orig_ifinfo *orig_ifinfo;
1382 struct batadv_neigh_node *orig_neigh_router = NULL;
1383 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
1384 struct batadv_ogm_packet *ogm_packet;
1385 enum batadv_dup_status dup_status;
1386 bool is_from_best_next_hop = false;
1387 bool is_single_hop_neigh = false;
1388 bool sameseq, similar_ttl;
1389 struct sk_buff *skb_priv;
1390 struct ethhdr *ethhdr;
1391 uint8_t *prev_sender;
1394 /* create a private copy of the skb, as some functions change tq value
1397 skb_priv = skb_copy(skb, GFP_ATOMIC);
1401 ethhdr = eth_hdr(skb_priv);
1402 ogm_packet = (struct batadv_ogm_packet *)(skb_priv->data + ogm_offset);
1404 dup_status = batadv_iv_ogm_update_seqnos(ethhdr, ogm_packet,
1405 if_incoming, if_outgoing);
1406 if (batadv_compare_eth(ethhdr->h_source, ogm_packet->orig))
1407 is_single_hop_neigh = true;
1409 if (dup_status == BATADV_PROTECTED) {
1410 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1411 "Drop packet: packet within seqno protection time (sender: %pM)\n",
1416 if (ogm_packet->tq == 0) {
1417 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1418 "Drop packet: originator packet with tq equal 0\n");
1422 router = batadv_orig_router_get(orig_node, if_outgoing);
1424 router_router = batadv_orig_router_get(router->orig_node,
1426 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1429 if ((router_ifinfo && router_ifinfo->bat_iv.tq_avg != 0) &&
1430 (batadv_compare_eth(router->addr, ethhdr->h_source)))
1431 is_from_best_next_hop = true;
1433 prev_sender = ogm_packet->prev_sender;
1434 /* avoid temporary routing loops */
1435 if (router && router_router &&
1436 (batadv_compare_eth(router->addr, prev_sender)) &&
1437 !(batadv_compare_eth(ogm_packet->orig, prev_sender)) &&
1438 (batadv_compare_eth(router->addr, router_router->addr))) {
1439 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1440 "Drop packet: ignoring all rebroadcast packets that may make me loop (sender: %pM)\n",
1445 if (if_outgoing == BATADV_IF_DEFAULT)
1446 batadv_tvlv_ogm_receive(bat_priv, ogm_packet, orig_node);
1448 /* if sender is a direct neighbor the sender mac equals
1451 if (is_single_hop_neigh)
1452 orig_neigh_node = orig_node;
1454 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1457 if (!orig_neigh_node)
1460 /* Update nc_nodes of the originator */
1461 batadv_nc_update_nc_node(bat_priv, orig_node, orig_neigh_node,
1462 ogm_packet, is_single_hop_neigh);
1464 orig_neigh_router = batadv_orig_router_get(orig_neigh_node,
1467 /* drop packet if sender is not a direct neighbor and if we
1468 * don't route towards it
1470 if (!is_single_hop_neigh && (!orig_neigh_router)) {
1471 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1472 "Drop packet: OGM via unknown neighbor!\n");
1476 is_bidirect = batadv_iv_ogm_calc_tq(orig_node, orig_neigh_node,
1477 ogm_packet, if_incoming,
1480 /* update ranking if it is not a duplicate or has the same
1481 * seqno and similar ttl as the non-duplicate
1483 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1487 sameseq = orig_ifinfo->last_real_seqno == ntohl(ogm_packet->seqno);
1488 similar_ttl = (orig_ifinfo->last_ttl - 3) <= ogm_packet->ttl;
1490 if (is_bidirect && ((dup_status == BATADV_NO_DUP) ||
1491 (sameseq && similar_ttl))) {
1492 batadv_iv_ogm_orig_update(bat_priv, orig_node,
1493 orig_ifinfo, ethhdr,
1494 ogm_packet, if_incoming,
1495 if_outgoing, dup_status);
1497 batadv_orig_ifinfo_free_ref(orig_ifinfo);
1499 /* only forward for specific interface, not for the default one. */
1500 if (if_outgoing == BATADV_IF_DEFAULT)
1503 /* is single hop (direct) neighbor */
1504 if (is_single_hop_neigh) {
1505 /* OGMs from secondary interfaces should only scheduled once
1506 * per interface where it has been received, not multiple times
1508 if ((ogm_packet->ttl <= 2) &&
1509 (if_incoming != if_outgoing)) {
1510 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1511 "Drop packet: OGM from secondary interface and wrong outgoing interface\n");
1514 /* mark direct link on incoming interface */
1515 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1516 is_single_hop_neigh,
1517 is_from_best_next_hop, if_incoming,
1520 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1521 "Forwarding packet: rebroadcast neighbor packet with direct link flag\n");
1525 /* multihop originator */
1527 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1528 "Drop packet: not received via bidirectional link\n");
1532 if (dup_status == BATADV_NEIGH_DUP) {
1533 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1534 "Drop packet: duplicate packet received\n");
1538 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1539 "Forwarding packet: rebroadcast originator packet\n");
1540 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1541 is_single_hop_neigh, is_from_best_next_hop,
1542 if_incoming, if_outgoing);
1545 if ((orig_neigh_node) && (!is_single_hop_neigh))
1546 batadv_orig_node_free_ref(orig_neigh_node);
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_outgoing: 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);