1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
2 | /* |
3 | * Copyright (c) 2008, 2009 open80211s Ltd. |
4 | * Copyright (C) 2023 Intel Corporation |
5 | * Authors: Luis Carlos Cobo <luisca@cozybit.com> |
6 | * Javier Cardona <javier@cozybit.com> |
7 | */ |
8 | |
9 | #ifndef IEEE80211S_H |
10 | #define IEEE80211S_H |
11 | |
12 | #include <linux/types.h> |
13 | #include <linux/jhash.h> |
14 | #include "ieee80211_i.h" |
15 | |
16 | |
17 | /* Data structures */ |
18 | |
19 | /** |
20 | * enum mesh_path_flags - mac80211 mesh path flags |
21 | * |
22 | * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding |
23 | * @MESH_PATH_RESOLVING: the discovery process is running for this mesh path |
24 | * @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence |
25 | * number |
26 | * @MESH_PATH_FIXED: the mesh path has been manually set and should not be |
27 | * modified |
28 | * @MESH_PATH_RESOLVED: the mesh path can has been resolved |
29 | * @MESH_PATH_REQ_QUEUED: there is an unsent path request for this destination |
30 | * already queued up, waiting for the discovery process to start. |
31 | * @MESH_PATH_DELETED: the mesh path has been deleted and should no longer |
32 | * be used |
33 | * |
34 | * MESH_PATH_RESOLVED is used by the mesh path timer to |
35 | * decide when to stop or cancel the mesh path discovery. |
36 | */ |
37 | enum mesh_path_flags { |
38 | MESH_PATH_ACTIVE = BIT(0), |
39 | MESH_PATH_RESOLVING = BIT(1), |
40 | MESH_PATH_SN_VALID = BIT(2), |
41 | MESH_PATH_FIXED = BIT(3), |
42 | MESH_PATH_RESOLVED = BIT(4), |
43 | MESH_PATH_REQ_QUEUED = BIT(5), |
44 | MESH_PATH_DELETED = BIT(6), |
45 | }; |
46 | |
47 | /** |
48 | * enum mesh_deferred_task_flags - mac80211 mesh deferred tasks |
49 | * |
50 | * |
51 | * |
52 | * @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks |
53 | * @MESH_WORK_ROOT: the mesh root station needs to send a frame |
54 | * @MESH_WORK_DRIFT_ADJUST: time to compensate for clock drift relative to other |
55 | * mesh nodes |
56 | * @MESH_WORK_MBSS_CHANGED: rebuild beacon and notify driver of BSS changes |
57 | */ |
58 | enum mesh_deferred_task_flags { |
59 | MESH_WORK_HOUSEKEEPING, |
60 | MESH_WORK_ROOT, |
61 | MESH_WORK_DRIFT_ADJUST, |
62 | MESH_WORK_MBSS_CHANGED, |
63 | }; |
64 | |
65 | /** |
66 | * struct mesh_path - mac80211 mesh path structure |
67 | * |
68 | * @dst: mesh path destination mac address |
69 | * @mpp: mesh proxy mac address |
70 | * @rhash: rhashtable list pointer |
71 | * @walk_list: linked list containing all mesh_path objects. |
72 | * @gate_list: list pointer for known gates list |
73 | * @sdata: mesh subif |
74 | * @next_hop: mesh neighbor to which frames for this destination will be |
75 | * forwarded |
76 | * @timer: mesh path discovery timer |
77 | * @frame_queue: pending queue for frames sent to this destination while the |
78 | * path is unresolved |
79 | * @rcu: rcu head for freeing mesh path |
80 | * @sn: target sequence number |
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 |
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. |
91 | * @rann_snd_addr: the RANN sender address |
92 | * @rann_metric: the aggregated path metric towards the root node |
93 | * @last_preq_to_root: Timestamp of last PREQ sent to root |
94 | * @is_root: the destination station of this path is a root node |
95 | * @is_gate: the destination station of this path is a mesh gate |
96 | * @path_change_count: the number of path changes to destination |
97 | * |
98 | * |
99 | * The dst address is unique in the mesh path table. Since the mesh_path is |
100 | * protected by RCU, deleting the next_hop STA must remove / substitute the |
101 | * mesh_path structure and wait until that is no longer reachable before |
102 | * destroying the STA completely. |
103 | */ |
104 | struct mesh_path { |
105 | u8 dst[ETH_ALEN]; |
106 | u8 mpp[ETH_ALEN]; /* used for MPP or MAP */ |
107 | struct rhash_head rhash; |
108 | struct hlist_node walk_list; |
109 | struct hlist_node gate_list; |
110 | struct ieee80211_sub_if_data *sdata; |
111 | struct sta_info __rcu *next_hop; |
112 | struct timer_list timer; |
113 | struct sk_buff_head frame_queue; |
114 | struct rcu_head rcu; |
115 | u32 sn; |
116 | u32 metric; |
117 | u8 hop_count; |
118 | unsigned long exp_time; |
119 | u32 discovery_timeout; |
120 | u8 discovery_retries; |
121 | enum mesh_path_flags flags; |
122 | spinlock_t state_lock; |
123 | u8 rann_snd_addr[ETH_ALEN]; |
124 | u32 rann_metric; |
125 | unsigned long last_preq_to_root; |
126 | unsigned long fast_tx_check; |
127 | bool is_root; |
128 | bool is_gate; |
129 | u32 path_change_count; |
130 | }; |
131 | |
132 | #define MESH_FAST_TX_CACHE_MAX_SIZE 512 |
133 | #define MESH_FAST_TX_CACHE_THRESHOLD_SIZE 384 |
134 | #define MESH_FAST_TX_CACHE_TIMEOUT 8000 /* msecs */ |
135 | |
136 | /** |
137 | * struct ieee80211_mesh_fast_tx - cached mesh fast tx entry |
138 | * @rhash: rhashtable pointer |
139 | * @addr_key: The Ethernet DA which is the key for this entry |
140 | * @fast_tx: base fast_tx data |
141 | * @hdr: cached mesh and rfc1042 headers |
142 | * @hdrlen: length of mesh + rfc1042 |
143 | * @walk_list: list containing all the fast tx entries |
144 | * @mpath: mesh path corresponding to the Mesh DA |
145 | * @mppath: MPP entry corresponding to this DA |
146 | * @timestamp: Last used time of this entry |
147 | */ |
148 | struct ieee80211_mesh_fast_tx { |
149 | struct rhash_head rhash; |
150 | u8 addr_key[ETH_ALEN] __aligned(2); |
151 | |
152 | struct ieee80211_fast_tx fast_tx; |
153 | u8 hdr[sizeof(struct ieee80211s_hdr) + sizeof(rfc1042_header)]; |
154 | u16 hdrlen; |
155 | |
156 | struct mesh_path *mpath, *mppath; |
157 | struct hlist_node walk_list; |
158 | unsigned long timestamp; |
159 | }; |
160 | |
161 | /* Recent multicast cache */ |
162 | /* RMC_BUCKETS must be a power of 2, maximum 256 */ |
163 | #define RMC_BUCKETS 256 |
164 | #define RMC_QUEUE_MAX_LEN 4 |
165 | #define RMC_TIMEOUT (3 * HZ) |
166 | |
167 | /** |
168 | * struct rmc_entry - entry in the Recent Multicast Cache |
169 | * |
170 | * @seqnum: mesh sequence number of the frame |
171 | * @exp_time: expiration time of the entry, in jiffies |
172 | * @sa: source address of the frame |
173 | * @list: hashtable list pointer |
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 hlist_node list; |
181 | unsigned long exp_time; |
182 | u32 seqnum; |
183 | u8 sa[ETH_ALEN]; |
184 | }; |
185 | |
186 | struct mesh_rmc { |
187 | struct hlist_head bucket[RMC_BUCKETS]; |
188 | u32 idx_mask; |
189 | }; |
190 | |
191 | #define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ) |
192 | |
193 | #define MESH_PATH_EXPIRE (600 * HZ) |
194 | |
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 | |
201 | /* Number of frames buffered per destination for unresolved destinations */ |
202 | #define MESH_FRAME_QUEUE_LEN 10 |
203 | |
204 | /* Public interfaces */ |
205 | /* Various */ |
206 | int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc, |
207 | const u8 *da, const u8 *sa); |
208 | unsigned int (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); |
213 | bool mesh_matches_local(struct ieee80211_sub_if_data *sdata, |
214 | struct ieee802_11_elems *ie); |
215 | int mesh_add_meshconf_ie(struct ieee80211_sub_if_data *sdata, |
216 | struct sk_buff *skb); |
217 | int mesh_add_meshid_ie(struct ieee80211_sub_if_data *sdata, |
218 | struct sk_buff *skb); |
219 | int mesh_add_rsn_ie(struct ieee80211_sub_if_data *sdata, |
220 | struct sk_buff *skb); |
221 | int mesh_add_vendor_ies(struct ieee80211_sub_if_data *sdata, |
222 | struct sk_buff *skb); |
223 | int mesh_add_ht_cap_ie(struct ieee80211_sub_if_data *sdata, |
224 | struct sk_buff *skb); |
225 | int mesh_add_ht_oper_ie(struct ieee80211_sub_if_data *sdata, |
226 | struct sk_buff *skb); |
227 | int mesh_add_vht_cap_ie(struct ieee80211_sub_if_data *sdata, |
228 | struct sk_buff *skb); |
229 | int mesh_add_vht_oper_ie(struct ieee80211_sub_if_data *sdata, |
230 | struct sk_buff *skb); |
231 | int mesh_add_he_cap_ie(struct ieee80211_sub_if_data *sdata, |
232 | struct sk_buff *skb, u8 ie_len); |
233 | int mesh_add_he_oper_ie(struct ieee80211_sub_if_data *sdata, |
234 | struct sk_buff *skb); |
235 | int mesh_add_he_6ghz_cap_ie(struct ieee80211_sub_if_data *sdata, |
236 | struct sk_buff *skb); |
237 | int mesh_add_eht_cap_ie(struct ieee80211_sub_if_data *sdata, |
238 | struct sk_buff *skb, u8 ie_len); |
239 | int mesh_add_eht_oper_ie(struct ieee80211_sub_if_data *sdata, |
240 | struct sk_buff *skb); |
241 | void mesh_rmc_free(struct ieee80211_sub_if_data *sdata); |
242 | int mesh_rmc_init(struct ieee80211_sub_if_data *sdata); |
243 | void ieee80211s_init(void); |
244 | void ieee80211s_update_metric(struct ieee80211_local *local, |
245 | struct sta_info *sta, |
246 | struct ieee80211_tx_status *st); |
247 | void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata); |
248 | void ieee80211_mesh_teardown_sdata(struct ieee80211_sub_if_data *sdata); |
249 | int ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata); |
250 | void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata); |
251 | void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh); |
252 | const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method); |
253 | /* wrapper for ieee80211_bss_info_change_notify() */ |
254 | void ieee80211_mbss_info_change_notify(struct ieee80211_sub_if_data *sdata, |
255 | u64 changed); |
256 | |
257 | /* mesh power save */ |
258 | u64 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata); |
259 | u64 ieee80211_mps_set_sta_local_pm(struct sta_info *sta, |
260 | enum nl80211_mesh_power_mode pm); |
261 | void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata, |
262 | struct sta_info *sta, |
263 | struct ieee80211_hdr *hdr); |
264 | void ieee80211_mps_sta_status_update(struct sta_info *sta); |
265 | void ieee80211_mps_rx_h_sta_process(struct sta_info *sta, |
266 | struct ieee80211_hdr *hdr); |
267 | void ieee80211_mpsp_trigger_process(u8 *qc, struct sta_info *sta, |
268 | bool tx, bool acked); |
269 | void ieee80211_mps_frame_release(struct sta_info *sta, |
270 | struct ieee802_11_elems *elems); |
271 | |
272 | /* Mesh paths */ |
273 | int mesh_nexthop_lookup(struct ieee80211_sub_if_data *sdata, |
274 | struct sk_buff *skb); |
275 | int mesh_nexthop_resolve(struct ieee80211_sub_if_data *sdata, |
276 | struct sk_buff *skb); |
277 | void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata); |
278 | struct mesh_path *mesh_path_lookup(struct ieee80211_sub_if_data *sdata, |
279 | const u8 *dst); |
280 | struct mesh_path *mpp_path_lookup(struct ieee80211_sub_if_data *sdata, |
281 | const u8 *dst); |
282 | int mpp_path_add(struct ieee80211_sub_if_data *sdata, |
283 | const u8 *dst, const u8 *mpp); |
284 | struct mesh_path * |
285 | mesh_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx); |
286 | struct mesh_path * |
287 | mpp_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx); |
288 | void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop); |
289 | void mesh_path_expire(struct ieee80211_sub_if_data *sdata); |
290 | void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata, |
291 | struct ieee80211_mgmt *mgmt, size_t len); |
292 | struct mesh_path * |
293 | mesh_path_add(struct ieee80211_sub_if_data *sdata, const u8 *dst); |
294 | |
295 | int mesh_path_add_gate(struct mesh_path *mpath); |
296 | int mesh_path_send_to_gates(struct mesh_path *mpath); |
297 | int mesh_gate_num(struct ieee80211_sub_if_data *sdata); |
298 | u32 airtime_link_metric_get(struct ieee80211_local *local, |
299 | struct sta_info *sta); |
300 | |
301 | /* Mesh plinks */ |
302 | void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata, |
303 | u8 *hw_addr, struct ieee802_11_elems *ie, |
304 | struct ieee80211_rx_status *rx_status); |
305 | bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie); |
306 | u64 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata); |
307 | void mesh_plink_timer(struct timer_list *t); |
308 | void mesh_plink_broken(struct sta_info *sta); |
309 | u64 mesh_plink_deactivate(struct sta_info *sta); |
310 | u64 mesh_plink_open(struct sta_info *sta); |
311 | u64 mesh_plink_block(struct sta_info *sta); |
312 | void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata, |
313 | struct ieee80211_mgmt *mgmt, size_t len, |
314 | struct ieee80211_rx_status *rx_status); |
315 | void mesh_sta_cleanup(struct sta_info *sta); |
316 | |
317 | /* Private interfaces */ |
318 | /* Mesh paths */ |
319 | int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata, |
320 | u8 ttl, const u8 *target, u32 target_sn, |
321 | u16 target_rcode, const u8 *ra); |
322 | void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta); |
323 | void mesh_path_flush_pending(struct mesh_path *mpath); |
324 | void mesh_path_tx_pending(struct mesh_path *mpath); |
325 | void mesh_pathtbl_init(struct ieee80211_sub_if_data *sdata); |
326 | void mesh_pathtbl_unregister(struct ieee80211_sub_if_data *sdata); |
327 | int mesh_path_del(struct ieee80211_sub_if_data *sdata, const u8 *addr); |
328 | void mesh_path_timer(struct timer_list *t); |
329 | void mesh_path_flush_by_nexthop(struct sta_info *sta); |
330 | void mesh_path_discard_frame(struct ieee80211_sub_if_data *sdata, |
331 | struct sk_buff *skb); |
332 | void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata); |
333 | |
334 | bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt); |
335 | struct ieee80211_mesh_fast_tx * |
336 | mesh_fast_tx_get(struct ieee80211_sub_if_data *sdata, const u8 *addr); |
337 | bool ieee80211_mesh_xmit_fast(struct ieee80211_sub_if_data *sdata, |
338 | struct sk_buff *skb, u32 ctrl_flags); |
339 | void mesh_fast_tx_cache(struct ieee80211_sub_if_data *sdata, |
340 | struct sk_buff *skb, struct mesh_path *mpath); |
341 | void mesh_fast_tx_gc(struct ieee80211_sub_if_data *sdata); |
342 | void mesh_fast_tx_flush_addr(struct ieee80211_sub_if_data *sdata, |
343 | const u8 *addr); |
344 | void mesh_fast_tx_flush_mpath(struct mesh_path *mpath); |
345 | void mesh_fast_tx_flush_sta(struct ieee80211_sub_if_data *sdata, |
346 | struct sta_info *sta); |
347 | void mesh_path_refresh(struct ieee80211_sub_if_data *sdata, |
348 | struct mesh_path *mpath, const u8 *addr); |
349 | |
350 | #ifdef CONFIG_MAC80211_MESH |
351 | static inline |
352 | u64 mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata) |
353 | { |
354 | atomic_inc(v: &sdata->u.mesh.estab_plinks); |
355 | return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON; |
356 | } |
357 | |
358 | static inline |
359 | u64 mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata) |
360 | { |
361 | atomic_dec(v: &sdata->u.mesh.estab_plinks); |
362 | return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON; |
363 | } |
364 | |
365 | static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata) |
366 | { |
367 | return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks - |
368 | atomic_read(v: &sdata->u.mesh.estab_plinks); |
369 | } |
370 | |
371 | static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata) |
372 | { |
373 | return (min_t(long, mesh_plink_free_count(sdata), |
374 | MESH_MAX_PLINKS - sdata->local->num_sta)) > 0; |
375 | } |
376 | |
377 | static inline void mesh_path_activate(struct mesh_path *mpath) |
378 | { |
379 | mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED; |
380 | } |
381 | |
382 | static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata) |
383 | { |
384 | return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP; |
385 | } |
386 | |
387 | void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata); |
388 | void mesh_sync_adjust_tsf(struct ieee80211_sub_if_data *sdata); |
389 | void ieee80211s_stop(void); |
390 | #else |
391 | static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata) |
392 | { return false; } |
393 | static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata) |
394 | {} |
395 | static inline void ieee80211s_stop(void) {} |
396 | #endif |
397 | |
398 | #endif /* IEEE80211S_H */ |
399 | |