net/mac80211/mesh_pathtbl.c

   1 /*
   2  * Copyright (c) 2008 open80211s Ltd.
   3  * Author:     Luis Carlos Cobo <luisca@cozybit.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 as
   7  * published by the Free Software Foundation.
   8  */
   9
  10 #include <linux/etherdevice.h>
  11 #include <linux/list.h>
  12 #include <linux/netdevice.h>
  13 #include <linux/random.h>
  14 #include <linux/spinlock.h>
  15 #include <linux/string.h>
  16 #include <net/mac80211.h>
  17 #include "ieee80211_i.h"
  18 #include "mesh.h"
  19
  20 /* There will be initially 2^INIT_PATHS_SIZE_ORDER buckets */
  21 #define INIT_PATHS_SIZE_ORDER   2
  22
  23 /* Keep the mean chain length below this constant */
  24 #define MEAN_CHAIN_LEN          2
  25
  26 #define MPATH_EXPIRED(mpath) ((mpath->flags & MESH_PATH_ACTIVE) && \
  27                                 time_after(jiffies, mpath->exp_time) && \
  28                                 !(mpath->flags & MESH_PATH_FIXED))
  29
  30 struct mpath_node {
  31         struct hlist_node list;
  32         struct rcu_head rcu;
  33         /* This indirection allows two different tables to point to the same
  34          * mesh_path structure, useful when resizing
  35          */
  36         struct mesh_path *mpath;
  37 };
  38
  39 static struct mesh_table *mesh_paths;
  40
  41 /* This lock will have the grow table function as writer and add / delete nodes
  42  * as readers. When reading the table (i.e. doing lookups) we are well protected
  43  * by RCU
  44  */
  45 static DEFINE_RWLOCK(pathtbl_resize_lock);
  46
  47 /**
  48  *
  49  * mesh_path_assign_nexthop - update mesh path next hop
  50  *
  51  * @mpath: mesh path to update
  52  * @sta: next hop to assign
  53  *
  54  * Locking: mpath->state_lock must be held when calling this function
  55  */
  56 void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta)
  57 {
  58         rcu_assign_pointer(mpath->next_hop, sta);
  59 }
  60
  61
  62 /**
  63  * mesh_path_lookup - look up a path in the mesh path table
  64  * @dst: hardware address (ETH_ALEN length) of destination
  65  * @dev: local interface
  66  *
  67  * Returns: pointer to the mesh path structure, or NULL if not found
  68  *
  69  * Locking: must be called within a read rcu section.
  70  */
  71 struct mesh_path *mesh_path_lookup(u8 *dst, struct net_device *dev)
  72 {
  73         struct mesh_path *mpath;
  74         struct hlist_node *n;
  75         struct hlist_head *bucket;
  76         struct mesh_table *tbl;
  77         struct mpath_node *node;
  78
  79         tbl = rcu_dereference(mesh_paths);
  80
  81         bucket = &tbl->hash_buckets[mesh_table_hash(dst, dev, tbl)];
  82         hlist_for_each_entry_rcu(node, n, bucket, list) {
  83                 mpath = node->mpath;
  84                 if (mpath->dev == dev &&
  85                                 memcmp(dst, mpath->dst, ETH_ALEN) == 0) {
  86                         if (MPATH_EXPIRED(mpath)) {
  87                                 spin_lock_bh(&mpath->state_lock);
  88                                 if (MPATH_EXPIRED(mpath))
  89                                         mpath->flags &= ~MESH_PATH_ACTIVE;
  90                                 spin_unlock_bh(&mpath->state_lock);
  91                         }
  92                         return mpath;
  93                 }
  94         }
  95         return NULL;
  96 }
  97
  98 /**
  99  * mesh_path_lookup_by_idx - look up a path in the mesh path table by its index
 100  * @idx: index
 101  * @dev: local interface, or NULL for all entries
 102  *
 103  * Returns: pointer to the mesh path structure, or NULL if not found.
 104  *
 105  * Locking: must be called within a read rcu section.
 106  */
 107 struct mesh_path *mesh_path_lookup_by_idx(int idx, struct net_device *dev)
 108 {
 109         struct mpath_node *node;
 110         struct hlist_node *p;
 111         int i;
 112         int j = 0;
 113
 114         for_each_mesh_entry(mesh_paths, p, node, i) {
 115                 if (dev && node->mpath->dev != dev)
 116                         continue;
 117                 if (j++ == idx) {
 118                         if (MPATH_EXPIRED(node->mpath)) {
 119                                 spin_lock_bh(&node->mpath->state_lock);
 120                                 if (MPATH_EXPIRED(node->mpath))
 121                                         node->mpath->flags &= ~MESH_PATH_ACTIVE;
 122                                 spin_unlock_bh(&node->mpath->state_lock);
 123                         }
 124                         return node->mpath;
 125                 }
 126         }
 127
 128         return NULL;
 129 }
 130
 131 /**
 132  * mesh_path_add - allocate and add a new path to the mesh path table
 133  * @addr: destination address of the path (ETH_ALEN length)
 134  * @dev: local interface
 135  *
 136  * Returns: 0 on sucess
 137  *
 138  * State: the initial state of the new path is set to 0
 139  */
 140 int mesh_path_add(u8 *dst, struct net_device *dev)
 141 {
 142         struct ieee80211_sub_if_data *sdata = IEEE80211_DEV_TO_SUB_IF(dev);
 143         struct mesh_path *mpath, *new_mpath;
 144         struct mpath_node *node, *new_node;
 145         struct hlist_head *bucket;
 146         struct hlist_node *n;
 147         int grow = 0;
 148         int err = 0;
 149         u32 hash_idx;
 150
 151         if (memcmp(dst, dev->dev_addr, ETH_ALEN) == 0)
 152                 /* never add ourselves as neighbours */
 153                 return -ENOTSUPP;
 154
 155         if (is_multicast_ether_addr(dst))
 156                 return -ENOTSUPP;
 157
 158         if (atomic_add_unless(&sdata->u.sta.mpaths, 1, MESH_MAX_MPATHS) == 0)
 159                 return -ENOSPC;
 160
 161         new_mpath = kzalloc(sizeof(struct mesh_path), GFP_KERNEL);
 162         if (!new_mpath) {
 163                 atomic_dec(&sdata->u.sta.mpaths);
 164                 err = -ENOMEM;
 165                 goto endadd2;
 166         }
 167         new_node = kmalloc(sizeof(struct mpath_node), GFP_KERNEL);
 168         if (!new_node) {
 169                 kfree(new_mpath);
 170                 atomic_dec(&sdata->u.sta.mpaths);
 171                 err = -ENOMEM;
 172                 goto endadd2;
 173         }
 174
 175         read_lock(&pathtbl_resize_lock);
 176         memcpy(new_mpath->dst, dst, ETH_ALEN);
 177         new_mpath->dev = dev;
 178         new_mpath->flags = 0;
 179         skb_queue_head_init(&new_mpath->frame_queue);
 180         new_node->mpath = new_mpath;
 181         new_mpath->timer.data = (unsigned long) new_mpath;
 182         new_mpath->timer.function = mesh_path_timer;
 183         new_mpath->exp_time = jiffies;
 184         spin_lock_init(&new_mpath->state_lock);
 185         init_timer(&new_mpath->timer);
 186
 187         hash_idx = mesh_table_hash(dst, dev, mesh_paths);
 188         bucket = &mesh_paths->hash_buckets[hash_idx];
 189
 190         spin_lock(&mesh_paths->hashwlock[hash_idx]);
 191
 192         hlist_for_each_entry(node, n, bucket, list) {
 193                 mpath = node->mpath;
 194                 if (mpath->dev == dev && memcmp(dst, mpath->dst, ETH_ALEN)
 195                                 == 0) {
 196                         err = -EEXIST;
 197                         atomic_dec(&sdata->u.sta.mpaths);
 198                         kfree(new_node);
 199                         kfree(new_mpath);
 200                         goto endadd;
 201                 }
 202         }
 203
 204         hlist_add_head_rcu(&new_node->list, bucket);
 205         if (atomic_inc_return(&mesh_paths->entries) >=
 206                 mesh_paths->mean_chain_len * (mesh_paths->hash_mask + 1))
 207                 grow = 1;
 208
 209 endadd:
 210         spin_unlock(&mesh_paths->hashwlock[hash_idx]);
 211         read_unlock(&pathtbl_resize_lock);
 212         if (!err && grow) {
 213                 struct mesh_table *oldtbl, *newtbl;
 214
 215                 write_lock(&pathtbl_resize_lock);
 216                 oldtbl = mesh_paths;
 217                 newtbl = mesh_table_grow(mesh_paths);
 218                 if (!newtbl) {
 219                         write_unlock(&pathtbl_resize_lock);
 220                         return -ENOMEM;
 221                 }
 222                 rcu_assign_pointer(mesh_paths, newtbl);
 223                 synchronize_rcu();
 224                 mesh_table_free(oldtbl, false);
 225                 write_unlock(&pathtbl_resize_lock);
 226         }
 227 endadd2:
 228         return err;
 229 }
 230
 231
 232 /**
 233  * mesh_plink_broken - deactivates paths and sends perr when a link breaks
 234  *
 235  * @sta: broken peer link
 236  *
 237  * This function must be called from the rate control algorithm if enough
 238  * delivery errors suggest that a peer link is no longer usable.
 239  */
 240 void mesh_plink_broken(struct sta_info *sta)
 241 {
 242         struct mesh_path *mpath;
 243         struct mpath_node *node;
 244         struct hlist_node *p;
 245         struct net_device *dev = sta->sdata->dev;
 246         int i;
 247
 248         rcu_read_lock();
 249         for_each_mesh_entry(mesh_paths, p, node, i) {
 250                 mpath = node->mpath;
 251                 spin_lock_bh(&mpath->state_lock);
 252                 if (mpath->next_hop == sta &&
 253                     mpath->flags & MESH_PATH_ACTIVE &&
 254                     !(mpath->flags & MESH_PATH_FIXED)) {
 255                         mpath->flags &= ~MESH_PATH_ACTIVE;
 256                         ++mpath->dsn;
 257                         spin_unlock_bh(&mpath->state_lock);
 258                         mesh_path_error_tx(mpath->dst,
 259                                         cpu_to_le32(mpath->dsn),
 260                                         dev->broadcast, dev);
 261                 } else
 262                 spin_unlock_bh(&mpath->state_lock);
 263         }
 264         rcu_read_unlock();
 265 }
 266 EXPORT_SYMBOL(mesh_plink_broken);
 267
 268 /**
 269  * mesh_path_flush_by_nexthop - Deletes mesh paths if their next hop matches
 270  *
 271  * @sta - mesh peer to match
 272  *
 273  * RCU notes: this function is called when a mesh plink transitions from
 274  * PLINK_ESTAB to any other state, since PLINK_ESTAB state is the only one that
 275  * allows path creation. This will happen before the sta can be freed (because
 276  * sta_info_destroy() calls this) so any reader in a rcu read block will be
 277  * protected against the plink disappearing.
 278  */
 279 void mesh_path_flush_by_nexthop(struct sta_info *sta)
 280 {
 281         struct mesh_path *mpath;
 282         struct mpath_node *node;
 283         struct hlist_node *p;
 284         int i;
 285
 286         for_each_mesh_entry(mesh_paths, p, node, i) {
 287                 mpath = node->mpath;
 288                 if (mpath->next_hop == sta)
 289                         mesh_path_del(mpath->dst, mpath->dev);
 290         }
 291 }
 292
 293 void mesh_path_flush(struct net_device *dev)
 294 {
 295         struct mesh_path *mpath;
 296         struct mpath_node *node;
 297         struct hlist_node *p;
 298         int i;
 299
 300         for_each_mesh_entry(mesh_paths, p, node, i) {
 301                 mpath = node->mpath;
 302                 if (mpath->dev == dev)
 303                         mesh_path_del(mpath->dst, mpath->dev);
 304         }
 305 }
 306
 307 static void mesh_path_node_reclaim(struct rcu_head *rp)
 308 {
 309         struct mpath_node *node = container_of(rp, struct mpath_node, rcu);
 310         struct ieee80211_sub_if_data *sdata =
 311                 IEEE80211_DEV_TO_SUB_IF(node->mpath->dev);
 312
 313         del_timer_sync(&node->mpath->timer);
 314         atomic_dec(&sdata->u.sta.mpaths);
 315         kfree(node->mpath);
 316         kfree(node);
 317 }
 318
 319 /**
 320  * mesh_path_del - delete a mesh path from the table
 321  *
 322  * @addr: dst address (ETH_ALEN length)
 323  * @dev: local interface
 324  *
 325  * Returns: 0 if succesful
 326  */
 327 int mesh_path_del(u8 *addr, struct net_device *dev)
 328 {
 329         struct mesh_path *mpath;
 330         struct mpath_node *node;
 331         struct hlist_head *bucket;
 332         struct hlist_node *n;
 333         int hash_idx;
 334         int err = 0;
 335
 336         read_lock(&pathtbl_resize_lock);
 337         hash_idx = mesh_table_hash(addr, dev, mesh_paths);
 338         bucket = &mesh_paths->hash_buckets[hash_idx];
 339
 340         spin_lock(&mesh_paths->hashwlock[hash_idx]);
 341         hlist_for_each_entry(node, n, bucket, list) {
 342                 mpath = node->mpath;
 343                 if (mpath->dev == dev &&
 344                                 memcmp(addr, mpath->dst, ETH_ALEN) == 0) {
 345                         spin_lock_bh(&mpath->state_lock);
 346                         mpath->flags |= MESH_PATH_RESOLVING;
 347                         hlist_del_rcu(&node->list);
 348                         call_rcu(&node->rcu, mesh_path_node_reclaim);
 349                         atomic_dec(&mesh_paths->entries);
 350                         spin_unlock_bh(&mpath->state_lock);
 351                         goto enddel;
 352                 }
 353         }
 354
 355         err = -ENXIO;
 356 enddel:
 357         spin_unlock(&mesh_paths->hashwlock[hash_idx]);
 358         read_unlock(&pathtbl_resize_lock);
 359         return err;
 360 }
 361
 362 /**
 363  * mesh_path_tx_pending - sends pending frames in a mesh path queue
 364  *
 365  * @mpath: mesh path to activate
 366  *
 367  * Locking: the state_lock of the mpath structure must NOT be held when calling
 368  * this function.
 369  */
 370 void mesh_path_tx_pending(struct mesh_path *mpath)
 371 {
 372         struct sk_buff *skb;
 373
 374         while ((skb = skb_dequeue(&mpath->frame_queue)) &&
 375                         (mpath->flags & MESH_PATH_ACTIVE))
 376                 dev_queue_xmit(skb);
 377 }
 378
 379 /**
 380  * mesh_path_discard_frame - discard a frame whose path could not be resolved
 381  *
 382  * @skb: frame to discard
 383  * @dev: network device the frame was to be sent through
 384  *
 385  * If the frame was beign forwarded from another MP, a PERR frame will be sent
 386  * to the precursor.
 387  *
 388  * Locking: the function must me called within a rcu_read_lock region
 389  */
 390 void mesh_path_discard_frame(struct sk_buff *skb, struct net_device *dev)
 391 {
 392         struct ieee80211_sub_if_data *sdata = IEEE80211_DEV_TO_SUB_IF(dev);
 393         struct mesh_path *mpath;
 394         u32 dsn = 0;
 395
 396         if (skb->pkt_type == PACKET_OTHERHOST) {
 397                 struct ieee80211s_hdr *prev_meshhdr;
 398                 int mshhdrlen;
 399                 u8 *ra, *da;
 400
 401                 prev_meshhdr = ((struct ieee80211s_hdr *)skb->cb);
 402                 mshhdrlen = ieee80211_get_mesh_hdrlen(prev_meshhdr);
 403                 da = skb->data;
 404                 ra = MESH_PREQ(skb);
 405                 mpath = mesh_path_lookup(da, dev);
 406                 if (mpath)
 407                         dsn = ++mpath->dsn;
 408                 mesh_path_error_tx(skb->data, cpu_to_le32(dsn), ra, dev);
 409         }
 410
 411         kfree_skb(skb);
 412         sdata->u.sta.mshstats.dropped_frames_no_route++;
 413 }
 414
 415 /**
 416  * mesh_path_flush_pending - free the pending queue of a mesh path
 417  *
 418  * @mpath: mesh path whose queue has to be freed
 419  *
 420  * Locking: the function must me called withing a rcu_read_lock region
 421  */
 422 void mesh_path_flush_pending(struct mesh_path *mpath)
 423 {
 424         struct ieee80211_sub_if_data *sdata;
 425         struct sk_buff *skb;
 426
 427         sdata = IEEE80211_DEV_TO_SUB_IF(mpath->dev);
 428
 429         while ((skb = skb_dequeue(&mpath->frame_queue)) &&
 430                         (mpath->flags & MESH_PATH_ACTIVE))
 431                 mesh_path_discard_frame(skb, mpath->dev);
 432 }
 433
 434 /**
 435  * mesh_path_fix_nexthop - force a specific next hop for a mesh path
 436  *
 437  * @mpath: the mesh path to modify
 438  * @next_hop: the next hop to force
 439  *
 440  * Locking: this function must be called holding mpath->state_lock
 441  */
 442 void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop)
 443 {
 444         spin_lock_bh(&mpath->state_lock);
 445         mesh_path_assign_nexthop(mpath, next_hop);
 446         mpath->dsn = 0xffff;
 447         mpath->metric = 0;
 448         mpath->hop_count = 0;
 449         mpath->exp_time = 0;
 450         mpath->flags |= MESH_PATH_FIXED;
 451         mesh_path_activate(mpath);
 452         spin_unlock_bh(&mpath->state_lock);
 453         mesh_path_tx_pending(mpath);
 454 }
 455
 456 static void mesh_path_node_free(struct hlist_node *p, bool free_leafs)
 457 {
 458         struct mesh_path *mpath;
 459         struct mpath_node *node = hlist_entry(p, struct mpath_node, list);
 460         mpath = node->mpath;
 461         hlist_del_rcu(p);
 462         synchronize_rcu();
 463         if (free_leafs)
 464                 kfree(mpath);
 465         kfree(node);
 466 }
 467
 468 static void mesh_path_node_copy(struct hlist_node *p, struct mesh_table *newtbl)
 469 {
 470         struct mesh_path *mpath;
 471         struct mpath_node *node, *new_node;
 472         u32 hash_idx;
 473
 474         node = hlist_entry(p, struct mpath_node, list);
 475         mpath = node->mpath;
 476         new_node = kmalloc(sizeof(struct mpath_node), GFP_KERNEL);
 477         new_node->mpath = mpath;
 478         hash_idx = mesh_table_hash(mpath->dst, mpath->dev, newtbl);
 479         hlist_add_head(&new_node->list,
 480                         &newtbl->hash_buckets[hash_idx]);
 481 }
 482
 483 int mesh_pathtbl_init(void)
 484 {
 485         mesh_paths = mesh_table_alloc(INIT_PATHS_SIZE_ORDER);
 486         mesh_paths->free_node = &mesh_path_node_free;
 487         mesh_paths->copy_node = &mesh_path_node_copy;
 488         mesh_paths->mean_chain_len = MEAN_CHAIN_LEN;
 489         if (!mesh_paths)
 490                 return -ENOMEM;
 491         return 0;
 492 }
 493
 494 void mesh_path_expire(struct net_device *dev)
 495 {
 496         struct mesh_path *mpath;
 497         struct mpath_node *node;
 498         struct hlist_node *p;
 499         int i;
 500
 501         read_lock(&pathtbl_resize_lock);
 502         for_each_mesh_entry(mesh_paths, p, node, i) {
 503                 if (node->mpath->dev != dev)
 504                         continue;
 505                 mpath = node->mpath;
 506                 spin_lock_bh(&mpath->state_lock);
 507                 if ((!(mpath->flags & MESH_PATH_RESOLVING)) &&
 508                     (!(mpath->flags & MESH_PATH_FIXED)) &&
 509                         time_after(jiffies,
 510                          mpath->exp_time + MESH_PATH_EXPIRE)) {
 511                         spin_unlock_bh(&mpath->state_lock);
 512                         mesh_path_del(mpath->dst, mpath->dev);
 513                 } else
 514                         spin_unlock_bh(&mpath->state_lock);
 515         }
 516         read_unlock(&pathtbl_resize_lock);
 517 }
 518
 519 void mesh_pathtbl_unregister(void)
 520 {
 521         mesh_table_free(mesh_paths, true);
 522 }