ieee80211_hwmp.c revision 234886
1/*-
2 * Copyright (c) 2009 The FreeBSD Foundation
3 * All rights reserved.
4 *
5 * This software was developed by Rui Paulo under sponsorship from the
6 * FreeBSD Foundation.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29#include <sys/cdefs.h>
30#ifdef __FreeBSD__
31__FBSDID("$FreeBSD: head/sys/net80211/ieee80211_hwmp.c 234886 2012-05-01 16:08:46Z monthadar $");
32#endif
33
34/*
35 * IEEE 802.11s Hybrid Wireless Mesh Protocol, HWMP.
36 *
37 * Based on March 2009, D3.0 802.11s draft spec.
38 */
39#include "opt_inet.h"
40#include "opt_wlan.h"
41
42#include <sys/param.h>
43#include <sys/systm.h>
44#include <sys/mbuf.h>
45#include <sys/malloc.h>
46#include <sys/kernel.h>
47
48#include <sys/socket.h>
49#include <sys/sockio.h>
50#include <sys/endian.h>
51#include <sys/errno.h>
52#include <sys/proc.h>
53#include <sys/sysctl.h>
54
55#include <net/if.h>
56#include <net/if_media.h>
57#include <net/if_llc.h>
58#include <net/ethernet.h>
59
60#include <net/bpf.h>
61
62#include <net80211/ieee80211_var.h>
63#include <net80211/ieee80211_action.h>
64#include <net80211/ieee80211_input.h>
65#include <net80211/ieee80211_mesh.h>
66
67static void	hwmp_vattach(struct ieee80211vap *);
68static void	hwmp_vdetach(struct ieee80211vap *);
69static int	hwmp_newstate(struct ieee80211vap *,
70		    enum ieee80211_state, int);
71static int	hwmp_send_action(struct ieee80211_node *,
72		    const uint8_t [IEEE80211_ADDR_LEN],
73		    const uint8_t [IEEE80211_ADDR_LEN],
74		    uint8_t *, size_t);
75static uint8_t * hwmp_add_meshpreq(uint8_t *,
76		    const struct ieee80211_meshpreq_ie *);
77static uint8_t * hwmp_add_meshprep(uint8_t *,
78		    const struct ieee80211_meshprep_ie *);
79static uint8_t * hwmp_add_meshperr(uint8_t *,
80		    const struct ieee80211_meshperr_ie *);
81static uint8_t * hwmp_add_meshrann(uint8_t *,
82		    const struct ieee80211_meshrann_ie *);
83static void	hwmp_rootmode_setup(struct ieee80211vap *);
84static void	hwmp_rootmode_cb(void *);
85static void	hwmp_rootmode_rann_cb(void *);
86static void	hwmp_recv_preq(struct ieee80211vap *, struct ieee80211_node *,
87		    const struct ieee80211_frame *,
88		    const struct ieee80211_meshpreq_ie *);
89static int	hwmp_send_preq(struct ieee80211_node *,
90		    const uint8_t [IEEE80211_ADDR_LEN],
91		    const uint8_t [IEEE80211_ADDR_LEN],
92		    struct ieee80211_meshpreq_ie *,
93		    struct timeval *, struct timeval *);
94static void	hwmp_recv_prep(struct ieee80211vap *, struct ieee80211_node *,
95		    const struct ieee80211_frame *,
96		    const struct ieee80211_meshprep_ie *);
97static int	hwmp_send_prep(struct ieee80211_node *,
98		    const uint8_t [IEEE80211_ADDR_LEN],
99		    const uint8_t [IEEE80211_ADDR_LEN],
100		    struct ieee80211_meshprep_ie *);
101static void	hwmp_recv_perr(struct ieee80211vap *, struct ieee80211_node *,
102		    const struct ieee80211_frame *,
103		    const struct ieee80211_meshperr_ie *);
104static int	hwmp_send_perr(struct ieee80211_node *,
105		    const uint8_t [IEEE80211_ADDR_LEN],
106		    const uint8_t [IEEE80211_ADDR_LEN],
107		    struct ieee80211_meshperr_ie *);
108static void	hwmp_recv_rann(struct ieee80211vap *, struct ieee80211_node *,
109		   const struct ieee80211_frame *,
110		   const struct ieee80211_meshrann_ie *);
111static int	hwmp_send_rann(struct ieee80211_node *,
112		    const uint8_t [IEEE80211_ADDR_LEN],
113		    const uint8_t [IEEE80211_ADDR_LEN],
114		    struct ieee80211_meshrann_ie *);
115static struct ieee80211_node *
116		hwmp_discover(struct ieee80211vap *,
117		    const uint8_t [IEEE80211_ADDR_LEN], struct mbuf *);
118static void	hwmp_peerdown(struct ieee80211_node *);
119
120static struct timeval ieee80211_hwmp_preqminint = { 0, 100000 };
121static struct timeval ieee80211_hwmp_perrminint = { 0, 100000 };
122
123/* unalligned little endian access */
124#define LE_WRITE_2(p, v) do {				\
125	((uint8_t *)(p))[0] = (v) & 0xff;		\
126	((uint8_t *)(p))[1] = ((v) >> 8) & 0xff;	\
127} while (0)
128#define LE_WRITE_4(p, v) do {				\
129	((uint8_t *)(p))[0] = (v) & 0xff;		\
130	((uint8_t *)(p))[1] = ((v) >> 8) & 0xff;	\
131	((uint8_t *)(p))[2] = ((v) >> 16) & 0xff;	\
132	((uint8_t *)(p))[3] = ((v) >> 24) & 0xff;	\
133} while (0)
134
135
136/* NB: the Target Address set in a Proactive PREQ is the broadcast address. */
137static const uint8_t	broadcastaddr[IEEE80211_ADDR_LEN] =
138	{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
139
140typedef uint32_t ieee80211_hwmp_seq;
141#define	HWMP_SEQ_LT(a, b)	((int32_t)((a)-(b)) < 0)
142#define	HWMP_SEQ_LEQ(a, b)	((int32_t)((a)-(b)) <= 0)
143#define	HWMP_SEQ_EQ(a, b)	((int32_t)((a)-(b)) == 0)
144#define	HWMP_SEQ_GT(a, b)	((int32_t)((a)-(b)) > 0)
145#define	HWMP_SEQ_GEQ(a, b)	((int32_t)((a)-(b)) >= 0)
146
147#define HWMP_SEQ_MAX(a, b)	(a > b ? a : b)
148
149/*
150 * Private extension of ieee80211_mesh_route.
151 */
152struct ieee80211_hwmp_route {
153	ieee80211_hwmp_seq	hr_seq;		/* last HWMP seq seen from dst*/
154	ieee80211_hwmp_seq	hr_preqid;	/* last PREQ ID seen from dst */
155	ieee80211_hwmp_seq	hr_origseq;	/* seq. no. on our latest PREQ*/
156	struct timeval		hr_lastpreq;	/* last time we sent a PREQ */
157	int			hr_preqretries;	/* number of discoveries */
158	int			hr_lastdiscovery; /* last discovery in ticks */
159};
160struct ieee80211_hwmp_state {
161	ieee80211_hwmp_seq	hs_seq;		/* next seq to be used */
162	ieee80211_hwmp_seq	hs_preqid;	/* next PREQ ID to be used */
163	int			hs_rootmode;	/* proactive HWMP */
164	struct timeval		hs_lastperr;	/* last time we sent a PERR */
165	struct callout		hs_roottimer;
166	uint8_t			hs_maxhops;	/* max hop count */
167};
168
169static SYSCTL_NODE(_net_wlan, OID_AUTO, hwmp, CTLFLAG_RD, 0,
170    "IEEE 802.11s HWMP parameters");
171static int	ieee80211_hwmp_targetonly = 0;
172SYSCTL_INT(_net_wlan_hwmp, OID_AUTO, targetonly, CTLTYPE_INT | CTLFLAG_RW,
173    &ieee80211_hwmp_targetonly, 0, "Set TO bit on generated PREQs");
174static int	ieee80211_hwmp_pathtimeout = -1;
175SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, pathlifetime, CTLTYPE_INT | CTLFLAG_RW,
176    &ieee80211_hwmp_pathtimeout, 0, ieee80211_sysctl_msecs_ticks, "I",
177    "path entry lifetime (ms)");
178static int	ieee80211_hwmp_maxpreq_retries = -1;
179SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, maxpreq_retries, CTLTYPE_INT | CTLFLAG_RW,
180    &ieee80211_hwmp_maxpreq_retries, 0, ieee80211_sysctl_msecs_ticks, "I",
181    "maximum number of preq retries");
182static int	ieee80211_hwmp_net_diameter_traversaltime = -1;
183SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, net_diameter_traversal_time,
184    CTLTYPE_INT | CTLFLAG_RW, &ieee80211_hwmp_net_diameter_traversaltime, 0,
185    ieee80211_sysctl_msecs_ticks, "I",
186    "estimate travelse time across the MBSS (ms)");
187static int	ieee80211_hwmp_roottimeout = -1;
188SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, roottimeout, CTLTYPE_INT | CTLFLAG_RW,
189    &ieee80211_hwmp_roottimeout, 0, ieee80211_sysctl_msecs_ticks, "I",
190    "root PREQ timeout (ms)");
191static int	ieee80211_hwmp_rootint = -1;
192SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, rootint, CTLTYPE_INT | CTLFLAG_RW,
193    &ieee80211_hwmp_rootint, 0, ieee80211_sysctl_msecs_ticks, "I",
194    "root interval (ms)");
195static int	ieee80211_hwmp_rannint = -1;
196SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, rannint, CTLTYPE_INT | CTLFLAG_RW,
197    &ieee80211_hwmp_rannint, 0, ieee80211_sysctl_msecs_ticks, "I",
198    "root announcement interval (ms)");
199
200#define	IEEE80211_HWMP_DEFAULT_MAXHOPS	31
201
202static	ieee80211_recv_action_func hwmp_recv_action_meshpath;
203
204static struct ieee80211_mesh_proto_path mesh_proto_hwmp = {
205	.mpp_descr	= "HWMP",
206	.mpp_ie		= IEEE80211_MESHCONF_PATH_HWMP,
207	.mpp_discover	= hwmp_discover,
208	.mpp_peerdown	= hwmp_peerdown,
209	.mpp_vattach	= hwmp_vattach,
210	.mpp_vdetach	= hwmp_vdetach,
211	.mpp_newstate	= hwmp_newstate,
212	.mpp_privlen	= sizeof(struct ieee80211_hwmp_route),
213};
214SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, inact, CTLTYPE_INT | CTLFLAG_RW,
215	&mesh_proto_hwmp.mpp_inact, 0, ieee80211_sysctl_msecs_ticks, "I",
216	"mesh route inactivity timeout (ms)");
217
218
219static void
220ieee80211_hwmp_init(void)
221{
222	/* Default values as per amendment */
223	ieee80211_hwmp_pathtimeout = msecs_to_ticks(5*1000);
224	ieee80211_hwmp_roottimeout = msecs_to_ticks(5*1000);
225	ieee80211_hwmp_rootint = msecs_to_ticks(2*1000);
226	ieee80211_hwmp_rannint = msecs_to_ticks(1*1000);
227	ieee80211_hwmp_maxpreq_retries = 3;
228	/*
229	 * (TU): A measurement of time equal to 1024 ��s,
230	 * 500 TU is 512 ms.
231	 */
232	ieee80211_hwmp_net_diameter_traversaltime = msecs_to_ticks(512);
233
234	/*
235	 * Register action frame handler.
236	 */
237	ieee80211_recv_action_register(IEEE80211_ACTION_CAT_MESH,
238	    IEEE80211_ACTION_MESH_HWMP, hwmp_recv_action_meshpath);
239
240	/* NB: default is 5 secs per spec */
241	mesh_proto_hwmp.mpp_inact = msecs_to_ticks(5*1000);
242
243	/*
244	 * Register HWMP.
245	 */
246	ieee80211_mesh_register_proto_path(&mesh_proto_hwmp);
247}
248SYSINIT(wlan_hwmp, SI_SUB_DRIVERS, SI_ORDER_SECOND, ieee80211_hwmp_init, NULL);
249
250void
251hwmp_vattach(struct ieee80211vap *vap)
252{
253	struct ieee80211_hwmp_state *hs;
254
255	KASSERT(vap->iv_opmode == IEEE80211_M_MBSS,
256	    ("not a mesh vap, opmode %d", vap->iv_opmode));
257
258	hs = malloc(sizeof(struct ieee80211_hwmp_state), M_80211_VAP,
259	    M_NOWAIT | M_ZERO);
260	if (hs == NULL) {
261		printf("%s: couldn't alloc HWMP state\n", __func__);
262		return;
263	}
264	hs->hs_maxhops = IEEE80211_HWMP_DEFAULT_MAXHOPS;
265	callout_init(&hs->hs_roottimer, CALLOUT_MPSAFE);
266	vap->iv_hwmp = hs;
267}
268
269void
270hwmp_vdetach(struct ieee80211vap *vap)
271{
272	struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
273
274	callout_drain(&hs->hs_roottimer);
275	free(vap->iv_hwmp, M_80211_VAP);
276	vap->iv_hwmp = NULL;
277}
278
279int
280hwmp_newstate(struct ieee80211vap *vap, enum ieee80211_state ostate, int arg)
281{
282	enum ieee80211_state nstate = vap->iv_state;
283	struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
284
285	IEEE80211_DPRINTF(vap, IEEE80211_MSG_STATE, "%s: %s -> %s (%d)\n",
286	    __func__, ieee80211_state_name[ostate],
287	    ieee80211_state_name[nstate], arg);
288
289	if (nstate != IEEE80211_S_RUN && ostate == IEEE80211_S_RUN)
290		callout_drain(&hs->hs_roottimer);
291	if (nstate == IEEE80211_S_RUN)
292		hwmp_rootmode_setup(vap);
293	return 0;
294}
295
296/*
297 * Verify the length of an HWMP PREQ and return the number
298 * of destinations >= 1, if verification fails -1 is returned.
299 */
300static int
301verify_mesh_preq_len(struct ieee80211vap *vap,
302    const struct ieee80211_frame *wh, const uint8_t *iefrm)
303{
304	int alloc_sz = -1;
305	int ndest = -1;
306	if (iefrm[2] & IEEE80211_MESHPREQ_FLAGS_AE) {
307		/* Originator External Address  present */
308		alloc_sz =  IEEE80211_MESHPREQ_BASE_SZ_AE;
309		ndest = iefrm[IEEE80211_MESHPREQ_TCNT_OFFSET_AE];
310	} else {
311		/* w/o Originator External Address */
312		alloc_sz =  IEEE80211_MESHPREQ_BASE_SZ;
313		ndest = iefrm[IEEE80211_MESHPREQ_TCNT_OFFSET];
314	}
315	alloc_sz += ndest * IEEE80211_MESHPREQ_TRGT_SZ;
316
317	if(iefrm[1] != (alloc_sz)) {
318		IEEE80211_DISCARD(vap,
319		    IEEE80211_MSG_ACTION | IEEE80211_MSG_HWMP,
320		    wh, NULL, "PREQ (AE=%s) with wrong len",
321		    iefrm[2] & IEEE80211_MESHPREQ_FLAGS_AE ? "1" : "0");
322		return (-1);
323	}
324	return ndest;
325}
326
327/*
328 * Verify the length of an HWMP PREP and returns 1 on success,
329 * otherwise -1.
330 */
331static int
332verify_mesh_prep_len(struct ieee80211vap *vap,
333    const struct ieee80211_frame *wh, const uint8_t *iefrm)
334{
335	int alloc_sz = -1;
336	if (iefrm[2] & IEEE80211_MESHPREP_FLAGS_AE) {
337		if (iefrm[1] == IEEE80211_MESHPREP_BASE_SZ_AE)
338			alloc_sz = IEEE80211_MESHPREP_BASE_SZ_AE;
339	} else if (iefrm[1] == IEEE80211_MESHPREP_BASE_SZ)
340		alloc_sz = IEEE80211_MESHPREP_BASE_SZ;
341	if(alloc_sz < 0) {
342		IEEE80211_DISCARD(vap,
343		    IEEE80211_MSG_ACTION | IEEE80211_MSG_HWMP,
344		    wh, NULL, "PREP (AE=%s) with wrong len",
345		    iefrm[2] & IEEE80211_MESHPREP_FLAGS_AE ? "1" : "0");
346		return (-1);
347	}
348	return (1);
349}
350
351/*
352 * Verify the length of an HWMP PERR and return the number
353 * of destinations >= 1, if verification fails -1 is returned.
354 */
355static int
356verify_mesh_perr_len(struct ieee80211vap *vap,
357    const struct ieee80211_frame *wh, const uint8_t *iefrm)
358{
359	int alloc_sz = -1;
360	const uint8_t *iefrm_t = iefrm;
361	uint8_t ndest = iefrm_t[IEEE80211_MESHPERR_NDEST_OFFSET];
362	int i;
363
364	if(ndest > IEEE80211_MESHPERR_MAXDEST) {
365		IEEE80211_DISCARD(vap,
366		    IEEE80211_MSG_ACTION | IEEE80211_MSG_HWMP,
367		    wh, NULL, "PERR with wrong number of destionat (>19), %u",
368		    ndest);
369		return (-1);
370	}
371
372	iefrm_t += IEEE80211_MESHPERR_NDEST_OFFSET + 1; /* flag is next field */
373	/* We need to check each destionation flag to know size */
374	for(i = 0; i<ndest; i++) {
375		if ((*iefrm_t) & IEEE80211_MESHPERR_FLAGS_AE)
376			iefrm_t += IEEE80211_MESHPERR_DEST_SZ_AE;
377		else
378			iefrm_t += IEEE80211_MESHPERR_DEST_SZ;
379	}
380
381	alloc_sz = (iefrm_t - iefrm) - 2; /* action + code */
382	if(alloc_sz !=  iefrm[1]) {
383		IEEE80211_DISCARD(vap,
384		    IEEE80211_MSG_ACTION | IEEE80211_MSG_HWMP,
385		    wh, NULL, "%s", "PERR with wrong len");
386		return (-1);
387	}
388	return ndest;
389}
390
391static int
392hwmp_recv_action_meshpath(struct ieee80211_node *ni,
393	const struct ieee80211_frame *wh,
394	const uint8_t *frm, const uint8_t *efrm)
395{
396	struct ieee80211vap *vap = ni->ni_vap;
397	struct ieee80211_meshpreq_ie *preq;
398	struct ieee80211_meshprep_ie *prep;
399	struct ieee80211_meshperr_ie *perr;
400	struct ieee80211_meshrann_ie rann;
401	const uint8_t *iefrm = frm + 2; /* action + code */
402	const uint8_t *iefrm_t = iefrm; /* temporary pointer */
403	int ndest = -1;
404	int found = 0;
405
406	while (efrm - iefrm > 1) {
407		IEEE80211_VERIFY_LENGTH(efrm - iefrm, iefrm[1] + 2, return 0);
408		switch (*iefrm) {
409		case IEEE80211_ELEMID_MESHPREQ:
410		{
411			int i = 0;
412
413			iefrm_t = iefrm;
414			ndest = verify_mesh_preq_len(vap, wh, iefrm_t);
415			if (ndest < 0) {
416				vap->iv_stats.is_rx_mgtdiscard++;
417				break;
418			}
419			preq = malloc(sizeof(*preq) +
420			    (ndest - 1) * sizeof(*preq->preq_targets),
421			    M_80211_MESH_PREQ, M_NOWAIT | M_ZERO);
422			KASSERT(preq != NULL, ("preq == NULL"));
423
424			preq->preq_ie = *iefrm_t++;
425			preq->preq_len = *iefrm_t++;
426			preq->preq_flags = *iefrm_t++;
427			preq->preq_hopcount = *iefrm_t++;
428			preq->preq_ttl = *iefrm_t++;
429			preq->preq_id = LE_READ_4(iefrm_t); iefrm_t += 4;
430			IEEE80211_ADDR_COPY(preq->preq_origaddr, iefrm_t);
431			iefrm_t += 6;
432			preq->preq_origseq = LE_READ_4(iefrm_t); iefrm_t += 4;
433			/* NB: may have Originator Proxied Address */
434			if (preq->preq_flags & IEEE80211_MESHPREQ_FLAGS_AE)  {
435				IEEE80211_ADDR_COPY(
436				    preq->preq_orig_ext_addr, iefrm_t);
437				iefrm_t += 6;
438			}
439			preq->preq_lifetime = LE_READ_4(iefrm_t); iefrm_t += 4;
440			preq->preq_metric = LE_READ_4(iefrm_t); iefrm_t += 4;
441			preq->preq_tcount = *iefrm_t++;
442
443			for (i = 0; i < preq->preq_tcount; i++) {
444				preq->preq_targets[i].target_flags = *iefrm_t++;
445				IEEE80211_ADDR_COPY(
446				    preq->preq_targets[i].target_addr, iefrm_t);
447				iefrm_t += 6;
448				preq->preq_targets[i].target_seq =
449				    LE_READ_4(iefrm_t);
450				iefrm_t += 4;
451			}
452
453			hwmp_recv_preq(vap, ni, wh, preq);
454			free(preq, M_80211_MESH_PREQ);
455			found++;
456			break;
457		}
458		case IEEE80211_ELEMID_MESHPREP:
459		{
460			iefrm_t = iefrm;
461			ndest = verify_mesh_prep_len(vap, wh, iefrm_t);
462			if (ndest < 0) {
463				vap->iv_stats.is_rx_mgtdiscard++;
464				break;
465			}
466			prep = malloc(sizeof(*prep),
467			    M_80211_MESH_PREP, M_NOWAIT | M_ZERO);
468			KASSERT(prep != NULL, ("prep == NULL"));
469
470			prep->prep_ie = *iefrm_t++;
471			prep->prep_len = *iefrm_t++;
472			prep->prep_flags = *iefrm_t++;
473			prep->prep_hopcount = *iefrm_t++;
474			prep->prep_ttl = *iefrm_t++;
475			IEEE80211_ADDR_COPY(prep->prep_targetaddr, iefrm_t);
476			iefrm_t += 6;
477			prep->prep_targetseq = LE_READ_4(iefrm_t); iefrm_t += 4;
478			/* NB: May have Target Proxied Address */
479			if (prep->prep_flags & IEEE80211_MESHPREP_FLAGS_AE)  {
480				IEEE80211_ADDR_COPY(
481				    prep->prep_target_ext_addr, iefrm_t);
482				iefrm_t += 6;
483			}
484			prep->prep_lifetime = LE_READ_4(iefrm_t); iefrm_t += 4;
485			prep->prep_metric = LE_READ_4(iefrm_t); iefrm_t += 4;
486			IEEE80211_ADDR_COPY(prep->prep_origaddr, iefrm_t);
487			iefrm_t += 6;
488			prep->prep_origseq = LE_READ_4(iefrm_t); iefrm_t += 4;
489
490			hwmp_recv_prep(vap, ni, wh, prep);
491			free(prep, M_80211_MESH_PREP);
492			found++;
493			break;
494		}
495		case IEEE80211_ELEMID_MESHPERR:
496		{
497			int i = 0;
498
499			iefrm_t = iefrm;
500			ndest = verify_mesh_perr_len(vap, wh, iefrm_t);
501			if (ndest < 0) {
502				vap->iv_stats.is_rx_mgtdiscard++;
503				break;
504			}
505			perr = malloc(sizeof(*perr) +
506			    (ndest - 1) * sizeof(*perr->perr_dests),
507			    M_80211_MESH_PERR, M_NOWAIT | M_ZERO);
508			KASSERT(perr != NULL, ("perr == NULL"));
509
510			perr->perr_ie = *iefrm_t++;
511			perr->perr_len = *iefrm_t++;
512			perr->perr_ttl = *iefrm_t++;
513			perr->perr_ndests = *iefrm_t++;
514
515			for (i = 0; i<perr->perr_ndests; i++) {
516				perr->perr_dests[i].dest_flags = *iefrm_t++;
517				IEEE80211_ADDR_COPY(
518				    perr->perr_dests[i].dest_addr, iefrm_t);
519				iefrm_t += 6;
520				perr->perr_dests[i].dest_seq = LE_READ_4(iefrm_t);
521				iefrm_t += 4;
522				/* NB: May have Target Proxied Address */
523				if (perr->perr_dests[i].dest_flags &
524				    IEEE80211_MESHPERR_FLAGS_AE) {
525					IEEE80211_ADDR_COPY(
526					    perr->perr_dests[i].dest_ext_addr,
527					    iefrm_t);
528					iefrm_t += 6;
529				}
530				perr->perr_dests[i].dest_rcode =
531				    LE_READ_2(iefrm_t);
532				iefrm_t += 2;
533			}
534
535			hwmp_recv_perr(vap, ni, wh, perr);
536			free(perr, M_80211_MESH_PERR);
537			found++;
538			break;
539		}
540		case IEEE80211_ELEMID_MESHRANN:
541		{
542			const struct ieee80211_meshrann_ie *mrann =
543			    (const struct ieee80211_meshrann_ie *) iefrm;
544			if (mrann->rann_len !=
545			    sizeof(struct ieee80211_meshrann_ie) - 2) {
546				IEEE80211_DISCARD(vap,
547				    IEEE80211_MSG_ACTION | IEEE80211_MSG_HWMP,
548				    wh, NULL, "%s", "RAN with wrong len");
549				    vap->iv_stats.is_rx_mgtdiscard++;
550				return 1;
551			}
552			memcpy(&rann, mrann, sizeof(rann));
553			rann.rann_seq = LE_READ_4(&mrann->rann_seq);
554			rann.rann_metric = LE_READ_4(&mrann->rann_metric);
555			hwmp_recv_rann(vap, ni, wh, &rann);
556			found++;
557			break;
558		}
559		}
560		iefrm += iefrm[1] + 2;
561	}
562	if (!found) {
563		IEEE80211_DISCARD(vap,
564		    IEEE80211_MSG_ACTION | IEEE80211_MSG_HWMP,
565		    wh, NULL, "%s", "PATH SEL action without IE");
566		vap->iv_stats.is_rx_mgtdiscard++;
567	}
568	return 0;
569}
570
571static int
572hwmp_send_action(struct ieee80211_node *ni,
573    const uint8_t sa[IEEE80211_ADDR_LEN],
574    const uint8_t da[IEEE80211_ADDR_LEN],
575    uint8_t *ie, size_t len)
576{
577	struct ieee80211vap *vap = ni->ni_vap;
578	struct ieee80211com *ic = ni->ni_ic;
579	struct ieee80211_bpf_params params;
580	struct mbuf *m;
581	uint8_t *frm;
582
583	if (vap->iv_state == IEEE80211_S_CAC) {
584		IEEE80211_NOTE(vap, IEEE80211_MSG_OUTPUT, ni,
585		    "block %s frame in CAC state", "HWMP action");
586		vap->iv_stats.is_tx_badstate++;
587		return EIO;	/* XXX */
588	}
589
590	KASSERT(ni != NULL, ("null node"));
591	/*
592	 * Hold a reference on the node so it doesn't go away until after
593	 * the xmit is complete all the way in the driver.  On error we
594	 * will remove our reference.
595	 */
596#ifdef IEEE80211_DEBUG_REFCNT
597	IEEE80211_DPRINTF(vap, IEEE80211_MSG_NODE,
598	    "ieee80211_ref_node (%s:%u) %p<%s> refcnt %d\n",
599	    __func__, __LINE__,
600	    ni, ether_sprintf(ni->ni_macaddr),
601	    ieee80211_node_refcnt(ni)+1);
602#endif
603	ieee80211_ref_node(ni);
604
605	m = ieee80211_getmgtframe(&frm,
606	    ic->ic_headroom + sizeof(struct ieee80211_frame),
607	    sizeof(struct ieee80211_action) + len
608	);
609	if (m == NULL) {
610		ieee80211_free_node(ni);
611		vap->iv_stats.is_tx_nobuf++;
612		return ENOMEM;
613	}
614	*frm++ = IEEE80211_ACTION_CAT_MESH;
615	*frm++ = IEEE80211_ACTION_MESH_HWMP;
616	switch (*ie) {
617	case IEEE80211_ELEMID_MESHPREQ:
618		frm = hwmp_add_meshpreq(frm,
619		    (struct ieee80211_meshpreq_ie *)ie);
620		break;
621	case IEEE80211_ELEMID_MESHPREP:
622		frm = hwmp_add_meshprep(frm,
623		    (struct ieee80211_meshprep_ie *)ie);
624		break;
625	case IEEE80211_ELEMID_MESHPERR:
626		frm = hwmp_add_meshperr(frm,
627		    (struct ieee80211_meshperr_ie *)ie);
628		break;
629	case IEEE80211_ELEMID_MESHRANN:
630		frm = hwmp_add_meshrann(frm,
631		    (struct ieee80211_meshrann_ie *)ie);
632		break;
633	}
634
635	m->m_pkthdr.len = m->m_len = frm - mtod(m, uint8_t *);
636	M_PREPEND(m, sizeof(struct ieee80211_frame), M_DONTWAIT);
637	if (m == NULL) {
638		ieee80211_free_node(ni);
639		vap->iv_stats.is_tx_nobuf++;
640		return ENOMEM;
641	}
642	ieee80211_send_setup(ni, m,
643	    IEEE80211_FC0_TYPE_MGT | IEEE80211_FC0_SUBTYPE_ACTION,
644	    IEEE80211_NONQOS_TID, sa, da, sa);
645
646	m->m_flags |= M_ENCAP;		/* mark encapsulated */
647	IEEE80211_NODE_STAT(ni, tx_mgmt);
648
649	memset(&params, 0, sizeof(params));
650	params.ibp_pri = WME_AC_VO;
651	params.ibp_rate0 = ni->ni_txparms->mgmtrate;
652	if (IEEE80211_IS_MULTICAST(da))
653		params.ibp_try0 = 1;
654	else
655		params.ibp_try0 = ni->ni_txparms->maxretry;
656	params.ibp_power = ni->ni_txpower;
657	return ic->ic_raw_xmit(ni, m, &params);
658}
659
660#define ADDSHORT(frm, v) do {		\
661	frm[0] = (v) & 0xff;		\
662	frm[1] = (v) >> 8;		\
663	frm += 2;			\
664} while (0)
665#define ADDWORD(frm, v) do {		\
666	LE_WRITE_4(frm, v);		\
667	frm += 4;			\
668} while (0)
669/*
670 * Add a Mesh Path Request IE to a frame.
671 */
672#define	PREQ_TFLAGS(n)	preq->preq_targets[n].target_flags
673#define	PREQ_TADDR(n)	preq->preq_targets[n].target_addr
674#define	PREQ_TSEQ(n)	preq->preq_targets[n].target_seq
675static uint8_t *
676hwmp_add_meshpreq(uint8_t *frm, const struct ieee80211_meshpreq_ie *preq)
677{
678	int i;
679
680	*frm++ = IEEE80211_ELEMID_MESHPREQ;
681	*frm++ = preq->preq_len;	/* len already calculated */
682	*frm++ = preq->preq_flags;
683	*frm++ = preq->preq_hopcount;
684	*frm++ = preq->preq_ttl;
685	ADDWORD(frm, preq->preq_id);
686	IEEE80211_ADDR_COPY(frm, preq->preq_origaddr); frm += 6;
687	ADDWORD(frm, preq->preq_origseq);
688	if (preq->preq_flags & IEEE80211_MESHPREQ_FLAGS_AE) {
689		IEEE80211_ADDR_COPY(frm, preq->preq_orig_ext_addr);
690		frm += 6;
691	}
692	ADDWORD(frm, preq->preq_lifetime);
693	ADDWORD(frm, preq->preq_metric);
694	*frm++ = preq->preq_tcount;
695	for (i = 0; i < preq->preq_tcount; i++) {
696		*frm++ = PREQ_TFLAGS(i);
697		IEEE80211_ADDR_COPY(frm, PREQ_TADDR(i));
698		frm += 6;
699		ADDWORD(frm, PREQ_TSEQ(i));
700	}
701	return frm;
702}
703#undef	PREQ_TFLAGS
704#undef	PREQ_TADDR
705#undef	PREQ_TSEQ
706
707/*
708 * Add a Mesh Path Reply IE to a frame.
709 */
710static uint8_t *
711hwmp_add_meshprep(uint8_t *frm, const struct ieee80211_meshprep_ie *prep)
712{
713	*frm++ = IEEE80211_ELEMID_MESHPREP;
714	*frm++ = prep->prep_len;	/* len already calculated */
715	*frm++ = prep->prep_flags;
716	*frm++ = prep->prep_hopcount;
717	*frm++ = prep->prep_ttl;
718	IEEE80211_ADDR_COPY(frm, prep->prep_targetaddr); frm += 6;
719	ADDWORD(frm, prep->prep_targetseq);
720	if (prep->prep_flags & IEEE80211_MESHPREP_FLAGS_AE) {
721		IEEE80211_ADDR_COPY(frm, prep->prep_target_ext_addr);
722		frm += 6;
723	}
724	ADDWORD(frm, prep->prep_lifetime);
725	ADDWORD(frm, prep->prep_metric);
726	IEEE80211_ADDR_COPY(frm, prep->prep_origaddr); frm += 6;
727	ADDWORD(frm, prep->prep_origseq);
728	return frm;
729}
730
731/*
732 * Add a Mesh Path Error IE to a frame.
733 */
734#define	PERR_DFLAGS(n)	perr->perr_dests[n].dest_flags
735#define	PERR_DADDR(n)	perr->perr_dests[n].dest_addr
736#define	PERR_DSEQ(n)	perr->perr_dests[n].dest_seq
737#define	PERR_EXTADDR(n)	perr->perr_dests[n].dest_ext_addr
738#define	PERR_DRCODE(n)	perr->perr_dests[n].dest_rcode
739static uint8_t *
740hwmp_add_meshperr(uint8_t *frm, const struct ieee80211_meshperr_ie *perr)
741{
742	int i;
743
744	*frm++ = IEEE80211_ELEMID_MESHPERR;
745	*frm++ = perr->perr_len;	/* len already calculated */
746	*frm++ = perr->perr_ttl;
747	*frm++ = perr->perr_ndests;
748	for (i = 0; i < perr->perr_ndests; i++) {
749		*frm++ = PERR_DFLAGS(i);
750		IEEE80211_ADDR_COPY(frm, PERR_DADDR(i));
751		frm += 6;
752		ADDWORD(frm, PERR_DSEQ(i));
753		if (PERR_DFLAGS(i) & IEEE80211_MESHPERR_FLAGS_AE) {
754			IEEE80211_ADDR_COPY(frm, PERR_EXTADDR(i));
755			frm += 6;
756		}
757		ADDSHORT(frm, PERR_DRCODE(i));
758	}
759	return frm;
760}
761#undef	PERR_DFLAGS
762#undef	PERR_DADDR
763#undef	PERR_DSEQ
764#undef	PERR_EXTADDR
765#undef	PERR_DRCODE
766
767/*
768 * Add a Root Annoucement IE to a frame.
769 */
770static uint8_t *
771hwmp_add_meshrann(uint8_t *frm, const struct ieee80211_meshrann_ie *rann)
772{
773	*frm++ = IEEE80211_ELEMID_MESHRANN;
774	*frm++ = rann->rann_len;
775	*frm++ = rann->rann_flags;
776	*frm++ = rann->rann_hopcount;
777	*frm++ = rann->rann_ttl;
778	IEEE80211_ADDR_COPY(frm, rann->rann_addr); frm += 6;
779	ADDWORD(frm, rann->rann_seq);
780	ADDWORD(frm, rann->rann_interval);
781	ADDWORD(frm, rann->rann_metric);
782	return frm;
783}
784
785static void
786hwmp_rootmode_setup(struct ieee80211vap *vap)
787{
788	struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
789
790	switch (hs->hs_rootmode) {
791	case IEEE80211_HWMP_ROOTMODE_DISABLED:
792		callout_drain(&hs->hs_roottimer);
793		break;
794	case IEEE80211_HWMP_ROOTMODE_NORMAL:
795	case IEEE80211_HWMP_ROOTMODE_PROACTIVE:
796		callout_reset(&hs->hs_roottimer, ieee80211_hwmp_rootint,
797		    hwmp_rootmode_cb, vap);
798		break;
799	case IEEE80211_HWMP_ROOTMODE_RANN:
800		callout_reset(&hs->hs_roottimer, ieee80211_hwmp_rannint,
801		    hwmp_rootmode_rann_cb, vap);
802		break;
803	}
804}
805
806/*
807 * Send a broadcast Path Request to find all nodes on the mesh. We are
808 * called when the vap is configured as a HWMP root node.
809 */
810#define	PREQ_TFLAGS(n)	preq.preq_targets[n].target_flags
811#define	PREQ_TADDR(n)	preq.preq_targets[n].target_addr
812#define	PREQ_TSEQ(n)	preq.preq_targets[n].target_seq
813static void
814hwmp_rootmode_cb(void *arg)
815{
816	struct ieee80211vap *vap = (struct ieee80211vap *)arg;
817	struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
818	struct ieee80211_mesh_state *ms = vap->iv_mesh;
819	struct ieee80211_meshpreq_ie preq;
820
821	IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, vap->iv_bss,
822	    "%s", "send broadcast PREQ");
823
824	preq.preq_flags = 0;
825	if (ms->ms_flags & IEEE80211_MESHFLAGS_PORTAL)
826		preq.preq_flags |= IEEE80211_MESHPREQ_FLAGS_PR;
827	if (hs->hs_rootmode == IEEE80211_HWMP_ROOTMODE_PROACTIVE)
828		preq.preq_flags |= IEEE80211_MESHPREQ_FLAGS_PP;
829	preq.preq_hopcount = 0;
830	preq.preq_ttl = ms->ms_ttl;
831	preq.preq_id = ++hs->hs_preqid;
832	IEEE80211_ADDR_COPY(preq.preq_origaddr, vap->iv_myaddr);
833	preq.preq_origseq = ++hs->hs_seq;
834	preq.preq_lifetime = ticks_to_msecs(ieee80211_hwmp_roottimeout);
835	preq.preq_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
836	preq.preq_tcount = 1;
837	IEEE80211_ADDR_COPY(PREQ_TADDR(0), broadcastaddr);
838	PREQ_TFLAGS(0) = IEEE80211_MESHPREQ_TFLAGS_TO |
839	    IEEE80211_MESHPREQ_TFLAGS_USN;
840	PREQ_TSEQ(0) = 0;
841	vap->iv_stats.is_hwmp_rootreqs++;
842	hwmp_send_preq(vap->iv_bss, vap->iv_myaddr, broadcastaddr, &preq,
843	    NULL, NULL);	/* NB: we enforce rate check ourself */
844	hwmp_rootmode_setup(vap);
845}
846#undef	PREQ_TFLAGS
847#undef	PREQ_TADDR
848#undef	PREQ_TSEQ
849
850/*
851 * Send a Root Annoucement (RANN) to find all the nodes on the mesh. We are
852 * called when the vap is configured as a HWMP RANN root node.
853 */
854static void
855hwmp_rootmode_rann_cb(void *arg)
856{
857	struct ieee80211vap *vap = (struct ieee80211vap *)arg;
858	struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
859	struct ieee80211_mesh_state *ms = vap->iv_mesh;
860	struct ieee80211_meshrann_ie rann;
861
862	IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, vap->iv_bss,
863	    "%s", "send broadcast RANN");
864
865	rann.rann_flags = 0;
866	if (ms->ms_flags & IEEE80211_MESHFLAGS_PORTAL)
867		rann.rann_flags |= IEEE80211_MESHRANN_FLAGS_PR;
868	rann.rann_hopcount = 0;
869	rann.rann_ttl = ms->ms_ttl;
870	IEEE80211_ADDR_COPY(rann.rann_addr, vap->iv_myaddr);
871	rann.rann_seq = ++hs->hs_seq;
872	rann.rann_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
873
874	vap->iv_stats.is_hwmp_rootrann++;
875	hwmp_send_rann(vap->iv_bss, vap->iv_myaddr, broadcastaddr, &rann);
876	hwmp_rootmode_setup(vap);
877}
878
879#define	PREQ_TFLAGS(n)	preq->preq_targets[n].target_flags
880#define	PREQ_TADDR(n)	preq->preq_targets[n].target_addr
881#define	PREQ_TSEQ(n)	preq->preq_targets[n].target_seq
882static void
883hwmp_recv_preq(struct ieee80211vap *vap, struct ieee80211_node *ni,
884    const struct ieee80211_frame *wh, const struct ieee80211_meshpreq_ie *preq)
885{
886	struct ieee80211_mesh_state *ms = vap->iv_mesh;
887	struct ieee80211_mesh_route *rt = NULL; /* pro-active code */
888	struct ieee80211_mesh_route *rtorig = NULL;
889	struct ieee80211_mesh_route *rttarg = NULL;
890	struct ieee80211_hwmp_route *hrorig = NULL;
891	struct ieee80211_hwmp_route *hrtarg = NULL;
892	struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
893	struct ieee80211_meshprep_ie prep;
894
895	if (ni == vap->iv_bss ||
896	    ni->ni_mlstate != IEEE80211_NODE_MESH_ESTABLISHED)
897		return;
898	/*
899	 * Ignore PREQs from us. Could happen because someone forward it
900	 * back to us.
901	 */
902	if (IEEE80211_ADDR_EQ(vap->iv_myaddr, preq->preq_origaddr))
903		return;
904
905	IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
906	    "received PREQ, orig %6D, targ(0) %6D", preq->preq_origaddr, ":",
907	    PREQ_TADDR(0), ":");
908
909	/*
910	 * Acceptance criteria: if the PREQ is not for us or not broadcast
911	 * AND forwarding is disabled, discard this PREQ.
912	 * XXX: need to check PROXY
913	 */
914	if ((!IEEE80211_ADDR_EQ(vap->iv_myaddr, PREQ_TADDR(0)) ||
915	    !IEEE80211_IS_MULTICAST(PREQ_TADDR(0))) &&
916	    !(ms->ms_flags & IEEE80211_MESHFLAGS_FWD)) {
917		IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_HWMP,
918		    preq->preq_origaddr, NULL, "%s", "not accepting PREQ");
919		return;
920	}
921	/*
922	 * Acceptance criteria: if unicast addressed
923	 * AND no valid forwarding for Target of PREQ, discard this PREQ.
924	 */
925	rttarg = ieee80211_mesh_rt_find(vap, PREQ_TADDR(0));
926	if(rttarg != NULL)
927		hrtarg = IEEE80211_MESH_ROUTE_PRIV(rttarg,
928		    struct ieee80211_hwmp_route);
929	/* Address mode: ucast */
930	if((preq->preq_flags & IEEE80211_MESHPREQ_FLAGS_AM) == 0 &&
931	    rttarg == NULL &&
932	    !IEEE80211_ADDR_EQ(vap->iv_myaddr, PREQ_TADDR(0))) {
933		IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_HWMP,
934		    preq->preq_origaddr, NULL,
935		    "unicast addressed PREQ of unknown target %6D",
936		    PREQ_TADDR(0), ":");
937		return;
938	}
939
940	/* PREQ ACCEPTED */
941
942	rtorig = ieee80211_mesh_rt_find(vap, preq->preq_origaddr);
943	if (rtorig == NULL) {
944		rtorig = ieee80211_mesh_rt_add(vap, preq->preq_origaddr);
945		IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
946		    "adding originator %6D", preq->preq_origaddr, ":");
947	}
948	if (rtorig == NULL) {
949		/* XXX stat */
950		return;
951	}
952	hrorig = IEEE80211_MESH_ROUTE_PRIV(rtorig, struct ieee80211_hwmp_route);
953
954	/* Data creation and update of forwarding information
955	 * according to Table 11C-8 for originator mesh STA.
956	 */
957	if (HWMP_SEQ_GT(preq->preq_origseq, hrorig->hr_seq) ||
958	    (HWMP_SEQ_EQ(preq->preq_origseq, hrorig->hr_seq) &&
959	    preq->preq_metric < rtorig->rt_metric)) {
960		hrorig->hr_seq = preq->preq_origseq;
961		IEEE80211_ADDR_COPY(rtorig->rt_nexthop, wh->i_addr2);
962		rtorig->rt_metric = preq->preq_metric +
963			ms->ms_pmetric->mpm_metric(ni);
964		rtorig->rt_nhops  = preq->preq_hopcount + 1;
965		ieee80211_mesh_rt_update(rtorig, preq->preq_lifetime);
966		/* path to orig is valid now */
967		rtorig->rt_flags |= IEEE80211_MESHRT_FLAGS_VALID;
968	}else if(hrtarg != NULL &&
969		HWMP_SEQ_EQ(hrtarg->hr_seq, PREQ_TSEQ(0)) &&
970		(rtorig->rt_flags & IEEE80211_MESHRT_FLAGS_VALID) == 0) {
971		IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
972		    "discard PREQ from %6D, old seq no %u <= %u",
973		    preq->preq_origaddr, ":",
974		    preq->preq_origseq, hrorig->hr_seq);
975		return;
976	}
977
978	/*
979	 * Forwarding information for transmitter mesh STA
980	 * [OPTIONAL: if metric improved]
981	 */
982
983	/*
984	 * Check if the PREQ is addressed to us.
985	 * or a Proxy currently supplied by us.
986	 */
987	if (IEEE80211_ADDR_EQ(vap->iv_myaddr, PREQ_TADDR(0)) ||
988	    (rttarg != NULL &&
989	    rttarg->rt_flags & IEEE80211_MESHRT_FLAGS_PROXY &&
990	    rttarg->rt_flags & IEEE80211_MESHRT_FLAGS_VALID)) {
991		/*
992		 * When we are the target we shall update our own HWMP seq
993		 * number with max of (current and preq->seq) + 1
994		 */
995		hs->hs_seq = HWMP_SEQ_MAX(hs->hs_seq, PREQ_TSEQ(0)) + 1;
996
997		prep.prep_flags = 0;
998		if (rttarg != NULL && /* if NULL it means we are the target */
999		    rttarg->rt_flags & IEEE80211_MESHRT_FLAGS_PROXY) {
1000			IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1001			    "reply for proxy %6D", rttarg->rt_dest, ":");
1002			prep.prep_flags |= IEEE80211_MESHPREP_FLAGS_AE;
1003			IEEE80211_ADDR_COPY(prep.prep_target_ext_addr,
1004			    rttarg->rt_dest);
1005			/* update proxy seqno to HWMP seqno */
1006			rttarg->rt_ext_seq = hs->hs_seq;
1007		}
1008		/*
1009		 * Build and send a PREP frame.
1010		 */
1011		prep.prep_hopcount = 0;
1012		prep.prep_ttl = ms->ms_ttl;
1013		IEEE80211_ADDR_COPY(prep.prep_targetaddr, vap->iv_myaddr);
1014		prep.prep_targetseq = hs->hs_seq;
1015		prep.prep_lifetime = preq->preq_lifetime;
1016		prep.prep_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
1017		IEEE80211_ADDR_COPY(prep.prep_origaddr, preq->preq_origaddr);
1018		prep.prep_origseq = preq->preq_origseq;
1019
1020		IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1021		    "reply to %6D", preq->preq_origaddr, ":");
1022		hwmp_send_prep(ni, vap->iv_myaddr, wh->i_addr2, &prep);
1023		return;
1024	}
1025	/*
1026	 * Proactive PREQ: reply with a proactive PREP to the
1027	 * root STA if requested.
1028	 */
1029	if (IEEE80211_ADDR_EQ(PREQ_TADDR(0), broadcastaddr) &&
1030	    (PREQ_TFLAGS(0) & IEEE80211_MESHPREQ_TFLAGS_TO)) {
1031		uint8_t rootmac[IEEE80211_ADDR_LEN];
1032
1033		IEEE80211_ADDR_COPY(rootmac, preq->preq_origaddr);
1034		rt = ieee80211_mesh_rt_find(vap, rootmac);
1035		if (rt == NULL) {
1036			rt = ieee80211_mesh_rt_add(vap, rootmac);
1037			if (rt == NULL) {
1038				IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1039				    "unable to add root mesh path to %6D",
1040				    rootmac, ":");
1041				vap->iv_stats.is_mesh_rtaddfailed++;
1042				return;
1043			}
1044		}
1045		IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1046		    "root mesh station @ %6D", rootmac, ":");
1047
1048		/*
1049		 * Reply with a PREP if we don't have a path to the root
1050		 * or if the root sent us a proactive PREQ.
1051		 */
1052		if ((rt->rt_flags & IEEE80211_MESHRT_FLAGS_VALID) == 0 ||
1053		    (preq->preq_flags & IEEE80211_MESHPREQ_FLAGS_PP)) {
1054			prep.prep_flags = 0;
1055			prep.prep_hopcount = 0;
1056			prep.prep_ttl = ms->ms_ttl;
1057			IEEE80211_ADDR_COPY(prep.prep_origaddr, rootmac);
1058			prep.prep_origseq = preq->preq_origseq;
1059			prep.prep_lifetime = preq->preq_lifetime;
1060			prep.prep_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
1061			IEEE80211_ADDR_COPY(prep.prep_targetaddr,
1062			    vap->iv_myaddr);
1063			prep.prep_targetseq = ++hs->hs_seq;
1064			hwmp_send_prep(vap->iv_bss, vap->iv_myaddr,
1065			    broadcastaddr, &prep);
1066		}
1067		hwmp_discover(vap, rootmac, NULL);
1068		return;
1069	}
1070
1071	/*
1072	 * Forwarding and Intermediate reply for PREQs with 1 target.
1073	 */
1074	if (preq->preq_tcount == 1) {
1075		struct ieee80211_meshpreq_ie ppreq; /* propagated PREQ */
1076
1077		memcpy(&ppreq, preq, sizeof(ppreq));
1078		/*
1079		 * We have a valid route to this node.
1080		 */
1081		if (rttarg != NULL &&
1082		    (rttarg->rt_flags & IEEE80211_MESHRT_FLAGS_VALID)) {
1083			if (preq->preq_ttl > 1 &&
1084			    preq->preq_hopcount < hs->hs_maxhops) {
1085				IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1086				    "forward PREQ from %6D",
1087				    preq->preq_origaddr, ":");
1088				/*
1089				 * Propagate the original PREQ.
1090				 * PREQ is unicast now to rttarg->rt_nexthop
1091				 */
1092				ppreq.preq_flags |=
1093				    IEEE80211_MESHPREQ_FLAGS_AM;
1094				ppreq.preq_hopcount += 1;
1095				ppreq.preq_ttl -= 1;
1096				ppreq.preq_metric +=
1097				    ms->ms_pmetric->mpm_metric(ni);
1098				/*
1099				 * Set TO and unset RF bits because we are
1100				 * going to send a PREP next.
1101				 */
1102				ppreq.preq_targets[0].target_flags |=
1103				    IEEE80211_MESHPREQ_TFLAGS_TO;
1104				hwmp_send_preq(ni, vap->iv_myaddr,
1105				    rttarg->rt_nexthop, &ppreq,
1106				    &hrtarg->hr_lastpreq,
1107				    &ieee80211_hwmp_preqminint);
1108			}
1109			/*
1110			 * Check if we can send an intermediate Path Reply,
1111			 * i.e., Target Only bit is not set.
1112			 */
1113			if (!(PREQ_TFLAGS(0) & IEEE80211_MESHPREQ_TFLAGS_TO) &&
1114			    HWMP_SEQ_GEQ(hrtarg->hr_seq, PREQ_TSEQ(0))) {
1115				struct ieee80211_meshprep_ie prep;
1116
1117				IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1118				    "intermediate reply for PREQ from %6D",
1119				    preq->preq_origaddr, ":");
1120				prep.prep_flags = 0;
1121				prep.prep_hopcount = rttarg->rt_nhops;
1122				prep.prep_ttl = ms->ms_ttl;
1123				IEEE80211_ADDR_COPY(&prep.prep_targetaddr,
1124				    PREQ_TADDR(0));
1125				prep.prep_targetseq = hrtarg->hr_seq;
1126				prep.prep_lifetime = preq->preq_lifetime;
1127				prep.prep_metric =rttarg->rt_metric;
1128				IEEE80211_ADDR_COPY(&prep.prep_origaddr,
1129				    preq->preq_origaddr);
1130				prep.prep_origseq = hrorig->hr_seq;
1131				hwmp_send_prep(ni, vap->iv_myaddr,
1132				    rtorig->rt_nexthop, &prep);
1133			}
1134		/*
1135		 * We have no information about this path,
1136		 * propagate the PREQ.
1137		 */
1138		} else if (preq->preq_ttl > 1 &&
1139		    preq->preq_hopcount < hs->hs_maxhops) {
1140			if (rttarg == NULL) {
1141				rttarg =
1142				    ieee80211_mesh_rt_add(vap, PREQ_TADDR(0));
1143				if (rttarg == NULL) {
1144					IEEE80211_NOTE(vap,
1145					    IEEE80211_MSG_HWMP, ni,
1146					    "unable to add PREQ path to %6D",
1147					    PREQ_TADDR(0), ":");
1148					vap->iv_stats.is_mesh_rtaddfailed++;
1149					return;
1150				}
1151			}
1152			rttarg->rt_metric = preq->preq_metric;
1153			ieee80211_mesh_rt_update(rttarg, preq->preq_lifetime);
1154			hrtarg = IEEE80211_MESH_ROUTE_PRIV(rttarg,
1155			    struct ieee80211_hwmp_route);
1156			hrtarg->hr_seq = PREQ_TSEQ(0);
1157			hrtarg->hr_preqid = preq->preq_id;
1158
1159			IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1160			    "forward PREQ from %6D",
1161			    preq->preq_origaddr, ":");
1162			ppreq.preq_hopcount += 1;
1163			ppreq.preq_ttl -= 1;
1164			ppreq.preq_metric += ms->ms_pmetric->mpm_metric(ni);
1165			hwmp_send_preq(ni, vap->iv_myaddr, broadcastaddr,
1166			    &ppreq, &hrtarg->hr_lastpreq,
1167			    &ieee80211_hwmp_preqminint);
1168		}
1169	}
1170}
1171#undef	PREQ_TFLAGS
1172#undef	PREQ_TADDR
1173#undef	PREQ_TSEQ
1174
1175static int
1176hwmp_send_preq(struct ieee80211_node *ni,
1177    const uint8_t sa[IEEE80211_ADDR_LEN],
1178    const uint8_t da[IEEE80211_ADDR_LEN],
1179    struct ieee80211_meshpreq_ie *preq,
1180    struct timeval *last, struct timeval *minint)
1181{
1182
1183	/*
1184	 * Enforce PREQ interval.
1185	 * NB: Proactive ROOT PREQs rate is handled by cb task.
1186	 */
1187	if (last != NULL && minint != NULL) {
1188		if (ratecheck(last, minint) == 0)
1189			return EALREADY; /* XXX: we should postpone */
1190		getmicrouptime(last);
1191	}
1192
1193	/*
1194	 * mesh preq action frame format
1195	 *     [6] da
1196	 *     [6] sa
1197	 *     [6] addr3 = sa
1198	 *     [1] action
1199	 *     [1] category
1200	 *     [tlv] mesh path request
1201	 */
1202	preq->preq_ie = IEEE80211_ELEMID_MESHPREQ;
1203	preq->preq_len = (preq->preq_flags & IEEE80211_MESHPREQ_FLAGS_AE ?
1204	    IEEE80211_MESHPREQ_BASE_SZ_AE : IEEE80211_MESHPREQ_BASE_SZ) +
1205	    preq->preq_tcount * IEEE80211_MESHPREQ_TRGT_SZ;
1206	return hwmp_send_action(ni, sa, da, (uint8_t *)preq, preq->preq_len+2);
1207}
1208
1209static void
1210hwmp_recv_prep(struct ieee80211vap *vap, struct ieee80211_node *ni,
1211    const struct ieee80211_frame *wh, const struct ieee80211_meshprep_ie *prep)
1212{
1213#define	IS_PROXY(rt)	(rt->rt_flags & IEEE80211_MESHRT_FLAGS_PROXY)
1214#define	PROXIED_BY_US(rt)		\
1215    (IEEE80211_ADDR_EQ(vap->iv_myaddr, rt->rt_mesh_gate))
1216	struct ieee80211_mesh_state *ms = vap->iv_mesh;
1217	struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
1218	struct ieee80211_mesh_route *rt = NULL;
1219	struct ieee80211_mesh_route *rtorig = NULL;
1220	struct ieee80211_mesh_route *rtext = NULL;
1221	struct ieee80211_hwmp_route *hr;
1222	struct ieee80211com *ic = vap->iv_ic;
1223	struct ifnet *ifp = vap->iv_ifp;
1224	struct mbuf *m, *next;
1225	uint32_t metric = 0;
1226	const uint8_t *addr;
1227
1228	if (ni == vap->iv_bss ||
1229	    ni->ni_mlstate != IEEE80211_NODE_MESH_ESTABLISHED)
1230		return;
1231
1232	IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1233	    "received PREP, orig %6D, targ %6D", prep->prep_origaddr, ":",
1234	    prep->prep_targetaddr, ":");
1235
1236	/*
1237	 * Acceptance criteria: (If the corresponding PREP was not generated
1238	 * by us OR not generated by an external mac that is not proxied by us)
1239	 * AND forwarding is disabled, discard this PREP.
1240	 */
1241	rtorig = ieee80211_mesh_rt_find(vap, prep->prep_origaddr);
1242	if ((!IEEE80211_ADDR_EQ(vap->iv_myaddr, prep->prep_origaddr) ||
1243	    (rtorig != NULL && IS_PROXY(rtorig) && !PROXIED_BY_US(rtorig))) &&
1244	    !(ms->ms_flags & IEEE80211_MESHFLAGS_FWD)){
1245		IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1246		    "discard PREP, orig(%6D) not proxied or generated by us",
1247		    prep->prep_origaddr, ":");
1248		return;
1249	}
1250
1251	/* PREP ACCEPTED */
1252
1253	/*
1254	 * If accepted shall create or update the active forwarding information
1255	 * it maintains for the target mesh STA of the PREP (according to the
1256	 * rules defined in 13.10.8.4). If the conditions for creating or
1257	 * updating the forwarding information have not been met in those
1258	 * rules, no further steps are applied to the PREP.
1259	 * [OPTIONAL]: update forwarding information to TA if metric improves.
1260	 */
1261	rt = ieee80211_mesh_rt_find(vap, prep->prep_targetaddr);
1262	if (rt == NULL) {
1263		rt = ieee80211_mesh_rt_add(vap, prep->prep_targetaddr);
1264		if (rt == NULL) {
1265			IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1266			    "unable to add PREP path to %6D",
1267			    prep->prep_targetaddr, ":");
1268			vap->iv_stats.is_mesh_rtaddfailed++;
1269			return;
1270		}
1271		IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1272		    "adding target %6D", prep->prep_targetaddr, ":");
1273	}
1274	hr = IEEE80211_MESH_ROUTE_PRIV(rt, struct ieee80211_hwmp_route);
1275	/* update path metric */
1276	metric = prep->prep_metric + ms->ms_pmetric->mpm_metric(ni);
1277	if ((rt->rt_flags & IEEE80211_MESHRT_FLAGS_VALID)) {
1278		if (HWMP_SEQ_LT(prep->prep_targetseq, hr->hr_seq)) {
1279			IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1280			    "discard PREP from %6D, old seq no %u < %u",
1281			    prep->prep_targetaddr, ":",
1282			    prep->prep_targetseq, hr->hr_seq);
1283			return;
1284		} else if (HWMP_SEQ_LEQ(prep->prep_targetseq, hr->hr_seq) &&
1285		    metric > rt->rt_metric) {
1286			IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1287			    "discard PREP from %6D, new metric %u > %u",
1288			    prep->prep_targetaddr, ":",
1289			    prep->prep_metric, rt->rt_metric);
1290			return;
1291		}
1292	}
1293
1294	IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1295	    "%s path to %6D, hopcount %d:%d metric %d:%d",
1296	    rt->rt_flags & IEEE80211_MESHRT_FLAGS_VALID ?
1297	    "prefer" : "update",
1298	    prep->prep_targetaddr, ":",
1299	    rt->rt_nhops, prep->prep_hopcount,
1300	    rt->rt_metric, metric);
1301
1302	hr->hr_seq = prep->prep_targetseq;
1303	hr->hr_preqretries = 0;
1304	IEEE80211_ADDR_COPY(rt->rt_nexthop, ni->ni_macaddr);
1305	rt->rt_metric = metric;
1306	rt->rt_nhops = prep->prep_hopcount + 1;
1307	ieee80211_mesh_rt_update(rt, prep->prep_lifetime);
1308	rt->rt_flags |= IEEE80211_MESHRT_FLAGS_VALID; /* mark valid */
1309
1310	/*
1311	 * If it's NOT for us, propagate the PREP
1312	 */
1313	if (!IEEE80211_ADDR_EQ(vap->iv_myaddr, prep->prep_origaddr) &&
1314	    prep->prep_ttl > 1 &&
1315	    prep->prep_hopcount < hs->hs_maxhops) {
1316		struct ieee80211_meshprep_ie pprep; /* propagated PREP */
1317		/*
1318		 * NB: We should already have setup the path to orig
1319		 * mesh STA when we propagated PREQ to target mesh STA,
1320		 * no PREP is generated without a corresponding PREQ.
1321		 * XXX: for now just ignore.
1322		 */
1323		if (rtorig == NULL) {
1324			IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1325			    "received PREP for an unknown orig(%6D)",
1326			    prep->prep_origaddr, ":");
1327			return;
1328		}
1329
1330		IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1331		    "propagate PREP from %6D",
1332		    prep->prep_targetaddr, ":");
1333
1334		memcpy(&pprep, prep, sizeof(pprep));
1335		pprep.prep_hopcount += 1;
1336		pprep.prep_ttl -= 1;
1337		pprep.prep_metric += ms->ms_pmetric->mpm_metric(ni);
1338		hwmp_send_prep(ni, vap->iv_myaddr, rtorig->rt_nexthop, &pprep);
1339
1340		/* precursor list for the Target Mesh STA Address is updated */
1341	}
1342
1343	/*
1344	 * Check if we received a PREP w/ AE and store target external address.
1345	 * We may store target external address if recevied PREP w/ AE
1346	 * and we are not final destination
1347	 */
1348	if (prep->prep_flags & IEEE80211_MESHPREP_FLAGS_AE) {
1349		rtext = ieee80211_mesh_rt_find(vap,
1350			prep->prep_target_ext_addr);
1351		if (rtext == NULL) {
1352			rtext = ieee80211_mesh_rt_add(vap,
1353				prep->prep_target_ext_addr);
1354			if (rtext == NULL) {
1355				IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1356				    "unable to add PREP path to proxy %6D",
1357				    prep->prep_targetaddr, ":");
1358				vap->iv_stats.is_mesh_rtaddfailed++;
1359				return;
1360			}
1361		}
1362		IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1363		    "%s path to %6D, hopcount %d:%d metric %d:%d",
1364		    rtext->rt_flags & IEEE80211_MESHRT_FLAGS_VALID ?
1365		    "prefer" : "update",
1366		    prep->prep_target_ext_addr, ":",
1367		    rtext->rt_nhops, prep->prep_hopcount,
1368		    rtext->rt_metric, metric);
1369
1370		rtext->rt_flags = IEEE80211_MESHRT_FLAGS_PROXY |
1371			IEEE80211_MESHRT_FLAGS_VALID;
1372		IEEE80211_ADDR_COPY(rtext->rt_dest,
1373		    prep->prep_target_ext_addr);
1374		IEEE80211_ADDR_COPY(rtext->rt_mesh_gate,
1375		    prep->prep_targetaddr);
1376		IEEE80211_ADDR_COPY(rtext->rt_nexthop, wh->i_addr2);
1377		rtext->rt_metric = metric;
1378		rtext->rt_lifetime = prep->prep_lifetime;
1379		rtext->rt_nhops = prep->prep_hopcount + 1;
1380		rtext->rt_ext_seq = prep->prep_origseq; /* new proxy seq */
1381		/*
1382		 * XXX: proxy entries have no HWMP priv data,
1383		 * nullify them to be sure?
1384		 */
1385	}
1386	/*
1387	 * Check for frames queued awaiting path discovery.
1388	 * XXX probably can tell exactly and avoid remove call
1389	 * NB: hash may have false matches, if so they will get
1390	 *     stuck back on the stageq because there won't be
1391	 *     a path.
1392	 */
1393	addr = prep->prep_flags & IEEE80211_MESHPREP_FLAGS_AE ?
1394	    prep->prep_target_ext_addr : prep->prep_targetaddr;
1395	m = ieee80211_ageq_remove(&ic->ic_stageq,
1396	    (struct ieee80211_node *)(uintptr_t)
1397	    ieee80211_mac_hash(ic, addr)); /* either dest or ext_dest */
1398	for (; m != NULL; m = next) {
1399		next = m->m_nextpkt;
1400		m->m_nextpkt = NULL;
1401		IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1402		    "flush queued frame %p len %d", m, m->m_pkthdr.len);
1403		ifp->if_transmit(ifp, m);
1404	}
1405#undef	IS_PROXY
1406#undef	PROXIED_BY_US
1407}
1408
1409static int
1410hwmp_send_prep(struct ieee80211_node *ni,
1411    const uint8_t sa[IEEE80211_ADDR_LEN],
1412    const uint8_t da[IEEE80211_ADDR_LEN],
1413    struct ieee80211_meshprep_ie *prep)
1414{
1415	/* NB: there's no PREP minimum interval. */
1416
1417	/*
1418	 * mesh prep action frame format
1419	 *     [6] da
1420	 *     [6] sa
1421	 *     [6] addr3 = sa
1422	 *     [1] action
1423	 *     [1] category
1424	 *     [tlv] mesh path reply
1425	 */
1426	prep->prep_ie = IEEE80211_ELEMID_MESHPREP;
1427	prep->prep_len = prep->prep_flags & IEEE80211_MESHPREP_FLAGS_AE ?
1428	    IEEE80211_MESHPREP_BASE_SZ_AE : IEEE80211_MESHPREP_BASE_SZ;
1429	return hwmp_send_action(ni, sa, da, (uint8_t *)prep,
1430	    prep->prep_len + 2);
1431}
1432
1433#define	PERR_DFLAGS(n)	perr.perr_dests[n].dest_flags
1434#define	PERR_DADDR(n)	perr.perr_dests[n].dest_addr
1435#define	PERR_DSEQ(n)	perr.perr_dests[n].dest_seq
1436#define	PERR_DRCODE(n)	perr.perr_dests[n].dest_rcode
1437static void
1438hwmp_peerdown(struct ieee80211_node *ni)
1439{
1440	struct ieee80211vap *vap = ni->ni_vap;
1441	struct ieee80211_mesh_state *ms = vap->iv_mesh;
1442	struct ieee80211_meshperr_ie perr;
1443	struct ieee80211_mesh_route *rt;
1444	struct ieee80211_hwmp_route *hr;
1445
1446	rt = ieee80211_mesh_rt_find(vap, ni->ni_macaddr);
1447	if (rt == NULL)
1448		return;
1449	hr = IEEE80211_MESH_ROUTE_PRIV(rt, struct ieee80211_hwmp_route);
1450	IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1451	    "%s", "delete route entry");
1452	perr.perr_ttl = ms->ms_ttl;
1453	perr.perr_ndests = 1;
1454	PERR_DFLAGS(0) = 0;
1455	if (hr->hr_seq == 0)
1456		PERR_DFLAGS(0) |= IEEE80211_MESHPERR_DFLAGS_USN;
1457	PERR_DFLAGS(0) |= IEEE80211_MESHPERR_DFLAGS_RC;
1458	IEEE80211_ADDR_COPY(PERR_DADDR(0), rt->rt_dest);
1459	PERR_DSEQ(0) = hr->hr_seq;
1460	PERR_DRCODE(0) = IEEE80211_REASON_MESH_PERR_DEST_UNREACH;
1461	/* NB: flush everything passing through peer */
1462	ieee80211_mesh_rt_flush_peer(vap, ni->ni_macaddr);
1463	hwmp_send_perr(vap->iv_bss, vap->iv_myaddr, broadcastaddr, &perr);
1464}
1465#undef	PERR_DFLAGS
1466#undef	PERR_DADDR
1467#undef	PERR_DSEQ
1468#undef	PERR_DRCODE
1469
1470#define	PERR_DFLAGS(n)	perr->perr_dests[n].dest_flags
1471#define	PERR_DADDR(n)	perr->perr_dests[n].dest_addr
1472#define	PERR_DSEQ(n)	perr->perr_dests[n].dest_seq
1473#define	PERR_DRCODE(n)	perr->perr_dests[n].dest_rcode
1474static void
1475hwmp_recv_perr(struct ieee80211vap *vap, struct ieee80211_node *ni,
1476    const struct ieee80211_frame *wh, const struct ieee80211_meshperr_ie *perr)
1477{
1478	struct ieee80211_mesh_state *ms = vap->iv_mesh;
1479	struct ieee80211_mesh_route *rt = NULL;
1480	struct ieee80211_hwmp_route *hr;
1481	struct ieee80211_meshperr_ie pperr;
1482	int i, forward = 0;
1483
1484	/*
1485	 * Acceptance criteria: check if we received a PERR from a
1486	 * neighbor and forwarding is enabled.
1487	 */
1488	if (ni == vap->iv_bss ||
1489	    ni->ni_mlstate != IEEE80211_NODE_MESH_ESTABLISHED ||
1490	    !(ms->ms_flags & IEEE80211_MESHFLAGS_FWD))
1491		return;
1492	/*
1493	 * Find all routing entries that match and delete them.
1494	 */
1495	for (i = 0; i < perr->perr_ndests; i++) {
1496		rt = ieee80211_mesh_rt_find(vap, PERR_DADDR(i));
1497		if (rt == NULL)
1498			continue;
1499		hr = IEEE80211_MESH_ROUTE_PRIV(rt, struct ieee80211_hwmp_route);
1500		if (!(PERR_DFLAGS(0) & IEEE80211_MESHPERR_DFLAGS_USN) &&
1501		    HWMP_SEQ_GEQ(PERR_DSEQ(i), hr->hr_seq)) {
1502			ieee80211_mesh_rt_del(vap, rt->rt_dest);
1503			ieee80211_mesh_rt_flush_peer(vap, rt->rt_dest);
1504			rt = NULL;
1505			forward = 1;
1506		}
1507	}
1508	/*
1509	 * Propagate the PERR if we previously found it on our routing table.
1510	 * XXX handle ndest > 1
1511	 */
1512	if (forward && perr->perr_ttl > 1) {
1513		IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1514		    "propagate PERR from %6D", wh->i_addr2, ":");
1515		memcpy(&pperr, perr, sizeof(*perr));
1516		pperr.perr_ttl--;
1517		hwmp_send_perr(vap->iv_bss, vap->iv_myaddr, broadcastaddr,
1518		    &pperr);
1519	}
1520}
1521#undef	PERR_DFLAGS
1522#undef	PEER_DADDR
1523#undef	PERR_DSEQ
1524#undef	PERR_DRCODE
1525
1526static int
1527hwmp_send_perr(struct ieee80211_node *ni,
1528    const uint8_t sa[IEEE80211_ADDR_LEN],
1529    const uint8_t da[IEEE80211_ADDR_LEN],
1530    struct ieee80211_meshperr_ie *perr)
1531{
1532	struct ieee80211_hwmp_state *hs = ni->ni_vap->iv_hwmp;
1533	int i;
1534	uint8_t length = 0;
1535
1536	/*
1537	 * Enforce PERR interval.
1538	 */
1539	if (ratecheck(&hs->hs_lastperr, &ieee80211_hwmp_perrminint) == 0)
1540		return EALREADY;
1541	getmicrouptime(&hs->hs_lastperr);
1542
1543	/*
1544	 * mesh perr action frame format
1545	 *     [6] da
1546	 *     [6] sa
1547	 *     [6] addr3 = sa
1548	 *     [1] action
1549	 *     [1] category
1550	 *     [tlv] mesh path error
1551	 */
1552	perr->perr_ie = IEEE80211_ELEMID_MESHPERR;
1553	length = IEEE80211_MESHPERR_BASE_SZ;
1554	for (i = 0; i<perr->perr_ndests; i++) {
1555		if (perr->perr_dests[i].dest_flags &
1556		    IEEE80211_MESHPERR_FLAGS_AE) {
1557			length += IEEE80211_MESHPERR_DEST_SZ_AE;
1558			continue ;
1559		}
1560		length += IEEE80211_MESHPERR_DEST_SZ;
1561	}
1562	perr->perr_len =length;
1563	return hwmp_send_action(ni, sa, da, (uint8_t *)perr, perr->perr_len+2);
1564}
1565
1566static void
1567hwmp_recv_rann(struct ieee80211vap *vap, struct ieee80211_node *ni,
1568    const struct ieee80211_frame *wh, const struct ieee80211_meshrann_ie *rann)
1569{
1570	struct ieee80211_mesh_state *ms = vap->iv_mesh;
1571	struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
1572	struct ieee80211_mesh_route *rt = NULL;
1573	struct ieee80211_hwmp_route *hr;
1574	struct ieee80211_meshrann_ie prann;
1575
1576	if (ni == vap->iv_bss ||
1577	    ni->ni_mlstate != IEEE80211_NODE_MESH_ESTABLISHED ||
1578	    IEEE80211_ADDR_EQ(rann->rann_addr, vap->iv_myaddr))
1579		return;
1580
1581	rt = ieee80211_mesh_rt_find(vap, rann->rann_addr);
1582	/*
1583	 * Discover the path to the root mesh STA.
1584	 * If we already know it, propagate the RANN element.
1585	 */
1586	if (rt == NULL) {
1587		hwmp_discover(vap, rann->rann_addr, NULL);
1588		return;
1589	}
1590	hr = IEEE80211_MESH_ROUTE_PRIV(rt, struct ieee80211_hwmp_route);
1591	if (HWMP_SEQ_GT(rann->rann_seq, hr->hr_seq)) {
1592		hr->hr_seq = rann->rann_seq;
1593		if (rann->rann_ttl > 1 &&
1594		    rann->rann_hopcount < hs->hs_maxhops &&
1595		    (ms->ms_flags & IEEE80211_MESHFLAGS_FWD)) {
1596			memcpy(&prann, rann, sizeof(prann));
1597			prann.rann_hopcount += 1;
1598			prann.rann_ttl -= 1;
1599			prann.rann_metric += ms->ms_pmetric->mpm_metric(ni);
1600			hwmp_send_rann(vap->iv_bss, vap->iv_myaddr,
1601			    broadcastaddr, &prann);
1602		}
1603	}
1604}
1605
1606static int
1607hwmp_send_rann(struct ieee80211_node *ni,
1608    const uint8_t sa[IEEE80211_ADDR_LEN],
1609    const uint8_t da[IEEE80211_ADDR_LEN],
1610    struct ieee80211_meshrann_ie *rann)
1611{
1612	/*
1613	 * mesh rann action frame format
1614	 *     [6] da
1615	 *     [6] sa
1616	 *     [6] addr3 = sa
1617	 *     [1] action
1618	 *     [1] category
1619	 *     [tlv] root annoucement
1620	 */
1621	rann->rann_ie = IEEE80211_ELEMID_MESHRANN;
1622	rann->rann_len = IEEE80211_MESHRANN_BASE_SZ;
1623	return hwmp_send_action(ni, sa, da, (uint8_t *)rann,
1624	    rann->rann_len + 2);
1625}
1626
1627#define	PREQ_TFLAGS(n)	preq.preq_targets[n].target_flags
1628#define	PREQ_TADDR(n)	preq.preq_targets[n].target_addr
1629#define	PREQ_TSEQ(n)	preq.preq_targets[n].target_seq
1630static struct ieee80211_node *
1631hwmp_discover(struct ieee80211vap *vap,
1632    const uint8_t dest[IEEE80211_ADDR_LEN], struct mbuf *m)
1633{
1634	struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
1635	struct ieee80211_mesh_state *ms = vap->iv_mesh;
1636	struct ieee80211_mesh_route *rt = NULL;
1637	struct ieee80211_hwmp_route *hr;
1638	struct ieee80211_meshpreq_ie preq;
1639	struct ieee80211_node *ni;
1640	int sendpreq = 0;
1641
1642	KASSERT(vap->iv_opmode == IEEE80211_M_MBSS,
1643	    ("not a mesh vap, opmode %d", vap->iv_opmode));
1644
1645	KASSERT(!IEEE80211_ADDR_EQ(vap->iv_myaddr, dest),
1646	    ("%s: discovering self!", __func__));
1647
1648	ni = NULL;
1649	if (!IEEE80211_IS_MULTICAST(dest)) {
1650		rt = ieee80211_mesh_rt_find(vap, dest);
1651		if (rt == NULL) {
1652			rt = ieee80211_mesh_rt_add(vap, dest);
1653			if (rt == NULL) {
1654				IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP,
1655				    ni, "unable to add discovery path to %6D",
1656				    dest, ":");
1657				vap->iv_stats.is_mesh_rtaddfailed++;
1658				goto done;
1659			}
1660		}
1661		hr = IEEE80211_MESH_ROUTE_PRIV(rt,
1662		    struct ieee80211_hwmp_route);
1663		if ((rt->rt_flags & IEEE80211_MESHRT_FLAGS_VALID) == 0) {
1664			if (hr->hr_lastdiscovery != 0 &&
1665			    (ticks - hr->hr_lastdiscovery <
1666			    (ieee80211_hwmp_net_diameter_traversaltime * 2))) {
1667				IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_ANY,
1668			            dest, NULL, "%s",
1669				    "too frequent discovery requeust");
1670				/* XXX: stats? */
1671				goto done;
1672			}
1673			hr->hr_lastdiscovery = ticks;
1674			if (hr->hr_preqretries >=
1675			    ieee80211_hwmp_maxpreq_retries) {
1676				IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_ANY,
1677			            dest, NULL, "%s",
1678				    "no valid path , max number of discovery");
1679				vap->iv_stats.is_mesh_fwd_nopath++;
1680				goto done;
1681			}
1682			hr->hr_preqretries++;
1683			if (hr->hr_origseq == 0)
1684				hr->hr_origseq = ++hs->hs_seq;
1685			rt->rt_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
1686			/* XXX: special discovery timeout, larger lifetime? */
1687			ieee80211_mesh_rt_update(rt,
1688			    ticks_to_msecs(ieee80211_hwmp_pathtimeout));
1689			sendpreq = 1;
1690			IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_HWMP, dest,
1691			    "start path discovery (src %s), target seq %u",
1692			    m == NULL ? "<none>" : ether_sprintf(
1693			    mtod(m, struct ether_header *)->ether_shost),
1694			    hr->hr_seq);
1695			/*
1696			 * Try to discover the path for this node.
1697			 * Group addressed PREQ Case A
1698			 */
1699			preq.preq_flags = 0;
1700			preq.preq_hopcount = 0;
1701			preq.preq_ttl = ms->ms_ttl;
1702			preq.preq_id = ++hs->hs_preqid;
1703			IEEE80211_ADDR_COPY(preq.preq_origaddr, vap->iv_myaddr);
1704			preq.preq_origseq = hr->hr_origseq;
1705			preq.preq_lifetime =
1706			    ticks_to_msecs(ieee80211_hwmp_pathtimeout);
1707			preq.preq_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
1708			preq.preq_tcount = 1;
1709			IEEE80211_ADDR_COPY(PREQ_TADDR(0), dest);
1710			PREQ_TFLAGS(0) = 0;
1711			if (ieee80211_hwmp_targetonly)
1712				PREQ_TFLAGS(0) |= IEEE80211_MESHPREQ_TFLAGS_TO;
1713			PREQ_TFLAGS(0) |= IEEE80211_MESHPREQ_TFLAGS_USN;
1714			PREQ_TSEQ(0) = 0; /* RESERVED when USN flag is set */
1715			/* XXX check return value */
1716			hwmp_send_preq(vap->iv_bss, vap->iv_myaddr,
1717			    broadcastaddr, &preq, &hr->hr_lastpreq,
1718			    &ieee80211_hwmp_preqminint);
1719		}
1720		if (rt->rt_flags & IEEE80211_MESHRT_FLAGS_VALID)
1721			ni = ieee80211_find_txnode(vap, rt->rt_nexthop);
1722	} else {
1723		ni = ieee80211_find_txnode(vap, dest);
1724		/* NB: if null then we leak mbuf */
1725		KASSERT(ni != NULL, ("leak mcast frame"));
1726		return ni;
1727	}
1728done:
1729	if (ni == NULL && m != NULL) {
1730		if (sendpreq) {
1731			struct ieee80211com *ic = vap->iv_ic;
1732			/*
1733			 * Queue packet for transmit when path discovery
1734			 * completes.  If discovery never completes the
1735			 * frame will be flushed by way of the aging timer.
1736			 */
1737			IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_HWMP, dest,
1738			    "%s", "queue frame until path found");
1739			m->m_pkthdr.rcvif = (void *)(uintptr_t)
1740			    ieee80211_mac_hash(ic, dest);
1741			/* XXX age chosen randomly */
1742			ieee80211_ageq_append(&ic->ic_stageq, m,
1743			    IEEE80211_INACT_WAIT);
1744		} else {
1745			IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_HWMP,
1746			    dest, NULL, "%s", "no valid path to this node");
1747			m_freem(m);
1748		}
1749	}
1750	return ni;
1751}
1752#undef	PREQ_TFLAGS
1753#undef	PREQ_TADDR
1754#undef	PREQ_TSEQ
1755
1756static int
1757hwmp_ioctl_get80211(struct ieee80211vap *vap, struct ieee80211req *ireq)
1758{
1759	struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
1760	int error;
1761
1762	if (vap->iv_opmode != IEEE80211_M_MBSS)
1763		return ENOSYS;
1764	error = 0;
1765	switch (ireq->i_type) {
1766	case IEEE80211_IOC_HWMP_ROOTMODE:
1767		ireq->i_val = hs->hs_rootmode;
1768		break;
1769	case IEEE80211_IOC_HWMP_MAXHOPS:
1770		ireq->i_val = hs->hs_maxhops;
1771		break;
1772	default:
1773		return ENOSYS;
1774	}
1775	return error;
1776}
1777IEEE80211_IOCTL_GET(hwmp, hwmp_ioctl_get80211);
1778
1779static int
1780hwmp_ioctl_set80211(struct ieee80211vap *vap, struct ieee80211req *ireq)
1781{
1782	struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
1783	int error;
1784
1785	if (vap->iv_opmode != IEEE80211_M_MBSS)
1786		return ENOSYS;
1787	error = 0;
1788	switch (ireq->i_type) {
1789	case IEEE80211_IOC_HWMP_ROOTMODE:
1790		if (ireq->i_val < 0 || ireq->i_val > 3)
1791			return EINVAL;
1792		hs->hs_rootmode = ireq->i_val;
1793		hwmp_rootmode_setup(vap);
1794		break;
1795	case IEEE80211_IOC_HWMP_MAXHOPS:
1796		if (ireq->i_val <= 0 || ireq->i_val > 255)
1797			return EINVAL;
1798		hs->hs_maxhops = ireq->i_val;
1799		break;
1800	default:
1801		return ENOSYS;
1802	}
1803	return error;
1804}
1805IEEE80211_IOCTL_SET(hwmp, hwmp_ioctl_set80211);
1806