aboutsummaryrefslogtreecommitdiffstats
path: root/src/fst/fst_group.c
blob: 321d40d50cd2377da68b09d3e565173b97138fd5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
/*
 * FST module - FST group object implementation
 * Copyright (c) 2014, Qualcomm Atheros, Inc.
 *
 * This software may be distributed under the terms of the BSD license.
 * See README for more details.
 */

#include "utils/includes.h"
#include "utils/common.h"
#include "common/defs.h"
#include "common/ieee802_11_defs.h"
#include "common/ieee802_11_common.h"
#include "drivers/driver.h"
#include "fst/fst_internal.h"
#include "fst/fst_defs.h"


struct dl_list fst_global_groups_list;


static void fst_dump_mb_ies(const char *group_id, const char *ifname,
			    struct wpabuf *mbies)
{
	const u8 *p = wpabuf_head(mbies);
	size_t s = wpabuf_len(mbies);

	while (s >= 2) {
		const struct multi_band_ie *mbie =
			(const struct multi_band_ie *) p;
		WPA_ASSERT(mbie->eid == WLAN_EID_MULTI_BAND);
		WPA_ASSERT(2 + mbie->len >= sizeof(*mbie));

		fst_printf(MSG_WARNING,
			   "%s: %s: mb_ctrl=%u band_id=%u op_class=%u chan=%u bssid="
			   MACSTR
			   " beacon_int=%u tsf_offs=[%u %u %u %u %u %u %u %u] mb_cc=0x%02x tmout=%u",
			   group_id, ifname,
			   mbie->mb_ctrl, mbie->band_id, mbie->op_class,
			   mbie->chan, MAC2STR(mbie->bssid), mbie->beacon_int,
			   mbie->tsf_offs[0], mbie->tsf_offs[1],
			   mbie->tsf_offs[2], mbie->tsf_offs[3],
			   mbie->tsf_offs[4], mbie->tsf_offs[5],
			   mbie->tsf_offs[6], mbie->tsf_offs[7],
			   mbie->mb_connection_capability,
			   mbie->fst_session_tmout);

		p += 2 + mbie->len;
		s -= 2 + mbie->len;
	}
}


static void fst_fill_mb_ie(struct wpabuf *buf, const u8 *bssid,
			   const u8 *own_addr, enum mb_band_id band, u8 channel)
{
	struct multi_band_ie *mbie;
	size_t len = sizeof(*mbie);

	if (own_addr)
		len += ETH_ALEN;

	mbie = wpabuf_put(buf, len);

	os_memset(mbie, 0, len);

	mbie->eid = WLAN_EID_MULTI_BAND;
	mbie->len = len - 2;
#ifdef HOSTAPD
	mbie->mb_ctrl = MB_STA_ROLE_AP;
	mbie->mb_connection_capability = MB_CONNECTION_CAPABILITY_AP;
#else /* HOSTAPD */
	mbie->mb_ctrl = MB_STA_ROLE_NON_PCP_NON_AP;
	mbie->mb_connection_capability = 0;
#endif /* HOSTAPD */
	if (bssid)
		os_memcpy(mbie->bssid, bssid, ETH_ALEN);
	mbie->band_id = band;
	mbie->op_class = 0;  /* means all */
	mbie->chan = channel;
	mbie->fst_session_tmout = FST_DEFAULT_SESSION_TIMEOUT_TU;

	if (own_addr) {
		mbie->mb_ctrl |= MB_CTRL_STA_MAC_PRESENT;
		os_memcpy(&mbie[1], own_addr, ETH_ALEN);
	}
}


static unsigned fst_fill_iface_mb_ies(struct fst_iface *f, struct wpabuf *buf)
{
	const  u8 *bssid;

	bssid = fst_iface_get_bssid(f);
	if (bssid) {
		enum hostapd_hw_mode hw_mode;
		u8 channel;

		if (buf) {
			fst_iface_get_channel_info(f, &hw_mode, &channel);
			fst_fill_mb_ie(buf, bssid, fst_iface_get_addr(f),
				       fst_hw_mode_to_band(hw_mode), channel);
		}
		return 1;
	} else {
		unsigned bands[MB_BAND_ID_WIFI_60GHZ + 1] = {};
		struct hostapd_hw_modes *modes;
		enum mb_band_id b;
		int num_modes = fst_iface_get_hw_modes(f, &modes);
		int ret = 0;

		while (num_modes--) {
			b = fst_hw_mode_to_band(modes->mode);
			modes++;
			if (b >= ARRAY_SIZE(bands) || bands[b]++)
				continue;
			ret++;
			if (buf)
				fst_fill_mb_ie(buf, NULL, fst_iface_get_addr(f),
					       b, MB_STA_CHANNEL_ALL);
		}
		return ret;
	}
}


