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