ieee80211_node.h revision 138568
1/*- 2 * Copyright (c) 2001 Atsushi Onoe 3 * Copyright (c) 2002, 2003 Sam Leffler, Errno Consulting 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * Alternatively, this software may be distributed under the terms of the 18 * GNU General Public License ("GPL") version 2 as published by the Free 19 * Software Foundation. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 * 32 * $FreeBSD: head/sys/net80211/ieee80211_node.h 138568 2004-12-08 17:26:47Z sam $ 33 */ 34#ifndef _NET80211_IEEE80211_NODE_H_ 35#define _NET80211_IEEE80211_NODE_H_ 36 37#include <net80211/ieee80211_ioctl.h> /* for ieee80211_nodestats */ 38 39/* 40 * Each ieee80211com instance has a single timer that fires once a 41 * second. This is used to initiate various work depending on the 42 * state of the instance: scanning (passive or active), ``transition'' 43 * (waiting for a response to a management frame when operating 44 * as a station), and node inactivity processing (when operating 45 * as an AP). For inactivity processing each node has a timeout 46 * set in it's ni_inact field that is decremented on each timeout 47 * and the node is reclaimed when the counter goes to zero. We 48 * use different inactivity timeout values depending on whether 49 * the node is associated and authorized (either by 802.1x or 50 * open/shared key authentication) or associated but yet to be 51 * authorized. The latter timeout is shorter to more aggressively 52 * reclaim nodes that leave part way through the 802.1x exchange. 53 */ 54#define IEEE80211_INACT_WAIT 15 /* inactivity interval (secs) */ 55#define IEEE80211_INACT_INIT (30/IEEE80211_INACT_WAIT) /* initial */ 56#define IEEE80211_INACT_AUTH (180/IEEE80211_INACT_WAIT) /* associated but not authorized */ 57#define IEEE80211_INACT_RUN (300/IEEE80211_INACT_WAIT) /* authorized */ 58#define IEEE80211_INACT_PROBE (30/IEEE80211_INACT_WAIT) /* probe */ 59#define IEEE80211_INACT_SCAN (300/IEEE80211_INACT_WAIT) /* scanned */ 60 61#define IEEE80211_TRANS_WAIT 5 /* mgt frame tx timer (secs) */ 62 63#define IEEE80211_NODE_HASHSIZE 32 64/* simple hash is enough for variation of macaddr */ 65#define IEEE80211_NODE_HASH(addr) \ 66 (((const u_int8_t *)(addr))[IEEE80211_ADDR_LEN - 1] % \ 67 IEEE80211_NODE_HASHSIZE) 68 69struct ieee80211_rsnparms { 70 u_int8_t rsn_mcastcipher; /* mcast/group cipher */ 71 u_int8_t rsn_mcastkeylen; /* mcast key length */ 72 u_int8_t rsn_ucastcipherset; /* unicast cipher set */ 73 u_int8_t rsn_ucastcipher; /* selected unicast cipher */ 74 u_int8_t rsn_ucastkeylen; /* unicast key length */ 75 u_int8_t rsn_keymgmtset; /* key mangement algorithms */ 76 u_int8_t rsn_keymgmt; /* selected key mgmt algo */ 77 u_int16_t rsn_caps; /* capabilities */ 78}; 79 80struct ieee80211_node_table; 81struct ieee80211com; 82 83/* 84 * Node specific information. Note that drivers are expected 85 * to derive from this structure to add device-specific per-node 86 * state. This is done by overriding the ic_node_* methods in 87 * the ieee80211com structure. 88 */ 89struct ieee80211_node { 90 struct ieee80211com *ni_ic; 91 struct ieee80211_node_table *ni_table; 92 TAILQ_ENTRY(ieee80211_node) ni_list; 93 LIST_ENTRY(ieee80211_node) ni_hash; 94 u_int ni_refcnt; 95 u_int ni_scangen; /* gen# for timeout scan */ 96 u_int8_t ni_authmode; /* authentication algorithm */ 97 u_int16_t ni_flags; /* special-purpose state */ 98#define IEEE80211_NODE_AUTH 0x0001 /* authorized for data */ 99#define IEEE80211_NODE_QOS 0x0002 /* QoS enabled */ 100#define IEEE80211_NODE_ERP 0x0004 /* ERP enabled */ 101/* NB: this must have the same value as IEEE80211_FC1_PWR_MGT */ 102#define IEEE80211_NODE_PWR_MGT 0x0010 /* power save mode enabled */ 103 u_int16_t ni_associd; /* assoc response */ 104 u_int16_t ni_txpower; /* current transmit power */ 105 u_int16_t ni_vlan; /* vlan tag */ 106 u_int32_t *ni_challenge; /* shared-key challenge */ 107 u_int8_t *ni_wpa_ie; /* captured WPA/RSN ie */ 108 u_int8_t *ni_wme_ie; /* captured WME ie */ 109 u_int16_t ni_txseqs[17]; /* tx seq per-tid */ 110 u_int16_t ni_rxseqs[17]; /* rx seq previous per-tid*/ 111 u_int32_t ni_rxfragstamp; /* time stamp of last rx frag */ 112 struct mbuf *ni_rxfrag[3]; /* rx frag reassembly */ 113 struct ieee80211_rsnparms ni_rsn; /* RSN/WPA parameters */ 114 struct ieee80211_key ni_ucastkey; /* unicast key */ 115 116 /* hardware */ 117 u_int32_t ni_rstamp; /* recv timestamp */ 118 u_int8_t ni_rssi; /* recv ssi */ 119 120 /* header */ 121 u_int8_t ni_macaddr[IEEE80211_ADDR_LEN]; 122 u_int8_t ni_bssid[IEEE80211_ADDR_LEN]; 123 124 /* beacon, probe response */ 125 union { 126 u_int8_t data[8]; 127 u_int64_t tsf; 128 } ni_tstamp; /* from last rcv'd beacon */ 129 u_int16_t ni_intval; /* beacon interval */ 130 u_int16_t ni_capinfo; /* capabilities */ 131 u_int8_t ni_esslen; 132 u_int8_t ni_essid[IEEE80211_NWID_LEN]; 133 struct ieee80211_rateset ni_rates; /* negotiated rate set */ 134 struct ieee80211_channel *ni_chan; 135 u_int16_t ni_fhdwell; /* FH only */ 136 u_int8_t ni_fhindex; /* FH only */ 137 u_int8_t ni_erp; /* ERP from beacon/probe resp */ 138 u_int16_t ni_timoff; /* byte offset to TIM ie */ 139 140 /* others */ 141 int ni_fails; /* failure count to associate */ 142 short ni_inact; /* inactivity mark count */ 143 short ni_inact_reload;/* inactivity reload value */ 144 int ni_txrate; /* index to ni_rates[] */ 145 struct ifqueue ni_savedq; /* ps-poll queue */ 146 struct ieee80211_nodestats ni_stats; /* per-node statistics */ 147}; 148MALLOC_DECLARE(M_80211_NODE); 149 150#define IEEE80211_NODE_AID(ni) IEEE80211_AID(ni->ni_associd) 151 152#define IEEE80211_NODE_STAT(ni,stat) (ni->ni_stats.ns_##stat++) 153#define IEEE80211_NODE_STAT_ADD(ni,stat,v) (ni->ni_stats.ns_##stat += v) 154#define IEEE80211_NODE_STAT_SET(ni,stat,v) (ni->ni_stats.ns_##stat = v) 155 156static __inline struct ieee80211_node * 157ieee80211_ref_node(struct ieee80211_node *ni) 158{ 159 ieee80211_node_incref(ni); 160 return ni; 161} 162 163static __inline void 164ieee80211_unref_node(struct ieee80211_node **ni) 165{ 166 ieee80211_node_decref(*ni); 167 *ni = NULL; /* guard against use */ 168} 169 170struct ieee80211com; 171 172extern void ieee80211_node_attach(struct ieee80211com *); 173extern void ieee80211_node_lateattach(struct ieee80211com *); 174extern void ieee80211_node_detach(struct ieee80211com *); 175 176static __inline int 177ieee80211_node_is_authorized(const struct ieee80211_node *ni) 178{ 179 return (ni->ni_flags & IEEE80211_NODE_AUTH); 180} 181 182extern void ieee80211_node_authorize(struct ieee80211com *, 183 struct ieee80211_node *); 184extern void ieee80211_node_unauthorize(struct ieee80211com *, 185 struct ieee80211_node *); 186 187extern void ieee80211_begin_scan(struct ieee80211com *, int); 188extern int ieee80211_next_scan(struct ieee80211com *); 189extern void ieee80211_create_ibss(struct ieee80211com*, 190 struct ieee80211_channel *); 191extern void ieee80211_reset_bss(struct ieee80211com *); 192extern void ieee80211_end_scan(struct ieee80211com *); 193extern int ieee80211_ibss_merge(struct ieee80211com *, 194 struct ieee80211_node *); 195extern int ieee80211_sta_join(struct ieee80211com *, 196 struct ieee80211_node *); 197extern void ieee80211_sta_leave(struct ieee80211com *, 198 struct ieee80211_node *); 199 200/* 201 * Table of ieee80211_node instances. Each ieee80211com 202 * has at least one for holding the scan candidates. 203 * When operating as an access point or in ibss mode there 204 * is a second table for associated stations or neighbors. 205 */ 206struct ieee80211_node_table { 207 struct ieee80211com *nt_ic; /* back reference */ 208 ieee80211_node_lock_t nt_nodelock; /* on node table */ 209 TAILQ_HEAD(, ieee80211_node) nt_node; /* information of all nodes */ 210 LIST_HEAD(, ieee80211_node) nt_hash[IEEE80211_NODE_HASHSIZE]; 211 const char *nt_name; /* for debugging */ 212 ieee80211_scan_lock_t nt_scanlock; /* on nt_scangen */ 213 u_int nt_scangen; /* gen# for timeout scan */ 214 int nt_inact_timer; /* inactivity timer */ 215 int nt_inact_init; /* initial node inact setting */ 216 217 void (*nt_timeout)(struct ieee80211_node_table *); 218}; 219extern void ieee80211_node_table_reset(struct ieee80211_node_table *); 220extern void ieee80211_node_table_free(struct ieee80211_node_table *); 221 222extern struct ieee80211_node *ieee80211_alloc_node( 223 struct ieee80211_node_table *, const u_int8_t *); 224extern struct ieee80211_node *ieee80211_dup_bss(struct ieee80211_node_table *, 225 const u_int8_t *); 226#ifdef IEEE80211_DEBUG_REFCNT 227extern void ieee80211_free_node_debug(struct ieee80211_node *, 228 const char *func, int line); 229extern struct ieee80211_node *ieee80211_find_node_debug( 230 struct ieee80211_node_table *, const u_int8_t *, 231 const char *func, int line); 232extern struct ieee80211_node * ieee80211_find_rxnode_debug( 233 struct ieee80211com *, const struct ieee80211_frame_min *, 234 const char *func, int line); 235extern struct ieee80211_node *ieee80211_find_txnode_debug( 236 struct ieee80211com *, const u_int8_t *, 237 const char *func, int line); 238extern struct ieee80211_node *ieee80211_find_node_with_channel_debug( 239 struct ieee80211_node_table *, const u_int8_t *macaddr, 240 struct ieee80211_channel *, const char *func, int line); 241extern struct ieee80211_node *ieee80211_find_node_with_ssid_debug( 242 struct ieee80211_node_table *, const u_int8_t *macaddr, 243 u_int ssidlen, const u_int8_t *ssid, 244 const char *func, int line); 245#define ieee80211_free_node(ni) \ 246 ieee80211_free_node_debug(ni, __func__, __LINE__) 247#define ieee80211_find_node(nt, mac) \ 248 ieee80211_find_node_debug(nt, mac, __func__, __LINE__) 249#define ieee80211_find_rxnode(nt, wh) \ 250 ieee80211_find_rxnode_debug(nt, wh, __func__, __LINE__) 251#define ieee80211_find_txnode(nt, mac) \ 252 ieee80211_find_txnode_debug(nt, mac, __func__, __LINE__) 253#define ieee80211_find_node_with_channel(nt, mac, c) \ 254 ieee80211_find_node_with_channel_debug(nt, mac, c, __func__, __LINE__) 255#define ieee80211_find_node_with_ssid(nt, mac, sl, ss) \ 256 ieee80211_find_node_with_ssid_debug(nt, mac, sl, ss, __func__, __LINE__) 257#else 258extern void ieee80211_free_node(struct ieee80211_node *); 259extern struct ieee80211_node *ieee80211_find_node( 260 struct ieee80211_node_table *, const u_int8_t *); 261extern struct ieee80211_node * ieee80211_find_rxnode( 262 struct ieee80211com *, const struct ieee80211_frame_min *); 263extern struct ieee80211_node *ieee80211_find_txnode( 264 struct ieee80211com *, const u_int8_t *); 265extern struct ieee80211_node *ieee80211_find_node_with_channel( 266 struct ieee80211_node_table *, const u_int8_t *macaddr, 267 struct ieee80211_channel *); 268extern struct ieee80211_node *ieee80211_find_node_with_ssid( 269 struct ieee80211_node_table *, const u_int8_t *macaddr, 270 u_int ssidlen, const u_int8_t *ssid); 271#endif 272 273typedef void ieee80211_iter_func(void *, struct ieee80211_node *); 274extern void ieee80211_iterate_nodes(struct ieee80211_node_table *, 275 ieee80211_iter_func *, void *); 276 277extern void ieee80211_dump_node(struct ieee80211_node_table *, 278 struct ieee80211_node *); 279extern void ieee80211_dump_nodes(struct ieee80211_node_table *); 280 281extern struct ieee80211_node *ieee80211_fakeup_adhoc_node( 282 struct ieee80211_node_table *nt, 283 const u_int8_t macaddr[]); 284extern void ieee80211_node_join(struct ieee80211com *, 285 struct ieee80211_node *, int); 286extern void ieee80211_node_leave(struct ieee80211com *, 287 struct ieee80211_node *); 288extern u_int8_t ieee80211_getrssi(struct ieee80211com *ic); 289#endif /* _NET80211_IEEE80211_NODE_H_ */ 290