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