batman-adv: Prefix hash static inline functions with batadv_
[firefly-linux-kernel-4.4.55.git] / net / batman-adv / originator.c
1 /* Copyright (C) 2009-2012 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, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA
18  */
19
20 #include "main.h"
21 #include "originator.h"
22 #include "hash.h"
23 #include "translation-table.h"
24 #include "routing.h"
25 #include "gateway_client.h"
26 #include "hard-interface.h"
27 #include "unicast.h"
28 #include "soft-interface.h"
29 #include "bridge_loop_avoidance.h"
30
31 static void purge_orig(struct work_struct *work);
32
33 static void start_purge_timer(struct bat_priv *bat_priv)
34 {
35         INIT_DELAYED_WORK(&bat_priv->orig_work, purge_orig);
36         queue_delayed_work(batadv_event_workqueue,
37                            &bat_priv->orig_work, msecs_to_jiffies(1000));
38 }
39
40 /* returns 1 if they are the same originator */
41 static int compare_orig(const struct hlist_node *node, const void *data2)
42 {
43         const void *data1 = container_of(node, struct orig_node, hash_entry);
44
45         return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0);
46 }
47
48 int batadv_originator_init(struct bat_priv *bat_priv)
49 {
50         if (bat_priv->orig_hash)
51                 return 0;
52
53         bat_priv->orig_hash = batadv_hash_new(1024);
54
55         if (!bat_priv->orig_hash)
56                 goto err;
57
58         start_purge_timer(bat_priv);
59         return 0;
60
61 err:
62         return -ENOMEM;
63 }
64
65 void batadv_neigh_node_free_ref(struct neigh_node *neigh_node)
66 {
67         if (atomic_dec_and_test(&neigh_node->refcount))
68                 kfree_rcu(neigh_node, rcu);
69 }
70
71 /* increases the refcounter of a found router */
72 struct neigh_node *batadv_orig_node_get_router(struct orig_node *orig_node)
73 {
74         struct neigh_node *router;
75
76         rcu_read_lock();
77         router = rcu_dereference(orig_node->router);
78
79         if (router && !atomic_inc_not_zero(&router->refcount))
80                 router = NULL;
81
82         rcu_read_unlock();
83         return router;
84 }
85
86 struct neigh_node *batadv_neigh_node_new(struct hard_iface *hard_iface,
87                                          const uint8_t *neigh_addr,
88                                          uint32_t seqno)
89 {
90         struct bat_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
91         struct neigh_node *neigh_node;
92
93         neigh_node = kzalloc(sizeof(*neigh_node), GFP_ATOMIC);
94         if (!neigh_node)
95                 goto out;
96
97         INIT_HLIST_NODE(&neigh_node->list);
98
99         memcpy(neigh_node->addr, neigh_addr, ETH_ALEN);
100         spin_lock_init(&neigh_node->lq_update_lock);
101
102         /* extra reference for return */
103         atomic_set(&neigh_node->refcount, 2);
104
105         bat_dbg(DBG_BATMAN, bat_priv,
106                 "Creating new neighbor %pM, initial seqno %d\n",
107                 neigh_addr, seqno);
108
109 out:
110         return neigh_node;
111 }
112
113 static void orig_node_free_rcu(struct rcu_head *rcu)
114 {
115         struct hlist_node *node, *node_tmp;
116         struct neigh_node *neigh_node, *tmp_neigh_node;
117         struct orig_node *orig_node;
118
119         orig_node = container_of(rcu, struct orig_node, rcu);
120
121         spin_lock_bh(&orig_node->neigh_list_lock);
122
123         /* for all bonding members ... */
124         list_for_each_entry_safe(neigh_node, tmp_neigh_node,
125                                  &orig_node->bond_list, bonding_list) {
126                 list_del_rcu(&neigh_node->bonding_list);
127                 batadv_neigh_node_free_ref(neigh_node);
128         }
129
130         /* for all neighbors towards this originator ... */
131         hlist_for_each_entry_safe(neigh_node, node, node_tmp,
132                                   &orig_node->neigh_list, list) {
133                 hlist_del_rcu(&neigh_node->list);
134                 batadv_neigh_node_free_ref(neigh_node);
135         }
136
137         spin_unlock_bh(&orig_node->neigh_list_lock);
138
139         batadv_frag_list_free(&orig_node->frag_list);
140         batadv_tt_global_del_orig(orig_node->bat_priv, orig_node,
141                                   "originator timed out");
142
143         kfree(orig_node->tt_buff);
144         kfree(orig_node->bcast_own);
145         kfree(orig_node->bcast_own_sum);
146         kfree(orig_node);
147 }
148
149 void batadv_orig_node_free_ref(struct orig_node *orig_node)
150 {
151         if (atomic_dec_and_test(&orig_node->refcount))
152                 call_rcu(&orig_node->rcu, orig_node_free_rcu);
153 }
154
155 void batadv_originator_free(struct bat_priv *bat_priv)
156 {
157         struct hashtable_t *hash = bat_priv->orig_hash;
158         struct hlist_node *node, *node_tmp;
159         struct hlist_head *head;
160         spinlock_t *list_lock; /* spinlock to protect write access */
161         struct orig_node *orig_node;
162         uint32_t i;
163
164         if (!hash)
165                 return;
166
167         cancel_delayed_work_sync(&bat_priv->orig_work);
168
169         bat_priv->orig_hash = NULL;
170
171         for (i = 0; i < hash->size; i++) {
172                 head = &hash->table[i];
173                 list_lock = &hash->list_locks[i];
174
175                 spin_lock_bh(list_lock);
176                 hlist_for_each_entry_safe(orig_node, node, node_tmp,
177                                           head, hash_entry) {
178
179                         hlist_del_rcu(node);
180                         batadv_orig_node_free_ref(orig_node);
181                 }
182                 spin_unlock_bh(list_lock);
183         }
184
185         batadv_hash_destroy(hash);
186 }
187
188 /* this function finds or creates an originator entry for the given
189  * address if it does not exits
190  */
191 struct orig_node *batadv_get_orig_node(struct bat_priv *bat_priv,
192                                        const uint8_t *addr)
193 {
194         struct orig_node *orig_node;
195         int size;
196         int hash_added;
197
198         orig_node = orig_hash_find(bat_priv, addr);
199         if (orig_node)
200                 return orig_node;
201
202         bat_dbg(DBG_BATMAN, bat_priv,
203                 "Creating new originator: %pM\n", addr);
204
205         orig_node = kzalloc(sizeof(*orig_node), GFP_ATOMIC);
206         if (!orig_node)
207                 return NULL;
208
209         INIT_HLIST_HEAD(&orig_node->neigh_list);
210         INIT_LIST_HEAD(&orig_node->bond_list);
211         spin_lock_init(&orig_node->ogm_cnt_lock);
212         spin_lock_init(&orig_node->bcast_seqno_lock);
213         spin_lock_init(&orig_node->neigh_list_lock);
214         spin_lock_init(&orig_node->tt_buff_lock);
215
216         /* extra reference for return */
217         atomic_set(&orig_node->refcount, 2);
218
219         orig_node->tt_initialised = false;
220         orig_node->tt_poss_change = false;
221         orig_node->bat_priv = bat_priv;
222         memcpy(orig_node->orig, addr, ETH_ALEN);
223         orig_node->router = NULL;
224         orig_node->tt_crc = 0;
225         atomic_set(&orig_node->last_ttvn, 0);
226         orig_node->tt_buff = NULL;
227         orig_node->tt_buff_len = 0;
228         atomic_set(&orig_node->tt_size, 0);
229         orig_node->bcast_seqno_reset = jiffies - 1
230                                         - msecs_to_jiffies(RESET_PROTECTION_MS);
231         orig_node->batman_seqno_reset = jiffies - 1
232                                         - msecs_to_jiffies(RESET_PROTECTION_MS);
233
234         atomic_set(&orig_node->bond_candidates, 0);
235
236         size = bat_priv->num_ifaces * sizeof(unsigned long) * NUM_WORDS;
237
238         orig_node->bcast_own = kzalloc(size, GFP_ATOMIC);
239         if (!orig_node->bcast_own)
240                 goto free_orig_node;
241
242         size = bat_priv->num_ifaces * sizeof(uint8_t);
243         orig_node->bcast_own_sum = kzalloc(size, GFP_ATOMIC);
244
245         INIT_LIST_HEAD(&orig_node->frag_list);
246         orig_node->last_frag_packet = 0;
247
248         if (!orig_node->bcast_own_sum)
249                 goto free_bcast_own;
250
251         hash_added = batadv_hash_add(bat_priv->orig_hash, compare_orig,
252                                      choose_orig, orig_node,
253                                      &orig_node->hash_entry);
254         if (hash_added != 0)
255                 goto free_bcast_own_sum;
256
257         return orig_node;
258 free_bcast_own_sum:
259         kfree(orig_node->bcast_own_sum);
260 free_bcast_own:
261         kfree(orig_node->bcast_own);
262 free_orig_node:
263         kfree(orig_node);
264         return NULL;
265 }
266
267 static bool purge_orig_neighbors(struct bat_priv *bat_priv,
268                                  struct orig_node *orig_node,
269                                  struct neigh_node **best_neigh_node)
270 {
271         struct hlist_node *node, *node_tmp;
272         struct neigh_node *neigh_node;
273         bool neigh_purged = false;
274         unsigned long last_seen;
275
276         *best_neigh_node = NULL;
277
278         spin_lock_bh(&orig_node->neigh_list_lock);
279
280         /* for all neighbors towards this originator ... */
281         hlist_for_each_entry_safe(neigh_node, node, node_tmp,
282                                   &orig_node->neigh_list, list) {
283
284                 if ((has_timed_out(neigh_node->last_seen, PURGE_TIMEOUT)) ||
285                     (neigh_node->if_incoming->if_status == IF_INACTIVE) ||
286                     (neigh_node->if_incoming->if_status == IF_NOT_IN_USE) ||
287                     (neigh_node->if_incoming->if_status == IF_TO_BE_REMOVED)) {
288
289                         last_seen = neigh_node->last_seen;
290
291                         if ((neigh_node->if_incoming->if_status ==
292                                                                 IF_INACTIVE) ||
293                             (neigh_node->if_incoming->if_status ==
294                                                         IF_NOT_IN_USE) ||
295                             (neigh_node->if_incoming->if_status ==
296                                                         IF_TO_BE_REMOVED))
297                                 bat_dbg(DBG_BATMAN, bat_priv,
298                                         "neighbor purge: originator %pM, neighbor: %pM, iface: %s\n",
299                                         orig_node->orig, neigh_node->addr,
300                                         neigh_node->if_incoming->net_dev->name);
301                         else
302                                 bat_dbg(DBG_BATMAN, bat_priv,
303                                         "neighbor timeout: originator %pM, neighbor: %pM, last_seen: %u\n",
304                                         orig_node->orig, neigh_node->addr,
305                                         jiffies_to_msecs(last_seen));
306
307                         neigh_purged = true;
308
309                         hlist_del_rcu(&neigh_node->list);
310                         batadv_bonding_candidate_del(orig_node, neigh_node);
311                         batadv_neigh_node_free_ref(neigh_node);
312                 } else {
313                         if ((!*best_neigh_node) ||
314                             (neigh_node->tq_avg > (*best_neigh_node)->tq_avg))
315                                 *best_neigh_node = neigh_node;
316                 }
317         }
318
319         spin_unlock_bh(&orig_node->neigh_list_lock);
320         return neigh_purged;
321 }
322
323 static bool purge_orig_node(struct bat_priv *bat_priv,
324                             struct orig_node *orig_node)
325 {
326         struct neigh_node *best_neigh_node;
327
328         if (has_timed_out(orig_node->last_seen, 2 * PURGE_TIMEOUT)) {
329                 bat_dbg(DBG_BATMAN, bat_priv,
330                         "Originator timeout: originator %pM, last_seen %u\n",
331                         orig_node->orig,
332                         jiffies_to_msecs(orig_node->last_seen));
333                 return true;
334         } else {
335                 if (purge_orig_neighbors(bat_priv, orig_node,
336                                          &best_neigh_node))
337                         batadv_update_route(bat_priv, orig_node,
338                                             best_neigh_node);
339         }
340
341         return false;
342 }
343
344 static void _purge_orig(struct bat_priv *bat_priv)
345 {
346         struct hashtable_t *hash = bat_priv->orig_hash;
347         struct hlist_node *node, *node_tmp;
348         struct hlist_head *head;
349         spinlock_t *list_lock; /* spinlock to protect write access */
350         struct orig_node *orig_node;
351         uint32_t i;
352
353         if (!hash)
354                 return;
355
356         /* for all origins... */
357         for (i = 0; i < hash->size; i++) {
358                 head = &hash->table[i];
359                 list_lock = &hash->list_locks[i];
360
361                 spin_lock_bh(list_lock);
362                 hlist_for_each_entry_safe(orig_node, node, node_tmp,
363                                           head, hash_entry) {
364                         if (purge_orig_node(bat_priv, orig_node)) {
365                                 if (orig_node->gw_flags)
366                                         batadv_gw_node_delete(bat_priv,
367                                                               orig_node);
368                                 hlist_del_rcu(node);
369                                 batadv_orig_node_free_ref(orig_node);
370                                 continue;
371                         }
372
373                         if (has_timed_out(orig_node->last_frag_packet,
374                                           FRAG_TIMEOUT))
375                                 batadv_frag_list_free(&orig_node->frag_list);
376                 }
377                 spin_unlock_bh(list_lock);
378         }
379
380         batadv_gw_node_purge(bat_priv);
381         batadv_gw_election(bat_priv);
382 }
383
384 static void purge_orig(struct work_struct *work)
385 {
386         struct delayed_work *delayed_work =
387                 container_of(work, struct delayed_work, work);
388         struct bat_priv *bat_priv =
389                 container_of(delayed_work, struct bat_priv, orig_work);
390
391         _purge_orig(bat_priv);
392         start_purge_timer(bat_priv);
393 }
394
395 void batadv_purge_orig_ref(struct bat_priv *bat_priv)
396 {
397         _purge_orig(bat_priv);
398 }
399
400 int batadv_orig_seq_print_text(struct seq_file *seq, void *offset)
401 {
402         struct net_device *net_dev = (struct net_device *)seq->private;
403         struct bat_priv *bat_priv = netdev_priv(net_dev);
404         struct hashtable_t *hash = bat_priv->orig_hash;
405         struct hlist_node *node, *node_tmp;
406         struct hlist_head *head;
407         struct hard_iface *primary_if;
408         struct orig_node *orig_node;
409         struct neigh_node *neigh_node, *neigh_node_tmp;
410         int batman_count = 0;
411         int last_seen_secs;
412         int last_seen_msecs;
413         uint32_t i;
414         int ret = 0;
415
416         primary_if = batadv_primary_if_get_selected(bat_priv);
417
418         if (!primary_if) {
419                 ret = seq_printf(seq,
420                                  "BATMAN mesh %s disabled - please specify interfaces to enable it\n",
421                                  net_dev->name);
422                 goto out;
423         }
424
425         if (primary_if->if_status != IF_ACTIVE) {
426                 ret = seq_printf(seq,
427                                  "BATMAN mesh %s disabled - primary interface not active\n",
428                                  net_dev->name);
429                 goto out;
430         }
431
432         seq_printf(seq, "[B.A.T.M.A.N. adv %s, MainIF/MAC: %s/%pM (%s)]\n",
433                    SOURCE_VERSION, primary_if->net_dev->name,
434                    primary_if->net_dev->dev_addr, net_dev->name);
435         seq_printf(seq, "  %-15s %s (%s/%i) %17s [%10s]: %20s ...\n",
436                    "Originator", "last-seen", "#", TQ_MAX_VALUE, "Nexthop",
437                    "outgoingIF", "Potential nexthops");
438
439         for (i = 0; i < hash->size; i++) {
440                 head = &hash->table[i];
441
442                 rcu_read_lock();
443                 hlist_for_each_entry_rcu(orig_node, node, head, hash_entry) {
444                         neigh_node = batadv_orig_node_get_router(orig_node);
445                         if (!neigh_node)
446                                 continue;
447
448                         if (neigh_node->tq_avg == 0)
449                                 goto next;
450
451                         last_seen_secs = jiffies_to_msecs(jiffies -
452                                                 orig_node->last_seen) / 1000;
453                         last_seen_msecs = jiffies_to_msecs(jiffies -
454                                                 orig_node->last_seen) % 1000;
455
456                         seq_printf(seq, "%pM %4i.%03is   (%3i) %pM [%10s]:",
457                                    orig_node->orig, last_seen_secs,
458                                    last_seen_msecs, neigh_node->tq_avg,
459                                    neigh_node->addr,
460                                    neigh_node->if_incoming->net_dev->name);
461
462                         hlist_for_each_entry_rcu(neigh_node_tmp, node_tmp,
463                                                  &orig_node->neigh_list, list) {
464                                 seq_printf(seq, " %pM (%3i)",
465                                            neigh_node_tmp->addr,
466                                            neigh_node_tmp->tq_avg);
467                         }
468
469                         seq_printf(seq, "\n");
470                         batman_count++;
471
472 next:
473                         batadv_neigh_node_free_ref(neigh_node);
474                 }
475                 rcu_read_unlock();
476         }
477
478         if (batman_count == 0)
479                 seq_printf(seq, "No batman nodes in range ...\n");
480
481 out:
482         if (primary_if)
483                 batadv_hardif_free_ref(primary_if);
484         return ret;
485 }
486
487 static int orig_node_add_if(struct orig_node *orig_node, int max_if_num)
488 {
489         void *data_ptr;
490
491         data_ptr = kmalloc(max_if_num * sizeof(unsigned long) * NUM_WORDS,
492                            GFP_ATOMIC);
493         if (!data_ptr)
494                 return -ENOMEM;
495
496         memcpy(data_ptr, orig_node->bcast_own,
497                (max_if_num - 1) * sizeof(unsigned long) * NUM_WORDS);
498         kfree(orig_node->bcast_own);
499         orig_node->bcast_own = data_ptr;
500
501         data_ptr = kmalloc(max_if_num * sizeof(uint8_t), GFP_ATOMIC);
502         if (!data_ptr)
503                 return -ENOMEM;
504
505         memcpy(data_ptr, orig_node->bcast_own_sum,
506                (max_if_num - 1) * sizeof(uint8_t));
507         kfree(orig_node->bcast_own_sum);
508         orig_node->bcast_own_sum = data_ptr;
509
510         return 0;
511 }
512
513 int batadv_orig_hash_add_if(struct hard_iface *hard_iface, int max_if_num)
514 {
515         struct bat_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
516         struct hashtable_t *hash = bat_priv->orig_hash;
517         struct hlist_node *node;
518         struct hlist_head *head;
519         struct orig_node *orig_node;
520         uint32_t i;
521         int ret;
522
523         /* resize all orig nodes because orig_node->bcast_own(_sum) depend on
524          * if_num
525          */
526         for (i = 0; i < hash->size; i++) {
527                 head = &hash->table[i];
528
529                 rcu_read_lock();
530                 hlist_for_each_entry_rcu(orig_node, node, head, hash_entry) {
531                         spin_lock_bh(&orig_node->ogm_cnt_lock);
532                         ret = orig_node_add_if(orig_node, max_if_num);
533                         spin_unlock_bh(&orig_node->ogm_cnt_lock);
534
535                         if (ret == -ENOMEM)
536                                 goto err;
537                 }
538                 rcu_read_unlock();
539         }
540
541         return 0;
542
543 err:
544         rcu_read_unlock();
545         return -ENOMEM;
546 }
547
548 static int orig_node_del_if(struct orig_node *orig_node,
549                      int max_if_num, int del_if_num)
550 {
551         void *data_ptr = NULL;
552         int chunk_size;
553
554         /* last interface was removed */
555         if (max_if_num == 0)
556                 goto free_bcast_own;
557
558         chunk_size = sizeof(unsigned long) * NUM_WORDS;
559         data_ptr = kmalloc(max_if_num * chunk_size, GFP_ATOMIC);
560         if (!data_ptr)
561                 return -ENOMEM;
562
563         /* copy first part */
564         memcpy(data_ptr, orig_node->bcast_own, del_if_num * chunk_size);
565
566         /* copy second part */
567         memcpy((char *)data_ptr + del_if_num * chunk_size,
568                orig_node->bcast_own + ((del_if_num + 1) * chunk_size),
569                (max_if_num - del_if_num) * chunk_size);
570
571 free_bcast_own:
572         kfree(orig_node->bcast_own);
573         orig_node->bcast_own = data_ptr;
574
575         if (max_if_num == 0)
576                 goto free_own_sum;
577
578         data_ptr = kmalloc(max_if_num * sizeof(uint8_t), GFP_ATOMIC);
579         if (!data_ptr)
580                 return -ENOMEM;
581
582         memcpy(data_ptr, orig_node->bcast_own_sum,
583                del_if_num * sizeof(uint8_t));
584
585         memcpy((char *)data_ptr + del_if_num * sizeof(uint8_t),
586                orig_node->bcast_own_sum + ((del_if_num + 1) * sizeof(uint8_t)),
587                (max_if_num - del_if_num) * sizeof(uint8_t));
588
589 free_own_sum:
590         kfree(orig_node->bcast_own_sum);
591         orig_node->bcast_own_sum = data_ptr;
592
593         return 0;
594 }
595
596 int batadv_orig_hash_del_if(struct hard_iface *hard_iface, int max_if_num)
597 {
598         struct bat_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
599         struct hashtable_t *hash = bat_priv->orig_hash;
600         struct hlist_node *node;
601         struct hlist_head *head;
602         struct hard_iface *hard_iface_tmp;
603         struct orig_node *orig_node;
604         uint32_t i;
605         int ret;
606
607         /* resize all orig nodes because orig_node->bcast_own(_sum) depend on
608          * if_num
609          */
610         for (i = 0; i < hash->size; i++) {
611                 head = &hash->table[i];
612
613                 rcu_read_lock();
614                 hlist_for_each_entry_rcu(orig_node, node, head, hash_entry) {
615                         spin_lock_bh(&orig_node->ogm_cnt_lock);
616                         ret = orig_node_del_if(orig_node, max_if_num,
617                                         hard_iface->if_num);
618                         spin_unlock_bh(&orig_node->ogm_cnt_lock);
619
620                         if (ret == -ENOMEM)
621                                 goto err;
622                 }
623                 rcu_read_unlock();
624         }
625
626         /* renumber remaining batman interfaces _inside_ of orig_hash_lock */
627         rcu_read_lock();
628         list_for_each_entry_rcu(hard_iface_tmp, &batadv_hardif_list, list) {
629                 if (hard_iface_tmp->if_status == IF_NOT_IN_USE)
630                         continue;
631
632                 if (hard_iface == hard_iface_tmp)
633                         continue;
634
635                 if (hard_iface->soft_iface != hard_iface_tmp->soft_iface)
636                         continue;
637
638                 if (hard_iface_tmp->if_num > hard_iface->if_num)
639                         hard_iface_tmp->if_num--;
640         }
641         rcu_read_unlock();
642
643         hard_iface->if_num = -1;
644         return 0;
645
646 err:
647         rcu_read_unlock();
648         return -ENOMEM;
649 }