git.oblomov.eu Git - linux-2.6/blob - 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->sta.addr)];
  77         if (!s)
  78                 return -ENOENT;
  79         if (s == sta) {
  80                 rcu_assign_pointer(local->sta_hash[STA_HASH(sta->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 struct sta_info *sta_info_get(struct ieee80211_local *local, const u8 *addr)
  97 {
  98         struct sta_info *sta;
  99
 100         sta = rcu_dereference(local->sta_hash[STA_HASH(addr)]);
 101         while (sta) {
 102                 if (memcmp(sta->sta.addr, addr, ETH_ALEN) == 0)
 103                         break;
 104                 sta = rcu_dereference(sta->hnext);
 105         }
 106         return sta;
 107 }
 108
 109 struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
 110                                      struct net_device *dev)
 111 {
 112         struct sta_info *sta;
 113         int i = 0;
 114
 115         list_for_each_entry_rcu(sta, &local->sta_list, list) {
 116                 if (dev && dev != sta->sdata->dev)
 117                         continue;
 118                 if (i < idx) {
 119                         ++i;
 120                         continue;
 121                 }
 122                 return sta;
 123         }
 124
 125         return NULL;
 126 }
 127
 128 /**
 129  * __sta_info_free - internal STA free helper
 130  *
 131  * @local: pointer to the global information
 132  * @sta: STA info to free
 133  *
 134  * This function must undo everything done by sta_info_alloc()
 135  * that may happen before sta_info_insert().
 136  */
 137 static void __sta_info_free(struct ieee80211_local *local,
 138                             struct sta_info *sta)
 139 {
 140         rate_control_free_sta(sta);
 141         rate_control_put(sta->rate_ctrl);
 142
 143 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 144         printk(KERN_DEBUG "%s: Destroyed STA %pM\n",
 145                wiphy_name(local->hw.wiphy), sta->sta.addr);
 146 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 147
 148         kfree(sta);
 149 }
 150
 151 void sta_info_destroy(struct sta_info *sta)
 152 {
 153         struct ieee80211_local *local;
 154         struct sk_buff *skb;
 155         int i;
 156
 157         might_sleep();
 158
 159         if (!sta)
 160                 return;
 161
 162         local = sta->local;
 163
 164         rate_control_remove_sta_debugfs(sta);
 165         ieee80211_sta_debugfs_remove(sta);
 166
 167 #ifdef CONFIG_MAC80211_MESH
 168         if (ieee80211_vif_is_mesh(&sta->sdata->vif))
 169                 mesh_plink_deactivate(sta);
 170 #endif
 171
 172         /*
 173          * We have only unlinked the key, and actually destroying it
 174          * may mean it is removed from hardware which requires that
 175          * the key->sta pointer is still valid, so flush the key todo
 176          * list here.
 177          *
 178          * ieee80211_key_todo() will synchronize_rcu() so after this
 179          * nothing can reference this sta struct any more.
 180          */
 181         ieee80211_key_todo();
 182
 183 #ifdef CONFIG_MAC80211_MESH
 184         if (ieee80211_vif_is_mesh(&sta->sdata->vif))
 185                 del_timer_sync(&sta->plink_timer);
 186 #endif
 187
 188         while ((skb = skb_dequeue(&sta->ps_tx_buf)) != NULL) {
 189                 local->total_ps_buffered--;
 190                 dev_kfree_skb_any(skb);
 191         }
 192
 193         while ((skb = skb_dequeue(&sta->tx_filtered)) != NULL)
 194                 dev_kfree_skb_any(skb);
 195
 196         for (i = 0; i <  STA_TID_NUM; i++) {
 197                 struct tid_ampdu_rx *tid_rx;
 198                 struct tid_ampdu_tx *tid_tx;
 199
 200                 spin_lock_bh(&sta->lock);
 201                 tid_rx = sta->ampdu_mlme.tid_rx[i];
 202                 /* Make sure timer won't free the tid_rx struct, see below */
 203                 if (tid_rx)
 204                         tid_rx->shutdown = true;
 205                 spin_unlock_bh(&sta->lock);
 206
 207                 /*
 208                  * Outside spinlock - shutdown is true now so that the timer
 209                  * won't free tid_rx, we have to do that now. Can't let the
 210                  * timer do it because we have to sync the timer outside the
 211                  * lock that it takes itself.
 212                  */
 213                 if (tid_rx) {
 214                         del_timer_sync(&tid_rx->session_timer);
 215                         kfree(tid_rx);
 216                 }
 217
 218                 /*
 219                  * No need to do such complications for TX agg sessions, the
 220                  * path leading to freeing the tid_tx struct goes via a call
 221                  * from the driver, and thus needs to look up the sta struct
 222                  * again, which cannot be found when we get here. Hence, we
 223                  * just need to delete the timer and free the aggregation
 224                  * info; we won't be telling the peer about it then but that
 225                  * doesn't matter if we're not talking to it again anyway.
 226                  */
 227                 tid_tx = sta->ampdu_mlme.tid_tx[i];
 228                 if (tid_tx) {
 229                         del_timer_sync(&tid_tx->addba_resp_timer);
 230                         kfree(tid_tx);
 231                 }
 232         }
 233
 234         __sta_info_free(local, sta);
 235 }
 236
 237
 238 /* Caller must hold local->sta_lock */
 239 static void sta_info_hash_add(struct ieee80211_local *local,
 240                               struct sta_info *sta)
 241 {
 242         sta->hnext = local->sta_hash[STA_HASH(sta->sta.addr)];
 243         rcu_assign_pointer(local->sta_hash[STA_HASH(sta->sta.addr)], sta);
 244 }
 245
 246 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
 247                                 u8 *addr, gfp_t gfp)
 248 {
 249         struct ieee80211_local *local = sdata->local;
 250         struct sta_info *sta;
 251         int i;
 252
 253         sta = kzalloc(sizeof(*sta) + local->hw.sta_data_size, gfp);
 254         if (!sta)
 255                 return NULL;
 256
 257         spin_lock_init(&sta->lock);
 258         spin_lock_init(&sta->flaglock);
 259
 260         memcpy(sta->sta.addr, addr, ETH_ALEN);
 261         sta->local = local;
 262         sta->sdata = sdata;
 263
 264         sta->rate_ctrl = rate_control_get(local->rate_ctrl);
 265         sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
 266                                                      &sta->sta, gfp);
 267         if (!sta->rate_ctrl_priv) {
 268                 rate_control_put(sta->rate_ctrl);
 269                 kfree(sta);
 270                 return NULL;
 271         }
 272
 273         for (i = 0; i < STA_TID_NUM; i++) {
 274                 /* timer_to_tid must be initialized with identity mapping to
 275                  * enable session_timer's data differentiation. refer to
 276                  * sta_rx_agg_session_timer_expired for useage */
 277                 sta->timer_to_tid[i] = i;
 278                 /* tid to tx queue: initialize according to HW (0 is valid) */
 279                 sta->tid_to_tx_q[i] = ieee80211_num_queues(&local->hw);
 280                 /* rx */
 281                 sta->ampdu_mlme.tid_state_rx[i] = HT_AGG_STATE_IDLE;
 282                 sta->ampdu_mlme.tid_rx[i] = NULL;
 283                 /* tx */
 284                 sta->ampdu_mlme.tid_state_tx[i] = HT_AGG_STATE_IDLE;
 285                 sta->ampdu_mlme.tid_tx[i] = NULL;
 286                 sta->ampdu_mlme.addba_req_num[i] = 0;
 287         }
 288         skb_queue_head_init(&sta->ps_tx_buf);
 289         skb_queue_head_init(&sta->tx_filtered);
 290
 291 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 292         printk(KERN_DEBUG "%s: Allocated STA %pM\n",
 293                wiphy_name(local->hw.wiphy), sta->sta.addr);
 294 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 295
 296 #ifdef CONFIG_MAC80211_MESH
 297         sta->plink_state = PLINK_LISTEN;
 298         init_timer(&sta->plink_timer);
 299 #endif
 300
 301         return sta;
 302 }
 303
 304 int sta_info_insert(struct sta_info *sta)
 305 {
 306         struct ieee80211_local *local = sta->local;
 307         struct ieee80211_sub_if_data *sdata = sta->sdata;
 308         unsigned long flags;
 309         int err = 0;
 310
 311         /*
 312          * Can't be a WARN_ON because it can be triggered through a race:
 313          * something inserts a STA (on one CPU) without holding the RTNL
 314          * and another CPU turns off the net device.
 315          */
 316         if (unlikely(!netif_running(sdata->dev))) {
 317                 err = -ENETDOWN;
 318                 goto out_free;
 319         }
 320
 321         if (WARN_ON(compare_ether_addr(sta->sta.addr, sdata->dev->dev_addr) == 0 ||
 322                     is_multicast_ether_addr(sta->sta.addr))) {
 323                 err = -EINVAL;
 324                 goto out_free;
 325         }
 326
 327         spin_lock_irqsave(&local->sta_lock, flags);
 328         /* check if STA exists already */
 329         if (sta_info_get(local, sta->sta.addr)) {
 330                 spin_unlock_irqrestore(&local->sta_lock, flags);
 331                 err = -EEXIST;
 332                 goto out_free;
 333         }
 334         list_add(&sta->list, &local->sta_list);
 335         local->num_sta++;
 336         sta_info_hash_add(local, sta);
 337
 338         /* notify driver */
 339         if (local->ops->sta_notify) {
 340                 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
 341                         sdata = container_of(sdata->bss,
 342                                              struct ieee80211_sub_if_data,
 343                                              u.ap);
 344
 345                 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
 346                                        STA_NOTIFY_ADD, &sta->sta);
 347         }
 348
 349 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 350         printk(KERN_DEBUG "%s: Inserted STA %pM\n",
 351                wiphy_name(local->hw.wiphy), sta->sta.addr);
 352 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 353
 354         spin_unlock_irqrestore(&local->sta_lock, flags);
 355
 356 #ifdef CONFIG_MAC80211_DEBUGFS
 357         /*
 358          * Debugfs entry adding might sleep, so schedule process
 359          * context task for adding entry for STAs that do not yet
 360          * have one.
 361          * NOTE: due to auto-freeing semantics this may only be done
 362          *       if the insertion is successful!
 363          */
 364         schedule_work(&local->sta_debugfs_add);
 365 #endif
 366
 367         if (ieee80211_vif_is_mesh(&sdata->vif))
 368                 mesh_accept_plinks_update(sdata);
 369
 370         return 0;
 371  out_free:
 372         BUG_ON(!err);
 373         __sta_info_free(local, sta);
 374         return err;
 375 }
 376
 377 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
 378 {
 379         /*
 380          * This format has been mandated by the IEEE specifications,
 381          * so this line may not be changed to use the __set_bit() format.
 382          */
 383         bss->tim[aid / 8] |= (1 << (aid % 8));
 384 }
 385
 386 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
 387 {
 388         /*
 389          * This format has been mandated by the IEEE specifications,
 390          * so this line may not be changed to use the __clear_bit() format.
 391          */
 392         bss->tim[aid / 8] &= ~(1 << (aid % 8));
 393 }
 394
 395 static void __sta_info_set_tim_bit(struct ieee80211_if_ap *bss,
 396                                    struct sta_info *sta)
 397 {
 398         BUG_ON(!bss);
 399
 400         __bss_tim_set(bss, sta->sta.aid);
 401
 402         if (sta->local->ops->set_tim) {
 403                 sta->local->tim_in_locked_section = true;
 404                 sta->local->ops->set_tim(local_to_hw(sta->local),
 405                                          &sta->sta, true);
 406                 sta->local->tim_in_locked_section = false;
 407         }
 408 }
 409
 410 void sta_info_set_tim_bit(struct sta_info *sta)
 411 {
 412         unsigned long flags;
 413
 414         BUG_ON(!sta->sdata->bss);
 415
 416         spin_lock_irqsave(&sta->local->sta_lock, flags);
 417         __sta_info_set_tim_bit(sta->sdata->bss, sta);
 418         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
 419 }
 420
 421 static void __sta_info_clear_tim_bit(struct ieee80211_if_ap *bss,
 422                                      struct sta_info *sta)
 423 {
 424         BUG_ON(!bss);
 425
 426         __bss_tim_clear(bss, sta->sta.aid);
 427
 428         if (sta->local->ops->set_tim) {
 429                 sta->local->tim_in_locked_section = true;
 430                 sta->local->ops->set_tim(local_to_hw(sta->local),
 431                                          &sta->sta, false);
 432                 sta->local->tim_in_locked_section = false;
 433         }
 434 }
 435
 436 void sta_info_clear_tim_bit(struct sta_info *sta)
 437 {
 438         unsigned long flags;
 439
 440         BUG_ON(!sta->sdata->bss);
 441
 442         spin_lock_irqsave(&sta->local->sta_lock, flags);
 443         __sta_info_clear_tim_bit(sta->sdata->bss, sta);
 444         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
 445 }
 446
 447 static void __sta_info_unlink(struct sta_info **sta)
 448 {
 449         struct ieee80211_local *local = (*sta)->local;
 450         struct ieee80211_sub_if_data *sdata = (*sta)->sdata;
 451         /*
 452          * pull caller's reference if we're already gone.
 453          */
 454         if (sta_info_hash_del(local, *sta)) {
 455                 *sta = NULL;
 456                 return;
 457         }
 458
 459         if ((*sta)->key) {
 460                 ieee80211_key_free((*sta)->key);
 461                 WARN_ON((*sta)->key);
 462         }
 463
 464         list_del(&(*sta)->list);
 465
 466         if (test_and_clear_sta_flags(*sta, WLAN_STA_PS)) {
 467                 BUG_ON(!sdata->bss);
 468
 469                 atomic_dec(&sdata->bss->num_sta_ps);
 470                 __sta_info_clear_tim_bit(sdata->bss, *sta);
 471         }
 472
 473         local->num_sta--;
 474
 475         if (local->ops->sta_notify) {
 476                 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
 477                         sdata = container_of(sdata->bss,
 478                                              struct ieee80211_sub_if_data,
 479                                              u.ap);
 480
 481                 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
 482                                        STA_NOTIFY_REMOVE, &(*sta)->sta);
 483         }
 484
 485         if (ieee80211_vif_is_mesh(&sdata->vif)) {
 486                 mesh_accept_plinks_update(sdata);
 487 #ifdef CONFIG_MAC80211_MESH
 488                 del_timer(&(*sta)->plink_timer);
 489 #endif
 490         }
 491
 492 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 493         printk(KERN_DEBUG "%s: Removed STA %pM\n",
 494                wiphy_name(local->hw.wiphy), (*sta)->sta.addr);
 495 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 496
 497         /*
 498          * Finally, pull caller's reference if the STA is pinned by the
 499          * task that is adding the debugfs entries. In that case, we
 500          * leave the STA "to be freed".
 501          *
 502          * The rules are not trivial, but not too complex either:
 503          *  (1) pin_status is only modified under the sta_lock
 504          *  (2) STAs may only be pinned under the RTNL so that
 505          *      sta_info_flush() is guaranteed to actually destroy
 506          *      all STAs that are active for a given interface, this
 507          *      is required for correctness because otherwise we
 508          *      could notify a driver that an interface is going
 509          *      away and only after that (!) notify it about a STA
 510          *      on that interface going away.
 511          *  (3) sta_info_debugfs_add_work() will set the status
 512          *      to PINNED when it found an item that needs a new
 513          *      debugfs directory created. In that case, that item
 514          *      must not be freed although all *RCU* users are done
 515          *      with it. Hence, we tell the caller of _unlink()
 516          *      that the item is already gone (as can happen when
 517          *      two tasks try to unlink/destroy at the same time)
 518          *  (4) We set the pin_status to DESTROY here when we
 519          *      find such an item.
 520          *  (5) sta_info_debugfs_add_work() will reset the pin_status
 521          *      from PINNED to NORMAL when it is done with the item,
 522          *      but will check for DESTROY before resetting it in
 523          *      which case it will free the item.
 524          */
 525         if ((*sta)->pin_status == STA_INFO_PIN_STAT_PINNED) {
 526                 (*sta)->pin_status = STA_INFO_PIN_STAT_DESTROY;
 527                 *sta = NULL;
 528                 return;
 529         }
 530 }
 531
 532 void sta_info_unlink(struct sta_info **sta)
 533 {
 534         struct ieee80211_local *local = (*sta)->local;
 535         unsigned long flags;
 536
 537         spin_lock_irqsave(&local->sta_lock, flags);
 538         __sta_info_unlink(sta);
 539         spin_unlock_irqrestore(&local->sta_lock, flags);
 540 }
 541
 542 static inline int sta_info_buffer_expired(struct ieee80211_local *local,
 543                                           struct sta_info *sta,
 544                                           struct sk_buff *skb)
 545 {
 546         struct ieee80211_tx_info *info;
 547         int timeout;
 548
 549         if (!skb)
 550                 return 0;
 551
 552         info = IEEE80211_SKB_CB(skb);
 553
 554         /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
 555         timeout = (sta->listen_interval * local->hw.conf.beacon_int * 32 /
 556                    15625) * HZ;
 557         if (timeout < STA_TX_BUFFER_EXPIRE)
 558                 timeout = STA_TX_BUFFER_EXPIRE;
 559         return time_after(jiffies, info->control.jiffies + timeout);
 560 }
 561
 562
 563 static void sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
 564                                              struct sta_info *sta)
 565 {
 566         unsigned long flags;
 567         struct sk_buff *skb;
 568         struct ieee80211_sub_if_data *sdata;
 569
 570         if (skb_queue_empty(&sta->ps_tx_buf))
 571                 return;
 572
 573         for (;;) {
 574                 spin_lock_irqsave(&sta->ps_tx_buf.lock, flags);
 575                 skb = skb_peek(&sta->ps_tx_buf);
 576                 if (sta_info_buffer_expired(local, sta, skb))
 577                         skb = __skb_dequeue(&sta->ps_tx_buf);
 578                 else
 579                         skb = NULL;
 580                 spin_unlock_irqrestore(&sta->ps_tx_buf.lock, flags);
 581
 582                 if (!skb)
 583                         break;
 584
 585                 sdata = sta->sdata;
 586                 local->total_ps_buffered--;
 587 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
 588                 printk(KERN_DEBUG "Buffered frame expired (STA %pM)\n",
 589                        sta->sta.addr);
 590 #endif
 591                 dev_kfree_skb(skb);
 592
 593                 if (skb_queue_empty(&sta->ps_tx_buf))
 594                         sta_info_clear_tim_bit(sta);
 595         }
 596 }
 597
 598
 599 static void sta_info_cleanup(unsigned long data)
 600 {
 601         struct ieee80211_local *local = (struct ieee80211_local *) data;
 602         struct sta_info *sta;
 603
 604         rcu_read_lock();
 605         list_for_each_entry_rcu(sta, &local->sta_list, list)
 606                 sta_info_cleanup_expire_buffered(local, sta);
 607         rcu_read_unlock();
 608
 609         local->sta_cleanup.expires =
 610                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
 611         add_timer(&local->sta_cleanup);
 612 }
 613
 614 #ifdef CONFIG_MAC80211_DEBUGFS
 615 /*
 616  * See comment in __sta_info_unlink,
 617  * caller must hold local->sta_lock.
 618  */
 619 static void __sta_info_pin(struct sta_info *sta)
 620 {
 621         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_NORMAL);
 622         sta->pin_status = STA_INFO_PIN_STAT_PINNED;
 623 }
 624
 625 /*
 626  * See comment in __sta_info_unlink, returns sta if it
 627  * needs to be destroyed.
 628  */
 629 static struct sta_info *__sta_info_unpin(struct sta_info *sta)
 630 {
 631         struct sta_info *ret = NULL;
 632         unsigned long flags;
 633
 634         spin_lock_irqsave(&sta->local->sta_lock, flags);
 635         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_DESTROY &&
 636                 sta->pin_status != STA_INFO_PIN_STAT_PINNED);
 637         if (sta->pin_status == STA_INFO_PIN_STAT_DESTROY)
 638                 ret = sta;
 639         sta->pin_status = STA_INFO_PIN_STAT_NORMAL;
 640         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
 641
 642         return ret;
 643 }
 644
 645 static void sta_info_debugfs_add_work(struct work_struct *work)
 646 {
 647         struct ieee80211_local *local =
 648                 container_of(work, struct ieee80211_local, sta_debugfs_add);
 649         struct sta_info *sta, *tmp;
 650         unsigned long flags;
 651
 652         /* We need to keep the RTNL across the whole pinned status. */
 653         rtnl_lock();
 654         while (1) {
 655                 sta = NULL;
 656
 657                 spin_lock_irqsave(&local->sta_lock, flags);
 658                 list_for_each_entry(tmp, &local->sta_list, list) {
 659                         /*
 660                          * debugfs.add_has_run will be set by
 661                          * ieee80211_sta_debugfs_add regardless
 662                          * of what else it does.
 663                          */
 664                         if (!tmp->debugfs.add_has_run) {
 665                                 sta = tmp;
 666                                 __sta_info_pin(sta);
 667                                 break;
 668                         }
 669                 }
 670                 spin_unlock_irqrestore(&local->sta_lock, flags);
 671
 672                 if (!sta)
 673                         break;
 674
 675                 ieee80211_sta_debugfs_add(sta);
 676                 rate_control_add_sta_debugfs(sta);
 677
 678                 sta = __sta_info_unpin(sta);
 679                 sta_info_destroy(sta);
 680         }
 681         rtnl_unlock();
 682 }
 683 #endif
 684
 685 static void __ieee80211_run_pending_flush(struct ieee80211_local *local)
 686 {
 687         struct sta_info *sta;
 688         unsigned long flags;
 689
 690         ASSERT_RTNL();
 691
 692         spin_lock_irqsave(&local->sta_lock, flags);
 693         while (!list_empty(&local->sta_flush_list)) {
 694                 sta = list_first_entry(&local->sta_flush_list,
 695                                        struct sta_info, list);
 696                 list_del(&sta->list);
 697                 spin_unlock_irqrestore(&local->sta_lock, flags);
 698                 sta_info_destroy(sta);
 699                 spin_lock_irqsave(&local->sta_lock, flags);
 700         }
 701         spin_unlock_irqrestore(&local->sta_lock, flags);
 702 }
 703
 704 static void ieee80211_sta_flush_work(struct work_struct *work)
 705 {
 706         struct ieee80211_local *local =
 707                 container_of(work, struct ieee80211_local, sta_flush_work);
 708
 709         rtnl_lock();
 710         __ieee80211_run_pending_flush(local);
 711         rtnl_unlock();
 712 }
 713
 714 void sta_info_init(struct ieee80211_local *local)
 715 {
 716         spin_lock_init(&local->sta_lock);
 717         INIT_LIST_HEAD(&local->sta_list);
 718         INIT_LIST_HEAD(&local->sta_flush_list);
 719         INIT_WORK(&local->sta_flush_work, ieee80211_sta_flush_work);
 720
 721         setup_timer(&local->sta_cleanup, sta_info_cleanup,
 722                     (unsigned long)local);
 723         local->sta_cleanup.expires =
 724                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
 725
 726 #ifdef CONFIG_MAC80211_DEBUGFS
 727         INIT_WORK(&local->sta_debugfs_add, sta_info_debugfs_add_work);
 728 #endif
 729 }
 730
 731 int sta_info_start(struct ieee80211_local *local)
 732 {
 733         add_timer(&local->sta_cleanup);
 734         return 0;
 735 }
 736
 737 void sta_info_stop(struct ieee80211_local *local)
 738 {
 739         del_timer(&local->sta_cleanup);
 740         cancel_work_sync(&local->sta_flush_work);
 741 #ifdef CONFIG_MAC80211_DEBUGFS
 742         /*
 743          * Make sure the debugfs adding work isn't pending after this
 744          * because we're about to be destroyed. It doesn't matter
 745          * whether it ran or not since we're going to flush all STAs
 746          * anyway.
 747          */
 748         cancel_work_sync(&local->sta_debugfs_add);
 749 #endif
 750
 751         rtnl_lock();
 752         sta_info_flush(local, NULL);
 753         __ieee80211_run_pending_flush(local);
 754         rtnl_unlock();
 755 }
 756
 757 /**
 758  * sta_info_flush - flush matching STA entries from the STA table
 759  *
 760  * Returns the number of removed STA entries.
 761  *
 762  * @local: local interface data
 763  * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
 764  */
 765 int sta_info_flush(struct ieee80211_local *local,
 766                     struct ieee80211_sub_if_data *sdata)
 767 {
 768         struct sta_info *sta, *tmp;
 769         LIST_HEAD(tmp_list);
 770         int ret = 0;
 771         unsigned long flags;
 772
 773         might_sleep();
 774         ASSERT_RTNL();
 775
 776         spin_lock_irqsave(&local->sta_lock, flags);
 777         list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
 778                 if (!sdata || sdata == sta->sdata) {
 779                         __sta_info_unlink(&sta);
 780                         if (sta) {
 781                                 list_add_tail(&sta->list, &tmp_list);
 782                                 ret++;
 783                         }
 784                 }
 785         }
 786         spin_unlock_irqrestore(&local->sta_lock, flags);
 787
 788         list_for_each_entry_safe(sta, tmp, &tmp_list, list)
 789                 sta_info_destroy(sta);
 790
 791         return ret;
 792 }
 793
 794 /**
 795  * sta_info_flush_delayed - flush matching STA entries from the STA table
 796  *
 797  * This function unlinks all stations for a given interface and queues
 798  * them for freeing. Note that the workqueue function scheduled here has
 799  * to run before any new keys can be added to the system to avoid set_key()
 800  * callback ordering issues.
 801  *
 802  * @sdata: the interface
 803  */
 804 void sta_info_flush_delayed(struct ieee80211_sub_if_data *sdata)
 805 {
 806         struct ieee80211_local *local = sdata->local;
 807         struct sta_info *sta, *tmp;
 808         unsigned long flags;
 809         bool work = false;
 810
 811         spin_lock_irqsave(&local->sta_lock, flags);
 812         list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
 813                 if (sdata == sta->sdata) {
 814                         __sta_info_unlink(&sta);
 815                         if (sta) {
 816                                 list_add_tail(&sta->list,
 817                                               &local->sta_flush_list);
 818                                 work = true;
 819                         }
 820                 }
 821         }
 822         if (work)
 823                 schedule_work(&local->sta_flush_work);
 824         spin_unlock_irqrestore(&local->sta_lock, flags);
 825 }
 826
 827 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
 828                           unsigned long exp_time)
 829 {
 830         struct ieee80211_local *local = sdata->local;
 831         struct sta_info *sta, *tmp;
 832         LIST_HEAD(tmp_list);
 833         unsigned long flags;
 834
 835         spin_lock_irqsave(&local->sta_lock, flags);
 836         list_for_each_entry_safe(sta, tmp, &local->sta_list, list)
 837                 if (time_after(jiffies, sta->last_rx + exp_time)) {
 838 #ifdef CONFIG_MAC80211_IBSS_DEBUG
 839                         printk(KERN_DEBUG "%s: expiring inactive STA %pM\n",
 840                                sdata->dev->name, sta->sta.addr);
 841 #endif
 842                         __sta_info_unlink(&sta);
 843                         if (sta)
 844                                 list_add(&sta->list, &tmp_list);
 845                 }
 846         spin_unlock_irqrestore(&local->sta_lock, flags);
 847
 848         list_for_each_entry_safe(sta, tmp, &tmp_list, list)
 849                 sta_info_destroy(sta);
 850 }
 851
 852 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
 853                                          const u8 *addr)
 854 {
 855         struct sta_info *sta = sta_info_get(hw_to_local(hw), addr);
 856
 857         if (!sta)
 858                 return NULL;
 859         return &sta->sta;
 860 }
 861 EXPORT_SYMBOL(ieee80211_find_sta);