net/batman-adv/originator.c

   1 /* Copyright (C) 2009-2015 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 "originator.h"
  19 #include "main.h"
  20
  21 #include <linux/errno.h>
  22 #include <linux/etherdevice.h>
  23 #include <linux/fs.h>
  24 #include <linux/jiffies.h>
  25 #include <linux/kernel.h>
  26 #include <linux/list.h>
  27 #include <linux/lockdep.h>
  28 #include <linux/netdevice.h>
  29 #include <linux/rculist.h>
  30 #include <linux/seq_file.h>
  31 #include <linux/slab.h>
  32 #include <linux/spinlock.h>
  33 #include <linux/workqueue.h>
  34
  35 #include "distributed-arp-table.h"
  36 #include "fragmentation.h"
  37 #include "gateway_client.h"
  38 #include "hard-interface.h"
  39 #include "hash.h"
  40 #include "multicast.h"
  41 #include "network-coding.h"
  42 #include "routing.h"
  43 #include "translation-table.h"
  44
  45 /* hash class keys */
  46 static struct lock_class_key batadv_orig_hash_lock_class_key;
  47
  48 static void batadv_purge_orig(struct work_struct *work);
  49
  50 /* returns 1 if they are the same originator */
  51 int batadv_compare_orig(const struct hlist_node *node, const void *data2)
  52 {
  53         const void *data1 = container_of(node, struct batadv_orig_node,
  54                                          hash_entry);
  55
  56         return batadv_compare_eth(data1, data2);
  57 }
  58
  59 /**
  60  * batadv_orig_node_vlan_get - get an orig_node_vlan object
  61  * @orig_node: the originator serving the VLAN
  62  * @vid: the VLAN identifier
  63  *
  64  * Returns the vlan object identified by vid and belonging to orig_node or NULL
  65  * if it does not exist.
  66  */
  67 struct batadv_orig_node_vlan *
  68 batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
  69                           unsigned short vid)
  70 {
  71         struct batadv_orig_node_vlan *vlan = NULL, *tmp;
  72
  73         rcu_read_lock();
  74         hlist_for_each_entry_rcu(tmp, &orig_node->vlan_list, list) {
  75                 if (tmp->vid != vid)
  76                         continue;
  77
  78                 if (!atomic_inc_not_zero(&tmp->refcount))
  79                         continue;
  80
  81                 vlan = tmp;
  82
  83                 break;
  84         }
  85         rcu_read_unlock();
  86
  87         return vlan;
  88 }
  89
  90 /**
  91  * batadv_orig_node_vlan_new - search and possibly create an orig_node_vlan
  92  *  object
  93  * @orig_node: the originator serving the VLAN
  94  * @vid: the VLAN identifier
  95  *
  96  * Returns NULL in case of failure or the vlan object identified by vid and
  97  * belonging to orig_node otherwise. The object is created and added to the list
  98  * if it does not exist.
  99  *
 100  * The object is returned with refcounter increased by 1.
 101  */
 102 struct batadv_orig_node_vlan *
 103 batadv_orig_node_vlan_new(struct batadv_orig_node *orig_node,
 104                           unsigned short vid)
 105 {
 106         struct batadv_orig_node_vlan *vlan;
 107
 108         spin_lock_bh(&orig_node->vlan_list_lock);
 109
 110         /* first look if an object for this vid already exists */
 111         vlan = batadv_orig_node_vlan_get(orig_node, vid);
 112         if (vlan)
 113                 goto out;
 114
 115         vlan = kzalloc(sizeof(*vlan), GFP_ATOMIC);
 116         if (!vlan)
 117                 goto out;
 118
 119         atomic_set(&vlan->refcount, 2);
 120         vlan->vid = vid;
 121
 122         hlist_add_head_rcu(&vlan->list, &orig_node->vlan_list);
 123
 124 out:
 125         spin_unlock_bh(&orig_node->vlan_list_lock);
 126
 127         return vlan;
 128 }
 129
 130 /**
 131  * batadv_orig_node_vlan_free_ref - decrement the refcounter and possibly free
 132  *  the originator-vlan object
 133  * @orig_vlan: the originator-vlan object to release
 134  */
 135 void batadv_orig_node_vlan_free_ref(struct batadv_orig_node_vlan *orig_vlan)
 136 {
 137         if (atomic_dec_and_test(&orig_vlan->refcount))
 138                 kfree_rcu(orig_vlan, rcu);
 139 }
 140
 141 int batadv_originator_init(struct batadv_priv *bat_priv)
 142 {
 143         if (bat_priv->orig_hash)
 144                 return 0;
 145
 146         bat_priv->orig_hash = batadv_hash_new(1024);
 147
 148         if (!bat_priv->orig_hash)
 149                 goto err;
 150
 151         batadv_hash_set_lock_class(bat_priv->orig_hash,
 152                                    &batadv_orig_hash_lock_class_key);
 153
 154         INIT_DELAYED_WORK(&bat_priv->orig_work, batadv_purge_orig);
 155         queue_delayed_work(batadv_event_workqueue,
 156                            &bat_priv->orig_work,
 157                            msecs_to_jiffies(BATADV_ORIG_WORK_PERIOD));
 158
 159         return 0;
 160
 161 err:
 162         return -ENOMEM;
 163 }
 164
 165 /**
 166  * batadv_neigh_ifinfo_free_rcu - free the neigh_ifinfo object
 167  * @rcu: rcu pointer of the neigh_ifinfo object
 168  */
 169 static void batadv_neigh_ifinfo_free_rcu(struct rcu_head *rcu)
 170 {
 171         struct batadv_neigh_ifinfo *neigh_ifinfo;
 172
 173         neigh_ifinfo = container_of(rcu, struct batadv_neigh_ifinfo, rcu);
 174
 175         if (neigh_ifinfo->if_outgoing != BATADV_IF_DEFAULT)
 176                 batadv_hardif_free_ref_now(neigh_ifinfo->if_outgoing);
 177
 178         kfree(neigh_ifinfo);
 179 }
 180
 181 /**
 182  * batadv_neigh_ifinfo_free_now - decrement the refcounter and possibly free
 183  *  the neigh_ifinfo (without rcu callback)
 184  * @neigh_ifinfo: the neigh_ifinfo object to release
 185  */
 186 static void
 187 batadv_neigh_ifinfo_free_ref_now(struct batadv_neigh_ifinfo *neigh_ifinfo)
 188 {
 189         if (atomic_dec_and_test(&neigh_ifinfo->refcount))
 190                 batadv_neigh_ifinfo_free_rcu(&neigh_ifinfo->rcu);
 191 }
 192
 193 /**
 194  * batadv_neigh_ifinfo_free_ref - decrement the refcounter and possibly free
 195  *  the neigh_ifinfo
 196  * @neigh_ifinfo: the neigh_ifinfo object to release
 197  */
 198 void batadv_neigh_ifinfo_free_ref(struct batadv_neigh_ifinfo *neigh_ifinfo)
 199 {
 200         if (atomic_dec_and_test(&neigh_ifinfo->refcount))
 201                 call_rcu(&neigh_ifinfo->rcu, batadv_neigh_ifinfo_free_rcu);
 202 }
 203
 204 /**
 205  * batadv_neigh_node_free_rcu - free the neigh_node
 206  * @rcu: rcu pointer of the neigh_node
 207  */
 208 static void batadv_neigh_node_free_rcu(struct rcu_head *rcu)
 209 {
 210         struct hlist_node *node_tmp;
 211         struct batadv_neigh_node *neigh_node;
 212         struct batadv_neigh_ifinfo *neigh_ifinfo;
 213         struct batadv_algo_ops *bao;
 214
 215         neigh_node = container_of(rcu, struct batadv_neigh_node, rcu);
 216         bao = neigh_node->orig_node->bat_priv->bat_algo_ops;
 217
 218         hlist_for_each_entry_safe(neigh_ifinfo, node_tmp,
 219                                   &neigh_node->ifinfo_list, list) {
 220                 batadv_neigh_ifinfo_free_ref_now(neigh_ifinfo);
 221         }
 222
 223         if (bao->bat_neigh_free)
 224                 bao->bat_neigh_free(neigh_node);
 225
 226         batadv_hardif_free_ref_now(neigh_node->if_incoming);
 227
 228         kfree(neigh_node);
 229 }
 230
 231 /**
 232  * batadv_neigh_node_free_ref_now - decrement the neighbors refcounter
 233  *  and possibly free it (without rcu callback)
 234  * @neigh_node: neigh neighbor to free
 235  */
 236 static void
 237 batadv_neigh_node_free_ref_now(struct batadv_neigh_node *neigh_node)
 238 {
 239         if (atomic_dec_and_test(&neigh_node->refcount))
 240                 batadv_neigh_node_free_rcu(&neigh_node->rcu);
 241 }
 242
 243 /**
 244  * batadv_neigh_node_free_ref - decrement the neighbors refcounter
 245  *  and possibly free it
 246  * @neigh_node: neigh neighbor to free
 247  */
 248 void batadv_neigh_node_free_ref(struct batadv_neigh_node *neigh_node)
 249 {
 250         if (atomic_dec_and_test(&neigh_node->refcount))
 251                 call_rcu(&neigh_node->rcu, batadv_neigh_node_free_rcu);
 252 }
 253
 254 /**
 255  * batadv_orig_node_get_router - router to the originator depending on iface
 256  * @orig_node: the orig node for the router
 257  * @if_outgoing: the interface where the payload packet has been received or
 258  *  the OGM should be sent to
 259  *
 260  * Returns the neighbor which should be router for this orig_node/iface.
 261  *
 262  * The object is returned with refcounter increased by 1.
 263  */
 264 struct batadv_neigh_node *
 265 batadv_orig_router_get(struct batadv_orig_node *orig_node,
 266                        const struct batadv_hard_iface *if_outgoing)
 267 {
 268         struct batadv_orig_ifinfo *orig_ifinfo;
 269         struct batadv_neigh_node *router = NULL;
 270
 271         rcu_read_lock();
 272         hlist_for_each_entry_rcu(orig_ifinfo, &orig_node->ifinfo_list, list) {
 273                 if (orig_ifinfo->if_outgoing != if_outgoing)
 274                         continue;
 275
 276                 router = rcu_dereference(orig_ifinfo->router);
 277                 break;
 278         }
 279
 280         if (router && !atomic_inc_not_zero(&router->refcount))
 281                 router = NULL;
 282
 283         rcu_read_unlock();
 284         return router;
 285 }
 286
 287 /**
 288  * batadv_orig_ifinfo_get - find the ifinfo from an orig_node
 289  * @orig_node: the orig node to be queried
 290  * @if_outgoing: the interface for which the ifinfo should be acquired
 291  *
 292  * Returns the requested orig_ifinfo or NULL if not found.
 293  *
 294  * The object is returned with refcounter increased by 1.
 295  */
 296 struct batadv_orig_ifinfo *
 297 batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
 298                        struct batadv_hard_iface *if_outgoing)
 299 {
 300         struct batadv_orig_ifinfo *tmp, *orig_ifinfo = NULL;
 301
 302         rcu_read_lock();
 303         hlist_for_each_entry_rcu(tmp, &orig_node->ifinfo_list,
 304                                  list) {
 305                 if (tmp->if_outgoing != if_outgoing)
 306                         continue;
 307
 308                 if (!atomic_inc_not_zero(&tmp->refcount))
 309                         continue;
 310
 311                 orig_ifinfo = tmp;
 312                 break;
 313         }
 314         rcu_read_unlock();
 315
 316         return orig_ifinfo;
 317 }
 318
 319 /**
 320  * batadv_orig_ifinfo_new - search and possibly create an orig_ifinfo object
 321  * @orig_node: the orig node to be queried
 322  * @if_outgoing: the interface for which the ifinfo should be acquired
 323  *
 324  * Returns NULL in case of failure or the orig_ifinfo object for the if_outgoing
 325  * interface otherwise. The object is created and added to the list
 326  * if it does not exist.
 327  *
 328  * The object is returned with refcounter increased by 1.
 329  */
 330 struct batadv_orig_ifinfo *
 331 batadv_orig_ifinfo_new(struct batadv_orig_node *orig_node,
 332                        struct batadv_hard_iface *if_outgoing)
 333 {
 334         struct batadv_orig_ifinfo *orig_ifinfo = NULL;
 335         unsigned long reset_time;
 336
 337         spin_lock_bh(&orig_node->neigh_list_lock);
 338
 339         orig_ifinfo = batadv_orig_ifinfo_get(orig_node, if_outgoing);
 340         if (orig_ifinfo)
 341                 goto out;
 342
 343         orig_ifinfo = kzalloc(sizeof(*orig_ifinfo), GFP_ATOMIC);
 344         if (!orig_ifinfo)
 345                 goto out;
 346
 347         if (if_outgoing != BATADV_IF_DEFAULT &&
 348             !atomic_inc_not_zero(&if_outgoing->refcount)) {
 349                 kfree(orig_ifinfo);
 350                 orig_ifinfo = NULL;
 351                 goto out;
 352         }
 353
 354         reset_time = jiffies - 1;
 355         reset_time -= msecs_to_jiffies(BATADV_RESET_PROTECTION_MS);
 356         orig_ifinfo->batman_seqno_reset = reset_time;
 357         orig_ifinfo->if_outgoing = if_outgoing;
 358         INIT_HLIST_NODE(&orig_ifinfo->list);
 359         atomic_set(&orig_ifinfo->refcount, 2);
 360         hlist_add_head_rcu(&orig_ifinfo->list,
 361                            &orig_node->ifinfo_list);
 362 out:
 363         spin_unlock_bh(&orig_node->neigh_list_lock);
 364         return orig_ifinfo;
 365 }
 366
 367 /**
 368  * batadv_neigh_ifinfo_get - find the ifinfo from an neigh_node
 369  * @neigh_node: the neigh node to be queried
 370  * @if_outgoing: the interface for which the ifinfo should be acquired
 371  *
 372  * The object is returned with refcounter increased by 1.
 373  *
 374  * Returns the requested neigh_ifinfo or NULL if not found
 375  */
 376 struct batadv_neigh_ifinfo *
 377 batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
 378                         struct batadv_hard_iface *if_outgoing)
 379 {
 380         struct batadv_neigh_ifinfo *neigh_ifinfo = NULL,
 381                                    *tmp_neigh_ifinfo;
 382
 383         rcu_read_lock();
 384         hlist_for_each_entry_rcu(tmp_neigh_ifinfo, &neigh->ifinfo_list,
 385                                  list) {
 386                 if (tmp_neigh_ifinfo->if_outgoing != if_outgoing)
 387                         continue;
 388
 389                 if (!atomic_inc_not_zero(&tmp_neigh_ifinfo->refcount))
 390                         continue;
 391
 392                 neigh_ifinfo = tmp_neigh_ifinfo;
 393                 break;
 394         }
 395         rcu_read_unlock();
 396
 397         return neigh_ifinfo;
 398 }
 399
 400 /**
 401  * batadv_neigh_ifinfo_new - search and possibly create an neigh_ifinfo object
 402  * @neigh_node: the neigh node to be queried
 403  * @if_outgoing: the interface for which the ifinfo should be acquired
 404  *
 405  * Returns NULL in case of failure or the neigh_ifinfo object for the
 406  * if_outgoing interface otherwise. The object is created and added to the list
 407  * if it does not exist.
 408  *
 409  * The object is returned with refcounter increased by 1.
 410  */
 411 struct batadv_neigh_ifinfo *
 412 batadv_neigh_ifinfo_new(struct batadv_neigh_node *neigh,
 413                         struct batadv_hard_iface *if_outgoing)
 414 {
 415         struct batadv_neigh_ifinfo *neigh_ifinfo;
 416
 417         spin_lock_bh(&neigh->ifinfo_lock);
 418
 419         neigh_ifinfo = batadv_neigh_ifinfo_get(neigh, if_outgoing);
 420         if (neigh_ifinfo)
 421                 goto out;
 422
 423         neigh_ifinfo = kzalloc(sizeof(*neigh_ifinfo), GFP_ATOMIC);
 424         if (!neigh_ifinfo)
 425                 goto out;
 426
 427         if (if_outgoing && !atomic_inc_not_zero(&if_outgoing->refcount)) {
 428                 kfree(neigh_ifinfo);
 429                 neigh_ifinfo = NULL;
 430                 goto out;
 431         }
 432
 433         INIT_HLIST_NODE(&neigh_ifinfo->list);
 434         atomic_set(&neigh_ifinfo->refcount, 2);
 435         neigh_ifinfo->if_outgoing = if_outgoing;
 436
 437         hlist_add_head_rcu(&neigh_ifinfo->list, &neigh->ifinfo_list);
 438
 439 out:
 440         spin_unlock_bh(&neigh->ifinfo_lock);
 441
 442         return neigh_ifinfo;
 443 }
 444
 445 /**
 446  * batadv_neigh_node_new - create and init a new neigh_node object
 447  * @hard_iface: the interface where the neighbour is connected to
 448  * @neigh_addr: the mac address of the neighbour interface
 449  * @orig_node: originator object representing the neighbour
 450  *
 451  * Allocates a new neigh_node object and initialises all the generic fields.
 452  * Returns the new object or NULL on failure.
 453  */
 454 struct batadv_neigh_node *
 455 batadv_neigh_node_new(struct batadv_hard_iface *hard_iface,
 456                       const u8 *neigh_addr, struct batadv_orig_node *orig_node)
 457 {
 458         struct batadv_neigh_node *neigh_node;
 459
 460         neigh_node = kzalloc(sizeof(*neigh_node), GFP_ATOMIC);
 461         if (!neigh_node)
 462                 goto out;
 463
 464         if (!atomic_inc_not_zero(&hard_iface->refcount)) {
 465                 kfree(neigh_node);
 466                 neigh_node = NULL;
 467                 goto out;
 468         }
 469
 470         INIT_HLIST_NODE(&neigh_node->list);
 471         INIT_HLIST_HEAD(&neigh_node->ifinfo_list);
 472         spin_lock_init(&neigh_node->ifinfo_lock);
 473
 474         ether_addr_copy(neigh_node->addr, neigh_addr);
 475         neigh_node->if_incoming = hard_iface;
 476         neigh_node->orig_node = orig_node;
 477
 478         /* extra reference for return */
 479         atomic_set(&neigh_node->refcount, 2);
 480
 481 out:
 482         return neigh_node;
 483 }
 484
 485 /**
 486  * batadv_neigh_node_get - retrieve a neighbour from the list
 487  * @orig_node: originator which the neighbour belongs to
 488  * @hard_iface: the interface where this neighbour is connected to
 489  * @addr: the address of the neighbour
 490  *
 491  * Looks for and possibly returns a neighbour belonging to this originator list
 492  * which is connected through the provided hard interface.
 493  * Returns NULL if the neighbour is not found.
 494  */
 495 struct batadv_neigh_node *
 496 batadv_neigh_node_get(const struct batadv_orig_node *orig_node,
 497                       const struct batadv_hard_iface *hard_iface,
 498                       const u8 *addr)
 499 {
 500         struct batadv_neigh_node *tmp_neigh_node, *res = NULL;
 501
 502         rcu_read_lock();
 503         hlist_for_each_entry_rcu(tmp_neigh_node, &orig_node->neigh_list, list) {
 504                 if (!batadv_compare_eth(tmp_neigh_node->addr, addr))
 505                         continue;
 506
 507                 if (tmp_neigh_node->if_incoming != hard_iface)
 508                         continue;
 509
 510                 if (!atomic_inc_not_zero(&tmp_neigh_node->refcount))
 511                         continue;
 512
 513                 res = tmp_neigh_node;
 514                 break;
 515         }
 516         rcu_read_unlock();
 517
 518         return res;
 519 }
 520
 521 /**
 522  * batadv_orig_ifinfo_free_rcu - free the orig_ifinfo object
 523  * @rcu: rcu pointer of the orig_ifinfo object
 524  */
 525 static void batadv_orig_ifinfo_free_rcu(struct rcu_head *rcu)
 526 {
 527         struct batadv_orig_ifinfo *orig_ifinfo;
 528         struct batadv_neigh_node *router;
 529
 530         orig_ifinfo = container_of(rcu, struct batadv_orig_ifinfo, rcu);
 531
 532         if (orig_ifinfo->if_outgoing != BATADV_IF_DEFAULT)
 533                 batadv_hardif_free_ref_now(orig_ifinfo->if_outgoing);
 534
 535         /* this is the last reference to this object */
 536         router = rcu_dereference_protected(orig_ifinfo->router, true);
 537         if (router)
 538                 batadv_neigh_node_free_ref_now(router);
 539         kfree(orig_ifinfo);
 540 }
 541
 542 /**
 543  * batadv_orig_ifinfo_free_ref - decrement the refcounter and possibly free
 544  *  the orig_ifinfo (without rcu callback)
 545  * @orig_ifinfo: the orig_ifinfo object to release
 546  */
 547 static void
 548 batadv_orig_ifinfo_free_ref_now(struct batadv_orig_ifinfo *orig_ifinfo)
 549 {
 550         if (atomic_dec_and_test(&orig_ifinfo->refcount))
 551                 batadv_orig_ifinfo_free_rcu(&orig_ifinfo->rcu);
 552 }
 553
 554 /**
 555  * batadv_orig_ifinfo_free_ref - decrement the refcounter and possibly free
 556  *  the orig_ifinfo
 557  * @orig_ifinfo: the orig_ifinfo object to release
 558  */
 559 void batadv_orig_ifinfo_free_ref(struct batadv_orig_ifinfo *orig_ifinfo)
 560 {
 561         if (atomic_dec_and_test(&orig_ifinfo->refcount))
 562                 call_rcu(&orig_ifinfo->rcu, batadv_orig_ifinfo_free_rcu);
 563 }
 564
 565 static void batadv_orig_node_free_rcu(struct rcu_head *rcu)
 566 {
 567         struct hlist_node *node_tmp;
 568         struct batadv_neigh_node *neigh_node;
 569         struct batadv_orig_node *orig_node;
 570         struct batadv_orig_ifinfo *orig_ifinfo;
 571
 572         orig_node = container_of(rcu, struct batadv_orig_node, rcu);
 573
 574         spin_lock_bh(&orig_node->neigh_list_lock);
 575
 576         /* for all neighbors towards this originator ... */
 577         hlist_for_each_entry_safe(neigh_node, node_tmp,
 578                                   &orig_node->neigh_list, list) {
 579                 hlist_del_rcu(&neigh_node->list);
 580                 batadv_neigh_node_free_ref_now(neigh_node);
 581         }
 582
 583         hlist_for_each_entry_safe(orig_ifinfo, node_tmp,
 584                                   &orig_node->ifinfo_list, list) {
 585                 hlist_del_rcu(&orig_ifinfo->list);
 586                 batadv_orig_ifinfo_free_ref_now(orig_ifinfo);
 587         }
 588         spin_unlock_bh(&orig_node->neigh_list_lock);
 589
 590         batadv_mcast_purge_orig(orig_node);
 591
 592         /* Free nc_nodes */
 593         batadv_nc_purge_orig(orig_node->bat_priv, orig_node, NULL);
 594
 595         batadv_frag_purge_orig(orig_node, NULL);
 596
 597         if (orig_node->bat_priv->bat_algo_ops->bat_orig_free)
 598                 orig_node->bat_priv->bat_algo_ops->bat_orig_free(orig_node);
 599
 600         kfree(orig_node->tt_buff);
 601         kfree(orig_node);
 602 }
 603
 604 /**
 605  * batadv_orig_node_free_ref - decrement the orig node refcounter and possibly
 606  * schedule an rcu callback for freeing it
 607  * @orig_node: the orig node to free
 608  */
 609 void batadv_orig_node_free_ref(struct batadv_orig_node *orig_node)
 610 {
 611         if (atomic_dec_and_test(&orig_node->refcount))
 612                 call_rcu(&orig_node->rcu, batadv_orig_node_free_rcu);
 613 }
 614
 615 /**
 616  * batadv_orig_node_free_ref_now - decrement the orig node refcounter and
 617  * possibly free it (without rcu callback)
 618  * @orig_node: the orig node to free
 619  */
 620 void batadv_orig_node_free_ref_now(struct batadv_orig_node *orig_node)
 621 {
 622         if (atomic_dec_and_test(&orig_node->refcount))
 623                 batadv_orig_node_free_rcu(&orig_node->rcu);
 624 }
 625
 626 void batadv_originator_free(struct batadv_priv *bat_priv)
 627 {
 628         struct batadv_hashtable *hash = bat_priv->orig_hash;
 629         struct hlist_node *node_tmp;
 630         struct hlist_head *head;
 631         spinlock_t *list_lock; /* spinlock to protect write access */
 632         struct batadv_orig_node *orig_node;
 633         u32 i;
 634
 635         if (!hash)
 636                 return;
 637
 638         cancel_delayed_work_sync(&bat_priv->orig_work);
 639
 640         bat_priv->orig_hash = NULL;
 641
 642         for (i = 0; i < hash->size; i++) {
 643                 head = &hash->table[i];
 644                 list_lock = &hash->list_locks[i];
 645
 646                 spin_lock_bh(list_lock);
 647                 hlist_for_each_entry_safe(orig_node, node_tmp,
 648                                           head, hash_entry) {
 649                         hlist_del_rcu(&orig_node->hash_entry);
 650                         batadv_orig_node_free_ref(orig_node);
 651                 }
 652                 spin_unlock_bh(list_lock);
 653         }
 654
 655         batadv_hash_destroy(hash);
 656 }
 657
 658 /**
 659  * batadv_orig_node_new - creates a new orig_node
 660  * @bat_priv: the bat priv with all the soft interface information
 661  * @addr: the mac address of the originator
 662  *
 663  * Creates a new originator object and initialise all the generic fields.
 664  * The new object is not added to the originator list.
 665  * Returns the newly created object or NULL on failure.
 666  */
 667 struct batadv_orig_node *batadv_orig_node_new(struct batadv_priv *bat_priv,
 668                                               const u8 *addr)
 669 {
 670         struct batadv_orig_node *orig_node;
 671         struct batadv_orig_node_vlan *vlan;
 672         unsigned long reset_time;
 673         int i;
 674
 675         batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
 676                    "Creating new originator: %pM\n", addr);
 677
 678         orig_node = kzalloc(sizeof(*orig_node), GFP_ATOMIC);
 679         if (!orig_node)
 680                 return NULL;
 681
 682         INIT_HLIST_HEAD(&orig_node->neigh_list);
 683         INIT_HLIST_HEAD(&orig_node->vlan_list);
 684         INIT_HLIST_HEAD(&orig_node->ifinfo_list);
 685         spin_lock_init(&orig_node->bcast_seqno_lock);
 686         spin_lock_init(&orig_node->neigh_list_lock);
 687         spin_lock_init(&orig_node->tt_buff_lock);
 688         spin_lock_init(&orig_node->tt_lock);
 689         spin_lock_init(&orig_node->vlan_list_lock);
 690
 691         batadv_nc_init_orig(orig_node);
 692
 693         /* extra reference for return */
 694         atomic_set(&orig_node->refcount, 2);
 695
 696         orig_node->bat_priv = bat_priv;
 697         ether_addr_copy(orig_node->orig, addr);
 698         batadv_dat_init_orig_node_addr(orig_node);
 699         atomic_set(&orig_node->last_ttvn, 0);
 700         orig_node->tt_buff = NULL;
 701         orig_node->tt_buff_len = 0;
 702         orig_node->last_seen = jiffies;
 703         reset_time = jiffies - 1 - msecs_to_jiffies(BATADV_RESET_PROTECTION_MS);
 704         orig_node->bcast_seqno_reset = reset_time;
 705
 706 #ifdef CONFIG_BATMAN_ADV_MCAST
 707         orig_node->mcast_flags = BATADV_NO_FLAGS;
 708         INIT_HLIST_NODE(&orig_node->mcast_want_all_unsnoopables_node);
 709         INIT_HLIST_NODE(&orig_node->mcast_want_all_ipv4_node);
 710         INIT_HLIST_NODE(&orig_node->mcast_want_all_ipv6_node);
 711         spin_lock_init(&orig_node->mcast_handler_lock);
 712 #endif
 713
 714         /* create a vlan object for the "untagged" LAN */
 715         vlan = batadv_orig_node_vlan_new(orig_node, BATADV_NO_FLAGS);
 716         if (!vlan)
 717                 goto free_orig_node;
 718         /* batadv_orig_node_vlan_new() increases the refcounter.
 719          * Immediately release vlan since it is not needed anymore in this
 720          * context
 721          */
 722         batadv_orig_node_vlan_free_ref(vlan);
 723
 724         for (i = 0; i < BATADV_FRAG_BUFFER_COUNT; i++) {
 725                 INIT_HLIST_HEAD(&orig_node->fragments[i].head);
 726                 spin_lock_init(&orig_node->fragments[i].lock);
 727                 orig_node->fragments[i].size = 0;
 728         }
 729
 730         return orig_node;
 731 free_orig_node:
 732         kfree(orig_node);
 733         return NULL;
 734 }
 735
 736 /**
 737  * batadv_purge_neigh_ifinfo - purge obsolete ifinfo entries from neighbor
 738  * @bat_priv: the bat priv with all the soft interface information
 739  * @neigh: orig node which is to be checked
 740  */
 741 static void
 742 batadv_purge_neigh_ifinfo(struct batadv_priv *bat_priv,
 743                           struct batadv_neigh_node *neigh)
 744 {
 745         struct batadv_neigh_ifinfo *neigh_ifinfo;
 746         struct batadv_hard_iface *if_outgoing;
 747         struct hlist_node *node_tmp;
 748
 749         spin_lock_bh(&neigh->ifinfo_lock);
 750
 751         /* for all ifinfo objects for this neighinator */
 752         hlist_for_each_entry_safe(neigh_ifinfo, node_tmp,
 753                                   &neigh->ifinfo_list, list) {
 754                 if_outgoing = neigh_ifinfo->if_outgoing;
 755
 756                 /* always keep the default interface */
 757                 if (if_outgoing == BATADV_IF_DEFAULT)
 758                         continue;
 759
 760                 /* don't purge if the interface is not (going) down */
 761                 if ((if_outgoing->if_status != BATADV_IF_INACTIVE) &&
 762                     (if_outgoing->if_status != BATADV_IF_NOT_IN_USE) &&
 763                     (if_outgoing->if_status != BATADV_IF_TO_BE_REMOVED))
 764                         continue;
 765
 766                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
 767                            "neighbor/ifinfo purge: neighbor %pM, iface: %s\n",
 768                            neigh->addr, if_outgoing->net_dev->name);
 769
 770                 hlist_del_rcu(&neigh_ifinfo->list);
 771                 batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
 772         }
 773
 774         spin_unlock_bh(&neigh->ifinfo_lock);
 775 }
 776
 777 /**
 778  * batadv_purge_orig_ifinfo - purge obsolete ifinfo entries from originator
 779  * @bat_priv: the bat priv with all the soft interface information
 780  * @orig_node: orig node which is to be checked
 781  *
 782  * Returns true if any ifinfo entry was purged, false otherwise.
 783  */
 784 static bool
 785 batadv_purge_orig_ifinfo(struct batadv_priv *bat_priv,
 786                          struct batadv_orig_node *orig_node)
 787 {
 788         struct batadv_orig_ifinfo *orig_ifinfo;
 789         struct batadv_hard_iface *if_outgoing;
 790         struct hlist_node *node_tmp;
 791         bool ifinfo_purged = false;
 792
 793         spin_lock_bh(&orig_node->neigh_list_lock);
 794
 795         /* for all ifinfo objects for this originator */
 796         hlist_for_each_entry_safe(orig_ifinfo, node_tmp,
 797                                   &orig_node->ifinfo_list, list) {
 798                 if_outgoing = orig_ifinfo->if_outgoing;
 799
 800                 /* always keep the default interface */
 801                 if (if_outgoing == BATADV_IF_DEFAULT)
 802                         continue;
 803
 804                 /* don't purge if the interface is not (going) down */
 805                 if ((if_outgoing->if_status != BATADV_IF_INACTIVE) &&
 806                     (if_outgoing->if_status != BATADV_IF_NOT_IN_USE) &&
 807                     (if_outgoing->if_status != BATADV_IF_TO_BE_REMOVED))
 808                         continue;
 809
 810                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
 811                            "router/ifinfo purge: originator %pM, iface: %s\n",
 812                            orig_node->orig, if_outgoing->net_dev->name);
 813
 814                 ifinfo_purged = true;
 815
 816                 hlist_del_rcu(&orig_ifinfo->list);
 817                 batadv_orig_ifinfo_free_ref(orig_ifinfo);
 818                 if (orig_node->last_bonding_candidate == orig_ifinfo) {
 819                         orig_node->last_bonding_candidate = NULL;
 820                         batadv_orig_ifinfo_free_ref(orig_ifinfo);
 821                 }
 822         }
 823
 824         spin_unlock_bh(&orig_node->neigh_list_lock);
 825
 826         return ifinfo_purged;
 827 }
 828
 829 /**
 830  * batadv_purge_orig_neighbors - purges neighbors from originator
 831  * @bat_priv: the bat priv with all the soft interface information
 832  * @orig_node: orig node which is to be checked
 833  *
 834  * Returns true if any neighbor was purged, false otherwise
 835  */
 836 static bool
 837 batadv_purge_orig_neighbors(struct batadv_priv *bat_priv,
 838                             struct batadv_orig_node *orig_node)
 839 {
 840         struct hlist_node *node_tmp;
 841         struct batadv_neigh_node *neigh_node;
 842         bool neigh_purged = false;
 843         unsigned long last_seen;
 844         struct batadv_hard_iface *if_incoming;
 845
 846         spin_lock_bh(&orig_node->neigh_list_lock);
 847
 848         /* for all neighbors towards this originator ... */
 849         hlist_for_each_entry_safe(neigh_node, node_tmp,
 850                                   &orig_node->neigh_list, list) {
 851                 last_seen = neigh_node->last_seen;
 852                 if_incoming = neigh_node->if_incoming;
 853
 854                 if ((batadv_has_timed_out(last_seen, BATADV_PURGE_TIMEOUT)) ||
 855                     (if_incoming->if_status == BATADV_IF_INACTIVE) ||
 856                     (if_incoming->if_status == BATADV_IF_NOT_IN_USE) ||
 857                     (if_incoming->if_status == BATADV_IF_TO_BE_REMOVED)) {
 858                         if ((if_incoming->if_status == BATADV_IF_INACTIVE) ||
 859                             (if_incoming->if_status == BATADV_IF_NOT_IN_USE) ||
 860                             (if_incoming->if_status == BATADV_IF_TO_BE_REMOVED))
 861                                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
 862                                            "neighbor purge: originator %pM, neighbor: %pM, iface: %s\n",
 863                                            orig_node->orig, neigh_node->addr,
 864                                            if_incoming->net_dev->name);
 865                         else
 866                                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
 867                                            "neighbor timeout: originator %pM, neighbor: %pM, last_seen: %u\n",
 868                                            orig_node->orig, neigh_node->addr,
 869                                            jiffies_to_msecs(last_seen));
 870
 871                         neigh_purged = true;
 872
 873                         hlist_del_rcu(&neigh_node->list);
 874                         batadv_neigh_node_free_ref(neigh_node);
 875                 } else {
 876                         /* only necessary if not the whole neighbor is to be
 877                          * deleted, but some interface has been removed.
 878                          */
 879                         batadv_purge_neigh_ifinfo(bat_priv, neigh_node);
 880                 }
 881         }
 882
 883         spin_unlock_bh(&orig_node->neigh_list_lock);
 884         return neigh_purged;
 885 }
 886
 887 /**
 888  * batadv_find_best_neighbor - finds the best neighbor after purging
 889  * @bat_priv: the bat priv with all the soft interface information
 890  * @orig_node: orig node which is to be checked
 891  * @if_outgoing: the interface for which the metric should be compared
 892  *
 893  * Returns the current best neighbor, with refcount increased.
 894  */
 895 static struct batadv_neigh_node *
 896 batadv_find_best_neighbor(struct batadv_priv *bat_priv,
 897                           struct batadv_orig_node *orig_node,
 898                           struct batadv_hard_iface *if_outgoing)
 899 {
 900         struct batadv_neigh_node *best = NULL, *neigh;
 901         struct batadv_algo_ops *bao = bat_priv->bat_algo_ops;
 902
 903         rcu_read_lock();
 904         hlist_for_each_entry_rcu(neigh, &orig_node->neigh_list, list) {
 905                 if (best && (bao->bat_neigh_cmp(neigh, if_outgoing,
 906                                                 best, if_outgoing) <= 0))
 907                         continue;
 908
 909                 if (!atomic_inc_not_zero(&neigh->refcount))
 910                         continue;
 911
 912                 if (best)
 913                         batadv_neigh_node_free_ref(best);
 914
 915                 best = neigh;
 916         }
 917         rcu_read_unlock();
 918
 919         return best;
 920 }
 921
 922 /**
 923  * batadv_purge_orig_node - purges obsolete information from an orig_node
 924  * @bat_priv: the bat priv with all the soft interface information
 925  * @orig_node: orig node which is to be checked
 926  *
 927  * This function checks if the orig_node or substructures of it have become
 928  * obsolete, and purges this information if that's the case.
 929  *
 930  * Returns true if the orig_node is to be removed, false otherwise.
 931  */
 932 static bool batadv_purge_orig_node(struct batadv_priv *bat_priv,
 933                                    struct batadv_orig_node *orig_node)
 934 {
 935         struct batadv_neigh_node *best_neigh_node;
 936         struct batadv_hard_iface *hard_iface;
 937         bool changed_ifinfo, changed_neigh;
 938
 939         if (batadv_has_timed_out(orig_node->last_seen,
 940                                  2 * BATADV_PURGE_TIMEOUT)) {
 941                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
 942                            "Originator timeout: originator %pM, last_seen %u\n",
 943                            orig_node->orig,
 944                            jiffies_to_msecs(orig_node->last_seen));
 945                 return true;
 946         }
 947         changed_ifinfo = batadv_purge_orig_ifinfo(bat_priv, orig_node);
 948         changed_neigh = batadv_purge_orig_neighbors(bat_priv, orig_node);
 949
 950         if (!changed_ifinfo && !changed_neigh)
 951                 return false;
 952
 953         /* first for NULL ... */
 954         best_neigh_node = batadv_find_best_neighbor(bat_priv, orig_node,
 955                                                     BATADV_IF_DEFAULT);
 956         batadv_update_route(bat_priv, orig_node, BATADV_IF_DEFAULT,
 957                             best_neigh_node);
 958         if (best_neigh_node)
 959                 batadv_neigh_node_free_ref(best_neigh_node);
 960
 961         /* ... then for all other interfaces. */
 962         rcu_read_lock();
 963         list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
 964                 if (hard_iface->if_status != BATADV_IF_ACTIVE)
 965                         continue;
 966
 967                 if (hard_iface->soft_iface != bat_priv->soft_iface)
 968                         continue;
 969
 970                 best_neigh_node = batadv_find_best_neighbor(bat_priv,
 971                                                             orig_node,
 972                                                             hard_iface);
 973                 batadv_update_route(bat_priv, orig_node, hard_iface,
 974                                     best_neigh_node);
 975                 if (best_neigh_node)
 976                         batadv_neigh_node_free_ref(best_neigh_node);
 977         }
 978         rcu_read_unlock();
 979
 980         return false;
 981 }
 982
 983 static void _batadv_purge_orig(struct batadv_priv *bat_priv)
 984 {
 985         struct batadv_hashtable *hash = bat_priv->orig_hash;
 986         struct hlist_node *node_tmp;
 987         struct hlist_head *head;
 988         spinlock_t *list_lock; /* spinlock to protect write access */
 989         struct batadv_orig_node *orig_node;
 990         u32 i;
 991
 992         if (!hash)
 993                 return;
 994
 995         /* for all origins... */
 996         for (i = 0; i < hash->size; i++) {
 997                 head = &hash->table[i];
 998                 list_lock = &hash->list_locks[i];
 999
1000                 spin_lock_bh(list_lock);
1001                 hlist_for_each_entry_safe(orig_node, node_tmp,
1002                                           head, hash_entry) {
1003                         if (batadv_purge_orig_node(bat_priv, orig_node)) {
1004                                 batadv_gw_node_delete(bat_priv, orig_node);
1005                                 hlist_del_rcu(&orig_node->hash_entry);
1006                                 batadv_tt_global_del_orig(orig_node->bat_priv,
1007                                                           orig_node, -1,
1008                                                           "originator timed out");
1009                                 batadv_orig_node_free_ref(orig_node);
1010                                 continue;
1011                         }
1012
1013                         batadv_frag_purge_orig(orig_node,
1014                                                batadv_frag_check_entry);
1015                 }
1016                 spin_unlock_bh(list_lock);
1017         }
1018
1019         batadv_gw_node_purge(bat_priv);
1020         batadv_gw_election(bat_priv);
1021 }
1022
1023 static void batadv_purge_orig(struct work_struct *work)
1024 {
1025         struct delayed_work *delayed_work;
1026         struct batadv_priv *bat_priv;
1027
1028         delayed_work = container_of(work, struct delayed_work, work);
1029         bat_priv = container_of(delayed_work, struct batadv_priv, orig_work);
1030         _batadv_purge_orig(bat_priv);
1031         queue_delayed_work(batadv_event_workqueue,
1032                            &bat_priv->orig_work,
1033                            msecs_to_jiffies(BATADV_ORIG_WORK_PERIOD));
1034 }
1035
1036 void batadv_purge_orig_ref(struct batadv_priv *bat_priv)
1037 {
1038         _batadv_purge_orig(bat_priv);
1039 }
1040
1041 int batadv_orig_seq_print_text(struct seq_file *seq, void *offset)
1042 {
1043         struct net_device *net_dev = (struct net_device *)seq->private;
1044         struct batadv_priv *bat_priv = netdev_priv(net_dev);
1045         struct batadv_hard_iface *primary_if;
1046
1047         primary_if = batadv_seq_print_text_primary_if_get(seq);
1048         if (!primary_if)
1049                 return 0;
1050
1051         seq_printf(seq, "[B.A.T.M.A.N. adv %s, MainIF/MAC: %s/%pM (%s %s)]\n",
1052                    BATADV_SOURCE_VERSION, primary_if->net_dev->name,
1053                    primary_if->net_dev->dev_addr, net_dev->name,
1054                    bat_priv->bat_algo_ops->name);
1055
1056         batadv_hardif_free_ref(primary_if);
1057
1058         if (!bat_priv->bat_algo_ops->bat_orig_print) {
1059                 seq_puts(seq,
1060                          "No printing function for this routing protocol\n");
1061                 return 0;
1062         }
1063
1064         bat_priv->bat_algo_ops->bat_orig_print(bat_priv, seq,
1065                                                BATADV_IF_DEFAULT);
1066
1067         return 0;
1068 }
1069
1070 /**
1071  * batadv_orig_hardif_seq_print_text - writes originator infos for a specific
1072  *  outgoing interface
1073  * @seq: debugfs table seq_file struct
1074  * @offset: not used
1075  *
1076  * Returns 0
1077  */
1078 int batadv_orig_hardif_seq_print_text(struct seq_file *seq, void *offset)
1079 {
1080         struct net_device *net_dev = (struct net_device *)seq->private;
1081         struct batadv_hard_iface *hard_iface;
1082         struct batadv_priv *bat_priv;
1083
1084         hard_iface = batadv_hardif_get_by_netdev(net_dev);
1085
1086         if (!hard_iface || !hard_iface->soft_iface) {
1087                 seq_puts(seq, "Interface not known to B.A.T.M.A.N.\n");
1088                 goto out;
1089         }
1090
1091         bat_priv = netdev_priv(hard_iface->soft_iface);
1092         if (!bat_priv->bat_algo_ops->bat_orig_print) {
1093                 seq_puts(seq,
1094                          "No printing function for this routing protocol\n");
1095                 goto out;
1096         }
1097
1098         if (hard_iface->if_status != BATADV_IF_ACTIVE) {
1099                 seq_puts(seq, "Interface not active\n");
1100                 goto out;
1101         }
1102
1103         seq_printf(seq, "[B.A.T.M.A.N. adv %s, IF/MAC: %s/%pM (%s %s)]\n",
1104                    BATADV_SOURCE_VERSION, hard_iface->net_dev->name,
1105                    hard_iface->net_dev->dev_addr,
1106                    hard_iface->soft_iface->name, bat_priv->bat_algo_ops->name);
1107
1108         bat_priv->bat_algo_ops->bat_orig_print(bat_priv, seq, hard_iface);
1109
1110 out:
1111         if (hard_iface)
1112                 batadv_hardif_free_ref(hard_iface);
1113         return 0;
1114 }
1115
1116 int batadv_orig_hash_add_if(struct batadv_hard_iface *hard_iface,
1117                             int max_if_num)
1118 {
1119         struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
1120         struct batadv_algo_ops *bao = bat_priv->bat_algo_ops;
1121         struct batadv_hashtable *hash = bat_priv->orig_hash;
1122         struct hlist_head *head;
1123         struct batadv_orig_node *orig_node;
1124         u32 i;
1125         int ret;
1126
1127         /* resize all orig nodes because orig_node->bcast_own(_sum) depend on
1128          * if_num
1129          */
1130         for (i = 0; i < hash->size; i++) {
1131                 head = &hash->table[i];
1132
1133                 rcu_read_lock();
1134                 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
1135                         ret = 0;
1136                         if (bao->bat_orig_add_if)
1137                                 ret = bao->bat_orig_add_if(orig_node,
1138                                                            max_if_num);
1139                         if (ret == -ENOMEM)
1140                                 goto err;
1141                 }
1142                 rcu_read_unlock();
1143         }
1144
1145         return 0;
1146
1147 err:
1148         rcu_read_unlock();
1149         return -ENOMEM;
1150 }
1151
1152 int batadv_orig_hash_del_if(struct batadv_hard_iface *hard_iface,
1153                             int max_if_num)
1154 {
1155         struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
1156         struct batadv_hashtable *hash = bat_priv->orig_hash;
1157         struct hlist_head *head;
1158         struct batadv_hard_iface *hard_iface_tmp;
1159         struct batadv_orig_node *orig_node;
1160         struct batadv_algo_ops *bao = bat_priv->bat_algo_ops;
1161         u32 i;
1162         int ret;
1163
1164         /* resize all orig nodes because orig_node->bcast_own(_sum) depend on
1165          * if_num
1166          */
1167         for (i = 0; i < hash->size; i++) {
1168                 head = &hash->table[i];
1169
1170                 rcu_read_lock();
1171                 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
1172                         ret = 0;
1173                         if (bao->bat_orig_del_if)
1174                                 ret = bao->bat_orig_del_if(orig_node,
1175                                                            max_if_num,
1176                                                            hard_iface->if_num);
1177                         if (ret == -ENOMEM)
1178                                 goto err;
1179                 }
1180                 rcu_read_unlock();
1181         }
1182
1183         /* renumber remaining batman interfaces _inside_ of orig_hash_lock */
1184         rcu_read_lock();
1185         list_for_each_entry_rcu(hard_iface_tmp, &batadv_hardif_list, list) {
1186                 if (hard_iface_tmp->if_status == BATADV_IF_NOT_IN_USE)
1187                         continue;
1188
1189                 if (hard_iface == hard_iface_tmp)
1190                         continue;
1191
1192                 if (hard_iface->soft_iface != hard_iface_tmp->soft_iface)
1193                         continue;
1194
1195                 if (hard_iface_tmp->if_num > hard_iface->if_num)
1196                         hard_iface_tmp->if_num--;
1197         }
1198         rcu_read_unlock();
1199
1200         hard_iface->if_num = -1;
1201         return 0;
1202
1203 err:
1204         rcu_read_unlock();
1205         return -ENOMEM;
1206 }