static struct wpabuf * fst_group_create_mb_ie(struct fst_group *g,
					      struct fst_iface *i)
{
	struct wpabuf *buf;
	struct fst_iface *f;
	unsigned int nof_mbies = 0;
	unsigned int nof_ifaces_added = 0;

	foreach_fst_group_iface(g, f) {
		if (f == i)
			continue;
		nof_mbies += fst_fill_iface_mb_ies(f, NULL);
	}

	buf = wpabuf_alloc(nof_mbies *
			   (sizeof(struct multi_band_ie) + ETH_ALEN));
	if (!buf) {
		fst_printf_iface(i, MSG_ERROR,
				 "cannot allocate mem for %u MB IEs",
				 nof_mbies);
		return NULL;
	}

	/* The list is sorted in descending order by priorities, so MB IEs will
	 * be arranged in the same order, as required by spec (see corresponding
	 * comment in.fst_attach().
	 */
	foreach_fst_group_iface(g, f) {
		if (f == i)
			continue;

		fst_fill_iface_mb_ies(f, buf);
		++nof_ifaces_added;

		fst_printf_iface(i, MSG_DEBUG, "added to MB IE");
	}

	if (!nof_ifaces_added) {
		wpabuf_free(buf);
		buf = NULL;
		fst_printf_iface(i, MSG_INFO,
				 "cannot add MB IE: no backup ifaces");
	} else {
		fst_dump_mb_ies(fst_group_get_id(g), fst_iface_get_name(i),
				buf);
	}

	return buf;
}


static const u8 * fst_mbie_get_peer_addr(const struct multi_band_ie *mbie)
{
	const u8 *peer_addr = NULL;

	switch (MB_CTRL_ROLE(mbie->mb_ctrl)) {
	case MB_STA_ROLE_AP:
		peer_addr = mbie->bssid;
		break;
	case MB_STA_ROLE_NON_PCP_NON_AP:
		if (mbie->mb_ctrl & MB_CTRL_STA_MAC_PRESENT &&
		    (size_t) 2 + mbie->len >= sizeof(*mbie) + ETH_ALEN)
			peer_addr = (const u8 *) &mbie[1];
		break;
	default:
		break;
	}

	return peer_addr;
}


static const u8 * fst_mbie_get_peer_addr_for_band(const struct wpabuf *mbies,
						  u8 band_id)
{
	const u8 *p = wpabuf_head(mbies);
	size_t s = wpabuf_len(mbies);

	while (s >= 2) {
		const struct multi_band_ie *mbie =
			(const struct multi_band_ie *) p;

		if (mbie->eid != WLAN_EID_MULTI_BAND) {
			fst_printf(MSG_INFO, "unexpected eid %d", mbie->eid);
			return NULL;
		}

		if (mbie->len < sizeof(*mbie) - 2 || mbie->len > s - 2) {
			fst_printf(MSG_INFO, "invalid mbie len %d",
				   mbie->len);
			return NULL;
		}

		if (mbie->band_id == band_id)
			return fst_mbie_get_peer_addr(mbie);

		p += 2 + mbie->len;
		s -= 2 + mbie->len;
	}

	fst_printf(MSG_INFO, "mbie doesn't contain band %d", band_id);
	return NULL;
}


struct fst_iface * fst_group_get_iface_by_name(struct fst_group *g,
					       const char *ifname)
{
	struct fst_iface *f;

	foreach_fst_group_iface(g, f) {
		const char *in = fst_iface_get_name(f);

		if (os_strncmp(in, ifname, os_strlen(in)) == 0)
			return f;
	}

	return NULL;
}


u8 fst_group_assign_dialog_token(struct fst_group *g)
{
	g->dialog_token++;
	if (g->dialog_token == 0)
		g->dialog_token++;
	return g->dialog_token;
}


u32 fst_group_assign_fsts_id(struct fst_group *g)
{
	g->fsts_id++;
	return g->fsts_id;
}


