3 * Copyright (c) 2009-2010, Jouni Malinen <j@w1.fi>
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.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
15 #include "utils/includes.h"
17 #include "utils/common.h"
18 #include "utils/eloop.h"
19 #include "common/ieee802_11_defs.h"
20 #include "drivers/driver.h"
21 #include "wpa_supplicant_i.h"
29 * WPA_BSS_EXPIRATION_PERIOD - Period of expiration run in seconds
31 #define WPA_BSS_EXPIRATION_PERIOD 10
34 * WPA_BSS_EXPIRATION_AGE - BSS entry age after which it can be expired
36 * This value control the time in seconds after which a BSS entry gets removed
37 * if it has not been updated or is not in use.
39 #define WPA_BSS_EXPIRATION_AGE 180
42 * WPA_BSS_EXPIRATION_SCAN_COUNT - Expire BSS after number of scans
44 * If the BSS entry has not been seen in this many scans, it will be removed.
45 * Value 1 means that the entry is removed after the first scan without the
46 * BSSID being seen. Larger values can be used to avoid BSS entries
47 * disappearing if they are not visible in every scan (e.g., low signal quality
50 #define WPA_BSS_EXPIRATION_SCAN_COUNT 2
52 #define WPA_BSS_FREQ_CHANGED_FLAG BIT(0)
53 #define WPA_BSS_SIGNAL_CHANGED_FLAG BIT(1)
54 #define WPA_BSS_PRIVACY_CHANGED_FLAG BIT(2)
55 #define WPA_BSS_MODE_CHANGED_FLAG BIT(3)
56 #define WPA_BSS_WPAIE_CHANGED_FLAG BIT(4)
57 #define WPA_BSS_RSNIE_CHANGED_FLAG BIT(5)
58 #define WPA_BSS_WPS_CHANGED_FLAG BIT(6)
59 #define WPA_BSS_RATES_CHANGED_FLAG BIT(7)
60 #define WPA_BSS_IES_CHANGED_FLAG BIT(8)
63 static void wpa_bss_remove(struct wpa_supplicant *wpa_s, struct wpa_bss *bss)
65 dl_list_del(&bss->list);
66 dl_list_del(&bss->list_id);
68 wpa_dbg(wpa_s, MSG_DEBUG, "BSS: Remove id %u BSSID " MACSTR
69 " SSID '%s'", bss->id, MAC2STR(bss->bssid),
70 wpa_ssid_txt(bss->ssid, bss->ssid_len));
71 wpas_notify_bss_removed(wpa_s, bss->bssid, bss->id);
76 struct wpa_bss * wpa_bss_get(struct wpa_supplicant *wpa_s, const u8 *bssid,
77 const u8 *ssid, size_t ssid_len)
80 dl_list_for_each(bss, &wpa_s->bss, struct wpa_bss, list) {
81 if (os_memcmp(bss->bssid, bssid, ETH_ALEN) == 0 &&
82 bss->ssid_len == ssid_len &&
83 os_memcmp(bss->ssid, ssid, ssid_len) == 0)
90 static void wpa_bss_copy_res(struct wpa_bss *dst, struct wpa_scan_res *src)
94 dst->flags = src->flags;
95 os_memcpy(dst->bssid, src->bssid, ETH_ALEN);
96 dst->freq = src->freq;
97 dst->beacon_int = src->beacon_int;
98 dst->caps = src->caps;
99 dst->qual = src->qual;
100 dst->noise = src->noise;
101 dst->level = src->level;
104 os_get_time(&dst->last_update);
105 dst->last_update.sec -= src->age / 1000;
106 usec = (src->age % 1000) * 1000;
107 if (dst->last_update.usec < usec) {
108 dst->last_update.sec--;
109 dst->last_update.usec += 1000000;
111 dst->last_update.usec -= usec;
115 static void wpa_bss_add(struct wpa_supplicant *wpa_s,
116 const u8 *ssid, size_t ssid_len,
117 struct wpa_scan_res *res)
121 bss = os_zalloc(sizeof(*bss) + res->ie_len + res->beacon_ie_len);
124 bss->id = wpa_s->bss_next_id++;
125 bss->last_update_idx = wpa_s->bss_update_idx;
126 wpa_bss_copy_res(bss, res);
127 os_memcpy(bss->ssid, ssid, ssid_len);
128 bss->ssid_len = ssid_len;
129 bss->ie_len = res->ie_len;
130 bss->beacon_ie_len = res->beacon_ie_len;
131 os_memcpy(bss + 1, res + 1, res->ie_len + res->beacon_ie_len);
133 dl_list_add_tail(&wpa_s->bss, &bss->list);
134 dl_list_add_tail(&wpa_s->bss_id, &bss->list_id);
136 wpa_dbg(wpa_s, MSG_DEBUG, "BSS: Add new id %u BSSID " MACSTR
138 bss->id, MAC2STR(bss->bssid), wpa_ssid_txt(ssid, ssid_len));
139 wpas_notify_bss_added(wpa_s, bss->bssid, bss->id);
140 if (wpa_s->num_bss > wpa_s->conf->bss_max_count) {
141 /* Remove the oldest entry */
142 wpa_bss_remove(wpa_s, dl_list_first(&wpa_s->bss,
143 struct wpa_bss, list));
148 static int are_ies_equal(const struct wpa_bss *old,
149 const struct wpa_scan_res *new, u32 ie)
151 const u8 *old_ie, *new_ie;
152 struct wpabuf *old_ie_buff = NULL;
153 struct wpabuf *new_ie_buff = NULL;
154 int new_ie_len, old_ie_len, ret, is_multi;
157 case WPA_IE_VENDOR_TYPE:
158 old_ie = wpa_bss_get_vendor_ie(old, ie);
159 new_ie = wpa_scan_get_vendor_ie(new, ie);
162 case WPS_IE_VENDOR_TYPE:
163 old_ie_buff = wpa_bss_get_vendor_ie_multi(old, ie);
164 new_ie_buff = wpa_scan_get_vendor_ie_multi(new, ie);
168 case WLAN_EID_SUPP_RATES:
169 case WLAN_EID_EXT_SUPP_RATES:
170 old_ie = wpa_bss_get_ie(old, ie);
171 new_ie = wpa_scan_get_ie(new, ie);
175 wpa_printf(MSG_DEBUG, "bss: %s: cannot compare IEs", __func__);
180 /* in case of multiple IEs stored in buffer */
181 old_ie = old_ie_buff ? wpabuf_head_u8(old_ie_buff) : NULL;
182 new_ie = new_ie_buff ? wpabuf_head_u8(new_ie_buff) : NULL;
183 old_ie_len = old_ie_buff ? wpabuf_len(old_ie_buff) : 0;
184 new_ie_len = new_ie_buff ? wpabuf_len(new_ie_buff) : 0;
186 /* in case of single IE */
187 old_ie_len = old_ie ? old_ie[1] + 2 : 0;
188 new_ie_len = new_ie ? new_ie[1] + 2 : 0;
191 ret = (old_ie_len == new_ie_len &&
192 os_memcmp(old_ie, new_ie, old_ie_len) == 0);
194 wpabuf_free(old_ie_buff);
195 wpabuf_free(new_ie_buff);
201 static u32 wpa_bss_compare_res(const struct wpa_bss *old,
202 const struct wpa_scan_res *new)
205 int caps_diff = old->caps ^ new->caps;
207 if (old->freq != new->freq)
208 changes |= WPA_BSS_FREQ_CHANGED_FLAG;
210 if (old->level != new->level)
211 changes |= WPA_BSS_SIGNAL_CHANGED_FLAG;
213 if (caps_diff & IEEE80211_CAP_PRIVACY)
214 changes |= WPA_BSS_PRIVACY_CHANGED_FLAG;
216 if (caps_diff & IEEE80211_CAP_IBSS)
217 changes |= WPA_BSS_MODE_CHANGED_FLAG;
219 if (old->ie_len == new->ie_len &&
220 os_memcmp(old + 1, new + 1, old->ie_len) == 0)
222 changes |= WPA_BSS_IES_CHANGED_FLAG;
224 if (!are_ies_equal(old, new, WPA_IE_VENDOR_TYPE))
225 changes |= WPA_BSS_WPAIE_CHANGED_FLAG;
227 if (!are_ies_equal(old, new, WLAN_EID_RSN))
228 changes |= WPA_BSS_RSNIE_CHANGED_FLAG;
230 if (!are_ies_equal(old, new, WPS_IE_VENDOR_TYPE))
231 changes |= WPA_BSS_WPS_CHANGED_FLAG;
233 if (!are_ies_equal(old, new, WLAN_EID_SUPP_RATES) ||
234 !are_ies_equal(old, new, WLAN_EID_EXT_SUPP_RATES))
235 changes |= WPA_BSS_RATES_CHANGED_FLAG;
241 static void notify_bss_changes(struct wpa_supplicant *wpa_s, u32 changes,
242 const struct wpa_bss *bss)
244 if (changes & WPA_BSS_FREQ_CHANGED_FLAG)
245 wpas_notify_bss_freq_changed(wpa_s, bss->id);
247 if (changes & WPA_BSS_SIGNAL_CHANGED_FLAG)
248 wpas_notify_bss_signal_changed(wpa_s, bss->id);
250 if (changes & WPA_BSS_PRIVACY_CHANGED_FLAG)
251 wpas_notify_bss_privacy_changed(wpa_s, bss->id);
253 if (changes & WPA_BSS_MODE_CHANGED_FLAG)
254 wpas_notify_bss_mode_changed(wpa_s, bss->id);
256 if (changes & WPA_BSS_WPAIE_CHANGED_FLAG)
257 wpas_notify_bss_wpaie_changed(wpa_s, bss->id);
259 if (changes & WPA_BSS_RSNIE_CHANGED_FLAG)
260 wpas_notify_bss_rsnie_changed(wpa_s, bss->id);
262 if (changes & WPA_BSS_WPS_CHANGED_FLAG)
263 wpas_notify_bss_wps_changed(wpa_s, bss->id);
265 if (changes & WPA_BSS_IES_CHANGED_FLAG)
266 wpas_notify_bss_ies_changed(wpa_s, bss->id);
268 if (changes & WPA_BSS_RATES_CHANGED_FLAG)
269 wpas_notify_bss_rates_changed(wpa_s, bss->id);
273 static void wpa_bss_update(struct wpa_supplicant *wpa_s, struct wpa_bss *bss,
274 struct wpa_scan_res *res)
278 changes = wpa_bss_compare_res(bss, res);
279 bss->scan_miss_count = 0;
280 bss->last_update_idx = wpa_s->bss_update_idx;
281 wpa_bss_copy_res(bss, res);
282 /* Move the entry to the end of the list */
283 dl_list_del(&bss->list);
284 if (bss->ie_len + bss->beacon_ie_len >=
285 res->ie_len + res->beacon_ie_len) {
286 os_memcpy(bss + 1, res + 1, res->ie_len + res->beacon_ie_len);
287 bss->ie_len = res->ie_len;
288 bss->beacon_ie_len = res->beacon_ie_len;
290 struct wpa_bss *nbss;
291 struct dl_list *prev = bss->list_id.prev;
292 dl_list_del(&bss->list_id);
293 nbss = os_realloc(bss, sizeof(*bss) + res->ie_len +
297 os_memcpy(bss + 1, res + 1,
298 res->ie_len + res->beacon_ie_len);
299 bss->ie_len = res->ie_len;
300 bss->beacon_ie_len = res->beacon_ie_len;
302 dl_list_add(prev, &bss->list_id);
304 dl_list_add_tail(&wpa_s->bss, &bss->list);
306 notify_bss_changes(wpa_s, changes, bss);
310 static int wpa_bss_in_use(struct wpa_supplicant *wpa_s, struct wpa_bss *bss)
312 return bss == wpa_s->current_bss ||
313 os_memcmp(bss->bssid, wpa_s->bssid, ETH_ALEN) == 0 ||
314 os_memcmp(bss->bssid, wpa_s->pending_bssid, ETH_ALEN) == 0;
318 void wpa_bss_update_start(struct wpa_supplicant *wpa_s)
320 wpa_s->bss_update_idx++;
321 wpa_dbg(wpa_s, MSG_DEBUG, "BSS: Start scan result update %u",
322 wpa_s->bss_update_idx);
326 void wpa_bss_update_scan_res(struct wpa_supplicant *wpa_s,
327 struct wpa_scan_res *res)
329 const u8 *ssid, *p2p;
332 ssid = wpa_scan_get_ie(res, WLAN_EID_SSID);
334 wpa_dbg(wpa_s, MSG_DEBUG, "BSS: No SSID IE included for "
335 MACSTR, MAC2STR(res->bssid));
339 wpa_dbg(wpa_s, MSG_DEBUG, "BSS: Too long SSID IE included for "
340 MACSTR, MAC2STR(res->bssid));
344 p2p = wpa_scan_get_vendor_ie(res, P2P_IE_VENDOR_TYPE);
345 if (p2p && ssid[1] == P2P_WILDCARD_SSID_LEN &&
346 os_memcmp(ssid + 2, P2P_WILDCARD_SSID, P2P_WILDCARD_SSID_LEN) == 0)
347 return; /* Skip P2P listen discovery results here */
349 /* TODO: add option for ignoring BSSes we are not interested in
350 * (to save memory) */
351 bss = wpa_bss_get(wpa_s, res->bssid, ssid + 2, ssid[1]);
353 wpa_bss_add(wpa_s, ssid + 2, ssid[1], res);
355 wpa_bss_update(wpa_s, bss, res);
359 static int wpa_bss_included_in_scan(const struct wpa_bss *bss,
360 const struct scan_info *info)
368 if (info->num_freqs) {
370 for (i = 0; i < info->num_freqs; i++) {
371 if (bss->freq == info->freqs[i]) {
380 if (info->num_ssids) {
382 for (i = 0; i < info->num_ssids; i++) {
383 const struct wpa_driver_scan_ssid *s = &info->ssids[i];
384 if ((s->ssid == NULL || s->ssid_len == 0) ||
385 (s->ssid_len == bss->ssid_len &&
386 os_memcmp(s->ssid, bss->ssid, bss->ssid_len) ==
400 void wpa_bss_update_end(struct wpa_supplicant *wpa_s, struct scan_info *info,
403 struct wpa_bss *bss, *n;
406 return; /* do not expire entries without new scan */
408 dl_list_for_each_safe(bss, n, &wpa_s->bss, struct wpa_bss, list) {
409 if (wpa_bss_in_use(wpa_s, bss))
411 if (!wpa_bss_included_in_scan(bss, info))
412 continue; /* expire only BSSes that were scanned */
413 if (bss->last_update_idx < wpa_s->bss_update_idx)
414 bss->scan_miss_count++;
415 if (bss->scan_miss_count >= WPA_BSS_EXPIRATION_SCAN_COUNT) {
416 wpa_dbg(wpa_s, MSG_DEBUG, "BSS: Expire BSS %u due to "
417 "no match in scan", bss->id);
418 wpa_bss_remove(wpa_s, bss);
424 static void wpa_bss_timeout(void *eloop_ctx, void *timeout_ctx)
426 struct wpa_supplicant *wpa_s = eloop_ctx;
427 struct wpa_bss *bss, *n;
430 if (dl_list_empty(&wpa_s->bss))
434 t.sec -= WPA_BSS_EXPIRATION_AGE;
436 dl_list_for_each_safe(bss, n, &wpa_s->bss, struct wpa_bss, list) {
437 if (wpa_bss_in_use(wpa_s, bss))
440 if (os_time_before(&bss->last_update, &t)) {
441 wpa_dbg(wpa_s, MSG_DEBUG, "BSS: Expire BSS %u due to "
443 wpa_bss_remove(wpa_s, bss);
447 eloop_register_timeout(WPA_BSS_EXPIRATION_PERIOD, 0,
448 wpa_bss_timeout, wpa_s, NULL);
452 int wpa_bss_init(struct wpa_supplicant *wpa_s)
454 dl_list_init(&wpa_s->bss);
455 dl_list_init(&wpa_s->bss_id);
456 eloop_register_timeout(WPA_BSS_EXPIRATION_PERIOD, 0,
457 wpa_bss_timeout, wpa_s, NULL);
462 void wpa_bss_deinit(struct wpa_supplicant *wpa_s)
464 struct wpa_bss *bss, *n;
465 eloop_cancel_timeout(wpa_bss_timeout, wpa_s, NULL);
466 if (wpa_s->bss.next == NULL)
467 return; /* BSS table not yet initialized */
468 dl_list_for_each_safe(bss, n, &wpa_s->bss, struct wpa_bss, list)
469 wpa_bss_remove(wpa_s, bss);
473 struct wpa_bss * wpa_bss_get_bssid(struct wpa_supplicant *wpa_s,
477 dl_list_for_each(bss, &wpa_s->bss, struct wpa_bss, list) {
478 if (os_memcmp(bss->bssid, bssid, ETH_ALEN) == 0)
485 struct wpa_bss * wpa_bss_get_id(struct wpa_supplicant *wpa_s, unsigned int id)
488 dl_list_for_each(bss, &wpa_s->bss, struct wpa_bss, list) {
496 const u8 * wpa_bss_get_ie(const struct wpa_bss *bss, u8 ie)
500 pos = (const u8 *) (bss + 1);
501 end = pos + bss->ie_len;
503 while (pos + 1 < end) {
504 if (pos + 2 + pos[1] > end)
515 const u8 * wpa_bss_get_vendor_ie(const struct wpa_bss *bss, u32 vendor_type)
519 pos = (const u8 *) (bss + 1);
520 end = pos + bss->ie_len;
522 while (pos + 1 < end) {
523 if (pos + 2 + pos[1] > end)
525 if (pos[0] == WLAN_EID_VENDOR_SPECIFIC && pos[1] >= 4 &&
526 vendor_type == WPA_GET_BE32(&pos[2]))
535 struct wpabuf * wpa_bss_get_vendor_ie_multi(const struct wpa_bss *bss,
541 buf = wpabuf_alloc(bss->ie_len);
545 pos = (const u8 *) (bss + 1);
546 end = pos + bss->ie_len;
548 while (pos + 1 < end) {
549 if (pos + 2 + pos[1] > end)
551 if (pos[0] == WLAN_EID_VENDOR_SPECIFIC && pos[1] >= 4 &&
552 vendor_type == WPA_GET_BE32(&pos[2]))
553 wpabuf_put_data(buf, pos + 2 + 4, pos[1] - 4);
557 if (wpabuf_len(buf) == 0) {
566 int wpa_bss_get_max_rate(const struct wpa_bss *bss)
572 ie = wpa_bss_get_ie(bss, WLAN_EID_SUPP_RATES);
573 for (i = 0; ie && i < ie[1]; i++) {
574 if ((ie[i + 2] & 0x7f) > rate)
575 rate = ie[i + 2] & 0x7f;
578 ie = wpa_bss_get_ie(bss, WLAN_EID_EXT_SUPP_RATES);
579 for (i = 0; ie && i < ie[1]; i++) {
580 if ((ie[i + 2] & 0x7f) > rate)
581 rate = ie[i + 2] & 0x7f;
588 int wpa_bss_get_bit_rates(const struct wpa_bss *bss, u8 **rates)
595 ie = wpa_bss_get_ie(bss, WLAN_EID_SUPP_RATES);
596 ie2 = wpa_bss_get_ie(bss, WLAN_EID_EXT_SUPP_RATES);
598 len = (ie ? ie[1] : 0) + (ie2 ? ie2[1] : 0);
604 for (i = 0; ie && i < ie[1]; i++)
605 r[i] = ie[i + 2] & 0x7f;
607 for (j = 0; ie2 && j < ie2[1]; j++)
608 r[i + j] = ie2[j + 2] & 0x7f;