net/mac80211/mesh.h

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