1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright (c) 2008, 2009 open80211s Ltd. 4 * Copyright (C) 2023-2024 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 * @fast_tx_check: timestamp of last fast-xmit enable attempt 98 * 99 * 100 * The dst address is unique in the mesh path table. Since the mesh_path is 101 * protected by RCU, deleting the next_hop STA must remove / substitute the 102 * mesh_path structure and wait until that is no longer reachable before 103 * destroying the STA completely. 104 */ 105 struct mesh_path { 106 u8 dst[ETH_ALEN]; 107 u8 mpp[ETH_ALEN]; /* used for MPP or MAP */ 108 struct rhash_head rhash; 109 struct hlist_node walk_list; 110 struct hlist_node gate_list; 111 struct ieee80211_sub_if_data *sdata; 112 struct sta_info __rcu *next_hop; 113 struct timer_list timer; 114 struct sk_buff_head frame_queue; 115 struct rcu_head rcu; 116 u32 sn; 117 u32 metric; 118 u8 hop_count; 119 unsigned long exp_time; 120 u32 discovery_timeout; 121 u8 discovery_retries; 122 enum mesh_path_flags flags; 123 spinlock_t state_lock; 124 u8 rann_snd_addr[ETH_ALEN]; 125 u32 rann_metric; 126 unsigned long last_preq_to_root; 127 unsigned long fast_tx_check; 128 bool is_root; 129 bool is_gate; 130 u32 path_change_count; 131 }; 132 133 #define MESH_FAST_TX_CACHE_MAX_SIZE 512 134 #define MESH_FAST_TX_CACHE_THRESHOLD_SIZE 384 135 #define MESH_FAST_TX_CACHE_TIMEOUT 8000 /* msecs */ 136 137 /** 138 * enum ieee80211_mesh_fast_tx_type - cached mesh fast tx entry type 139 * 140 * @MESH_FAST_TX_TYPE_LOCAL: tx from the local vif address as SA 141 * @MESH_FAST_TX_TYPE_PROXIED: local tx with a different SA (e.g. bridged) 142 * @MESH_FAST_TX_TYPE_FORWARDED: forwarded from a different mesh point 143 * @NUM_MESH_FAST_TX_TYPE: number of entry types 144 */ 145 enum ieee80211_mesh_fast_tx_type { 146 MESH_FAST_TX_TYPE_LOCAL, 147 MESH_FAST_TX_TYPE_PROXIED, 148 MESH_FAST_TX_TYPE_FORWARDED, 149 150 /* must be last */ 151 NUM_MESH_FAST_TX_TYPE 152 }; 153 154 155 /** 156 * struct ieee80211_mesh_fast_tx_key - cached mesh fast tx entry key 157 * 158 * @addr: The Ethernet DA for this entry 159 * @type: cache entry type 160 */ 161 struct ieee80211_mesh_fast_tx_key { 162 u8 addr[ETH_ALEN] __aligned(2); 163 u16 type; 164 }; 165 166 /** 167 * struct ieee80211_mesh_fast_tx - cached mesh fast tx entry 168 * @rhash: rhashtable pointer 169 * @key: the lookup key for this cache entry 170 * @fast_tx: base fast_tx data 171 * @hdr: cached mesh and rfc1042 headers 172 * @hdrlen: length of mesh + rfc1042 173 * @walk_list: list containing all the fast tx entries 174 * @mpath: mesh path corresponding to the Mesh DA 175 * @mppath: MPP entry corresponding to this DA 176 * @timestamp: Last used time of this entry 177 */ 178 struct ieee80211_mesh_fast_tx { 179 struct rhash_head rhash; 180 struct ieee80211_mesh_fast_tx_key key; 181 182 struct ieee80211_fast_tx fast_tx; 183 u8 hdr[sizeof(struct ieee80211s_hdr) + sizeof(rfc1042_header)]; 184 u16 hdrlen; 185 186 struct mesh_path *mpath, *mppath; 187 struct hlist_node walk_list; 188 unsigned long timestamp; 189 }; 190 191 /* Recent multicast cache */ 192 /* RMC_BUCKETS must be a power of 2, maximum 256 */ 193 #define RMC_BUCKETS 256 194 #define RMC_QUEUE_MAX_LEN 4 195 #define RMC_TIMEOUT (3 * HZ) 196 197 /** 198 * struct rmc_entry - entry in the Recent Multicast Cache 199 * 200 * @seqnum: mesh sequence number of the frame 201 * @exp_time: expiration time of the entry, in jiffies 202 * @sa: source address of the frame 203 * @list: hashtable list pointer 204 * 205 * The Recent Multicast Cache keeps track of the latest multicast frames that 206 * have been received by a mesh interface and discards received multicast frames 207 * that are found in the cache. 208 */ 209 struct rmc_entry { 210 struct hlist_node list; 211 unsigned long exp_time; 212 u32 seqnum; 213 u8 sa[ETH_ALEN]; 214 }; 215 216 struct mesh_rmc { 217 struct hlist_head bucket[RMC_BUCKETS]; 218 u32 idx_mask; 219 }; 220 221 #define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ) 222 223 #define MESH_PATH_EXPIRE (600 * HZ) 224 225 /* Default maximum number of plinks per interface */ 226 #define MESH_MAX_PLINKS 256 227 228 /* Maximum number of paths per interface */ 229 #define MESH_MAX_MPATHS 1024 230 231 /* Number of frames buffered per destination for unresolved destinations */ 232 #define MESH_FRAME_QUEUE_LEN 10 233 234 /* Public interfaces */ 235 /* Various */ 236 int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc, 237 const u8 *da, const u8 *sa); 238 unsigned int ieee80211_new_mesh_header(struct ieee80211_sub_if_data *sdata, 239 struct ieee80211s_hdr *meshhdr, 240 const char *addr4or5, const char *addr6); 241 int mesh_rmc_check(struct ieee80211_sub_if_data *sdata, 242 const u8 *addr, struct ieee80211s_hdr *mesh_hdr); 243 bool mesh_matches_local(struct ieee80211_sub_if_data *sdata, 244 struct ieee802_11_elems *ie); 245 int mesh_add_meshconf_ie(struct ieee80211_sub_if_data *sdata, 246 struct sk_buff *skb); 247 int mesh_add_meshid_ie(struct ieee80211_sub_if_data *sdata, 248 struct sk_buff *skb); 249 int mesh_add_rsn_ie(struct ieee80211_sub_if_data *sdata, 250 struct sk_buff *skb); 251 int mesh_add_vendor_ies(struct ieee80211_sub_if_data *sdata, 252 struct sk_buff *skb); 253 int mesh_add_ht_cap_ie(struct ieee80211_sub_if_data *sdata, 254 struct sk_buff *skb); 255 int mesh_add_ht_oper_ie(struct ieee80211_sub_if_data *sdata, 256 struct sk_buff *skb); 257 int mesh_add_vht_cap_ie(struct ieee80211_sub_if_data *sdata, 258 struct sk_buff *skb); 259 int mesh_add_vht_oper_ie(struct ieee80211_sub_if_data *sdata, 260 struct sk_buff *skb); 261 int mesh_add_he_cap_ie(struct ieee80211_sub_if_data *sdata, 262 struct sk_buff *skb, u8 ie_len); 263 int mesh_add_he_oper_ie(struct ieee80211_sub_if_data *sdata, 264 struct sk_buff *skb); 265 int mesh_add_he_6ghz_cap_ie(struct ieee80211_sub_if_data *sdata, 266 struct sk_buff *skb); 267 int mesh_add_eht_cap_ie(struct ieee80211_sub_if_data *sdata, 268 struct sk_buff *skb, u8 ie_len); 269 int mesh_add_eht_oper_ie(struct ieee80211_sub_if_data *sdata, 270 struct sk_buff *skb); 271 void mesh_rmc_free(struct ieee80211_sub_if_data *sdata); 272 int mesh_rmc_init(struct ieee80211_sub_if_data *sdata); 273 void ieee80211s_init(void); 274 void ieee80211s_update_metric(struct ieee80211_local *local, 275 struct sta_info *sta, 276 struct ieee80211_tx_status *st); 277 void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata); 278 void ieee80211_mesh_teardown_sdata(struct ieee80211_sub_if_data *sdata); 279 int ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata); 280 void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata); 281 void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh); 282 const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method); 283 /* wrapper for ieee80211_bss_info_change_notify() */ 284 void ieee80211_mbss_info_change_notify(struct ieee80211_sub_if_data *sdata, 285 u64 changed); 286 287 /* mesh power save */ 288 u64 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata); 289 u64 ieee80211_mps_set_sta_local_pm(struct sta_info *sta, 290 enum nl80211_mesh_power_mode pm); 291 void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata, 292 struct sta_info *sta, 293 struct ieee80211_hdr *hdr); 294 void ieee80211_mps_sta_status_update(struct sta_info *sta); 295 void ieee80211_mps_rx_h_sta_process(struct sta_info *sta, 296 struct ieee80211_hdr *hdr); 297 void ieee80211_mpsp_trigger_process(u8 *qc, struct sta_info *sta, 298 bool tx, bool acked); 299 void ieee80211_mps_frame_release(struct sta_info *sta, 300 struct ieee802_11_elems *elems); 301 302 /* Mesh paths */ 303 int mesh_nexthop_lookup(struct ieee80211_sub_if_data *sdata, 304 struct sk_buff *skb); 305 int mesh_nexthop_resolve(struct ieee80211_sub_if_data *sdata, 306 struct sk_buff *skb); 307 void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata); 308 struct mesh_path *mesh_path_lookup(struct ieee80211_sub_if_data *sdata, 309 const u8 *dst); 310 struct mesh_path *mpp_path_lookup(struct ieee80211_sub_if_data *sdata, 311 const u8 *dst); 312 int mpp_path_add(struct ieee80211_sub_if_data *sdata, 313 const u8 *dst, const u8 *mpp); 314 struct mesh_path * 315 mesh_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx); 316 struct mesh_path * 317 mpp_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx); 318 void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop); 319 void mesh_path_expire(struct ieee80211_sub_if_data *sdata); 320 void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata, 321 struct ieee80211_mgmt *mgmt, size_t len); 322 struct mesh_path * 323 mesh_path_add(struct ieee80211_sub_if_data *sdata, const u8 *dst); 324 325 int mesh_path_add_gate(struct mesh_path *mpath); 326 int mesh_path_send_to_gates(struct mesh_path *mpath); 327 int mesh_gate_num(struct ieee80211_sub_if_data *sdata); 328 u32 airtime_link_metric_get(struct ieee80211_local *local, 329 struct sta_info *sta); 330 331 /* Mesh plinks */ 332 void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata, 333 u8 *hw_addr, struct ieee802_11_elems *ie, 334 struct ieee80211_rx_status *rx_status); 335 bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie); 336 u64 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata); 337 void mesh_plink_timer(struct timer_list *t); 338 void mesh_plink_broken(struct sta_info *sta); 339 u64 mesh_plink_deactivate(struct sta_info *sta); 340 u64 mesh_plink_open(struct sta_info *sta); 341 u64 mesh_plink_block(struct sta_info *sta); 342 void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata, 343 struct ieee80211_mgmt *mgmt, size_t len, 344 struct ieee80211_rx_status *rx_status); 345 void mesh_sta_cleanup(struct sta_info *sta); 346 347 /* Private interfaces */ 348 /* Mesh paths */ 349 int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata, 350 u8 ttl, const u8 *target, u32 target_sn, 351 u16 target_rcode, const u8 *ra); 352 void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta); 353 void mesh_path_flush_pending(struct mesh_path *mpath); 354 void mesh_path_tx_pending(struct mesh_path *mpath); 355 void mesh_pathtbl_init(struct ieee80211_sub_if_data *sdata); 356 void mesh_pathtbl_unregister(struct ieee80211_sub_if_data *sdata); 357 int mesh_path_del(struct ieee80211_sub_if_data *sdata, const u8 *addr); 358 void mesh_path_timer(struct timer_list *t); 359 void mesh_path_flush_by_nexthop(struct sta_info *sta); 360 void mesh_path_discard_frame(struct ieee80211_sub_if_data *sdata, 361 struct sk_buff *skb); 362 void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata); 363 364 bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt); 365 struct ieee80211_mesh_fast_tx * 366 mesh_fast_tx_get(struct ieee80211_sub_if_data *sdata, 367 struct ieee80211_mesh_fast_tx_key *key); 368 bool ieee80211_mesh_xmit_fast(struct ieee80211_sub_if_data *sdata, 369 struct sk_buff *skb, u32 ctrl_flags); 370 void mesh_fast_tx_cache(struct ieee80211_sub_if_data *sdata, 371 struct sk_buff *skb, struct mesh_path *mpath); 372 void mesh_fast_tx_gc(struct ieee80211_sub_if_data *sdata); 373 void mesh_fast_tx_flush_addr(struct ieee80211_sub_if_data *sdata, 374 const u8 *addr); 375 void mesh_fast_tx_flush_mpath(struct mesh_path *mpath); 376 void mesh_fast_tx_flush_sta(struct ieee80211_sub_if_data *sdata, 377 struct sta_info *sta); 378 void mesh_path_refresh(struct ieee80211_sub_if_data *sdata, 379 struct mesh_path *mpath, const u8 *addr); 380 381 #ifdef CONFIG_MAC80211_MESH 382 static inline mesh_plink_inc_estab_count(struct ieee80211_sub_if_data * sdata)383 u64 mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata) 384 { 385 atomic_inc(&sdata->u.mesh.estab_plinks); 386 return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON; 387 } 388 389 static inline mesh_plink_dec_estab_count(struct ieee80211_sub_if_data * sdata)390 u64 mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata) 391 { 392 atomic_dec(&sdata->u.mesh.estab_plinks); 393 return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON; 394 } 395 mesh_plink_free_count(struct ieee80211_sub_if_data * sdata)396 static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata) 397 { 398 return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks - 399 atomic_read(&sdata->u.mesh.estab_plinks); 400 } 401 mesh_plink_availables(struct ieee80211_sub_if_data * sdata)402 static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata) 403 { 404 return (min_t(long, mesh_plink_free_count(sdata), 405 MESH_MAX_PLINKS - sdata->local->num_sta)) > 0; 406 } 407 mesh_path_activate(struct mesh_path * mpath)408 static inline void mesh_path_activate(struct mesh_path *mpath) 409 { 410 mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED; 411 } 412 mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data * sdata)413 static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata) 414 { 415 return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP; 416 } 417 418 void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata); 419 void mesh_sync_adjust_tsf(struct ieee80211_sub_if_data *sdata); 420 void ieee80211s_stop(void); 421 #else mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data * sdata)422 static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata) 423 { return false; } mesh_path_flush_by_iface(struct ieee80211_sub_if_data * sdata)424 static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata) 425 {} ieee80211s_stop(void)426 static inline void ieee80211s_stop(void) {} 427 #endif 428 429 #endif /* IEEE80211S_H */ 430