net/mac80211/sta_info.c

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