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"
22 #include "ieee80211_rate.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.
41 * Because there are debugfs entries for each station, and adding those
42 * must be able to sleep, it is also possible to "pin" a station entry,
43 * that means it can be removed from the hash table but not be freed.
44 * See the comment in __sta_info_unlink() for more information.
46 * In order to remove a STA info structure, the caller needs to first
47 * unlink it (sta_info_unlink()) from the list and hash tables and
48 * then wait for an RCU synchronisation before it can be freed. Due to
49 * the pinning and the possibility of multiple callers trying to remove
50 * the same STA info at the same time, sta_info_unlink() can clear the
51 * STA info pointer it is passed to indicate that the STA info is owned
52 * by somebody else now.
54 * If sta_info_unlink() did not clear the pointer then the caller owns
55 * the STA info structure now and is responsible of destroying it with
56 * a call to sta_info_destroy(), not before RCU synchronisation, of
57 * course. Note that sta_info_destroy() must be protected by the RTNL.
59 * In all other cases, there is no concept of ownership on a STA entry,
60 * each structure is owned by the global hash table/list until it is
61 * removed. All users of the structure need to be RCU protected so that
62 * the structure won't be freed before they are done using it.
65 /* Caller must hold local->sta_lock */
66 static int sta_info_hash_del(struct ieee80211_local *local,
71 s = local->sta_hash[STA_HASH(sta->addr)];
75 rcu_assign_pointer(local->sta_hash[STA_HASH(sta->addr)],
80 while (s->hnext && s->hnext != sta)
83 rcu_assign_pointer(s->hnext, sta->hnext);
90 /* protected by RCU */
91 static struct sta_info *__sta_info_find(struct ieee80211_local *local,
96 sta = rcu_dereference(local->sta_hash[STA_HASH(addr)]);
98 if (compare_ether_addr(sta->addr, addr) == 0)
100 sta = rcu_dereference(sta->hnext);
105 struct sta_info *sta_info_get(struct ieee80211_local *local, u8 *addr)
107 return __sta_info_find(local, addr);
109 EXPORT_SYMBOL(sta_info_get);
111 struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
112 struct net_device *dev)
114 struct sta_info *sta;
117 list_for_each_entry_rcu(sta, &local->sta_list, list) {
118 if (dev && dev != sta->sdata->dev)
130 void sta_info_destroy(struct sta_info *sta)
132 struct ieee80211_local *local = sta->local;
135 DECLARE_MAC_BUF(mbuf);
143 rate_control_remove_sta_debugfs(sta);
144 ieee80211_sta_debugfs_remove(sta);
146 #ifdef CONFIG_MAC80211_MESH
147 if (ieee80211_vif_is_mesh(&sta->sdata->vif))
148 mesh_plink_deactivate(sta);
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!
156 ieee80211_key_free(sta->key);
159 #ifdef CONFIG_MAC80211_MESH
160 if (ieee80211_vif_is_mesh(&sta->sdata->vif))
161 del_timer_sync(&sta->plink_timer);
164 while ((skb = skb_dequeue(&sta->ps_tx_buf)) != NULL) {
165 local->total_ps_buffered--;
166 dev_kfree_skb_any(skb);
169 while ((skb = skb_dequeue(&sta->tx_filtered)) != NULL)
170 dev_kfree_skb_any(skb);
172 for (i = 0; i < STA_TID_NUM; i++) {
173 spin_lock_bh(&sta->ampdu_mlme.ampdu_rx);
174 if (sta->ampdu_mlme.tid_rx[i])
175 del_timer_sync(&sta->ampdu_mlme.tid_rx[i]->session_timer);
176 spin_unlock_bh(&sta->ampdu_mlme.ampdu_rx);
177 spin_lock_bh(&sta->ampdu_mlme.ampdu_tx);
178 if (sta->ampdu_mlme.tid_tx[i])
179 del_timer_sync(&sta->ampdu_mlme.tid_tx[i]->addba_resp_timer);
180 spin_unlock_bh(&sta->ampdu_mlme.ampdu_tx);
183 rate_control_free_sta(sta->rate_ctrl, sta->rate_ctrl_priv);
184 rate_control_put(sta->rate_ctrl);
186 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
187 printk(KERN_DEBUG "%s: Destroyed STA %s\n",
188 wiphy_name(local->hw.wiphy), print_mac(mbuf, sta->addr));
189 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
195 /* Caller must hold local->sta_lock */
196 static void sta_info_hash_add(struct ieee80211_local *local,
197 struct sta_info *sta)
199 sta->hnext = local->sta_hash[STA_HASH(sta->addr)];
200 rcu_assign_pointer(local->sta_hash[STA_HASH(sta->addr)], sta);
203 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
206 struct ieee80211_local *local = sdata->local;
207 struct sta_info *sta;
209 DECLARE_MAC_BUF(mbuf);
211 sta = kzalloc(sizeof(*sta), gfp);
215 memcpy(sta->addr, addr, ETH_ALEN);
219 sta->rate_ctrl = rate_control_get(local->rate_ctrl);
220 sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
222 if (!sta->rate_ctrl_priv) {
223 rate_control_put(sta->rate_ctrl);
228 spin_lock_init(&sta->ampdu_mlme.ampdu_rx);
229 spin_lock_init(&sta->ampdu_mlme.ampdu_tx);
230 for (i = 0; i < STA_TID_NUM; i++) {
231 /* timer_to_tid must be initialized with identity mapping to
232 * enable session_timer's data differentiation. refer to
233 * sta_rx_agg_session_timer_expired for useage */
234 sta->timer_to_tid[i] = i;
235 /* tid to tx queue: initialize according to HW (0 is valid) */
236 sta->tid_to_tx_q[i] = local->hw.queues;
238 sta->ampdu_mlme.tid_state_rx[i] = HT_AGG_STATE_IDLE;
239 sta->ampdu_mlme.tid_rx[i] = NULL;
241 sta->ampdu_mlme.tid_state_tx[i] = HT_AGG_STATE_IDLE;
242 sta->ampdu_mlme.tid_tx[i] = NULL;
243 sta->ampdu_mlme.addba_req_num[i] = 0;
245 skb_queue_head_init(&sta->ps_tx_buf);
246 skb_queue_head_init(&sta->tx_filtered);
248 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
249 printk(KERN_DEBUG "%s: Allocated STA %s\n",
250 wiphy_name(local->hw.wiphy), print_mac(mbuf, sta->addr));
251 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
253 #ifdef CONFIG_MAC80211_MESH
254 sta->plink_state = PLINK_LISTEN;
255 spin_lock_init(&sta->plink_lock);
256 init_timer(&sta->plink_timer);
262 int sta_info_insert(struct sta_info *sta)
264 struct ieee80211_local *local = sta->local;
265 struct ieee80211_sub_if_data *sdata = sta->sdata;
267 DECLARE_MAC_BUF(mac);
270 * Can't be a WARN_ON because it can be triggered through a race:
271 * something inserts a STA (on one CPU) without holding the RTNL
272 * and another CPU turns off the net device.
274 if (unlikely(!netif_running(sdata->dev)))
277 if (WARN_ON(compare_ether_addr(sta->addr, sdata->dev->dev_addr) == 0))
280 if (WARN_ON(is_multicast_ether_addr(sta->addr)))
283 spin_lock_irqsave(&local->sta_lock, flags);
284 /* check if STA exists already */
285 if (__sta_info_find(local, sta->addr)) {
286 spin_unlock_irqrestore(&local->sta_lock, flags);
289 list_add(&sta->list, &local->sta_list);
291 sta_info_hash_add(local, sta);
294 if (local->ops->sta_notify) {
295 if (sdata->vif.type == IEEE80211_IF_TYPE_VLAN)
296 sdata = sdata->u.vlan.ap;
298 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
299 STA_NOTIFY_ADD, sta->addr);
302 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
303 printk(KERN_DEBUG "%s: Inserted STA %s\n",
304 wiphy_name(local->hw.wiphy), print_mac(mac, sta->addr));
305 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
307 spin_unlock_irqrestore(&local->sta_lock, flags);
309 #ifdef CONFIG_MAC80211_DEBUGFS
310 /* debugfs entry adding might sleep, so schedule process
311 * context task for adding entry for STAs that do not yet
313 queue_work(local->hw.workqueue, &local->sta_debugfs_add);
316 if (ieee80211_vif_is_mesh(&sdata->vif))
317 mesh_accept_plinks_update(sdata);
322 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
325 * This format has been mandated by the IEEE specifications,
326 * so this line may not be changed to use the __set_bit() format.
328 bss->tim[aid / 8] |= (1 << (aid % 8));
331 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
334 * This format has been mandated by the IEEE specifications,
335 * so this line may not be changed to use the __clear_bit() format.
337 bss->tim[aid / 8] &= ~(1 << (aid % 8));
340 static void __sta_info_set_tim_bit(struct ieee80211_if_ap *bss,
341 struct sta_info *sta)
344 __bss_tim_set(bss, sta->aid);
345 if (sta->local->ops->set_tim) {
346 sta->local->tim_in_locked_section = true;
347 sta->local->ops->set_tim(local_to_hw(sta->local), sta->aid, 1);
348 sta->local->tim_in_locked_section = false;
352 void sta_info_set_tim_bit(struct sta_info *sta)
356 spin_lock_irqsave(&sta->local->sta_lock, flags);
357 __sta_info_set_tim_bit(sta->sdata->bss, sta);
358 spin_unlock_irqrestore(&sta->local->sta_lock, flags);
361 static void __sta_info_clear_tim_bit(struct ieee80211_if_ap *bss,
362 struct sta_info *sta)
365 __bss_tim_clear(bss, sta->aid);
366 if (sta->local->ops->set_tim) {
367 sta->local->tim_in_locked_section = true;
368 sta->local->ops->set_tim(local_to_hw(sta->local), sta->aid, 0);
369 sta->local->tim_in_locked_section = false;
373 void sta_info_clear_tim_bit(struct sta_info *sta)
377 spin_lock_irqsave(&sta->local->sta_lock, flags);
378 __sta_info_clear_tim_bit(sta->sdata->bss, sta);
379 spin_unlock_irqrestore(&sta->local->sta_lock, flags);
383 * See comment in __sta_info_unlink,
384 * caller must hold local->sta_lock.
386 static void __sta_info_pin(struct sta_info *sta)
388 WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_NORMAL);
389 sta->pin_status = STA_INFO_PIN_STAT_PINNED;
393 * See comment in __sta_info_unlink, returns sta if it
394 * needs to be destroyed.
396 static struct sta_info *__sta_info_unpin(struct sta_info *sta)
398 struct sta_info *ret = NULL;
401 spin_lock_irqsave(&sta->local->sta_lock, flags);
402 WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_DESTROY &&
403 sta->pin_status != STA_INFO_PIN_STAT_PINNED);
404 if (sta->pin_status == STA_INFO_PIN_STAT_DESTROY)
406 sta->pin_status = STA_INFO_PIN_STAT_NORMAL;
407 spin_unlock_irqrestore(&sta->local->sta_lock, flags);
412 static void __sta_info_unlink(struct sta_info **sta)
414 struct ieee80211_local *local = (*sta)->local;
415 struct ieee80211_sub_if_data *sdata = (*sta)->sdata;
416 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
417 DECLARE_MAC_BUF(mbuf);
420 * pull caller's reference if we're already gone.
422 if (sta_info_hash_del(local, *sta)) {
428 * Also pull caller's reference if the STA is pinned by the
429 * task that is adding the debugfs entries. In that case, we
430 * leave the STA "to be freed".
432 * The rules are not trivial, but not too complex either:
433 * (1) pin_status is only modified under the sta_lock
434 * (2) sta_info_debugfs_add_work() will set the status
435 * to PINNED when it found an item that needs a new
436 * debugfs directory created. In that case, that item
437 * must not be freed although all *RCU* users are done
438 * with it. Hence, we tell the caller of _unlink()
439 * that the item is already gone (as can happen when
440 * two tasks try to unlink/destroy at the same time)
441 * (3) We set the pin_status to DESTROY here when we
443 * (4) sta_info_debugfs_add_work() will reset the pin_status
444 * from PINNED to NORMAL when it is done with the item,
445 * but will check for DESTROY before resetting it in
446 * which case it will free the item.
448 if ((*sta)->pin_status == STA_INFO_PIN_STAT_PINNED) {
449 (*sta)->pin_status = STA_INFO_PIN_STAT_DESTROY;
454 list_del(&(*sta)->list);
456 if ((*sta)->flags & WLAN_STA_PS) {
457 (*sta)->flags &= ~WLAN_STA_PS;
459 atomic_dec(&sdata->bss->num_sta_ps);
460 __sta_info_clear_tim_bit(sdata->bss, *sta);
465 if (local->ops->sta_notify) {
466 if (sdata->vif.type == IEEE80211_IF_TYPE_VLAN)
467 sdata = sdata->u.vlan.ap;
469 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
470 STA_NOTIFY_REMOVE, (*sta)->addr);
473 if (ieee80211_vif_is_mesh(&sdata->vif)) {
474 mesh_accept_plinks_update(sdata);
475 #ifdef CONFIG_MAC80211_MESH
476 del_timer(&(*sta)->plink_timer);
480 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
481 printk(KERN_DEBUG "%s: Removed STA %s\n",
482 wiphy_name(local->hw.wiphy), print_mac(mbuf, (*sta)->addr));
483 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
486 void sta_info_unlink(struct sta_info **sta)
488 struct ieee80211_local *local = (*sta)->local;
491 spin_lock_irqsave(&local->sta_lock, flags);
492 __sta_info_unlink(sta);
493 spin_unlock_irqrestore(&local->sta_lock, flags);
496 static inline int sta_info_buffer_expired(struct ieee80211_local *local,
497 struct sta_info *sta,
500 struct ieee80211_tx_packet_data *pkt_data;
506 pkt_data = (struct ieee80211_tx_packet_data *) skb->cb;
508 /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
509 timeout = (sta->listen_interval * local->hw.conf.beacon_int * 32 /
511 if (timeout < STA_TX_BUFFER_EXPIRE)
512 timeout = STA_TX_BUFFER_EXPIRE;
513 return time_after(jiffies, pkt_data->jiffies + timeout);
517 static void sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
518 struct sta_info *sta)
522 struct ieee80211_sub_if_data *sdata;
523 DECLARE_MAC_BUF(mac);
525 if (skb_queue_empty(&sta->ps_tx_buf))
529 spin_lock_irqsave(&sta->ps_tx_buf.lock, flags);
530 skb = skb_peek(&sta->ps_tx_buf);
531 if (sta_info_buffer_expired(local, sta, skb))
532 skb = __skb_dequeue(&sta->ps_tx_buf);
535 spin_unlock_irqrestore(&sta->ps_tx_buf.lock, flags);
541 local->total_ps_buffered--;
542 printk(KERN_DEBUG "Buffered frame expired (STA "
543 "%s)\n", print_mac(mac, sta->addr));
546 if (skb_queue_empty(&sta->ps_tx_buf))
547 sta_info_clear_tim_bit(sta);
552 static void sta_info_cleanup(unsigned long data)
554 struct ieee80211_local *local = (struct ieee80211_local *) data;
555 struct sta_info *sta;
558 list_for_each_entry_rcu(sta, &local->sta_list, list)
559 sta_info_cleanup_expire_buffered(local, sta);
562 local->sta_cleanup.expires =
563 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
564 add_timer(&local->sta_cleanup);
567 #ifdef CONFIG_MAC80211_DEBUGFS
568 static void sta_info_debugfs_add_work(struct work_struct *work)
570 struct ieee80211_local *local =
571 container_of(work, struct ieee80211_local, sta_debugfs_add);
572 struct sta_info *sta, *tmp;
578 spin_lock_irqsave(&local->sta_lock, flags);
579 list_for_each_entry(tmp, &local->sta_list, list) {
580 if (!tmp->debugfs.dir) {
586 spin_unlock_irqrestore(&local->sta_lock, flags);
591 ieee80211_sta_debugfs_add(sta);
592 rate_control_add_sta_debugfs(sta);
594 sta = __sta_info_unpin(sta);
598 sta_info_destroy(sta);
604 void sta_info_init(struct ieee80211_local *local)
606 spin_lock_init(&local->sta_lock);
607 INIT_LIST_HEAD(&local->sta_list);
609 setup_timer(&local->sta_cleanup, sta_info_cleanup,
610 (unsigned long)local);
611 local->sta_cleanup.expires =
612 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
614 #ifdef CONFIG_MAC80211_DEBUGFS
615 INIT_WORK(&local->sta_debugfs_add, sta_info_debugfs_add_work);
619 int sta_info_start(struct ieee80211_local *local)
621 add_timer(&local->sta_cleanup);
625 void sta_info_stop(struct ieee80211_local *local)
627 del_timer(&local->sta_cleanup);
628 sta_info_flush(local, NULL);
632 * sta_info_flush - flush matching STA entries from the STA table
634 * Returns the number of removed STA entries.
636 * @local: local interface data
637 * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
639 int sta_info_flush(struct ieee80211_local *local,
640 struct ieee80211_sub_if_data *sdata)
642 struct sta_info *sta, *tmp;
649 spin_lock_irqsave(&local->sta_lock, flags);
650 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
651 if (!sdata || sdata == sta->sdata) {
652 __sta_info_unlink(&sta);
654 list_add_tail(&sta->list, &tmp_list);
659 spin_unlock_irqrestore(&local->sta_lock, flags);
663 list_for_each_entry_safe(sta, tmp, &tmp_list, list)
664 sta_info_destroy(sta);