Commit | Line | Data |
---|---|---|
ccf80ddf | 1 | /* |
264d9b7d | 2 | * Copyright (c) 2008, 2009 open80211s Ltd. |
ccf80ddf LCC |
3 | * Authors: Luis Carlos Cobo <luisca@cozybit.com> |
4 | * Javier Cardona <javier@cozybit.com> | |
5 | * | |
6 | * This program is free software; you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License version 2 as | |
8 | * published by the Free Software Foundation. | |
9 | */ | |
10 | ||
11 | #ifndef IEEE80211S_H | |
12 | #define IEEE80211S_H | |
13 | ||
902acc78 | 14 | #include <linux/types.h> |
ccf80ddf | 15 | #include <linux/jhash.h> |
902acc78 | 16 | #include "ieee80211_i.h" |
ccf80ddf | 17 | |
ccf80ddf LCC |
18 | |
19 | /* Data structures */ | |
20 | ||
21 | /** | |
22 | * enum mesh_path_flags - mac80211 mesh path flags | |
23 | * | |
24 | * | |
25 | * | |
eb80ed8d RR |
26 | * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding |
27 | * @MESH_PATH_RESOLVING: the discovery process is running for this mesh path | |
d19b3bf6 | 28 | * @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence |
ccf80ddf LCC |
29 | * number |
30 | * @MESH_PATH_FIXED: the mesh path has been manually set and should not be | |
31 | * modified | |
32 | * @MESH_PATH_RESOLVED: the mesh path can has been resolved | |
f3011cf9 JC |
33 | * @MESH_PATH_REQ_QUEUED: there is an unsent path request for this destination |
34 | * already queued up, waiting for the discovery process to start. | |
ccf80ddf | 35 | * |
eb80ed8d | 36 | * MESH_PATH_RESOLVED is used by the mesh path timer to |
ccf80ddf LCC |
37 | * decide when to stop or cancel the mesh path discovery. |
38 | */ | |
39 | enum mesh_path_flags { | |
40 | MESH_PATH_ACTIVE = BIT(0), | |
41 | MESH_PATH_RESOLVING = BIT(1), | |
d19b3bf6 | 42 | MESH_PATH_SN_VALID = BIT(2), |
ccf80ddf LCC |
43 | MESH_PATH_FIXED = BIT(3), |
44 | MESH_PATH_RESOLVED = BIT(4), | |
f3011cf9 | 45 | MESH_PATH_REQ_QUEUED = BIT(5), |
ccf80ddf LCC |
46 | }; |
47 | ||
18889231 JC |
48 | /** |
49 | * enum mesh_deferred_task_flags - mac80211 mesh deferred tasks | |
50 | * | |
51 | * | |
52 | * | |
53 | * @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks | |
54 | * @MESH_WORK_GROW_MPATH_TABLE: the mesh path table is full and needs | |
55 | * to grow. | |
56 | * @MESH_WORK_GROW_MPP_TABLE: the mesh portals table is full and needs to | |
57 | * grow | |
e304bfd3 | 58 | * @MESH_WORK_ROOT: the mesh root station needs to send a frame |
dbf498fb JC |
59 | * @MESH_WORK_DRIFT_ADJUST: time to compensate for clock drift relative to other |
60 | * mesh nodes | |
18889231 JC |
61 | */ |
62 | enum mesh_deferred_task_flags { | |
63 | MESH_WORK_HOUSEKEEPING, | |
64 | MESH_WORK_GROW_MPATH_TABLE, | |
65 | MESH_WORK_GROW_MPP_TABLE, | |
e304bfd3 | 66 | MESH_WORK_ROOT, |
dbf498fb | 67 | MESH_WORK_DRIFT_ADJUST, |
18889231 JC |
68 | }; |
69 | ||
ccf80ddf LCC |
70 | /** |
71 | * struct mesh_path - mac80211 mesh path structure | |
72 | * | |
73 | * @dst: mesh path destination mac address | |
f698d856 | 74 | * @sdata: mesh subif |
ccf80ddf LCC |
75 | * @next_hop: mesh neighbor to which frames for this destination will be |
76 | * forwarded | |
77 | * @timer: mesh path discovery timer | |
78 | * @frame_queue: pending queue for frames sent to this destination while the | |
79 | * path is unresolved | |
d19b3bf6 | 80 | * @sn: target sequence number |
ccf80ddf LCC |
81 | * @metric: current metric to this destination |
82 | * @hop_count: hops to destination | |
83 | * @exp_time: in jiffies, when the path will expire or when it expired | |
84 | * @discovery_timeout: timeout (lapse in jiffies) used for the last discovery | |
85 | * retry | |
86 | * @discovery_retries: number of discovery retries | |
87 | * @flags: mesh path flags, as specified on &enum mesh_path_flags | |
f5e50cd0 JC |
88 | * @state_lock: mesh path state lock used to protect changes to the |
89 | * mpath itself. No need to take this lock when adding or removing | |
90 | * an mpath to a hash bucket on a path table. | |
3d045a54 | 91 | * @rann_snd_addr: the RANN sender address |
d2a079fd | 92 | * @rann_metric: the aggregated path metric towards the root node |
728b19e5 | 93 | * @last_preq_to_root: Timestamp of last PREQ sent to root |
3d045a54 | 94 | * @is_root: the destination station of this path is a root node |
5ee68e5b | 95 | * @is_gate: the destination station of this path is a mesh gate |
ccf80ddf LCC |
96 | * |
97 | * | |
f698d856 | 98 | * The combination of dst and sdata is unique in the mesh path table. Since the |
d0709a65 JB |
99 | * next_hop STA is only protected by RCU as well, deleting the STA must also |
100 | * remove/substitute the mesh_path structure and wait until that is no longer | |
101 | * reachable before destroying the STA completely. | |
ccf80ddf LCC |
102 | */ |
103 | struct mesh_path { | |
104 | u8 dst[ETH_ALEN]; | |
79617dee | 105 | u8 mpp[ETH_ALEN]; /* used for MPP or MAP */ |
f698d856 | 106 | struct ieee80211_sub_if_data *sdata; |
40b275b6 | 107 | struct sta_info __rcu *next_hop; |
ccf80ddf LCC |
108 | struct timer_list timer; |
109 | struct sk_buff_head frame_queue; | |
110 | struct rcu_head rcu; | |
d19b3bf6 | 111 | u32 sn; |
ccf80ddf LCC |
112 | u32 metric; |
113 | u8 hop_count; | |
114 | unsigned long exp_time; | |
115 | u32 discovery_timeout; | |
116 | u8 discovery_retries; | |
117 | enum mesh_path_flags flags; | |
118 | spinlock_t state_lock; | |
3d045a54 | 119 | u8 rann_snd_addr[ETH_ALEN]; |
d2a079fd | 120 | u32 rann_metric; |
728b19e5 | 121 | unsigned long last_preq_to_root; |
3d045a54 | 122 | bool is_root; |
5ee68e5b | 123 | bool is_gate; |
ccf80ddf LCC |
124 | }; |
125 | ||
126 | /** | |
127 | * struct mesh_table | |
128 | * | |
129 | * @hash_buckets: array of hash buckets of the table | |
130 | * @hashwlock: array of locks to protect write operations, one per bucket | |
131 | * @hash_mask: 2^size_order - 1, used to compute hash idx | |
132 | * @hash_rnd: random value used for hash computations | |
133 | * @entries: number of entries in the table | |
134 | * @free_node: function to free nodes of the table | |
eef35c2d | 135 | * @copy_node: function to copy nodes of the table |
ccf80ddf LCC |
136 | * @size_order: determines size of the table, there will be 2^size_order hash |
137 | * buckets | |
138 | * @mean_chain_len: maximum average length for the hash buckets' list, if it is | |
139 | * reached, the table will grow | |
5ee68e5b JC |
140 | * @known_gates: list of known mesh gates and their mpaths by the station. The |
141 | * gate's mpath may or may not be resolved and active. | |
142 | * | |
1928ecab | 143 | * rcu_head: RCU head to free the table |
ccf80ddf LCC |
144 | */ |
145 | struct mesh_table { | |
146 | /* Number of buckets will be 2^N */ | |
147 | struct hlist_head *hash_buckets; | |
148 | spinlock_t *hashwlock; /* One per bucket, for add/del */ | |
149 | unsigned int hash_mask; /* (2^size_order) - 1 */ | |
150 | __u32 hash_rnd; /* Used for hash generation */ | |
151 | atomic_t entries; /* Up to MAX_MESH_NEIGHBOURS */ | |
152 | void (*free_node) (struct hlist_node *p, bool free_leafs); | |
4caf86c6 | 153 | int (*copy_node) (struct hlist_node *p, struct mesh_table *newtbl); |
ccf80ddf LCC |
154 | int size_order; |
155 | int mean_chain_len; | |
5ee68e5b JC |
156 | struct hlist_head *known_gates; |
157 | spinlock_t gates_lock; | |
1928ecab JB |
158 | |
159 | struct rcu_head rcu_head; | |
ccf80ddf LCC |
160 | }; |
161 | ||
162 | /* Recent multicast cache */ | |
163 | /* RMC_BUCKETS must be a power of 2, maximum 256 */ | |
164 | #define RMC_BUCKETS 256 | |
165 | #define RMC_QUEUE_MAX_LEN 4 | |
166 | #define RMC_TIMEOUT (3 * HZ) | |
167 | ||
168 | /** | |
169 | * struct rmc_entry - entry in the Recent Multicast Cache | |
170 | * | |
171 | * @seqnum: mesh sequence number of the frame | |
172 | * @exp_time: expiration time of the entry, in jiffies | |
173 | * @sa: source address of the frame | |
174 | * | |
175 | * The Recent Multicast Cache keeps track of the latest multicast frames that | |
176 | * have been received by a mesh interface and discards received multicast frames | |
177 | * that are found in the cache. | |
178 | */ | |
179 | struct rmc_entry { | |
180 | struct list_head list; | |
181 | u32 seqnum; | |
182 | unsigned long exp_time; | |
183 | u8 sa[ETH_ALEN]; | |
184 | }; | |
185 | ||
186 | struct mesh_rmc { | |
187 | struct rmc_entry bucket[RMC_BUCKETS]; | |
51ceddad | 188 | u32 idx_mask; |
ccf80ddf LCC |
189 | }; |
190 | ||
25d49e4d TP |
191 | #define IEEE80211_MESH_PEER_INACTIVITY_LIMIT (1800 * HZ) |
192 | #define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ) | |
ccf80ddf | 193 | |
5b365834 | 194 | #define MESH_DEFAULT_BEACON_INTERVAL 1000 /* in 1024 us units */ |
ccf80ddf | 195 | |
ccf80ddf LCC |
196 | #define MESH_PATH_EXPIRE (600 * HZ) |
197 | ||
ccf80ddf LCC |
198 | /* Default maximum number of plinks per interface */ |
199 | #define MESH_MAX_PLINKS 256 | |
200 | ||
201 | /* Maximum number of paths per interface */ | |
202 | #define MESH_MAX_MPATHS 1024 | |
203 | ||
4bd4c2dd TP |
204 | /* Number of frames buffered per destination for unresolved destinations */ |
205 | #define MESH_FRAME_QUEUE_LEN 10 | |
206 | ||
ccf80ddf LCC |
207 | /* Public interfaces */ |
208 | /* Various */ | |
3c5772a5 | 209 | int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc, |
15ff6365 | 210 | const u8 *da, const u8 *sa); |
ccf80ddf | 211 | int ieee80211_new_mesh_header(struct ieee80211s_hdr *meshhdr, |
61ad5394 JC |
212 | struct ieee80211_sub_if_data *sdata, char *addr4or5, |
213 | char *addr6); | |
ccf80ddf | 214 | int mesh_rmc_check(u8 *addr, struct ieee80211s_hdr *mesh_hdr, |
f698d856 | 215 | struct ieee80211_sub_if_data *sdata); |
f743ff49 TP |
216 | bool mesh_matches_local(struct ieee80211_sub_if_data *sdata, |
217 | struct ieee802_11_elems *ie); | |
472dbc45 | 218 | void mesh_ids_set_default(struct ieee80211_if_mesh *mesh); |
f698d856 JBG |
219 | void mesh_mgmt_ies_add(struct sk_buff *skb, |
220 | struct ieee80211_sub_if_data *sdata); | |
082ebb0c TP |
221 | int mesh_add_meshconf_ie(struct sk_buff *skb, |
222 | struct ieee80211_sub_if_data *sdata); | |
223 | int mesh_add_meshid_ie(struct sk_buff *skb, | |
224 | struct ieee80211_sub_if_data *sdata); | |
225 | int mesh_add_rsn_ie(struct sk_buff *skb, | |
226 | struct ieee80211_sub_if_data *sdata); | |
227 | int mesh_add_vendor_ies(struct sk_buff *skb, | |
228 | struct ieee80211_sub_if_data *sdata); | |
082ebb0c TP |
229 | int mesh_add_ds_params_ie(struct sk_buff *skb, |
230 | struct ieee80211_sub_if_data *sdata); | |
176f3608 TP |
231 | int mesh_add_ht_cap_ie(struct sk_buff *skb, |
232 | struct ieee80211_sub_if_data *sdata); | |
074d46d1 | 233 | int mesh_add_ht_oper_ie(struct sk_buff *skb, |
176f3608 | 234 | struct ieee80211_sub_if_data *sdata); |
f698d856 JBG |
235 | void mesh_rmc_free(struct ieee80211_sub_if_data *sdata); |
236 | int mesh_rmc_init(struct ieee80211_sub_if_data *sdata); | |
ccf80ddf | 237 | void ieee80211s_init(void); |
bfc32e6a | 238 | void ieee80211s_update_metric(struct ieee80211_local *local, |
35b3fe1c | 239 | struct sta_info *sta, struct sk_buff *skb); |
ccf80ddf | 240 | void ieee80211s_stop(void); |
902acc78 | 241 | void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata); |
472dbc45 JB |
242 | void ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata); |
243 | void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata); | |
63c5723b | 244 | void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh); |
8ba7acf3 | 245 | const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method); |
902acc78 | 246 | |
ccf80ddf | 247 | /* Mesh paths */ |
f698d856 JBG |
248 | int mesh_nexthop_lookup(struct sk_buff *skb, |
249 | struct ieee80211_sub_if_data *sdata); | |
0cfda851 TP |
250 | int mesh_nexthop_resolve(struct sk_buff *skb, |
251 | struct ieee80211_sub_if_data *sdata); | |
f698d856 JBG |
252 | void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata); |
253 | struct mesh_path *mesh_path_lookup(u8 *dst, | |
254 | struct ieee80211_sub_if_data *sdata); | |
79617dee Y |
255 | struct mesh_path *mpp_path_lookup(u8 *dst, |
256 | struct ieee80211_sub_if_data *sdata); | |
257 | int mpp_path_add(u8 *dst, u8 *mpp, struct ieee80211_sub_if_data *sdata); | |
f698d856 JBG |
258 | struct mesh_path *mesh_path_lookup_by_idx(int idx, |
259 | struct ieee80211_sub_if_data *sdata); | |
ccf80ddf | 260 | void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop); |
f698d856 | 261 | void mesh_path_expire(struct ieee80211_sub_if_data *sdata); |
f698d856 JBG |
262 | void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata, |
263 | struct ieee80211_mgmt *mgmt, size_t len); | |
264 | int mesh_path_add(u8 *dst, struct ieee80211_sub_if_data *sdata); | |
5ee68e5b JC |
265 | |
266 | int mesh_path_add_gate(struct mesh_path *mpath); | |
267 | int mesh_path_send_to_gates(struct mesh_path *mpath); | |
268 | int mesh_gate_num(struct ieee80211_sub_if_data *sdata); | |
ccf80ddf | 269 | /* Mesh plinks */ |
f743ff49 TP |
270 | void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata, |
271 | u8 *hw_addr, | |
272 | struct ieee802_11_elems *ie); | |
f698d856 | 273 | bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie); |
df323818 | 274 | u32 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata); |
ccf80ddf LCC |
275 | void mesh_plink_broken(struct sta_info *sta); |
276 | void mesh_plink_deactivate(struct sta_info *sta); | |
277 | int mesh_plink_open(struct sta_info *sta); | |
ccf80ddf | 278 | void mesh_plink_block(struct sta_info *sta); |
f698d856 JBG |
279 | void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata, |
280 | struct ieee80211_mgmt *mgmt, size_t len, | |
281 | struct ieee80211_rx_status *rx_status); | |
ccf80ddf LCC |
282 | |
283 | /* Private interfaces */ | |
284 | /* Mesh tables */ | |
18889231 JC |
285 | void mesh_mpath_table_grow(void); |
286 | void mesh_mpp_table_grow(void); | |
ccf80ddf | 287 | /* Mesh paths */ |
d19b3bf6 | 288 | int mesh_path_error_tx(u8 ttl, u8 *target, __le32 target_sn, __le16 target_rcode, |
15ff6365 | 289 | const u8 *ra, struct ieee80211_sub_if_data *sdata); |
ccf80ddf LCC |
290 | void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta); |
291 | void mesh_path_flush_pending(struct mesh_path *mpath); | |
292 | void mesh_path_tx_pending(struct mesh_path *mpath); | |
293 | int mesh_pathtbl_init(void); | |
294 | void mesh_pathtbl_unregister(void); | |
f698d856 | 295 | int mesh_path_del(u8 *addr, struct ieee80211_sub_if_data *sdata); |
ccf80ddf LCC |
296 | void mesh_path_timer(unsigned long data); |
297 | void mesh_path_flush_by_nexthop(struct sta_info *sta); | |
f698d856 JBG |
298 | void mesh_path_discard_frame(struct sk_buff *skb, |
299 | struct ieee80211_sub_if_data *sdata); | |
5bb644a0 JB |
300 | void mesh_path_quiesce(struct ieee80211_sub_if_data *sdata); |
301 | void mesh_path_restart(struct ieee80211_sub_if_data *sdata); | |
e304bfd3 | 302 | void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata); |
ccf80ddf | 303 | |
25d49e4d | 304 | bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt); |
f5ea9120 JB |
305 | extern int mesh_paths_generation; |
306 | ||
902acc78 JB |
307 | #ifdef CONFIG_MAC80211_MESH |
308 | extern int mesh_allocated; | |
309 | ||
ccf80ddf LCC |
310 | static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata) |
311 | { | |
472dbc45 | 312 | return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks - |
1258d976 | 313 | atomic_read(&sdata->u.mesh.estab_plinks); |
ccf80ddf LCC |
314 | } |
315 | ||
316 | static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata) | |
317 | { | |
d0709a65 | 318 | return (min_t(long, mesh_plink_free_count(sdata), |
ccf80ddf LCC |
319 | MESH_MAX_PLINKS - sdata->local->num_sta)) > 0; |
320 | } | |
321 | ||
322 | static inline void mesh_path_activate(struct mesh_path *mpath) | |
323 | { | |
324 | mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED; | |
325 | } | |
326 | ||
c7108a71 JC |
327 | static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata) |
328 | { | |
329 | return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP; | |
330 | } | |
331 | ||
472dbc45 JB |
332 | void ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local); |
333 | ||
5bb644a0 JB |
334 | void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata); |
335 | void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata); | |
336 | void mesh_plink_quiesce(struct sta_info *sta); | |
337 | void mesh_plink_restart(struct sta_info *sta); | |
94c514fe | 338 | void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata); |
dbf498fb | 339 | void mesh_sync_adjust_tbtt(struct ieee80211_sub_if_data *sdata); |
902acc78 JB |
340 | #else |
341 | #define mesh_allocated 0 | |
472dbc45 JB |
342 | static inline void |
343 | ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local) {} | |
5bb644a0 JB |
344 | static inline void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata) |
345 | {} | |
346 | static inline void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata) | |
347 | {} | |
348 | static inline void mesh_plink_quiesce(struct sta_info *sta) {} | |
349 | static inline void mesh_plink_restart(struct sta_info *sta) {} | |
c7108a71 JC |
350 | static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata) |
351 | { return false; } | |
94c514fe AE |
352 | static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata) |
353 | {} | |
902acc78 JB |
354 | #endif |
355 | ||
ccf80ddf | 356 | #endif /* IEEE80211S_H */ |