net/mac80211/mesh.h

   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  * struct ieee80211_mesh_fast_tx - cached mesh fast tx entry
 139  * @rhash: rhashtable pointer
 140  * @addr_key: The Ethernet DA which is the key for this entry
 141  * @fast_tx: base fast_tx data
 142  * @hdr: cached mesh and rfc1042 headers
 143  * @hdrlen: length of mesh + rfc1042
 144  * @walk_list: list containing all the fast tx entries
 145  * @mpath: mesh path corresponding to the Mesh DA
 146  * @mppath: MPP entry corresponding to this DA
 147  * @timestamp: Last used time of this entry
 148  */
 149 struct ieee80211_mesh_fast_tx {
 150         struct rhash_head rhash;
 151         u8 addr_key[ETH_ALEN] __aligned(2);
 152
 153         struct ieee80211_fast_tx fast_tx;
 154         u8 hdr[sizeof(struct ieee80211s_hdr) + sizeof(rfc1042_header)];
 155         u16 hdrlen;
 156
 157         struct mesh_path *mpath, *mppath;
 158         struct hlist_node walk_list;
 159         unsigned long timestamp;
 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  * @list: hashtable list pointer
 175  *
 176  * The Recent Multicast Cache keeps track of the latest multicast frames that
 177  * have been received by a mesh interface and discards received multicast frames
 178  * that are found in the cache.
 179  */
 180 struct rmc_entry {
 181         struct hlist_node list;
 182         unsigned long exp_time;
 183         u32 seqnum;
 184         u8 sa[ETH_ALEN];
 185 };
 186
 187 struct mesh_rmc {
 188         struct hlist_head bucket[RMC_BUCKETS];
 189         u32 idx_mask;
 190 };
 191
 192 #define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)
 193
 194 #define MESH_PATH_EXPIRE (600 * HZ)
 195
 196 /* Default maximum number of plinks per interface */
 197 #define MESH_MAX_PLINKS         256
 198
 199 /* Maximum number of paths per interface */
 200 #define MESH_MAX_MPATHS         1024
 201
 202 /* Number of frames buffered per destination for unresolved destinations */
 203 #define MESH_FRAME_QUEUE_LEN    10
 204
 205 /* Public interfaces */
 206 /* Various */
 207 int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,
 208                                   const u8 *da, const u8 *sa);
 209 unsigned int ieee80211_new_mesh_header(struct ieee80211_sub_if_data *sdata,
 210                                        struct ieee80211s_hdr *meshhdr,
 211                                        const char *addr4or5, const char *addr6);
 212 int mesh_rmc_check(struct ieee80211_sub_if_data *sdata,
 213                    const u8 *addr, struct ieee80211s_hdr *mesh_hdr);
 214 bool mesh_matches_local(struct ieee80211_sub_if_data *sdata,
 215                         struct ieee802_11_elems *ie);
 216 int mesh_add_meshconf_ie(struct ieee80211_sub_if_data *sdata,
 217                          struct sk_buff *skb);
 218 int mesh_add_meshid_ie(struct ieee80211_sub_if_data *sdata,
 219                        struct sk_buff *skb);
 220 int mesh_add_rsn_ie(struct ieee80211_sub_if_data *sdata,
 221                     struct sk_buff *skb);
 222 int mesh_add_vendor_ies(struct ieee80211_sub_if_data *sdata,
 223                         struct sk_buff *skb);
 224 int mesh_add_ht_cap_ie(struct ieee80211_sub_if_data *sdata,
 225                        struct sk_buff *skb);
 226 int mesh_add_ht_oper_ie(struct ieee80211_sub_if_data *sdata,
 227                         struct sk_buff *skb);
 228 int mesh_add_vht_cap_ie(struct ieee80211_sub_if_data *sdata,
 229                         struct sk_buff *skb);
 230 int mesh_add_vht_oper_ie(struct ieee80211_sub_if_data *sdata,
 231                          struct sk_buff *skb);
 232 int mesh_add_he_cap_ie(struct ieee80211_sub_if_data *sdata,
 233                        struct sk_buff *skb, u8 ie_len);
 234 int mesh_add_he_oper_ie(struct ieee80211_sub_if_data *sdata,
 235                         struct sk_buff *skb);
 236 int mesh_add_he_6ghz_cap_ie(struct ieee80211_sub_if_data *sdata,
 237                             struct sk_buff *skb);
 238 int mesh_add_eht_cap_ie(struct ieee80211_sub_if_data *sdata,
 239                         struct sk_buff *skb, u8 ie_len);
 240 int mesh_add_eht_oper_ie(struct ieee80211_sub_if_data *sdata,
 241                          struct sk_buff *skb);
 242 void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
 243 int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
 244 void ieee80211s_init(void);
 245 void ieee80211s_update_metric(struct ieee80211_local *local,
 246                               struct sta_info *sta,
 247                               struct ieee80211_tx_status *st);
 248 void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
 249 void ieee80211_mesh_teardown_sdata(struct ieee80211_sub_if_data *sdata);
 250 int ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
 251 void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
 252 void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
 253 const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method);
 254 /* wrapper for ieee80211_bss_info_change_notify() */
 255 void ieee80211_mbss_info_change_notify(struct ieee80211_sub_if_data *sdata,
 256                                        u64 changed);
 257
 258 /* mesh power save */
 259 u64 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata);
 260 u64 ieee80211_mps_set_sta_local_pm(struct sta_info *sta,
 261                                    enum nl80211_mesh_power_mode pm);
 262 void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata,
 263                                    struct sta_info *sta,
 264                                    struct ieee80211_hdr *hdr);
 265 void ieee80211_mps_sta_status_update(struct sta_info *sta);
 266 void ieee80211_mps_rx_h_sta_process(struct sta_info *sta,
 267                                     struct ieee80211_hdr *hdr);
 268 void ieee80211_mpsp_trigger_process(u8 *qc, struct sta_info *sta,
 269                                     bool tx, bool acked);
 270 void ieee80211_mps_frame_release(struct sta_info *sta,
 271                                  struct ieee802_11_elems *elems);
 272
 273 /* Mesh paths */
 274 int mesh_nexthop_lookup(struct ieee80211_sub_if_data *sdata,
 275                         struct sk_buff *skb);
 276 int mesh_nexthop_resolve(struct ieee80211_sub_if_data *sdata,
 277                          struct sk_buff *skb);
 278 void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
 279 struct mesh_path *mesh_path_lookup(struct ieee80211_sub_if_data *sdata,
 280                                    const u8 *dst);
 281 struct mesh_path *mpp_path_lookup(struct ieee80211_sub_if_data *sdata,
 282                                   const u8 *dst);
 283 int mpp_path_add(struct ieee80211_sub_if_data *sdata,
 284                  const u8 *dst, const u8 *mpp);
 285 struct mesh_path *
 286 mesh_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
 287 struct mesh_path *
 288 mpp_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
 289 void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop);
 290 void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
 291 void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
 292                             struct ieee80211_mgmt *mgmt, size_t len);
 293 struct mesh_path *
 294 mesh_path_add(struct ieee80211_sub_if_data *sdata, const u8 *dst);
 295
 296 int mesh_path_add_gate(struct mesh_path *mpath);
 297 int mesh_path_send_to_gates(struct mesh_path *mpath);
 298 int mesh_gate_num(struct ieee80211_sub_if_data *sdata);
 299 u32 airtime_link_metric_get(struct ieee80211_local *local,
 300                             struct sta_info *sta);
 301
 302 /* Mesh plinks */
 303 void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata,
 304                            u8 *hw_addr, struct ieee802_11_elems *ie,
 305                            struct ieee80211_rx_status *rx_status);
 306 bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
 307 u64 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
 308 void mesh_plink_timer(struct timer_list *t);
 309 void mesh_plink_broken(struct sta_info *sta);
 310 u64 mesh_plink_deactivate(struct sta_info *sta);
 311 u64 mesh_plink_open(struct sta_info *sta);
 312 u64 mesh_plink_block(struct sta_info *sta);
 313 void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
 314                          struct ieee80211_mgmt *mgmt, size_t len,
 315                          struct ieee80211_rx_status *rx_status);
 316 void mesh_sta_cleanup(struct sta_info *sta);
 317
 318 /* Private interfaces */
 319 /* Mesh paths */
 320 int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata,
 321                        u8 ttl, const u8 *target, u32 target_sn,
 322                        u16 target_rcode, const u8 *ra);
 323 void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta);
 324 void mesh_path_flush_pending(struct mesh_path *mpath);
 325 void mesh_path_tx_pending(struct mesh_path *mpath);
 326 void mesh_pathtbl_init(struct ieee80211_sub_if_data *sdata);
 327 void mesh_pathtbl_unregister(struct ieee80211_sub_if_data *sdata);
 328 int mesh_path_del(struct ieee80211_sub_if_data *sdata, const u8 *addr);
 329 void mesh_path_timer(struct timer_list *t);
 330 void mesh_path_flush_by_nexthop(struct sta_info *sta);
 331 void mesh_path_discard_frame(struct ieee80211_sub_if_data *sdata,
 332                              struct sk_buff *skb);
 333 void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
 334
 335 bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
 336 struct ieee80211_mesh_fast_tx *
 337 mesh_fast_tx_get(struct ieee80211_sub_if_data *sdata, const u8 *addr);
 338 bool ieee80211_mesh_xmit_fast(struct ieee80211_sub_if_data *sdata,
 339                               struct sk_buff *skb, u32 ctrl_flags);
 340 void mesh_fast_tx_cache(struct ieee80211_sub_if_data *sdata,
 341                         struct sk_buff *skb, struct mesh_path *mpath);
 342 void mesh_fast_tx_gc(struct ieee80211_sub_if_data *sdata);
 343 void mesh_fast_tx_flush_addr(struct ieee80211_sub_if_data *sdata,
 344                              const u8 *addr);
 345 void mesh_fast_tx_flush_mpath(struct mesh_path *mpath);
 346 void mesh_fast_tx_flush_sta(struct ieee80211_sub_if_data *sdata,
 347                             struct sta_info *sta);
 348 void mesh_path_refresh(struct ieee80211_sub_if_data *sdata,
 349                        struct mesh_path *mpath, const u8 *addr);
 350
 351 #ifdef CONFIG_MAC80211_MESH
 352 static inline
 353 u64 mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata)
 354 {
 355         atomic_inc(&sdata->u.mesh.estab_plinks);
 356         return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
 357 }
 358
 359 static inline
 360 u64 mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata)
 361 {
 362         atomic_dec(&sdata->u.mesh.estab_plinks);
 363         return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
 364 }
 365
 366 static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
 367 {
 368         return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
 369                atomic_read(&sdata->u.mesh.estab_plinks);
 370 }
 371
 372 static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
 373 {
 374         return (min_t(long, mesh_plink_free_count(sdata),
 375                    MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
 376 }
 377
 378 static inline void mesh_path_activate(struct mesh_path *mpath)
 379 {
 380         mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED;
 381 }
 382
 383 static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
 384 {
 385         return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
 386 }
 387
 388 void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
 389 void mesh_sync_adjust_tsf(struct ieee80211_sub_if_data *sdata);
 390 void ieee80211s_stop(void);
 391 #else
 392 static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
 393 { return false; }
 394 static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata)
 395 {}
 396 static inline void ieee80211s_stop(void) {}
 397 #endif
 398
 399 #endif /* IEEE80211S_H */