2 * Copyright (c) 2008, 2009 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/slab.h>
14 #include <linux/spinlock.h>
15 #include <linux/string.h>
16 #include <net/mac80211.h>
17 #include "ieee80211_i.h"
20 /* There will be initially 2^INIT_PATHS_SIZE_ORDER buckets */
21 #define INIT_PATHS_SIZE_ORDER 2
23 /* Keep the mean chain length below this constant */
24 #define MEAN_CHAIN_LEN 2
26 #define MPATH_EXPIRED(mpath) ((mpath->flags & MESH_PATH_ACTIVE) && \
27 time_after(jiffies, mpath->exp_time) && \
28 !(mpath->flags & MESH_PATH_FIXED))
31 struct hlist_node list
;
33 /* This indirection allows two different tables to point to the same
34 * mesh_path structure, useful when resizing
36 struct mesh_path
*mpath
;
39 static struct mesh_table
*mesh_paths
;
40 static struct mesh_table
*mpp_paths
; /* Store paths for MPP&MAP */
42 int mesh_paths_generation
;
43 static void __mesh_table_free(struct mesh_table
*tbl
)
45 kfree(tbl
->hash_buckets
);
46 kfree(tbl
->hashwlock
);
50 void mesh_table_free(struct mesh_table
*tbl
, bool free_leafs
)
52 struct hlist_head
*mesh_hash
;
53 struct hlist_node
*p
, *q
;
56 mesh_hash
= tbl
->hash_buckets
;
57 for (i
= 0; i
<= tbl
->hash_mask
; i
++) {
58 spin_lock(&tbl
->hashwlock
[i
]);
59 hlist_for_each_safe(p
, q
, &mesh_hash
[i
]) {
60 tbl
->free_node(p
, free_leafs
);
61 atomic_dec(&tbl
->entries
);
63 spin_unlock(&tbl
->hashwlock
[i
]);
65 __mesh_table_free(tbl
);
68 static struct mesh_table
*mesh_table_grow(struct mesh_table
*tbl
)
70 struct mesh_table
*newtbl
;
71 struct hlist_head
*oldhash
;
72 struct hlist_node
*p
, *q
;
75 if (atomic_read(&tbl
->entries
)
76 < tbl
->mean_chain_len
* (tbl
->hash_mask
+ 1))
79 newtbl
= mesh_table_alloc(tbl
->size_order
+ 1);
83 newtbl
->free_node
= tbl
->free_node
;
84 newtbl
->mean_chain_len
= tbl
->mean_chain_len
;
85 newtbl
->copy_node
= tbl
->copy_node
;
86 atomic_set(&newtbl
->entries
, atomic_read(&tbl
->entries
));
88 oldhash
= tbl
->hash_buckets
;
89 for (i
= 0; i
<= tbl
->hash_mask
; i
++)
90 hlist_for_each(p
, &oldhash
[i
])
91 if (tbl
->copy_node(p
, newtbl
) < 0)
97 for (i
= 0; i
<= newtbl
->hash_mask
; i
++) {
98 hlist_for_each_safe(p
, q
, &newtbl
->hash_buckets
[i
])
101 __mesh_table_free(newtbl
);
107 /* This lock will have the grow table function as writer and add / delete nodes
108 * as readers. When reading the table (i.e. doing lookups) we are well protected
111 static DEFINE_RWLOCK(pathtbl_resize_lock
);
115 * mesh_path_assign_nexthop - update mesh path next hop
117 * @mpath: mesh path to update
118 * @sta: next hop to assign
120 * Locking: mpath->state_lock must be held when calling this function
122 void mesh_path_assign_nexthop(struct mesh_path
*mpath
, struct sta_info
*sta
)
125 struct ieee80211_hdr
*hdr
;
126 struct sk_buff_head tmpq
;
129 rcu_assign_pointer(mpath
->next_hop
, sta
);
131 __skb_queue_head_init(&tmpq
);
133 spin_lock_irqsave(&mpath
->frame_queue
.lock
, flags
);
135 while ((skb
= __skb_dequeue(&mpath
->frame_queue
)) != NULL
) {
136 hdr
= (struct ieee80211_hdr
*) skb
->data
;
137 memcpy(hdr
->addr1
, sta
->sta
.addr
, ETH_ALEN
);
138 __skb_queue_tail(&tmpq
, skb
);
141 skb_queue_splice(&tmpq
, &mpath
->frame_queue
);
142 spin_unlock_irqrestore(&mpath
->frame_queue
.lock
, flags
);
147 * mesh_path_lookup - look up a path in the mesh path table
148 * @dst: hardware address (ETH_ALEN length) of destination
149 * @sdata: local subif
151 * Returns: pointer to the mesh path structure, or NULL if not found
153 * Locking: must be called within a read rcu section.
155 struct mesh_path
*mesh_path_lookup(u8
*dst
, struct ieee80211_sub_if_data
*sdata
)
157 struct mesh_path
*mpath
;
158 struct hlist_node
*n
;
159 struct hlist_head
*bucket
;
160 struct mesh_table
*tbl
;
161 struct mpath_node
*node
;
163 tbl
= rcu_dereference(mesh_paths
);
165 bucket
= &tbl
->hash_buckets
[mesh_table_hash(dst
, sdata
, tbl
)];
166 hlist_for_each_entry_rcu(node
, n
, bucket
, list
) {
168 if (mpath
->sdata
== sdata
&&
169 memcmp(dst
, mpath
->dst
, ETH_ALEN
) == 0) {
170 if (MPATH_EXPIRED(mpath
)) {
171 spin_lock_bh(&mpath
->state_lock
);
172 if (MPATH_EXPIRED(mpath
))
173 mpath
->flags
&= ~MESH_PATH_ACTIVE
;
174 spin_unlock_bh(&mpath
->state_lock
);
182 struct mesh_path
*mpp_path_lookup(u8
*dst
, struct ieee80211_sub_if_data
*sdata
)
184 struct mesh_path
*mpath
;
185 struct hlist_node
*n
;
186 struct hlist_head
*bucket
;
187 struct mesh_table
*tbl
;
188 struct mpath_node
*node
;
190 tbl
= rcu_dereference(mpp_paths
);
192 bucket
= &tbl
->hash_buckets
[mesh_table_hash(dst
, sdata
, tbl
)];
193 hlist_for_each_entry_rcu(node
, n
, bucket
, list
) {
195 if (mpath
->sdata
== sdata
&&
196 memcmp(dst
, mpath
->dst
, ETH_ALEN
) == 0) {
197 if (MPATH_EXPIRED(mpath
)) {
198 spin_lock_bh(&mpath
->state_lock
);
199 if (MPATH_EXPIRED(mpath
))
200 mpath
->flags
&= ~MESH_PATH_ACTIVE
;
201 spin_unlock_bh(&mpath
->state_lock
);
211 * mesh_path_lookup_by_idx - look up a path in the mesh path table by its index
213 * @sdata: local subif, or NULL for all entries
215 * Returns: pointer to the mesh path structure, or NULL if not found.
217 * Locking: must be called within a read rcu section.
219 struct mesh_path
*mesh_path_lookup_by_idx(int idx
, struct ieee80211_sub_if_data
*sdata
)
221 struct mpath_node
*node
;
222 struct hlist_node
*p
;
226 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
227 if (sdata
&& node
->mpath
->sdata
!= sdata
)
230 if (MPATH_EXPIRED(node
->mpath
)) {
231 spin_lock_bh(&node
->mpath
->state_lock
);
232 if (MPATH_EXPIRED(node
->mpath
))
233 node
->mpath
->flags
&= ~MESH_PATH_ACTIVE
;
234 spin_unlock_bh(&node
->mpath
->state_lock
);
244 * mesh_path_add - allocate and add a new path to the mesh path table
245 * @addr: destination address of the path (ETH_ALEN length)
246 * @sdata: local subif
248 * Returns: 0 on success
250 * State: the initial state of the new path is set to 0
252 int mesh_path_add(u8
*dst
, struct ieee80211_sub_if_data
*sdata
)
254 struct ieee80211_if_mesh
*ifmsh
= &sdata
->u
.mesh
;
255 struct ieee80211_local
*local
= sdata
->local
;
256 struct mesh_path
*mpath
, *new_mpath
;
257 struct mpath_node
*node
, *new_node
;
258 struct hlist_head
*bucket
;
259 struct hlist_node
*n
;
264 if (memcmp(dst
, sdata
->vif
.addr
, ETH_ALEN
) == 0)
265 /* never add ourselves as neighbours */
268 if (is_multicast_ether_addr(dst
))
271 if (atomic_add_unless(&sdata
->u
.mesh
.mpaths
, 1, MESH_MAX_MPATHS
) == 0)
275 new_mpath
= kzalloc(sizeof(struct mesh_path
), GFP_ATOMIC
);
279 new_node
= kmalloc(sizeof(struct mpath_node
), GFP_ATOMIC
);
283 read_lock(&pathtbl_resize_lock
);
284 memcpy(new_mpath
->dst
, dst
, ETH_ALEN
);
285 new_mpath
->sdata
= sdata
;
286 new_mpath
->flags
= 0;
287 skb_queue_head_init(&new_mpath
->frame_queue
);
288 new_node
->mpath
= new_mpath
;
289 new_mpath
->timer
.data
= (unsigned long) new_mpath
;
290 new_mpath
->timer
.function
= mesh_path_timer
;
291 new_mpath
->exp_time
= jiffies
;
292 spin_lock_init(&new_mpath
->state_lock
);
293 init_timer(&new_mpath
->timer
);
295 hash_idx
= mesh_table_hash(dst
, sdata
, mesh_paths
);
296 bucket
= &mesh_paths
->hash_buckets
[hash_idx
];
298 spin_lock(&mesh_paths
->hashwlock
[hash_idx
]);
301 hlist_for_each_entry(node
, n
, bucket
, list
) {
303 if (mpath
->sdata
== sdata
&& memcmp(dst
, mpath
->dst
, ETH_ALEN
) == 0)
307 hlist_add_head_rcu(&new_node
->list
, bucket
);
308 if (atomic_inc_return(&mesh_paths
->entries
) >=
309 mesh_paths
->mean_chain_len
* (mesh_paths
->hash_mask
+ 1))
312 mesh_paths_generation
++;
314 spin_unlock(&mesh_paths
->hashwlock
[hash_idx
]);
315 read_unlock(&pathtbl_resize_lock
);
317 set_bit(MESH_WORK_GROW_MPATH_TABLE
, &ifmsh
->wrkq_flags
);
318 ieee80211_queue_work(&local
->hw
, &sdata
->work
);
323 spin_unlock(&mesh_paths
->hashwlock
[hash_idx
]);
324 read_unlock(&pathtbl_resize_lock
);
329 atomic_dec(&sdata
->u
.mesh
.mpaths
);
333 void mesh_mpath_table_grow(void)
335 struct mesh_table
*oldtbl
, *newtbl
;
337 write_lock(&pathtbl_resize_lock
);
339 newtbl
= mesh_table_grow(mesh_paths
);
341 write_unlock(&pathtbl_resize_lock
);
344 rcu_assign_pointer(mesh_paths
, newtbl
);
345 write_unlock(&pathtbl_resize_lock
);
348 mesh_table_free(oldtbl
, false);
351 void mesh_mpp_table_grow(void)
353 struct mesh_table
*oldtbl
, *newtbl
;
355 write_lock(&pathtbl_resize_lock
);
357 newtbl
= mesh_table_grow(mpp_paths
);
359 write_unlock(&pathtbl_resize_lock
);
362 rcu_assign_pointer(mpp_paths
, newtbl
);
363 write_unlock(&pathtbl_resize_lock
);
366 mesh_table_free(oldtbl
, false);
369 int mpp_path_add(u8
*dst
, u8
*mpp
, struct ieee80211_sub_if_data
*sdata
)
371 struct ieee80211_if_mesh
*ifmsh
= &sdata
->u
.mesh
;
372 struct ieee80211_local
*local
= sdata
->local
;
373 struct mesh_path
*mpath
, *new_mpath
;
374 struct mpath_node
*node
, *new_node
;
375 struct hlist_head
*bucket
;
376 struct hlist_node
*n
;
381 if (memcmp(dst
, sdata
->vif
.addr
, ETH_ALEN
) == 0)
382 /* never add ourselves as neighbours */
385 if (is_multicast_ether_addr(dst
))
389 new_mpath
= kzalloc(sizeof(struct mesh_path
), GFP_ATOMIC
);
393 new_node
= kmalloc(sizeof(struct mpath_node
), GFP_ATOMIC
);
397 read_lock(&pathtbl_resize_lock
);
398 memcpy(new_mpath
->dst
, dst
, ETH_ALEN
);
399 memcpy(new_mpath
->mpp
, mpp
, ETH_ALEN
);
400 new_mpath
->sdata
= sdata
;
401 new_mpath
->flags
= 0;
402 skb_queue_head_init(&new_mpath
->frame_queue
);
403 new_node
->mpath
= new_mpath
;
404 new_mpath
->exp_time
= jiffies
;
405 spin_lock_init(&new_mpath
->state_lock
);
407 hash_idx
= mesh_table_hash(dst
, sdata
, mpp_paths
);
408 bucket
= &mpp_paths
->hash_buckets
[hash_idx
];
410 spin_lock(&mpp_paths
->hashwlock
[hash_idx
]);
413 hlist_for_each_entry(node
, n
, bucket
, list
) {
415 if (mpath
->sdata
== sdata
&& memcmp(dst
, mpath
->dst
, ETH_ALEN
) == 0)
419 hlist_add_head_rcu(&new_node
->list
, bucket
);
420 if (atomic_inc_return(&mpp_paths
->entries
) >=
421 mpp_paths
->mean_chain_len
* (mpp_paths
->hash_mask
+ 1))
424 spin_unlock(&mpp_paths
->hashwlock
[hash_idx
]);
425 read_unlock(&pathtbl_resize_lock
);
427 set_bit(MESH_WORK_GROW_MPP_TABLE
, &ifmsh
->wrkq_flags
);
428 ieee80211_queue_work(&local
->hw
, &sdata
->work
);
433 spin_unlock(&mpp_paths
->hashwlock
[hash_idx
]);
434 read_unlock(&pathtbl_resize_lock
);
444 * mesh_plink_broken - deactivates paths and sends perr when a link breaks
446 * @sta: broken peer link
448 * This function must be called from the rate control algorithm if enough
449 * delivery errors suggest that a peer link is no longer usable.
451 void mesh_plink_broken(struct sta_info
*sta
)
453 static const u8 bcast
[ETH_ALEN
] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
454 struct mesh_path
*mpath
;
455 struct mpath_node
*node
;
456 struct hlist_node
*p
;
457 struct ieee80211_sub_if_data
*sdata
= sta
->sdata
;
461 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
463 spin_lock_bh(&mpath
->state_lock
);
464 if (mpath
->next_hop
== sta
&&
465 mpath
->flags
& MESH_PATH_ACTIVE
&&
466 !(mpath
->flags
& MESH_PATH_FIXED
)) {
467 mpath
->flags
&= ~MESH_PATH_ACTIVE
;
469 spin_unlock_bh(&mpath
->state_lock
);
470 mesh_path_error_tx(MESH_TTL
, mpath
->dst
,
471 cpu_to_le32(mpath
->sn
),
472 cpu_to_le16(PERR_RCODE_DEST_UNREACH
),
475 spin_unlock_bh(&mpath
->state_lock
);
481 * mesh_path_flush_by_nexthop - Deletes mesh paths if their next hop matches
483 * @sta - mesh peer to match
485 * RCU notes: this function is called when a mesh plink transitions from
486 * PLINK_ESTAB to any other state, since PLINK_ESTAB state is the only one that
487 * allows path creation. This will happen before the sta can be freed (because
488 * sta_info_destroy() calls this) so any reader in a rcu read block will be
489 * protected against the plink disappearing.
491 void mesh_path_flush_by_nexthop(struct sta_info
*sta
)
493 struct mesh_path
*mpath
;
494 struct mpath_node
*node
;
495 struct hlist_node
*p
;
498 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
500 if (mpath
->next_hop
== sta
)
501 mesh_path_del(mpath
->dst
, mpath
->sdata
);
505 void mesh_path_flush(struct ieee80211_sub_if_data
*sdata
)
507 struct mesh_path
*mpath
;
508 struct mpath_node
*node
;
509 struct hlist_node
*p
;
512 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
514 if (mpath
->sdata
== sdata
)
515 mesh_path_del(mpath
->dst
, mpath
->sdata
);
519 static void mesh_path_node_reclaim(struct rcu_head
*rp
)
521 struct mpath_node
*node
= container_of(rp
, struct mpath_node
, rcu
);
522 struct ieee80211_sub_if_data
*sdata
= node
->mpath
->sdata
;
524 del_timer_sync(&node
->mpath
->timer
);
525 atomic_dec(&sdata
->u
.mesh
.mpaths
);
531 * mesh_path_del - delete a mesh path from the table
533 * @addr: dst address (ETH_ALEN length)
534 * @sdata: local subif
536 * Returns: 0 if successful
538 int mesh_path_del(u8
*addr
, struct ieee80211_sub_if_data
*sdata
)
540 struct mesh_path
*mpath
;
541 struct mpath_node
*node
;
542 struct hlist_head
*bucket
;
543 struct hlist_node
*n
;
547 read_lock(&pathtbl_resize_lock
);
548 hash_idx
= mesh_table_hash(addr
, sdata
, mesh_paths
);
549 bucket
= &mesh_paths
->hash_buckets
[hash_idx
];
551 spin_lock(&mesh_paths
->hashwlock
[hash_idx
]);
552 hlist_for_each_entry(node
, n
, bucket
, list
) {
554 if (mpath
->sdata
== sdata
&&
555 memcmp(addr
, mpath
->dst
, ETH_ALEN
) == 0) {
556 spin_lock_bh(&mpath
->state_lock
);
557 mpath
->flags
|= MESH_PATH_RESOLVING
;
558 hlist_del_rcu(&node
->list
);
559 call_rcu(&node
->rcu
, mesh_path_node_reclaim
);
560 atomic_dec(&mesh_paths
->entries
);
561 spin_unlock_bh(&mpath
->state_lock
);
568 mesh_paths_generation
++;
569 spin_unlock(&mesh_paths
->hashwlock
[hash_idx
]);
570 read_unlock(&pathtbl_resize_lock
);
575 * mesh_path_tx_pending - sends pending frames in a mesh path queue
577 * @mpath: mesh path to activate
579 * Locking: the state_lock of the mpath structure must NOT be held when calling
582 void mesh_path_tx_pending(struct mesh_path
*mpath
)
584 if (mpath
->flags
& MESH_PATH_ACTIVE
)
585 ieee80211_add_pending_skbs(mpath
->sdata
->local
,
586 &mpath
->frame_queue
);
590 * mesh_path_discard_frame - discard a frame whose path could not be resolved
592 * @skb: frame to discard
593 * @sdata: network subif the frame was to be sent through
595 * If the frame was being forwarded from another MP, a PERR frame will be sent
596 * to the precursor. The precursor's address (i.e. the previous hop) was saved
597 * in addr1 of the frame-to-be-forwarded, and would only be overwritten once
598 * the destination is successfully resolved.
600 * Locking: the function must me called within a rcu_read_lock region
602 void mesh_path_discard_frame(struct sk_buff
*skb
,
603 struct ieee80211_sub_if_data
*sdata
)
605 struct ieee80211_hdr
*hdr
= (struct ieee80211_hdr
*) skb
->data
;
606 struct mesh_path
*mpath
;
609 if (memcmp(hdr
->addr4
, sdata
->vif
.addr
, ETH_ALEN
) != 0) {
614 mpath
= mesh_path_lookup(da
, sdata
);
617 mesh_path_error_tx(MESH_TTL
, skb
->data
, cpu_to_le32(sn
),
618 cpu_to_le16(PERR_RCODE_NO_ROUTE
), ra
, sdata
);
622 sdata
->u
.mesh
.mshstats
.dropped_frames_no_route
++;
626 * mesh_path_flush_pending - free the pending queue of a mesh path
628 * @mpath: mesh path whose queue has to be freed
630 * Locking: the function must me called withing a rcu_read_lock region
632 void mesh_path_flush_pending(struct mesh_path
*mpath
)
636 while ((skb
= skb_dequeue(&mpath
->frame_queue
)) &&
637 (mpath
->flags
& MESH_PATH_ACTIVE
))
638 mesh_path_discard_frame(skb
, mpath
->sdata
);
642 * mesh_path_fix_nexthop - force a specific next hop for a mesh path
644 * @mpath: the mesh path to modify
645 * @next_hop: the next hop to force
647 * Locking: this function must be called holding mpath->state_lock
649 void mesh_path_fix_nexthop(struct mesh_path
*mpath
, struct sta_info
*next_hop
)
651 spin_lock_bh(&mpath
->state_lock
);
652 mesh_path_assign_nexthop(mpath
, next_hop
);
655 mpath
->hop_count
= 0;
657 mpath
->flags
|= MESH_PATH_FIXED
;
658 mesh_path_activate(mpath
);
659 spin_unlock_bh(&mpath
->state_lock
);
660 mesh_path_tx_pending(mpath
);
663 static void mesh_path_node_free(struct hlist_node
*p
, bool free_leafs
)
665 struct mesh_path
*mpath
;
666 struct mpath_node
*node
= hlist_entry(p
, struct mpath_node
, list
);
674 static int mesh_path_node_copy(struct hlist_node
*p
, struct mesh_table
*newtbl
)
676 struct mesh_path
*mpath
;
677 struct mpath_node
*node
, *new_node
;
680 new_node
= kmalloc(sizeof(struct mpath_node
), GFP_ATOMIC
);
681 if (new_node
== NULL
)
684 node
= hlist_entry(p
, struct mpath_node
, list
);
686 new_node
->mpath
= mpath
;
687 hash_idx
= mesh_table_hash(mpath
->dst
, mpath
->sdata
, newtbl
);
688 hlist_add_head(&new_node
->list
,
689 &newtbl
->hash_buckets
[hash_idx
]);
693 int mesh_pathtbl_init(void)
695 mesh_paths
= mesh_table_alloc(INIT_PATHS_SIZE_ORDER
);
698 mesh_paths
->free_node
= &mesh_path_node_free
;
699 mesh_paths
->copy_node
= &mesh_path_node_copy
;
700 mesh_paths
->mean_chain_len
= MEAN_CHAIN_LEN
;
702 mpp_paths
= mesh_table_alloc(INIT_PATHS_SIZE_ORDER
);
704 mesh_table_free(mesh_paths
, true);
707 mpp_paths
->free_node
= &mesh_path_node_free
;
708 mpp_paths
->copy_node
= &mesh_path_node_copy
;
709 mpp_paths
->mean_chain_len
= MEAN_CHAIN_LEN
;
714 void mesh_path_expire(struct ieee80211_sub_if_data
*sdata
)
716 struct mesh_path
*mpath
;
717 struct mpath_node
*node
;
718 struct hlist_node
*p
;
721 read_lock(&pathtbl_resize_lock
);
722 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
723 if (node
->mpath
->sdata
!= sdata
)
726 spin_lock_bh(&mpath
->state_lock
);
727 if ((!(mpath
->flags
& MESH_PATH_RESOLVING
)) &&
728 (!(mpath
->flags
& MESH_PATH_FIXED
)) &&
730 mpath
->exp_time
+ MESH_PATH_EXPIRE
)) {
731 spin_unlock_bh(&mpath
->state_lock
);
732 mesh_path_del(mpath
->dst
, mpath
->sdata
);
734 spin_unlock_bh(&mpath
->state_lock
);
736 read_unlock(&pathtbl_resize_lock
);
739 void mesh_pathtbl_unregister(void)
741 mesh_table_free(mesh_paths
, true);
742 mesh_table_free(mpp_paths
, true);