]>
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 |
bf7cd94d | 29 | * number |
ccf80ddf | 30 | * @MESH_PATH_FIXED: the mesh path has been manually set and should not be |
bf7cd94d | 31 | * modified |
ccf80ddf | 32 | * @MESH_PATH_RESOLVED: the mesh path can has been resolved |
f3011cf9 | 33 | * @MESH_PATH_REQ_QUEUED: there is an unsent path request for this destination |
bf7cd94d | 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 | 75 | * @next_hop: mesh neighbor to which frames for this destination will be |
bf7cd94d | 76 | * forwarded |
ccf80ddf LCC |
77 | * @timer: mesh path discovery timer |
78 | * @frame_queue: pending queue for frames sent to this destination while the | |
bf7cd94d | 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 | |
bf7cd94d | 85 | * retry |
ccf80ddf LCC |
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 { | |
b7cfcd11 | 187 | struct list_head bucket[RMC_BUCKETS]; |
51ceddad | 188 | u32 idx_mask; |
ccf80ddf LCC |
189 | }; |
190 | ||
25d49e4d | 191 | #define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ) |
ccf80ddf | 192 | |
ccf80ddf LCC |
193 | #define MESH_PATH_EXPIRE (600 * HZ) |
194 | ||
ccf80ddf LCC |
195 | /* Default maximum number of plinks per interface */ |
196 | #define MESH_MAX_PLINKS 256 | |
197 | ||
198 | /* Maximum number of paths per interface */ | |
199 | #define MESH_MAX_MPATHS 1024 | |
200 | ||
4bd4c2dd TP |
201 | /* Number of frames buffered per destination for unresolved destinations */ |
202 | #define MESH_FRAME_QUEUE_LEN 10 | |
203 | ||
ccf80ddf LCC |
204 | /* Public interfaces */ |
205 | /* Various */ | |
3c5772a5 | 206 | int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc, |
15ff6365 | 207 | const u8 *da, const u8 *sa); |
bf7cd94d JB |
208 | int ieee80211_new_mesh_header(struct ieee80211_sub_if_data *sdata, |
209 | struct ieee80211s_hdr *meshhdr, | |
210 | const char *addr4or5, const char *addr6); | |
211 | int mesh_rmc_check(struct ieee80211_sub_if_data *sdata, | |
212 | const u8 *addr, struct ieee80211s_hdr *mesh_hdr); | |
f743ff49 TP |
213 | bool mesh_matches_local(struct ieee80211_sub_if_data *sdata, |
214 | struct ieee802_11_elems *ie); | |
472dbc45 | 215 | void mesh_ids_set_default(struct ieee80211_if_mesh *mesh); |
bf7cd94d JB |
216 | void mesh_mgmt_ies_add(struct ieee80211_sub_if_data *sdata, |
217 | struct sk_buff *skb); | |
218 | int mesh_add_meshconf_ie(struct ieee80211_sub_if_data *sdata, | |
219 | struct sk_buff *skb); | |
220 | int mesh_add_meshid_ie(struct ieee80211_sub_if_data *sdata, | |
221 | struct sk_buff *skb); | |
222 | int mesh_add_rsn_ie(struct ieee80211_sub_if_data *sdata, | |
223 | struct sk_buff *skb); | |
224 | int mesh_add_vendor_ies(struct ieee80211_sub_if_data *sdata, | |
225 | struct sk_buff *skb); | |
226 | int mesh_add_ht_cap_ie(struct ieee80211_sub_if_data *sdata, | |
227 | struct sk_buff *skb); | |
228 | int mesh_add_ht_oper_ie(struct ieee80211_sub_if_data *sdata, | |
229 | struct sk_buff *skb); | |
f698d856 JBG |
230 | void mesh_rmc_free(struct ieee80211_sub_if_data *sdata); |
231 | int mesh_rmc_init(struct ieee80211_sub_if_data *sdata); | |
ccf80ddf | 232 | void ieee80211s_init(void); |
bfc32e6a | 233 | void ieee80211s_update_metric(struct ieee80211_local *local, |
bf7cd94d | 234 | struct sta_info *sta, struct sk_buff *skb); |
902acc78 | 235 | void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata); |
2b5e1967 | 236 | int ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata); |
472dbc45 | 237 | void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata); |
63c5723b | 238 | void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh); |
8ba7acf3 | 239 | const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method); |
2b5e1967 TP |
240 | /* wrapper for ieee80211_bss_info_change_notify() */ |
241 | void ieee80211_mbss_info_change_notify(struct ieee80211_sub_if_data *sdata, | |
242 | u32 changed); | |
902acc78 | 243 | |
3f52b7e3 | 244 | /* mesh power save */ |
39886b61 TP |
245 | u32 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata); |
246 | u32 ieee80211_mps_set_sta_local_pm(struct sta_info *sta, | |
247 | enum nl80211_mesh_power_mode pm); | |
3f52b7e3 MP |
248 | void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata, |
249 | struct sta_info *sta, | |
250 | struct ieee80211_hdr *hdr); | |
251 | void ieee80211_mps_sta_status_update(struct sta_info *sta); | |
252 | void ieee80211_mps_rx_h_sta_process(struct sta_info *sta, | |
253 | struct ieee80211_hdr *hdr); | |
254 | void ieee80211_mpsp_trigger_process(u8 *qc, struct sta_info *sta, | |
255 | bool tx, bool acked); | |
256 | void ieee80211_mps_frame_release(struct sta_info *sta, | |
257 | struct ieee802_11_elems *elems); | |
258 | ||
ccf80ddf | 259 | /* Mesh paths */ |
bf7cd94d JB |
260 | int mesh_nexthop_lookup(struct ieee80211_sub_if_data *sdata, |
261 | struct sk_buff *skb); | |
262 | int mesh_nexthop_resolve(struct ieee80211_sub_if_data *sdata, | |
263 | struct sk_buff *skb); | |
f698d856 | 264 | void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata); |
bf7cd94d JB |
265 | struct mesh_path *mesh_path_lookup(struct ieee80211_sub_if_data *sdata, |
266 | const u8 *dst); | |
267 | struct mesh_path *mpp_path_lookup(struct ieee80211_sub_if_data *sdata, | |
268 | const u8 *dst); | |
269 | int mpp_path_add(struct ieee80211_sub_if_data *sdata, | |
270 | const u8 *dst, const u8 *mpp); | |
271 | struct mesh_path * | |
272 | mesh_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx); | |
ccf80ddf | 273 | void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop); |
f698d856 | 274 | void mesh_path_expire(struct ieee80211_sub_if_data *sdata); |
f698d856 | 275 | void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata, |
bf7cd94d | 276 | struct ieee80211_mgmt *mgmt, size_t len); |
ae76eef0 BC |
277 | struct mesh_path * |
278 | mesh_path_add(struct ieee80211_sub_if_data *sdata, const u8 *dst); | |
5ee68e5b JC |
279 | |
280 | int mesh_path_add_gate(struct mesh_path *mpath); | |
281 | int mesh_path_send_to_gates(struct mesh_path *mpath); | |
282 | int mesh_gate_num(struct ieee80211_sub_if_data *sdata); | |
bf7cd94d | 283 | |
ccf80ddf | 284 | /* Mesh plinks */ |
f743ff49 | 285 | void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata, |
bf7cd94d | 286 | u8 *hw_addr, struct ieee802_11_elems *ie); |
f698d856 | 287 | bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie); |
df323818 | 288 | u32 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata); |
ccf80ddf | 289 | void mesh_plink_broken(struct sta_info *sta); |
45b5028e | 290 | u32 mesh_plink_deactivate(struct sta_info *sta); |
39886b61 TP |
291 | u32 mesh_plink_open(struct sta_info *sta); |
292 | u32 mesh_plink_block(struct sta_info *sta); | |
f698d856 JBG |
293 | void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata, |
294 | struct ieee80211_mgmt *mgmt, size_t len, | |
295 | struct ieee80211_rx_status *rx_status); | |
45b5028e | 296 | void mesh_sta_cleanup(struct sta_info *sta); |
ccf80ddf LCC |
297 | |
298 | /* Private interfaces */ | |
299 | /* Mesh tables */ | |
18889231 JC |
300 | void mesh_mpath_table_grow(void); |
301 | void mesh_mpp_table_grow(void); | |
ccf80ddf | 302 | /* Mesh paths */ |
bf7cd94d JB |
303 | int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata, |
304 | u8 ttl, const u8 *target, __le32 target_sn, | |
305 | __le16 target_rcode, const u8 *ra); | |
ccf80ddf LCC |
306 | void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta); |
307 | void mesh_path_flush_pending(struct mesh_path *mpath); | |
308 | void mesh_path_tx_pending(struct mesh_path *mpath); | |
309 | int mesh_pathtbl_init(void); | |
310 | void mesh_pathtbl_unregister(void); | |
bf7cd94d | 311 | int mesh_path_del(struct ieee80211_sub_if_data *sdata, const u8 *addr); |
ccf80ddf LCC |
312 | void mesh_path_timer(unsigned long data); |
313 | void mesh_path_flush_by_nexthop(struct sta_info *sta); | |
bf7cd94d JB |
314 | void mesh_path_discard_frame(struct ieee80211_sub_if_data *sdata, |
315 | struct sk_buff *skb); | |
e304bfd3 | 316 | void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata); |
ccf80ddf | 317 | |
25d49e4d | 318 | bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt); |
f5ea9120 JB |
319 | extern int mesh_paths_generation; |
320 | ||
902acc78 | 321 | #ifdef CONFIG_MAC80211_MESH |
1617bab8 MP |
322 | static inline |
323 | u32 mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata) | |
324 | { | |
325 | atomic_inc(&sdata->u.mesh.estab_plinks); | |
e05ecccd | 326 | return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON; |
1617bab8 MP |
327 | } |
328 | ||
329 | static inline | |
330 | u32 mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata) | |
331 | { | |
332 | atomic_dec(&sdata->u.mesh.estab_plinks); | |
e05ecccd | 333 | return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON; |
1617bab8 MP |
334 | } |
335 | ||
ccf80ddf LCC |
336 | static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata) |
337 | { | |
472dbc45 | 338 | return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks - |
1258d976 | 339 | atomic_read(&sdata->u.mesh.estab_plinks); |
ccf80ddf LCC |
340 | } |
341 | ||
342 | static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata) | |
343 | { | |
d0709a65 | 344 | return (min_t(long, mesh_plink_free_count(sdata), |
ccf80ddf LCC |
345 | MESH_MAX_PLINKS - sdata->local->num_sta)) > 0; |
346 | } | |
347 | ||
348 | static inline void mesh_path_activate(struct mesh_path *mpath) | |
349 | { | |
350 | mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED; | |
351 | } | |
352 | ||
c7108a71 JC |
353 | static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata) |
354 | { | |
355 | return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP; | |
356 | } | |
357 | ||
472dbc45 JB |
358 | void ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local); |
359 | ||
94c514fe | 360 | void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata); |
dbf498fb | 361 | void mesh_sync_adjust_tbtt(struct ieee80211_sub_if_data *sdata); |
bf7cd94d | 362 | void ieee80211s_stop(void); |
902acc78 | 363 | #else |
472dbc45 JB |
364 | static inline void |
365 | ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local) {} | |
c7108a71 JC |
366 | static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata) |
367 | { return false; } | |
94c514fe AE |
368 | static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata) |
369 | {} | |
bf7cd94d | 370 | static inline void ieee80211s_stop(void) {} |
902acc78 JB |
371 | #endif |
372 | ||
ccf80ddf | 373 | #endif /* IEEE80211S_H */ |