1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) B.A.T.M.A.N. contributors:
10 #include <linux/atomic.h>
11 #include <linux/byteorder/generic.h>
12 #include <linux/container_of.h>
13 #include <linux/errno.h>
14 #include <linux/etherdevice.h>
15 #include <linux/gfp.h>
16 #include <linux/if_ether.h>
17 #include <linux/jiffies.h>
18 #include <linux/kref.h>
19 #include <linux/list.h>
20 #include <linux/lockdep.h>
21 #include <linux/minmax.h>
22 #include <linux/mutex.h>
23 #include <linux/netdevice.h>
24 #include <linux/random.h>
25 #include <linux/rculist.h>
26 #include <linux/rcupdate.h>
27 #include <linux/skbuff.h>
28 #include <linux/slab.h>
29 #include <linux/spinlock.h>
30 #include <linux/stddef.h>
31 #include <linux/string.h>
32 #include <linux/types.h>
33 #include <linux/workqueue.h>
34 #include <uapi/linux/batadv_packet.h>
37 #include "hard-interface.h"
40 #include "originator.h"
43 #include "translation-table.h"
47 * batadv_v_ogm_orig_get() - retrieve and possibly create an originator node
48 * @bat_priv: the bat priv with all the soft interface information
49 * @addr: the address of the originator
51 * Return: the orig_node corresponding to the specified address. If such an
52 * object does not exist, it is allocated here. In case of allocation failure
55 struct batadv_orig_node *batadv_v_ogm_orig_get(struct batadv_priv *bat_priv,
58 struct batadv_orig_node *orig_node;
61 orig_node = batadv_orig_hash_find(bat_priv, addr);
65 orig_node = batadv_orig_node_new(bat_priv, addr);
69 kref_get(&orig_node->refcount);
70 hash_added = batadv_hash_add(bat_priv->orig_hash, batadv_compare_orig,
71 batadv_choose_orig, orig_node,
72 &orig_node->hash_entry);
73 if (hash_added != 0) {
74 /* remove refcnt for newly created orig_node and hash entry */
75 batadv_orig_node_put(orig_node);
76 batadv_orig_node_put(orig_node);
84 * batadv_v_ogm_start_queue_timer() - restart the OGM aggregation timer
85 * @hard_iface: the interface to use to send the OGM
87 static void batadv_v_ogm_start_queue_timer(struct batadv_hard_iface *hard_iface)
89 unsigned int msecs = BATADV_MAX_AGGREGATION_MS * 1000;
91 /* msecs * [0.9, 1.1] */
92 msecs += get_random_u32_below(msecs / 5) - (msecs / 10);
93 queue_delayed_work(batadv_event_workqueue, &hard_iface->bat_v.aggr_wq,
94 msecs_to_jiffies(msecs / 1000));
98 * batadv_v_ogm_start_timer() - restart the OGM sending timer
99 * @bat_priv: the bat priv with all the soft interface information
101 static void batadv_v_ogm_start_timer(struct batadv_priv *bat_priv)
104 /* this function may be invoked in different contexts (ogm rescheduling
105 * or hard_iface activation), but the work timer should not be reset
107 if (delayed_work_pending(&bat_priv->bat_v.ogm_wq))
110 msecs = atomic_read(&bat_priv->orig_interval) - BATADV_JITTER;
111 msecs += get_random_u32_below(2 * BATADV_JITTER);
112 queue_delayed_work(batadv_event_workqueue, &bat_priv->bat_v.ogm_wq,
113 msecs_to_jiffies(msecs));
117 * batadv_v_ogm_send_to_if() - send a batman ogm using a given interface
118 * @skb: the OGM to send
119 * @hard_iface: the interface to use to send the OGM
121 static void batadv_v_ogm_send_to_if(struct sk_buff *skb,
122 struct batadv_hard_iface *hard_iface)
124 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
126 if (hard_iface->if_status != BATADV_IF_ACTIVE)
129 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_TX);
130 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_TX_BYTES,
131 skb->len + ETH_HLEN);
133 batadv_send_broadcast_skb(skb, hard_iface);
137 * batadv_v_ogm_len() - OGMv2 packet length
138 * @skb: the OGM to check
140 * Return: Length of the given OGMv2 packet, including tvlv length, excluding
141 * ethernet header length.
143 static unsigned int batadv_v_ogm_len(struct sk_buff *skb)
145 struct batadv_ogm2_packet *ogm_packet;
147 ogm_packet = (struct batadv_ogm2_packet *)skb->data;
148 return BATADV_OGM2_HLEN + ntohs(ogm_packet->tvlv_len);
152 * batadv_v_ogm_queue_left() - check if given OGM still fits aggregation queue
153 * @skb: the OGM to check
154 * @hard_iface: the interface to use to send the OGM
156 * Caller needs to hold the hard_iface->bat_v.aggr_list.lock.
158 * Return: True, if the given OGMv2 packet still fits, false otherwise.
160 static bool batadv_v_ogm_queue_left(struct sk_buff *skb,
161 struct batadv_hard_iface *hard_iface)
163 unsigned int max = min_t(unsigned int, hard_iface->net_dev->mtu,
164 BATADV_MAX_AGGREGATION_BYTES);
165 unsigned int ogm_len = batadv_v_ogm_len(skb);
167 lockdep_assert_held(&hard_iface->bat_v.aggr_list.lock);
169 return hard_iface->bat_v.aggr_len + ogm_len <= max;
173 * batadv_v_ogm_aggr_list_free - free all elements in an aggregation queue
174 * @hard_iface: the interface holding the aggregation queue
176 * Empties the OGMv2 aggregation queue and frees all the skbs it contains.
178 * Caller needs to hold the hard_iface->bat_v.aggr_list.lock.
180 static void batadv_v_ogm_aggr_list_free(struct batadv_hard_iface *hard_iface)
182 lockdep_assert_held(&hard_iface->bat_v.aggr_list.lock);
184 __skb_queue_purge(&hard_iface->bat_v.aggr_list);
185 hard_iface->bat_v.aggr_len = 0;
189 * batadv_v_ogm_aggr_send() - flush & send aggregation queue
190 * @hard_iface: the interface with the aggregation queue to flush
192 * Aggregates all OGMv2 packets currently in the aggregation queue into a
193 * single OGMv2 packet and transmits this aggregate.
195 * The aggregation queue is empty after this call.
197 * Caller needs to hold the hard_iface->bat_v.aggr_list.lock.
199 static void batadv_v_ogm_aggr_send(struct batadv_hard_iface *hard_iface)
201 unsigned int aggr_len = hard_iface->bat_v.aggr_len;
202 struct sk_buff *skb_aggr;
203 unsigned int ogm_len;
206 lockdep_assert_held(&hard_iface->bat_v.aggr_list.lock);
211 skb_aggr = dev_alloc_skb(aggr_len + ETH_HLEN + NET_IP_ALIGN);
213 batadv_v_ogm_aggr_list_free(hard_iface);
217 skb_reserve(skb_aggr, ETH_HLEN + NET_IP_ALIGN);
218 skb_reset_network_header(skb_aggr);
220 while ((skb = __skb_dequeue(&hard_iface->bat_v.aggr_list))) {
221 hard_iface->bat_v.aggr_len -= batadv_v_ogm_len(skb);
223 ogm_len = batadv_v_ogm_len(skb);
224 skb_put_data(skb_aggr, skb->data, ogm_len);
229 batadv_v_ogm_send_to_if(skb_aggr, hard_iface);
233 * batadv_v_ogm_queue_on_if() - queue a batman ogm on a given interface
234 * @skb: the OGM to queue
235 * @hard_iface: the interface to queue the OGM on
237 static void batadv_v_ogm_queue_on_if(struct sk_buff *skb,
238 struct batadv_hard_iface *hard_iface)
240 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
242 if (!atomic_read(&bat_priv->aggregated_ogms)) {
243 batadv_v_ogm_send_to_if(skb, hard_iface);
247 spin_lock_bh(&hard_iface->bat_v.aggr_list.lock);
248 if (!batadv_v_ogm_queue_left(skb, hard_iface))
249 batadv_v_ogm_aggr_send(hard_iface);
251 hard_iface->bat_v.aggr_len += batadv_v_ogm_len(skb);
252 __skb_queue_tail(&hard_iface->bat_v.aggr_list, skb);
253 spin_unlock_bh(&hard_iface->bat_v.aggr_list.lock);
257 * batadv_v_ogm_send_softif() - periodic worker broadcasting the own OGM
258 * @bat_priv: the bat priv with all the soft interface information
260 static void batadv_v_ogm_send_softif(struct batadv_priv *bat_priv)
262 struct batadv_hard_iface *hard_iface;
263 struct batadv_ogm2_packet *ogm_packet;
264 struct sk_buff *skb, *skb_tmp;
265 unsigned char *ogm_buff;
270 lockdep_assert_held(&bat_priv->bat_v.ogm_buff_mutex);
272 if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_DEACTIVATING)
275 ogm_buff = bat_priv->bat_v.ogm_buff;
276 ogm_buff_len = bat_priv->bat_v.ogm_buff_len;
277 /* tt changes have to be committed before the tvlv data is
278 * appended as it may alter the tt tvlv container
280 batadv_tt_local_commit_changes(bat_priv);
281 tvlv_len = batadv_tvlv_container_ogm_append(bat_priv, &ogm_buff,
285 bat_priv->bat_v.ogm_buff = ogm_buff;
286 bat_priv->bat_v.ogm_buff_len = ogm_buff_len;
288 skb = netdev_alloc_skb_ip_align(NULL, ETH_HLEN + ogm_buff_len);
292 skb_reserve(skb, ETH_HLEN);
293 skb_put_data(skb, ogm_buff, ogm_buff_len);
295 ogm_packet = (struct batadv_ogm2_packet *)skb->data;
296 ogm_packet->seqno = htonl(atomic_read(&bat_priv->bat_v.ogm_seqno));
297 atomic_inc(&bat_priv->bat_v.ogm_seqno);
298 ogm_packet->tvlv_len = htons(tvlv_len);
300 /* broadcast on every interface */
302 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
303 if (hard_iface->soft_iface != bat_priv->soft_iface)
306 if (!kref_get_unless_zero(&hard_iface->refcount))
309 ret = batadv_hardif_no_broadcast(hard_iface, NULL, NULL);
314 case BATADV_HARDIF_BCAST_NORECIPIENT:
315 type = "no neighbor";
317 case BATADV_HARDIF_BCAST_DUPFWD:
318 type = "single neighbor is source";
320 case BATADV_HARDIF_BCAST_DUPORIG:
321 type = "single neighbor is originator";
327 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "OGM2 from ourselves on %s suppressed: %s\n",
328 hard_iface->net_dev->name, type);
330 batadv_hardif_put(hard_iface);
334 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
335 "Sending own OGM2 packet (originator %pM, seqno %u, throughput %u, TTL %d) on interface %s [%pM]\n",
336 ogm_packet->orig, ntohl(ogm_packet->seqno),
337 ntohl(ogm_packet->throughput), ogm_packet->ttl,
338 hard_iface->net_dev->name,
339 hard_iface->net_dev->dev_addr);
341 /* this skb gets consumed by batadv_v_ogm_send_to_if() */
342 skb_tmp = skb_clone(skb, GFP_ATOMIC);
344 batadv_hardif_put(hard_iface);
348 batadv_v_ogm_queue_on_if(skb_tmp, hard_iface);
349 batadv_hardif_put(hard_iface);
356 batadv_v_ogm_start_timer(bat_priv);
362 * batadv_v_ogm_send() - periodic worker broadcasting the own OGM
363 * @work: work queue item
365 static void batadv_v_ogm_send(struct work_struct *work)
367 struct batadv_priv_bat_v *bat_v;
368 struct batadv_priv *bat_priv;
370 bat_v = container_of(work, struct batadv_priv_bat_v, ogm_wq.work);
371 bat_priv = container_of(bat_v, struct batadv_priv, bat_v);
373 mutex_lock(&bat_priv->bat_v.ogm_buff_mutex);
374 batadv_v_ogm_send_softif(bat_priv);
375 mutex_unlock(&bat_priv->bat_v.ogm_buff_mutex);
379 * batadv_v_ogm_aggr_work() - OGM queue periodic task per interface
380 * @work: work queue item
382 * Emits aggregated OGM messages in regular intervals.
384 void batadv_v_ogm_aggr_work(struct work_struct *work)
386 struct batadv_hard_iface_bat_v *batv;
387 struct batadv_hard_iface *hard_iface;
389 batv = container_of(work, struct batadv_hard_iface_bat_v, aggr_wq.work);
390 hard_iface = container_of(batv, struct batadv_hard_iface, bat_v);
392 spin_lock_bh(&hard_iface->bat_v.aggr_list.lock);
393 batadv_v_ogm_aggr_send(hard_iface);
394 spin_unlock_bh(&hard_iface->bat_v.aggr_list.lock);
396 batadv_v_ogm_start_queue_timer(hard_iface);
400 * batadv_v_ogm_iface_enable() - prepare an interface for B.A.T.M.A.N. V
401 * @hard_iface: the interface to prepare
403 * Takes care of scheduling its own OGM sending routine for this interface.
405 * Return: 0 on success or a negative error code otherwise
407 int batadv_v_ogm_iface_enable(struct batadv_hard_iface *hard_iface)
409 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
411 batadv_v_ogm_start_queue_timer(hard_iface);
412 batadv_v_ogm_start_timer(bat_priv);
418 * batadv_v_ogm_iface_disable() - release OGM interface private resources
419 * @hard_iface: interface for which the resources have to be released
421 void batadv_v_ogm_iface_disable(struct batadv_hard_iface *hard_iface)
423 cancel_delayed_work_sync(&hard_iface->bat_v.aggr_wq);
425 spin_lock_bh(&hard_iface->bat_v.aggr_list.lock);
426 batadv_v_ogm_aggr_list_free(hard_iface);
427 spin_unlock_bh(&hard_iface->bat_v.aggr_list.lock);
431 * batadv_v_ogm_primary_iface_set() - set a new primary interface
432 * @primary_iface: the new primary interface
434 void batadv_v_ogm_primary_iface_set(struct batadv_hard_iface *primary_iface)
436 struct batadv_priv *bat_priv = netdev_priv(primary_iface->soft_iface);
437 struct batadv_ogm2_packet *ogm_packet;
439 mutex_lock(&bat_priv->bat_v.ogm_buff_mutex);
440 if (!bat_priv->bat_v.ogm_buff)
443 ogm_packet = (struct batadv_ogm2_packet *)bat_priv->bat_v.ogm_buff;
444 ether_addr_copy(ogm_packet->orig, primary_iface->net_dev->dev_addr);
447 mutex_unlock(&bat_priv->bat_v.ogm_buff_mutex);
451 * batadv_v_forward_penalty() - apply a penalty to the throughput metric
452 * forwarded with B.A.T.M.A.N. V OGMs
453 * @bat_priv: the bat priv with all the soft interface information
454 * @if_incoming: the interface where the OGM has been received
455 * @if_outgoing: the interface where the OGM has to be forwarded to
456 * @throughput: the current throughput
458 * Apply a penalty on the current throughput metric value based on the
459 * characteristic of the interface where the OGM has been received.
461 * Initially the per hardif hop penalty is applied to the throughput. After
462 * that the return value is then computed as follows:
463 * - throughput * 50% if the incoming and outgoing interface are the
464 * same WiFi interface and the throughput is above
466 * - throughput if the outgoing interface is the default
467 * interface (i.e. this OGM is processed for the
468 * internal table and not forwarded)
469 * - throughput * node hop penalty otherwise
471 * Return: the penalised throughput metric.
473 static u32 batadv_v_forward_penalty(struct batadv_priv *bat_priv,
474 struct batadv_hard_iface *if_incoming,
475 struct batadv_hard_iface *if_outgoing,
478 int if_hop_penalty = atomic_read(&if_incoming->hop_penalty);
479 int hop_penalty = atomic_read(&bat_priv->hop_penalty);
480 int hop_penalty_max = BATADV_TQ_MAX_VALUE;
482 /* Apply per hardif hop penalty */
483 throughput = throughput * (hop_penalty_max - if_hop_penalty) /
486 /* Don't apply hop penalty in default originator table. */
487 if (if_outgoing == BATADV_IF_DEFAULT)
490 /* Forwarding on the same WiFi interface cuts the throughput in half
491 * due to the store & forward characteristics of WIFI.
492 * Very low throughput values are the exception.
494 if (throughput > 10 &&
495 if_incoming == if_outgoing &&
496 !(if_incoming->bat_v.flags & BATADV_FULL_DUPLEX))
497 return throughput / 2;
499 /* hop penalty of 255 equals 100% */
500 return throughput * (hop_penalty_max - hop_penalty) / hop_penalty_max;
504 * batadv_v_ogm_forward() - check conditions and forward an OGM to the given
506 * @bat_priv: the bat priv with all the soft interface information
507 * @ogm_received: previously received OGM to be forwarded
508 * @orig_node: the originator which has been updated
509 * @neigh_node: the neigh_node through with the OGM has been received
510 * @if_incoming: the interface on which this OGM was received on
511 * @if_outgoing: the interface to which the OGM has to be forwarded to
513 * Forward an OGM to an interface after having altered the throughput metric and
514 * the TTL value contained in it. The original OGM isn't modified.
516 static void batadv_v_ogm_forward(struct batadv_priv *bat_priv,
517 const struct batadv_ogm2_packet *ogm_received,
518 struct batadv_orig_node *orig_node,
519 struct batadv_neigh_node *neigh_node,
520 struct batadv_hard_iface *if_incoming,
521 struct batadv_hard_iface *if_outgoing)
523 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL;
524 struct batadv_orig_ifinfo *orig_ifinfo = NULL;
525 struct batadv_neigh_node *router = NULL;
526 struct batadv_ogm2_packet *ogm_forward;
527 unsigned char *skb_buff;
532 /* only forward for specific interfaces, not for the default one. */
533 if (if_outgoing == BATADV_IF_DEFAULT)
536 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
540 /* acquire possibly updated router */
541 router = batadv_orig_router_get(orig_node, if_outgoing);
543 /* strict rule: forward packets coming from the best next hop only */
544 if (neigh_node != router)
547 /* don't forward the same seqno twice on one interface */
548 if (orig_ifinfo->last_seqno_forwarded == ntohl(ogm_received->seqno))
551 orig_ifinfo->last_seqno_forwarded = ntohl(ogm_received->seqno);
553 if (ogm_received->ttl <= 1) {
554 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "ttl exceeded\n");
558 neigh_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
562 tvlv_len = ntohs(ogm_received->tvlv_len);
564 packet_len = BATADV_OGM2_HLEN + tvlv_len;
565 skb = netdev_alloc_skb_ip_align(if_outgoing->net_dev,
566 ETH_HLEN + packet_len);
570 skb_reserve(skb, ETH_HLEN);
571 skb_buff = skb_put_data(skb, ogm_received, packet_len);
573 /* apply forward penalty */
574 ogm_forward = (struct batadv_ogm2_packet *)skb_buff;
575 ogm_forward->throughput = htonl(neigh_ifinfo->bat_v.throughput);
578 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
579 "Forwarding OGM2 packet on %s: throughput %u, ttl %u, received via %s\n",
580 if_outgoing->net_dev->name, ntohl(ogm_forward->throughput),
581 ogm_forward->ttl, if_incoming->net_dev->name);
583 batadv_v_ogm_queue_on_if(skb, if_outgoing);
586 batadv_orig_ifinfo_put(orig_ifinfo);
587 batadv_neigh_node_put(router);
588 batadv_neigh_ifinfo_put(neigh_ifinfo);
592 * batadv_v_ogm_metric_update() - update route metric based on OGM
593 * @bat_priv: the bat priv with all the soft interface information
594 * @ogm2: OGM2 structure
595 * @orig_node: Originator structure for which the OGM has been received
596 * @neigh_node: the neigh_node through with the OGM has been received
597 * @if_incoming: the interface where this packet was received
598 * @if_outgoing: the interface for which the packet should be considered
601 * 1 if the OGM is new,
602 * 0 if it is not new but valid,
603 * <0 on error (e.g. old OGM)
605 static int batadv_v_ogm_metric_update(struct batadv_priv *bat_priv,
606 const struct batadv_ogm2_packet *ogm2,
607 struct batadv_orig_node *orig_node,
608 struct batadv_neigh_node *neigh_node,
609 struct batadv_hard_iface *if_incoming,
610 struct batadv_hard_iface *if_outgoing)
612 struct batadv_orig_ifinfo *orig_ifinfo;
613 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL;
614 bool protection_started = false;
619 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
623 seq_diff = ntohl(ogm2->seqno) - orig_ifinfo->last_real_seqno;
625 if (!hlist_empty(&orig_node->neigh_list) &&
626 batadv_window_protected(bat_priv, seq_diff,
628 &orig_ifinfo->batman_seqno_reset,
629 &protection_started)) {
630 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
631 "Drop packet: packet within window protection time from %pM\n",
633 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
634 "Last reset: %ld, %ld\n",
635 orig_ifinfo->batman_seqno_reset, jiffies);
639 /* drop packets with old seqnos, however accept the first packet after
640 * a host has been rebooted.
642 if (seq_diff < 0 && !protection_started)
645 neigh_node->last_seen = jiffies;
647 orig_node->last_seen = jiffies;
649 orig_ifinfo->last_real_seqno = ntohl(ogm2->seqno);
650 orig_ifinfo->last_ttl = ogm2->ttl;
652 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
656 path_throughput = batadv_v_forward_penalty(bat_priv, if_incoming,
658 ntohl(ogm2->throughput));
659 neigh_ifinfo->bat_v.throughput = path_throughput;
660 neigh_ifinfo->bat_v.last_seqno = ntohl(ogm2->seqno);
661 neigh_ifinfo->last_ttl = ogm2->ttl;
663 if (seq_diff > 0 || protection_started)
668 batadv_orig_ifinfo_put(orig_ifinfo);
669 batadv_neigh_ifinfo_put(neigh_ifinfo);
675 * batadv_v_ogm_route_update() - update routes based on OGM
676 * @bat_priv: the bat priv with all the soft interface information
677 * @ethhdr: the Ethernet header of the OGM2
678 * @ogm2: OGM2 structure
679 * @orig_node: Originator structure for which the OGM has been received
680 * @neigh_node: the neigh_node through with the OGM has been received
681 * @if_incoming: the interface where this packet was received
682 * @if_outgoing: the interface for which the packet should be considered
684 * Return: true if the packet should be forwarded, false otherwise
686 static bool batadv_v_ogm_route_update(struct batadv_priv *bat_priv,
687 const struct ethhdr *ethhdr,
688 const struct batadv_ogm2_packet *ogm2,
689 struct batadv_orig_node *orig_node,
690 struct batadv_neigh_node *neigh_node,
691 struct batadv_hard_iface *if_incoming,
692 struct batadv_hard_iface *if_outgoing)
694 struct batadv_neigh_node *router = NULL;
695 struct batadv_orig_node *orig_neigh_node;
696 struct batadv_neigh_node *orig_neigh_router = NULL;
697 struct batadv_neigh_ifinfo *router_ifinfo = NULL, *neigh_ifinfo = NULL;
698 u32 router_throughput, neigh_throughput;
699 u32 router_last_seqno;
700 u32 neigh_last_seqno;
702 bool forward = false;
704 orig_neigh_node = batadv_v_ogm_orig_get(bat_priv, ethhdr->h_source);
705 if (!orig_neigh_node)
708 orig_neigh_router = batadv_orig_router_get(orig_neigh_node,
711 /* drop packet if sender is not a direct neighbor and if we
712 * don't route towards it
714 router = batadv_orig_router_get(orig_node, if_outgoing);
715 if (router && router->orig_node != orig_node && !orig_neigh_router) {
716 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
717 "Drop packet: OGM via unknown neighbor!\n");
721 /* Mark the OGM to be considered for forwarding, and update routes
726 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
727 "Searching and updating originator entry of received packet\n");
729 /* if this neighbor already is our next hop there is nothing
732 if (router == neigh_node)
735 /* don't consider neighbours with worse throughput.
736 * also switch route if this seqno is BATADV_V_MAX_ORIGDIFF newer than
737 * the last received seqno from our best next hop.
740 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
741 neigh_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
743 /* if these are not allocated, something is wrong. */
744 if (!router_ifinfo || !neigh_ifinfo)
747 neigh_last_seqno = neigh_ifinfo->bat_v.last_seqno;
748 router_last_seqno = router_ifinfo->bat_v.last_seqno;
749 neigh_seq_diff = neigh_last_seqno - router_last_seqno;
750 router_throughput = router_ifinfo->bat_v.throughput;
751 neigh_throughput = neigh_ifinfo->bat_v.throughput;
753 if (neigh_seq_diff < BATADV_OGM_MAX_ORIGDIFF &&
754 router_throughput >= neigh_throughput)
758 batadv_update_route(bat_priv, orig_node, if_outgoing, neigh_node);
760 batadv_neigh_node_put(router);
761 batadv_neigh_node_put(orig_neigh_router);
762 batadv_orig_node_put(orig_neigh_node);
763 batadv_neigh_ifinfo_put(router_ifinfo);
764 batadv_neigh_ifinfo_put(neigh_ifinfo);
770 * batadv_v_ogm_process_per_outif() - process a batman v OGM for an outgoing if
771 * @bat_priv: the bat priv with all the soft interface information
772 * @ethhdr: the Ethernet header of the OGM2
773 * @ogm2: OGM2 structure
774 * @orig_node: Originator structure for which the OGM has been received
775 * @neigh_node: the neigh_node through with the OGM has been received
776 * @if_incoming: the interface where this packet was received
777 * @if_outgoing: the interface for which the packet should be considered
780 batadv_v_ogm_process_per_outif(struct batadv_priv *bat_priv,
781 const struct ethhdr *ethhdr,
782 const struct batadv_ogm2_packet *ogm2,
783 struct batadv_orig_node *orig_node,
784 struct batadv_neigh_node *neigh_node,
785 struct batadv_hard_iface *if_incoming,
786 struct batadv_hard_iface *if_outgoing)
791 /* first, update the metric with according sanity checks */
792 seqno_age = batadv_v_ogm_metric_update(bat_priv, ogm2, orig_node,
793 neigh_node, if_incoming,
796 /* outdated sequence numbers are to be discarded */
800 /* only unknown & newer OGMs contain TVLVs we are interested in */
801 if (seqno_age > 0 && if_outgoing == BATADV_IF_DEFAULT)
802 batadv_tvlv_containers_process(bat_priv, BATADV_OGM2, orig_node,
804 (unsigned char *)(ogm2 + 1),
805 ntohs(ogm2->tvlv_len));
807 /* if the metric update went through, update routes if needed */
808 forward = batadv_v_ogm_route_update(bat_priv, ethhdr, ogm2, orig_node,
809 neigh_node, if_incoming,
812 /* if the routes have been processed correctly, check and forward */
814 batadv_v_ogm_forward(bat_priv, ogm2, orig_node, neigh_node,
815 if_incoming, if_outgoing);
819 * batadv_v_ogm_aggr_packet() - checks if there is another OGM aggregated
820 * @buff_pos: current position in the skb
821 * @packet_len: total length of the skb
822 * @ogm2_packet: potential OGM2 in buffer
824 * Return: true if there is enough space for another OGM, false otherwise.
827 batadv_v_ogm_aggr_packet(int buff_pos, int packet_len,
828 const struct batadv_ogm2_packet *ogm2_packet)
830 int next_buff_pos = 0;
832 /* check if there is enough space for the header */
833 next_buff_pos += buff_pos + sizeof(*ogm2_packet);
834 if (next_buff_pos > packet_len)
837 /* check if there is enough space for the optional TVLV */
838 next_buff_pos += ntohs(ogm2_packet->tvlv_len);
840 return (next_buff_pos <= packet_len) &&
841 (next_buff_pos <= BATADV_MAX_AGGREGATION_BYTES);
845 * batadv_v_ogm_process() - process an incoming batman v OGM
846 * @skb: the skb containing the OGM
847 * @ogm_offset: offset to the OGM which should be processed (for aggregates)
848 * @if_incoming: the interface where this packet was received
850 static void batadv_v_ogm_process(const struct sk_buff *skb, int ogm_offset,
851 struct batadv_hard_iface *if_incoming)
853 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
854 struct ethhdr *ethhdr;
855 struct batadv_orig_node *orig_node = NULL;
856 struct batadv_hardif_neigh_node *hardif_neigh = NULL;
857 struct batadv_neigh_node *neigh_node = NULL;
858 struct batadv_hard_iface *hard_iface;
859 struct batadv_ogm2_packet *ogm_packet;
860 u32 ogm_throughput, link_throughput, path_throughput;
863 ethhdr = eth_hdr(skb);
864 ogm_packet = (struct batadv_ogm2_packet *)(skb->data + ogm_offset);
866 ogm_throughput = ntohl(ogm_packet->throughput);
868 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
869 "Received OGM2 packet via NB: %pM, IF: %s [%pM] (from OG: %pM, seqno %u, throughput %u, TTL %u, V %u, tvlv_len %u)\n",
870 ethhdr->h_source, if_incoming->net_dev->name,
871 if_incoming->net_dev->dev_addr, ogm_packet->orig,
872 ntohl(ogm_packet->seqno), ogm_throughput, ogm_packet->ttl,
873 ogm_packet->version, ntohs(ogm_packet->tvlv_len));
875 if (batadv_is_my_mac(bat_priv, ogm_packet->orig)) {
876 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
877 "Drop packet: originator packet from ourself\n");
881 /* If the throughput metric is 0, immediately drop the packet. No need
882 * to create orig_node / neigh_node for an unusable route.
884 if (ogm_throughput == 0) {
885 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
886 "Drop packet: originator packet with throughput metric of 0\n");
890 /* require ELP packets be to received from this neighbor first */
891 hardif_neigh = batadv_hardif_neigh_get(if_incoming, ethhdr->h_source);
893 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
894 "Drop packet: OGM via unknown neighbor!\n");
898 orig_node = batadv_v_ogm_orig_get(bat_priv, ogm_packet->orig);
902 neigh_node = batadv_neigh_node_get_or_create(orig_node, if_incoming,
907 /* Update the received throughput metric to match the link
909 * - If this OGM traveled one hop so far (emitted by single hop
910 * neighbor) the path throughput metric equals the link throughput.
911 * - For OGMs traversing more than hop the path throughput metric is
912 * the smaller of the path throughput and the link throughput.
914 link_throughput = ewma_throughput_read(&hardif_neigh->bat_v.throughput);
915 path_throughput = min_t(u32, link_throughput, ogm_throughput);
916 ogm_packet->throughput = htonl(path_throughput);
918 batadv_v_ogm_process_per_outif(bat_priv, ethhdr, ogm_packet, orig_node,
919 neigh_node, if_incoming,
923 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
924 if (hard_iface->if_status != BATADV_IF_ACTIVE)
927 if (hard_iface->soft_iface != bat_priv->soft_iface)
930 if (!kref_get_unless_zero(&hard_iface->refcount))
933 ret = batadv_hardif_no_broadcast(hard_iface,
941 case BATADV_HARDIF_BCAST_NORECIPIENT:
942 type = "no neighbor";
944 case BATADV_HARDIF_BCAST_DUPFWD:
945 type = "single neighbor is source";
947 case BATADV_HARDIF_BCAST_DUPORIG:
948 type = "single neighbor is originator";
954 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "OGM2 packet from %pM on %s suppressed: %s\n",
955 ogm_packet->orig, hard_iface->net_dev->name,
958 batadv_hardif_put(hard_iface);
962 batadv_v_ogm_process_per_outif(bat_priv, ethhdr, ogm_packet,
963 orig_node, neigh_node,
964 if_incoming, hard_iface);
966 batadv_hardif_put(hard_iface);
970 batadv_orig_node_put(orig_node);
971 batadv_neigh_node_put(neigh_node);
972 batadv_hardif_neigh_put(hardif_neigh);
976 * batadv_v_ogm_packet_recv() - OGM2 receiving handler
977 * @skb: the received OGM
978 * @if_incoming: the interface where this OGM has been received
980 * Return: NET_RX_SUCCESS and consume the skb on success or returns NET_RX_DROP
981 * (without freeing the skb) on failure
983 int batadv_v_ogm_packet_recv(struct sk_buff *skb,
984 struct batadv_hard_iface *if_incoming)
986 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
987 struct batadv_ogm2_packet *ogm_packet;
988 struct ethhdr *ethhdr = eth_hdr(skb);
991 int ret = NET_RX_DROP;
993 /* did we receive a OGM2 packet on an interface that does not have
994 * B.A.T.M.A.N. V enabled ?
996 if (strcmp(bat_priv->algo_ops->name, "BATMAN_V") != 0)
999 if (!batadv_check_management_packet(skb, if_incoming, BATADV_OGM2_HLEN))
1002 if (batadv_is_my_mac(bat_priv, ethhdr->h_source))
1005 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_RX);
1006 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_RX_BYTES,
1007 skb->len + ETH_HLEN);
1010 ogm_packet = (struct batadv_ogm2_packet *)skb->data;
1012 while (batadv_v_ogm_aggr_packet(ogm_offset, skb_headlen(skb),
1014 batadv_v_ogm_process(skb, ogm_offset, if_incoming);
1016 ogm_offset += BATADV_OGM2_HLEN;
1017 ogm_offset += ntohs(ogm_packet->tvlv_len);
1019 packet_pos = skb->data + ogm_offset;
1020 ogm_packet = (struct batadv_ogm2_packet *)packet_pos;
1023 ret = NET_RX_SUCCESS;
1026 if (ret == NET_RX_SUCCESS)
1035 * batadv_v_ogm_init() - initialise the OGM2 engine
1036 * @bat_priv: the bat priv with all the soft interface information
1038 * Return: 0 on success or a negative error code in case of failure
1040 int batadv_v_ogm_init(struct batadv_priv *bat_priv)
1042 struct batadv_ogm2_packet *ogm_packet;
1043 unsigned char *ogm_buff;
1046 bat_priv->bat_v.ogm_buff_len = BATADV_OGM2_HLEN;
1047 ogm_buff = kzalloc(bat_priv->bat_v.ogm_buff_len, GFP_ATOMIC);
1051 bat_priv->bat_v.ogm_buff = ogm_buff;
1052 ogm_packet = (struct batadv_ogm2_packet *)ogm_buff;
1053 ogm_packet->packet_type = BATADV_OGM2;
1054 ogm_packet->version = BATADV_COMPAT_VERSION;
1055 ogm_packet->ttl = BATADV_TTL;
1056 ogm_packet->flags = BATADV_NO_FLAGS;
1057 ogm_packet->throughput = htonl(BATADV_THROUGHPUT_MAX_VALUE);
1059 /* randomize initial seqno to avoid collision */
1060 get_random_bytes(&random_seqno, sizeof(random_seqno));
1061 atomic_set(&bat_priv->bat_v.ogm_seqno, random_seqno);
1062 INIT_DELAYED_WORK(&bat_priv->bat_v.ogm_wq, batadv_v_ogm_send);
1064 mutex_init(&bat_priv->bat_v.ogm_buff_mutex);
1070 * batadv_v_ogm_free() - free OGM private resources
1071 * @bat_priv: the bat priv with all the soft interface information
1073 void batadv_v_ogm_free(struct batadv_priv *bat_priv)
1075 cancel_delayed_work_sync(&bat_priv->bat_v.ogm_wq);
1077 mutex_lock(&bat_priv->bat_v.ogm_buff_mutex);
1079 kfree(bat_priv->bat_v.ogm_buff);
1080 bat_priv->bat_v.ogm_buff = NULL;
1081 bat_priv->bat_v.ogm_buff_len = 0;
1083 mutex_unlock(&bat_priv->bat_v.ogm_buff_mutex);