netfilter: xt_recent: save 8 bytes per htable
[safe/jmp/linux-2.6] / 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         struct station_info sinfo;
363         unsigned long flags;
364         int err = 0;
365
366         /*
367          * Can't be a WARN_ON because it can be triggered through a race:
368          * something inserts a STA (on one CPU) without holding the RTNL
369          * and another CPU turns off the net device.
370          */
371         if (unlikely(!ieee80211_sdata_running(sdata))) {
372                 err = -ENETDOWN;
373                 goto out_free;
374         }
375
376         if (WARN_ON(compare_ether_addr(sta->sta.addr, sdata->vif.addr) == 0 ||
377                     is_multicast_ether_addr(sta->sta.addr))) {
378                 err = -EINVAL;
379                 goto out_free;
380         }
381
382         spin_lock_irqsave(&local->sta_lock, flags);
383         /* check if STA exists already */
384         if (sta_info_get(sdata, sta->sta.addr)) {
385                 spin_unlock_irqrestore(&local->sta_lock, flags);
386                 err = -EEXIST;
387                 goto out_free;
388         }
389         list_add(&sta->list, &local->sta_list);
390         local->sta_generation++;
391         local->num_sta++;
392         sta_info_hash_add(local, sta);
393
394         /* notify driver */
395         if (local->ops->sta_notify) {
396                 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
397                         sdata = container_of(sdata->bss,
398                                              struct ieee80211_sub_if_data,
399                                              u.ap);
400
401                 drv_sta_notify(local, sdata, STA_NOTIFY_ADD, &sta->sta);
402                 sdata = sta->sdata;
403         }
404
405 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
406         printk(KERN_DEBUG "%s: Inserted STA %pM\n",
407                wiphy_name(local->hw.wiphy), sta->sta.addr);
408 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
409
410         spin_unlock_irqrestore(&local->sta_lock, flags);
411
412         sinfo.filled = 0;
413         sinfo.generation = local->sta_generation;
414         cfg80211_new_sta(sdata->dev, sta->sta.addr, &sinfo, GFP_ATOMIC);
415
416 #ifdef CONFIG_MAC80211_DEBUGFS
417         /*
418          * Debugfs entry adding might sleep, so schedule process
419          * context task for adding entry for STAs that do not yet
420          * have one.
421          * NOTE: due to auto-freeing semantics this may only be done
422          *       if the insertion is successful!
423          */
424         schedule_work(&local->sta_debugfs_add);
425 #endif
426
427         if (ieee80211_vif_is_mesh(&sdata->vif))
428                 mesh_accept_plinks_update(sdata);
429
430         return 0;
431  out_free:
432         BUG_ON(!err);
433         __sta_info_free(local, sta);
434         return err;
435 }
436
437 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
438 {
439         /*
440          * This format has been mandated by the IEEE specifications,
441          * so this line may not be changed to use the __set_bit() format.
442          */
443         bss->tim[aid / 8] |= (1 << (aid % 8));
444 }
445
446 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
447 {
448         /*
449          * This format has been mandated by the IEEE specifications,
450          * so this line may not be changed to use the __clear_bit() format.
451          */
452         bss->tim[aid / 8] &= ~(1 << (aid % 8));
453 }
454
455 static void __sta_info_set_tim_bit(struct ieee80211_if_ap *bss,
456                                    struct sta_info *sta)
457 {
458         BUG_ON(!bss);
459
460         __bss_tim_set(bss, sta->sta.aid);
461
462         if (sta->local->ops->set_tim) {
463                 sta->local->tim_in_locked_section = true;
464                 drv_set_tim(sta->local, &sta->sta, true);
465                 sta->local->tim_in_locked_section = false;
466         }
467 }
468
469 void sta_info_set_tim_bit(struct sta_info *sta)
470 {
471         unsigned long flags;
472
473         BUG_ON(!sta->sdata->bss);
474
475         spin_lock_irqsave(&sta->local->sta_lock, flags);
476         __sta_info_set_tim_bit(sta->sdata->bss, sta);
477         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
478 }
479
480 static void __sta_info_clear_tim_bit(struct ieee80211_if_ap *bss,
481                                      struct sta_info *sta)
482 {
483         BUG_ON(!bss);
484
485         __bss_tim_clear(bss, sta->sta.aid);
486
487         if (sta->local->ops->set_tim) {
488                 sta->local->tim_in_locked_section = true;
489                 drv_set_tim(sta->local, &sta->sta, false);
490                 sta->local->tim_in_locked_section = false;
491         }
492 }
493
494 void sta_info_clear_tim_bit(struct sta_info *sta)
495 {
496         unsigned long flags;
497
498         BUG_ON(!sta->sdata->bss);
499
500         spin_lock_irqsave(&sta->local->sta_lock, flags);
501         __sta_info_clear_tim_bit(sta->sdata->bss, sta);
502         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
503 }
504
505 static void __sta_info_unlink(struct sta_info **sta)
506 {
507         struct ieee80211_local *local = (*sta)->local;
508         struct ieee80211_sub_if_data *sdata = (*sta)->sdata;
509         /*
510          * pull caller's reference if we're already gone.
511          */
512         if (sta_info_hash_del(local, *sta)) {
513                 *sta = NULL;
514                 return;
515         }
516
517         if ((*sta)->key) {
518                 ieee80211_key_free((*sta)->key);
519                 WARN_ON((*sta)->key);
520         }
521
522         list_del(&(*sta)->list);
523         (*sta)->dead = true;
524
525         if (test_and_clear_sta_flags(*sta,
526                                 WLAN_STA_PS_STA | WLAN_STA_PS_DRIVER)) {
527                 BUG_ON(!sdata->bss);
528
529                 atomic_dec(&sdata->bss->num_sta_ps);
530                 __sta_info_clear_tim_bit(sdata->bss, *sta);
531         }
532
533         local->num_sta--;
534         local->sta_generation++;
535
536         if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
537                 rcu_assign_pointer(sdata->u.vlan.sta, NULL);
538
539         if (local->ops->sta_notify) {
540                 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
541                         sdata = container_of(sdata->bss,
542                                              struct ieee80211_sub_if_data,
543                                              u.ap);
544
545                 drv_sta_notify(local, sdata, STA_NOTIFY_REMOVE,
546                                &(*sta)->sta);
547                 sdata = (*sta)->sdata;
548         }
549
550         if (ieee80211_vif_is_mesh(&sdata->vif)) {
551                 mesh_accept_plinks_update(sdata);
552 #ifdef CONFIG_MAC80211_MESH
553                 del_timer(&(*sta)->plink_timer);
554 #endif
555         }
556
557 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
558         printk(KERN_DEBUG "%s: Removed STA %pM\n",
559                wiphy_name(local->hw.wiphy), (*sta)->sta.addr);
560 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
561
562         /*
563          * Finally, pull caller's reference if the STA is pinned by the
564          * task that is adding the debugfs entries. In that case, we
565          * leave the STA "to be freed".
566          *
567          * The rules are not trivial, but not too complex either:
568          *  (1) pin_status is only modified under the sta_lock
569          *  (2) STAs may only be pinned under the RTNL so that
570          *      sta_info_flush() is guaranteed to actually destroy
571          *      all STAs that are active for a given interface, this
572          *      is required for correctness because otherwise we
573          *      could notify a driver that an interface is going
574          *      away and only after that (!) notify it about a STA
575          *      on that interface going away.
576          *  (3) sta_info_debugfs_add_work() will set the status
577          *      to PINNED when it found an item that needs a new
578          *      debugfs directory created. In that case, that item
579          *      must not be freed although all *RCU* users are done
580          *      with it. Hence, we tell the caller of _unlink()
581          *      that the item is already gone (as can happen when
582          *      two tasks try to unlink/destroy at the same time)
583          *  (4) We set the pin_status to DESTROY here when we
584          *      find such an item.
585          *  (5) sta_info_debugfs_add_work() will reset the pin_status
586          *      from PINNED to NORMAL when it is done with the item,
587          *      but will check for DESTROY before resetting it in
588          *      which case it will free the item.
589          */
590         if ((*sta)->pin_status == STA_INFO_PIN_STAT_PINNED) {
591                 (*sta)->pin_status = STA_INFO_PIN_STAT_DESTROY;
592                 *sta = NULL;
593                 return;
594         }
595 }
596
597 void sta_info_unlink(struct sta_info **sta)
598 {
599         struct ieee80211_local *local = (*sta)->local;
600         unsigned long flags;
601
602         spin_lock_irqsave(&local->sta_lock, flags);
603         __sta_info_unlink(sta);
604         spin_unlock_irqrestore(&local->sta_lock, flags);
605 }
606
607 static int sta_info_buffer_expired(struct sta_info *sta,
608                                    struct sk_buff *skb)
609 {
610         struct ieee80211_tx_info *info;
611         int timeout;
612
613         if (!skb)
614                 return 0;
615
616         info = IEEE80211_SKB_CB(skb);
617
618         /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
619         timeout = (sta->listen_interval *
620                    sta->sdata->vif.bss_conf.beacon_int *
621                    32 / 15625) * HZ;
622         if (timeout < STA_TX_BUFFER_EXPIRE)
623                 timeout = STA_TX_BUFFER_EXPIRE;
624         return time_after(jiffies, info->control.jiffies + timeout);
625 }
626
627
628 static void sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
629                                              struct sta_info *sta)
630 {
631         unsigned long flags;
632         struct sk_buff *skb;
633         struct ieee80211_sub_if_data *sdata;
634
635         if (skb_queue_empty(&sta->ps_tx_buf))
636                 return;
637
638         for (;;) {
639                 spin_lock_irqsave(&sta->ps_tx_buf.lock, flags);
640                 skb = skb_peek(&sta->ps_tx_buf);
641                 if (sta_info_buffer_expired(sta, skb))
642                         skb = __skb_dequeue(&sta->ps_tx_buf);
643                 else
644                         skb = NULL;
645                 spin_unlock_irqrestore(&sta->ps_tx_buf.lock, flags);
646
647                 if (!skb)
648                         break;
649
650                 sdata = sta->sdata;
651                 local->total_ps_buffered--;
652 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
653                 printk(KERN_DEBUG "Buffered frame expired (STA %pM)\n",
654                        sta->sta.addr);
655 #endif
656                 dev_kfree_skb(skb);
657
658                 if (skb_queue_empty(&sta->ps_tx_buf))
659                         sta_info_clear_tim_bit(sta);
660         }
661 }
662
663
664 static void sta_info_cleanup(unsigned long data)
665 {
666         struct ieee80211_local *local = (struct ieee80211_local *) data;
667         struct sta_info *sta;
668
669         rcu_read_lock();
670         list_for_each_entry_rcu(sta, &local->sta_list, list)
671                 sta_info_cleanup_expire_buffered(local, sta);
672         rcu_read_unlock();
673
674         if (local->quiescing)
675                 return;
676
677         local->sta_cleanup.expires =
678                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
679         add_timer(&local->sta_cleanup);
680 }
681
682 #ifdef CONFIG_MAC80211_DEBUGFS
683 /*
684  * See comment in __sta_info_unlink,
685  * caller must hold local->sta_lock.
686  */
687 static void __sta_info_pin(struct sta_info *sta)
688 {
689         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_NORMAL);
690         sta->pin_status = STA_INFO_PIN_STAT_PINNED;
691 }
692
693 /*
694  * See comment in __sta_info_unlink, returns sta if it
695  * needs to be destroyed.
696  */
697 static struct sta_info *__sta_info_unpin(struct sta_info *sta)
698 {
699         struct sta_info *ret = NULL;
700         unsigned long flags;
701
702         spin_lock_irqsave(&sta->local->sta_lock, flags);
703         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_DESTROY &&
704                 sta->pin_status != STA_INFO_PIN_STAT_PINNED);
705         if (sta->pin_status == STA_INFO_PIN_STAT_DESTROY)
706                 ret = sta;
707         sta->pin_status = STA_INFO_PIN_STAT_NORMAL;
708         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
709
710         return ret;
711 }
712
713 static void sta_info_debugfs_add_work(struct work_struct *work)
714 {
715         struct ieee80211_local *local =
716                 container_of(work, struct ieee80211_local, sta_debugfs_add);
717         struct sta_info *sta, *tmp;
718         unsigned long flags;
719
720         /* We need to keep the RTNL across the whole pinned status. */
721         rtnl_lock();
722         while (1) {
723                 sta = NULL;
724
725                 spin_lock_irqsave(&local->sta_lock, flags);
726                 list_for_each_entry(tmp, &local->sta_list, list) {
727                         /*
728                          * debugfs.add_has_run will be set by
729                          * ieee80211_sta_debugfs_add regardless
730                          * of what else it does.
731                          */
732                         if (!tmp->debugfs.add_has_run) {
733                                 sta = tmp;
734                                 __sta_info_pin(sta);
735                                 break;
736                         }
737                 }
738                 spin_unlock_irqrestore(&local->sta_lock, flags);
739
740                 if (!sta)
741                         break;
742
743                 ieee80211_sta_debugfs_add(sta);
744                 rate_control_add_sta_debugfs(sta);
745
746                 sta = __sta_info_unpin(sta);
747                 sta_info_destroy(sta);
748         }
749         rtnl_unlock();
750 }
751 #endif
752
753 void sta_info_init(struct ieee80211_local *local)
754 {
755         spin_lock_init(&local->sta_lock);
756         INIT_LIST_HEAD(&local->sta_list);
757
758         setup_timer(&local->sta_cleanup, sta_info_cleanup,
759                     (unsigned long)local);
760         local->sta_cleanup.expires =
761                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
762
763 #ifdef CONFIG_MAC80211_DEBUGFS
764         INIT_WORK(&local->sta_debugfs_add, sta_info_debugfs_add_work);
765 #endif
766 }
767
768 int sta_info_start(struct ieee80211_local *local)
769 {
770         add_timer(&local->sta_cleanup);
771         return 0;
772 }
773
774 void sta_info_stop(struct ieee80211_local *local)
775 {
776         del_timer(&local->sta_cleanup);
777 #ifdef CONFIG_MAC80211_DEBUGFS
778         /*
779          * Make sure the debugfs adding work isn't pending after this
780          * because we're about to be destroyed. It doesn't matter
781          * whether it ran or not since we're going to flush all STAs
782          * anyway.
783          */
784         cancel_work_sync(&local->sta_debugfs_add);
785 #endif
786
787         sta_info_flush(local, NULL);
788 }
789
790 /**
791  * sta_info_flush - flush matching STA entries from the STA table
792  *
793  * Returns the number of removed STA entries.
794  *
795  * @local: local interface data
796  * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
797  */
798 int sta_info_flush(struct ieee80211_local *local,
799                    struct ieee80211_sub_if_data *sdata)
800 {
801         struct sta_info *sta, *tmp;
802         LIST_HEAD(tmp_list);
803         int ret = 0;
804         unsigned long flags;
805
806         might_sleep();
807
808         spin_lock_irqsave(&local->sta_lock, flags);
809         list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
810                 if (!sdata || sdata == sta->sdata) {
811                         __sta_info_unlink(&sta);
812                         if (sta) {
813                                 list_add_tail(&sta->list, &tmp_list);
814                                 ret++;
815                         }
816                 }
817         }
818         spin_unlock_irqrestore(&local->sta_lock, flags);
819
820         list_for_each_entry_safe(sta, tmp, &tmp_list, list)
821                 sta_info_destroy(sta);
822
823         return ret;
824 }
825
826 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
827                           unsigned long exp_time)
828 {
829         struct ieee80211_local *local = sdata->local;
830         struct sta_info *sta, *tmp;
831         LIST_HEAD(tmp_list);
832         unsigned long flags;
833
834         spin_lock_irqsave(&local->sta_lock, flags);
835         list_for_each_entry_safe(sta, tmp, &local->sta_list, list)
836                 if (time_after(jiffies, sta->last_rx + exp_time)) {
837 #ifdef CONFIG_MAC80211_IBSS_DEBUG
838                         printk(KERN_DEBUG "%s: expiring inactive STA %pM\n",
839                                sdata->name, sta->sta.addr);
840 #endif
841                         __sta_info_unlink(&sta);
842                         if (sta)
843                                 list_add(&sta->list, &tmp_list);
844                 }
845         spin_unlock_irqrestore(&local->sta_lock, flags);
846
847         list_for_each_entry_safe(sta, tmp, &tmp_list, list)
848                 sta_info_destroy(sta);
849 }
850
851 struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw,
852                                                const u8 *addr)
853 {
854         struct sta_info *sta, *nxt;
855
856         /* Just return a random station ... first in list ... */
857         for_each_sta_info(hw_to_local(hw), addr, sta, nxt)
858                 return &sta->sta;
859         return NULL;
860 }
861 EXPORT_SYMBOL_GPL(ieee80211_find_sta_by_hw);
862
863 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
864                                          const u8 *addr)
865 {
866         struct ieee80211_sub_if_data *sdata;
867
868         if (!vif)
869                 return NULL;
870
871         sdata = vif_to_sdata(vif);
872
873         return ieee80211_find_sta_by_hw(&sdata->local->hw, addr);
874 }
875 EXPORT_SYMBOL(ieee80211_find_sta);
876
877 /* powersave support code */
878 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta)
879 {
880         struct ieee80211_sub_if_data *sdata = sta->sdata;
881         struct ieee80211_local *local = sdata->local;
882         int sent, buffered;
883
884         drv_sta_notify(local, sdata, STA_NOTIFY_AWAKE, &sta->sta);
885
886         if (!skb_queue_empty(&sta->ps_tx_buf))
887                 sta_info_clear_tim_bit(sta);
888
889         /* Send all buffered frames to the station */
890         sent = ieee80211_add_pending_skbs(local, &sta->tx_filtered);
891         buffered = ieee80211_add_pending_skbs(local, &sta->ps_tx_buf);
892         sent += buffered;
893         local->total_ps_buffered -= buffered;
894
895 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
896         printk(KERN_DEBUG "%s: STA %pM aid %d sending %d filtered/%d PS frames "
897                "since STA not sleeping anymore\n", sdata->name,
898                sta->sta.addr, sta->sta.aid, sent - buffered, buffered);
899 #endif /* CONFIG_MAC80211_VERBOSE_PS_DEBUG */
900 }
901
902 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta)
903 {
904         struct ieee80211_sub_if_data *sdata = sta->sdata;
905         struct ieee80211_local *local = sdata->local;
906         struct sk_buff *skb;
907         int no_pending_pkts;
908
909         skb = skb_dequeue(&sta->tx_filtered);
910         if (!skb) {
911                 skb = skb_dequeue(&sta->ps_tx_buf);
912                 if (skb)
913                         local->total_ps_buffered--;
914         }
915         no_pending_pkts = skb_queue_empty(&sta->tx_filtered) &&
916                 skb_queue_empty(&sta->ps_tx_buf);
917
918         if (skb) {
919                 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
920                 struct ieee80211_hdr *hdr =
921                         (struct ieee80211_hdr *) skb->data;
922
923                 /*
924                  * Tell TX path to send this frame even though the STA may
925                  * still remain is PS mode after this frame exchange.
926                  */
927                 info->flags |= IEEE80211_TX_CTL_PSPOLL_RESPONSE;
928
929 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
930                 printk(KERN_DEBUG "STA %pM aid %d: PS Poll (entries after %d)\n",
931                        sta->sta.addr, sta->sta.aid,
932                        skb_queue_len(&sta->ps_tx_buf));
933 #endif /* CONFIG_MAC80211_VERBOSE_PS_DEBUG */
934
935                 /* Use MoreData flag to indicate whether there are more
936                  * buffered frames for this STA */
937                 if (no_pending_pkts)
938                         hdr->frame_control &= cpu_to_le16(~IEEE80211_FCTL_MOREDATA);
939                 else
940                         hdr->frame_control |= cpu_to_le16(IEEE80211_FCTL_MOREDATA);
941
942                 ieee80211_add_pending_skb(local, skb);
943
944                 if (no_pending_pkts)
945                         sta_info_clear_tim_bit(sta);
946 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
947         } else {
948                 /*
949                  * FIXME: This can be the result of a race condition between
950                  *        us expiring a frame and the station polling for it.
951                  *        Should we send it a null-func frame indicating we
952                  *        have nothing buffered for it?
953                  */
954                 printk(KERN_DEBUG "%s: STA %pM sent PS Poll even "
955                        "though there are no buffered frames for it\n",
956                        sdata->name, sta->sta.addr);
957 #endif /* CONFIG_MAC80211_VERBOSE_PS_DEBUG */
958         }
959 }
960
961 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
962                                struct ieee80211_sta *pubsta, bool block)
963 {
964         struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
965
966         if (block)
967                 set_sta_flags(sta, WLAN_STA_PS_DRIVER);
968         else
969                 ieee80211_queue_work(hw, &sta->drv_unblock_wk);
970 }
971 EXPORT_SYMBOL(ieee80211_sta_block_awake);