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/netdevice.h>
13 #include <linux/random.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
;
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
65 * @dev: local interface
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 net_device
*dev
)
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
, dev
, tbl
)];
82 hlist_for_each_entry_rcu(node
, n
, bucket
, list
) {
84 if (mpath
->dev
== dev
&&
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
);
99 * mesh_path_lookup_by_idx - look up a path in the mesh path table by its index
101 * @dev: local interface, or NULL for all entries
103 * Returns: pointer to the mesh path structure, or NULL if not found.
105 * Locking: must be called within a read rcu section.
107 struct mesh_path
*mesh_path_lookup_by_idx(int idx
, struct net_device
*dev
)
109 struct mpath_node
*node
;
110 struct hlist_node
*p
;
114 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
115 if (dev
&& node
->mpath
->dev
!= dev
)
118 if (MPATH_EXPIRED(node
->mpath
)) {
119 spin_lock_bh(&node
->mpath
->state_lock
);
120 if (MPATH_EXPIRED(node
->mpath
))
121 node
->mpath
->flags
&= ~MESH_PATH_ACTIVE
;
122 spin_unlock_bh(&node
->mpath
->state_lock
);
132 * mesh_path_add - allocate and add a new path to the mesh path table
133 * @addr: destination address of the path (ETH_ALEN length)
134 * @dev: local interface
136 * Returns: 0 on sucess
138 * State: the initial state of the new path is set to 0
140 int mesh_path_add(u8
*dst
, struct net_device
*dev
)
142 struct ieee80211_sub_if_data
*sdata
= IEEE80211_DEV_TO_SUB_IF(dev
);
143 struct mesh_path
*mpath
, *new_mpath
;
144 struct mpath_node
*node
, *new_node
;
145 struct hlist_head
*bucket
;
146 struct hlist_node
*n
;
151 if (memcmp(dst
, dev
->dev_addr
, ETH_ALEN
) == 0)
152 /* never add ourselves as neighbours */
155 if (is_multicast_ether_addr(dst
))
158 if (atomic_add_unless(&sdata
->u
.sta
.mpaths
, 1, MESH_MAX_MPATHS
) == 0)
161 new_mpath
= kzalloc(sizeof(struct mesh_path
), GFP_KERNEL
);
163 atomic_dec(&sdata
->u
.sta
.mpaths
);
167 new_node
= kmalloc(sizeof(struct mpath_node
), GFP_KERNEL
);
170 atomic_dec(&sdata
->u
.sta
.mpaths
);
175 read_lock(&pathtbl_resize_lock
);
176 memcpy(new_mpath
->dst
, dst
, ETH_ALEN
);
177 new_mpath
->dev
= dev
;
178 new_mpath
->flags
= 0;
179 skb_queue_head_init(&new_mpath
->frame_queue
);
180 new_node
->mpath
= new_mpath
;
181 new_mpath
->timer
.data
= (unsigned long) new_mpath
;
182 new_mpath
->timer
.function
= mesh_path_timer
;
183 new_mpath
->exp_time
= jiffies
;
184 spin_lock_init(&new_mpath
->state_lock
);
185 init_timer(&new_mpath
->timer
);
187 hash_idx
= mesh_table_hash(dst
, dev
, mesh_paths
);
188 bucket
= &mesh_paths
->hash_buckets
[hash_idx
];
190 spin_lock(&mesh_paths
->hashwlock
[hash_idx
]);
192 hlist_for_each_entry(node
, n
, bucket
, list
) {
194 if (mpath
->dev
== dev
&& memcmp(dst
, mpath
->dst
, ETH_ALEN
)
197 atomic_dec(&sdata
->u
.sta
.mpaths
);
204 hlist_add_head_rcu(&new_node
->list
, bucket
);
205 if (atomic_inc_return(&mesh_paths
->entries
) >=
206 mesh_paths
->mean_chain_len
* (mesh_paths
->hash_mask
+ 1))
210 spin_unlock(&mesh_paths
->hashwlock
[hash_idx
]);
211 read_unlock(&pathtbl_resize_lock
);
213 struct mesh_table
*oldtbl
, *newtbl
;
215 write_lock(&pathtbl_resize_lock
);
217 newtbl
= mesh_table_grow(mesh_paths
);
219 write_unlock(&pathtbl_resize_lock
);
222 rcu_assign_pointer(mesh_paths
, newtbl
);
223 write_unlock(&pathtbl_resize_lock
);
226 mesh_table_free(oldtbl
, false);
234 * mesh_plink_broken - deactivates paths and sends perr when a link breaks
236 * @sta: broken peer link
238 * This function must be called from the rate control algorithm if enough
239 * delivery errors suggest that a peer link is no longer usable.
241 void mesh_plink_broken(struct sta_info
*sta
)
243 struct mesh_path
*mpath
;
244 struct mpath_node
*node
;
245 struct hlist_node
*p
;
246 struct net_device
*dev
= sta
->sdata
->dev
;
250 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
252 spin_lock_bh(&mpath
->state_lock
);
253 if (mpath
->next_hop
== sta
&&
254 mpath
->flags
& MESH_PATH_ACTIVE
&&
255 !(mpath
->flags
& MESH_PATH_FIXED
)) {
256 mpath
->flags
&= ~MESH_PATH_ACTIVE
;
258 spin_unlock_bh(&mpath
->state_lock
);
259 mesh_path_error_tx(mpath
->dst
,
260 cpu_to_le32(mpath
->dsn
),
261 dev
->broadcast
, dev
);
263 spin_unlock_bh(&mpath
->state_lock
);
267 EXPORT_SYMBOL(mesh_plink_broken
);
270 * mesh_path_flush_by_nexthop - Deletes mesh paths if their next hop matches
272 * @sta - mesh peer to match
274 * RCU notes: this function is called when a mesh plink transitions from
275 * PLINK_ESTAB to any other state, since PLINK_ESTAB state is the only one that
276 * allows path creation. This will happen before the sta can be freed (because
277 * sta_info_destroy() calls this) so any reader in a rcu read block will be
278 * protected against the plink disappearing.
280 void mesh_path_flush_by_nexthop(struct sta_info
*sta
)
282 struct mesh_path
*mpath
;
283 struct mpath_node
*node
;
284 struct hlist_node
*p
;
287 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
289 if (mpath
->next_hop
== sta
)
290 mesh_path_del(mpath
->dst
, mpath
->dev
);
294 void mesh_path_flush(struct net_device
*dev
)
296 struct mesh_path
*mpath
;
297 struct mpath_node
*node
;
298 struct hlist_node
*p
;
301 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
303 if (mpath
->dev
== dev
)
304 mesh_path_del(mpath
->dst
, mpath
->dev
);
308 static void mesh_path_node_reclaim(struct rcu_head
*rp
)
310 struct mpath_node
*node
= container_of(rp
, struct mpath_node
, rcu
);
311 struct ieee80211_sub_if_data
*sdata
=
312 IEEE80211_DEV_TO_SUB_IF(node
->mpath
->dev
);
314 del_timer_sync(&node
->mpath
->timer
);
315 atomic_dec(&sdata
->u
.sta
.mpaths
);
321 * mesh_path_del - delete a mesh path from the table
323 * @addr: dst address (ETH_ALEN length)
324 * @dev: local interface
326 * Returns: 0 if succesful
328 int mesh_path_del(u8
*addr
, struct net_device
*dev
)
330 struct mesh_path
*mpath
;
331 struct mpath_node
*node
;
332 struct hlist_head
*bucket
;
333 struct hlist_node
*n
;
337 read_lock(&pathtbl_resize_lock
);
338 hash_idx
= mesh_table_hash(addr
, dev
, mesh_paths
);
339 bucket
= &mesh_paths
->hash_buckets
[hash_idx
];
341 spin_lock(&mesh_paths
->hashwlock
[hash_idx
]);
342 hlist_for_each_entry(node
, n
, bucket
, list
) {
344 if (mpath
->dev
== dev
&&
345 memcmp(addr
, mpath
->dst
, ETH_ALEN
) == 0) {
346 spin_lock_bh(&mpath
->state_lock
);
347 mpath
->flags
|= MESH_PATH_RESOLVING
;
348 hlist_del_rcu(&node
->list
);
349 call_rcu(&node
->rcu
, mesh_path_node_reclaim
);
350 atomic_dec(&mesh_paths
->entries
);
351 spin_unlock_bh(&mpath
->state_lock
);
358 spin_unlock(&mesh_paths
->hashwlock
[hash_idx
]);
359 read_unlock(&pathtbl_resize_lock
);
364 * mesh_path_tx_pending - sends pending frames in a mesh path queue
366 * @mpath: mesh path to activate
368 * Locking: the state_lock of the mpath structure must NOT be held when calling
371 void mesh_path_tx_pending(struct mesh_path
*mpath
)
375 while ((skb
= skb_dequeue(&mpath
->frame_queue
)) &&
376 (mpath
->flags
& MESH_PATH_ACTIVE
))
381 * mesh_path_discard_frame - discard a frame whose path could not be resolved
383 * @skb: frame to discard
384 * @dev: network device the frame was to be sent through
386 * If the frame was beign forwarded from another MP, a PERR frame will be sent
389 * Locking: the function must me called within a rcu_read_lock region
391 void mesh_path_discard_frame(struct sk_buff
*skb
, struct net_device
*dev
)
393 struct ieee80211_sub_if_data
*sdata
= IEEE80211_DEV_TO_SUB_IF(dev
);
394 struct mesh_path
*mpath
;
397 if (skb
->pkt_type
== PACKET_OTHERHOST
) {
398 struct ieee80211s_hdr
*prev_meshhdr
;
402 prev_meshhdr
= ((struct ieee80211s_hdr
*)skb
->cb
);
403 mshhdrlen
= ieee80211_get_mesh_hdrlen(prev_meshhdr
);
406 mpath
= mesh_path_lookup(da
, dev
);
409 mesh_path_error_tx(skb
->data
, cpu_to_le32(dsn
), ra
, dev
);
413 sdata
->u
.sta
.mshstats
.dropped_frames_no_route
++;
417 * mesh_path_flush_pending - free the pending queue of a mesh path
419 * @mpath: mesh path whose queue has to be freed
421 * Locking: the function must me called withing a rcu_read_lock region
423 void mesh_path_flush_pending(struct mesh_path
*mpath
)
425 struct ieee80211_sub_if_data
*sdata
;
428 sdata
= IEEE80211_DEV_TO_SUB_IF(mpath
->dev
);
430 while ((skb
= skb_dequeue(&mpath
->frame_queue
)) &&
431 (mpath
->flags
& MESH_PATH_ACTIVE
))
432 mesh_path_discard_frame(skb
, mpath
->dev
);
436 * mesh_path_fix_nexthop - force a specific next hop for a mesh path
438 * @mpath: the mesh path to modify
439 * @next_hop: the next hop to force
441 * Locking: this function must be called holding mpath->state_lock
443 void mesh_path_fix_nexthop(struct mesh_path
*mpath
, struct sta_info
*next_hop
)
445 spin_lock_bh(&mpath
->state_lock
);
446 mesh_path_assign_nexthop(mpath
, next_hop
);
449 mpath
->hop_count
= 0;
451 mpath
->flags
|= MESH_PATH_FIXED
;
452 mesh_path_activate(mpath
);
453 spin_unlock_bh(&mpath
->state_lock
);
454 mesh_path_tx_pending(mpath
);
457 static void mesh_path_node_free(struct hlist_node
*p
, bool free_leafs
)
459 struct mesh_path
*mpath
;
460 struct mpath_node
*node
= hlist_entry(p
, struct mpath_node
, list
);
469 static void mesh_path_node_copy(struct hlist_node
*p
, struct mesh_table
*newtbl
)
471 struct mesh_path
*mpath
;
472 struct mpath_node
*node
, *new_node
;
475 node
= hlist_entry(p
, struct mpath_node
, list
);
477 new_node
= kmalloc(sizeof(struct mpath_node
), GFP_KERNEL
);
478 new_node
->mpath
= mpath
;
479 hash_idx
= mesh_table_hash(mpath
->dst
, mpath
->dev
, newtbl
);
480 hlist_add_head(&new_node
->list
,
481 &newtbl
->hash_buckets
[hash_idx
]);
484 int mesh_pathtbl_init(void)
486 mesh_paths
= mesh_table_alloc(INIT_PATHS_SIZE_ORDER
);
487 mesh_paths
->free_node
= &mesh_path_node_free
;
488 mesh_paths
->copy_node
= &mesh_path_node_copy
;
489 mesh_paths
->mean_chain_len
= MEAN_CHAIN_LEN
;
495 void mesh_path_expire(struct net_device
*dev
)
497 struct mesh_path
*mpath
;
498 struct mpath_node
*node
;
499 struct hlist_node
*p
;
502 read_lock(&pathtbl_resize_lock
);
503 for_each_mesh_entry(mesh_paths
, p
, node
, i
) {
504 if (node
->mpath
->dev
!= dev
)
507 spin_lock_bh(&mpath
->state_lock
);
508 if ((!(mpath
->flags
& MESH_PATH_RESOLVING
)) &&
509 (!(mpath
->flags
& MESH_PATH_FIXED
)) &&
511 mpath
->exp_time
+ MESH_PATH_EXPIRE
)) {
512 spin_unlock_bh(&mpath
->state_lock
);
513 mesh_path_del(mpath
->dst
, mpath
->dev
);
515 spin_unlock_bh(&mpath
->state_lock
);
517 read_unlock(&pathtbl_resize_lock
);
520 void mesh_pathtbl_unregister(void)
522 mesh_table_free(mesh_paths
, true);