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