/**
 * fst_group_get_peer_other_connection_1 - Find peer's "other" connection
 * (iface, MAC tuple) by using peer's MB IE on iface.
 *
 * @iface: iface on which FST Setup Request was received
 * @peer_addr: Peer address on iface
 * @band_id: "other" connection band id
 * @other_peer_addr (out): Peer's MAC address on the "other" connection (on the
 *   "other" iface)
 *
 * This function parses peer's MB IE on iface. It looks for peer's MAC address
 * on band_id (tmp_peer_addr). Next all interfaces are iterated to find an
 * interface which correlates with band_id. If such interface is found, peer
 * database is iterated to see if tmp_peer_addr is connected over it.
 */
static struct fst_iface *
fst_group_get_peer_other_connection_1(struct fst_iface *iface,
				      const u8 *peer_addr, u8 band_id,
				      u8 *other_peer_addr)
{
	const struct wpabuf *mbies;
	struct fst_iface *other_iface;
	const u8 *tmp_peer_addr;

	/* Get peer's MB IEs on iface */
	mbies = fst_iface_get_peer_mb_ie(iface, peer_addr);
	if (!mbies)
		return NULL;

	/* Get peer's MAC address on the "other" interface */
	tmp_peer_addr = fst_mbie_get_peer_addr_for_band(mbies, band_id);
	if (!tmp_peer_addr) {
		fst_printf(MSG_INFO,
			   "couldn't extract other peer addr from mbies");
		return NULL;
	}

	fst_printf(MSG_DEBUG, "found other peer addr from mbies: " MACSTR,
		   MAC2STR(tmp_peer_addr));

	foreach_fst_group_iface(fst_iface_get_group(iface), other_iface) {
		if (other_iface == iface ||
		    band_id != fst_iface_get_band_id(other_iface))
			continue;
		if (fst_iface_is_connected(other_iface, tmp_peer_addr, FALSE)) {
			os_memcpy(other_peer_addr, tmp_peer_addr, ETH_ALEN);
			return other_iface;
		}
	}

	return NULL;
}


/**
 * fst_group_get_peer_other_connection_2 - Find peer's "other" connection
 * (iface, MAC tuple) by using MB IEs of other peers.
 *
 * @iface: iface on which FST Setup Request was received
 * @peer_addr: Peer address on iface
 * @band_id: "other" connection band id
 * @other_peer_addr (out): Peer's MAC address on the "other" connection (on the
 *   "other" iface)
 *
 * This function iterates all connection (other_iface, cur_peer_addr tuples).
 * For each connection, MB IE (of cur_peer_addr on other_iface) is parsed and
 * MAC address on iface's band_id is extracted (this_peer_addr).
 * this_peer_addr is then compared to peer_addr. A match indicates we have
 * found the "other" connection.
 */
static struct fst_iface *
fst_group_get_peer_other_connection_2(struct fst_iface *iface,
				      const u8 *peer_addr, u8 band_id,
				      u8 *other_peer_addr)
{
	u8 this_band_id = fst_iface_get_band_id(iface);
	const u8 *cur_peer_addr, *this_peer_addr;
	struct fst_get_peer_ctx *ctx;
	struct fst_iface *other_iface;
	const struct wpabuf *cur_mbie;

	foreach_fst_group_iface(fst_iface_get_group(iface), other_iface) {
		if (other_iface == iface ||
		    band_id != fst_iface_get_band_id(other_iface))
			continue;
		cur_peer_addr = fst_iface_get_peer_first(other_iface, &ctx,
							 TRUE);
		for (; cur_peer_addr;
		     cur_peer_addr = fst_iface_get_peer_next(other_iface, &ctx,
							     TRUE)) {
			cur_mbie = fst_iface_get_peer_mb_ie(other_iface,
							    cur_peer_addr);
			if (!cur_mbie)
				continue;
			this_peer_addr = fst_mbie_get_peer_addr_for_band(
				cur_mbie, this_band_id);
			if (!this_peer_addr)
				continue;
			if (os_memcmp(this_peer_addr, peer_addr, ETH_ALEN) ==
			    0) {
				os_memcpy(other_peer_addr, cur_peer_addr,
					  ETH_ALEN);
				return other_iface;
			}
		}
	}

	return NULL;
}


/**
 * fst_group_get_peer_other_connection - Find peer's "other" connection (iface,
 * MAC tuple).
 *
 * @iface: iface on which FST Setup Request was received
 * @peer_addr: Peer address on iface
 * @band_id: "other" connection band id
 * @other_peer_addr (out): Peer's MAC address on the "other" connection (on the
 *   "other" iface)
 *
 * This function is called upon receiving FST Setup Request from some peer who
 * has peer_addr on iface. It searches for another connection of the same peer
 * on different interface which correlates with band_id. MB IEs received from
 * peer (on the two different interfaces) are used to identify same peer.
 */
