net/mac80211/sta_info.c

   1 /*
   2  * Copyright 2002-2005, Instant802 Networks, Inc.
   3  * Copyright 2006-2007  Jiri Benc <jbenc@suse.cz>
   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/module.h>
  11 #include <linux/init.h>
  12 #include <linux/netdevice.h>
  13 #include <linux/types.h>
  14 #include <linux/slab.h>
  15 #include <linux/skbuff.h>
  16 #include <linux/if_arp.h>
  17 #include <linux/timer.h>
  18 #include <linux/rtnetlink.h>
  19
  20 #include <net/mac80211.h>
  21 #include "ieee80211_i.h"
  22 #include "rate.h"
  23 #include "sta_info.h"
  24 #include "debugfs_sta.h"
  25 #include "mesh.h"
  26
  27 /**
  28  * DOC: STA information lifetime rules
  29  *
  30  * STA info structures (&struct sta_info) are managed in a hash table
  31  * for faster lookup and a list for iteration. They are managed using
  32  * RCU, i.e. access to the list and hash table is protected by RCU.
  33  *
  34  * Upon allocating a STA info structure with sta_info_alloc(), the caller owns
  35  * that structure. It must then either destroy it using sta_info_destroy()
  36  * (which is pretty useless) or insert it into the hash table using
  37  * sta_info_insert() which demotes the reference from ownership to a regular
  38  * RCU-protected reference; if the function is called without protection by an
  39  * RCU critical section the reference is instantly invalidated. Note that the
  40  * caller may not do much with the STA info before inserting it, in particular,
  41  * it may not start any mesh peer link management or add encryption keys.
  42  *
  43  * When the insertion fails (sta_info_insert()) returns non-zero), the
  44  * structure will have been freed by sta_info_insert()!
  45  *
  46  * Because there are debugfs entries for each station, and adding those
  47  * must be able to sleep, it is also possible to "pin" a station entry,
  48  * that means it can be removed from the hash table but not be freed.
  49  * See the comment in __sta_info_unlink() for more information, this is
  50  * an internal capability only.
  51  *
  52  * In order to remove a STA info structure, the caller needs to first
  53  * unlink it (sta_info_unlink()) from the list and hash tables and
  54  * then destroy it; sta_info_destroy() will wait for an RCU grace period
  55  * to elapse before actually freeing it. Due to the pinning and the
  56  * possibility of multiple callers trying to remove the same STA info at
  57  * the same time, sta_info_unlink() can clear the STA info pointer it is
  58  * passed to indicate that the STA info is owned by somebody else now.
  59  *
  60  * If sta_info_unlink() did not clear the pointer then the caller owns
  61  * the STA info structure now and is responsible of destroying it with
  62  * a call to sta_info_destroy().
  63  *
  64  * In all other cases, there is no concept of ownership on a STA entry,
  65  * each structure is owned by the global hash table/list until it is
  66  * removed. All users of the structure need to be RCU protected so that
  67  * the structure won't be freed before they are done using it.
  68  */
  69
  70 /* Caller must hold local->sta_lock */
  71 static int sta_info_hash_del(struct ieee80211_local *local,
  72                              struct sta_info *sta)
  73 {
  74         struct sta_info *s;
  75
  76         s = local->sta_hash[STA_HASH(sta->addr)];
  77         if (!s)
  78                 return -ENOENT;
  79         if (s == sta) {
  80                 rcu_assign_pointer(local->sta_hash[STA_HASH(sta->addr)],
  81                                    s->hnext);
  82                 return 0;
  83         }
  84
  85         while (s->hnext && s->hnext != sta)
  86                 s = s->hnext;
  87         if (s->hnext) {
  88                 rcu_assign_pointer(s->hnext, sta->hnext);
  89                 return 0;
  90         }
  91
  92         return -ENOENT;
  93 }
  94
  95 /* protected by RCU */
  96 static struct sta_info *__sta_info_find(struct ieee80211_local *local,
  97                                         u8 *addr)
  98 {
  99         struct sta_info *sta;
 100
 101         sta = rcu_dereference(local->sta_hash[STA_HASH(addr)]);
 102         while (sta) {
 103                 if (compare_ether_addr(sta->addr, addr) == 0)
 104                         break;
 105                 sta = rcu_dereference(sta->hnext);
 106         }
 107         return sta;
 108 }
 109
 110 struct sta_info *sta_info_get(struct ieee80211_local *local, u8 *addr)
 111 {
 112         return __sta_info_find(local, addr);
 113 }
 114 EXPORT_SYMBOL(sta_info_get);
 115
 116 struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
 117                                      struct net_device *dev)
 118 {
 119         struct sta_info *sta;
 120         int i = 0;
 121
 122         list_for_each_entry_rcu(sta, &local->sta_list, list) {
 123                 if (dev && dev != sta->sdata->dev)
 124                         continue;
 125                 if (i < idx) {
 126                         ++i;
 127                         continue;
 128                 }
 129                 return sta;
 130         }
 131
 132         return NULL;
 133 }
 134
 135 /**
 136  * __sta_info_free - internal STA free helper
 137  *
 138  * @local: pointer to the global information
 139  * @sta: STA info to free
 140  *
 141  * This function must undo everything done by sta_info_alloc()
 142  * that may happen before sta_info_insert().
 143  */
 144 static void __sta_info_free(struct ieee80211_local *local,
 145                             struct sta_info *sta)
 146 {
 147         DECLARE_MAC_BUF(mbuf);
 148
 149         rate_control_free_sta(sta->rate_ctrl, sta->rate_ctrl_priv);
 150         rate_control_put(sta->rate_ctrl);
 151
 152 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 153         printk(KERN_DEBUG "%s: Destroyed STA %s\n",
 154                wiphy_name(local->hw.wiphy), print_mac(mbuf, sta->addr));
 155 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 156
 157         kfree(sta);
 158 }
 159
 160 void sta_info_destroy(struct sta_info *sta)
 161 {
 162         struct ieee80211_local *local;
 163         struct sk_buff *skb;
 164         int i;
 165
 166         might_sleep();
 167
 168         if (!sta)
 169                 return;
 170
 171         local = sta->local;
 172
 173         rate_control_remove_sta_debugfs(sta);
 174         ieee80211_sta_debugfs_remove(sta);
 175
 176 #ifdef CONFIG_MAC80211_MESH
 177         if (ieee80211_vif_is_mesh(&sta->sdata->vif))
 178                 mesh_plink_deactivate(sta);
 179 #endif
 180
 181         /*
 182          * We have only unlinked the key, and actually destroying it
 183          * may mean it is removed from hardware which requires that
 184          * the key->sta pointer is still valid, so flush the key todo
 185          * list here.
 186          *
 187          * ieee80211_key_todo() will synchronize_rcu() so after this
 188          * nothing can reference this sta struct any more.
 189          */
 190         ieee80211_key_todo();
 191
 192 #ifdef CONFIG_MAC80211_MESH
 193         if (ieee80211_vif_is_mesh(&sta->sdata->vif))
 194                 del_timer_sync(&sta->plink_timer);
 195 #endif
 196
 197         while ((skb = skb_dequeue(&sta->ps_tx_buf)) != NULL) {
 198                 local->total_ps_buffered--;
 199                 dev_kfree_skb_any(skb);
 200         }
 201
 202         while ((skb = skb_dequeue(&sta->tx_filtered)) != NULL)
 203                 dev_kfree_skb_any(skb);
 204
 205         for (i = 0; i <  STA_TID_NUM; i++) {
 206                 spin_lock_bh(&sta->lock);
 207                 if (sta->ampdu_mlme.tid_rx[i])
 208                   del_timer_sync(&sta->ampdu_mlme.tid_rx[i]->session_timer);
 209                 if (sta->ampdu_mlme.tid_tx[i])
 210                   del_timer_sync(&sta->ampdu_mlme.tid_tx[i]->addba_resp_timer);
 211                 spin_unlock_bh(&sta->lock);
 212         }
 213
 214         __sta_info_free(local, sta);
 215 }
 216
 217
 218 /* Caller must hold local->sta_lock */
 219 static void sta_info_hash_add(struct ieee80211_local *local,
 220                               struct sta_info *sta)
 221 {
 222         sta->hnext = local->sta_hash[STA_HASH(sta->addr)];
 223         rcu_assign_pointer(local->sta_hash[STA_HASH(sta->addr)], sta);
 224 }
 225
 226 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
 227                                 u8 *addr, gfp_t gfp)
 228 {
 229         struct ieee80211_local *local = sdata->local;
 230         struct sta_info *sta;
 231         int i;
 232         DECLARE_MAC_BUF(mbuf);
 233
 234         sta = kzalloc(sizeof(*sta), gfp);
 235         if (!sta)
 236                 return NULL;
 237
 238         spin_lock_init(&sta->lock);
 239         spin_lock_init(&sta->flaglock);
 240
 241         memcpy(sta->addr, addr, ETH_ALEN);
 242         sta->local = local;
 243         sta->sdata = sdata;
 244
 245         sta->rate_ctrl = rate_control_get(local->rate_ctrl);
 246         sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
 247                                                      gfp);
 248         if (!sta->rate_ctrl_priv) {
 249                 rate_control_put(sta->rate_ctrl);
 250                 kfree(sta);
 251                 return NULL;
 252         }
 253
 254         for (i = 0; i < STA_TID_NUM; i++) {
 255                 /* timer_to_tid must be initialized with identity mapping to
 256                  * enable session_timer's data differentiation. refer to
 257                  * sta_rx_agg_session_timer_expired for useage */
 258                 sta->timer_to_tid[i] = i;
 259                 /* tid to tx queue: initialize according to HW (0 is valid) */
 260                 sta->tid_to_tx_q[i] = ieee80211_num_queues(&local->hw);
 261                 /* rx */
 262                 sta->ampdu_mlme.tid_state_rx[i] = HT_AGG_STATE_IDLE;
 263                 sta->ampdu_mlme.tid_rx[i] = NULL;
 264                 /* tx */
 265                 sta->ampdu_mlme.tid_state_tx[i] = HT_AGG_STATE_IDLE;
 266                 sta->ampdu_mlme.tid_tx[i] = NULL;
 267                 sta->ampdu_mlme.addba_req_num[i] = 0;
 268         }
 269         skb_queue_head_init(&sta->ps_tx_buf);
 270         skb_queue_head_init(&sta->tx_filtered);
 271
 272 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 273         printk(KERN_DEBUG "%s: Allocated STA %s\n",
 274                wiphy_name(local->hw.wiphy), print_mac(mbuf, sta->addr));
 275 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 276
 277 #ifdef CONFIG_MAC80211_MESH
 278         sta->plink_state = PLINK_LISTEN;
 279         init_timer(&sta->plink_timer);
 280 #endif
 281
 282         return sta;
 283 }
 284
 285 int sta_info_insert(struct sta_info *sta)
 286 {
 287         struct ieee80211_local *local = sta->local;
 288         struct ieee80211_sub_if_data *sdata = sta->sdata;
 289         unsigned long flags;
 290         int err = 0;
 291         DECLARE_MAC_BUF(mac);
 292
 293         /*
 294          * Can't be a WARN_ON because it can be triggered through a race:
 295          * something inserts a STA (on one CPU) without holding the RTNL
 296          * and another CPU turns off the net device.
 297          */
 298         if (unlikely(!netif_running(sdata->dev))) {
 299                 err = -ENETDOWN;
 300                 goto out_free;
 301         }
 302
 303         if (WARN_ON(compare_ether_addr(sta->addr, sdata->dev->dev_addr) == 0 ||
 304                     is_multicast_ether_addr(sta->addr))) {
 305                 err = -EINVAL;
 306                 goto out_free;
 307         }
 308
 309         spin_lock_irqsave(&local->sta_lock, flags);
 310         /* check if STA exists already */
 311         if (__sta_info_find(local, sta->addr)) {
 312                 spin_unlock_irqrestore(&local->sta_lock, flags);
 313                 err = -EEXIST;
 314                 goto out_free;
 315         }
 316         list_add(&sta->list, &local->sta_list);
 317         local->num_sta++;
 318         sta_info_hash_add(local, sta);
 319
 320         /* notify driver */
 321         if (local->ops->sta_notify) {
 322                 if (sdata->vif.type == IEEE80211_IF_TYPE_VLAN)
 323                         sdata = container_of(sdata->bss,
 324                                              struct ieee80211_sub_if_data,
 325                                              u.ap);
 326
 327                 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
 328                                        STA_NOTIFY_ADD, sta->addr);
 329         }
 330
 331 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 332         printk(KERN_DEBUG "%s: Inserted STA %s\n",
 333                wiphy_name(local->hw.wiphy), print_mac(mac, sta->addr));
 334 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 335
 336         spin_unlock_irqrestore(&local->sta_lock, flags);
 337
 338 #ifdef CONFIG_MAC80211_DEBUGFS
 339         /*
 340          * Debugfs entry adding might sleep, so schedule process
 341          * context task for adding entry for STAs that do not yet
 342          * have one.
 343          * NOTE: due to auto-freeing semantics this may only be done
 344          *       if the insertion is successful!
 345          */
 346         schedule_work(&local->sta_debugfs_add);
 347 #endif
 348
 349         if (ieee80211_vif_is_mesh(&sdata->vif))
 350                 mesh_accept_plinks_update(sdata);
 351
 352         return 0;
 353  out_free:
 354         BUG_ON(!err);
 355         __sta_info_free(local, sta);
 356         return err;
 357 }
 358
 359 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
 360 {
 361         /*
 362          * This format has been mandated by the IEEE specifications,
 363          * so this line may not be changed to use the __set_bit() format.
 364          */
 365         bss->tim[aid / 8] |= (1 << (aid % 8));
 366 }
 367
 368 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
 369 {
 370         /*
 371          * This format has been mandated by the IEEE specifications,
 372          * so this line may not be changed to use the __clear_bit() format.
 373          */
 374         bss->tim[aid / 8] &= ~(1 << (aid % 8));
 375 }
 376
 377 static void __sta_info_set_tim_bit(struct ieee80211_if_ap *bss,
 378                                    struct sta_info *sta)
 379 {
 380         BUG_ON(!bss);
 381
 382         __bss_tim_set(bss, sta->aid);
 383
 384         if (sta->local->ops->set_tim) {
 385                 sta->local->tim_in_locked_section = true;
 386                 sta->local->ops->set_tim(local_to_hw(sta->local), sta->aid, 1);
 387                 sta->local->tim_in_locked_section = false;
 388         }
 389 }
 390
 391 void sta_info_set_tim_bit(struct sta_info *sta)
 392 {
 393         unsigned long flags;
 394
 395         BUG_ON(!sta->sdata->bss);
 396
 397         spin_lock_irqsave(&sta->local->sta_lock, flags);
 398         __sta_info_set_tim_bit(sta->sdata->bss, sta);
 399         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
 400 }
 401
 402 static void __sta_info_clear_tim_bit(struct ieee80211_if_ap *bss,
 403                                      struct sta_info *sta)
 404 {
 405         BUG_ON(!bss);
 406
 407         __bss_tim_clear(bss, sta->aid);
 408
 409         if (sta->local->ops->set_tim) {
 410                 sta->local->tim_in_locked_section = true;
 411                 sta->local->ops->set_tim(local_to_hw(sta->local), sta->aid, 0);
 412                 sta->local->tim_in_locked_section = false;
 413         }
 414 }
 415
 416 void sta_info_clear_tim_bit(struct sta_info *sta)
 417 {
 418         unsigned long flags;
 419
 420         BUG_ON(!sta->sdata->bss);
 421
 422         spin_lock_irqsave(&sta->local->sta_lock, flags);
 423         __sta_info_clear_tim_bit(sta->sdata->bss, sta);
 424         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
 425 }
 426
 427 void __sta_info_unlink(struct sta_info **sta)
 428 {
 429         struct ieee80211_local *local = (*sta)->local;
 430         struct ieee80211_sub_if_data *sdata = (*sta)->sdata;
 431 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 432         DECLARE_MAC_BUF(mbuf);
 433 #endif
 434         /*
 435          * pull caller's reference if we're already gone.
 436          */
 437         if (sta_info_hash_del(local, *sta)) {
 438                 *sta = NULL;
 439                 return;
 440         }
 441
 442         if ((*sta)->key) {
 443                 ieee80211_key_free((*sta)->key);
 444                 WARN_ON((*sta)->key);
 445         }
 446
 447         list_del(&(*sta)->list);
 448
 449         if (test_and_clear_sta_flags(*sta, WLAN_STA_PS)) {
 450                 BUG_ON(!sdata->bss);
 451
 452                 atomic_dec(&sdata->bss->num_sta_ps);
 453                 __sta_info_clear_tim_bit(sdata->bss, *sta);
 454         }
 455
 456         local->num_sta--;
 457
 458         if (local->ops->sta_notify) {
 459                 if (sdata->vif.type == IEEE80211_IF_TYPE_VLAN)
 460                         sdata = container_of(sdata->bss,
 461                                              struct ieee80211_sub_if_data,
 462                                              u.ap);
 463
 464                 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
 465                                        STA_NOTIFY_REMOVE, (*sta)->addr);
 466         }
 467
 468         if (ieee80211_vif_is_mesh(&sdata->vif)) {
 469                 mesh_accept_plinks_update(sdata);
 470 #ifdef CONFIG_MAC80211_MESH
 471                 del_timer(&(*sta)->plink_timer);
 472 #endif
 473         }
 474
 475 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 476         printk(KERN_DEBUG "%s: Removed STA %s\n",
 477                wiphy_name(local->hw.wiphy), print_mac(mbuf, (*sta)->addr));
 478 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 479
 480         /*
 481          * Finally, pull caller's reference if the STA is pinned by the
 482          * task that is adding the debugfs entries. In that case, we
 483          * leave the STA "to be freed".
 484          *
 485          * The rules are not trivial, but not too complex either:
 486          *  (1) pin_status is only modified under the sta_lock
 487          *  (2) STAs may only be pinned under the RTNL so that
 488          *      sta_info_flush() is guaranteed to actually destroy
 489          *      all STAs that are active for a given interface, this
 490          *      is required for correctness because otherwise we
 491          *      could notify a driver that an interface is going
 492          *      away and only after that (!) notify it about a STA
 493          *      on that interface going away.
 494          *  (3) sta_info_debugfs_add_work() will set the status
 495          *      to PINNED when it found an item that needs a new
 496          *      debugfs directory created. In that case, that item
 497          *      must not be freed although all *RCU* users are done
 498          *      with it. Hence, we tell the caller of _unlink()
 499          *      that the item is already gone (as can happen when
 500          *      two tasks try to unlink/destroy at the same time)
 501          *  (4) We set the pin_status to DESTROY here when we
 502          *      find such an item.
 503          *  (5) sta_info_debugfs_add_work() will reset the pin_status
 504          *      from PINNED to NORMAL when it is done with the item,
 505          *      but will check for DESTROY before resetting it in
 506          *      which case it will free the item.
 507          */
 508         if ((*sta)->pin_status == STA_INFO_PIN_STAT_PINNED) {
 509                 (*sta)->pin_status = STA_INFO_PIN_STAT_DESTROY;
 510                 *sta = NULL;
 511                 return;
 512         }
 513 }
 514
 515 void sta_info_unlink(struct sta_info **sta)
 516 {
 517         struct ieee80211_local *local = (*sta)->local;
 518         unsigned long flags;
 519
 520         spin_lock_irqsave(&local->sta_lock, flags);
 521         __sta_info_unlink(sta);
 522         spin_unlock_irqrestore(&local->sta_lock, flags);
 523 }
 524
 525 static inline int sta_info_buffer_expired(struct ieee80211_local *local,
 526                                           struct sta_info *sta,
 527                                           struct sk_buff *skb)
 528 {
 529         struct ieee80211_tx_info *info;
 530         int timeout;
 531
 532         if (!skb)
 533                 return 0;
 534
 535         info = IEEE80211_SKB_CB(skb);
 536
 537         /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
 538         timeout = (sta->listen_interval * local->hw.conf.beacon_int * 32 /
 539                    15625) * HZ;
 540         if (timeout < STA_TX_BUFFER_EXPIRE)
 541                 timeout = STA_TX_BUFFER_EXPIRE;
 542         return time_after(jiffies, info->control.jiffies + timeout);
 543 }
 544
 545
 546 static void sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
 547                                              struct sta_info *sta)
 548 {
 549         unsigned long flags;
 550         struct sk_buff *skb;
 551         struct ieee80211_sub_if_data *sdata;
 552         DECLARE_MAC_BUF(mac);
 553
 554         if (skb_queue_empty(&sta->ps_tx_buf))
 555                 return;
 556
 557         for (;;) {
 558                 spin_lock_irqsave(&sta->ps_tx_buf.lock, flags);
 559                 skb = skb_peek(&sta->ps_tx_buf);
 560                 if (sta_info_buffer_expired(local, sta, skb))
 561                         skb = __skb_dequeue(&sta->ps_tx_buf);
 562                 else
 563                         skb = NULL;
 564                 spin_unlock_irqrestore(&sta->ps_tx_buf.lock, flags);
 565
 566                 if (!skb)
 567                         break;
 568
 569                 sdata = sta->sdata;
 570                 local->total_ps_buffered--;
 571 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
 572                 printk(KERN_DEBUG "Buffered frame expired (STA "
 573                        "%s)\n", print_mac(mac, sta->addr));
 574 #endif
 575                 dev_kfree_skb(skb);
 576
 577                 if (skb_queue_empty(&sta->ps_tx_buf))
 578                         sta_info_clear_tim_bit(sta);
 579         }
 580 }
 581
 582
 583 static void sta_info_cleanup(unsigned long data)
 584 {
 585         struct ieee80211_local *local = (struct ieee80211_local *) data;
 586         struct sta_info *sta;
 587
 588         rcu_read_lock();
 589         list_for_each_entry_rcu(sta, &local->sta_list, list)
 590                 sta_info_cleanup_expire_buffered(local, sta);
 591         rcu_read_unlock();
 592
 593         local->sta_cleanup.expires =
 594                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
 595         add_timer(&local->sta_cleanup);
 596 }
 597
 598 #ifdef CONFIG_MAC80211_DEBUGFS
 599 /*
 600  * See comment in __sta_info_unlink,
 601  * caller must hold local->sta_lock.
 602  */
 603 static void __sta_info_pin(struct sta_info *sta)
 604 {
 605         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_NORMAL);
 606         sta->pin_status = STA_INFO_PIN_STAT_PINNED;
 607 }
 608
 609 /*
 610  * See comment in __sta_info_unlink, returns sta if it
 611  * needs to be destroyed.
 612  */
 613 static struct sta_info *__sta_info_unpin(struct sta_info *sta)
 614 {
 615         struct sta_info *ret = NULL;
 616         unsigned long flags;
 617
 618         spin_lock_irqsave(&sta->local->sta_lock, flags);
 619         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_DESTROY &&
 620                 sta->pin_status != STA_INFO_PIN_STAT_PINNED);
 621         if (sta->pin_status == STA_INFO_PIN_STAT_DESTROY)
 622                 ret = sta;
 623         sta->pin_status = STA_INFO_PIN_STAT_NORMAL;
 624         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
 625
 626         return ret;
 627 }
 628
 629 static void sta_info_debugfs_add_work(struct work_struct *work)
 630 {
 631         struct ieee80211_local *local =
 632                 container_of(work, struct ieee80211_local, sta_debugfs_add);
 633         struct sta_info *sta, *tmp;
 634         unsigned long flags;
 635
 636         /* We need to keep the RTNL across the whole pinned status. */
 637         rtnl_lock();
 638         while (1) {
 639                 sta = NULL;
 640
 641                 spin_lock_irqsave(&local->sta_lock, flags);
 642                 list_for_each_entry(tmp, &local->sta_list, list) {
 643                         if (!tmp->debugfs.dir) {
 644                                 sta = tmp;
 645                                 __sta_info_pin(sta);
 646                                 break;
 647                         }
 648                 }
 649                 spin_unlock_irqrestore(&local->sta_lock, flags);
 650
 651                 if (!sta)
 652                         break;
 653
 654                 ieee80211_sta_debugfs_add(sta);
 655                 rate_control_add_sta_debugfs(sta);
 656
 657                 sta = __sta_info_unpin(sta);
 658                 sta_info_destroy(sta);
 659         }
 660         rtnl_unlock();
 661 }
 662 #endif
 663
 664 static void __ieee80211_run_pending_flush(struct ieee80211_local *local)
 665 {
 666         struct sta_info *sta;
 667         unsigned long flags;
 668
 669         ASSERT_RTNL();
 670
 671         spin_lock_irqsave(&local->sta_lock, flags);
 672         while (!list_empty(&local->sta_flush_list)) {
 673                 sta = list_first_entry(&local->sta_flush_list,
 674                                        struct sta_info, list);
 675                 list_del(&sta->list);
 676                 spin_unlock_irqrestore(&local->sta_lock, flags);
 677                 sta_info_destroy(sta);
 678                 spin_lock_irqsave(&local->sta_lock, flags);
 679         }
 680         spin_unlock_irqrestore(&local->sta_lock, flags);
 681 }
 682
 683 static void ieee80211_sta_flush_work(struct work_struct *work)
 684 {
 685         struct ieee80211_local *local =
 686                 container_of(work, struct ieee80211_local, sta_flush_work);
 687
 688         rtnl_lock();
 689         __ieee80211_run_pending_flush(local);
 690         rtnl_unlock();
 691 }
 692
 693 void sta_info_init(struct ieee80211_local *local)
 694 {
 695         spin_lock_init(&local->sta_lock);
 696         INIT_LIST_HEAD(&local->sta_list);
 697         INIT_LIST_HEAD(&local->sta_flush_list);
 698         INIT_WORK(&local->sta_flush_work, ieee80211_sta_flush_work);
 699
 700         setup_timer(&local->sta_cleanup, sta_info_cleanup,
 701                     (unsigned long)local);
 702         local->sta_cleanup.expires =
 703                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
 704
 705 #ifdef CONFIG_MAC80211_DEBUGFS
 706         INIT_WORK(&local->sta_debugfs_add, sta_info_debugfs_add_work);
 707 #endif
 708 }
 709
 710 int sta_info_start(struct ieee80211_local *local)
 711 {
 712         add_timer(&local->sta_cleanup);
 713         return 0;
 714 }
 715
 716 void sta_info_stop(struct ieee80211_local *local)
 717 {
 718         del_timer(&local->sta_cleanup);
 719         cancel_work_sync(&local->sta_flush_work);
 720 #ifdef CONFIG_MAC80211_DEBUGFS
 721         /*
 722          * Make sure the debugfs adding work isn't pending after this
 723          * because we're about to be destroyed. It doesn't matter
 724          * whether it ran or not since we're going to flush all STAs
 725          * anyway.
 726          */
 727         cancel_work_sync(&local->sta_debugfs_add);
 728 #endif
 729
 730         rtnl_lock();
 731         sta_info_flush(local, NULL);
 732         __ieee80211_run_pending_flush(local);
 733         rtnl_unlock();
 734 }
 735
 736 /**
 737  * sta_info_flush - flush matching STA entries from the STA table
 738  *
 739  * Returns the number of removed STA entries.
 740  *
 741  * @local: local interface data
 742  * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
 743  */
 744 int sta_info_flush(struct ieee80211_local *local,
 745                     struct ieee80211_sub_if_data *sdata)
 746 {
 747         struct sta_info *sta, *tmp;
 748         LIST_HEAD(tmp_list);
 749         int ret = 0;
 750         unsigned long flags;
 751
 752         might_sleep();
 753         ASSERT_RTNL();
 754
 755         spin_lock_irqsave(&local->sta_lock, flags);
 756         list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
 757                 if (!sdata || sdata == sta->sdata) {
 758                         __sta_info_unlink(&sta);
 759                         if (sta) {
 760                                 list_add_tail(&sta->list, &tmp_list);
 761                                 ret++;
 762                         }
 763                 }
 764         }
 765         spin_unlock_irqrestore(&local->sta_lock, flags);
 766
 767         list_for_each_entry_safe(sta, tmp, &tmp_list, list)
 768                 sta_info_destroy(sta);
 769
 770         return ret;
 771 }
 772
 773 /**
 774  * sta_info_flush_delayed - flush matching STA entries from the STA table
 775  *
 776  * This function unlinks all stations for a given interface and queues
 777  * them for freeing. Note that the workqueue function scheduled here has
 778  * to run before any new keys can be added to the system to avoid set_key()
 779  * callback ordering issues.
 780  *
 781  * @sdata: the interface
 782  */
 783 void sta_info_flush_delayed(struct ieee80211_sub_if_data *sdata)
 784 {
 785         struct ieee80211_local *local = sdata->local;
 786         struct sta_info *sta, *tmp;
 787         unsigned long flags;
 788         bool work = false;
 789
 790         spin_lock_irqsave(&local->sta_lock, flags);
 791         list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
 792                 if (sdata == sta->sdata) {
 793                         __sta_info_unlink(&sta);
 794                         if (sta) {
 795                                 list_add_tail(&sta->list,
 796                                               &local->sta_flush_list);
 797                                 work = true;
 798                         }
 799                 }
 800         }
 801         if (work)
 802                 schedule_work(&local->sta_flush_work);
 803         spin_unlock_irqrestore(&local->sta_lock, flags);
 804 }