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         sta->last_rx = jiffies;
 280
 281         sta->rate_ctrl = rate_control_get(local->rate_ctrl);
 282         sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
 283                                                      &sta->sta, gfp);
 284         if (!sta->rate_ctrl_priv) {
 285                 rate_control_put(sta->rate_ctrl);
 286                 kfree(sta);
 287                 return NULL;
 288         }
 289
 290         for (i = 0; i < STA_TID_NUM; i++) {
 291                 /* timer_to_tid must be initialized with identity mapping to
 292                  * enable session_timer's data differentiation. refer to
 293                  * sta_rx_agg_session_timer_expired for useage */
 294                 sta->timer_to_tid[i] = i;
 295                 /* rx */
 296                 sta->ampdu_mlme.tid_state_rx[i] = HT_AGG_STATE_IDLE;
 297                 sta->ampdu_mlme.tid_rx[i] = NULL;
 298                 /* tx */
 299                 sta->ampdu_mlme.tid_state_tx[i] = HT_AGG_STATE_IDLE;
 300                 sta->ampdu_mlme.tid_tx[i] = NULL;
 301                 sta->ampdu_mlme.addba_req_num[i] = 0;
 302         }
 303         skb_queue_head_init(&sta->ps_tx_buf);
 304         skb_queue_head_init(&sta->tx_filtered);
 305
 306         for (i = 0; i < NUM_RX_DATA_QUEUES; i++)
 307                 sta->last_seq_ctrl[i] = cpu_to_le16(USHORT_MAX);
 308
 309 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 310         printk(KERN_DEBUG "%s: Allocated STA %pM\n",
 311                wiphy_name(local->hw.wiphy), sta->sta.addr);
 312 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 313
 314 #ifdef CONFIG_MAC80211_MESH
 315         sta->plink_state = PLINK_LISTEN;
 316         init_timer(&sta->plink_timer);
 317 #endif
 318
 319         return sta;
 320 }
 321
 322 int sta_info_insert(struct sta_info *sta)
 323 {
 324         struct ieee80211_local *local = sta->local;
 325         struct ieee80211_sub_if_data *sdata = sta->sdata;
 326         unsigned long flags;
 327         int err = 0;
 328
 329         /*
 330          * Can't be a WARN_ON because it can be triggered through a race:
 331          * something inserts a STA (on one CPU) without holding the RTNL
 332          * and another CPU turns off the net device.
 333          */
 334         if (unlikely(!netif_running(sdata->dev))) {
 335                 err = -ENETDOWN;
 336                 goto out_free;
 337         }
 338
 339         if (WARN_ON(compare_ether_addr(sta->sta.addr, sdata->dev->dev_addr) == 0 ||
 340                     is_multicast_ether_addr(sta->sta.addr))) {
 341                 err = -EINVAL;
 342                 goto out_free;
 343         }
 344
 345         spin_lock_irqsave(&local->sta_lock, flags);
 346         /* check if STA exists already */
 347         if (sta_info_get(local, sta->sta.addr)) {
 348                 spin_unlock_irqrestore(&local->sta_lock, flags);
 349                 err = -EEXIST;
 350                 goto out_free;
 351         }
 352         list_add(&sta->list, &local->sta_list);
 353         local->sta_generation++;
 354         local->num_sta++;
 355         sta_info_hash_add(local, sta);
 356
 357         /* notify driver */
 358         if (local->ops->sta_notify) {
 359                 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
 360                         sdata = container_of(sdata->bss,
 361                                              struct ieee80211_sub_if_data,
 362                                              u.ap);
 363
 364                 drv_sta_notify(local, &sdata->vif, STA_NOTIFY_ADD, &sta->sta);
 365                 sdata = sta->sdata;
 366         }
 367
 368 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 369         printk(KERN_DEBUG "%s: Inserted STA %pM\n",
 370                wiphy_name(local->hw.wiphy), sta->sta.addr);
 371 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 372
 373         spin_unlock_irqrestore(&local->sta_lock, flags);
 374
 375 #ifdef CONFIG_MAC80211_DEBUGFS
 376         /*
 377          * Debugfs entry adding might sleep, so schedule process
 378          * context task for adding entry for STAs that do not yet
 379          * have one.
 380          * NOTE: due to auto-freeing semantics this may only be done
 381          *       if the insertion is successful!
 382          */
 383         schedule_work(&local->sta_debugfs_add);
 384 #endif
 385
 386         if (ieee80211_vif_is_mesh(&sdata->vif))
 387                 mesh_accept_plinks_update(sdata);
 388
 389         return 0;
 390  out_free:
 391         BUG_ON(!err);
 392         __sta_info_free(local, sta);
 393         return err;
 394 }
 395
 396 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
 397 {
 398         /*
 399          * This format has been mandated by the IEEE specifications,
 400          * so this line may not be changed to use the __set_bit() format.
 401          */
 402         bss->tim[aid / 8] |= (1 << (aid % 8));
 403 }
 404
 405 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
 406 {
 407         /*
 408          * This format has been mandated by the IEEE specifications,
 409          * so this line may not be changed to use the __clear_bit() format.
 410          */
 411         bss->tim[aid / 8] &= ~(1 << (aid % 8));
 412 }
 413
 414 static void __sta_info_set_tim_bit(struct ieee80211_if_ap *bss,
 415                                    struct sta_info *sta)
 416 {
 417         BUG_ON(!bss);
 418
 419         __bss_tim_set(bss, sta->sta.aid);
 420
 421         if (sta->local->ops->set_tim) {
 422                 sta->local->tim_in_locked_section = true;
 423                 drv_set_tim(sta->local, &sta->sta, true);
 424                 sta->local->tim_in_locked_section = false;
 425         }
 426 }
 427
 428 void sta_info_set_tim_bit(struct sta_info *sta)
 429 {
 430         unsigned long flags;
 431
 432         BUG_ON(!sta->sdata->bss);
 433
 434         spin_lock_irqsave(&sta->local->sta_lock, flags);
 435         __sta_info_set_tim_bit(sta->sdata->bss, sta);
 436         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
 437 }
 438
 439 static void __sta_info_clear_tim_bit(struct ieee80211_if_ap *bss,
 440                                      struct sta_info *sta)
 441 {
 442         BUG_ON(!bss);
 443
 444         __bss_tim_clear(bss, sta->sta.aid);
 445
 446         if (sta->local->ops->set_tim) {
 447                 sta->local->tim_in_locked_section = true;
 448                 drv_set_tim(sta->local, &sta->sta, false);
 449                 sta->local->tim_in_locked_section = false;
 450         }
 451 }
 452
 453 void sta_info_clear_tim_bit(struct sta_info *sta)
 454 {
 455         unsigned long flags;
 456
 457         BUG_ON(!sta->sdata->bss);
 458
 459         spin_lock_irqsave(&sta->local->sta_lock, flags);
 460         __sta_info_clear_tim_bit(sta->sdata->bss, sta);
 461         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
 462 }
 463
 464 static void __sta_info_unlink(struct sta_info **sta)
 465 {
 466         struct ieee80211_local *local = (*sta)->local;
 467         struct ieee80211_sub_if_data *sdata = (*sta)->sdata;
 468         /*
 469          * pull caller's reference if we're already gone.
 470          */
 471         if (sta_info_hash_del(local, *sta)) {
 472                 *sta = NULL;
 473                 return;
 474         }
 475
 476         if ((*sta)->key) {
 477                 ieee80211_key_free((*sta)->key);
 478                 WARN_ON((*sta)->key);
 479         }
 480
 481         list_del(&(*sta)->list);
 482
 483         if (test_and_clear_sta_flags(*sta, WLAN_STA_PS)) {
 484                 BUG_ON(!sdata->bss);
 485
 486                 atomic_dec(&sdata->bss->num_sta_ps);
 487                 __sta_info_clear_tim_bit(sdata->bss, *sta);
 488         }
 489
 490         local->num_sta--;
 491         local->sta_generation++;
 492
 493         if (local->ops->sta_notify) {
 494                 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
 495                         sdata = container_of(sdata->bss,
 496                                              struct ieee80211_sub_if_data,
 497                                              u.ap);
 498
 499                 drv_sta_notify(local, &sdata->vif, STA_NOTIFY_REMOVE,
 500                                &(*sta)->sta);
 501                 sdata = (*sta)->sdata;
 502         }
 503
 504         if (ieee80211_vif_is_mesh(&sdata->vif)) {
 505                 mesh_accept_plinks_update(sdata);
 506 #ifdef CONFIG_MAC80211_MESH
 507                 del_timer(&(*sta)->plink_timer);
 508 #endif
 509         }
 510
 511 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
 512         printk(KERN_DEBUG "%s: Removed STA %pM\n",
 513                wiphy_name(local->hw.wiphy), (*sta)->sta.addr);
 514 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
 515
 516         /*
 517          * Finally, pull caller's reference if the STA is pinned by the
 518          * task that is adding the debugfs entries. In that case, we
 519          * leave the STA "to be freed".
 520          *
 521          * The rules are not trivial, but not too complex either:
 522          *  (1) pin_status is only modified under the sta_lock
 523          *  (2) STAs may only be pinned under the RTNL so that
 524          *      sta_info_flush() is guaranteed to actually destroy
 525          *      all STAs that are active for a given interface, this
 526          *      is required for correctness because otherwise we
 527          *      could notify a driver that an interface is going
 528          *      away and only after that (!) notify it about a STA
 529          *      on that interface going away.
 530          *  (3) sta_info_debugfs_add_work() will set the status
 531          *      to PINNED when it found an item that needs a new
 532          *      debugfs directory created. In that case, that item
 533          *      must not be freed although all *RCU* users are done
 534          *      with it. Hence, we tell the caller of _unlink()
 535          *      that the item is already gone (as can happen when
 536          *      two tasks try to unlink/destroy at the same time)
 537          *  (4) We set the pin_status to DESTROY here when we
 538          *      find such an item.
 539          *  (5) sta_info_debugfs_add_work() will reset the pin_status
 540          *      from PINNED to NORMAL when it is done with the item,
 541          *      but will check for DESTROY before resetting it in
 542          *      which case it will free the item.
 543          */
 544         if ((*sta)->pin_status == STA_INFO_PIN_STAT_PINNED) {
 545                 (*sta)->pin_status = STA_INFO_PIN_STAT_DESTROY;
 546                 *sta = NULL;
 547                 return;
 548         }
 549 }
 550
 551 void sta_info_unlink(struct sta_info **sta)
 552 {
 553         struct ieee80211_local *local = (*sta)->local;
 554         unsigned long flags;
 555
 556         spin_lock_irqsave(&local->sta_lock, flags);
 557         __sta_info_unlink(sta);
 558         spin_unlock_irqrestore(&local->sta_lock, flags);
 559 }
 560
 561 static int sta_info_buffer_expired(struct sta_info *sta,
 562                                    struct sk_buff *skb)
 563 {
 564         struct ieee80211_tx_info *info;
 565         int timeout;
 566
 567         if (!skb)
 568                 return 0;
 569
 570         info = IEEE80211_SKB_CB(skb);
 571
 572         /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
 573         timeout = (sta->listen_interval *
 574                    sta->sdata->vif.bss_conf.beacon_int *
 575                    32 / 15625) * HZ;
 576         if (timeout < STA_TX_BUFFER_EXPIRE)
 577                 timeout = STA_TX_BUFFER_EXPIRE;
 578         return time_after(jiffies, info->control.jiffies + timeout);
 579 }
 580
 581
 582 static void sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
 583                                              struct sta_info *sta)
 584 {
 585         unsigned long flags;
 586         struct sk_buff *skb;
 587         struct ieee80211_sub_if_data *sdata;
 588
 589         if (skb_queue_empty(&sta->ps_tx_buf))
 590                 return;
 591
 592         for (;;) {
 593                 spin_lock_irqsave(&sta->ps_tx_buf.lock, flags);
 594                 skb = skb_peek(&sta->ps_tx_buf);
 595                 if (sta_info_buffer_expired(sta, skb))
 596                         skb = __skb_dequeue(&sta->ps_tx_buf);
 597                 else
 598                         skb = NULL;
 599                 spin_unlock_irqrestore(&sta->ps_tx_buf.lock, flags);
 600
 601                 if (!skb)
 602                         break;
 603
 604                 sdata = sta->sdata;
 605                 local->total_ps_buffered--;
 606 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
 607                 printk(KERN_DEBUG "Buffered frame expired (STA %pM)\n",
 608                        sta->sta.addr);
 609 #endif
 610                 dev_kfree_skb(skb);
 611
 612                 if (skb_queue_empty(&sta->ps_tx_buf))
 613                         sta_info_clear_tim_bit(sta);
 614         }
 615 }
 616
 617
 618 static void sta_info_cleanup(unsigned long data)
 619 {
 620         struct ieee80211_local *local = (struct ieee80211_local *) data;
 621         struct sta_info *sta;
 622
 623         rcu_read_lock();
 624         list_for_each_entry_rcu(sta, &local->sta_list, list)
 625                 sta_info_cleanup_expire_buffered(local, sta);
 626         rcu_read_unlock();
 627
 628         if (local->quiescing)
 629                 return;
 630
 631         local->sta_cleanup.expires =
 632                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
 633         add_timer(&local->sta_cleanup);
 634 }
 635
 636 #ifdef CONFIG_MAC80211_DEBUGFS
 637 /*
 638  * See comment in __sta_info_unlink,
 639  * caller must hold local->sta_lock.
 640  */
 641 static void __sta_info_pin(struct sta_info *sta)
 642 {
 643         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_NORMAL);
 644         sta->pin_status = STA_INFO_PIN_STAT_PINNED;
 645 }
 646
 647 /*
 648  * See comment in __sta_info_unlink, returns sta if it
 649  * needs to be destroyed.
 650  */
 651 static struct sta_info *__sta_info_unpin(struct sta_info *sta)
 652 {
 653         struct sta_info *ret = NULL;
 654         unsigned long flags;
 655
 656         spin_lock_irqsave(&sta->local->sta_lock, flags);
 657         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_DESTROY &&
 658                 sta->pin_status != STA_INFO_PIN_STAT_PINNED);
 659         if (sta->pin_status == STA_INFO_PIN_STAT_DESTROY)
 660                 ret = sta;
 661         sta->pin_status = STA_INFO_PIN_STAT_NORMAL;
 662         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
 663
 664         return ret;
 665 }
 666
 667 static void sta_info_debugfs_add_work(struct work_struct *work)
 668 {
 669         struct ieee80211_local *local =
 670                 container_of(work, struct ieee80211_local, sta_debugfs_add);
 671         struct sta_info *sta, *tmp;
 672         unsigned long flags;
 673
 674         /* We need to keep the RTNL across the whole pinned status. */
 675         rtnl_lock();
 676         while (1) {
 677                 sta = NULL;
 678
 679                 spin_lock_irqsave(&local->sta_lock, flags);
 680                 list_for_each_entry(tmp, &local->sta_list, list) {
 681                         /*
 682                          * debugfs.add_has_run will be set by
 683                          * ieee80211_sta_debugfs_add regardless
 684                          * of what else it does.
 685                          */
 686                         if (!tmp->debugfs.add_has_run) {
 687                                 sta = tmp;
 688                                 __sta_info_pin(sta);
 689                                 break;
 690                         }
 691                 }
 692                 spin_unlock_irqrestore(&local->sta_lock, flags);
 693
 694                 if (!sta)
 695                         break;
 696
 697                 ieee80211_sta_debugfs_add(sta);
 698                 rate_control_add_sta_debugfs(sta);
 699
 700                 sta = __sta_info_unpin(sta);
 701                 sta_info_destroy(sta);
 702         }
 703         rtnl_unlock();
 704 }
 705 #endif
 706
 707 void sta_info_init(struct ieee80211_local *local)
 708 {
 709         spin_lock_init(&local->sta_lock);
 710         INIT_LIST_HEAD(&local->sta_list);
 711
 712         setup_timer(&local->sta_cleanup, sta_info_cleanup,
 713                     (unsigned long)local);
 714         local->sta_cleanup.expires =
 715                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
 716
 717 #ifdef CONFIG_MAC80211_DEBUGFS
 718         INIT_WORK(&local->sta_debugfs_add, sta_info_debugfs_add_work);
 719 #endif
 720 }
 721
 722 int sta_info_start(struct ieee80211_local *local)
 723 {
 724         add_timer(&local->sta_cleanup);
 725         return 0;
 726 }
 727
 728 void sta_info_stop(struct ieee80211_local *local)
 729 {
 730         del_timer(&local->sta_cleanup);
 731 #ifdef CONFIG_MAC80211_DEBUGFS
 732         /*
 733          * Make sure the debugfs adding work isn't pending after this
 734          * because we're about to be destroyed. It doesn't matter
 735          * whether it ran or not since we're going to flush all STAs
 736          * anyway.
 737          */
 738         cancel_work_sync(&local->sta_debugfs_add);
 739 #endif
 740
 741         sta_info_flush(local, NULL);
 742 }
 743
 744 /**
 745  * sta_info_flush - flush matching STA entries from the STA table
 746  *
 747  * Returns the number of removed STA entries.
 748  *
 749  * @local: local interface data
 750  * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
 751  */
 752 int sta_info_flush(struct ieee80211_local *local,
 753                    struct ieee80211_sub_if_data *sdata)
 754 {
 755         struct sta_info *sta, *tmp;
 756         LIST_HEAD(tmp_list);
 757         int ret = 0;
 758         unsigned long flags;
 759
 760         might_sleep();
 761
 762         spin_lock_irqsave(&local->sta_lock, flags);
 763         list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
 764                 if (!sdata || sdata == sta->sdata) {
 765                         __sta_info_unlink(&sta);
 766                         if (sta) {
 767                                 list_add_tail(&sta->list, &tmp_list);
 768                                 ret++;
 769                         }
 770                 }
 771         }
 772         spin_unlock_irqrestore(&local->sta_lock, flags);
 773
 774         list_for_each_entry_safe(sta, tmp, &tmp_list, list)
 775                 sta_info_destroy(sta);
 776
 777         return ret;
 778 }
 779
 780 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
 781                           unsigned long exp_time)
 782 {
 783         struct ieee80211_local *local = sdata->local;
 784         struct sta_info *sta, *tmp;
 785         LIST_HEAD(tmp_list);
 786         unsigned long flags;
 787
 788         spin_lock_irqsave(&local->sta_lock, flags);
 789         list_for_each_entry_safe(sta, tmp, &local->sta_list, list)
 790                 if (time_after(jiffies, sta->last_rx + exp_time)) {
 791 #ifdef CONFIG_MAC80211_IBSS_DEBUG
 792                         printk(KERN_DEBUG "%s: expiring inactive STA %pM\n",
 793                                sdata->dev->name, sta->sta.addr);
 794 #endif
 795                         __sta_info_unlink(&sta);
 796                         if (sta)
 797                                 list_add(&sta->list, &tmp_list);
 798                 }
 799         spin_unlock_irqrestore(&local->sta_lock, flags);
 800
 801         list_for_each_entry_safe(sta, tmp, &tmp_list, list)
 802                 sta_info_destroy(sta);
 803 }
 804
 805 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
 806                                          const u8 *addr)
 807 {
 808         struct sta_info *sta = sta_info_get(hw_to_local(hw), addr);
 809
 810         if (!sta)
 811                 return NULL;
 812         return &sta->sta;
 813 }
 814 EXPORT_SYMBOL(ieee80211_find_sta);