2 * WPA Supplicant - background scan and roaming module: learn
3 * Copyright (c) 2009-2010, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
14 #include "common/ieee802_11_defs.h"
15 #include "drivers/driver.h"
16 #include "config_ssid.h"
17 #include "wpa_supplicant_i.h"
22 struct bgscan_learn_bss {
26 u8 *neigh; /* num_neigh * ETH_ALEN buffer */
30 struct bgscan_learn_data {
31 struct wpa_supplicant *wpa_s;
32 const struct wpa_ssid *ssid;
35 int short_interval; /* use if signal < threshold */
36 int long_interval; /* use if signal > threshold */
37 struct os_time last_bgscan;
45 static void bss_free(struct bgscan_learn_bss *bss)
52 static int bssid_in_array(u8 *array, size_t array_len, const u8 *bssid)
56 if (array == NULL || array_len == 0)
59 for (i = 0; i < array_len; i++) {
60 if (os_memcmp(array + i * ETH_ALEN, bssid, ETH_ALEN) == 0)
68 static void bgscan_learn_add_neighbor(struct bgscan_learn_bss *bss,
73 if (os_memcmp(bss->bssid, bssid, ETH_ALEN) == 0)
75 if (bssid_in_array(bss->neigh, bss->num_neigh, bssid))
78 n = os_realloc_array(bss->neigh, bss->num_neigh + 1, ETH_ALEN);
82 os_memcpy(n + bss->num_neigh * ETH_ALEN, bssid, ETH_ALEN);
88 static struct bgscan_learn_bss * bgscan_learn_get_bss(
89 struct bgscan_learn_data *data, const u8 *bssid)
91 struct bgscan_learn_bss *bss;
93 dl_list_for_each(bss, &data->bss, struct bgscan_learn_bss, list) {
94 if (os_memcmp(bss->bssid, bssid, ETH_ALEN) == 0)
101 static int bgscan_learn_load(struct bgscan_learn_data *data)
105 struct bgscan_learn_bss *bss;
107 if (data->fname == NULL)
110 f = fopen(data->fname, "r");
114 wpa_printf(MSG_DEBUG, "bgscan learn: Loading data from %s",
117 if (fgets(buf, sizeof(buf), f) == NULL ||
118 os_strncmp(buf, "wpa_supplicant-bgscan-learn\n", 28) != 0) {
119 wpa_printf(MSG_INFO, "bgscan learn: Invalid data file %s",
125 while (fgets(buf, sizeof(buf), f)) {
126 if (os_strncmp(buf, "BSS ", 4) == 0) {
127 bss = os_zalloc(sizeof(*bss));
130 if (hwaddr_aton(buf + 4, bss->bssid) < 0) {
134 bss->freq = atoi(buf + 4 + 18);
135 dl_list_add(&data->bss, &bss->list);
136 wpa_printf(MSG_DEBUG, "bgscan learn: Loaded BSS "
137 "entry: " MACSTR " freq=%d",
138 MAC2STR(bss->bssid), bss->freq);
141 if (os_strncmp(buf, "NEIGHBOR ", 9) == 0) {
144 if (hwaddr_aton(buf + 9, addr) < 0)
146 bss = bgscan_learn_get_bss(data, addr);
149 if (hwaddr_aton(buf + 9 + 18, addr) < 0)
152 bgscan_learn_add_neighbor(bss, addr);
161 static void bgscan_learn_save(struct bgscan_learn_data *data)
164 struct bgscan_learn_bss *bss;
166 if (data->fname == NULL)
169 wpa_printf(MSG_DEBUG, "bgscan learn: Saving data to %s",
172 f = fopen(data->fname, "w");
175 fprintf(f, "wpa_supplicant-bgscan-learn\n");
177 dl_list_for_each(bss, &data->bss, struct bgscan_learn_bss, list) {
178 fprintf(f, "BSS " MACSTR " %d\n",
179 MAC2STR(bss->bssid), bss->freq);
182 dl_list_for_each(bss, &data->bss, struct bgscan_learn_bss, list) {
184 for (i = 0; i < bss->num_neigh; i++) {
185 fprintf(f, "NEIGHBOR " MACSTR " " MACSTR "\n",
187 MAC2STR(bss->neigh + i * ETH_ALEN));
195 static int in_array(int *array, int val)
202 for (i = 0; array[i]; i++) {
211 static int * bgscan_learn_get_freqs(struct bgscan_learn_data *data,
214 struct bgscan_learn_bss *bss;
215 int *freqs = NULL, *n;
219 dl_list_for_each(bss, &data->bss, struct bgscan_learn_bss, list) {
220 if (in_array(freqs, bss->freq))
222 n = os_realloc_array(freqs, *count + 2, sizeof(int));
226 freqs[*count] = bss->freq;
235 static int * bgscan_learn_get_probe_freq(struct bgscan_learn_data *data,
236 int *freqs, size_t count)
240 if (data->supp_freqs == NULL)
243 idx = data->probe_idx + 1;
244 while (idx != data->probe_idx) {
245 if (data->supp_freqs[idx] == 0) {
246 if (data->probe_idx == 0)
250 if (!in_array(freqs, data->supp_freqs[idx])) {
251 wpa_printf(MSG_DEBUG, "bgscan learn: Probe new freq "
252 "%u", data->supp_freqs[idx]);
253 data->probe_idx = idx;
254 n = os_realloc_array(freqs, count + 2, sizeof(int));
258 freqs[count] = data->supp_freqs[idx];
271 static void bgscan_learn_timeout(void *eloop_ctx, void *timeout_ctx)
273 struct bgscan_learn_data *data = eloop_ctx;
274 struct wpa_supplicant *wpa_s = data->wpa_s;
275 struct wpa_driver_scan_params params;
280 os_memset(¶ms, 0, sizeof(params));
281 params.num_ssids = 1;
282 params.ssids[0].ssid = data->ssid->ssid;
283 params.ssids[0].ssid_len = data->ssid->ssid_len;
284 if (data->ssid->scan_freq)
285 params.freqs = data->ssid->scan_freq;
287 freqs = bgscan_learn_get_freqs(data, &count);
288 wpa_printf(MSG_DEBUG, "bgscan learn: BSSes in this ESS have "
289 "been seen on %u channels", (unsigned int) count);
290 freqs = bgscan_learn_get_probe_freq(data, freqs, count);
294 for (i = 0; freqs && freqs[i]; i++) {
296 ret = os_snprintf(pos, msg + sizeof(msg) - pos, " %d",
298 if (ret < 0 || ret >= msg + sizeof(msg) - pos)
303 wpa_printf(MSG_DEBUG, "bgscan learn: Scanning frequencies:%s",
305 params.freqs = freqs;
308 wpa_printf(MSG_DEBUG, "bgscan learn: Request a background scan");
309 if (wpa_supplicant_trigger_scan(wpa_s, ¶ms)) {
310 wpa_printf(MSG_DEBUG, "bgscan learn: Failed to trigger scan");
311 eloop_register_timeout(data->scan_interval, 0,
312 bgscan_learn_timeout, data, NULL);
314 os_get_time(&data->last_bgscan);
319 static int bgscan_learn_get_params(struct bgscan_learn_data *data,
327 data->short_interval = atoi(params);
329 pos = os_strchr(params, ':');
333 data->signal_threshold = atoi(pos);
334 pos = os_strchr(pos, ':');
336 wpa_printf(MSG_ERROR, "bgscan learn: Missing scan interval "
341 data->long_interval = atoi(pos);
342 pos = os_strchr(pos, ':');
345 data->fname = os_strdup(pos);
352 static int * bgscan_learn_get_supp_freqs(struct wpa_supplicant *wpa_s)
354 struct hostapd_hw_modes *modes;
355 int i, j, *freqs = NULL, *n;
358 modes = wpa_s->hw.modes;
362 for (i = 0; i < wpa_s->hw.num_modes; i++) {
363 for (j = 0; j < modes[i].num_channels; j++) {
364 if (modes[i].channels[j].flag & HOSTAPD_CHAN_DISABLED)
366 /* some hw modes (e.g. 11b & 11g) contain same freqs */
367 if (in_array(freqs, modes[i].channels[j].freq))
369 n = os_realloc_array(freqs, count + 2, sizeof(int));
374 freqs[count] = modes[i].channels[j].freq;
384 static void * bgscan_learn_init(struct wpa_supplicant *wpa_s,
386 const struct wpa_ssid *ssid)
388 struct bgscan_learn_data *data;
390 data = os_zalloc(sizeof(*data));
393 dl_list_init(&data->bss);
396 if (bgscan_learn_get_params(data, params) < 0) {
397 os_free(data->fname);
401 if (data->short_interval <= 0)
402 data->short_interval = 30;
403 if (data->long_interval <= 0)
404 data->long_interval = 30;
406 if (bgscan_learn_load(data) < 0) {
407 os_free(data->fname);
412 wpa_printf(MSG_DEBUG, "bgscan learn: Signal strength threshold %d "
413 "Short bgscan interval %d Long bgscan interval %d",
414 data->signal_threshold, data->short_interval,
415 data->long_interval);
417 if (data->signal_threshold &&
418 wpa_drv_signal_monitor(wpa_s, data->signal_threshold, 4) < 0) {
419 wpa_printf(MSG_ERROR, "bgscan learn: Failed to enable "
420 "signal strength monitoring");
423 data->supp_freqs = bgscan_learn_get_supp_freqs(wpa_s);
424 data->scan_interval = data->short_interval;
425 eloop_register_timeout(data->scan_interval, 0, bgscan_learn_timeout,
429 * This function is called immediately after an association, so it is
430 * reasonable to assume that a scan was completed recently. This makes
431 * us skip an immediate new scan in cases where the current signal
432 * level is below the bgscan threshold.
434 os_get_time(&data->last_bgscan);
440 static void bgscan_learn_deinit(void *priv)
442 struct bgscan_learn_data *data = priv;
443 struct bgscan_learn_bss *bss, *n;
445 bgscan_learn_save(data);
446 eloop_cancel_timeout(bgscan_learn_timeout, data, NULL);
447 if (data->signal_threshold)
448 wpa_drv_signal_monitor(data->wpa_s, 0, 0);
449 os_free(data->fname);
450 dl_list_for_each_safe(bss, n, &data->bss, struct bgscan_learn_bss,
452 dl_list_del(&bss->list);
455 os_free(data->supp_freqs);
460 static int bgscan_learn_bss_match(struct bgscan_learn_data *data,
461 struct wpa_scan_res *bss)
465 ie = wpa_scan_get_ie(bss, WLAN_EID_SSID);
469 if (data->ssid->ssid_len != ie[1] ||
470 os_memcmp(data->ssid->ssid, ie + 2, ie[1]) != 0)
471 return 0; /* SSID mismatch */
477 static int bgscan_learn_notify_scan(void *priv,
478 struct wpa_scan_results *scan_res)
480 struct bgscan_learn_data *data = priv;
483 u8 bssid[MAX_BSS * ETH_ALEN];
484 size_t num_bssid = 0;
486 wpa_printf(MSG_DEBUG, "bgscan learn: scan result notification");
488 eloop_cancel_timeout(bgscan_learn_timeout, data, NULL);
489 eloop_register_timeout(data->scan_interval, 0, bgscan_learn_timeout,
492 for (i = 0; i < scan_res->num; i++) {
493 struct wpa_scan_res *res = scan_res->res[i];
494 if (!bgscan_learn_bss_match(data, res))
497 if (num_bssid < MAX_BSS) {
498 os_memcpy(bssid + num_bssid * ETH_ALEN, res->bssid,
503 wpa_printf(MSG_DEBUG, "bgscan learn: %u matching BSSes in scan "
504 "results", (unsigned int) num_bssid);
506 for (i = 0; i < scan_res->num; i++) {
507 struct wpa_scan_res *res = scan_res->res[i];
508 struct bgscan_learn_bss *bss;
510 if (!bgscan_learn_bss_match(data, res))
513 bss = bgscan_learn_get_bss(data, res->bssid);
514 if (bss && bss->freq != res->freq) {
515 wpa_printf(MSG_DEBUG, "bgscan learn: Update BSS "
516 MACSTR " freq %d -> %d",
517 MAC2STR(res->bssid), bss->freq, res->freq);
518 bss->freq = res->freq;
520 wpa_printf(MSG_DEBUG, "bgscan learn: Add BSS " MACSTR
521 " freq=%d", MAC2STR(res->bssid), res->freq);
522 bss = os_zalloc(sizeof(*bss));
525 os_memcpy(bss->bssid, res->bssid, ETH_ALEN);
526 bss->freq = res->freq;
527 dl_list_add(&data->bss, &bss->list);
530 for (j = 0; j < num_bssid; j++) {
531 u8 *addr = bssid + j * ETH_ALEN;
532 bgscan_learn_add_neighbor(bss, addr);
537 * A more advanced bgscan could process scan results internally, select
538 * the BSS and request roam if needed. This sample uses the existing
539 * BSS/ESS selection routine. Change this to return 1 if selection is
540 * done inside the bgscan module.
547 static void bgscan_learn_notify_beacon_loss(void *priv)
549 wpa_printf(MSG_DEBUG, "bgscan learn: beacon loss");
550 /* TODO: speed up background scanning */
554 static void bgscan_learn_notify_signal_change(void *priv, int above,
559 struct bgscan_learn_data *data = priv;
563 if (data->short_interval == data->long_interval ||
564 data->signal_threshold == 0)
567 wpa_printf(MSG_DEBUG, "bgscan learn: signal level changed "
568 "(above=%d current_signal=%d current_noise=%d "
569 "current_txrate=%d)", above, current_signal,
570 current_noise, current_txrate);
571 if (data->scan_interval == data->long_interval && !above) {
572 wpa_printf(MSG_DEBUG, "bgscan learn: Start using short bgscan "
574 data->scan_interval = data->short_interval;
576 if (now.sec > data->last_bgscan.sec + 1)
578 } else if (data->scan_interval == data->short_interval && above) {
579 wpa_printf(MSG_DEBUG, "bgscan learn: Start using long bgscan "
581 data->scan_interval = data->long_interval;
582 eloop_cancel_timeout(bgscan_learn_timeout, data, NULL);
583 eloop_register_timeout(data->scan_interval, 0,
584 bgscan_learn_timeout, data, NULL);
587 * Signal dropped further 4 dB. Request a new scan if we have
588 * not yet scanned in a while.
591 if (now.sec > data->last_bgscan.sec + 10)
596 wpa_printf(MSG_DEBUG, "bgscan learn: Trigger immediate scan");
597 eloop_cancel_timeout(bgscan_learn_timeout, data, NULL);
598 eloop_register_timeout(0, 0, bgscan_learn_timeout, data, NULL);
603 const struct bgscan_ops bgscan_learn_ops = {
605 .init = bgscan_learn_init,
606 .deinit = bgscan_learn_deinit,
607 .notify_scan = bgscan_learn_notify_scan,
608 .notify_beacon_loss = bgscan_learn_notify_beacon_loss,
609 .notify_signal_change = bgscan_learn_notify_signal_change,