mac80211: split sta_info_add
[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 "ieee80211_rate.h"
23 #include "sta_info.h"
24 #include "debugfs_sta.h"
25 #include "mesh.h"
26
27 /**
28  * DOC: STA information lifetime rules
29  *
30  * STA info structures (&struct sta_info) are managed in a hash table
31  * for faster lookup and a list for iteration. They are managed using
32  * RCU, i.e. access to the list and hash table is protected by RCU.
33  *
34  * Upon allocating a STA info structure with @sta_info_alloc() or
35  * mesh_plink_alloc(), the caller owns that structure. It must then either
36  * destroy it using @sta_info_destroy() (which is pretty useless) or insert
37  * it into the hash table using @sta_info_insert() which demotes the reference
38  * from ownership to a regular RCU-protected reference; if the function
39  * is called without protection by an RCU critical section the reference
40  * is instantly invalidated.
41  *
42  * Because there are debugfs entries for each station, and adding those
43  * must be able to sleep, it is also possible to "pin" a station entry,
44  * that means it can be removed from the hash table but not be freed.
45  * See the comment in @__sta_info_unlink() for more information.
46  *
47  * In order to remove a STA info structure, the caller needs to first
48  * unlink it (@sta_info_unlink()) from the list and hash tables and
49  * then wait for an RCU synchronisation before it can be freed. Due to
50  * the pinning and the possibility of multiple callers trying to remove
51  * the same STA info at the same time, @sta_info_unlink() can clear the
52  * STA info pointer it is passed to indicate that the STA info is owned
53  * by somebody else now.
54  *
55  * If @sta_info_unlink() did not clear the pointer then the caller owns
56  * the STA info structure now and is responsible of destroying it with
57  * a call to @sta_info_destroy(), not before RCU synchronisation, of
58  * course. Note that sta_info_destroy() must be protected by the RTNL.
59  *
60  * In all other cases, there is no concept of ownership on a STA entry,
61  * each structure is owned by the global hash table/list until it is
62  * removed. All users of the structure need to be RCU protected so that
63  * the structure won't be freed before they are done using it.
64  */
65
66 /* Caller must hold local->sta_lock */
67 static int sta_info_hash_del(struct ieee80211_local *local,
68                              struct sta_info *sta)
69 {
70         struct sta_info *s;
71
72         s = local->sta_hash[STA_HASH(sta->addr)];
73         if (!s)
74                 return -ENOENT;
75         if (s == sta) {
76                 rcu_assign_pointer(local->sta_hash[STA_HASH(sta->addr)],
77                                    s->hnext);
78                 return 0;
79         }
80
81         while (s->hnext && s->hnext != sta)
82                 s = s->hnext;
83         if (s->hnext) {
84                 rcu_assign_pointer(s->hnext, sta->hnext);
85                 return 0;
86         }
87
88         return -ENOENT;
89 }
90
91 /* protected by RCU */
92 static struct sta_info *__sta_info_find(struct ieee80211_local *local,
93                                         u8 *addr)
94 {
95         struct sta_info *sta;
96
97         sta = rcu_dereference(local->sta_hash[STA_HASH(addr)]);
98         while (sta) {
99                 if (compare_ether_addr(sta->addr, addr) == 0)
100                         break;
101                 sta = rcu_dereference(sta->hnext);
102         }
103         return sta;
104 }
105
106 struct sta_info *sta_info_get(struct ieee80211_local *local, u8 *addr)
107 {
108         return __sta_info_find(local, addr);
109 }
110 EXPORT_SYMBOL(sta_info_get);
111
112 struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
113                                      struct net_device *dev)
114 {
115         struct sta_info *sta;
116         int i = 0;
117
118         list_for_each_entry_rcu(sta, &local->sta_list, list) {
119                 if (i < idx) {
120                         ++i;
121                         continue;
122                 } else if (!dev || dev == sta->sdata->dev) {
123                         return sta;
124                 }
125         }
126
127         return NULL;
128 }
129
130 void sta_info_destroy(struct sta_info *sta)
131 {
132         struct ieee80211_local *local = sta->local;
133         struct sk_buff *skb;
134         int i;
135         DECLARE_MAC_BUF(mbuf);
136
137         if (!sta)
138                 return;
139
140         ASSERT_RTNL();
141         might_sleep();
142
143         rate_control_remove_sta_debugfs(sta);
144         ieee80211_sta_debugfs_remove(sta);
145
146 #ifdef CONFIG_MAC80211_MESH
147         if (ieee80211_vif_is_mesh(&sta->sdata->vif))
148                 mesh_plink_deactivate(sta);
149 #endif
150
151         /*
152          * NOTE: This will call synchronize_rcu() internally to
153          * make sure no key references can be in use. We rely on
154          * that here for the mesh code!
155          */
156         ieee80211_key_free(sta->key);
157         WARN_ON(sta->key);
158
159 #ifdef CONFIG_MAC80211_MESH
160         if (ieee80211_vif_is_mesh(&sta->sdata->vif))
161                 del_timer_sync(&sta->plink_timer);
162 #endif
163
164         while ((skb = skb_dequeue(&sta->ps_tx_buf)) != NULL) {
165                 local->total_ps_buffered--;
166                 dev_kfree_skb_any(skb);
167         }
168
169         while ((skb = skb_dequeue(&sta->tx_filtered)) != NULL)
170                 dev_kfree_skb_any(skb);
171
172         for (i = 0; i <  STA_TID_NUM; i++) {
173                 del_timer_sync(&sta->ampdu_mlme.tid_rx[i].session_timer);
174                 del_timer_sync(&sta->ampdu_mlme.tid_tx[i].addba_resp_timer);
175         }
176         rate_control_free_sta(sta->rate_ctrl, sta->rate_ctrl_priv);
177         rate_control_put(sta->rate_ctrl);
178
179 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
180         printk(KERN_DEBUG "%s: Destroyed STA %s\n",
181                wiphy_name(local->hw.wiphy), print_mac(mbuf, sta->addr));
182 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
183
184         kfree(sta);
185 }
186
187
188 /* Caller must hold local->sta_lock */
189 static void sta_info_hash_add(struct ieee80211_local *local,
190                               struct sta_info *sta)
191 {
192         sta->hnext = local->sta_hash[STA_HASH(sta->addr)];
193         rcu_assign_pointer(local->sta_hash[STA_HASH(sta->addr)], sta);
194 }
195
196 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
197                                 u8 *addr, gfp_t gfp)
198 {
199         struct ieee80211_local *local = sdata->local;
200         struct sta_info *sta;
201         int i;
202         DECLARE_MAC_BUF(mbuf);
203
204         sta = kzalloc(sizeof(*sta), gfp);
205         if (!sta)
206                 return NULL;
207
208         memcpy(sta->addr, addr, ETH_ALEN);
209         sta->local = local;
210         sta->sdata = sdata;
211
212         sta->rate_ctrl = rate_control_get(local->rate_ctrl);
213         sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
214                                                      gfp);
215         if (!sta->rate_ctrl_priv) {
216                 rate_control_put(sta->rate_ctrl);
217                 kfree(sta);
218                 return NULL;
219         }
220
221         spin_lock_init(&sta->ampdu_mlme.ampdu_rx);
222         spin_lock_init(&sta->ampdu_mlme.ampdu_tx);
223         for (i = 0; i < STA_TID_NUM; i++) {
224                 /* timer_to_tid must be initialized with identity mapping to
225                  * enable session_timer's data differentiation. refer to
226                  * sta_rx_agg_session_timer_expired for useage */
227                 sta->timer_to_tid[i] = i;
228                 /* tid to tx queue: initialize according to HW (0 is valid) */
229                 sta->tid_to_tx_q[i] = local->hw.queues;
230                 /* rx timers */
231                 sta->ampdu_mlme.tid_rx[i].session_timer.function =
232                         sta_rx_agg_session_timer_expired;
233                 sta->ampdu_mlme.tid_rx[i].session_timer.data =
234                         (unsigned long)&sta->timer_to_tid[i];
235                 init_timer(&sta->ampdu_mlme.tid_rx[i].session_timer);
236                 /* tx timers */
237                 sta->ampdu_mlme.tid_tx[i].addba_resp_timer.function =
238                         sta_addba_resp_timer_expired;
239                 sta->ampdu_mlme.tid_tx[i].addba_resp_timer.data =
240                         (unsigned long)&sta->timer_to_tid[i];
241                 init_timer(&sta->ampdu_mlme.tid_tx[i].addba_resp_timer);
242         }
243         skb_queue_head_init(&sta->ps_tx_buf);
244         skb_queue_head_init(&sta->tx_filtered);
245
246 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
247         printk(KERN_DEBUG "%s: Allocated STA %s\n",
248                wiphy_name(local->hw.wiphy), print_mac(mbuf, sta->addr));
249 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
250
251         return sta;
252 }
253
254 int sta_info_insert(struct sta_info *sta)
255 {
256         struct ieee80211_local *local = sta->local;
257         struct ieee80211_sub_if_data *sdata = sta->sdata;
258         unsigned long flags;
259         DECLARE_MAC_BUF(mac);
260
261         spin_lock_irqsave(&local->sta_lock, flags);
262         /* check if STA exists already */
263         if (__sta_info_find(local, sta->addr)) {
264                 spin_unlock_irqrestore(&local->sta_lock, flags);
265                 return -EEXIST;
266         }
267         list_add(&sta->list, &local->sta_list);
268         local->num_sta++;
269         sta_info_hash_add(local, sta);
270
271         /* notify driver */
272         if (local->ops->sta_notify) {
273                 if (sdata->vif.type == IEEE80211_IF_TYPE_VLAN)
274                         sdata = sdata->u.vlan.ap;
275
276                 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
277                                        STA_NOTIFY_ADD, sta->addr);
278         }
279
280 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
281         printk(KERN_DEBUG "%s: Inserted STA %s\n",
282                wiphy_name(local->hw.wiphy), print_mac(mac, sta->addr));
283 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
284
285         spin_unlock_irqrestore(&local->sta_lock, flags);
286
287 #ifdef CONFIG_MAC80211_DEBUGFS
288         /* debugfs entry adding might sleep, so schedule process
289          * context task for adding entry for STAs that do not yet
290          * have one. */
291         queue_work(local->hw.workqueue, &local->sta_debugfs_add);
292 #endif
293
294         if (ieee80211_vif_is_mesh(&sdata->vif))
295                 mesh_accept_plinks_update(sdata);
296
297         return 0;
298 }
299
300 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
301 {
302         /*
303          * This format has been mandated by the IEEE specifications,
304          * so this line may not be changed to use the __set_bit() format.
305          */
306         bss->tim[aid / 8] |= (1 << (aid % 8));
307 }
308
309 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
310 {
311         /*
312          * This format has been mandated by the IEEE specifications,
313          * so this line may not be changed to use the __clear_bit() format.
314          */
315         bss->tim[aid / 8] &= ~(1 << (aid % 8));
316 }
317
318 static void __sta_info_set_tim_bit(struct ieee80211_if_ap *bss,
319                                    struct sta_info *sta)
320 {
321         if (bss)
322                 __bss_tim_set(bss, sta->aid);
323         if (sta->local->ops->set_tim) {
324                 sta->local->tim_in_locked_section = true;
325                 sta->local->ops->set_tim(local_to_hw(sta->local), sta->aid, 1);
326                 sta->local->tim_in_locked_section = false;
327         }
328 }
329
330 void sta_info_set_tim_bit(struct sta_info *sta)
331 {
332         unsigned long flags;
333
334         spin_lock_irqsave(&sta->local->sta_lock, flags);
335         __sta_info_set_tim_bit(sta->sdata->bss, sta);
336         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
337 }
338
339 static void __sta_info_clear_tim_bit(struct ieee80211_if_ap *bss,
340                                      struct sta_info *sta)
341 {
342         if (bss)
343                 __bss_tim_clear(bss, sta->aid);
344         if (sta->local->ops->set_tim) {
345                 sta->local->tim_in_locked_section = true;
346                 sta->local->ops->set_tim(local_to_hw(sta->local), sta->aid, 0);
347                 sta->local->tim_in_locked_section = false;
348         }
349 }
350
351 void sta_info_clear_tim_bit(struct sta_info *sta)
352 {
353         unsigned long flags;
354
355         spin_lock_irqsave(&sta->local->sta_lock, flags);
356         __sta_info_clear_tim_bit(sta->sdata->bss, sta);
357         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
358 }
359
360 /*
361  * See comment in __sta_info_unlink,
362  * caller must hold local->sta_lock.
363  */
364 static void __sta_info_pin(struct sta_info *sta)
365 {
366         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_NORMAL);
367         sta->pin_status = STA_INFO_PIN_STAT_PINNED;
368 }
369
370 /*
371  * See comment in __sta_info_unlink, returns sta if it
372  * needs to be destroyed.
373  */
374 static struct sta_info *__sta_info_unpin(struct sta_info *sta)
375 {
376         struct sta_info *ret = NULL;
377         unsigned long flags;
378
379         spin_lock_irqsave(&sta->local->sta_lock, flags);
380         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_DESTROY &&
381                 sta->pin_status != STA_INFO_PIN_STAT_PINNED);
382         if (sta->pin_status == STA_INFO_PIN_STAT_DESTROY)
383                 ret = sta;
384         sta->pin_status = STA_INFO_PIN_STAT_NORMAL;
385         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
386
387         return ret;
388 }
389
390 static void __sta_info_unlink(struct sta_info **sta)
391 {
392         struct ieee80211_local *local = (*sta)->local;
393         struct ieee80211_sub_if_data *sdata = (*sta)->sdata;
394 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
395         DECLARE_MAC_BUF(mbuf);
396 #endif
397         /*
398          * pull caller's reference if we're already gone.
399          */
400         if (sta_info_hash_del(local, *sta)) {
401                 *sta = NULL;
402                 return;
403         }
404
405         /*
406          * Also pull caller's reference if the STA is pinned by the
407          * task that is adding the debugfs entries. In that case, we
408          * leave the STA "to be freed".
409          *
410          * The rules are not trivial, but not too complex either:
411          *  (1) pin_status is only modified under the sta_lock
412          *  (2) sta_info_debugfs_add_work() will set the status
413          *      to PINNED when it found an item that needs a new
414          *      debugfs directory created. In that case, that item
415          *      must not be freed although all *RCU* users are done
416          *      with it. Hence, we tell the caller of _unlink()
417          *      that the item is already gone (as can happen when
418          *      two tasks try to unlink/destroy at the same time)
419          *  (3) We set the pin_status to DESTROY here when we
420          *      find such an item.
421          *  (4) sta_info_debugfs_add_work() will reset the pin_status
422          *      from PINNED to NORMAL when it is done with the item,
423          *      but will check for DESTROY before resetting it in
424          *      which case it will free the item.
425          */
426         if ((*sta)->pin_status == STA_INFO_PIN_STAT_PINNED) {
427                 (*sta)->pin_status = STA_INFO_PIN_STAT_DESTROY;
428                 *sta = NULL;
429                 return;
430         }
431
432         list_del(&(*sta)->list);
433
434         if ((*sta)->flags & WLAN_STA_PS) {
435                 (*sta)->flags &= ~WLAN_STA_PS;
436                 if (sdata->bss)
437                         atomic_dec(&sdata->bss->num_sta_ps);
438                 __sta_info_clear_tim_bit(sdata->bss, *sta);
439         }
440
441         local->num_sta--;
442
443         if (local->ops->sta_notify) {
444                 if (sdata->vif.type == IEEE80211_IF_TYPE_VLAN)
445                         sdata = sdata->u.vlan.ap;
446
447                 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
448                                        STA_NOTIFY_REMOVE, (*sta)->addr);
449         }
450
451         if (ieee80211_vif_is_mesh(&sdata->vif)) {
452                 mesh_accept_plinks_update(sdata);
453 #ifdef CONFIG_MAC80211_MESH
454                 del_timer(&(*sta)->plink_timer);
455 #endif
456         }
457
458 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
459         printk(KERN_DEBUG "%s: Removed STA %s\n",
460                wiphy_name(local->hw.wiphy), print_mac(mbuf, (*sta)->addr));
461 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
462 }
463
464 void sta_info_unlink(struct sta_info **sta)
465 {
466         struct ieee80211_local *local = (*sta)->local;
467         unsigned long flags;
468
469         spin_lock_irqsave(&local->sta_lock, flags);
470         __sta_info_unlink(sta);
471         spin_unlock_irqrestore(&local->sta_lock, flags);
472 }
473
474 static inline int sta_info_buffer_expired(struct ieee80211_local *local,
475                                           struct sta_info *sta,
476                                           struct sk_buff *skb)
477 {
478         struct ieee80211_tx_packet_data *pkt_data;
479         int timeout;
480
481         if (!skb)
482                 return 0;
483
484         pkt_data = (struct ieee80211_tx_packet_data *) skb->cb;
485
486         /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
487         timeout = (sta->listen_interval * local->hw.conf.beacon_int * 32 /
488                    15625) * HZ;
489         if (timeout < STA_TX_BUFFER_EXPIRE)
490                 timeout = STA_TX_BUFFER_EXPIRE;
491         return time_after(jiffies, pkt_data->jiffies + timeout);
492 }
493
494
495 static void sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
496                                              struct sta_info *sta)
497 {
498         unsigned long flags;
499         struct sk_buff *skb;
500         struct ieee80211_sub_if_data *sdata;
501         DECLARE_MAC_BUF(mac);
502
503         if (skb_queue_empty(&sta->ps_tx_buf))
504                 return;
505
506         for (;;) {
507                 spin_lock_irqsave(&sta->ps_tx_buf.lock, flags);
508                 skb = skb_peek(&sta->ps_tx_buf);
509                 if (sta_info_buffer_expired(local, sta, skb))
510                         skb = __skb_dequeue(&sta->ps_tx_buf);
511                 else
512                         skb = NULL;
513                 spin_unlock_irqrestore(&sta->ps_tx_buf.lock, flags);
514
515                 if (!skb)
516                         break;
517
518                 sdata = sta->sdata;
519                 local->total_ps_buffered--;
520                 printk(KERN_DEBUG "Buffered frame expired (STA "
521                        "%s)\n", print_mac(mac, sta->addr));
522                 dev_kfree_skb(skb);
523
524                 if (skb_queue_empty(&sta->ps_tx_buf))
525                         sta_info_clear_tim_bit(sta);
526         }
527 }
528
529
530 static void sta_info_cleanup(unsigned long data)
531 {
532         struct ieee80211_local *local = (struct ieee80211_local *) data;
533         struct sta_info *sta;
534
535         rcu_read_lock();
536         list_for_each_entry_rcu(sta, &local->sta_list, list)
537                 sta_info_cleanup_expire_buffered(local, sta);
538         rcu_read_unlock();
539
540         local->sta_cleanup.expires =
541                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
542         add_timer(&local->sta_cleanup);
543 }
544
545 #ifdef CONFIG_MAC80211_DEBUGFS
546 static void sta_info_debugfs_add_work(struct work_struct *work)
547 {
548         struct ieee80211_local *local =
549                 container_of(work, struct ieee80211_local, sta_debugfs_add);
550         struct sta_info *sta, *tmp;
551         unsigned long flags;
552
553         while (1) {
554                 sta = NULL;
555
556                 spin_lock_irqsave(&local->sta_lock, flags);
557                 list_for_each_entry(tmp, &local->sta_list, list) {
558                         if (!tmp->debugfs.dir) {
559                                 sta = tmp;
560                                 __sta_info_pin(sta);
561                                 break;
562                         }
563                 }
564                 spin_unlock_irqrestore(&local->sta_lock, flags);
565
566                 if (!sta)
567                         break;
568
569                 ieee80211_sta_debugfs_add(sta);
570                 rate_control_add_sta_debugfs(sta);
571
572                 sta = __sta_info_unpin(sta);
573
574                 if (sta) {
575                         synchronize_rcu();
576                         sta_info_destroy(sta);
577                 }
578         }
579 }
580 #endif
581
582 void sta_info_init(struct ieee80211_local *local)
583 {
584         spin_lock_init(&local->sta_lock);
585         INIT_LIST_HEAD(&local->sta_list);
586
587         setup_timer(&local->sta_cleanup, sta_info_cleanup,
588                     (unsigned long)local);
589         local->sta_cleanup.expires =
590                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
591
592 #ifdef CONFIG_MAC80211_DEBUGFS
593         INIT_WORK(&local->sta_debugfs_add, sta_info_debugfs_add_work);
594 #endif
595 }
596
597 int sta_info_start(struct ieee80211_local *local)
598 {
599         add_timer(&local->sta_cleanup);
600         return 0;
601 }
602
603 void sta_info_stop(struct ieee80211_local *local)
604 {
605         del_timer(&local->sta_cleanup);
606         sta_info_flush(local, NULL);
607 }
608
609 /**
610  * sta_info_flush - flush matching STA entries from the STA table
611  * @local: local interface data
612  * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
613  */
614 void sta_info_flush(struct ieee80211_local *local,
615                     struct ieee80211_sub_if_data *sdata)
616 {
617         struct sta_info *sta, *tmp;
618         LIST_HEAD(tmp_list);
619         unsigned long flags;
620
621         might_sleep();
622
623         spin_lock_irqsave(&local->sta_lock, flags);
624         list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
625                 if (!sdata || sdata == sta->sdata) {
626                         __sta_info_unlink(&sta);
627                         if (sta)
628                                 list_add_tail(&sta->list, &tmp_list);
629                 }
630         }
631         spin_unlock_irqrestore(&local->sta_lock, flags);
632
633         synchronize_rcu();
634
635         list_for_each_entry_safe(sta, tmp, &tmp_list, list)
636                 sta_info_destroy(sta);
637 }