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/prandom.h>
25 #include <linux/random.h>
26 #include <linux/rculist.h>
27 #include <linux/rcupdate.h>
28 #include <linux/skbuff.h>
29 #include <linux/slab.h>
30 #include <linux/spinlock.h>
31 #include <linux/stddef.h>
32 #include <linux/string.h>
33 #include <linux/types.h>
34 #include <linux/workqueue.h>
35 #include <uapi/linux/batadv_packet.h>
38 #include "hard-interface.h"
41 #include "originator.h"
44 #include "translation-table.h"
48 * batadv_v_ogm_orig_get() - retrieve and possibly create an originator node
49 * @bat_priv: the bat priv with all the soft interface information
50 * @addr: the address of the originator
52 * Return: the orig_node corresponding to the specified address. If such an
53 * object does not exist, it is allocated here. In case of allocation failure
56 struct batadv_orig_node *batadv_v_ogm_orig_get(struct batadv_priv *bat_priv,
59 struct batadv_orig_node *orig_node;
62 orig_node = batadv_orig_hash_find(bat_priv, addr);
66 orig_node = batadv_orig_node_new(bat_priv, addr);
70 kref_get(&orig_node->refcount);
71 hash_added = batadv_hash_add(bat_priv->orig_hash, batadv_compare_orig,
72 batadv_choose_orig, orig_node,
73 &orig_node->hash_entry);
74 if (hash_added != 0) {
75 /* remove refcnt for newly created orig_node and hash entry */
76 batadv_orig_node_put(orig_node);
77 batadv_orig_node_put(orig_node);
85 * batadv_v_ogm_start_queue_timer() - restart the OGM aggregation timer
86 * @hard_iface: the interface to use to send the OGM
88 static void batadv_v_ogm_start_queue_timer(struct batadv_hard_iface *hard_iface)
90 unsigned int msecs = BATADV_MAX_AGGREGATION_MS * 1000;
92 /* msecs * [0.9, 1.1] */
93 msecs += prandom_u32_max(msecs / 5) - (msecs / 10);
94 queue_delayed_work(batadv_event_workqueue, &hard_iface->bat_v.aggr_wq,
95 msecs_to_jiffies(msecs / 1000));
99 * batadv_v_ogm_start_timer() - restart the OGM sending timer
100 * @bat_priv: the bat priv with all the soft interface information
102 static void batadv_v_ogm_start_timer(struct batadv_priv *bat_priv)
105 /* this function may be invoked in different contexts (ogm rescheduling
106 * or hard_iface activation), but the work timer should not be reset
108 if (delayed_work_pending(&bat_priv->bat_v.ogm_wq))
111 msecs = atomic_read(&bat_priv->orig_interval) - BATADV_JITTER;
112 msecs += prandom_u32_max(2 * BATADV_JITTER);
113 queue_delayed_work(batadv_event_workqueue, &bat_priv->bat_v.ogm_wq,
114 msecs_to_jiffies(msecs));
118 * batadv_v_ogm_send_to_if() - send a batman ogm using a given interface
119 * @skb: the OGM to send
120 * @hard_iface: the interface to use to send the OGM
122 static void batadv_v_ogm_send_to_if(struct sk_buff *skb,
123 struct batadv_hard_iface *hard_iface)
125 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
127 if (hard_iface->if_status != BATADV_IF_ACTIVE) {
132 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_TX);
133 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_TX_BYTES,
134 skb->len + ETH_HLEN);
136 batadv_send_broadcast_skb(skb, hard_iface);
140 * batadv_v_ogm_len() - OGMv2 packet length
141 * @skb: the OGM to check
143 * Return: Length of the given OGMv2 packet, including tvlv length, excluding
144 * ethernet header length.
146 static unsigned int batadv_v_ogm_len(struct sk_buff *skb)
148 struct batadv_ogm2_packet *ogm_packet;
150 ogm_packet = (struct batadv_ogm2_packet *)skb->data;
151 return BATADV_OGM2_HLEN + ntohs(ogm_packet->tvlv_len);
155 * batadv_v_ogm_queue_left() - check if given OGM still fits aggregation queue
156 * @skb: the OGM to check
157 * @hard_iface: the interface to use to send the OGM
159 * Caller needs to hold the hard_iface->bat_v.aggr_list.lock.
161 * Return: True, if the given OGMv2 packet still fits, false otherwise.
163 static bool batadv_v_ogm_queue_left(struct sk_buff *skb,
164 struct batadv_hard_iface *hard_iface)
166 unsigned int max = min_t(unsigned int, hard_iface->net_dev->mtu,
167 BATADV_MAX_AGGREGATION_BYTES);
168 unsigned int ogm_len = batadv_v_ogm_len(skb);
170 lockdep_assert_held(&hard_iface->bat_v.aggr_list.lock);
172 return hard_iface->bat_v.aggr_len + ogm_len <= max;
176 * batadv_v_ogm_aggr_list_free - free all elements in an aggregation queue
177 * @hard_iface: the interface holding the aggregation queue
179 * Empties the OGMv2 aggregation queue and frees all the skbs it contains.
181 * Caller needs to hold the hard_iface->bat_v.aggr_list.lock.
183 static void batadv_v_ogm_aggr_list_free(struct batadv_hard_iface *hard_iface)
185 lockdep_assert_held(&hard_iface->bat_v.aggr_list.lock);
187 __skb_queue_purge(&hard_iface->bat_v.aggr_list);
188 hard_iface->bat_v.aggr_len = 0;
192 * batadv_v_ogm_aggr_send() - flush & send aggregation queue
193 * @hard_iface: the interface with the aggregation queue to flush
195 * Aggregates all OGMv2 packets currently in the aggregation queue into a
196 * single OGMv2 packet and transmits this aggregate.
198 * The aggregation queue is empty after this call.
200 * Caller needs to hold the hard_iface->bat_v.aggr_list.lock.
202 static void batadv_v_ogm_aggr_send(struct batadv_hard_iface *hard_iface)
204 unsigned int aggr_len = hard_iface->bat_v.aggr_len;
205 struct sk_buff *skb_aggr;
206 unsigned int ogm_len;
209 lockdep_assert_held(&hard_iface->bat_v.aggr_list.lock);
214 skb_aggr = dev_alloc_skb(aggr_len + ETH_HLEN + NET_IP_ALIGN);
216 batadv_v_ogm_aggr_list_free(hard_iface);
220 skb_reserve(skb_aggr, ETH_HLEN + NET_IP_ALIGN);
221 skb_reset_network_header(skb_aggr);
223 while ((skb = __skb_dequeue(&hard_iface->bat_v.aggr_list))) {
224 hard_iface->bat_v.aggr_len -= batadv_v_ogm_len(skb);
226 ogm_len = batadv_v_ogm_len(skb);
227 skb_put_data(skb_aggr, skb->data, ogm_len);
232 batadv_v_ogm_send_to_if(skb_aggr, hard_iface);
236 * batadv_v_ogm_queue_on_if() - queue a batman ogm on a given interface
237 * @skb: the OGM to queue
238 * @hard_iface: the interface to queue the OGM on
240 static void batadv_v_ogm_queue_on_if(struct sk_buff *skb,
241 struct batadv_hard_iface *hard_iface)
243 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
245 if (!atomic_read(&bat_priv->aggregated_ogms)) {
246 batadv_v_ogm_send_to_if(skb, hard_iface);
250 spin_lock_bh(&hard_iface->bat_v.aggr_list.lock);
251 if (!batadv_v_ogm_queue_left(skb, hard_iface))
252 batadv_v_ogm_aggr_send(hard_iface);
254 hard_iface->bat_v.aggr_len += batadv_v_ogm_len(skb);
255 __skb_queue_tail(&hard_iface->bat_v.aggr_list, skb);
256 spin_unlock_bh(&hard_iface->bat_v.aggr_list.lock);
260 * batadv_v_ogm_send_softif() - periodic worker broadcasting the own OGM
261 * @bat_priv: the bat priv with all the soft interface information
263 static void batadv_v_ogm_send_softif(struct batadv_priv *bat_priv)
265 struct batadv_hard_iface *hard_iface;
266 struct batadv_ogm2_packet *ogm_packet;
267 struct sk_buff *skb, *skb_tmp;
268 unsigned char *ogm_buff;
273 lockdep_assert_held(&bat_priv->bat_v.ogm_buff_mutex);
275 if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_DEACTIVATING)
278 ogm_buff = bat_priv->bat_v.ogm_buff;
279 ogm_buff_len = bat_priv->bat_v.ogm_buff_len;
280 /* tt changes have to be committed before the tvlv data is
281 * appended as it may alter the tt tvlv container
283 batadv_tt_local_commit_changes(bat_priv);
284 tvlv_len = batadv_tvlv_container_ogm_append(bat_priv, &ogm_buff,
288 bat_priv->bat_v.ogm_buff = ogm_buff;
289 bat_priv->bat_v.ogm_buff_len = ogm_buff_len;
291 skb = netdev_alloc_skb_ip_align(NULL, ETH_HLEN + ogm_buff_len);
295 skb_reserve(skb, ETH_HLEN);
296 skb_put_data(skb, ogm_buff, ogm_buff_len);
298 ogm_packet = (struct batadv_ogm2_packet *)skb->data;
299 ogm_packet->seqno = htonl(atomic_read(&bat_priv->bat_v.ogm_seqno));
300 atomic_inc(&bat_priv->bat_v.ogm_seqno);
301 ogm_packet->tvlv_len = htons(tvlv_len);
303 /* broadcast on every interface */
305 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
306 if (hard_iface->soft_iface != bat_priv->soft_iface)
309 if (!kref_get_unless_zero(&hard_iface->refcount))
312 ret = batadv_hardif_no_broadcast(hard_iface, NULL, NULL);
317 case BATADV_HARDIF_BCAST_NORECIPIENT:
318 type = "no neighbor";
320 case BATADV_HARDIF_BCAST_DUPFWD:
321 type = "single neighbor is source";
323 case BATADV_HARDIF_BCAST_DUPORIG:
324 type = "single neighbor is originator";
330 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "OGM2 from ourselves on %s suppressed: %s\n",
331 hard_iface->net_dev->name, type);
333 batadv_hardif_put(hard_iface);
337 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
338 "Sending own OGM2 packet (originator %pM, seqno %u, throughput %u, TTL %d) on interface %s [%pM]\n",
339 ogm_packet->orig, ntohl(ogm_packet->seqno),
340 ntohl(ogm_packet->throughput), ogm_packet->ttl,
341 hard_iface->net_dev->name,
342 hard_iface->net_dev->dev_addr);
344 /* this skb gets consumed by batadv_v_ogm_send_to_if() */
345 skb_tmp = skb_clone(skb, GFP_ATOMIC);
347 batadv_hardif_put(hard_iface);
351 batadv_v_ogm_queue_on_if(skb_tmp, hard_iface);
352 batadv_hardif_put(hard_iface);
359 batadv_v_ogm_start_timer(bat_priv);
365 * batadv_v_ogm_send() - periodic worker broadcasting the own OGM
366 * @work: work queue item
368 static void batadv_v_ogm_send(struct work_struct *work)
370 struct batadv_priv_bat_v *bat_v;
371 struct batadv_priv *bat_priv;
373 bat_v = container_of(work, struct batadv_priv_bat_v, ogm_wq.work);
374 bat_priv = container_of(bat_v, struct batadv_priv, bat_v);
376 mutex_lock(&bat_priv->bat_v.ogm_buff_mutex);
377 batadv_v_ogm_send_softif(bat_priv);
378 mutex_unlock(&bat_priv->bat_v.ogm_buff_mutex);
382 * batadv_v_ogm_aggr_work() - OGM queue periodic task per interface
383 * @work: work queue item
385 * Emits aggregated OGM messages in regular intervals.
387 void batadv_v_ogm_aggr_work(struct work_struct *work)
389 struct batadv_hard_iface_bat_v *batv;
390 struct batadv_hard_iface *hard_iface;
392 batv = container_of(work, struct batadv_hard_iface_bat_v, aggr_wq.work);
393 hard_iface = container_of(batv, struct batadv_hard_iface, bat_v);
395 spin_lock_bh(&hard_iface->bat_v.aggr_list.lock);
396 batadv_v_ogm_aggr_send(hard_iface);
397 spin_unlock_bh(&hard_iface->bat_v.aggr_list.lock);
399 batadv_v_ogm_start_queue_timer(hard_iface);
403 * batadv_v_ogm_iface_enable() - prepare an interface for B.A.T.M.A.N. V
404 * @hard_iface: the interface to prepare
406 * Takes care of scheduling its own OGM sending routine for this interface.
408 * Return: 0 on success or a negative error code otherwise
410 int batadv_v_ogm_iface_enable(struct batadv_hard_iface *hard_iface)
412 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
414 batadv_v_ogm_start_queue_timer(hard_iface);
415 batadv_v_ogm_start_timer(bat_priv);
421 * batadv_v_ogm_iface_disable() - release OGM interface private resources
422 * @hard_iface: interface for which the resources have to be released
424 void batadv_v_ogm_iface_disable(struct batadv_hard_iface *hard_iface)
426 cancel_delayed_work_sync(&hard_iface->bat_v.aggr_wq);
428 spin_lock_bh(&hard_iface->bat_v.aggr_list.lock);
429 batadv_v_ogm_aggr_list_free(hard_iface);
430 spin_unlock_bh(&hard_iface->bat_v.aggr_list.lock);
434 * batadv_v_ogm_primary_iface_set() - set a new primary interface
435 * @primary_iface: the new primary interface
437 void batadv_v_ogm_primary_iface_set(struct batadv_hard_iface *primary_iface)
439 struct batadv_priv *bat_priv = netdev_priv(primary_iface->soft_iface);
440 struct batadv_ogm2_packet *ogm_packet;
442 mutex_lock(&bat_priv->bat_v.ogm_buff_mutex);
443 if (!bat_priv->bat_v.ogm_buff)
446 ogm_packet = (struct batadv_ogm2_packet *)bat_priv->bat_v.ogm_buff;
447 ether_addr_copy(ogm_packet->orig, primary_iface->net_dev->dev_addr);
450 mutex_unlock(&bat_priv->bat_v.ogm_buff_mutex);
454 * batadv_v_forward_penalty() - apply a penalty to the throughput metric
455 * forwarded with B.A.T.M.A.N. V OGMs
456 * @bat_priv: the bat priv with all the soft interface information
457 * @if_incoming: the interface where the OGM has been received
458 * @if_outgoing: the interface where the OGM has to be forwarded to
459 * @throughput: the current throughput
461 * Apply a penalty on the current throughput metric value based on the
462 * characteristic of the interface where the OGM has been received.
464 * Initially the per hardif hop penalty is applied to the throughput. After
465 * that the return value is then computed as follows:
466 * - throughput * 50% if the incoming and outgoing interface are the
467 * same WiFi interface and the throughput is above
469 * - throughput if the outgoing interface is the default
470 * interface (i.e. this OGM is processed for the
471 * internal table and not forwarded)
472 * - throughput * node hop penalty otherwise
474 * Return: the penalised throughput metric.
476 static u32 batadv_v_forward_penalty(struct batadv_priv *bat_priv,
477 struct batadv_hard_iface *if_incoming,
478 struct batadv_hard_iface *if_outgoing,
481 int if_hop_penalty = atomic_read(&if_incoming->hop_penalty);
482 int hop_penalty = atomic_read(&bat_priv->hop_penalty);
483 int hop_penalty_max = BATADV_TQ_MAX_VALUE;
485 /* Apply per hardif hop penalty */
486 throughput = throughput * (hop_penalty_max - if_hop_penalty) /
489 /* Don't apply hop penalty in default originator table. */
490 if (if_outgoing == BATADV_IF_DEFAULT)
493 /* Forwarding on the same WiFi interface cuts the throughput in half
494 * due to the store & forward characteristics of WIFI.
495 * Very low throughput values are the exception.
497 if (throughput > 10 &&
498 if_incoming == if_outgoing &&
499 !(if_incoming->bat_v.flags & BATADV_FULL_DUPLEX))
500 return throughput / 2;
502 /* hop penalty of 255 equals 100% */
503 return throughput * (hop_penalty_max - hop_penalty) / hop_penalty_max;
507 * batadv_v_ogm_forward() - check conditions and forward an OGM to the given
509 * @bat_priv: the bat priv with all the soft interface information
510 * @ogm_received: previously received OGM to be forwarded
511 * @orig_node: the originator which has been updated
512 * @neigh_node: the neigh_node through with the OGM has been received
513 * @if_incoming: the interface on which this OGM was received on
514 * @if_outgoing: the interface to which the OGM has to be forwarded to
516 * Forward an OGM to an interface after having altered the throughput metric and
517 * the TTL value contained in it. The original OGM isn't modified.
519 static void batadv_v_ogm_forward(struct batadv_priv *bat_priv,
520 const struct batadv_ogm2_packet *ogm_received,
521 struct batadv_orig_node *orig_node,
522 struct batadv_neigh_node *neigh_node,
523 struct batadv_hard_iface *if_incoming,
524 struct batadv_hard_iface *if_outgoing)
526 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL;
527 struct batadv_orig_ifinfo *orig_ifinfo = NULL;
528 struct batadv_neigh_node *router = NULL;
529 struct batadv_ogm2_packet *ogm_forward;
530 unsigned char *skb_buff;
535 /* only forward for specific interfaces, not for the default one. */
536 if (if_outgoing == BATADV_IF_DEFAULT)
539 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
543 /* acquire possibly updated router */
544 router = batadv_orig_router_get(orig_node, if_outgoing);
546 /* strict rule: forward packets coming from the best next hop only */
547 if (neigh_node != router)
550 /* don't forward the same seqno twice on one interface */
551 if (orig_ifinfo->last_seqno_forwarded == ntohl(ogm_received->seqno))
554 orig_ifinfo->last_seqno_forwarded = ntohl(ogm_received->seqno);
556 if (ogm_received->ttl <= 1) {
557 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "ttl exceeded\n");
561 neigh_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
565 tvlv_len = ntohs(ogm_received->tvlv_len);
567 packet_len = BATADV_OGM2_HLEN + tvlv_len;
568 skb = netdev_alloc_skb_ip_align(if_outgoing->net_dev,
569 ETH_HLEN + packet_len);
573 skb_reserve(skb, ETH_HLEN);
574 skb_buff = skb_put_data(skb, ogm_received, packet_len);
576 /* apply forward penalty */
577 ogm_forward = (struct batadv_ogm2_packet *)skb_buff;
578 ogm_forward->throughput = htonl(neigh_ifinfo->bat_v.throughput);
581 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
582 "Forwarding OGM2 packet on %s: throughput %u, ttl %u, received via %s\n",
583 if_outgoing->net_dev->name, ntohl(ogm_forward->throughput),
584 ogm_forward->ttl, if_incoming->net_dev->name);
586 batadv_v_ogm_queue_on_if(skb, if_outgoing);
589 batadv_orig_ifinfo_put(orig_ifinfo);
590 batadv_neigh_node_put(router);
591 batadv_neigh_ifinfo_put(neigh_ifinfo);
595 * batadv_v_ogm_metric_update() - update route metric based on OGM
596 * @bat_priv: the bat priv with all the soft interface information
597 * @ogm2: OGM2 structure
598 * @orig_node: Originator structure for which the OGM has been received
599 * @neigh_node: the neigh_node through with the OGM has been received
600 * @if_incoming: the interface where this packet was received
601 * @if_outgoing: the interface for which the packet should be considered
604 * 1 if the OGM is new,
605 * 0 if it is not new but valid,
606 * <0 on error (e.g. old OGM)
608 static int batadv_v_ogm_metric_update(struct batadv_priv *bat_priv,
609 const struct batadv_ogm2_packet *ogm2,
610 struct batadv_orig_node *orig_node,
611 struct batadv_neigh_node *neigh_node,
612 struct batadv_hard_iface *if_incoming,
613 struct batadv_hard_iface *if_outgoing)
615 struct batadv_orig_ifinfo *orig_ifinfo;
616 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL;
617 bool protection_started = false;
622 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
626 seq_diff = ntohl(ogm2->seqno) - orig_ifinfo->last_real_seqno;
628 if (!hlist_empty(&orig_node->neigh_list) &&
629 batadv_window_protected(bat_priv, seq_diff,
631 &orig_ifinfo->batman_seqno_reset,
632 &protection_started)) {
633 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
634 "Drop packet: packet within window protection time from %pM\n",
636 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
637 "Last reset: %ld, %ld\n",
638 orig_ifinfo->batman_seqno_reset, jiffies);
642 /* drop packets with old seqnos, however accept the first packet after
643 * a host has been rebooted.
645 if (seq_diff < 0 && !protection_started)
648 neigh_node->last_seen = jiffies;
650 orig_node->last_seen = jiffies;
652 orig_ifinfo->last_real_seqno = ntohl(ogm2->seqno);
653 orig_ifinfo->last_ttl = ogm2->ttl;
655 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
659 path_throughput = batadv_v_forward_penalty(bat_priv, if_incoming,
661 ntohl(ogm2->throughput));
662 neigh_ifinfo->bat_v.throughput = path_throughput;
663 neigh_ifinfo->bat_v.last_seqno = ntohl(ogm2->seqno);
664 neigh_ifinfo->last_ttl = ogm2->ttl;
666 if (seq_diff > 0 || protection_started)
671 batadv_orig_ifinfo_put(orig_ifinfo);
672 batadv_neigh_ifinfo_put(neigh_ifinfo);
678 * batadv_v_ogm_route_update() - update routes based on OGM
679 * @bat_priv: the bat priv with all the soft interface information
680 * @ethhdr: the Ethernet header of the OGM2
681 * @ogm2: OGM2 structure
682 * @orig_node: Originator structure for which the OGM has been received
683 * @neigh_node: the neigh_node through with the OGM has been received
684 * @if_incoming: the interface where this packet was received
685 * @if_outgoing: the interface for which the packet should be considered
687 * Return: true if the packet should be forwarded, false otherwise
689 static bool batadv_v_ogm_route_update(struct batadv_priv *bat_priv,
690 const struct ethhdr *ethhdr,
691 const struct batadv_ogm2_packet *ogm2,
692 struct batadv_orig_node *orig_node,
693 struct batadv_neigh_node *neigh_node,
694 struct batadv_hard_iface *if_incoming,
695 struct batadv_hard_iface *if_outgoing)
697 struct batadv_neigh_node *router = NULL;
698 struct batadv_orig_node *orig_neigh_node;
699 struct batadv_neigh_node *orig_neigh_router = NULL;
700 struct batadv_neigh_ifinfo *router_ifinfo = NULL, *neigh_ifinfo = NULL;
701 u32 router_throughput, neigh_throughput;
702 u32 router_last_seqno;
703 u32 neigh_last_seqno;
705 bool forward = false;
707 orig_neigh_node = batadv_v_ogm_orig_get(bat_priv, ethhdr->h_source);
708 if (!orig_neigh_node)
711 orig_neigh_router = batadv_orig_router_get(orig_neigh_node,
714 /* drop packet if sender is not a direct neighbor and if we
715 * don't route towards it
717 router = batadv_orig_router_get(orig_node, if_outgoing);
718 if (router && router->orig_node != orig_node && !orig_neigh_router) {
719 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
720 "Drop packet: OGM via unknown neighbor!\n");
724 /* Mark the OGM to be considered for forwarding, and update routes
729 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
730 "Searching and updating originator entry of received packet\n");
732 /* if this neighbor already is our next hop there is nothing
735 if (router == neigh_node)
738 /* don't consider neighbours with worse throughput.
739 * also switch route if this seqno is BATADV_V_MAX_ORIGDIFF newer than
740 * the last received seqno from our best next hop.
743 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
744 neigh_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
746 /* if these are not allocated, something is wrong. */
747 if (!router_ifinfo || !neigh_ifinfo)
750 neigh_last_seqno = neigh_ifinfo->bat_v.last_seqno;
751 router_last_seqno = router_ifinfo->bat_v.last_seqno;
752 neigh_seq_diff = neigh_last_seqno - router_last_seqno;
753 router_throughput = router_ifinfo->bat_v.throughput;
754 neigh_throughput = neigh_ifinfo->bat_v.throughput;
756 if (neigh_seq_diff < BATADV_OGM_MAX_ORIGDIFF &&
757 router_throughput >= neigh_throughput)
761 batadv_update_route(bat_priv, orig_node, if_outgoing, neigh_node);
763 batadv_neigh_node_put(router);
764 batadv_neigh_node_put(orig_neigh_router);
765 batadv_orig_node_put(orig_neigh_node);
766 batadv_neigh_ifinfo_put(router_ifinfo);
767 batadv_neigh_ifinfo_put(neigh_ifinfo);
773 * batadv_v_ogm_process_per_outif() - process a batman v OGM for an outgoing if
774 * @bat_priv: the bat priv with all the soft interface information
775 * @ethhdr: the Ethernet header of the OGM2
776 * @ogm2: OGM2 structure
777 * @orig_node: Originator structure for which the OGM has been received
778 * @neigh_node: the neigh_node through with the OGM has been received
779 * @if_incoming: the interface where this packet was received
780 * @if_outgoing: the interface for which the packet should be considered
783 batadv_v_ogm_process_per_outif(struct batadv_priv *bat_priv,
784 const struct ethhdr *ethhdr,
785 const struct batadv_ogm2_packet *ogm2,
786 struct batadv_orig_node *orig_node,
787 struct batadv_neigh_node *neigh_node,
788 struct batadv_hard_iface *if_incoming,
789 struct batadv_hard_iface *if_outgoing)
794 /* first, update the metric with according sanity checks */
795 seqno_age = batadv_v_ogm_metric_update(bat_priv, ogm2, orig_node,
796 neigh_node, if_incoming,
799 /* outdated sequence numbers are to be discarded */
803 /* only unknown & newer OGMs contain TVLVs we are interested in */
804 if (seqno_age > 0 && if_outgoing == BATADV_IF_DEFAULT)
805 batadv_tvlv_containers_process(bat_priv, true, orig_node,
807 (unsigned char *)(ogm2 + 1),
808 ntohs(ogm2->tvlv_len));
810 /* if the metric update went through, update routes if needed */
811 forward = batadv_v_ogm_route_update(bat_priv, ethhdr, ogm2, orig_node,
812 neigh_node, if_incoming,
815 /* if the routes have been processed correctly, check and forward */
817 batadv_v_ogm_forward(bat_priv, ogm2, orig_node, neigh_node,
818 if_incoming, if_outgoing);
822 * batadv_v_ogm_aggr_packet() - checks if there is another OGM aggregated
823 * @buff_pos: current position in the skb
824 * @packet_len: total length of the skb
825 * @ogm2_packet: potential OGM2 in buffer
827 * Return: true if there is enough space for another OGM, false otherwise.
830 batadv_v_ogm_aggr_packet(int buff_pos, int packet_len,
831 const struct batadv_ogm2_packet *ogm2_packet)
833 int next_buff_pos = 0;
835 /* check if there is enough space for the header */
836 next_buff_pos += buff_pos + sizeof(*ogm2_packet);
837 if (next_buff_pos > packet_len)
840 /* check if there is enough space for the optional TVLV */
841 next_buff_pos += ntohs(ogm2_packet->tvlv_len);
843 return (next_buff_pos <= packet_len) &&
844 (next_buff_pos <= BATADV_MAX_AGGREGATION_BYTES);
848 * batadv_v_ogm_process() - process an incoming batman v OGM
849 * @skb: the skb containing the OGM
850 * @ogm_offset: offset to the OGM which should be processed (for aggregates)
851 * @if_incoming: the interface where this packet was received
853 static void batadv_v_ogm_process(const struct sk_buff *skb, int ogm_offset,
854 struct batadv_hard_iface *if_incoming)
856 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
857 struct ethhdr *ethhdr;
858 struct batadv_orig_node *orig_node = NULL;
859 struct batadv_hardif_neigh_node *hardif_neigh = NULL;
860 struct batadv_neigh_node *neigh_node = NULL;
861 struct batadv_hard_iface *hard_iface;
862 struct batadv_ogm2_packet *ogm_packet;
863 u32 ogm_throughput, link_throughput, path_throughput;
866 ethhdr = eth_hdr(skb);
867 ogm_packet = (struct batadv_ogm2_packet *)(skb->data + ogm_offset);
869 ogm_throughput = ntohl(ogm_packet->throughput);
871 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
872 "Received OGM2 packet via NB: %pM, IF: %s [%pM] (from OG: %pM, seqno %u, throughput %u, TTL %u, V %u, tvlv_len %u)\n",
873 ethhdr->h_source, if_incoming->net_dev->name,
874 if_incoming->net_dev->dev_addr, ogm_packet->orig,
875 ntohl(ogm_packet->seqno), ogm_throughput, ogm_packet->ttl,
876 ogm_packet->version, ntohs(ogm_packet->tvlv_len));
878 if (batadv_is_my_mac(bat_priv, ogm_packet->orig)) {
879 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
880 "Drop packet: originator packet from ourself\n");
884 /* If the throughput metric is 0, immediately drop the packet. No need
885 * to create orig_node / neigh_node for an unusable route.
887 if (ogm_throughput == 0) {
888 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
889 "Drop packet: originator packet with throughput metric of 0\n");
893 /* require ELP packets be to received from this neighbor first */
894 hardif_neigh = batadv_hardif_neigh_get(if_incoming, ethhdr->h_source);
896 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
897 "Drop packet: OGM via unknown neighbor!\n");
901 orig_node = batadv_v_ogm_orig_get(bat_priv, ogm_packet->orig);
905 neigh_node = batadv_neigh_node_get_or_create(orig_node, if_incoming,
910 /* Update the received throughput metric to match the link
912 * - If this OGM traveled one hop so far (emitted by single hop
913 * neighbor) the path throughput metric equals the link throughput.
914 * - For OGMs traversing more than hop the path throughput metric is
915 * the smaller of the path throughput and the link throughput.
917 link_throughput = ewma_throughput_read(&hardif_neigh->bat_v.throughput);
918 path_throughput = min_t(u32, link_throughput, ogm_throughput);
919 ogm_packet->throughput = htonl(path_throughput);
921 batadv_v_ogm_process_per_outif(bat_priv, ethhdr, ogm_packet, orig_node,
922 neigh_node, if_incoming,
926 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
927 if (hard_iface->if_status != BATADV_IF_ACTIVE)
930 if (hard_iface->soft_iface != bat_priv->soft_iface)
933 if (!kref_get_unless_zero(&hard_iface->refcount))
936 ret = batadv_hardif_no_broadcast(hard_iface,
944 case BATADV_HARDIF_BCAST_NORECIPIENT:
945 type = "no neighbor";
947 case BATADV_HARDIF_BCAST_DUPFWD:
948 type = "single neighbor is source";
950 case BATADV_HARDIF_BCAST_DUPORIG:
951 type = "single neighbor is originator";
957 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "OGM2 packet from %pM on %s suppressed: %s\n",
958 ogm_packet->orig, hard_iface->net_dev->name,
961 batadv_hardif_put(hard_iface);
965 batadv_v_ogm_process_per_outif(bat_priv, ethhdr, ogm_packet,
966 orig_node, neigh_node,
967 if_incoming, hard_iface);
969 batadv_hardif_put(hard_iface);
973 batadv_orig_node_put(orig_node);
974 batadv_neigh_node_put(neigh_node);
975 batadv_hardif_neigh_put(hardif_neigh);
979 * batadv_v_ogm_packet_recv() - OGM2 receiving handler
980 * @skb: the received OGM
981 * @if_incoming: the interface where this OGM has been received
983 * Return: NET_RX_SUCCESS and consume the skb on success or returns NET_RX_DROP
984 * (without freeing the skb) on failure
986 int batadv_v_ogm_packet_recv(struct sk_buff *skb,
987 struct batadv_hard_iface *if_incoming)
989 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
990 struct batadv_ogm2_packet *ogm_packet;
991 struct ethhdr *ethhdr;
994 int ret = NET_RX_DROP;
996 /* did we receive a OGM2 packet on an interface that does not have
997 * B.A.T.M.A.N. V enabled ?
999 if (strcmp(bat_priv->algo_ops->name, "BATMAN_V") != 0)
1002 if (!batadv_check_management_packet(skb, if_incoming, BATADV_OGM2_HLEN))
1005 ethhdr = eth_hdr(skb);
1006 if (batadv_is_my_mac(bat_priv, ethhdr->h_source))
1009 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_RX);
1010 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_RX_BYTES,
1011 skb->len + ETH_HLEN);
1014 ogm_packet = (struct batadv_ogm2_packet *)skb->data;
1016 while (batadv_v_ogm_aggr_packet(ogm_offset, skb_headlen(skb),
1018 batadv_v_ogm_process(skb, ogm_offset, if_incoming);
1020 ogm_offset += BATADV_OGM2_HLEN;
1021 ogm_offset += ntohs(ogm_packet->tvlv_len);
1023 packet_pos = skb->data + ogm_offset;
1024 ogm_packet = (struct batadv_ogm2_packet *)packet_pos;
1027 ret = NET_RX_SUCCESS;
1030 if (ret == NET_RX_SUCCESS)
1039 * batadv_v_ogm_init() - initialise the OGM2 engine
1040 * @bat_priv: the bat priv with all the soft interface information
1042 * Return: 0 on success or a negative error code in case of failure
1044 int batadv_v_ogm_init(struct batadv_priv *bat_priv)
1046 struct batadv_ogm2_packet *ogm_packet;
1047 unsigned char *ogm_buff;
1050 bat_priv->bat_v.ogm_buff_len = BATADV_OGM2_HLEN;
1051 ogm_buff = kzalloc(bat_priv->bat_v.ogm_buff_len, GFP_ATOMIC);
1055 bat_priv->bat_v.ogm_buff = ogm_buff;
1056 ogm_packet = (struct batadv_ogm2_packet *)ogm_buff;
1057 ogm_packet->packet_type = BATADV_OGM2;
1058 ogm_packet->version = BATADV_COMPAT_VERSION;
1059 ogm_packet->ttl = BATADV_TTL;
1060 ogm_packet->flags = BATADV_NO_FLAGS;
1061 ogm_packet->throughput = htonl(BATADV_THROUGHPUT_MAX_VALUE);
1063 /* randomize initial seqno to avoid collision */
1064 get_random_bytes(&random_seqno, sizeof(random_seqno));
1065 atomic_set(&bat_priv->bat_v.ogm_seqno, random_seqno);
1066 INIT_DELAYED_WORK(&bat_priv->bat_v.ogm_wq, batadv_v_ogm_send);
1068 mutex_init(&bat_priv->bat_v.ogm_buff_mutex);
1074 * batadv_v_ogm_free() - free OGM private resources
1075 * @bat_priv: the bat priv with all the soft interface information
1077 void batadv_v_ogm_free(struct batadv_priv *bat_priv)
1079 cancel_delayed_work_sync(&bat_priv->bat_v.ogm_wq);
1081 mutex_lock(&bat_priv->bat_v.ogm_buff_mutex);
1083 kfree(bat_priv->bat_v.ogm_buff);
1084 bat_priv->bat_v.ogm_buff = NULL;
1085 bat_priv->bat_v.ogm_buff_len = 0;
1087 mutex_unlock(&bat_priv->bat_v.ogm_buff_mutex);