scsi: cxgb4i: libcxgbi: in error case RST tcp conn
[linux/fpc-iii.git] / net / batman-adv / bat_iv_ogm.c
blob495ba7cdcb0451c997656116a300a49b7e43a089
1 /* Copyright (C) 2007-2017 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/>.
18 #include "bat_iv_ogm.h"
19 #include "main.h"
21 #include <linux/atomic.h>
22 #include <linux/bitmap.h>
23 #include <linux/bitops.h>
24 #include <linux/bug.h>
25 #include <linux/byteorder/generic.h>
26 #include <linux/cache.h>
27 #include <linux/errno.h>
28 #include <linux/etherdevice.h>
29 #include <linux/fs.h>
30 #include <linux/if_ether.h>
31 #include <linux/init.h>
32 #include <linux/jiffies.h>
33 #include <linux/kernel.h>
34 #include <linux/kref.h>
35 #include <linux/list.h>
36 #include <linux/lockdep.h>
37 #include <linux/netdevice.h>
38 #include <linux/netlink.h>
39 #include <linux/pkt_sched.h>
40 #include <linux/printk.h>
41 #include <linux/random.h>
42 #include <linux/rculist.h>
43 #include <linux/rcupdate.h>
44 #include <linux/seq_file.h>
45 #include <linux/skbuff.h>
46 #include <linux/slab.h>
47 #include <linux/spinlock.h>
48 #include <linux/stddef.h>
49 #include <linux/string.h>
50 #include <linux/types.h>
51 #include <linux/workqueue.h>
52 #include <net/genetlink.h>
53 #include <net/netlink.h>
54 #include <uapi/linux/batman_adv.h>
56 #include "bat_algo.h"
57 #include "bitarray.h"
58 #include "gateway_client.h"
59 #include "hard-interface.h"
60 #include "hash.h"
61 #include "log.h"
62 #include "netlink.h"
63 #include "network-coding.h"
64 #include "originator.h"
65 #include "packet.h"
66 #include "routing.h"
67 #include "send.h"
68 #include "translation-table.h"
69 #include "tvlv.h"
71 static void batadv_iv_send_outstanding_bat_ogm_packet(struct work_struct *work);
73 /**
74 * enum batadv_dup_status - duplicate status
75 * @BATADV_NO_DUP: the packet is no duplicate
76 * @BATADV_ORIG_DUP: OGM is a duplicate in the originator (but not for the
77 * neighbor)
78 * @BATADV_NEIGH_DUP: OGM is a duplicate for the neighbor
79 * @BATADV_PROTECTED: originator is currently protected (after reboot)
81 enum batadv_dup_status {
82 BATADV_NO_DUP = 0,
83 BATADV_ORIG_DUP,
84 BATADV_NEIGH_DUP,
85 BATADV_PROTECTED,
88 /**
89 * batadv_ring_buffer_set - update the ring buffer with the given value
90 * @lq_recv: pointer to the ring buffer
91 * @lq_index: index to store the value at
92 * @value: value to store in the ring buffer
94 static void batadv_ring_buffer_set(u8 lq_recv[], u8 *lq_index, u8 value)
96 lq_recv[*lq_index] = value;
97 *lq_index = (*lq_index + 1) % BATADV_TQ_GLOBAL_WINDOW_SIZE;
101 * batadv_ring_buffer_avg - compute the average of all non-zero values stored
102 * in the given ring buffer
103 * @lq_recv: pointer to the ring buffer
105 * Return: computed average value.
107 static u8 batadv_ring_buffer_avg(const u8 lq_recv[])
109 const u8 *ptr;
110 u16 count = 0;
111 u16 i = 0;
112 u16 sum = 0;
114 ptr = lq_recv;
116 while (i < BATADV_TQ_GLOBAL_WINDOW_SIZE) {
117 if (*ptr != 0) {
118 count++;
119 sum += *ptr;
122 i++;
123 ptr++;
126 if (count == 0)
127 return 0;
129 return (u8)(sum / count);
133 * batadv_iv_ogm_orig_free - free the private resources allocated for this
134 * orig_node
135 * @orig_node: the orig_node for which the resources have to be free'd
137 static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node)
139 kfree(orig_node->bat_iv.bcast_own);
140 kfree(orig_node->bat_iv.bcast_own_sum);
144 * batadv_iv_ogm_orig_add_if - change the private structures of the orig_node to
145 * include the new hard-interface
146 * @orig_node: the orig_node that has to be changed
147 * @max_if_num: the current amount of interfaces
149 * Return: 0 on success, a negative error code otherwise.
151 static int batadv_iv_ogm_orig_add_if(struct batadv_orig_node *orig_node,
152 int max_if_num)
154 void *data_ptr;
155 size_t old_size;
156 int ret = -ENOMEM;
158 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
160 old_size = (max_if_num - 1) * sizeof(unsigned long) * BATADV_NUM_WORDS;
161 data_ptr = kmalloc_array(max_if_num,
162 BATADV_NUM_WORDS * sizeof(unsigned long),
163 GFP_ATOMIC);
164 if (!data_ptr)
165 goto unlock;
167 memcpy(data_ptr, orig_node->bat_iv.bcast_own, old_size);
168 kfree(orig_node->bat_iv.bcast_own);
169 orig_node->bat_iv.bcast_own = data_ptr;
171 data_ptr = kmalloc_array(max_if_num, sizeof(u8), GFP_ATOMIC);
172 if (!data_ptr)
173 goto unlock;
175 memcpy(data_ptr, orig_node->bat_iv.bcast_own_sum,
176 (max_if_num - 1) * sizeof(u8));
177 kfree(orig_node->bat_iv.bcast_own_sum);
178 orig_node->bat_iv.bcast_own_sum = data_ptr;
180 ret = 0;
182 unlock:
183 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
185 return ret;
189 * batadv_iv_ogm_drop_bcast_own_entry - drop section of bcast_own
190 * @orig_node: the orig_node that has to be changed
191 * @max_if_num: the current amount of interfaces
192 * @del_if_num: the index of the interface being removed
194 static void
195 batadv_iv_ogm_drop_bcast_own_entry(struct batadv_orig_node *orig_node,
196 int max_if_num, int del_if_num)
198 size_t chunk_size;
199 size_t if_offset;
200 void *data_ptr;
202 lockdep_assert_held(&orig_node->bat_iv.ogm_cnt_lock);
204 chunk_size = sizeof(unsigned long) * BATADV_NUM_WORDS;
205 data_ptr = kmalloc_array(max_if_num, chunk_size, GFP_ATOMIC);
206 if (!data_ptr)
207 /* use old buffer when new one could not be allocated */
208 data_ptr = orig_node->bat_iv.bcast_own;
210 /* copy first part */
211 memmove(data_ptr, orig_node->bat_iv.bcast_own, del_if_num * chunk_size);
213 /* copy second part */
214 if_offset = (del_if_num + 1) * chunk_size;
215 memmove((char *)data_ptr + del_if_num * chunk_size,
216 (uint8_t *)orig_node->bat_iv.bcast_own + if_offset,
217 (max_if_num - del_if_num) * chunk_size);
219 /* bcast_own was shrunk down in new buffer; free old one */
220 if (orig_node->bat_iv.bcast_own != data_ptr) {
221 kfree(orig_node->bat_iv.bcast_own);
222 orig_node->bat_iv.bcast_own = data_ptr;
227 * batadv_iv_ogm_drop_bcast_own_sum_entry - drop section of bcast_own_sum
228 * @orig_node: the orig_node that has to be changed
229 * @max_if_num: the current amount of interfaces
230 * @del_if_num: the index of the interface being removed
232 static void
233 batadv_iv_ogm_drop_bcast_own_sum_entry(struct batadv_orig_node *orig_node,
234 int max_if_num, int del_if_num)
236 size_t if_offset;
237 void *data_ptr;
239 lockdep_assert_held(&orig_node->bat_iv.ogm_cnt_lock);
241 data_ptr = kmalloc_array(max_if_num, sizeof(u8), GFP_ATOMIC);
242 if (!data_ptr)
243 /* use old buffer when new one could not be allocated */
244 data_ptr = orig_node->bat_iv.bcast_own_sum;
246 memmove(data_ptr, orig_node->bat_iv.bcast_own_sum,
247 del_if_num * sizeof(u8));
249 if_offset = (del_if_num + 1) * sizeof(u8);
250 memmove((char *)data_ptr + del_if_num * sizeof(u8),
251 orig_node->bat_iv.bcast_own_sum + if_offset,
252 (max_if_num - del_if_num) * sizeof(u8));
254 /* bcast_own_sum was shrunk down in new buffer; free old one */
255 if (orig_node->bat_iv.bcast_own_sum != data_ptr) {
256 kfree(orig_node->bat_iv.bcast_own_sum);
257 orig_node->bat_iv.bcast_own_sum = data_ptr;
262 * batadv_iv_ogm_orig_del_if - change the private structures of the orig_node to
263 * exclude the removed interface
264 * @orig_node: the orig_node that has to be changed
265 * @max_if_num: the current amount of interfaces
266 * @del_if_num: the index of the interface being removed
268 * Return: 0 on success, a negative error code otherwise.
270 static int batadv_iv_ogm_orig_del_if(struct batadv_orig_node *orig_node,
271 int max_if_num, int del_if_num)
273 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
275 if (max_if_num == 0) {
276 kfree(orig_node->bat_iv.bcast_own);
277 kfree(orig_node->bat_iv.bcast_own_sum);
278 orig_node->bat_iv.bcast_own = NULL;
279 orig_node->bat_iv.bcast_own_sum = NULL;
280 } else {
281 batadv_iv_ogm_drop_bcast_own_entry(orig_node, max_if_num,
282 del_if_num);
283 batadv_iv_ogm_drop_bcast_own_sum_entry(orig_node, max_if_num,
284 del_if_num);
287 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
289 return 0;
293 * batadv_iv_ogm_orig_get - retrieve or create (if does not exist) an originator
294 * @bat_priv: the bat priv with all the soft interface information
295 * @addr: mac address of the originator
297 * Return: the originator object corresponding to the passed mac address or NULL
298 * on failure.
299 * If the object does not exists it is created an initialised.
301 static struct batadv_orig_node *
302 batadv_iv_ogm_orig_get(struct batadv_priv *bat_priv, const u8 *addr)
304 struct batadv_orig_node *orig_node;
305 int size, hash_added;
307 orig_node = batadv_orig_hash_find(bat_priv, addr);
308 if (orig_node)
309 return orig_node;
311 orig_node = batadv_orig_node_new(bat_priv, addr);
312 if (!orig_node)
313 return NULL;
315 spin_lock_init(&orig_node->bat_iv.ogm_cnt_lock);
317 size = bat_priv->num_ifaces * sizeof(unsigned long) * BATADV_NUM_WORDS;
318 orig_node->bat_iv.bcast_own = kzalloc(size, GFP_ATOMIC);
319 if (!orig_node->bat_iv.bcast_own)
320 goto free_orig_node;
322 size = bat_priv->num_ifaces * sizeof(u8);
323 orig_node->bat_iv.bcast_own_sum = kzalloc(size, GFP_ATOMIC);
324 if (!orig_node->bat_iv.bcast_own_sum)
325 goto free_orig_node;
327 kref_get(&orig_node->refcount);
328 hash_added = batadv_hash_add(bat_priv->orig_hash, batadv_compare_orig,
329 batadv_choose_orig, orig_node,
330 &orig_node->hash_entry);
331 if (hash_added != 0)
332 goto free_orig_node_hash;
334 return orig_node;
336 free_orig_node_hash:
337 batadv_orig_node_put(orig_node);
338 free_orig_node:
339 batadv_orig_node_put(orig_node);
341 return NULL;
344 static struct batadv_neigh_node *
345 batadv_iv_ogm_neigh_new(struct batadv_hard_iface *hard_iface,
346 const u8 *neigh_addr,
347 struct batadv_orig_node *orig_node,
348 struct batadv_orig_node *orig_neigh)
350 struct batadv_neigh_node *neigh_node;
352 neigh_node = batadv_neigh_node_get_or_create(orig_node,
353 hard_iface, neigh_addr);
354 if (!neigh_node)
355 goto out;
357 neigh_node->orig_node = orig_neigh;
359 out:
360 return neigh_node;
363 static int batadv_iv_ogm_iface_enable(struct batadv_hard_iface *hard_iface)
365 struct batadv_ogm_packet *batadv_ogm_packet;
366 unsigned char *ogm_buff;
367 u32 random_seqno;
369 /* randomize initial seqno to avoid collision */
370 get_random_bytes(&random_seqno, sizeof(random_seqno));
371 atomic_set(&hard_iface->bat_iv.ogm_seqno, random_seqno);
373 hard_iface->bat_iv.ogm_buff_len = BATADV_OGM_HLEN;
374 ogm_buff = kmalloc(hard_iface->bat_iv.ogm_buff_len, GFP_ATOMIC);
375 if (!ogm_buff)
376 return -ENOMEM;
378 hard_iface->bat_iv.ogm_buff = ogm_buff;
380 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
381 batadv_ogm_packet->packet_type = BATADV_IV_OGM;
382 batadv_ogm_packet->version = BATADV_COMPAT_VERSION;
383 batadv_ogm_packet->ttl = 2;
384 batadv_ogm_packet->flags = BATADV_NO_FLAGS;
385 batadv_ogm_packet->reserved = 0;
386 batadv_ogm_packet->tq = BATADV_TQ_MAX_VALUE;
388 return 0;
391 static void batadv_iv_ogm_iface_disable(struct batadv_hard_iface *hard_iface)
393 kfree(hard_iface->bat_iv.ogm_buff);
394 hard_iface->bat_iv.ogm_buff = NULL;
397 static void batadv_iv_ogm_iface_update_mac(struct batadv_hard_iface *hard_iface)
399 struct batadv_ogm_packet *batadv_ogm_packet;
400 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
402 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
403 ether_addr_copy(batadv_ogm_packet->orig,
404 hard_iface->net_dev->dev_addr);
405 ether_addr_copy(batadv_ogm_packet->prev_sender,
406 hard_iface->net_dev->dev_addr);
409 static void
410 batadv_iv_ogm_primary_iface_set(struct batadv_hard_iface *hard_iface)
412 struct batadv_ogm_packet *batadv_ogm_packet;
413 unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
415 batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
416 batadv_ogm_packet->ttl = BATADV_TTL;
419 /* when do we schedule our own ogm to be sent */
420 static unsigned long
421 batadv_iv_ogm_emit_send_time(const struct batadv_priv *bat_priv)
423 unsigned int msecs;
425 msecs = atomic_read(&bat_priv->orig_interval) - BATADV_JITTER;
426 msecs += prandom_u32() % (2 * BATADV_JITTER);
428 return jiffies + msecs_to_jiffies(msecs);
431 /* when do we schedule a ogm packet to be sent */
432 static unsigned long batadv_iv_ogm_fwd_send_time(void)
434 return jiffies + msecs_to_jiffies(prandom_u32() % (BATADV_JITTER / 2));
437 /* apply hop penalty for a normal link */
438 static u8 batadv_hop_penalty(u8 tq, const struct batadv_priv *bat_priv)
440 int hop_penalty = atomic_read(&bat_priv->hop_penalty);
441 int new_tq;
443 new_tq = tq * (BATADV_TQ_MAX_VALUE - hop_penalty);
444 new_tq /= BATADV_TQ_MAX_VALUE;
446 return new_tq;
450 * batadv_iv_ogm_aggr_packet - checks if there is another OGM attached
451 * @buff_pos: current position in the skb
452 * @packet_len: total length of the skb
453 * @tvlv_len: tvlv length of the previously considered OGM
455 * Return: true if there is enough space for another OGM, false otherwise.
457 static bool batadv_iv_ogm_aggr_packet(int buff_pos, int packet_len,
458 __be16 tvlv_len)
460 int next_buff_pos = 0;
462 next_buff_pos += buff_pos + BATADV_OGM_HLEN;
463 next_buff_pos += ntohs(tvlv_len);
465 return (next_buff_pos <= packet_len) &&
466 (next_buff_pos <= BATADV_MAX_AGGREGATION_BYTES);
469 /* send a batman ogm to a given interface */
470 static void batadv_iv_ogm_send_to_if(struct batadv_forw_packet *forw_packet,
471 struct batadv_hard_iface *hard_iface)
473 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
474 const char *fwd_str;
475 u8 packet_num;
476 s16 buff_pos;
477 struct batadv_ogm_packet *batadv_ogm_packet;
478 struct sk_buff *skb;
479 u8 *packet_pos;
481 if (hard_iface->if_status != BATADV_IF_ACTIVE)
482 return;
484 packet_num = 0;
485 buff_pos = 0;
486 packet_pos = forw_packet->skb->data;
487 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
489 /* adjust all flags and log packets */
490 while (batadv_iv_ogm_aggr_packet(buff_pos, forw_packet->packet_len,
491 batadv_ogm_packet->tvlv_len)) {
492 /* we might have aggregated direct link packets with an
493 * ordinary base packet
495 if (forw_packet->direct_link_flags & BIT(packet_num) &&
496 forw_packet->if_incoming == hard_iface)
497 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
498 else
499 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
501 if (packet_num > 0 || !forw_packet->own)
502 fwd_str = "Forwarding";
503 else
504 fwd_str = "Sending own";
506 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
507 "%s %spacket (originator %pM, seqno %u, TQ %d, TTL %d, IDF %s) on interface %s [%pM]\n",
508 fwd_str, (packet_num > 0 ? "aggregated " : ""),
509 batadv_ogm_packet->orig,
510 ntohl(batadv_ogm_packet->seqno),
511 batadv_ogm_packet->tq, batadv_ogm_packet->ttl,
512 ((batadv_ogm_packet->flags & BATADV_DIRECTLINK) ?
513 "on" : "off"),
514 hard_iface->net_dev->name,
515 hard_iface->net_dev->dev_addr);
517 buff_pos += BATADV_OGM_HLEN;
518 buff_pos += ntohs(batadv_ogm_packet->tvlv_len);
519 packet_num++;
520 packet_pos = forw_packet->skb->data + buff_pos;
521 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
524 /* create clone because function is called more than once */
525 skb = skb_clone(forw_packet->skb, GFP_ATOMIC);
526 if (skb) {
527 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_TX);
528 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_TX_BYTES,
529 skb->len + ETH_HLEN);
530 batadv_send_broadcast_skb(skb, hard_iface);
534 /* send a batman ogm packet */
535 static void batadv_iv_ogm_emit(struct batadv_forw_packet *forw_packet)
537 struct net_device *soft_iface;
539 if (!forw_packet->if_incoming) {
540 pr_err("Error - can't forward packet: incoming iface not specified\n");
541 return;
544 soft_iface = forw_packet->if_incoming->soft_iface;
546 if (WARN_ON(!forw_packet->if_outgoing))
547 return;
549 if (WARN_ON(forw_packet->if_outgoing->soft_iface != soft_iface))
550 return;
552 if (forw_packet->if_incoming->if_status != BATADV_IF_ACTIVE)
553 return;
555 /* only for one specific outgoing interface */
556 batadv_iv_ogm_send_to_if(forw_packet, forw_packet->if_outgoing);
560 * batadv_iv_ogm_can_aggregate - find out if an OGM can be aggregated on an
561 * existing forward packet
562 * @new_bat_ogm_packet: OGM packet to be aggregated
563 * @bat_priv: the bat priv with all the soft interface information
564 * @packet_len: (total) length of the OGM
565 * @send_time: timestamp (jiffies) when the packet is to be sent
566 * @directlink: true if this is a direct link packet
567 * @if_incoming: interface where the packet was received
568 * @if_outgoing: interface for which the retransmission should be considered
569 * @forw_packet: the forwarded packet which should be checked
571 * Return: true if new_packet can be aggregated with forw_packet
573 static bool
574 batadv_iv_ogm_can_aggregate(const struct batadv_ogm_packet *new_bat_ogm_packet,
575 struct batadv_priv *bat_priv,
576 int packet_len, unsigned long send_time,
577 bool directlink,
578 const struct batadv_hard_iface *if_incoming,
579 const struct batadv_hard_iface *if_outgoing,
580 const struct batadv_forw_packet *forw_packet)
582 struct batadv_ogm_packet *batadv_ogm_packet;
583 int aggregated_bytes = forw_packet->packet_len + packet_len;
584 struct batadv_hard_iface *primary_if = NULL;
585 bool res = false;
586 unsigned long aggregation_end_time;
588 batadv_ogm_packet = (struct batadv_ogm_packet *)forw_packet->skb->data;
589 aggregation_end_time = send_time;
590 aggregation_end_time += msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
592 /* we can aggregate the current packet to this aggregated packet
593 * if:
595 * - the send time is within our MAX_AGGREGATION_MS time
596 * - the resulting packet wont be bigger than
597 * MAX_AGGREGATION_BYTES
598 * otherwise aggregation is not possible
600 if (!time_before(send_time, forw_packet->send_time) ||
601 !time_after_eq(aggregation_end_time, forw_packet->send_time))
602 return false;
604 if (aggregated_bytes > BATADV_MAX_AGGREGATION_BYTES)
605 return false;
607 /* packet is not leaving on the same interface. */
608 if (forw_packet->if_outgoing != if_outgoing)
609 return false;
611 /* check aggregation compatibility
612 * -> direct link packets are broadcasted on
613 * their interface only
614 * -> aggregate packet if the current packet is
615 * a "global" packet as well as the base
616 * packet
618 primary_if = batadv_primary_if_get_selected(bat_priv);
619 if (!primary_if)
620 return false;
622 /* packets without direct link flag and high TTL
623 * are flooded through the net
625 if (!directlink &&
626 !(batadv_ogm_packet->flags & BATADV_DIRECTLINK) &&
627 batadv_ogm_packet->ttl != 1 &&
629 /* own packets originating non-primary
630 * interfaces leave only that interface
632 (!forw_packet->own ||
633 forw_packet->if_incoming == primary_if)) {
634 res = true;
635 goto out;
638 /* if the incoming packet is sent via this one
639 * interface only - we still can aggregate
641 if (directlink &&
642 new_bat_ogm_packet->ttl == 1 &&
643 forw_packet->if_incoming == if_incoming &&
645 /* packets from direct neighbors or
646 * own secondary interface packets
647 * (= secondary interface packets in general)
649 (batadv_ogm_packet->flags & BATADV_DIRECTLINK ||
650 (forw_packet->own &&
651 forw_packet->if_incoming != primary_if))) {
652 res = true;
653 goto out;
656 out:
657 if (primary_if)
658 batadv_hardif_put(primary_if);
659 return res;
663 * batadv_iv_ogm_aggregate_new - create a new aggregated packet and add this
664 * packet to it.
665 * @packet_buff: pointer to the OGM
666 * @packet_len: (total) length of the OGM
667 * @send_time: timestamp (jiffies) when the packet is to be sent
668 * @direct_link: whether this OGM has direct link status
669 * @if_incoming: interface where the packet was received
670 * @if_outgoing: interface for which the retransmission should be considered
671 * @own_packet: true if it is a self-generated ogm
673 static void batadv_iv_ogm_aggregate_new(const unsigned char *packet_buff,
674 int packet_len, unsigned long send_time,
675 bool direct_link,
676 struct batadv_hard_iface *if_incoming,
677 struct batadv_hard_iface *if_outgoing,
678 int own_packet)
680 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
681 struct batadv_forw_packet *forw_packet_aggr;
682 struct sk_buff *skb;
683 unsigned char *skb_buff;
684 unsigned int skb_size;
685 atomic_t *queue_left = own_packet ? NULL : &bat_priv->batman_queue_left;
687 if (atomic_read(&bat_priv->aggregated_ogms) &&
688 packet_len < BATADV_MAX_AGGREGATION_BYTES)
689 skb_size = BATADV_MAX_AGGREGATION_BYTES;
690 else
691 skb_size = packet_len;
693 skb_size += ETH_HLEN;
695 skb = netdev_alloc_skb_ip_align(NULL, skb_size);
696 if (!skb)
697 return;
699 forw_packet_aggr = batadv_forw_packet_alloc(if_incoming, if_outgoing,
700 queue_left, bat_priv, skb);
701 if (!forw_packet_aggr) {
702 kfree_skb(skb);
703 return;
706 forw_packet_aggr->skb->priority = TC_PRIO_CONTROL;
707 skb_reserve(forw_packet_aggr->skb, ETH_HLEN);
709 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
710 forw_packet_aggr->packet_len = packet_len;
711 memcpy(skb_buff, packet_buff, packet_len);
713 forw_packet_aggr->own = own_packet;
714 forw_packet_aggr->direct_link_flags = BATADV_NO_FLAGS;
715 forw_packet_aggr->send_time = send_time;
717 /* save packet direct link flag status */
718 if (direct_link)
719 forw_packet_aggr->direct_link_flags |= 1;
721 INIT_DELAYED_WORK(&forw_packet_aggr->delayed_work,
722 batadv_iv_send_outstanding_bat_ogm_packet);
724 batadv_forw_packet_ogmv1_queue(bat_priv, forw_packet_aggr, send_time);
727 /* aggregate a new packet into the existing ogm packet */
728 static void batadv_iv_ogm_aggregate(struct batadv_forw_packet *forw_packet_aggr,
729 const unsigned char *packet_buff,
730 int packet_len, bool direct_link)
732 unsigned char *skb_buff;
733 unsigned long new_direct_link_flag;
735 skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
736 memcpy(skb_buff, packet_buff, packet_len);
737 forw_packet_aggr->packet_len += packet_len;
738 forw_packet_aggr->num_packets++;
740 /* save packet direct link flag status */
741 if (direct_link) {
742 new_direct_link_flag = BIT(forw_packet_aggr->num_packets);
743 forw_packet_aggr->direct_link_flags |= new_direct_link_flag;
748 * batadv_iv_ogm_queue_add - queue up an OGM for transmission
749 * @bat_priv: the bat priv with all the soft interface information
750 * @packet_buff: pointer to the OGM
751 * @packet_len: (total) length of the OGM
752 * @if_incoming: interface where the packet was received
753 * @if_outgoing: interface for which the retransmission should be considered
754 * @own_packet: true if it is a self-generated ogm
755 * @send_time: timestamp (jiffies) when the packet is to be sent
757 static void batadv_iv_ogm_queue_add(struct batadv_priv *bat_priv,
758 unsigned char *packet_buff,
759 int packet_len,
760 struct batadv_hard_iface *if_incoming,
761 struct batadv_hard_iface *if_outgoing,
762 int own_packet, unsigned long send_time)
764 /* _aggr -> pointer to the packet we want to aggregate with
765 * _pos -> pointer to the position in the queue
767 struct batadv_forw_packet *forw_packet_aggr = NULL;
768 struct batadv_forw_packet *forw_packet_pos = NULL;
769 struct batadv_ogm_packet *batadv_ogm_packet;
770 bool direct_link;
771 unsigned long max_aggregation_jiffies;
773 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_buff;
774 direct_link = !!(batadv_ogm_packet->flags & BATADV_DIRECTLINK);
775 max_aggregation_jiffies = msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
777 /* find position for the packet in the forward queue */
778 spin_lock_bh(&bat_priv->forw_bat_list_lock);
779 /* own packets are not to be aggregated */
780 if (atomic_read(&bat_priv->aggregated_ogms) && !own_packet) {
781 hlist_for_each_entry(forw_packet_pos,
782 &bat_priv->forw_bat_list, list) {
783 if (batadv_iv_ogm_can_aggregate(batadv_ogm_packet,
784 bat_priv, packet_len,
785 send_time, direct_link,
786 if_incoming,
787 if_outgoing,
788 forw_packet_pos)) {
789 forw_packet_aggr = forw_packet_pos;
790 break;
795 /* nothing to aggregate with - either aggregation disabled or no
796 * suitable aggregation packet found
798 if (!forw_packet_aggr) {
799 /* the following section can run without the lock */
800 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
802 /* if we could not aggregate this packet with one of the others
803 * we hold it back for a while, so that it might be aggregated
804 * later on
806 if (!own_packet && atomic_read(&bat_priv->aggregated_ogms))
807 send_time += max_aggregation_jiffies;
809 batadv_iv_ogm_aggregate_new(packet_buff, packet_len,
810 send_time, direct_link,
811 if_incoming, if_outgoing,
812 own_packet);
813 } else {
814 batadv_iv_ogm_aggregate(forw_packet_aggr, packet_buff,
815 packet_len, direct_link);
816 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
820 static void batadv_iv_ogm_forward(struct batadv_orig_node *orig_node,
821 const struct ethhdr *ethhdr,
822 struct batadv_ogm_packet *batadv_ogm_packet,
823 bool is_single_hop_neigh,
824 bool is_from_best_next_hop,
825 struct batadv_hard_iface *if_incoming,
826 struct batadv_hard_iface *if_outgoing)
828 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
829 u16 tvlv_len;
831 if (batadv_ogm_packet->ttl <= 1) {
832 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "ttl exceeded\n");
833 return;
836 if (!is_from_best_next_hop) {
837 /* Mark the forwarded packet when it is not coming from our
838 * best next hop. We still need to forward the packet for our
839 * neighbor link quality detection to work in case the packet
840 * originated from a single hop neighbor. Otherwise we can
841 * simply drop the ogm.
843 if (is_single_hop_neigh)
844 batadv_ogm_packet->flags |= BATADV_NOT_BEST_NEXT_HOP;
845 else
846 return;
849 tvlv_len = ntohs(batadv_ogm_packet->tvlv_len);
851 batadv_ogm_packet->ttl--;
852 ether_addr_copy(batadv_ogm_packet->prev_sender, ethhdr->h_source);
854 /* apply hop penalty */
855 batadv_ogm_packet->tq = batadv_hop_penalty(batadv_ogm_packet->tq,
856 bat_priv);
858 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
859 "Forwarding packet: tq: %i, ttl: %i\n",
860 batadv_ogm_packet->tq, batadv_ogm_packet->ttl);
862 if (is_single_hop_neigh)
863 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
864 else
865 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
867 batadv_iv_ogm_queue_add(bat_priv, (unsigned char *)batadv_ogm_packet,
868 BATADV_OGM_HLEN + tvlv_len,
869 if_incoming, if_outgoing, 0,
870 batadv_iv_ogm_fwd_send_time());
874 * batadv_iv_ogm_slide_own_bcast_window - bitshift own OGM broadcast windows for
875 * the given interface
876 * @hard_iface: the interface for which the windows have to be shifted
878 static void
879 batadv_iv_ogm_slide_own_bcast_window(struct batadv_hard_iface *hard_iface)
881 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
882 struct batadv_hashtable *hash = bat_priv->orig_hash;
883 struct hlist_head *head;
884 struct batadv_orig_node *orig_node;
885 unsigned long *word;
886 u32 i;
887 size_t word_index;
888 u8 *w;
889 int if_num;
891 for (i = 0; i < hash->size; i++) {
892 head = &hash->table[i];
894 rcu_read_lock();
895 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
896 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
897 word_index = hard_iface->if_num * BATADV_NUM_WORDS;
898 word = &orig_node->bat_iv.bcast_own[word_index];
900 batadv_bit_get_packet(bat_priv, word, 1, 0);
901 if_num = hard_iface->if_num;
902 w = &orig_node->bat_iv.bcast_own_sum[if_num];
903 *w = bitmap_weight(word, BATADV_TQ_LOCAL_WINDOW_SIZE);
904 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
906 rcu_read_unlock();
910 static void batadv_iv_ogm_schedule(struct batadv_hard_iface *hard_iface)
912 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
913 unsigned char **ogm_buff = &hard_iface->bat_iv.ogm_buff;
914 struct batadv_ogm_packet *batadv_ogm_packet;
915 struct batadv_hard_iface *primary_if, *tmp_hard_iface;
916 int *ogm_buff_len = &hard_iface->bat_iv.ogm_buff_len;
917 u32 seqno;
918 u16 tvlv_len = 0;
919 unsigned long send_time;
921 if ((hard_iface->if_status == BATADV_IF_NOT_IN_USE) ||
922 (hard_iface->if_status == BATADV_IF_TO_BE_REMOVED))
923 return;
925 /* the interface gets activated here to avoid race conditions between
926 * the moment of activating the interface in
927 * hardif_activate_interface() where the originator mac is set and
928 * outdated packets (especially uninitialized mac addresses) in the
929 * packet queue
931 if (hard_iface->if_status == BATADV_IF_TO_BE_ACTIVATED)
932 hard_iface->if_status = BATADV_IF_ACTIVE;
934 primary_if = batadv_primary_if_get_selected(bat_priv);
936 if (hard_iface == primary_if) {
937 /* tt changes have to be committed before the tvlv data is
938 * appended as it may alter the tt tvlv container
940 batadv_tt_local_commit_changes(bat_priv);
941 tvlv_len = batadv_tvlv_container_ogm_append(bat_priv, ogm_buff,
942 ogm_buff_len,
943 BATADV_OGM_HLEN);
946 batadv_ogm_packet = (struct batadv_ogm_packet *)(*ogm_buff);
947 batadv_ogm_packet->tvlv_len = htons(tvlv_len);
949 /* change sequence number to network order */
950 seqno = (u32)atomic_read(&hard_iface->bat_iv.ogm_seqno);
951 batadv_ogm_packet->seqno = htonl(seqno);
952 atomic_inc(&hard_iface->bat_iv.ogm_seqno);
954 batadv_iv_ogm_slide_own_bcast_window(hard_iface);
956 send_time = batadv_iv_ogm_emit_send_time(bat_priv);
958 if (hard_iface != primary_if) {
959 /* OGMs from secondary interfaces are only scheduled on their
960 * respective interfaces.
962 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff, *ogm_buff_len,
963 hard_iface, hard_iface, 1, send_time);
964 goto out;
967 /* OGMs from primary interfaces are scheduled on all
968 * interfaces.
970 rcu_read_lock();
971 list_for_each_entry_rcu(tmp_hard_iface, &batadv_hardif_list, list) {
972 if (tmp_hard_iface->soft_iface != hard_iface->soft_iface)
973 continue;
975 if (!kref_get_unless_zero(&tmp_hard_iface->refcount))
976 continue;
978 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff,
979 *ogm_buff_len, hard_iface,
980 tmp_hard_iface, 1, send_time);
982 batadv_hardif_put(tmp_hard_iface);
984 rcu_read_unlock();
986 out:
987 if (primary_if)
988 batadv_hardif_put(primary_if);
992 * batadv_iv_ogm_orig_update - use OGM to update corresponding data in an
993 * originator
994 * @bat_priv: the bat priv with all the soft interface information
995 * @orig_node: the orig node who originally emitted the ogm packet
996 * @orig_ifinfo: ifinfo for the outgoing interface of the orig_node
997 * @ethhdr: Ethernet header of the OGM
998 * @batadv_ogm_packet: the ogm packet
999 * @if_incoming: interface where the packet was received
1000 * @if_outgoing: interface for which the retransmission should be considered
1001 * @dup_status: the duplicate status of this ogm packet.
1003 static void
1004 batadv_iv_ogm_orig_update(struct batadv_priv *bat_priv,
1005 struct batadv_orig_node *orig_node,
1006 struct batadv_orig_ifinfo *orig_ifinfo,
1007 const struct ethhdr *ethhdr,
1008 const struct batadv_ogm_packet *batadv_ogm_packet,
1009 struct batadv_hard_iface *if_incoming,
1010 struct batadv_hard_iface *if_outgoing,
1011 enum batadv_dup_status dup_status)
1013 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL;
1014 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
1015 struct batadv_neigh_node *neigh_node = NULL;
1016 struct batadv_neigh_node *tmp_neigh_node = NULL;
1017 struct batadv_neigh_node *router = NULL;
1018 struct batadv_orig_node *orig_node_tmp;
1019 int if_num;
1020 u8 sum_orig, sum_neigh;
1021 u8 *neigh_addr;
1022 u8 tq_avg;
1024 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1025 "update_originator(): Searching and updating originator entry of received packet\n");
1027 rcu_read_lock();
1028 hlist_for_each_entry_rcu(tmp_neigh_node,
1029 &orig_node->neigh_list, list) {
1030 neigh_addr = tmp_neigh_node->addr;
1031 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1032 tmp_neigh_node->if_incoming == if_incoming &&
1033 kref_get_unless_zero(&tmp_neigh_node->refcount)) {
1034 if (WARN(neigh_node, "too many matching neigh_nodes"))
1035 batadv_neigh_node_put(neigh_node);
1036 neigh_node = tmp_neigh_node;
1037 continue;
1040 if (dup_status != BATADV_NO_DUP)
1041 continue;
1043 /* only update the entry for this outgoing interface */
1044 neigh_ifinfo = batadv_neigh_ifinfo_get(tmp_neigh_node,
1045 if_outgoing);
1046 if (!neigh_ifinfo)
1047 continue;
1049 spin_lock_bh(&tmp_neigh_node->ifinfo_lock);
1050 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1051 &neigh_ifinfo->bat_iv.tq_index, 0);
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(&tmp_neigh_node->ifinfo_lock);
1056 batadv_neigh_ifinfo_put(neigh_ifinfo);
1057 neigh_ifinfo = NULL;
1060 if (!neigh_node) {
1061 struct batadv_orig_node *orig_tmp;
1063 orig_tmp = batadv_iv_ogm_orig_get(bat_priv, ethhdr->h_source);
1064 if (!orig_tmp)
1065 goto unlock;
1067 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1068 ethhdr->h_source,
1069 orig_node, orig_tmp);
1071 batadv_orig_node_put(orig_tmp);
1072 if (!neigh_node)
1073 goto unlock;
1074 } else {
1075 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1076 "Updating existing last-hop neighbor of originator\n");
1079 rcu_read_unlock();
1080 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1081 if (!neigh_ifinfo)
1082 goto out;
1084 neigh_node->last_seen = jiffies;
1086 spin_lock_bh(&neigh_node->ifinfo_lock);
1087 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1088 &neigh_ifinfo->bat_iv.tq_index,
1089 batadv_ogm_packet->tq);
1090 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1091 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1092 spin_unlock_bh(&neigh_node->ifinfo_lock);
1094 if (dup_status == BATADV_NO_DUP) {
1095 orig_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1096 neigh_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1099 /* if this neighbor already is our next hop there is nothing
1100 * to change
1102 router = batadv_orig_router_get(orig_node, if_outgoing);
1103 if (router == neigh_node)
1104 goto out;
1106 if (router) {
1107 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1108 if (!router_ifinfo)
1109 goto out;
1111 /* if this neighbor does not offer a better TQ we won't
1112 * consider it
1114 if (router_ifinfo->bat_iv.tq_avg > neigh_ifinfo->bat_iv.tq_avg)
1115 goto out;
1118 /* if the TQ is the same and the link not more symmetric we
1119 * won't consider it either
1121 if (router_ifinfo &&
1122 neigh_ifinfo->bat_iv.tq_avg == router_ifinfo->bat_iv.tq_avg) {
1123 orig_node_tmp = router->orig_node;
1124 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1125 if_num = router->if_incoming->if_num;
1126 sum_orig = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1127 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1129 orig_node_tmp = neigh_node->orig_node;
1130 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1131 if_num = neigh_node->if_incoming->if_num;
1132 sum_neigh = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1133 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1135 if (sum_orig >= sum_neigh)
1136 goto out;
1139 batadv_update_route(bat_priv, orig_node, if_outgoing, neigh_node);
1140 goto out;
1142 unlock:
1143 rcu_read_unlock();
1144 out:
1145 if (neigh_node)
1146 batadv_neigh_node_put(neigh_node);
1147 if (router)
1148 batadv_neigh_node_put(router);
1149 if (neigh_ifinfo)
1150 batadv_neigh_ifinfo_put(neigh_ifinfo);
1151 if (router_ifinfo)
1152 batadv_neigh_ifinfo_put(router_ifinfo);
1156 * batadv_iv_ogm_calc_tq - calculate tq for current received ogm packet
1157 * @orig_node: the orig node who originally emitted the ogm packet
1158 * @orig_neigh_node: the orig node struct of the neighbor who sent the packet
1159 * @batadv_ogm_packet: the ogm packet
1160 * @if_incoming: interface where the packet was received
1161 * @if_outgoing: interface for which the retransmission should be considered
1163 * Return: true if the link can be considered bidirectional, false otherwise
1165 static bool batadv_iv_ogm_calc_tq(struct batadv_orig_node *orig_node,
1166 struct batadv_orig_node *orig_neigh_node,
1167 struct batadv_ogm_packet *batadv_ogm_packet,
1168 struct batadv_hard_iface *if_incoming,
1169 struct batadv_hard_iface *if_outgoing)
1171 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1172 struct batadv_neigh_node *neigh_node = NULL, *tmp_neigh_node;
1173 struct batadv_neigh_ifinfo *neigh_ifinfo;
1174 u8 total_count;
1175 u8 orig_eq_count, neigh_rq_count, neigh_rq_inv, tq_own;
1176 unsigned int neigh_rq_inv_cube, neigh_rq_max_cube;
1177 int if_num;
1178 unsigned int tq_asym_penalty, inv_asym_penalty;
1179 unsigned int combined_tq;
1180 unsigned int tq_iface_penalty;
1181 bool ret = false;
1183 /* find corresponding one hop neighbor */
1184 rcu_read_lock();
1185 hlist_for_each_entry_rcu(tmp_neigh_node,
1186 &orig_neigh_node->neigh_list, list) {
1187 if (!batadv_compare_eth(tmp_neigh_node->addr,
1188 orig_neigh_node->orig))
1189 continue;
1191 if (tmp_neigh_node->if_incoming != if_incoming)
1192 continue;
1194 if (!kref_get_unless_zero(&tmp_neigh_node->refcount))
1195 continue;
1197 neigh_node = tmp_neigh_node;
1198 break;
1200 rcu_read_unlock();
1202 if (!neigh_node)
1203 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1204 orig_neigh_node->orig,
1205 orig_neigh_node,
1206 orig_neigh_node);
1208 if (!neigh_node)
1209 goto out;
1211 /* if orig_node is direct neighbor update neigh_node last_seen */
1212 if (orig_node == orig_neigh_node)
1213 neigh_node->last_seen = jiffies;
1215 orig_node->last_seen = jiffies;
1217 /* find packet count of corresponding one hop neighbor */
1218 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1219 if_num = if_incoming->if_num;
1220 orig_eq_count = orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1221 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1222 if (neigh_ifinfo) {
1223 neigh_rq_count = neigh_ifinfo->bat_iv.real_packet_count;
1224 batadv_neigh_ifinfo_put(neigh_ifinfo);
1225 } else {
1226 neigh_rq_count = 0;
1228 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1230 /* pay attention to not get a value bigger than 100 % */
1231 if (orig_eq_count > neigh_rq_count)
1232 total_count = neigh_rq_count;
1233 else
1234 total_count = orig_eq_count;
1236 /* if we have too few packets (too less data) we set tq_own to zero
1237 * if we receive too few packets it is not considered bidirectional
1239 if (total_count < BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM ||
1240 neigh_rq_count < BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM)
1241 tq_own = 0;
1242 else
1243 /* neigh_node->real_packet_count is never zero as we
1244 * only purge old information when getting new
1245 * information
1247 tq_own = (BATADV_TQ_MAX_VALUE * total_count) / neigh_rq_count;
1249 /* 1 - ((1-x) ** 3), normalized to TQ_MAX_VALUE this does
1250 * affect the nearly-symmetric links only a little, but
1251 * punishes asymmetric links more. This will give a value
1252 * between 0 and TQ_MAX_VALUE
1254 neigh_rq_inv = BATADV_TQ_LOCAL_WINDOW_SIZE - neigh_rq_count;
1255 neigh_rq_inv_cube = neigh_rq_inv * neigh_rq_inv * neigh_rq_inv;
1256 neigh_rq_max_cube = BATADV_TQ_LOCAL_WINDOW_SIZE *
1257 BATADV_TQ_LOCAL_WINDOW_SIZE *
1258 BATADV_TQ_LOCAL_WINDOW_SIZE;
1259 inv_asym_penalty = BATADV_TQ_MAX_VALUE * neigh_rq_inv_cube;
1260 inv_asym_penalty /= neigh_rq_max_cube;
1261 tq_asym_penalty = BATADV_TQ_MAX_VALUE - inv_asym_penalty;
1263 /* penalize if the OGM is forwarded on the same interface. WiFi
1264 * interfaces and other half duplex devices suffer from throughput
1265 * drops as they can't send and receive at the same time.
1267 tq_iface_penalty = BATADV_TQ_MAX_VALUE;
1268 if (if_outgoing && (if_incoming == if_outgoing) &&
1269 batadv_is_wifi_hardif(if_outgoing))
1270 tq_iface_penalty = batadv_hop_penalty(BATADV_TQ_MAX_VALUE,
1271 bat_priv);
1273 combined_tq = batadv_ogm_packet->tq *
1274 tq_own *
1275 tq_asym_penalty *
1276 tq_iface_penalty;
1277 combined_tq /= BATADV_TQ_MAX_VALUE *
1278 BATADV_TQ_MAX_VALUE *
1279 BATADV_TQ_MAX_VALUE;
1280 batadv_ogm_packet->tq = combined_tq;
1282 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1283 "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",
1284 orig_node->orig, orig_neigh_node->orig, total_count,
1285 neigh_rq_count, tq_own, tq_asym_penalty, tq_iface_penalty,
1286 batadv_ogm_packet->tq, if_incoming->net_dev->name,
1287 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT");
1289 /* if link has the minimum required transmission quality
1290 * consider it bidirectional
1292 if (batadv_ogm_packet->tq >= BATADV_TQ_TOTAL_BIDRECT_LIMIT)
1293 ret = true;
1295 out:
1296 if (neigh_node)
1297 batadv_neigh_node_put(neigh_node);
1298 return ret;
1302 * batadv_iv_ogm_update_seqnos - process a batman packet for all interfaces,
1303 * adjust the sequence number and find out whether it is a duplicate
1304 * @ethhdr: ethernet header of the packet
1305 * @batadv_ogm_packet: OGM packet to be considered
1306 * @if_incoming: interface on which the OGM packet was received
1307 * @if_outgoing: interface for which the retransmission should be considered
1309 * Return: duplicate status as enum batadv_dup_status
1311 static enum batadv_dup_status
1312 batadv_iv_ogm_update_seqnos(const struct ethhdr *ethhdr,
1313 const struct batadv_ogm_packet *batadv_ogm_packet,
1314 const struct batadv_hard_iface *if_incoming,
1315 struct batadv_hard_iface *if_outgoing)
1317 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1318 struct batadv_orig_node *orig_node;
1319 struct batadv_orig_ifinfo *orig_ifinfo = NULL;
1320 struct batadv_neigh_node *neigh_node;
1321 struct batadv_neigh_ifinfo *neigh_ifinfo;
1322 bool is_dup;
1323 s32 seq_diff;
1324 bool need_update = false;
1325 int set_mark;
1326 enum batadv_dup_status ret = BATADV_NO_DUP;
1327 u32 seqno = ntohl(batadv_ogm_packet->seqno);
1328 u8 *neigh_addr;
1329 u8 packet_count;
1330 unsigned long *bitmap;
1332 orig_node = batadv_iv_ogm_orig_get(bat_priv, batadv_ogm_packet->orig);
1333 if (!orig_node)
1334 return BATADV_NO_DUP;
1336 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1337 if (WARN_ON(!orig_ifinfo)) {
1338 batadv_orig_node_put(orig_node);
1339 return 0;
1342 spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1343 seq_diff = seqno - orig_ifinfo->last_real_seqno;
1345 /* signalize caller that the packet is to be dropped. */
1346 if (!hlist_empty(&orig_node->neigh_list) &&
1347 batadv_window_protected(bat_priv, seq_diff,
1348 BATADV_TQ_LOCAL_WINDOW_SIZE,
1349 &orig_ifinfo->batman_seqno_reset, NULL)) {
1350 ret = BATADV_PROTECTED;
1351 goto out;
1354 rcu_read_lock();
1355 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1356 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node,
1357 if_outgoing);
1358 if (!neigh_ifinfo)
1359 continue;
1361 neigh_addr = neigh_node->addr;
1362 is_dup = batadv_test_bit(neigh_ifinfo->bat_iv.real_bits,
1363 orig_ifinfo->last_real_seqno,
1364 seqno);
1366 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1367 neigh_node->if_incoming == if_incoming) {
1368 set_mark = 1;
1369 if (is_dup)
1370 ret = BATADV_NEIGH_DUP;
1371 } else {
1372 set_mark = 0;
1373 if (is_dup && (ret != BATADV_NEIGH_DUP))
1374 ret = BATADV_ORIG_DUP;
1377 /* if the window moved, set the update flag. */
1378 bitmap = neigh_ifinfo->bat_iv.real_bits;
1379 need_update |= batadv_bit_get_packet(bat_priv, bitmap,
1380 seq_diff, set_mark);
1382 packet_count = bitmap_weight(bitmap,
1383 BATADV_TQ_LOCAL_WINDOW_SIZE);
1384 neigh_ifinfo->bat_iv.real_packet_count = packet_count;
1385 batadv_neigh_ifinfo_put(neigh_ifinfo);
1387 rcu_read_unlock();
1389 if (need_update) {
1390 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1391 "%s updating last_seqno: old %u, new %u\n",
1392 if_outgoing ? if_outgoing->net_dev->name : "DEFAULT",
1393 orig_ifinfo->last_real_seqno, seqno);
1394 orig_ifinfo->last_real_seqno = seqno;
1397 out:
1398 spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1399 batadv_orig_node_put(orig_node);
1400 batadv_orig_ifinfo_put(orig_ifinfo);
1401 return ret;
1405 * batadv_iv_ogm_process_per_outif - process a batman iv OGM for an outgoing if
1406 * @skb: the skb containing the OGM
1407 * @ogm_offset: offset from skb->data to start of ogm header
1408 * @orig_node: the (cached) orig node for the originator of this OGM
1409 * @if_incoming: the interface where this packet was received
1410 * @if_outgoing: the interface for which the packet should be considered
1412 static void
1413 batadv_iv_ogm_process_per_outif(const struct sk_buff *skb, int ogm_offset,
1414 struct batadv_orig_node *orig_node,
1415 struct batadv_hard_iface *if_incoming,
1416 struct batadv_hard_iface *if_outgoing)
1418 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1419 struct batadv_hardif_neigh_node *hardif_neigh = NULL;
1420 struct batadv_neigh_node *router = NULL;
1421 struct batadv_neigh_node *router_router = NULL;
1422 struct batadv_orig_node *orig_neigh_node;
1423 struct batadv_orig_ifinfo *orig_ifinfo;
1424 struct batadv_neigh_node *orig_neigh_router = NULL;
1425 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
1426 struct batadv_ogm_packet *ogm_packet;
1427 enum batadv_dup_status dup_status;
1428 bool is_from_best_next_hop = false;
1429 bool is_single_hop_neigh = false;
1430 bool sameseq, similar_ttl;
1431 struct sk_buff *skb_priv;
1432 struct ethhdr *ethhdr;
1433 u8 *prev_sender;
1434 bool is_bidirect;
1436 /* create a private copy of the skb, as some functions change tq value
1437 * and/or flags.
1439 skb_priv = skb_copy(skb, GFP_ATOMIC);
1440 if (!skb_priv)
1441 return;
1443 ethhdr = eth_hdr(skb_priv);
1444 ogm_packet = (struct batadv_ogm_packet *)(skb_priv->data + ogm_offset);
1446 dup_status = batadv_iv_ogm_update_seqnos(ethhdr, ogm_packet,
1447 if_incoming, if_outgoing);
1448 if (batadv_compare_eth(ethhdr->h_source, ogm_packet->orig))
1449 is_single_hop_neigh = true;
1451 if (dup_status == BATADV_PROTECTED) {
1452 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1453 "Drop packet: packet within seqno protection time (sender: %pM)\n",
1454 ethhdr->h_source);
1455 goto out;
1458 if (ogm_packet->tq == 0) {
1459 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1460 "Drop packet: originator packet with tq equal 0\n");
1461 goto out;
1464 if (is_single_hop_neigh) {
1465 hardif_neigh = batadv_hardif_neigh_get(if_incoming,
1466 ethhdr->h_source);
1467 if (hardif_neigh)
1468 hardif_neigh->last_seen = jiffies;
1471 router = batadv_orig_router_get(orig_node, if_outgoing);
1472 if (router) {
1473 router_router = batadv_orig_router_get(router->orig_node,
1474 if_outgoing);
1475 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1478 if ((router_ifinfo && router_ifinfo->bat_iv.tq_avg != 0) &&
1479 (batadv_compare_eth(router->addr, ethhdr->h_source)))
1480 is_from_best_next_hop = true;
1482 prev_sender = ogm_packet->prev_sender;
1483 /* avoid temporary routing loops */
1484 if (router && router_router &&
1485 (batadv_compare_eth(router->addr, prev_sender)) &&
1486 !(batadv_compare_eth(ogm_packet->orig, prev_sender)) &&
1487 (batadv_compare_eth(router->addr, router_router->addr))) {
1488 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1489 "Drop packet: ignoring all rebroadcast packets that may make me loop (sender: %pM)\n",
1490 ethhdr->h_source);
1491 goto out;
1494 if (if_outgoing == BATADV_IF_DEFAULT)
1495 batadv_tvlv_ogm_receive(bat_priv, ogm_packet, orig_node);
1497 /* if sender is a direct neighbor the sender mac equals
1498 * originator mac
1500 if (is_single_hop_neigh)
1501 orig_neigh_node = orig_node;
1502 else
1503 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1504 ethhdr->h_source);
1506 if (!orig_neigh_node)
1507 goto out;
1509 /* Update nc_nodes of the originator */
1510 batadv_nc_update_nc_node(bat_priv, orig_node, orig_neigh_node,
1511 ogm_packet, is_single_hop_neigh);
1513 orig_neigh_router = batadv_orig_router_get(orig_neigh_node,
1514 if_outgoing);
1516 /* drop packet if sender is not a direct neighbor and if we
1517 * don't route towards it
1519 if (!is_single_hop_neigh && (!orig_neigh_router)) {
1520 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1521 "Drop packet: OGM via unknown neighbor!\n");
1522 goto out_neigh;
1525 is_bidirect = batadv_iv_ogm_calc_tq(orig_node, orig_neigh_node,
1526 ogm_packet, if_incoming,
1527 if_outgoing);
1529 /* update ranking if it is not a duplicate or has the same
1530 * seqno and similar ttl as the non-duplicate
1532 orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1533 if (!orig_ifinfo)
1534 goto out_neigh;
1536 sameseq = orig_ifinfo->last_real_seqno == ntohl(ogm_packet->seqno);
1537 similar_ttl = (orig_ifinfo->last_ttl - 3) <= ogm_packet->ttl;
1539 if (is_bidirect && ((dup_status == BATADV_NO_DUP) ||
1540 (sameseq && similar_ttl))) {
1541 batadv_iv_ogm_orig_update(bat_priv, orig_node,
1542 orig_ifinfo, ethhdr,
1543 ogm_packet, if_incoming,
1544 if_outgoing, dup_status);
1546 batadv_orig_ifinfo_put(orig_ifinfo);
1548 /* only forward for specific interface, not for the default one. */
1549 if (if_outgoing == BATADV_IF_DEFAULT)
1550 goto out_neigh;
1552 /* is single hop (direct) neighbor */
1553 if (is_single_hop_neigh) {
1554 /* OGMs from secondary interfaces should only scheduled once
1555 * per interface where it has been received, not multiple times
1557 if ((ogm_packet->ttl <= 2) &&
1558 (if_incoming != if_outgoing)) {
1559 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1560 "Drop packet: OGM from secondary interface and wrong outgoing interface\n");
1561 goto out_neigh;
1563 /* mark direct link on incoming interface */
1564 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1565 is_single_hop_neigh,
1566 is_from_best_next_hop, if_incoming,
1567 if_outgoing);
1569 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1570 "Forwarding packet: rebroadcast neighbor packet with direct link flag\n");
1571 goto out_neigh;
1574 /* multihop originator */
1575 if (!is_bidirect) {
1576 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1577 "Drop packet: not received via bidirectional link\n");
1578 goto out_neigh;
1581 if (dup_status == BATADV_NEIGH_DUP) {
1582 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1583 "Drop packet: duplicate packet received\n");
1584 goto out_neigh;
1587 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1588 "Forwarding packet: rebroadcast originator packet\n");
1589 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1590 is_single_hop_neigh, is_from_best_next_hop,
1591 if_incoming, if_outgoing);
1593 out_neigh:
1594 if ((orig_neigh_node) && (!is_single_hop_neigh))
1595 batadv_orig_node_put(orig_neigh_node);
1596 out:
1597 if (router_ifinfo)
1598 batadv_neigh_ifinfo_put(router_ifinfo);
1599 if (router)
1600 batadv_neigh_node_put(router);
1601 if (router_router)
1602 batadv_neigh_node_put(router_router);
1603 if (orig_neigh_router)
1604 batadv_neigh_node_put(orig_neigh_router);
1605 if (hardif_neigh)
1606 batadv_hardif_neigh_put(hardif_neigh);
1608 consume_skb(skb_priv);
1612 * batadv_iv_ogm_process - process an incoming batman iv OGM
1613 * @skb: the skb containing the OGM
1614 * @ogm_offset: offset to the OGM which should be processed (for aggregates)
1615 * @if_incoming: the interface where this packet was receved
1617 static void batadv_iv_ogm_process(const struct sk_buff *skb, int ogm_offset,
1618 struct batadv_hard_iface *if_incoming)
1620 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1621 struct batadv_orig_node *orig_neigh_node, *orig_node;
1622 struct batadv_hard_iface *hard_iface;
1623 struct batadv_ogm_packet *ogm_packet;
1624 u32 if_incoming_seqno;
1625 bool has_directlink_flag;
1626 struct ethhdr *ethhdr;
1627 bool is_my_oldorig = false;
1628 bool is_my_addr = false;
1629 bool is_my_orig = false;
1631 ogm_packet = (struct batadv_ogm_packet *)(skb->data + ogm_offset);
1632 ethhdr = eth_hdr(skb);
1634 /* Silently drop when the batman packet is actually not a
1635 * correct packet.
1637 * This might happen if a packet is padded (e.g. Ethernet has a
1638 * minimum frame length of 64 byte) and the aggregation interprets
1639 * it as an additional length.
1641 * TODO: A more sane solution would be to have a bit in the
1642 * batadv_ogm_packet to detect whether the packet is the last
1643 * packet in an aggregation. Here we expect that the padding
1644 * is always zero (or not 0x01)
1646 if (ogm_packet->packet_type != BATADV_IV_OGM)
1647 return;
1649 /* could be changed by schedule_own_packet() */
1650 if_incoming_seqno = atomic_read(&if_incoming->bat_iv.ogm_seqno);
1652 if (ogm_packet->flags & BATADV_DIRECTLINK)
1653 has_directlink_flag = true;
1654 else
1655 has_directlink_flag = false;
1657 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1658 "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",
1659 ethhdr->h_source, if_incoming->net_dev->name,
1660 if_incoming->net_dev->dev_addr, ogm_packet->orig,
1661 ogm_packet->prev_sender, ntohl(ogm_packet->seqno),
1662 ogm_packet->tq, ogm_packet->ttl,
1663 ogm_packet->version, has_directlink_flag);
1665 rcu_read_lock();
1666 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1667 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1668 continue;
1670 if (hard_iface->soft_iface != if_incoming->soft_iface)
1671 continue;
1673 if (batadv_compare_eth(ethhdr->h_source,
1674 hard_iface->net_dev->dev_addr))
1675 is_my_addr = true;
1677 if (batadv_compare_eth(ogm_packet->orig,
1678 hard_iface->net_dev->dev_addr))
1679 is_my_orig = true;
1681 if (batadv_compare_eth(ogm_packet->prev_sender,
1682 hard_iface->net_dev->dev_addr))
1683 is_my_oldorig = true;
1685 rcu_read_unlock();
1687 if (is_my_addr) {
1688 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1689 "Drop packet: received my own broadcast (sender: %pM)\n",
1690 ethhdr->h_source);
1691 return;
1694 if (is_my_orig) {
1695 unsigned long *word;
1696 int offset;
1697 s32 bit_pos;
1698 s16 if_num;
1699 u8 *weight;
1701 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1702 ethhdr->h_source);
1703 if (!orig_neigh_node)
1704 return;
1706 /* neighbor has to indicate direct link and it has to
1707 * come via the corresponding interface
1708 * save packet seqno for bidirectional check
1710 if (has_directlink_flag &&
1711 batadv_compare_eth(if_incoming->net_dev->dev_addr,
1712 ogm_packet->orig)) {
1713 if_num = if_incoming->if_num;
1714 offset = if_num * BATADV_NUM_WORDS;
1716 spin_lock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1717 word = &orig_neigh_node->bat_iv.bcast_own[offset];
1718 bit_pos = if_incoming_seqno - 2;
1719 bit_pos -= ntohl(ogm_packet->seqno);
1720 batadv_set_bit(word, bit_pos);
1721 weight = &orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1722 *weight = bitmap_weight(word,
1723 BATADV_TQ_LOCAL_WINDOW_SIZE);
1724 spin_unlock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1727 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1728 "Drop packet: originator packet from myself (via neighbor)\n");
1729 batadv_orig_node_put(orig_neigh_node);
1730 return;
1733 if (is_my_oldorig) {
1734 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1735 "Drop packet: ignoring all rebroadcast echos (sender: %pM)\n",
1736 ethhdr->h_source);
1737 return;
1740 if (ogm_packet->flags & BATADV_NOT_BEST_NEXT_HOP) {
1741 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1742 "Drop packet: ignoring all packets not forwarded from the best next hop (sender: %pM)\n",
1743 ethhdr->h_source);
1744 return;
1747 orig_node = batadv_iv_ogm_orig_get(bat_priv, ogm_packet->orig);
1748 if (!orig_node)
1749 return;
1751 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1752 if_incoming, BATADV_IF_DEFAULT);
1754 rcu_read_lock();
1755 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1756 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1757 continue;
1759 if (hard_iface->soft_iface != bat_priv->soft_iface)
1760 continue;
1762 if (!kref_get_unless_zero(&hard_iface->refcount))
1763 continue;
1765 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1766 if_incoming, hard_iface);
1768 batadv_hardif_put(hard_iface);
1770 rcu_read_unlock();
1772 batadv_orig_node_put(orig_node);
1775 static void batadv_iv_send_outstanding_bat_ogm_packet(struct work_struct *work)
1777 struct delayed_work *delayed_work;
1778 struct batadv_forw_packet *forw_packet;
1779 struct batadv_priv *bat_priv;
1780 bool dropped = false;
1782 delayed_work = to_delayed_work(work);
1783 forw_packet = container_of(delayed_work, struct batadv_forw_packet,
1784 delayed_work);
1785 bat_priv = netdev_priv(forw_packet->if_incoming->soft_iface);
1787 if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_DEACTIVATING) {
1788 dropped = true;
1789 goto out;
1792 batadv_iv_ogm_emit(forw_packet);
1794 /* we have to have at least one packet in the queue to determine the
1795 * queues wake up time unless we are shutting down.
1797 * only re-schedule if this is the "original" copy, e.g. the OGM of the
1798 * primary interface should only be rescheduled once per period, but
1799 * this function will be called for the forw_packet instances of the
1800 * other secondary interfaces as well.
1802 if (forw_packet->own &&
1803 forw_packet->if_incoming == forw_packet->if_outgoing)
1804 batadv_iv_ogm_schedule(forw_packet->if_incoming);
1806 out:
1807 /* do we get something for free()? */
1808 if (batadv_forw_packet_steal(forw_packet,
1809 &bat_priv->forw_bat_list_lock))
1810 batadv_forw_packet_free(forw_packet, dropped);
1813 static int batadv_iv_ogm_receive(struct sk_buff *skb,
1814 struct batadv_hard_iface *if_incoming)
1816 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1817 struct batadv_ogm_packet *ogm_packet;
1818 u8 *packet_pos;
1819 int ogm_offset;
1820 bool res;
1821 int ret = NET_RX_DROP;
1823 res = batadv_check_management_packet(skb, if_incoming, BATADV_OGM_HLEN);
1824 if (!res)
1825 goto free_skb;
1827 /* did we receive a B.A.T.M.A.N. IV OGM packet on an interface
1828 * that does not have B.A.T.M.A.N. IV enabled ?
1830 if (bat_priv->algo_ops->iface.enable != batadv_iv_ogm_iface_enable)
1831 goto free_skb;
1833 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_RX);
1834 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_RX_BYTES,
1835 skb->len + ETH_HLEN);
1837 ogm_offset = 0;
1838 ogm_packet = (struct batadv_ogm_packet *)skb->data;
1840 /* unpack the aggregated packets and process them one by one */
1841 while (batadv_iv_ogm_aggr_packet(ogm_offset, skb_headlen(skb),
1842 ogm_packet->tvlv_len)) {
1843 batadv_iv_ogm_process(skb, ogm_offset, if_incoming);
1845 ogm_offset += BATADV_OGM_HLEN;
1846 ogm_offset += ntohs(ogm_packet->tvlv_len);
1848 packet_pos = skb->data + ogm_offset;
1849 ogm_packet = (struct batadv_ogm_packet *)packet_pos;
1852 ret = NET_RX_SUCCESS;
1854 free_skb:
1855 if (ret == NET_RX_SUCCESS)
1856 consume_skb(skb);
1857 else
1858 kfree_skb(skb);
1860 return ret;
1863 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1865 * batadv_iv_ogm_orig_print_neigh - print neighbors for the originator table
1866 * @orig_node: the orig_node for which the neighbors are printed
1867 * @if_outgoing: outgoing interface for these entries
1868 * @seq: debugfs table seq_file struct
1870 * Must be called while holding an rcu lock.
1872 static void
1873 batadv_iv_ogm_orig_print_neigh(struct batadv_orig_node *orig_node,
1874 struct batadv_hard_iface *if_outgoing,
1875 struct seq_file *seq)
1877 struct batadv_neigh_node *neigh_node;
1878 struct batadv_neigh_ifinfo *n_ifinfo;
1880 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1881 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
1882 if (!n_ifinfo)
1883 continue;
1885 seq_printf(seq, " %pM (%3i)",
1886 neigh_node->addr,
1887 n_ifinfo->bat_iv.tq_avg);
1889 batadv_neigh_ifinfo_put(n_ifinfo);
1894 * batadv_iv_ogm_orig_print - print the originator table
1895 * @bat_priv: the bat priv with all the soft interface information
1896 * @seq: debugfs table seq_file struct
1897 * @if_outgoing: the outgoing interface for which this should be printed
1899 static void batadv_iv_ogm_orig_print(struct batadv_priv *bat_priv,
1900 struct seq_file *seq,
1901 struct batadv_hard_iface *if_outgoing)
1903 struct batadv_neigh_node *neigh_node;
1904 struct batadv_hashtable *hash = bat_priv->orig_hash;
1905 int last_seen_msecs, last_seen_secs;
1906 struct batadv_orig_node *orig_node;
1907 struct batadv_neigh_ifinfo *n_ifinfo;
1908 unsigned long last_seen_jiffies;
1909 struct hlist_head *head;
1910 int batman_count = 0;
1911 u32 i;
1913 seq_puts(seq,
1914 " Originator last-seen (#/255) Nexthop [outgoingIF]: Potential nexthops ...\n");
1916 for (i = 0; i < hash->size; i++) {
1917 head = &hash->table[i];
1919 rcu_read_lock();
1920 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
1921 neigh_node = batadv_orig_router_get(orig_node,
1922 if_outgoing);
1923 if (!neigh_node)
1924 continue;
1926 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node,
1927 if_outgoing);
1928 if (!n_ifinfo)
1929 goto next;
1931 if (n_ifinfo->bat_iv.tq_avg == 0)
1932 goto next;
1934 last_seen_jiffies = jiffies - orig_node->last_seen;
1935 last_seen_msecs = jiffies_to_msecs(last_seen_jiffies);
1936 last_seen_secs = last_seen_msecs / 1000;
1937 last_seen_msecs = last_seen_msecs % 1000;
1939 seq_printf(seq, "%pM %4i.%03is (%3i) %pM [%10s]:",
1940 orig_node->orig, last_seen_secs,
1941 last_seen_msecs, n_ifinfo->bat_iv.tq_avg,
1942 neigh_node->addr,
1943 neigh_node->if_incoming->net_dev->name);
1945 batadv_iv_ogm_orig_print_neigh(orig_node, if_outgoing,
1946 seq);
1947 seq_puts(seq, "\n");
1948 batman_count++;
1950 next:
1951 batadv_neigh_node_put(neigh_node);
1952 if (n_ifinfo)
1953 batadv_neigh_ifinfo_put(n_ifinfo);
1955 rcu_read_unlock();
1958 if (batman_count == 0)
1959 seq_puts(seq, "No batman nodes in range ...\n");
1961 #endif
1964 * batadv_iv_ogm_neigh_get_tq_avg - Get the TQ average for a neighbour on a
1965 * given outgoing interface.
1966 * @neigh_node: Neighbour of interest
1967 * @if_outgoing: Outgoing interface of interest
1968 * @tq_avg: Pointer of where to store the TQ average
1970 * Return: False if no average TQ available, otherwise true.
1972 static bool
1973 batadv_iv_ogm_neigh_get_tq_avg(struct batadv_neigh_node *neigh_node,
1974 struct batadv_hard_iface *if_outgoing,
1975 u8 *tq_avg)
1977 struct batadv_neigh_ifinfo *n_ifinfo;
1979 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
1980 if (!n_ifinfo)
1981 return false;
1983 *tq_avg = n_ifinfo->bat_iv.tq_avg;
1984 batadv_neigh_ifinfo_put(n_ifinfo);
1986 return true;
1990 * batadv_iv_ogm_orig_dump_subentry - Dump an originator subentry into a
1991 * message
1992 * @msg: Netlink message to dump into
1993 * @portid: Port making netlink request
1994 * @seq: Sequence number of netlink message
1995 * @bat_priv: The bat priv with all the soft interface information
1996 * @if_outgoing: Limit dump to entries with this outgoing interface
1997 * @orig_node: Originator to dump
1998 * @neigh_node: Single hops neighbour
1999 * @best: Is the best originator
2001 * Return: Error code, or 0 on success
2003 static int
2004 batadv_iv_ogm_orig_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq,
2005 struct batadv_priv *bat_priv,
2006 struct batadv_hard_iface *if_outgoing,
2007 struct batadv_orig_node *orig_node,
2008 struct batadv_neigh_node *neigh_node,
2009 bool best)
2011 void *hdr;
2012 u8 tq_avg;
2013 unsigned int last_seen_msecs;
2015 last_seen_msecs = jiffies_to_msecs(jiffies - orig_node->last_seen);
2017 if (!batadv_iv_ogm_neigh_get_tq_avg(neigh_node, if_outgoing, &tq_avg))
2018 return 0;
2020 if (if_outgoing != BATADV_IF_DEFAULT &&
2021 if_outgoing != neigh_node->if_incoming)
2022 return 0;
2024 hdr = genlmsg_put(msg, portid, seq, &batadv_netlink_family,
2025 NLM_F_MULTI, BATADV_CMD_GET_ORIGINATORS);
2026 if (!hdr)
2027 return -ENOBUFS;
2029 if (nla_put(msg, BATADV_ATTR_ORIG_ADDRESS, ETH_ALEN,
2030 orig_node->orig) ||
2031 nla_put(msg, BATADV_ATTR_NEIGH_ADDRESS, ETH_ALEN,
2032 neigh_node->addr) ||
2033 nla_put_u32(msg, BATADV_ATTR_HARD_IFINDEX,
2034 neigh_node->if_incoming->net_dev->ifindex) ||
2035 nla_put_u8(msg, BATADV_ATTR_TQ, tq_avg) ||
2036 nla_put_u32(msg, BATADV_ATTR_LAST_SEEN_MSECS,
2037 last_seen_msecs))
2038 goto nla_put_failure;
2040 if (best && nla_put_flag(msg, BATADV_ATTR_FLAG_BEST))
2041 goto nla_put_failure;
2043 genlmsg_end(msg, hdr);
2044 return 0;
2046 nla_put_failure:
2047 genlmsg_cancel(msg, hdr);
2048 return -EMSGSIZE;
2052 * batadv_iv_ogm_orig_dump_entry - Dump an originator entry into a message
2053 * @msg: Netlink message to dump into
2054 * @portid: Port making netlink request
2055 * @seq: Sequence number of netlink message
2056 * @bat_priv: The bat priv with all the soft interface information
2057 * @if_outgoing: Limit dump to entries with this outgoing interface
2058 * @orig_node: Originator to dump
2059 * @sub_s: Number of sub entries to skip
2061 * This function assumes the caller holds rcu_read_lock().
2063 * Return: Error code, or 0 on success
2065 static int
2066 batadv_iv_ogm_orig_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
2067 struct batadv_priv *bat_priv,
2068 struct batadv_hard_iface *if_outgoing,
2069 struct batadv_orig_node *orig_node, int *sub_s)
2071 struct batadv_neigh_node *neigh_node_best;
2072 struct batadv_neigh_node *neigh_node;
2073 int sub = 0;
2074 bool best;
2075 u8 tq_avg_best;
2077 neigh_node_best = batadv_orig_router_get(orig_node, if_outgoing);
2078 if (!neigh_node_best)
2079 goto out;
2081 if (!batadv_iv_ogm_neigh_get_tq_avg(neigh_node_best, if_outgoing,
2082 &tq_avg_best))
2083 goto out;
2085 if (tq_avg_best == 0)
2086 goto out;
2088 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
2089 if (sub++ < *sub_s)
2090 continue;
2092 best = (neigh_node == neigh_node_best);
2094 if (batadv_iv_ogm_orig_dump_subentry(msg, portid, seq,
2095 bat_priv, if_outgoing,
2096 orig_node, neigh_node,
2097 best)) {
2098 batadv_neigh_node_put(neigh_node_best);
2100 *sub_s = sub - 1;
2101 return -EMSGSIZE;
2105 out:
2106 if (neigh_node_best)
2107 batadv_neigh_node_put(neigh_node_best);
2109 *sub_s = 0;
2110 return 0;
2114 * batadv_iv_ogm_orig_dump_bucket - Dump an originator bucket into a
2115 * message
2116 * @msg: Netlink message to dump into
2117 * @portid: Port making netlink request
2118 * @seq: Sequence number of netlink message
2119 * @bat_priv: The bat priv with all the soft interface information
2120 * @if_outgoing: Limit dump to entries with this outgoing interface
2121 * @head: Bucket to be dumped
2122 * @idx_s: Number of entries to be skipped
2123 * @sub: Number of sub entries to be skipped
2125 * Return: Error code, or 0 on success
2127 static int
2128 batadv_iv_ogm_orig_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq,
2129 struct batadv_priv *bat_priv,
2130 struct batadv_hard_iface *if_outgoing,
2131 struct hlist_head *head, int *idx_s, int *sub)
2133 struct batadv_orig_node *orig_node;
2134 int idx = 0;
2136 rcu_read_lock();
2137 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
2138 if (idx++ < *idx_s)
2139 continue;
2141 if (batadv_iv_ogm_orig_dump_entry(msg, portid, seq, bat_priv,
2142 if_outgoing, orig_node,
2143 sub)) {
2144 rcu_read_unlock();
2145 *idx_s = idx - 1;
2146 return -EMSGSIZE;
2149 rcu_read_unlock();
2151 *idx_s = 0;
2152 *sub = 0;
2153 return 0;
2157 * batadv_iv_ogm_orig_dump - Dump the originators into a message
2158 * @msg: Netlink message to dump into
2159 * @cb: Control block containing additional options
2160 * @bat_priv: The bat priv with all the soft interface information
2161 * @if_outgoing: Limit dump to entries with this outgoing interface
2163 static void
2164 batadv_iv_ogm_orig_dump(struct sk_buff *msg, struct netlink_callback *cb,
2165 struct batadv_priv *bat_priv,
2166 struct batadv_hard_iface *if_outgoing)
2168 struct batadv_hashtable *hash = bat_priv->orig_hash;
2169 struct hlist_head *head;
2170 int bucket = cb->args[0];
2171 int idx = cb->args[1];
2172 int sub = cb->args[2];
2173 int portid = NETLINK_CB(cb->skb).portid;
2175 while (bucket < hash->size) {
2176 head = &hash->table[bucket];
2178 if (batadv_iv_ogm_orig_dump_bucket(msg, portid,
2179 cb->nlh->nlmsg_seq,
2180 bat_priv, if_outgoing, head,
2181 &idx, &sub))
2182 break;
2184 bucket++;
2187 cb->args[0] = bucket;
2188 cb->args[1] = idx;
2189 cb->args[2] = sub;
2192 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2194 * batadv_iv_hardif_neigh_print - print a single hop neighbour node
2195 * @seq: neighbour table seq_file struct
2196 * @hardif_neigh: hardif neighbour information
2198 static void
2199 batadv_iv_hardif_neigh_print(struct seq_file *seq,
2200 struct batadv_hardif_neigh_node *hardif_neigh)
2202 int last_secs, last_msecs;
2204 last_secs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) / 1000;
2205 last_msecs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) % 1000;
2207 seq_printf(seq, " %10s %pM %4i.%03is\n",
2208 hardif_neigh->if_incoming->net_dev->name,
2209 hardif_neigh->addr, last_secs, last_msecs);
2213 * batadv_iv_ogm_neigh_print - print the single hop neighbour list
2214 * @bat_priv: the bat priv with all the soft interface information
2215 * @seq: neighbour table seq_file struct
2217 static void batadv_iv_neigh_print(struct batadv_priv *bat_priv,
2218 struct seq_file *seq)
2220 struct net_device *net_dev = (struct net_device *)seq->private;
2221 struct batadv_hardif_neigh_node *hardif_neigh;
2222 struct batadv_hard_iface *hard_iface;
2223 int batman_count = 0;
2225 seq_puts(seq, " IF Neighbor last-seen\n");
2227 rcu_read_lock();
2228 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
2229 if (hard_iface->soft_iface != net_dev)
2230 continue;
2232 hlist_for_each_entry_rcu(hardif_neigh,
2233 &hard_iface->neigh_list, list) {
2234 batadv_iv_hardif_neigh_print(seq, hardif_neigh);
2235 batman_count++;
2238 rcu_read_unlock();
2240 if (batman_count == 0)
2241 seq_puts(seq, "No batman nodes in range ...\n");
2243 #endif
2246 * batadv_iv_ogm_neigh_diff - calculate tq difference of two neighbors
2247 * @neigh1: the first neighbor object of the comparison
2248 * @if_outgoing1: outgoing interface for the first neighbor
2249 * @neigh2: the second neighbor object of the comparison
2250 * @if_outgoing2: outgoing interface for the second neighbor
2251 * @diff: pointer to integer receiving the calculated difference
2253 * The content of *@diff is only valid when this function returns true.
2254 * It is less, equal to or greater than 0 if the metric via neigh1 is lower,
2255 * the same as or higher than the metric via neigh2
2257 * Return: true when the difference could be calculated, false otherwise
2259 static bool batadv_iv_ogm_neigh_diff(struct batadv_neigh_node *neigh1,
2260 struct batadv_hard_iface *if_outgoing1,
2261 struct batadv_neigh_node *neigh2,
2262 struct batadv_hard_iface *if_outgoing2,
2263 int *diff)
2265 struct batadv_neigh_ifinfo *neigh1_ifinfo, *neigh2_ifinfo;
2266 u8 tq1, tq2;
2267 bool ret = true;
2269 neigh1_ifinfo = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
2270 neigh2_ifinfo = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
2272 if (!neigh1_ifinfo || !neigh2_ifinfo) {
2273 ret = false;
2274 goto out;
2277 tq1 = neigh1_ifinfo->bat_iv.tq_avg;
2278 tq2 = neigh2_ifinfo->bat_iv.tq_avg;
2279 *diff = (int)tq1 - (int)tq2;
2281 out:
2282 if (neigh1_ifinfo)
2283 batadv_neigh_ifinfo_put(neigh1_ifinfo);
2284 if (neigh2_ifinfo)
2285 batadv_neigh_ifinfo_put(neigh2_ifinfo);
2287 return ret;
2291 * batadv_iv_ogm_neigh_dump_neigh - Dump a neighbour into a netlink message
2292 * @msg: Netlink message to dump into
2293 * @portid: Port making netlink request
2294 * @seq: Sequence number of netlink message
2295 * @hardif_neigh: Neighbour to be dumped
2297 * Return: Error code, or 0 on success
2299 static int
2300 batadv_iv_ogm_neigh_dump_neigh(struct sk_buff *msg, u32 portid, u32 seq,
2301 struct batadv_hardif_neigh_node *hardif_neigh)
2303 void *hdr;
2304 unsigned int last_seen_msecs;
2306 last_seen_msecs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen);
2308 hdr = genlmsg_put(msg, portid, seq, &batadv_netlink_family,
2309 NLM_F_MULTI, BATADV_CMD_GET_NEIGHBORS);
2310 if (!hdr)
2311 return -ENOBUFS;
2313 if (nla_put(msg, BATADV_ATTR_NEIGH_ADDRESS, ETH_ALEN,
2314 hardif_neigh->addr) ||
2315 nla_put_u32(msg, BATADV_ATTR_HARD_IFINDEX,
2316 hardif_neigh->if_incoming->net_dev->ifindex) ||
2317 nla_put_u32(msg, BATADV_ATTR_LAST_SEEN_MSECS,
2318 last_seen_msecs))
2319 goto nla_put_failure;
2321 genlmsg_end(msg, hdr);
2322 return 0;
2324 nla_put_failure:
2325 genlmsg_cancel(msg, hdr);
2326 return -EMSGSIZE;
2330 * batadv_iv_ogm_neigh_dump_hardif - Dump the neighbours of a hard interface
2331 * into a message
2332 * @msg: Netlink message to dump into
2333 * @portid: Port making netlink request
2334 * @seq: Sequence number of netlink message
2335 * @bat_priv: The bat priv with all the soft interface information
2336 * @hard_iface: Hard interface to dump the neighbours for
2337 * @idx_s: Number of entries to skip
2339 * This function assumes the caller holds rcu_read_lock().
2341 * Return: Error code, or 0 on success
2343 static int
2344 batadv_iv_ogm_neigh_dump_hardif(struct sk_buff *msg, u32 portid, u32 seq,
2345 struct batadv_priv *bat_priv,
2346 struct batadv_hard_iface *hard_iface,
2347 int *idx_s)
2349 struct batadv_hardif_neigh_node *hardif_neigh;
2350 int idx = 0;
2352 hlist_for_each_entry_rcu(hardif_neigh,
2353 &hard_iface->neigh_list, list) {
2354 if (idx++ < *idx_s)
2355 continue;
2357 if (batadv_iv_ogm_neigh_dump_neigh(msg, portid, seq,
2358 hardif_neigh)) {
2359 *idx_s = idx - 1;
2360 return -EMSGSIZE;
2364 *idx_s = 0;
2365 return 0;
2369 * batadv_iv_ogm_neigh_dump - Dump the neighbours into a message
2370 * @msg: Netlink message to dump into
2371 * @cb: Control block containing additional options
2372 * @bat_priv: The bat priv with all the soft interface information
2373 * @single_hardif: Limit dump to this hard interfaace
2375 static void
2376 batadv_iv_ogm_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb,
2377 struct batadv_priv *bat_priv,
2378 struct batadv_hard_iface *single_hardif)
2380 struct batadv_hard_iface *hard_iface;
2381 int i_hardif = 0;
2382 int i_hardif_s = cb->args[0];
2383 int idx = cb->args[1];
2384 int portid = NETLINK_CB(cb->skb).portid;
2386 rcu_read_lock();
2387 if (single_hardif) {
2388 if (i_hardif_s == 0) {
2389 if (batadv_iv_ogm_neigh_dump_hardif(msg, portid,
2390 cb->nlh->nlmsg_seq,
2391 bat_priv,
2392 single_hardif,
2393 &idx) == 0)
2394 i_hardif++;
2396 } else {
2397 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list,
2398 list) {
2399 if (hard_iface->soft_iface != bat_priv->soft_iface)
2400 continue;
2402 if (i_hardif++ < i_hardif_s)
2403 continue;
2405 if (batadv_iv_ogm_neigh_dump_hardif(msg, portid,
2406 cb->nlh->nlmsg_seq,
2407 bat_priv,
2408 hard_iface, &idx)) {
2409 i_hardif--;
2410 break;
2414 rcu_read_unlock();
2416 cb->args[0] = i_hardif;
2417 cb->args[1] = idx;
2421 * batadv_iv_ogm_neigh_cmp - compare the metrics of two neighbors
2422 * @neigh1: the first neighbor object of the comparison
2423 * @if_outgoing1: outgoing interface for the first neighbor
2424 * @neigh2: the second neighbor object of the comparison
2425 * @if_outgoing2: outgoing interface for the second neighbor
2427 * Return: a value less, equal to or greater than 0 if the metric via neigh1 is
2428 * lower, the same as or higher than the metric via neigh2
2430 static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
2431 struct batadv_hard_iface *if_outgoing1,
2432 struct batadv_neigh_node *neigh2,
2433 struct batadv_hard_iface *if_outgoing2)
2435 bool ret;
2436 int diff;
2438 ret = batadv_iv_ogm_neigh_diff(neigh1, if_outgoing1, neigh2,
2439 if_outgoing2, &diff);
2440 if (!ret)
2441 return 0;
2443 return diff;
2447 * batadv_iv_ogm_neigh_is_sob - check if neigh1 is similarly good or better
2448 * than neigh2 from the metric prospective
2449 * @neigh1: the first neighbor object of the comparison
2450 * @if_outgoing1: outgoing interface for the first neighbor
2451 * @neigh2: the second neighbor object of the comparison
2452 * @if_outgoing2: outgoing interface for the second neighbor
2454 * Return: true if the metric via neigh1 is equally good or better than
2455 * the metric via neigh2, false otherwise.
2457 static bool
2458 batadv_iv_ogm_neigh_is_sob(struct batadv_neigh_node *neigh1,
2459 struct batadv_hard_iface *if_outgoing1,
2460 struct batadv_neigh_node *neigh2,
2461 struct batadv_hard_iface *if_outgoing2)
2463 bool ret;
2464 int diff;
2466 ret = batadv_iv_ogm_neigh_diff(neigh1, if_outgoing1, neigh2,
2467 if_outgoing2, &diff);
2468 if (!ret)
2469 return false;
2471 ret = diff > -BATADV_TQ_SIMILARITY_THRESHOLD;
2472 return ret;
2475 static void batadv_iv_iface_activate(struct batadv_hard_iface *hard_iface)
2477 /* begin scheduling originator messages on that interface */
2478 batadv_iv_ogm_schedule(hard_iface);
2482 * batadv_iv_init_sel_class - initialize GW selection class
2483 * @bat_priv: the bat priv with all the soft interface information
2485 static void batadv_iv_init_sel_class(struct batadv_priv *bat_priv)
2487 /* set default TQ difference threshold to 20 */
2488 atomic_set(&bat_priv->gw.sel_class, 20);
2491 static struct batadv_gw_node *
2492 batadv_iv_gw_get_best_gw_node(struct batadv_priv *bat_priv)
2494 struct batadv_neigh_node *router;
2495 struct batadv_neigh_ifinfo *router_ifinfo;
2496 struct batadv_gw_node *gw_node, *curr_gw = NULL;
2497 u64 max_gw_factor = 0;
2498 u64 tmp_gw_factor = 0;
2499 u8 max_tq = 0;
2500 u8 tq_avg;
2501 struct batadv_orig_node *orig_node;
2503 rcu_read_lock();
2504 hlist_for_each_entry_rcu(gw_node, &bat_priv->gw.gateway_list, list) {
2505 orig_node = gw_node->orig_node;
2506 router = batadv_orig_router_get(orig_node, BATADV_IF_DEFAULT);
2507 if (!router)
2508 continue;
2510 router_ifinfo = batadv_neigh_ifinfo_get(router,
2511 BATADV_IF_DEFAULT);
2512 if (!router_ifinfo)
2513 goto next;
2515 if (!kref_get_unless_zero(&gw_node->refcount))
2516 goto next;
2518 tq_avg = router_ifinfo->bat_iv.tq_avg;
2520 switch (atomic_read(&bat_priv->gw.sel_class)) {
2521 case 1: /* fast connection */
2522 tmp_gw_factor = tq_avg * tq_avg;
2523 tmp_gw_factor *= gw_node->bandwidth_down;
2524 tmp_gw_factor *= 100 * 100;
2525 tmp_gw_factor >>= 18;
2527 if ((tmp_gw_factor > max_gw_factor) ||
2528 ((tmp_gw_factor == max_gw_factor) &&
2529 (tq_avg > max_tq))) {
2530 if (curr_gw)
2531 batadv_gw_node_put(curr_gw);
2532 curr_gw = gw_node;
2533 kref_get(&curr_gw->refcount);
2535 break;
2537 default: /* 2: stable connection (use best statistic)
2538 * 3: fast-switch (use best statistic but change as
2539 * soon as a better gateway appears)
2540 * XX: late-switch (use best statistic but change as
2541 * soon as a better gateway appears which has
2542 * $routing_class more tq points)
2544 if (tq_avg > max_tq) {
2545 if (curr_gw)
2546 batadv_gw_node_put(curr_gw);
2547 curr_gw = gw_node;
2548 kref_get(&curr_gw->refcount);
2550 break;
2553 if (tq_avg > max_tq)
2554 max_tq = tq_avg;
2556 if (tmp_gw_factor > max_gw_factor)
2557 max_gw_factor = tmp_gw_factor;
2559 batadv_gw_node_put(gw_node);
2561 next:
2562 batadv_neigh_node_put(router);
2563 if (router_ifinfo)
2564 batadv_neigh_ifinfo_put(router_ifinfo);
2566 rcu_read_unlock();
2568 return curr_gw;
2571 static bool batadv_iv_gw_is_eligible(struct batadv_priv *bat_priv,
2572 struct batadv_orig_node *curr_gw_orig,
2573 struct batadv_orig_node *orig_node)
2575 struct batadv_neigh_ifinfo *router_orig_ifinfo = NULL;
2576 struct batadv_neigh_ifinfo *router_gw_ifinfo = NULL;
2577 struct batadv_neigh_node *router_gw = NULL;
2578 struct batadv_neigh_node *router_orig = NULL;
2579 u8 gw_tq_avg, orig_tq_avg;
2580 bool ret = false;
2582 /* dynamic re-election is performed only on fast or late switch */
2583 if (atomic_read(&bat_priv->gw.sel_class) <= 2)
2584 return false;
2586 router_gw = batadv_orig_router_get(curr_gw_orig, BATADV_IF_DEFAULT);
2587 if (!router_gw) {
2588 ret = true;
2589 goto out;
2592 router_gw_ifinfo = batadv_neigh_ifinfo_get(router_gw,
2593 BATADV_IF_DEFAULT);
2594 if (!router_gw_ifinfo) {
2595 ret = true;
2596 goto out;
2599 router_orig = batadv_orig_router_get(orig_node, BATADV_IF_DEFAULT);
2600 if (!router_orig)
2601 goto out;
2603 router_orig_ifinfo = batadv_neigh_ifinfo_get(router_orig,
2604 BATADV_IF_DEFAULT);
2605 if (!router_orig_ifinfo)
2606 goto out;
2608 gw_tq_avg = router_gw_ifinfo->bat_iv.tq_avg;
2609 orig_tq_avg = router_orig_ifinfo->bat_iv.tq_avg;
2611 /* the TQ value has to be better */
2612 if (orig_tq_avg < gw_tq_avg)
2613 goto out;
2615 /* if the routing class is greater than 3 the value tells us how much
2616 * greater the TQ value of the new gateway must be
2618 if ((atomic_read(&bat_priv->gw.sel_class) > 3) &&
2619 (orig_tq_avg - gw_tq_avg < atomic_read(&bat_priv->gw.sel_class)))
2620 goto out;
2622 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
2623 "Restarting gateway selection: better gateway found (tq curr: %i, tq new: %i)\n",
2624 gw_tq_avg, orig_tq_avg);
2626 ret = true;
2627 out:
2628 if (router_gw_ifinfo)
2629 batadv_neigh_ifinfo_put(router_gw_ifinfo);
2630 if (router_orig_ifinfo)
2631 batadv_neigh_ifinfo_put(router_orig_ifinfo);
2632 if (router_gw)
2633 batadv_neigh_node_put(router_gw);
2634 if (router_orig)
2635 batadv_neigh_node_put(router_orig);
2637 return ret;
2640 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2641 /* fails if orig_node has no router */
2642 static int batadv_iv_gw_write_buffer_text(struct batadv_priv *bat_priv,
2643 struct seq_file *seq,
2644 const struct batadv_gw_node *gw_node)
2646 struct batadv_gw_node *curr_gw;
2647 struct batadv_neigh_node *router;
2648 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
2649 int ret = -1;
2651 router = batadv_orig_router_get(gw_node->orig_node, BATADV_IF_DEFAULT);
2652 if (!router)
2653 goto out;
2655 router_ifinfo = batadv_neigh_ifinfo_get(router, BATADV_IF_DEFAULT);
2656 if (!router_ifinfo)
2657 goto out;
2659 curr_gw = batadv_gw_get_selected_gw_node(bat_priv);
2661 seq_printf(seq, "%s %pM (%3i) %pM [%10s]: %u.%u/%u.%u MBit\n",
2662 (curr_gw == gw_node ? "=>" : " "),
2663 gw_node->orig_node->orig,
2664 router_ifinfo->bat_iv.tq_avg, router->addr,
2665 router->if_incoming->net_dev->name,
2666 gw_node->bandwidth_down / 10,
2667 gw_node->bandwidth_down % 10,
2668 gw_node->bandwidth_up / 10,
2669 gw_node->bandwidth_up % 10);
2670 ret = seq_has_overflowed(seq) ? -1 : 0;
2672 if (curr_gw)
2673 batadv_gw_node_put(curr_gw);
2674 out:
2675 if (router_ifinfo)
2676 batadv_neigh_ifinfo_put(router_ifinfo);
2677 if (router)
2678 batadv_neigh_node_put(router);
2679 return ret;
2682 static void batadv_iv_gw_print(struct batadv_priv *bat_priv,
2683 struct seq_file *seq)
2685 struct batadv_gw_node *gw_node;
2686 int gw_count = 0;
2688 seq_puts(seq,
2689 " Gateway (#/255) Nexthop [outgoingIF]: advertised uplink bandwidth\n");
2691 rcu_read_lock();
2692 hlist_for_each_entry_rcu(gw_node, &bat_priv->gw.gateway_list, list) {
2693 /* fails if orig_node has no router */
2694 if (batadv_iv_gw_write_buffer_text(bat_priv, seq, gw_node) < 0)
2695 continue;
2697 gw_count++;
2699 rcu_read_unlock();
2701 if (gw_count == 0)
2702 seq_puts(seq, "No gateways in range ...\n");
2704 #endif
2707 * batadv_iv_gw_dump_entry - Dump a gateway into a message
2708 * @msg: Netlink message to dump into
2709 * @portid: Port making netlink request
2710 * @seq: Sequence number of netlink message
2711 * @bat_priv: The bat priv with all the soft interface information
2712 * @gw_node: Gateway to be dumped
2714 * Return: Error code, or 0 on success
2716 static int batadv_iv_gw_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
2717 struct batadv_priv *bat_priv,
2718 struct batadv_gw_node *gw_node)
2720 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
2721 struct batadv_neigh_node *router;
2722 struct batadv_gw_node *curr_gw;
2723 int ret = -EINVAL;
2724 void *hdr;
2726 router = batadv_orig_router_get(gw_node->orig_node, BATADV_IF_DEFAULT);
2727 if (!router)
2728 goto out;
2730 router_ifinfo = batadv_neigh_ifinfo_get(router, BATADV_IF_DEFAULT);
2731 if (!router_ifinfo)
2732 goto out;
2734 curr_gw = batadv_gw_get_selected_gw_node(bat_priv);
2736 hdr = genlmsg_put(msg, portid, seq, &batadv_netlink_family,
2737 NLM_F_MULTI, BATADV_CMD_GET_GATEWAYS);
2738 if (!hdr) {
2739 ret = -ENOBUFS;
2740 goto out;
2743 ret = -EMSGSIZE;
2745 if (curr_gw == gw_node)
2746 if (nla_put_flag(msg, BATADV_ATTR_FLAG_BEST)) {
2747 genlmsg_cancel(msg, hdr);
2748 goto out;
2751 if (nla_put(msg, BATADV_ATTR_ORIG_ADDRESS, ETH_ALEN,
2752 gw_node->orig_node->orig) ||
2753 nla_put_u8(msg, BATADV_ATTR_TQ, router_ifinfo->bat_iv.tq_avg) ||
2754 nla_put(msg, BATADV_ATTR_ROUTER, ETH_ALEN,
2755 router->addr) ||
2756 nla_put_string(msg, BATADV_ATTR_HARD_IFNAME,
2757 router->if_incoming->net_dev->name) ||
2758 nla_put_u32(msg, BATADV_ATTR_BANDWIDTH_DOWN,
2759 gw_node->bandwidth_down) ||
2760 nla_put_u32(msg, BATADV_ATTR_BANDWIDTH_UP,
2761 gw_node->bandwidth_up)) {
2762 genlmsg_cancel(msg, hdr);
2763 goto out;
2766 genlmsg_end(msg, hdr);
2767 ret = 0;
2769 out:
2770 if (router_ifinfo)
2771 batadv_neigh_ifinfo_put(router_ifinfo);
2772 if (router)
2773 batadv_neigh_node_put(router);
2774 return ret;
2778 * batadv_iv_gw_dump - Dump gateways into a message
2779 * @msg: Netlink message to dump into
2780 * @cb: Control block containing additional options
2781 * @bat_priv: The bat priv with all the soft interface information
2783 static void batadv_iv_gw_dump(struct sk_buff *msg, struct netlink_callback *cb,
2784 struct batadv_priv *bat_priv)
2786 int portid = NETLINK_CB(cb->skb).portid;
2787 struct batadv_gw_node *gw_node;
2788 int idx_skip = cb->args[0];
2789 int idx = 0;
2791 rcu_read_lock();
2792 hlist_for_each_entry_rcu(gw_node, &bat_priv->gw.gateway_list, list) {
2793 if (idx++ < idx_skip)
2794 continue;
2796 if (batadv_iv_gw_dump_entry(msg, portid, cb->nlh->nlmsg_seq,
2797 bat_priv, gw_node)) {
2798 idx_skip = idx - 1;
2799 goto unlock;
2803 idx_skip = idx;
2804 unlock:
2805 rcu_read_unlock();
2807 cb->args[0] = idx_skip;
2810 static struct batadv_algo_ops batadv_batman_iv __read_mostly = {
2811 .name = "BATMAN_IV",
2812 .iface = {
2813 .activate = batadv_iv_iface_activate,
2814 .enable = batadv_iv_ogm_iface_enable,
2815 .disable = batadv_iv_ogm_iface_disable,
2816 .update_mac = batadv_iv_ogm_iface_update_mac,
2817 .primary_set = batadv_iv_ogm_primary_iface_set,
2819 .neigh = {
2820 .cmp = batadv_iv_ogm_neigh_cmp,
2821 .is_similar_or_better = batadv_iv_ogm_neigh_is_sob,
2822 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2823 .print = batadv_iv_neigh_print,
2824 #endif
2825 .dump = batadv_iv_ogm_neigh_dump,
2827 .orig = {
2828 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2829 .print = batadv_iv_ogm_orig_print,
2830 #endif
2831 .dump = batadv_iv_ogm_orig_dump,
2832 .free = batadv_iv_ogm_orig_free,
2833 .add_if = batadv_iv_ogm_orig_add_if,
2834 .del_if = batadv_iv_ogm_orig_del_if,
2836 .gw = {
2837 .init_sel_class = batadv_iv_init_sel_class,
2838 .get_best_gw_node = batadv_iv_gw_get_best_gw_node,
2839 .is_eligible = batadv_iv_gw_is_eligible,
2840 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2841 .print = batadv_iv_gw_print,
2842 #endif
2843 .dump = batadv_iv_gw_dump,
2847 int __init batadv_iv_init(void)
2849 int ret;
2851 /* batman originator packet */
2852 ret = batadv_recv_handler_register(BATADV_IV_OGM,
2853 batadv_iv_ogm_receive);
2854 if (ret < 0)
2855 goto out;
2857 ret = batadv_algo_register(&batadv_batman_iv);
2858 if (ret < 0)
2859 goto handler_unregister;
2861 goto out;
2863 handler_unregister:
2864 batadv_recv_handler_unregister(BATADV_IV_OGM);
2865 out:
2866 return ret;