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