struct fst_iface *
fst_group_get_peer_other_connection(struct fst_iface *iface,
				    const u8 *peer_addr, u8 band_id,
				    u8 *other_peer_addr)
{
	struct fst_iface *other_iface;

	fst_printf(MSG_DEBUG, "%s: %s:" MACSTR ", %d", __func__,
		   fst_iface_get_name(iface), MAC2STR(peer_addr), band_id);

	/*
	 * Two search methods are used:
	 * 1. Use peer's MB IE on iface to extract peer's MAC address on
	 *    "other" connection. Then check if such "other" connection exists.
	 * 2. Iterate peer database, examine each MB IE to see if it points to
	 *    (iface, peer_addr) tuple
	 */

	other_iface = fst_group_get_peer_other_connection_1(iface, peer_addr,
							    band_id,
							    other_peer_addr);
	if (other_iface) {
		fst_printf(MSG_DEBUG, "found by method #1. %s:" MACSTR,
			   fst_iface_get_name(other_iface),
			   MAC2STR(other_peer_addr));
		return other_iface;
	}

	other_iface = fst_group_get_peer_other_connection_2(iface, peer_addr,
							    band_id,
							    other_peer_addr);
	if (other_iface) {
		fst_printf(MSG_DEBUG, "found by method #2. %s:" MACSTR,
			   fst_iface_get_name(other_iface),
			   MAC2STR(other_peer_addr));
		return other_iface;
	}

	fst_printf(MSG_INFO, "%s: other connection not found", __func__);
	return NULL;
}


struct fst_group * fst_group_create(const char *group_id)
{
	struct fst_group *g;

	g = os_zalloc(sizeof(*g));
	if (g == NULL) {
		fst_printf(MSG_ERROR, "%s: Cannot alloc group", group_id);
		return NULL;
	}

	dl_list_init(&g->ifaces);
	os_strlcpy(g->group_id, group_id, sizeof(g->group_id));

	dl_list_add_tail(&fst_global_groups_list, &g->global_groups_lentry);
	fst_printf_group(g, MSG_DEBUG, "instance created");

	foreach_fst_ctrl_call(on_group_created, g);

	return g;
}


void fst_group_attach_iface(struct fst_group *g, struct fst_iface *i)
{
	struct dl_list *list = &g->ifaces;
	struct fst_iface *f;

	/*
	 * Add new interface to the list.
	 * The list is sorted in descending order by priority to allow
	 * multiple MB IEs creation according to the spec (see 10.32 Multi-band
	 * operation, 10.32.1 General), as they should be ordered according to
	 * priorities.
	 */
	foreach_fst_group_iface(g, f) {
		if (fst_iface_get_priority(f) < fst_iface_get_priority(i))
			break;
		list = &f->group_lentry;
	}
	dl_list_add(list, &i->group_lentry);
}


void fst_group_detach_iface(struct fst_group *g, struct fst_iface *i)
{
	dl_list_del(&i->group_lentry);
}


void fst_group_delete(struct fst_group *group)
{
	struct fst_session *s;

	dl_list_del(&group->global_groups_lentry);
	WPA_ASSERT(dl_list_empty(&group->ifaces));
	foreach_fst_ctrl_call(on_group_deleted, group);
	fst_printf_group(group, MSG_DEBUG, "instance deleted");
	while ((s = fst_session_global_get_first_by_group(group)) != NULL)
		fst_session_delete(s);
	os_free(group);
}


Boolean fst_group_delete_if_empty(struct fst_group *group)
{
	Boolean is_empty = !fst_group_has_ifaces(group) &&
		!fst_session_global_get_first_by_group(group);

	if (is_empty)
		fst_group_delete(group);

	return is_empty;
}


void fst_group_update_ie(struct fst_group *g)
{
	struct fst_iface *i;

	foreach_fst_group_iface(g, i) {
		struct wpabuf *mbie = fst_group_create_mb_ie(g, i);

		if (!mbie)
			fst_printf_iface(i, MSG_WARNING, "cannot create MB IE");

		fst_iface_attach_mbie(i, mbie);
		fst_iface_set_ies(i, mbie);
		fst_printf_iface(i, MSG_DEBUG, "multi-band IE set to %p", mbie);
	}
}