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         DECLARE_MAC_BUF(mbuf);
 141
 142         rate_control_free_sta(sta);
 143         rate_control_put(sta->rate_ctrl);
 144
 145 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 146         printk(KERN_DEBUG "%s: Destroyed STA %s\n",
 147                wiphy_name(local->hw.wiphy), print_mac(mbuf, sta->sta.addr));
 148 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 149
 150         kfree(sta);
 151 }
 152
 153 void sta_info_destroy(struct sta_info *sta)
 154 {
 155         struct ieee80211_local *local;
 156         struct sk_buff *skb;
 157         int i;
 158
 159         might_sleep();
 160
 161         if (!sta)
 162                 return;
 163
 164         local = sta->local;
 165
 166         rate_control_remove_sta_debugfs(sta);
 167         ieee80211_sta_debugfs_remove(sta);
 168
 169 #ifdef CONFIG_MAC80211_MESH
 170         if (ieee80211_vif_is_mesh(&sta->sdata->vif))
 171                 mesh_plink_deactivate(sta);
 172 #endif
 173
 174         /*
 175          * We have only unlinked the key, and actually destroying it
 176          * may mean it is removed from hardware which requires that
 177          * the key->sta pointer is still valid, so flush the key todo
 178          * list here.
 179          *
 180          * ieee80211_key_todo() will synchronize_rcu() so after this
 181          * nothing can reference this sta struct any more.
 182          */
 183         ieee80211_key_todo();
 184
 185 #ifdef CONFIG_MAC80211_MESH
 186         if (ieee80211_vif_is_mesh(&sta->sdata->vif))
 187                 del_timer_sync(&sta->plink_timer);
 188 #endif
 189
 190         while ((skb = skb_dequeue(&sta->ps_tx_buf)) != NULL) {
 191                 local->total_ps_buffered--;
 192                 dev_kfree_skb_any(skb);
 193         }
 194
 195         while ((skb = skb_dequeue(&sta->tx_filtered)) != NULL)
 196                 dev_kfree_skb_any(skb);
 197
 198         for (i = 0; i <  STA_TID_NUM; i++) {
 199                 spin_lock_bh(&sta->lock);
 200                 if (sta->ampdu_mlme.tid_rx[i])
 201                   del_timer_sync(&sta->ampdu_mlme.tid_rx[i]->session_timer);
 202                 if (sta->ampdu_mlme.tid_tx[i])
 203                   del_timer_sync(&sta->ampdu_mlme.tid_tx[i]->addba_resp_timer);
 204                 spin_unlock_bh(&sta->lock);
 205         }
 206
 207         __sta_info_free(local, sta);
 208 }
 209
 210
 211 /* Caller must hold local->sta_lock */
 212 static void sta_info_hash_add(struct ieee80211_local *local,
 213                               struct sta_info *sta)
 214 {
 215         sta->hnext = local->sta_hash[STA_HASH(sta->sta.addr)];
 216         rcu_assign_pointer(local->sta_hash[STA_HASH(sta->sta.addr)], sta);
 217 }
 218
 219 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
 220                                 u8 *addr, gfp_t gfp)
 221 {
 222         struct ieee80211_local *local = sdata->local;
 223         struct sta_info *sta;
 224         int i;
 225         DECLARE_MAC_BUF(mbuf);
 226
 227         sta = kzalloc(sizeof(*sta) + local->hw.sta_data_size, gfp);
 228         if (!sta)
 229                 return NULL;
 230
 231         spin_lock_init(&sta->lock);
 232         spin_lock_init(&sta->flaglock);
 233
 234         memcpy(sta->sta.addr, addr, ETH_ALEN);
 235         sta->local = local;
 236         sta->sdata = sdata;
 237
 238         sta->rate_ctrl = rate_control_get(local->rate_ctrl);
 239         sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
 240                                                      &sta->sta, gfp);
 241         if (!sta->rate_ctrl_priv) {
 242                 rate_control_put(sta->rate_ctrl);
 243                 kfree(sta);
 244                 return NULL;
 245         }
 246
 247         for (i = 0; i < STA_TID_NUM; i++) {
 248                 /* timer_to_tid must be initialized with identity mapping to
 249                  * enable session_timer's data differentiation. refer to
 250                  * sta_rx_agg_session_timer_expired for useage */
 251                 sta->timer_to_tid[i] = i;
 252                 /* tid to tx queue: initialize according to HW (0 is valid) */
 253                 sta->tid_to_tx_q[i] = ieee80211_num_queues(&local->hw);
 254                 /* rx */
 255                 sta->ampdu_mlme.tid_state_rx[i] = HT_AGG_STATE_IDLE;
 256                 sta->ampdu_mlme.tid_rx[i] = NULL;
 257                 /* tx */
 258                 sta->ampdu_mlme.tid_state_tx[i] = HT_AGG_STATE_IDLE;
 259                 sta->ampdu_mlme.tid_tx[i] = NULL;
 260                 sta->ampdu_mlme.addba_req_num[i] = 0;
 261         }
 262         skb_queue_head_init(&sta->ps_tx_buf);
 263         skb_queue_head_init(&sta->tx_filtered);
 264
 265 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 266         printk(KERN_DEBUG "%s: Allocated STA %s\n",
 267                wiphy_name(local->hw.wiphy), print_mac(mbuf, sta->sta.addr));
 268 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 269
 270 #ifdef CONFIG_MAC80211_MESH
 271         sta->plink_state = PLINK_LISTEN;
 272         init_timer(&sta->plink_timer);
 273 #endif
 274
 275         return sta;
 276 }
 277
 278 int sta_info_insert(struct sta_info *sta)
 279 {
 280         struct ieee80211_local *local = sta->local;
 281         struct ieee80211_sub_if_data *sdata = sta->sdata;
 282         unsigned long flags;
 283         int err = 0;
 284         DECLARE_MAC_BUF(mac);
 285
 286         /*
 287          * Can't be a WARN_ON because it can be triggered through a race:
 288          * something inserts a STA (on one CPU) without holding the RTNL
 289          * and another CPU turns off the net device.
 290          */
 291         if (unlikely(!netif_running(sdata->dev))) {
 292                 err = -ENETDOWN;
 293                 goto out_free;
 294         }
 295
 296         if (WARN_ON(compare_ether_addr(sta->sta.addr, sdata->dev->dev_addr) == 0 ||
 297                     is_multicast_ether_addr(sta->sta.addr))) {
 298                 err = -EINVAL;
 299                 goto out_free;
 300         }
 301
 302         spin_lock_irqsave(&local->sta_lock, flags);
 303         /* check if STA exists already */
 304         if (sta_info_get(local, sta->sta.addr)) {
 305                 spin_unlock_irqrestore(&local->sta_lock, flags);
 306                 err = -EEXIST;
 307                 goto out_free;
 308         }
 309         list_add(&sta->list, &local->sta_list);
 310         local->num_sta++;
 311         sta_info_hash_add(local, sta);
 312
 313         /* notify driver */
 314         if (local->ops->sta_notify) {
 315                 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
 316                         sdata = container_of(sdata->bss,
 317                                              struct ieee80211_sub_if_data,
 318                                              u.ap);
 319
 320                 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
 321                                        STA_NOTIFY_ADD, &sta->sta);
 322         }
 323
 324 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 325         printk(KERN_DEBUG "%s: Inserted STA %s\n",
 326                wiphy_name(local->hw.wiphy), print_mac(mac, sta->sta.addr));
 327 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 328
 329         spin_unlock_irqrestore(&local->sta_lock, flags);
 330
 331 #ifdef CONFIG_MAC80211_DEBUGFS
 332         /*
 333          * Debugfs entry adding might sleep, so schedule process
 334          * context task for adding entry for STAs that do not yet
 335          * have one.
 336          * NOTE: due to auto-freeing semantics this may only be done
 337          *       if the insertion is successful!
 338          */
 339         schedule_work(&local->sta_debugfs_add);
 340 #endif
 341
 342         if (ieee80211_vif_is_mesh(&sdata->vif))
 343                 mesh_accept_plinks_update(sdata);
 344
 345         return 0;
 346  out_free:
 347         BUG_ON(!err);
 348         __sta_info_free(local, sta);
 349         return err;
 350 }
 351
 352 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
 353 {
 354         /*
 355          * This format has been mandated by the IEEE specifications,
 356          * so this line may not be changed to use the __set_bit() format.
 357          */
 358         bss->tim[aid / 8] |= (1 << (aid % 8));
 359 }
 360
 361 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
 362 {
 363         /*
 364          * This format has been mandated by the IEEE specifications,
 365          * so this line may not be changed to use the __clear_bit() format.
 366          */
 367         bss->tim[aid / 8] &= ~(1 << (aid % 8));
 368 }
 369
 370 static void __sta_info_set_tim_bit(struct ieee80211_if_ap *bss,
 371                                    struct sta_info *sta)
 372 {
 373         BUG_ON(!bss);
 374
 375         __bss_tim_set(bss, sta->sta.aid);
 376
 377         if (sta->local->ops->set_tim) {
 378                 sta->local->tim_in_locked_section = true;
 379                 sta->local->ops->set_tim(local_to_hw(sta->local),
 380                                          &sta->sta, true);
 381                 sta->local->tim_in_locked_section = false;
 382         }
 383 }
 384
 385 void sta_info_set_tim_bit(struct sta_info *sta)
 386 {
 387         unsigned long flags;
 388
 389         BUG_ON(!sta->sdata->bss);
 390
 391         spin_lock_irqsave(&sta->local->sta_lock, flags);
 392         __sta_info_set_tim_bit(sta->sdata->bss, sta);
 393         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
 394 }
 395
 396 static void __sta_info_clear_tim_bit(struct ieee80211_if_ap *bss,
 397                                      struct sta_info *sta)
 398 {
 399         BUG_ON(!bss);
 400
 401         __bss_tim_clear(bss, sta->sta.aid);
 402
 403         if (sta->local->ops->set_tim) {
 404                 sta->local->tim_in_locked_section = true;
 405                 sta->local->ops->set_tim(local_to_hw(sta->local),
 406                                          &sta->sta, false);
 407                 sta->local->tim_in_locked_section = false;
 408         }
 409 }
 410
 411 void sta_info_clear_tim_bit(struct sta_info *sta)
 412 {
 413         unsigned long flags;
 414
 415         BUG_ON(!sta->sdata->bss);
 416
 417         spin_lock_irqsave(&sta->local->sta_lock, flags);
 418         __sta_info_clear_tim_bit(sta->sdata->bss, sta);
 419         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
 420 }
 421
 422 static void __sta_info_unlink(struct sta_info **sta)
 423 {
 424         struct ieee80211_local *local = (*sta)->local;
 425         struct ieee80211_sub_if_data *sdata = (*sta)->sdata;
 426 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 427         DECLARE_MAC_BUF(mbuf);
 428 #endif
 429         /*
 430          * pull caller's reference if we're already gone.
 431          */
 432         if (sta_info_hash_del(local, *sta)) {
 433                 *sta = NULL;
 434                 return;
 435         }
 436
 437         if ((*sta)->key) {
 438                 ieee80211_key_free((*sta)->key);
 439                 WARN_ON((*sta)->key);
 440         }
 441
 442         list_del(&(*sta)->list);
 443
 444         if (test_and_clear_sta_flags(*sta, WLAN_STA_PS)) {
 445                 BUG_ON(!sdata->bss);
 446
 447                 atomic_dec(&sdata->bss->num_sta_ps);
 448                 __sta_info_clear_tim_bit(sdata->bss, *sta);
 449         }
 450
 451         local->num_sta--;
 452
 453         if (local->ops->sta_notify) {
 454                 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
 455                         sdata = container_of(sdata->bss,
 456                                              struct ieee80211_sub_if_data,
 457                                              u.ap);
 458
 459                 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
 460                                        STA_NOTIFY_REMOVE, &(*sta)->sta);
 461         }
 462
 463         if (ieee80211_vif_is_mesh(&sdata->vif)) {
 464                 mesh_accept_plinks_update(sdata);
 465 #ifdef CONFIG_MAC80211_MESH
 466                 del_timer(&(*sta)->plink_timer);
 467 #endif
 468         }
 469
 470 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 471         printk(KERN_DEBUG "%s: Removed STA %s\n",
 472                wiphy_name(local->hw.wiphy), print_mac(mbuf, (*sta)->sta.addr));
 473 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 474
 475         /*
 476          * Finally, pull caller's reference if the STA is pinned by the
 477          * task that is adding the debugfs entries. In that case, we
 478          * leave the STA "to be freed".
 479          *
 480          * The rules are not trivial, but not too complex either:
 481          *  (1) pin_status is only modified under the sta_lock
 482          *  (2) STAs may only be pinned under the RTNL so that
 483          *      sta_info_flush() is guaranteed to actually destroy
 484          *      all STAs that are active for a given interface, this
 485          *      is required for correctness because otherwise we
 486          *      could notify a driver that an interface is going
 487          *      away and only after that (!) notify it about a STA
 488          *      on that interface going away.
 489          *  (3) sta_info_debugfs_add_work() will set the status
 490          *      to PINNED when it found an item that needs a new
 491          *      debugfs directory created. In that case, that item
 492          *      must not be freed although all *RCU* users are done
 493          *      with it. Hence, we tell the caller of _unlink()
 494          *      that the item is already gone (as can happen when
 495          *      two tasks try to unlink/destroy at the same time)
 496          *  (4) We set the pin_status to DESTROY here when we
 497          *      find such an item.
 498          *  (5) sta_info_debugfs_add_work() will reset the pin_status
 499          *      from PINNED to NORMAL when it is done with the item,
 500          *      but will check for DESTROY before resetting it in
 501          *      which case it will free the item.
 502          */
 503         if ((*sta)->pin_status == STA_INFO_PIN_STAT_PINNED) {
 504                 (*sta)->pin_status = STA_INFO_PIN_STAT_DESTROY;
 505                 *sta = NULL;
 506                 return;
 507         }
 508 }
 509
 510 void sta_info_unlink(struct sta_info **sta)
 511 {
 512         struct ieee80211_local *local = (*sta)->local;
 513         unsigned long flags;
 514
 515         spin_lock_irqsave(&local->sta_lock, flags);
 516         __sta_info_unlink(sta);
 517         spin_unlock_irqrestore(&local->sta_lock, flags);
 518 }
 519
 520 static inline int sta_info_buffer_expired(struct ieee80211_local *local,
 521                                           struct sta_info *sta,
 522                                           struct sk_buff *skb)
 523 {
 524         struct ieee80211_tx_info *info;
 525         int timeout;
 526
 527         if (!skb)
 528                 return 0;
 529
 530         info = IEEE80211_SKB_CB(skb);
 531
 532         /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
 533         timeout = (sta->listen_interval * local->hw.conf.beacon_int * 32 /
 534                    15625) * HZ;
 535         if (timeout < STA_TX_BUFFER_EXPIRE)
 536                 timeout = STA_TX_BUFFER_EXPIRE;
 537         return time_after(jiffies, info->control.jiffies + timeout);
 538 }
 539
 540
 541 static void sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
 542                                              struct sta_info *sta)
 543 {
 544         unsigned long flags;
 545         struct sk_buff *skb;
 546         struct ieee80211_sub_if_data *sdata;
 547         DECLARE_MAC_BUF(mac);
 548
 549         if (skb_queue_empty(&sta->ps_tx_buf))
 550                 return;
 551
 552         for (;;) {
 553                 spin_lock_irqsave(&sta->ps_tx_buf.lock, flags);
 554                 skb = skb_peek(&sta->ps_tx_buf);
 555                 if (sta_info_buffer_expired(local, sta, skb))
 556                         skb = __skb_dequeue(&sta->ps_tx_buf);
 557                 else
 558                         skb = NULL;
 559                 spin_unlock_irqrestore(&sta->ps_tx_buf.lock, flags);
 560
 561                 if (!skb)
 562                         break;
 563
 564                 sdata = sta->sdata;
 565                 local->total_ps_buffered--;
 566 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
 567                 printk(KERN_DEBUG "Buffered frame expired (STA "
 568                        "%s)\n", print_mac(mac, sta->sta.addr));
 569 #endif
 570                 dev_kfree_skb(skb);
 571
 572                 if (skb_queue_empty(&sta->ps_tx_buf))
 573                         sta_info_clear_tim_bit(sta);
 574         }
 575 }
 576
 577
 578 static void sta_info_cleanup(unsigned long data)
 579 {
 580         struct ieee80211_local *local = (struct ieee80211_local *) data;
 581         struct sta_info *sta;
 582
 583         rcu_read_lock();
 584         list_for_each_entry_rcu(sta, &local->sta_list, list)
 585                 sta_info_cleanup_expire_buffered(local, sta);
 586         rcu_read_unlock();
 587
 588         local->sta_cleanup.expires =
 589                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
 590         add_timer(&local->sta_cleanup);
 591 }
 592
 593 #ifdef CONFIG_MAC80211_DEBUGFS
 594 /*
 595  * See comment in __sta_info_unlink,
 596  * caller must hold local->sta_lock.
 597  */
 598 static void __sta_info_pin(struct sta_info *sta)
 599 {
 600         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_NORMAL);
 601         sta->pin_status = STA_INFO_PIN_STAT_PINNED;
 602 }
 603
 604 /*
 605  * See comment in __sta_info_unlink, returns sta if it
 606  * needs to be destroyed.
 607  */
 608 static struct sta_info *__sta_info_unpin(struct sta_info *sta)
 609 {
 610         struct sta_info *ret = NULL;
 611         unsigned long flags;
 612
 613         spin_lock_irqsave(&sta->local->sta_lock, flags);
 614         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_DESTROY &&
 615                 sta->pin_status != STA_INFO_PIN_STAT_PINNED);
 616         if (sta->pin_status == STA_INFO_PIN_STAT_DESTROY)
 617                 ret = sta;
 618         sta->pin_status = STA_INFO_PIN_STAT_NORMAL;
 619         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
 620
 621         return ret;
 622 }
 623
 624 static void sta_info_debugfs_add_work(struct work_struct *work)
 625 {
 626         struct ieee80211_local *local =
 627                 container_of(work, struct ieee80211_local, sta_debugfs_add);
 628         struct sta_info *sta, *tmp;
 629         unsigned long flags;
 630
 631         /* We need to keep the RTNL across the whole pinned status. */
 632         rtnl_lock();
 633         while (1) {
 634                 sta = NULL;
 635
 636                 spin_lock_irqsave(&local->sta_lock, flags);
 637                 list_for_each_entry(tmp, &local->sta_list, list) {
 638                         /*
 639                          * debugfs.add_has_run will be set by
 640                          * ieee80211_sta_debugfs_add regardless
 641                          * of what else it does.
 642                          */
 643                         if (!tmp->debugfs.add_has_run) {
 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 }
 805
 806 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
 807                           unsigned long exp_time)
 808 {
 809         struct ieee80211_local *local = sdata->local;
 810         struct sta_info *sta, *tmp;
 811         LIST_HEAD(tmp_list);
 812         DECLARE_MAC_BUF(mac);
 813         unsigned long flags;
 814
 815         spin_lock_irqsave(&local->sta_lock, flags);
 816         list_for_each_entry_safe(sta, tmp, &local->sta_list, list)
 817                 if (time_after(jiffies, sta->last_rx + exp_time)) {
 818 #ifdef CONFIG_MAC80211_IBSS_DEBUG
 819                         printk(KERN_DEBUG "%s: expiring inactive STA %s\n",
 820                                sdata->dev->name, print_mac(mac, sta->sta.addr));
 821 #endif
 822                         __sta_info_unlink(&sta);
 823                         if (sta)
 824                                 list_add(&sta->list, &tmp_list);
 825                 }
 826         spin_unlock_irqrestore(&local->sta_lock, flags);
 827
 828         list_for_each_entry_safe(sta, tmp, &tmp_list, list)
 829                 sta_info_destroy(sta);
 830 }
 831
 832 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
 833                                          const u8 *addr)
 834 {
 835         struct sta_info *sta = sta_info_get(hw_to_local(hw), addr);
 836
 837         if (!sta)
 838                 return NULL;
 839         return &sta->sta;
 840 }
 841 EXPORT_SYMBOL(ieee80211_find_sta);