xref: /openbmc/linux/net/mac80211/sta_info.c (revision fd589a8f)
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_local *local, const u8 *addr)
107 {
108 	struct sta_info *sta;
109 
110 	sta = rcu_dereference(local->sta_hash[STA_HASH(addr)]);
111 	while (sta) {
112 		if (memcmp(sta->sta.addr, addr, ETH_ALEN) == 0)
113 			break;
114 		sta = rcu_dereference(sta->hnext);
115 	}
116 	return sta;
117 }
118 
119 struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
120 				     struct net_device *dev)
121 {
122 	struct sta_info *sta;
123 	int i = 0;
124 
125 	list_for_each_entry_rcu(sta, &local->sta_list, list) {
126 		if (dev && dev != sta->sdata->dev)
127 			continue;
128 		if (i < idx) {
129 			++i;
130 			continue;
131 		}
132 		return sta;
133 	}
134 
135 	return NULL;
136 }
137 
138 /**
139  * __sta_info_free - internal STA free helper
140  *
141  * @local: pointer to the global information
142  * @sta: STA info to free
143  *
144  * This function must undo everything done by sta_info_alloc()
145  * that may happen before sta_info_insert().
146  */
147 static void __sta_info_free(struct ieee80211_local *local,
148 			    struct sta_info *sta)
149 {
150 	rate_control_free_sta(sta);
151 	rate_control_put(sta->rate_ctrl);
152 
153 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
154 	printk(KERN_DEBUG "%s: Destroyed STA %pM\n",
155 	       wiphy_name(local->hw.wiphy), sta->sta.addr);
156 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
157 
158 	kfree(sta);
159 }
160 
161 void sta_info_destroy(struct sta_info *sta)
162 {
163 	struct ieee80211_local *local;
164 	struct sk_buff *skb;
165 	int i;
166 
167 	might_sleep();
168 
169 	if (!sta)
170 		return;
171 
172 	local = sta->local;
173 
174 	rate_control_remove_sta_debugfs(sta);
175 	ieee80211_sta_debugfs_remove(sta);
176 
177 #ifdef CONFIG_MAC80211_MESH
178 	if (ieee80211_vif_is_mesh(&sta->sdata->vif))
179 		mesh_plink_deactivate(sta);
180 #endif
181 
182 	/*
183 	 * We have only unlinked the key, and actually destroying it
184 	 * may mean it is removed from hardware which requires that
185 	 * the key->sta pointer is still valid, so flush the key todo
186 	 * list here.
187 	 *
188 	 * ieee80211_key_todo() will synchronize_rcu() so after this
189 	 * nothing can reference this sta struct any more.
190 	 */
191 	ieee80211_key_todo();
192 
193 #ifdef CONFIG_MAC80211_MESH
194 	if (ieee80211_vif_is_mesh(&sta->sdata->vif))
195 		del_timer_sync(&sta->plink_timer);
196 #endif
197 
198 	while ((skb = skb_dequeue(&sta->ps_tx_buf)) != NULL) {
199 		local->total_ps_buffered--;
200 		dev_kfree_skb_any(skb);
201 	}
202 
203 	while ((skb = skb_dequeue(&sta->tx_filtered)) != NULL)
204 		dev_kfree_skb_any(skb);
205 
206 	for (i = 0; i <  STA_TID_NUM; i++) {
207 		struct tid_ampdu_rx *tid_rx;
208 		struct tid_ampdu_tx *tid_tx;
209 
210 		spin_lock_bh(&sta->lock);
211 		tid_rx = sta->ampdu_mlme.tid_rx[i];
212 		/* Make sure timer won't free the tid_rx struct, see below */
213 		if (tid_rx)
214 			tid_rx->shutdown = true;
215 
216 		spin_unlock_bh(&sta->lock);
217 
218 		/*
219 		 * Outside spinlock - shutdown is true now so that the timer
220 		 * won't free tid_rx, we have to do that now. Can't let the
221 		 * timer do it because we have to sync the timer outside the
222 		 * lock that it takes itself.
223 		 */
224 		if (tid_rx) {
225 			del_timer_sync(&tid_rx->session_timer);
226 			kfree(tid_rx);
227 		}
228 
229 		/*
230 		 * No need to do such complications for TX agg sessions, the
231 		 * path leading to freeing the tid_tx struct goes via a call
232 		 * from the driver, and thus needs to look up the sta struct
233 		 * again, which cannot be found when we get here. Hence, we
234 		 * just need to delete the timer and free the aggregation
235 		 * info; we won't be telling the peer about it then but that
236 		 * doesn't matter if we're not talking to it again anyway.
237 		 */
238 		tid_tx = sta->ampdu_mlme.tid_tx[i];
239 		if (tid_tx) {
240 			del_timer_sync(&tid_tx->addba_resp_timer);
241 			/*
242 			 * STA removed while aggregation session being
243 			 * started? Bit odd, but purge frames anyway.
244 			 */
245 			skb_queue_purge(&tid_tx->pending);
246 			kfree(tid_tx);
247 		}
248 	}
249 
250 	__sta_info_free(local, sta);
251 }
252 
253 
254 /* Caller must hold local->sta_lock */
255 static void sta_info_hash_add(struct ieee80211_local *local,
256 			      struct sta_info *sta)
257 {
258 	sta->hnext = local->sta_hash[STA_HASH(sta->sta.addr)];
259 	rcu_assign_pointer(local->sta_hash[STA_HASH(sta->sta.addr)], sta);
260 }
261 
262 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
263 				u8 *addr, gfp_t gfp)
264 {
265 	struct ieee80211_local *local = sdata->local;
266 	struct sta_info *sta;
267 	int i;
268 
269 	sta = kzalloc(sizeof(*sta) + local->hw.sta_data_size, gfp);
270 	if (!sta)
271 		return NULL;
272 
273 	spin_lock_init(&sta->lock);
274 	spin_lock_init(&sta->flaglock);
275 
276 	memcpy(sta->sta.addr, addr, ETH_ALEN);
277 	sta->local = local;
278 	sta->sdata = sdata;
279 
280 	sta->rate_ctrl = rate_control_get(local->rate_ctrl);
281 	sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
282 						     &sta->sta, gfp);
283 	if (!sta->rate_ctrl_priv) {
284 		rate_control_put(sta->rate_ctrl);
285 		kfree(sta);
286 		return NULL;
287 	}
288 
289 	for (i = 0; i < STA_TID_NUM; i++) {
290 		/* timer_to_tid must be initialized with identity mapping to
291 		 * enable session_timer's data differentiation. refer to
292 		 * sta_rx_agg_session_timer_expired for useage */
293 		sta->timer_to_tid[i] = i;
294 		/* rx */
295 		sta->ampdu_mlme.tid_state_rx[i] = HT_AGG_STATE_IDLE;
296 		sta->ampdu_mlme.tid_rx[i] = NULL;
297 		/* tx */
298 		sta->ampdu_mlme.tid_state_tx[i] = HT_AGG_STATE_IDLE;
299 		sta->ampdu_mlme.tid_tx[i] = NULL;
300 		sta->ampdu_mlme.addba_req_num[i] = 0;
301 	}
302 	skb_queue_head_init(&sta->ps_tx_buf);
303 	skb_queue_head_init(&sta->tx_filtered);
304 
305 	for (i = 0; i < NUM_RX_DATA_QUEUES; i++)
306 		sta->last_seq_ctrl[i] = cpu_to_le16(USHORT_MAX);
307 
308 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
309 	printk(KERN_DEBUG "%s: Allocated STA %pM\n",
310 	       wiphy_name(local->hw.wiphy), sta->sta.addr);
311 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
312 
313 #ifdef CONFIG_MAC80211_MESH
314 	sta->plink_state = PLINK_LISTEN;
315 	init_timer(&sta->plink_timer);
316 #endif
317 
318 	return sta;
319 }
320 
321 int sta_info_insert(struct sta_info *sta)
322 {
323 	struct ieee80211_local *local = sta->local;
324 	struct ieee80211_sub_if_data *sdata = sta->sdata;
325 	unsigned long flags;
326 	int err = 0;
327 
328 	/*
329 	 * Can't be a WARN_ON because it can be triggered through a race:
330 	 * something inserts a STA (on one CPU) without holding the RTNL
331 	 * and another CPU turns off the net device.
332 	 */
333 	if (unlikely(!netif_running(sdata->dev))) {
334 		err = -ENETDOWN;
335 		goto out_free;
336 	}
337 
338 	if (WARN_ON(compare_ether_addr(sta->sta.addr, sdata->dev->dev_addr) == 0 ||
339 		    is_multicast_ether_addr(sta->sta.addr))) {
340 		err = -EINVAL;
341 		goto out_free;
342 	}
343 
344 	spin_lock_irqsave(&local->sta_lock, flags);
345 	/* check if STA exists already */
346 	if (sta_info_get(local, sta->sta.addr)) {
347 		spin_unlock_irqrestore(&local->sta_lock, flags);
348 		err = -EEXIST;
349 		goto out_free;
350 	}
351 	list_add(&sta->list, &local->sta_list);
352 	local->sta_generation++;
353 	local->num_sta++;
354 	sta_info_hash_add(local, sta);
355 
356 	/* notify driver */
357 	if (local->ops->sta_notify) {
358 		if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
359 			sdata = container_of(sdata->bss,
360 					     struct ieee80211_sub_if_data,
361 					     u.ap);
362 
363 		drv_sta_notify(local, &sdata->vif, STA_NOTIFY_ADD, &sta->sta);
364 	}
365 
366 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
367 	printk(KERN_DEBUG "%s: Inserted STA %pM\n",
368 	       wiphy_name(local->hw.wiphy), sta->sta.addr);
369 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
370 
371 	spin_unlock_irqrestore(&local->sta_lock, flags);
372 
373 #ifdef CONFIG_MAC80211_DEBUGFS
374 	/*
375 	 * Debugfs entry adding might sleep, so schedule process
376 	 * context task for adding entry for STAs that do not yet
377 	 * have one.
378 	 * NOTE: due to auto-freeing semantics this may only be done
379 	 *       if the insertion is successful!
380 	 */
381 	schedule_work(&local->sta_debugfs_add);
382 #endif
383 
384 	if (ieee80211_vif_is_mesh(&sdata->vif))
385 		mesh_accept_plinks_update(sdata);
386 
387 	return 0;
388  out_free:
389 	BUG_ON(!err);
390 	__sta_info_free(local, sta);
391 	return err;
392 }
393 
394 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
395 {
396 	/*
397 	 * This format has been mandated by the IEEE specifications,
398 	 * so this line may not be changed to use the __set_bit() format.
399 	 */
400 	bss->tim[aid / 8] |= (1 << (aid % 8));
401 }
402 
403 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
404 {
405 	/*
406 	 * This format has been mandated by the IEEE specifications,
407 	 * so this line may not be changed to use the __clear_bit() format.
408 	 */
409 	bss->tim[aid / 8] &= ~(1 << (aid % 8));
410 }
411 
412 static void __sta_info_set_tim_bit(struct ieee80211_if_ap *bss,
413 				   struct sta_info *sta)
414 {
415 	BUG_ON(!bss);
416 
417 	__bss_tim_set(bss, sta->sta.aid);
418 
419 	if (sta->local->ops->set_tim) {
420 		sta->local->tim_in_locked_section = true;
421 		drv_set_tim(sta->local, &sta->sta, true);
422 		sta->local->tim_in_locked_section = false;
423 	}
424 }
425 
426 void sta_info_set_tim_bit(struct sta_info *sta)
427 {
428 	unsigned long flags;
429 
430 	BUG_ON(!sta->sdata->bss);
431 
432 	spin_lock_irqsave(&sta->local->sta_lock, flags);
433 	__sta_info_set_tim_bit(sta->sdata->bss, sta);
434 	spin_unlock_irqrestore(&sta->local->sta_lock, flags);
435 }
436 
437 static void __sta_info_clear_tim_bit(struct ieee80211_if_ap *bss,
438 				     struct sta_info *sta)
439 {
440 	BUG_ON(!bss);
441 
442 	__bss_tim_clear(bss, sta->sta.aid);
443 
444 	if (sta->local->ops->set_tim) {
445 		sta->local->tim_in_locked_section = true;
446 		drv_set_tim(sta->local, &sta->sta, false);
447 		sta->local->tim_in_locked_section = false;
448 	}
449 }
450 
451 void sta_info_clear_tim_bit(struct sta_info *sta)
452 {
453 	unsigned long flags;
454 
455 	BUG_ON(!sta->sdata->bss);
456 
457 	spin_lock_irqsave(&sta->local->sta_lock, flags);
458 	__sta_info_clear_tim_bit(sta->sdata->bss, sta);
459 	spin_unlock_irqrestore(&sta->local->sta_lock, flags);
460 }
461 
462 static void __sta_info_unlink(struct sta_info **sta)
463 {
464 	struct ieee80211_local *local = (*sta)->local;
465 	struct ieee80211_sub_if_data *sdata = (*sta)->sdata;
466 	/*
467 	 * pull caller's reference if we're already gone.
468 	 */
469 	if (sta_info_hash_del(local, *sta)) {
470 		*sta = NULL;
471 		return;
472 	}
473 
474 	if ((*sta)->key) {
475 		ieee80211_key_free((*sta)->key);
476 		WARN_ON((*sta)->key);
477 	}
478 
479 	list_del(&(*sta)->list);
480 
481 	if (test_and_clear_sta_flags(*sta, WLAN_STA_PS)) {
482 		BUG_ON(!sdata->bss);
483 
484 		atomic_dec(&sdata->bss->num_sta_ps);
485 		__sta_info_clear_tim_bit(sdata->bss, *sta);
486 	}
487 
488 	local->num_sta--;
489 	local->sta_generation++;
490 
491 	if (local->ops->sta_notify) {
492 		if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
493 			sdata = container_of(sdata->bss,
494 					     struct ieee80211_sub_if_data,
495 					     u.ap);
496 
497 		drv_sta_notify(local, &sdata->vif, STA_NOTIFY_REMOVE,
498 			       &(*sta)->sta);
499 	}
500 
501 	if (ieee80211_vif_is_mesh(&sdata->vif)) {
502 		mesh_accept_plinks_update(sdata);
503 #ifdef CONFIG_MAC80211_MESH
504 		del_timer(&(*sta)->plink_timer);
505 #endif
506 	}
507 
508 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
509 	printk(KERN_DEBUG "%s: Removed STA %pM\n",
510 	       wiphy_name(local->hw.wiphy), (*sta)->sta.addr);
511 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
512 
513 	/*
514 	 * Finally, pull caller's reference if the STA is pinned by the
515 	 * task that is adding the debugfs entries. In that case, we
516 	 * leave the STA "to be freed".
517 	 *
518 	 * The rules are not trivial, but not too complex either:
519 	 *  (1) pin_status is only modified under the sta_lock
520 	 *  (2) STAs may only be pinned under the RTNL so that
521 	 *	sta_info_flush() is guaranteed to actually destroy
522 	 *	all STAs that are active for a given interface, this
523 	 *	is required for correctness because otherwise we
524 	 *	could notify a driver that an interface is going
525 	 *	away and only after that (!) notify it about a STA
526 	 *	on that interface going away.
527 	 *  (3) sta_info_debugfs_add_work() will set the status
528 	 *	to PINNED when it found an item that needs a new
529 	 *	debugfs directory created. In that case, that item
530 	 *	must not be freed although all *RCU* users are done
531 	 *	with it. Hence, we tell the caller of _unlink()
532 	 *	that the item is already gone (as can happen when
533 	 *	two tasks try to unlink/destroy at the same time)
534 	 *  (4) We set the pin_status to DESTROY here when we
535 	 *	find such an item.
536 	 *  (5) sta_info_debugfs_add_work() will reset the pin_status
537 	 *	from PINNED to NORMAL when it is done with the item,
538 	 *	but will check for DESTROY before resetting it in
539 	 *	which case it will free the item.
540 	 */
541 	if ((*sta)->pin_status == STA_INFO_PIN_STAT_PINNED) {
542 		(*sta)->pin_status = STA_INFO_PIN_STAT_DESTROY;
543 		*sta = NULL;
544 		return;
545 	}
546 }
547 
548 void sta_info_unlink(struct sta_info **sta)
549 {
550 	struct ieee80211_local *local = (*sta)->local;
551 	unsigned long flags;
552 
553 	spin_lock_irqsave(&local->sta_lock, flags);
554 	__sta_info_unlink(sta);
555 	spin_unlock_irqrestore(&local->sta_lock, flags);
556 }
557 
558 static int sta_info_buffer_expired(struct sta_info *sta,
559 				   struct sk_buff *skb)
560 {
561 	struct ieee80211_tx_info *info;
562 	int timeout;
563 
564 	if (!skb)
565 		return 0;
566 
567 	info = IEEE80211_SKB_CB(skb);
568 
569 	/* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
570 	timeout = (sta->listen_interval *
571 		   sta->sdata->vif.bss_conf.beacon_int *
572 		   32 / 15625) * HZ;
573 	if (timeout < STA_TX_BUFFER_EXPIRE)
574 		timeout = STA_TX_BUFFER_EXPIRE;
575 	return time_after(jiffies, info->control.jiffies + timeout);
576 }
577 
578 
579 static void sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
580 					     struct sta_info *sta)
581 {
582 	unsigned long flags;
583 	struct sk_buff *skb;
584 	struct ieee80211_sub_if_data *sdata;
585 
586 	if (skb_queue_empty(&sta->ps_tx_buf))
587 		return;
588 
589 	for (;;) {
590 		spin_lock_irqsave(&sta->ps_tx_buf.lock, flags);
591 		skb = skb_peek(&sta->ps_tx_buf);
592 		if (sta_info_buffer_expired(sta, skb))
593 			skb = __skb_dequeue(&sta->ps_tx_buf);
594 		else
595 			skb = NULL;
596 		spin_unlock_irqrestore(&sta->ps_tx_buf.lock, flags);
597 
598 		if (!skb)
599 			break;
600 
601 		sdata = sta->sdata;
602 		local->total_ps_buffered--;
603 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
604 		printk(KERN_DEBUG "Buffered frame expired (STA %pM)\n",
605 		       sta->sta.addr);
606 #endif
607 		dev_kfree_skb(skb);
608 
609 		if (skb_queue_empty(&sta->ps_tx_buf))
610 			sta_info_clear_tim_bit(sta);
611 	}
612 }
613 
614 
615 static void sta_info_cleanup(unsigned long data)
616 {
617 	struct ieee80211_local *local = (struct ieee80211_local *) data;
618 	struct sta_info *sta;
619 
620 	rcu_read_lock();
621 	list_for_each_entry_rcu(sta, &local->sta_list, list)
622 		sta_info_cleanup_expire_buffered(local, sta);
623 	rcu_read_unlock();
624 
625 	if (local->quiescing)
626 		return;
627 
628 	local->sta_cleanup.expires =
629 		round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
630 	add_timer(&local->sta_cleanup);
631 }
632 
633 #ifdef CONFIG_MAC80211_DEBUGFS
634 /*
635  * See comment in __sta_info_unlink,
636  * caller must hold local->sta_lock.
637  */
638 static void __sta_info_pin(struct sta_info *sta)
639 {
640 	WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_NORMAL);
641 	sta->pin_status = STA_INFO_PIN_STAT_PINNED;
642 }
643 
644 /*
645  * See comment in __sta_info_unlink, returns sta if it
646  * needs to be destroyed.
647  */
648 static struct sta_info *__sta_info_unpin(struct sta_info *sta)
649 {
650 	struct sta_info *ret = NULL;
651 	unsigned long flags;
652 
653 	spin_lock_irqsave(&sta->local->sta_lock, flags);
654 	WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_DESTROY &&
655 		sta->pin_status != STA_INFO_PIN_STAT_PINNED);
656 	if (sta->pin_status == STA_INFO_PIN_STAT_DESTROY)
657 		ret = sta;
658 	sta->pin_status = STA_INFO_PIN_STAT_NORMAL;
659 	spin_unlock_irqrestore(&sta->local->sta_lock, flags);
660 
661 	return ret;
662 }
663 
664 static void sta_info_debugfs_add_work(struct work_struct *work)
665 {
666 	struct ieee80211_local *local =
667 		container_of(work, struct ieee80211_local, sta_debugfs_add);
668 	struct sta_info *sta, *tmp;
669 	unsigned long flags;
670 
671 	/* We need to keep the RTNL across the whole pinned status. */
672 	rtnl_lock();
673 	while (1) {
674 		sta = NULL;
675 
676 		spin_lock_irqsave(&local->sta_lock, flags);
677 		list_for_each_entry(tmp, &local->sta_list, list) {
678 			/*
679 			 * debugfs.add_has_run will be set by
680 			 * ieee80211_sta_debugfs_add regardless
681 			 * of what else it does.
682 			 */
683 			if (!tmp->debugfs.add_has_run) {
684 				sta = tmp;
685 				__sta_info_pin(sta);
686 				break;
687 			}
688 		}
689 		spin_unlock_irqrestore(&local->sta_lock, flags);
690 
691 		if (!sta)
692 			break;
693 
694 		ieee80211_sta_debugfs_add(sta);
695 		rate_control_add_sta_debugfs(sta);
696 
697 		sta = __sta_info_unpin(sta);
698 		sta_info_destroy(sta);
699 	}
700 	rtnl_unlock();
701 }
702 #endif
703 
704 void sta_info_init(struct ieee80211_local *local)
705 {
706 	spin_lock_init(&local->sta_lock);
707 	INIT_LIST_HEAD(&local->sta_list);
708 
709 	setup_timer(&local->sta_cleanup, sta_info_cleanup,
710 		    (unsigned long)local);
711 	local->sta_cleanup.expires =
712 		round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
713 
714 #ifdef CONFIG_MAC80211_DEBUGFS
715 	INIT_WORK(&local->sta_debugfs_add, sta_info_debugfs_add_work);
716 #endif
717 }
718 
719 int sta_info_start(struct ieee80211_local *local)
720 {
721 	add_timer(&local->sta_cleanup);
722 	return 0;
723 }
724 
725 void sta_info_stop(struct ieee80211_local *local)
726 {
727 	del_timer(&local->sta_cleanup);
728 #ifdef CONFIG_MAC80211_DEBUGFS
729 	/*
730 	 * Make sure the debugfs adding work isn't pending after this
731 	 * because we're about to be destroyed. It doesn't matter
732 	 * whether it ran or not since we're going to flush all STAs
733 	 * anyway.
734 	 */
735 	cancel_work_sync(&local->sta_debugfs_add);
736 #endif
737 
738 	sta_info_flush(local, NULL);
739 }
740 
741 /**
742  * sta_info_flush - flush matching STA entries from the STA table
743  *
744  * Returns the number of removed STA entries.
745  *
746  * @local: local interface data
747  * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
748  */
749 int sta_info_flush(struct ieee80211_local *local,
750 		   struct ieee80211_sub_if_data *sdata)
751 {
752 	struct sta_info *sta, *tmp;
753 	LIST_HEAD(tmp_list);
754 	int ret = 0;
755 	unsigned long flags;
756 
757 	might_sleep();
758 
759 	spin_lock_irqsave(&local->sta_lock, flags);
760 	list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
761 		if (!sdata || sdata == sta->sdata) {
762 			__sta_info_unlink(&sta);
763 			if (sta) {
764 				list_add_tail(&sta->list, &tmp_list);
765 				ret++;
766 			}
767 		}
768 	}
769 	spin_unlock_irqrestore(&local->sta_lock, flags);
770 
771 	list_for_each_entry_safe(sta, tmp, &tmp_list, list)
772 		sta_info_destroy(sta);
773 
774 	return ret;
775 }
776 
777 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
778 			  unsigned long exp_time)
779 {
780 	struct ieee80211_local *local = sdata->local;
781 	struct sta_info *sta, *tmp;
782 	LIST_HEAD(tmp_list);
783 	unsigned long flags;
784 
785 	spin_lock_irqsave(&local->sta_lock, flags);
786 	list_for_each_entry_safe(sta, tmp, &local->sta_list, list)
787 		if (time_after(jiffies, sta->last_rx + exp_time)) {
788 #ifdef CONFIG_MAC80211_IBSS_DEBUG
789 			printk(KERN_DEBUG "%s: expiring inactive STA %pM\n",
790 			       sdata->dev->name, sta->sta.addr);
791 #endif
792 			__sta_info_unlink(&sta);
793 			if (sta)
794 				list_add(&sta->list, &tmp_list);
795 		}
796 	spin_unlock_irqrestore(&local->sta_lock, flags);
797 
798 	list_for_each_entry_safe(sta, tmp, &tmp_list, list)
799 		sta_info_destroy(sta);
800 }
801 
802 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
803 					 const u8 *addr)
804 {
805 	struct sta_info *sta = sta_info_get(hw_to_local(hw), addr);
806 
807 	if (!sta)
808 		return NULL;
809 	return &sta->sta;
810 }
811 EXPORT_SYMBOL(ieee80211_find_sta);
812