batman-adv: kernel doc fixes for bat_iv_ogm.c
[linux-2.6-microblaze.git] / net / batman-adv / bat_iv_ogm.c
1 /* Copyright (C) 2007-2014 B.A.T.M.A.N. contributors:
2  *
3  * Marek Lindner, Simon Wunderlich
4  *
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.
8  *
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.
13  *
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/>.
16  */
17
18 #include "main.h"
19 #include "translation-table.h"
20 #include "originator.h"
21 #include "routing.h"
22 #include "gateway_common.h"
23 #include "gateway_client.h"
24 #include "hard-interface.h"
25 #include "send.h"
26 #include "bat_algo.h"
27 #include "network-coding.h"
28
29
30 /**
31  * enum batadv_dup_status - duplicate status
32  * @BATADV_NO_DUP: the packet is a duplicate
33  * @BATADV_ORIG_DUP: OGM is a duplicate in the originator (but not for the
34  *  neighbor)
35  * @BATADV_NEIGH_DUP: OGM is a duplicate for the neighbor
36  * @BATADV_PROTECTED: originator is currently protected (after reboot)
37  */
38 enum batadv_dup_status {
39         BATADV_NO_DUP = 0,
40         BATADV_ORIG_DUP,
41         BATADV_NEIGH_DUP,
42         BATADV_PROTECTED,
43 };
44
45 /**
46  * batadv_ring_buffer_set - update the ring buffer with the given value
47  * @lq_recv: pointer to the ring buffer
48  * @lq_index: index to store the value at
49  * @value: value to store in the ring buffer
50  */
51 static void batadv_ring_buffer_set(uint8_t lq_recv[], uint8_t *lq_index,
52                                    uint8_t value)
53 {
54         lq_recv[*lq_index] = value;
55         *lq_index = (*lq_index + 1) % BATADV_TQ_GLOBAL_WINDOW_SIZE;
56 }
57
58 /**
59  * batadv_ring_buffer_set - compute the average of all non-zero values stored
60  * in the given ring buffer
61  * @lq_recv: pointer to the ring buffer
62  *
63  * Returns computed average value.
64  */
65 static uint8_t batadv_ring_buffer_avg(const uint8_t lq_recv[])
66 {
67         const uint8_t *ptr;
68         uint16_t count = 0, i = 0, sum = 0;
69
70         ptr = lq_recv;
71
72         while (i < BATADV_TQ_GLOBAL_WINDOW_SIZE) {
73                 if (*ptr != 0) {
74                         count++;
75                         sum += *ptr;
76                 }
77
78                 i++;
79                 ptr++;
80         }
81
82         if (count == 0)
83                 return 0;
84
85         return (uint8_t)(sum / count);
86 }
87
88 /**
89  * batadv_iv_ogm_orig_free - free the private resources allocated for this
90  *  orig_node
91  * @orig_node: the orig_node for which the resources have to be free'd
92  */
93 static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node)
94 {
95         kfree(orig_node->bat_iv.bcast_own);
96         kfree(orig_node->bat_iv.bcast_own_sum);
97 }
98
99 /**
100  * batadv_iv_ogm_orig_add_if - change the private structures of the orig_node to
101  *  include the new hard-interface
102  * @orig_node: the orig_node that has to be changed
103  * @max_if_num: the current amount of interfaces
104  *
105  * Returns 0 on success, a negative error code otherwise.
106  */
107 static int batadv_iv_ogm_orig_add_if(struct batadv_orig_node *orig_node,
108                                      int max_if_num)
109 {
110         void *data_ptr;
111         size_t old_size;
112         int ret = -ENOMEM;
113
114         spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
115
116         old_size = (max_if_num - 1) * sizeof(unsigned long) * BATADV_NUM_WORDS;
117         data_ptr = kmalloc_array(max_if_num,
118                                  BATADV_NUM_WORDS * sizeof(unsigned long),
119                                  GFP_ATOMIC);
120         if (!data_ptr)
121                 goto unlock;
122
123         memcpy(data_ptr, orig_node->bat_iv.bcast_own, old_size);
124         kfree(orig_node->bat_iv.bcast_own);
125         orig_node->bat_iv.bcast_own = data_ptr;
126
127         data_ptr = kmalloc_array(max_if_num, sizeof(uint8_t), GFP_ATOMIC);
128         if (!data_ptr) {
129                 kfree(orig_node->bat_iv.bcast_own);
130                 goto unlock;
131         }
132
133         memcpy(data_ptr, orig_node->bat_iv.bcast_own_sum,
134                (max_if_num - 1) * sizeof(uint8_t));
135         kfree(orig_node->bat_iv.bcast_own_sum);
136         orig_node->bat_iv.bcast_own_sum = data_ptr;
137
138         ret = 0;
139
140 unlock:
141         spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
142
143         return ret;
144 }
145
146 /**
147  * batadv_iv_ogm_orig_del_if - change the private structures of the orig_node to
148  *  exclude the removed interface
149  * @orig_node: the orig_node that has to be changed
150  * @max_if_num: the current amount of interfaces
151  * @del_if_num: the index of the interface being removed
152  *
153  * Returns 0 on success, a negative error code otherwise.
154  */
155 static int batadv_iv_ogm_orig_del_if(struct batadv_orig_node *orig_node,
156                                      int max_if_num, int del_if_num)
157 {
158         int chunk_size,  ret = -ENOMEM, if_offset;
159         void *data_ptr = NULL;
160
161         spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
162
163         /* last interface was removed */
164         if (max_if_num == 0)
165                 goto free_bcast_own;
166
167         chunk_size = sizeof(unsigned long) * BATADV_NUM_WORDS;
168         data_ptr = kmalloc_array(max_if_num, chunk_size, GFP_ATOMIC);
169         if (!data_ptr)
170                 goto unlock;
171
172         /* copy first part */
173         memcpy(data_ptr, orig_node->bat_iv.bcast_own, del_if_num * chunk_size);
174
175         /* copy second part */
176         memcpy((char *)data_ptr + del_if_num * chunk_size,
177                orig_node->bat_iv.bcast_own + ((del_if_num + 1) * chunk_size),
178                (max_if_num - del_if_num) * chunk_size);
179
180 free_bcast_own:
181         kfree(orig_node->bat_iv.bcast_own);
182         orig_node->bat_iv.bcast_own = data_ptr;
183
184         if (max_if_num == 0)
185                 goto free_own_sum;
186
187         data_ptr = kmalloc_array(max_if_num, sizeof(uint8_t), GFP_ATOMIC);
188         if (!data_ptr) {
189                 kfree(orig_node->bat_iv.bcast_own);
190                 goto unlock;
191         }
192
193         memcpy(data_ptr, orig_node->bat_iv.bcast_own_sum,
194                del_if_num * sizeof(uint8_t));
195
196         if_offset = (del_if_num + 1) * sizeof(uint8_t);
197         memcpy((char *)data_ptr + del_if_num * sizeof(uint8_t),
198                orig_node->bat_iv.bcast_own_sum + if_offset,
199                (max_if_num - del_if_num) * sizeof(uint8_t));
200
201 free_own_sum:
202         kfree(orig_node->bat_iv.bcast_own_sum);
203         orig_node->bat_iv.bcast_own_sum = data_ptr;
204
205         ret = 0;
206 unlock:
207         spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
208
209         return ret;
210 }
211
212 /**
213  * batadv_iv_ogm_orig_get - retrieve or create (if does not exist) an originator
214  * @bat_priv: the bat priv with all the soft interface information
215  * @addr: mac address of the originator
216  *
217  * Returns the originator object corresponding to the passed mac address or NULL
218  * on failure.
219  * If the object does not exists it is created an initialised.
220  */
221 static struct batadv_orig_node *
222 batadv_iv_ogm_orig_get(struct batadv_priv *bat_priv, const uint8_t *addr)
223 {
224         struct batadv_orig_node *orig_node;
225         int size, hash_added;
226
227         orig_node = batadv_orig_hash_find(bat_priv, addr);
228         if (orig_node)
229                 return orig_node;
230
231         orig_node = batadv_orig_node_new(bat_priv, addr);
232         if (!orig_node)
233                 return NULL;
234
235         spin_lock_init(&orig_node->bat_iv.ogm_cnt_lock);
236
237         size = bat_priv->num_ifaces * sizeof(unsigned long) * BATADV_NUM_WORDS;
238         orig_node->bat_iv.bcast_own = kzalloc(size, GFP_ATOMIC);
239         if (!orig_node->bat_iv.bcast_own)
240                 goto free_orig_node;
241
242         size = bat_priv->num_ifaces * sizeof(uint8_t);
243         orig_node->bat_iv.bcast_own_sum = kzalloc(size, GFP_ATOMIC);
244         if (!orig_node->bat_iv.bcast_own_sum)
245                 goto free_orig_node;
246
247         hash_added = batadv_hash_add(bat_priv->orig_hash, batadv_compare_orig,
248                                      batadv_choose_orig, orig_node,
249                                      &orig_node->hash_entry);
250         if (hash_added != 0)
251                 goto free_orig_node;
252
253         return orig_node;
254
255 free_orig_node:
256         /* free twice, as batadv_orig_node_new sets refcount to 2 */
257         batadv_orig_node_free_ref(orig_node);
258         batadv_orig_node_free_ref(orig_node);
259
260         return NULL;
261 }
262
263 static struct batadv_neigh_node *
264 batadv_iv_ogm_neigh_new(struct batadv_hard_iface *hard_iface,
265                         const uint8_t *neigh_addr,
266                         struct batadv_orig_node *orig_node,
267                         struct batadv_orig_node *orig_neigh)
268 {
269         struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
270         struct batadv_neigh_node *neigh_node, *tmp_neigh_node;
271
272         neigh_node = batadv_neigh_node_new(hard_iface, neigh_addr, orig_node);
273         if (!neigh_node)
274                 goto out;
275
276         if (!atomic_inc_not_zero(&hard_iface->refcount)) {
277                 kfree(neigh_node);
278                 neigh_node = NULL;
279                 goto out;
280         }
281
282         neigh_node->orig_node = orig_neigh;
283         neigh_node->if_incoming = hard_iface;
284
285         spin_lock_bh(&orig_node->neigh_list_lock);
286         tmp_neigh_node = batadv_neigh_node_get(orig_node, hard_iface,
287                                                neigh_addr);
288         if (!tmp_neigh_node) {
289                 hlist_add_head_rcu(&neigh_node->list, &orig_node->neigh_list);
290         } else {
291                 kfree(neigh_node);
292                 batadv_hardif_free_ref(hard_iface);
293                 neigh_node = tmp_neigh_node;
294         }
295         spin_unlock_bh(&orig_node->neigh_list_lock);
296
297         if (!tmp_neigh_node)
298                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
299                            "Creating new neighbor %pM for orig_node %pM on interface %s\n",
300                            neigh_addr, orig_node->orig,
301                            hard_iface->net_dev->name);
302
303 out:
304         return neigh_node;
305 }
306
307 static int batadv_iv_ogm_iface_enable(struct batadv_hard_iface *hard_iface)
308 {
309         struct batadv_ogm_packet *batadv_ogm_packet;
310         unsigned char *ogm_buff;
311         uint32_t random_seqno;
312         int res = -ENOMEM;
313
314         /* randomize initial seqno to avoid collision */
315         get_random_bytes(&random_seqno, sizeof(random_seqno));
316         atomic_set(&hard_iface->bat_iv.ogm_seqno, random_seqno);
317
318         hard_iface->bat_iv.ogm_buff_len = BATADV_OGM_HLEN;
319         ogm_buff = kmalloc(hard_iface->bat_iv.ogm_buff_len, GFP_ATOMIC);
320         if (!ogm_buff)
321                 goto out;
322
323         hard_iface->bat_iv.ogm_buff = ogm_buff;
324
325         batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
326         batadv_ogm_packet->packet_type = BATADV_IV_OGM;
327         batadv_ogm_packet->version = BATADV_COMPAT_VERSION;
328         batadv_ogm_packet->ttl = 2;
329         batadv_ogm_packet->flags = BATADV_NO_FLAGS;
330         batadv_ogm_packet->reserved = 0;
331         batadv_ogm_packet->tq = BATADV_TQ_MAX_VALUE;
332
333         res = 0;
334
335 out:
336         return res;
337 }
338
339 static void batadv_iv_ogm_iface_disable(struct batadv_hard_iface *hard_iface)
340 {
341         kfree(hard_iface->bat_iv.ogm_buff);
342         hard_iface->bat_iv.ogm_buff = NULL;
343 }
344
345 static void batadv_iv_ogm_iface_update_mac(struct batadv_hard_iface *hard_iface)
346 {
347         struct batadv_ogm_packet *batadv_ogm_packet;
348         unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
349
350         batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
351         ether_addr_copy(batadv_ogm_packet->orig,
352                         hard_iface->net_dev->dev_addr);
353         ether_addr_copy(batadv_ogm_packet->prev_sender,
354                         hard_iface->net_dev->dev_addr);
355 }
356
357 static void
358 batadv_iv_ogm_primary_iface_set(struct batadv_hard_iface *hard_iface)
359 {
360         struct batadv_ogm_packet *batadv_ogm_packet;
361         unsigned char *ogm_buff = hard_iface->bat_iv.ogm_buff;
362
363         batadv_ogm_packet = (struct batadv_ogm_packet *)ogm_buff;
364         batadv_ogm_packet->flags = BATADV_PRIMARIES_FIRST_HOP;
365         batadv_ogm_packet->ttl = BATADV_TTL;
366 }
367
368 /* when do we schedule our own ogm to be sent */
369 static unsigned long
370 batadv_iv_ogm_emit_send_time(const struct batadv_priv *bat_priv)
371 {
372         unsigned int msecs;
373
374         msecs = atomic_read(&bat_priv->orig_interval) - BATADV_JITTER;
375         msecs += prandom_u32() % (2 * BATADV_JITTER);
376
377         return jiffies + msecs_to_jiffies(msecs);
378 }
379
380 /* when do we schedule a ogm packet to be sent */
381 static unsigned long batadv_iv_ogm_fwd_send_time(void)
382 {
383         return jiffies + msecs_to_jiffies(prandom_u32() % (BATADV_JITTER / 2));
384 }
385
386 /* apply hop penalty for a normal link */
387 static uint8_t batadv_hop_penalty(uint8_t tq,
388                                   const struct batadv_priv *bat_priv)
389 {
390         int hop_penalty = atomic_read(&bat_priv->hop_penalty);
391         int new_tq;
392
393         new_tq = tq * (BATADV_TQ_MAX_VALUE - hop_penalty);
394         new_tq /= BATADV_TQ_MAX_VALUE;
395
396         return new_tq;
397 }
398
399 /* is there another aggregated packet here? */
400 static int batadv_iv_ogm_aggr_packet(int buff_pos, int packet_len,
401                                      __be16 tvlv_len)
402 {
403         int next_buff_pos = 0;
404
405         next_buff_pos += buff_pos + BATADV_OGM_HLEN;
406         next_buff_pos += ntohs(tvlv_len);
407
408         return (next_buff_pos <= packet_len) &&
409                (next_buff_pos <= BATADV_MAX_AGGREGATION_BYTES);
410 }
411
412 /* send a batman ogm to a given interface */
413 static void batadv_iv_ogm_send_to_if(struct batadv_forw_packet *forw_packet,
414                                      struct batadv_hard_iface *hard_iface)
415 {
416         struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
417         char *fwd_str;
418         uint8_t packet_num;
419         int16_t buff_pos;
420         struct batadv_ogm_packet *batadv_ogm_packet;
421         struct sk_buff *skb;
422         uint8_t *packet_pos;
423
424         if (hard_iface->if_status != BATADV_IF_ACTIVE)
425                 return;
426
427         packet_num = 0;
428         buff_pos = 0;
429         packet_pos = forw_packet->skb->data;
430         batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
431
432         /* adjust all flags and log packets */
433         while (batadv_iv_ogm_aggr_packet(buff_pos, forw_packet->packet_len,
434                                          batadv_ogm_packet->tvlv_len)) {
435                 /* we might have aggregated direct link packets with an
436                  * ordinary base packet
437                  */
438                 if (forw_packet->direct_link_flags & BIT(packet_num) &&
439                     forw_packet->if_incoming == hard_iface)
440                         batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
441                 else
442                         batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
443
444                 if (packet_num > 0 || !forw_packet->own)
445                         fwd_str = "Forwarding";
446                 else
447                         fwd_str = "Sending own";
448
449                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
450                            "%s %spacket (originator %pM, seqno %u, TQ %d, TTL %d, IDF %s) on interface %s [%pM]\n",
451                            fwd_str, (packet_num > 0 ? "aggregated " : ""),
452                            batadv_ogm_packet->orig,
453                            ntohl(batadv_ogm_packet->seqno),
454                            batadv_ogm_packet->tq, batadv_ogm_packet->ttl,
455                            (batadv_ogm_packet->flags & BATADV_DIRECTLINK ?
456                             "on" : "off"),
457                            hard_iface->net_dev->name,
458                            hard_iface->net_dev->dev_addr);
459
460                 buff_pos += BATADV_OGM_HLEN;
461                 buff_pos += ntohs(batadv_ogm_packet->tvlv_len);
462                 packet_num++;
463                 packet_pos = forw_packet->skb->data + buff_pos;
464                 batadv_ogm_packet = (struct batadv_ogm_packet *)packet_pos;
465         }
466
467         /* create clone because function is called more than once */
468         skb = skb_clone(forw_packet->skb, GFP_ATOMIC);
469         if (skb) {
470                 batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_TX);
471                 batadv_add_counter(bat_priv, BATADV_CNT_MGMT_TX_BYTES,
472                                    skb->len + ETH_HLEN);
473                 batadv_send_skb_packet(skb, hard_iface, batadv_broadcast_addr);
474         }
475 }
476
477 /* send a batman ogm packet */
478 static void batadv_iv_ogm_emit(struct batadv_forw_packet *forw_packet)
479 {
480         struct net_device *soft_iface;
481         struct batadv_priv *bat_priv;
482         struct batadv_hard_iface *primary_if = NULL;
483
484         if (!forw_packet->if_incoming) {
485                 pr_err("Error - can't forward packet: incoming iface not specified\n");
486                 goto out;
487         }
488
489         soft_iface = forw_packet->if_incoming->soft_iface;
490         bat_priv = netdev_priv(soft_iface);
491
492         if (WARN_ON(!forw_packet->if_outgoing))
493                 goto out;
494
495         if (WARN_ON(forw_packet->if_outgoing->soft_iface != soft_iface))
496                 goto out;
497
498         if (forw_packet->if_incoming->if_status != BATADV_IF_ACTIVE)
499                 goto out;
500
501         primary_if = batadv_primary_if_get_selected(bat_priv);
502         if (!primary_if)
503                 goto out;
504
505         /* only for one specific outgoing interface */
506         batadv_iv_ogm_send_to_if(forw_packet, forw_packet->if_outgoing);
507
508 out:
509         if (primary_if)
510                 batadv_hardif_free_ref(primary_if);
511 }
512
513 /**
514  * batadv_iv_ogm_can_aggregate - find out if an OGM can be aggregated on an
515  *  existing forward packet
516  * @new_bat_ogm_packet: OGM packet to be aggregated
517  * @bat_priv: the bat priv with all the soft interface information
518  * @packet_len: (total) length of the OGM
519  * @send_time: timestamp (jiffies) when the packet is to be sent
520  * @directlink: true if this is a direct link packet
521  * @if_incoming: interface where the packet was received
522  * @if_outgoing: interface for which the retransmission should be considered
523  * @forw_packet: the forwarded packet which should be checked
524  *
525  * Returns true if new_packet can be aggregated with forw_packet
526  */
527 static bool
528 batadv_iv_ogm_can_aggregate(const struct batadv_ogm_packet *new_bat_ogm_packet,
529                             struct batadv_priv *bat_priv,
530                             int packet_len, unsigned long send_time,
531                             bool directlink,
532                             const struct batadv_hard_iface *if_incoming,
533                             const struct batadv_hard_iface *if_outgoing,
534                             const struct batadv_forw_packet *forw_packet)
535 {
536         struct batadv_ogm_packet *batadv_ogm_packet;
537         int aggregated_bytes = forw_packet->packet_len + packet_len;
538         struct batadv_hard_iface *primary_if = NULL;
539         bool res = false;
540         unsigned long aggregation_end_time;
541
542         batadv_ogm_packet = (struct batadv_ogm_packet *)forw_packet->skb->data;
543         aggregation_end_time = send_time;
544         aggregation_end_time += msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
545
546         /* we can aggregate the current packet to this aggregated packet
547          * if:
548          *
549          * - the send time is within our MAX_AGGREGATION_MS time
550          * - the resulting packet wont be bigger than
551          *   MAX_AGGREGATION_BYTES
552          */
553         if (time_before(send_time, forw_packet->send_time) &&
554             time_after_eq(aggregation_end_time, forw_packet->send_time) &&
555             (aggregated_bytes <= BATADV_MAX_AGGREGATION_BYTES)) {
556                 /* check aggregation compatibility
557                  * -> direct link packets are broadcasted on
558                  *    their interface only
559                  * -> aggregate packet if the current packet is
560                  *    a "global" packet as well as the base
561                  *    packet
562                  */
563                 primary_if = batadv_primary_if_get_selected(bat_priv);
564                 if (!primary_if)
565                         goto out;
566
567                 /* packet is not leaving on the same interface. */
568                 if (forw_packet->if_outgoing != if_outgoing)
569                         goto out;
570
571                 /* packets without direct link flag and high TTL
572                  * are flooded through the net
573                  */
574                 if ((!directlink) &&
575                     (!(batadv_ogm_packet->flags & BATADV_DIRECTLINK)) &&
576                     (batadv_ogm_packet->ttl != 1) &&
577
578                     /* own packets originating non-primary
579                      * interfaces leave only that interface
580                      */
581                     ((!forw_packet->own) ||
582                      (forw_packet->if_incoming == primary_if))) {
583                         res = true;
584                         goto out;
585                 }
586
587                 /* if the incoming packet is sent via this one
588                  * interface only - we still can aggregate
589                  */
590                 if ((directlink) &&
591                     (new_bat_ogm_packet->ttl == 1) &&
592                     (forw_packet->if_incoming == if_incoming) &&
593
594                     /* packets from direct neighbors or
595                      * own secondary interface packets
596                      * (= secondary interface packets in general)
597                      */
598                     (batadv_ogm_packet->flags & BATADV_DIRECTLINK ||
599                      (forw_packet->own &&
600                       forw_packet->if_incoming != primary_if))) {
601                         res = true;
602                         goto out;
603                 }
604         }
605
606 out:
607         if (primary_if)
608                 batadv_hardif_free_ref(primary_if);
609         return res;
610 }
611
612 /**
613  * batadv_iv_ogm_aggregate_new - create a new aggregated packet and add this
614  *  packet to it.
615  * @packet_buff: pointer to the OGM
616  * @packet_len: (total) length of the OGM
617  * @send_time: timestamp (jiffies) when the packet is to be sent
618  * @direct_link: whether this OGM has direct link status
619  * @if_incoming: interface where the packet was received
620  * @if_outgoing: interface for which the retransmission should be considered
621  * @own_packet: true if it is a self-generated ogm
622  */
623 static void batadv_iv_ogm_aggregate_new(const unsigned char *packet_buff,
624                                         int packet_len, unsigned long send_time,
625                                         bool direct_link,
626                                         struct batadv_hard_iface *if_incoming,
627                                         struct batadv_hard_iface *if_outgoing,
628                                         int own_packet)
629 {
630         struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
631         struct batadv_forw_packet *forw_packet_aggr;
632         unsigned char *skb_buff;
633         unsigned int skb_size;
634
635         if (!atomic_inc_not_zero(&if_incoming->refcount))
636                 return;
637
638         if (!atomic_inc_not_zero(&if_outgoing->refcount))
639                 goto out_free_incoming;
640
641         /* own packet should always be scheduled */
642         if (!own_packet) {
643                 if (!batadv_atomic_dec_not_zero(&bat_priv->batman_queue_left)) {
644                         batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
645                                    "batman packet queue full\n");
646                         goto out;
647                 }
648         }
649
650         forw_packet_aggr = kmalloc(sizeof(*forw_packet_aggr), GFP_ATOMIC);
651         if (!forw_packet_aggr) {
652                 if (!own_packet)
653                         atomic_inc(&bat_priv->batman_queue_left);
654                 goto out;
655         }
656
657         if ((atomic_read(&bat_priv->aggregated_ogms)) &&
658             (packet_len < BATADV_MAX_AGGREGATION_BYTES))
659                 skb_size = BATADV_MAX_AGGREGATION_BYTES;
660         else
661                 skb_size = packet_len;
662
663         skb_size += ETH_HLEN;
664
665         forw_packet_aggr->skb = netdev_alloc_skb_ip_align(NULL, skb_size);
666         if (!forw_packet_aggr->skb) {
667                 if (!own_packet)
668                         atomic_inc(&bat_priv->batman_queue_left);
669                 kfree(forw_packet_aggr);
670                 goto out;
671         }
672         forw_packet_aggr->skb->priority = TC_PRIO_CONTROL;
673         skb_reserve(forw_packet_aggr->skb, ETH_HLEN);
674
675         skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
676         forw_packet_aggr->packet_len = packet_len;
677         memcpy(skb_buff, packet_buff, packet_len);
678
679         forw_packet_aggr->own = own_packet;
680         forw_packet_aggr->if_incoming = if_incoming;
681         forw_packet_aggr->if_outgoing = if_outgoing;
682         forw_packet_aggr->num_packets = 0;
683         forw_packet_aggr->direct_link_flags = BATADV_NO_FLAGS;
684         forw_packet_aggr->send_time = send_time;
685
686         /* save packet direct link flag status */
687         if (direct_link)
688                 forw_packet_aggr->direct_link_flags |= 1;
689
690         /* add new packet to packet list */
691         spin_lock_bh(&bat_priv->forw_bat_list_lock);
692         hlist_add_head(&forw_packet_aggr->list, &bat_priv->forw_bat_list);
693         spin_unlock_bh(&bat_priv->forw_bat_list_lock);
694
695         /* start timer for this packet */
696         INIT_DELAYED_WORK(&forw_packet_aggr->delayed_work,
697                           batadv_send_outstanding_bat_ogm_packet);
698         queue_delayed_work(batadv_event_workqueue,
699                            &forw_packet_aggr->delayed_work,
700                            send_time - jiffies);
701
702         return;
703 out:
704         batadv_hardif_free_ref(if_outgoing);
705 out_free_incoming:
706         batadv_hardif_free_ref(if_incoming);
707 }
708
709 /* aggregate a new packet into the existing ogm packet */
710 static void batadv_iv_ogm_aggregate(struct batadv_forw_packet *forw_packet_aggr,
711                                     const unsigned char *packet_buff,
712                                     int packet_len, bool direct_link)
713 {
714         unsigned char *skb_buff;
715         unsigned long new_direct_link_flag;
716
717         skb_buff = skb_put(forw_packet_aggr->skb, packet_len);
718         memcpy(skb_buff, packet_buff, packet_len);
719         forw_packet_aggr->packet_len += packet_len;
720         forw_packet_aggr->num_packets++;
721
722         /* save packet direct link flag status */
723         if (direct_link) {
724                 new_direct_link_flag = BIT(forw_packet_aggr->num_packets);
725                 forw_packet_aggr->direct_link_flags |= new_direct_link_flag;
726         }
727 }
728
729 /**
730  * batadv_iv_ogm_queue_add - queue up an OGM for transmission
731  * @bat_priv: the bat priv with all the soft interface information
732  * @packet_buff: pointer to the OGM
733  * @packet_len: (total) length of the OGM
734  * @if_incoming: interface where the packet was received
735  * @if_outgoing: interface for which the retransmission should be considered
736  * @own_packet: true if it is a self-generated ogm
737  * @send_time: timestamp (jiffies) when the packet is to be sent
738  */
739 static void batadv_iv_ogm_queue_add(struct batadv_priv *bat_priv,
740                                     unsigned char *packet_buff,
741                                     int packet_len,
742                                     struct batadv_hard_iface *if_incoming,
743                                     struct batadv_hard_iface *if_outgoing,
744                                     int own_packet, unsigned long send_time)
745 {
746         /* _aggr -> pointer to the packet we want to aggregate with
747          * _pos -> pointer to the position in the queue
748          */
749         struct batadv_forw_packet *forw_packet_aggr = NULL;
750         struct batadv_forw_packet *forw_packet_pos = NULL;
751         struct batadv_ogm_packet *batadv_ogm_packet;
752         bool direct_link;
753         unsigned long max_aggregation_jiffies;
754
755         batadv_ogm_packet = (struct batadv_ogm_packet *)packet_buff;
756         direct_link = batadv_ogm_packet->flags & BATADV_DIRECTLINK ? 1 : 0;
757         max_aggregation_jiffies = msecs_to_jiffies(BATADV_MAX_AGGREGATION_MS);
758
759         /* find position for the packet in the forward queue */
760         spin_lock_bh(&bat_priv->forw_bat_list_lock);
761         /* own packets are not to be aggregated */
762         if ((atomic_read(&bat_priv->aggregated_ogms)) && (!own_packet)) {
763                 hlist_for_each_entry(forw_packet_pos,
764                                      &bat_priv->forw_bat_list, list) {
765                         if (batadv_iv_ogm_can_aggregate(batadv_ogm_packet,
766                                                         bat_priv, packet_len,
767                                                         send_time, direct_link,
768                                                         if_incoming,
769                                                         if_outgoing,
770                                                         forw_packet_pos)) {
771                                 forw_packet_aggr = forw_packet_pos;
772                                 break;
773                         }
774                 }
775         }
776
777         /* nothing to aggregate with - either aggregation disabled or no
778          * suitable aggregation packet found
779          */
780         if (!forw_packet_aggr) {
781                 /* the following section can run without the lock */
782                 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
783
784                 /* if we could not aggregate this packet with one of the others
785                  * we hold it back for a while, so that it might be aggregated
786                  * later on
787                  */
788                 if (!own_packet && atomic_read(&bat_priv->aggregated_ogms))
789                         send_time += max_aggregation_jiffies;
790
791                 batadv_iv_ogm_aggregate_new(packet_buff, packet_len,
792                                             send_time, direct_link,
793                                             if_incoming, if_outgoing,
794                                             own_packet);
795         } else {
796                 batadv_iv_ogm_aggregate(forw_packet_aggr, packet_buff,
797                                         packet_len, direct_link);
798                 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
799         }
800 }
801
802 static void batadv_iv_ogm_forward(struct batadv_orig_node *orig_node,
803                                   const struct ethhdr *ethhdr,
804                                   struct batadv_ogm_packet *batadv_ogm_packet,
805                                   bool is_single_hop_neigh,
806                                   bool is_from_best_next_hop,
807                                   struct batadv_hard_iface *if_incoming,
808                                   struct batadv_hard_iface *if_outgoing)
809 {
810         struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
811         uint16_t tvlv_len;
812
813         if (batadv_ogm_packet->ttl <= 1) {
814                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "ttl exceeded\n");
815                 return;
816         }
817
818         if (!is_from_best_next_hop) {
819                 /* Mark the forwarded packet when it is not coming from our
820                  * best next hop. We still need to forward the packet for our
821                  * neighbor link quality detection to work in case the packet
822                  * originated from a single hop neighbor. Otherwise we can
823                  * simply drop the ogm.
824                  */
825                 if (is_single_hop_neigh)
826                         batadv_ogm_packet->flags |= BATADV_NOT_BEST_NEXT_HOP;
827                 else
828                         return;
829         }
830
831         tvlv_len = ntohs(batadv_ogm_packet->tvlv_len);
832
833         batadv_ogm_packet->ttl--;
834         ether_addr_copy(batadv_ogm_packet->prev_sender, ethhdr->h_source);
835
836         /* apply hop penalty */
837         batadv_ogm_packet->tq = batadv_hop_penalty(batadv_ogm_packet->tq,
838                                                    bat_priv);
839
840         batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
841                    "Forwarding packet: tq: %i, ttl: %i\n",
842                    batadv_ogm_packet->tq, batadv_ogm_packet->ttl);
843
844         /* switch of primaries first hop flag when forwarding */
845         batadv_ogm_packet->flags &= ~BATADV_PRIMARIES_FIRST_HOP;
846         if (is_single_hop_neigh)
847                 batadv_ogm_packet->flags |= BATADV_DIRECTLINK;
848         else
849                 batadv_ogm_packet->flags &= ~BATADV_DIRECTLINK;
850
851         batadv_iv_ogm_queue_add(bat_priv, (unsigned char *)batadv_ogm_packet,
852                                 BATADV_OGM_HLEN + tvlv_len,
853                                 if_incoming, if_outgoing, 0,
854                                 batadv_iv_ogm_fwd_send_time());
855 }
856
857 /**
858  * batadv_iv_ogm_slide_own_bcast_window - bitshift own OGM broadcast windows for
859  * the given interface
860  * @hard_iface: the interface for which the windows have to be shifted
861  */
862 static void
863 batadv_iv_ogm_slide_own_bcast_window(struct batadv_hard_iface *hard_iface)
864 {
865         struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
866         struct batadv_hashtable *hash = bat_priv->orig_hash;
867         struct hlist_head *head;
868         struct batadv_orig_node *orig_node;
869         unsigned long *word;
870         uint32_t i;
871         size_t word_index;
872         uint8_t *w;
873         int if_num;
874
875         for (i = 0; i < hash->size; i++) {
876                 head = &hash->table[i];
877
878                 rcu_read_lock();
879                 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
880                         spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
881                         word_index = hard_iface->if_num * BATADV_NUM_WORDS;
882                         word = &(orig_node->bat_iv.bcast_own[word_index]);
883
884                         batadv_bit_get_packet(bat_priv, word, 1, 0);
885                         if_num = hard_iface->if_num;
886                         w = &orig_node->bat_iv.bcast_own_sum[if_num];
887                         *w = bitmap_weight(word, BATADV_TQ_LOCAL_WINDOW_SIZE);
888                         spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
889                 }
890                 rcu_read_unlock();
891         }
892 }
893
894 static void batadv_iv_ogm_schedule(struct batadv_hard_iface *hard_iface)
895 {
896         struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
897         unsigned char **ogm_buff = &hard_iface->bat_iv.ogm_buff;
898         struct batadv_ogm_packet *batadv_ogm_packet;
899         struct batadv_hard_iface *primary_if, *tmp_hard_iface;
900         int *ogm_buff_len = &hard_iface->bat_iv.ogm_buff_len;
901         uint32_t seqno;
902         uint16_t tvlv_len = 0;
903         unsigned long send_time;
904
905         primary_if = batadv_primary_if_get_selected(bat_priv);
906
907         if (hard_iface == primary_if) {
908                 /* tt changes have to be committed before the tvlv data is
909                  * appended as it may alter the tt tvlv container
910                  */
911                 batadv_tt_local_commit_changes(bat_priv);
912                 tvlv_len = batadv_tvlv_container_ogm_append(bat_priv, ogm_buff,
913                                                             ogm_buff_len,
914                                                             BATADV_OGM_HLEN);
915         }
916
917         batadv_ogm_packet = (struct batadv_ogm_packet *)(*ogm_buff);
918         batadv_ogm_packet->tvlv_len = htons(tvlv_len);
919
920         /* change sequence number to network order */
921         seqno = (uint32_t)atomic_read(&hard_iface->bat_iv.ogm_seqno);
922         batadv_ogm_packet->seqno = htonl(seqno);
923         atomic_inc(&hard_iface->bat_iv.ogm_seqno);
924
925         batadv_iv_ogm_slide_own_bcast_window(hard_iface);
926
927         send_time = batadv_iv_ogm_emit_send_time(bat_priv);
928
929         if (hard_iface != primary_if) {
930                 /* OGMs from secondary interfaces are only scheduled on their
931                  * respective interfaces.
932                  */
933                 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff, *ogm_buff_len,
934                                         hard_iface, hard_iface, 1, send_time);
935                 goto out;
936         }
937
938         /* OGMs from primary interfaces are scheduled on all
939          * interfaces.
940          */
941         rcu_read_lock();
942         list_for_each_entry_rcu(tmp_hard_iface, &batadv_hardif_list, list) {
943                 if (tmp_hard_iface->soft_iface != hard_iface->soft_iface)
944                                 continue;
945                 batadv_iv_ogm_queue_add(bat_priv, *ogm_buff,
946                                         *ogm_buff_len, hard_iface,
947                                         tmp_hard_iface, 1, send_time);
948         }
949         rcu_read_unlock();
950
951 out:
952         if (primary_if)
953                 batadv_hardif_free_ref(primary_if);
954 }
955
956 /**
957  * batadv_iv_ogm_orig_update - use OGM to update corresponding data in an
958  *  originator
959  * @bat_priv: the bat priv with all the soft interface information
960  * @orig_node: the orig node who originally emitted the ogm packet
961  * @orig_ifinfo: ifinfo for the outgoing interface of the orig_node
962  * @ethhdr: Ethernet header of the OGM
963  * @batadv_ogm_packet: the ogm packet
964  * @if_incoming: interface where the packet was received
965  * @if_outgoing: interface for which the retransmission should be considered
966  * @dup_status: the duplicate status of this ogm packet.
967  */
968 static void
969 batadv_iv_ogm_orig_update(struct batadv_priv *bat_priv,
970                           struct batadv_orig_node *orig_node,
971                           struct batadv_orig_ifinfo *orig_ifinfo,
972                           const struct ethhdr *ethhdr,
973                           const struct batadv_ogm_packet *batadv_ogm_packet,
974                           struct batadv_hard_iface *if_incoming,
975                           struct batadv_hard_iface *if_outgoing,
976                           enum batadv_dup_status dup_status)
977 {
978         struct batadv_neigh_ifinfo *neigh_ifinfo = NULL;
979         struct batadv_neigh_ifinfo *router_ifinfo = NULL;
980         struct batadv_neigh_node *neigh_node = NULL, *tmp_neigh_node = NULL;
981         struct batadv_neigh_node *router = NULL;
982         struct batadv_orig_node *orig_node_tmp;
983         int if_num;
984         uint8_t sum_orig, sum_neigh;
985         uint8_t *neigh_addr;
986         uint8_t tq_avg;
987
988         batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
989                    "update_originator(): Searching and updating originator entry of received packet\n");
990
991         rcu_read_lock();
992         hlist_for_each_entry_rcu(tmp_neigh_node,
993                                  &orig_node->neigh_list, list) {
994                 neigh_addr = tmp_neigh_node->addr;
995                 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
996                     tmp_neigh_node->if_incoming == if_incoming &&
997                     atomic_inc_not_zero(&tmp_neigh_node->refcount)) {
998                         if (WARN(neigh_node, "too many matching neigh_nodes"))
999                                 batadv_neigh_node_free_ref(neigh_node);
1000                         neigh_node = tmp_neigh_node;
1001                         continue;
1002                 }
1003
1004                 if (dup_status != BATADV_NO_DUP)
1005                         continue;
1006
1007                 /* only update the entry for this outgoing interface */
1008                 neigh_ifinfo = batadv_neigh_ifinfo_get(tmp_neigh_node,
1009                                                        if_outgoing);
1010                 if (!neigh_ifinfo)
1011                         continue;
1012
1013                 spin_lock_bh(&tmp_neigh_node->ifinfo_lock);
1014                 batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1015                                        &neigh_ifinfo->bat_iv.tq_index, 0);
1016                 tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1017                 neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1018                 spin_unlock_bh(&tmp_neigh_node->ifinfo_lock);
1019
1020                 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1021                 neigh_ifinfo = NULL;
1022         }
1023
1024         if (!neigh_node) {
1025                 struct batadv_orig_node *orig_tmp;
1026
1027                 orig_tmp = batadv_iv_ogm_orig_get(bat_priv, ethhdr->h_source);
1028                 if (!orig_tmp)
1029                         goto unlock;
1030
1031                 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1032                                                      ethhdr->h_source,
1033                                                      orig_node, orig_tmp);
1034
1035                 batadv_orig_node_free_ref(orig_tmp);
1036                 if (!neigh_node)
1037                         goto unlock;
1038         } else
1039                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1040                            "Updating existing last-hop neighbor of originator\n");
1041
1042         rcu_read_unlock();
1043         neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1044         if (!neigh_ifinfo)
1045                 goto out;
1046
1047         neigh_node->last_seen = jiffies;
1048
1049         spin_lock_bh(&neigh_node->ifinfo_lock);
1050         batadv_ring_buffer_set(neigh_ifinfo->bat_iv.tq_recv,
1051                                &neigh_ifinfo->bat_iv.tq_index,
1052                                batadv_ogm_packet->tq);
1053         tq_avg = batadv_ring_buffer_avg(neigh_ifinfo->bat_iv.tq_recv);
1054         neigh_ifinfo->bat_iv.tq_avg = tq_avg;
1055         spin_unlock_bh(&neigh_node->ifinfo_lock);
1056
1057         if (dup_status == BATADV_NO_DUP) {
1058                 orig_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1059                 neigh_ifinfo->last_ttl = batadv_ogm_packet->ttl;
1060         }
1061
1062         /* if this neighbor already is our next hop there is nothing
1063          * to change
1064          */
1065         router = batadv_orig_router_get(orig_node, if_outgoing);
1066         if (router == neigh_node)
1067                 goto out;
1068
1069         if (router) {
1070                 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1071                 if (!router_ifinfo)
1072                         goto out;
1073
1074                 /* if this neighbor does not offer a better TQ we won't
1075                  * consider it
1076                  */
1077                 if (router_ifinfo->bat_iv.tq_avg > neigh_ifinfo->bat_iv.tq_avg)
1078                         goto out;
1079         }
1080
1081         /* if the TQ is the same and the link not more symmetric we
1082          * won't consider it either
1083          */
1084         if (router_ifinfo &&
1085             (neigh_ifinfo->bat_iv.tq_avg == router_ifinfo->bat_iv.tq_avg)) {
1086                 orig_node_tmp = router->orig_node;
1087                 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1088                 if_num = router->if_incoming->if_num;
1089                 sum_orig = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1090                 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1091
1092                 orig_node_tmp = neigh_node->orig_node;
1093                 spin_lock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1094                 if_num = neigh_node->if_incoming->if_num;
1095                 sum_neigh = orig_node_tmp->bat_iv.bcast_own_sum[if_num];
1096                 spin_unlock_bh(&orig_node_tmp->bat_iv.ogm_cnt_lock);
1097
1098                 if (sum_orig >= sum_neigh)
1099                         goto out;
1100         }
1101
1102         batadv_update_route(bat_priv, orig_node, if_outgoing, neigh_node);
1103         goto out;
1104
1105 unlock:
1106         rcu_read_unlock();
1107 out:
1108         if (neigh_node)
1109                 batadv_neigh_node_free_ref(neigh_node);
1110         if (router)
1111                 batadv_neigh_node_free_ref(router);
1112         if (neigh_ifinfo)
1113                 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1114         if (router_ifinfo)
1115                 batadv_neigh_ifinfo_free_ref(router_ifinfo);
1116 }
1117
1118 /**
1119  * batadv_iv_ogm_calc_tq - calculate tq for current received ogm packet
1120  * @orig_node: the orig node who originally emitted the ogm packet
1121  * @orig_neigh_node: the orig node struct of the neighbor who sent the packet
1122  * @batadv_ogm_packet: the ogm packet
1123  * @if_incoming: interface where the packet was received
1124  * @if_outgoing: interface for which the retransmission should be considered
1125  *
1126  * Returns 1 if the link can be considered bidirectional, 0 otherwise
1127  */
1128 static int batadv_iv_ogm_calc_tq(struct batadv_orig_node *orig_node,
1129                                  struct batadv_orig_node *orig_neigh_node,
1130                                  struct batadv_ogm_packet *batadv_ogm_packet,
1131                                  struct batadv_hard_iface *if_incoming,
1132                                  struct batadv_hard_iface *if_outgoing)
1133 {
1134         struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1135         struct batadv_neigh_node *neigh_node = NULL, *tmp_neigh_node;
1136         struct batadv_neigh_ifinfo *neigh_ifinfo;
1137         uint8_t total_count;
1138         uint8_t orig_eq_count, neigh_rq_count, neigh_rq_inv, tq_own;
1139         unsigned int neigh_rq_inv_cube, neigh_rq_max_cube;
1140         int tq_asym_penalty, inv_asym_penalty, if_num, ret = 0;
1141         unsigned int combined_tq;
1142         int tq_iface_penalty;
1143
1144         /* find corresponding one hop neighbor */
1145         rcu_read_lock();
1146         hlist_for_each_entry_rcu(tmp_neigh_node,
1147                                  &orig_neigh_node->neigh_list, list) {
1148                 if (!batadv_compare_eth(tmp_neigh_node->addr,
1149                                         orig_neigh_node->orig))
1150                         continue;
1151
1152                 if (tmp_neigh_node->if_incoming != if_incoming)
1153                         continue;
1154
1155                 if (!atomic_inc_not_zero(&tmp_neigh_node->refcount))
1156                         continue;
1157
1158                 neigh_node = tmp_neigh_node;
1159                 break;
1160         }
1161         rcu_read_unlock();
1162
1163         if (!neigh_node)
1164                 neigh_node = batadv_iv_ogm_neigh_new(if_incoming,
1165                                                      orig_neigh_node->orig,
1166                                                      orig_neigh_node,
1167                                                      orig_neigh_node);
1168
1169         if (!neigh_node)
1170                 goto out;
1171
1172         /* if orig_node is direct neighbor update neigh_node last_seen */
1173         if (orig_node == orig_neigh_node)
1174                 neigh_node->last_seen = jiffies;
1175
1176         orig_node->last_seen = jiffies;
1177
1178         /* find packet count of corresponding one hop neighbor */
1179         spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1180         if_num = if_incoming->if_num;
1181         orig_eq_count = orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1182         neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node, if_outgoing);
1183         if (neigh_ifinfo) {
1184                 neigh_rq_count = neigh_ifinfo->bat_iv.real_packet_count;
1185                 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1186         } else {
1187                 neigh_rq_count = 0;
1188         }
1189         spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1190
1191         /* pay attention to not get a value bigger than 100 % */
1192         if (orig_eq_count > neigh_rq_count)
1193                 total_count = neigh_rq_count;
1194         else
1195                 total_count = orig_eq_count;
1196
1197         /* if we have too few packets (too less data) we set tq_own to zero
1198          * if we receive too few packets it is not considered bidirectional
1199          */
1200         if (total_count < BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM ||
1201             neigh_rq_count < BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM)
1202                 tq_own = 0;
1203         else
1204                 /* neigh_node->real_packet_count is never zero as we
1205                  * only purge old information when getting new
1206                  * information
1207                  */
1208                 tq_own = (BATADV_TQ_MAX_VALUE * total_count) /  neigh_rq_count;
1209
1210         /* 1 - ((1-x) ** 3), normalized to TQ_MAX_VALUE this does
1211          * affect the nearly-symmetric links only a little, but
1212          * punishes asymmetric links more.  This will give a value
1213          * between 0 and TQ_MAX_VALUE
1214          */
1215         neigh_rq_inv = BATADV_TQ_LOCAL_WINDOW_SIZE - neigh_rq_count;
1216         neigh_rq_inv_cube = neigh_rq_inv * neigh_rq_inv * neigh_rq_inv;
1217         neigh_rq_max_cube = BATADV_TQ_LOCAL_WINDOW_SIZE *
1218                             BATADV_TQ_LOCAL_WINDOW_SIZE *
1219                             BATADV_TQ_LOCAL_WINDOW_SIZE;
1220         inv_asym_penalty = BATADV_TQ_MAX_VALUE * neigh_rq_inv_cube;
1221         inv_asym_penalty /= neigh_rq_max_cube;
1222         tq_asym_penalty = BATADV_TQ_MAX_VALUE - inv_asym_penalty;
1223
1224         /* penalize if the OGM is forwarded on the same interface. WiFi
1225          * interfaces and other half duplex devices suffer from throughput
1226          * drops as they can't send and receive at the same time.
1227          */
1228         tq_iface_penalty = BATADV_TQ_MAX_VALUE;
1229         if (if_outgoing && (if_incoming == if_outgoing) &&
1230             batadv_is_wifi_netdev(if_outgoing->net_dev))
1231                 tq_iface_penalty = batadv_hop_penalty(BATADV_TQ_MAX_VALUE,
1232                                                       bat_priv);
1233
1234         combined_tq = batadv_ogm_packet->tq *
1235                       tq_own *
1236                       tq_asym_penalty *
1237                       tq_iface_penalty;
1238         combined_tq /= BATADV_TQ_MAX_VALUE *
1239                        BATADV_TQ_MAX_VALUE *
1240                        BATADV_TQ_MAX_VALUE;
1241         batadv_ogm_packet->tq = combined_tq;
1242
1243         batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1244                    "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",
1245                    orig_node->orig, orig_neigh_node->orig, total_count,
1246                    neigh_rq_count, tq_own, tq_asym_penalty, tq_iface_penalty,
1247                    batadv_ogm_packet->tq, if_incoming->net_dev->name,
1248                    if_outgoing ? if_outgoing->net_dev->name : "DEFAULT");
1249
1250         /* if link has the minimum required transmission quality
1251          * consider it bidirectional
1252          */
1253         if (batadv_ogm_packet->tq >= BATADV_TQ_TOTAL_BIDRECT_LIMIT)
1254                 ret = 1;
1255
1256 out:
1257         if (neigh_node)
1258                 batadv_neigh_node_free_ref(neigh_node);
1259         return ret;
1260 }
1261
1262 /**
1263  * batadv_iv_ogm_update_seqnos -  process a batman packet for all interfaces,
1264  *  adjust the sequence number and find out whether it is a duplicate
1265  * @ethhdr: ethernet header of the packet
1266  * @batadv_ogm_packet: OGM packet to be considered
1267  * @if_incoming: interface on which the OGM packet was received
1268  * @if_outgoing: interface for which the retransmission should be considered
1269  *
1270  * Returns duplicate status as enum batadv_dup_status
1271  */
1272 static enum batadv_dup_status
1273 batadv_iv_ogm_update_seqnos(const struct ethhdr *ethhdr,
1274                             const struct batadv_ogm_packet *batadv_ogm_packet,
1275                             const struct batadv_hard_iface *if_incoming,
1276                             struct batadv_hard_iface *if_outgoing)
1277 {
1278         struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1279         struct batadv_orig_node *orig_node;
1280         struct batadv_orig_ifinfo *orig_ifinfo = NULL;
1281         struct batadv_neigh_node *neigh_node;
1282         struct batadv_neigh_ifinfo *neigh_ifinfo;
1283         int is_dup;
1284         int32_t seq_diff;
1285         int need_update = 0;
1286         int set_mark;
1287         enum batadv_dup_status ret = BATADV_NO_DUP;
1288         uint32_t seqno = ntohl(batadv_ogm_packet->seqno);
1289         uint8_t *neigh_addr;
1290         uint8_t packet_count;
1291         unsigned long *bitmap;
1292
1293         orig_node = batadv_iv_ogm_orig_get(bat_priv, batadv_ogm_packet->orig);
1294         if (!orig_node)
1295                 return BATADV_NO_DUP;
1296
1297         orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1298         if (WARN_ON(!orig_ifinfo)) {
1299                 batadv_orig_node_free_ref(orig_node);
1300                 return 0;
1301         }
1302
1303         spin_lock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1304         seq_diff = seqno - orig_ifinfo->last_real_seqno;
1305
1306         /* signalize caller that the packet is to be dropped. */
1307         if (!hlist_empty(&orig_node->neigh_list) &&
1308             batadv_window_protected(bat_priv, seq_diff,
1309                                     &orig_ifinfo->batman_seqno_reset)) {
1310                 ret = BATADV_PROTECTED;
1311                 goto out;
1312         }
1313
1314         rcu_read_lock();
1315         hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1316                 neigh_ifinfo = batadv_neigh_ifinfo_new(neigh_node,
1317                                                        if_outgoing);
1318                 if (!neigh_ifinfo)
1319                         continue;
1320
1321                 neigh_addr = neigh_node->addr;
1322                 is_dup = batadv_test_bit(neigh_ifinfo->bat_iv.real_bits,
1323                                          orig_ifinfo->last_real_seqno,
1324                                          seqno);
1325
1326                 if (batadv_compare_eth(neigh_addr, ethhdr->h_source) &&
1327                     neigh_node->if_incoming == if_incoming) {
1328                         set_mark = 1;
1329                         if (is_dup)
1330                                 ret = BATADV_NEIGH_DUP;
1331                 } else {
1332                         set_mark = 0;
1333                         if (is_dup && (ret != BATADV_NEIGH_DUP))
1334                                 ret = BATADV_ORIG_DUP;
1335                 }
1336
1337                 /* if the window moved, set the update flag. */
1338                 bitmap = neigh_ifinfo->bat_iv.real_bits;
1339                 need_update |= batadv_bit_get_packet(bat_priv, bitmap,
1340                                                      seq_diff, set_mark);
1341
1342                 packet_count = bitmap_weight(bitmap,
1343                                              BATADV_TQ_LOCAL_WINDOW_SIZE);
1344                 neigh_ifinfo->bat_iv.real_packet_count = packet_count;
1345                 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
1346         }
1347         rcu_read_unlock();
1348
1349         if (need_update) {
1350                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1351                            "%s updating last_seqno: old %u, new %u\n",
1352                            if_outgoing ? if_outgoing->net_dev->name : "DEFAULT",
1353                            orig_ifinfo->last_real_seqno, seqno);
1354                 orig_ifinfo->last_real_seqno = seqno;
1355         }
1356
1357 out:
1358         spin_unlock_bh(&orig_node->bat_iv.ogm_cnt_lock);
1359         batadv_orig_node_free_ref(orig_node);
1360         if (orig_ifinfo)
1361                 batadv_orig_ifinfo_free_ref(orig_ifinfo);
1362         return ret;
1363 }
1364
1365
1366 /**
1367  * batadv_iv_ogm_process_per_outif - process a batman iv OGM for an outgoing if
1368  * @skb: the skb containing the OGM
1369  * @ogm_offset: offset from skb->data to start of ogm header
1370  * @orig_node: the (cached) orig node for the originator of this OGM
1371  * @if_incoming: the interface where this packet was received
1372  * @if_outgoing: the interface for which the packet should be considered
1373  */
1374 static void
1375 batadv_iv_ogm_process_per_outif(const struct sk_buff *skb, int ogm_offset,
1376                                 struct batadv_orig_node *orig_node,
1377                                 struct batadv_hard_iface *if_incoming,
1378                                 struct batadv_hard_iface *if_outgoing)
1379 {
1380         struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1381         struct batadv_neigh_node *router = NULL, *router_router = NULL;
1382         struct batadv_orig_node *orig_neigh_node;
1383         struct batadv_orig_ifinfo *orig_ifinfo;
1384         struct batadv_neigh_node *orig_neigh_router = NULL;
1385         struct batadv_neigh_ifinfo *router_ifinfo = NULL;
1386         struct batadv_ogm_packet *ogm_packet;
1387         enum batadv_dup_status dup_status;
1388         bool is_from_best_next_hop = false;
1389         bool is_single_hop_neigh = false;
1390         bool sameseq, similar_ttl;
1391         struct sk_buff *skb_priv;
1392         struct ethhdr *ethhdr;
1393         uint8_t *prev_sender;
1394         int is_bidirect;
1395
1396         /* create a private copy of the skb, as some functions change tq value
1397          * and/or flags.
1398          */
1399         skb_priv = skb_copy(skb, GFP_ATOMIC);
1400         if (!skb_priv)
1401                 return;
1402
1403         ethhdr = eth_hdr(skb_priv);
1404         ogm_packet = (struct batadv_ogm_packet *)(skb_priv->data + ogm_offset);
1405
1406         dup_status = batadv_iv_ogm_update_seqnos(ethhdr, ogm_packet,
1407                                                  if_incoming, if_outgoing);
1408         if (batadv_compare_eth(ethhdr->h_source, ogm_packet->orig))
1409                 is_single_hop_neigh = true;
1410
1411         if (dup_status == BATADV_PROTECTED) {
1412                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1413                            "Drop packet: packet within seqno protection time (sender: %pM)\n",
1414                            ethhdr->h_source);
1415                 goto out;
1416         }
1417
1418         if (ogm_packet->tq == 0) {
1419                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1420                            "Drop packet: originator packet with tq equal 0\n");
1421                 goto out;
1422         }
1423
1424         router = batadv_orig_router_get(orig_node, if_outgoing);
1425         if (router) {
1426                 router_router = batadv_orig_router_get(router->orig_node,
1427                                                        if_outgoing);
1428                 router_ifinfo = batadv_neigh_ifinfo_get(router, if_outgoing);
1429         }
1430
1431         if ((router_ifinfo && router_ifinfo->bat_iv.tq_avg != 0) &&
1432             (batadv_compare_eth(router->addr, ethhdr->h_source)))
1433                 is_from_best_next_hop = true;
1434
1435         prev_sender = ogm_packet->prev_sender;
1436         /* avoid temporary routing loops */
1437         if (router && router_router &&
1438             (batadv_compare_eth(router->addr, prev_sender)) &&
1439             !(batadv_compare_eth(ogm_packet->orig, prev_sender)) &&
1440             (batadv_compare_eth(router->addr, router_router->addr))) {
1441                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1442                            "Drop packet: ignoring all rebroadcast packets that may make me loop (sender: %pM)\n",
1443                            ethhdr->h_source);
1444                 goto out;
1445         }
1446
1447         if (if_outgoing == BATADV_IF_DEFAULT)
1448                 batadv_tvlv_ogm_receive(bat_priv, ogm_packet, orig_node);
1449
1450         /* if sender is a direct neighbor the sender mac equals
1451          * originator mac
1452          */
1453         if (is_single_hop_neigh)
1454                 orig_neigh_node = orig_node;
1455         else
1456                 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1457                                                          ethhdr->h_source);
1458
1459         if (!orig_neigh_node)
1460                 goto out;
1461
1462         /* Update nc_nodes of the originator */
1463         batadv_nc_update_nc_node(bat_priv, orig_node, orig_neigh_node,
1464                                  ogm_packet, is_single_hop_neigh);
1465
1466         orig_neigh_router = batadv_orig_router_get(orig_neigh_node,
1467                                                    if_outgoing);
1468
1469         /* drop packet if sender is not a direct neighbor and if we
1470          * don't route towards it
1471          */
1472         if (!is_single_hop_neigh && (!orig_neigh_router)) {
1473                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1474                            "Drop packet: OGM via unknown neighbor!\n");
1475                 goto out_neigh;
1476         }
1477
1478         is_bidirect = batadv_iv_ogm_calc_tq(orig_node, orig_neigh_node,
1479                                             ogm_packet, if_incoming,
1480                                             if_outgoing);
1481
1482         /* update ranking if it is not a duplicate or has the same
1483          * seqno and similar ttl as the non-duplicate
1484          */
1485         orig_ifinfo = batadv_orig_ifinfo_new(orig_node, if_outgoing);
1486         if (!orig_ifinfo)
1487                 goto out_neigh;
1488
1489         sameseq = orig_ifinfo->last_real_seqno == ntohl(ogm_packet->seqno);
1490         similar_ttl = (orig_ifinfo->last_ttl - 3) <= ogm_packet->ttl;
1491
1492         if (is_bidirect && ((dup_status == BATADV_NO_DUP) ||
1493                             (sameseq && similar_ttl))) {
1494                 batadv_iv_ogm_orig_update(bat_priv, orig_node,
1495                                           orig_ifinfo, ethhdr,
1496                                           ogm_packet, if_incoming,
1497                                           if_outgoing, dup_status);
1498         }
1499         batadv_orig_ifinfo_free_ref(orig_ifinfo);
1500
1501         /* only forward for specific interface, not for the default one. */
1502         if (if_outgoing == BATADV_IF_DEFAULT)
1503                 goto out_neigh;
1504
1505         /* is single hop (direct) neighbor */
1506         if (is_single_hop_neigh) {
1507                 /* OGMs from secondary interfaces should only scheduled once
1508                  * per interface where it has been received, not multiple times
1509                  */
1510                 if ((ogm_packet->ttl <= 2) &&
1511                     (if_incoming != if_outgoing)) {
1512                         batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1513                                    "Drop packet: OGM from secondary interface and wrong outgoing interface\n");
1514                         goto out_neigh;
1515                 }
1516                 /* mark direct link on incoming interface */
1517                 batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1518                                       is_single_hop_neigh,
1519                                       is_from_best_next_hop, if_incoming,
1520                                       if_outgoing);
1521
1522                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1523                            "Forwarding packet: rebroadcast neighbor packet with direct link flag\n");
1524                 goto out_neigh;
1525         }
1526
1527         /* multihop originator */
1528         if (!is_bidirect) {
1529                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1530                            "Drop packet: not received via bidirectional link\n");
1531                 goto out_neigh;
1532         }
1533
1534         if (dup_status == BATADV_NEIGH_DUP) {
1535                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1536                            "Drop packet: duplicate packet received\n");
1537                 goto out_neigh;
1538         }
1539
1540         batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1541                    "Forwarding packet: rebroadcast originator packet\n");
1542         batadv_iv_ogm_forward(orig_node, ethhdr, ogm_packet,
1543                               is_single_hop_neigh, is_from_best_next_hop,
1544                               if_incoming, if_outgoing);
1545
1546 out_neigh:
1547         if ((orig_neigh_node) && (!is_single_hop_neigh))
1548                 batadv_orig_node_free_ref(orig_neigh_node);
1549 out:
1550         if (router_ifinfo)
1551                 batadv_neigh_ifinfo_free_ref(router_ifinfo);
1552         if (router)
1553                 batadv_neigh_node_free_ref(router);
1554         if (router_router)
1555                 batadv_neigh_node_free_ref(router_router);
1556         if (orig_neigh_router)
1557                 batadv_neigh_node_free_ref(orig_neigh_router);
1558
1559         kfree_skb(skb_priv);
1560 }
1561
1562 /**
1563  * batadv_iv_ogm_process - process an incoming batman iv OGM
1564  * @skb: the skb containing the OGM
1565  * @ogm_offset: offset to the OGM which should be processed (for aggregates)
1566  * @if_incoming: the interface where this packet was receved
1567  */
1568 static void batadv_iv_ogm_process(const struct sk_buff *skb, int ogm_offset,
1569                                   struct batadv_hard_iface *if_incoming)
1570 {
1571         struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1572         struct batadv_orig_node *orig_neigh_node, *orig_node;
1573         struct batadv_hard_iface *hard_iface;
1574         struct batadv_ogm_packet *ogm_packet;
1575         uint32_t if_incoming_seqno;
1576         bool has_directlink_flag;
1577         struct ethhdr *ethhdr;
1578         bool is_my_oldorig = false;
1579         bool is_my_addr = false;
1580         bool is_my_orig = false;
1581
1582         ogm_packet = (struct batadv_ogm_packet *)(skb->data + ogm_offset);
1583         ethhdr = eth_hdr(skb);
1584
1585         /* Silently drop when the batman packet is actually not a
1586          * correct packet.
1587          *
1588          * This might happen if a packet is padded (e.g. Ethernet has a
1589          * minimum frame length of 64 byte) and the aggregation interprets
1590          * it as an additional length.
1591          *
1592          * TODO: A more sane solution would be to have a bit in the
1593          * batadv_ogm_packet to detect whether the packet is the last
1594          * packet in an aggregation.  Here we expect that the padding
1595          * is always zero (or not 0x01)
1596          */
1597         if (ogm_packet->packet_type != BATADV_IV_OGM)
1598                 return;
1599
1600         /* could be changed by schedule_own_packet() */
1601         if_incoming_seqno = atomic_read(&if_incoming->bat_iv.ogm_seqno);
1602
1603         if (ogm_packet->flags & BATADV_DIRECTLINK)
1604                 has_directlink_flag = true;
1605         else
1606                 has_directlink_flag = false;
1607
1608         batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1609                    "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",
1610                    ethhdr->h_source, if_incoming->net_dev->name,
1611                    if_incoming->net_dev->dev_addr, ogm_packet->orig,
1612                    ogm_packet->prev_sender, ntohl(ogm_packet->seqno),
1613                    ogm_packet->tq, ogm_packet->ttl,
1614                    ogm_packet->version, has_directlink_flag);
1615
1616         rcu_read_lock();
1617         list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1618                 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1619                         continue;
1620
1621                 if (hard_iface->soft_iface != if_incoming->soft_iface)
1622                         continue;
1623
1624                 if (batadv_compare_eth(ethhdr->h_source,
1625                                        hard_iface->net_dev->dev_addr))
1626                         is_my_addr = true;
1627
1628                 if (batadv_compare_eth(ogm_packet->orig,
1629                                        hard_iface->net_dev->dev_addr))
1630                         is_my_orig = true;
1631
1632                 if (batadv_compare_eth(ogm_packet->prev_sender,
1633                                        hard_iface->net_dev->dev_addr))
1634                         is_my_oldorig = true;
1635         }
1636         rcu_read_unlock();
1637
1638         if (is_my_addr) {
1639                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1640                            "Drop packet: received my own broadcast (sender: %pM)\n",
1641                            ethhdr->h_source);
1642                 return;
1643         }
1644
1645         if (is_my_orig) {
1646                 unsigned long *word;
1647                 int offset;
1648                 int32_t bit_pos;
1649                 int16_t if_num;
1650                 uint8_t *weight;
1651
1652                 orig_neigh_node = batadv_iv_ogm_orig_get(bat_priv,
1653                                                          ethhdr->h_source);
1654                 if (!orig_neigh_node)
1655                         return;
1656
1657                 /* neighbor has to indicate direct link and it has to
1658                  * come via the corresponding interface
1659                  * save packet seqno for bidirectional check
1660                  */
1661                 if (has_directlink_flag &&
1662                     batadv_compare_eth(if_incoming->net_dev->dev_addr,
1663                                        ogm_packet->orig)) {
1664                         if_num = if_incoming->if_num;
1665                         offset = if_num * BATADV_NUM_WORDS;
1666
1667                         spin_lock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1668                         word = &(orig_neigh_node->bat_iv.bcast_own[offset]);
1669                         bit_pos = if_incoming_seqno - 2;
1670                         bit_pos -= ntohl(ogm_packet->seqno);
1671                         batadv_set_bit(word, bit_pos);
1672                         weight = &orig_neigh_node->bat_iv.bcast_own_sum[if_num];
1673                         *weight = bitmap_weight(word,
1674                                                 BATADV_TQ_LOCAL_WINDOW_SIZE);
1675                         spin_unlock_bh(&orig_neigh_node->bat_iv.ogm_cnt_lock);
1676                 }
1677
1678                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1679                            "Drop packet: originator packet from myself (via neighbor)\n");
1680                 batadv_orig_node_free_ref(orig_neigh_node);
1681                 return;
1682         }
1683
1684         if (is_my_oldorig) {
1685                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1686                            "Drop packet: ignoring all rebroadcast echos (sender: %pM)\n",
1687                            ethhdr->h_source);
1688                 return;
1689         }
1690
1691         if (ogm_packet->flags & BATADV_NOT_BEST_NEXT_HOP) {
1692                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1693                            "Drop packet: ignoring all packets not forwarded from the best next hop (sender: %pM)\n",
1694                            ethhdr->h_source);
1695                 return;
1696         }
1697
1698         orig_node = batadv_iv_ogm_orig_get(bat_priv, ogm_packet->orig);
1699         if (!orig_node)
1700                 return;
1701
1702         batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1703                                         if_incoming, BATADV_IF_DEFAULT);
1704
1705         rcu_read_lock();
1706         list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1707                 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1708                         continue;
1709
1710                 if (hard_iface->soft_iface != bat_priv->soft_iface)
1711                         continue;
1712
1713                 batadv_iv_ogm_process_per_outif(skb, ogm_offset, orig_node,
1714                                                 if_incoming, hard_iface);
1715         }
1716         rcu_read_unlock();
1717
1718         batadv_orig_node_free_ref(orig_node);
1719 }
1720
1721 static int batadv_iv_ogm_receive(struct sk_buff *skb,
1722                                  struct batadv_hard_iface *if_incoming)
1723 {
1724         struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
1725         struct batadv_ogm_packet *ogm_packet;
1726         uint8_t *packet_pos;
1727         int ogm_offset;
1728         bool ret;
1729
1730         ret = batadv_check_management_packet(skb, if_incoming, BATADV_OGM_HLEN);
1731         if (!ret)
1732                 return NET_RX_DROP;
1733
1734         /* did we receive a B.A.T.M.A.N. IV OGM packet on an interface
1735          * that does not have B.A.T.M.A.N. IV enabled ?
1736          */
1737         if (bat_priv->bat_algo_ops->bat_ogm_emit != batadv_iv_ogm_emit)
1738                 return NET_RX_DROP;
1739
1740         batadv_inc_counter(bat_priv, BATADV_CNT_MGMT_RX);
1741         batadv_add_counter(bat_priv, BATADV_CNT_MGMT_RX_BYTES,
1742                            skb->len + ETH_HLEN);
1743
1744         ogm_offset = 0;
1745         ogm_packet = (struct batadv_ogm_packet *)skb->data;
1746
1747         /* unpack the aggregated packets and process them one by one */
1748         while (batadv_iv_ogm_aggr_packet(ogm_offset, skb_headlen(skb),
1749                                          ogm_packet->tvlv_len)) {
1750                 batadv_iv_ogm_process(skb, ogm_offset, if_incoming);
1751
1752                 ogm_offset += BATADV_OGM_HLEN;
1753                 ogm_offset += ntohs(ogm_packet->tvlv_len);
1754
1755                 packet_pos = skb->data + ogm_offset;
1756                 ogm_packet = (struct batadv_ogm_packet *)packet_pos;
1757         }
1758
1759         kfree_skb(skb);
1760         return NET_RX_SUCCESS;
1761 }
1762
1763 /**
1764  * batadv_iv_ogm_orig_print_neigh - print neighbors for the originator table
1765  * @orig_node: the orig_node for which the neighbors are printed
1766  * @if_outgoing: outgoing interface for these entries
1767  * @seq: debugfs table seq_file struct
1768  *
1769  * Must be called while holding an rcu lock.
1770  */
1771 static void
1772 batadv_iv_ogm_orig_print_neigh(struct batadv_orig_node *orig_node,
1773                                struct batadv_hard_iface *if_outgoing,
1774                                struct seq_file *seq)
1775 {
1776         struct batadv_neigh_node *neigh_node;
1777         struct batadv_neigh_ifinfo *n_ifinfo;
1778
1779         hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
1780                 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
1781                 if (!n_ifinfo)
1782                         continue;
1783
1784                 seq_printf(seq, " %pM (%3i)",
1785                            neigh_node->addr,
1786                            n_ifinfo->bat_iv.tq_avg);
1787
1788                 batadv_neigh_ifinfo_free_ref(n_ifinfo);
1789         }
1790 }
1791
1792 /**
1793  * batadv_iv_ogm_orig_print - print the originator table
1794  * @bat_priv: the bat priv with all the soft interface information
1795  * @seq: debugfs table seq_file struct
1796  * @if_outgoing: the outgoing interface for which this should be printed
1797  */
1798 static void batadv_iv_ogm_orig_print(struct batadv_priv *bat_priv,
1799                                      struct seq_file *seq,
1800                                      struct batadv_hard_iface *if_outgoing)
1801 {
1802         struct batadv_neigh_node *neigh_node;
1803         struct batadv_hashtable *hash = bat_priv->orig_hash;
1804         int last_seen_msecs, last_seen_secs;
1805         struct batadv_orig_node *orig_node;
1806         struct batadv_neigh_ifinfo *n_ifinfo;
1807         unsigned long last_seen_jiffies;
1808         struct hlist_head *head;
1809         int batman_count = 0;
1810         uint32_t i;
1811
1812         seq_printf(seq, "  %-15s %s (%s/%i) %17s [%10s]: %20s ...\n",
1813                    "Originator", "last-seen", "#", BATADV_TQ_MAX_VALUE,
1814                    "Nexthop", "outgoingIF", "Potential nexthops");
1815
1816         for (i = 0; i < hash->size; i++) {
1817                 head = &hash->table[i];
1818
1819                 rcu_read_lock();
1820                 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
1821                         neigh_node = batadv_orig_router_get(orig_node,
1822                                                             if_outgoing);
1823                         if (!neigh_node)
1824                                 continue;
1825
1826                         n_ifinfo = batadv_neigh_ifinfo_get(neigh_node,
1827                                                            if_outgoing);
1828                         if (!n_ifinfo)
1829                                 goto next;
1830
1831                         if (n_ifinfo->bat_iv.tq_avg == 0)
1832                                 goto next;
1833
1834                         last_seen_jiffies = jiffies - orig_node->last_seen;
1835                         last_seen_msecs = jiffies_to_msecs(last_seen_jiffies);
1836                         last_seen_secs = last_seen_msecs / 1000;
1837                         last_seen_msecs = last_seen_msecs % 1000;
1838
1839                         seq_printf(seq, "%pM %4i.%03is   (%3i) %pM [%10s]:",
1840                                    orig_node->orig, last_seen_secs,
1841                                    last_seen_msecs, n_ifinfo->bat_iv.tq_avg,
1842                                    neigh_node->addr,
1843                                    neigh_node->if_incoming->net_dev->name);
1844
1845                         batadv_iv_ogm_orig_print_neigh(orig_node, if_outgoing,
1846                                                        seq);
1847                         seq_puts(seq, "\n");
1848                         batman_count++;
1849
1850 next:
1851                         batadv_neigh_node_free_ref(neigh_node);
1852                         if (n_ifinfo)
1853                                 batadv_neigh_ifinfo_free_ref(n_ifinfo);
1854                 }
1855                 rcu_read_unlock();
1856         }
1857
1858         if (batman_count == 0)
1859                 seq_puts(seq, "No batman nodes in range ...\n");
1860 }
1861
1862 /**
1863  * batadv_iv_ogm_neigh_cmp - compare the metrics of two neighbors
1864  * @neigh1: the first neighbor object of the comparison
1865  * @if_outgoing1: outgoing interface for the first neighbor
1866  * @neigh2: the second neighbor object of the comparison
1867  * @if_outgoing2: outgoing interface for the second neighbor
1868  *
1869  * Returns a value less, equal to or greater than 0 if the metric via neigh1 is
1870  * lower, the same as or higher than the metric via neigh2
1871  */
1872 static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
1873                                    struct batadv_hard_iface *if_outgoing1,
1874                                    struct batadv_neigh_node *neigh2,
1875                                    struct batadv_hard_iface *if_outgoing2)
1876 {
1877         struct batadv_neigh_ifinfo *neigh1_ifinfo, *neigh2_ifinfo;
1878         uint8_t tq1, tq2;
1879         int diff;
1880
1881         neigh1_ifinfo = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
1882         neigh2_ifinfo = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
1883
1884         if (!neigh1_ifinfo || !neigh2_ifinfo) {
1885                 diff = 0;
1886                 goto out;
1887         }
1888
1889         tq1 = neigh1_ifinfo->bat_iv.tq_avg;
1890         tq2 = neigh2_ifinfo->bat_iv.tq_avg;
1891         diff = tq1 - tq2;
1892
1893 out:
1894         if (neigh1_ifinfo)
1895                 batadv_neigh_ifinfo_free_ref(neigh1_ifinfo);
1896         if (neigh2_ifinfo)
1897                 batadv_neigh_ifinfo_free_ref(neigh2_ifinfo);
1898
1899         return diff;
1900 }
1901
1902 /**
1903  * batadv_iv_ogm_neigh_is_eob - check if neigh1 is equally good or better than
1904  *  neigh2 from the metric prospective
1905  * @neigh1: the first neighbor object of the comparison
1906  * @if_outgoing1: outgoing interface for the first neighbor
1907  * @neigh2: the second neighbor object of the comparison
1908  * @if_outgoing2: outgoing interface for the second neighbor
1909  *
1910  * Returns true if the metric via neigh1 is equally good or better than
1911  * the metric via neigh2, false otherwise.
1912  */
1913 static bool
1914 batadv_iv_ogm_neigh_is_eob(struct batadv_neigh_node *neigh1,
1915                            struct batadv_hard_iface *if_outgoing1,
1916                            struct batadv_neigh_node *neigh2,
1917                            struct batadv_hard_iface *if_outgoing2)
1918 {
1919         struct batadv_neigh_ifinfo *neigh1_ifinfo, *neigh2_ifinfo;
1920         uint8_t tq1, tq2;
1921         bool ret;
1922
1923         neigh1_ifinfo = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
1924         neigh2_ifinfo = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
1925
1926         /* we can't say that the metric is better */
1927         if (!neigh1_ifinfo || !neigh2_ifinfo) {
1928                 ret = false;
1929                 goto out;
1930         }
1931
1932         tq1 = neigh1_ifinfo->bat_iv.tq_avg;
1933         tq2 = neigh2_ifinfo->bat_iv.tq_avg;
1934         ret = (tq1 - tq2) > -BATADV_TQ_SIMILARITY_THRESHOLD;
1935
1936 out:
1937         if (neigh1_ifinfo)
1938                 batadv_neigh_ifinfo_free_ref(neigh1_ifinfo);
1939         if (neigh2_ifinfo)
1940                 batadv_neigh_ifinfo_free_ref(neigh2_ifinfo);
1941
1942         return ret;
1943 }
1944
1945 static struct batadv_algo_ops batadv_batman_iv __read_mostly = {
1946         .name = "BATMAN_IV",
1947         .bat_iface_enable = batadv_iv_ogm_iface_enable,
1948         .bat_iface_disable = batadv_iv_ogm_iface_disable,
1949         .bat_iface_update_mac = batadv_iv_ogm_iface_update_mac,
1950         .bat_primary_iface_set = batadv_iv_ogm_primary_iface_set,
1951         .bat_ogm_schedule = batadv_iv_ogm_schedule,
1952         .bat_ogm_emit = batadv_iv_ogm_emit,
1953         .bat_neigh_cmp = batadv_iv_ogm_neigh_cmp,
1954         .bat_neigh_is_equiv_or_better = batadv_iv_ogm_neigh_is_eob,
1955         .bat_orig_print = batadv_iv_ogm_orig_print,
1956         .bat_orig_free = batadv_iv_ogm_orig_free,
1957         .bat_orig_add_if = batadv_iv_ogm_orig_add_if,
1958         .bat_orig_del_if = batadv_iv_ogm_orig_del_if,
1959 };
1960
1961 int __init batadv_iv_init(void)
1962 {
1963         int ret;
1964
1965         /* batman originator packet */
1966         ret = batadv_recv_handler_register(BATADV_IV_OGM,
1967                                            batadv_iv_ogm_receive);
1968         if (ret < 0)
1969                 goto out;
1970
1971         ret = batadv_algo_register(&batadv_batman_iv);
1972         if (ret < 0)
1973                 goto handler_unregister;
1974
1975         goto out;
1976
1977 handler_unregister:
1978         batadv_recv_handler_unregister(BATADV_IV_OGM);
1979 out:
1980         return ret;
1981 }