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->sta.addr)];
80 rcu_assign_pointer(local->sta_hash[STA_HASH(sta->sta.addr)],
85 while (s->hnext && s->hnext != sta)
88 rcu_assign_pointer(s->hnext, sta->hnext);
95 /* protected by RCU */
96 struct sta_info *sta_info_get(struct ieee80211_local *local, const u8 *addr)
100 sta = rcu_dereference(local->sta_hash[STA_HASH(addr)]);
102 if (memcmp(sta->sta.addr, addr, ETH_ALEN) == 0)
104 sta = rcu_dereference(sta->hnext);
109 struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
110 struct net_device *dev)
112 struct sta_info *sta;
115 list_for_each_entry_rcu(sta, &local->sta_list, list) {
116 if (dev && dev != sta->sdata->dev)
129 * __sta_info_free - internal STA free helper
131 * @local: pointer to the global information
132 * @sta: STA info to free
134 * This function must undo everything done by sta_info_alloc()
135 * that may happen before sta_info_insert().
137 static void __sta_info_free(struct ieee80211_local *local,
138 struct sta_info *sta)
140 rate_control_free_sta(sta);
141 rate_control_put(sta->rate_ctrl);
143 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
144 printk(KERN_DEBUG "%s: Destroyed STA %pM\n",
145 wiphy_name(local->hw.wiphy), sta->sta.addr);
146 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
151 void sta_info_destroy(struct sta_info *sta)
153 struct ieee80211_local *local;
164 rate_control_remove_sta_debugfs(sta);
165 ieee80211_sta_debugfs_remove(sta);
167 #ifdef CONFIG_MAC80211_MESH
168 if (ieee80211_vif_is_mesh(&sta->sdata->vif))
169 mesh_plink_deactivate(sta);
173 * We have only unlinked the key, and actually destroying it
174 * may mean it is removed from hardware which requires that
175 * the key->sta pointer is still valid, so flush the key todo
178 * ieee80211_key_todo() will synchronize_rcu() so after this
179 * nothing can reference this sta struct any more.
181 ieee80211_key_todo();
183 #ifdef CONFIG_MAC80211_MESH
184 if (ieee80211_vif_is_mesh(&sta->sdata->vif))
185 del_timer_sync(&sta->plink_timer);
188 while ((skb = skb_dequeue(&sta->ps_tx_buf)) != NULL) {
189 local->total_ps_buffered--;
190 dev_kfree_skb_any(skb);
193 while ((skb = skb_dequeue(&sta->tx_filtered)) != NULL)
194 dev_kfree_skb_any(skb);
196 for (i = 0; i < STA_TID_NUM; i++) {
197 spin_lock_bh(&sta->lock);
198 if (sta->ampdu_mlme.tid_rx[i])
199 del_timer_sync(&sta->ampdu_mlme.tid_rx[i]->session_timer);
200 if (sta->ampdu_mlme.tid_tx[i])
201 del_timer_sync(&sta->ampdu_mlme.tid_tx[i]->addba_resp_timer);
202 spin_unlock_bh(&sta->lock);
205 __sta_info_free(local, sta);
209 /* Caller must hold local->sta_lock */
210 static void sta_info_hash_add(struct ieee80211_local *local,
211 struct sta_info *sta)
213 sta->hnext = local->sta_hash[STA_HASH(sta->sta.addr)];
214 rcu_assign_pointer(local->sta_hash[STA_HASH(sta->sta.addr)], sta);
217 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
220 struct ieee80211_local *local = sdata->local;
221 struct sta_info *sta;
224 sta = kzalloc(sizeof(*sta) + local->hw.sta_data_size, gfp);
228 spin_lock_init(&sta->lock);
229 spin_lock_init(&sta->flaglock);
231 memcpy(sta->sta.addr, addr, ETH_ALEN);
235 sta->rate_ctrl = rate_control_get(local->rate_ctrl);
236 sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
238 if (!sta->rate_ctrl_priv) {
239 rate_control_put(sta->rate_ctrl);
244 for (i = 0; i < STA_TID_NUM; i++) {
245 /* timer_to_tid must be initialized with identity mapping to
246 * enable session_timer's data differentiation. refer to
247 * sta_rx_agg_session_timer_expired for useage */
248 sta->timer_to_tid[i] = i;
249 /* tid to tx queue: initialize according to HW (0 is valid) */
250 sta->tid_to_tx_q[i] = ieee80211_num_queues(&local->hw);
252 sta->ampdu_mlme.tid_state_rx[i] = HT_AGG_STATE_IDLE;
253 sta->ampdu_mlme.tid_rx[i] = NULL;
255 sta->ampdu_mlme.tid_state_tx[i] = HT_AGG_STATE_IDLE;
256 sta->ampdu_mlme.tid_tx[i] = NULL;
257 sta->ampdu_mlme.addba_req_num[i] = 0;
259 skb_queue_head_init(&sta->ps_tx_buf);
260 skb_queue_head_init(&sta->tx_filtered);
262 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
263 printk(KERN_DEBUG "%s: Allocated STA %pM\n",
264 wiphy_name(local->hw.wiphy), sta->sta.addr);
265 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
267 #ifdef CONFIG_MAC80211_MESH
268 sta->plink_state = PLINK_LISTEN;
269 init_timer(&sta->plink_timer);
275 int sta_info_insert(struct sta_info *sta)
277 struct ieee80211_local *local = sta->local;
278 struct ieee80211_sub_if_data *sdata = sta->sdata;
283 * Can't be a WARN_ON because it can be triggered through a race:
284 * something inserts a STA (on one CPU) without holding the RTNL
285 * and another CPU turns off the net device.
287 if (unlikely(!netif_running(sdata->dev))) {
292 if (WARN_ON(compare_ether_addr(sta->sta.addr, sdata->dev->dev_addr) == 0 ||
293 is_multicast_ether_addr(sta->sta.addr))) {
298 spin_lock_irqsave(&local->sta_lock, flags);
299 /* check if STA exists already */
300 if (sta_info_get(local, sta->sta.addr)) {
301 spin_unlock_irqrestore(&local->sta_lock, flags);
305 list_add(&sta->list, &local->sta_list);
307 sta_info_hash_add(local, sta);
310 if (local->ops->sta_notify) {
311 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
312 sdata = container_of(sdata->bss,
313 struct ieee80211_sub_if_data,
316 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
317 STA_NOTIFY_ADD, &sta->sta);
320 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
321 printk(KERN_DEBUG "%s: Inserted STA %pM\n",
322 wiphy_name(local->hw.wiphy), sta->sta.addr);
323 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
325 spin_unlock_irqrestore(&local->sta_lock, flags);
327 #ifdef CONFIG_MAC80211_DEBUGFS
329 * Debugfs entry adding might sleep, so schedule process
330 * context task for adding entry for STAs that do not yet
332 * NOTE: due to auto-freeing semantics this may only be done
333 * if the insertion is successful!
335 schedule_work(&local->sta_debugfs_add);
338 if (ieee80211_vif_is_mesh(&sdata->vif))
339 mesh_accept_plinks_update(sdata);
344 __sta_info_free(local, sta);
348 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
351 * This format has been mandated by the IEEE specifications,
352 * so this line may not be changed to use the __set_bit() format.
354 bss->tim[aid / 8] |= (1 << (aid % 8));
357 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
360 * This format has been mandated by the IEEE specifications,
361 * so this line may not be changed to use the __clear_bit() format.
363 bss->tim[aid / 8] &= ~(1 << (aid % 8));
366 static void __sta_info_set_tim_bit(struct ieee80211_if_ap *bss,
367 struct sta_info *sta)
371 __bss_tim_set(bss, sta->sta.aid);
373 if (sta->local->ops->set_tim) {
374 sta->local->tim_in_locked_section = true;
375 sta->local->ops->set_tim(local_to_hw(sta->local),
377 sta->local->tim_in_locked_section = false;
381 void sta_info_set_tim_bit(struct sta_info *sta)
385 BUG_ON(!sta->sdata->bss);
387 spin_lock_irqsave(&sta->local->sta_lock, flags);
388 __sta_info_set_tim_bit(sta->sdata->bss, sta);
389 spin_unlock_irqrestore(&sta->local->sta_lock, flags);
392 static void __sta_info_clear_tim_bit(struct ieee80211_if_ap *bss,
393 struct sta_info *sta)
397 __bss_tim_clear(bss, sta->sta.aid);
399 if (sta->local->ops->set_tim) {
400 sta->local->tim_in_locked_section = true;
401 sta->local->ops->set_tim(local_to_hw(sta->local),
403 sta->local->tim_in_locked_section = false;
407 void sta_info_clear_tim_bit(struct sta_info *sta)
411 BUG_ON(!sta->sdata->bss);
413 spin_lock_irqsave(&sta->local->sta_lock, flags);
414 __sta_info_clear_tim_bit(sta->sdata->bss, sta);
415 spin_unlock_irqrestore(&sta->local->sta_lock, flags);
418 static void __sta_info_unlink(struct sta_info **sta)
420 struct ieee80211_local *local = (*sta)->local;
421 struct ieee80211_sub_if_data *sdata = (*sta)->sdata;
423 * pull caller's reference if we're already gone.
425 if (sta_info_hash_del(local, *sta)) {
431 ieee80211_key_free((*sta)->key);
432 WARN_ON((*sta)->key);
435 list_del(&(*sta)->list);
437 if (test_and_clear_sta_flags(*sta, WLAN_STA_PS)) {
440 atomic_dec(&sdata->bss->num_sta_ps);
441 __sta_info_clear_tim_bit(sdata->bss, *sta);
446 if (local->ops->sta_notify) {
447 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
448 sdata = container_of(sdata->bss,
449 struct ieee80211_sub_if_data,
452 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
453 STA_NOTIFY_REMOVE, &(*sta)->sta);
456 if (ieee80211_vif_is_mesh(&sdata->vif)) {
457 mesh_accept_plinks_update(sdata);
458 #ifdef CONFIG_MAC80211_MESH
459 del_timer(&(*sta)->plink_timer);
463 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
464 printk(KERN_DEBUG "%s: Removed STA %pM\n",
465 wiphy_name(local->hw.wiphy), (*sta)->sta.addr);
466 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
469 * Finally, pull caller's reference if the STA is pinned by the
470 * task that is adding the debugfs entries. In that case, we
471 * leave the STA "to be freed".
473 * The rules are not trivial, but not too complex either:
474 * (1) pin_status is only modified under the sta_lock
475 * (2) STAs may only be pinned under the RTNL so that
476 * sta_info_flush() is guaranteed to actually destroy
477 * all STAs that are active for a given interface, this
478 * is required for correctness because otherwise we
479 * could notify a driver that an interface is going
480 * away and only after that (!) notify it about a STA
481 * on that interface going away.
482 * (3) sta_info_debugfs_add_work() will set the status
483 * to PINNED when it found an item that needs a new
484 * debugfs directory created. In that case, that item
485 * must not be freed although all *RCU* users are done
486 * with it. Hence, we tell the caller of _unlink()
487 * that the item is already gone (as can happen when
488 * two tasks try to unlink/destroy at the same time)
489 * (4) We set the pin_status to DESTROY here when we
491 * (5) sta_info_debugfs_add_work() will reset the pin_status
492 * from PINNED to NORMAL when it is done with the item,
493 * but will check for DESTROY before resetting it in
494 * which case it will free the item.
496 if ((*sta)->pin_status == STA_INFO_PIN_STAT_PINNED) {
497 (*sta)->pin_status = STA_INFO_PIN_STAT_DESTROY;
503 void sta_info_unlink(struct sta_info **sta)
505 struct ieee80211_local *local = (*sta)->local;
508 spin_lock_irqsave(&local->sta_lock, flags);
509 __sta_info_unlink(sta);
510 spin_unlock_irqrestore(&local->sta_lock, flags);
513 static inline int sta_info_buffer_expired(struct ieee80211_local *local,
514 struct sta_info *sta,
517 struct ieee80211_tx_info *info;
523 info = IEEE80211_SKB_CB(skb);
525 /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
526 timeout = (sta->listen_interval * local->hw.conf.beacon_int * 32 /
528 if (timeout < STA_TX_BUFFER_EXPIRE)
529 timeout = STA_TX_BUFFER_EXPIRE;
530 return time_after(jiffies, info->control.jiffies + timeout);
534 static void sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
535 struct sta_info *sta)
539 struct ieee80211_sub_if_data *sdata;
541 if (skb_queue_empty(&sta->ps_tx_buf))
545 spin_lock_irqsave(&sta->ps_tx_buf.lock, flags);
546 skb = skb_peek(&sta->ps_tx_buf);
547 if (sta_info_buffer_expired(local, sta, skb))
548 skb = __skb_dequeue(&sta->ps_tx_buf);
551 spin_unlock_irqrestore(&sta->ps_tx_buf.lock, flags);
557 local->total_ps_buffered--;
558 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
559 printk(KERN_DEBUG "Buffered frame expired (STA %pM)\n",
564 if (skb_queue_empty(&sta->ps_tx_buf))
565 sta_info_clear_tim_bit(sta);
570 static void sta_info_cleanup(unsigned long data)
572 struct ieee80211_local *local = (struct ieee80211_local *) data;
573 struct sta_info *sta;
576 list_for_each_entry_rcu(sta, &local->sta_list, list)
577 sta_info_cleanup_expire_buffered(local, sta);
580 local->sta_cleanup.expires =
581 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
582 add_timer(&local->sta_cleanup);
585 #ifdef CONFIG_MAC80211_DEBUGFS
587 * See comment in __sta_info_unlink,
588 * caller must hold local->sta_lock.
590 static void __sta_info_pin(struct sta_info *sta)
592 WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_NORMAL);
593 sta->pin_status = STA_INFO_PIN_STAT_PINNED;
597 * See comment in __sta_info_unlink, returns sta if it
598 * needs to be destroyed.
600 static struct sta_info *__sta_info_unpin(struct sta_info *sta)
602 struct sta_info *ret = NULL;
605 spin_lock_irqsave(&sta->local->sta_lock, flags);
606 WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_DESTROY &&
607 sta->pin_status != STA_INFO_PIN_STAT_PINNED);
608 if (sta->pin_status == STA_INFO_PIN_STAT_DESTROY)
610 sta->pin_status = STA_INFO_PIN_STAT_NORMAL;
611 spin_unlock_irqrestore(&sta->local->sta_lock, flags);
616 static void sta_info_debugfs_add_work(struct work_struct *work)
618 struct ieee80211_local *local =
619 container_of(work, struct ieee80211_local, sta_debugfs_add);
620 struct sta_info *sta, *tmp;
623 /* We need to keep the RTNL across the whole pinned status. */
628 spin_lock_irqsave(&local->sta_lock, flags);
629 list_for_each_entry(tmp, &local->sta_list, list) {
631 * debugfs.add_has_run will be set by
632 * ieee80211_sta_debugfs_add regardless
633 * of what else it does.
635 if (!tmp->debugfs.add_has_run) {
641 spin_unlock_irqrestore(&local->sta_lock, flags);
646 ieee80211_sta_debugfs_add(sta);
647 rate_control_add_sta_debugfs(sta);
649 sta = __sta_info_unpin(sta);
650 sta_info_destroy(sta);
656 static void __ieee80211_run_pending_flush(struct ieee80211_local *local)
658 struct sta_info *sta;
663 spin_lock_irqsave(&local->sta_lock, flags);
664 while (!list_empty(&local->sta_flush_list)) {
665 sta = list_first_entry(&local->sta_flush_list,
666 struct sta_info, list);
667 list_del(&sta->list);
668 spin_unlock_irqrestore(&local->sta_lock, flags);
669 sta_info_destroy(sta);
670 spin_lock_irqsave(&local->sta_lock, flags);
672 spin_unlock_irqrestore(&local->sta_lock, flags);
675 static void ieee80211_sta_flush_work(struct work_struct *work)
677 struct ieee80211_local *local =
678 container_of(work, struct ieee80211_local, sta_flush_work);
681 __ieee80211_run_pending_flush(local);
685 void sta_info_init(struct ieee80211_local *local)
687 spin_lock_init(&local->sta_lock);
688 INIT_LIST_HEAD(&local->sta_list);
689 INIT_LIST_HEAD(&local->sta_flush_list);
690 INIT_WORK(&local->sta_flush_work, ieee80211_sta_flush_work);
692 setup_timer(&local->sta_cleanup, sta_info_cleanup,
693 (unsigned long)local);
694 local->sta_cleanup.expires =
695 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
697 #ifdef CONFIG_MAC80211_DEBUGFS
698 INIT_WORK(&local->sta_debugfs_add, sta_info_debugfs_add_work);
702 int sta_info_start(struct ieee80211_local *local)
704 add_timer(&local->sta_cleanup);
708 void sta_info_stop(struct ieee80211_local *local)
710 del_timer(&local->sta_cleanup);
711 cancel_work_sync(&local->sta_flush_work);
712 #ifdef CONFIG_MAC80211_DEBUGFS
714 * Make sure the debugfs adding work isn't pending after this
715 * because we're about to be destroyed. It doesn't matter
716 * whether it ran or not since we're going to flush all STAs
719 cancel_work_sync(&local->sta_debugfs_add);
723 sta_info_flush(local, NULL);
724 __ieee80211_run_pending_flush(local);
729 * sta_info_flush - flush matching STA entries from the STA table
731 * Returns the number of removed STA entries.
733 * @local: local interface data
734 * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
736 int sta_info_flush(struct ieee80211_local *local,
737 struct ieee80211_sub_if_data *sdata)
739 struct sta_info *sta, *tmp;
747 spin_lock_irqsave(&local->sta_lock, flags);
748 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
749 if (!sdata || sdata == sta->sdata) {
750 __sta_info_unlink(&sta);
752 list_add_tail(&sta->list, &tmp_list);
757 spin_unlock_irqrestore(&local->sta_lock, flags);
759 list_for_each_entry_safe(sta, tmp, &tmp_list, list)
760 sta_info_destroy(sta);
766 * sta_info_flush_delayed - flush matching STA entries from the STA table
768 * This function unlinks all stations for a given interface and queues
769 * them for freeing. Note that the workqueue function scheduled here has
770 * to run before any new keys can be added to the system to avoid set_key()
771 * callback ordering issues.
773 * @sdata: the interface
775 void sta_info_flush_delayed(struct ieee80211_sub_if_data *sdata)
777 struct ieee80211_local *local = sdata->local;
778 struct sta_info *sta, *tmp;
782 spin_lock_irqsave(&local->sta_lock, flags);
783 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
784 if (sdata == sta->sdata) {
785 __sta_info_unlink(&sta);
787 list_add_tail(&sta->list,
788 &local->sta_flush_list);
794 schedule_work(&local->sta_flush_work);
795 spin_unlock_irqrestore(&local->sta_lock, flags);
798 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
799 unsigned long exp_time)
801 struct ieee80211_local *local = sdata->local;
802 struct sta_info *sta, *tmp;
806 spin_lock_irqsave(&local->sta_lock, flags);
807 list_for_each_entry_safe(sta, tmp, &local->sta_list, list)
808 if (time_after(jiffies, sta->last_rx + exp_time)) {
809 #ifdef CONFIG_MAC80211_IBSS_DEBUG
810 printk(KERN_DEBUG "%s: expiring inactive STA %pM\n",
811 sdata->dev->name, sta->sta.addr);
813 __sta_info_unlink(&sta);
815 list_add(&sta->list, &tmp_list);
817 spin_unlock_irqrestore(&local->sta_lock, flags);
819 list_for_each_entry_safe(sta, tmp, &tmp_list, list)
820 sta_info_destroy(sta);
823 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
826 struct sta_info *sta = sta_info_get(hw_to_local(hw), addr);
832 EXPORT_SYMBOL(ieee80211_find_sta);