2 * Copyright 2002-2005, Instant802 Networks, Inc.
3 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
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.
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>
20 #include <net/mac80211.h>
21 #include "ieee80211_i.h"
24 #include "debugfs_sta.h"
28 * DOC: STA information lifetime rules
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.
34 * Upon allocating a STA info structure with sta_info_alloc(), the caller owns
35 * that structure. It must then either destroy it using sta_info_destroy()
36 * (which is pretty useless) or insert it into the hash table using
37 * sta_info_insert() which demotes the reference from ownership to a regular
38 * RCU-protected reference; if the function is called without protection by an
39 * RCU critical section the reference is instantly invalidated. Note that the
40 * caller may not do much with the STA info before inserting it, in particular,
41 * it may not start any mesh peer link management or add encryption keys.
43 * When the insertion fails (sta_info_insert()) returns non-zero), the
44 * structure will have been freed by sta_info_insert()!
46 * Because there are debugfs entries for each station, and adding those
47 * must be able to sleep, it is also possible to "pin" a station entry,
48 * that means it can be removed from the hash table but not be freed.
49 * See the comment in __sta_info_unlink() for more information, this is
50 * an internal capability only.
52 * In order to remove a STA info structure, the caller needs to first
53 * unlink it (sta_info_unlink()) from the list and hash tables and
54 * then destroy it; sta_info_destroy() will wait for an RCU grace period
55 * to elapse before actually freeing it. Due to the pinning and the
56 * possibility of multiple callers trying to remove the same STA info at
57 * the same time, sta_info_unlink() can clear the STA info pointer it is
58 * passed to indicate that the STA info is owned by somebody else now.
60 * If sta_info_unlink() did not clear the pointer then the caller owns
61 * the STA info structure now and is responsible of destroying it with
62 * a call to sta_info_destroy().
64 * In all other cases, there is no concept of ownership on a STA entry,
65 * each structure is owned by the global hash table/list until it is
66 * removed. All users of the structure need to be RCU protected so that
67 * the structure won't be freed before they are done using it.
70 /* Caller must hold local->sta_lock */
71 static int sta_info_hash_del(struct ieee80211_local *local,
76 s = local->sta_hash[STA_HASH(sta->addr)];
80 rcu_assign_pointer(local->sta_hash[STA_HASH(sta->addr)],
85 while (s->hnext && s->hnext != sta)
88 rcu_assign_pointer(s->hnext, sta->hnext);
95 /* protected by RCU */
96 static struct sta_info *__sta_info_find(struct ieee80211_local *local,
101 sta = rcu_dereference(local->sta_hash[STA_HASH(addr)]);
103 if (compare_ether_addr(sta->addr, addr) == 0)
105 sta = rcu_dereference(sta->hnext);
110 struct sta_info *sta_info_get(struct ieee80211_local *local, u8 *addr)
112 return __sta_info_find(local, addr);
114 EXPORT_SYMBOL(sta_info_get);
116 struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
117 struct net_device *dev)
119 struct sta_info *sta;
122 list_for_each_entry_rcu(sta, &local->sta_list, list) {
123 if (dev && dev != sta->sdata->dev)
136 * __sta_info_free - internal STA free helper
138 * @local: pointer to the global information
139 * @sta: STA info to free
141 * This function must undo everything done by sta_info_alloc()
142 * that may happen before sta_info_insert().
144 static void __sta_info_free(struct ieee80211_local *local,
145 struct sta_info *sta)
147 DECLARE_MAC_BUF(mbuf);
149 rate_control_free_sta(sta->rate_ctrl, sta->rate_ctrl_priv);
150 rate_control_put(sta->rate_ctrl);
152 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
153 printk(KERN_DEBUG "%s: Destroyed STA %s\n",
154 wiphy_name(local->hw.wiphy), print_mac(mbuf, sta->addr));
155 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
160 void sta_info_destroy(struct sta_info *sta)
162 struct ieee80211_local *local;
173 rate_control_remove_sta_debugfs(sta);
174 ieee80211_sta_debugfs_remove(sta);
176 #ifdef CONFIG_MAC80211_MESH
177 if (ieee80211_vif_is_mesh(&sta->sdata->vif))
178 mesh_plink_deactivate(sta);
182 * We have only unlinked the key, and actually destroying it
183 * may mean it is removed from hardware which requires that
184 * the key->sta pointer is still valid, so flush the key todo
187 * ieee80211_key_todo() will synchronize_rcu() so after this
188 * nothing can reference this sta struct any more.
190 ieee80211_key_todo();
192 #ifdef CONFIG_MAC80211_MESH
193 if (ieee80211_vif_is_mesh(&sta->sdata->vif))
194 del_timer_sync(&sta->plink_timer);
197 while ((skb = skb_dequeue(&sta->ps_tx_buf)) != NULL) {
198 local->total_ps_buffered--;
199 dev_kfree_skb_any(skb);
202 while ((skb = skb_dequeue(&sta->tx_filtered)) != NULL)
203 dev_kfree_skb_any(skb);
205 for (i = 0; i < STA_TID_NUM; i++) {
206 spin_lock_bh(&sta->lock);
207 if (sta->ampdu_mlme.tid_rx[i])
208 del_timer_sync(&sta->ampdu_mlme.tid_rx[i]->session_timer);
209 if (sta->ampdu_mlme.tid_tx[i])
210 del_timer_sync(&sta->ampdu_mlme.tid_tx[i]->addba_resp_timer);
211 spin_unlock_bh(&sta->lock);
214 __sta_info_free(local, sta);
218 /* Caller must hold local->sta_lock */
219 static void sta_info_hash_add(struct ieee80211_local *local,
220 struct sta_info *sta)
222 sta->hnext = local->sta_hash[STA_HASH(sta->addr)];
223 rcu_assign_pointer(local->sta_hash[STA_HASH(sta->addr)], sta);
226 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
229 struct ieee80211_local *local = sdata->local;
230 struct sta_info *sta;
232 DECLARE_MAC_BUF(mbuf);
234 sta = kzalloc(sizeof(*sta), gfp);
238 spin_lock_init(&sta->lock);
239 spin_lock_init(&sta->flaglock);
241 memcpy(sta->addr, addr, ETH_ALEN);
245 sta->rate_ctrl = rate_control_get(local->rate_ctrl);
246 sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
248 if (!sta->rate_ctrl_priv) {
249 rate_control_put(sta->rate_ctrl);
254 for (i = 0; i < STA_TID_NUM; i++) {
255 /* timer_to_tid must be initialized with identity mapping to
256 * enable session_timer's data differentiation. refer to
257 * sta_rx_agg_session_timer_expired for useage */
258 sta->timer_to_tid[i] = i;
259 /* tid to tx queue: initialize according to HW (0 is valid) */
260 sta->tid_to_tx_q[i] = ieee80211_num_queues(&local->hw);
262 sta->ampdu_mlme.tid_state_rx[i] = HT_AGG_STATE_IDLE;
263 sta->ampdu_mlme.tid_rx[i] = NULL;
265 sta->ampdu_mlme.tid_state_tx[i] = HT_AGG_STATE_IDLE;
266 sta->ampdu_mlme.tid_tx[i] = NULL;
267 sta->ampdu_mlme.addba_req_num[i] = 0;
269 skb_queue_head_init(&sta->ps_tx_buf);
270 skb_queue_head_init(&sta->tx_filtered);
272 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
273 printk(KERN_DEBUG "%s: Allocated STA %s\n",
274 wiphy_name(local->hw.wiphy), print_mac(mbuf, sta->addr));
275 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
277 #ifdef CONFIG_MAC80211_MESH
278 sta->plink_state = PLINK_LISTEN;
279 init_timer(&sta->plink_timer);
285 int sta_info_insert(struct sta_info *sta)
287 struct ieee80211_local *local = sta->local;
288 struct ieee80211_sub_if_data *sdata = sta->sdata;
291 DECLARE_MAC_BUF(mac);
294 * Can't be a WARN_ON because it can be triggered through a race:
295 * something inserts a STA (on one CPU) without holding the RTNL
296 * and another CPU turns off the net device.
298 if (unlikely(!netif_running(sdata->dev))) {
303 if (WARN_ON(compare_ether_addr(sta->addr, sdata->dev->dev_addr) == 0 ||
304 is_multicast_ether_addr(sta->addr))) {
309 spin_lock_irqsave(&local->sta_lock, flags);
310 /* check if STA exists already */
311 if (__sta_info_find(local, sta->addr)) {
312 spin_unlock_irqrestore(&local->sta_lock, flags);
316 list_add(&sta->list, &local->sta_list);
318 sta_info_hash_add(local, sta);
321 if (local->ops->sta_notify) {
322 if (sdata->vif.type == IEEE80211_IF_TYPE_VLAN)
323 sdata = container_of(sdata->bss,
324 struct ieee80211_sub_if_data,
327 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
328 STA_NOTIFY_ADD, sta->addr);
331 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
332 printk(KERN_DEBUG "%s: Inserted STA %s\n",
333 wiphy_name(local->hw.wiphy), print_mac(mac, sta->addr));
334 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
336 spin_unlock_irqrestore(&local->sta_lock, flags);
338 #ifdef CONFIG_MAC80211_DEBUGFS
340 * Debugfs entry adding might sleep, so schedule process
341 * context task for adding entry for STAs that do not yet
343 * NOTE: due to auto-freeing semantics this may only be done
344 * if the insertion is successful!
346 schedule_work(&local->sta_debugfs_add);
349 if (ieee80211_vif_is_mesh(&sdata->vif))
350 mesh_accept_plinks_update(sdata);
355 __sta_info_free(local, sta);
359 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
362 * This format has been mandated by the IEEE specifications,
363 * so this line may not be changed to use the __set_bit() format.
365 bss->tim[aid / 8] |= (1 << (aid % 8));
368 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
371 * This format has been mandated by the IEEE specifications,
372 * so this line may not be changed to use the __clear_bit() format.
374 bss->tim[aid / 8] &= ~(1 << (aid % 8));
377 static void __sta_info_set_tim_bit(struct ieee80211_if_ap *bss,
378 struct sta_info *sta)
382 __bss_tim_set(bss, sta->aid);
384 if (sta->local->ops->set_tim) {
385 sta->local->tim_in_locked_section = true;
386 sta->local->ops->set_tim(local_to_hw(sta->local), sta->aid, 1);
387 sta->local->tim_in_locked_section = false;
391 void sta_info_set_tim_bit(struct sta_info *sta)
395 BUG_ON(!sta->sdata->bss);
397 spin_lock_irqsave(&sta->local->sta_lock, flags);
398 __sta_info_set_tim_bit(sta->sdata->bss, sta);
399 spin_unlock_irqrestore(&sta->local->sta_lock, flags);
402 static void __sta_info_clear_tim_bit(struct ieee80211_if_ap *bss,
403 struct sta_info *sta)
407 __bss_tim_clear(bss, sta->aid);
409 if (sta->local->ops->set_tim) {
410 sta->local->tim_in_locked_section = true;
411 sta->local->ops->set_tim(local_to_hw(sta->local), sta->aid, 0);
412 sta->local->tim_in_locked_section = false;
416 void sta_info_clear_tim_bit(struct sta_info *sta)
420 BUG_ON(!sta->sdata->bss);
422 spin_lock_irqsave(&sta->local->sta_lock, flags);
423 __sta_info_clear_tim_bit(sta->sdata->bss, sta);
424 spin_unlock_irqrestore(&sta->local->sta_lock, flags);
427 void __sta_info_unlink(struct sta_info **sta)
429 struct ieee80211_local *local = (*sta)->local;
430 struct ieee80211_sub_if_data *sdata = (*sta)->sdata;
431 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
432 DECLARE_MAC_BUF(mbuf);
435 * pull caller's reference if we're already gone.
437 if (sta_info_hash_del(local, *sta)) {
443 ieee80211_key_free((*sta)->key);
444 WARN_ON((*sta)->key);
447 list_del(&(*sta)->list);
449 if (test_and_clear_sta_flags(*sta, WLAN_STA_PS)) {
452 atomic_dec(&sdata->bss->num_sta_ps);
453 __sta_info_clear_tim_bit(sdata->bss, *sta);
458 if (local->ops->sta_notify) {
459 if (sdata->vif.type == IEEE80211_IF_TYPE_VLAN)
460 sdata = container_of(sdata->bss,
461 struct ieee80211_sub_if_data,
464 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
465 STA_NOTIFY_REMOVE, (*sta)->addr);
468 if (ieee80211_vif_is_mesh(&sdata->vif)) {
469 mesh_accept_plinks_update(sdata);
470 #ifdef CONFIG_MAC80211_MESH
471 del_timer(&(*sta)->plink_timer);
475 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
476 printk(KERN_DEBUG "%s: Removed STA %s\n",
477 wiphy_name(local->hw.wiphy), print_mac(mbuf, (*sta)->addr));
478 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
481 * Finally, pull caller's reference if the STA is pinned by the
482 * task that is adding the debugfs entries. In that case, we
483 * leave the STA "to be freed".
485 * The rules are not trivial, but not too complex either:
486 * (1) pin_status is only modified under the sta_lock
487 * (2) STAs may only be pinned under the RTNL so that
488 * sta_info_flush() is guaranteed to actually destroy
489 * all STAs that are active for a given interface, this
490 * is required for correctness because otherwise we
491 * could notify a driver that an interface is going
492 * away and only after that (!) notify it about a STA
493 * on that interface going away.
494 * (3) sta_info_debugfs_add_work() will set the status
495 * to PINNED when it found an item that needs a new
496 * debugfs directory created. In that case, that item
497 * must not be freed although all *RCU* users are done
498 * with it. Hence, we tell the caller of _unlink()
499 * that the item is already gone (as can happen when
500 * two tasks try to unlink/destroy at the same time)
501 * (4) We set the pin_status to DESTROY here when we
503 * (5) sta_info_debugfs_add_work() will reset the pin_status
504 * from PINNED to NORMAL when it is done with the item,
505 * but will check for DESTROY before resetting it in
506 * which case it will free the item.
508 if ((*sta)->pin_status == STA_INFO_PIN_STAT_PINNED) {
509 (*sta)->pin_status = STA_INFO_PIN_STAT_DESTROY;
515 void sta_info_unlink(struct sta_info **sta)
517 struct ieee80211_local *local = (*sta)->local;
520 spin_lock_irqsave(&local->sta_lock, flags);
521 __sta_info_unlink(sta);
522 spin_unlock_irqrestore(&local->sta_lock, flags);
525 static inline int sta_info_buffer_expired(struct ieee80211_local *local,
526 struct sta_info *sta,
529 struct ieee80211_tx_info *info;
535 info = IEEE80211_SKB_CB(skb);
537 /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
538 timeout = (sta->listen_interval * local->hw.conf.beacon_int * 32 /
540 if (timeout < STA_TX_BUFFER_EXPIRE)
541 timeout = STA_TX_BUFFER_EXPIRE;
542 return time_after(jiffies, info->control.jiffies + timeout);
546 static void sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
547 struct sta_info *sta)
551 struct ieee80211_sub_if_data *sdata;
552 DECLARE_MAC_BUF(mac);
554 if (skb_queue_empty(&sta->ps_tx_buf))
558 spin_lock_irqsave(&sta->ps_tx_buf.lock, flags);
559 skb = skb_peek(&sta->ps_tx_buf);
560 if (sta_info_buffer_expired(local, sta, skb))
561 skb = __skb_dequeue(&sta->ps_tx_buf);
564 spin_unlock_irqrestore(&sta->ps_tx_buf.lock, flags);
570 local->total_ps_buffered--;
571 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
572 printk(KERN_DEBUG "Buffered frame expired (STA "
573 "%s)\n", print_mac(mac, sta->addr));
577 if (skb_queue_empty(&sta->ps_tx_buf))
578 sta_info_clear_tim_bit(sta);
583 static void sta_info_cleanup(unsigned long data)
585 struct ieee80211_local *local = (struct ieee80211_local *) data;
586 struct sta_info *sta;
589 list_for_each_entry_rcu(sta, &local->sta_list, list)
590 sta_info_cleanup_expire_buffered(local, sta);
593 local->sta_cleanup.expires =
594 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
595 add_timer(&local->sta_cleanup);
598 #ifdef CONFIG_MAC80211_DEBUGFS
600 * See comment in __sta_info_unlink,
601 * caller must hold local->sta_lock.
603 static void __sta_info_pin(struct sta_info *sta)
605 WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_NORMAL);
606 sta->pin_status = STA_INFO_PIN_STAT_PINNED;
610 * See comment in __sta_info_unlink, returns sta if it
611 * needs to be destroyed.
613 static struct sta_info *__sta_info_unpin(struct sta_info *sta)
615 struct sta_info *ret = NULL;
618 spin_lock_irqsave(&sta->local->sta_lock, flags);
619 WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_DESTROY &&
620 sta->pin_status != STA_INFO_PIN_STAT_PINNED);
621 if (sta->pin_status == STA_INFO_PIN_STAT_DESTROY)
623 sta->pin_status = STA_INFO_PIN_STAT_NORMAL;
624 spin_unlock_irqrestore(&sta->local->sta_lock, flags);
629 static void sta_info_debugfs_add_work(struct work_struct *work)
631 struct ieee80211_local *local =
632 container_of(work, struct ieee80211_local, sta_debugfs_add);
633 struct sta_info *sta, *tmp;
636 /* We need to keep the RTNL across the whole pinned status. */
641 spin_lock_irqsave(&local->sta_lock, flags);
642 list_for_each_entry(tmp, &local->sta_list, list) {
643 if (!tmp->debugfs.dir) {
649 spin_unlock_irqrestore(&local->sta_lock, flags);
654 ieee80211_sta_debugfs_add(sta);
655 rate_control_add_sta_debugfs(sta);
657 sta = __sta_info_unpin(sta);
658 sta_info_destroy(sta);
664 static void __ieee80211_run_pending_flush(struct ieee80211_local *local)
666 struct sta_info *sta;
671 spin_lock_irqsave(&local->sta_lock, flags);
672 while (!list_empty(&local->sta_flush_list)) {
673 sta = list_first_entry(&local->sta_flush_list,
674 struct sta_info, list);
675 list_del(&sta->list);
676 spin_unlock_irqrestore(&local->sta_lock, flags);
677 sta_info_destroy(sta);
678 spin_lock_irqsave(&local->sta_lock, flags);
680 spin_unlock_irqrestore(&local->sta_lock, flags);
683 static void ieee80211_sta_flush_work(struct work_struct *work)
685 struct ieee80211_local *local =
686 container_of(work, struct ieee80211_local, sta_flush_work);
689 __ieee80211_run_pending_flush(local);
693 void sta_info_init(struct ieee80211_local *local)
695 spin_lock_init(&local->sta_lock);
696 INIT_LIST_HEAD(&local->sta_list);
697 INIT_LIST_HEAD(&local->sta_flush_list);
698 INIT_WORK(&local->sta_flush_work, ieee80211_sta_flush_work);
700 setup_timer(&local->sta_cleanup, sta_info_cleanup,
701 (unsigned long)local);
702 local->sta_cleanup.expires =
703 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
705 #ifdef CONFIG_MAC80211_DEBUGFS
706 INIT_WORK(&local->sta_debugfs_add, sta_info_debugfs_add_work);
710 int sta_info_start(struct ieee80211_local *local)
712 add_timer(&local->sta_cleanup);
716 void sta_info_stop(struct ieee80211_local *local)
718 del_timer(&local->sta_cleanup);
719 cancel_work_sync(&local->sta_flush_work);
720 #ifdef CONFIG_MAC80211_DEBUGFS
722 * Make sure the debugfs adding work isn't pending after this
723 * because we're about to be destroyed. It doesn't matter
724 * whether it ran or not since we're going to flush all STAs
727 cancel_work_sync(&local->sta_debugfs_add);
731 sta_info_flush(local, NULL);
732 __ieee80211_run_pending_flush(local);
737 * sta_info_flush - flush matching STA entries from the STA table
739 * Returns the number of removed STA entries.
741 * @local: local interface data
742 * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
744 int sta_info_flush(struct ieee80211_local *local,
745 struct ieee80211_sub_if_data *sdata)
747 struct sta_info *sta, *tmp;
755 spin_lock_irqsave(&local->sta_lock, flags);
756 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
757 if (!sdata || sdata == sta->sdata) {
758 __sta_info_unlink(&sta);
760 list_add_tail(&sta->list, &tmp_list);
765 spin_unlock_irqrestore(&local->sta_lock, flags);
767 list_for_each_entry_safe(sta, tmp, &tmp_list, list)
768 sta_info_destroy(sta);
774 * sta_info_flush_delayed - flush matching STA entries from the STA table
776 * This function unlinks all stations for a given interface and queues
777 * them for freeing. Note that the workqueue function scheduled here has
778 * to run before any new keys can be added to the system to avoid set_key()
779 * callback ordering issues.
781 * @sdata: the interface
783 void sta_info_flush_delayed(struct ieee80211_sub_if_data *sdata)
785 struct ieee80211_local *local = sdata->local;
786 struct sta_info *sta, *tmp;
790 spin_lock_irqsave(&local->sta_lock, flags);
791 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
792 if (sdata == sta->sdata) {
793 __sta_info_unlink(&sta);
795 list_add_tail(&sta->list,
796 &local->sta_flush_list);
802 schedule_work(&local->sta_flush_work);
803 spin_unlock_irqrestore(&local->sta_lock, flags);