2 * Copyright (c) 2009 The FreeBSD Foundation
5 * This software was developed by Rui Paulo under sponsorship from the
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
29 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
35 * IEEE 802.11s Hybrid Wireless Mesh Protocol, HWMP.
37 * Based on March 2009, D3.0 802.11s draft spec.
42 #include <sys/param.h>
43 #include <sys/systm.h>
45 #include <sys/malloc.h>
46 #include <sys/kernel.h>
48 #include <sys/socket.h>
49 #include <sys/sockio.h>
50 #include <sys/endian.h>
51 #include <sys/errno.h>
53 #include <sys/sysctl.h>
56 #include <net/if_media.h>
57 #include <net/if_llc.h>
58 #include <net/ethernet.h>
62 #include <net80211/ieee80211_var.h>
63 #include <net80211/ieee80211_action.h>
64 #include <net80211/ieee80211_input.h>
65 #include <net80211/ieee80211_mesh.h>
67 static void hwmp_vattach(struct ieee80211vap *);
68 static void hwmp_vdetach(struct ieee80211vap *);
69 static int hwmp_newstate(struct ieee80211vap *,
70 enum ieee80211_state, int);
71 static int hwmp_send_action(struct ieee80211vap *,
72 const uint8_t [IEEE80211_ADDR_LEN],
74 static uint8_t * hwmp_add_meshpreq(uint8_t *,
75 const struct ieee80211_meshpreq_ie *);
76 static uint8_t * hwmp_add_meshprep(uint8_t *,
77 const struct ieee80211_meshprep_ie *);
78 static uint8_t * hwmp_add_meshperr(uint8_t *,
79 const struct ieee80211_meshperr_ie *);
80 static uint8_t * hwmp_add_meshrann(uint8_t *,
81 const struct ieee80211_meshrann_ie *);
82 static void hwmp_rootmode_setup(struct ieee80211vap *);
83 static void hwmp_rootmode_cb(void *);
84 static void hwmp_rootmode_rann_cb(void *);
85 static void hwmp_recv_preq(struct ieee80211vap *, struct ieee80211_node *,
86 const struct ieee80211_frame *,
87 const struct ieee80211_meshpreq_ie *);
88 static int hwmp_send_preq(struct ieee80211vap *,
89 const uint8_t [IEEE80211_ADDR_LEN],
90 struct ieee80211_meshpreq_ie *,
91 struct timeval *, struct timeval *);
92 static void hwmp_recv_prep(struct ieee80211vap *, struct ieee80211_node *,
93 const struct ieee80211_frame *,
94 const struct ieee80211_meshprep_ie *);
95 static int hwmp_send_prep(struct ieee80211vap *,
96 const uint8_t [IEEE80211_ADDR_LEN],
97 struct ieee80211_meshprep_ie *);
98 static void hwmp_recv_perr(struct ieee80211vap *, struct ieee80211_node *,
99 const struct ieee80211_frame *,
100 const struct ieee80211_meshperr_ie *);
101 static int hwmp_send_perr(struct ieee80211vap *,
102 const uint8_t [IEEE80211_ADDR_LEN],
103 struct ieee80211_meshperr_ie *);
104 static void hwmp_senderror(struct ieee80211vap *,
105 const uint8_t [IEEE80211_ADDR_LEN],
106 struct ieee80211_mesh_route *, int);
107 static void hwmp_recv_rann(struct ieee80211vap *, struct ieee80211_node *,
108 const struct ieee80211_frame *,
109 const struct ieee80211_meshrann_ie *);
110 static int hwmp_send_rann(struct ieee80211vap *,
111 const uint8_t [IEEE80211_ADDR_LEN],
112 struct ieee80211_meshrann_ie *);
113 static struct ieee80211_node *
114 hwmp_discover(struct ieee80211vap *,
115 const uint8_t [IEEE80211_ADDR_LEN], struct mbuf *);
116 static void hwmp_peerdown(struct ieee80211_node *);
118 static struct timeval ieee80211_hwmp_preqminint = { 0, 100000 };
119 static struct timeval ieee80211_hwmp_perrminint = { 0, 100000 };
121 /* unalligned little endian access */
122 #define LE_WRITE_2(p, v) do { \
123 ((uint8_t *)(p))[0] = (v) & 0xff; \
124 ((uint8_t *)(p))[1] = ((v) >> 8) & 0xff; \
126 #define LE_WRITE_4(p, v) do { \
127 ((uint8_t *)(p))[0] = (v) & 0xff; \
128 ((uint8_t *)(p))[1] = ((v) >> 8) & 0xff; \
129 ((uint8_t *)(p))[2] = ((v) >> 16) & 0xff; \
130 ((uint8_t *)(p))[3] = ((v) >> 24) & 0xff; \
134 /* NB: the Target Address set in a Proactive PREQ is the broadcast address. */
135 static const uint8_t broadcastaddr[IEEE80211_ADDR_LEN] =
136 { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
138 typedef uint32_t ieee80211_hwmp_seq;
139 #define HWMP_SEQ_LT(a, b) ((int32_t)((a)-(b)) < 0)
140 #define HWMP_SEQ_LEQ(a, b) ((int32_t)((a)-(b)) <= 0)
141 #define HWMP_SEQ_EQ(a, b) ((int32_t)((a)-(b)) == 0)
142 #define HWMP_SEQ_GT(a, b) ((int32_t)((a)-(b)) > 0)
143 #define HWMP_SEQ_GEQ(a, b) ((int32_t)((a)-(b)) >= 0)
145 #define HWMP_SEQ_MAX(a, b) (a > b ? a : b)
148 * Private extension of ieee80211_mesh_route.
150 struct ieee80211_hwmp_route {
151 ieee80211_hwmp_seq hr_seq; /* last HWMP seq seen from dst*/
152 ieee80211_hwmp_seq hr_preqid; /* last PREQ ID seen from dst */
153 ieee80211_hwmp_seq hr_origseq; /* seq. no. on our latest PREQ*/
154 struct timeval hr_lastpreq; /* last time we sent a PREQ */
155 struct timeval hr_lastrootconf; /* last sent PREQ root conf */
156 int hr_preqretries; /* number of discoveries */
157 int hr_lastdiscovery; /* last discovery in ticks */
159 struct ieee80211_hwmp_state {
160 ieee80211_hwmp_seq hs_seq; /* next seq to be used */
161 ieee80211_hwmp_seq hs_preqid; /* next PREQ ID to be used */
162 int hs_rootmode; /* proactive HWMP */
163 struct timeval hs_lastperr; /* last time we sent a PERR */
164 struct callout hs_roottimer;
165 uint8_t hs_maxhops; /* max hop count */
168 static SYSCTL_NODE(_net_wlan, OID_AUTO, hwmp, CTLFLAG_RD, 0,
169 "IEEE 802.11s HWMP parameters");
170 static int ieee80211_hwmp_targetonly = 0;
171 SYSCTL_INT(_net_wlan_hwmp, OID_AUTO, targetonly, CTLTYPE_INT | CTLFLAG_RW,
172 &ieee80211_hwmp_targetonly, 0, "Set TO bit on generated PREQs");
173 static int ieee80211_hwmp_pathtimeout = -1;
174 SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, pathlifetime, CTLTYPE_INT | CTLFLAG_RW,
175 &ieee80211_hwmp_pathtimeout, 0, ieee80211_sysctl_msecs_ticks, "I",
176 "path entry lifetime (ms)");
177 static int ieee80211_hwmp_maxpreq_retries = -1;
178 SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, maxpreq_retries, CTLTYPE_INT | CTLFLAG_RW,
179 &ieee80211_hwmp_maxpreq_retries, 0, ieee80211_sysctl_msecs_ticks, "I",
180 "maximum number of preq retries");
181 static int ieee80211_hwmp_net_diameter_traversaltime = -1;
182 SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, net_diameter_traversal_time,
183 CTLTYPE_INT | CTLFLAG_RW, &ieee80211_hwmp_net_diameter_traversaltime, 0,
184 ieee80211_sysctl_msecs_ticks, "I",
185 "estimate travelse time across the MBSS (ms)");
186 static int ieee80211_hwmp_roottimeout = -1;
187 SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, roottimeout, CTLTYPE_INT | CTLFLAG_RW,
188 &ieee80211_hwmp_roottimeout, 0, ieee80211_sysctl_msecs_ticks, "I",
189 "root PREQ timeout (ms)");
190 static int ieee80211_hwmp_rootint = -1;
191 SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, rootint, CTLTYPE_INT | CTLFLAG_RW,
192 &ieee80211_hwmp_rootint, 0, ieee80211_sysctl_msecs_ticks, "I",
193 "root interval (ms)");
194 static int ieee80211_hwmp_rannint = -1;
195 SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, rannint, CTLTYPE_INT | CTLFLAG_RW,
196 &ieee80211_hwmp_rannint, 0, ieee80211_sysctl_msecs_ticks, "I",
197 "root announcement interval (ms)");
198 static struct timeval ieee80211_hwmp_rootconfint = { 0, 0 };
199 static int ieee80211_hwmp_rootconfint_internal = -1;
200 SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, rootconfint, CTLTYPE_INT | CTLFLAG_RD,
201 &ieee80211_hwmp_rootconfint_internal, 0, ieee80211_sysctl_msecs_ticks, "I",
202 "root confirmation interval (ms) (read-only)");
204 #define IEEE80211_HWMP_DEFAULT_MAXHOPS 31
206 static ieee80211_recv_action_func hwmp_recv_action_meshpath;
208 static struct ieee80211_mesh_proto_path mesh_proto_hwmp = {
210 .mpp_ie = IEEE80211_MESHCONF_PATH_HWMP,
211 .mpp_discover = hwmp_discover,
212 .mpp_peerdown = hwmp_peerdown,
213 .mpp_senderror = hwmp_senderror,
214 .mpp_vattach = hwmp_vattach,
215 .mpp_vdetach = hwmp_vdetach,
216 .mpp_newstate = hwmp_newstate,
217 .mpp_privlen = sizeof(struct ieee80211_hwmp_route),
219 SYSCTL_PROC(_net_wlan_hwmp, OID_AUTO, inact, CTLTYPE_INT | CTLFLAG_RW,
220 &mesh_proto_hwmp.mpp_inact, 0, ieee80211_sysctl_msecs_ticks, "I",
221 "mesh route inactivity timeout (ms)");
225 ieee80211_hwmp_init(void)
227 /* Default values as per amendment */
228 ieee80211_hwmp_pathtimeout = msecs_to_ticks(5*1000);
229 ieee80211_hwmp_roottimeout = msecs_to_ticks(5*1000);
230 ieee80211_hwmp_rootint = msecs_to_ticks(2*1000);
231 ieee80211_hwmp_rannint = msecs_to_ticks(1*1000);
232 ieee80211_hwmp_rootconfint_internal = msecs_to_ticks(2*1000);
233 ieee80211_hwmp_maxpreq_retries = 3;
235 * (TU): A measurement of time equal to 1024 μs,
238 ieee80211_hwmp_net_diameter_traversaltime = msecs_to_ticks(512);
241 * NB: I dont know how to make SYSCTL_PROC that calls ms to ticks
242 * and return a struct timeval...
244 ieee80211_hwmp_rootconfint.tv_usec =
245 ieee80211_hwmp_rootconfint_internal * 1000;
248 * Register action frame handler.
250 ieee80211_recv_action_register(IEEE80211_ACTION_CAT_MESH,
251 IEEE80211_ACTION_MESH_HWMP, hwmp_recv_action_meshpath);
253 /* NB: default is 5 secs per spec */
254 mesh_proto_hwmp.mpp_inact = msecs_to_ticks(5*1000);
259 ieee80211_mesh_register_proto_path(&mesh_proto_hwmp);
261 SYSINIT(wlan_hwmp, SI_SUB_DRIVERS, SI_ORDER_SECOND, ieee80211_hwmp_init, NULL);
264 hwmp_vattach(struct ieee80211vap *vap)
266 struct ieee80211_hwmp_state *hs;
268 KASSERT(vap->iv_opmode == IEEE80211_M_MBSS,
269 ("not a mesh vap, opmode %d", vap->iv_opmode));
271 hs = malloc(sizeof(struct ieee80211_hwmp_state), M_80211_VAP,
274 printf("%s: couldn't alloc HWMP state\n", __func__);
277 hs->hs_maxhops = IEEE80211_HWMP_DEFAULT_MAXHOPS;
278 callout_init(&hs->hs_roottimer, CALLOUT_MPSAFE);
283 hwmp_vdetach(struct ieee80211vap *vap)
285 struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
287 callout_drain(&hs->hs_roottimer);
288 free(vap->iv_hwmp, M_80211_VAP);
293 hwmp_newstate(struct ieee80211vap *vap, enum ieee80211_state ostate, int arg)
295 enum ieee80211_state nstate = vap->iv_state;
296 struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
298 IEEE80211_DPRINTF(vap, IEEE80211_MSG_STATE, "%s: %s -> %s (%d)\n",
299 __func__, ieee80211_state_name[ostate],
300 ieee80211_state_name[nstate], arg);
302 if (nstate != IEEE80211_S_RUN && ostate == IEEE80211_S_RUN)
303 callout_drain(&hs->hs_roottimer);
304 if (nstate == IEEE80211_S_RUN)
305 hwmp_rootmode_setup(vap);
310 * Verify the length of an HWMP PREQ and return the number
311 * of destinations >= 1, if verification fails -1 is returned.
314 verify_mesh_preq_len(struct ieee80211vap *vap,
315 const struct ieee80211_frame *wh, const uint8_t *iefrm)
319 if (iefrm[2] & IEEE80211_MESHPREQ_FLAGS_AE) {
320 /* Originator External Address present */
321 alloc_sz = IEEE80211_MESHPREQ_BASE_SZ_AE;
322 ndest = iefrm[IEEE80211_MESHPREQ_TCNT_OFFSET_AE];
324 /* w/o Originator External Address */
325 alloc_sz = IEEE80211_MESHPREQ_BASE_SZ;
326 ndest = iefrm[IEEE80211_MESHPREQ_TCNT_OFFSET];
328 alloc_sz += ndest * IEEE80211_MESHPREQ_TRGT_SZ;
330 if(iefrm[1] != (alloc_sz)) {
331 IEEE80211_DISCARD(vap,
332 IEEE80211_MSG_ACTION | IEEE80211_MSG_HWMP,
333 wh, NULL, "PREQ (AE=%s) with wrong len",
334 iefrm[2] & IEEE80211_MESHPREQ_FLAGS_AE ? "1" : "0");
341 * Verify the length of an HWMP PREP and returns 1 on success,
345 verify_mesh_prep_len(struct ieee80211vap *vap,
346 const struct ieee80211_frame *wh, const uint8_t *iefrm)
349 if (iefrm[2] & IEEE80211_MESHPREP_FLAGS_AE) {
350 if (iefrm[1] == IEEE80211_MESHPREP_BASE_SZ_AE)
351 alloc_sz = IEEE80211_MESHPREP_BASE_SZ_AE;
352 } else if (iefrm[1] == IEEE80211_MESHPREP_BASE_SZ)
353 alloc_sz = IEEE80211_MESHPREP_BASE_SZ;
355 IEEE80211_DISCARD(vap,
356 IEEE80211_MSG_ACTION | IEEE80211_MSG_HWMP,
357 wh, NULL, "PREP (AE=%s) with wrong len",
358 iefrm[2] & IEEE80211_MESHPREP_FLAGS_AE ? "1" : "0");
365 * Verify the length of an HWMP PERR and return the number
366 * of destinations >= 1, if verification fails -1 is returned.
369 verify_mesh_perr_len(struct ieee80211vap *vap,
370 const struct ieee80211_frame *wh, const uint8_t *iefrm)
373 const uint8_t *iefrm_t = iefrm;
374 uint8_t ndest = iefrm_t[IEEE80211_MESHPERR_NDEST_OFFSET];
377 if(ndest > IEEE80211_MESHPERR_MAXDEST) {
378 IEEE80211_DISCARD(vap,
379 IEEE80211_MSG_ACTION | IEEE80211_MSG_HWMP,
380 wh, NULL, "PERR with wrong number of destionat (>19), %u",
385 iefrm_t += IEEE80211_MESHPERR_NDEST_OFFSET + 1; /* flag is next field */
386 /* We need to check each destionation flag to know size */
387 for(i = 0; i<ndest; i++) {
388 if ((*iefrm_t) & IEEE80211_MESHPERR_FLAGS_AE)
389 iefrm_t += IEEE80211_MESHPERR_DEST_SZ_AE;
391 iefrm_t += IEEE80211_MESHPERR_DEST_SZ;
394 alloc_sz = (iefrm_t - iefrm) - 2; /* action + code */
395 if(alloc_sz != iefrm[1]) {
396 IEEE80211_DISCARD(vap,
397 IEEE80211_MSG_ACTION | IEEE80211_MSG_HWMP,
398 wh, NULL, "%s", "PERR with wrong len");
405 hwmp_recv_action_meshpath(struct ieee80211_node *ni,
406 const struct ieee80211_frame *wh,
407 const uint8_t *frm, const uint8_t *efrm)
409 struct ieee80211vap *vap = ni->ni_vap;
410 struct ieee80211_meshpreq_ie *preq;
411 struct ieee80211_meshprep_ie *prep;
412 struct ieee80211_meshperr_ie *perr;
413 struct ieee80211_meshrann_ie rann;
414 const uint8_t *iefrm = frm + 2; /* action + code */
415 const uint8_t *iefrm_t = iefrm; /* temporary pointer */
419 while (efrm - iefrm > 1) {
420 IEEE80211_VERIFY_LENGTH(efrm - iefrm, iefrm[1] + 2, return 0);
422 case IEEE80211_ELEMID_MESHPREQ:
427 ndest = verify_mesh_preq_len(vap, wh, iefrm_t);
429 vap->iv_stats.is_rx_mgtdiscard++;
432 preq = malloc(sizeof(*preq) +
433 (ndest - 1) * sizeof(*preq->preq_targets),
434 M_80211_MESH_PREQ, M_NOWAIT | M_ZERO);
435 KASSERT(preq != NULL, ("preq == NULL"));
437 preq->preq_ie = *iefrm_t++;
438 preq->preq_len = *iefrm_t++;
439 preq->preq_flags = *iefrm_t++;
440 preq->preq_hopcount = *iefrm_t++;
441 preq->preq_ttl = *iefrm_t++;
442 preq->preq_id = LE_READ_4(iefrm_t); iefrm_t += 4;
443 IEEE80211_ADDR_COPY(preq->preq_origaddr, iefrm_t);
445 preq->preq_origseq = LE_READ_4(iefrm_t); iefrm_t += 4;
446 /* NB: may have Originator Proxied Address */
447 if (preq->preq_flags & IEEE80211_MESHPREQ_FLAGS_AE) {
449 preq->preq_orig_ext_addr, iefrm_t);
452 preq->preq_lifetime = LE_READ_4(iefrm_t); iefrm_t += 4;
453 preq->preq_metric = LE_READ_4(iefrm_t); iefrm_t += 4;
454 preq->preq_tcount = *iefrm_t++;
456 for (i = 0; i < preq->preq_tcount; i++) {
457 preq->preq_targets[i].target_flags = *iefrm_t++;
459 preq->preq_targets[i].target_addr, iefrm_t);
461 preq->preq_targets[i].target_seq =
466 hwmp_recv_preq(vap, ni, wh, preq);
467 free(preq, M_80211_MESH_PREQ);
471 case IEEE80211_ELEMID_MESHPREP:
474 ndest = verify_mesh_prep_len(vap, wh, iefrm_t);
476 vap->iv_stats.is_rx_mgtdiscard++;
479 prep = malloc(sizeof(*prep),
480 M_80211_MESH_PREP, M_NOWAIT | M_ZERO);
481 KASSERT(prep != NULL, ("prep == NULL"));
483 prep->prep_ie = *iefrm_t++;
484 prep->prep_len = *iefrm_t++;
485 prep->prep_flags = *iefrm_t++;
486 prep->prep_hopcount = *iefrm_t++;
487 prep->prep_ttl = *iefrm_t++;
488 IEEE80211_ADDR_COPY(prep->prep_targetaddr, iefrm_t);
490 prep->prep_targetseq = LE_READ_4(iefrm_t); iefrm_t += 4;
491 /* NB: May have Target Proxied Address */
492 if (prep->prep_flags & IEEE80211_MESHPREP_FLAGS_AE) {
494 prep->prep_target_ext_addr, iefrm_t);
497 prep->prep_lifetime = LE_READ_4(iefrm_t); iefrm_t += 4;
498 prep->prep_metric = LE_READ_4(iefrm_t); iefrm_t += 4;
499 IEEE80211_ADDR_COPY(prep->prep_origaddr, iefrm_t);
501 prep->prep_origseq = LE_READ_4(iefrm_t); iefrm_t += 4;
503 hwmp_recv_prep(vap, ni, wh, prep);
504 free(prep, M_80211_MESH_PREP);
508 case IEEE80211_ELEMID_MESHPERR:
513 ndest = verify_mesh_perr_len(vap, wh, iefrm_t);
515 vap->iv_stats.is_rx_mgtdiscard++;
518 perr = malloc(sizeof(*perr) +
519 (ndest - 1) * sizeof(*perr->perr_dests),
520 M_80211_MESH_PERR, M_NOWAIT | M_ZERO);
521 KASSERT(perr != NULL, ("perr == NULL"));
523 perr->perr_ie = *iefrm_t++;
524 perr->perr_len = *iefrm_t++;
525 perr->perr_ttl = *iefrm_t++;
526 perr->perr_ndests = *iefrm_t++;
528 for (i = 0; i<perr->perr_ndests; i++) {
529 perr->perr_dests[i].dest_flags = *iefrm_t++;
531 perr->perr_dests[i].dest_addr, iefrm_t);
533 perr->perr_dests[i].dest_seq = LE_READ_4(iefrm_t);
535 /* NB: May have Target Proxied Address */
536 if (perr->perr_dests[i].dest_flags &
537 IEEE80211_MESHPERR_FLAGS_AE) {
539 perr->perr_dests[i].dest_ext_addr,
543 perr->perr_dests[i].dest_rcode =
548 hwmp_recv_perr(vap, ni, wh, perr);
549 free(perr, M_80211_MESH_PERR);
553 case IEEE80211_ELEMID_MESHRANN:
555 const struct ieee80211_meshrann_ie *mrann =
556 (const struct ieee80211_meshrann_ie *) iefrm;
557 if (mrann->rann_len !=
558 sizeof(struct ieee80211_meshrann_ie) - 2) {
559 IEEE80211_DISCARD(vap,
560 IEEE80211_MSG_ACTION | IEEE80211_MSG_HWMP,
561 wh, NULL, "%s", "RAN with wrong len");
562 vap->iv_stats.is_rx_mgtdiscard++;
565 memcpy(&rann, mrann, sizeof(rann));
566 rann.rann_seq = LE_READ_4(&mrann->rann_seq);
567 rann.rann_interval = LE_READ_4(&mrann->rann_interval);
568 rann.rann_metric = LE_READ_4(&mrann->rann_metric);
569 hwmp_recv_rann(vap, ni, wh, &rann);
574 iefrm += iefrm[1] + 2;
577 IEEE80211_DISCARD(vap,
578 IEEE80211_MSG_ACTION | IEEE80211_MSG_HWMP,
579 wh, NULL, "%s", "PATH SEL action without IE");
580 vap->iv_stats.is_rx_mgtdiscard++;
586 hwmp_send_action(struct ieee80211vap *vap,
587 const uint8_t da[IEEE80211_ADDR_LEN],
588 uint8_t *ie, size_t len)
590 struct ieee80211_node *ni;
591 struct ieee80211com *ic;
592 struct ieee80211_bpf_params params;
596 if (IEEE80211_IS_MULTICAST(da)) {
597 ni = ieee80211_ref_node(vap->iv_bss);
598 #ifdef IEEE80211_DEBUG_REFCNT
599 IEEE80211_DPRINTF(vap, IEEE80211_MSG_NODE,
600 "ieee80211_ref_node (%s:%u) %p<%s> refcnt %d\n",
602 ni, ether_sprintf(ni->ni_macaddr),
603 ieee80211_node_refcnt(ni)+1);
605 ieee80211_ref_node(ni);
608 ni = ieee80211_mesh_find_txnode(vap, da);
610 if (vap->iv_state == IEEE80211_S_CAC) {
611 IEEE80211_NOTE(vap, IEEE80211_MSG_OUTPUT, ni,
612 "block %s frame in CAC state", "HWMP action");
613 vap->iv_stats.is_tx_badstate++;
614 return EIO; /* XXX */
617 KASSERT(ni != NULL, ("null node"));
620 m = ieee80211_getmgtframe(&frm,
621 ic->ic_headroom + sizeof(struct ieee80211_frame),
622 sizeof(struct ieee80211_action) + len
625 ieee80211_free_node(ni);
626 vap->iv_stats.is_tx_nobuf++;
629 *frm++ = IEEE80211_ACTION_CAT_MESH;
630 *frm++ = IEEE80211_ACTION_MESH_HWMP;
632 case IEEE80211_ELEMID_MESHPREQ:
633 frm = hwmp_add_meshpreq(frm,
634 (struct ieee80211_meshpreq_ie *)ie);
636 case IEEE80211_ELEMID_MESHPREP:
637 frm = hwmp_add_meshprep(frm,
638 (struct ieee80211_meshprep_ie *)ie);
640 case IEEE80211_ELEMID_MESHPERR:
641 frm = hwmp_add_meshperr(frm,
642 (struct ieee80211_meshperr_ie *)ie);
644 case IEEE80211_ELEMID_MESHRANN:
645 frm = hwmp_add_meshrann(frm,
646 (struct ieee80211_meshrann_ie *)ie);
650 m->m_pkthdr.len = m->m_len = frm - mtod(m, uint8_t *);
651 M_PREPEND(m, sizeof(struct ieee80211_frame), M_NOWAIT);
653 ieee80211_free_node(ni);
654 vap->iv_stats.is_tx_nobuf++;
657 ieee80211_send_setup(ni, m,
658 IEEE80211_FC0_TYPE_MGT | IEEE80211_FC0_SUBTYPE_ACTION,
659 IEEE80211_NONQOS_TID, vap->iv_myaddr, da, vap->iv_myaddr);
661 m->m_flags |= M_ENCAP; /* mark encapsulated */
662 IEEE80211_NODE_STAT(ni, tx_mgmt);
664 memset(¶ms, 0, sizeof(params));
665 params.ibp_pri = WME_AC_VO;
666 params.ibp_rate0 = ni->ni_txparms->mgmtrate;
667 if (IEEE80211_IS_MULTICAST(da))
670 params.ibp_try0 = ni->ni_txparms->maxretry;
671 params.ibp_power = ni->ni_txpower;
672 return ic->ic_raw_xmit(ni, m, ¶ms);
675 #define ADDSHORT(frm, v) do { \
676 frm[0] = (v) & 0xff; \
680 #define ADDWORD(frm, v) do { \
681 LE_WRITE_4(frm, v); \
685 * Add a Mesh Path Request IE to a frame.
687 #define PREQ_TFLAGS(n) preq->preq_targets[n].target_flags
688 #define PREQ_TADDR(n) preq->preq_targets[n].target_addr
689 #define PREQ_TSEQ(n) preq->preq_targets[n].target_seq
691 hwmp_add_meshpreq(uint8_t *frm, const struct ieee80211_meshpreq_ie *preq)
695 *frm++ = IEEE80211_ELEMID_MESHPREQ;
696 *frm++ = preq->preq_len; /* len already calculated */
697 *frm++ = preq->preq_flags;
698 *frm++ = preq->preq_hopcount;
699 *frm++ = preq->preq_ttl;
700 ADDWORD(frm, preq->preq_id);
701 IEEE80211_ADDR_COPY(frm, preq->preq_origaddr); frm += 6;
702 ADDWORD(frm, preq->preq_origseq);
703 if (preq->preq_flags & IEEE80211_MESHPREQ_FLAGS_AE) {
704 IEEE80211_ADDR_COPY(frm, preq->preq_orig_ext_addr);
707 ADDWORD(frm, preq->preq_lifetime);
708 ADDWORD(frm, preq->preq_metric);
709 *frm++ = preq->preq_tcount;
710 for (i = 0; i < preq->preq_tcount; i++) {
711 *frm++ = PREQ_TFLAGS(i);
712 IEEE80211_ADDR_COPY(frm, PREQ_TADDR(i));
714 ADDWORD(frm, PREQ_TSEQ(i));
723 * Add a Mesh Path Reply IE to a frame.
726 hwmp_add_meshprep(uint8_t *frm, const struct ieee80211_meshprep_ie *prep)
728 *frm++ = IEEE80211_ELEMID_MESHPREP;
729 *frm++ = prep->prep_len; /* len already calculated */
730 *frm++ = prep->prep_flags;
731 *frm++ = prep->prep_hopcount;
732 *frm++ = prep->prep_ttl;
733 IEEE80211_ADDR_COPY(frm, prep->prep_targetaddr); frm += 6;
734 ADDWORD(frm, prep->prep_targetseq);
735 if (prep->prep_flags & IEEE80211_MESHPREP_FLAGS_AE) {
736 IEEE80211_ADDR_COPY(frm, prep->prep_target_ext_addr);
739 ADDWORD(frm, prep->prep_lifetime);
740 ADDWORD(frm, prep->prep_metric);
741 IEEE80211_ADDR_COPY(frm, prep->prep_origaddr); frm += 6;
742 ADDWORD(frm, prep->prep_origseq);
747 * Add a Mesh Path Error IE to a frame.
749 #define PERR_DFLAGS(n) perr->perr_dests[n].dest_flags
750 #define PERR_DADDR(n) perr->perr_dests[n].dest_addr
751 #define PERR_DSEQ(n) perr->perr_dests[n].dest_seq
752 #define PERR_EXTADDR(n) perr->perr_dests[n].dest_ext_addr
753 #define PERR_DRCODE(n) perr->perr_dests[n].dest_rcode
755 hwmp_add_meshperr(uint8_t *frm, const struct ieee80211_meshperr_ie *perr)
759 *frm++ = IEEE80211_ELEMID_MESHPERR;
760 *frm++ = perr->perr_len; /* len already calculated */
761 *frm++ = perr->perr_ttl;
762 *frm++ = perr->perr_ndests;
763 for (i = 0; i < perr->perr_ndests; i++) {
764 *frm++ = PERR_DFLAGS(i);
765 IEEE80211_ADDR_COPY(frm, PERR_DADDR(i));
767 ADDWORD(frm, PERR_DSEQ(i));
768 if (PERR_DFLAGS(i) & IEEE80211_MESHPERR_FLAGS_AE) {
769 IEEE80211_ADDR_COPY(frm, PERR_EXTADDR(i));
772 ADDSHORT(frm, PERR_DRCODE(i));
783 * Add a Root Annoucement IE to a frame.
786 hwmp_add_meshrann(uint8_t *frm, const struct ieee80211_meshrann_ie *rann)
788 *frm++ = IEEE80211_ELEMID_MESHRANN;
789 *frm++ = rann->rann_len;
790 *frm++ = rann->rann_flags;
791 *frm++ = rann->rann_hopcount;
792 *frm++ = rann->rann_ttl;
793 IEEE80211_ADDR_COPY(frm, rann->rann_addr); frm += 6;
794 ADDWORD(frm, rann->rann_seq);
795 ADDWORD(frm, rann->rann_interval);
796 ADDWORD(frm, rann->rann_metric);
801 hwmp_rootmode_setup(struct ieee80211vap *vap)
803 struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
804 struct ieee80211_mesh_state *ms = vap->iv_mesh;
806 switch (hs->hs_rootmode) {
807 case IEEE80211_HWMP_ROOTMODE_DISABLED:
808 callout_drain(&hs->hs_roottimer);
809 ms->ms_flags &= ~IEEE80211_MESHFLAGS_ROOT;
811 case IEEE80211_HWMP_ROOTMODE_NORMAL:
812 case IEEE80211_HWMP_ROOTMODE_PROACTIVE:
813 callout_reset(&hs->hs_roottimer, ieee80211_hwmp_rootint,
814 hwmp_rootmode_cb, vap);
815 ms->ms_flags |= IEEE80211_MESHFLAGS_ROOT;
817 case IEEE80211_HWMP_ROOTMODE_RANN:
818 callout_reset(&hs->hs_roottimer, ieee80211_hwmp_rannint,
819 hwmp_rootmode_rann_cb, vap);
820 ms->ms_flags |= IEEE80211_MESHFLAGS_ROOT;
826 * Send a broadcast Path Request to find all nodes on the mesh. We are
827 * called when the vap is configured as a HWMP root node.
829 #define PREQ_TFLAGS(n) preq.preq_targets[n].target_flags
830 #define PREQ_TADDR(n) preq.preq_targets[n].target_addr
831 #define PREQ_TSEQ(n) preq.preq_targets[n].target_seq
833 hwmp_rootmode_cb(void *arg)
835 struct ieee80211vap *vap = (struct ieee80211vap *)arg;
836 struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
837 struct ieee80211_mesh_state *ms = vap->iv_mesh;
838 struct ieee80211_meshpreq_ie preq;
840 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, vap->iv_bss,
841 "%s", "send broadcast PREQ");
844 if (ms->ms_flags & IEEE80211_MESHFLAGS_GATE)
845 preq.preq_flags |= IEEE80211_MESHPREQ_FLAGS_GATE;
846 if (hs->hs_rootmode == IEEE80211_HWMP_ROOTMODE_PROACTIVE)
847 preq.preq_flags |= IEEE80211_MESHPREQ_FLAGS_PP;
848 preq.preq_hopcount = 0;
849 preq.preq_ttl = ms->ms_ttl;
850 preq.preq_id = ++hs->hs_preqid;
851 IEEE80211_ADDR_COPY(preq.preq_origaddr, vap->iv_myaddr);
852 preq.preq_origseq = ++hs->hs_seq;
853 preq.preq_lifetime = ticks_to_msecs(ieee80211_hwmp_roottimeout);
854 preq.preq_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
855 preq.preq_tcount = 1;
856 IEEE80211_ADDR_COPY(PREQ_TADDR(0), broadcastaddr);
857 PREQ_TFLAGS(0) = IEEE80211_MESHPREQ_TFLAGS_TO |
858 IEEE80211_MESHPREQ_TFLAGS_USN;
860 vap->iv_stats.is_hwmp_rootreqs++;
861 /* NB: we enforce rate check ourself */
862 hwmp_send_preq(vap, broadcastaddr, &preq, NULL, NULL);
863 hwmp_rootmode_setup(vap);
870 * Send a Root Annoucement (RANN) to find all the nodes on the mesh. We are
871 * called when the vap is configured as a HWMP RANN root node.
874 hwmp_rootmode_rann_cb(void *arg)
876 struct ieee80211vap *vap = (struct ieee80211vap *)arg;
877 struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
878 struct ieee80211_mesh_state *ms = vap->iv_mesh;
879 struct ieee80211_meshrann_ie rann;
881 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, vap->iv_bss,
882 "%s", "send broadcast RANN");
885 if (ms->ms_flags & IEEE80211_MESHFLAGS_GATE)
886 rann.rann_flags |= IEEE80211_MESHFLAGS_GATE;
887 rann.rann_hopcount = 0;
888 rann.rann_ttl = ms->ms_ttl;
889 IEEE80211_ADDR_COPY(rann.rann_addr, vap->iv_myaddr);
890 rann.rann_seq = ++hs->hs_seq;
891 rann.rann_interval = ieee80211_hwmp_rannint;
892 rann.rann_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
894 vap->iv_stats.is_hwmp_rootrann++;
895 hwmp_send_rann(vap, broadcastaddr, &rann);
896 hwmp_rootmode_setup(vap);
900 * Update forwarding information to TA if metric improves.
903 hwmp_update_transmitter(struct ieee80211vap *vap, struct ieee80211_node *ni,
904 const char *hwmp_frame)
906 struct ieee80211_mesh_state *ms = vap->iv_mesh;
907 struct ieee80211_mesh_route *rttran = NULL; /* Transmitter */
910 rttran = ieee80211_mesh_rt_find(vap, ni->ni_macaddr);
911 if (rttran == NULL) {
912 rttran = ieee80211_mesh_rt_add(vap, ni->ni_macaddr);
913 if (rttran == NULL) {
914 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
915 "unable to add path to transmitter %6D of %s",
916 ni->ni_macaddr, ":", hwmp_frame);
917 vap->iv_stats.is_mesh_rtaddfailed++;
921 metric = ms->ms_pmetric->mpm_metric(ni);
922 if (!(rttran->rt_flags & IEEE80211_MESHRT_FLAGS_VALID) ||
923 rttran->rt_metric > metric)
925 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
926 "%s path to transmiter %6D of %s, metric %d:%d",
927 rttran->rt_flags & IEEE80211_MESHRT_FLAGS_VALID ?
928 "prefer" : "update", ni->ni_macaddr, ":", hwmp_frame,
929 rttran->rt_metric, metric);
930 IEEE80211_ADDR_COPY(rttran->rt_nexthop, ni->ni_macaddr);
931 rttran->rt_metric = metric;
932 rttran->rt_nhops = 1;
933 ieee80211_mesh_rt_update(rttran, ms->ms_ppath->mpp_inact);
934 rttran->rt_flags = IEEE80211_MESHRT_FLAGS_VALID;
938 #define PREQ_TFLAGS(n) preq->preq_targets[n].target_flags
939 #define PREQ_TADDR(n) preq->preq_targets[n].target_addr
940 #define PREQ_TSEQ(n) preq->preq_targets[n].target_seq
942 hwmp_recv_preq(struct ieee80211vap *vap, struct ieee80211_node *ni,
943 const struct ieee80211_frame *wh, const struct ieee80211_meshpreq_ie *preq)
945 struct ieee80211_mesh_state *ms = vap->iv_mesh;
946 struct ieee80211_mesh_route *rtorig = NULL;
947 struct ieee80211_mesh_route *rtorig_ext = NULL;
948 struct ieee80211_mesh_route *rttarg = NULL;
949 struct ieee80211_hwmp_route *hrorig = NULL;
950 struct ieee80211_hwmp_route *hrtarg = NULL;
951 struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
952 struct ieee80211_meshprep_ie prep;
953 ieee80211_hwmp_seq preqid; /* last seen preqid for orig */
957 * Ignore PREQs from us. Could happen because someone forward it
960 if (IEEE80211_ADDR_EQ(vap->iv_myaddr, preq->preq_origaddr))
963 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
964 "received PREQ, orig %6D, targ(0) %6D", preq->preq_origaddr, ":",
968 * Acceptance criteria: (if the PREQ is not for us or not broadcast,
969 * or an external mac address not proxied by us),
970 * AND forwarding is disabled, discard this PREQ.
972 rttarg = ieee80211_mesh_rt_find(vap, PREQ_TADDR(0));
973 if (!(ms->ms_flags & IEEE80211_MESHFLAGS_FWD) &&
974 (!IEEE80211_ADDR_EQ(vap->iv_myaddr, PREQ_TADDR(0)) ||
975 !IEEE80211_IS_MULTICAST(PREQ_TADDR(0)) ||
977 rttarg->rt_flags & IEEE80211_MESHRT_FLAGS_PROXY &&
978 IEEE80211_ADDR_EQ(vap->iv_myaddr, rttarg->rt_mesh_gate)))) {
979 IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_HWMP,
980 preq->preq_origaddr, NULL, "%s", "not accepting PREQ");
984 * Acceptance criteria: if unicast addressed
985 * AND no valid forwarding for Target of PREQ, discard this PREQ.
988 hrtarg = IEEE80211_MESH_ROUTE_PRIV(rttarg,
989 struct ieee80211_hwmp_route);
990 /* Address mode: ucast */
991 if(preq->preq_flags & IEEE80211_MESHPREQ_FLAGS_AM &&
993 !IEEE80211_ADDR_EQ(vap->iv_myaddr, PREQ_TADDR(0))) {
994 IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_HWMP,
995 preq->preq_origaddr, NULL,
996 "unicast addressed PREQ of unknown target %6D",
1003 rtorig = ieee80211_mesh_rt_find(vap, preq->preq_origaddr);
1004 if (rtorig == NULL) {
1005 rtorig = ieee80211_mesh_rt_add(vap, preq->preq_origaddr);
1006 if (rtorig == NULL) {
1007 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1008 "unable to add orig path to %6D",
1009 preq->preq_origaddr, ":");
1010 vap->iv_stats.is_mesh_rtaddfailed++;
1013 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1014 "adding originator %6D", preq->preq_origaddr, ":");
1016 hrorig = IEEE80211_MESH_ROUTE_PRIV(rtorig, struct ieee80211_hwmp_route);
1018 /* record last seen preqid */
1019 preqid = hrorig->hr_preqid;
1020 hrorig->hr_preqid = HWMP_SEQ_MAX(hrorig->hr_preqid, preq->preq_id);
1022 /* Data creation and update of forwarding information
1023 * according to Table 11C-8 for originator mesh STA.
1025 metric = preq->preq_metric + ms->ms_pmetric->mpm_metric(ni);
1026 if (HWMP_SEQ_GT(preq->preq_origseq, hrorig->hr_seq) ||
1027 (HWMP_SEQ_EQ(preq->preq_origseq, hrorig->hr_seq) &&
1028 metric < rtorig->rt_metric)) {
1029 hrorig->hr_seq = preq->preq_origseq;
1030 IEEE80211_ADDR_COPY(rtorig->rt_nexthop, wh->i_addr2);
1031 rtorig->rt_metric = metric;
1032 rtorig->rt_nhops = preq->preq_hopcount + 1;
1033 ieee80211_mesh_rt_update(rtorig, preq->preq_lifetime);
1034 /* Path to orig is valid now.
1035 * NB: we know it can't be Proxy, and if it is GATE
1036 * it will be marked below.
1038 rtorig->rt_flags = IEEE80211_MESHRT_FLAGS_VALID;
1039 } else if ((hrtarg != NULL &&
1040 !HWMP_SEQ_EQ(hrtarg->hr_seq, PREQ_TSEQ(0))) ||
1041 (rtorig->rt_flags & IEEE80211_MESHRT_FLAGS_VALID &&
1042 preqid >= preq->preq_id)) {
1043 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1044 "discard PREQ from %6D, old seqno %u <= %u,"
1045 " or old preqid %u < %u",
1046 preq->preq_origaddr, ":",
1047 preq->preq_origseq, hrorig->hr_seq,
1048 preq->preq_id, preqid);
1052 /* Update forwarding information to TA if metric improves. */
1053 hwmp_update_transmitter(vap, ni, "PREQ");
1056 * Check if the PREQ is addressed to us.
1057 * or a Proxy currently gated by us.
1059 if (IEEE80211_ADDR_EQ(vap->iv_myaddr, PREQ_TADDR(0)) ||
1060 (ms->ms_flags & IEEE80211_MESHFLAGS_GATE &&
1062 IEEE80211_ADDR_EQ(vap->iv_myaddr, rttarg->rt_mesh_gate) &&
1063 rttarg->rt_flags & IEEE80211_MESHRT_FLAGS_PROXY &&
1064 rttarg->rt_flags & IEEE80211_MESHRT_FLAGS_VALID)) {
1066 * When we are the target we shall update our own HWMP seq
1067 * number with max of (current and preq->seq) + 1
1069 hs->hs_seq = HWMP_SEQ_MAX(hs->hs_seq, PREQ_TSEQ(0)) + 1;
1071 prep.prep_flags = 0;
1072 prep.prep_hopcount = 0;
1073 prep.prep_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
1074 IEEE80211_ADDR_COPY(prep.prep_targetaddr, vap->iv_myaddr);
1075 if (rttarg != NULL && /* if NULL it means we are the target */
1076 rttarg->rt_flags & IEEE80211_MESHRT_FLAGS_PROXY) {
1077 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1078 "reply for proxy %6D", rttarg->rt_dest, ":");
1079 prep.prep_flags |= IEEE80211_MESHPREP_FLAGS_AE;
1080 IEEE80211_ADDR_COPY(prep.prep_target_ext_addr,
1082 /* update proxy seqno to HWMP seqno */
1083 rttarg->rt_ext_seq = hs->hs_seq;
1084 prep.prep_hopcount = rttarg->rt_nhops;
1085 prep.prep_metric = rttarg->rt_metric;
1086 IEEE80211_ADDR_COPY(prep.prep_targetaddr, rttarg->rt_mesh_gate);
1089 * Build and send a PREP frame.
1091 prep.prep_ttl = ms->ms_ttl;
1092 prep.prep_targetseq = hs->hs_seq;
1093 prep.prep_lifetime = preq->preq_lifetime;
1094 IEEE80211_ADDR_COPY(prep.prep_origaddr, preq->preq_origaddr);
1095 prep.prep_origseq = preq->preq_origseq;
1097 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1098 "reply to %6D", preq->preq_origaddr, ":");
1099 hwmp_send_prep(vap, wh->i_addr2, &prep);
1102 /* we may update our proxy information for the orig external */
1103 else if (preq->preq_flags & IEEE80211_MESHPREQ_FLAGS_AE) {
1105 ieee80211_mesh_rt_find(vap, preq->preq_orig_ext_addr);
1106 if (rtorig_ext == NULL) {
1107 rtorig_ext = ieee80211_mesh_rt_add(vap,
1108 preq->preq_orig_ext_addr);
1109 if (rtorig_ext == NULL) {
1110 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1111 "unable to add orig ext proxy to %6D",
1112 preq->preq_orig_ext_addr, ":");
1113 vap->iv_stats.is_mesh_rtaddfailed++;
1116 IEEE80211_ADDR_COPY(rtorig_ext->rt_mesh_gate,
1117 preq->preq_origaddr);
1119 rtorig_ext->rt_ext_seq = preq->preq_origseq;
1120 ieee80211_mesh_rt_update(rtorig_ext, preq->preq_lifetime);
1123 * Proactive PREQ: reply with a proactive PREP to the
1124 * root STA if requested.
1126 if (IEEE80211_ADDR_EQ(PREQ_TADDR(0), broadcastaddr) &&
1127 (PREQ_TFLAGS(0) & IEEE80211_MESHPREQ_TFLAGS_TO)) {
1128 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1129 "root mesh station @ %6D", preq->preq_origaddr, ":");
1131 /* Check if root is a mesh gate, mark it */
1132 if (preq->preq_flags & IEEE80211_MESHPREQ_FLAGS_GATE) {
1133 struct ieee80211_mesh_gate_route *gr;
1135 rtorig->rt_flags |= IEEE80211_MESHRT_FLAGS_GATE;
1136 gr = ieee80211_mesh_mark_gate(vap, preq->preq_origaddr,
1138 gr->gr_lastseq = 0; /* NOT GANN */
1142 * Reply with a PREP if we don't have a path to the root
1143 * or if the root sent us a proactive PREQ.
1145 if ((rtorig->rt_flags & IEEE80211_MESHRT_FLAGS_VALID) == 0 ||
1146 (preq->preq_flags & IEEE80211_MESHPREQ_FLAGS_PP)) {
1147 prep.prep_flags = 0;
1148 prep.prep_hopcount = 0;
1149 prep.prep_ttl = ms->ms_ttl;
1150 IEEE80211_ADDR_COPY(prep.prep_origaddr,
1151 preq->preq_origaddr);
1152 prep.prep_origseq = preq->preq_origseq;
1153 prep.prep_lifetime = preq->preq_lifetime;
1154 prep.prep_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
1155 IEEE80211_ADDR_COPY(prep.prep_targetaddr,
1157 prep.prep_targetseq = ++hs->hs_seq;
1158 hwmp_send_prep(vap, rtorig->rt_nexthop, &prep);
1163 * Forwarding and Intermediate reply for PREQs with 1 target.
1165 if ((preq->preq_tcount == 1) && (preq->preq_ttl > 1) &&
1166 (ms->ms_flags & IEEE80211_MESHFLAGS_FWD)) {
1167 struct ieee80211_meshpreq_ie ppreq; /* propagated PREQ */
1169 memcpy(&ppreq, preq, sizeof(ppreq));
1172 * We have a valid route to this node.
1173 * NB: if target is proxy dont reply.
1175 if (rttarg != NULL &&
1176 rttarg->rt_flags & IEEE80211_MESHRT_FLAGS_VALID &&
1177 !(rttarg->rt_flags & IEEE80211_MESHRT_FLAGS_PROXY)) {
1179 * Check if we can send an intermediate Path Reply,
1180 * i.e., Target Only bit is not set and target is not
1181 * the MAC broadcast address.
1183 if (!(PREQ_TFLAGS(0) & IEEE80211_MESHPREQ_TFLAGS_TO) &&
1184 !IEEE80211_ADDR_EQ(PREQ_TADDR(0), broadcastaddr)) {
1185 struct ieee80211_meshprep_ie prep;
1187 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1188 "intermediate reply for PREQ from %6D",
1189 preq->preq_origaddr, ":");
1190 prep.prep_flags = 0;
1191 prep.prep_hopcount = rttarg->rt_nhops;
1192 prep.prep_ttl = ms->ms_ttl;
1193 IEEE80211_ADDR_COPY(&prep.prep_targetaddr,
1195 prep.prep_targetseq = hrtarg->hr_seq;
1196 prep.prep_lifetime = preq->preq_lifetime;
1197 prep.prep_metric =rttarg->rt_metric;
1198 IEEE80211_ADDR_COPY(&prep.prep_origaddr,
1199 preq->preq_origaddr);
1200 prep.prep_origseq = hrorig->hr_seq;
1201 hwmp_send_prep(vap, rtorig->rt_nexthop, &prep);
1204 * Set TO and unset RF bits because we have
1207 ppreq.preq_targets[0].target_flags |=
1208 IEEE80211_MESHPREQ_TFLAGS_TO;
1212 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1213 "forward PREQ from %6D",
1214 preq->preq_origaddr, ":");
1215 ppreq.preq_hopcount += 1;
1216 ppreq.preq_ttl -= 1;
1217 ppreq.preq_metric += ms->ms_pmetric->mpm_metric(ni);
1219 /* don't do PREQ ratecheck when we propagate */
1220 hwmp_send_preq(vap, broadcastaddr, &ppreq, NULL, NULL);
1228 hwmp_send_preq(struct ieee80211vap *vap,
1229 const uint8_t da[IEEE80211_ADDR_LEN],
1230 struct ieee80211_meshpreq_ie *preq,
1231 struct timeval *last, struct timeval *minint)
1235 * Enforce PREQ interval.
1236 * NB: Proactive ROOT PREQs rate is handled by cb task.
1238 if (last != NULL && minint != NULL) {
1239 if (ratecheck(last, minint) == 0)
1240 return EALREADY; /* XXX: we should postpone */
1241 getmicrouptime(last);
1245 * mesh preq action frame format
1251 * [tlv] mesh path request
1253 preq->preq_ie = IEEE80211_ELEMID_MESHPREQ;
1254 preq->preq_len = (preq->preq_flags & IEEE80211_MESHPREQ_FLAGS_AE ?
1255 IEEE80211_MESHPREQ_BASE_SZ_AE : IEEE80211_MESHPREQ_BASE_SZ) +
1256 preq->preq_tcount * IEEE80211_MESHPREQ_TRGT_SZ;
1257 return hwmp_send_action(vap, da, (uint8_t *)preq, preq->preq_len+2);
1261 hwmp_recv_prep(struct ieee80211vap *vap, struct ieee80211_node *ni,
1262 const struct ieee80211_frame *wh, const struct ieee80211_meshprep_ie *prep)
1264 #define IS_PROXY(rt) (rt->rt_flags & IEEE80211_MESHRT_FLAGS_PROXY)
1265 #define PROXIED_BY_US(rt) \
1266 (IEEE80211_ADDR_EQ(vap->iv_myaddr, rt->rt_mesh_gate))
1267 struct ieee80211_mesh_state *ms = vap->iv_mesh;
1268 struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
1269 struct ieee80211_mesh_route *rt = NULL;
1270 struct ieee80211_mesh_route *rtorig = NULL;
1271 struct ieee80211_mesh_route *rtext = NULL;
1272 struct ieee80211_hwmp_route *hr;
1273 struct ieee80211com *ic = vap->iv_ic;
1274 struct ifnet *ifp = vap->iv_ifp;
1275 struct mbuf *m, *next;
1276 uint32_t metric = 0;
1277 const uint8_t *addr;
1279 struct ieee80211_node *ni_encap;
1281 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1282 "received PREP, orig %6D, targ %6D", prep->prep_origaddr, ":",
1283 prep->prep_targetaddr, ":");
1286 * Acceptance criteria: (If the corresponding PREP was not generated
1287 * by us OR not generated by an external mac that is not proxied by us)
1288 * AND forwarding is disabled, discard this PREP.
1290 rtorig = ieee80211_mesh_rt_find(vap, prep->prep_origaddr);
1291 if ((!IEEE80211_ADDR_EQ(vap->iv_myaddr, prep->prep_origaddr) ||
1292 (rtorig != NULL && IS_PROXY(rtorig) && !PROXIED_BY_US(rtorig))) &&
1293 !(ms->ms_flags & IEEE80211_MESHFLAGS_FWD)){
1294 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1295 "discard PREP, orig(%6D) not proxied or generated by us",
1296 prep->prep_origaddr, ":");
1303 * If accepted shall create or update the active forwarding information
1304 * it maintains for the target mesh STA of the PREP (according to the
1305 * rules defined in 13.10.8.4). If the conditions for creating or
1306 * updating the forwarding information have not been met in those
1307 * rules, no further steps are applied to the PREP.
1309 rt = ieee80211_mesh_rt_find(vap, prep->prep_targetaddr);
1311 rt = ieee80211_mesh_rt_add(vap, prep->prep_targetaddr);
1313 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1314 "unable to add PREP path to %6D",
1315 prep->prep_targetaddr, ":");
1316 vap->iv_stats.is_mesh_rtaddfailed++;
1319 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1320 "adding target %6D", prep->prep_targetaddr, ":");
1322 hr = IEEE80211_MESH_ROUTE_PRIV(rt, struct ieee80211_hwmp_route);
1323 /* update path metric */
1324 metric = prep->prep_metric + ms->ms_pmetric->mpm_metric(ni);
1325 if ((rt->rt_flags & IEEE80211_MESHRT_FLAGS_VALID)) {
1326 if (HWMP_SEQ_LT(prep->prep_targetseq, hr->hr_seq)) {
1327 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1328 "discard PREP from %6D, old seq no %u < %u",
1329 prep->prep_targetaddr, ":",
1330 prep->prep_targetseq, hr->hr_seq);
1332 } else if (HWMP_SEQ_LEQ(prep->prep_targetseq, hr->hr_seq) &&
1333 metric > rt->rt_metric) {
1334 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1335 "discard PREP from %6D, new metric %u > %u",
1336 prep->prep_targetaddr, ":",
1337 metric, rt->rt_metric);
1342 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1343 "%s path to %6D, hopcount %d:%d metric %d:%d",
1344 rt->rt_flags & IEEE80211_MESHRT_FLAGS_VALID ?
1345 "prefer" : "update",
1346 prep->prep_targetaddr, ":",
1347 rt->rt_nhops, prep->prep_hopcount + 1,
1348 rt->rt_metric, metric);
1350 hr->hr_seq = prep->prep_targetseq;
1351 hr->hr_preqretries = 0;
1352 IEEE80211_ADDR_COPY(rt->rt_nexthop, ni->ni_macaddr);
1353 rt->rt_metric = metric;
1354 rt->rt_nhops = prep->prep_hopcount + 1;
1355 ieee80211_mesh_rt_update(rt, prep->prep_lifetime);
1356 if (rt->rt_flags & IEEE80211_MESHRT_FLAGS_DISCOVER) {
1357 /* discovery complete */
1358 rt->rt_flags &= ~IEEE80211_MESHRT_FLAGS_DISCOVER;
1360 rt->rt_flags |= IEEE80211_MESHRT_FLAGS_VALID; /* mark valid */
1362 /* Update forwarding information to TA if metric improves */
1363 hwmp_update_transmitter(vap, ni, "PREP");
1366 * If it's NOT for us, propagate the PREP
1368 if (!IEEE80211_ADDR_EQ(vap->iv_myaddr, prep->prep_origaddr) &&
1369 prep->prep_ttl > 1 &&
1370 prep->prep_hopcount < hs->hs_maxhops) {
1371 struct ieee80211_meshprep_ie pprep; /* propagated PREP */
1373 * NB: We should already have setup the path to orig
1374 * mesh STA when we propagated PREQ to target mesh STA,
1375 * no PREP is generated without a corresponding PREQ.
1376 * XXX: for now just ignore.
1378 if (rtorig == NULL) {
1379 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1380 "received PREP for an unknown orig(%6D)",
1381 prep->prep_origaddr, ":");
1385 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1386 "propagate PREP from %6D",
1387 prep->prep_targetaddr, ":");
1389 memcpy(&pprep, prep, sizeof(pprep));
1390 pprep.prep_hopcount += 1;
1391 pprep.prep_ttl -= 1;
1392 pprep.prep_metric += ms->ms_pmetric->mpm_metric(ni);
1393 hwmp_send_prep(vap, rtorig->rt_nexthop, &pprep);
1395 /* precursor list for the Target Mesh STA Address is updated */
1399 * Check if we received a PREP w/ AE and store target external address.
1400 * We may store target external address if recevied PREP w/ AE
1401 * and we are not final destination
1403 if (prep->prep_flags & IEEE80211_MESHPREP_FLAGS_AE) {
1404 rtext = ieee80211_mesh_rt_find(vap,
1405 prep->prep_target_ext_addr);
1406 if (rtext == NULL) {
1407 rtext = ieee80211_mesh_rt_add(vap,
1408 prep->prep_target_ext_addr);
1409 if (rtext == NULL) {
1410 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1411 "unable to add PREP path to proxy %6D",
1412 prep->prep_targetaddr, ":");
1413 vap->iv_stats.is_mesh_rtaddfailed++;
1417 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1418 "%s path to %6D, hopcount %d:%d metric %d:%d",
1419 rtext->rt_flags & IEEE80211_MESHRT_FLAGS_VALID ?
1420 "prefer" : "update",
1421 prep->prep_target_ext_addr, ":",
1422 rtext->rt_nhops, prep->prep_hopcount + 1,
1423 rtext->rt_metric, metric);
1425 rtext->rt_flags = IEEE80211_MESHRT_FLAGS_PROXY |
1426 IEEE80211_MESHRT_FLAGS_VALID;
1427 IEEE80211_ADDR_COPY(rtext->rt_dest,
1428 prep->prep_target_ext_addr);
1429 IEEE80211_ADDR_COPY(rtext->rt_mesh_gate,
1430 prep->prep_targetaddr);
1431 IEEE80211_ADDR_COPY(rtext->rt_nexthop, wh->i_addr2);
1432 rtext->rt_metric = metric;
1433 rtext->rt_lifetime = prep->prep_lifetime;
1434 rtext->rt_nhops = prep->prep_hopcount + 1;
1435 rtext->rt_ext_seq = prep->prep_origseq; /* new proxy seq */
1437 * XXX: proxy entries have no HWMP priv data,
1438 * nullify them to be sure?
1442 * Check for frames queued awaiting path discovery.
1443 * XXX probably can tell exactly and avoid remove call
1444 * NB: hash may have false matches, if so they will get
1445 * stuck back on the stageq because there won't be
1448 addr = prep->prep_flags & IEEE80211_MESHPREP_FLAGS_AE ?
1449 prep->prep_target_ext_addr : prep->prep_targetaddr;
1450 m = ieee80211_ageq_remove(&ic->ic_stageq,
1451 (struct ieee80211_node *)(uintptr_t)
1452 ieee80211_mac_hash(ic, addr)); /* either dest or ext_dest */
1453 for (; m != NULL; m = next) {
1454 is_encap = !! (m->m_flags & M_ENCAP);
1455 ni_encap = (struct ieee80211_node *) m->m_pkthdr.rcvif;
1456 next = m->m_nextpkt;
1457 m->m_nextpkt = NULL;
1458 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1459 "flush queued frame %p len %d", m, m->m_pkthdr.len);
1462 * If the mbuf has M_ENCAP set, ensure we free it.
1463 * Note that after if_transmit() is called, m is invalid.
1465 if (ifp->if_transmit(ifp, m) != 0) {
1467 ieee80211_free_node(ni_encap);
1471 #undef PROXIED_BY_US
1475 hwmp_send_prep(struct ieee80211vap *vap,
1476 const uint8_t da[IEEE80211_ADDR_LEN],
1477 struct ieee80211_meshprep_ie *prep)
1479 /* NB: there's no PREP minimum interval. */
1482 * mesh prep action frame format
1488 * [tlv] mesh path reply
1490 prep->prep_ie = IEEE80211_ELEMID_MESHPREP;
1491 prep->prep_len = prep->prep_flags & IEEE80211_MESHPREP_FLAGS_AE ?
1492 IEEE80211_MESHPREP_BASE_SZ_AE : IEEE80211_MESHPREP_BASE_SZ;
1493 return hwmp_send_action(vap, da, (uint8_t *)prep, prep->prep_len + 2);
1496 #define PERR_DFLAGS(n) perr.perr_dests[n].dest_flags
1497 #define PERR_DADDR(n) perr.perr_dests[n].dest_addr
1498 #define PERR_DSEQ(n) perr.perr_dests[n].dest_seq
1499 #define PERR_DRCODE(n) perr.perr_dests[n].dest_rcode
1501 hwmp_peerdown(struct ieee80211_node *ni)
1503 struct ieee80211vap *vap = ni->ni_vap;
1504 struct ieee80211_mesh_state *ms = vap->iv_mesh;
1505 struct ieee80211_meshperr_ie perr;
1506 struct ieee80211_mesh_route *rt;
1507 struct ieee80211_hwmp_route *hr;
1509 rt = ieee80211_mesh_rt_find(vap, ni->ni_macaddr);
1512 hr = IEEE80211_MESH_ROUTE_PRIV(rt, struct ieee80211_hwmp_route);
1513 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1514 "%s", "delete route entry");
1515 perr.perr_ttl = ms->ms_ttl;
1516 perr.perr_ndests = 1;
1518 if (hr->hr_seq == 0)
1519 PERR_DFLAGS(0) |= IEEE80211_MESHPERR_DFLAGS_USN;
1520 PERR_DFLAGS(0) |= IEEE80211_MESHPERR_DFLAGS_RC;
1521 IEEE80211_ADDR_COPY(PERR_DADDR(0), rt->rt_dest);
1522 PERR_DSEQ(0) = ++hr->hr_seq;
1523 PERR_DRCODE(0) = IEEE80211_REASON_MESH_PERR_DEST_UNREACH;
1524 /* NB: flush everything passing through peer */
1525 ieee80211_mesh_rt_flush_peer(vap, ni->ni_macaddr);
1526 hwmp_send_perr(vap, broadcastaddr, &perr);
1533 #define PERR_DFLAGS(n) perr->perr_dests[n].dest_flags
1534 #define PERR_DADDR(n) perr->perr_dests[n].dest_addr
1535 #define PERR_DSEQ(n) perr->perr_dests[n].dest_seq
1536 #define PERR_DEXTADDR(n) perr->perr_dests[n].dest_ext_addr
1537 #define PERR_DRCODE(n) perr->perr_dests[n].dest_rcode
1539 hwmp_recv_perr(struct ieee80211vap *vap, struct ieee80211_node *ni,
1540 const struct ieee80211_frame *wh, const struct ieee80211_meshperr_ie *perr)
1542 struct ieee80211_mesh_state *ms = vap->iv_mesh;
1543 struct ieee80211_mesh_route *rt = NULL;
1544 struct ieee80211_mesh_route *rt_ext = NULL;
1545 struct ieee80211_hwmp_route *hr;
1546 struct ieee80211_meshperr_ie *pperr = NULL;
1547 int i, j = 0, forward = 0;
1549 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1550 "received PERR from %6D", wh->i_addr2, ":");
1553 * if forwarding is true, prepare pperr
1555 if (ms->ms_flags & IEEE80211_MESHFLAGS_FWD) {
1557 pperr = malloc(sizeof(*perr) + 31*sizeof(*perr->perr_dests),
1558 M_80211_MESH_PERR, M_NOWAIT); /* XXX: magic number, 32 err dests */
1562 * Acceptance criteria: check if we have forwarding information
1563 * stored about destination, and that nexthop == TA of this PERR.
1564 * NB: we also build a new PERR to propagate in case we should forward.
1566 for (i = 0; i < perr->perr_ndests; i++) {
1567 rt = ieee80211_mesh_rt_find(vap, PERR_DADDR(i));
1570 if (!IEEE80211_ADDR_EQ(rt->rt_nexthop, wh->i_addr2))
1573 /* found and accepted a PERR ndest element, process it... */
1575 memcpy(&pperr->perr_dests[j], &perr->perr_dests[i],
1576 sizeof(*perr->perr_dests));
1577 hr = IEEE80211_MESH_ROUTE_PRIV(rt, struct ieee80211_hwmp_route);
1578 switch(PERR_DFLAGS(i)) {
1579 case (IEEE80211_REASON_MESH_PERR_NO_FI):
1580 if (PERR_DSEQ(i) == 0) {
1583 pperr->perr_dests[j].dest_seq =
1587 hr->hr_seq = PERR_DSEQ(i);
1589 rt->rt_flags &= ~IEEE80211_MESHRT_FLAGS_VALID;
1592 case (IEEE80211_REASON_MESH_PERR_DEST_UNREACH):
1593 if(HWMP_SEQ_GT(PERR_DSEQ(i), hr->hr_seq)) {
1594 hr->hr_seq = PERR_DSEQ(i);
1595 rt->rt_flags &= ~IEEE80211_MESHRT_FLAGS_VALID;
1599 case (IEEE80211_REASON_MESH_PERR_NO_PROXY):
1600 rt_ext = ieee80211_mesh_rt_find(vap, PERR_DEXTADDR(i));
1601 if (rt_ext != NULL) {
1603 ~IEEE80211_MESHRT_FLAGS_VALID;
1608 IEEE80211_DISCARD(vap, IEEE80211_MSG_HWMP, wh, NULL,
1609 "PERR, unknown reason code %u\n", PERR_DFLAGS(i));
1610 goto done; /* XXX: stats?? */
1612 ieee80211_mesh_rt_flush_peer(vap, PERR_DADDR(i));
1613 KASSERT(j < 32, ("PERR, error ndest >= 32 (%u)", j));
1616 IEEE80211_DISCARD(vap, IEEE80211_MSG_HWMP, wh, NULL, "%s",
1617 "PERR not accepted");
1618 goto done; /* XXX: stats?? */
1622 * Propagate the PERR if we previously found it on our routing table.
1624 if (forward && perr->perr_ttl > 1) {
1625 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP, ni,
1626 "propagate PERR from %6D", wh->i_addr2, ":");
1627 pperr->perr_ndests = j;
1629 hwmp_send_perr(vap, broadcastaddr, pperr);
1633 free(pperr, M_80211_MESH_PERR);
1638 #undef PERR_DEXTADDR
1642 hwmp_send_perr(struct ieee80211vap *vap,
1643 const uint8_t da[IEEE80211_ADDR_LEN],
1644 struct ieee80211_meshperr_ie *perr)
1646 struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
1651 * Enforce PERR interval.
1653 if (ratecheck(&hs->hs_lastperr, &ieee80211_hwmp_perrminint) == 0)
1655 getmicrouptime(&hs->hs_lastperr);
1658 * mesh perr action frame format
1664 * [tlv] mesh path error
1666 perr->perr_ie = IEEE80211_ELEMID_MESHPERR;
1667 length = IEEE80211_MESHPERR_BASE_SZ;
1668 for (i = 0; i<perr->perr_ndests; i++) {
1669 if (perr->perr_dests[i].dest_flags &
1670 IEEE80211_MESHPERR_FLAGS_AE) {
1671 length += IEEE80211_MESHPERR_DEST_SZ_AE;
1674 length += IEEE80211_MESHPERR_DEST_SZ;
1676 perr->perr_len =length;
1677 return hwmp_send_action(vap, da, (uint8_t *)perr, perr->perr_len+2);
1681 * Called from the rest of the net80211 code (mesh code for example).
1682 * NB: IEEE80211_REASON_MESH_PERR_DEST_UNREACH can be trigger by the fact that
1683 * a mesh STA is unable to forward an MSDU/MMPDU to a next-hop mesh STA.
1685 #define PERR_DFLAGS(n) perr.perr_dests[n].dest_flags
1686 #define PERR_DADDR(n) perr.perr_dests[n].dest_addr
1687 #define PERR_DSEQ(n) perr.perr_dests[n].dest_seq
1688 #define PERR_DEXTADDR(n) perr.perr_dests[n].dest_ext_addr
1689 #define PERR_DRCODE(n) perr.perr_dests[n].dest_rcode
1691 hwmp_senderror(struct ieee80211vap *vap,
1692 const uint8_t addr[IEEE80211_ADDR_LEN],
1693 struct ieee80211_mesh_route *rt, int rcode)
1695 struct ieee80211_mesh_state *ms = vap->iv_mesh;
1696 struct ieee80211_hwmp_route *hr = NULL;
1697 struct ieee80211_meshperr_ie perr;
1700 hr = IEEE80211_MESH_ROUTE_PRIV(rt,
1701 struct ieee80211_hwmp_route);
1703 perr.perr_ndests = 1;
1704 perr.perr_ttl = ms->ms_ttl;
1706 PERR_DRCODE(0) = rcode;
1709 case IEEE80211_REASON_MESH_PERR_NO_FI:
1710 IEEE80211_ADDR_COPY(PERR_DADDR(0), addr);
1711 PERR_DSEQ(0) = 0; /* reserved */
1713 case IEEE80211_REASON_MESH_PERR_NO_PROXY:
1714 KASSERT(rt != NULL, ("no proxy info for sending PERR"));
1715 KASSERT(rt->rt_flags & IEEE80211_MESHRT_FLAGS_PROXY,
1716 ("route is not marked proxy"));
1717 PERR_DFLAGS(0) |= IEEE80211_MESHPERR_FLAGS_AE;
1718 IEEE80211_ADDR_COPY(PERR_DADDR(0), vap->iv_myaddr);
1719 PERR_DSEQ(0) = rt->rt_ext_seq;
1720 IEEE80211_ADDR_COPY(PERR_DEXTADDR(0), addr);
1722 case IEEE80211_REASON_MESH_PERR_DEST_UNREACH:
1723 KASSERT(rt != NULL, ("no route info for sending PERR"));
1724 IEEE80211_ADDR_COPY(PERR_DADDR(0), addr);
1725 PERR_DSEQ(0) = hr->hr_seq;
1728 KASSERT(0, ("unknown reason code for HWMP PERR (%u)", rcode));
1730 hwmp_send_perr(vap, broadcastaddr, &perr);
1735 #undef PERR_DEXTADDR
1739 hwmp_recv_rann(struct ieee80211vap *vap, struct ieee80211_node *ni,
1740 const struct ieee80211_frame *wh, const struct ieee80211_meshrann_ie *rann)
1742 struct ieee80211_mesh_state *ms = vap->iv_mesh;
1743 struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
1744 struct ieee80211_mesh_route *rt = NULL;
1745 struct ieee80211_hwmp_route *hr;
1746 struct ieee80211_meshpreq_ie preq;
1747 struct ieee80211_meshrann_ie prann;
1748 uint32_t metric = 0;
1750 if (IEEE80211_ADDR_EQ(rann->rann_addr, vap->iv_myaddr))
1753 rt = ieee80211_mesh_rt_find(vap, rann->rann_addr);
1754 if (rt != NULL && rt->rt_flags & IEEE80211_MESHRT_FLAGS_VALID) {
1755 hr = IEEE80211_MESH_ROUTE_PRIV(rt, struct ieee80211_hwmp_route);
1757 /* Acceptance criteria: if RANN.seq < stored seq, discard RANN */
1758 if (HWMP_SEQ_LT(rann->rann_seq, hr->hr_seq)) {
1759 IEEE80211_DISCARD(vap, IEEE80211_MSG_HWMP, wh, NULL,
1760 "RANN seq %u < %u", rann->rann_seq, hr->hr_seq);
1764 /* Acceptance criteria: if RANN.seq == stored seq AND
1765 * RANN.metric > stored metric, discard RANN */
1766 if (HWMP_SEQ_EQ(rann->rann_seq, hr->hr_seq) &&
1767 rann->rann_metric > rt->rt_metric) {
1768 IEEE80211_DISCARD(vap, IEEE80211_MSG_HWMP, wh, NULL,
1769 "RANN metric %u > %u", rann->rann_metric, rt->rt_metric);
1776 ieee80211_hwmp_rannint = rann->rann_interval; /* XXX: mtx lock? */
1777 metric = rann->rann_metric + ms->ms_pmetric->mpm_metric(ni);
1780 rt = ieee80211_mesh_rt_add(vap, rann->rann_addr);
1782 IEEE80211_DISCARD(vap, IEEE80211_MSG_HWMP, wh, NULL,
1783 "unable to add mac for RANN root %6D",
1784 rann->rann_addr, ":");
1785 vap->iv_stats.is_mesh_rtaddfailed++;
1789 hr = IEEE80211_MESH_ROUTE_PRIV(rt, struct ieee80211_hwmp_route);
1790 /* Check if root is a mesh gate, mark it */
1791 if (rann->rann_flags & IEEE80211_MESHRANN_FLAGS_GATE) {
1792 struct ieee80211_mesh_gate_route *gr;
1794 rt->rt_flags |= IEEE80211_MESHRT_FLAGS_GATE;
1795 gr = ieee80211_mesh_mark_gate(vap, rann->rann_addr,
1797 gr->gr_lastseq = 0; /* NOT GANN */
1799 /* discovery timeout */
1800 ieee80211_mesh_rt_update(rt,
1801 ticks_to_msecs(ieee80211_hwmp_roottimeout));
1803 preq.preq_flags = IEEE80211_MESHPREQ_FLAGS_AM;
1804 preq.preq_hopcount = 0;
1805 preq.preq_ttl = ms->ms_ttl;
1806 preq.preq_id = 0; /* reserved */
1807 IEEE80211_ADDR_COPY(preq.preq_origaddr, vap->iv_myaddr);
1808 preq.preq_origseq = ++hs->hs_seq;
1809 preq.preq_lifetime = ieee80211_hwmp_roottimeout;
1810 preq.preq_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
1811 preq.preq_tcount = 1;
1812 preq.preq_targets[0].target_flags = IEEE80211_MESHPREQ_TFLAGS_TO;
1813 /* NB: IEEE80211_MESHPREQ_TFLAGS_USN = 0 implicitly implied */
1814 IEEE80211_ADDR_COPY(preq.preq_targets[0].target_addr, rann->rann_addr);
1815 preq.preq_targets[0].target_seq = rann->rann_seq;
1816 /* XXX: if rootconfint have not passed, we built this preq in vain */
1817 hwmp_send_preq(vap, wh->i_addr2, &preq, &hr->hr_lastrootconf,
1818 &ieee80211_hwmp_rootconfint);
1820 /* propagate a RANN */
1821 if (rt->rt_flags & IEEE80211_MESHRT_FLAGS_VALID &&
1822 rann->rann_ttl > 1 &&
1823 ms->ms_flags & IEEE80211_MESHFLAGS_FWD) {
1824 hr->hr_seq = rann->rann_seq;
1825 memcpy(&prann, rann, sizeof(prann));
1826 prann.rann_hopcount += 1;
1827 prann.rann_ttl -= 1;
1828 prann.rann_metric += ms->ms_pmetric->mpm_metric(ni);
1829 hwmp_send_rann(vap, broadcastaddr, &prann);
1834 hwmp_send_rann(struct ieee80211vap *vap,
1835 const uint8_t da[IEEE80211_ADDR_LEN],
1836 struct ieee80211_meshrann_ie *rann)
1839 * mesh rann action frame format
1845 * [tlv] root annoucement
1847 rann->rann_ie = IEEE80211_ELEMID_MESHRANN;
1848 rann->rann_len = IEEE80211_MESHRANN_BASE_SZ;
1849 return hwmp_send_action(vap, da, (uint8_t *)rann, rann->rann_len + 2);
1852 #define PREQ_TFLAGS(n) preq.preq_targets[n].target_flags
1853 #define PREQ_TADDR(n) preq.preq_targets[n].target_addr
1854 #define PREQ_TSEQ(n) preq.preq_targets[n].target_seq
1856 hwmp_rediscover_cb(void *arg)
1858 struct ieee80211_mesh_route *rt = arg;
1859 struct ieee80211vap *vap = rt->rt_vap;
1860 struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
1861 struct ieee80211_mesh_state *ms = vap->iv_mesh;
1862 struct ieee80211_hwmp_route *hr;
1863 struct ieee80211_meshpreq_ie preq; /* Optimize: storing first preq? */
1865 if ((rt->rt_flags & IEEE80211_MESHRT_FLAGS_VALID))
1866 return ; /* nothing to do */
1868 hr = IEEE80211_MESH_ROUTE_PRIV(rt, struct ieee80211_hwmp_route);
1869 if (hr->hr_preqretries >=
1870 ieee80211_hwmp_maxpreq_retries) {
1871 IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_ANY,
1873 "max number of discovery, send queued frames to GATE");
1874 ieee80211_mesh_forward_to_gates(vap, rt);
1875 vap->iv_stats.is_mesh_fwd_nopath++;
1876 return ; /* XXX: flush queue? */
1879 hr->hr_preqretries++;
1882 IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_HWMP, rt->rt_dest,
1883 "start path rediscovery , target seq %u", hr->hr_seq);
1885 * Try to discover the path for this node.
1886 * Group addressed PREQ Case A
1888 preq.preq_flags = 0;
1889 preq.preq_hopcount = 0;
1890 preq.preq_ttl = ms->ms_ttl;
1891 preq.preq_id = ++hs->hs_preqid;
1892 IEEE80211_ADDR_COPY(preq.preq_origaddr, vap->iv_myaddr);
1893 preq.preq_origseq = hr->hr_origseq;
1894 preq.preq_lifetime = ticks_to_msecs(ieee80211_hwmp_pathtimeout);
1895 preq.preq_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
1896 preq.preq_tcount = 1;
1897 IEEE80211_ADDR_COPY(PREQ_TADDR(0), rt->rt_dest);
1899 if (ieee80211_hwmp_targetonly)
1900 PREQ_TFLAGS(0) |= IEEE80211_MESHPREQ_TFLAGS_TO;
1901 PREQ_TFLAGS(0) |= IEEE80211_MESHPREQ_TFLAGS_USN;
1902 PREQ_TSEQ(0) = 0; /* RESERVED when USN flag is set */
1903 /* XXX check return value */
1904 hwmp_send_preq(vap, broadcastaddr, &preq, &hr->hr_lastpreq,
1905 &ieee80211_hwmp_preqminint);
1906 callout_reset(&rt->rt_discovery,
1907 ieee80211_hwmp_net_diameter_traversaltime * 2,
1908 hwmp_rediscover_cb, rt);
1911 static struct ieee80211_node *
1912 hwmp_discover(struct ieee80211vap *vap,
1913 const uint8_t dest[IEEE80211_ADDR_LEN], struct mbuf *m)
1915 struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
1916 struct ieee80211_mesh_state *ms = vap->iv_mesh;
1917 struct ieee80211_mesh_route *rt = NULL;
1918 struct ieee80211_hwmp_route *hr;
1919 struct ieee80211_meshpreq_ie preq;
1920 struct ieee80211_node *ni;
1923 KASSERT(vap->iv_opmode == IEEE80211_M_MBSS,
1924 ("not a mesh vap, opmode %d", vap->iv_opmode));
1926 KASSERT(!IEEE80211_ADDR_EQ(vap->iv_myaddr, dest),
1927 ("%s: discovering self!", __func__));
1930 if (!IEEE80211_IS_MULTICAST(dest)) {
1931 rt = ieee80211_mesh_rt_find(vap, dest);
1933 rt = ieee80211_mesh_rt_add(vap, dest);
1935 IEEE80211_NOTE(vap, IEEE80211_MSG_HWMP,
1936 ni, "unable to add discovery path to %6D",
1938 vap->iv_stats.is_mesh_rtaddfailed++;
1942 hr = IEEE80211_MESH_ROUTE_PRIV(rt,
1943 struct ieee80211_hwmp_route);
1944 if (rt->rt_flags & IEEE80211_MESHRT_FLAGS_DISCOVER) {
1945 IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_HWMP, dest,
1946 "%s", "already discovering queue frame until path found");
1950 if ((rt->rt_flags & IEEE80211_MESHRT_FLAGS_VALID) == 0) {
1951 if (hr->hr_lastdiscovery != 0 &&
1952 (ticks - hr->hr_lastdiscovery <
1953 (ieee80211_hwmp_net_diameter_traversaltime * 2))) {
1954 IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_ANY,
1956 "too frequent discovery requeust");
1960 hr->hr_lastdiscovery = ticks;
1961 if (hr->hr_preqretries >=
1962 ieee80211_hwmp_maxpreq_retries) {
1963 IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_ANY,
1965 "no valid path , max number of discovery");
1966 vap->iv_stats.is_mesh_fwd_nopath++;
1969 rt->rt_flags = IEEE80211_MESHRT_FLAGS_DISCOVER;
1970 hr->hr_preqretries++;
1971 if (hr->hr_origseq == 0)
1972 hr->hr_origseq = ++hs->hs_seq;
1973 rt->rt_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
1975 IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_HWMP, dest,
1976 "start path discovery (src %s), target seq %u",
1977 m == NULL ? "<none>" : ether_sprintf(
1978 mtod(m, struct ether_header *)->ether_shost),
1981 * Try to discover the path for this node.
1982 * Group addressed PREQ Case A
1984 preq.preq_flags = 0;
1985 preq.preq_hopcount = 0;
1986 preq.preq_ttl = ms->ms_ttl;
1987 preq.preq_id = ++hs->hs_preqid;
1988 IEEE80211_ADDR_COPY(preq.preq_origaddr, vap->iv_myaddr);
1989 preq.preq_origseq = hr->hr_origseq;
1990 preq.preq_lifetime =
1991 ticks_to_msecs(ieee80211_hwmp_pathtimeout);
1992 preq.preq_metric = IEEE80211_MESHLMETRIC_INITIALVAL;
1993 preq.preq_tcount = 1;
1994 IEEE80211_ADDR_COPY(PREQ_TADDR(0), dest);
1996 if (ieee80211_hwmp_targetonly)
1997 PREQ_TFLAGS(0) |= IEEE80211_MESHPREQ_TFLAGS_TO;
1998 PREQ_TFLAGS(0) |= IEEE80211_MESHPREQ_TFLAGS_USN;
1999 PREQ_TSEQ(0) = 0; /* RESERVED when USN flag is set */
2000 /* XXX check return value */
2001 hwmp_send_preq(vap, broadcastaddr, &preq,
2002 &hr->hr_lastpreq, &ieee80211_hwmp_preqminint);
2003 callout_reset(&rt->rt_discovery,
2004 ieee80211_hwmp_net_diameter_traversaltime * 2,
2005 hwmp_rediscover_cb, rt);
2007 if (rt->rt_flags & IEEE80211_MESHRT_FLAGS_VALID)
2008 ni = ieee80211_find_txnode(vap, rt->rt_nexthop);
2010 ni = ieee80211_find_txnode(vap, dest);
2011 /* NB: if null then we leak mbuf */
2012 KASSERT(ni != NULL, ("leak mcast frame"));
2016 if (ni == NULL && m != NULL) {
2018 struct ieee80211com *ic = vap->iv_ic;
2020 * Queue packet for transmit when path discovery
2021 * completes. If discovery never completes the
2022 * frame will be flushed by way of the aging timer.
2024 IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_HWMP, dest,
2025 "%s", "queue frame until path found");
2026 m->m_pkthdr.rcvif = (void *)(uintptr_t)
2027 ieee80211_mac_hash(ic, dest);
2028 /* XXX age chosen randomly */
2029 ieee80211_ageq_append(&ic->ic_stageq, m,
2030 IEEE80211_INACT_WAIT);
2032 IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_HWMP,
2033 dest, NULL, "%s", "no valid path to this node");
2044 hwmp_ioctl_get80211(struct ieee80211vap *vap, struct ieee80211req *ireq)
2046 struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
2049 if (vap->iv_opmode != IEEE80211_M_MBSS)
2052 switch (ireq->i_type) {
2053 case IEEE80211_IOC_HWMP_ROOTMODE:
2054 ireq->i_val = hs->hs_rootmode;
2056 case IEEE80211_IOC_HWMP_MAXHOPS:
2057 ireq->i_val = hs->hs_maxhops;
2064 IEEE80211_IOCTL_GET(hwmp, hwmp_ioctl_get80211);
2067 hwmp_ioctl_set80211(struct ieee80211vap *vap, struct ieee80211req *ireq)
2069 struct ieee80211_hwmp_state *hs = vap->iv_hwmp;
2072 if (vap->iv_opmode != IEEE80211_M_MBSS)
2075 switch (ireq->i_type) {
2076 case IEEE80211_IOC_HWMP_ROOTMODE:
2077 if (ireq->i_val < 0 || ireq->i_val > 3)
2079 hs->hs_rootmode = ireq->i_val;
2080 hwmp_rootmode_setup(vap);
2082 case IEEE80211_IOC_HWMP_MAXHOPS:
2083 if (ireq->i_val <= 0 || ireq->i_val > 255)
2085 hs->hs_maxhops = ireq->i_val;
2092 IEEE80211_IOCTL_SET(hwmp, hwmp_ioctl_set80211);