2 * Copyright (c) 2008 open80211s Ltd.
3 * Author: Luis Carlos Cobo <luisca@cozybit.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
10 #include <linux/etherdevice.h>
11 #include <linux/list.h>
12 #include <linux/random.h>
13 #include <linux/spinlock.h>
14 #include <linux/string.h>
15 #include <net/mac80211.h>
16 #include "ieee80211_i.h"
19 /* There will be initially 2^INIT_PATHS_SIZE_ORDER buckets */
20 #define INIT_PATHS_SIZE_ORDER 2
22 /* Keep the mean chain length below this constant */
23 #define MEAN_CHAIN_LEN 2
25 #define MPATH_EXPIRED(mpath) ((mpath->flags & MESH_PATH_ACTIVE) && \
26 time_after(jiffies, mpath->exp_time) && \
27 !(mpath->flags & MESH_PATH_FIXED))
30 struct hlist_node list
;
32 /* This indirection allows two different tables to point to the same
33 * mesh_path structure, useful when resizing
35 struct mesh_path
*mpath
;
38 static struct mesh_table
*mesh_paths
;
39 static struct mesh_table
*mpp_paths
; /* Store paths for MPP&MAP */
41 /* This lock will have the grow table function as writer and add / delete nodes
42 * as readers. When reading the table (i.e. doing lookups) we are well protected
45 static DEFINE_RWLOCK(pathtbl_resize_lock
);
49 * mesh_path_assign_nexthop - update mesh path next hop
51 * @mpath: mesh path to update
52 * @sta: next hop to assign
54 * Locking: mpath->state_lock must be held when calling this function
56 void mesh_path_assign_nexthop(struct mesh_path
*mpath
, struct sta_info
*sta
)
58 rcu_assign_pointer(mpath
->next_hop
, sta
);
63 * mesh_path_lookup - look up a path in the mesh path table
64 * @dst: hardware address (ETH_ALEN length) of destination
67 * Returns: pointer to the mesh path structure, or NULL if not found
69 * Locking: must be called within a read rcu section.
71 struct mesh_path
*mesh_path_lookup(u8
*dst
, struct ieee80211_sub_if_data
*sdata
)
73 struct mesh_path
*mpath
;
75 struct hlist_head
*bucket
;
76 struct mesh_table
*tbl
;
77 struct mpath_node
*node
;
79 tbl
= rcu_dereference(mesh_paths
);
81 bucket
= &tbl
->hash_buckets
[mesh_table_hash(dst
, sdata
, tbl
)];
82 hlist_for_each_entry_rcu(node
, n
, bucket
, list
) {
84 if (mpath
->sdata
== sdata
&&
85 memcmp(dst
, mpath
->dst
, ETH_ALEN
) == 0) {
86 if (MPATH_EXPIRED(mpath
)) {
87 spin_lock_bh(&mpath
->state_lock
);
88 if (MPATH_EXPIRED(mpath
))
89 mpath
->flags
&= ~MESH_PATH_ACTIVE
;
90 spin_unlock_bh(&mpath
->state_lock
);
98 struct mesh_path
*mpp_path_lookup(u8
*dst
, struct ieee80211_sub_if_data
*sdata
)
100 struct mesh_path
*mpath
;
101 struct hlist_node
*n
;
102 struct hlist_head
*bucket
;
103 struct mesh_table
*tbl
;
104 struct mpath_node
*node
;
106 tbl
= rcu_dereference(mpp_paths
);
108 bucket
= &tbl
->hash_buckets
[mesh_table_hash(dst
, sdata
, tbl
)];
109 hlist_for_each_entry_rcu(node
, n
, bucket
, list
) {
111 if (mpath
->sdata
== sdata
&&
112 memcmp(dst
, mpath
->dst
, ETH_ALEN
) == 0) {
113 if (MPATH_EXPIRED(mpath
)) {
114 spin_lock_bh(&mpath
->state_lock
);
115 if (MPATH_EXPIRED(mpath
))
116 mpath
->flags
&= ~MESH_PATH_ACTIVE
;
117 spin_unlock_bh(&mpath
->state_lock
);
127 * mesh_path_lookup_by_idx - look up a path in the mesh path table by its index
129 * @sdata: local subif, or NULL for all entries
131 * Returns: pointer to the mesh path structure, or NULL if not found.
133 * Locking: must be called within a read rcu section.
135 struct mesh_path
*mesh_path_lookup_by_idx(int idx
, struct ieee80211_sub_if_data
*sdata
)
137 struct mpath_node
*node
;
138 struct hlist_node
*p
;
142 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
143 if (sdata
&& node
->mpath
->sdata
!= sdata
)
146 if (MPATH_EXPIRED(node
->mpath
)) {
147 spin_lock_bh(&node
->mpath
->state_lock
);
148 if (MPATH_EXPIRED(node
->mpath
))
149 node
->mpath
->flags
&= ~MESH_PATH_ACTIVE
;
150 spin_unlock_bh(&node
->mpath
->state_lock
);
160 * mesh_path_add - allocate and add a new path to the mesh path table
161 * @addr: destination address of the path (ETH_ALEN length)
162 * @sdata: local subif
164 * Returns: 0 on sucess
166 * State: the initial state of the new path is set to 0
168 int mesh_path_add(u8
*dst
, struct ieee80211_sub_if_data
*sdata
)
170 struct mesh_path
*mpath
, *new_mpath
;
171 struct mpath_node
*node
, *new_node
;
172 struct hlist_head
*bucket
;
173 struct hlist_node
*n
;
180 if (memcmp(dst
, sdata
->dev
->dev_addr
, ETH_ALEN
) == 0)
181 /* never add ourselves as neighbours */
184 if (is_multicast_ether_addr(dst
))
187 if (atomic_add_unless(&sdata
->u
.mesh
.mpaths
, 1, MESH_MAX_MPATHS
) == 0)
191 new_mpath
= kzalloc(sizeof(struct mesh_path
), GFP_KERNEL
);
195 new_node
= kmalloc(sizeof(struct mpath_node
), GFP_KERNEL
);
199 read_lock(&pathtbl_resize_lock
);
200 memcpy(new_mpath
->dst
, dst
, ETH_ALEN
);
201 new_mpath
->sdata
= sdata
;
202 new_mpath
->flags
= 0;
203 skb_queue_head_init(&new_mpath
->frame_queue
);
204 new_node
->mpath
= new_mpath
;
205 new_mpath
->timer
.data
= (unsigned long) new_mpath
;
206 new_mpath
->timer
.function
= mesh_path_timer
;
207 new_mpath
->exp_time
= jiffies
;
208 spin_lock_init(&new_mpath
->state_lock
);
209 init_timer(&new_mpath
->timer
);
211 hash_idx
= mesh_table_hash(dst
, sdata
, mesh_paths
);
212 bucket
= &mesh_paths
->hash_buckets
[hash_idx
];
214 spin_lock(&mesh_paths
->hashwlock
[hash_idx
]);
217 hlist_for_each_entry(node
, n
, bucket
, list
) {
219 if (mpath
->sdata
== sdata
&& memcmp(dst
, mpath
->dst
, ETH_ALEN
) == 0)
223 hlist_add_head_rcu(&new_node
->list
, bucket
);
224 if (atomic_inc_return(&mesh_paths
->entries
) >=
225 mesh_paths
->mean_chain_len
* (mesh_paths
->hash_mask
+ 1))
228 spin_unlock(&mesh_paths
->hashwlock
[hash_idx
]);
229 read_unlock(&pathtbl_resize_lock
);
231 struct mesh_table
*oldtbl
, *newtbl
;
233 write_lock(&pathtbl_resize_lock
);
235 newtbl
= mesh_table_grow(mesh_paths
);
237 write_unlock(&pathtbl_resize_lock
);
240 rcu_assign_pointer(mesh_paths
, newtbl
);
241 write_unlock(&pathtbl_resize_lock
);
244 mesh_table_free(oldtbl
, false);
249 spin_unlock(&mesh_paths
->hashwlock
[hash_idx
]);
250 read_unlock(&pathtbl_resize_lock
);
255 atomic_dec(&sdata
->u
.mesh
.mpaths
);
260 int mpp_path_add(u8
*dst
, u8
*mpp
, struct ieee80211_sub_if_data
*sdata
)
262 struct mesh_path
*mpath
, *new_mpath
;
263 struct mpath_node
*node
, *new_node
;
264 struct hlist_head
*bucket
;
265 struct hlist_node
*n
;
272 if (memcmp(dst
, sdata
->dev
->dev_addr
, ETH_ALEN
) == 0)
273 /* never add ourselves as neighbours */
276 if (is_multicast_ether_addr(dst
))
280 new_mpath
= kzalloc(sizeof(struct mesh_path
), GFP_KERNEL
);
284 new_node
= kmalloc(sizeof(struct mpath_node
), GFP_KERNEL
);
288 read_lock(&pathtbl_resize_lock
);
289 memcpy(new_mpath
->dst
, dst
, ETH_ALEN
);
290 memcpy(new_mpath
->mpp
, mpp
, ETH_ALEN
);
291 new_mpath
->sdata
= sdata
;
292 new_mpath
->flags
= 0;
293 skb_queue_head_init(&new_mpath
->frame_queue
);
294 new_node
->mpath
= new_mpath
;
295 new_mpath
->exp_time
= jiffies
;
296 spin_lock_init(&new_mpath
->state_lock
);
298 hash_idx
= mesh_table_hash(dst
, sdata
, mpp_paths
);
299 bucket
= &mpp_paths
->hash_buckets
[hash_idx
];
301 spin_lock(&mpp_paths
->hashwlock
[hash_idx
]);
304 hlist_for_each_entry(node
, n
, bucket
, list
) {
306 if (mpath
->sdata
== sdata
&& memcmp(dst
, mpath
->dst
, ETH_ALEN
) == 0)
310 hlist_add_head_rcu(&new_node
->list
, bucket
);
311 if (atomic_inc_return(&mpp_paths
->entries
) >=
312 mpp_paths
->mean_chain_len
* (mpp_paths
->hash_mask
+ 1))
315 spin_unlock(&mpp_paths
->hashwlock
[hash_idx
]);
316 read_unlock(&pathtbl_resize_lock
);
318 struct mesh_table
*oldtbl
, *newtbl
;
320 write_lock(&pathtbl_resize_lock
);
322 newtbl
= mesh_table_grow(mpp_paths
);
324 write_unlock(&pathtbl_resize_lock
);
327 rcu_assign_pointer(mpp_paths
, newtbl
);
328 write_unlock(&pathtbl_resize_lock
);
331 mesh_table_free(oldtbl
, false);
336 spin_unlock(&mpp_paths
->hashwlock
[hash_idx
]);
337 read_unlock(&pathtbl_resize_lock
);
347 * mesh_plink_broken - deactivates paths and sends perr when a link breaks
349 * @sta: broken peer link
351 * This function must be called from the rate control algorithm if enough
352 * delivery errors suggest that a peer link is no longer usable.
354 void mesh_plink_broken(struct sta_info
*sta
)
356 struct mesh_path
*mpath
;
357 struct mpath_node
*node
;
358 struct hlist_node
*p
;
359 struct ieee80211_sub_if_data
*sdata
= sta
->sdata
;
363 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
365 spin_lock_bh(&mpath
->state_lock
);
366 if (mpath
->next_hop
== sta
&&
367 mpath
->flags
& MESH_PATH_ACTIVE
&&
368 !(mpath
->flags
& MESH_PATH_FIXED
)) {
369 mpath
->flags
&= ~MESH_PATH_ACTIVE
;
371 spin_unlock_bh(&mpath
->state_lock
);
372 mesh_path_error_tx(mpath
->dst
,
373 cpu_to_le32(mpath
->dsn
),
374 sdata
->dev
->broadcast
, sdata
);
376 spin_unlock_bh(&mpath
->state_lock
);
382 * mesh_path_flush_by_nexthop - Deletes mesh paths if their next hop matches
384 * @sta - mesh peer to match
386 * RCU notes: this function is called when a mesh plink transitions from
387 * PLINK_ESTAB to any other state, since PLINK_ESTAB state is the only one that
388 * allows path creation. This will happen before the sta can be freed (because
389 * sta_info_destroy() calls this) so any reader in a rcu read block will be
390 * protected against the plink disappearing.
392 void mesh_path_flush_by_nexthop(struct sta_info
*sta
)
394 struct mesh_path
*mpath
;
395 struct mpath_node
*node
;
396 struct hlist_node
*p
;
399 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
401 if (mpath
->next_hop
== sta
)
402 mesh_path_del(mpath
->dst
, mpath
->sdata
);
406 void mesh_path_flush(struct ieee80211_sub_if_data
*sdata
)
408 struct mesh_path
*mpath
;
409 struct mpath_node
*node
;
410 struct hlist_node
*p
;
413 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
415 if (mpath
->sdata
== sdata
)
416 mesh_path_del(mpath
->dst
, mpath
->sdata
);
420 static void mesh_path_node_reclaim(struct rcu_head
*rp
)
422 struct mpath_node
*node
= container_of(rp
, struct mpath_node
, rcu
);
423 struct ieee80211_sub_if_data
*sdata
= node
->mpath
->sdata
;
425 del_timer_sync(&node
->mpath
->timer
);
426 atomic_dec(&sdata
->u
.mesh
.mpaths
);
432 * mesh_path_del - delete a mesh path from the table
434 * @addr: dst address (ETH_ALEN length)
435 * @sdata: local subif
437 * Returns: 0 if succesful
439 int mesh_path_del(u8
*addr
, struct ieee80211_sub_if_data
*sdata
)
441 struct mesh_path
*mpath
;
442 struct mpath_node
*node
;
443 struct hlist_head
*bucket
;
444 struct hlist_node
*n
;
448 read_lock(&pathtbl_resize_lock
);
449 hash_idx
= mesh_table_hash(addr
, sdata
, mesh_paths
);
450 bucket
= &mesh_paths
->hash_buckets
[hash_idx
];
452 spin_lock(&mesh_paths
->hashwlock
[hash_idx
]);
453 hlist_for_each_entry(node
, n
, bucket
, list
) {
455 if (mpath
->sdata
== sdata
&&
456 memcmp(addr
, mpath
->dst
, ETH_ALEN
) == 0) {
457 spin_lock_bh(&mpath
->state_lock
);
458 mpath
->flags
|= MESH_PATH_RESOLVING
;
459 hlist_del_rcu(&node
->list
);
460 call_rcu(&node
->rcu
, mesh_path_node_reclaim
);
461 atomic_dec(&mesh_paths
->entries
);
462 spin_unlock_bh(&mpath
->state_lock
);
469 spin_unlock(&mesh_paths
->hashwlock
[hash_idx
]);
470 read_unlock(&pathtbl_resize_lock
);
475 * mesh_path_tx_pending - sends pending frames in a mesh path queue
477 * @mpath: mesh path to activate
479 * Locking: the state_lock of the mpath structure must NOT be held when calling
482 void mesh_path_tx_pending(struct mesh_path
*mpath
)
486 while ((skb
= skb_dequeue(&mpath
->frame_queue
)) &&
487 (mpath
->flags
& MESH_PATH_ACTIVE
))
492 * mesh_path_discard_frame - discard a frame whose path could not be resolved
494 * @skb: frame to discard
495 * @sdata: network subif the frame was to be sent through
497 * If the frame was being forwarded from another MP, a PERR frame will be sent
498 * to the precursor. The precursor's address (i.e. the previous hop) was saved
499 * in addr1 of the frame-to-be-forwarded, and would only be overwritten once
500 * the destination is successfully resolved.
502 * Locking: the function must me called within a rcu_read_lock region
504 void mesh_path_discard_frame(struct sk_buff
*skb
,
505 struct ieee80211_sub_if_data
*sdata
)
507 struct ieee80211_hdr
*hdr
= (struct ieee80211_hdr
*) skb
->data
;
508 struct mesh_path
*mpath
;
511 if (memcmp(hdr
->addr4
, sdata
->dev
->dev_addr
, ETH_ALEN
) != 0) {
516 mpath
= mesh_path_lookup(da
, sdata
);
519 mesh_path_error_tx(skb
->data
, cpu_to_le32(dsn
), ra
, sdata
);
523 sdata
->u
.mesh
.mshstats
.dropped_frames_no_route
++;
527 * mesh_path_flush_pending - free the pending queue of a mesh path
529 * @mpath: mesh path whose queue has to be freed
531 * Locking: the function must me called withing a rcu_read_lock region
533 void mesh_path_flush_pending(struct mesh_path
*mpath
)
537 while ((skb
= skb_dequeue(&mpath
->frame_queue
)) &&
538 (mpath
->flags
& MESH_PATH_ACTIVE
))
539 mesh_path_discard_frame(skb
, mpath
->sdata
);
543 * mesh_path_fix_nexthop - force a specific next hop for a mesh path
545 * @mpath: the mesh path to modify
546 * @next_hop: the next hop to force
548 * Locking: this function must be called holding mpath->state_lock
550 void mesh_path_fix_nexthop(struct mesh_path
*mpath
, struct sta_info
*next_hop
)
552 spin_lock_bh(&mpath
->state_lock
);
553 mesh_path_assign_nexthop(mpath
, next_hop
);
556 mpath
->hop_count
= 0;
558 mpath
->flags
|= MESH_PATH_FIXED
;
559 mesh_path_activate(mpath
);
560 spin_unlock_bh(&mpath
->state_lock
);
561 mesh_path_tx_pending(mpath
);
564 static void mesh_path_node_free(struct hlist_node
*p
, bool free_leafs
)
566 struct mesh_path
*mpath
;
567 struct mpath_node
*node
= hlist_entry(p
, struct mpath_node
, list
);
575 static int mesh_path_node_copy(struct hlist_node
*p
, struct mesh_table
*newtbl
)
577 struct mesh_path
*mpath
;
578 struct mpath_node
*node
, *new_node
;
581 new_node
= kmalloc(sizeof(struct mpath_node
), GFP_ATOMIC
);
582 if (new_node
== NULL
)
585 node
= hlist_entry(p
, struct mpath_node
, list
);
587 new_node
->mpath
= mpath
;
588 hash_idx
= mesh_table_hash(mpath
->dst
, mpath
->sdata
, newtbl
);
589 hlist_add_head(&new_node
->list
,
590 &newtbl
->hash_buckets
[hash_idx
]);
594 int mesh_pathtbl_init(void)
596 mesh_paths
= mesh_table_alloc(INIT_PATHS_SIZE_ORDER
);
599 mesh_paths
->free_node
= &mesh_path_node_free
;
600 mesh_paths
->copy_node
= &mesh_path_node_copy
;
601 mesh_paths
->mean_chain_len
= MEAN_CHAIN_LEN
;
603 mpp_paths
= mesh_table_alloc(INIT_PATHS_SIZE_ORDER
);
605 mesh_table_free(mesh_paths
, true);
608 mpp_paths
->free_node
= &mesh_path_node_free
;
609 mpp_paths
->copy_node
= &mesh_path_node_copy
;
610 mpp_paths
->mean_chain_len
= MEAN_CHAIN_LEN
;
615 void mesh_path_expire(struct ieee80211_sub_if_data
*sdata
)
617 struct mesh_path
*mpath
;
618 struct mpath_node
*node
;
619 struct hlist_node
*p
;
622 read_lock(&pathtbl_resize_lock
);
623 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
624 if (node
->mpath
->sdata
!= sdata
)
627 spin_lock_bh(&mpath
->state_lock
);
628 if ((!(mpath
->flags
& MESH_PATH_RESOLVING
)) &&
629 (!(mpath
->flags
& MESH_PATH_FIXED
)) &&
631 mpath
->exp_time
+ MESH_PATH_EXPIRE
)) {
632 spin_unlock_bh(&mpath
->state_lock
);
633 mesh_path_del(mpath
->dst
, mpath
->sdata
);
635 spin_unlock_bh(&mpath
->state_lock
);
637 read_unlock(&pathtbl_resize_lock
);
640 void mesh_pathtbl_unregister(void)
642 mesh_table_free(mesh_paths
, true);
643 mesh_table_free(mpp_paths
, true);