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