ipv4: flush route cache after change accept_local
[linux-2.6.git] / net / mac80211 / sta_info.h
1 /*
2  * Copyright 2002-2005, Devicescape Software, Inc.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation.
7  */
8
9 #ifndef STA_INFO_H
10 #define STA_INFO_H
11
12 #include <linux/list.h>
13 #include <linux/types.h>
14 #include <linux/if_ether.h>
15 #include <linux/workqueue.h>
16 #include <linux/average.h>
17 #include "key.h"
18
19 /**
20  * enum ieee80211_sta_info_flags - Stations flags
21  *
22  * These flags are used with &struct sta_info's @flags member.
23  *
24  * @WLAN_STA_AUTH: Station is authenticated.
25  * @WLAN_STA_ASSOC: Station is associated.
26  * @WLAN_STA_PS_STA: Station is in power-save mode
27  * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
28  *      This bit is always checked so needs to be enabled for all stations
29  *      when virtual port control is not in use.
30  * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
31  *      frames.
32  * @WLAN_STA_ASSOC_AP: We're associated to that station, it is an AP.
33  * @WLAN_STA_WME: Station is a QoS-STA.
34  * @WLAN_STA_WDS: Station is one of our WDS peers.
35  * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
36  *      IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
37  *      frame to this station is transmitted.
38  * @WLAN_STA_MFP: Management frame protection is used with this STA.
39  * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
40  *      during suspend/resume and station removal.
41  * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
42  *      power-save mode logically to flush frames that might still
43  *      be in the queues
44  * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
45  *      station in power-save mode, reply when the driver unblocks.
46  * @WLAN_STA_PS_DRIVER_BUF: Station has frames pending in driver internal
47  *      buffers. Automatically cleared on station wake-up.
48  */
49 enum ieee80211_sta_info_flags {
50         WLAN_STA_AUTH           = 1<<0,
51         WLAN_STA_ASSOC          = 1<<1,
52         WLAN_STA_PS_STA         = 1<<2,
53         WLAN_STA_AUTHORIZED     = 1<<3,
54         WLAN_STA_SHORT_PREAMBLE = 1<<4,
55         WLAN_STA_ASSOC_AP       = 1<<5,
56         WLAN_STA_WME            = 1<<6,
57         WLAN_STA_WDS            = 1<<7,
58         WLAN_STA_CLEAR_PS_FILT  = 1<<9,
59         WLAN_STA_MFP            = 1<<10,
60         WLAN_STA_BLOCK_BA       = 1<<11,
61         WLAN_STA_PS_DRIVER      = 1<<12,
62         WLAN_STA_PSPOLL         = 1<<13,
63         WLAN_STA_PS_DRIVER_BUF  = 1<<14,
64 };
65
66 #define STA_TID_NUM 16
67 #define ADDBA_RESP_INTERVAL HZ
68 #define HT_AGG_MAX_RETRIES              0x3
69
70 #define HT_AGG_STATE_DRV_READY          0
71 #define HT_AGG_STATE_RESPONSE_RECEIVED  1
72 #define HT_AGG_STATE_OPERATIONAL        2
73 #define HT_AGG_STATE_STOPPING           3
74 #define HT_AGG_STATE_WANT_START         4
75 #define HT_AGG_STATE_WANT_STOP          5
76
77 /**
78  * struct tid_ampdu_tx - TID aggregation information (Tx).
79  *
80  * @rcu_head: rcu head for freeing structure
81  * @addba_resp_timer: timer for peer's response to addba request
82  * @pending: pending frames queue -- use sta's spinlock to protect
83  * @dialog_token: dialog token for aggregation session
84  * @timeout: session timeout value to be filled in ADDBA requests
85  * @state: session state (see above)
86  * @stop_initiator: initiator of a session stop
87  * @tx_stop: TX DelBA frame when stopping
88  * @buf_size: reorder buffer size at receiver
89  *
90  * This structure's lifetime is managed by RCU, assignments to
91  * the array holding it must hold the aggregation mutex.
92  *
93  * The TX path can access it under RCU lock-free if, and
94  * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
95  * set. Otherwise, the TX path must also acquire the spinlock
96  * and re-check the state, see comments in the tx code
97  * touching it.
98  */
99 struct tid_ampdu_tx {
100         struct rcu_head rcu_head;
101         struct timer_list addba_resp_timer;
102         struct sk_buff_head pending;
103         unsigned long state;
104         u16 timeout;
105         u8 dialog_token;
106         u8 stop_initiator;
107         bool tx_stop;
108         u8 buf_size;
109 };
110
111 /**
112  * struct tid_ampdu_rx - TID aggregation information (Rx).
113  *
114  * @reorder_buf: buffer to reorder incoming aggregated MPDUs
115  * @reorder_time: jiffies when skb was added
116  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
117  * @reorder_timer: releases expired frames from the reorder buffer.
118  * @head_seq_num: head sequence number in reordering buffer.
119  * @stored_mpdu_num: number of MPDUs in reordering buffer
120  * @ssn: Starting Sequence Number expected to be aggregated.
121  * @buf_size: buffer size for incoming A-MPDUs
122  * @timeout: reset timer value (in TUs).
123  * @dialog_token: dialog token for aggregation session
124  * @rcu_head: RCU head used for freeing this struct
125  * @reorder_lock: serializes access to reorder buffer, see below.
126  *
127  * This structure's lifetime is managed by RCU, assignments to
128  * the array holding it must hold the aggregation mutex.
129  *
130  * The @reorder_lock is used to protect the members of this
131  * struct, except for @timeout, @buf_size and @dialog_token,
132  * which are constant across the lifetime of the struct (the
133  * dialog token being used only for debugging).
134  */
135 struct tid_ampdu_rx {
136         struct rcu_head rcu_head;
137         spinlock_t reorder_lock;
138         struct sk_buff **reorder_buf;
139         unsigned long *reorder_time;
140         struct timer_list session_timer;
141         struct timer_list reorder_timer;
142         u16 head_seq_num;
143         u16 stored_mpdu_num;
144         u16 ssn;
145         u16 buf_size;
146         u16 timeout;
147         u8 dialog_token;
148 };
149
150 /**
151  * struct sta_ampdu_mlme - STA aggregation information.
152  *
153  * @tid_rx: aggregation info for Rx per TID -- RCU protected
154  * @tid_tx: aggregation info for Tx per TID
155  * @tid_start_tx: sessions where start was requested
156  * @addba_req_num: number of times addBA request has been sent.
157  * @dialog_token_allocator: dialog token enumerator for each new session;
158  * @work: work struct for starting/stopping aggregation
159  * @tid_rx_timer_expired: bitmap indicating on which TIDs the
160  *      RX timer expired until the work for it runs
161  * @tid_rx_stop_requested:  bitmap indicating which BA sessions per TID the
162  *      driver requested to close until the work for it runs
163  * @mtx: mutex to protect all TX data (except non-NULL assignments
164  *      to tid_tx[idx], which are protected by the sta spinlock)
165  */
166 struct sta_ampdu_mlme {
167         struct mutex mtx;
168         /* rx */
169         struct tid_ampdu_rx __rcu *tid_rx[STA_TID_NUM];
170         unsigned long tid_rx_timer_expired[BITS_TO_LONGS(STA_TID_NUM)];
171         unsigned long tid_rx_stop_requested[BITS_TO_LONGS(STA_TID_NUM)];
172         /* tx */
173         struct work_struct work;
174         struct tid_ampdu_tx __rcu *tid_tx[STA_TID_NUM];
175         struct tid_ampdu_tx *tid_start_tx[STA_TID_NUM];
176         u8 addba_req_num[STA_TID_NUM];
177         u8 dialog_token_allocator;
178 };
179
180
181 /**
182  * struct sta_info - STA information
183  *
184  * This structure collects information about a station that
185  * mac80211 is communicating with.
186  *
187  * @list: global linked list entry
188  * @hnext: hash table linked list pointer
189  * @local: pointer to the global information
190  * @sdata: virtual interface this station belongs to
191  * @ptk: peer key negotiated with this station, if any
192  * @gtk: group keys negotiated with this station, if any
193  * @rate_ctrl: rate control algorithm reference
194  * @rate_ctrl_priv: rate control private per-STA pointer
195  * @last_tx_rate: rate used for last transmit, to report to userspace as
196  *      "the" transmit rate
197  * @last_rx_rate_idx: rx status rate index of the last data packet
198  * @last_rx_rate_flag: rx status flag of the last data packet
199  * @lock: used for locking all fields that require locking, see comments
200  *      in the header file.
201  * @flaglock: spinlock for flags accesses
202  * @drv_unblock_wk: used for driver PS unblocking
203  * @listen_interval: listen interval of this station, when we're acting as AP
204  * @flags: STA flags, see &enum ieee80211_sta_info_flags
205  * @ps_tx_buf: buffer of frames to transmit to this station
206  *      when it leaves power saving state
207  * @tx_filtered: buffer of frames we already tried to transmit
208  *      but were filtered by hardware due to STA having entered
209  *      power saving state
210  * @rx_packets: Number of MSDUs received from this STA
211  * @rx_bytes: Number of bytes received from this STA
212  * @wep_weak_iv_count: number of weak WEP IVs received from this station
213  * @last_rx: time (in jiffies) when last frame was received from this STA
214  * @last_connected: time (in seconds) when a station got connected
215  * @num_duplicates: number of duplicate frames received from this STA
216  * @rx_fragments: number of received MPDUs
217  * @rx_dropped: number of dropped MPDUs from this STA
218  * @last_signal: signal of last received frame from this STA
219  * @avg_signal: moving average of signal of received frames from this STA
220  * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
221  * @tx_filtered_count: number of frames the hardware filtered for this STA
222  * @tx_retry_failed: number of frames that failed retry
223  * @tx_retry_count: total number of retries for frames to this STA
224  * @fail_avg: moving percentage of failed MSDUs
225  * @tx_packets: number of RX/TX MSDUs
226  * @tx_bytes: number of bytes transmitted to this STA
227  * @tx_fragments: number of transmitted MPDUs
228  * @tid_seq: per-TID sequence numbers for sending to this STA
229  * @ampdu_mlme: A-MPDU state machine state
230  * @timer_to_tid: identity mapping to ID timers
231  * @llid: Local link ID
232  * @plid: Peer link ID
233  * @reason: Cancel reason on PLINK_HOLDING state
234  * @plink_retries: Retries in establishment
235  * @ignore_plink_timer: ignore the peer-link timer (used internally)
236  * @plink_state: peer link state
237  * @plink_timeout: timeout of peer link
238  * @plink_timer: peer link watch timer
239  * @plink_timer_was_running: used by suspend/resume to restore timers
240  * @debugfs: debug filesystem info
241  * @sta: station information we share with the driver
242  * @dead: set to true when sta is unlinked
243  * @uploaded: set to true when sta is uploaded to the driver
244  * @lost_packets: number of consecutive lost packets
245  */
246 struct sta_info {
247         /* General information, mostly static */
248         struct list_head list;
249         struct sta_info __rcu *hnext;
250         struct ieee80211_local *local;
251         struct ieee80211_sub_if_data *sdata;
252         struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
253         struct ieee80211_key __rcu *ptk;
254         struct rate_control_ref *rate_ctrl;
255         void *rate_ctrl_priv;
256         spinlock_t lock;
257         spinlock_t flaglock;
258
259         struct work_struct drv_unblock_wk;
260
261         u16 listen_interval;
262
263         bool dead;
264
265         bool uploaded;
266
267         /*
268          * frequently updated, locked with own spinlock (flaglock),
269          * use the accessors defined below
270          */
271         u32 flags;
272
273         /*
274          * STA powersave frame queues, no more than the internal
275          * locking required.
276          */
277         struct sk_buff_head ps_tx_buf;
278         struct sk_buff_head tx_filtered;
279
280         /* Updated from RX path only, no locking requirements */
281         unsigned long rx_packets, rx_bytes;
282         unsigned long wep_weak_iv_count;
283         unsigned long last_rx;
284         long last_connected;
285         unsigned long num_duplicates;
286         unsigned long rx_fragments;
287         unsigned long rx_dropped;
288         int last_signal;
289         struct ewma avg_signal;
290         /* Plus 1 for non-QoS frames */
291         __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES + 1];
292
293         /* Updated from TX status path only, no locking requirements */
294         unsigned long tx_filtered_count;
295         unsigned long tx_retry_failed, tx_retry_count;
296         /* moving percentage of failed MSDUs */
297         unsigned int fail_avg;
298
299         /* Updated from TX path only, no locking requirements */
300         unsigned long tx_packets;
301         unsigned long tx_bytes;
302         unsigned long tx_fragments;
303         struct ieee80211_tx_rate last_tx_rate;
304         int last_rx_rate_idx;
305         int last_rx_rate_flag;
306         u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
307
308         /*
309          * Aggregation information, locked with lock.
310          */
311         struct sta_ampdu_mlme ampdu_mlme;
312         u8 timer_to_tid[STA_TID_NUM];
313
314 #ifdef CONFIG_MAC80211_MESH
315         /*
316          * Mesh peer link attributes
317          * TODO: move to a sub-structure that is referenced with pointer?
318          */
319         __le16 llid;
320         __le16 plid;
321         __le16 reason;
322         u8 plink_retries;
323         bool ignore_plink_timer;
324         bool plink_timer_was_running;
325         enum nl80211_plink_state plink_state;
326         u32 plink_timeout;
327         struct timer_list plink_timer;
328 #endif
329
330 #ifdef CONFIG_MAC80211_DEBUGFS
331         struct sta_info_debugfsdentries {
332                 struct dentry *dir;
333                 bool add_has_run;
334         } debugfs;
335 #endif
336
337         unsigned int lost_packets;
338
339         /* keep last! */
340         struct ieee80211_sta sta;
341 };
342
343 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
344 {
345 #ifdef CONFIG_MAC80211_MESH
346         return sta->plink_state;
347 #endif
348         return NL80211_PLINK_LISTEN;
349 }
350
351 static inline void set_sta_flags(struct sta_info *sta, const u32 flags)
352 {
353         unsigned long irqfl;
354
355         spin_lock_irqsave(&sta->flaglock, irqfl);
356         sta->flags |= flags;
357         spin_unlock_irqrestore(&sta->flaglock, irqfl);
358 }
359
360 static inline void clear_sta_flags(struct sta_info *sta, const u32 flags)
361 {
362         unsigned long irqfl;
363
364         spin_lock_irqsave(&sta->flaglock, irqfl);
365         sta->flags &= ~flags;
366         spin_unlock_irqrestore(&sta->flaglock, irqfl);
367 }
368
369 static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags)
370 {
371         u32 ret;
372         unsigned long irqfl;
373
374         spin_lock_irqsave(&sta->flaglock, irqfl);
375         ret = sta->flags & flags;
376         spin_unlock_irqrestore(&sta->flaglock, irqfl);
377
378         return ret;
379 }
380
381 static inline u32 test_and_clear_sta_flags(struct sta_info *sta,
382                                            const u32 flags)
383 {
384         u32 ret;
385         unsigned long irqfl;
386
387         spin_lock_irqsave(&sta->flaglock, irqfl);
388         ret = sta->flags & flags;
389         sta->flags &= ~flags;
390         spin_unlock_irqrestore(&sta->flaglock, irqfl);
391
392         return ret;
393 }
394
395 static inline u32 get_sta_flags(struct sta_info *sta)
396 {
397         u32 ret;
398         unsigned long irqfl;
399
400         spin_lock_irqsave(&sta->flaglock, irqfl);
401         ret = sta->flags;
402         spin_unlock_irqrestore(&sta->flaglock, irqfl);
403
404         return ret;
405 }
406
407 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
408                              struct tid_ampdu_tx *tid_tx);
409
410 static inline struct tid_ampdu_tx *
411 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
412 {
413         return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
414                                          lockdep_is_held(&sta->lock) ||
415                                          lockdep_is_held(&sta->ampdu_mlme.mtx));
416 }
417
418 #define STA_HASH_SIZE 256
419 #define STA_HASH(sta) (sta[5])
420
421
422 /* Maximum number of frames to buffer per power saving station */
423 #define STA_MAX_TX_BUFFER 128
424
425 /* Minimum buffered frame expiry time. If STA uses listen interval that is
426  * smaller than this value, the minimum value here is used instead. */
427 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
428
429 /* How often station data is cleaned up (e.g., expiration of buffered frames)
430  */
431 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
432
433 /*
434  * Get a STA info, must be under RCU read lock.
435  */
436 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
437                               const u8 *addr);
438
439 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
440                                   const u8 *addr);
441
442 static inline
443 void for_each_sta_info_type_check(struct ieee80211_local *local,
444                                   const u8 *addr,
445                                   struct sta_info *sta,
446                                   struct sta_info *nxt)
447 {
448 }
449
450 #define for_each_sta_info(local, _addr, _sta, nxt)                      \
451         for (   /* initialise loop */                                   \
452                 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
453                 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL;       \
454                 /* typecheck */                                         \
455                 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
456                 /* continue condition */                                \
457                 _sta;                                                   \
458                 /* advance loop */                                      \
459                 _sta = nxt,                                             \
460                 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL        \
461              )                                                          \
462         /* compare address and run code only if it matches */           \
463         if (memcmp(_sta->sta.addr, (_addr), ETH_ALEN) == 0)
464
465 /*
466  * Get STA info by index, BROKEN!
467  */
468 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
469                                      int idx);
470 /*
471  * Create a new STA info, caller owns returned structure
472  * until sta_info_insert().
473  */
474 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
475                                 u8 *addr, gfp_t gfp);
476 /*
477  * Insert STA info into hash table/list, returns zero or a
478  * -EEXIST if (if the same MAC address is already present).
479  *
480  * Calling the non-rcu version makes the caller relinquish,
481  * the _rcu version calls read_lock_rcu() and must be called
482  * without it held.
483  */
484 int sta_info_insert(struct sta_info *sta);
485 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
486 int sta_info_insert_atomic(struct sta_info *sta);
487
488 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
489                           const u8 *addr);
490 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
491                               const u8 *addr);
492
493 void sta_info_set_tim_bit(struct sta_info *sta);
494 void sta_info_clear_tim_bit(struct sta_info *sta);
495
496 void sta_info_init(struct ieee80211_local *local);
497 void sta_info_stop(struct ieee80211_local *local);
498 int sta_info_flush(struct ieee80211_local *local,
499                    struct ieee80211_sub_if_data *sdata);
500 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
501                           unsigned long exp_time);
502
503 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
504 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
505
506 #endif /* STA_INFO_H */