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